Version 6.1.4.1, tag libreoffice-6.1.4.1
[LibreOffice.git] / package / source / xstor / xstorage.hxx
blob82cffa69a2fe39c91bd73f81faf12b75e981d182
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_PACKAGE_SOURCE_XSTOR_XSTORAGE_HXX
21 #define INCLUDED_PACKAGE_SOURCE_XSTOR_XSTORAGE_HXX
23 #include <com/sun/star/uno/Sequence.hxx>
24 #include <com/sun/star/embed/XStorage2.hpp>
25 #include <com/sun/star/embed/XOptimizedStorage.hpp>
26 #include <com/sun/star/embed/XHierarchicalStorageAccess2.hpp>
27 #include <com/sun/star/embed/XStorageRawAccess.hpp>
28 #include <com/sun/star/embed/XTransactedObject.hpp>
29 #include <com/sun/star/embed/XTransactionBroadcaster.hpp>
30 #include <com/sun/star/embed/XClassifiedObject.hpp>
31 #include <com/sun/star/embed/XEncryptionProtectedStorage.hpp>
32 #include <com/sun/star/embed/XRelationshipAccess.hpp>
33 #include <com/sun/star/util/XModifiable.hpp>
34 #include <com/sun/star/container/XNameAccess.hpp>
35 #include <com/sun/star/container/XNameContainer.hpp>
36 #include <com/sun/star/util/XCloseable.hpp>
37 #include <com/sun/star/beans/XPropertySet.hpp>
38 #include <com/sun/star/beans/PropertyValue.hpp>
39 #include <com/sun/star/beans/StringPair.hpp>
40 #include <com/sun/star/io/XStream.hpp>
41 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
42 #include <com/sun/star/lang/XTypeProvider.hpp>
43 #include <com/sun/star/lang/XComponent.hpp>
44 #include <com/sun/star/packages/NoEncryptionException.hpp>
46 #include <cppuhelper/weak.hxx>
47 #include <cppuhelper/weakref.hxx>
48 #include <cppuhelper/interfacecontainer.h>
49 #include <comphelper/refcountedmutex.hxx>
50 #include <comphelper/sequenceashashmap.hxx>
51 #include <o3tl/deleter.hxx>
52 #include <rtl/ref.hxx>
54 #include <list>
55 #include <vector>
56 #include <memory>
58 namespace com { namespace sun { namespace star { namespace uno {
59 class XComponentContext;
60 } } } }
62 #define RELINFO_NO_INIT 1
63 #define RELINFO_READ 2
64 #define RELINFO_CHANGED 3
65 #define RELINFO_CHANGED_STREAM 4
66 #define RELINFO_CHANGED_STREAM_READ 5
67 #define RELINFO_BROKEN 6
68 #define RELINFO_CHANGED_BROKEN 7
70 #define STOR_MESS_PRECOMMIT 1
71 #define STOR_MESS_COMMITED 2
72 #define STOR_MESS_PREREVERT 3
73 #define STOR_MESS_REVERTED 4
75 // a common implementation for an entry
77 struct StorInternalData_Impl;
78 struct OStorage_Impl;
79 struct OWriteStream_Impl;
81 struct SotElement_Impl
83 OUString m_aName;
84 OUString m_aOriginalName;
85 bool m_bIsRemoved;
86 bool m_bIsInserted;
87 bool m_bIsStorage;
89 std::unique_ptr<OStorage_Impl> m_xStorage;
90 std::unique_ptr<OWriteStream_Impl, o3tl::default_delete<OWriteStream_Impl>> m_xStream;
92 public:
93 SotElement_Impl(const OUString& rName, bool bStor, bool bNew);
96 typedef ::std::vector< SotElement_Impl* > SotElementVector_Impl;
98 // Main storage implementation
100 class OStorage;
102 struct StorageHolder_Impl
104 OStorage* m_pPointer;
105 css::uno::WeakReference< css::embed::XStorage > m_xWeakRef;
107 explicit inline StorageHolder_Impl( OStorage* pStorage );
109 StorageHolder_Impl( const StorageHolder_Impl& aSH )
110 : m_pPointer( aSH.m_pPointer )
111 , m_xWeakRef( aSH.m_xWeakRef )
116 class SwitchablePersistenceStream;
117 struct OStorage_Impl
119 typedef std::vector<StorageHolder_Impl> StorageHoldersType;
121 rtl::Reference<comphelper::RefCountedMutex> m_xMutex;
123 OStorage* m_pAntiImpl; // only valid if external references exists
124 StorageHoldersType m_aReadOnlyWrapVector; // only valid if readonly external reference exists
126 sal_Int32 m_nStorageMode; // open mode ( read/write/trunc/nocreate )
127 bool m_bIsModified; // only modified elements will be sent to the original content
128 bool m_bBroadcastModified; // will be set if notification is required
130 bool m_bCommited; // sending the streams is coordinated by the root storage of the package
132 bool m_bIsRoot; // marks this storage as root storages that manages all commits and reverts
133 bool m_bListCreated;
135 /// Count of registered modification listeners
136 oslInterlockedCount m_nModifiedListenerCount;
137 bool HasModifiedListener()
139 return m_nModifiedListenerCount > 0 && m_pAntiImpl != nullptr;
142 SotElementVector_Impl m_aChildrenVector;
143 SotElementVector_Impl m_aDeletedVector;
145 css::uno::Reference< css::container::XNameContainer > m_xPackageFolder;
147 css::uno::Reference< css::lang::XSingleServiceFactory > m_xPackage;
148 css::uno::Reference< css::uno::XComponentContext > m_xContext;
150 // valid only for root storage
151 css::uno::Reference< css::io::XInputStream > m_xInputStream; // ??? may be stored in properties
152 css::uno::Reference< css::io::XStream > m_xStream; // ??? may be stored in properties
153 css::uno::Sequence< css::beans::PropertyValue > m_xProperties;
154 bool m_bHasCommonEncryptionData;
155 ::comphelper::SequenceAsHashMap m_aCommonEncryptionData;
157 // must be empty in case of root storage
158 OStorage_Impl* m_pParent;
160 bool m_bControlMediaType;
161 OUString m_aMediaType;
162 bool m_bMTFallbackUsed;
164 bool m_bControlVersion;
165 OUString m_aVersion;
167 SwitchablePersistenceStream* m_pSwitchStream;
169 sal_Int32 m_nStorageType; // the mode in which the storage is used
171 // the _rels substorage that is handled in a special way in embed::StorageFormats::OFOPXML
172 SotElement_Impl* m_pRelStorElement;
173 css::uno::Reference< css::embed::XStorage > m_xRelStorage;
174 css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > m_aRelInfo;
175 css::uno::Reference< css::io::XInputStream > m_xNewRelInfoStream;
176 sal_Int16 m_nRelInfoStatus;
178 // Constructors
179 OStorage_Impl( css::uno::Reference< css::io::XInputStream > const & xInputStream,
180 sal_Int32 nMode,
181 const css::uno::Sequence< css::beans::PropertyValue >& xProperties,
182 css::uno::Reference< css::uno::XComponentContext > const & xContext,
183 sal_Int32 nStorageType );
185 OStorage_Impl( css::uno::Reference< css::io::XStream > const & xStream,
186 sal_Int32 nMode,
187 const css::uno::Sequence< css::beans::PropertyValue >& xProperties,
188 css::uno::Reference< css::uno::XComponentContext > const & xContext,
189 sal_Int32 nStorageType );
191 // constructor for a substorage
192 OStorage_Impl( OStorage_Impl* pParent,
193 sal_Int32 nMode,
194 css::uno::Reference< css::container::XNameContainer > const & xPackageFolder,
195 css::uno::Reference< css::lang::XSingleServiceFactory > const & xPackage,
196 css::uno::Reference< css::uno::XComponentContext > const & xContext,
197 sal_Int32 nStorageType );
199 ~OStorage_Impl();
201 void SetReadOnlyWrap( OStorage& aStorage );
202 void RemoveReadOnlyWrap( OStorage& aStorage );
204 void OpenOwnPackage();
205 void ReadContents();
206 void ReadRelInfoIfNecessary();
208 SotElementVector_Impl& GetChildrenVector();
209 void GetStorageProperties();
211 css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > GetAllRelationshipsIfAny();
212 void CopyLastCommitTo( const css::uno::Reference< css::embed::XStorage >& xNewStor );
214 void InsertIntoPackageFolder(
215 const OUString& aName,
216 const css::uno::Reference< css::container::XNameContainer >& xParentPackageFolder );
218 void Commit();
219 void Revert();
221 /// @throws css::packages::NoEncryptionException
222 ::comphelper::SequenceAsHashMap GetCommonRootEncryptionData();
224 void CopyToStorage( const css::uno::Reference< css::embed::XStorage >& xDest,
225 bool bDirect );
226 void CopyStorageElement( SotElement_Impl* pElement,
227 const css::uno::Reference< css::embed::XStorage >& xDest,
228 const OUString& aName,
229 bool bDirect );
231 SotElement_Impl* FindElement( const OUString& rName );
233 SotElement_Impl* InsertStream( const OUString& aName, bool bEncr );
234 void InsertRawStream( const OUString& aName, const css::uno::Reference< css::io::XInputStream >& xInStream );
236 OStorage_Impl* CreateNewStorageImpl( sal_Int32 nStorageMode );
237 SotElement_Impl* InsertStorage( const OUString& aName, sal_Int32 nStorageMode );
238 SotElement_Impl* InsertElement( const OUString& aName, bool bIsStorage );
240 void OpenSubStorage( SotElement_Impl* pElement, sal_Int32 nStorageMode );
241 void OpenSubStream( SotElement_Impl* pElement );
243 css::uno::Sequence< OUString > GetElementNames();
245 void RemoveElement( SotElement_Impl* pElement );
246 static void ClearElement( SotElement_Impl* pElement );
248 /// @throws css::embed::InvalidStorageException
249 /// @throws css::lang::IllegalArgumentException
250 /// @throws css::packages::WrongPasswordException
251 /// @throws css::packages::NoEncryptionException
252 /// @throws css::container::NoSuchElementException
253 /// @throws css::io::IOException
254 /// @throws css::embed::StorageWrappedTargetException
255 /// @throws css::uno::RuntimeException
256 void CloneStreamElement(
257 const OUString& aStreamName,
258 bool bPassProvided,
259 const ::comphelper::SequenceAsHashMap& aEncryptionData,
260 css::uno::Reference< css::io::XStream >& xTargetStream );
262 void RemoveStreamRelInfo( const OUString& aOriginalName );
263 void CreateRelStorage();
264 void CommitStreamRelInfo( SotElement_Impl const * pStreamElement );
265 css::uno::Reference< css::io::XInputStream > GetRelInfoStreamForName( const OUString& aName );
266 void CommitRelInfo( const css::uno::Reference< css::container::XNameContainer >& xNewPackageFolder );
268 static void completeStorageStreamCopy_Impl(
269 const css::uno::Reference< css::io::XStream >& xSource,
270 const css::uno::Reference< css::io::XStream >& xDest,
271 sal_Int32 nStorageType,
272 const css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > >& aRelInfo );
276 class OStorage : public css::lang::XTypeProvider
277 , public css::embed::XStorage2
278 , public css::embed::XStorageRawAccess
279 , public css::embed::XTransactedObject
280 , public css::embed::XTransactionBroadcaster
281 , public css::util::XModifiable
282 , public css::embed::XEncryptionProtectedStorage
283 , public css::beans::XPropertySet
284 , public css::embed::XOptimizedStorage
285 , public css::embed::XRelationshipAccess
286 , public css::embed::XHierarchicalStorageAccess2
287 , public ::cppu::OWeakObject
289 OStorage_Impl* m_pImpl;
290 std::unique_ptr<StorInternalData_Impl> m_pData;
292 protected:
294 SotElement_Impl* OpenStreamElement_Impl( const OUString& aStreamName, sal_Int32 nOpenMode, bool bEncr );
296 void BroadcastModifiedIfNecessary();
298 void BroadcastTransaction( sal_Int8 nMessage );
300 void MakeLinkToSubComponent_Impl(
301 const css::uno::Reference< css::lang::XComponent >& xComponent );
303 public:
305 OStorage( css::uno::Reference< css::io::XInputStream > const & xInputStream,
306 sal_Int32 nMode,
307 const css::uno::Sequence< css::beans::PropertyValue >& xProperties,
308 css::uno::Reference< css::uno::XComponentContext > const & xContext,
309 sal_Int32 nStorageType );
311 OStorage( css::uno::Reference< css::io::XStream > const & xStream,
312 sal_Int32 nMode,
313 const css::uno::Sequence< css::beans::PropertyValue >& xProperties,
314 css::uno::Reference< css::uno::XComponentContext > const & xContext,
315 sal_Int32 nStorageType );
317 OStorage( OStorage_Impl* pImpl, bool bReadOnlyWrap );
319 virtual ~OStorage() override;
321 void InternalDispose( bool bNotifyImpl );
323 void ChildIsDisposed( const css::uno::Reference< css::uno::XInterface >& xChild );
325 sal_Int32 GetRefCount_Impl() { return m_refCount; }
327 // XInterface
329 virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) override;
331 virtual void SAL_CALL acquire() throw() override;
333 virtual void SAL_CALL release() throw() override;
335 // XTypeProvider
337 virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
339 virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
341 // XStorage
343 virtual void SAL_CALL copyToStorage( const css::uno::Reference< css::embed::XStorage >& xDest ) override;
345 virtual css::uno::Reference< css::io::XStream > SAL_CALL openStreamElement(
346 const OUString& aStreamName, sal_Int32 nOpenMode ) override;
348 virtual css::uno::Reference< css::io::XStream > SAL_CALL openEncryptedStreamElement(
349 const OUString& aStreamName, sal_Int32 nOpenMode, const OUString& aPass ) override;
351 virtual css::uno::Reference< css::embed::XStorage > SAL_CALL openStorageElement(
352 const OUString& aStorName, sal_Int32 nStorageMode ) override;
354 virtual css::uno::Reference< css::io::XStream > SAL_CALL cloneStreamElement(
355 const OUString& aStreamName ) override;
357 virtual css::uno::Reference< css::io::XStream > SAL_CALL cloneEncryptedStreamElement(
358 const OUString& aStreamName, const OUString& aPass ) override;
360 virtual void SAL_CALL copyLastCommitTo(
361 const css::uno::Reference< css::embed::XStorage >& xTargetStorage ) override;
363 virtual void SAL_CALL copyStorageElementLastCommitTo(
364 const OUString& aStorName,
365 const css::uno::Reference< css::embed::XStorage >& xTargetStorage ) override;
367 virtual sal_Bool SAL_CALL isStreamElement( const OUString& aElementName ) override;
369 virtual sal_Bool SAL_CALL isStorageElement( const OUString& aElementName ) override;
371 virtual void SAL_CALL removeElement( const OUString& aElementName ) override;
373 virtual void SAL_CALL renameElement( const OUString& rEleName, const OUString& rNewName ) override;
375 virtual void SAL_CALL copyElementTo( const OUString& aElementName,
376 const css::uno::Reference< css::embed::XStorage >& xDest,
377 const OUString& aNewName ) override;
379 virtual void SAL_CALL moveElementTo( const OUString& aElementName,
380 const css::uno::Reference< css::embed::XStorage >& xDest,
381 const OUString& rNewName ) override;
383 // XStorage2
385 virtual css::uno::Reference< css::io::XStream > SAL_CALL openEncryptedStream( const OUString& sStreamName, ::sal_Int32 nOpenMode, const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) override;
387 virtual css::uno::Reference< css::io::XStream > SAL_CALL cloneEncryptedStream( const OUString& sStreamName, const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) override;
389 // XStorageRawAccess
391 virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getPlainRawStreamElement(
392 const OUString& sStreamName ) override;
394 virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getRawEncrStreamElement(
395 const OUString& sStreamName ) override;
397 virtual void SAL_CALL insertRawEncrStreamElement( const OUString& aStreamName,
398 const css::uno::Reference< css::io::XInputStream >& xInStream ) override;
400 // XTransactedObject
401 virtual void SAL_CALL commit() override;
403 virtual void SAL_CALL revert() override;
405 // XTransactionBroadcaster
406 virtual void SAL_CALL addTransactionListener(
407 const css::uno::Reference< css::embed::XTransactionListener >& aListener ) override;
409 virtual void SAL_CALL removeTransactionListener(
410 const css::uno::Reference< css::embed::XTransactionListener >& aListener ) override;
412 // XModifiable
414 virtual sal_Bool SAL_CALL isModified() override;
416 virtual void SAL_CALL setModified( sal_Bool bModified ) override;
418 virtual void SAL_CALL addModifyListener(
419 const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
421 virtual void SAL_CALL removeModifyListener(
422 const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
424 // XNameAccess
426 virtual css::uno::Any SAL_CALL getByName( const OUString& aName ) override;
428 virtual css::uno::Sequence< OUString > SAL_CALL getElementNames() override;
430 virtual sal_Bool SAL_CALL hasByName( const OUString& aName ) override;
432 virtual css::uno::Type SAL_CALL getElementType() override;
434 virtual sal_Bool SAL_CALL hasElements() override;
436 // XComponent
438 virtual void SAL_CALL dispose() override;
440 virtual void SAL_CALL addEventListener(
441 const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
443 virtual void SAL_CALL removeEventListener(
444 const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
446 // XEncryptionProtectedSource
448 virtual void SAL_CALL setEncryptionPassword( const OUString& aPass ) override;
450 virtual void SAL_CALL removeEncryption() override;
452 // XEncryptionProtectedSource2
454 virtual void SAL_CALL setEncryptionData(
455 const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) override;
457 virtual sal_Bool SAL_CALL hasEncryptionData() override;
459 // XEncryptionProtectedStorage
461 virtual void SAL_CALL setEncryptionAlgorithms( const css::uno::Sequence< css::beans::NamedValue >& aAlgorithms ) override;
462 virtual void SAL_CALL setGpgProperties( const css::uno::Sequence< css::uno::Sequence< css::beans::NamedValue > >& aCryptProps ) override;
464 virtual css::uno::Sequence< css::beans::NamedValue > SAL_CALL getEncryptionAlgorithms() override;
466 // XPropertySet
468 virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
470 virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
472 virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
474 virtual void SAL_CALL addPropertyChangeListener(
475 const OUString& aPropertyName,
476 const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
478 virtual void SAL_CALL removePropertyChangeListener(
479 const OUString& aPropertyName,
480 const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
482 virtual void SAL_CALL addVetoableChangeListener(
483 const OUString& PropertyName,
484 const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
486 virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
488 // XOptimizedStorage
489 virtual void SAL_CALL insertRawNonEncrStreamElementDirect( const OUString& sStreamName, const css::uno::Reference< css::io::XInputStream >& xInStream ) override;
491 virtual void SAL_CALL insertStreamElementDirect( const OUString& sStreamName, const css::uno::Reference< css::io::XInputStream >& xInStream, const css::uno::Sequence< css::beans::PropertyValue >& aProps ) override;
493 virtual void SAL_CALL copyElementDirectlyTo( const OUString& sSourceName, const css::uno::Reference< css::embed::XOptimizedStorage >& xTargetStorage, const OUString& sTargetName ) override;
495 virtual void SAL_CALL writeAndAttachToStream( const css::uno::Reference< css::io::XStream >& xStream ) override;
497 virtual void SAL_CALL attachToURL( const OUString& sURL, sal_Bool bReadOnly ) override;
499 virtual css::uno::Any SAL_CALL getElementPropertyValue( const OUString& sElementName, const OUString& sPropertyName ) override;
501 virtual void SAL_CALL copyStreamElementData( const OUString& sStreamName, const css::uno::Reference< css::io::XStream >& xTargetStream ) override;
503 // XRelationshipAccess
504 virtual sal_Bool SAL_CALL hasByID( const OUString& sID ) override;
506 virtual OUString SAL_CALL getTargetByID( const OUString& sID ) override;
508 virtual OUString SAL_CALL getTypeByID( const OUString& sID ) override;
510 virtual css::uno::Sequence< css::beans::StringPair > SAL_CALL getRelationshipByID( const OUString& sID ) override;
512 virtual css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > SAL_CALL getRelationshipsByType( const OUString& sType ) override;
514 virtual css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > SAL_CALL getAllRelationships( ) override;
516 virtual void SAL_CALL insertRelationshipByID( const OUString& sID, const css::uno::Sequence< css::beans::StringPair >& aEntry, sal_Bool bReplace ) override;
518 virtual void SAL_CALL removeRelationshipByID( const OUString& sID ) override;
520 virtual void SAL_CALL insertRelationships( const css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > >& aEntries, sal_Bool bReplace ) override;
522 virtual void SAL_CALL clearRelationships( ) override;
524 // XHierarchicalStorageAccess
525 virtual css::uno::Reference< css::embed::XExtendedStorageStream > SAL_CALL openStreamElementByHierarchicalName( const OUString& sStreamPath, ::sal_Int32 nOpenMode ) override;
527 virtual css::uno::Reference< css::embed::XExtendedStorageStream > SAL_CALL openEncryptedStreamElementByHierarchicalName( const OUString& sStreamName, ::sal_Int32 nOpenMode, const OUString& sPassword ) override;
529 virtual void SAL_CALL removeStreamElementByHierarchicalName( const OUString& sElementPath ) override;
531 // XHierarchicalStorageAccess2
532 virtual css::uno::Reference< css::embed::XExtendedStorageStream > SAL_CALL openEncryptedStreamByHierarchicalName( const OUString& sStreamName, ::sal_Int32 nOpenMode, const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) override;
535 StorageHolder_Impl::StorageHolder_Impl( OStorage* pStorage )
536 : m_pPointer( pStorage )
537 , m_xWeakRef( css::uno::Reference< css::embed::XStorage >( pStorage ) )
541 #endif
543 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */