dbaccess/source/core/inc/ContentHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_DBACCESS_SOURCE_CORE_INC_CONTENTHELPER_HXX
  20 #define INCLUDED_DBACCESS_SOURCE_CORE_INC_CONTENTHELPER_HXX
  21
  22 #include <com/sun/star/ucb/XContent.hpp>
  23 #include <com/sun/star/ucb/XCommandProcessor.hpp>
  24 #include <com/sun/star/beans/XPropertiesChangeNotifier.hpp>
  25 #include <com/sun/star/beans/XPropertyContainer.hpp>
  26 #include <com/sun/star/lang/XServiceInfo.hpp>
  27 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  28 #include <com/sun/star/lang/XInitialization.hpp>
  29 #include <com/sun/star/container/XNameAccess.hpp>
  30 #include <com/sun/star/sdbc/XRow.hpp>
  31 #include <com/sun/star/embed/XStorage.hpp>
  32 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  33 #include <com/sun/star/lang/XUnoTunnel.hpp>
  34 #include <cppuhelper/compbase9.hxx>
  35 #include <comphelper/broadcasthelper.hxx>
  36 #include <comphelper/uno3.hxx>
  37 #include <com/sun/star/beans/Property.hpp>
  38 #include <com/sun/star/container/XChild.hpp>
  39 #include <com/sun/star/sdbcx/XRename.hpp>
  40 #include <connectivity/sqlerror.hxx>
  41 #include <boost/shared_ptr.hpp>
  42
  43 namespace com { namespace sun { namespace star { namespace beans {
  44     struct PropertyValue;
  45 } } } }
  46
  47 namespace dbaccess
  48 {
  49     class ODatabaseModelImpl;
  50     struct ContentProperties
  51     {
  52         OUString aTitle;         // Title
  53         ::boost::optional< OUString >
  54                         aContentType;   // ContentType (aka MediaType aka MimeType)
  55         bool        bIsDocument;    // IsDocument
  56         bool        bIsFolder;      // IsFolder
  57         bool        bAsTemplate;    // AsTemplate
  58         OUString sPersistentName;// persistent name of the document
  59
  60         ContentProperties()
  61             :bIsDocument( true )
  62             ,bIsFolder( false )
  63             ,bAsTemplate( false )
  64         {
  65         }
  66     };
  67
  68     class OContentHelper_Impl
  69     {
  70     public:
  71         OContentHelper_Impl();
  72         virtual ~OContentHelper_Impl();
  73
  74         ContentProperties   m_aProps;
  75         ODatabaseModelImpl* m_pDataSource; // this will stay alive as long as the content exists
  76     };
  77
  78     typedef ::boost::shared_ptr<OContentHelper_Impl> TContentPtr;
  79
  80     typedef cppu::OMultiTypeInterfaceContainerHelperVar<OUString>
  81         PropertyChangeListenerContainer;
  82     typedef ::comphelper::OBaseMutex    OContentHelper_MBASE;
  83     typedef ::cppu::WeakComponentImplHelper9    <   ::com::sun::star::ucb::XContent
  84                                                 ,   ::com::sun::star::ucb::XCommandProcessor
  85                                                 ,   ::com::sun::star::lang::XServiceInfo
  86                                                 ,   ::com::sun::star::beans::XPropertiesChangeNotifier
  87                                                 ,   ::com::sun::star::beans::XPropertyContainer
  88                                                 ,   ::com::sun::star::lang::XInitialization
  89                                                 ,   ::com::sun::star::lang::XUnoTunnel
  90                                                 ,   ::com::sun::star::container::XChild
  91                                                 ,   ::com::sun::star::sdbcx::XRename
  92                                                 >   OContentHelper_COMPBASE;
  93
  94     class OContentHelper :   public OContentHelper_MBASE
  95                             ,public OContentHelper_COMPBASE
  96     {
  97         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
  98             setPropertyValues( const ::com::sun::star::uno::Sequence<
  99                                 ::com::sun::star::beans::PropertyValue >& rValues,
 100                             const ::com::sun::star::uno::Reference<
 101                                 ::com::sun::star::ucb::XCommandEnvironment >& xEnv );
 102         com::sun::star::uno::Sequence< com::sun::star::beans::Property >
 103             getProperties( const com::sun::star::uno::Reference<
 104                             com::sun::star::ucb::XCommandEnvironment > & xEnv );
 105
 106         void impl_rename_throw(const OUString& _sNewName,bool _bNotify = true);
 107
 108     protected:
 109         ::cppu::OInterfaceContainerHelper       m_aContentListeners;
 110         PropertyChangeListenerContainer         m_aPropertyChangeListeners;
 111         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
 112                                                 m_xParentContainer;
 113         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
 114                                                 m_aContext;
 115         const ::connectivity::SQLError          m_aErrorHelper;
 116         TContentPtr                             m_pImpl;
 117         sal_uInt32                              m_nCommandId;
 118
 119         // helper
 120         virtual void SAL_CALL disposing() SAL_OVERRIDE;
 121
 122         virtual void notifyDataSourceModified();
 123
 124         /**
 125         * This method can be used to propagate changes of property values.
 126         *
 127         * @param evt is a sequence of property change events.
 128         */
 129         void notifyPropertiesChange( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyChangeEvent >& evt ) const;
 130
 131         OUString impl_getHierarchicalName( bool _includingRootContainer ) const;
 132
 133     public:
 134
 135         OContentHelper( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _xORB
 136                         ,const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&   _xParentContainer
 137                         ,const TContentPtr& _pImpl
 138                     );
 139
 140         // com::sun::star::lang::XTypeProvider
 141         virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId(  ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 142         static ::com::sun::star::uno::Sequence< sal_Int8 >  getUnoTunnelImplementationId();
 143         // ::com::sun::star::lang::XServiceInfo
 144         virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 145         virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 146         virtual OUString SAL_CALL getImplementationName(  ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 147
 148         // XContent
 149         virtual ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContentIdentifier > SAL_CALL getIdentifier(  ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 150         virtual OUString SAL_CALL getContentType(  ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 151         virtual void SAL_CALL addContentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContentEventListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 152         virtual void SAL_CALL removeContentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContentEventListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 153
 154         // XCommandProcessor
 155         virtual sal_Int32 SAL_CALL createCommandIdentifier(  ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 156         virtual ::com::sun::star::uno::Any SAL_CALL execute( const ::com::sun::star::ucb::Command& aCommand, sal_Int32 CommandId, const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >& Environment ) throw (::com::sun::star::uno::Exception, ::com::sun::star::ucb::CommandAbortedException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 157         virtual void SAL_CALL abort( sal_Int32 CommandId ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 158
 159         // XPropertiesChangeNotifier
 160         virtual void SAL_CALL addPropertiesChangeListener( const ::com::sun::star::uno::Sequence< OUString >& PropertyNames, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 161         virtual void SAL_CALL removePropertiesChangeListener( const ::com::sun::star::uno::Sequence< OUString >& PropertyNames, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 162
 163         // XPropertyContainer
 164         virtual void SAL_CALL addProperty( const OUString& Name, sal_Int16 Attributes, const ::com::sun::star::uno::Any& DefaultValue ) throw (::com::sun::star::beans::PropertyExistException, ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 165         virtual void SAL_CALL removeProperty( const OUString& Name ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::NotRemoveableException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE ;
 166
 167         // XInitialization
 168         virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw(::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 169
 170         // com::sun::star::lang::XUnoTunnel
 171         virtual sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& aIdentifier ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 172         static OContentHelper* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxComponent );
 173
 174         // ::com::sun::star::container::XChild
 175         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent(  ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 176         virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& Parent ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 177
 178         // XRename
 179         virtual void SAL_CALL rename( const OUString& newName ) throw (::com::sun::star::sdbc::SQLException, ::com::sun::star::container::ElementExistException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 180
 181         inline const ContentProperties& getContentProperties() const { return m_pImpl->m_aProps; }
 182         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
 183             getPropertyValues( const ::com::sun::star::uno::Sequence<
 184                             ::com::sun::star::beans::Property >& rProperties );
 185
 186         const css::uno::Reference< css::uno::XComponentContext >& getContext() const { return m_aContext; }
 187
 188         inline TContentPtr getImpl() const { return m_pImpl; }
 189
 190     protected:
 191         virtual OUString determineContentType() const = 0;
 192     };
 193
 194 }   // namespace dbaccess
 195
 196 #endif // INCLUDED_DBACCESS_SOURCE_CORE_INC_CONTENTHELPER_HXX
 197
 198 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */