Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
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/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
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 .
18 : */
19 :
20 : #ifndef SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
21 : #define SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
22 :
23 : #include <com/sun/star/ucb/XCommandEnvironment.hpp>
24 : #include <com/sun/star/document/XDocumentProperties.hpp>
25 : #include <salhelper/thread.hxx>
26 : #include <ucbhelper/content.hxx>
27 : #include <rtl/ustring.hxx>
28 : #include <tools/datetime.hxx>
29 : #include <tools/string.hxx>
30 : #include <vcl/image.hxx>
31 :
32 : class IUrlFilter;
33 : //........................................................................
34 : namespace svt
35 : {
36 : //........................................................................
37 :
38 : //====================================================================
39 : //= SortingData_Impl
40 : //====================================================================
41 0 : struct SortingData_Impl
42 : {
43 : private:
44 : ::rtl::OUString maFilename; // only filename in upper case - for compare purposes
45 : ::rtl::OUString maTitle; // -> be carefull when changing maTitle to update maFilename only when new
46 : ::rtl::OUString maLowerTitle;
47 :
48 :
49 : public:
50 : ::rtl::OUString maType;
51 : ::rtl::OUString maTargetURL;
52 : ::rtl::OUString maImageURL;
53 : ::rtl::OUString maDisplayText;
54 : DateTime maModDate;
55 : Image maImage;
56 : sal_Int64 maSize;
57 : sal_Bool mbIsFolder;
58 : sal_Bool mbIsVolume;
59 : sal_Bool mbIsRemote;
60 : sal_Bool mbIsRemoveable;
61 : sal_Bool mbIsFloppy;
62 : sal_Bool mbIsCompactDisc;
63 :
64 : inline SortingData_Impl();
65 : inline const ::rtl::OUString& GetTitle() const;
66 : inline const ::rtl::OUString& GetLowerTitle() const;
67 : inline const ::rtl::OUString& GetFileName() const;
68 : inline void SetNewTitle( const ::rtl::OUString& rNewTitle ); // new maTitle is set -> maFilename is set to same!
69 : inline void ChangeTitle( const ::rtl::OUString& rChangedTitle ); // maTitle is changed, maFilename is unchanged!
70 :
71 : private:
72 : inline void SetTitles( const ::rtl::OUString& rNewTitle );
73 : };
74 :
75 0 : inline SortingData_Impl::SortingData_Impl() :
76 : maModDate ( DateTime::EMPTY ),
77 : maSize ( 0 ),
78 : mbIsFolder ( sal_False ),
79 : mbIsVolume ( sal_False ),
80 : mbIsRemote ( sal_False ),
81 : mbIsRemoveable ( sal_False ),
82 : mbIsFloppy ( sal_False ),
83 0 : mbIsCompactDisc ( sal_False )
84 : {
85 0 : }
86 :
87 0 : inline const ::rtl::OUString& SortingData_Impl::GetTitle() const
88 : {
89 0 : return maTitle;
90 : }
91 :
92 0 : inline const ::rtl::OUString& SortingData_Impl::GetLowerTitle() const
93 : {
94 0 : return maLowerTitle;
95 : }
96 :
97 0 : inline const ::rtl::OUString& SortingData_Impl::GetFileName() const
98 : {
99 0 : return maFilename;
100 : }
101 :
102 0 : inline void SortingData_Impl::SetNewTitle( const ::rtl::OUString& rNewTitle )
103 : {
104 0 : SetTitles( rNewTitle );
105 0 : maFilename = rNewTitle.toAsciiUpperCase();
106 0 : }
107 :
108 0 : inline void SortingData_Impl::ChangeTitle( const ::rtl::OUString& rChangedTitle )
109 : {
110 0 : SetTitles( rChangedTitle );
111 0 : }
112 :
113 0 : inline void SortingData_Impl::SetTitles( const ::rtl::OUString& rNewTitle )
114 : {
115 0 : maTitle = rNewTitle;
116 0 : maLowerTitle = rNewTitle.toAsciiLowerCase();
117 0 : }
118 :
119 : //====================================================================
120 : //= IContentTitleTranslation
121 : //====================================================================
122 0 : class IContentTitleTranslation
123 : {
124 : public:
125 : virtual sal_Bool GetTranslation( const ::rtl::OUString& _rOriginalName, ::rtl::OUString& _rTranslatedName ) const = 0;
126 :
127 : protected:
128 0 : ~IContentTitleTranslation() {}
129 : };
130 :
131 : //====================================================================
132 : //= EnumerationResult
133 : //====================================================================
134 : enum EnumerationResult
135 : {
136 : SUCCESS, /// the enumeration was successful
137 : ERROR, /// the enumeration was unsuccessful
138 : RUNNING /// the enumeration is still running, and the maximum wait time has passed
139 : };
140 :
141 : //====================================================================
142 : //= FolderDescriptor
143 : //====================================================================
144 0 : struct FolderDescriptor
145 : {
146 : /** a content object describing the folder. Can be <NULL/>, in this case <member>sURL</member>
147 : is relevant.
148 : */
149 : ::ucbhelper::Content aContent;
150 : /** the URL of a folder. Will be ignored if <member>aContent</member> is not <NULL/>.
151 : */
152 : String sURL;
153 :
154 0 : FolderDescriptor() { }
155 :
156 0 : FolderDescriptor( const ::ucbhelper::Content& _rContent )
157 0 : :aContent( _rContent )
158 : {
159 0 : }
160 :
161 0 : FolderDescriptor( const String& _rURL )
162 0 : :sURL( _rURL )
163 : {
164 0 : }
165 : };
166 :
167 : //====================================================================
168 : //= IEnumerationResultHandler
169 : //====================================================================
170 0 : class IEnumerationResultHandler
171 : {
172 : public:
173 : virtual void enumerationDone( EnumerationResult _eResult ) = 0;
174 :
175 : protected:
176 0 : ~IEnumerationResultHandler() {}
177 : };
178 :
179 : //====================================================================
180 : //= FileViewContentEnumerator
181 : //====================================================================
182 : class FileViewContentEnumerator: public salhelper::Thread
183 : {
184 : public:
185 : typedef ::std::vector< SortingData_Impl* > ContentData;
186 :
187 : private:
188 : ContentData& m_rContent;
189 : ::osl::Mutex& m_rContentMutex;
190 :
191 : mutable ::osl::Mutex m_aMutex;
192 :
193 : FolderDescriptor m_aFolder;
194 : ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >
195 : m_xCommandEnv;
196 : const IUrlFilter* m_pFilter;
197 : const IContentTitleTranslation* m_pTranslator;
198 : IEnumerationResultHandler* m_pResultHandler;
199 : bool m_bCancelled;
200 :
201 : mutable ::com::sun::star::uno::Reference<
202 : ::com::sun::star::document::XDocumentProperties>
203 : m_xDocProps;
204 :
205 : ::com::sun::star::uno::Sequence< ::rtl::OUString > m_rBlackList;
206 :
207 : sal_Bool URLOnBlackList ( const ::rtl::OUString& sRealURL );
208 :
209 : public:
210 : /** constructs an enumerator instance
211 :
212 : @param _rContentToFill
213 : the structure which is to be filled with the found content
214 : @param _rContentMutex
215 : the mutex which protects the access to <arg>_rContentToFill</arg>
216 : @param _pTranslator
217 : an instance which should be used to translate content titles. May be <NULL/>
218 : */
219 : FileViewContentEnumerator(
220 : const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >& _rxCommandEnv,
221 : ContentData& _rContentToFill,
222 : ::osl::Mutex& _rContentMutex,
223 : const IContentTitleTranslation* _pTranslator
224 : );
225 :
226 : /** enumerates the content of a given folder
227 :
228 : @param _rFolder
229 : the folder whose content is to be enumerated
230 : @param _pFilter
231 : a filter to apply to the found contents
232 : @param _pResultHandler
233 : an instance which should handle the results of the enumeration
234 : */
235 : void enumerateFolderContent(
236 : const FolderDescriptor& _rFolder,
237 : const IUrlFilter* _pFilter,
238 : IEnumerationResultHandler* _pResultHandler
239 : );
240 :
241 : /** enumerates the content of a given folder synchronously
242 : */
243 : EnumerationResult enumerateFolderContentSync(
244 : const FolderDescriptor& _rFolder,
245 : const IUrlFilter* _pFilter,
246 : const ::com::sun::star::uno::Sequence< ::rtl::OUString >& rBlackList = ::com::sun::star::uno::Sequence< ::rtl::OUString >()
247 : );
248 :
249 : /** cancels the running operation.
250 :
251 : Note that "cancel" may mean that the operation is running, but its result
252 : is simply disregarded later on.
253 : */
254 : void cancel();
255 :
256 : protected:
257 : ~FileViewContentEnumerator();
258 :
259 : private:
260 : EnumerationResult enumerateFolderContent();
261 :
262 : // Thread overridables
263 : virtual void execute();
264 :
265 : private:
266 : sal_Bool implGetDocTitle( const ::rtl::OUString& _rTargetURL, ::rtl::OUString& _rRet ) const;
267 : };
268 :
269 : //........................................................................
270 : } // namespace svt
271 : //........................................................................
272 :
273 : #endif // SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
274 :
275 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
