File: PluginModuleChild.h

package info (click to toggle)
thunderbird 1:60.8.0-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,339,208 kB
  • sloc: cpp: 5,456,704; ansic: 2,360,384; python: 596,095; asm: 340,963; java: 326,291; xml: 258,664; sh: 84,366; makefile: 23,702; perl: 17,317; objc: 3,768; yacc: 1,766; ada: 1,681; lex: 1,364; pascal: 1,264; cs: 879; exp: 527; php: 436; lisp: 258; ruby: 153; awk: 152; sed: 53; csh: 27
file content (337 lines) | stat: -rw-r--r-- 11,312 bytes parent folder | download | duplicates (5)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 * vim: sw=4 ts=4 et :
 * 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/. */

#ifndef dom_plugins_PluginModuleChild_h
#define dom_plugins_PluginModuleChild_h 1

#include "mozilla/Attributes.h"

#include <string>
#include <vector>

#include "base/basictypes.h"

#include "prlink.h"

#include "npapi.h"
#include "npfunctions.h"

#include "nsDataHashtable.h"
#include "nsTHashtable.h"
#include "nsHashKeys.h"

#ifdef MOZ_WIDGET_COCOA
#include "PluginInterposeOSX.h"
#endif

#include "mozilla/plugins/PPluginModuleChild.h"
#include "mozilla/plugins/PluginInstanceChild.h"
#include "mozilla/plugins/PluginMessageUtils.h"
#include "mozilla/plugins/PluginQuirks.h"

namespace mozilla {

class ChildProfilerController;

namespace plugins {

class PluginInstanceChild;

class PluginModuleChild : public PPluginModuleChild {
 protected:
  virtual mozilla::ipc::RacyInterruptPolicy MediateInterruptRace(
      const MessageInfo& parent, const MessageInfo& child) override {
    return MediateRace(parent, child);
  }

  virtual bool ShouldContinueFromReplyTimeout() override;

  virtual mozilla::ipc::IPCResult RecvSettingChanged(
      const PluginSettings& aSettings) override;

  // Implement the PPluginModuleChild interface
  virtual mozilla::ipc::IPCResult RecvInitProfiler(
      Endpoint<mozilla::PProfilerChild>&& aEndpoint) override;
  virtual mozilla::ipc::IPCResult RecvDisableFlashProtectedMode() override;
  virtual mozilla::ipc::IPCResult AnswerNP_GetEntryPoints(NPError* rv) override;
  virtual mozilla::ipc::IPCResult AnswerNP_Initialize(
      const PluginSettings& aSettings, NPError* rv) override;
  virtual mozilla::ipc::IPCResult AnswerSyncNPP_New(
      PPluginInstanceChild* aActor, NPError* rv) override;

  virtual mozilla::ipc::IPCResult RecvInitPluginModuleChild(
      Endpoint<PPluginModuleChild>&& endpoint) override;

  virtual mozilla::ipc::IPCResult RecvInitPluginFunctionBroker(
      Endpoint<PFunctionBrokerChild>&& endpoint) override;

  virtual PPluginInstanceChild* AllocPPluginInstanceChild(
      const nsCString& aMimeType, const InfallibleTArray<nsCString>& aNames,
      const InfallibleTArray<nsCString>& aValues) override;

  virtual bool DeallocPPluginInstanceChild(
      PPluginInstanceChild* aActor) override;

  virtual mozilla::ipc::IPCResult RecvPPluginInstanceConstructor(
      PPluginInstanceChild* aActor, const nsCString& aMimeType,
      InfallibleTArray<nsCString>&& aNames,
      InfallibleTArray<nsCString>&& aValues) override;
  virtual mozilla::ipc::IPCResult AnswerNP_Shutdown(NPError* rv) override;

  virtual mozilla::ipc::IPCResult AnswerOptionalFunctionsSupported(
      bool* aURLRedirectNotify, bool* aClearSiteData,
      bool* aGetSitesWithData) override;

  virtual mozilla::ipc::IPCResult RecvNPP_ClearSiteData(
      const nsCString& aSite, const uint64_t& aFlags, const uint64_t& aMaxAge,
      const uint64_t& aCallbackId) override;

  virtual mozilla::ipc::IPCResult RecvNPP_GetSitesWithData(
      const uint64_t& aCallbackId) override;

  virtual mozilla::ipc::IPCResult RecvSetAudioSessionData(
      const nsID& aId, const nsString& aDisplayName,
      const nsString& aIconPath) override;

