summaryrefslogtreecommitdiff
path: root/desktop/source/app/officeipcthread.hxx
blob: e4f3edaf9673fb95e31bec2bc488e84ed16ecd9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_DESKTOP_SOURCE_APP_OFFICEIPCTHREAD_HXX
#define INCLUDED_DESKTOP_SOURCE_APP_OFFICEIPCTHREAD_HXX

#include <sal/config.h>

#include <vector>

#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/frame/XTerminateListener.hpp>
#include <osl/signal.h>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <salhelper/simplereferenceobject.hxx>
#include <cppuhelper/implbase.hxx>
#include <osl/conditn.hxx>
#include <optional>

namespace desktop
{

oslSignalAction SalMainPipeExchangeSignal_impl(void* /*pData*/, oslSignalInfo* pInfo);

// A request for the current office
// that was given by command line or by IPC pipe communication.
struct ProcessDocumentsRequest
{
    explicit ProcessDocumentsRequest(std::optional< OUString > const & cwdUrl):
        aCwdUrl(cwdUrl), pcProcessed( nullptr ), bTextCat( false ), bScriptCat( false ) {}

    std::optional< OUString > aCwdUrl;
    OUString aModule;
    std::vector< OUString > aOpenList; // Documents that should be opened in the default way
    std::vector< OUString > aViewList; // Documents that should be opened in viewmode
    std::vector< OUString > aStartList; // Documents/Presentations that should be started
    std::vector< OUString > aPrintList; // Documents that should be printed on default printer
    std::vector< OUString > aForceOpenList; // Documents that should be forced to open for editing (even templates)
    std::vector< OUString > aForceNewList; // Documents that should be forced to create a new document
    OUString aPrinterName;   // The printer name that should be used for printing
    std::vector< OUString > aPrintToList; // Documents that should be printed on the given printer
    std::vector< OUString > aConversionList;
    OUString aConversionParams;
    OUString aConversionOut;
    OUString aImageConversionType;
    std::vector< OUString > aInFilter;
    ::osl::Condition *pcProcessed;  // pointer condition to be set when the request has been processed
    bool* mpbSuccess = nullptr; // pointer to boolean receiving if the processing was successful
    bool bTextCat; // boolean flag indicating whether to dump text content to console
    bool bScriptCat; // boolean flag indicating whether to dump script content to console
};

class DispatchWatcher;
class IpcThread;
class PipeIpcThread;
class DbusIpcThread;

class RequestHandler: public salhelper::SimpleReferenceObject
{
    friend IpcThread;
    friend PipeIpcThread;
    friend DbusIpcThread;

  private:
    static rtl::Reference< RequestHandler > pGlobal;

    enum class State { Starting, RequestsEnabled, Downing };

    State                       mState;
    int                         mnPendingRequests;
    rtl::Reference<DispatchWatcher> mpDispatchWatcher;
    rtl::Reference<IpcThread> mIpcThread;

    /* condition to be set when the request has been processed */
    ::osl::Condition cProcessed;
    /* receives if the processing was successful (may be false e.g. when shutting down) */
    bool mbSuccess = false;

    /* condition to be set when the main event loop is ready
       otherwise an error dialogs event loop could eat away
       requests from a 2nd office */
    ::osl::Condition cReady;

    static ::osl::Mutex&        GetMutex();

    RequestHandler();

    virtual ~RequestHandler() override;

  public:
    enum Status
    {
        IPC_STATUS_OK,
        IPC_STATUS_2ND_OFFICE,
        IPC_STATUS_PIPE_ERROR,
        IPC_STATUS_BOOTSTRAP_ERROR
    };

    // controlling pipe communication during shutdown
    static void                 SetDowning();
    static void                 EnableRequests();
    static bool                 AreRequestsPending();
    static void                 RequestsCompleted();
    static bool                 ExecuteCmdLineRequests(
        ProcessDocumentsRequest&, bool noTerminate);

    // return sal_False if second office
    static Status               Enable(bool ipc);
    static void                 Disable();
    // start dispatching events...
    static void                 SetReady(bool bIsReady);
    static void                 WaitForReady();

    bool                        AreRequestsEnabled() const { return mState == State::RequestsEnabled; }
};


class RequestHandlerController : public ::cppu::WeakImplHelper<
                                            css::lang::XServiceInfo,
                                            css::frame::XTerminateListener >
{
    public:
        RequestHandlerController() {}

        // XServiceInfo
        virtual OUString SAL_CALL getImplementationName() override;
        virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
        virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;

        // XEventListener
        virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;

        // XTerminateListener
        virtual void SAL_CALL queryTermination( const css::lang::EventObject& aEvent ) override;
        virtual void SAL_CALL notifyTermination( const css::lang::EventObject& aEvent ) override;
};

}

#endif // INCLUDED_DESKTOP_SOURCE_APP_OFFICEIPCTHREAD_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */