ucbhelper/source/provider/providerhelper.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: providerhelper.cxx,v $
  10  * $Revision: 1.13 $
  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_ucbhelper.hxx"
  33
  34 /**************************************************************************
  35                                 TODO
  36  **************************************************************************
  37
  38  *************************************************************************/
  39
  40 #include <hash_map>
  41 #include <com/sun/star/beans/XPropertyAccess.hpp>
  42 #include <com/sun/star/container/XNameAccess.hpp>
  43 #include <com/sun/star/container/XNamed.hpp>
  44 #include <com/sun/star/ucb/XPropertySetRegistryFactory.hpp>
  45 #include <com/sun/star/ucb/XPropertySetRegistry.hpp>
  46
  47 #include "osl/diagnose.h"
  48 #include "osl/mutex.hxx"
  49 #include "cppuhelper/weakref.hxx"
  50 #include <ucbhelper/contentidentifier.hxx>
  51 #include <ucbhelper/providerhelper.hxx>
  52 #include <ucbhelper/contenthelper.hxx>
  53
  54 using namespace com::sun::star;
  55
  56 namespace ucbhelper_impl
  57 {
  58
  59 //=========================================================================
  60 //
  61 // Contents.
  62 //
  63 //=========================================================================
  64
  65 struct equalString
  66 {
  67     bool operator()(
  68         const rtl::OUString& rKey11, const rtl::OUString& rKey22 ) const
  69       {
  70           return !!( rKey11 == rKey22 );
  71       }
  72 };
  73
  74 struct hashString
  75 {
  76     size_t operator()( const rtl::OUString & rName ) const
  77     {
  78         return rName.hashCode();
  79     }
  80 };
  81
  82 typedef std::hash_map
  83 <
  84     rtl::OUString,
  85     uno::WeakReference< ucb::XContent >,
  86     hashString,
  87     equalString
  88 >
  89 Contents;
  90
  91 //=========================================================================
  92 //
  93 // struct ContentProviderImplHelper_Impl.
  94 //
  95 //=========================================================================
  96
  97 struct ContentProviderImplHelper_Impl
  98 {
  99     uno::Reference< com::sun::star::ucb::XPropertySetRegistry >
 100         m_xPropertySetRegistry;
 101     Contents
 102         m_aContents;
 103 };
 104
 105 } // namespace ucbhelper_impl
 106
 107 //=========================================================================
 108 //=========================================================================
 109 //
 110 // ContentProviderImplHelper Implementation.
 111 //
 112 //=========================================================================
 113 //=========================================================================
 114
 115 namespace ucbhelper {
 116
 117 ContentProviderImplHelper::ContentProviderImplHelper(
 118     const uno::Reference< lang::XMultiServiceFactory >& rXSMgr )
 119 : m_pImpl( new ucbhelper_impl::ContentProviderImplHelper_Impl ),
 120   m_xSMgr( rXSMgr )
 121 {
 122 }
 123
 124 //=========================================================================
 125 // virtual
 126 ContentProviderImplHelper::~ContentProviderImplHelper()
 127 {
 128     delete m_pImpl;
 129 }
 130
 131 //=========================================================================
 132 //
 133 // XInterface methods.
 134 //
 135 //=========================================================================
 136
 137 XINTERFACE_IMPL_3( ContentProviderImplHelper,
 138                    lang::XTypeProvider,
 139                    lang::XServiceInfo,
 140                    com::sun::star::ucb::XContentProvider );
 141
 142 //=========================================================================
 143 //
 144 // XTypeProvider methods.
 145 //
 146 //=========================================================================
 147
 148 XTYPEPROVIDER_IMPL_3( ContentProviderImplHelper,
 149                          lang::XTypeProvider,
 150                          lang::XServiceInfo,
 151                          com::sun::star::ucb::XContentProvider );
 152
 153 //=========================================================================
 154 //
 155 // XServiceInfo methods.
 156 //
 157 //=========================================================================
 158
 159 // virtual
 160 sal_Bool SAL_CALL ContentProviderImplHelper::supportsService(
 161                                             const rtl::OUString& ServiceName )
 162     throw( uno::RuntimeException )
 163 {
 164     uno::Sequence< rtl::OUString > aSNL = getSupportedServiceNames();
 165     const rtl::OUString* pArray = aSNL.getConstArray();
 166     for ( sal_Int32 i = 0; i < aSNL.getLength(); i++ )
 167     {
 168         if ( pArray[ i ] == ServiceName )
 169             return sal_True;
 170     }
 171
 172     return sal_False;
 173 }
 174
 175 //=========================================================================
 176 //
 177 // XContentProvider methods.
 178 //
 179 //=========================================================================
 180
 181 // virtual
 182 sal_Int32 SAL_CALL ContentProviderImplHelper::compareContentIds(
 183         const uno::Reference< com::sun::star::ucb::XContentIdentifier >& Id1,
 184         const uno::Reference< com::sun::star::ucb::XContentIdentifier >& Id2 )
 185     throw( uno::RuntimeException )
 186 {
 187     // Simply do a string compare.
 188
 189     rtl::OUString aURL1( Id1->getContentIdentifier() );
 190     rtl::OUString aURL2( Id2->getContentIdentifier() );
 191
 192     return aURL1.compareTo( aURL2 );;
 193 }
 194
 195 //=========================================================================
 196 //
 197 // Non-interface methods
 198 //
 199 //=========================================================================
 200
 201 void ContentProviderImplHelper::cleanupRegisteredContents()
 202 {
 203     osl::MutexGuard aGuard( m_aMutex );
 204
 205     ucbhelper_impl::Contents::iterator it
 206         = m_pImpl->m_aContents.begin();
 207     while( it != m_pImpl->m_aContents.end() )
 208     {
 209         uno::Reference< ucb::XContent > xContent( (*it).second );
 210         if ( !xContent.is() )
 211         {
 212             ucbhelper_impl::Contents::iterator tmp = it;
 213             ++it;
 214             m_pImpl->m_aContents.erase( tmp );
 215         }
 216         else
 217         {
 218             ++it;
 219         }
 220     }
 221 }
 222
 223 //=========================================================================
 224
 225 void ContentProviderImplHelper::removeContent( ContentImplHelper* pContent )
 226 {
 227     osl::MutexGuard aGuard( m_aMutex );
 228
 229     cleanupRegisteredContents();
 230
 231     const rtl::OUString aURL(
 232         pContent->getIdentifier()->getContentIdentifier() );
 233
 234     ucbhelper_impl::Contents::iterator it = m_pImpl->m_aContents.find( aURL );
 235
 236     if ( it != m_pImpl->m_aContents.end() )
 237         m_pImpl->m_aContents.erase( it );
 238 }
 239
 240 //=========================================================================
 241 rtl::Reference< ContentImplHelper >
 242 ContentProviderImplHelper::queryExistingContent(
 243     const uno::Reference< com::sun::star::ucb::XContentIdentifier >&
 244         Identifier )
 245 {
 246     return queryExistingContent( Identifier->getContentIdentifier() );
 247 }
 248
 249 //=========================================================================
 250 rtl::Reference< ContentImplHelper >
 251 ContentProviderImplHelper::queryExistingContent( const rtl::OUString& rURL )
 252 {
 253     osl::MutexGuard aGuard( m_aMutex );
 254
 255     cleanupRegisteredContents();
 256
 257     // Check, if a content with given id already exists...
 258
 259     ucbhelper_impl::Contents::const_iterator it
 260         = m_pImpl->m_aContents.find( rURL );
 261     if ( it != m_pImpl->m_aContents.end() )
 262     {
 263         uno::Reference< ucb::XContent > xContent( (*it).second );
 264         if ( xContent.is() )
 265         {
 266             return rtl::Reference< ContentImplHelper >(
 267                 static_cast< ContentImplHelper * >( xContent.get() ) );
 268         }
 269     }
 270     return rtl::Reference< ContentImplHelper >();
 271 }
 272
 273 //=========================================================================
 274 void ContentProviderImplHelper::queryExistingContents(
 275         ContentRefList& rContents )
 276 {
 277     osl::MutexGuard aGuard( m_aMutex );
 278
 279     cleanupRegisteredContents();
 280
 281     ucbhelper_impl::Contents::const_iterator it
 282         = m_pImpl->m_aContents.begin();
 283     ucbhelper_impl::Contents::const_iterator end
 284         = m_pImpl->m_aContents.end();
 285
 286     while ( it != end )
 287     {
 288         uno::Reference< ucb::XContent > xContent( (*it).second );
 289         if ( xContent.is() )
 290         {
 291             rContents.push_back(
 292                 rtl::Reference< ContentImplHelper >(
 293                     static_cast< ContentImplHelper * >( xContent.get() ) ) );
 294         }
 295         ++it;
 296     }
 297 }
 298
 299 //=========================================================================
 300 void ContentProviderImplHelper::registerNewContent(
 301     const uno::Reference< ucb::XContent > & xContent )
 302 {
 303     if ( xContent.is() )
 304     {
 305         osl::MutexGuard aGuard( m_aMutex );
 306
 307         cleanupRegisteredContents();
 308
 309         const rtl::OUString aURL(
 310             xContent->getIdentifier()->getContentIdentifier() );
 311         ucbhelper_impl::Contents::const_iterator it
 312             = m_pImpl->m_aContents.find( aURL );
 313         if ( it == m_pImpl->m_aContents.end() )
 314             m_pImpl->m_aContents[ aURL ] = xContent;
 315     }
 316 }
 317
 318 //=========================================================================
 319 uno::Reference< com::sun::star::ucb::XPropertySetRegistry >
 320 ContentProviderImplHelper::getAdditionalPropertySetRegistry()
 321 {
 322     // Get propertyset registry.
 323
 324     osl::MutexGuard aGuard( m_aMutex );
 325
 326     if ( !m_pImpl->m_xPropertySetRegistry.is() )
 327     {
 328         uno::Reference< com::sun::star::ucb::XPropertySetRegistryFactory >
 329             xRegFac(
 330                 m_xSMgr->createInstance(
 331                     rtl::OUString::createFromAscii(
 332                         "com.sun.star.ucb.Store" ) ),
 333                 uno::UNO_QUERY );
 334
 335         OSL_ENSURE( xRegFac.is(),
 336                     "ContentProviderImplHelper::getAdditionalPropertySet - "
 337                     "No UCB-Store service!" );
 338
 339         if ( xRegFac.is() )
 340         {
 341             // Open/create a registry.
 342             m_pImpl->m_xPropertySetRegistry
 343                 = xRegFac->createPropertySetRegistry( rtl::OUString() );
 344
 345             OSL_ENSURE( m_pImpl->m_xPropertySetRegistry.is(),
 346                     "ContentProviderImplHelper::getAdditionalPropertySet - "
 347                     "Error opening registry!" );
 348         }
 349     }
 350
 351     return m_pImpl->m_xPropertySetRegistry;
 352 }
 353
 354
 355 //=========================================================================
 356 uno::Reference< com::sun::star::ucb::XPersistentPropertySet >
 357 ContentProviderImplHelper::getAdditionalPropertySet(
 358     const rtl::OUString& rKey, sal_Bool bCreate )
 359 {
 360     // Get propertyset registry.
 361     getAdditionalPropertySetRegistry();
 362
 363     if ( m_pImpl->m_xPropertySetRegistry.is() )
 364     {
 365         // Open/create persistent property set.
 366         return uno::Reference< com::sun::star::ucb::XPersistentPropertySet >(
 367             m_pImpl->m_xPropertySetRegistry->openPropertySet(
 368                 rKey, bCreate ) );
 369     }
 370
 371     return uno::Reference< com::sun::star::ucb::XPersistentPropertySet >();
 372 }
 373
 374 //=========================================================================
 375 sal_Bool ContentProviderImplHelper::renameAdditionalPropertySet(
 376     const rtl::OUString& rOldKey,
 377     const rtl::OUString& rNewKey,
 378     sal_Bool bRecursive )
 379 {
 380     if ( rOldKey == rNewKey )
 381         return sal_True;
 382
 383     osl::MutexGuard aGuard( m_aMutex );
 384
 385     if ( bRecursive )
 386     {
 387         // Get propertyset registry.
 388         getAdditionalPropertySetRegistry();
 389
 390         if ( m_pImpl->m_xPropertySetRegistry.is() )
 391         {
 392             uno::Reference< container::XNameAccess > xNameAccess(
 393                 m_pImpl->m_xPropertySetRegistry, uno::UNO_QUERY );
 394             if ( xNameAccess.is() )
 395             {
 396                 uno::Sequence< rtl::OUString > aKeys
 397                     = xNameAccess->getElementNames();
 398                 sal_Int32 nCount = aKeys.getLength();
 399                 if ( nCount > 0 )
 400                 {
 401                     rtl::OUString aOldKeyWithSlash = rOldKey;
 402                     rtl::OUString aOldKeyWithoutSlash;
 403                     if ( aOldKeyWithSlash.lastIndexOf(
 404                              sal_Unicode('/')
 405                                  != aOldKeyWithSlash.getLength() - 1 ) )
 406                     {
 407                         aOldKeyWithSlash += rtl::OUString( sal_Unicode('/') );
 408                         aOldKeyWithoutSlash = rOldKey;
 409                     }
 410                     else if ( rOldKey.getLength() )
 411                         aOldKeyWithoutSlash
 412                             = rOldKey.copy( 0, rOldKey.getLength() - 1 );
 413
 414                     const rtl::OUString* pKeys = aKeys.getConstArray();
 415                     for ( sal_Int32 n = 0; n < nCount; ++n )
 416                     {
 417                         const rtl::OUString& rKey = pKeys[ n ];
 418                         if ( rKey.compareTo(
 419                                  aOldKeyWithSlash,
 420                                  aOldKeyWithSlash.getLength() ) == 0
 421                              || rKey.equals( aOldKeyWithoutSlash ) )
 422                         {
 423                             rtl::OUString aNewKey
 424                                 = rKey.replaceAt(
 425                                     0, rOldKey.getLength(), rNewKey );
 426                             if ( !renameAdditionalPropertySet(
 427                                     rKey, aNewKey, sal_False ) )
 428                                 return sal_False;
 429                         }
 430                     }
 431                 }
 432             }
 433             else
 434                 return sal_False;
 435         }
 436         else
 437             return sal_False;
 438     }
 439     else
 440     {
 441         // Get old property set, if exists.
 442         uno::Reference< com::sun::star::ucb::XPersistentPropertySet > xOldSet
 443             = getAdditionalPropertySet( rOldKey, sal_False );
 444         if ( xOldSet.is() )
 445         {
 446             // Rename property set.
 447             uno::Reference< container::XNamed > xNamed(
 448                 xOldSet, uno::UNO_QUERY );
 449             if ( xNamed.is() )
 450             {
 451                 // ??? throws no exceptions and has no return value ???
 452                 xNamed->setName( rNewKey );
 453             }
 454             else
 455                 return sal_False;
 456         }
 457     }
 458     return sal_True;
 459 }
 460
 461 //=========================================================================
 462 sal_Bool ContentProviderImplHelper::copyAdditionalPropertySet(
 463     const rtl::OUString& rSourceKey,
 464     const rtl::OUString& rTargetKey,
 465     sal_Bool bRecursive )
 466 {
 467     if ( rSourceKey == rTargetKey )
 468         return sal_True;
 469
 470     osl::MutexGuard aGuard( m_aMutex );
 471
 472     if ( bRecursive )
 473     {
 474         // Get propertyset registry.
 475         getAdditionalPropertySetRegistry();
 476
 477         if ( m_pImpl->m_xPropertySetRegistry.is() )
 478         {
 479             uno::Reference< container::XNameAccess > xNameAccess(
 480                 m_pImpl->m_xPropertySetRegistry, uno::UNO_QUERY );
 481             if ( xNameAccess.is() )
 482             {
 483                 uno::Sequence< rtl::OUString > aKeys
 484                     = xNameAccess->getElementNames();
 485                 sal_Int32 nCount = aKeys.getLength();
 486                 if ( nCount > 0 )
 487                 {
 488                     rtl::OUString aSrcKeyWithSlash = rSourceKey;
 489                     rtl::OUString aSrcKeyWithoutSlash;
 490                     if ( aSrcKeyWithSlash.lastIndexOf(
 491                              sal_Unicode('/')
 492                              != aSrcKeyWithSlash.getLength() - 1 ) )
 493                     {
 494                         aSrcKeyWithSlash += rtl::OUString( sal_Unicode('/') );
 495                         aSrcKeyWithoutSlash = rSourceKey;
 496                     }
 497                     else if ( rSourceKey.getLength() )
 498                         aSrcKeyWithoutSlash = rSourceKey.copy(
 499                             0, rSourceKey.getLength() - 1 );
 500
 501                     const rtl::OUString* pKeys = aKeys.getConstArray();
 502                     for ( sal_Int32 n = 0; n < nCount; ++n )
 503                     {
 504                         const rtl::OUString& rKey = pKeys[ n ];
 505                         if ( rKey.compareTo(
 506                                  aSrcKeyWithSlash,
 507                                  aSrcKeyWithSlash.getLength() ) == 0
 508                              || rKey.equals( aSrcKeyWithoutSlash ) )
 509                         {
 510                             rtl::OUString aNewKey
 511                                 = rKey.replaceAt(
 512                                     0, rSourceKey.getLength(), rTargetKey );
 513                             if ( !copyAdditionalPropertySet(
 514                                     rKey, aNewKey, sal_False ) )
 515                                 return sal_False;
 516                         }
 517                     }
 518                 }
 519             }
 520             else
 521                 return sal_False;
 522         }
 523         else
 524             return sal_False;
 525     }
 526     else
 527     {
 528         // Get old property set, if exists.
 529         uno::Reference< com::sun::star::ucb::XPersistentPropertySet >
 530             xOldPropSet = getAdditionalPropertySet( rSourceKey, sal_False );
 531         if ( !xOldPropSet.is() )
 532             return sal_False;
 533
 534         uno::Reference< beans::XPropertySetInfo > xPropSetInfo
 535             = xOldPropSet->getPropertySetInfo();
 536         if ( !xPropSetInfo.is() )
 537             return sal_False;
 538
 539         uno::Reference< beans::XPropertyAccess > xOldPropAccess(
 540             xOldPropSet, uno::UNO_QUERY );
 541         if ( !xOldPropAccess.is() )
 542             return sal_False;
 543
 544         // Obtain all values from old set.
 545         uno::Sequence< beans::PropertyValue > aValues
 546             = xOldPropAccess->getPropertyValues();
 547         sal_Int32 nCount = aValues.getLength();
 548
 549         uno::Sequence< beans::Property > aProps
 550             = xPropSetInfo->getProperties();
 551
 552         if ( nCount )
 553         {
 554             // Fail, if property set with new key already exists.
 555             uno::Reference< com::sun::star::ucb::XPersistentPropertySet >
 556                 xNewPropSet
 557                     = getAdditionalPropertySet( rTargetKey, sal_False );
 558             if ( xNewPropSet.is() )
 559                 return sal_False;
 560
 561             // Create new, empty set.
 562             xNewPropSet = getAdditionalPropertySet( rTargetKey, sal_True );
 563             if ( !xNewPropSet.is() )
 564                 return sal_False;
 565
 566             uno::Reference< beans::XPropertyContainer > xNewPropContainer(
 567                 xNewPropSet, uno::UNO_QUERY );
 568             if ( !xNewPropContainer.is() )
 569                 return sal_False;
 570
 571             for ( sal_Int32 n = 0; n < nCount; ++n )
 572             {
 573                 const beans::PropertyValue& rValue = aValues[ n ];
 574
 575                 sal_Int16 nAttribs = 0;
 576                 for ( sal_Int32 m = 0; m < aProps.getLength(); ++m )
 577                 {
 578                     if ( aProps[ m ].Name == rValue.Name )
 579                     {
 580                         nAttribs = aProps[ m ].Attributes;
 581                         break;
 582                     }
 583                 }
 584
 585                 try
 586                 {
 587                     xNewPropContainer->addProperty(
 588                         rValue.Name, nAttribs, rValue.Value );
 589                 }
 590                 catch ( beans::PropertyExistException & )
 591                 {
 592                 }
 593                    catch ( beans::IllegalTypeException & )
 594                 {
 595                 }
 596                 catch ( lang::IllegalArgumentException & )
 597                 {
 598                 }
 599             }
 600         }
 601     }
 602     return sal_True;
 603 }
 604
 605 //=========================================================================
 606 sal_Bool ContentProviderImplHelper::removeAdditionalPropertySet(
 607     const rtl::OUString& rKey, sal_Bool bRecursive )
 608 {
 609     osl::MutexGuard aGuard( m_aMutex );
 610
 611     if ( bRecursive )
 612     {
 613         // Get propertyset registry.
 614         getAdditionalPropertySetRegistry();
 615
 616         if ( m_pImpl->m_xPropertySetRegistry.is() )
 617         {
 618             uno::Reference< container::XNameAccess > xNameAccess(
 619                 m_pImpl->m_xPropertySetRegistry, uno::UNO_QUERY );
 620             if ( xNameAccess.is() )
 621             {
 622                 uno::Sequence< rtl::OUString > aKeys
 623                     = xNameAccess->getElementNames();
 624                 sal_Int32 nCount = aKeys.getLength();
 625                 if ( nCount > 0 )
 626                 {
 627                     rtl::OUString aKeyWithSlash = rKey;
 628                     rtl::OUString aKeyWithoutSlash;
 629                     if ( aKeyWithSlash.lastIndexOf(
 630                              sal_Unicode('/')
 631                              != aKeyWithSlash.getLength() - 1 ) )
 632                     {
 633                         aKeyWithSlash += rtl::OUString( (sal_Unicode)'/' );
 634                         aKeyWithoutSlash = rKey;
 635                     }
 636                     else if ( rKey.getLength() )
 637                         aKeyWithoutSlash
 638                             = rKey.copy( 0, rKey.getLength() - 1 );
 639
 640                     const rtl::OUString* pKeys = aKeys.getConstArray();
 641                     for ( sal_Int32 n = 0; n < nCount; ++n )
 642                     {
 643                         const rtl::OUString& rCurrKey = pKeys[ n ];
 644                         if ( rCurrKey.compareTo(
 645                                  aKeyWithSlash,
 646                                  aKeyWithSlash.getLength() ) == 0
 647                              || rCurrKey.equals( aKeyWithoutSlash ) )
 648                         {
 649                             if ( !removeAdditionalPropertySet(
 650                                      rCurrKey, sal_False ) )
 651                                 return sal_False;
 652                         }
 653                     }
 654                 }
 655             }
 656             else
 657                 return sal_False;
 658         }
 659         else
 660             return sal_False;
 661     }
 662     else
 663     {
 664         // Get propertyset registry.
 665         getAdditionalPropertySetRegistry();
 666
 667         if ( m_pImpl->m_xPropertySetRegistry.is() )
 668             m_pImpl->m_xPropertySetRegistry->removePropertySet( rKey );
 669         else
 670             return sal_False;
 671     }
 672     return sal_True;
 673 }
 674
 675 } // namespace ucbhelper