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 "core/workers/WorkerLoaderProxy.h"
  35
  36 #include "public/web/WebContentSecurityPolicy.h"
  37 #include "public/web/WebDevToolsAgentClient.h"
  38 #include "public/web/WebEmbeddedWorker.h"
  39 #include "public/web/WebEmbeddedWorkerStartData.h"
  40 #include "public/web/WebFrameClient.h"
  41
  42 namespace blink {
  43
  44 class ServiceWorkerGlobalScopeProxy;
  45 class WebLocalFrameImpl;
  46 class WebServiceWorkerNetworkProvider;
  47 class WebView;
  48 class WorkerInspectorProxy;
  49 class WorkerScriptLoader;
  50 class WorkerThread;
  51
  52 class WebEmbeddedWorkerImpl final
  53     : public WebEmbeddedWorker
  54     , public WebFrameClient
  55     , public WebDevToolsAgentClient
  56     , private WorkerLoaderProxyProvider {
  57     WTF_MAKE_NONCOPYABLE(WebEmbeddedWorkerImpl);
  58 public:
  59     WebEmbeddedWorkerImpl(PassOwnPtr<WebServiceWorkerContextClient>, PassOwnPtr<WebWorkerContentSettingsClientProxy>);
  60     ~WebEmbeddedWorkerImpl() override;
  61
  62     // WebEmbeddedWorker overrides.
  63     void startWorkerContext(const WebEmbeddedWorkerStartData&) override;
  64     void terminateWorkerContext() override;
  65     void attachDevTools(const WebString& hostId) override;
  66     void reattachDevTools(const WebString& hostId, const WebString& savedState) override;
  67     void detachDevTools() override;
  68     void dispatchDevToolsMessage(const WebString&) override;
  69
  70     void postMessageToPageInspector(const WTF::String&);
  71
  72 private:
  73     void prepareShadowPageForLoader();
  74     void loadShadowPage();
  75
  76     // WebFrameClient overrides.
  77     void willSendRequest(
  78         WebLocalFrame*, unsigned identifier, WebURLRequest&,
  79         const WebURLResponse& redirectResponse) override;
  80     void didFinishDocumentLoad(WebLocalFrame*, bool documentIsEmpty) override;
  81
  82     // WebDevToolsAgentClient overrides.
  83     void sendProtocolMessage(int callId, const WebString&, const WebString&) override;
  84     void resumeStartup() override;
  85
  86     void onScriptLoaderFinished();
  87     void startWorkerThread();
  88
  89     // WorkerLoaderProxyProvider
  90     void postTaskToLoader(PassOwnPtr<ExecutionContextTask>) override;
  91     bool postTaskToWorkerGlobalScope(PassOwnPtr<ExecutionContextTask>) override;
  92
  93     WebEmbeddedWorkerStartData m_workerStartData;
  94
  95     OwnPtr<WebServiceWorkerContextClient> m_workerContextClient;
  96
  97     // This is kept until startWorkerContext is called, and then passed on
  98     // to WorkerContext.
  99     OwnPtr<WebWorkerContentSettingsClientProxy> m_contentSettingsClient;
 100
 101     // We retain ownership of this one which is for use on the
 102     // main thread only.
 103     OwnPtr<WebServiceWorkerNetworkProvider> m_networkProvider;
 104
 105     // Kept around only while main script loading is ongoing.
 106     RefPtr<WorkerScriptLoader> m_mainScriptLoader;
 107
 108     RefPtr<WorkerThread> m_workerThread;
 109     RefPtr<WorkerLoaderProxy> m_loaderProxy;
 110     OwnPtr<ServiceWorkerGlobalScopeProxy> m_workerGlobalScopeProxy;
 111     OwnPtrWillBePersistent<WorkerInspectorProxy> m_workerInspectorProxy;
 112
 113     // 'shadow page' - created to proxy loading requests from the worker.
 114     // Both WebView and WebFrame objects are close()'ed (where they're
 115     // deref'ed) when this EmbeddedWorkerImpl is destructed, therefore they
 116     // are guaranteed to exist while this object is around.
 117     WebView* m_webView;
 118     RefPtrWillBePersistent<WebLocalFrameImpl> m_mainFrame;
 119
 120     bool m_loadingShadowPage;
 121     bool m_askedToTerminate;
 122
 123     enum WaitingForDebuggerState {
 124         WaitingForDebuggerBeforeLoadingScript,
 125         WaitingForDebuggerAfterScriptLoaded,
 126         NotWaitingForDebugger
 127     };
 128
 129     WaitingForDebuggerState m_waitingForDebuggerState;
 130 };
 131
 132 } // namespace blink
 133
 134 #endif // WebEmbeddedWorkerImpl_h