svtools/source/contnr/contentenumeration.cxx

   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.cxx,v $
  10  * $Revision: 1.11.104.1 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svtools.hxx"
  33 #include "contentenumeration.hxx"
  34 #include <svtools/urlfilter.hxx>
  35 #include <svtools/inettbc.hxx>
  36 #include "imagemgr.hxx"
  37
  38 /** === begin UNO includes === **/
  39 #include <com/sun/star/beans/XPropertySet.hpp>
  40 #include <com/sun/star/sdbc/XResultSet.hpp>
  41 #include <com/sun/star/sdbc/XRow.hpp>
  42 #include <com/sun/star/ucb/XDynamicResultSet.hpp>
  43 #include <com/sun/star/ucb/XContentAccess.hpp>
  44 #include <com/sun/star/util/DateTime.hpp>
  45 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  46 /** === end UNO includes === **/
  47 #include <comphelper/processfactory.hxx>
  48 #include <tools/debug.hxx>
  49 #include <vcl/svapp.hxx>
  50 #include <vos/mutex.hxx>
  51
  52 #include <memory>
  53
  54 //........................................................................
  55 namespace svt
  56 {
  57 //........................................................................
  58
  59 #define ROW_TITLE           1
  60 #define ROW_SIZE            2
  61 #define ROW_DATE_MOD        3
  62 #define ROW_DATE_CREATE     4
  63 #define ROW_IS_FOLDER       5
  64 #define ROW_TARGET_URL      6
  65 #define ROW_IS_HIDDEN           7
  66 #define ROW_IS_VOLUME           8
  67 #define ROW_IS_REMOTE           9
  68 #define ROW_IS_REMOVEABLE       10
  69 #define ROW_IS_FLOPPY           11
  70 #define ROW_IS_COMPACTDISC      12
  71
  72 #define CONVERT_DATETIME( aUnoDT, aToolsDT ) \
  73     aToolsDT = ::DateTime( Date( aUnoDT.Day, aUnoDT.Month, aUnoDT.Year ), \
  74                            Time( aUnoDT.Hours, aUnoDT.Minutes, aUnoDT.Seconds, aUnoDT.HundredthSeconds ) );
  75
  76     using ::com::sun::star::uno::Reference;
  77     using ::com::sun::star::uno::Sequence;
  78     using ::com::sun::star::uno::Exception;
  79     using ::com::sun::star::uno::UNO_QUERY;
  80     using ::com::sun::star::uno::Any;
  81     using ::com::sun::star::util::DateTime;
  82     using ::com::sun::star::sdbc::XResultSet;
  83     using ::com::sun::star::sdbc::XRow;
  84     using ::com::sun::star::ucb::XDynamicResultSet;
  85     using ::com::sun::star::ucb::CommandAbortedException;
  86     using ::com::sun::star::ucb::XContentAccess;
  87     using ::com::sun::star::ucb::XCommandEnvironment;
  88     using ::com::sun::star::beans::XPropertySet;
  89     using ::rtl::OUString;
  90     using ::ucbhelper::ResultSetInclude;
  91     using ::ucbhelper::INCLUDE_FOLDERS_AND_DOCUMENTS;
  92
  93     //====================================================================
  94     //= FileViewContentEnumerator
  95     //====================================================================
  96     //--------------------------------------------------------------------
  97     FileViewContentEnumerator::FileViewContentEnumerator(
  98             const Reference< XCommandEnvironment >& _rxCommandEnv,
  99             ContentData& _rContentToFill, ::osl::Mutex& _rContentMutex,
 100             const IContentTitleTranslation* _pTranslator )
 101         :m_rContent              ( _rContentToFill )
 102         ,m_rContentMutex         ( _rContentMutex  )
 103         ,m_refCount              ( 0               )
 104         ,m_xCommandEnv           ( _rxCommandEnv   )
 105         ,m_pFilter               ( NULL            )
 106         ,m_pTranslator           ( _pTranslator    )
 107         ,m_bCancelled            ( false           )
 108         ,m_rBlackList                    ( ::com::sun::star::uno::Sequence< ::rtl::OUString >() )
 109     {
 110     }
 111
 112     //--------------------------------------------------------------------
 113     FileViewContentEnumerator::~FileViewContentEnumerator()
 114     {
 115     }
 116
 117     //--------------------------------------------------------------------
 118     void FileViewContentEnumerator::cancel()
 119     {
 120         ::osl::MutexGuard aGuard( m_aMutex );
 121         m_bCancelled = true;
 122         m_pResultHandler = NULL;
 123         m_pTranslator = NULL;
 124         m_pFilter = NULL;
 125         m_aFolder.aContent = ::ucbhelper::Content();
 126         m_aFolder.sURL = String();
 127     }
 128
 129     //--------------------------------------------------------------------
 130     EnumerationResult FileViewContentEnumerator::enumerateFolderContentSync(
 131         const FolderDescriptor& _rFolder,
 132         const IUrlFilter* _pFilter,
 133         const ::com::sun::star::uno::Sequence< ::rtl::OUString >& rBlackList )
 134     {
 135         {
 136             ::osl::MutexGuard aGuard( m_aMutex );
 137             m_aFolder = _rFolder;
 138             m_pFilter = _pFilter;
 139             m_pResultHandler = NULL;
 140             m_rBlackList = rBlackList;
 141         }
 142         return enumerateFolderContent();
 143     }
 144
 145     //--------------------------------------------------------------------
 146     void FileViewContentEnumerator::enumerateFolderContent(
 147         const FolderDescriptor& _rFolder, const IUrlFilter* _pFilter, IEnumerationResultHandler* _pResultHandler )
 148     {
 149         // ensure that we don't get deleted while herein
 150         acquire();
 151             // the matching "release" will be called in onTerminated
 152             // Note that onTerminated is only called if run was left normally.
 153             // If somebody terminates the thread from the outside, then onTerminated
 154             // will never be called. However, our terminate method is not accessible
 155             // to our clients, so the only class which could misbehave is this class
 156             // here itself ...
 157
 158         ::osl::MutexGuard aGuard( m_aMutex );
 159         m_aFolder = _rFolder;
 160         m_pFilter = _pFilter;
 161         m_pResultHandler = _pResultHandler;
 162
 163         OSL_ENSURE( m_aFolder.aContent.get().is() || m_aFolder.sURL.Len(),
 164             "FileViewContentEnumerator::enumerateFolderContent: invalid folder descriptor!" );
 165
 166         // start the thread
 167         create();
 168     }
 169
 170     //--------------------------------------------------------------------
 171     oslInterlockedCount SAL_CALL FileViewContentEnumerator::acquire()
 172     {
 173         return osl_incrementInterlockedCount( &m_refCount );
 174     }
 175
 176     //--------------------------------------------------------------------
 177     oslInterlockedCount SAL_CALL FileViewContentEnumerator::release()
 178     {
 179         if ( 0 == osl_decrementInterlockedCount( &m_refCount ) )
 180         {
 181             delete this;
 182             return 0;
 183         }
 184         return m_refCount;
 185     }
 186
 187     //--------------------------------------------------------------------
 188     EnumerationResult FileViewContentEnumerator::enumerateFolderContent()
 189     {
 190         EnumerationResult eResult = ERROR;
 191         try
 192         {
 193
 194             Reference< XResultSet > xResultSet;
 195             Sequence< OUString > aProps(12);
 196
 197             aProps[0] = OUString::createFromAscii( "Title" );
 198             aProps[1] = OUString::createFromAscii( "Size" );
 199             aProps[2] = OUString::createFromAscii( "DateModified" );
 200             aProps[3] = OUString::createFromAscii( "DateCreated" );
 201             aProps[4] = OUString::createFromAscii( "IsFolder" );
 202             aProps[5] = OUString::createFromAscii( "TargetURL" );
 203             aProps[6] = OUString::createFromAscii( "IsHidden" );
 204             aProps[7] = OUString::createFromAscii( "IsVolume" );
 205             aProps[8] = OUString::createFromAscii( "IsRemote" );
 206             aProps[9] = OUString::createFromAscii( "IsRemoveable" );
 207             aProps[10] = OUString::createFromAscii( "IsFloppy" );
 208             aProps[11] = OUString::createFromAscii( "IsCompactDisc" );
 209
 210             Reference< XCommandEnvironment > xEnvironment;
 211             try
 212             {
 213                 FolderDescriptor aFolder;
 214                 {
 215                     ::osl::MutexGuard aGuard( m_aMutex );
 216                     aFolder = m_aFolder;
 217                     xEnvironment = m_xCommandEnv;
 218                 }
 219                 if ( !aFolder.aContent.get().is() )
 220                 {
 221                     aFolder.aContent = ::ucbhelper::Content( aFolder.sURL, xEnvironment );
 222                     {
 223                         ::osl::MutexGuard aGuard( m_aMutex );
 224                         m_aFolder.aContent = aFolder.aContent;
 225                     }
 226                 }
 227
 228                 Reference< XDynamicResultSet > xDynResultSet;
 229                 ResultSetInclude eInclude = INCLUDE_FOLDERS_AND_DOCUMENTS;
 230                 xDynResultSet = aFolder.aContent.createDynamicCursor( aProps, eInclude );
 231
 232                 if ( xDynResultSet.is() )
 233                     xResultSet = xDynResultSet->getStaticResultSet();
 234             }
 235             catch( CommandAbortedException& )
 236             {
 237                 DBG_ERRORFILE( "createCursor: CommandAbortedException" );
 238             }
 239             catch( Exception& )
 240             {
 241             }
 242
 243             bool bCancelled = false;
 244             if ( xResultSet.is() )
 245             {
 246                 Reference< XRow > xRow( xResultSet, UNO_QUERY );
 247                 Reference< XContentAccess > xContentAccess( xResultSet, UNO_QUERY );
 248
 249                 try
 250                 {
 251                     SortingData_Impl* pData;
 252                     DateTime aDT;
 253
 254                     while ( !bCancelled && xResultSet->next() )
 255                     {
 256                         sal_Bool bIsHidden = xRow->getBoolean( ROW_IS_HIDDEN );
 257                         // don't show hidden files
 258                         if ( !bIsHidden || xRow->wasNull() )
 259                         {
 260                             pData = NULL;
 261
 262                             aDT = xRow->getTimestamp( ROW_DATE_MOD );
 263                             sal_Bool bContainsDate = !xRow->wasNull();
 264                             if ( !bContainsDate )
 265                             {
 266                                 aDT = xRow->getTimestamp( ROW_DATE_CREATE );
 267                                 bContainsDate = !xRow->wasNull();
 268                             }
 269
 270                             OUString aContentURL = xContentAccess->queryContentIdentifierString();
 271                             OUString aTargetURL = xRow->getString( ROW_TARGET_URL );
 272                             sal_Bool bHasTargetURL = !xRow->wasNull() && aTargetURL.getLength() > 0;
 273
 274                             OUString sRealURL = bHasTargetURL ? aTargetURL : aContentURL;
 275
 276                             // check for restrictions
 277                             {
 278                                 ::osl::MutexGuard aGuard( m_aMutex );
 279                                 if ( m_pFilter && !m_pFilter->isUrlAllowed( sRealURL ) )
 280                                     continue;
 281
 282                                 if ( /* m_rBlackList.hasElements() && */ URLOnBlackList ( sRealURL ) )
 283                                     continue;
 284                             }
 285
 286                             pData = new SortingData_Impl;
 287                             pData->maTargetURL = sRealURL;
 288
 289                             pData->mbIsFolder = xRow->getBoolean( ROW_IS_FOLDER ) && !xRow->wasNull();
 290                             pData->mbIsVolume = xRow->getBoolean( ROW_IS_VOLUME ) && !xRow->wasNull();
 291                             pData->mbIsRemote = xRow->getBoolean( ROW_IS_REMOTE ) && !xRow->wasNull();
 292                             pData->mbIsRemoveable = xRow->getBoolean( ROW_IS_REMOVEABLE ) && !xRow->wasNull();
 293                             pData->mbIsFloppy = xRow->getBoolean( ROW_IS_FLOPPY ) && !xRow->wasNull();
 294                             pData->mbIsCompactDisc = xRow->getBoolean( ROW_IS_COMPACTDISC ) && !xRow->wasNull();
 295                             pData->SetNewTitle( xRow->getString( ROW_TITLE ) );
 296                             pData->maSize = xRow->getLong( ROW_SIZE );
 297
 298                             if ( bHasTargetURL &&
 299                                 INetURLObject( aContentURL ).GetProtocol() == INET_PROT_VND_SUN_STAR_HIER )
 300                             {
 301                                 ::ucbhelper::Content aCnt( aTargetURL, xEnvironment );
 302                                 try
 303                                 {
 304                                 aCnt.getPropertyValue( OUString::createFromAscii( "Size" ) ) >>= pData->maSize;
 305                                 aCnt.getPropertyValue( OUString::createFromAscii( "DateModified" ) ) >>= aDT;
 306                                 }
 307                                 catch (...) {}
 308                             }
 309
 310                             if ( bContainsDate )
 311                             {
 312                                 CONVERT_DATETIME( aDT, pData->maModDate );
 313                             }
 314
 315                             if ( pData->mbIsFolder )
 316                             {
 317                                 ::vos::OGuard aGuard( Application::GetSolarMutex() );
 318                                 ::svtools::VolumeInfo aVolInfo( pData->mbIsVolume, pData->mbIsRemote,
 319                                                                 pData->mbIsRemoveable, pData->mbIsFloppy,
 320                                                                 pData->mbIsCompactDisc );
 321                                 pData->maType = SvFileInformationManager::GetFolderDescription( aVolInfo );
 322                             }
 323                             else
 324                                 pData->maType = SvFileInformationManager::GetFileDescription(
 325                                     INetURLObject( pData->maTargetURL ) );
 326
 327                             // replace names on demand
 328                             {
 329                                 ::osl::MutexGuard aGuard( m_aMutex );
 330                                 if( m_pTranslator )
 331                                 {
 332                                     OUString sNewTitle;
 333                                     sal_Bool bTranslated = sal_False;
 334
 335                                     if ( pData->mbIsFolder )
 336                                         bTranslated = m_pTranslator->GetTranslation( pData->GetTitle(), sNewTitle );
 337                                     else
 338                                         bTranslated = implGetDocTitle( pData->maTargetURL, sNewTitle );
 339
 340                                     if ( bTranslated )
 341                                         pData->ChangeTitle( sNewTitle );
 342                                 }
 343                             }
 344
 345                             {
 346                                 ::osl::MutexGuard aGuard( m_rContentMutex );
 347                                 m_rContent.push_back( pData );
 348                             }
 349                         }
 350
 351                         {
 352                             ::osl::MutexGuard aGuard( m_aMutex );
 353                             bCancelled = m_bCancelled;
 354                         }
 355                     }
 356                     eResult = SUCCESS;
 357                 }
 358                 catch( CommandAbortedException& )
 359                 {
 360                     DBG_ERRORFILE( "FileViewContentEnumerator::enumerateFolderContent: caught an CommandAbortedException while enumerating!" );
 361                 }
 362                 catch( Exception& )
 363                 {
 364                     DBG_ERRORFILE( "FileViewContentEnumerator::enumerateFolderContent: caught an exception other than CommandAbortedException while enumerating!" );
 365                 }
 366             }
 367         }
 368         catch( CommandAbortedException& )
 369         {
 370             DBG_ERRORFILE( "FileViewContentEnumerator::enumerateFolderContent: caught an CommandAbortedException!" );
 371         }
 372         catch( Exception& )
 373         {
 374             DBG_ERRORFILE( "FileViewContentEnumerator::enumerateFolderContent: caught an exception other than CommandAbortedException!" );
 375         }
 376
 377         IEnumerationResultHandler* pHandler = NULL;
 378         {
 379             ::osl::MutexGuard aGuard( m_aMutex );
 380             pHandler = m_pResultHandler;
 381             if ( m_bCancelled )
 382                 return ERROR;
 383         }
 384
 385         {
 386             ::osl::MutexGuard aGuard( m_rContentMutex );
 387             if ( eResult != SUCCESS )
 388                 // clear any "intermediate" and unfinished result
 389                 m_rContent.clear();
 390         }
 391
 392         if ( pHandler )
 393             pHandler->enumerationDone( eResult );
 394         return eResult;
 395     }
 396
 397     //--------------------------------------------------------------------
 398
 399     sal_Bool FileViewContentEnumerator::URLOnBlackList ( const ::rtl::OUString& sRealURL )
 400     {
 401         ::rtl::OUString entryName = sRealURL.copy( sRealURL.lastIndexOf( rtl::OUString::createFromAscii("/")) +1 );
 402
 403         for (int i = 0; i < m_rBlackList.getLength() ; i++)
 404         {
 405             if ( entryName.equals(  m_rBlackList[i] ) )
 406                 return true;
 407         }
 408
 409         return false;
 410     }
 411
 412     //--------------------------------------------------------------------
 413     sal_Bool FileViewContentEnumerator::implGetDocTitle( const OUString& _rTargetURL, OUString& _rRet ) const
 414     {
 415         sal_Bool bRet = sal_False;
 416
 417         try
 418         {
 419             ::osl::MutexGuard aGuard( m_aMutex );
 420             if( !m_xDocInfo.is() )
 421             {
 422                 m_xDocInfo = m_xDocInfo.query(
 423                     ::comphelper::getProcessServiceFactory()->createInstance(
 424                         String( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.document.StandaloneDocumentInfo") )
 425                     )
 426                 );
 427             }
 428
 429             DBG_ASSERT( m_xDocInfo.is(), "FileViewContentEnumerator::implGetDocTitle: no DocumentProperties service!" );
 430             if ( !m_xDocInfo.is() )
 431                 return sal_False;
 432
 433             m_xDocInfo->loadFromURL( _rTargetURL );
 434             Reference< XPropertySet > xPropSet( m_xDocInfo, UNO_QUERY );
 435
 436             Any aAny = xPropSet->getPropertyValue( OUString::createFromAscii( "Title" ) );
 437
 438             OUString sTitle;
 439             if ( ( aAny >>= sTitle ) && sTitle.getLength() > 0 )
 440             {
 441                 _rRet = sTitle;
 442                 bRet = sal_True;
 443             }
 444         }
 445         catch ( const Exception& )
 446         {
 447         }
 448
 449         return bRet;
 450     }
 451
 452     //--------------------------------------------------------------------
 453     void SAL_CALL FileViewContentEnumerator::run()
 454     {
 455         enumerateFolderContent();
 456     }
 457
 458     //--------------------------------------------------------------------
 459     void SAL_CALL FileViewContentEnumerator::onTerminated()
 460     {
 461         release();
 462     }
 463
 464 //........................................................................
 465 } // namespace svt
 466 //........................................................................
 467