desktop/source/app/dispatchwatcher.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_DESKTOP_SOURCE_APP_DISPATCHWATCHER_HXX
  21 #define INCLUDED_DESKTOP_SOURCE_APP_DISPATCHWATCHER_HXX
  22
  23 #include <cppuhelper/implbase1.hxx>
  24 #include <com/sun/star/frame/XNotifyingDispatch.hpp>
  25 #include <com/sun/star/frame/XDispatchResultListener.hpp>
  26
  27 #include "officeipcthread.hxx"
  28 #include <boost/unordered_map.hpp>
  29 #include <vector>
  30
  31 namespace desktop
  32 {
  33
  34 /*
  35     Class for controlls dispatching of command URL through office command line. There
  36     are "dangerous" command URLs, that can result in a running office without UI. To prevent
  37     this situation the implementation surveile all dispatches and looks for an open task if
  38     there is arose a problem. If there is none the office will be shutdown to prevent a
  39     running office without UI.
  40 */
  41
  42 class DispatchWatcherHashMap : public ::boost::unordered_map< OUString, sal_Int32, OUStringHash, ::std::equal_to< OUString >  >
  43 {
  44     public:
  45         inline void free()
  46         {
  47             DispatchWatcherHashMap().swap( *this );
  48         }
  49 };
  50
  51 class DispatchWatcher : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XDispatchResultListener >
  52 {
  53     public:
  54         enum RequestType
  55         {
  56             REQUEST_OPEN,
  57             REQUEST_VIEW,
  58             REQUEST_START,
  59             REQUEST_PRINT,
  60             REQUEST_PRINTTO,
  61             REQUEST_FORCEOPEN,
  62             REQUEST_FORCENEW,
  63             REQUEST_CONVERSION,
  64             REQUEST_INFILTER,
  65             REQUEST_BATCHPRINT
  66         };
  67
  68         struct DispatchRequest
  69         {
  70             DispatchRequest( RequestType aType, const OUString& aFile, boost::optional< OUString > const & cwdUrl, const OUString& aPrinter, const OUString& aFact ) :
  71                 aRequestType( aType ), aURL( aFile ), aCwdUrl( cwdUrl ), aPrinterName( aPrinter ), aPreselectedFactory( aFact ) {}
  72
  73             RequestType     aRequestType;
  74             OUString   aURL;
  75             boost::optional< OUString > aCwdUrl;
  76             OUString   aPrinterName;  // also conversion params
  77             OUString   aPreselectedFactory;
  78         };
  79
  80         typedef std::vector< DispatchRequest > DispatchList;
  81
  82         virtual ~DispatchWatcher();
  83
  84         // XEventListener
  85         virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source )
  86             throw(::com::sun::star::uno::RuntimeException);
  87
  88         // XDispachResultListener
  89         virtual void SAL_CALL dispatchFinished( const com::sun::star::frame::DispatchResultEvent& aEvent ) throw( com::sun::star::uno::RuntimeException );
  90
  91         // Access function to get a dispatcher watcher reference. There must be a global reference holder
  92         static DispatchWatcher* GetDispatchWatcher();
  93
  94         // execute new dispatch request
  95         sal_Bool executeDispatchRequests( const DispatchList& aDispatches, bool bNoTerminate = false );
  96
  97     private:
  98         DispatchWatcher();
  99
 100         static ::osl::Mutex&        GetMutex();
 101
 102         DispatchWatcherHashMap      m_aRequestContainer;
 103
 104         sal_Int16                   m_nRequestCount;
 105 };
 106
 107 }
 108
 109 #endif // INCLUDED_DESKTOP_SOURCE_APP_DISPATCHWATCHER_HXX
 110
 111 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */