ucb/source/ucp/odma/odma_provider.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: odma_provider.hxx,v $
  10  * $Revision: 1.6 $
  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 ODMA_PROVIDER_HXX
  32 #define ODMA_PROVIDER_HXX
  33
  34 #include <ucbhelper/providerhelper.hxx>
  35 #include <tools/prewin.h>
  36 #include <tools/postwin.h>
  37 #include "odma_lib.hxx"
  38
  39 #include "rtl/ref.hxx"
  40
  41 #include <map>
  42 #include "odma_contentprops.hxx"
  43
  44 namespace odma {
  45
  46 //=========================================================================
  47
  48 // UNO service name for the provider. This name will be used by the UCB to
  49 // create instances of the provider.
  50 #define ODMA_CONTENT_PROVIDER_SERVICE_NAME \
  51                                 "com.sun.star.ucb.ODMAContentProvider"
  52 //      #define ODMA_CONTENT_PROVIDER_SERVICE_NAME_LENGTH       34
  53
  54 // URL scheme. This is the scheme the provider will be able to create
  55 // contents for. The UCB will select the provider ( i.e. in order to create
  56 // contents ) according to this scheme.
  57 #define ODMA_URL_ODMAID                 "::ODMA"
  58 #define ODMA_URL_SCHEME                 "vnd.sun.star.odma"
  59 #define ODMA_URL_SCHEME_SHORT   "odma"
  60 #define ODMA_URL_SHORT                  ":"
  61 #define ODMA_URL_SHORT_LGTH             5
  62 #define ODMA_URL_LGTH                   18
  63 #define ODMA_URL_ODMAID_LGTH    6
  64
  65 // UCB Content Type.
  66 #define ODMA_CONTENT_TYPE               "application/" ODMA_URL_SCHEME "-content"
  67 #define ODMA_ODMA_REGNAME               "sodma"
  68 #define ODM_NAME_MAX                    64              // Max length of a name document including
  69                                         // the terminating NULL character.
  70
  71 //=========================================================================
  72 class ContentProperties;
  73 class ContentProvider : public ::ucbhelper::ContentProviderImplHelper
  74 {
  75     typedef ::std::map< ::rtl::OString, ::rtl::Reference<ContentProperties> > ContentsMap;
  76     ContentsMap          m_aContents;  // contains all ContentProperties
  77     static ODMHANDLE m_aOdmHandle; // the one and only ODMA handle to our DMS
  78
  79     /** fillDocumentProperties fills the given _rProp with ODMA properties
  80         @param  _rProp  the ContentProperties
  81     */
  82     void fillDocumentProperties(const ::rtl::Reference<ContentProperties>& _rProp);
  83
  84     /**
  85     */
  86     ::rtl::Reference<ContentProperties> getContentProperty(const ::rtl::OUString& _sName,
  87                                                        const ContentPropertiesMemberFunctor& _aFunctor) const;
  88 public:
  89     ContentProvider( const ::com::sun::star::uno::Reference<
  90                         ::com::sun::star::lang::XMultiServiceFactory >& rSMgr );
  91     virtual ~ContentProvider();
  92
  93     // XInterface
  94     XINTERFACE_DECL()
  95
  96     // XTypeProvider
  97     XTYPEPROVIDER_DECL()
  98
  99     // XServiceInfo
 100     XSERVICEINFO_DECL()
 101
 102     // XContentProvider
 103     virtual ::com::sun::star::uno::Reference<
 104                 ::com::sun::star::ucb::XContent > SAL_CALL
 105     queryContent( const ::com::sun::star::uno::Reference<
 106                     ::com::sun::star::ucb::XContentIdentifier >& Identifier )
 107         throw( ::com::sun::star::ucb::IllegalIdentifierException,
 108                ::com::sun::star::uno::RuntimeException );
 109
 110     //////////////////////////////////////////////////////////////////////
 111     // Additional interfaces
 112     //////////////////////////////////////////////////////////////////////
 113
 114     //////////////////////////////////////////////////////////////////////
 115     // Non-interface methods.
 116     //////////////////////////////////////////////////////////////////////
 117     static ODMHANDLE getHandle();
 118
 119     /** append add an entry to the internal map
 120         @param  _rProp  the content properties
 121     */
 122     void append(const ::rtl::Reference<ContentProperties>& _rProp);
 123
 124     /** closeDocument closes the document
 125         @param  _sDocumentId    the id of the document
 126     */
 127     void closeDocument(const ::rtl::OString& _sDocumentId);
 128
 129     /** saveDocument saves the document in DMS
 130         @param  _sDocumentId    the id of the document
 131     */
 132     void saveDocument(const ::rtl::OString& _sDocumentId);
 133
 134     /** queryContentProperty query in the DMS for a content which document name is equal to _sDocumentName
 135         @param  _sDocumentName  the document to query for
 136
 137         @return the content properties for this content or an empty refernce
 138     */
 139     ::rtl::Reference<ContentProperties> queryContentProperty(const ::rtl::OUString& _sDocumentName);
 140
 141         /** getContentPropertyWithTitle returns the ContentProperties for the first content with that title
 142         @param  _sTitle the title of the document
 143
 144         @return the content properties
 145     */
 146     ::rtl::Reference<ContentProperties> getContentPropertyWithTitle(const ::rtl::OUString& _sTitle) const;
 147
 148         /** getContentPropertyWithDocumentId returns the ContentProperties for the first content with that title
 149                 @param  _sTitle the title of the document
 150
 151                 @return the content properties
 152         */
 153         ::rtl::Reference<ContentProperties> getContentPropertyWithDocumentId(const ::rtl::OUString& _sDocumentId) const;
 154
 155         /** getContentPropertyWithSavedAsName returns the ContentProperties for the first content with that SavedAsName
 156         @param  _sSaveAsName    the SavedAsName of the document
 157
 158         @return the content properties
 159     */
 160     ::rtl::Reference<ContentProperties> getContentPropertyWithSavedAsName(const ::rtl::OUString& _sSaveAsName) const;
 161
 162     /** openDoc returns the URL for the temporary file for the specific Content and opens it
 163         @param  _rProp  used for check if already open, the member m_sFileURL will be set if is wan't opened yet
 164
 165         @return the URL of the temporary file
 166     */
 167     static ::rtl::OUString openDoc(const ::rtl::Reference<ContentProperties>& _rProp) throw (::com::sun::star::uno::Exception);
 168
 169     /** convertURL converts a normal URL into an ODMA understandable name
 170         @param  _sCanonicURL    the URL from ContentIndentifier
 171
 172         @return the ODMA name
 173     */
 174     static ::rtl::OUString convertURL(const ::rtl::OUString& _sCanonicURL);
 175
 176     /** deleteDocument deletes the document inside the DMS and remove the content properties from inside list
 177         @param  _rProp  the ContentProperties
 178
 179         @return true when successful
 180     */
 181     sal_Bool deleteDocument(const ::rtl::Reference<ContentProperties>& _rProp);
 182 };
 183
 184 }
 185
 186 #endif