1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/* -*- 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_SFX2_DOCFILE_HXX
#define INCLUDED_SFX2_DOCFILE_HXX
#include <memory>
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sfx2/signaturestate.hxx>
#include <svl/lockfilecommon.hxx>
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <svl/itemset.hxx>
#include <tools/link.hxx>
#include <tools/stream.hxx>
#include <mutex>
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::embed { class XStorage; }
namespace com::sun::star::graphic { class XGraphic; }
namespace com::sun::star::io { class XInputStream; }
namespace com::sun::star::security { class XCertificate; }
namespace com::sun::star::task { class XInteractionHandler; }
namespace com::sun::star::ucb { class XCommandEnvironment; }
namespace com::sun::star::ucb { class XContent; }
namespace com::sun::star::util { struct DateTime; }
namespace com::sun::star::util { struct RevisionTag; }
namespace com::sun::star::frame
{
class XModel;
}
namespace ucbhelper { class Content; }
class SvKeyValueIterator;
class SfxFilter;
class SfxMedium_Impl;
class INetURLObject;
class SfxFrame;
class DateTime;
struct ImplSVEvent;
namespace weld
{
class Window;
}
class SFX2_DLLPUBLIC SfxMedium final : public SvRefBase
{
std::unique_ptr< SfxMedium_Impl > pImpl;
SAL_DLLPRIVATE void SetIsRemote_Impl();
SAL_DLLPRIVATE void CloseInStream_Impl(bool bInDestruction = false);
SAL_DLLPRIVATE void CloseOutStream_Impl();
SAL_DLLPRIVATE void CloseStreams_Impl(bool bInDestruction = false);
SAL_DLLPRIVATE bool SetEncryptionDataToStorage_Impl();
public:
SfxMedium();
SfxMedium( const OUString &rName,
StreamMode nOpenMode,
std::shared_ptr<const SfxFilter> pFilter = nullptr,
const std::shared_ptr<SfxItemSet>& pSet = nullptr );
SfxMedium( const OUString &rName,
const OUString &rReferer,
StreamMode nOpenMode,
std::shared_ptr<const SfxFilter> pFilter = nullptr,
const std::shared_ptr<SfxItemSet>& pSet = nullptr );
SfxMedium( const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& rBaseURL,
const std::shared_ptr<SfxItemSet>& pSet = nullptr );
SfxMedium( const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& rBaseURL,
const OUString& rTypeName,
const std::shared_ptr<SfxItemSet>& pSet = nullptr );
SfxMedium( const css::uno::Sequence< css::beans::PropertyValue >& aArgs );
virtual ~SfxMedium() override;
DECL_DLLPRIVATE_STATIC_LINK(SfxMedium, ShowReloadEditableDialog, void*, void);
bool CheckCanGetLockfile() const;
void SetOriginallyReadOnly(bool val);
void AddToCheckEditableWorkerList();
void SetWorkerReloadEvent(ImplSVEvent* pEvent);
ImplSVEvent* GetWorkerReloadEvent() const;
const std::shared_ptr<std::recursive_mutex>& GetCheckEditableMutex() const;
void CancelCheckEditableEntry(bool bRemoveEvent = true);
void UseInteractionHandler( bool );
css::uno::Reference< css::task::XInteractionHandler >
GetInteractionHandler( bool bGetAlways = false );
void setStreamToLoadFrom(
const css::uno::Reference<css::io::XInputStream>& xInputStream,
bool bIsReadOnly);
void SetLoadTargetFrame(SfxFrame* pFrame );
SfxFrame* GetLoadTargetFrame() const;
/**
* Does not take ownership of pFlt but pFlt needs to be around as long as the SfxMedium instance.
*/
void SetFilter(const std::shared_ptr<const SfxFilter>& pFilter);
const std::shared_ptr<const SfxFilter>& GetFilter() const;
const OUString& GetOrigURL() const;
SfxItemSet& GetItemSet() const;
void SetArgs(const css::uno::Sequence<css::beans::PropertyValue>& rArgs);
const css::uno::Sequence<css::beans::PropertyValue> & GetArgs() const;
void Close(bool bInDestruction = false);
void CloseAndRelease();
void ReOpen();
void CompleteReOpen();
const OUString& GetName() const;
const INetURLObject& GetURLObject() const;
void CheckFileDate( const css::util::DateTime& aInitDate );
[[nodiscard]] bool DocNeedsFileDateCheck() const;
css::util::DateTime const & GetInitFileDate( bool bIgnoreOldValue );
css::uno::Reference< css::ucb::XContent > GetContent() const;
const OUString& GetPhysicalName() const;
[[nodiscard]] bool IsRemote() const;
[[nodiscard]] bool IsOpen() const; // { return aStorage.Is() || pInStream; }
void Download( const Link<void*,void>& aLink = Link<void*,void>());
void SetDoneLink( const Link<void*,void>& rLink );
ErrCodeMsg GetErrorCode() const;
ErrCodeMsg GetErrorIgnoreWarning() const
{ return GetErrorCode().IgnoreWarning(); }
ErrCodeMsg const & GetWarningError() const;
ErrCodeMsg const & GetLastStorageCreationState() const;
void SetError(ErrCodeMsg nError);
void SetWarningError(const ErrCodeMsg& nWarningError);
void CloseInStream();
void CloseOutStream();
void CloseStorage();
StreamMode GetOpenMode() const;
void SetOpenMode( StreamMode nStorOpen, bool bDontClose = false );
SvStream* GetInStream();
SvStream* GetOutStream();
bool Commit();
bool IsStorage();
enum class LockFileResult
{
Failed,
FailedLockFile, // there was only lock file that prevented success - no syslock or IO error
Succeeded,
};
LockFileResult LockOrigFileOnDemand(bool bLoading, bool bNoUI, bool bTryIgnoreLockFile = false,
LockFileEntry* pLockData = nullptr);
void DisableUnlockWebDAV( bool bDisableUnlockWebDAV = true );
void UnlockFile( bool bReleaseLockStream );
/// Lets Transfer_Impl() not fsync the output file.
void DisableFileSync(bool bDisableFileSync);
css::uno::Reference< css::embed::XStorage > GetStorage( bool bCreateTempFile = true );
css::uno::Reference< css::embed::XStorage > GetOutputStorage();
void ResetError();
[[nodiscard]] bool IsExpired() const;
void SetName( const OUString& rName, bool bSetOrigURL = false );
const css::uno::Sequence < css::util::RevisionTag >&
GetVersionList( bool _bNoReload = false );
[[nodiscard]] bool IsReadOnly() const;
// Whether the medium had originally been opened r/o (either because it is
// "physically" r/o, or because it was requested to be opened r/o,
// independent of later changes via SetOpenMode; used to keep track of the
// "true" state of the medium across toggles via SID_EDITDOC (which do
// change SetOpenMode):
[[nodiscard]] bool IsOriginallyReadOnly() const;
// Whether the medium had originally been requested to be opened r/o,
// independent of later changes via SetOpenMode; used for SID_RELOAD:
[[nodiscard]] bool IsOriginallyLoadedReadOnly() const;
[[nodiscard]] bool IsRepairPackage() const;
css::uno::Reference< css::io::XInputStream > const & GetInputStream();
void CreateTempFile( bool bReplace = true );
void CreateTempFileNoCopy();
OUString SwitchDocumentToTempFile();
bool SwitchDocumentToFile( const OUString& aURL );
OUString GetBaseURL( bool bForSaving=false );
void SetInCheckIn( bool bInCheckIn );
bool IsInCheckIn( ) const;
bool IsSkipImages( ) const;
SAL_DLLPRIVATE bool HasStorage_Impl() const;
SAL_DLLPRIVATE void StorageBackup_Impl();
SAL_DLLPRIVATE OUString const & GetBackup_Impl();
SAL_DLLPRIVATE css::uno::Reference< css::embed::XStorage > const & GetZipStorageToSign_Impl( bool bReadOnly = true );
SAL_DLLPRIVATE css::uno::Reference<css::embed::XStorage> GetScriptingStorageToSign_Impl();
SAL_DLLPRIVATE void CloseZipStorage_Impl();
// the storage that will be returned by the medium on GetStorage request
SAL_DLLPRIVATE void SetStorage_Impl( const css::uno::Reference< css::embed::XStorage >& xNewStorage );
SAL_DLLPRIVATE void SetInnerStorage_Impl(const css::uno::Reference<css::embed::XStorage>& xStorage);
SAL_DLLPRIVATE css::uno::Reference<css::embed::XStorage>
TryEncryptedInnerPackage(css::uno::Reference<css::embed::XStorage> xStorage);
SAL_DLLPRIVATE void CloseAndReleaseStreams_Impl();
SAL_DLLPRIVATE void AddVersion_Impl( css::util::RevisionTag& rVersion );
SAL_DLLPRIVATE bool TransferVersionList_Impl( SfxMedium const & rMedium );
SAL_DLLPRIVATE void SaveVersionList_Impl();
SAL_DLLPRIVATE void RemoveVersion_Impl( const OUString& rVersion );
SAL_DLLPRIVATE void SetExpired_Impl( const DateTime& rDateTime );
SAL_DLLPRIVATE SvKeyValueIterator* GetHeaderAttributes_Impl();
SAL_DLLPRIVATE void Init_Impl();
SAL_DLLPRIVATE void GetLockingStream_Impl();
SAL_DLLPRIVATE void GetMedium_Impl();
SAL_DLLPRIVATE bool TryDirectTransfer( const OUString& aURL, SfxItemSet const & aTargetSet );
SAL_DLLPRIVATE void Transfer_Impl();
SAL_DLLPRIVATE void CreateFileStream();
SAL_DLLPRIVATE void SetUpdatePickList(bool);
SAL_DLLPRIVATE bool IsUpdatePickList() const;
SAL_DLLPRIVATE void SetLongName(const OUString &rName);
SAL_DLLPRIVATE const OUString & GetLongName() const;
SAL_DLLPRIVATE bool IsPreview_Impl() const;
SAL_DLLPRIVATE void ClearBackup_Impl();
SAL_DLLPRIVATE void SetPhysicalName_Impl(const OUString& rName);
SAL_DLLPRIVATE void CanDisposeStorage_Impl( bool bDisposeStorage );
SAL_DLLPRIVATE bool WillDisposeStorageOnClose_Impl();
SAL_DLLPRIVATE void DoBackup_Impl(bool bForceUsingBackupPath);
SAL_DLLPRIVATE void DoInternalBackup_Impl( const ::ucbhelper::Content& aOriginalContent );
SAL_DLLPRIVATE void DoInternalBackup_Impl( const ::ucbhelper::Content& aOriginalContent,
std::u16string_view aPrefix,
std::u16string_view aExtension,
const OUString& aDestDir );
SAL_DLLPRIVATE bool UseBackupToRestore_Impl( ::ucbhelper::Content& aOriginalContent,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xComEnv );
SAL_DLLPRIVATE bool StorageCommit_Impl();
SAL_DLLPRIVATE void TransactedTransferForFS_Impl( const INetURLObject& aSource,
const INetURLObject& aDest,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xComEnv );
SAL_DLLPRIVATE bool
SignContents_Impl(weld::Window* pDialogParent,
bool bSignScriptingContent, bool bHasValidDocumentSignature,
const OUString& aSignatureLineId = OUString(),
const css::uno::Reference<css::security::XCertificate>& xCert
= css::uno::Reference<css::security::XCertificate>(),
const css::uno::Reference<css::graphic::XGraphic>& xValidGraphic
= css::uno::Reference<css::graphic::XGraphic>(),
const css::uno::Reference<css::graphic::XGraphic>& xInvalidGraphic
= css::uno::Reference<css::graphic::XGraphic>(),
const OUString& aComment = OUString());
SAL_DLLPRIVATE bool SignDocumentContentUsingCertificate(
const css::uno::Reference<css::frame::XModel>& xModel, bool bHasValidDocumentSignature,
const css::uno::Reference<css::security::XCertificate>& xCertificate);
// the following two methods must be used and make sense only during saving currently
// TODO/LATER: in future the signature state should be controlled by the medium not by the document
// in this case the methods will be used generally, and might need to be renamed
SAL_DLLPRIVATE SignatureState GetCachedSignatureState_Impl() const;
SAL_DLLPRIVATE void SetCachedSignatureState_Impl( SignatureState nState );
void SetHasEmbeddedObjects(bool bHasEmbeddedObjects);
static css::uno::Sequence < css::util::RevisionTag > GetVersionList(
const css::uno::Reference< css::embed::XStorage >& xStorage );
static OUString CreateTempCopyWithExt( std::u16string_view aURL );
static bool CallApproveHandler(const css::uno::Reference< css::task::XInteractionHandler >& xHandler, const css::uno::Any& rRequest, bool bAllowAbort);
static bool SetWritableForUserOnly( const OUString& aURL );
static sal_uInt32 CreatePasswordToModifyHash( std::u16string_view aPasswd, bool bWriter );
private:
enum class ShowLockResult { NoLock, Succeeded, Try };
ShowLockResult ShowLockedDocumentDialog(const LockFileEntry& aData,
bool bIsLoading, bool bOwnLock, bool bHandleSysLocked);
enum class MessageDlg { LockFileIgnore, LockFileCorrupt };
bool ShowLockFileProblemDialog(MessageDlg nWhichDlg);
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
