svtools/source/config/extendedsecurityoptions.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: extendedsecurityoptions.cxx,v $
  10  * $Revision: 1.10 $
  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_svtools.hxx"
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <svtools/extendedsecurityoptions.hxx>
  39 #include <unotools/configmgr.hxx>
  40 #include <unotools/configitem.hxx>
  41 #include <tools/debug.hxx>
  42 #include <com/sun/star/uno/Any.hxx>
  43 #include <com/sun/star/uno/Sequence.hxx>
  44 #include <tools/urlobj.hxx>
  45 #include <tools/wldcrd.hxx>
  46 #include <rtl/ustrbuf.hxx>
  47
  48 #include <svtools/pathoptions.hxx>
  49
  50 #include <hash_map>
  51
  52 #include <rtl/logfile.hxx>
  53 #include "itemholder1.hxx"
  54
  55 //_________________________________________________________________________________________________________________
  56 //      namespaces
  57 //_________________________________________________________________________________________________________________
  58
  59 using namespace ::utl                                   ;
  60 using namespace ::rtl                                   ;
  61 using namespace ::osl                                   ;
  62 using namespace ::com::sun::star::uno   ;
  63
  64 //_________________________________________________________________________________________________________________
  65 //      const
  66 //_________________________________________________________________________________________________________________
  67
  68 #define ROOTNODE_SECURITY                               OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Security"))
  69
  70 #define SECURE_EXTENSIONS_SET                   OUString(RTL_CONSTASCII_USTRINGPARAM("SecureExtensions"))
  71 #define EXTENSION_PROPNAME                              OUString(RTL_CONSTASCII_USTRINGPARAM("/Extension"))
  72
  73 #define PROPERTYNAME_HYPERLINKS_OPEN    OUString(RTL_CONSTASCII_USTRINGPARAM("Hyperlinks/Open"))
  74
  75 #define PROPERTYHANDLE_HYPERLINKS_OPEN  0
  76
  77 #define PROPERTYCOUNT                   1
  78
  79 //_________________________________________________________________________________________________________________
  80 //      private declarations!
  81 //_________________________________________________________________________________________________________________
  82
  83 struct OUStringHashCode
  84 {
  85     size_t operator()( const ::rtl::OUString& sString ) const
  86     {
  87         return sString.hashCode();
  88     }
  89 };
  90
  91 class ExtensionHashMap : public ::std::hash_map< ::rtl::OUString,
  92                                                  sal_Int32,
  93                                                  OUStringHashCode,
  94                                                  ::std::equal_to< ::rtl::OUString > >
  95 {
  96     public:
  97         inline void free()
  98         {
  99             ExtensionHashMap().swap( *this );
 100         }
 101 };
 102
 103 class SvtExtendedSecurityOptions_Impl : public ConfigItem
 104 {
 105     //-------------------------------------------------------------------------------------------------------------
 106     //  public methods
 107     //-------------------------------------------------------------------------------------------------------------
 108
 109     public:
 110
 111         //---------------------------------------------------------------------------------------------------------
 112         //      constructor / destructor
 113         //---------------------------------------------------------------------------------------------------------
 114
 115          SvtExtendedSecurityOptions_Impl();
 116         ~SvtExtendedSecurityOptions_Impl();
 117
 118         //---------------------------------------------------------------------------------------------------------
 119         //      overloaded methods of baseclass
 120         //---------------------------------------------------------------------------------------------------------
 121
 122         /*-****************************************************************************************************//**
 123             @short              called for notify of configmanager
 124             @descr              These method is called from the ConfigManager before application ends or from the
 125                          PropertyChangeListener if the sub tree broadcasts changes. You must update your
 126                         internal values.
 127
 128             @seealso    baseclass ConfigItem
 129
 130             @param              "seqPropertyNames" is the list of properties which should be updated.
 131             @return             -
 132
 133             @onerror    -
 134         *//*-*****************************************************************************************************/
 135
 136         virtual void Notify( const Sequence< OUString >& seqPropertyNames );
 137
 138         /*-****************************************************************************************************//**
 139             @short              write changes to configuration
 140             @descr              These method writes the changed values into the sub tree
 141                         and should always called in our destructor to guarantee consistency of config data.
 142
 143             @seealso    baseclass ConfigItem
 144
 145             @param              -
 146             @return             -
 147
 148             @onerror    -
 149         *//*-*****************************************************************************************************/
 150
 151         virtual void Commit();
 152
 153         //---------------------------------------------------------------------------------------------------------
 154         //      public interface
 155         //---------------------------------------------------------------------------------------------------------
 156
 157         /*-****************************************************************************************************//**
 158             @short              Access method to check for security problems
 159             @descr              Different methods to check for security related problems.
 160
 161             @seealso    -
 162
 163             @param              -
 164             @return             -
 165
 166             @onerror    -
 167         *//*-*****************************************************************************************************/
 168
 169         sal_Bool                                                                                IsSecureHyperlink( const rtl::OUString& aURL ) const;
 170         Sequence< rtl::OUString >                                               GetSecureExtensionList() const;
 171
 172         SvtExtendedSecurityOptions::OpenHyperlinkMode   GetOpenHyperlinkMode();
 173         void                                                                                    SetOpenHyperlinkMode( SvtExtendedSecurityOptions::OpenHyperlinkMode aMode );
 174         sal_Bool                                        IsOpenHyperlinkModeReadOnly() const;
 175
 176     //-------------------------------------------------------------------------------------------------------------
 177     //  private methods
 178     //-------------------------------------------------------------------------------------------------------------
 179
 180     private:
 181
 182         /*-****************************************************************************************************//**
 183             @short              return list of key names of ouer configuration management which represent oue module tree
 184             @descr              These methods return a static const list of key names. We need it to get needed values from our
 185                         configuration management.
 186
 187             @seealso    -
 188
 189             @param              -
 190             @return             A list of needed configuration keys is returned.
 191
 192             @onerror    -
 193         *//*-*****************************************************************************************************/
 194
 195         static Sequence< OUString > GetPropertyNames();
 196
 197         /*-****************************************************************************************************//**
 198             @short              Fills the hash map with all extensions known to be secure
 199             @descr              These methods fills the given hash map object with all extensions known to be secure.
 200
 201             @seealso    -
 202
 203             @param              aHashMap
 204                         A hash map to be filled with secure extension strings.
 205             @return             -
 206
 207             @onerror    -
 208         *//*-*****************************************************************************************************/
 209         void FillExtensionHashMap( ExtensionHashMap& aHashMap );
 210
 211     //-------------------------------------------------------------------------------------------------------------
 212     //  private member
 213     //-------------------------------------------------------------------------------------------------------------
 214
 215     private:
 216         OUString                                                                                m_aSecureExtensionsSetName;
 217         OUString                                                                                m_aExtensionPropName;
 218
 219         SvtExtendedSecurityOptions::OpenHyperlinkMode   m_eOpenHyperlinkMode;
 220         sal_Bool                                        m_bROOpenHyperlinkMode;
 221         ExtensionHashMap                                                                m_aExtensionHashMap;
 222 };
 223
 224 //_________________________________________________________________________________________________________________
 225 //      definitions
 226 //_________________________________________________________________________________________________________________
 227
 228 //*****************************************************************************************************************
 229 //      constructor
 230 //*****************************************************************************************************************
 231 SvtExtendedSecurityOptions_Impl::SvtExtendedSecurityOptions_Impl()
 232     // Init baseclasses first
 233     :   ConfigItem                      ( ROOTNODE_SECURITY                     ),
 234     m_aSecureExtensionsSetName( SECURE_EXTENSIONS_SET ),
 235     m_aExtensionPropName( EXTENSION_PROPNAME ),
 236     m_bROOpenHyperlinkMode(sal_False)
 237     // Init member then.
 238 {
 239     // Fill the extension hash map with all secure extension strings
 240     FillExtensionHashMap( m_aExtensionHashMap );
 241
 242     Sequence< OUString >        seqNames        = GetPropertyNames();
 243     Sequence< Any >                     seqValues       = GetProperties( seqNames );
 244     Sequence< sal_Bool >    seqRO       = GetReadOnlyStates ( seqNames  );
 245
 246     sal_Int32 nPropertyCount = seqValues.getLength();
 247     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 248     {
 249         // Safe impossible cases.
 250         // Check any for valid value.
 251         DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtExtendedSecurityOptions_Impl::SvtExtendedSecurityOptions_Impl()\nInvalid property value detected!\n" );
 252         switch( nProperty )
 253         {
 254             case PROPERTYHANDLE_HYPERLINKS_OPEN:
 255             {
 256                 DBG_ASSERT( ( seqValues[nProperty].getValueTypeClass() == TypeClass_LONG ), "SvtExtendedSecurityOptions_Impl::SvtExtendedSecurityOptions_Impl()\nWho has changed the value type of 'Hyperlink/Open'?" );
 257
 258                 sal_Int32 nMode = SvtExtendedSecurityOptions::OPEN_WITHSECURITYCHECK;
 259                 if ( seqValues[nProperty] >>= nMode )
 260                     m_eOpenHyperlinkMode = (SvtExtendedSecurityOptions::OpenHyperlinkMode)nMode;
 261                 else {
 262                     DBG_ERROR("Wrong type for Open mode!");
 263                 }
 264                 m_bROOpenHyperlinkMode = seqRO[nProperty];
 265             }
 266             break;
 267         }
 268     }
 269
 270     // Enable notification mechanism of our baseclass.
 271     // We need it to get information about changes outside these class on ouer used configuration keys!
 272     Sequence< OUString > seqNotifyNames( 1 );
 273     seqNotifyNames[0] = m_aSecureExtensionsSetName;
 274     EnableNotification( seqNotifyNames );
 275 }
 276
 277 //*****************************************************************************************************************
 278 //      destructor
 279 //*****************************************************************************************************************
 280 SvtExtendedSecurityOptions_Impl::~SvtExtendedSecurityOptions_Impl()
 281 {
 282     // We must save our current values .. if user forget it!
 283     if( IsModified() == sal_True )
 284     {
 285         Commit();
 286     }
 287 }
 288
 289 //*****************************************************************************************************************
 290 //      public method
 291 //*****************************************************************************************************************
 292 void SvtExtendedSecurityOptions_Impl::Notify( const Sequence< OUString >& )
 293 {
 294     // Not implemented
 295 }
 296
 297 //*****************************************************************************************************************
 298 //      public method
 299 //*****************************************************************************************************************
 300 void SvtExtendedSecurityOptions_Impl::Commit()
 301 {
 302     // Get names of supported properties, create a list for values and copy current values to it.
 303     Sequence< OUString >        seqNames        = GetPropertyNames      ();
 304     sal_Int32                           nCount          = seqNames.getLength();
 305     Sequence< Any >                     seqValues       ( nCount );
 306     for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
 307     {
 308         switch( nProperty )
 309         {
 310             case PROPERTYHANDLE_HYPERLINKS_OPEN:        {
 311                                                         seqValues[nProperty] <<= (sal_Int32)m_eOpenHyperlinkMode;
 312                                                     }
 313                                                     break;
 314         }
 315     }
 316
 317     // Set properties in configuration.
 318     PutProperties( seqNames, seqValues );
 319 }
 320
 321 //*****************************************************************************************************************
 322 //      public method
 323 //*****************************************************************************************************************
 324 sal_Bool SvtExtendedSecurityOptions_Impl::IsSecureHyperlink( const OUString& aURL ) const
 325 {
 326     INetURLObject aURLObject( aURL );
 327
 328     String aExtension = aURLObject.getExtension();
 329     aExtension.ToLowerAscii();
 330
 331     ExtensionHashMap::const_iterator pIter = m_aExtensionHashMap.find( aExtension );
 332     if ( pIter != m_aExtensionHashMap.end() )
 333         return sal_True;
 334     else
 335         return sal_False;
 336 }
 337
 338 //*****************************************************************************************************************
 339 //      public method
 340 //*****************************************************************************************************************
 341 Sequence< OUString > SvtExtendedSecurityOptions_Impl::GetSecureExtensionList() const
 342 {
 343     Sequence< OUString > aResult( m_aExtensionHashMap.size() );
 344
 345     sal_Int32 nIndex = 0;
 346     for ( ExtensionHashMap::const_iterator pIter = m_aExtensionHashMap.begin();
 347             pIter != m_aExtensionHashMap.end(); pIter++ )
 348     {
 349         aResult[nIndex++] = pIter->first;
 350     }
 351
 352     return aResult;
 353 }
 354
 355 //*****************************************************************************************************************
 356 //      public method
 357 //*****************************************************************************************************************
 358 SvtExtendedSecurityOptions::OpenHyperlinkMode SvtExtendedSecurityOptions_Impl::GetOpenHyperlinkMode()
 359 {
 360     return m_eOpenHyperlinkMode;
 361 }
 362 /* -----------------09.07.2003 11:26-----------------
 363
 364  --------------------------------------------------*/
 365 sal_Bool SvtExtendedSecurityOptions_Impl::IsOpenHyperlinkModeReadOnly() const
 366 {
 367     return m_bROOpenHyperlinkMode;
 368 }
 369
 370 //*****************************************************************************************************************
 371 //      public method
 372 //*****************************************************************************************************************
 373 void SvtExtendedSecurityOptions_Impl::SetOpenHyperlinkMode( SvtExtendedSecurityOptions::OpenHyperlinkMode eNewMode )
 374 {
 375     m_eOpenHyperlinkMode = eNewMode;
 376     SetModified();
 377 }
 378
 379 //*****************************************************************************************************************
 380 //      private method
 381 //*****************************************************************************************************************
 382 void SvtExtendedSecurityOptions_Impl::FillExtensionHashMap( ExtensionHashMap& aHashMap )
 383 {
 384     // Get sequence with secure extensions from configuration
 385     Sequence< OUString >        seqNodes = GetNodeNames( m_aSecureExtensionsSetName );
 386
 387     OUString                            aValue;
 388     Sequence< Any >                     aValues;
 389     Sequence< OUString >        aPropSeq( 1 );
 390     for ( int i = 0; i < seqNodes.getLength(); i++ )
 391     {
 392         // Create access name for property
 393         OUStringBuffer aExtEntryProp( m_aSecureExtensionsSetName );
 394         aExtEntryProp.appendAscii( "/" );
 395         aExtEntryProp.append( seqNodes[i] );
 396         aExtEntryProp.append( m_aExtensionPropName );
 397
 398         aPropSeq[0] = aExtEntryProp.makeStringAndClear();
 399         aValues = GetProperties( aPropSeq );
 400         if ( aValues.getLength() == 1 )
 401         {
 402             // Don't use value if sequence has not the correct length
 403             if ( aValues[0] >>= aValue )
 404                 // Add extension into secure extensions hash map
 405                 aHashMap.insert( ExtensionHashMap::value_type( aValue.toAsciiLowerCase(), 1 ) );
 406             else
 407             {
 408                 DBG_ERRORFILE( "SvtExtendedSecurityOptions_Impl::FillExtensionHashMap(): not string value?" );
 409             }
 410         }
 411     }
 412 }
 413
 414 //*****************************************************************************************************************
 415 //      private method (currently not used)
 416 //*****************************************************************************************************************
 417 Sequence< OUString > SvtExtendedSecurityOptions_Impl::GetPropertyNames()
 418 {
 419     // Build static list of configuration key names.
 420     static const OUString pProperties[] =
 421     {
 422         PROPERTYNAME_HYPERLINKS_OPEN
 423     };
 424     // Initialize return sequence with these list ...
 425     static const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
 426     // ... and return it.
 427     return seqPropertyNames;
 428 }
 429
 430 //*****************************************************************************************************************
 431 //      initialize static member
 432 //      DON'T DO IT IN YOUR HEADER!
 433 //      see definition for further informations
 434 //*****************************************************************************************************************
 435 SvtExtendedSecurityOptions_Impl*        SvtExtendedSecurityOptions::m_pDataContainer    = NULL  ;
 436 sal_Int32                                                       SvtExtendedSecurityOptions::m_nRefCount                 = 0             ;
 437
 438 //*****************************************************************************************************************
 439 //      constructor
 440 //*****************************************************************************************************************
 441 SvtExtendedSecurityOptions::SvtExtendedSecurityOptions()
 442 {
 443     // Global access, must be guarded (multithreading!).
 444     MutexGuard aGuard( GetInitMutex() );
 445     // Increase ouer refcount ...
 446     ++m_nRefCount;
 447     // ... and initialize ouer data container only if it not already exist!
 448     if( m_pDataContainer == NULL )
 449     {
 450        RTL_LOGFILE_CONTEXT(aLog, "svtools ( ??? ) ::SvtExtendedSecurityOptions_Impl::ctor()");
 451        m_pDataContainer = new SvtExtendedSecurityOptions_Impl;
 452
 453         ItemHolder1::holdConfigItem(E_EXTENDEDSECURITYOPTIONS);
 454     }
 455 }
 456
 457 //*****************************************************************************************************************
 458 //      destructor
 459 //*****************************************************************************************************************
 460 SvtExtendedSecurityOptions::~SvtExtendedSecurityOptions()
 461 {
 462     // Global access, must be guarded (multithreading!)
 463     MutexGuard aGuard( GetInitMutex() );
 464     // Decrease ouer refcount.
 465     --m_nRefCount;
 466     // If last instance was deleted ...
 467     // we must destroy ouer static data container!
 468     if( m_nRefCount <= 0 )
 469     {
 470         delete m_pDataContainer;
 471         m_pDataContainer = NULL;
 472     }
 473 }
 474
 475 //*****************************************************************************************************************
 476 //      public method
 477 //*****************************************************************************************************************
 478 sal_Bool SvtExtendedSecurityOptions::IsSecureHyperlink( const rtl::OUString& aURL ) const
 479 {
 480     MutexGuard aGuard( GetInitMutex() );
 481     return m_pDataContainer->IsSecureHyperlink( aURL );
 482 }
 483
 484 //*****************************************************************************************************************
 485 //      public method
 486 //*****************************************************************************************************************
 487 Sequence< rtl::OUString > SvtExtendedSecurityOptions::GetSecureExtensionList() const
 488 {
 489     MutexGuard aGuard( GetInitMutex() );
 490     return m_pDataContainer->GetSecureExtensionList();
 491 }
 492
 493 //*****************************************************************************************************************
 494 //      public method
 495 //*****************************************************************************************************************
 496 SvtExtendedSecurityOptions::OpenHyperlinkMode SvtExtendedSecurityOptions::GetOpenHyperlinkMode()
 497 {
 498     MutexGuard aGuard( GetInitMutex() );
 499     return m_pDataContainer->GetOpenHyperlinkMode();
 500 }
 501 /* -----------------09.07.2003 11:26-----------------
 502
 503  --------------------------------------------------*/
 504 sal_Bool SvtExtendedSecurityOptions::IsOpenHyperlinkModeReadOnly() const
 505 {
 506     return m_pDataContainer->IsOpenHyperlinkModeReadOnly();
 507 }
 508
 509 //*****************************************************************************************************************
 510 //      public method
 511 //*****************************************************************************************************************
 512 void SvtExtendedSecurityOptions::SetOpenHyperlinkMode( SvtExtendedSecurityOptions::OpenHyperlinkMode eMode )
 513 {
 514     MutexGuard aGuard( GetInitMutex() );
 515     m_pDataContainer->SetOpenHyperlinkMode( eMode );
 516 }
 517
 518 //*****************************************************************************************************************
 519 //      private method
 520 //*****************************************************************************************************************
 521 Mutex& SvtExtendedSecurityOptions::GetInitMutex()
 522 {
 523     // Initialize static mutex only for one time!
 524     static Mutex* pMutex = NULL;
 525     // If these method first called (Mutex not already exist!) ...
 526     if( pMutex == NULL )
 527     {
 528         // ... we must create a new one. Protect follow code with the global mutex -
 529         // It must be - we create a static variable!
 530         MutexGuard aGuard( Mutex::getGlobalMutex() );
 531         // We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
 532         if( pMutex == NULL )
 533         {
 534             // Create the new mutex and set it for return on static variable.
 535             static Mutex aMutex;
 536             pMutex = &aMutex;
 537         }
 538     }
 539     // Return new created or already existing mutex object.
 540     return *pMutex;
 541 }