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/implbase.hxx>
  24 #include <com/sun/star/frame/XDispatchResultListener.hpp>
  25
  26 #include "officeipcthread.hxx"
  27 #include <unordered_map>
  28 #include <vector>
  29
  30 namespace desktop
  31 {
  32
  33 /*
  34     Class for controls dispatching of command URL through office command line. There
  35     are "dangerous" command URLs, that can result in a running office without UI. To prevent
  36     this situation the implementation monitors all dispatches and looks for an open task if
  37     there is arose a problem. If there is none the office will be shutdown to prevent a
  38     running office without UI.
  39 */
  40 class DispatchWatcher : public ::cppu::WeakImplHelper< css::frame::XDispatchResultListener >
  41 {
  42     public:
  43         enum RequestType
  44         {
  45             REQUEST_OPEN,
  46             REQUEST_VIEW,
  47             REQUEST_START,
  48             REQUEST_PRINT,
  49             REQUEST_PRINTTO,
  50             REQUEST_FORCEOPEN,
  51             REQUEST_FORCENEW,
  52             REQUEST_CONVERSION,
  53             REQUEST_INFILTER,
  54             REQUEST_BATCHPRINT,
  55             REQUEST_CAT,
  56             REQUEST_SCRIPT_CAT
  57         };
  58
  59         struct DispatchRequest
  60         {
  61             RequestType aRequestType;
  62             OUString    aURL;
  63             boost::optional< OUString > aCwdUrl;
  64             OUString    aPrinterName;  // also conversion params
  65             OUString    aPreselectedFactory;
  66         };
  67
  68         DispatchWatcher();
  69
  70         virtual ~DispatchWatcher() override;
  71
  72         // XEventListener
  73         virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
  74
  75         // XDispachResultListener
  76         virtual void SAL_CALL dispatchFinished( const css::frame::DispatchResultEvent& aEvent ) override;
  77
  78         // execute new dispatch request
  79         bool executeDispatchRequests( const std::vector<DispatchRequest>& aDispatches, bool bNoTerminate );
  80
  81     private:
  82         osl::Mutex m_mutex;
  83
  84         sal_Int16                   m_nRequestCount;
  85 };
  86
  87 }
  88
  89 #endif // INCLUDED_DESKTOP_SOURCE_APP_DISPATCHWATCHER_HXX
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */