sfx2/source/appl/sfxpicklist.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: sfxpicklist.cxx,v $
  10  * $Revision: 1.34 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sfx2.hxx"
  33
  34 #include <com/sun/star/document/XDocumentProperties.hpp>
  35 #include <svtools/historyoptions.hxx>
  36 #include <svtools/useroptions.hxx>
  37 #include <tools/urlobj.hxx>
  38 #include <framework/menuconfiguration.hxx>
  39 #include <svtools/inethist.hxx>
  40 #include <svtools/stritem.hxx>
  41 #include <svtools/eitem.hxx>
  42 #include <osl/file.hxx>
  43 #include <unotools/localfilehelper.hxx>
  44 #include <cppuhelper/implbase1.hxx>
  45
  46 #include <shell/systemshell.hxx>
  47
  48 // ----------------------------------------------------------------------------
  49
  50 #include <sfx2/app.hxx>
  51 #include "sfxpicklist.hxx"
  52 #include <sfx2/sfxuno.hxx>
  53 #include "sfxtypes.hxx"
  54 #include <sfx2/request.hxx>
  55 #include <sfx2/sfxsids.hrc>
  56 #include <sfx2/sfx.hrc>
  57 #include <sfx2/event.hxx>
  58 #include <sfx2/objsh.hxx>
  59 #include <sfx2/bindings.hxx>
  60 #include "referers.hxx"
  61 #include <sfx2/docfile.hxx>
  62 #include "objshimp.hxx"
  63 #include <sfx2/docfilt.hxx>
  64
  65 #include <algorithm>
  66
  67 // ----------------------------------------------------------------------------
  68
  69 using namespace ::com::sun::star::uno;
  70 using namespace ::com::sun::star::beans;
  71 using namespace ::com::sun::star::util;
  72
  73 // ----------------------------------------------------------------------------
  74
  75 osl::Mutex*             SfxPickList::pMutex = 0;
  76 SfxPickList*    SfxPickList::pUniqueInstance = 0;
  77
  78 // ----------------------------------------------------------------------------
  79
  80 class StringLength : public ::cppu::WeakImplHelper1< XStringWidth >
  81 {
  82     public:
  83         StringLength() {}
  84         virtual ~StringLength() {}
  85
  86         // XStringWidth
  87         sal_Int32 SAL_CALL queryStringWidth( const ::rtl::OUString& aString )
  88             throw (::com::sun::star::uno::RuntimeException)
  89         {
  90             return aString.getLength();
  91         }
  92 };
  93
  94 // ----------------------------------------------------------------------------
  95
  96 osl::Mutex*     SfxPickList::GetOrCreateMutex()
  97 {
  98     if ( !pMutex )
  99     {
 100         ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
 101         if ( !pMutex )
 102             pMutex = new osl::Mutex;
 103     }
 104
 105     return pMutex;
 106 }
 107
 108 void SfxPickList::CreatePicklistMenuTitle( Menu* pMenu, USHORT nItemId, const String& aURLString, sal_uInt32 nNo )
 109 {
 110     String aPickEntry;
 111
 112     if ( nNo < 9 )
 113     {
 114         aPickEntry += '~';
 115         aPickEntry += String::CreateFromInt32( nNo + 1 );
 116     }
 117     else if ( nNo == 9 )
 118         aPickEntry += DEFINE_CONST_UNICODE("1~0");
 119     else
 120         aPickEntry += String::CreateFromInt32( nNo + 1 );
 121     aPickEntry += DEFINE_CONST_UNICODE(": ");
 122
 123     INetURLObject       aURL( aURLString );
 124     rtl::OUString       aTipHelpText;
 125     rtl::OUString       aAccessibleName( aPickEntry );
 126
 127     if ( aURL.GetProtocol() == INET_PROT_FILE )
 128     {
 129         // Do handle file URL differently => convert it to a system
 130         // path and abbreviate it with a special function:
 131         String aFileSystemPath( aURL.getFSysPath( INetURLObject::FSYS_DETECT ) );
 132
 133 //              ::utl::LocalFileHelper::ConvertURLToPhysicalName( aURLString, aPhysicalName );
 134
 135         ::rtl::OUString aSystemPath( aFileSystemPath );
 136         ::rtl::OUString aCompactedSystemPath;
 137
 138         aTipHelpText = aSystemPath;
 139         aAccessibleName += aSystemPath;
 140         oslFileError nError = osl_abbreviateSystemPath( aSystemPath.pData, &aCompactedSystemPath.pData, 46, NULL );
 141         if ( !nError )
 142             aPickEntry += String( aCompactedSystemPath );
 143         else
 144             aPickEntry += aFileSystemPath;
 145
 146         if ( aPickEntry.Len() > 50 )
 147         {
 148             aPickEntry.Erase( 47 );
 149             aPickEntry += DEFINE_CONST_UNICODE("...");
 150         }
 151     }
 152     else
 153     {
 154         // Use INetURLObject to abbreviate all other URLs
 155         String  aShortURL;
 156         aShortURL = aURL.getAbbreviated( m_xStringLength, 46, INetURLObject::DECODE_UNAMBIGUOUS );
 157         aPickEntry += aShortURL;
 158         aTipHelpText = aURLString;
 159         aAccessibleName += aURLString;
 160     }
 161
 162     // Set menu item text, tip help and accessible name
 163     pMenu->SetItemText( nItemId, aPickEntry );
 164     pMenu->SetTipHelpText( nItemId, aTipHelpText );
 165     pMenu->SetAccessibleName( nItemId, aAccessibleName );
 166 }
 167
 168 void SfxPickList::RemovePickListEntries()
 169 {
 170     ::osl::MutexGuard aGuard( GetOrCreateMutex() );
 171     for ( sal_uInt32 i = 0; i < m_aPicklistVector.size(); i++ )
 172         delete m_aPicklistVector[i];
 173     m_aPicklistVector.clear();
 174 }
 175
 176 SfxPickList::PickListEntry*     SfxPickList::GetPickListEntry( sal_uInt32 nIndex )
 177 {
 178     OSL_ASSERT( m_aPicklistVector.size() > nIndex );
 179
 180     if ( nIndex < m_aPicklistVector.size() )
 181         return m_aPicklistVector[ nIndex ];
 182     else
 183         return 0;
 184 }
 185
 186 SfxPickList*    SfxPickList::GetOrCreate( const sal_uInt32 nMenuSize )
 187 {
 188     if ( !pUniqueInstance )
 189     {
 190         ::osl::MutexGuard aGuard( GetOrCreateMutex() );
 191         if ( !pUniqueInstance )
 192             pUniqueInstance = new SfxPickList( nMenuSize );
 193     }
 194
 195     return pUniqueInstance;
 196 }
 197
 198 SfxPickList* SfxPickList::Get()
 199 {
 200     ::osl::MutexGuard aGuard( GetOrCreateMutex() );
 201     return pUniqueInstance;
 202 }
 203
 204 void SfxPickList::Delete()
 205 {
 206     ::osl::MutexGuard aGuard( GetOrCreateMutex() );
 207     DELETEZ( pUniqueInstance );
 208 }
 209
 210 SfxPickList::SfxPickList( sal_uInt32 nAllowedMenuSize ) :
 211     m_nAllowedMenuSize( nAllowedMenuSize )
 212 {
 213     m_xStringLength = new StringLength;
 214     m_nAllowedMenuSize = ::std::min( m_nAllowedMenuSize, (sal_uInt32)PICKLIST_MAXSIZE );
 215     StartListening( *SFX_APP() );
 216 }
 217
 218 SfxPickList::~SfxPickList()
 219 {
 220     RemovePickListEntries();
 221 }
 222
 223 void SfxPickList::CreatePickListEntries()
 224 {
 225     RemovePickListEntries();
 226
 227     // Einlesen der Pickliste
 228     Sequence< Sequence< PropertyValue > > seqPicklist = SvtHistoryOptions().GetList( ePICKLIST );
 229
 230     sal_uInt32 nCount   = seqPicklist.getLength();
 231     sal_uInt32 nEntries = ::std::min( m_nAllowedMenuSize, nCount );
 232
 233     for( sal_uInt32 nItem=0; nItem < nEntries; ++nItem )
 234     {
 235         Sequence< PropertyValue > seqPropertySet = seqPicklist[ nItem ];
 236
 237         INetURLObject   aURL;
 238         ::rtl::OUString sURL;
 239         ::rtl::OUString sFilter;
 240         ::rtl::OUString sTitle;
 241         ::rtl::OUString sPassword;
 242
 243         sal_uInt32 nPropertyCount = seqPropertySet.getLength();
 244         for( sal_uInt32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 245         {
 246             if( seqPropertySet[nProperty].Name == HISTORY_PROPERTYNAME_URL )
 247             {
 248                 seqPropertySet[nProperty].Value >>= sURL;
 249             }
 250             else if( seqPropertySet[nProperty].Name == HISTORY_PROPERTYNAME_FILTER )
 251             {
 252                 seqPropertySet[nProperty].Value >>= sFilter;
 253             }
 254             else if( seqPropertySet[nProperty].Name == HISTORY_PROPERTYNAME_TITLE )
 255             {
 256                 seqPropertySet[nProperty].Value >>= sTitle;
 257             }
 258             else if( seqPropertySet[nProperty].Name == HISTORY_PROPERTYNAME_PASSWORD )
 259             {
 260                 seqPropertySet[nProperty].Value >>= sPassword;
 261             }
 262         }
 263
 264         aURL.SetSmartURL( sURL );
 265         aURL.SetPass( SfxStringDecode( sPassword ) );
 266
 267         PickListEntry *pPick = new PickListEntry( aURL.GetMainURL( INetURLObject::NO_DECODE ), sFilter, sTitle );
 268         m_aPicklistVector.push_back( pPick );
 269     }
 270 }
 271
 272 void SfxPickList::CreateMenuEntries( Menu* pMenu )
 273 {
 274     static sal_Bool     bPickListMenuInitializing = sal_False;
 275
 276     ::osl::MutexGuard aGuard( GetOrCreateMutex() );
 277
 278     if ( bPickListMenuInitializing ) // method is not reentrant!
 279         return;
 280
 281     bPickListMenuInitializing = sal_True;
 282     CreatePickListEntries();
 283
 284     for ( sal_uInt16 nId = START_ITEMID_PICKLIST; nId <= END_ITEMID_PICKLIST; ++nId )
 285         pMenu->RemoveItem( pMenu->GetItemPos( nId ) );
 286
 287     if ( pMenu->GetItemType( pMenu->GetItemCount()-1 ) == MENUITEM_SEPARATOR )
 288         pMenu->RemoveItem( pMenu->GetItemCount()-1 );
 289
 290     if ( m_aPicklistVector.size() > 0 &&
 291          pMenu->GetItemType( pMenu->GetItemCount()-1 )
 292             != MENUITEM_SEPARATOR && m_nAllowedMenuSize )
 293         pMenu->InsertSeparator();
 294
 295     rtl::OUString aEmptyString;
 296     for ( sal_uInt32 i = 0; i < m_aPicklistVector.size(); i++ )
 297     {
 298         PickListEntry* pEntry = GetPickListEntry( i );
 299
 300         pMenu->InsertItem( (USHORT)(START_ITEMID_PICKLIST + i), aEmptyString );
 301         CreatePicklistMenuTitle( pMenu, (USHORT)(START_ITEMID_PICKLIST + i), pEntry->aName, i );
 302     }
 303
 304     bPickListMenuInitializing = sal_False;
 305 }
 306
 307 void SfxPickList::ExecuteEntry( sal_uInt32 nIndex )
 308 {
 309     ::osl::ClearableMutexGuard aGuard( GetOrCreateMutex() );
 310
 311     PickListEntry *pPick = SfxPickList::Get()->GetPickListEntry( nIndex );
 312
 313     if ( pPick )
 314     {
 315         SfxRequest aReq( SID_OPENDOC, SFX_CALLMODE_ASYNCHRON, SFX_APP()->GetPool() );
 316         aReq.AppendItem( SfxStringItem( SID_FILE_NAME, pPick->aName ));
 317         aReq.AppendItem( SfxStringItem( SID_REFERER, DEFINE_CONST_UNICODE( SFX_REFERER_USER ) ) );
 318         aReq.AppendItem( SfxStringItem( SID_TARGETNAME, DEFINE_CONST_UNICODE("_default") ) );
 319         String aFilter( pPick->aFilter );
 320         aGuard.clear();
 321
 322         USHORT nPos=aFilter.Search('|');
 323         if( nPos != STRING_NOTFOUND )
 324         {
 325             String aOptions(aFilter.Copy( nPos ).GetBuffer()+1);
 326             aFilter.Erase( nPos );
 327             aReq.AppendItem( SfxStringItem(SID_FILE_FILTEROPTIONS, aOptions));
 328         }
 329
 330         aReq.AppendItem(SfxStringItem( SID_FILTER_NAME, aFilter ));
 331         aReq.AppendItem( SfxBoolItem( SID_TEMPLATE, sal_False ) );
 332         SFX_APP()->ExecuteSlot( aReq );
 333     }
 334 }
 335
 336 void SfxPickList::ExecuteMenuEntry( USHORT nId )
 337 {
 338     ExecuteEntry( (sal_uInt32)( nId - START_ITEMID_PICKLIST ) );
 339 }
 340
 341 String SfxPickList::GetMenuEntryTitle( sal_uInt32 nIndex )
 342 {
 343     PickListEntry *pPick = SfxPickList::Get()->GetPickListEntry( nIndex );
 344
 345     if ( pPick )
 346         return pPick->aTitle;
 347     else
 348         return String();
 349 }
 350
 351 void SfxPickList::Notify( SfxBroadcaster&, const SfxHint& rHint )
 352 {
 353     if ( rHint.IsA( TYPE( SfxStringHint )))
 354     {
 355         SfxStringHint* pStringHint = (SfxStringHint*) &rHint;
 356
 357         if ( pStringHint->GetId() == SID_OPENURL )
 358             INetURLHistory::GetOrCreate()->PutUrl( INetURLObject( pStringHint->GetObject() ));
 359     }
 360
 361     if ( rHint.IsA( TYPE( SfxEventHint )))
 362     {
 363         SfxEventHint* pEventHint = PTR_CAST(SfxEventHint,&rHint);
 364         // nur ObjectShell-bezogene Events mit Medium interessieren
 365         SfxObjectShell* pDocSh = pEventHint->GetObjShell();
 366         if( !pDocSh )
 367             return;
 368
 369         switch ( pEventHint->GetEventId() )
 370         {
 371             case SFX_EVENT_CREATEDOC:
 372             {
 373                 sal_Bool bAllowModif = pDocSh->IsEnableSetModified();
 374                 if ( bAllowModif )
 375                     pDocSh->EnableSetModified( sal_False );
 376
 377                 using namespace ::com::sun::star;
 378                 uno::Reference<document::XDocumentProperties> xDocProps(
 379                     pDocSh->getDocProperties());
 380                 if (xDocProps.is()) {
 381                     xDocProps->setAuthor( SvtUserOptions().GetFullName() );
 382                     ::DateTime now;
 383                     xDocProps->setCreationDate( util::DateTime(
 384                         now.Get100Sec(), now.GetSec(), now.GetMin(),
 385                         now.GetHour(), now.GetDay(), now.GetMonth(),
 386                         now.GetYear() ) );
 387                 }
 388
 389                 if ( bAllowModif )
 390                     pDocSh->EnableSetModified( bAllowModif );
 391             }
 392             break;
 393
 394             case SFX_EVENT_OPENDOC:
 395             {
 396                 SfxMedium *pMed = pDocSh->GetMedium();
 397                 if( !pMed )
 398                     return;
 399
 400                 // unbenannt-Docs und embedded-Docs nicht in History
 401                 if ( !pDocSh->HasName() ||
 402                      SFX_CREATE_MODE_STANDARD != pDocSh->GetCreateMode() )
 403                     return;
 404
 405                 // Hilfe nicht in History
 406                 INetURLObject aURL( pDocSh->IsDocShared() ? pDocSh->GetSharedFileURL() : ::rtl::OUString( pMed->GetOrigURL() ) );
 407                 if ( aURL.GetProtocol() == INET_PROT_VND_SUN_STAR_HELP )
 408                     return;
 409
 410                 ::rtl::OUString  aTitle = pDocSh->GetTitle(SFX_TITLE_PICKLIST);
 411                 ::rtl::OUString  aFilter;
 412                 const SfxFilter* pFilter = pMed->GetOrigFilter();
 413                 if ( pFilter )
 414                     aFilter = pFilter->GetFilterName();
 415
 416                 // add to svtool history options
 417                 SvtHistoryOptions().AppendItem( eHISTORY,
 418                         aURL.GetURLNoPass( INetURLObject::NO_DECODE ),
 419                         aFilter,
 420                         aTitle,
 421                         SfxStringEncode( aURL.GetPass() ) );
 422             }
 423             break;
 424
 425             case SFX_EVENT_CLOSEDOC:
 426             {
 427                 SfxMedium *pMed = pDocSh->GetMedium();
 428                 if( !pMed )
 429                     return;
 430
 431                 // unbenannt-Docs und embedded-Docs nicht in Pickliste
 432                 if ( !pDocSh->HasName() ||
 433                      SFX_CREATE_MODE_STANDARD != pDocSh->GetCreateMode() )
 434                     return;
 435
 436                 // Hilfe nicht in History
 437                 INetURLObject aURL( pDocSh->IsDocShared() ? pDocSh->GetSharedFileURL() : ::rtl::OUString( pMed->GetOrigURL() ) );
 438                 if ( aURL.GetProtocol() == INET_PROT_VND_SUN_STAR_HELP )
 439                     return;
 440
 441                 // only add r/w document into picklist
 442                 if ( pDocSh->IsReadOnly() || !pMed->IsUpdatePickList() )
 443                     return;
 444
 445                 // add no document that forbids this (for example Message-Body)
 446                 SFX_ITEMSET_ARG( pMed->GetItemSet(), pPicklistItem, SfxBoolItem, SID_PICKLIST, sal_False );
 447                 if (
 448                     (pPicklistItem && !pPicklistItem->GetValue()) ||
 449                     (!(pDocSh->Get_Impl()->bWaitingForPicklist) )
 450                    )
 451                     return;
 452
 453                 // ignore hidden documents
 454                 if ( !SfxViewFrame::GetFirst( pDocSh, 0, TRUE ) )
 455                     return;
 456
 457                 ::rtl::OUString  aTitle = pDocSh->GetTitle(SFX_TITLE_PICKLIST);
 458                 ::rtl::OUString  aFilter;
 459                 const SfxFilter* pFilter = pMed->GetOrigFilter();
 460                 if ( pFilter )
 461                     aFilter = pFilter->GetFilterName();
 462
 463                 // add to svtool history options
 464                 SvtHistoryOptions().AppendItem( ePICKLIST,
 465                         aURL.GetURLNoPass( INetURLObject::NO_DECODE ),
 466                         aFilter,
 467                         aTitle,
 468                         SfxStringEncode( aURL.GetPass() ) );
 469
 470                 pDocSh->Get_Impl()->bWaitingForPicklist = sal_False;
 471
 472                 if ( aURL.GetProtocol() == INET_PROT_FILE )
 473                     SystemShell::AddToRecentDocumentList( aURL.GetURLNoPass( INetURLObject::NO_DECODE ), (pFilter) ? pFilter->GetMimeType() : String() );
 474             }
 475             break;
 476         }
 477     }
 478 }