extensions/source/update/check/updatecheckjob.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 #include <memory>
  31
  32 #include "updatecheck.hxx"
  33 #include "updatecheckconfig.hxx"
  34 #include "updatehdl.hxx"
  35 #include "updateprotocol.hxx"
  36
  37 #include <cppuhelper/implbase3.hxx>
  38 #include <cppuhelper/implementationentry.hxx>
  39
  40 #include "com/sun/star/frame/XDesktop.hpp"
  41 #include "com/sun/star/frame/XTerminateListener.hpp"
  42 #include <com/sun/star/task/XJob.hpp>
  43
  44 namespace beans = com::sun::star::beans ;
  45 namespace frame = com::sun::star::frame ;
  46 namespace lang = com::sun::star::lang ;
  47 namespace task = com::sun::star::task ;
  48 namespace uno = com::sun::star::uno ;
  49
  50 #define UNISTRING(s) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(s))
  51
  52 namespace
  53 {
  54
  55 class InitUpdateCheckJobThread : public osl::Thread
  56 {
  57 public:
  58     InitUpdateCheckJobThread( const uno::Reference< uno::XComponentContext > &xContext,
  59                               const uno::Sequence< beans::NamedValue > &xParameters,
  60                               bool bShowDialog );
  61
  62     virtual void SAL_CALL run();
  63
  64     void    setTerminating();
  65
  66 private:
  67     osl::Condition m_aCondition;
  68     uno::Reference<uno::XComponentContext> m_xContext;
  69     uno::Sequence<beans::NamedValue> m_xParameters;
  70     bool m_bShowDialog;
  71     bool m_bTerminating;
  72 };
  73
  74 class UpdateCheckJob :
  75     public ::cppu::WeakImplHelper3< task::XJob, lang::XServiceInfo, frame::XTerminateListener >
  76 {
  77     virtual ~UpdateCheckJob();
  78
  79 public:
  80
  81     UpdateCheckJob(const uno::Reference<uno::XComponentContext>& xContext);
  82
  83     static uno::Sequence< rtl::OUString > getServiceNames();
  84     static rtl::OUString getImplName();
  85
  86     // Allows runtime exceptions to be thrown by const methods
  87     inline SAL_CALL operator uno::Reference< uno::XInterface > () const
  88         { return const_cast< cppu::OWeakObject * > (static_cast< cppu::OWeakObject const * > (this)); };
  89
  90     // XJob
  91     virtual uno::Any SAL_CALL execute(const uno::Sequence<beans::NamedValue>&)
  92         throw (lang::IllegalArgumentException, uno::Exception);
  93
  94     // XServiceInfo
  95     virtual rtl::OUString SAL_CALL getImplementationName()
  96         throw (uno::RuntimeException);
  97     virtual sal_Bool SAL_CALL supportsService(rtl::OUString const & serviceName)
  98         throw (uno::RuntimeException);
  99     virtual uno::Sequence< rtl::OUString > SAL_CALL getSupportedServiceNames()
 100         throw (uno::RuntimeException);
 101
 102     // XEventListener
 103     virtual void SAL_CALL disposing( ::com::sun::star::lang::EventObject const & evt )
 104         throw (::com::sun::star::uno::RuntimeException);
 105
 106     // XTerminateListener
 107     virtual void SAL_CALL queryTermination( lang::EventObject const & evt )
 108         throw ( frame::TerminationVetoException, uno::RuntimeException );
 109     virtual void SAL_CALL notifyTermination( lang::EventObject const & evt )
 110         throw ( uno::RuntimeException );
 111
 112 private:
 113     uno::Reference<uno::XComponentContext>  m_xContext;
 114     uno::Reference< frame::XDesktop >       m_xDesktop;
 115     std::auto_ptr< InitUpdateCheckJobThread > m_pInitThread;
 116
 117     void handleExtensionUpdates( const uno::Sequence< beans::NamedValue > &rListProp );
 118 };
 119
 120 //------------------------------------------------------------------------------
 121 //------------------------------------------------------------------------------
 122 //------------------------------------------------------------------------------
 123 InitUpdateCheckJobThread::InitUpdateCheckJobThread(
 124             const uno::Reference< uno::XComponentContext > &xContext,
 125             const uno::Sequence< beans::NamedValue > &xParameters,
 126             bool bShowDialog ) :
 127     m_xContext( xContext ),
 128     m_xParameters( xParameters ),
 129     m_bShowDialog( bShowDialog ),
 130     m_bTerminating( false )
 131 {
 132     create();
 133 }
 134
 135 //------------------------------------------------------------------------------
 136 void SAL_CALL InitUpdateCheckJobThread::run()
 137 {
 138     if (!m_bShowDialog) {
 139         TimeValue tv = { 25, 0 };
 140         m_aCondition.wait( &tv );
 141         if ( m_bTerminating )
 142             return;
 143     }
 144
 145     rtl::Reference< UpdateCheck > aController( UpdateCheck::get() );
 146     aController->initialize( m_xParameters, m_xContext );
 147
 148     if ( m_bShowDialog )
 149         aController->showDialog( true );
 150 }
 151
 152 void InitUpdateCheckJobThread::setTerminating() {
 153     m_bTerminating = true;
 154     m_aCondition.set();
 155 }
 156
 157 //------------------------------------------------------------------------------
 158 //------------------------------------------------------------------------------
 159 //------------------------------------------------------------------------------
 160
 161 UpdateCheckJob::UpdateCheckJob( const uno::Reference<uno::XComponentContext>& xContext ) :
 162     m_xContext(xContext)
 163 {
 164     m_xDesktop.set( xContext->getServiceManager()->createInstanceWithContext( UNISTRING("com.sun.star.frame.Desktop"), xContext ), uno::UNO_QUERY );
 165     if ( m_xDesktop.is() )
 166         m_xDesktop->addTerminateListener( this );
 167 }
 168
 169 //------------------------------------------------------------------------------
 170
 171 UpdateCheckJob::~UpdateCheckJob()
 172 {
 173 }
 174
 175 //------------------------------------------------------------------------------
 176
 177 uno::Sequence< rtl::OUString >
 178 UpdateCheckJob::getServiceNames()
 179 {
 180     uno::Sequence< rtl::OUString > aServiceList(1);
 181     aServiceList[0] = UNISTRING( "com.sun.star.setup.UpdateCheck");
 182     return aServiceList;
 183 };
 184
 185 //------------------------------------------------------------------------------
 186
 187 rtl::OUString
 188 UpdateCheckJob::getImplName()
 189 {
 190     return UNISTRING( "vnd.sun.UpdateCheck");
 191 }
 192
 193
 194 //------------------------------------------------------------------------------
 195
 196 uno::Any
 197 UpdateCheckJob::execute(const uno::Sequence<beans::NamedValue>& namedValues)
 198     throw (lang::IllegalArgumentException, uno::Exception)
 199 {
 200     for ( sal_Int32 n=namedValues.getLength(); n-- > 0; )
 201     {
 202         if ( namedValues[ n ].Name == "DynamicData" )
 203         {
 204             uno::Sequence<beans::NamedValue> aListProp;
 205             if ( namedValues[n].Value >>= aListProp )
 206             {
 207                 for ( sal_Int32 i=aListProp.getLength(); i-- > 0; )
 208                 {
 209                     if ( aListProp[ i ].Name == "updateList" )
 210                     {
 211                         handleExtensionUpdates( aListProp );
 212                         return uno::Any();
 213                     }
 214                 }
 215             }
 216         }
 217     }
 218
 219     uno::Sequence<beans::NamedValue> aConfig =
 220         getValue< uno::Sequence<beans::NamedValue> > (namedValues, "JobConfig");
 221
 222     /* Determine the way we got invoked here -
 223      * see Developers Guide Chapter "4.7.2 Jobs" to understand the magic
 224      */
 225
 226     uno::Sequence<beans::NamedValue> aEnvironment =
 227         getValue< uno::Sequence<beans::NamedValue> > (namedValues, "Environment");
 228
 229     rtl::OUString aEventName = getValue< rtl::OUString > (aEnvironment, "EventName");
 230
 231     m_pInitThread.reset(
 232         new InitUpdateCheckJobThread(
 233             m_xContext, aConfig,
 234             !aEventName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("onFirstVisibleTask"))));
 235
 236     return uno::Any();
 237 }
 238
 239 //------------------------------------------------------------------------------
 240 void UpdateCheckJob::handleExtensionUpdates( const uno::Sequence< beans::NamedValue > &rListProp )
 241 {
 242     try {
 243         uno::Sequence< uno::Sequence< rtl::OUString > > aList =
 244             getValue< uno::Sequence< uno::Sequence< rtl::OUString > > > ( rListProp, "updateList" );
 245         bool bPrepareOnly = getValue< bool > ( rListProp, "prepareOnly" );
 246
 247         // we will first store any new found updates and then check, if there are any
 248         // pending updates.
 249         storeExtensionUpdateInfos( m_xContext, aList );
 250
 251         if ( bPrepareOnly )
 252             return;
 253
 254         bool bHasUpdates = checkForPendingUpdates( m_xContext );
 255
 256         rtl::Reference<UpdateCheck> aController( UpdateCheck::get() );
 257         if ( ! aController.is() )
 258             return;
 259
 260         aController->setHasExtensionUpdates( bHasUpdates );
 261
 262         if ( ! aController->hasOfficeUpdate() )
 263         {
 264             if ( bHasUpdates )
 265                 aController->setUIState( UPDATESTATE_EXT_UPD_AVAIL, true );
 266             else
 267                 aController->setUIState( UPDATESTATE_NO_UPDATE_AVAIL, true );
 268         }
 269     }
 270     catch( const uno::Exception& e )
 271     {
 272          OSL_TRACE( "Caught exception: %s\n thread terminated.\n",
 273             rtl::OUStringToOString(e.Message, RTL_TEXTENCODING_UTF8).getStr());
 274     }
 275 }
 276
 277 //------------------------------------------------------------------------------
 278
 279 rtl::OUString SAL_CALL
 280 UpdateCheckJob::getImplementationName() throw (uno::RuntimeException)
 281 {
 282     return getImplName();
 283 }
 284
 285 //------------------------------------------------------------------------------
 286
 287 uno::Sequence< rtl::OUString > SAL_CALL
 288 UpdateCheckJob::getSupportedServiceNames() throw (uno::RuntimeException)
 289 {
 290     return getServiceNames();
 291 }
 292
 293 //------------------------------------------------------------------------------
 294
 295 sal_Bool SAL_CALL
 296 UpdateCheckJob::supportsService( rtl::OUString const & serviceName ) throw (uno::RuntimeException)
 297 {
 298     uno::Sequence< rtl::OUString > aServiceNameList = getServiceNames();
 299
 300     for( sal_Int32 n=0; n < aServiceNameList.getLength(); n++ )
 301         if( aServiceNameList[n].equals(serviceName) )
 302             return sal_True;
 303
 304     return sal_False;
 305 }
 306
 307 //------------------------------------------------------------------------------
 308 // XEventListener
 309 void SAL_CALL UpdateCheckJob::disposing( lang::EventObject const & rEvt )
 310     throw ( uno::RuntimeException )
 311 {
 312     bool shutDown = ( rEvt.Source == m_xDesktop );
 313
 314     if ( shutDown && m_xDesktop.is() )
 315     {
 316         m_xDesktop->removeTerminateListener( this );
 317         m_xDesktop.clear();
 318     }
 319 }
 320
 321 //------------------------------------------------------------------------------
 322 // XTerminateListener
 323 void SAL_CALL UpdateCheckJob::queryTermination( lang::EventObject const & )
 324     throw ( frame::TerminationVetoException, uno::RuntimeException )
 325 {
 326 }
 327
 328 //------------------------------------------------------------------------------
 329 void SAL_CALL UpdateCheckJob::notifyTermination( lang::EventObject const & )
 330     throw ( uno::RuntimeException )
 331 {
 332     if ( m_pInitThread.get() != 0 )
 333     {
 334         m_pInitThread->setTerminating();
 335         m_pInitThread->join();
 336     }
 337 }
 338
 339 } // anonymous namespace
 340
 341 //------------------------------------------------------------------------------
 342
 343 static uno::Reference<uno::XInterface> SAL_CALL
 344 createJobInstance(const uno::Reference<uno::XComponentContext>& xContext)
 345 {
 346     return *new UpdateCheckJob(xContext);
 347 }
 348
 349 //------------------------------------------------------------------------------
 350
 351 static uno::Reference<uno::XInterface> SAL_CALL
 352 createConfigInstance(const uno::Reference<uno::XComponentContext>& xContext)
 353 {
 354     return *UpdateCheckConfig::get(xContext, *UpdateCheck::get());
 355 }
 356
 357 //------------------------------------------------------------------------------
 358
 359 static const cppu::ImplementationEntry kImplementations_entries[] =
 360 {
 361     {
 362         createJobInstance,
 363         UpdateCheckJob::getImplName,
 364         UpdateCheckJob::getServiceNames,
 365         cppu::createSingleComponentFactory,
 366         NULL,
 367         0
 368     },
 369     {
 370         createConfigInstance,
 371         UpdateCheckConfig::getImplName,
 372         UpdateCheckConfig::getServiceNames,
 373         cppu::createSingleComponentFactory,
 374         NULL,
 375         0
 376     },
 377     { NULL, NULL, NULL, NULL, NULL, 0 }
 378 } ;
 379
 380 //------------------------------------------------------------------------------
 381
 382 extern "C" SAL_DLLPUBLIC_EXPORT void * SAL_CALL component_getFactory(const sal_Char *pszImplementationName, void *pServiceManager, void *pRegistryKey)
 383 {
 384     return cppu::component_getFactoryHelper(
 385         pszImplementationName,
 386         pServiceManager,
 387         pRegistryKey,
 388         kImplementations_entries) ;
 389 }
 390
 391 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */