src/third_party/WebKit/Source/web/WebEmbeddedWorkerImpl.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebEmbeddedWorkerImpl_h
  32 #define WebEmbeddedWorkerImpl_h
  33
  34 #include "public/web/WebContentSecurityPolicy.h"
  35 #include "public/web/WebDevToolsAgentClient.h"
  36 #include "public/web/WebEmbeddedWorker.h"
  37 #include "public/web/WebEmbeddedWorkerStartData.h"
  38 #include "public/web/WebFrameClient.h"
  39
  40 namespace blink {
  41
  42 class ServiceWorkerGlobalScopeProxy;
  43 class WebServiceWorkerNetworkProvider;
  44 class WebView;
  45 class WorkerInspectorProxy;
  46 class WorkerThread;
  47
  48 class WebEmbeddedWorkerImpl final
  49     : public WebEmbeddedWorker
  50     , public WebFrameClient
  51     , public WebDevToolsAgentClient {
  52     WTF_MAKE_NONCOPYABLE(WebEmbeddedWorkerImpl);
  53 public:
  54     WebEmbeddedWorkerImpl(
  55         PassOwnPtr<WebServiceWorkerContextClient>,
  56         PassOwnPtr<WebWorkerPermissionClientProxy>);
  57     virtual ~WebEmbeddedWorkerImpl();
  58
  59     // Terminate all WebEmbeddedWorkerImpl for testing purposes.
  60     // Note that this only schedules termination and
  61     // does not synchronously wait for it to complete.
  62     static void terminateAll();
  63
  64     // WebEmbeddedWorker overrides.
  65     virtual void startWorkerContext(const WebEmbeddedWorkerStartData&) override;
  66     virtual void resumeAfterDownload() override;
  67     virtual void terminateWorkerContext() override;
  68     virtual void attachDevTools(const WebString& hostId) override;
  69     virtual void reattachDevTools(const WebString& hostId, const WebString& savedState) override;
  70     virtual void detachDevTools() override;
  71     virtual void dispatchDevToolsMessage(const WebString&) override;
  72
  73     void postMessageToPageInspector(const WTF::String&);
  74
  75 private:
  76     class Loader;
  77     class LoaderProxy;
  78
  79     void prepareShadowPageForLoader();
  80     void loadShadowPage();
  81
  82     // WebFrameClient overrides.
  83     virtual void willSendRequest(
  84         WebLocalFrame*, unsigned identifier, WebURLRequest&,
  85         const WebURLResponse& redirectResponse) override;
  86     virtual void didFinishDocumentLoad(WebLocalFrame*) override;
  87
  88     // WebDevToolsAgentClient overrides.
  89     virtual void sendMessageToInspectorFrontend(const WebString&) override;
  90     virtual void saveAgentRuntimeState(const WebString&) override;
  91     virtual void resumeStartup() override;
  92
  93     void onScriptLoaderFinished();
  94     void startWorkerThread();
  95
  96     WebEmbeddedWorkerStartData m_workerStartData;
  97
  98     OwnPtr<WebServiceWorkerContextClient> m_workerContextClient;
  99
 100     // This is kept until startWorkerContext is called, and then passed on
 101     // to WorkerContext.
 102     OwnPtr<WebWorkerPermissionClientProxy> m_permissionClient;
 103
 104     // We retain ownership of this one which is for use on the
 105     // main thread only.
 106     OwnPtr<WebServiceWorkerNetworkProvider> m_networkProvider;
 107
 108     // Kept around only while main script loading is ongoing.
 109     OwnPtr<Loader> m_mainScriptLoader;
 110
 111     RefPtr<WorkerThread> m_workerThread;
 112     OwnPtr<LoaderProxy> m_loaderProxy;
 113     OwnPtr<ServiceWorkerGlobalScopeProxy> m_workerGlobalScopeProxy;
 114     OwnPtr<WorkerInspectorProxy> m_workerInspectorProxy;
 115
 116     // 'shadow page' - created to proxy loading requests from the worker.
 117     // Both WebView and WebFrame objects are close()'ed (where they're
 118     // deref'ed) when this EmbeddedWorkerImpl is destructed, therefore they
 119     // are guaranteed to exist while this object is around.
 120     WebView* m_webView;
 121     WebFrame* m_mainFrame;
 122
 123     bool m_askedToTerminate;
 124
 125     enum WaitingForDebuggerState {
 126         WaitingForDebuggerBeforeLoadingScript,
 127         WaitingForDebuggerAfterScriptLoaded,
 128         NotWaitingForDebugger
 129     };
 130
 131     enum {
 132         DontPauseAfterDownload,
 133         DoPauseAfterDownload,
 134         IsPausedAfterDownload
 135     } m_pauseAfterDownloadState;
 136
 137     WaitingForDebuggerState m_waitingForDebuggerState;
 138 };
 139
 140 } // namespace blink
 141
 142 #endif // WebEmbeddedWorkerImpl_h