358 lines
15 KiB
C++
358 lines
15 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_PACKAGE_SOURCE_XSTOR_OWRITEABLESTREAM_HXX
|
|
#define INCLUDED_PACKAGE_SOURCE_XSTOR_OWRITEABLESTREAM_HXX
|
|
|
|
#include <com/sun/star/io/XInputStream.hpp>
|
|
#include <com/sun/star/io/XOutputStream.hpp>
|
|
#include <com/sun/star/io/XStream.hpp>
|
|
#include <com/sun/star/io/XSeekable.hpp>
|
|
#include <com/sun/star/io/XTruncate.hpp>
|
|
#include <com/sun/star/packages/XDataSinkEncrSupport.hpp>
|
|
#include <com/sun/star/lang/XEventListener.hpp>
|
|
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
|
|
#include <com/sun/star/embed/XEncryptionProtectedSource2.hpp>
|
|
#include <com/sun/star/embed/XStorage.hpp>
|
|
#include <com/sun/star/embed/XRelationshipAccess.hpp>
|
|
#include <com/sun/star/embed/XExtendedStorageStream.hpp>
|
|
#include <com/sun/star/embed/XTransactedObject.hpp>
|
|
#include <com/sun/star/embed/XTransactionBroadcaster.hpp>
|
|
#include <com/sun/star/container/XNameContainer.hpp>
|
|
#include <com/sun/star/beans/StringPair.hpp>
|
|
|
|
#include <cppuhelper/weak.hxx>
|
|
#include <cppuhelper/typeprovider.hxx>
|
|
#include <comphelper/multicontainer2.hxx>
|
|
|
|
#include <comphelper/bytereader.hxx>
|
|
#include <comphelper/refcountedmutex.hxx>
|
|
#include <comphelper/sequenceashashmap.hxx>
|
|
#include <unotools/tempfile.hxx>
|
|
|
|
#include <vector>
|
|
#include <memory>
|
|
#include <string_view>
|
|
|
|
#include "ocompinstream.hxx"
|
|
|
|
namespace com::sun::star::uno {
|
|
class XComponentContext;
|
|
}
|
|
|
|
namespace package {
|
|
// all data in aHash1 is contained in aHash2
|
|
bool PackageEncryptionDataLessOrEqual( const ::comphelper::SequenceAsHashMap& aHash1, const ::comphelper::SequenceAsHashMap& aHash2 );
|
|
}
|
|
|
|
struct OStorage_Impl;
|
|
class OWriteStream;
|
|
|
|
struct OWriteStream_Impl
|
|
{
|
|
rtl::Reference<comphelper::RefCountedMutex> m_xMutex;
|
|
|
|
friend struct OStorage_Impl;
|
|
friend class OWriteStream;
|
|
friend class OInputCompStream;
|
|
|
|
OWriteStream* m_pAntiImpl;
|
|
std::optional<utl::TempFileFast> m_oTempFile;
|
|
|
|
css::uno::Reference< css::io::XStream > m_xCacheStream;
|
|
css::uno::Reference< css::io::XSeekable > m_xCacheSeek;
|
|
|
|
std::vector< OInputCompStream* > m_aInputStreamsVector;
|
|
|
|
bool m_bHasDataToFlush; // only modified elements will be sent to the original content
|
|
bool m_bFlushed; // sending the streams is coordinated by the root storage of the package
|
|
|
|
css::uno::Reference< css::packages::XDataSinkEncrSupport > m_xPackageStream;
|
|
|
|
css::uno::Reference< css::uno::XComponentContext > m_xContext;
|
|
|
|
OStorage_Impl* m_pParent;
|
|
|
|
css::uno::Sequence< css::beans::PropertyValue > m_aProps;
|
|
|
|
bool m_bForceEncrypted;
|
|
|
|
bool m_bUseCommonEncryption;
|
|
bool m_bHasCachedEncryptionData;
|
|
::comphelper::SequenceAsHashMap m_aEncryptionData;
|
|
|
|
bool m_bCompressedSetExplicit;
|
|
|
|
css::uno::Reference< css::lang::XSingleServiceFactory > m_xPackage;
|
|
|
|
bool m_bHasInsertedStreamOptimization;
|
|
|
|
sal_Int32 m_nStorageType;
|
|
|
|
// Relations info related data, stored in *.rels file in OFOPXML format
|
|
css::uno::Reference< css::io::XInputStream > m_xOrigRelInfoStream;
|
|
css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > m_aOrigRelInfo;
|
|
bool m_bOrigRelInfoBroken;
|
|
|
|
css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > m_aNewRelInfo;
|
|
css::uno::Reference< css::io::XInputStream > m_xNewRelInfoStream;
|
|
sal_Int16 m_nRelInfoStatus;
|
|
sal_Int32 m_nRelId;
|
|
|
|
private:
|
|
void GetFilledTempFileIfNo( const css::uno::Reference< css::io::XInputStream >& xStream );
|
|
void FillTempGetFileName();
|
|
css::uno::Reference< css::io::XStream > GetTempFileAsStream();
|
|
css::uno::Reference< css::io::XInputStream > GetTempFileAsInputStream();
|
|
|
|
css::uno::Reference< css::io::XStream > GetStream_Impl( sal_Int32 nStreamMode,
|
|
bool bHierarchyAccess );
|
|
|
|
/// @throws css::packages::NoEncryptionException
|
|
::comphelper::SequenceAsHashMap GetCommonRootEncryptionData();
|
|
|
|
css::uno::Sequence< css::beans::PropertyValue > ReadPackageStreamProperties();
|
|
css::uno::Sequence< css::beans::PropertyValue > InsertOwnProps(
|
|
const css::uno::Sequence< css::beans::PropertyValue >& aProps,
|
|
bool bUseCommonEncryption );
|
|
|
|
public:
|
|
OWriteStream_Impl(
|
|
OStorage_Impl* pParent,
|
|
const css::uno::Reference< css::packages::XDataSinkEncrSupport >& xPackageStream,
|
|
const css::uno::Reference< css::lang::XSingleServiceFactory >& xPackage,
|
|
css::uno::Reference< css::uno::XComponentContext > xContext,
|
|
bool bForceEncrypted,
|
|
sal_Int32 nStorageType,
|
|
bool bDefaultCompress,
|
|
css::uno::Reference< css::io::XInputStream > xRelInfoStream =
|
|
css::uno::Reference< css::io::XInputStream >() );
|
|
|
|
~OWriteStream_Impl();
|
|
|
|
void CleanCacheStream();
|
|
|
|
bool UsesCommonEncryption_Impl() const { return m_bUseCommonEncryption; }
|
|
bool HasTempFile_Impl() const { return m_oTempFile.has_value(); }
|
|
bool IsTransacted();
|
|
|
|
bool HasWriteOwner_Impl() const { return ( m_pAntiImpl != nullptr ); }
|
|
|
|
void InsertIntoPackageFolder(
|
|
const OUString& aName,
|
|
const css::uno::Reference< css::container::XNameContainer >& xParentPackageFolder );
|
|
|
|
void SetToBeCommited() { m_bFlushed = true; }
|
|
|
|
bool HasCachedEncryptionData() const { return m_bHasCachedEncryptionData; }
|
|
::comphelper::SequenceAsHashMap& GetCachedEncryptionData() { return m_aEncryptionData; }
|
|
|
|
bool IsModified() const { return m_bHasDataToFlush || m_bFlushed; }
|
|
|
|
bool IsEncrypted();
|
|
void SetDecrypted();
|
|
void SetEncrypted( const ::comphelper::SequenceAsHashMap& aEncryptionData );
|
|
|
|
void DisposeWrappers();
|
|
|
|
void InsertStreamDirectly(
|
|
const css::uno::Reference< css::io::XInputStream >& xInStream,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& aProps );
|
|
|
|
void Commit();
|
|
void Revert();
|
|
|
|
css::uno::Sequence< css::beans::PropertyValue > const & GetStreamProperties();
|
|
|
|
css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > GetAllRelationshipsIfAny();
|
|
|
|
void CopyInternallyTo_Impl( const css::uno::Reference< css::io::XStream >& xDestStream,
|
|
const ::comphelper::SequenceAsHashMap& aEncryptionData );
|
|
void CopyInternallyTo_Impl( const css::uno::Reference< css::io::XStream >& xDestStream );
|
|
|
|
css::uno::Reference< css::io::XStream > GetStream(
|
|
sal_Int32 nStreamMode,
|
|
const ::comphelper::SequenceAsHashMap& aEncryptionData,
|
|
bool bHierarchyAccess );
|
|
|
|
css::uno::Reference< css::io::XStream > GetStream(
|
|
sal_Int32 nStreamMode,
|
|
bool bHierarchyAccess );
|
|
|
|
css::uno::Reference< css::io::XInputStream > GetRawInStream();
|
|
css::uno::Reference< css::io::XInputStream > GetPlainRawInStream();
|
|
|
|
void InputStreamDisposed( OInputCompStream* pStream );
|
|
|
|
void CreateReadonlyCopyBasedOnData(
|
|
const css::uno::Reference< css::io::XInputStream >& xDataToCopy,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& aProps,
|
|
css::uno::Reference< css::io::XStream >& xTargetStream );
|
|
|
|
void GetCopyOfLastCommit( css::uno::Reference< css::io::XStream >& xTargetStream );
|
|
void GetCopyOfLastCommit(
|
|
css::uno::Reference< css::io::XStream >& xTargetStream,
|
|
const ::comphelper::SequenceAsHashMap& aEncryptionData );
|
|
|
|
void CommitStreamRelInfo(
|
|
const css::uno::Reference< css::embed::XStorage >& xRelStorage,
|
|
std::u16string_view aOrigStreamName,
|
|
std::u16string_view aNewStreamName );
|
|
|
|
void ReadRelInfoIfNecessary();
|
|
|
|
sal_Int32 GetNewRelId() { return m_nRelId ++; }
|
|
};
|
|
|
|
class OWriteStream : public css::lang::XTypeProvider
|
|
, public css::io::XInputStream
|
|
, public css::io::XOutputStream
|
|
, public css::embed::XExtendedStorageStream
|
|
, public css::io::XSeekable
|
|
, public css::io::XTruncate
|
|
, public css::embed::XEncryptionProtectedSource2
|
|
, public css::embed::XRelationshipAccess
|
|
, public css::embed::XTransactedObject
|
|
, public css::embed::XTransactionBroadcaster
|
|
, public css::beans::XPropertySet
|
|
, public ::cppu::OWeakObject
|
|
, public comphelper::ByteWriter
|
|
{
|
|
friend struct OWriteStream_Impl;
|
|
|
|
protected:
|
|
css::uno::Reference < css::io::XInputStream > m_xInStream;
|
|
css::uno::Reference < css::io::XOutputStream > m_xOutStream;
|
|
css::uno::Reference < css::io::XSeekable > m_xSeekable;
|
|
|
|
OWriteStream_Impl* m_pImpl;
|
|
rtl::Reference<comphelper::RefCountedMutex> m_xSharedMutex;
|
|
::std::optional< ::cppu::OTypeCollection> m_oTypeCollection;
|
|
comphelper::OMultiTypeInterfaceContainerHelper2 m_aListenersContainer; // list of listeners
|
|
sal_Int32 m_nStorageType;
|
|
|
|
bool m_bInStreamDisconnected;
|
|
bool m_bInitOnDemand;
|
|
sal_Int64 m_nInitPosition;
|
|
|
|
bool m_bTransacted;
|
|
|
|
OWriteStream( OWriteStream_Impl& rImpl, bool bTransacted );
|
|
OWriteStream( OWriteStream_Impl& rImpl, css::uno::Reference< css::io::XStream > const & xStream, bool bTransacted );
|
|
|
|
void CloseOutput_Impl();
|
|
|
|
void CopyToStreamInternally_Impl( const css::uno::Reference< css::io::XStream >& xStream );
|
|
|
|
void ModifyParentUnlockMutex_Impl(osl::ClearableMutexGuard& aGuard);
|
|
|
|
void BroadcastTransaction( sal_Int8 nMessage );
|
|
|
|
public:
|
|
|
|
virtual ~OWriteStream() override;
|
|
|
|
void CheckInitOnDemand();
|
|
void DeInit();
|
|
|
|
// XInterface
|
|
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) override;
|
|
virtual void SAL_CALL acquire() noexcept override;
|
|
virtual void SAL_CALL release() noexcept override;
|
|
|
|
// XTypeProvider
|
|
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
|
|
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
|
|
|
|
// XInputStream
|
|
virtual sal_Int32 SAL_CALL readBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead ) override;
|
|
virtual sal_Int32 SAL_CALL readSomeBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead ) override;
|
|
virtual void SAL_CALL skipBytes( sal_Int32 nBytesToSkip ) override;
|
|
virtual sal_Int32 SAL_CALL available( ) override;
|
|
virtual void SAL_CALL closeInput( ) override;
|
|
|
|
// XOutputStream
|
|
virtual void SAL_CALL writeBytes( const css::uno::Sequence< sal_Int8 >& aData ) override;
|
|
virtual void SAL_CALL flush( ) override;
|
|
virtual void SAL_CALL closeOutput( ) override;
|
|
|
|
//XSeekable
|
|
virtual void SAL_CALL seek( sal_Int64 location ) override;
|
|
virtual sal_Int64 SAL_CALL getPosition() override;
|
|
virtual sal_Int64 SAL_CALL getLength() override;
|
|
|
|
//XStream
|
|
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getInputStream( ) override;
|
|
virtual css::uno::Reference< css::io::XOutputStream > SAL_CALL getOutputStream( ) override;
|
|
|
|
// XTruncate
|
|
virtual void SAL_CALL truncate() override;
|
|
|
|
//XComponent
|
|
virtual void SAL_CALL dispose() override;
|
|
virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
|
|
virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
|
|
|
|
//XEncryptionProtectedSource
|
|
virtual void SAL_CALL setEncryptionPassword( const OUString& aPass ) override;
|
|
virtual void SAL_CALL removeEncryption() override;
|
|
|
|
//XEncryptionProtectedSource2
|
|
virtual void SAL_CALL setEncryptionData( const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) override;
|
|
virtual sal_Bool SAL_CALL hasEncryptionData() override;
|
|
|
|
//XRelationshipAccess
|
|
virtual sal_Bool SAL_CALL hasByID( const OUString& sID ) override;
|
|
virtual OUString SAL_CALL getTargetByID( const OUString& sID ) override;
|
|
virtual OUString SAL_CALL getTypeByID( const OUString& sID ) override;
|
|
virtual css::uno::Sequence< css::beans::StringPair > SAL_CALL getRelationshipByID( const OUString& sID ) override;
|
|
virtual css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > SAL_CALL getRelationshipsByType( const OUString& sType ) override;
|
|
virtual css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > SAL_CALL getAllRelationships( ) override;
|
|
virtual void SAL_CALL insertRelationshipByID( const OUString& sID, const css::uno::Sequence< css::beans::StringPair >& aEntry, sal_Bool bReplace ) override;
|
|
virtual void SAL_CALL removeRelationshipByID( const OUString& sID ) override;
|
|
virtual void SAL_CALL insertRelationships( const css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > >& aEntries, sal_Bool bReplace ) override;
|
|
virtual void SAL_CALL clearRelationships( ) override;
|
|
|
|
//XPropertySet
|
|
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
|
|
virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
|
|
virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
|
|
virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
|
|
virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
|
|
virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
|
|
virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
|
|
|
|
// XTransactedObject
|
|
virtual void SAL_CALL commit() override;
|
|
virtual void SAL_CALL revert() override;
|
|
|
|
// XTransactionBroadcaster
|
|
virtual void SAL_CALL addTransactionListener(
|
|
const css::uno::Reference< css::embed::XTransactionListener >& aListener ) override;
|
|
virtual void SAL_CALL removeTransactionListener(
|
|
const css::uno::Reference< css::embed::XTransactionListener >& aListener ) override;
|
|
|
|
// comphelper::ByteWriter
|
|
virtual void writeBytes(const sal_Int8* aData, sal_Int32 nBytesToWrite) override;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|