  virtual mozilla::ipc::IPCResult RecvSetParentHangTimeout(
      const uint32_t& aSeconds) override;

  virtual mozilla::ipc::IPCResult AnswerInitCrashReporter(
      Shmem&& aShmem, mozilla::dom::NativeThreadId* aId) override;

  virtual void ActorDestroy(ActorDestroyReason why) override;

  virtual mozilla::ipc::IPCResult RecvProcessNativeEventsInInterruptCall()
      override;

  virtual mozilla::ipc::IPCResult AnswerModuleSupportsAsyncRender(
      bool* aResult) override;

 public:
  explicit PluginModuleChild(bool aIsChrome);
  virtual ~PluginModuleChild();

  void CommonInit();

  // aPluginFilename is UTF8, not native-charset!
  bool InitForChrome(const std::string& aPluginFilename,
                     base::ProcessId aParentPid, MessageLoop* aIOLoop,
                     IPC::Channel* aChannel);

  bool InitForContent(Endpoint<PPluginModuleChild>&& aEndpoint);

  static bool CreateForContentProcess(Endpoint<PPluginModuleChild>&& aEndpoint);

  void CleanUp();

  NPError NP_Shutdown();

  const char* GetUserAgent();

  static const NPNetscapeFuncs sBrowserFuncs;

  static PluginModuleChild* GetChrome();

  /**
   * The child implementation of NPN_CreateObject.
   */
  static NPObject* NPN_CreateObject(NPP aNPP, NPClass* aClass);
  /**
   * The child implementation of NPN_RetainObject.
   */
  static NPObject* NPN_RetainObject(NPObject* aNPObj);
  /**
   * The child implementation of NPN_ReleaseObject.
   */
  static void NPN_ReleaseObject(NPObject* aNPObj);

  /**
   * The child implementations of NPIdentifier-related functions.
   */
  static NPIdentifier NPN_GetStringIdentifier(const NPUTF8* aName);
  static void NPN_GetStringIdentifiers(const NPUTF8** aNames,
                                       int32_t aNameCount,
                                       NPIdentifier* aIdentifiers);
  static NPIdentifier NPN_GetIntIdentifier(int32_t aIntId);
  static bool NPN_IdentifierIsString(NPIdentifier aIdentifier);
  static NPUTF8* NPN_UTF8FromIdentifier(NPIdentifier aIdentifier);
  static int32_t NPN_IntFromIdentifier(NPIdentifier aIdentifier);

#ifdef MOZ_WIDGET_COCOA
  void ProcessNativeEvents();

  void PluginShowWindow(uint32_t window_id, bool modal, CGRect r) {
    SendPluginShowWindow(window_id, modal, r.origin.x, r.origin.y, r.size.width,
                         r.size.height);
  }

  void PluginHideWindow(uint32_t window_id) { SendPluginHideWindow(window_id); }

  void SetCursor(NSCursorInfo& cursorInfo) { SendSetCursor(cursorInfo); }

  void ShowCursor(bool show) { SendShowCursor(show); }

  void PushCursor(NSCursorInfo& cursorInfo) { SendPushCursor(cursorInfo); }

  void PopCursor() { SendPopCursor(); }

  bool GetNativeCursorsSupported() {
    return Settings().nativeCursorsSupported();
  }
#endif

  int GetQuirks() { return mQuirks; }

  const PluginSettings& Settings() const { return mCachedSettings; }

  NPError PluginRequiresAudioDeviceChanges(PluginInstanceChild* aInstance,
                                           NPBool aShouldRegister);
  mozilla::ipc::IPCResult RecvNPP_SetValue_NPNVaudioDeviceChangeDetails(
      const NPAudioDeviceChangeDetailsIPC& detailsIPC) override;

 private:
  NPError DoNP_Initialize(const PluginSettings& aSettings);
  void AddQuirk(PluginQuirks quirk) {
    if (mQuirks == QUIRKS_NOT_INITIALIZED) mQuirks = 0;
    mQuirks |= quirk;
  }
  void InitQuirksModes(const nsCString& aMimeType);
  bool InitGraphics();
  void DeinitGraphics();

#if defined(MOZ_WIDGET_GTK)
  static gboolean DetectNestedEventLoop(gpointer data);
  static gboolean ProcessBrowserEvents(gpointer data);

  virtual void EnteredCxxStack() override;
  virtual void ExitedCxxStack() override;
#endif

  PRLibrary* mLibrary;
  nsCString mPluginFilename;  // UTF8
  int mQuirks;

