ucb/source/ucp/ext/ucpext_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 #include "ucpext_datasupplier.hxx"
  22 #include "ucpext_content.hxx"
  23 #include "ucpext_provider.hxx"
  24
  25 #include <com/sun/star/deployment/PackageInformationProvider.hpp>
  26
  27 #include <ucbhelper/contentidentifier.hxx>
  28 #include <comphelper/processfactory.hxx>
  29 #include <ucbhelper/providerhelper.hxx>
  30 #include <ucbhelper/content.hxx>
  31 #include <ucbhelper/propertyvalueset.hxx>
  32 #include <tools/diagnose_ex.h>
  33 #include <rtl/ustrbuf.hxx>
  34
  35 #include <vector>
  36 #include <boost/shared_ptr.hpp>
  37
  38
  39 namespace ucb { namespace ucp { namespace ext
  40 {
  41
  42
  43     using ::com::sun::star::uno::Reference;
  44     using ::com::sun::star::uno::XInterface;
  45     using ::com::sun::star::uno::UNO_QUERY;
  46     using ::com::sun::star::uno::UNO_QUERY_THROW;
  47     using ::com::sun::star::uno::UNO_SET_THROW;
  48     using ::com::sun::star::uno::Exception;
  49     using ::com::sun::star::uno::RuntimeException;
  50     using ::com::sun::star::uno::Any;
  51     using ::com::sun::star::uno::makeAny;
  52     using ::com::sun::star::uno::Sequence;
  53     using ::com::sun::star::uno::Type;
  54     using ::com::sun::star::uno::XComponentContext;
  55     using ::com::sun::star::ucb::XContent;
  56     using ::com::sun::star::ucb::XContentIdentifier;
  57     using ::com::sun::star::sdbc::XRow;
  58     using ::com::sun::star::lang::XMultiServiceFactory;
  59     using ::com::sun::star::ucb::IllegalIdentifierException;
  60     using ::com::sun::star::ucb::ResultSetException;
  61     using ::com::sun::star::deployment::PackageInformationProvider;
  62     using ::com::sun::star::deployment::XPackageInformationProvider;
  63     using ::com::sun::star::beans::Property;
  64     using ::com::sun::star::sdbc::XResultSet;
  65     using ::com::sun::star::ucb::XCommandEnvironment;
  66
  67
  68     //= ResultListEntry
  69
  70     struct ResultListEntry
  71     {
  72         OUString                 sId;
  73         Reference< XContentIdentifier > xId;
  74         ::rtl::Reference< Content >     pContent;
  75         Reference< XRow >               xRow;
  76     };
  77
  78     typedef ::std::vector< ResultListEntry >    ResultList;
  79
  80
  81     //= DataSupplier_Impl
  82
  83     struct DataSupplier_Impl
  84     {
  85         ::osl::Mutex                                m_aMutex;
  86         ResultList                                  m_aResults;
  87         ::rtl::Reference< Content >                 m_xContent;
  88         Reference< XComponentContext >              m_xContext;
  89         sal_Int32                                   m_nOpenMode;
  90
  91         DataSupplier_Impl( const Reference< XComponentContext >& rxContext, const ::rtl::Reference< Content >& i_rContent,
  92                            const sal_Int32 i_nOpenMode )
  93             :m_xContent( i_rContent )
  94             ,m_xContext( rxContext )
  95             ,m_nOpenMode( i_nOpenMode )
  96         {
  97         }
  98         ~DataSupplier_Impl();
  99     };
 100
 101
 102     DataSupplier_Impl::~DataSupplier_Impl()
 103     {
 104     }
 105
 106
 107     //= helper
 108
 109     namespace
 110     {
 111         OUString lcl_compose( const OUString& i_rBaseURL, const OUString& i_rRelativeURL )
 112         {
 113             ENSURE_OR_RETURN( !i_rBaseURL.isEmpty(), "illegal base URL", i_rRelativeURL );
 114
 115             OUStringBuffer aComposer( i_rBaseURL );
 116             if ( !i_rBaseURL.endsWith("/") )
 117                 aComposer.append( '/' );
 118             aComposer.append( i_rRelativeURL );
 119             return aComposer.makeStringAndClear();
 120         }
 121     }
 122
 123
 124
 125     //= DataSupplier
 126
 127
 128     DataSupplier::DataSupplier( const Reference< XComponentContext >& rxContext,
 129                                 const ::rtl::Reference< Content >& i_rContent,
 130                                 const sal_Int32 i_nOpenMode )
 131         :m_pImpl( new DataSupplier_Impl( rxContext, i_rContent, i_nOpenMode ) )
 132     {
 133     }
 134
 135
 136     void DataSupplier::fetchData()
 137     {
 138         try
 139         {
 140             const Reference< XPackageInformationProvider > xPackageInfo = PackageInformationProvider::get( m_pImpl->m_xContext );
 141
 142             const OUString sContentIdentifier( m_pImpl->m_xContent->getIdentifier()->getContentIdentifier() );
 143
 144             switch ( m_pImpl->m_xContent->getExtensionContentType() )
 145             {
 146             case E_ROOT:
 147             {
 148                 Sequence< Sequence< OUString > > aExtensionInfo( xPackageInfo->getExtensionList() );
 149                 for (   const Sequence< OUString >* pExtInfo = aExtensionInfo.getConstArray();
 150                         pExtInfo != aExtensionInfo.getConstArray() + aExtensionInfo.getLength();
 151                         ++pExtInfo
 152                     )
 153                 {
 154                     if ( pExtInfo->getLength() <= 0 )
 155                     {
 156                         SAL_WARN( "ucb.ucp.ext", "illegal extension info" );
 157                         continue;
 158                     }
 159
 160                     const OUString& rLocalId = (*pExtInfo)[0];
 161                     ResultListEntry aEntry;
 162                     aEntry.sId = ContentProvider::getRootURL() + Content::encodeIdentifier( rLocalId ) + "/";
 163                     m_pImpl->m_aResults.push_back( aEntry );
 164                 }
 165             }
 166             break;
 167             case E_EXTENSION_ROOT:
 168             case E_EXTENSION_CONTENT:
 169             {
 170                 const OUString sPackageLocation( m_pImpl->m_xContent->getPhysicalURL() );
 171                 ::ucbhelper::Content aWrappedContent( sPackageLocation, getResultSet()->getEnvironment(), m_pImpl->m_xContext );
 172
 173                 // obtain the properties which our result set is set up for from the wrapped content
 174                 Sequence< OUString > aPropertyNames(1);
 175                 aPropertyNames[0] = "Title";
 176
 177                 const Reference< XResultSet > xFolderContent( aWrappedContent.createCursor( aPropertyNames ), UNO_SET_THROW );
 178                 const Reference< XRow > xContentRow( xFolderContent, UNO_QUERY_THROW );
 179                 while ( xFolderContent->next() )
 180                 {
 181                     ResultListEntry aEntry;
 182                     aEntry.sId = lcl_compose( sContentIdentifier, xContentRow->getString( 1 ) );
 183                     m_pImpl->m_aResults.push_back( aEntry );
 184                 }
 185             }
 186             break;
 187             default:
 188                 OSL_FAIL( "DataSupplier::fetchData: unimplemented content type!" );
 189                 break;
 190             }
 191         }
 192         catch( const Exception& )
 193         {
 194             DBG_UNHANDLED_EXCEPTION();
 195         }
 196     }
 197
 198
 199     DataSupplier::~DataSupplier()
 200     {
 201     }
 202
 203
 204     OUString DataSupplier::queryContentIdentifierString( sal_uInt32 i_nIndex )
 205     {
 206         ::osl::Guard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 207
 208         if ( i_nIndex < m_pImpl->m_aResults.size() )
 209         {
 210             const OUString sId = m_pImpl->m_aResults[ i_nIndex ].sId;
 211             if ( !sId.isEmpty() )
 212                 return sId;
 213         }
 214
 215         OSL_FAIL( "DataSupplier::queryContentIdentifierString: illegal index, or illegal result entry id!" );
 216         return OUString();
 217     }
 218
 219
 220     Reference< XContentIdentifier > DataSupplier::queryContentIdentifier( sal_uInt32 i_nIndex )
 221     {
 222         ::osl::Guard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 223
 224         if ( i_nIndex < m_pImpl->m_aResults.size() )
 225         {
 226             Reference< XContentIdentifier > xId( m_pImpl->m_aResults[ i_nIndex ].xId );
 227             if ( xId.is() )
 228                 return xId;
 229         }
 230
 231         OUString sId = queryContentIdentifierString( i_nIndex );
 232         if ( !sId.isEmpty() )
 233         {
 234             Reference< XContentIdentifier > xId = new ::ucbhelper::ContentIdentifier( sId );
 235             m_pImpl->m_aResults[ i_nIndex ].xId = xId;
 236             return xId;
 237         }
 238
 239         return Reference< XContentIdentifier >();
 240     }
 241
 242
 243     Reference< XContent > DataSupplier::queryContent( sal_uInt32 i_nIndex )
 244     {
 245         ::osl::Guard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 246         ENSURE_OR_RETURN( i_nIndex < m_pImpl->m_aResults.size(), "illegal index!", NULL );
 247
 248
 249         ::rtl::Reference< Content > pContent( m_pImpl->m_aResults[ i_nIndex ].pContent );
 250         if ( pContent.is() )
 251             return pContent.get();
 252
 253         Reference< XContentIdentifier > xId( queryContentIdentifier( i_nIndex ) );
 254         if ( xId.is() )
 255         {
 256             try
 257             {
 258                 Reference< XContent > xContent( m_pImpl->m_xContent->getProvider()->queryContent( xId ) );
 259                 pContent.set( dynamic_cast< Content* >( xContent.get() ) );
 260                 OSL_ENSURE( pContent.is() || !xContent.is(), "DataSupplier::queryContent: invalid content implementation!" );
 261                 m_pImpl->m_aResults[ i_nIndex ].pContent = pContent;
 262                 return pContent.get();
 263
 264             }
 265             catch ( const IllegalIdentifierException& )
 266             {
 267                 DBG_UNHANDLED_EXCEPTION();
 268             }
 269         }
 270
 271         return Reference< XContent >();
 272     }
 273
 274
 275     bool DataSupplier::getResult( sal_uInt32 i_nIndex )
 276     {
 277         ::osl::ClearableGuard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 278
 279         if ( m_pImpl->m_aResults.size() > i_nIndex )
 280             // result already present.
 281             return true;
 282
 283         return false;
 284     }
 285
 286
 287     sal_uInt32 DataSupplier::totalCount()
 288     {
 289         ::osl::ClearableGuard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 290         return m_pImpl->m_aResults.size();
 291     }
 292
 293
 294     sal_uInt32 DataSupplier::currentCount()
 295     {
 296         return m_pImpl->m_aResults.size();
 297     }
 298
 299
 300     bool DataSupplier::isCountFinal()
 301     {
 302         return true;
 303     }
 304
 305
 306     Reference< XRow > DataSupplier::queryPropertyValues( sal_uInt32 i_nIndex  )
 307     {
 308         ::osl::MutexGuard aGuard( m_pImpl->m_aMutex );
 309         ENSURE_OR_RETURN( i_nIndex < m_pImpl->m_aResults.size(), "DataSupplier::queryPropertyValues: illegal index!", NULL );
 310
 311         Reference< XRow > xRow = m_pImpl->m_aResults[ i_nIndex ].xRow;
 312         if ( xRow.is() )
 313             return xRow;
 314
 315         ENSURE_OR_RETURN( queryContent( i_nIndex ).is(), "could not retrieve the content", NULL );
 316
 317         switch ( m_pImpl->m_xContent->getExtensionContentType() )
 318         {
 319         case E_ROOT:
 320         {
 321             const OUString& rId( m_pImpl->m_aResults[ i_nIndex ].sId );
 322             const OUString sRootURL( ContentProvider::getRootURL() );
 323             OUString sTitle = Content::decodeIdentifier( rId.copy( sRootURL.getLength() ) );
 324             if ( sTitle.endsWith("/") )
 325                 sTitle = sTitle.copy( 0, sTitle.getLength() - 1 );
 326             xRow = Content::getArtificialNodePropertyValues( m_pImpl->m_xContext, getResultSet()->getProperties(), sTitle );
 327         }
 328         break;
 329
 330         case E_EXTENSION_ROOT:
 331         case E_EXTENSION_CONTENT:
 332         {
 333             xRow = m_pImpl->m_aResults[ i_nIndex ].pContent->getPropertyValues(
 334                 getResultSet()->getProperties(), getResultSet()->getEnvironment() );
 335         }
 336         break;
 337         default:
 338             OSL_FAIL( "DataSupplier::queryPropertyValues: unhandled case!" );
 339             break;
 340         }
 341
 342         m_pImpl->m_aResults[ i_nIndex ].xRow = xRow;
 343         return xRow;
 344     }
 345
 346
 347     void DataSupplier::releasePropertyValues( sal_uInt32 i_nIndex )
 348     {
 349         ::osl::Guard< ::osl::Mutex > aGuard( m_pImpl->m_aMutex );
 350
 351         if ( i_nIndex < m_pImpl->m_aResults.size() )
 352             m_pImpl->m_aResults[ i_nIndex ].xRow.clear();
 353     }
 354
 355
 356     void DataSupplier::close()
 357     {
 358     }
 359
 360
 361     void DataSupplier::validate() throw( ResultSetException )
 362     {
 363     }
 364
 365
 366 } } }   // namespace ucp::ext
 367
 368
 369 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */