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