Home | History | Annotate | Download | only in web 
      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 WorkerScriptLoader;
     47 class WorkerThread;
     48 
     49 class WebEmbeddedWorkerImpl FINAL
     50     : public WebEmbeddedWorker
     51     , public WebFrameClient
     52     , public WebDevToolsAgentClient {
     53     WTF_MAKE_NONCOPYABLE(WebEmbeddedWorkerImpl);
     54 public:
     55     WebEmbeddedWorkerImpl(
     56         PassOwnPtr<WebServiceWorkerContextClient>,
     57         PassOwnPtr<WebWorkerPermissionClientProxy>);
     58     virtual ~WebEmbeddedWorkerImpl();
     59 
     60     // Terminate all WebEmbeddedWorkerImpl for testing purposes.
     61     // Note that this only schedules termination and
     62     // does not synchronously wait for it to complete.
     63     static void terminateAll();
     64 
     65     // WebEmbeddedWorker overrides.
     66     virtual void startWorkerContext(const WebEmbeddedWorkerStartData&) OVERRIDE;
     67     virtual void resumeAfterDownload() OVERRIDE;
     68     virtual void terminateWorkerContext() OVERRIDE;
     69     virtual void resumeWorkerContext() OVERRIDE;
     70     virtual void attachDevTools(const WebString& hostId) OVERRIDE;
     71     virtual void reattachDevTools(const WebString& hostId, const WebString& savedState) OVERRIDE;
     72     virtual void detachDevTools() OVERRIDE;
     73     virtual void dispatchDevToolsMessage(const WebString&) OVERRIDE;
     74 
     75     void postMessageToPageInspector(const WTF::String&);
     76 
     77 private:
     78     class Loader;
     79     class LoaderProxy;
     80 
     81     void prepareShadowPageForLoader();
     82 
     83     // WebFrameClient overrides.
     84     virtual void willSendRequest(
     85         WebLocalFrame*, unsigned identifier, WebURLRequest&,
     86         const WebURLResponse& redirectResponse) OVERRIDE;
     87     virtual void didFinishDocumentLoad(WebLocalFrame*) OVERRIDE;
     88 
     89     // WebDevToolsAgentClient overrides.
     90     virtual void sendMessageToInspectorFrontend(const WebString&) OVERRIDE;
     91     virtual void saveAgentRuntimeState(const WebString&) OVERRIDE;
     92     virtual void resumeStartup() OVERRIDE;
     93 
     94     void startScriptLoader(WebLocalFrame*);
     95     void onScriptLoaderFinished();
     96     void startWorkerThread();
     97 
     98     WebEmbeddedWorkerStartData m_workerStartData;
     99 
    100     OwnPtr<WebServiceWorkerContextClient> m_workerContextClient;
    101 
    102     // This is kept until startWorkerContext is called, and then passed on
    103     // to WorkerContext.
    104     OwnPtr<WebWorkerPermissionClientProxy> m_permissionClient;
    105 
    106     // We retain ownership of this one which is for use on the
    107     // main thread only.
    108     OwnPtr<WebServiceWorkerNetworkProvider> m_networkProvider;
    109 
    110     // Kept around only while main script loading is ongoing.
    111     OwnPtr<Loader> m_mainScriptLoader;
    112 
    113     RefPtr<WorkerThread> m_workerThread;
    114     OwnPtr<LoaderProxy> m_loaderProxy;
    115     OwnPtr<ServiceWorkerGlobalScopeProxy> m_workerGlobalScopeProxy;
    116     OwnPtr<WorkerInspectorProxy> m_workerInspectorProxy;
    117 
    118     // 'shadow page' - created to proxy loading requests from the worker.
    119     // Both WebView and WebFrame objects are close()'ed (where they're
    120     // deref'ed) when this EmbeddedWorkerImpl is destructed, therefore they
    121     // are guaranteed to exist while this object is around.
    122     WebView* m_webView;
    123     WebFrame* m_mainFrame;
    124 
    125     bool m_askedToTerminate;
    126 
    127     enum WaitingForDebuggerState {
    128         WaitingForDebuggerBeforeLoadingScript,
    129         WaitingForDebuggerAfterScriptLoaded,
    130         NotWaitingForDebugger
    131     };
    132 
    133     enum {
    134         DontPauseAfterDownload,
    135         DoPauseAfterDownload,
    136         IsPausedAfterDownload
    137     } m_pauseAfterDownloadState;
    138 
    139     WaitingForDebuggerState m_waitingForDebuggerState;
    140 };
    141 
    142 } // namespace blink
    143 
    144 #endif // WebEmbeddedWorkerImpl_h
    145