svtools/source/config/startoptions.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: startoptions.cxx,v $
  10  * $Revision: 1.16 $
  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 #ifndef GCC
  34 #endif
  35
  36 //_________________________________________________________________________________________________________________
  37 //      includes
  38 //_________________________________________________________________________________________________________________
  39
  40 #include <svtools/startoptions.hxx>
  41 #include <unotools/configmgr.hxx>
  42 #include <unotools/configitem.hxx>
  43 #include <tools/debug.hxx>
  44 #include <com/sun/star/uno/Any.hxx>
  45 #include <com/sun/star/uno/Sequence.hxx>
  46
  47 #include <rtl/logfile.hxx>
  48 #include "itemholder1.hxx"
  49 //_________________________________________________________________________________________________________________
  50 //      namespaces
  51 //_________________________________________________________________________________________________________________
  52
  53 using namespace ::utl                                   ;
  54 using namespace ::rtl                                   ;
  55 using namespace ::osl                                   ;
  56 using namespace ::com::sun::star::uno   ;
  57
  58 //_________________________________________________________________________________________________________________
  59 //      const
  60 //_________________________________________________________________________________________________________________
  61
  62 #define DEFAULT_SHOWINTRO                               sal_True
  63 #define DEFAULT_CONNECTIONURL                   OUString()
  64
  65 #define ROOTNODE_START                                  OUString(RTL_CONSTASCII_USTRINGPARAM("Setup/Office"     ))
  66 #define PROPERTYNAME_SHOWINTRO                  OUString(RTL_CONSTASCII_USTRINGPARAM("ooSetupShowIntro" ))
  67 #define PROPERTYNAME_CONNECTIONURL              OUString(RTL_CONSTASCII_USTRINGPARAM("ooSetupConnectionURL"     ))
  68
  69 #define PROPERTYHANDLE_SHOWINTRO                0
  70 #define PROPERTYHANDLE_CONNECTIONURL    1
  71
  72 #define PROPERTYCOUNT                                   2
  73
  74 //_________________________________________________________________________________________________________________
  75 //      private declarations!
  76 //_________________________________________________________________________________________________________________
  77
  78 class SvtStartOptions_Impl : public ConfigItem
  79 {
  80     //-------------------------------------------------------------------------------------------------------------
  81     //  public methods
  82     //-------------------------------------------------------------------------------------------------------------
  83
  84     public:
  85
  86         //---------------------------------------------------------------------------------------------------------
  87         //      constructor / destructor
  88         //---------------------------------------------------------------------------------------------------------
  89
  90          SvtStartOptions_Impl();
  91         ~SvtStartOptions_Impl();
  92
  93         //---------------------------------------------------------------------------------------------------------
  94         //      overloaded methods of baseclass
  95         //---------------------------------------------------------------------------------------------------------
  96
  97         /*-****************************************************************************************************//**
  98             @short              called for notify of configmanager
  99             @descr              These method is called from the ConfigManager before application ends or from the
 100                          PropertyChangeListener if the sub tree broadcasts changes. You must update your
 101                         internal values.
 102
 103             @ATTENTION  We don't implement these method - because we support readonly values at runtime only!
 104
 105             @seealso    baseclass ConfigItem
 106
 107             @param              "seqPropertyNames" is the list of properties which should be updated.
 108             @return             -
 109
 110             @onerror    -
 111         *//*-*****************************************************************************************************/
 112
 113         virtual void Notify( const Sequence< OUString >& seqPropertyNames );
 114
 115         /*-****************************************************************************************************//**
 116             @short              write changes to configuration
 117             @descr              These method writes the changed values into the sub tree
 118                         and should always called in our destructor to guarantee consistency of config data.
 119
 120             @ATTENTION  We don't implement these method - because we support readonly values at runtime only!
 121
 122             @seealso    baseclass ConfigItem
 123
 124             @param              -
 125             @return             -
 126
 127             @onerror    -
 128         *//*-*****************************************************************************************************/
 129
 130         virtual void Commit();
 131
 132         //---------------------------------------------------------------------------------------------------------
 133         //      public interface
 134         //---------------------------------------------------------------------------------------------------------
 135
 136         /*-****************************************************************************************************//**
 137             @short              access method to get internal values
 138             @descr              These method give us a chance to regulate acces to ouer internal values.
 139                         It's not used in the moment - but it's possible for the feature!
 140
 141             @seealso    -
 142
 143             @param              -
 144             @return             -
 145
 146             @onerror    -
 147         *//*-*****************************************************************************************************/
 148
 149         sal_Bool        IsIntroEnabled  (                                               ) const ;
 150         void            EnableIntro             ( sal_Bool bState               )               ;
 151         OUString        GetConnectionURL(                                               ) const ;
 152         void            SetConnectionURL( const OUString& sURL  )               ;
 153
 154     //-------------------------------------------------------------------------------------------------------------
 155     //  private methods
 156     //-------------------------------------------------------------------------------------------------------------
 157
 158     private:
 159
 160         /*-****************************************************************************************************//**
 161             @short              return list of fix key names of ouer configuration management which represent oue module tree
 162             @descr              These methods return a static const list of key names. We need it to get needed values from our
 163                         configuration management. We return well known key names only - because the "UserData" node
 164                         is handled in a special way!
 165
 166             @seealso    -
 167
 168             @param              -
 169             @return             A list of needed configuration keys is returned.
 170
 171             @onerror    -
 172         *//*-*****************************************************************************************************/
 173
 174         static Sequence< OUString > impl_GetPropertyNames();
 175
 176     //-------------------------------------------------------------------------------------------------------------
 177     //  private member
 178     //-------------------------------------------------------------------------------------------------------------
 179
 180     private:
 181
 182         sal_Bool        m_bShowIntro            ;       /// cache "ShowIntro" of Start section
 183         OUString        m_sConnectionURL        ;       /// cache "Connection" of Start section
 184 };
 185
 186 //_________________________________________________________________________________________________________________
 187 //      definitions
 188 //_________________________________________________________________________________________________________________
 189
 190 //*****************************************************************************************************************
 191 //      constructor
 192 //*****************************************************************************************************************
 193 SvtStartOptions_Impl::SvtStartOptions_Impl()
 194     // Init baseclasses first
 195     :   ConfigItem                      ( ROOTNODE_START        )
 196     // Init member then.
 197     ,   m_bShowIntro            ( DEFAULT_SHOWINTRO     )
 198 {
 199     // Use our static list of configuration keys to get his values.
 200     Sequence< OUString >        seqNames        = impl_GetPropertyNames();
 201     Sequence< Any >                     seqValues       = GetProperties( seqNames )     ;
 202
 203     // Safe impossible cases.
 204     // We need values from ALL configuration keys.
 205     // Follow assignment use order of values in relation to our list of key names!
 206     DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nI miss some values of configuration keys!\n" );
 207
 208     // Copy values from list in right order to ouer internal member.
 209     sal_Int32 nPropertyCount    =       seqValues.getLength()   ;
 210     sal_Int32 nProperty                 =       0                                               ;
 211     for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
 212     {
 213         // Safe impossible cases.
 214         // Check any for valid value.
 215         DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nInvalid property value for property detected!\n" );
 216         switch( nProperty )
 217         {
 218             case PROPERTYHANDLE_SHOWINTRO               :       {
 219                                                             DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nWho has changed the value type of \"Office.Common\\Start\\ShowIntro\"?" );
 220                                                         seqValues[nProperty] >>= m_bShowIntro;
 221                                                     }
 222                                                     break;
 223
 224             case PROPERTYHANDLE_CONNECTIONURL   :       {
 225                                                          DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_STRING), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nWho has changed the value type of \"Office.Common\\Start\\Connection\"?" );
 226                                                         seqValues[nProperty] >>= m_sConnectionURL;
 227                                                     }
 228                                                     break;
 229         }
 230     }
 231
 232     // Don't enable notification mechanism of ouer baseclass!
 233     // We support readonly variables in the moment.
 234 }
 235
 236 //*****************************************************************************************************************
 237 //      destructor
 238 //*****************************************************************************************************************
 239 SvtStartOptions_Impl::~SvtStartOptions_Impl()
 240 {
 241     // We must save our current values .. if user forget it!
 242     if( IsModified() == sal_True )
 243     {
 244         Commit();
 245     }
 246 }
 247
 248 //*****************************************************************************************************************
 249 //      public method
 250 //*****************************************************************************************************************
 251 void SvtStartOptions_Impl::Notify( const Sequence< OUString >& seqPropertyNames )
 252 {
 253     // Use given list of updated properties to get his values from configuration directly!
 254     Sequence< Any > seqValues = GetProperties( seqPropertyNames );
 255     // Safe impossible cases.
 256     // We need values from ALL notified configuration keys.
 257     DBG_ASSERT( !(seqPropertyNames.getLength()!=seqValues.getLength()), "SvtStartOptions_Impl::Notify()\nI miss some values of configuration keys!\n" );
 258     // Step over list of property names and get right value from coreesponding value list to set it on internal members!
 259     sal_Int32 nCount = seqPropertyNames.getLength();
 260     for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
 261     {
 262         if( seqPropertyNames[nProperty] == PROPERTYNAME_SHOWINTRO )
 263         {
 264             DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtStartOptions_Impl::Notify()\nWho has changed the value type of \"Office.Common\\Start\\ShowIntro\"?" );
 265             seqValues[nProperty] >>= m_bShowIntro;
 266         }
 267         else
 268         if( seqPropertyNames[nProperty] == PROPERTYNAME_CONNECTIONURL )
 269         {
 270             DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_STRING), "SvtStartOptions_Impl::Notify()\nWho has changed the value type of \"Office.Common\\Start\\Connection\"?" );
 271             seqValues[nProperty] >>= m_sConnectionURL;
 272         }
 273         #if OSL_DEBUG_LEVEL > 1
 274         else DBG_ASSERT( sal_False, "SvtStartOptions_Impl::Notify()\nUnkown property detected ... I can't handle these!\n" );
 275         #endif
 276     }
 277 }
 278
 279 //*****************************************************************************************************************
 280 //      public method
 281 //*****************************************************************************************************************
 282 void SvtStartOptions_Impl::Commit()
 283 {
 284     // Get names of supported properties, create a list for values and copy current values to it.
 285     Sequence< OUString >        seqNames        = impl_GetPropertyNames();
 286     sal_Int32                           nCount          = seqNames.getLength();
 287     Sequence< Any >                     seqValues       ( nCount );
 288     for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
 289     {
 290         switch( nProperty )
 291         {
 292             case PROPERTYHANDLE_SHOWINTRO               :       {
 293                                                          seqValues[nProperty] <<= m_bShowIntro;
 294                                                      }
 295                                                      break;
 296             case PROPERTYHANDLE_CONNECTIONURL   :       {
 297                                                          seqValues[nProperty] <<= m_sConnectionURL;
 298                                                      }
 299                                                      break;
 300         }
 301     }
 302     // Set properties in configuration.
 303     PutProperties( seqNames, seqValues );
 304 }
 305
 306 //*****************************************************************************************************************
 307 //      public method
 308 //*****************************************************************************************************************
 309 sal_Bool SvtStartOptions_Impl::IsIntroEnabled() const
 310 {
 311     return m_bShowIntro;
 312 }
 313
 314 //*****************************************************************************************************************
 315 //      public method
 316 //*****************************************************************************************************************
 317 void SvtStartOptions_Impl::EnableIntro( sal_Bool bState )
 318 {
 319     m_bShowIntro = bState;
 320     SetModified();
 321 }
 322
 323 //*****************************************************************************************************************
 324 //      public method
 325 //*****************************************************************************************************************
 326 OUString SvtStartOptions_Impl::GetConnectionURL() const
 327 {
 328     return m_sConnectionURL;
 329 }
 330
 331 //*****************************************************************************************************************
 332 //      public method
 333 //*****************************************************************************************************************
 334 void SvtStartOptions_Impl::SetConnectionURL( const OUString& sURL )
 335 {
 336     m_sConnectionURL = sURL;
 337     SetModified();
 338 }
 339
 340 //*****************************************************************************************************************
 341 //      private method
 342 //*****************************************************************************************************************
 343 Sequence< OUString > SvtStartOptions_Impl::impl_GetPropertyNames()
 344 {
 345     // Build static list of configuration key names.
 346     static const OUString pProperties[] =
 347     {
 348         PROPERTYNAME_SHOWINTRO          ,
 349         PROPERTYNAME_CONNECTIONURL      ,
 350     };
 351     // Initialize return sequence with these list ...
 352     static const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
 353     // ... and return it.
 354     return seqPropertyNames;
 355 }
 356
 357 //*****************************************************************************************************************
 358 //      initialize static member
 359 //      DON'T DO IT IN YOUR HEADER!
 360 //      see definition for further informations
 361 //*****************************************************************************************************************
 362 SvtStartOptions_Impl*   SvtStartOptions::m_pDataContainer       = NULL  ;
 363 sal_Int32                               SvtStartOptions::m_nRefCount            = 0             ;
 364
 365 //*****************************************************************************************************************
 366 //      constructor
 367 //*****************************************************************************************************************
 368 SvtStartOptions::SvtStartOptions()
 369 {
 370     // Global access, must be guarded (multithreading!).
 371     MutexGuard aGuard( GetOwnStaticMutex() );
 372     // Increase ouer refcount ...
 373     ++m_nRefCount;
 374     // ... and initialize ouer data container only if it not already!
 375     if( m_pDataContainer == NULL )
 376     {
 377         RTL_LOGFILE_CONTEXT(aLog, "svtools ( ??? ) ::SvtStartOptions_Impl::ctor()");
 378         m_pDataContainer = new SvtStartOptions_Impl();
 379
 380         ItemHolder1::holdConfigItem(E_STARTOPTIONS);
 381     }
 382 }
 383
 384 //*****************************************************************************************************************
 385 //      destructor
 386 //*****************************************************************************************************************
 387 SvtStartOptions::~SvtStartOptions()
 388 {
 389     // Global access, must be guarded (multithreading!)
 390     MutexGuard aGuard( GetOwnStaticMutex() );
 391     // Decrease ouer refcount.
 392     --m_nRefCount;
 393     // If last instance was deleted ...
 394     // we must destroy ouer static data container!
 395     if( m_nRefCount <= 0 )
 396     {
 397         delete m_pDataContainer;
 398         m_pDataContainer = NULL;
 399     }
 400 }
 401
 402 //*****************************************************************************************************************
 403 //      public method
 404 //*****************************************************************************************************************
 405 sal_Bool SvtStartOptions::IsIntroEnabled() const
 406 {
 407     MutexGuard aGuard( GetOwnStaticMutex() );
 408     return m_pDataContainer->IsIntroEnabled();
 409 }
 410
 411 //*****************************************************************************************************************
 412 //      public method
 413 //*****************************************************************************************************************
 414 void SvtStartOptions::EnableIntro( sal_Bool bState )
 415 {
 416     MutexGuard aGuard( GetOwnStaticMutex() );
 417     m_pDataContainer->EnableIntro( bState );
 418 }
 419
 420 //*****************************************************************************************************************
 421 //      public method
 422 //*****************************************************************************************************************
 423 OUString SvtStartOptions::GetConnectionURL() const
 424 {
 425     MutexGuard aGuard( GetOwnStaticMutex() );
 426     return m_pDataContainer->GetConnectionURL();
 427 }
 428
 429 //*****************************************************************************************************************
 430 //      public method
 431 //*****************************************************************************************************************
 432 void SvtStartOptions::SetConnectionURL( const OUString& sURL )
 433 {
 434     MutexGuard aGuard( GetOwnStaticMutex() );
 435     m_pDataContainer->SetConnectionURL( sURL );
 436 }
 437
 438 //*****************************************************************************************************************
 439 //      private method
 440 //*****************************************************************************************************************
 441 Mutex& SvtStartOptions::GetOwnStaticMutex()
 442 {
 443     // Initialize static mutex only for one time!
 444     static Mutex* pMutex = NULL;
 445     // If these method first called (Mutex not already exist!) ...
 446     if( pMutex == NULL )
 447     {
 448         // ... we must create a new one. Protect follow code with the global mutex -
 449         // It must be - we create a static variable!
 450         MutexGuard aGuard( Mutex::getGlobalMutex() );
 451         // We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
 452         if( pMutex == NULL )
 453         {
 454             // Create the new mutex and set it for return on static variable.
 455             static Mutex aMutex;
 456             pMutex = &aMutex;
 457         }
 458     }
 459     // Return new created or already existing mutex object.
 460     return *pMutex;
 461 }