INTEGRATION: CWS cfg04 (1.1.2); FILE ADDED

2004/02/13 13:54:20 ssmith 1.1.2.6: #114070# adding notification support
2004/02/12 10:10:39 ssmith 1.1.2.5: #114070# adding notification thread
2004/02/06 11:25:09 ssmith 1.1.2.4: #114070# adding notification support
2004/02/03 14:59:33 ssmith 1.1.2.3: #114070# updating gconf impl
2004/02/02 10:26:40 ssmith 1.1.2.2: #114070# adding gconf calls
2004/01/29 11:27:14 ssmith 1.1.2.1: #114070# gconfbe ref imp

1 files changed, 294 insertions, 0 deletions

diff --git a/shell/source/backends/gconfbe/gconfbackend.hxx b/shell/source/backends/gconfbe/gconfbackend.hxx
new file mode 100644
index 000000000000..497aa262d3f2
--- /dev/null
+++ b/shell/source/backends/gconfbe/gconfbackend.hxx
@@ -0,0 +1,294 @@
+/*************************************************************************
+ *
+ *  $RCSfile: gconfbackend.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-03-30 15:05:16 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards OOurce License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free OOftware; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free OOftware Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free OOftware
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards OOurce License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  OOurce License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  OOftware provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE OOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the OOftware.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef GCONFBACKEND_HXX_
+#define GCONFBACKEND_HXX_
+
+#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XSCHEMASUPPLIER_HPP_
+#include <com/sun/star/configuration/backend/XSingleLayerStratum.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
+#include <com/sun/star/lang/XInitialization.hpp>
+#endif // _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_
+#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
+#include <com/sun/star/uno/XComponentContext.hpp>
+#endif
+#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#endif // _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
+
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif // _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+
+#ifndef _COM_SUN_STAR_CONFIGURATION_INVALIDBOOTSTRAPFILEEXCEPTION_HPP_
+#include <com/sun/star/configuration/InvalidBootstrapFileException.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_CANNOTCONNECTEXCEPTION_HPP_
+#include <com/sun/star/configuration/backend/CannotConnectException.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XBACKENDCHANGESNOTIFIER_HPP_
+#include <com/sun/star/configuration/backend/XBackendChangesNotifier.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_UCB_XSIMPLEFILEACCESS_HPP_
+#include <com/sun/star/ucb/XSimpleFileAccess.hpp>
+#endif
+
+#ifndef _CPPUHELPER_COMPBASE3_HXX_
+#include <cppuhelper/compbase3.hxx>
+#endif // _CPPUHELPER_COMPBASE3_HXX_
+
+#ifndef _OSL_FILE_HXX_
+#include <osl/file.hxx>
+#endif
+
+#ifndef INCLUDED_MAP
+#include <map>
+#define INCLUDED_MAP
+#endif
+#ifndef _VOS_THREAD_HXX_
+#include <vos/thread.hxx>
+#endif
+
+#include <gconf/gconf-client.h>
+
+
+namespace css = com::sun::star ;
+namespace uno = css::uno ;
+namespace lang = css::lang ;
+namespace ucb = css::ucb;
+namespace backend = css::configuration::backend ;
+
+
+#define SYSTEMBE_INIFILE                   SAL_CONFIGFILE("systembe")
+
+/** Structure containing the mapping between OOffice and Gconf keys.
+    AlOO specifies whether the key is protected, if key is protected it
+    can not be over riden in subsequent higher layers
+ */
+struct keyMapping
+{
+
+    keyMapping(){};
+
+    rtl::OUString mOOName;
+    rtl::OUString mOOType;
+    rtl::OUString mGconfName;
+    sal_Bool mbProtected;
+
+};
+
+typedef keyMapping KeyMappingInfo;
+typedef std::multimap<rtl::OUString, KeyMappingInfo> KeyMappingTable;
+
+/*Time Stamp mapping table used to store timestamps of updated components
+  when a notification is recieved. It is needed as you cannot access gconf key
+  timestamps via the Gconf api */
+typedef std::multimap<rtl::OUString, rtl::OUString>  TSMappingTable;
+//------------------------------------------------------------------------------
+class ONotificationThread: public vos::OThread
+{
+
+
+public:
+    ONotificationThread()
+    {}
+
+    ~ONotificationThread()
+    {
+        g_main_loop_quit(mLoop);
+    }
+
+private:
+    virtual void SAL_CALL onTerminated()
+    {
+        delete this;
+    }
+
+    virtual void SAL_CALL run();
+    GMainLoop* mLoop;
+};
+
+
+
+//------------------------------------------------------------------------------
+typedef cppu::WeakComponentImplHelper3<backend::XSingleLayerStratum,
+                                       backend::XBackendChangesNotifier,
+                                       lang::XServiceInfo> BackendBase ;
+
+/**
+  Implements the SingleLayerStratum service for gconf access.
+  */
+class GconfBackend : public BackendBase {
+    public :
+
+        static GconfBackend* createGconfInstance(
+             const uno::Reference<uno::XComponentContext>& xContext);
+
+        /** Destructor */
+        ~GconfBackend(void) ;
+
+        // XServiceInfo
+        virtual rtl::OUString SAL_CALL
+            getImplementationName(  )
+                throw (uno::RuntimeException) ;
+
+        virtual sal_Bool SAL_CALL
+            supportsService( const rtl::OUString& aServiceName )
+                throw (uno::RuntimeException) ;
+
+        virtual uno::Sequence<rtl::OUString> SAL_CALL
+            getSupportedServiceNames(  )
+                throw (uno::RuntimeException) ;
+
+        /**
+          Provides the implementation name.
+
+          @return   implementation name
+          */
+        static rtl::OUString SAL_CALL getGconfBackendName(void) ;
+        /**
+          Provides the supported services names
+
+          @return   service names
+          */
+        static uno::Sequence<rtl::OUString> SAL_CALL getGconfBackendServiceNames(void) ;
+        /**
+          Provide the current module directory
+
+          @return current module directory
+        */
+        static rtl::OUString getCurrentModuleDirectory();
+
+        /* returns a GconfClient */
+        static GConfClient* getGconfClient();
+
+        //XSingleLayerStratum
+        virtual uno::Reference<backend::XLayer> SAL_CALL
+        getLayer( const rtl::OUString& aLayerId, const rtl::OUString& aTimestamp )
+            throw (backend::BackendAccessException,
+                   lang::IllegalArgumentException) ;
+
+        virtual uno::Reference<backend::XUpdatableLayer> SAL_CALL
+        getUpdatableLayer( const rtl::OUString& aLayerId )
+            throw (backend::BackendAccessException,
+                   lang::NoSupportException,
+                   lang::IllegalArgumentException) ;
+
+        // XBackendChangesNotifier
+        virtual void SAL_CALL addChangesListener(
+            const uno::Reference<backend::XBackendChangesListener>& xListener,
+            const rtl::OUString& aComponent)
+            throw (::com::sun::star::uno::RuntimeException);
+
+
+        virtual void SAL_CALL removeChangesListener(
+            const uno::Reference<backend::XBackendChangesListener>& xListener,
+            const rtl::OUString& aComponent)
+            throw (::com::sun::star::uno::RuntimeException);
+
+        //Notify all listener of component change
+        void notifyListeners(const rtl::OUString& aGconfKey);
+    protected:
+        /**
+          Service constructor from a service factory.
+
+          @param xContext   component context
+          */
+         GconfBackend(const uno::Reference<uno::XComponentContext>& xContext)
+            throw (backend::BackendAccessException);
+    private:
+
+        typedef uno::Reference<backend::XBackendChangesListener> ListenerRef;
+        typedef std::multimap<rtl::OUString,ListenerRef> ListenerList;
+
+        /** Build Gconf/OO mapping table */
+        void initializeMappingTable ();
+
+        uno::Reference<lang::XMultiServiceFactory> mFactory;
+
+        /** Mutex for reOOurces protection */
+        osl::Mutex mMutex ;
+
+        KeyMappingTable mKeyMap;
+
+        /** List of component TimeStamps */
+        TSMappingTable mTSMap;
+
+        static GconfBackend* mInstance;
+
+        /** List of listener */
+        ListenerList mListenerList;
+
+        /**Connection to Gconf */
+        static GConfClient* mClient;
+
+       ONotificationThread* mNotificationThread;
+
+
+} ;
+
+
+#endif // CONFIGMGR_LOCALBE_LOCALSINGLESTRATUM_HXX_