blob: 26002ec8eea761218c8da745b4fbbb0f005d2b01 [file] [log] [blame]
// Copyright 2014 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.
#include <string>
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "extensions/common/features/feature.h"
#include "extensions/renderer/module_system.h"
#include "extensions/renderer/request_sender.h"
#include "extensions/renderer/safe_builtins.h"
#include "extensions/renderer/scoped_persistent.h"
#include "v8/include/v8.h"
namespace blink {
class WebFrame;
namespace content {
class RenderView;
namespace extensions {
class Extension;
// Extensions wrapper for a v8 context.
class ScriptContext : public RequestSender::Source {
ScriptContext(const v8::Handle<v8::Context>& context,
blink::WebFrame* frame,
const Extension* extension,
Feature::Context context_type);
virtual ~ScriptContext();
// Clears the WebFrame for this contexts and invalidates the associated
// ModuleSystem.
void Invalidate();
// Returns true if this context is still valid, false if it isn't.
// A context becomes invalid via Invalidate().
bool is_valid() const { return !v8_context_.IsEmpty(); }
v8::Handle<v8::Context> v8_context() const {
return v8_context_.NewHandle(isolate());
const Extension* extension() const { return extension_.get(); }
blink::WebFrame* web_frame() const { return web_frame_; }
Feature::Context context_type() const { return context_type_; }
void set_module_system(scoped_ptr<ModuleSystem> module_system) {
module_system_ = module_system.Pass();
ModuleSystem* module_system() { return module_system_.get(); }
SafeBuiltins* safe_builtins() { return &safe_builtins_; }
const SafeBuiltins* safe_builtins() const { return &safe_builtins_; }
// Returns the ID of the extension associated with this context, or empty
// string if there is no such extension.
const std::string& GetExtensionID() const;
// Returns the RenderView associated with this context. Can return NULL if the
// context is in the process of being destroyed.
content::RenderView* GetRenderView() const;
// Runs |function| with appropriate scopes. Doesn't catch exceptions, callers
// must do that if they want.
v8::Local<v8::Value> CallFunction(v8::Handle<v8::Function> function,
int argc,
v8::Handle<v8::Value> argv[]) const;
void DispatchEvent(const char* event_name, v8::Handle<v8::Array> args) const;
// Fires the onunload event on the unload_event module.
void DispatchOnUnloadEvent();
// Returns the availability of the API |api_name|.
Feature::Availability GetAvailability(const std::string& api_name);
// Returns a string description of the type of context this is.
std::string GetContextTypeDescription();
v8::Isolate* isolate() const { return isolate_; }
// Get the URL of this context's web frame.
GURL GetURL() const;
// Returns whether the API |api| or any part of the API could be
// available in this context without taking into account the context's
// extension.
bool IsAnyFeatureAvailableToContext(const extensions::Feature& api);
// Utility to get the URL we will match against for a frame. If the frame has
// committed, this is the commited URL. Otherwise it is the provisional URL.
static GURL GetDataSourceURLForFrame(const blink::WebFrame* frame);
// Returns the first non-about:-URL in the document hierarchy above and
// including |frame|. The document hierarchy is only traversed if
// |document_url| is an about:-URL and if |match_about_blank| is true.
static GURL GetEffectiveDocumentURL(const blink::WebFrame* frame,
const GURL& document_url,
bool match_about_blank);
// RequestSender::Source implementation.
virtual ScriptContext* GetContext() OVERRIDE;
virtual void OnResponseReceived(const std::string& name,
int request_id,
bool success,
const base::ListValue& response,
const std::string& error) OVERRIDE;
// The v8 context the bindings are accessible to.
ScopedPersistent<v8::Context> v8_context_;
// The WebFrame associated with this context. This can be NULL because this
// object can outlive is destroyed asynchronously.
blink::WebFrame* web_frame_;
// The extension associated with this context, or NULL if there is none. This
// might be a hosted app in the case that this context is hosting a web URL.
scoped_refptr<const Extension> extension_;
// The type of context.
Feature::Context context_type_;
// Owns and structures the JS that is injected to set up extension bindings.
scoped_ptr<ModuleSystem> module_system_;
// Contains safe copies of builtin objects like Function.prototype.
SafeBuiltins safe_builtins_;
v8::Isolate* isolate_;
} // namespace extensions