Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebKit / PluginProcess / PluginProcess.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(NETSCAPE_PLUGIN_API)
29
30 #include "ChildProcess.h"
31 #include <WebCore/CountedUserActivity.h>
32 #include <wtf/Forward.h>
33 #include <wtf/text/WTFString.h>
34
35 #if PLATFORM(COCOA)
36 #include <WebCore/MachSendRight.h>
37 #endif
38
39 namespace WebKit {
40
41 class NetscapePluginModule;
42 class WebProcessConnection;
43 struct PluginProcessCreationParameters;
44         
45 class PluginProcess : public ChildProcess
46 {
47     WTF_MAKE_NONCOPYABLE(PluginProcess);
48     friend class NeverDestroyed<PluginProcess>;
49 public:
50     static PluginProcess& singleton();
51
52     void removeWebProcessConnection(WebProcessConnection*);
53
54     NetscapePluginModule* netscapePluginModule();
55
56     const String& pluginPath() const { return m_pluginPath; }
57
58 #if PLATFORM(COCOA)
59     void setModalWindowIsShowing(bool);
60     void setFullscreenWindowIsShowing(bool);
61
62     const WebCore::MachSendRight& compositingRenderServerPort() const { return m_compositingRenderServerPort; }
63
64     bool launchProcess(const String& launchPath, const Vector<String>& arguments);
65     bool launchApplicationAtURL(const String& urlString, const Vector<String>& arguments);
66     bool openURL(const String& urlString, int32_t& status, String& launchedURLString);
67     bool openFile(const String& urlString);
68 #endif
69
70     CountedUserActivity& connectionActivity() { return m_connectionActivity; }
71
72 private:
73     PluginProcess();
74     ~PluginProcess();
75
76     // ChildProcess
77     void initializeProcess(const ChildProcessInitializationParameters&) override;
78     void initializeProcessName(const ChildProcessInitializationParameters&) override;
79     void initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&) override;
80     bool shouldTerminate() override;
81     void platformInitializeProcess(const ChildProcessInitializationParameters&);
82
83 #if USE(APPKIT)
84     void stopRunLoop() override;
85 #endif
86
87     // IPC::Connection::Client
88     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
89     void didClose(IPC::Connection&) override;
90
91     // Message handlers.
92     void didReceivePluginProcessMessage(IPC::Connection&, IPC::Decoder&);
93     void initializePluginProcess(PluginProcessCreationParameters&&);
94     void createWebProcessConnection();
95
96     void getSitesWithData(uint64_t callbackID);
97     void deleteWebsiteData(std::chrono::system_clock::time_point modifiedSince, uint64_t callbackID);
98     void deleteWebsiteDataForHostNames(const Vector<String>& hostNames, uint64_t callbackID);
99
100     void platformInitializePluginProcess(PluginProcessCreationParameters&&);
101     
102     void setMinimumLifetime(Seconds);
103     void minimumLifetimeTimerFired();
104     // Our web process connections.
105     Vector<RefPtr<WebProcessConnection>> m_webProcessConnections;
106
107     // The plug-in path.
108     String m_pluginPath;
109
110 #if PLATFORM(COCOA)
111     String m_pluginBundleIdentifier;
112 #endif
113
114     // The plug-in module.
115     RefPtr<NetscapePluginModule> m_pluginModule;
116     
117     bool m_supportsAsynchronousPluginInitialization;
118
119     RunLoop::Timer<PluginProcess> m_minimumLifetimeTimer;
120
121 #if PLATFORM(COCOA)
122     // The Mach port used for accelerated compositing.
123     WebCore::MachSendRight m_compositingRenderServerPort;
124
125     String m_nsurlCacheDirectory;
126 #endif
127
128     CountedUserActivity m_connectionActivity;
129 };
130
131 } // namespace WebKit
132
133 #endif // ENABLE(NETSCAPE_PLUGIN_API)