blob: 4d5eb7c407f9425e63e7a7dd6ed2072d77a570a2 [file] [log] [blame]
// Copyright 2016 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 "extensions/renderer/bindings/api_binding.h"
#include <algorithm>
#include "base/bind.h"
#include "base/logging.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/values.h"
#include "extensions/renderer/bindings/api_binding_hooks.h"
#include "extensions/renderer/bindings/api_binding_types.h"
#include "extensions/renderer/bindings/api_binding_util.h"
#include "extensions/renderer/bindings/api_event_handler.h"
#include "extensions/renderer/bindings/api_invocation_errors.h"
#include "extensions/renderer/bindings/api_request_handler.h"
#include "extensions/renderer/bindings/api_signature.h"
#include "extensions/renderer/bindings/api_type_reference_map.h"
#include "extensions/renderer/bindings/binding_access_checker.h"
#include "extensions/renderer/bindings/declarative_event.h"
#include "gin/arguments.h"
#include "gin/handle.h"
#include "gin/per_context_data.h"
#include "third_party/blink/public/web/web_user_gesture_indicator.h"
namespace extensions {
namespace {
// Returns the name of the enum value for use in JavaScript; JS enum entries use
// SCREAMING_STYLE.
std::string GetJSEnumEntryName(const std::string& original) {
// The webstorePrivate API has an empty enum value for a result.
// TODO(devlin): Work with the webstore team to see if we can move them off
// this - they also already have a "success" result that they can use.
// See crbug.com/709120.
if (original.empty())
return original;
std::string result;
// If the original starts with a digit, prefix it with an underscore.
if (base::IsAsciiDigit(original[0]))
result.push_back('_');
// Given 'myEnum-Foo':
for (size_t i = 0; i < original.size(); ++i) {
// Add an underscore between camelcased items:
// 'myEnum-Foo' -> 'mY_Enum-Foo'
if (i > 0 && base::IsAsciiLower(original[i - 1]) &&
base::IsAsciiUpper(original[i])) {
result.push_back('_');
result.push_back(original[i]);
} else if (original[i] == '-') { // 'mY_Enum-Foo' -> 'mY_Enum_Foo'
result.push_back('_');
} else { // 'mY_Enum_Foo' -> 'MY_ENUM_FOO'
result.push_back(base::ToUpperASCII(original[i]));
}
}
return result;
}
struct SignaturePair {
std::unique_ptr<APISignature> method_signature;
std::unique_ptr<APISignature> callback_signature;
};
SignaturePair GetAPISignatureFromDictionary(const base::DictionaryValue* dict) {
const base::ListValue* params = nullptr;
CHECK(dict->GetList("parameters", &params));
SignaturePair result;
result.method_signature = std::make_unique<APISignature>(*params);
// If response validation is enabled, parse the callback signature. Otherwise,
// there's no reason to, so don't bother.
if (result.method_signature->has_callback() &&
binding::IsResponseValidationEnabled()) {
const base::Value* callback_params = params->GetList().back().FindKeyOfType(
"parameters", base::Value::Type::LIST);
if (callback_params) {
const base::ListValue* params_as_list = nullptr;
callback_params->GetAsList(&params_as_list);
result.callback_signature =
std::make_unique<APISignature>(*params_as_list);
}
}
return result;
}
void RunAPIBindingHandlerCallback(
const v8::FunctionCallbackInfo<v8::Value>& info) {
gin::Arguments args(info);
if (!binding::IsContextValidOrThrowError(args.isolate()->GetCurrentContext()))
return;
v8::Local<v8::External> external;
CHECK(args.GetData(&external));
auto* callback = static_cast<APIBinding::HandlerCallback*>(external->Value());
callback->Run(&args);
}
} // namespace
struct APIBinding::MethodData {
MethodData(std::string full_name,
const APISignature* signature,
binding::RequestThread thread)
: full_name(std::move(full_name)), signature(signature), thread(thread) {}
// The fully-qualified name of this api (e.g. runtime.sendMessage instead of
// sendMessage).
const std::string full_name;
// The expected API signature.
const APISignature* signature;
// Thread to invoke the method on.
const binding::RequestThread thread;
// The callback used by the v8 function.
APIBinding::HandlerCallback callback;
};
// TODO(devlin): Maybe separate EventData into two classes? Rules, actions, and
// conditions should never be present on vanilla events.
struct APIBinding::EventData {
EventData(std::string exposed_name,
std::string full_name,
bool supports_filters,
bool supports_rules,
bool supports_lazy_listeners,
int max_listeners,
bool notify_on_change,
std::vector<std::string> actions,
std::vector<std::string> conditions,
APIBinding* binding)
: exposed_name(std::move(exposed_name)),
full_name(std::move(full_name)),
supports_filters(supports_filters),
supports_rules(supports_rules),
supports_lazy_listeners(supports_lazy_listeners),
max_listeners(max_listeners),
notify_on_change(notify_on_change),
actions(std::move(actions)),
conditions(std::move(conditions)),
binding(binding) {}
// The name of the event on the API object (e.g. onCreated).
std::string exposed_name;
// The fully-specified name of the event (e.g. tabs.onCreated).
std::string full_name;
// Whether the event supports filters.
bool supports_filters;
// Whether the event supports rules.
bool supports_rules;
// Whether the event supports lazy listeners.
bool supports_lazy_listeners;
// The maximum number of listeners this event supports.
int max_listeners;
// Whether to notify the browser of listener changes.
bool notify_on_change;
// The associated actions and conditions for declarative events.
std::vector<std::string> actions;
std::vector<std::string> conditions;
// The associated APIBinding. This raw pointer is safe because the
// EventData is only accessed from the callbacks associated with the
// APIBinding, and both the APIBinding and APIEventHandler are owned by the
// same object (the APIBindingsSystem).
APIBinding* binding;
};
struct APIBinding::CustomPropertyData {
CustomPropertyData(const std::string& type_name,
const std::string& property_name,
const base::ListValue* property_values,
const CreateCustomType& create_custom_type)
: type_name(type_name),
property_name(property_name),
property_values(property_values),
create_custom_type(create_custom_type) {}
// The type of the property, e.g. 'storage.StorageArea'.
std::string type_name;
// The name of the property on the object, e.g. 'local' for
// chrome.storage.local.
std::string property_name;
// Values curried into this particular type from the schema.
const base::ListValue* property_values;
CreateCustomType create_custom_type;
};
APIBinding::APIBinding(const std::string& api_name,
const base::ListValue* function_definitions,
const base::ListValue* type_definitions,
const base::ListValue* event_definitions,
const base::DictionaryValue* property_definitions,
CreateCustomType create_custom_type,
OnSilentRequest on_silent_request,
std::unique_ptr<APIBindingHooks> binding_hooks,
APITypeReferenceMap* type_refs,
APIRequestHandler* request_handler,
APIEventHandler* event_handler,
BindingAccessChecker* access_checker)
: api_name_(api_name),
property_definitions_(property_definitions),
create_custom_type_(std::move(create_custom_type)),
on_silent_request_(std::move(on_silent_request)),
binding_hooks_(std::move(binding_hooks)),
type_refs_(type_refs),
request_handler_(request_handler),
event_handler_(event_handler),
access_checker_(access_checker),
weak_factory_(this) {
// TODO(devlin): It might make sense to instantiate the object_template_
// directly here, which would avoid the need to hold on to
// |property_definitions_| and |enums_|. However, there are *some* cases where
// we don't immediately stamp out an API from the template following
// construction.
if (function_definitions) {
for (const auto& func : *function_definitions) {
const base::DictionaryValue* func_dict = nullptr;
CHECK(func.GetAsDictionary(&func_dict));
std::string name;
CHECK(func_dict->GetString("name", &name));
SignaturePair signatures = GetAPISignatureFromDictionary(func_dict);
bool for_io_thread = false;
func_dict->GetBoolean("forIOThread", &for_io_thread);
std::string full_name =
base::StringPrintf("%s.%s", api_name_.c_str(), name.c_str());
methods_[name] = std::make_unique<MethodData>(
full_name, signatures.method_signature.get(),
for_io_thread ? binding::RequestThread::IO
: binding::RequestThread::UI);
type_refs->AddAPIMethodSignature(full_name,
std::move(signatures.method_signature));
if (signatures.callback_signature) {
type_refs->AddCallbackSignature(
full_name, std::move(signatures.callback_signature));
}
}
}
if (type_definitions) {
for (const auto& type : *type_definitions) {
const base::DictionaryValue* type_dict = nullptr;
CHECK(type.GetAsDictionary(&type_dict));
std::string id;
CHECK(type_dict->GetString("id", &id));
auto argument_spec = std::make_unique<ArgumentSpec>(*type_dict);
const std::set<std::string>& enum_values = argument_spec->enum_values();
if (!enum_values.empty()) {
// Type names may be prefixed by the api name. If so, remove the prefix.
base::Optional<std::string> stripped_id;
if (base::StartsWith(id, api_name_, base::CompareCase::SENSITIVE))
stripped_id = id.substr(api_name_.size() + 1); // +1 for trailing '.'
std::vector<EnumEntry>& entries =
enums_[stripped_id ? *stripped_id : id];
entries.reserve(enum_values.size());
for (const auto& enum_value : enum_values) {
entries.push_back(
std::make_pair(enum_value, GetJSEnumEntryName(enum_value)));
}
}
type_refs->AddSpec(id, std::move(argument_spec));
// Some types, like storage.StorageArea, have functions associated with
// them. Cache the function signatures in the type map.
const base::ListValue* type_functions = nullptr;
if (type_dict->GetList("functions", &type_functions)) {
for (const auto& func : *type_functions) {
const base::DictionaryValue* func_dict = nullptr;
CHECK(func.GetAsDictionary(&func_dict));
std::string function_name;
CHECK(func_dict->GetString("name", &function_name));
SignaturePair signatures = GetAPISignatureFromDictionary(func_dict);
std::string full_name =
base::StringPrintf("%s.%s", id.c_str(), function_name.c_str());
type_refs->AddTypeMethodSignature(
full_name, std::move(signatures.method_signature));
if (signatures.callback_signature) {
type_refs->AddCallbackSignature(
full_name, std::move(signatures.callback_signature));
}
}
}
}
}
if (event_definitions) {
events_.reserve(event_definitions->GetSize());
for (const auto& event : *event_definitions) {
const base::DictionaryValue* event_dict = nullptr;
CHECK(event.GetAsDictionary(&event_dict));
std::string name;
CHECK(event_dict->GetString("name", &name));
std::string full_name =
base::StringPrintf("%s.%s", api_name_.c_str(), name.c_str());
const base::ListValue* filters = nullptr;
bool supports_filters =
event_dict->GetList("filters", &filters) && !filters->empty();
std::vector<std::string> rule_actions;
std::vector<std::string> rule_conditions;
const base::DictionaryValue* options = nullptr;
bool supports_rules = false;
bool notify_on_change = true;
bool supports_lazy_listeners = true;
int max_listeners = binding::kNoListenerMax;
if (event_dict->GetDictionary("options", &options)) {
bool temp_supports_filters = false;
// TODO(devlin): For some reason, schemas indicate supporting filters
// either through having a 'filters' property *or* through having
// a 'supportsFilters' property. We should clean that up.
supports_filters |=
(options->GetBoolean("supportsFilters", &temp_supports_filters) &&
temp_supports_filters);
if (options->GetBoolean("supportsRules", &supports_rules) &&
supports_rules) {
bool supports_listeners = false;
DCHECK(options->GetBoolean("supportsListeners", &supports_listeners));
DCHECK(!supports_listeners)
<< "Events cannot support rules and listeners.";
auto get_values = [options](base::StringPiece name,
std::vector<std::string>* out_value) {
const base::ListValue* list = nullptr;
CHECK(options->GetList(name, &list));
for (const auto& entry : *list) {
DCHECK(entry.is_string());
out_value->push_back(entry.GetString());
}
};
get_values("actions", &rule_actions);
get_values("conditions", &rule_conditions);
}
options->GetInteger("maxListeners", &max_listeners);
bool unmanaged = false;
if (options->GetBoolean("unmanaged", &unmanaged))
notify_on_change = !unmanaged;
if (options->GetBoolean("supportsLazyListeners",
&supports_lazy_listeners)) {
DCHECK(!supports_lazy_listeners)
<< "Don't specify supportsLazyListeners: true; it's the default.";
}
}
events_.push_back(std::make_unique<EventData>(
std::move(name), std::move(full_name), supports_filters,
supports_rules, supports_lazy_listeners, max_listeners,
notify_on_change, std::move(rule_actions), std::move(rule_conditions),
this));
}
}
}
APIBinding::~APIBinding() {}
v8::Local<v8::Object> APIBinding::CreateInstance(
v8::Local<v8::Context> context) {
DCHECK(binding::IsContextValid(context));
v8::Isolate* isolate = context->GetIsolate();
if (object_template_.IsEmpty())
InitializeTemplate(isolate);
DCHECK(!object_template_.IsEmpty());
v8::Local<v8::Object> object =
object_template_.Get(isolate)->NewInstance(context).ToLocalChecked();
// The object created from the template includes all methods, but some may
// be unavailable in this context. Iterate over them and delete any that
// aren't available.
// TODO(devlin): Ideally, we'd only do this check on the methods that are
// conditionally exposed. Or, we could have multiple templates for different
// configurations, assuming there are a small number of possibilities.
for (const auto& key_value : methods_) {
if (!access_checker_->HasAccess(context, key_value.second->full_name)) {
v8::Maybe<bool> success = object->Delete(
context, gin::StringToSymbol(isolate, key_value.first));
CHECK(success.IsJust());
CHECK(success.FromJust());
}
}
for (const auto& event : events_) {
if (!access_checker_->HasAccess(context, event->full_name)) {
v8::Maybe<bool> success = object->Delete(
context, gin::StringToSymbol(isolate, event->exposed_name));
CHECK(success.IsJust());
CHECK(success.FromJust());
}
}
binding_hooks_->InitializeInstance(context, object);
return object;
}
void APIBinding::InitializeTemplate(v8::Isolate* isolate) {
DCHECK(object_template_.IsEmpty());
v8::Local<v8::ObjectTemplate> object_template =
v8::ObjectTemplate::New(isolate);
for (const auto& key_value : methods_) {
MethodData& method = *key_value.second;
DCHECK(method.callback.is_null());
method.callback =
base::BindRepeating(&APIBinding::HandleCall, weak_factory_.GetWeakPtr(),
method.full_name, method.signature, method.thread);
object_template->Set(
gin::StringToSymbol(isolate, key_value.first),
v8::FunctionTemplate::New(isolate, &RunAPIBindingHandlerCallback,
v8::External::New(isolate, &method.callback),
v8::Local<v8::Signature>(), 0,
v8::ConstructorBehavior::kThrow));
}
for (const auto& event : events_) {
object_template->SetLazyDataProperty(
gin::StringToSymbol(isolate, event->exposed_name),
&APIBinding::GetEventObject, v8::External::New(isolate, event.get()));
}
for (const auto& entry : enums_) {
v8::Local<v8::ObjectTemplate> enum_object =
v8::ObjectTemplate::New(isolate);
for (const auto& enum_entry : entry.second) {
enum_object->Set(gin::StringToSymbol(isolate, enum_entry.second),
gin::StringToSymbol(isolate, enum_entry.first));
}
object_template->Set(isolate, entry.first.c_str(), enum_object);
}
if (property_definitions_) {
DecorateTemplateWithProperties(isolate, object_template,
*property_definitions_);
}
// Allow custom bindings a chance to tweak the template, such as to add
// additional properties or types.
binding_hooks_->InitializeTemplate(isolate, object_template, *type_refs_);
object_template_.Set(isolate, object_template);
}
void APIBinding::DecorateTemplateWithProperties(
v8::Isolate* isolate,
v8::Local<v8::ObjectTemplate> object_template,
const base::DictionaryValue& properties) {
static const char kValueKey[] = "value";
for (base::DictionaryValue::Iterator iter(properties); !iter.IsAtEnd();
iter.Advance()) {
const base::DictionaryValue* dict = nullptr;
CHECK(iter.value().GetAsDictionary(&dict));
bool optional = false;
if (dict->GetBoolean("optional", &optional)) {
// TODO(devlin): What does optional even mean here? It's only used, it
// seems, for lastError and inIncognitoContext, which are both handled
// with custom bindings. Investigate, and remove.
continue;
}
const base::ListValue* platforms = nullptr;
// TODO(devlin): This isn't great. It's bad to have availability primarily
// defined in the features files, and then partially defined within the
// API specification itself. Additionally, they aren't equivalent
// definitions. But given the rarity of property restrictions, and the fact
// that they are all limited by platform, it makes more sense to isolate
// this check here. If this becomes more common, we should really find a
// way of moving these checks to the features files.
if (dict->GetList("platforms", &platforms)) {
std::string this_platform = binding::GetPlatformString();
auto is_this_platform = [&this_platform](const base::Value& platform) {
return platform.is_string() && platform.GetString() == this_platform;
};
if (std::none_of(platforms->begin(), platforms->end(), is_this_platform))
continue;
}
v8::Local<v8::String> v8_key = gin::StringToSymbol(isolate, iter.key());
std::string ref;
if (dict->GetString("$ref", &ref)) {
const base::ListValue* property_values = nullptr;
CHECK(dict->GetList("value", &property_values));
auto property_data = std::make_unique<CustomPropertyData>(
ref, iter.key(), property_values, create_custom_type_);
object_template->SetLazyDataProperty(
v8_key, &APIBinding::GetCustomPropertyObject,
v8::External::New(isolate, property_data.get()));
custom_properties_.push_back(std::move(property_data));
continue;
}
std::string type;
CHECK(dict->GetString("type", &type));
if (type != "object" && !dict->HasKey(kValueKey)) {
// TODO(devlin): What does a fundamental property not having a value mean?
// It doesn't seem useful, and looks like it's only used by runtime.id,
// which is set by custom bindings. Investigate, and remove.
continue;
}
if (type == "integer") {
int val = 0;
CHECK(dict->GetInteger(kValueKey, &val));
object_template->Set(v8_key, v8::Integer::New(isolate, val));
} else if (type == "boolean") {
bool val = false;
CHECK(dict->GetBoolean(kValueKey, &val));
object_template->Set(v8_key, v8::Boolean::New(isolate, val));
} else if (type == "string") {
std::string val;
CHECK(dict->GetString(kValueKey, &val)) << iter.key();
object_template->Set(v8_key, gin::StringToSymbol(isolate, val));
} else if (type == "object" || !ref.empty()) {
v8::Local<v8::ObjectTemplate> property_template =
v8::ObjectTemplate::New(isolate);
const base::DictionaryValue* property_dict = nullptr;
CHECK(dict->GetDictionary("properties", &property_dict));
DecorateTemplateWithProperties(isolate, property_template,
*property_dict);
object_template->Set(v8_key, property_template);
}
}
}
// static
void APIBinding::GetEventObject(
v8::Local<v8::Name> property,
const v8::PropertyCallbackInfo<v8::Value>& info) {
v8::Isolate* isolate = info.GetIsolate();
v8::HandleScope handle_scope(isolate);
v8::Local<v8::Context> context = info.Holder()->CreationContext();
if (!binding::IsContextValidOrThrowError(context))
return;
CHECK(info.Data()->IsExternal());
auto* event_data =
static_cast<EventData*>(info.Data().As<v8::External>()->Value());
v8::Local<v8::Value> retval;
if (event_data->binding->binding_hooks_->CreateCustomEvent(
context, event_data->full_name, &retval)) {
// A custom event was created; our work is done.
} else if (event_data->supports_rules) {
gin::Handle<DeclarativeEvent> event = gin::CreateHandle(
isolate, new DeclarativeEvent(
event_data->full_name, event_data->binding->type_refs_,
event_data->binding->request_handler_, event_data->actions,
event_data->conditions, 0));
retval = event.ToV8();
} else {
retval = event_data->binding->event_handler_->CreateEventInstance(
event_data->full_name, event_data->supports_filters,
event_data->supports_lazy_listeners, event_data->max_listeners,
event_data->notify_on_change, context);
}
info.GetReturnValue().Set(retval);
}
void APIBinding::GetCustomPropertyObject(
v8::Local<v8::Name> property_name,
const v8::PropertyCallbackInfo<v8::Value>& info) {
v8::Isolate* isolate = info.GetIsolate();
v8::HandleScope handle_scope(isolate);
v8::Local<v8::Context> context = info.Holder()->CreationContext();
if (!binding::IsContextValid(context))
return;
v8::Context::Scope context_scope(context);
CHECK(info.Data()->IsExternal());
auto* property_data =
static_cast<CustomPropertyData*>(info.Data().As<v8::External>()->Value());
v8::Local<v8::Object> property = property_data->create_custom_type.Run(
isolate, property_data->type_name, property_data->property_name,
property_data->property_values);
if (property.IsEmpty())
return;
info.GetReturnValue().Set(property);
}
void APIBinding::HandleCall(const std::string& name,
const APISignature* signature,
const binding::RequestThread thread,
gin::Arguments* arguments) {
std::string error;
v8::Isolate* isolate = arguments->isolate();
v8::HandleScope handle_scope(isolate);
// Since this is called synchronously from the JS entry point,
// GetCurrentContext() should always be correct.
v8::Local<v8::Context> context = isolate->GetCurrentContext();
if (!access_checker_->HasAccessOrThrowError(context, name)) {
// TODO(devlin): Do we need handle this for events as well? I'm not sure the
// currrent system does (though perhaps it should). Investigate.
return;
}
std::vector<v8::Local<v8::Value>> argument_list = arguments->GetAll();
bool invalid_invocation = false;
v8::Local<v8::Function> custom_callback;
bool updated_args = false;
int old_request_id = request_handler_->last_sent_request_id();
{
v8::TryCatch try_catch(isolate);
APIBindingHooks::RequestResult hooks_result = binding_hooks_->RunHooks(
name, context, signature, &argument_list, *type_refs_);
switch (hooks_result.code) {
case APIBindingHooks::RequestResult::INVALID_INVOCATION:
invalid_invocation = true;
error = std::move(hooks_result.error);
// Throw a type error below so that it's not caught by our try-catch.
break;
case APIBindingHooks::RequestResult::THROWN:
DCHECK(try_catch.HasCaught());
try_catch.ReThrow();
return;
case APIBindingHooks::RequestResult::HANDLED:
if (!hooks_result.return_value.IsEmpty())
arguments->Return(hooks_result.return_value);
// TODO(devlin): This is a pretty simplistic implementation of this,
// but it's similar to the current JS logic. If we wanted to be more
// correct, we could create a RequestScope object that watches outgoing
// requests.
if (old_request_id == request_handler_->last_sent_request_id())
on_silent_request_.Run(context, name, argument_list);
return; // Our work here is done.
case APIBindingHooks::RequestResult::ARGUMENTS_UPDATED:
updated_args = true;
FALLTHROUGH;
case APIBindingHooks::RequestResult::NOT_HANDLED:
break; // Handle in the default manner.
}
custom_callback = hooks_result.custom_callback;
}
if (invalid_invocation) {
arguments->ThrowTypeError(api_errors::InvocationError(
name, signature->GetExpectedSignature(), error));
return;
}
std::unique_ptr<base::ListValue> converted_arguments;
v8::Local<v8::Function> callback;
{
v8::TryCatch try_catch(isolate);
// If custom hooks updated the arguments post-validation, we just trust the
// values the hooks provide and convert them directly. This is because some
// APIs have one set of values they use for validation, and a second they
// use in the implementation of the function (see, e.g.
// fileSystem.getDisplayPath).
// TODO(devlin): That's unfortunate. Not only does it require special casing
// here, but it also means we can't auto-generate the params for the
// function on the browser side.
if (updated_args) {
bool success = signature->ConvertArgumentsIgnoringSchema(
context, argument_list, &converted_arguments, &callback);
if (!success) {
// Converted arguments passed to us by our bindings should never fail.
NOTREACHED();
return;
}
} else {
invalid_invocation = !signature->ParseArgumentsToJSON(
context, argument_list, *type_refs_, &converted_arguments, &callback,
&error);
}
if (try_catch.HasCaught()) {
DCHECK(!converted_arguments);
try_catch.ReThrow();
return;
}
}
if (invalid_invocation) {
arguments->ThrowTypeError(api_errors::InvocationError(
name, signature->GetExpectedSignature(), error));
return;
}
request_handler_->StartRequest(context, name, std::move(converted_arguments),
callback, custom_callback, thread);
}
} // namespace extensions