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