xref: /trunk/main/svl/source/fsstor/fsstorage.hxx (revision 91144cd0085a7583d2099b982122deb2184ab956)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef __XSTORAGE_HXX_
25 #define __XSTORAGE_HXX_
26 
27 #include <com/sun/star/uno/Sequence.hxx>
28 #include <com/sun/star/embed/XStorage.hpp>
29 #include <com/sun/star/embed/XHierarchicalStorageAccess.hpp>
30 #include <com/sun/star/beans/XPropertySet.hpp>
31 #include <com/sun/star/beans/PropertyValue.hpp>
32 #include <com/sun/star/io/XStream.hpp>
33 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
34 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
35 #include <com/sun/star/lang/XTypeProvider.hpp>
36 #include <com/sun/star/lang/XComponent.hpp>
37 #include <com/sun/star/packages/NoEncryptionException.hpp>
38 #include <cppuhelper/weak.hxx>
39 #include <cppuhelper/interfacecontainer.h>
40 
41 #include <ucbhelper/content.hxx>
42 
43 struct FSStorage_Impl;
44 class FSStorage : public ::com::sun::star::lang::XTypeProvider
45                 , public ::com::sun::star::embed::XStorage
46                 , public ::com::sun::star::embed::XHierarchicalStorageAccess
47                 , public ::com::sun::star::beans::XPropertySet
48                 , public ::cppu::OWeakObject
49 {
50     ::osl::Mutex m_aMutex;
51     FSStorage_Impl* m_pImpl;
52 
53 protected:
54 
55 public:
56 
57     FSStorage(  const ::ucbhelper::Content& aContent,
58                 sal_Int32 nMode,
59                 ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > xProperties,
60                 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory );
61 
62     virtual ~FSStorage();
63 
64     ::ucbhelper::Content* GetContent();
65 
66     void CopyStreamToSubStream( const ::rtl::OUString& aSourceURL,
67                                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xDest,
68                                 const ::rtl::OUString& aNewEntryName );
69 
70     void CopyContentToStorage_Impl( ::ucbhelper::Content* pContent,
71                                     const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xDest );
72 
73     static sal_Bool MakeFolderNoUI( const String& rFolder, sal_Bool bNewOnly );
74 
75     //____________________________________________________________________________________________________
76     //  XInterface
77     //____________________________________________________________________________________________________
78 
79     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& rType );
80 
81     virtual void SAL_CALL acquire() throw();
82 
83     virtual void SAL_CALL release() throw();
84 
85     //____________________________________________________________________________________________________
86     //  XTypeProvider
87     //____________________________________________________________________________________________________
88 
89     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes();
90 
91     virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId();
92 
93     //____________________________________________________________________________________________________
94     //  XStorage
95     //____________________________________________________________________________________________________
96 
97     virtual void SAL_CALL copyToStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xDest );
98 
99     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > SAL_CALL openStreamElement(
100             const ::rtl::OUString& aStreamName, sal_Int32 nOpenMode );
101 
102     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > SAL_CALL openEncryptedStreamElement(
103             const ::rtl::OUString& aStreamName, sal_Int32 nOpenMode, const ::rtl::OUString& aPass );
104 
105     virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > SAL_CALL openStorageElement(
106             const ::rtl::OUString& aStorName, sal_Int32 nStorageMode );
107 
108     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > SAL_CALL cloneStreamElement(
109             const ::rtl::OUString& aStreamName );
110 
111     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > SAL_CALL cloneEncryptedStreamElement(
112             const ::rtl::OUString& aStreamName, const ::rtl::OUString& aPass );
113 
114     virtual void SAL_CALL copyLastCommitTo(
115             const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xTargetStorage );
116 
117     virtual void SAL_CALL copyStorageElementLastCommitTo(
118             const ::rtl::OUString& aStorName,
119             const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xTargetStorage );
120 
121     virtual sal_Bool SAL_CALL isStreamElement( const ::rtl::OUString& aElementName );
122 
123     virtual sal_Bool SAL_CALL isStorageElement( const ::rtl::OUString& aElementName );
124 
125     virtual void SAL_CALL removeElement( const ::rtl::OUString& aElementName );
126 
127     virtual void SAL_CALL renameElement( const ::rtl::OUString& rEleName, const ::rtl::OUString& rNewName );
128 
129     virtual void SAL_CALL copyElementTo(    const ::rtl::OUString& aElementName,
130                                         const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xDest,
131                                         const ::rtl::OUString& aNewName );
132 
133     virtual void SAL_CALL moveElementTo(    const ::rtl::OUString& aElementName,
134                                         const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xDest,
135                                         const ::rtl::OUString& rNewName );
136 
137     //____________________________________________________________________________________________________
138     //  XNameAccess
139     //____________________________________________________________________________________________________
140 
141     virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName );
142 
143     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames();
144 
145     virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName );
146 
147     virtual ::com::sun::star::uno::Type SAL_CALL getElementType();
148 
149     virtual sal_Bool SAL_CALL hasElements();
150 
151     //____________________________________________________________________________________________________
152     //  XComponent
153     //____________________________________________________________________________________________________
154 
155     virtual void SAL_CALL dispose();
156 
157     virtual void SAL_CALL addEventListener(
158             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener );
159 
160     virtual void SAL_CALL removeEventListener(
161             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener );
162 
163     //____________________________________________________________________________________________________
164     //  XPropertySet
165     //____________________________________________________________________________________________________
166 
167     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo();
168 
169     virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue );
170 
171     virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& PropertyName );
172 
173     virtual void SAL_CALL addPropertyChangeListener(
174             const ::rtl::OUString& aPropertyName,
175             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& xListener );
176 
177     virtual void SAL_CALL removePropertyChangeListener(
178             const ::rtl::OUString& aPropertyName,
179             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& aListener );
180 
181     virtual void SAL_CALL addVetoableChangeListener(
182             const ::rtl::OUString& PropertyName,
183             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener );
184 
185     virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener );
186 
187     //____________________________________________________________________________________________________
188     //  XHierarchicalStorageAccess
189     //____________________________________________________________________________________________________
190 
191     virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XExtendedStorageStream > SAL_CALL openStreamElementByHierarchicalName( const ::rtl::OUString& sStreamPath, ::sal_Int32 nOpenMode );
192 
193     virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XExtendedStorageStream > SAL_CALL openEncryptedStreamElementByHierarchicalName( const ::rtl::OUString& sStreamName, ::sal_Int32 nOpenMode, const ::rtl::OUString& sPassword );
194 
195     virtual void SAL_CALL removeStreamElementByHierarchicalName( const ::rtl::OUString& sElementPath );
196 };
197 
198 #endif
199