dbaccess/source/core/dataaccess/ModelImpl.hxx

   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: ModelImpl.hxx,v $
  10  * $Revision: 1.24.26.1 $
  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 #ifndef _DBA_COREDATAACCESS_MODELIMPL_HXX_
  32 #define _DBA_COREDATAACCESS_MODELIMPL_HXX_
  33
  34 #include "apitools.hxx"
  35 #include "bookmarkcontainer.hxx"
  36 #include "ContentHelper.hxx"
  37 #include "core_resource.hxx"
  38 #include "documentevents.hxx"
  39
  40 /** === begin UNO includes === **/
  41 #include <com/sun/star/beans/PropertyAttribute.hpp>
  42 #include <com/sun/star/beans/PropertyValue.hpp>
  43 #include <com/sun/star/beans/XPropertyAccess.hpp>
  44 #include <com/sun/star/container/XContainerListener.hpp>
  45 #include <com/sun/star/document/XDocumentSubStorageSupplier.hpp>
  46 #include <com/sun/star/document/XEventListener.hpp>
  47 #include <com/sun/star/document/XStorageBasedDocument.hpp>
  48 #include <com/sun/star/embed/ElementModes.hpp>
  49 #include <com/sun/star/embed/XStorage.hpp>
  50 #include <com/sun/star/embed/XTransactionListener.hpp>
  51 #include <com/sun/star/frame/XModel.hpp>
  52 #include <com/sun/star/frame/XStorable.hpp>
  53 #include <com/sun/star/lang/NotInitializedException.hpp>
  54 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  55 #include <com/sun/star/lang/XServiceInfo.hpp>
  56 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  57 #include <com/sun/star/sdb/XBookmarksSupplier.hpp>
  58 #include <com/sun/star/sdb/XCompletedConnection.hpp>
  59 #include <com/sun/star/sdb/XFormDocumentsSupplier.hpp>
  60 #include <com/sun/star/sdb/XQueryDefinitionsSupplier.hpp>
  61 #include <com/sun/star/sdb/XReportDocumentsSupplier.hpp>
  62 #include <com/sun/star/sdbc/XDataSource.hpp>
  63 #include <com/sun/star/sdbc/XIsolatedConnection.hpp>
  64 #include <com/sun/star/sdbcx/XTablesSupplier.hpp>
  65 #include <com/sun/star/util/XCloseable.hpp>
  66 #include <com/sun/star/util/XFlushable.hpp>
  67 #include <com/sun/star/util/XModifiable.hpp>
  68 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  69 #include <com/sun/star/util/XNumberFormatter.hpp>
  70 #include <com/sun/star/util/XRefreshable.hpp>
  71 #include <com/sun/star/sdb/XDocumentDataSource.hpp>
  72 #include <com/sun/star/frame/DoubleInitializationException.hpp>
  73 /** === end UNO includes === **/
  74
  75 #include <comphelper/broadcasthelper.hxx>
  76 #include <comphelper/proparrhlp.hxx>
  77 #include <comphelper/sharedmutex.hxx>
  78 #include <connectivity/CommonTools.hxx>
  79 #include <cppuhelper/propshlp.hxx>
  80 #include <cppuhelper/weakref.hxx>
  81 #include <sfx2/docmacromode.hxx>
  82 #include <sfx2/docstoragemodifylistener.hxx>
  83 #include <tools/string.hxx>
  84 #include <unotools/sharedunocomponent.hxx>
  85 #include <vos/mutex.hxx>
  86
  87 #include <memory>
  88
  89 namespace comphelper
  90 {
  91     class NamedValueCollection;
  92 }
  93
  94 //........................................................................
  95 namespace dbaccess
  96 {
  97 //........................................................................
  98
  99 typedef ::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XConnection > OWeakConnection;
 100 typedef std::vector< OWeakConnection > OWeakConnectionArray;
 101
 102 struct AsciiPropertyValue
 103 {
 104     // note: the canonic member order would be AsciiName / DefaultValue, but
 105     // this crashes on unxlngi6.pro, since there's a bug which somehow results in
 106     // getDefaultDataSourceSettings returning corrupted Any instances then.
 107     ::com::sun::star::uno::Any  DefaultValue;
 108     const sal_Char*             AsciiName;
 109
 110     AsciiPropertyValue( const sal_Char* _pAsciiName, const ::com::sun::star::uno::Any& _rDefaultValue )
 111         :DefaultValue( _rDefaultValue )
 112         ,AsciiName( _pAsciiName )
 113     {
 114     }
 115 };
 116
 117 class ODatabaseContext;
 118 class OSharedConnectionManager;
 119
 120 //============================================================
 121 //= VosMutexFacade
 122 //============================================================
 123 /** a class which provides an IMutex interface to an OSL-based mutex
 124 */
 125 class VosMutexFacade : public ::vos::IMutex
 126 {
 127 public:
 128     /** beware of life time: the mutex you pass here must live as least as long
 129         as the VosMutexFacade instance lives.
 130     */
 131     VosMutexFacade( ::osl::Mutex& _rMutex );
 132
 133     // IMutex
 134     virtual void SAL_CALL acquire();
 135     virtual sal_Bool SAL_CALL tryToAcquire();
 136     virtual void SAL_CALL release();
 137
 138 private:
 139     ::osl::Mutex&   m_rMutex;
 140 };
 141
 142
 143 //============================================================
 144 //= ODatabaseModelImpl
 145 //============================================================
 146 DECLARE_STL_USTRINGACCESS_MAP(::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >,TStorages);
 147
 148 typedef ::utl::SharedUNOComponent< ::com::sun::star::embed::XStorage >  SharedStorage;
 149
 150 class ODatabaseContext;
 151 class DocumentStorageAccess;
 152 class OSharedConnectionManager;
 153 class ODatabaseModelImpl    :public ::rtl::IReference
 154                             ,public ::sfx2::IMacroDocumentAccess
 155                             ,public ::sfx2::IModifiableDocument
 156 {
 157 public:
 158     enum ObjectType
 159     {
 160         E_FORM   = 0,
 161         E_REPORT = 1,
 162         E_QUERY  = 2,
 163         E_TABLE  = 3
 164     };
 165
 166     enum EmbeddedMacros
 167     {
 168         // the database document (storage) itself contains macros
 169         eDocumentWideMacros,
 170         // there are sub document( storage)s containing macros
 171         eSubDocumentMacros,
 172         // there are no known macro( storage)s
 173         eNoMacros
 174     };
 175
 176 private:
 177     OModuleClient                                                               m_aModuleClient;
 178     ::com::sun::star::uno::WeakReference< ::com::sun::star::frame::XModel >         m_xModel;
 179     ::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XDataSource > m_xDataSource;
 180
 181     DocumentStorageAccess*                                                      m_pStorageAccess;
 182     ::comphelper::SharedMutex                                                   m_aMutex;
 183     VosMutexFacade                                                              m_aMutexFacade;
 184     ::std::vector< TContentPtr >                                                m_aContainer;   // one for each ObjectType
 185     TStorages                                                                                       m_aStorages;
 186     ::sfx2::DocumentMacroMode                                                   m_aMacroMode;
 187     sal_Int16                                                                   m_nImposedMacroExecMode;
 188
 189     ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer > m_xBasicLibraries;
 190     ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer > m_xDialogLibraries;
 191
 192     SharedStorage                                                               m_xDocumentStorage;
 193     ::rtl::Reference< ::sfx2::DocumentStorageModifyListener >                   m_pStorageModifyListener;
 194     ODatabaseContext*                                                                                           m_pDBContext;
 195     DocumentEventsData                                                          m_aDocumentEvents;
 196
 197     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >   m_aArgs;
 198     /// the URL the document was loaded from
 199     ::rtl::OUString                                                                                                     m_sDocFileLocation;
 200
 201     oslInterlockedCount                                                                 m_refCount;
 202
 203     /// do we have any object (forms/reports) which contains macros?
 204     ::boost::optional< EmbeddedMacros >                 m_aEmbeddedMacros;
 205
 206     /// true if setting the Modified flag of the document is currently locked
 207     bool                                                m_bModificationLock;
 208
 209     /// true if and only if a database document existed previously (though meanwhile disposed), and was already initialized
 210     bool                                                m_bDocumentInitialized;
 211
 212     /** the URL which the document should report as it's URL
 213
 214         This might differ from ->m_sDocFileLocation in case the document was loaded
 215         as part of a crash recovery process. In this case, ->m_sDocFileLocation points to
 216         the temporary file where the DB had been saved to, after a crash.
 217         ->m_sDocumentURL then is the URL of the document which actually had
 218         been recovered.
 219     */
 220     ::rtl::OUString                                     m_sDocumentURL;
 221
 222 public:
 223     OWeakConnectionArray                                                        m_aConnections;
 224     const ::comphelper::ComponentContext                                        m_aContext;
 225
 226 public:
 227     ::com::sun::star::uno::WeakReference< ::com::sun::star::container::XNameAccess >    m_xCommandDefinitions;
 228     ::com::sun::star::uno::WeakReference< ::com::sun::star::container::XNameAccess >    m_xTableDefinitions;
 229
 230     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >
 231                                                         m_xNumberFormatsSupplier;
 232     ::rtl::OUString                                                                             m_sConnectURL;
 233     ::rtl::OUString                                                                             m_sName;                // transient, our creator has to tell us the title
 234     ::rtl::OUString                                                                             m_sUser;
 235     ::rtl::OUString                                                                             m_aPassword;    // transient !
 236     ::rtl::OUString                                     m_sFailedPassword;
 237     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>
 238                                                         m_aLayoutInformation;
 239     sal_Int32                                           m_nLoginTimeout;
 240     sal_Bool                                                                                    m_bReadOnly : 1;
 241     sal_Bool                                                                                    m_bPasswordRequired : 1;
 242     sal_Bool                                                                                    m_bSuppressVersionColumns : 1;
 243     sal_Bool                                                                                    m_bModified : 1;
 244     sal_Bool                                                                                    m_bDocumentReadOnly : 1;
 245     sal_Bool                                                                                    m_bDisposingSubStorages;
 246     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyAccess >
 247                                                         m_xSettings;
 248     ::com::sun::star::uno::Sequence< ::rtl::OUString >  m_aTableFilter;
 249     ::com::sun::star::uno::Sequence< ::rtl::OUString >  m_aTableTypeFilter;
 250     OSharedConnectionManager*                                                   m_pSharedConnectionManager;
 251     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >
 252                                                         m_xSharedConnectionManager;
 253     sal_uInt16                                                                                  m_nControllerLockCount;
 254
 255     void reset();
 256
 257     /** determines whether the database document has an embedded data storage
 258     */
 259     inline bool isEmbeddedDatabase() const { return ( m_sConnectURL.compareToAscii( "sdbc:embedded:", 14 ) == 0 ); }
 260
 261     /** stores the embedded storage ("database")
 262
 263         @param _bPreventRootCommits
 264             Normally, committing the embedded storage results in also commiting the root storage
 265             - this is an automatism for data safety reasons.
 266             If you pass <TRUE/> here, committing the root storage is prevented for this particular
 267             call.
 268         @return <TRUE/> if the storage could be commited, otherwise <FALSE/>
 269     */
 270     sal_Bool    commitEmbeddedStorage( sal_Bool _bPreventRootCommits = sal_False );
 271
 272     /** commits all storages storages which have been obtained via getStorage
 273     */
 274     void commitStorages()
 275             SAL_THROW(( ::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException ));
 276
 277     ODatabaseModelImpl(
 278         const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory,
 279         ODatabaseContext& _pDBContext
 280     );
 281     virtual ~ODatabaseModelImpl();
 282
 283     ODatabaseModelImpl(
 284         const ::rtl::OUString& _rRegistrationName,
 285         const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory,
 286         ODatabaseContext& _rDBContext
 287         );
 288
 289     // XEventListener
 290     void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw(::com::sun::star::uno::RuntimeException);
 291
 292     void setModified( sal_Bool bModified );
 293
 294     void dispose();
 295
 296     inline ::rtl::OUString getURL() const               { return m_sDocumentURL;     }
 297     inline ::rtl::OUString getDocFileLocation() const   { return m_sDocFileLocation; }
 298
 299     ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage> getStorage(const ::rtl::OUString& _sStorageName,sal_Int32 nMode = ::com::sun::star::embed::ElementModes::READWRITE);
 300 // helper
 301     const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >&
 302             getNumberFormatsSupplier();
 303
 304     DocumentEventsData&
 305             getDocumentEvents() { return m_aDocumentEvents; }
 306
 307     const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >&
 308             getResource() const { return m_aArgs; }
 309
 310     void    attachResource(
 311                 const ::rtl::OUString& _rURL,
 312                 const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArgs );
 313
 314     static ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >
 315             stripLoadArguments( const ::comphelper::NamedValueCollection& _rArguments );
 316
 317 // other stuff
 318     void        flushTables();
 319
 320     // disposes all elements in m_aStorages, and clears it
 321     void    disposeStorages() SAL_THROW(());
 322
 323     /// creates a ->com::sun::star::embed::StorageFactory
 324     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory >
 325             createStorageFactory() const;
 326
 327     /// commits our storage
 328     void    commitRootStorage();
 329
 330     /// commits a given storage if it's not readonly
 331     static  bool    commitStorageIfWriteable(
 332                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
 333             )
 334             SAL_THROW((
 335                 ::com::sun::star::io::IOException,
 336                 ::com::sun::star::lang::WrappedTargetException,
 337                 ::com::sun::star::uno::RuntimeException
 338             ));
 339
 340     /// commits a given storage if it's not readonly, ignoring (but asserting) all errors
 341     static  bool    commitStorageIfWriteable_ignoreErrors(
 342                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
 343             )
 344             SAL_THROW(());
 345
 346     void clearConnections();
 347
 348             ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getOrCreateRootStorage();
 349     inline  ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getRootStorage() const { return m_xDocumentStorage.getTyped(); }
 350     inline  void resetRootStroage() { impl_switchToStorage_throw( NULL ); }
 351
 352     /** returns the data source. If it doesn't exist it will be created
 353     */
 354     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource> getOrCreateDataSource();
 355
 356     /** returns the model, if there already exists one
 357     */
 358     ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > getModel_noCreate() const;
 359
 360     /** returns a new ->ODatabaseDocument
 361
 362         @param _bInitializeIfNecessary
 363             calls XLoadable::initNew on the newly created model, if necessary
 364
 365         @precond
 366             No ->ODatabaseDocument exists so far
 367
 368         @seealso
 369             getModel_noCreate
 370     */
 371     ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > createNewModel_deliverOwnership( bool _bInitialize );
 372
 373     struct ResetModelAccess { friend class ODatabaseDocument; private: ResetModelAccess() { } };
 374
 375     /** resets the model to NULL
 376
 377         Only to be called when the model is being disposed
 378     */
 379     void    modelIsDisposing( const bool _wasInitialized, ResetModelAccess );
 380
 381     bool    hadInitializedDocument() const { return m_bDocumentInitialized; }
 382
 383     DocumentStorageAccess*
 384             getDocumentStorageAccess();
 385
 386     ::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentSubStorageSupplier >
 387             getDocumentSubStorageSupplier();
 388
 389     inline const ::comphelper::SharedMutex& getSharedMutex() const { return m_aMutex; }
 390
 391     /** @see osl_incrementInterlockedCount.
 392      */
 393     virtual oslInterlockedCount SAL_CALL acquire();
 394
 395     /** @see osl_decrementInterlockedCount.
 396      */
 397     virtual oslInterlockedCount SAL_CALL release();
 398
 399     /// returns a all known data source settings, including their default values
 400     static const AsciiPropertyValue* getDefaultDataSourceSettings();
 401
 402     /** retrieves the requested container of objects (forms/reports/tables/queries)
 403     */
 404     TContentPtr&    getObjectContainer( const ObjectType _eType );
 405
 406     /** determines whether the given storage is the storage of our embedded database (named "database"), if any
 407     */
 408     bool            isDatabaseStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage ) const;
 409
 410     /** returns the name of the storage which is used to stored objects of the given type, if applicable
 411     */
 412     static ::rtl::OUString
 413                     getObjectContainerStorageName( const ObjectType _eType );
 414
 415     /** revokes the data source registration at the database context
 416     */
 417     void            revokeDataSource() const;
 418
 419     /** determines whether a given object storage contains macros
 420     */
 421     static bool     objectHasMacros(
 422                         const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxContainerStorage,
 423                         const ::rtl::OUString& _rPersistentName
 424                     );
 425
 426     /** determines which kind of embedded macros are present in the document
 427     */
 428     EmbeddedMacros  determineEmbeddedMacros();
 429
 430     /** checks our document's macro execution mode, using the interaction handler as supplied with our
 431         load arguments
 432     */
 433     bool            checkMacrosOnLoading();
 434
 435     /** adjusts our document's macro execution mode, without using any UI, assuming the user
 436         would reject execution of macros, if she would have been asked.
 437
 438         If checkMacrosOnLoading has been called before (and thus the macro execution mode
 439         is already adjusted), then the current execution mode is simply returned.
 440
 441         @return
 442             whether or not macro execution is allowed
 443     */
 444     bool            adjustMacroMode_AutoReject();
 445
 446     /** resets our macro execute mode, so next time  the checkMacrosOnLoading is called, it will
 447         behave as if it has never been called before
 448     */
 449     void            resetMacroExecutionMode();
 450
 451     /** ensures that ->m_xBasicLibraries resp. m_xDialogLibraries exists
 452
 453         @return
 454             the requested library container. Is never <NULL/>.
 455
 456         @throws RuntimeException
 457             if something does wrong, which indicates a server error in the installation
 458     */
 459     ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer >
 460             getLibraryContainer( bool _bScript );
 461
 462     /** lets our library containers store themself into the given root storage
 463     */
 464     void    storeLibraryContainersTo( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxToRootStorage );
 465
 466     /** rebases the document to the given storage
 467
 468         No actual committing, copying, saving, whatsoever happens. The storage is just remembered as the documents
 469         new storage, nothing more.
 470
 471         @throws ::com::sun::star::lang::IllegalArgumentException
 472             if the given storage is <NULL/>
 473         @throws ::com::sun::star::lang::RuntimeException
 474             if any of the invoked operations does so
 475     */
 476     ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
 477             switchToStorage(
 478                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxNewRootStorage
 479             );
 480
 481     /** switches to the given document location/URL
 482
 483         The document location is the URL of the file from which the document has been loaded.
 484         The document URL is the "intended location" of the document. It differs from the location
 485         if and only if the document was loaded as part of a document recovery process. In this case,
 486         the location points to some temporary file, but the URL is the URL of the file which has been
 487         just recovered. The next store operation would operate on the URL, not the location.
 488     */
 489     void    switchToURL(
 490                 const ::rtl::OUString& _rDocumentLocation,
 491                 const ::rtl::OUString& _rDocumentURL
 492             );
 493
 494     /** returns the macro mode imposed by an external instance, which passed it to attachResource
 495     */
 496     sal_Int16       getImposedMacroExecMode() const
 497     {
 498         return m_nImposedMacroExecMode;
 499     }
 500     void            setImposedMacroExecMode( const sal_Int16 _nMacroMode )
 501     {
 502         m_nImposedMacroExecMode = _nMacroMode;
 503     }
 504
 505 public:
 506     // IMacroDocumentAccess overridables
 507     virtual sal_Int16 getCurrentMacroExecMode() const;
 508     virtual sal_Bool setCurrentMacroExecMode( sal_uInt16 );
 509     virtual ::rtl::OUString getDocumentLocation() const;
 510     virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getZipStorageToSign();
 511     virtual sal_Bool documentStorageHasMacros() const;
 512     virtual ::com::sun::star::uno::Reference< ::com::sun::star::document::XEmbeddedScripts > getEmbeddedDocumentScripts() const;
 513     virtual sal_Int16 getScriptingSignatureState();
 514     virtual sal_Bool hasTrustedScriptingSignature( sal_Bool bAllowUIToAddAuthor );
 515     virtual void showBrokenSignatureWarning( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxInteraction ) const;
 516
 517     // IModifiableDocument
 518     virtual void storageIsModified();
 519
 520     // don't use directly, use the ModifyLock class instead
 521     void    lockModify()              { m_bModificationLock = true; }
 522     void    unlockModify()            { m_bModificationLock = false; }
 523     bool    isModifyLocked() const    { return m_bModificationLock; }
 524
 525 private:
 526     void    impl_construct_nothrow();
 527     ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
 528             impl_switchToStorage_throw( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxNewRootStorage );
 529 };
 530
 531 /** a small base class for UNO components whose functionality depends on a ODatabaseModelImpl
 532 */
 533 class ModelDependentComponent
 534 {
 535 protected:
 536     ::rtl::Reference< ODatabaseModelImpl >  m_pImpl;
 537     mutable ::comphelper::SharedMutex       m_aMutex;
 538
 539 protected:
 540     ModelDependentComponent( const ::rtl::Reference< ODatabaseModelImpl >& _model );
 541     virtual ~ModelDependentComponent();
 542
 543     /** returns the component itself
 544     */
 545     virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getThis() const = 0;
 546
 547     inline ::osl::Mutex& getMutex() const
 548     {
 549         return m_aMutex;
 550     }
 551
 552 public:
 553     struct GuardAccess { friend class ModelMethodGuard; private: GuardAccess() { } };
 554
 555     /** returns the mutex used for thread safety
 556
 557         @throws ::com::sun::star::lang::DisposedException
 558             if m_pImpl is <NULL/>. Usually, you will set this member in your derived
 559             component's <code>dispose</code> method to <NULL/>.
 560     */
 561     inline ::osl::Mutex& getMutex( GuardAccess ) const
 562     {
 563         return getMutex();
 564     }
 565     inline ::rtl::Reference< ODatabaseModelImpl > getImpl( GuardAccess )
 566     {
 567         return m_pImpl;
 568     }
 569
 570     /// checks whether the component is already disposed, throws a DisposedException if so
 571     inline void checkDisposed() const
 572     {
 573         if ( !m_pImpl.is() )
 574             throw ::com::sun::star::lang::DisposedException( ::rtl::OUString::createFromAscii( "Component is already disposed." ), getThis() );
 575     }
 576
 577     inline void lockModify()
 578     {
 579         m_pImpl->lockModify();
 580     }
 581
 582     inline void unlockModify()
 583     {
 584         m_pImpl->unlockModify();
 585     }
 586 };
 587
 588 class ModifyLock
 589 {
 590 public:
 591     ModifyLock( ModelDependentComponent& _component )
 592         :m_rComponent( _component )
 593     {
 594         m_rComponent.lockModify();
 595     }
 596
 597     ~ModifyLock()
 598     {
 599         m_rComponent.unlockModify();
 600     }
 601
 602 private:
 603     ModelDependentComponent&    m_rComponent;
 604 };
 605
 606 /** a guard for public methods of objects dependent on a ODatabaseModelImpl instance
 607
 608     Just put this guard onto the stack at the beginning of your method. Don't bother yourself
 609     with a MutexGuard, checks for being disposed, and the like.
 610 */
 611 class ModelMethodGuard : public ::osl::ResettableMutexGuard
 612 {
 613 private:
 614     typedef ::osl::ResettableMutexGuard             BaseMutexGuard;
 615
 616 public:
 617     /** constructs the guard
 618
 619         @param _component
 620             the component whose functionality depends on a ODatabaseModelImpl instance
 621
 622         @throws ::com::sun::star::lang::DisposedException
 623             If the given component is already disposed
 624     */
 625     ModelMethodGuard( const ModelDependentComponent& _component )
 626         :BaseMutexGuard( _component.getMutex( ModelDependentComponent::GuardAccess() ) )
 627     {
 628         _component.checkDisposed();
 629     }
 630
 631     ~ModelMethodGuard()
 632     {
 633     }
 634 };
 635
 636 //........................................................................
 637 }       // namespace dbaccess
 638 //........................................................................
 639
 640 #endif // _DBA_COREDATAACCESS_DATALINK_HXX_
 641