1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_COMMON_UTILS_CONTENT_SCRIPT_UTILS_H_
#define EXTENSIONS_COMMON_UTILS_CONTENT_SCRIPT_UTILS_H_
#include <string>
#include "base/auto_reset.h"
#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "extensions/common/api/content_scripts.h"
#include "extensions/common/api/scripts_internal.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_resource.h"
#include "extensions/common/mojom/match_origin_as_fallback.mojom-forward.h"
#include "extensions/common/user_script.h"
// Contains helper methods for parsing content script fields.
namespace extensions::script_parsing {
enum class ContentScriptType {
kJs,
kCss,
};
// Returns the maximum length allowed in an individual script file. Scripts
// above this length will not be loaded.
size_t GetMaxScriptLength();
// Returns the maximum allowed total length for all scripts loaded for a single
// extension. Any scripts past this limit will not be loaded.
size_t GetMaxScriptsLengthPerExtension();
using ScopedMaxScriptLengthOverride = base::AutoReset<size_t>;
// Temporarily sets the max per-file limit to `max`. The value gets reset once
// the AutoReset falls out of scope and is destroyed.
ScopedMaxScriptLengthOverride CreateScopedMaxScriptLengthForTesting(size_t max);
// Temporarily sets the per-extension limit to `max`. The value gets reset once
// the AutoReset falls out of scope and is destroyed.
ScopedMaxScriptLengthOverride
CreateScopedMaxScriptsLengthPerExtensionForTesting(size_t max);
// Parses and validates `matches` and `exclude_matches`, and updates these
// fields for `result`. If `wants_file_access` is not null, then it will be set
// to signal to the caller that the extension is requesting file access based
// the match patterns specified. `definition_index` must be only provided for
// static scripts.
bool ParseMatchPatterns(const std::vector<std::string>& matches,
const std::vector<std::string>* exclude_matches,
int creation_flags,
bool can_execute_script_everywhere,
bool all_urls_includes_chrome_urls,
std::optional<int> definition_index,
UserScript* result,
std::u16string* error,
bool* wants_file_access);
// Parses the `js` and `css` fields, and updates `result` with the specified
// file paths. Returns false and populates `error` if both `js` and `css` are
// empty. `definition_index` must be only provided for static scripts.
bool ParseFileSources(
const Extension* extension,
const std::vector<api::scripts_internal::ScriptSource>* js,
const std::vector<api::scripts_internal::ScriptSource>* css,
std::optional<int> definition_index,
UserScript* result,
std::u16string* error);
// Parses `include_globs` and `exclude_globs` and updates these fields for
// `result`. Done for Greasemonkey compatibility.
void ParseGlobs(const std::vector<std::string>* include_globs,
const std::vector<std::string>* exclude_globs,
UserScript* result);
// Validates that the mime type, deduced from the file extension, is allowed to
// be used for a content script of a given type.
bool ValidateMimeTypeFromFileExtension(const base::FilePath& relative_path,
ContentScriptType content_script_type,
std::string* error);
// Validates that the claimed file sources in `scripts` actually exist and are
// UTF-8 encoded. This function must be called on a sequence which allows file
// I/O.
bool ValidateFileSources(const UserScriptList& scripts,
ExtensionResource::SymlinkPolicy symlink_policy,
std::string* error,
std::vector<InstallWarning>* warnings);
// Validates that the user script mime types, deduced from the file extensions,
// are allowed to be used.
bool ValidateUserScriptMimeTypesFromFileExtensions(const UserScript& script,
std::string* error);
// Validates that `match_origin_as_fallback` is legal in relation to the match
// patterns specified in `url_patterns`. I.e. patterns in `url_patterns` must
// specify a wildcard path or no path if `match_origin_as_fallback` is enabled.
bool ValidateMatchOriginAsFallback(
mojom::MatchOriginAsFallbackBehavior match_origin_as_fallback,
const URLPatternSet& url_patterns,
std::u16string* error_out);
ExtensionResource::SymlinkPolicy GetSymlinkPolicy(const Extension* extension);
} // namespace extensions::script_parsing
#endif // EXTENSIONS_COMMON_UTILS_CONTENT_SCRIPT_UTILS_H_
|
