ucb/source/ucp/webdav/webdavdatasupplier.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29
  30 /**************************************************************************
  31                                 TODO
  32  **************************************************************************
  33
  34  *************************************************************************/
  35 #include <osl/diagnose.h>
  36 #include <com/sun/star/ucb/OpenMode.hpp>
  37 #include <ucbhelper/contentidentifier.hxx>
  38 #include <ucbhelper/providerhelper.hxx>
  39 #include "webdavdatasupplier.hxx"
  40 #include "webdavcontent.hxx"
  41 #include "ContentProperties.hxx"
  42 #include "DAVSession.hxx"
  43 #include "NeonUri.hxx"
  44
  45 using namespace com::sun::star;
  46 using namespace webdav_ucp;
  47
  48 namespace webdav_ucp
  49 {
  50
  51 //=========================================================================
  52 //
  53 // struct ResultListEntry.
  54 //
  55 //=========================================================================
  56
  57 struct ResultListEntry
  58 {
  59     rtl::OUString                             aId;
  60     uno::Reference< ucb::XContentIdentifier > xId;
  61     uno::Reference< ucb::XContent >           xContent;
  62     uno::Reference< sdbc::XRow >              xRow;
  63     const ContentProperties*                  pData;
  64
  65     ResultListEntry( const ContentProperties* pEntry ) : pData( pEntry ) {};
  66      ~ResultListEntry() { delete pData; }
  67 };
  68
  69 //=========================================================================
  70 //
  71 // ResultList.
  72 //
  73 //=========================================================================
  74
  75 typedef std::vector< ResultListEntry* > ResultList;
  76
  77 //=========================================================================
  78 //
  79 // struct DataSupplier_Impl.
  80 //
  81 //=========================================================================
  82
  83 struct DataSupplier_Impl
  84 {
  85     osl::Mutex                                   m_aMutex;
  86     ResultList                                   m_aResults;
  87     rtl::Reference< Content >                    m_xContent;
  88     uno::Reference< lang::XMultiServiceFactory > m_xSMgr;
  89     sal_Int32                                    m_nOpenMode;
  90     sal_Bool                                     m_bCountFinal;
  91     sal_Bool                                     m_bThrowException;
  92
  93     DataSupplier_Impl(
  94                 const uno::Reference< lang::XMultiServiceFactory >& rxSMgr,
  95                 const rtl::Reference< Content >& rContent,
  96                 sal_Int32 nOpenMode )
  97     : m_xContent( rContent ), m_xSMgr( rxSMgr ), m_nOpenMode( nOpenMode ),
  98       m_bCountFinal( sal_False ), m_bThrowException( sal_False ) {}
  99     ~DataSupplier_Impl();
 100 };
 101
 102 //=========================================================================
 103 DataSupplier_Impl::~DataSupplier_Impl()
 104 {
 105     ResultList::const_iterator it  = m_aResults.begin();
 106     ResultList::const_iterator end = m_aResults.end();
 107
 108     while ( it != end )
 109     {
 110         delete (*it);
 111         ++it;
 112     }
 113 }
 114
 115 }
 116
 117 //=========================================================================
 118 //=========================================================================
 119 //
 120 // DataSupplier Implementation.
 121 //
 122 //=========================================================================
 123 //=========================================================================
 124
 125 DataSupplier::DataSupplier(
 126             const uno::Reference< lang::XMultiServiceFactory >& rxSMgr,
 127             const rtl::Reference< Content >& rContent,
 128             sal_Int32 nOpenMode )
 129 : m_pImpl( new DataSupplier_Impl( rxSMgr, rContent, nOpenMode ) )
 130 {
 131 }
 132
 133 //=========================================================================
 134 // virtual
 135 DataSupplier::~DataSupplier()
 136 {
 137     delete m_pImpl;
 138 }
 139
 140 //=========================================================================
 141 // virtual
 142 rtl::OUString DataSupplier::queryContentIdentifierString( sal_uInt32 nIndex )
 143 {
 144     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 145
 146     if ( nIndex < m_pImpl->m_aResults.size() )
 147     {
 148         rtl::OUString aId = m_pImpl->m_aResults[ nIndex ]->aId;
 149         if ( !aId.isEmpty() )
 150         {
 151             // Already cached.
 152             return aId;
 153         }
 154     }
 155
 156     if ( getResult( nIndex ) )
 157     {
 158         rtl::OUString aId = m_pImpl->m_xContent->getResourceAccess().getURL();
 159
 160         const ContentProperties& props
 161                             = *( m_pImpl->m_aResults[ nIndex ]->pData );
 162
 163         if ( ( aId.lastIndexOf( '/' ) + 1 ) != aId.getLength() )
 164             aId += rtl::OUString("/");
 165
 166         aId += props.getEscapedTitle();
 167
 168         if ( props.isTrailingSlash() )
 169             aId += rtl::OUString("/");
 170
 171         m_pImpl->m_aResults[ nIndex ]->aId = aId;
 172         return aId;
 173     }
 174     return rtl::OUString();
 175 }
 176
 177 //=========================================================================
 178 // virtual
 179 uno::Reference< ucb::XContentIdentifier >
 180 DataSupplier::queryContentIdentifier( sal_uInt32 nIndex )
 181 {
 182     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 183
 184     if ( nIndex < m_pImpl->m_aResults.size() )
 185     {
 186         uno::Reference< ucb::XContentIdentifier > xId
 187             = m_pImpl->m_aResults[ nIndex ]->xId;
 188         if ( xId.is() )
 189         {
 190             // Already cached.
 191             return xId;
 192         }
 193     }
 194
 195     rtl::OUString aId = queryContentIdentifierString( nIndex );
 196     if ( !aId.isEmpty() )
 197     {
 198         uno::Reference< ucb::XContentIdentifier > xId
 199             = new ::ucbhelper::ContentIdentifier( aId );
 200         m_pImpl->m_aResults[ nIndex ]->xId = xId;
 201         return xId;
 202     }
 203     return uno::Reference< ucb::XContentIdentifier >();
 204 }
 205
 206 //=========================================================================
 207 // virtual
 208 uno::Reference< ucb::XContent >
 209 DataSupplier::queryContent( sal_uInt32 nIndex )
 210 {
 211     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 212
 213     if ( nIndex < m_pImpl->m_aResults.size() )
 214     {
 215         uno::Reference< ucb::XContent > xContent
 216             = m_pImpl->m_aResults[ nIndex ]->xContent;
 217         if ( xContent.is() )
 218         {
 219             // Already cached.
 220             return xContent;
 221         }
 222     }
 223
 224     uno::Reference< ucb::XContentIdentifier > xId
 225         = queryContentIdentifier( nIndex );
 226     if ( xId.is() )
 227     {
 228         try
 229         {
 230             uno::Reference< ucb::XContent > xContent
 231                 = m_pImpl->m_xContent->getProvider()->queryContent( xId );
 232             m_pImpl->m_aResults[ nIndex ]->xContent = xContent;
 233             return xContent;
 234
 235         }
 236         catch ( ucb::IllegalIdentifierException& )
 237         {
 238         }
 239     }
 240     return uno::Reference< ucb::XContent >();
 241 }
 242
 243 //=========================================================================
 244 // virtual
 245 sal_Bool DataSupplier::getResult( sal_uInt32 nIndex )
 246 {
 247     osl::ClearableGuard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 248
 249     if ( m_pImpl->m_aResults.size() > nIndex )
 250     {
 251         // Result already present.
 252         return sal_True;
 253     }
 254
 255     // Obtain values...
 256     if ( getData() )
 257     {
 258         if ( m_pImpl->m_aResults.size() > nIndex )
 259         {
 260             // Result already present.
 261             return sal_True;
 262         }
 263     }
 264
 265     return sal_False;
 266 }
 267
 268 //=========================================================================
 269 // virtual
 270 sal_uInt32 DataSupplier::totalCount()
 271 {
 272   // Obtain values...
 273   getData();
 274
 275   return m_pImpl->m_aResults.size();
 276 }
 277
 278 //=========================================================================
 279 // virtual
 280 sal_uInt32 DataSupplier::currentCount()
 281 {
 282     return m_pImpl->m_aResults.size();
 283 }
 284
 285 //=========================================================================
 286 // virtual
 287 sal_Bool DataSupplier::isCountFinal()
 288 {
 289     return m_pImpl->m_bCountFinal;
 290 }
 291
 292 //=========================================================================
 293 // virtual
 294 uno::Reference< sdbc::XRow > DataSupplier::queryPropertyValues(
 295                                                     sal_uInt32 nIndex  )
 296 {
 297     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 298
 299     if ( nIndex < m_pImpl->m_aResults.size() )
 300     {
 301         uno::Reference< sdbc::XRow > xRow = m_pImpl->m_aResults[ nIndex ]->xRow;
 302         if ( xRow.is() )
 303         {
 304             // Already cached.
 305             return xRow;
 306         }
 307     }
 308
 309     if ( getResult( nIndex ) )
 310     {
 311         uno::Reference< sdbc::XRow > xRow
 312             = Content::getPropertyValues(
 313                 m_pImpl->m_xSMgr,
 314                 getResultSet()->getProperties(),
 315                 *(m_pImpl->m_aResults[ nIndex ]->pData),
 316                 rtl::Reference< ::ucbhelper::ContentProviderImplHelper >(
 317                     m_pImpl->m_xContent->getProvider().get() ),
 318                 queryContentIdentifierString( nIndex ) );
 319         m_pImpl->m_aResults[ nIndex ]->xRow = xRow;
 320         return xRow;
 321     }
 322
 323     return uno::Reference< sdbc::XRow >();
 324 }
 325
 326 //=========================================================================
 327 // virtual
 328 void DataSupplier::releasePropertyValues( sal_uInt32 nIndex )
 329 {
 330     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 331
 332     if ( nIndex < m_pImpl->m_aResults.size() )
 333         m_pImpl->m_aResults[ nIndex ]->xRow = uno::Reference< sdbc::XRow >();
 334 }
 335
 336 //=========================================================================
 337 // virtual
 338 void DataSupplier::close()
 339 {
 340 }
 341
 342 //=========================================================================
 343 // virtual
 344 void DataSupplier::validate()
 345     throw( ucb::ResultSetException )
 346 {
 347     if ( m_pImpl->m_bThrowException )
 348         throw ucb::ResultSetException();
 349 }
 350
 351 //=========================================================================
 352 sal_Bool DataSupplier::getData()
 353 {
 354     osl::ClearableGuard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 355
 356     if ( !m_pImpl->m_bCountFinal )
 357     {
 358         std::vector< rtl::OUString > propertyNames;
 359         ContentProperties::UCBNamesToDAVNames(
 360                         getResultSet()->getProperties(), propertyNames );
 361
 362         // Append "resourcetype", if not already present. It's value is
 363         // needed to get a valid ContentProperties::pIsFolder value, which
 364         // is needed for OpenMode handling.
 365
 366         std::vector< rtl::OUString >::const_iterator it
 367             = propertyNames.begin();
 368         std::vector< rtl::OUString >::const_iterator end
 369             = propertyNames.end();
 370
 371         while ( it != end )
 372         {
 373             if ( (*it).equals( DAVProperties::RESOURCETYPE ) )
 374                 break;
 375
 376             ++it;
 377         }
 378
 379         if ( it == end )
 380             propertyNames.push_back( DAVProperties::RESOURCETYPE );
 381
 382         std::vector< DAVResource > resources;
 383         try
 384         {
 385             // propfind depth 1, get property values for parent AND for each
 386             // child
 387             m_pImpl->m_xContent->getResourceAccess()
 388                 .PROPFIND( DAVONE,
 389                            propertyNames,
 390                            resources,
 391                            getResultSet()->getEnvironment() );
 392           }
 393           catch ( DAVException & )
 394         {
 395 //          OSL_FAIL( "PROPFIND : DAVException" );
 396             m_pImpl->m_bThrowException = sal_True;
 397           }
 398
 399         if ( !m_pImpl->m_bThrowException )
 400         {
 401             try
 402             {
 403                 NeonUri aURI(
 404                     m_pImpl->m_xContent->getResourceAccess().getURL() );
 405                 rtl::OUString aPath = aURI.GetPath();
 406
 407                 if ( aPath.getStr()[ aPath.getLength() - 1 ]
 408                      == sal_Unicode( '/' ) )
 409                     aPath = aPath.copy( 0, aPath.getLength() - 1 );
 410
 411                 aPath = NeonUri::unescape( aPath );
 412                 bool bFoundParent = false;
 413
 414                 for ( sal_uInt32 n = 0; n < resources.size(); ++n )
 415                 {
 416                     const DAVResource & rRes = resources[ n ];
 417
 418                     // Filter parent, which is contained somewhere(!) in
 419                     // the vector.
 420                     if ( !bFoundParent )
 421                     {
 422                         try
 423                         {
 424                             NeonUri aCurrURI( rRes.uri );
 425                             rtl::OUString aCurrPath = aCurrURI.GetPath();
 426                             if ( aCurrPath.getStr()[
 427                                      aCurrPath.getLength() - 1 ]
 428                                  == sal_Unicode( '/' ) )
 429                                 aCurrPath
 430                                     = aCurrPath.copy(
 431                                         0,
 432                                         aCurrPath.getLength() - 1 );
 433
 434                             aCurrPath = NeonUri::unescape( aCurrPath );
 435                             if ( aPath == aCurrPath )
 436                             {
 437                                 bFoundParent = true;
 438                                 continue;
 439                             }
 440                         }
 441                         catch ( DAVException const & )
 442                         {
 443                             // do nothing, ignore error. continue.
 444                         }
 445                     }
 446
 447                     ContentProperties* pContentProperties
 448                         = new ContentProperties( rRes );
 449
 450                     // Check resource against open mode.
 451                     switch ( m_pImpl->m_nOpenMode )
 452                     {
 453                     case ucb::OpenMode::FOLDERS:
 454                         {
 455                             sal_Bool bFolder = sal_False;
 456
 457                             const uno::Any & rValue
 458                                 = pContentProperties->getValue(
 459                                     rtl::OUString( "IsFolder"  ) );
 460                             rValue >>= bFolder;
 461
 462                             if ( !bFolder )
 463                                 continue;
 464
 465                             break;
 466                         }
 467
 468                     case ucb::OpenMode::DOCUMENTS:
 469                         {
 470                             sal_Bool bDocument = sal_False;
 471
 472                             const uno::Any & rValue
 473                                 = pContentProperties->getValue(
 474                                     rtl::OUString( "IsDocument"  ) );
 475                             rValue >>= bDocument;
 476
 477                             if ( !bDocument )
 478                                 continue;
 479
 480                             break;
 481                         }
 482
 483                     case ucb::OpenMode::ALL:
 484                     default:
 485                         break;
 486                     }
 487
 488                     m_pImpl->m_aResults.push_back(
 489                         new ResultListEntry( pContentProperties ) );
 490                 }
 491             }
 492             catch ( DAVException const & )
 493             {
 494             }
 495         }
 496
 497           m_pImpl->m_bCountFinal = sal_True;
 498
 499         // Callback possible, because listeners may be informed!
 500         aGuard.clear();
 501         getResultSet()->rowCountFinal();
 502     }
 503     return !m_pImpl->m_bThrowException;
 504 }
 505
 506 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */