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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
|
/* -*- 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_UCB_SOURCE_UCP_FILE_SHELL_HXX
#define INCLUDED_UCB_SOURCE_UCP_FILE_SHELL_HXX
#include <cppuhelper/weak.hxx>
#include <cppuhelper/interfacecontainer.hxx>
#include <cppuhelper/typeprovider.hxx>
#include <vector>
#include <boost/unordered_map.hpp>
#include <boost/unordered_set.hpp>
#include <list>
#include <osl/file.hxx>
#include "osl/mutex.hxx"
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/beans/PropertyChangeEvent.hpp>
#include <com/sun/star/ucb/XCommandInfo.hpp>
#include <com/sun/star/beans/Property.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/ucb/XCommandProcessor.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#include <com/sun/star/beans/XPropertiesChangeNotifier.hpp>
#include <com/sun/star/ucb/NumberedSortingInfo.hpp>
#include <com/sun/star/sdbc/XRow.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/ucb/XContentProvider.hpp>
#include <com/sun/star/ucb/XDynamicResultSet.hpp>
#include <com/sun/star/beans/XPropertyContainer.hpp>
#include <com/sun/star/beans/XPropertyAccess.hpp>
#include <com/sun/star/ucb/XPropertySetRegistryFactory.hpp>
#include <com/sun/star/ucb/TransferInfo.hpp>
#include <com/sun/star/ucb/ContentInfo.hpp>
#include "filtask.hxx"
#include "filnot.hxx"
namespace fileaccess {
class FileProvider;
class XPropertySetInfo_impl;
class XCommandInfo_impl;
class XResultSet_impl;
class shell;
class shell
: public virtual TaskManager
{
friend class XPropertySetInfo_impl;
friend class XResultSet_impl;
friend class XCommandInfo_impl;
public:
// Type definitions
class MyProperty
{
private:
OUString PropertyName;
sal_Int32 Handle;
bool isNative;
com::sun::star::uno::Type Typ; // Duplicates information in Value
com::sun::star::uno::Any Value;
com::sun::star::beans::PropertyState State;
sal_Int16 Attributes;
public:
MyProperty();
MyProperty( const OUString& __PropertyName );
MyProperty( const bool& __isNative,
const OUString& __PropertyName,
const sal_Int32& __Handle,
const com::sun::star::uno::Type& __Typ,
const com::sun::star::uno::Any& __Value,
const com::sun::star::beans::PropertyState& __State,
const sal_Int16& __Attributes );
~MyProperty();
inline const bool& SAL_CALL IsNative() const;
inline const OUString& SAL_CALL getPropertyName() const { return PropertyName; }
inline const sal_Int32& SAL_CALL getHandle() const;
inline const com::sun::star::uno::Type& SAL_CALL getType() const;
inline const com::sun::star::uno::Any& SAL_CALL getValue() const;
inline const com::sun::star::beans::PropertyState& SAL_CALL getState() const;
inline const sal_Int16& SAL_CALL getAttributes() const;
// The set* functions are declared const, because the key of "this" stays intact
inline void SAL_CALL setHandle( const sal_Int32& __Handle ) const;
inline void SAL_CALL setType( const com::sun::star::uno::Type& __Type ) const;
inline void SAL_CALL setValue( const com::sun::star::uno::Any& __Value ) const;
inline void SAL_CALL setState( const com::sun::star::beans::PropertyState& __State ) const;
inline void SAL_CALL setAttributes( const sal_Int16& __Attributes ) const;
};
struct eMyProperty
{
bool operator()( const MyProperty& rKey1, const MyProperty& rKey2 ) const
{
return !!( rKey1.getPropertyName() == rKey2.getPropertyName() );
}
};
struct hMyProperty
{
size_t operator()( const MyProperty& rName ) const
{
return rName.getPropertyName().hashCode();
}
};
typedef boost::unordered_set< MyProperty,hMyProperty,eMyProperty > PropertySet;
typedef std::list< Notifier* > NotifierList;
class UnqPathData
{
public:
UnqPathData();
~UnqPathData();
UnqPathData( const UnqPathData& );
UnqPathData& operator=( UnqPathData& );
PropertySet* properties;
NotifierList* notifier;
// Three views on the PersistentPropertySet
com::sun::star::uno::Reference< com::sun::star::ucb::XPersistentPropertySet > xS;
com::sun::star::uno::Reference< com::sun::star::beans::XPropertyContainer > xC;
com::sun::star::uno::Reference< com::sun::star::beans::XPropertyAccess > xA;
};
typedef boost::unordered_map< OUString,UnqPathData,OUStringHash > ContentMap;
public:
// MethodenDefinitionen
shell( const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& rxContext,
FileProvider* pProvider, bool bWithConfig );
virtual ~shell();
/**
* This two methods register and deregister a change listener for the content belonging
* to URL aUnqPath
*/
void SAL_CALL registerNotifier( const OUString& aUnqPath,Notifier* pNotifier );
void SAL_CALL deregisterNotifier( const OUString& aUnqPath,Notifier* pNotifier );
/**
* Used to associate and deassociate a new property with
* the content belonging to URL UnqPath.
* The default value and the attributes are input
*/
void SAL_CALL associate( const OUString& UnqPath,
const OUString& PropertyName,
const com::sun::star::uno::Any& DefaultValue,
const sal_Int16 Attributes )
throw( com::sun::star::beans::PropertyExistException,
com::sun::star::beans::IllegalTypeException,
com::sun::star::uno::RuntimeException);
void SAL_CALL deassociate( const OUString& UnqPath,
const OUString& PropertyName )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::NotRemoveableException,
com::sun::star::uno::RuntimeException);
// Every method having a command id is not allowed to throw anything,
// but instead must install every error code in the task handler
/**
* Given an xOutputStream, this method writes the content of the file belonging to
* URL aUnqPath into the XOutputStream
*/
void SAL_CALL page( sal_Int32 CommandId,
const OUString& aUnqPath,
const com::sun::star::uno::Reference< com::sun::star::io::XOutputStream >& xOutputStream )
throw();
/**
* Given a file URL aUnqPath, this methods returns a XInputStream which reads from the open file.
*/
com::sun::star::uno::Reference< com::sun::star::io::XInputStream > SAL_CALL
open( sal_Int32 CommandId,
const OUString& aUnqPath,
bool bLock )
throw();
/**
* Given a file URL aUnqPath, this methods returns a XStream which can be used
* to read and write from/to the file.
*/
com::sun::star::uno::Reference< com::sun::star::io::XStream > SAL_CALL
open_rw( sal_Int32 CommandId,
const OUString& aUnqPath,
bool bLock )
throw();
/**
* This method returns the result set containing the children of the directory belonging
* to file URL aUnqPath
*/
com::sun::star::uno::Reference< com::sun::star::ucb::XDynamicResultSet > SAL_CALL
ls( sal_Int32 CommandId,
const OUString& aUnqPath,
const sal_Int32 OpenMode,
const com::sun::star::uno::Sequence< com::sun::star::beans::Property >& sProperty,
const com::sun::star::uno::Sequence< com::sun::star::ucb::NumberedSortingInfo > & sSortingInfo )
throw();
/**
* Info methods
*/
// Info for commands
com::sun::star::uno::Reference< com::sun::star::ucb::XCommandInfo > SAL_CALL
info_c()
throw();
// Info for the properties
com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo > SAL_CALL
info_p( const OUString& aUnqPath )
throw();
/**
* Sets the values of the properties belonging to fileURL aUnqPath
*/
com::sun::star::uno::Sequence< com::sun::star::uno::Any > SAL_CALL
setv( const OUString& aUnqPath,
const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& values )
throw();
/**
* Reads the values of the properties belonging to fileURL aUnqPath;
* Returns an XRow object containing the values in the requested order.
*/
com::sun::star::uno::Reference< com::sun::star::sdbc::XRow > SAL_CALL
getv( sal_Int32 CommandId,
const OUString& aUnqPath,
const com::sun::star::uno::Sequence< com::sun::star::beans::Property >& properties )
throw();
/********************************************************************************/
/* transfer-commands */
/********************************************************************************/
/**
* Moves the content belonging to fileURL srcUnqPath to fileURL dstUnqPath( files and directories )
*/
void SAL_CALL
move( sal_Int32 CommandId,
const OUString& srcUnqPath, // Full file(folder)-path
const OUString& dstUnqPath, // Path to the destination-directory
const sal_Int32 NameClash )
throw();
/**
* Copies the content belonging to fileURL srcUnqPath to fileURL dstUnqPath ( files and directories )
*/
void SAL_CALL
copy( sal_Int32 CommandId, // See "move"
const OUString& srcUnqPath,
const OUString& dstUnqPath,
sal_Int32 NameClash )
throw();
#define RemoveFolder 1
#define RemoveFile -1
#define RemoveUnknown 0
/**
* Deletes the content belonging to fileURL aUnqPath( recursively in case of directory )
*/
bool SAL_CALL
remove( sal_Int32 CommandId,
const OUString& aUnqPath,
sal_Int32 TypeToMove = RemoveUnknown,
bool MustExist = true )
throw();
#undef RemoveUnknown
#undef RemoveFile
#undef RemoveFolder
/********************************************************************************/
/* write and create - commandos */
/********************************************************************************/
/**
* Creates new directory with given URL, recursively if necessary
* Return:: success of operation
*/
bool SAL_CALL
mkdir( sal_Int32 CommandId,
const OUString& aDirectoryName,
bool OverWrite )
throw();
/**
* Creates new file with given URL.
* The content of aInputStream becomes the content of the file
* Return:: success of operation
*/
bool SAL_CALL
mkfil( sal_Int32 CommandId,
const OUString& aFileName,
bool OverWrite,
const com::sun::star::uno::Reference< com::sun::star::io::XInputStream >& aInputStream )
throw();
/**
* writes to the file with given URL.
* The content of aInputStream becomes the content of the file
* Return:: success of operation
*/
bool SAL_CALL
write( sal_Int32 CommandId,
const OUString& aUnqPath,
bool OverWrite,
const com::sun::star::uno::Reference< com::sun::star::io::XInputStream >& aInputStream )
throw();
void SAL_CALL insertDefaultProperties( const OUString& aUnqPath );
com::sun::star::uno::Sequence< com::sun::star::ucb::ContentInfo >
queryCreatableContentsInfo();
/******************************************************************************/
/* */
/* mapping of file urls */
/* to uncpath and vice versa */
/* */
/******************************************************************************/
bool SAL_CALL getUnqFromUrl( const OUString& Url, OUString& Unq );
bool SAL_CALL getUrlFromUnq( const OUString& Unq, OUString& Url );
bool m_bWithConfig;
FileProvider* m_pProvider;
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > m_xContext;
com::sun::star::uno::Reference< com::sun::star::ucb::XPropertySetRegistry > m_xFileRegistry;
private:
/********************************************************************************/
/* get eventListeners */
/********************************************************************************/
std::list< ContentEventNotifier* >* SAL_CALL
getContentEventListeners( const OUString& aName );
std::list< ContentEventNotifier* >* SAL_CALL
getContentDeletedEventListeners( const OUString& aName );
std::vector< std::list< ContentEventNotifier* >* >* SAL_CALL
getContentExchangedEventListeners( const OUString& aOldPrefix,
const OUString& aNewPrefix,
bool withChildren );
std::list< PropertyChangeNotifier* >* SAL_CALL
getPropertyChangeNotifier( const OUString& aName );
std::list< PropertySetInfoChangeNotifier* >* SAL_CALL
getPropertySetListeners( const OUString& aName );
/********************************************************************************/
/* notify eventListeners */
/********************************************************************************/
void SAL_CALL notifyPropertyChanges(
std::list< PropertyChangeNotifier* >* listeners,
const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyChangeEvent >& seqChanged );
void SAL_CALL notifyContentExchanged(
std::vector< std::list< ContentEventNotifier* >* >* listeners_vec );
void SAL_CALL notifyInsert(
std::list< ContentEventNotifier* >* listeners,const OUString& aChildName );
void SAL_CALL notifyContentDeleted(
std::list< ContentEventNotifier* >* listeners );
void SAL_CALL notifyContentRemoved(
std::list< ContentEventNotifier* >* listeners,
const OUString& aChildName );
void SAL_CALL notifyPropertyAdded(
std::list< PropertySetInfoChangeNotifier* >* listeners,
const OUString& aPropertyName );
void SAL_CALL notifyPropertyRemoved(
std::list< PropertySetInfoChangeNotifier* >* listeners,
const OUString& aPropertyName );
/********************************************************************************/
/* remove persistent propertyset */
/********************************************************************************/
void SAL_CALL erasePersistentSet( const OUString& aUnqPath,
bool withChildren = false );
/********************************************************************************/
/* copy persistent propertyset */
/* from srcUnqPath to dstUnqPath */
/********************************************************************************/
void SAL_CALL copyPersistentSet( const OUString& srcUnqPath,
const OUString& dstUnqPath,
bool withChildren = false );
// Special optimized method for getting the properties of a directoryitem, which
// is returned by osl::DirectoryItem::getNextItem()
com::sun::star::uno::Reference< com::sun::star::sdbc::XRow > SAL_CALL
getv( Notifier* pNotifier,
const com::sun::star::uno::Sequence< com::sun::star::beans::Property >& properties,
osl::DirectoryItem& DirItem,
OUString& aUnqPath,
bool& bIsRegular );
/**
* Load the properties from configuration, if create == true create them.
* The Properties are stored under the url belonging to it->first.
*/
void SAL_CALL load( const shell::ContentMap::iterator& it,
bool create );
/**
* Commit inserts the determined properties in the filestatus object into
* the internal map, so that is possible to determine on a subsequent
* setting of file properties which properties have changed without filestat
*/
void SAL_CALL
commit(
const shell::ContentMap::iterator& it,
const osl::FileStatus& aFileStatus );
/**
* Given a Sequence of properties seq, this method determines the mask
* used to instantiate a osl::FileStatus, so that a call to
* osl::DirectoryItem::getFileStatus fills the required fields.
*/
void SAL_CALL
getMaskFromProperties(
sal_Int32& n_Mask,
const com::sun::star::uno::Sequence< com::sun::star::beans::Property >& seq );
void SAL_CALL
setFileProperties(
const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& values,
sal_Int32 numberOfValues )
throw();
// Helper function for public copy
osl::FileBase::RC SAL_CALL
copy_recursive(
const OUString& srcUnqPath,
const OUString& dstUnqPath,
sal_Int32 TypeToCopy,
bool testExistence )
throw();
// Helper function for mkfil,mkdir and write
// Creates whole path
// returns success of the operation
// The calle determines the errorCode, which should be used to install
// any error
bool SAL_CALL
ensuredir( sal_Int32 CommandId,
const OUString& aDirectoryName,
sal_Int32 errorCode )
throw();
// General
osl::Mutex m_aMutex;
ContentMap m_aContent;
// Default properties
const OUString Title;
const OUString CasePreservingURL;
const OUString IsDocument;
const OUString IsFolder;
const OUString DateModified;
const OUString Size;
const OUString IsVolume;
const OUString IsRemoveable;
const OUString IsRemote;
const OUString IsCompactDisc;
const OUString IsFloppy;
const OUString IsHidden;
const OUString ContentType;
const OUString IsReadOnly;
const OUString CreatableContentsInfo;
public:
const OUString FolderContentType;
const OUString FileContentType;
private:
PropertySet m_aDefaultProperties;
com::sun::star::uno::Sequence< com::sun::star::ucb::CommandInfo > m_sCommandInfo;
public:
// Misceancellous:
// Methods for "writeComponentInfo" and "createComponentFactory"
static void SAL_CALL getScheme( OUString& Scheme );
static OUString SAL_CALL getImplementationName_static( void );
static com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames_static( void );
}; // end class shell
} // end namespace fileaccess
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
