ucb/source/ucp/webdav/webdavdatasupplier.cxx

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