ucb/source/ucp/package/pkgcontent.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: pkgcontent.hxx,v $
  10  * $Revision: 1.31 $
  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 _PKGCONTENT_HXX
  32 #define _PKGCONTENT_HXX
  33
  34 #include <list>
  35 #include <rtl/ref.hxx>
  36
  37 #ifndef _COM_SUN_STAR_UCB_INTERACTIVEBADTRANSFRERURLEXCEPTION_HPP_
  38 #include <com/sun/star/ucb/InteractiveBadTransferURLException.hpp>
  39 #endif
  40 #include <com/sun/star/ucb/XContentCreator.hpp>
  41 #include <ucbhelper/contenthelper.hxx>
  42 #include "pkguri.hxx"
  43
  44 namespace com { namespace sun { namespace star {
  45     namespace beans
  46     {
  47         struct Property;
  48         struct PropertyValue;
  49     }
  50     namespace container
  51     {
  52         class XHierarchicalNameAccess;
  53         class XEnumeration;
  54     }
  55     namespace io
  56     {
  57         class XInputStream;
  58     }
  59     namespace sdbc
  60     {
  61         class XRow;
  62     }
  63     namespace ucb
  64     {
  65         struct OpenCommandArgument2;
  66         struct TransferInfo;
  67     }
  68 } } }
  69
  70 namespace package_ucp
  71 {
  72
  73 //=========================================================================
  74
  75 // UNO service name for the content.
  76 #define PACKAGE_FOLDER_CONTENT_SERVICE_NAME \
  77                             "com.sun.star.ucb.PackageFolderContent"
  78 #define PACKAGE_STREAM_CONTENT_SERVICE_NAME \
  79                             "com.sun.star.ucb.PackageStreamContent"
  80
  81 //=========================================================================
  82
  83 struct ContentProperties
  84 {
  85     ::rtl::OUString  aTitle;                // Title
  86     ::rtl::OUString  aContentType;          // ContentType
  87     sal_Bool         bIsDocument;           // IsDocument
  88     sal_Bool         bIsFolder;             // IsFolder
  89     ::rtl::OUString  aMediaType;            // MediaType
  90     com::sun::star::uno::Sequence <
  91         sal_Int8 >   aEncryptionKey;        // EncryptionKey
  92     sal_Int64        nSize;                 // Size
  93     sal_Bool         bCompressed;           // Compressed
  94     sal_Bool         bEncrypted;            // Encrypted
  95     sal_Bool         bHasEncryptedEntries;  // HasEncryptedEntries
  96
  97     ContentProperties()
  98     : bIsDocument( sal_True ), bIsFolder( sal_False ), nSize( 0 ),
  99       bCompressed( sal_True ), bEncrypted( sal_False ),
 100       bHasEncryptedEntries( sal_False ) {}
 101
 102     ContentProperties( const ::rtl::OUString& rContentType );
 103 };
 104
 105 //=========================================================================
 106
 107 class ContentProvider;
 108
 109 class Content : public ::ucbhelper::ContentImplHelper,
 110                 public com::sun::star::ucb::XContentCreator
 111 {
 112     enum ContentState { TRANSIENT,  // created via CreateNewContent,
 113                                        // but did not process "insert" yet
 114                         PERSISTENT, // processed "insert"
 115                         DEAD            // processed "delete"
 116                       };
 117
 118     PackageUri                          m_aUri;
 119     ContentProperties           m_aProps;
 120     ContentState                        m_eState;
 121     com::sun::star::uno::Reference<
 122         com::sun::star::container::XHierarchicalNameAccess >    m_xPackage;
 123     ContentProvider*            m_pProvider;
 124     sal_uInt32              m_nModifiedProps;
 125
 126 private:
 127     Content( const com::sun::star::uno::Reference<
 128                 com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 129              ContentProvider* pProvider,
 130              const com::sun::star::uno::Reference<
 131                 com::sun::star::ucb::XContentIdentifier >& Identifier,
 132              const ::com::sun::star::uno::Reference<
 133                  com::sun::star::container::XHierarchicalNameAccess >& Package,
 134              const PackageUri& rUri,
 135              const ContentProperties& rProps );
 136     Content( const com::sun::star::uno::Reference<
 137                 com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 138              ContentProvider* pProvider,
 139              const com::sun::star::uno::Reference<
 140                 com::sun::star::ucb::XContentIdentifier >& Identifier,
 141              const com::sun::star::uno::Reference<
 142                  com::sun::star::container::XHierarchicalNameAccess >& Package,
 143              const PackageUri& rUri,
 144              const com::sun::star::ucb::ContentInfo& Info );
 145
 146     virtual com::sun::star::uno::Sequence< com::sun::star::beans::Property >
 147     getProperties( const com::sun::star::uno::Reference<
 148                     com::sun::star::ucb::XCommandEnvironment > & xEnv );
 149     virtual com::sun::star::uno::Sequence< com::sun::star::ucb::CommandInfo >
 150     getCommands( const com::sun::star::uno::Reference<
 151                     com::sun::star::ucb::XCommandEnvironment > & xEnv );
 152     virtual ::rtl::OUString getParentURL();
 153
 154     static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
 155     getPropertyValues( const ::com::sun::star::uno::Reference<
 156                         ::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
 157                        const ::com::sun::star::uno::Sequence<
 158                            ::com::sun::star::beans::Property >& rProperties,
 159                        const ContentProperties& rData,
 160                        const rtl::Reference<
 161                             ::ucbhelper::ContentProviderImplHelper >& rProvider,
 162                        const ::rtl::OUString& rContentId );
 163
 164     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
 165     getPropertyValues( const ::com::sun::star::uno::Sequence<
 166                         ::com::sun::star::beans::Property >& rProperties );
 167     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
 168     setPropertyValues( const ::com::sun::star::uno::Sequence<
 169                         ::com::sun::star::beans::PropertyValue >& rValues,
 170                        const ::com::sun::star::uno::Reference<
 171                         ::com::sun::star::ucb::XCommandEnvironment > & xEnv )
 172         throw( ::com::sun::star::uno::Exception );
 173
 174     com::sun::star::uno::Reference<
 175         com::sun::star::container::XHierarchicalNameAccess >
 176     getPackage( const PackageUri& rURI );
 177     com::sun::star::uno::Reference<
 178         com::sun::star::container::XHierarchicalNameAccess >
 179     getPackage();
 180
 181     static sal_Bool
 182     loadData( ContentProvider* pProvider,
 183               const PackageUri& rURI,
 184               ContentProperties& rProps,
 185               com::sun::star::uno::Reference<
 186                   com::sun::star::container::XHierarchicalNameAccess > &
 187                     rxPackage );
 188     static sal_Bool
 189     hasData( ContentProvider* pProvider,
 190              const PackageUri& rURI,
 191              com::sun::star::uno::Reference<
 192                  com::sun::star::container::XHierarchicalNameAccess > &
 193                     rxPackage );
 194
 195     static ::rtl::OUString
 196     GetContentType( const ::rtl::OUString& aScheme,
 197             sal_Bool bFolder );
 198
 199     sal_Bool
 200     hasData( const PackageUri& rURI );
 201     sal_Bool
 202     renameData( const com::sun::star::uno::Reference<
 203                      com::sun::star::ucb::XContentIdentifier >& xOldId,
 204                 const com::sun::star::uno::Reference<
 205                     com::sun::star::ucb::XContentIdentifier >& xNewId );
 206     sal_Bool
 207     storeData( const com::sun::star::uno::Reference<
 208                     com::sun::star::io::XInputStream >& xStream );
 209     sal_Bool
 210     removeData();
 211
 212     sal_Bool
 213     flushData();
 214
 215     typedef rtl::Reference< Content > ContentRef;
 216     typedef std::list< ContentRef > ContentRefList;
 217     void queryChildren( ContentRefList& rChildren );
 218
 219     sal_Bool
 220     exchangeIdentity( const ::com::sun::star::uno::Reference<
 221                         ::com::sun::star::ucb::XContentIdentifier >& xNewId );
 222
 223     ::com::sun::star::uno::Any
 224     open( const ::com::sun::star::ucb::OpenCommandArgument2& rArg,
 225           const ::com::sun::star::uno::Reference<
 226                       ::com::sun::star::ucb::XCommandEnvironment > & xEnv )
 227         throw( ::com::sun::star::uno::Exception );
 228
 229     void insert( const ::com::sun::star::uno::Reference<
 230                         ::com::sun::star::io::XInputStream >& xStream,
 231                  sal_Int32 nNameClashResolve,
 232                  const ::com::sun::star::uno::Reference<
 233                     ::com::sun::star::ucb::XCommandEnvironment > & xEnv )
 234         throw( ::com::sun::star::uno::Exception );
 235
 236     void destroy( sal_Bool bDeletePhysical,
 237                   const ::com::sun::star::uno::Reference<
 238                     ::com::sun::star::ucb::XCommandEnvironment > & xEnv )
 239         throw( ::com::sun::star::uno::Exception );
 240
 241     void transfer( const ::com::sun::star::ucb::TransferInfo& rInfo,
 242                    const ::com::sun::star::uno::Reference<
 243                     ::com::sun::star::ucb::XCommandEnvironment > & xEnv )
 244         throw( ::com::sun::star::uno::Exception );
 245
 246     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
 247     getInputStream();
 248
 249     sal_Bool isFolder() const { return m_aProps.bIsFolder; }
 250
 251 public:
 252     // Create existing content. Fail, if not already exists.
 253     static Content* create(
 254             const com::sun::star::uno::Reference<
 255                 com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 256             ContentProvider* pProvider,
 257             const com::sun::star::uno::Reference<
 258                 com::sun::star::ucb::XContentIdentifier >& Identifier );
 259
 260     // Create new content. Fail, if already exists.
 261     static Content* create(
 262             const com::sun::star::uno::Reference<
 263                 com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 264             ContentProvider* pProvider,
 265             const com::sun::star::uno::Reference<
 266                 com::sun::star::ucb::XContentIdentifier >& Identifier,
 267             const com::sun::star::ucb::ContentInfo& Info );
 268
 269     virtual ~Content();
 270
 271     // XInterface
 272     XINTERFACE_DECL()
 273
 274     // XTypeProvider
 275     XTYPEPROVIDER_DECL()
 276
 277     // XServiceInfo
 278     virtual ::rtl::OUString SAL_CALL
 279     getImplementationName()
 280         throw( ::com::sun::star::uno::RuntimeException );
 281     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 282     getSupportedServiceNames()
 283         throw( ::com::sun::star::uno::RuntimeException );
 284
 285     // XContent
 286     virtual rtl::OUString SAL_CALL
 287     getContentType()
 288         throw( com::sun::star::uno::RuntimeException );
 289
 290     // XCommandProcessor
 291     virtual com::sun::star::uno::Any SAL_CALL
 292     execute( const com::sun::star::ucb::Command& aCommand,
 293              sal_Int32 CommandId,
 294              const com::sun::star::uno::Reference<
 295                  com::sun::star::ucb::XCommandEnvironment >& Environment )
 296         throw( com::sun::star::uno::Exception,
 297                com::sun::star::ucb::CommandAbortedException,
 298                com::sun::star::uno::RuntimeException );
 299     virtual void SAL_CALL
 300     abort( sal_Int32 CommandId )
 301         throw( com::sun::star::uno::RuntimeException );
 302
 303     //////////////////////////////////////////////////////////////////////
 304     // Additional interfaces
 305     //////////////////////////////////////////////////////////////////////
 306
 307     // XContentCreator
 308     virtual com::sun::star::uno::Sequence<
 309                 com::sun::star::ucb::ContentInfo > SAL_CALL
 310     queryCreatableContentsInfo()
 311         throw( com::sun::star::uno::RuntimeException );
 312     virtual com::sun::star::uno::Reference<
 313                 com::sun::star::ucb::XContent > SAL_CALL
 314     createNewContent( const com::sun::star::ucb::ContentInfo& Info )
 315         throw( com::sun::star::uno::RuntimeException );
 316
 317     //////////////////////////////////////////////////////////////////////
 318     // Non-interface methods.
 319     //////////////////////////////////////////////////////////////////////
 320
 321     // Called from resultset data supplier.
 322     static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
 323     getPropertyValues( const ::com::sun::star::uno::Reference<
 324                         ::com::sun::star::lang::XMultiServiceFactory >& rSMgr,
 325                        const ::com::sun::star::uno::Sequence<
 326                            ::com::sun::star::beans::Property >& rProperties,
 327                        ContentProvider* pProvider,
 328                        const ::rtl::OUString& rContentId );
 329
 330     // Called from resultset data supplier.
 331     ::com::sun::star::uno::Reference<
 332         ::com::sun::star::container::XEnumeration >
 333     getIterator();
 334 };
 335
 336 }
 337
 338 #endif