ucb/source/ucp/tdoc/tdoc_datasupplier.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
  21 /**************************************************************************
  22                                 TODO
  23  **************************************************************************
  24
  25  *************************************************************************/
  26
  27 #include <vector>
  28
  29 #include "osl/diagnose.h"
  30 #include "ucbhelper/contentidentifier.hxx"
  31
  32 #include "tdoc_datasupplier.hxx"
  33 #include "tdoc_content.hxx"
  34
  35 using namespace com::sun::star;
  36 using namespace tdoc_ucp;
  37
  38 namespace tdoc_ucp
  39 {
  40
  41
  42
  43 // struct ResultListEntry.
  44
  45
  46
  47 struct ResultListEntry
  48 {
  49     OUString                             aURL;
  50     uno::Reference< ucb::XContentIdentifier > xId;
  51     uno::Reference< ucb::XContent >           xContent;
  52     uno::Reference< sdbc::XRow >              xRow;
  53
  54     ResultListEntry( const OUString& rURL ) : aURL( rURL ) {}
  55 };
  56
  57
  58
  59 // ResultList.
  60
  61
  62
  63 typedef std::vector< ResultListEntry* > ResultList;
  64
  65
  66
  67 // struct DataSupplier_Impl.
  68
  69
  70
  71 struct DataSupplier_Impl
  72 {
  73     osl::Mutex                                   m_aMutex;
  74     ResultList                                   m_aResults;
  75     rtl::Reference< Content >                    m_xContent;
  76     uno::Reference< uno::XComponentContext >     m_xContext;
  77     uno::Sequence< OUString > *             m_pNamesOfChildren;
  78     sal_Int32                                    m_nOpenMode;
  79     bool                                         m_bCountFinal;
  80     bool                                         m_bThrowException;
  81
  82     DataSupplier_Impl(
  83             const uno::Reference< uno::XComponentContext >& rxContext,
  84             const rtl::Reference< Content >& rContent,
  85             sal_Int32 nOpenMode )
  86     : m_xContent( rContent ), m_xContext( rxContext ),
  87       m_pNamesOfChildren( 0 ), m_nOpenMode( nOpenMode ),
  88       m_bCountFinal( false ), m_bThrowException( false )
  89     {}
  90     ~DataSupplier_Impl();
  91 };
  92
  93
  94 DataSupplier_Impl::~DataSupplier_Impl()
  95 {
  96     ResultList::const_iterator it  = m_aResults.begin();
  97     ResultList::const_iterator end = m_aResults.end();
  98
  99     while ( it != end )
 100     {
 101         delete (*it);
 102         ++it;
 103     }
 104
 105     delete m_pNamesOfChildren;
 106 }
 107
 108 }
 109
 110 // DataSupplier Implementation.
 111 ResultSetDataSupplier::ResultSetDataSupplier(
 112                 const uno::Reference< uno::XComponentContext >& rxContext,
 113                 const rtl::Reference< Content >& rContent,
 114                 sal_Int32 nOpenMode )
 115 : m_pImpl( new DataSupplier_Impl( rxContext, rContent, nOpenMode ) )
 116 {
 117 }
 118
 119 // virtual
 120 ResultSetDataSupplier::~ResultSetDataSupplier()
 121 {
 122     delete m_pImpl;
 123 }
 124
 125 // virtual
 126 OUString
 127 ResultSetDataSupplier::queryContentIdentifierString( sal_uInt32 nIndex )
 128 {
 129     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 130
 131     if ( nIndex < m_pImpl->m_aResults.size() )
 132     {
 133         OUString aId = m_pImpl->m_aResults[ nIndex ]->aURL;
 134         if ( !aId.isEmpty() )
 135         {
 136             // Already cached.
 137             return aId;
 138         }
 139     }
 140
 141     if ( getResult( nIndex ) )
 142     {
 143         // Note: getResult fills m_pImpl->m_aResults[ nIndex ]->aURL.
 144         return m_pImpl->m_aResults[ nIndex ]->aURL;
 145     }
 146     return OUString();
 147 }
 148
 149 // virtual
 150 uno::Reference< ucb::XContentIdentifier >
 151 ResultSetDataSupplier::queryContentIdentifier( sal_uInt32 nIndex )
 152 {
 153     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 154
 155     if ( nIndex < m_pImpl->m_aResults.size() )
 156     {
 157         uno::Reference< ucb::XContentIdentifier > xId
 158                                 = m_pImpl->m_aResults[ nIndex ]->xId;
 159         if ( xId.is() )
 160         {
 161             // Already cached.
 162             return xId;
 163         }
 164     }
 165
 166     OUString aId = queryContentIdentifierString( nIndex );
 167     if ( !aId.isEmpty() )
 168     {
 169         uno::Reference< ucb::XContentIdentifier > xId
 170             = new ::ucbhelper::ContentIdentifier( aId );
 171         m_pImpl->m_aResults[ nIndex ]->xId = xId;
 172         return xId;
 173     }
 174     return uno::Reference< ucb::XContentIdentifier >();
 175 }
 176
 177 // virtual
 178 uno::Reference< ucb::XContent >
 179 ResultSetDataSupplier::queryContent( sal_uInt32 nIndex )
 180 {
 181     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 182
 183     if ( nIndex < m_pImpl->m_aResults.size() )
 184     {
 185         uno::Reference< ucb::XContent > xContent
 186                                 = m_pImpl->m_aResults[ nIndex ]->xContent;
 187         if ( xContent.is() )
 188         {
 189             // Already cached.
 190             return xContent;
 191         }
 192     }
 193
 194     uno::Reference< ucb::XContentIdentifier > xId
 195         = queryContentIdentifier( nIndex );
 196     if ( xId.is() )
 197     {
 198         try
 199         {
 200             uno::Reference< ucb::XContent > xContent
 201                 = m_pImpl->m_xContent->getProvider()->queryContent( xId );
 202             m_pImpl->m_aResults[ nIndex ]->xContent = xContent;
 203             return xContent;
 204
 205         }
 206         catch ( ucb::IllegalIdentifierException const & )
 207         {
 208         }
 209     }
 210     return uno::Reference< ucb::XContent >();
 211 }
 212
 213 // virtual
 214 bool ResultSetDataSupplier::getResult( sal_uInt32 nIndex )
 215 {
 216     osl::ClearableGuard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 217
 218     if ( m_pImpl->m_aResults.size() > nIndex )
 219     {
 220         // Result already present.
 221         return true;
 222     }
 223
 224     // Result not (yet) present.
 225
 226     if ( m_pImpl->m_bCountFinal )
 227         return false;
 228
 229     // Try to obtain result...
 230
 231     sal_uInt32 nOldCount = m_pImpl->m_aResults.size();
 232     bool bFound = false;
 233
 234     if ( queryNamesOfChildren() )
 235     {
 236         for ( sal_uInt32 n = nOldCount;
 237               n < sal::static_int_cast<sal_uInt32>(
 238                       m_pImpl->m_pNamesOfChildren->getLength());
 239               ++n )
 240         {
 241             const OUString & rName
 242                 = m_pImpl->m_pNamesOfChildren->getConstArray()[ n ];
 243
 244             if ( rName.isEmpty() )
 245             {
 246                 OSL_FAIL( "ResultDataSupplier::getResult - Empty name!" );
 247                 break;
 248             }
 249
 250             // Assemble URL for child.
 251             OUString aURL = assembleChildURL( rName );
 252
 253             m_pImpl->m_aResults.push_back( new ResultListEntry( aURL ) );
 254
 255             if ( n == nIndex )
 256             {
 257                 // Result obtained.
 258                 bFound = true;
 259                 break;
 260             }
 261         }
 262     }
 263
 264     if ( !bFound )
 265         m_pImpl->m_bCountFinal = true;
 266
 267     rtl::Reference< ::ucbhelper::ResultSet > xResultSet = getResultSet().get();
 268     if ( xResultSet.is() )
 269     {
 270         // Callbacks follow!
 271         aGuard.clear();
 272
 273         if ( nOldCount < m_pImpl->m_aResults.size() )
 274             xResultSet->rowCountChanged( nOldCount, m_pImpl->m_aResults.size() );
 275
 276         if ( m_pImpl->m_bCountFinal )
 277             xResultSet->rowCountFinal();
 278     }
 279
 280     return bFound;
 281 }
 282
 283 // virtual
 284 sal_uInt32 ResultSetDataSupplier::totalCount()
 285 {
 286     osl::ClearableGuard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 287
 288     if ( m_pImpl->m_bCountFinal )
 289         return m_pImpl->m_aResults.size();
 290
 291     sal_uInt32 nOldCount = m_pImpl->m_aResults.size();
 292
 293     if ( queryNamesOfChildren() )
 294     {
 295         for ( sal_uInt32 n = nOldCount;
 296               n < sal::static_int_cast<sal_uInt32>(
 297                       m_pImpl->m_pNamesOfChildren->getLength());
 298               ++n )
 299         {
 300             const OUString & rName
 301                 = m_pImpl->m_pNamesOfChildren->getConstArray()[ n ];
 302
 303             if ( rName.isEmpty() )
 304             {
 305                 OSL_FAIL( "ResultDataSupplier::getResult - Empty name!" );
 306                 break;
 307             }
 308
 309             // Assemble URL for child.
 310             OUString aURL = assembleChildURL( rName );
 311
 312             m_pImpl->m_aResults.push_back( new ResultListEntry( aURL ) );
 313         }
 314     }
 315
 316     m_pImpl->m_bCountFinal = true;
 317
 318     rtl::Reference< ::ucbhelper::ResultSet > xResultSet = getResultSet().get();
 319     if ( xResultSet.is() )
 320     {
 321         // Callbacks follow!
 322         aGuard.clear();
 323
 324         if ( nOldCount < m_pImpl->m_aResults.size() )
 325             xResultSet->rowCountChanged( nOldCount, m_pImpl->m_aResults.size() );
 326
 327         xResultSet->rowCountFinal();
 328     }
 329
 330     return m_pImpl->m_aResults.size();
 331 }
 332
 333 // virtual
 334 sal_uInt32 ResultSetDataSupplier::currentCount()
 335 {
 336     return m_pImpl->m_aResults.size();
 337 }
 338
 339 // virtual
 340 bool ResultSetDataSupplier::isCountFinal()
 341 {
 342     return m_pImpl->m_bCountFinal;
 343 }
 344
 345 // virtual
 346 uno::Reference< sdbc::XRow >
 347 ResultSetDataSupplier::queryPropertyValues( sal_uInt32 nIndex  )
 348 {
 349     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 350
 351     if ( nIndex < m_pImpl->m_aResults.size() )
 352     {
 353         uno::Reference< sdbc::XRow > xRow = m_pImpl->m_aResults[ nIndex ]->xRow;
 354         if ( xRow.is() )
 355         {
 356             // Already cached.
 357             return xRow;
 358         }
 359     }
 360
 361     if ( getResult( nIndex ) )
 362     {
 363         uno::Reference< sdbc::XRow > xRow = Content::getPropertyValues(
 364                         m_pImpl->m_xContext,
 365                         getResultSet()->getProperties(),
 366                         m_pImpl->m_xContent->getContentProvider().get(),
 367                         queryContentIdentifierString( nIndex ) );
 368         m_pImpl->m_aResults[ nIndex ]->xRow = xRow;
 369         return xRow;
 370     }
 371
 372     return uno::Reference< sdbc::XRow >();
 373 }
 374
 375 // virtual
 376 void ResultSetDataSupplier::releasePropertyValues( sal_uInt32 nIndex )
 377 {
 378     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 379
 380     if ( nIndex < m_pImpl->m_aResults.size() )
 381         m_pImpl->m_aResults[ nIndex ]->xRow = uno::Reference< sdbc::XRow >();
 382 }
 383
 384 // virtual
 385 void ResultSetDataSupplier::close()
 386 {
 387 }
 388
 389 // virtual
 390 void ResultSetDataSupplier::validate()
 391     throw( ucb::ResultSetException )
 392 {
 393     if ( m_pImpl->m_bThrowException )
 394         throw ucb::ResultSetException();
 395 }
 396
 397 bool ResultSetDataSupplier::queryNamesOfChildren()
 398 {
 399     osl::Guard< osl::Mutex > aGuard( m_pImpl->m_aMutex );
 400
 401     if ( m_pImpl->m_pNamesOfChildren == 0 )
 402     {
 403         uno::Sequence< OUString > * pNamesOfChildren
 404             = new uno::Sequence< OUString >();
 405
 406         if ( !m_pImpl->m_xContent->getContentProvider()->queryNamesOfChildren(
 407                 m_pImpl->m_xContent->getIdentifier()->getContentIdentifier(),
 408                 *pNamesOfChildren ) )
 409         {
 410             OSL_FAIL( "Got no list of children!" );
 411             delete pNamesOfChildren;
 412             m_pImpl->m_bThrowException = true;
 413             return false;
 414         }
 415         else
 416         {
 417             m_pImpl->m_pNamesOfChildren = pNamesOfChildren;
 418         }
 419     }
 420     return true;
 421 }
 422
 423 OUString
 424 ResultSetDataSupplier::assembleChildURL( const OUString& aName )
 425 {
 426     OUString aContURL
 427         = m_pImpl->m_xContent->getIdentifier()->getContentIdentifier();
 428     OUString aURL( aContURL );
 429
 430     sal_Int32 nUrlEnd = aURL.lastIndexOf( '/' );
 431     if ( nUrlEnd != aURL.getLength() - 1 )
 432         aURL += "/";
 433
 434     aURL += aName;
 435     return aURL;
 436 }
 437
 438 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */