framework/source/jobs/jobdispatch.cxx

   1     /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 // MARKER(update_precomp.py): autogen include statement, do not remove
  29 #include "precompiled_framework.hxx"
  30
  31 //________________________________
  32 //  my own includes
  33 #include <jobs/jobdispatch.hxx>
  34 #include <jobs/joburl.hxx>
  35 #include <jobs/job.hxx>
  36 #include <threadhelp/readguard.hxx>
  37 #include <threadhelp/writeguard.hxx>
  38 #include <threadhelp/resetableguard.hxx>
  39 #include <classes/converter.hxx>
  40 #include <general.h>
  41 #include <services.h>
  42
  43 //________________________________
  44 //  interface includes
  45 #include <com/sun/star/beans/XPropertySet.hpp>
  46 #include <com/sun/star/frame/DispatchResultState.hpp>
  47
  48 //________________________________
  49 //  includes of other projects
  50 #include <rtl/ustrbuf.hxx>
  51 #include <vcl/svapp.hxx>
  52
  53 //________________________________
  54 //  namespace
  55
  56 namespace framework{
  57
  58 //________________________________
  59 //  non exported const
  60
  61 //________________________________
  62 //  non exported definitions
  63
  64 //________________________________
  65 //  declarations
  66
  67 DEFINE_XINTERFACE_6( JobDispatch                                     ,
  68                      OWeakObject                                     ,
  69                      DIRECT_INTERFACE(css::lang::XTypeProvider      ),
  70                      DIRECT_INTERFACE(css::frame::XDispatchProvider ),
  71                      DIRECT_INTERFACE(css::lang::XInitialization ),
  72                      DIRECT_INTERFACE(css::lang::XServiceInfo),
  73                      DIRECT_INTERFACE(css::frame::XNotifyingDispatch),
  74                      DIRECT_INTERFACE(css::frame::XDispatch         )
  75                    )
  76
  77 DEFINE_XTYPEPROVIDER_6( JobDispatch                   ,
  78                         css::lang::XTypeProvider      ,
  79                         css::frame::XDispatchProvider ,
  80                         css::frame::XNotifyingDispatch,
  81                         css::lang::XInitialization,
  82                         css::lang::XServiceInfo,
  83                         css::frame::XDispatch
  84                       )
  85
  86 DEFINE_XSERVICEINFO_MULTISERVICE( JobDispatch                   ,
  87                                   ::cppu::OWeakObject           ,
  88                                   SERVICENAME_PROTOCOLHANDLER   ,
  89                                   IMPLEMENTATIONNAME_JOBDISPATCH
  90                                 )
  91
  92 DEFINE_INIT_SERVICE( JobDispatch,
  93                      {
  94                          /*Attention
  95                              I think we don't need any mutex or lock here ... because we are called by our own static method impl_createInstance()
  96                              to create a new instance of this class by our own supported service factory.
  97                              see macro DEFINE_XSERVICEINFO_MULTISERVICE and "impl_initService()" for further informations!
  98                          */
  99                      }
 100                    )
 101
 102 //________________________________
 103 /**
 104     @short      standard ctor
 105     @descr      It initialize this new instance.
 106
 107     @param      xSMGR
 108                     reference to the uno service manager
 109 */
 110 JobDispatch::JobDispatch( /*IN*/ const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR )
 111     : ThreadHelpBase(&Application::GetSolarMutex())
 112     , OWeakObject   (                             )
 113     , m_xSMGR       (xSMGR                        )
 114 {
 115 }
 116
 117 //________________________________
 118 /**
 119     @short  let this instance die
 120     @descr  We have to release all used ressources and free used memory.
 121 */
 122 JobDispatch::~JobDispatch()
 123 {
 124     // release all used ressources
 125     m_xSMGR  = css::uno::Reference< css::lang::XMultiServiceFactory >();
 126     m_xFrame = css::uno::Reference< css::frame::XFrame >();
 127 }
 128
 129 //________________________________
 130 /**
 131     @short  implementation of XInitalization
 132     @descr  A protocol handler can provide this functionality, if it wish to get additional informations
 133             about the context it runs. In this case the frame reference would be given by the outside code.
 134
 135     @param  lArguments
 136                 the list of initialization arguments
 137                 First parameter should be the frame reference we need.
 138 */
 139 void SAL_CALL JobDispatch::initialize( const css::uno::Sequence< css::uno::Any >& lArguments ) throw(css::uno::Exception       ,
 140                                                                                                      css::uno::RuntimeException)
 141 {
 142     /* SAFE { */
 143     WriteGuard aWriteLock(m_aLock);
 144
 145     for (int a=0; a<lArguments.getLength(); ++a)
 146     {
 147         if (a==0)
 148             lArguments[a] >>= m_xFrame;
 149     }
 150
 151     aWriteLock.unlock();
 152     /* } SAFE */
 153 }
 154
 155 //________________________________
 156 /**
 157     @short  implementation of XDispatchProvider::queryDispatches()
 158     @descr  Every protocol handler will be asked for his agreement, if an URL was queried
 159             for which this handler is registered. It's the chance for this handler to validate
 160             the given URL and return a dispatch object (may be itself) or not.
 161
 162     @param  aURL
 163                 the queried URL, which should be checked
 164
 165     @param  sTargetFrameName
 166                 describes the target frame, in which context this handler will be used
 167                 Is mostly set to "", "_self", "_blank", "_default" or a non special one
 168                 using SELF/CREATE as search flags.
 169
 170     @param  nSearchFlags
 171                 Can be SELF or CREATE only and are set only if sTargetFrameName isn't a special target
 172 */
 173 css::uno::Reference< css::frame::XDispatch > SAL_CALL JobDispatch::queryDispatch( /*IN*/ const css::util::URL&  aURL             ,
 174                                                                                   /*IN*/ const ::rtl::OUString& /*sTargetFrameName*/ ,
 175                                                                                   /*IN*/       sal_Int32        /*nSearchFlags*/     ) throw(css::uno::RuntimeException)
 176 {
 177     css::uno::Reference< css::frame::XDispatch > xDispatch;
 178
 179     JobURL aAnalyzedURL(aURL.Complete);
 180     if (aAnalyzedURL.isValid())
 181         xDispatch = css::uno::Reference< css::frame::XDispatch >( static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY );
 182
 183     return xDispatch;
 184 }
 185
 186 //________________________________
 187 /**
 188     @short  implementation of XDispatchProvider::queryDispatches()
 189     @descr  It's an optimized access for remote, so you can ask for
 190             multiple dispatch objects at the same time.
 191
 192     @param  lDescriptor
 193                 a list of queryDispatch() parameter
 194
 195     @return A list of corresponding dispatch objects.
 196             NULL references are not skipped. Every result
 197             match to one given descriptor item.
 198 */
 199 css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL JobDispatch::queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw(css::uno::RuntimeException)
 200 {
 201     // don't pack resulting list!
 202     sal_Int32 nCount = lDescriptor.getLength();
 203     css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > lDispatches(nCount);
 204
 205     for (sal_Int32 i=0; i<nCount; ++i)
 206         lDispatches[i] = queryDispatch( lDescriptor[i].FeatureURL  ,
 207                                         lDescriptor[i].FrameName   ,
 208                                         lDescriptor[i].SearchFlags );
 209     return lDispatches;
 210 }
 211
 212 //________________________________
 213 /**
 214     @short  implementation of XNotifyingDispatch::dispatchWithNotification()
 215     @descr  It creates the job service implementation and call execute on it.
 216             Further it starts the life time control of it. (important for async job)
 217             For synchonrous job we react for the returned result directly ... for asynchronous
 218             ones we do it later inside our callback method. But we use the same impl method
 219             doing that to share the code. (see impl_finishJob())
 220
 221             If a job is already running, (it can only occure for asynchronous jobs)
 222             don't start the same job a second time. Queue in the given dispatch parameter
 223             and return immediatly. If the current running job call us back, we will start this
 224             new dispatch request.
 225             If no job is running - queue the parameter too! But then start the new job immediatly.
 226             We have to queue it every time - because it hold us alive by ref count!
 227
 228     @param  aURL
 229                 describe the job(s), which should be started
 230
 231     @param  lArgs
 232                 optional arguments for this request
 233
 234     @param  xListener
 235                 an interested listener for possible results of this operation
 236 */
 237 void SAL_CALL JobDispatch::dispatchWithNotification( /*IN*/ const css::util::URL&                                             aURL      ,
 238                                                      /*IN*/ const css::uno::Sequence< css::beans::PropertyValue >&            lArgs     ,
 239                                                      /*IN*/ const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException)
 240 {
 241     JobURL aAnalyzedURL(aURL.Complete);
 242     if (aAnalyzedURL.isValid())
 243     {
 244         ::rtl::OUString sRequest;
 245         if (aAnalyzedURL.getEvent(sRequest))
 246             impl_dispatchEvent(sRequest, lArgs, xListener);
 247         else
 248         if (aAnalyzedURL.getService(sRequest))
 249             impl_dispatchService(sRequest, lArgs, xListener);
 250         else
 251         if (aAnalyzedURL.getAlias(sRequest))
 252             impl_dispatchAlias(sRequest, lArgs, xListener);
 253     }
 254 }
 255
 256 //________________________________
 257 /**
 258     @short  dispatch an event
 259     @descr  We search all registered jobs for this event and execute it.
 260             After doing so, we inform the given listener about the results.
 261             (There will be one notify for every executed job!)
 262
 263     @param  sEvent
 264                 the event, for which jobs can be registered
 265
 266     @param  lArgs
 267                 optional arguments for this request
 268                 Currently not used!
 269
 270     @param  xListener
 271                 an interested listener for possible results of this operation
 272 */
 273 void JobDispatch::impl_dispatchEvent( /*IN*/ const ::rtl::OUString&                                            sEvent    ,
 274                                       /*IN*/ const css::uno::Sequence< css::beans::PropertyValue >&            lArgs     ,
 275                                       /*IN*/ const css::uno::Reference< css::frame::XDispatchResultListener >& xListener )
 276 {
 277     // get list of all enabled jobs
 278     // The called static helper methods read it from the configuration and
 279     // filter disabled jobs using it's time stamp values.
 280     /* SAFE { */
 281     ReadGuard aReadLock(m_aLock);
 282     css::uno::Sequence< ::rtl::OUString > lJobs = JobData::getEnabledJobsForEvent(m_xSMGR, sEvent);
 283     aReadLock.unlock();
 284     /* } SAFE */
 285
 286     css::uno::Reference< css::frame::XDispatchResultListener > xThis( static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY );
 287
 288     // no jobs ... no execution
 289     // But a may given listener will know something ...
 290     // I think this operaton was finished successfully.
 291     // It's not realy an error, if no registered jobs could be located.
 292     if (lJobs.getLength()<1 && xListener.is())
 293     {
 294         css::frame::DispatchResultEvent aEvent;
 295         aEvent.Source = xThis;
 296         aEvent.State  = css::frame::DispatchResultState::SUCCESS;
 297         xListener->dispatchFinished(aEvent);
 298         return;
 299     }
 300
 301     // Step over all found jobs and execute it
 302     for (int j=0; j<lJobs.getLength(); ++j)
 303     {
 304         /* SAFE { */
 305         aReadLock.lock();
 306
 307         JobData aCfg(m_xSMGR);
 308         aCfg.setEvent(sEvent, lJobs[j]);
 309         aCfg.setEnvironment(JobData::E_DISPATCH);
 310
 311         /*Attention!
 312             Jobs implements interfaces and dies by ref count!
 313             And freeing of such uno object is done by uno itself.
 314             So we have to use dynamic memory everytimes.
 315          */
 316         Job* pJob = new Job(m_xSMGR, m_xFrame);
 317         css::uno::Reference< css::uno::XInterface > xJob(static_cast< ::cppu::OWeakObject* >(pJob), css::uno::UNO_QUERY);
 318         pJob->setJobData(aCfg);
 319
 320         aReadLock.unlock();
 321         /* } SAFE */
 322
 323         // Special mode for listener.
 324         // We dont notify it directly here. We delegate that
 325         // to the job implementation. But we must set ourself there too.
 326         // Because this job must fake the source adress of the event.
 327         // Otherwhise the listener may will ignore it.
 328         if (xListener.is())
 329             pJob->setDispatchResultFake(xListener, xThis);
 330         pJob->execute(Converter::convert_seqPropVal2seqNamedVal(lArgs));
 331     }
 332 }
 333
 334 //________________________________
 335 /**
 336     @short  dispatch a service
 337     @descr  We use the given name only to create and if possible to initialize
 338             it as an uno service. It can be usefully for creating (caching?)
 339             of e.g. one instance services.
 340
 341     @param  sService
 342                 the uno implementation or service name of the job, which should be instanciated
 343
 344     @param  lArgs
 345                 optional arguments for this request
 346                 Currently not used!
 347
 348     @param  xListener
 349                 an interested listener for possible results of this operation
 350 */
 351 void JobDispatch::impl_dispatchService( /*IN*/ const ::rtl::OUString&                                            sService  ,
 352                                         /*IN*/ const css::uno::Sequence< css::beans::PropertyValue >&            lArgs     ,
 353                                         /*IN*/ const css::uno::Reference< css::frame::XDispatchResultListener >& xListener )
 354 {
 355     /* SAFE { */
 356     ReadGuard aReadLock(m_aLock);
 357
 358     JobData aCfg(m_xSMGR);
 359     aCfg.setService(sService);
 360     aCfg.setEnvironment(JobData::E_DISPATCH);
 361
 362     /*Attention!
 363         Jobs implements interfaces and dies by ref count!
 364         And freeing of such uno object is done by uno itself.
 365         So we have to use dynamic memory everytimes.
 366      */
 367     Job* pJob = new Job(m_xSMGR, m_xFrame);
 368     css::uno::Reference< css::uno::XInterface > xJob(static_cast< ::cppu::OWeakObject* >(pJob), css::uno::UNO_QUERY);
 369     pJob->setJobData(aCfg);
 370
 371     aReadLock.unlock();
 372     /* } SAFE */
 373
 374     css::uno::Reference< css::frame::XDispatchResultListener > xThis( static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY );
 375
 376     // Special mode for listener.
 377     // We dont notify it directly here. We delegate that
 378     // to the job implementation. But we must set ourself there too.
 379     // Because this job must fake the source adress of the event.
 380     // Otherwhise the listener may will ignore it.
 381     if (xListener.is())
 382         pJob->setDispatchResultFake(xListener, xThis);
 383     pJob->execute(Converter::convert_seqPropVal2seqNamedVal(lArgs));
 384 }
 385
 386 //________________________________
 387 /**
 388     @short  dispatch an alias
 389     @descr  We use this alias to locate a job inside the configuration
 390             and execute it. Further we inform the given listener about the results.
 391
 392     @param  sAlias
 393                 the alias name of the configured job
 394
 395     @param  lArgs
 396                 optional arguments for this request
 397                 Currently not used!
 398
 399     @param  xListener
 400                 an interested listener for possible results of this operation
 401 */
 402 void JobDispatch::impl_dispatchAlias( /*IN*/ const ::rtl::OUString&                                            sAlias    ,
 403                                       /*IN*/ const css::uno::Sequence< css::beans::PropertyValue >&            lArgs     ,
 404                                       /*IN*/ const css::uno::Reference< css::frame::XDispatchResultListener >& xListener )
 405 {
 406     /* SAFE { */
 407     ReadGuard aReadLock(m_aLock);
 408
 409     JobData aCfg(m_xSMGR);
 410     aCfg.setAlias(sAlias);
 411     aCfg.setEnvironment(JobData::E_DISPATCH);
 412
 413     /*Attention!
 414         Jobs implements interfaces and dies by ref count!
 415         And freeing of such uno object is done by uno itself.
 416         So we have to use dynamic memory everytimes.
 417      */
 418     Job* pJob = new Job(m_xSMGR, m_xFrame);
 419     css::uno::Reference< css::uno::XInterface > xJob(static_cast< ::cppu::OWeakObject* >(pJob), css::uno::UNO_QUERY);
 420     pJob->setJobData(aCfg);
 421
 422     aReadLock.unlock();
 423     /* } SAFE */
 424
 425     css::uno::Reference< css::frame::XDispatchResultListener > xThis( static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY );
 426
 427     // Special mode for listener.
 428     // We dont notify it directly here. We delegate that
 429     // to the job implementation. But we must set ourself there too.
 430     // Because this job must fake the source adress of the event.
 431     // Otherwhise the listener may will ignore it.
 432     if (xListener.is())
 433         pJob->setDispatchResultFake(xListener, xThis);
 434     pJob->execute(Converter::convert_seqPropVal2seqNamedVal(lArgs));
 435 }
 436
 437 //________________________________
 438 /**
 439     @short  implementation of XDispatch::dispatch()
 440     @descr  Because the methods dispatch() and dispatchWithNotification() are different in her parameters
 441             only, we can forward this request to dispatchWithNotification() by using an empty listener!
 442
 443     @param  aURL
 444                 describe the job(s), which should be started
 445
 446     @param  lArgs
 447                 optional arguments for this request
 448
 449     @see    dispatchWithNotification()
 450 */
 451 void SAL_CALL JobDispatch::dispatch( /*IN*/ const css::util::URL&                                  aURL  ,
 452                                      /*IN*/ const css::uno::Sequence< css::beans::PropertyValue >& lArgs ) throw(css::uno::RuntimeException)
 453 {
 454     dispatchWithNotification(aURL, lArgs, css::uno::Reference< css::frame::XDispatchResultListener >());
 455 }
 456
 457 //________________________________
 458 /**
 459     @short  not supported
 460 */
 461 void SAL_CALL JobDispatch::addStatusListener( /*IN*/ const css::uno::Reference< css::frame::XStatusListener >&,
 462                                               /*IN*/ const css::util::URL&                                      ) throw(css::uno::RuntimeException)
 463 {
 464 }
 465
 466 //________________________________
 467 /**
 468     @short  not supported
 469 */
 470 void SAL_CALL JobDispatch::removeStatusListener( /*IN*/ const css::uno::Reference< css::frame::XStatusListener >&,
 471                                                  /*IN*/ const css::util::URL&                                          ) throw(css::uno::RuntimeException)
 472 {
 473 }
 474
 475 } // namespace framework