  bool mIsChrome;
  bool mHasShutdown;  // true if NP_Shutdown has run

#ifdef MOZ_GECKO_PROFILER
  RefPtr<ChildProfilerController> mProfilerController;
#endif

  // we get this from the plugin
  NP_PLUGINSHUTDOWN mShutdownFunc;
#if defined(OS_LINUX) || defined(OS_BSD) || defined(OS_SOLARIS) || defined(OS_HURD)
  NP_PLUGINUNIXINIT mInitializeFunc;
#elif defined(OS_WIN) || defined(OS_MACOSX)
  NP_PLUGININIT mInitializeFunc;
  NP_GETENTRYPOINTS mGetEntryPointsFunc;
#endif

  NPPluginFuncs mFunctions;

  PluginSettings mCachedSettings;

#if defined(MOZ_WIDGET_GTK)
  // If a plugin spins a nested glib event loop in response to a
  // synchronous IPC message from the browser, the loop might break
  // only after the browser responds to a request sent by the
  // plugin.  This can happen if a plugin uses gtk's synchronous
  // copy/paste, for example.  But because the browser is blocked on
  // a condvar, it can't respond to the request.  This situation
  // isn't technically a deadlock, but the symptoms are basically
  // the same from the user's perspective.
  //
  // We take two steps to prevent this
  //
  //  (1) Detect nested event loops spun by the plugin.  This is
  //      done by scheduling a glib timer event in the plugin
  //      process whenever the browser might block on the plugin.
  //      If the plugin indeed spins a nested loop, this timer event
  //      will fire "soon" thereafter.
  //
  //  (2) When a nested loop is detected, deschedule the
  //      nested-loop-detection timer and in its place, schedule
  //      another timer that periodically calls back into the
  //      browser and spins a mini event loop.  This mini event loop
  //      processes a handful of pending native events.
  //
  // Because only timer (1) or (2) (or neither) may be active at any
  // point in time, we use the same member variable
  // |mNestedLoopTimerId| to refer to both.
  //
  // When the browser no longer might be blocked on a plugin's IPC
  // response, we deschedule whichever of (1) or (2) is active.
  guint mNestedLoopTimerId;
#ifdef DEBUG
  // Depth of the stack of calls to g_main_context_dispatch before any
  // nested loops are run.  This is 1 when IPC calls are dispatched from
  // g_main_context_iteration, or 0 when dispatched directly from
  // MessagePumpForUI.
  int mTopLoopDepth;
#endif
#endif

#if defined(XP_WIN)
  typedef nsTHashtable<nsPtrHashKey<PluginInstanceChild>> PluginInstanceSet;
  // Set of plugins that have registered to be notified when the audio device
  // changes.
  PluginInstanceSet mAudioNotificationSet;
#endif

 public:  // called by PluginInstanceChild
  /**
   * Dealloc an NPObject after last-release or when the associated instance
   * is destroyed. This function will remove the object from mObjectMap.
   */
  static void DeallocNPObject(NPObject* o);

  NPError NPP_Destroy(PluginInstanceChild* instance) {
    return mFunctions.destroy(instance->GetNPP(), 0);
  }

#if defined(OS_MACOSX) && defined(MOZ_SANDBOX)
  void EnableFlashSandbox(bool aShouldEnableLogging);
#endif

 private:
#if defined(OS_MACOSX) && defined(MOZ_SANDBOX)
  bool mEnableFlashSandbox;
  bool mEnableFlashSandboxLogging;
#endif

#if defined(OS_WIN)
  virtual void EnteredCall() override;
  virtual void ExitedCall() override;

  // Entered/ExitedCall notifications keep track of whether the plugin has
  // entered a nested event loop within this interrupt call.
  struct IncallFrame {
    IncallFrame() : _spinning(false), _savedNestableTasksAllowed(false) {}

    bool _spinning;
    bool _savedNestableTasksAllowed;
  };

  AutoTArray<IncallFrame, 8> mIncallPumpingStack;

  static LRESULT CALLBACK NestedInputEventHook(int code, WPARAM wParam,
                                               LPARAM lParam);
  static LRESULT CALLBACK CallWindowProcHook(int code, WPARAM wParam,
                                             LPARAM lParam);
  void SetEventHooks();
  void ResetEventHooks();
  HHOOK mNestedEventHook;
  HHOOK mGlobalCallWndProcHook;

 public:
  bool mAsyncRenderSupport;
#endif
};

} /* namespace plugins */
} /* namespace mozilla */

#endif  // ifndef dom_plugins_PluginModuleChild_h