svtools/source/contnr/contentenumeration.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: contentenumeration.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
  32 #define SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  36 #include <com/sun/star/document/XStandaloneDocumentInfo.hpp>
  37 /** === end UNO includes === **/
  38 #include <osl/thread.hxx>
  39 #include <rtl/ref.hxx>
  40 #include <ucbhelper/content.hxx>
  41 #include <rtl/ustring.hxx>
  42 #include <tools/datetime.hxx>
  43 #include <vcl/image.hxx>
  44
  45 class IUrlFilter;
  46 //........................................................................
  47 namespace svt
  48 {
  49 //........................................................................
  50
  51     //====================================================================
  52     //= SortingData_Impl
  53     //====================================================================
  54     struct SortingData_Impl
  55     {
  56     private:
  57         ::rtl::OUString maFilename;     // only filename in upper case - for compare purposes
  58         ::rtl::OUString maTitle;        //  -> be carefull when changing maTitle to update maFilename only when new
  59         ::rtl::OUString maLowerTitle;
  60
  61
  62     public:
  63         ::rtl::OUString maType;
  64         ::rtl::OUString maTargetURL;
  65         ::rtl::OUString maImageURL;
  66         ::rtl::OUString maDisplayText;
  67         DateTime        maModDate;
  68         Image           maImage;
  69         sal_Int64       maSize;
  70         sal_Bool        mbIsFolder;
  71         sal_Bool        mbIsVolume;
  72         sal_Bool        mbIsRemote;
  73         sal_Bool        mbIsRemoveable;
  74         sal_Bool        mbIsFloppy;
  75         sal_Bool        mbIsCompactDisc;
  76
  77         inline                          SortingData_Impl();
  78         inline const ::rtl::OUString&   GetTitle() const;
  79         inline const ::rtl::OUString&   GetLowerTitle() const;
  80         inline const ::rtl::OUString&   GetFileName() const;
  81         inline void                     SetNewTitle( const ::rtl::OUString& rNewTitle );        // new maTitle is set -> maFilename is set to same!
  82         inline void                     ChangeTitle( const ::rtl::OUString& rChangedTitle );    // maTitle is changed, maFilename is unchanged!
  83
  84     private:
  85         inline void                     SetTitles( const ::rtl::OUString& rNewTitle );
  86     };
  87
  88     inline SortingData_Impl::SortingData_Impl() :
  89         maSize          ( 0 ),
  90         mbIsFolder      ( sal_False ),
  91         mbIsVolume      ( sal_False ),
  92         mbIsRemote      ( sal_False ),
  93         mbIsRemoveable  ( sal_False ),
  94         mbIsFloppy      ( sal_False ),
  95         mbIsCompactDisc ( sal_False )
  96     {
  97     }
  98
  99     inline const ::rtl::OUString& SortingData_Impl::GetTitle() const
 100     {
 101         return maTitle;
 102     }
 103
 104     inline const ::rtl::OUString& SortingData_Impl::GetLowerTitle() const
 105     {
 106         return maLowerTitle;
 107     }
 108
 109     inline const ::rtl::OUString& SortingData_Impl::GetFileName() const
 110     {
 111         return maFilename;
 112     }
 113
 114     inline void SortingData_Impl::SetNewTitle( const ::rtl::OUString& rNewTitle )
 115     {
 116         SetTitles( rNewTitle );
 117         maFilename = rNewTitle.toAsciiUpperCase();
 118     }
 119
 120     inline void SortingData_Impl::ChangeTitle( const ::rtl::OUString& rChangedTitle )
 121     {
 122         SetTitles( rChangedTitle );
 123     }
 124
 125     inline void SortingData_Impl::SetTitles( const ::rtl::OUString& rNewTitle )
 126     {
 127         maTitle = rNewTitle;
 128         maLowerTitle = rNewTitle.toAsciiLowerCase();
 129     }
 130
 131     //====================================================================
 132     //= IContentTitleTranslation
 133     //====================================================================
 134     class IContentTitleTranslation
 135     {
 136     public:
 137         virtual sal_Bool    GetTranslation( const ::rtl::OUString& _rOriginalName, ::rtl::OUString& _rTranslatedName ) const = 0;
 138     };
 139
 140     //====================================================================
 141     //= EnumerationResult
 142     //====================================================================
 143     enum EnumerationResult
 144     {
 145         SUCCESS,    /// the enumration was successfull
 146         ERROR,      /// the enumration was unsuccessfull
 147         RUNNING     /// the enumeration is still running, and the maximum wait time has passed
 148     };
 149
 150     //====================================================================
 151     //= FolderDescriptor
 152     //====================================================================
 153     struct FolderDescriptor
 154     {
 155         /** a content object describing the folder. Can be <NULL/>, in this case <member>sURL</member>
 156             is relevant.
 157         */
 158         ::ucbhelper::Content  aContent;
 159         /** the URL of a folder. Will be ignored if <member>aContent</member> is not <NULL/>.
 160         */
 161         String          sURL;
 162
 163         FolderDescriptor() { }
 164
 165         FolderDescriptor( const ::ucbhelper::Content& _rContent )
 166             :aContent( _rContent )
 167         {
 168         }
 169
 170         FolderDescriptor( const String& _rURL )
 171             :sURL( _rURL )
 172         {
 173         }
 174     };
 175
 176     //====================================================================
 177     //= IEnumerationResultHandler
 178     //====================================================================
 179     class IEnumerationResultHandler
 180     {
 181     public:
 182         virtual void        enumerationDone( EnumerationResult _eResult ) = 0;
 183     };
 184
 185     //====================================================================
 186     //= FileViewContentEnumerator
 187     //====================================================================
 188     class FileViewContentEnumerator
 189             :public  ::rtl::IReference
 190             ,private ::osl::Thread
 191     {
 192     public:
 193         typedef ::std::vector< SortingData_Impl* >  ContentData;
 194
 195     private:
 196         ContentData&                    m_rContent;
 197         ::osl::Mutex&                   m_rContentMutex;
 198
 199         oslInterlockedCount             m_refCount;
 200         mutable ::osl::Mutex            m_aMutex;
 201
 202         FolderDescriptor                m_aFolder;
 203         ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >
 204                                         m_xCommandEnv;
 205         const IUrlFilter*               m_pFilter;
 206         const IContentTitleTranslation* m_pTranslator;
 207         IEnumerationResultHandler*      m_pResultHandler;
 208         bool                            m_bCancelled;
 209
 210         mutable ::com::sun::star::uno::Reference< ::com::sun::star::document::XStandaloneDocumentInfo >
 211                                         m_xDocInfo;
 212
 213         ::com::sun::star::uno::Sequence< ::rtl::OUString > m_rBlackList;
 214
 215         sal_Bool URLOnBlackList ( const ::rtl::OUString& sRealURL );
 216
 217     public:
 218         /** constructs an enumerator instance
 219
 220             @param _rContentToFill
 221                 the structure which is to be filled with the found content
 222             @param _rContentMutex
 223                 the mutex which protects the access to <arg>_rContentToFill</arg>
 224             @param _pTranslator
 225                 an instance which should be used to translate content titles. May be <NULL/>
 226         */
 227         FileViewContentEnumerator(
 228             const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >& _rxCommandEnv,
 229             ContentData& _rContentToFill,
 230             ::osl::Mutex& _rContentMutex,
 231             const IContentTitleTranslation* _pTranslator
 232         );
 233
 234         /** enumerates the content of a given folder
 235
 236             @param _rFolder
 237                 the folder whose content is to be enumerated
 238             @param _pFilter
 239                 a filter to apply to the found contents
 240             @param _pResultHandler
 241                 an instance which should handle the results of the enumeration
 242         */
 243         void    enumerateFolderContent(
 244                     const FolderDescriptor& _rFolder,
 245                     const IUrlFilter* _pFilter,
 246                     IEnumerationResultHandler* _pResultHandler
 247                 );
 248
 249         /** enumerates the content of a given folder synchronously
 250         */
 251         EnumerationResult   enumerateFolderContentSync(
 252                     const FolderDescriptor& _rFolder,
 253                     const IUrlFilter* _pFilter,
 254                     const ::com::sun::star::uno::Sequence< ::rtl::OUString >& rBlackList = ::com::sun::star::uno::Sequence< ::rtl::OUString >()
 255                 );
 256
 257         /** cancels the running operation.
 258
 259             Note that "cancel" may mean that the operation is running, but its result
 260             is simply disregarded later on.
 261         */
 262         void    cancel();
 263
 264         // IReference overridables
 265         virtual oslInterlockedCount SAL_CALL acquire();
 266         virtual oslInterlockedCount SAL_CALL release();
 267
 268         using Thread::operator new;
 269         using Thread::operator delete;
 270
 271     protected:
 272         ~FileViewContentEnumerator();
 273
 274     private:
 275         EnumerationResult enumerateFolderContent();
 276
 277         // Thread overridables
 278         virtual void SAL_CALL run();
 279         virtual void SAL_CALL onTerminated();
 280
 281     private:
 282         sal_Bool implGetDocTitle( const ::rtl::OUString& _rTargetURL, ::rtl::OUString& _rRet ) const;
 283     };
 284
 285 //........................................................................
 286 } // namespace svt
 287 //........................................................................
 288
 289 #endif // SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
 290