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