desktop/source/deployment/registry/dp_backend.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: dp_backend.cxx,v $
  10  * $Revision: 1.20 $
  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_desktop.hxx"
  33
  34 #include "dp_backend.h"
  35 #include "dp_ucb.h"
  36 #include "rtl/uri.hxx"
  37 #include "cppuhelper/exc_hlp.hxx"
  38 #include "comphelper/servicedecl.hxx"
  39 #include "comphelper/unwrapargs.hxx"
  40 #include "ucbhelper/content.hxx"
  41 #include "com/sun/star/lang/WrappedTargetRuntimeException.hpp"
  42 #include "com/sun/star/beans/StringPair.hpp"
  43
  44
  45 using namespace ::dp_misc;
  46 using namespace ::com::sun::star;
  47 using namespace ::com::sun::star::uno;
  48 using namespace ::com::sun::star::ucb;
  49 using ::rtl::OUString;
  50
  51 namespace dp_registry {
  52 namespace backend {
  53
  54 //______________________________________________________________________________
  55 PackageRegistryBackend::~PackageRegistryBackend()
  56 {
  57 }
  58
  59 //______________________________________________________________________________
  60 void PackageRegistryBackend::disposing( lang::EventObject const & event )
  61     throw (RuntimeException)
  62 {
  63     Reference<deployment::XPackage> xPackage(
  64         event.Source, UNO_QUERY_THROW );
  65     OUString url( xPackage->getURL() );
  66     ::osl::MutexGuard guard( getMutex() );
  67     if ( m_bound.erase( url ) != 1 )
  68     {
  69         OSL_ASSERT( false );
  70     }
  71 }
  72
  73 //______________________________________________________________________________
  74 PackageRegistryBackend::PackageRegistryBackend(
  75     Sequence<Any> const & args,
  76     Reference<XComponentContext> const & xContext )
  77     : t_BackendBase( getMutex() ),
  78       m_xComponentContext( xContext ),
  79       m_eContext( CONTEXT_UNKNOWN ),
  80       m_readOnly( false )
  81 {
  82     boost::optional<OUString> cachePath;
  83     boost::optional<bool> readOnly;
  84     comphelper::unwrapArgs( args, m_context, cachePath, readOnly );
  85     if (cachePath)
  86         m_cachePath = *cachePath;
  87     if (readOnly)
  88         m_readOnly = *readOnly;
  89
  90     if (m_context.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM("user") ))
  91         m_eContext = CONTEXT_USER;
  92     else if (m_context.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM("shared") ))
  93         m_eContext = CONTEXT_SHARED;
  94     else if (m_context.matchIgnoreAsciiCaseAsciiL(
  95                  RTL_CONSTASCII_STRINGPARAM("vnd.sun.star.tdoc:/") ))
  96         m_eContext = CONTEXT_DOCUMENT;
  97     else
  98         m_eContext = CONTEXT_UNKNOWN;
  99 }
 100
 101 //______________________________________________________________________________
 102 void PackageRegistryBackend::check()
 103 {
 104     ::osl::MutexGuard guard( getMutex() );
 105     if (rBHelper.bInDispose || rBHelper.bDisposed) {
 106         throw lang::DisposedException(
 107             OUSTR("PackageRegistryBackend instance has already been disposed!"),
 108             static_cast<OWeakObject *>(this) );
 109     }
 110 }
 111
 112 //______________________________________________________________________________
 113 void PackageRegistryBackend::disposing()
 114 {
 115     try {
 116         m_xComponentContext.clear();
 117         WeakComponentImplHelperBase::disposing();
 118     }
 119     catch (RuntimeException &) {
 120         throw;
 121     }
 122     catch (Exception &) {
 123         Any exc( ::cppu::getCaughtException() );
 124         throw lang::WrappedTargetRuntimeException(
 125             OUSTR("caught unexpected exception while disposing!"),
 126             static_cast<OWeakObject *>(this), exc );
 127     }
 128 }
 129
 130 // XPackageRegistry
 131 //______________________________________________________________________________
 132 Reference<deployment::XPackage> PackageRegistryBackend::bindPackage(
 133     OUString const & url, OUString const & mediaType,
 134     Reference<XCommandEnvironment> const & xCmdEnv )
 135     throw (deployment::DeploymentException, CommandFailedException,
 136            lang::IllegalArgumentException, RuntimeException)
 137 {
 138     ::osl::ResettableMutexGuard guard( getMutex() );
 139     check();
 140     t_string2weakref::const_iterator const iFind( m_bound.find( url ) );
 141     if (iFind != m_bound.end()) {
 142         Reference<deployment::XPackage> xPackage( iFind->second );
 143         if (xPackage.is())
 144             return xPackage;
 145     }
 146     guard.clear();
 147
 148     Reference<deployment::XPackage> xNewPackage;
 149     try {
 150         xNewPackage = bindPackage_( url, mediaType, xCmdEnv );
 151     }
 152     catch (RuntimeException &) {
 153         throw;
 154     }
 155     catch (lang::IllegalArgumentException &) {
 156         throw;
 157     }
 158     catch (CommandFailedException &) {
 159         throw;
 160     }
 161     catch (deployment::DeploymentException &) {
 162         throw;
 163     }
 164     catch (Exception &) {
 165         Any exc( ::cppu::getCaughtException() );
 166         throw deployment::DeploymentException(
 167             OUSTR("Error binding package: ") + url,
 168             static_cast<OWeakObject *>(this), exc );
 169     }
 170
 171     guard.reset();
 172     ::std::pair< t_string2weakref::iterator, bool > insertion(
 173         m_bound.insert( t_string2weakref::value_type( url, xNewPackage ) ) );
 174     if (insertion.second)
 175     { // first insertion
 176         OSL_ASSERT( Reference<XInterface>(insertion.first->second)
 177                     == xNewPackage );
 178     }
 179     else
 180     { // found existing entry
 181         Reference<deployment::XPackage> xPackage( insertion.first->second );
 182         if (xPackage.is())
 183             return xPackage;
 184         insertion.first->second = xNewPackage;
 185     }
 186     guard.clear();
 187     xNewPackage->addEventListener( this ); // listen for disposing events
 188     return xNewPackage;
 189 }
 190
 191 //##############################################################################
 192
 193 //______________________________________________________________________________
 194 Package::~Package()
 195 {
 196 }
 197
 198 //______________________________________________________________________________
 199 Package::Package( ::rtl::Reference<PackageRegistryBackend> const & myBackend,
 200                   OUString const & url,
 201                   OUString const & name,
 202                   OUString const & displayName,
 203                   Reference<deployment::XPackageTypeInfo> const & xPackageType )
 204     : t_PackageBase( getMutex() ),
 205       m_myBackend( myBackend ),
 206       m_url( url ),
 207       m_name( name ),
 208       m_displayName( displayName ),
 209       m_xPackageType( xPackageType )
 210 {
 211 }
 212
 213 //______________________________________________________________________________
 214 void Package::disposing()
 215 {
 216     m_myBackend.clear();
 217     WeakComponentImplHelperBase::disposing();
 218 }
 219
 220 //______________________________________________________________________________
 221 void Package::check() const
 222 {
 223     ::osl::MutexGuard guard( getMutex() );
 224     if (rBHelper.bInDispose || rBHelper.bDisposed) {
 225         throw lang::DisposedException(
 226             OUSTR("Package instance has already been disposed!"),
 227             static_cast<OWeakObject *>(const_cast<Package *>(this)));
 228     }
 229 }
 230
 231 // XComponent
 232 //______________________________________________________________________________
 233 void Package::dispose() throw (RuntimeException)
 234 {
 235     check();
 236     WeakComponentImplHelperBase::dispose();
 237 }
 238
 239 //______________________________________________________________________________
 240 void Package::addEventListener(
 241     Reference<lang::XEventListener> const & xListener ) throw (RuntimeException)
 242 {
 243     check();
 244     WeakComponentImplHelperBase::addEventListener( xListener );
 245 }
 246
 247 //______________________________________________________________________________
 248 void Package::removeEventListener(
 249     Reference<lang::XEventListener> const & xListener ) throw (RuntimeException)
 250 {
 251     check();
 252     WeakComponentImplHelperBase::removeEventListener( xListener );
 253 }
 254
 255 // XModifyBroadcaster
 256 //______________________________________________________________________________
 257 void Package::addModifyListener(
 258     Reference<util::XModifyListener> const & xListener )
 259     throw (RuntimeException)
 260 {
 261     check();
 262     rBHelper.addListener( ::getCppuType( &xListener ), xListener );
 263 }
 264
 265 //______________________________________________________________________________
 266 void Package::removeModifyListener(
 267     Reference<util::XModifyListener> const & xListener )
 268     throw (RuntimeException)
 269 {
 270     check();
 271     rBHelper.removeListener( ::getCppuType( &xListener ), xListener );
 272 }
 273
 274 //______________________________________________________________________________
 275 void Package::checkAborted(
 276     ::rtl::Reference<AbortChannel> const & abortChannel )
 277 {
 278     if (abortChannel.is() && abortChannel->isAborted()) {
 279         throw CommandAbortedException(
 280             OUSTR("abort!"), static_cast<OWeakObject *>(this) );
 281     }
 282 }
 283
 284 // XPackage
 285 //______________________________________________________________________________
 286 Reference<task::XAbortChannel> Package::createAbortChannel()
 287     throw (RuntimeException)
 288 {
 289     check();
 290     return new AbortChannel;
 291 }
 292
 293 //______________________________________________________________________________
 294 sal_Bool Package::isBundle() throw (RuntimeException)
 295 {
 296     return false; // default
 297 }
 298
 299 //______________________________________________________________________________
 300 ::sal_Bool Package::checkPrerequisites(
 301         const css::uno::Reference< css::task::XAbortChannel >&,
 302         const css::uno::Reference< css::ucb::XCommandEnvironment >&,
 303         sal_Bool, ::rtl::OUString const &)
 304         throw (css::deployment::DeploymentException,
 305             css::ucb::CommandFailedException,
 306             css::ucb::CommandAbortedException,
 307             css::uno::RuntimeException)
 308 {
 309     return true;
 310 }
 311
 312 //______________________________________________________________________________
 313 ::sal_Bool Package::checkDependencies(
 314         const css::uno::Reference< css::ucb::XCommandEnvironment >& )
 315         throw (css::deployment::DeploymentException,
 316             css::ucb::CommandFailedException,
 317             css::uno::RuntimeException)
 318 {
 319     return true;
 320 }
 321
 322
 323 //______________________________________________________________________________
 324 Sequence< Reference<deployment::XPackage> > Package::getBundle(
 325     Reference<task::XAbortChannel> const &,
 326     Reference<XCommandEnvironment> const & )
 327     throw (deployment::DeploymentException,
 328            CommandFailedException, CommandAbortedException,
 329            lang::IllegalArgumentException, RuntimeException)
 330 {
 331     return Sequence< Reference<deployment::XPackage> >();
 332 }
 333
 334 //______________________________________________________________________________
 335 OUString Package::getName() throw (RuntimeException)
 336 {
 337     return m_name;
 338 }
 339
 340 beans::Optional<OUString> Package::getIdentifier() throw (RuntimeException)
 341 {
 342     return beans::Optional<OUString>();
 343 }
 344
 345 //______________________________________________________________________________
 346 OUString Package::getVersion() throw (RuntimeException)
 347 {
 348     return OUString();
 349 }
 350
 351 //______________________________________________________________________________
 352 OUString Package::getURL() throw (RuntimeException)
 353 {
 354     return m_url;
 355 }
 356
 357 //______________________________________________________________________________
 358 OUString Package::getDisplayName() throw (RuntimeException)
 359 {
 360     return m_displayName;
 361 }
 362
 363 //______________________________________________________________________________
 364 OUString Package::getDescription() throw (RuntimeException)
 365 {
 366     return OUString();
 367 }
 368
 369 //______________________________________________________________________________
 370 Sequence<OUString> Package::getUpdateInformationURLs() throw (RuntimeException)
 371 {
 372     return Sequence<OUString>();
 373 }
 374
 375 //______________________________________________________________________________
 376 css::beans::StringPair Package::getPublisherInfo() throw (RuntimeException)
 377 {
 378     css::beans::StringPair aEmptyPair;
 379     return aEmptyPair;
 380 }
 381
 382 //______________________________________________________________________________
 383 uno::Reference< css::graphic::XGraphic > Package::getIcon( sal_Bool /*bHighContrast*/ ) throw ( RuntimeException )
 384 {
 385     uno::Reference< css::graphic::XGraphic > aEmpty;
 386     return aEmpty;
 387 }
 388
 389 //______________________________________________________________________________
 390 Reference<deployment::XPackageTypeInfo> Package::getPackageType()
 391     throw (RuntimeException)
 392 {
 393     return m_xPackageType;
 394 }
 395
 396 //______________________________________________________________________________
 397 void Package::exportTo(
 398     OUString const & destFolderURL, OUString const & newTitle,
 399     sal_Int32 nameClashAction, Reference<XCommandEnvironment> const & xCmdEnv )
 400     throw (CommandFailedException, CommandAbortedException, RuntimeException)
 401 {
 402     ::ucbhelper::Content destFolder( destFolderURL, xCmdEnv );
 403     ::ucbhelper::Content sourceContent( getURL(), xCmdEnv );
 404     if (! destFolder.transferContent(
 405             sourceContent, ::ucbhelper::InsertOperation_COPY,
 406             newTitle, nameClashAction ))
 407         throw RuntimeException( OUSTR("UCB transferContent() failed!"), 0 );
 408 }
 409
 410 //______________________________________________________________________________
 411 void Package::fireModified()
 412 {
 413     ::cppu::OInterfaceContainerHelper * container = rBHelper.getContainer(
 414         ::getCppuType( static_cast<Reference<
 415                        util::XModifyListener> const *>(0) ) );
 416     if (container != 0) {
 417         Sequence< Reference<XInterface> > elements(
 418             container->getElements() );
 419         lang::EventObject evt( static_cast<OWeakObject *>(this) );
 420         for ( sal_Int32 pos = 0; pos < elements.getLength(); ++pos )
 421         {
 422             Reference<util::XModifyListener> xListener(
 423                 elements[ pos ], UNO_QUERY );
 424             if (xListener.is())
 425                 xListener->modified( evt );
 426         }
 427     }
 428 }
 429
 430 // XPackage
 431 //______________________________________________________________________________
 432 beans::Optional< beans::Ambiguous<sal_Bool> > Package::isRegistered(
 433     Reference<task::XAbortChannel> const & xAbortChannel,
 434     Reference<XCommandEnvironment> const & xCmdEnv )
 435     throw (deployment::DeploymentException,
 436            CommandFailedException, CommandAbortedException, RuntimeException)
 437 {
 438     try {
 439         ::osl::ResettableMutexGuard guard( getMutex() );
 440         return isRegistered_( guard,
 441                               AbortChannel::get(xAbortChannel),
 442                               xCmdEnv );
 443     }
 444     catch (RuntimeException &) {
 445         throw;
 446     }
 447     catch (CommandFailedException &) {
 448         throw;
 449     }
 450     catch (CommandAbortedException &) {
 451         throw;
 452     }
 453     catch (deployment::DeploymentException &) {
 454         throw;
 455     }
 456     catch (Exception &) {
 457         Any exc( ::cppu::getCaughtException() );
 458         throw deployment::DeploymentException(
 459             OUSTR("unexpected exception occured!"),
 460             static_cast<OWeakObject *>(this), exc );
 461     }
 462 }
 463
 464 //______________________________________________________________________________
 465 void Package::processPackage_impl(
 466     bool doRegisterPackage,
 467     Reference<task::XAbortChannel> const & xAbortChannel,
 468     Reference<XCommandEnvironment> const & xCmdEnv )
 469 {
 470     check();
 471     bool action = false;
 472
 473     try {
 474         try {
 475             ::osl::ResettableMutexGuard guard( getMutex() );
 476             beans::Optional< beans::Ambiguous<sal_Bool> > option(
 477                 isRegistered_( guard, AbortChannel::get(xAbortChannel),
 478                                xCmdEnv ) );
 479             action = (option.IsPresent &&
 480                       (option.Value.IsAmbiguous ||
 481                        (doRegisterPackage ? !option.Value.Value
 482                                         : option.Value.Value)));
 483             if (action) {
 484                 OUString displayName( getDisplayName() );
 485                 ProgressLevel progress(
 486                     xCmdEnv,
 487                     (doRegisterPackage
 488                      ? PackageRegistryBackend::StrRegisteringPackage::get()
 489                      : PackageRegistryBackend::StrRevokingPackage::get())
 490                     + displayName );
 491                 processPackage_( guard,
 492                                  doRegisterPackage,
 493                                  AbortChannel::get(xAbortChannel),
 494                                  xCmdEnv );
 495             }
 496         }
 497         catch (RuntimeException &) {
 498             OSL_ENSURE( 0, "### unexpected RuntimeException!" );
 499             throw;
 500         }
 501         catch (CommandFailedException &) {
 502             throw;
 503         }
 504         catch (CommandAbortedException &) {
 505             throw;
 506         }
 507         catch (deployment::DeploymentException &) {
 508             throw;
 509         }
 510         catch (Exception &) {
 511             Any exc( ::cppu::getCaughtException() );
 512             throw deployment::DeploymentException(
 513                 (doRegisterPackage
 514                  ? getResourceString(RID_STR_ERROR_WHILE_REGISTERING)
 515                  : getResourceString(RID_STR_ERROR_WHILE_REVOKING))
 516                 + getDisplayName(), static_cast<OWeakObject *>(this), exc );
 517         }
 518     }
 519     catch (...) {
 520         if (action)
 521             fireModified();
 522         throw;
 523     }
 524     if (action)
 525         fireModified();
 526 }
 527
 528 //______________________________________________________________________________
 529 void Package::registerPackage(
 530     Reference<task::XAbortChannel> const & xAbortChannel,
 531     Reference<XCommandEnvironment> const & xCmdEnv )
 532     throw (deployment::DeploymentException,
 533            CommandFailedException, CommandAbortedException,
 534            lang::IllegalArgumentException, RuntimeException)
 535 {
 536     processPackage_impl( true /* register */, xAbortChannel, xCmdEnv );
 537 }
 538
 539 //______________________________________________________________________________
 540 void Package::revokePackage(
 541     Reference<task::XAbortChannel> const & xAbortChannel,
 542     Reference<XCommandEnvironment> const & xCmdEnv )
 543     throw (deployment::DeploymentException,
 544            CommandFailedException, CommandAbortedException,
 545            lang::IllegalArgumentException, RuntimeException)
 546 {
 547     processPackage_impl( false /* revoke */, xAbortChannel, xCmdEnv );
 548 }
 549
 550 //##############################################################################
 551
 552 //______________________________________________________________________________
 553 Package::TypeInfo::~TypeInfo()
 554 {
 555 }
 556
 557 // XPackageTypeInfo
 558 //______________________________________________________________________________
 559 OUString Package::TypeInfo::getMediaType() throw (RuntimeException)
 560 {
 561     return m_mediaType;
 562 }
 563
 564 //______________________________________________________________________________
 565 OUString Package::TypeInfo::getDescription() throw (RuntimeException)
 566 {
 567     return getShortDescription();
 568 }
 569
 570 //______________________________________________________________________________
 571 OUString Package::TypeInfo::getShortDescription() throw (RuntimeException)
 572 {
 573     return m_shortDescr;
 574 }
 575
 576 //______________________________________________________________________________
 577 OUString Package::TypeInfo::getFileFilter() throw (RuntimeException)
 578 {
 579     return m_fileFilter;
 580 }
 581
 582 //______________________________________________________________________________
 583 Any Package::TypeInfo::getIcon( sal_Bool highContrast, sal_Bool smallIcon )
 584     throw (RuntimeException)
 585 {
 586     if (! smallIcon)
 587         return Any();
 588     const sal_uInt16 nIconId = (highContrast ? m_smallIcon_HC : m_smallIcon);
 589     return Any( &nIconId, getCppuType( static_cast<sal_uInt16 const *>(0) ) );
 590 }
 591
 592 }
 593 }
 594