desktop/source/app/dispatchwatcher.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: dispatchwatcher.hxx,v $
  10  * $Revision: 1.11 $
  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 #ifndef _DESKTOP_DISPATCHWATCHER_HXX
  32 #define _DESKTOP_DISPATCHWATCHER_HXX
  33
  34 #include <cppuhelper/implbase1.hxx>
  35 #include <com/sun/star/frame/XNotifyingDispatch.hpp>
  36 #include <com/sun/star/frame/XDispatchResultListener.hpp>
  37
  38 #include "officeipcthread.hxx"
  39 #include <hash_map>
  40 #include <vector>
  41
  42 namespace desktop
  43 {
  44
  45 /*
  46     Class for controlls dispatching of command URL through office command line. There
  47     are "dangerous" command URLs, that can result in a running office without UI. To prevent
  48     this situation the implementation surveile all dispatches and looks for an open task if
  49     there is arose a problem. If there is none the office will be shutdown to prevent a
  50     running office without UI.
  51 */
  52
  53 struct OUStringHashCode
  54 {
  55     size_t operator()( const ::rtl::OUString& sString ) const
  56     {
  57         return sString.hashCode();
  58     }
  59 };
  60
  61 class DispatchWatcherHashMap : public ::std::hash_map< ::rtl::OUString, sal_Int32, OUStringHashCode, ::std::equal_to< ::rtl::OUString > >
  62 {
  63     public:
  64         inline void free()
  65         {
  66             DispatchWatcherHashMap().swap( *this );
  67         }
  68 };
  69
  70 class DispatchWatcher : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XDispatchResultListener >
  71 {
  72     public:
  73         enum RequestType
  74         {
  75             REQUEST_OPEN,
  76             REQUEST_VIEW,
  77             REQUEST_START,
  78             REQUEST_PRINT,
  79             REQUEST_PRINTTO,
  80             REQUEST_FORCEOPEN,
  81             REQUEST_FORCENEW
  82         };
  83
  84         struct DispatchRequest
  85         {
  86             DispatchRequest( RequestType aType, const ::rtl::OUString& aFile, boost::optional< rtl::OUString > const & cwdUrl, const ::rtl::OUString& aPrinter, const ::rtl::OUString& aFact ) :
  87                 aRequestType( aType ), aURL( aFile ), aCwdUrl( cwdUrl ), aPrinterName( aPrinter ), aPreselectedFactory( aFact ) {}
  88
  89             RequestType         aRequestType;
  90             rtl::OUString       aURL;
  91             boost::optional< rtl::OUString > aCwdUrl;
  92             rtl::OUString       aPrinterName;
  93             rtl::OUString   aPreselectedFactory;
  94         };
  95
  96         typedef std::vector< DispatchRequest > DispatchList;
  97
  98         virtual ~DispatchWatcher();
  99
 100         // XEventListener
 101         virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source )
 102             throw(::com::sun::star::uno::RuntimeException);
 103
 104         // XDispachResultListener
 105         virtual void SAL_CALL dispatchFinished( const com::sun::star::frame::DispatchResultEvent& aEvent ) throw( com::sun::star::uno::RuntimeException );
 106
 107         // Access function to get a dispatcher watcher reference. There must be a global reference holder
 108         static DispatchWatcher* GetDispatchWatcher();
 109
 110         // execute new dispatch request
 111         sal_Bool executeDispatchRequests( const DispatchList& aDispatches, bool bNoTerminate = false );
 112
 113     private:
 114         DispatchWatcher();
 115
 116         static ::osl::Mutex&            GetMutex();
 117
 118         DispatchWatcherHashMap          m_aRequestContainer;
 119
 120         static ::osl::Mutex*            pWatcherMutex;
 121
 122         sal_Int16                   m_nRequestCount;
 123 };
 124
 125 }
 126
 127 #endif // _DESKTOP_DISPATCHWATCHER_HXX