// Copyright 2013 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/common/user_script.h"
#include "base/command_line.h"
#include "base/pickle.h"
#include "base/strings/string_util.h"
#include "extensions/common/switches.h"
namespace {
bool UrlMatchesGlobs(const std::vector<std::string>* globs,
const GURL& url) {
for (std::vector<std::string>::const_iterator glob = globs->begin();
glob != globs->end(); ++glob) {
if (MatchPattern(url.spec(), *glob))
return true;
}
return false;
}
} // namespace
namespace extensions {
// The bitmask for valid user script injectable schemes used by URLPattern.
enum {
kValidUserScriptSchemes = URLPattern::SCHEME_CHROMEUI |
URLPattern::SCHEME_HTTP |
URLPattern::SCHEME_HTTPS |
URLPattern::SCHEME_FILE |
URLPattern::SCHEME_FTP
};
// static
const char UserScript::kFileExtension[] = ".user.js";
bool UserScript::IsURLUserScript(const GURL& url,
const std::string& mime_type) {
return EndsWith(url.ExtractFileName(), kFileExtension, false) &&
mime_type != "text/html";
}
// static
int UserScript::ValidUserScriptSchemes(bool canExecuteScriptEverywhere) {
if (canExecuteScriptEverywhere)
return URLPattern::SCHEME_ALL;
int valid_schemes = kValidUserScriptSchemes;
if (!CommandLine::ForCurrentProcess()->HasSwitch(
switches::kExtensionsOnChromeURLs)) {
valid_schemes &= ~URLPattern::SCHEME_CHROMEUI;
}
return valid_schemes;
}
UserScript::File::File(const base::FilePath& extension_root,
const base::FilePath& relative_path,
const GURL& url)
: extension_root_(extension_root),
relative_path_(relative_path),
url_(url) {
}
UserScript::File::File() {}
UserScript::File::~File() {}
UserScript::UserScript()
: run_location_(DOCUMENT_IDLE),
user_script_id_(-1),
emulate_greasemonkey_(false),
match_all_frames_(false),
match_about_blank_(false),
incognito_enabled_(false) {}
UserScript::~UserScript() {
}
void UserScript::add_url_pattern(const URLPattern& pattern) {
url_set_.AddPattern(pattern);
}
void UserScript::add_exclude_url_pattern(const URLPattern& pattern) {
exclude_url_set_.AddPattern(pattern);
}
bool UserScript::MatchesURL(const GURL& url) const {
if (!url_set_.is_empty()) {
if (!url_set_.MatchesURL(url))
return false;
}
if (!exclude_url_set_.is_empty()) {
if (exclude_url_set_.MatchesURL(url))
return false;
}
if (!globs_.empty()) {
if (!UrlMatchesGlobs(&globs_, url))
return false;
}
if (!exclude_globs_.empty()) {
if (UrlMatchesGlobs(&exclude_globs_, url))
return false;
}
return true;
}
void UserScript::File::Pickle(::Pickle* pickle) const {
pickle->WriteString(url_.spec());
// Do not write path. It's not needed in the renderer.
// Do not write content. It will be serialized by other means.
}
void UserScript::File::Unpickle(const ::Pickle& pickle, PickleIterator* iter) {
// Read the url from the pickle.
std::string url;
CHECK(pickle.ReadString(iter, &url));
set_url(GURL(url));
}
void UserScript::Pickle(::Pickle* pickle) const {
// Write the simple types to the pickle.
pickle->WriteInt(run_location());
pickle->WriteString(extension_id());
pickle->WriteInt64(user_script_id_);
pickle->WriteBool(emulate_greasemonkey());
pickle->WriteBool(match_all_frames());
pickle->WriteBool(match_about_blank());
pickle->WriteBool(is_incognito_enabled());
PickleGlobs(pickle, globs_);
PickleGlobs(pickle, exclude_globs_);
PickleURLPatternSet(pickle, url_set_);
PickleURLPatternSet(pickle, exclude_url_set_);
PickleScripts(pickle, js_scripts_);
PickleScripts(pickle, css_scripts_);
}
void UserScript::PickleGlobs(::Pickle* pickle,
const std::vector<std::string>& globs) const {
pickle->WriteUInt64(globs.size());
for (std::vector<std::string>::const_iterator glob = globs.begin();
glob != globs.end(); ++glob) {
pickle->WriteString(*glob);
}
}
void UserScript::PickleURLPatternSet(::Pickle* pickle,
const URLPatternSet& pattern_list) const {
pickle->WriteUInt64(pattern_list.patterns().size());
for (URLPatternSet::const_iterator pattern = pattern_list.begin();
pattern != pattern_list.end(); ++pattern) {
pickle->WriteInt(pattern->valid_schemes());
pickle->WriteString(pattern->GetAsString());
}
}
void UserScript::PickleScripts(::Pickle* pickle,
const FileList& scripts) const {
pickle->WriteUInt64(scripts.size());
for (FileList::const_iterator file = scripts.begin();
file != scripts.end(); ++file) {
file->Pickle(pickle);
}
}
void UserScript::Unpickle(const ::Pickle& pickle, PickleIterator* iter) {
// Read the run location.
int run_location = 0;
CHECK(pickle.ReadInt(iter, &run_location));
CHECK(run_location >= 0 && run_location < RUN_LOCATION_LAST);
run_location_ = static_cast<RunLocation>(run_location);
CHECK(pickle.ReadString(iter, &extension_id_));
CHECK(pickle.ReadInt64(iter, &user_script_id_));
CHECK(pickle.ReadBool(iter, &emulate_greasemonkey_));
CHECK(pickle.ReadBool(iter, &match_all_frames_));
CHECK(pickle.ReadBool(iter, &match_about_blank_));
CHECK(pickle.ReadBool(iter, &incognito_enabled_));
UnpickleGlobs(pickle, iter, &globs_);
UnpickleGlobs(pickle, iter, &exclude_globs_);
UnpickleURLPatternSet(pickle, iter, &url_set_);
UnpickleURLPatternSet(pickle, iter, &exclude_url_set_);
UnpickleScripts(pickle, iter, &js_scripts_);
UnpickleScripts(pickle, iter, &css_scripts_);
}
void UserScript::UnpickleGlobs(const ::Pickle& pickle, PickleIterator* iter,
std::vector<std::string>* globs) {
uint64 num_globs = 0;
CHECK(pickle.ReadUInt64(iter, &num_globs));
globs->clear();
for (uint64 i = 0; i < num_globs; ++i) {
std::string glob;
CHECK(pickle.ReadString(iter, &glob));
globs->push_back(glob);
}
}
void UserScript::UnpickleURLPatternSet(const ::Pickle& pickle,
PickleIterator* iter,
URLPatternSet* pattern_list) {
uint64 num_patterns = 0;
CHECK(pickle.ReadUInt64(iter, &num_patterns));
pattern_list->ClearPatterns();
for (uint64 i = 0; i < num_patterns; ++i) {
int valid_schemes;
CHECK(pickle.ReadInt(iter, &valid_schemes));
std::string pattern_str;
CHECK(pickle.ReadString(iter, &pattern_str));
URLPattern pattern(kValidUserScriptSchemes);
URLPattern::ParseResult result = pattern.Parse(pattern_str);
CHECK(URLPattern::PARSE_SUCCESS == result) <<
URLPattern::GetParseResultString(result) << " " << pattern_str.c_str();
pattern.SetValidSchemes(valid_schemes);
pattern_list->AddPattern(pattern);
}
}
void UserScript::UnpickleScripts(const ::Pickle& pickle, PickleIterator* iter,
FileList* scripts) {
uint64 num_files = 0;
CHECK(pickle.ReadUInt64(iter, &num_files));
scripts->clear();
for (uint64 i = 0; i < num_files; ++i) {
File file;
file.Unpickle(pickle, iter);
scripts->push_back(file);
}
}
} // namespace extensions