desktop/source/deployment/gui/dp_gui_extensioncmdqueue.hxx

   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_gui_extensioncmdqueue.hxx,v $
  10  *
  11  * $Revision: 1.3.14.1 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef INCLUDED_DP_GUI_EXTENSIONCMDQUEUE_HXX
  33 #define INCLUDED_DP_GUI_EXTENSIONCMDQUEUE_HXX
  34
  35 #include "sal/config.h"
  36
  37 #include "com/sun/star/uno/Reference.hxx"
  38 #include "rtl/ref.hxx"
  39
  40 #include <vector>
  41
  42 #include "dp_gui_updatedata.hxx"
  43
  44 /// @HTML
  45
  46 namespace com { namespace sun { namespace star {
  47     namespace deployment { class XPackageManager; }
  48     namespace task { class XInteractionRequest; }
  49     namespace uno { class XComponentContext; }
  50 } } }
  51
  52 namespace dp_gui {
  53
  54 class DialogHelper;
  55 class TheExtensionManager;
  56
  57 /**
  58    Manages installing of extensions in the GUI mode. Requests for installing
  59    Extensions can be asynchronous. For example, the Extension Manager is running
  60    in an office process and someone uses the system integration to install an Extension.
  61    That is, the user double clicks an extension symbol in a file browser, which then
  62    causes an invocation of "unopkg gui ext". When at that time the Extension Manager
  63    already performs a task, triggered by the user (for example, add, update, disable,
  64    enable) then adding of the extension will be postponed until the user has finished
  65    the task.
  66
  67    This class also ensures that the extensions are not installed in the main thread.
  68    Doing so would cause a deadlock because of the progress bar which needs to be constantly
  69    updated.
  70 */
  71 class ExtensionCmdQueue {
  72
  73 public:
  74     /**
  75        Create an instance.
  76     */
  77     ExtensionCmdQueue( DialogHelper * pDialogHelper,
  78                        TheExtensionManager *pManager,
  79                        const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > & rContext);
  80
  81     ~ExtensionCmdQueue();
  82
  83     /**
  84     */
  85     void addExtension( const ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackageManager > &rPackageManager,
  86                        const ::rtl::OUString &rExtensionURL,
  87                        const bool bWarnUser );
  88     void removeExtension( const ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackageManager > &rPackageManager,
  89                           const ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackage > &rPackage );
  90     void enableExtension( const ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackage > &rPackage,
  91                           const bool bEnable );
  92     void checkForUpdates( const std::vector< TUpdateListEntry > &vList );
  93     /**
  94        This call does not block. It signals the internal thread
  95        that it should install the remaining extensions and then terminate.
  96     */
  97     void stop();
  98
  99     /** Determines if thread of this class has terminated.
 100     */
 101     bool hasTerminated();
 102
 103     /** Blocks until the thread has terminated. All URLs in the queue will be processed.
 104     */
 105     void stopAndWait();
 106
 107     bool isBusy();
 108 private:
 109     ExtensionCmdQueue(ExtensionCmdQueue &); // not defined
 110     void operator =(ExtensionCmdQueue &); // not defined
 111
 112     class Thread;
 113
 114     rtl::Reference< Thread > m_thread;
 115 };
 116
 117 void handleInteractionRequest( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > & xContext,
 118                                const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest > & xRequest );
 119
 120 }
 121
 122 #endif