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