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