shell/source/backends/gconfbe/gconfbackend.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: gconfbackend.hxx,v $
  10  * $Revision: 1.8 $
  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 GCONFBACKEND_HXX_
  32 #define GCONFBACKEND_HXX_
  33
  34 #ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XSCHEMASUPPLIER_HPP_
  35 #include <com/sun/star/configuration/backend/XSingleLayerStratum.hpp>
  36 #endif
  37 #include <com/sun/star/lang/XInitialization.hpp>
  38 #include <com/sun/star/uno/XComponentContext.hpp>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40
  41 //#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  42 //#include <com/sun/star/lang/XMultiServiceFactory.hpp>
  43 //#endif // _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  44 #include <com/sun/star/configuration/InvalidBootstrapFileException.hpp>
  45 #include <com/sun/star/configuration/backend/CannotConnectException.hpp>
  46 #include <com/sun/star/configuration/backend/XBackendChangesNotifier.hpp>
  47 #include <cppuhelper/compbase3.hxx>
  48
  49 #ifndef INCLUDED_MAP
  50 #include <map>
  51 #define INCLUDED_MAP
  52 #endif
  53 //#ifndef _VOS_THREAD_HXX_
  54 //#include <vos/thread.hxx>
  55 //#endif
  56
  57 #include <gconf/gconf-client.h>
  58
  59
  60 namespace css = com::sun::star ;
  61 namespace uno = css::uno ;
  62 namespace lang = css::lang ;
  63 namespace backend = css::configuration::backend ;
  64
  65
  66 /** Structure containing the mapping between OOffice and Gconf keys.
  67     AlOO specifies whether the key is protected, if key is protected it
  68     can not be over riden in subsequent higher layers
  69 */
  70 struct keyMapping
  71 {
  72     keyMapping(){};
  73     rtl::OUString mOOName;
  74     rtl::OUString mOOType;
  75     rtl::OUString mGconfName;
  76     sal_Bool mbProtected;
  77 };
  78
  79 typedef keyMapping KeyMappingInfo;
  80 typedef std::multimap<rtl::OUString, KeyMappingInfo> KeyMappingTable;
  81
  82 /*Time Stamp mapping table used to store timestamps of updated components
  83   when a notification is recieved. It is needed as you cannot access gconf key
  84   timestamps via the Gconf api */
  85
  86 typedef std::multimap<rtl::OUString, rtl::OUString>  TSMappingTable;
  87
  88 //------------------------------------------------------------------------------
  89
  90 /*
  91 class ONotificationThread: public vos::OThread
  92 {
  93
  94
  95 public:
  96     ONotificationThread()
  97     {}
  98
  99     ~ONotificationThread()
 100     {
 101         g_main_loop_quit(mLoop);
 102     }
 103
 104 private:
 105     virtual void SAL_CALL onTerminated()
 106     {
 107         delete this;
 108     }
 109
 110     virtual void SAL_CALL run();
 111     GMainLoop* mLoop;
 112 };
 113
 114 */
 115
 116 //------------------------------------------------------------------------------
 117 typedef cppu::WeakComponentImplHelper3<backend::XSingleLayerStratum,
 118                                        backend::XBackendChangesNotifier,
 119                        lang::XServiceInfo> BackendBase ;
 120
 121 /**
 122   Implements the SingleLayerStratum service for gconf access.
 123   */
 124 class GconfBackend : public BackendBase {
 125     public :
 126
 127     static GconfBackend* createInstance(const uno::Reference<uno::XComponentContext>& xContext);
 128
 129         // XServiceInfo
 130         virtual rtl::OUString SAL_CALL getImplementationName(  )
 131             throw (uno::RuntimeException) ;
 132
 133         virtual sal_Bool SAL_CALL supportsService( const rtl::OUString& aServiceName )
 134             throw (uno::RuntimeException) ;
 135
 136         virtual uno::Sequence<rtl::OUString> SAL_CALL getSupportedServiceNames(  )
 137             throw (uno::RuntimeException) ;
 138
 139         /**
 140           Provides the implementation name.
 141
 142           @return   implementation name
 143           */
 144         static rtl::OUString SAL_CALL getBackendName(void) ;
 145
 146         /**
 147           Provides the supported services names
 148
 149           @return   service names
 150           */
 151         static uno::Sequence<rtl::OUString> SAL_CALL getBackendServiceNames(void) ;
 152
 153         /* returns a GconfClient */
 154         static GConfClient* getGconfClient();
 155
 156         //XSingleLayerStratum
 157         virtual uno::Reference<backend::XLayer> SAL_CALL
 158             getLayer( const rtl::OUString& aLayerId, const rtl::OUString& aTimestamp )
 159                 throw (backend::BackendAccessException, lang::IllegalArgumentException) ;
 160
 161         virtual uno::Reference<backend::XUpdatableLayer> SAL_CALL
 162             getUpdatableLayer( const rtl::OUString& aLayerId )
 163                 throw (backend::BackendAccessException, lang::NoSupportException,
 164                        lang::IllegalArgumentException) ;
 165
 166         // XBackendChangesNotifier
 167         virtual void SAL_CALL addChangesListener(
 168             const uno::Reference<backend::XBackendChangesListener>& xListener,
 169             const rtl::OUString& aComponent)
 170                 throw (::com::sun::star::uno::RuntimeException);
 171
 172
 173         virtual void SAL_CALL removeChangesListener(
 174             const uno::Reference<backend::XBackendChangesListener>& xListener,
 175             const rtl::OUString& aComponent)
 176                 throw (::com::sun::star::uno::RuntimeException);
 177
 178         //Notify all listener of component change
 179         void notifyListeners(const rtl::OUString& aGconfKey);
 180
 181     protected:
 182         /**
 183           Service constructor from a service factory.
 184
 185           @param xContext   component context
 186           */
 187          GconfBackend(const uno::Reference<uno::XComponentContext>& xContext)
 188             throw (backend::BackendAccessException);
 189
 190         /** Destructor */
 191         ~GconfBackend(void) ;
 192
 193     private:
 194
 195         typedef uno::Reference<backend::XBackendChangesListener> ListenerRef;
 196         typedef std::multimap<rtl::OUString,ListenerRef> ListenerList;
 197
 198         /** Build Gconf/OO mapping table */
 199         void initializeMappingTable ();
 200
 201
 202         /** The component context */
 203         uno::Reference<uno::XComponentContext> m_xContext;
 204
 205         /** Mutex for reOOurces protection */
 206         osl::Mutex mMutex ;
 207
 208         KeyMappingTable mKeyMap;
 209
 210         /** List of component TimeStamps */
 211         TSMappingTable mTSMap;
 212
 213         static GconfBackend* mInstance;
 214
 215         /** List of listener */
 216         ListenerList mListenerList;
 217
 218         /**Connection to Gconf */
 219         static GConfClient* mClient;
 220
 221 //       ONotificationThread* mNotificationThread;
 222 } ;
 223
 224
 225 #endif // CONFIGMGR_LOCALBE_LOCALSINGLESTRATUM_HXX_