ucb/source/ucp/file/bc.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
  20 #pragma once
  21
  22 #include <mutex>
  23 #include <rtl/ustring.hxx>
  24 #include <cppuhelper/implbase.hxx>
  25 #include <comphelper/interfacecontainer4.hxx>
  26 #include <com/sun/star/uno/XInterface.hpp>
  27 #include <com/sun/star/lang/XComponent.hpp>
  28 #include <com/sun/star/ucb/XCommandProcessor.hpp>
  29 #include <com/sun/star/beans/XPropertiesChangeNotifier.hpp>
  30 #include <com/sun/star/ucb/XContent.hpp>
  31 #include <com/sun/star/ucb/XDynamicResultSet.hpp>
  32 #include <com/sun/star/lang/XServiceInfo.hpp>
  33 #include <com/sun/star/sdbc/XRow.hpp>
  34 #include <com/sun/star/beans/Property.hpp>
  35 #include <com/sun/star/beans/PropertyValue.hpp>
  36 #include <com/sun/star/ucb/XCommandInfo.hpp>
  37 #include <com/sun/star/ucb/InsertCommandArgument.hpp>
  38 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  39 #include <com/sun/star/beans/XPropertyContainer.hpp>
  40 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.hpp>
  41 #include <com/sun/star/beans/XPropertySetInfoChangeListener.hpp>
  42 #include <com/sun/star/container/XChild.hpp>
  43 #include <com/sun/star/ucb/XContentCreator.hpp>
  44 #include <com/sun/star/ucb/OpenCommandArgument2.hpp>
  45 #include <com/sun/star/ucb/TransferInfo.hpp>
  46 #include "filtask.hxx"
  47
  48
  49 namespace fileaccess {
  50
  51     class PropertyListeners;
  52     class TaskManager;
  53
  54     class BaseContent:
  55         public cppu::WeakImplHelper<
  56             css::lang::XComponent,
  57             css::lang::XServiceInfo,
  58             css::ucb::XCommandProcessor,
  59             css::beans::XPropertiesChangeNotifier,
  60             css::beans::XPropertyContainer,
  61             css::beans::XPropertySetInfoChangeNotifier,
  62             css::ucb::XContentCreator,
  63             css::container::XChild,
  64             css::ucb::XContent>,
  65         public fileaccess::Notifier    // implementation class
  66     {
  67     private:
  68
  69         // A special creator for inserted contents; Creates an ugly object
  70         BaseContent( TaskManager* pMyShell,
  71                      OUString parentName,
  72                      bool bFolder );
  73
  74     public:
  75         BaseContent(
  76             TaskManager* pMyShell,
  77             const css::uno::Reference< css::ucb::XContentIdentifier >& xContentIdentifier,
  78             OUString aUnqPath );
  79
  80         virtual ~BaseContent() override;
  81
  82         // XComponent
  83         virtual void SAL_CALL
  84         dispose() override;
  85
  86         virtual void SAL_CALL
  87         addEventListener(
  88             const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
  89
  90         virtual void SAL_CALL
  91         removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
  92
  93
  94         // XServiceInfo
  95         virtual OUString SAL_CALL
  96         getImplementationName() override;
  97
  98         virtual sal_Bool SAL_CALL
  99         supportsService( const OUString& ServiceName ) override;
 100
 101         virtual css::uno::Sequence< OUString > SAL_CALL
 102         getSupportedServiceNames() override;
 103
 104
 105         // XCommandProcessor
 106         virtual sal_Int32 SAL_CALL
 107         createCommandIdentifier() override;
 108
 109         virtual css::uno::Any SAL_CALL
 110         execute(
 111             const css::ucb::Command& aCommand,
 112             sal_Int32 CommandId,
 113             const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment ) override;
 114
 115         virtual void SAL_CALL
 116         abort( sal_Int32 CommandId ) override;
 117
 118
 119         // XContent
 120         virtual css::uno::Reference< css::ucb::XContentIdentifier > SAL_CALL
 121         getIdentifier() override;
 122
 123         virtual OUString SAL_CALL
 124         getContentType() override;
 125
 126         virtual void SAL_CALL
 127         addContentEventListener(
 128             const css::uno::Reference< css::ucb::XContentEventListener >& Listener ) override;
 129
 130         virtual void SAL_CALL
 131         removeContentEventListener(
 132             const css::uno::Reference< css::ucb::XContentEventListener >& Listener ) override;
 133
 134         // XPropertiesChangeNotifier
 135
 136         virtual void SAL_CALL
 137         addPropertiesChangeListener(
 138             const css::uno::Sequence< OUString >& PropertyNames,
 139             const css::uno::Reference< css::beans::XPropertiesChangeListener >& Listener ) override;
 140
 141         virtual void SAL_CALL
 142         removePropertiesChangeListener( const css::uno::Sequence< OUString >& PropertyNames,
 143                                         const css::uno::Reference< css::beans::XPropertiesChangeListener >& Listener ) override;
 144
 145         // XPropertyContainer
 146
 147         virtual void SAL_CALL
 148         addProperty(
 149             const OUString& Name,
 150             sal_Int16 Attributes,
 151             const css::uno::Any& DefaultValue ) override;
 152
 153         virtual void SAL_CALL
 154         removeProperty( const OUString& Name ) override;
 155
 156         // XPropertySetInfoChangeNotifier
 157
 158         virtual void SAL_CALL
 159         addPropertySetInfoChangeListener(
 160             const css::uno::Reference< css::beans::XPropertySetInfoChangeListener >& Listener ) override;
 161
 162         virtual void SAL_CALL
 163         removePropertySetInfoChangeListener(
 164             const css::uno::Reference< css::beans::XPropertySetInfoChangeListener >& Listener ) override;
 165
 166
 167         // XContentCreator
 168
 169         virtual css::uno::Sequence< css::ucb::ContentInfo > SAL_CALL
 170         queryCreatableContentsInfo() override;
 171
 172         virtual css::uno::Reference< css::ucb::XContent > SAL_CALL
 173         createNewContent( const css::ucb::ContentInfo& Info ) override;
 174
 175
 176         // XChild
 177         virtual css::uno::Reference< css::uno::XInterface > SAL_CALL
 178         getParent() override;
 179
 180         // Not supported
 181         virtual void SAL_CALL
 182         setParent( const css::uno::Reference< css::uno::XInterface >& Parent ) override;
 183
 184
 185         // Notifier
 186
 187         std::optional<ContentEventNotifier> cDEL() override;
 188         std::optional<ContentEventNotifier> cEXC( const OUString& aNewName ) override;
 189         std::optional<ContentEventNotifier> cCEL() override;
 190         std::optional<PropertySetInfoChangeNotifier> cPSL() override;
 191         std::optional<PropertyChangeNotifier> cPCL() override;
 192
 193     private:
 194         // Data members
 195         TaskManager*                                                m_pMyShell;
 196         css::uno::Reference< css::ucb::XContentIdentifier >   m_xContentIdentifier;
 197         OUString                                              m_aUncPath;
 198
 199         enum state { NameForInsertionSet = 1,
 200                      JustInserted = 2,
 201                      Deleted = 4,
 202                      FullFeatured = 8 };
 203         bool                                                  m_bFolder;
 204         sal_uInt16                                            m_nState;
 205
 206         std::mutex                         m_aMutex;
 207         comphelper::OInterfaceContainerHelper4<css::lang::XEventListener>   m_aDisposeEventListeners;
 208         comphelper::OInterfaceContainerHelper4<css::ucb::XContentEventListener> m_aContentEventListeners;
 209         comphelper::OInterfaceContainerHelper4<css::beans::XPropertySetInfoChangeListener> m_aPropertySetInfoChangeListeners;
 210         std::unique_ptr<PropertyListeners>                  m_pPropertyListener;
 211
 212
 213         // Private Methods
 214         /// @throws css::uno::RuntimeException
 215         css::uno::Reference< css::ucb::XCommandInfo >
 216         getCommandInfo();
 217
 218         /// @throws css::uno::RuntimeException
 219         css::uno::Reference< css::beans::XPropertySetInfo >
 220         getPropertySetInfo();
 221
 222         /// @throws css::uno::RuntimeException
 223         css::uno::Reference< css::sdbc::XRow >
 224         getPropertyValues(
 225             sal_Int32 nMyCommandIdentifier,
 226             const css::uno::Sequence< css::beans::Property >& PropertySet );
 227
 228         css::uno::Sequence< css::uno::Any >
 229         setPropertyValues(
 230             sal_Int32 nMyCommandIdentifier,
 231             const css::uno::Sequence< css::beans::PropertyValue >& Values );
 232
 233         css::uno::Reference< css::ucb::XDynamicResultSet >
 234         open(
 235             sal_Int32 nMyCommandIdentifier,
 236             const css::ucb::OpenCommandArgument2& aCommandArgument );
 237
 238         void
 239         deleteContent( sal_Int32 nMyCommandIdentifier );
 240
 241
 242         void
 243         transfer( sal_Int32 nMyCommandIdentifier,
 244                   const css::ucb::TransferInfo& aTransferInfo );
 245
 246         void
 247         insert( sal_Int32 nMyCommandIdentifier,
 248                 const css::ucb::InsertCommandArgument& aInsertArgument );
 249
 250         void endTask( sal_Int32 CommandId );
 251
 252         friend class ContentEventNotifier;
 253     };
 254
 255 }             // end namespace fileaccess
 256
 257 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */