blob: 336d409026b0d4fc75e934ba9342be9a2d104536 [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef WorkerShadowPage_h
#define WorkerShadowPage_h
#include "core/exported/WebDevToolsAgentImpl.h"
#include "core/frame/WebLocalFrameImpl.h"
#include "public/web/WebDocumentLoader.h"
#include "public/web/WebFrameClient.h"
#include "public/web/WebView.h"
namespace blink {
class ContentSecurityPolicy;
class WebApplicationCacheHost;
class WebApplicationCacheHostClient;
class WebSettings;
// WorkerShadowPage implements the 'shadow page' concept.
// Loading components are strongly associated with frames, but out-of-process
// workers (i.e., SharedWorker and ServiceWorker) don't have frames. To enable
// loading on such workers, this class provides a virtual frame (a.k.a, shadow
// page) to them.
// WorkerShadowPage lives on the main thread.
// TODO(nhiroki): Move this into core/workers once all dependencies on
// core/exported are gone (now depending on core/exported/WebViewImpl.h in
// *.cpp).
// TODO(kinuko): Make this go away (
class CORE_EXPORT WorkerShadowPage : public WebFrameClient {
class CORE_EXPORT Client : public WebDevToolsAgentImpl::WorkerClient {
virtual ~Client() = default;
// Called when the shadow page is requested to create an application cache
// host.
virtual std::unique_ptr<WebApplicationCacheHost> CreateApplicationCacheHost(
WebApplicationCacheHostClient*) = 0;
// Called when Initialize() is completed.
virtual void OnShadowPageInitialized() = 0;
virtual const WebString& GetDevToolsFrameToken() = 0;
explicit WorkerShadowPage(Client*);
~WorkerShadowPage() override;
// Calls Client::OnShadowPageInitialized() when complete.
void Initialize(const KURL& script_url);
void SetContentSecurityPolicyAndReferrerPolicy(ContentSecurityPolicy*,
String referrer_policy);
// WebFrameClient overrides.
std::unique_ptr<WebApplicationCacheHost> CreateApplicationCacheHost(
WebApplicationCacheHostClient*) override;
// Note: usually WebFrameClient implementations override WebFrameClient to
// call Close() on the corresponding WebLocalFrame. Shadow pages are set up a
// bit differently and clear the WebFrameClient pointer before shutting down,
// so the shadow page must also manually call Close() on the corresponding
// frame and its widget.
void DidFinishDocumentLoad() override;
std::unique_ptr<blink::WebURLLoaderFactory> CreateURLLoaderFactory() override;
WebString GetDevToolsFrameToken() override;
Document* GetDocument() { return main_frame_->GetFrame()->GetDocument(); }
WebSettings* GetSettings() { return web_view_->GetSettings(); }
WebDocumentLoader* DocumentLoader() {
return main_frame_->GetDocumentLoader();
void BindDevToolsAgent(mojom::blink::DevToolsAgentAssociatedRequest);
bool WasInitialized() const;
enum class State { kUninitialized, kInitializing, kInitialized };
void AdvanceState(State);
Client* client_;
WebView* web_view_;
Persistent<WebLocalFrameImpl> main_frame_;
State state_ = State::kUninitialized;
} // namespace blink
#endif // WorkerShadowPage_h