blob: 922dba7f111ffdc12352c2e06703c3fa828e3197 (
plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
// Copyright (c) 2012 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 CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_WEBREQUEST_WEBREQUEST_CONDITION_H_
#define CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_WEBREQUEST_WEBREQUEST_CONDITION_H_
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/memory/linked_ptr.h"
#include "chrome/browser/extensions/api/declarative_webrequest/webrequest_condition_attribute.h"
#include "chrome/browser/extensions/api/declarative_webrequest/webrequest_rule.h"
#include "chrome/common/extensions/matcher/url_matcher.h"
namespace extensions {
// Representation of a condition in the Declarative WebRequest API. A condition
// consists of several attributes. Each of these attributes needs to be
// fulfilled in order for the condition to be fulfilled.
//
// We distinguish between two types of conditions:
// - URL Matcher conditions are conditions that test the URL of a request.
// These are treated separately because we use a URLMatcher to efficiently
// test many of these conditions in parallel by using some advanced
// data structures. The URLMatcher tells us if all URL Matcher conditions
// are fulfilled for a WebRequestCondition.
// - All other conditions are represented as WebRequestConditionAttributes.
// These conditions are probed linearly (only if the URL Matcher found a hit).
//
// TODO(battre) Consider making the URLMatcher an owner of the
// URLMatcherConditionSet and only pass a pointer to URLMatcherConditionSet
// in url_matcher_condition_set(). This saves some copying in
// WebRequestConditionSet::GetURLMatcherConditionSets.
class WebRequestCondition {
public:
WebRequestCondition(
scoped_refptr<URLMatcherConditionSet> url_matcher_conditions,
const WebRequestConditionAttributes& condition_attributes);
~WebRequestCondition();
// Factory method that instantiates a WebRequestCondition according to
// the description |condition| passed by the extension API.
static scoped_ptr<WebRequestCondition> Create(
URLMatcherConditionFactory* url_matcher_condition_factory,
const base::Value& condition,
std::string* error);
// Returns whether the request is a match, given that the URLMatcher found
// a match for |url_matcher_conditions_|.
bool IsFulfilled(const WebRequestRule::RequestData& request_data) const;
// Returns a URLMatcherConditionSet::ID which is the canonical representation
// for all URL patterns that need to be matched by this WebRequestCondition.
// This ID is registered in a URLMatcher that can inform us in case of a
// match.
URLMatcherConditionSet::ID url_matcher_condition_set_id() const {
return url_matcher_conditions_->id();
}
// Returns the set of conditions that are checked on the URL. This is the
// primary trigger for WebRequestCondition and therefore never empty.
// (If it was empty, the URLMatcher would never notify us about network
// requests which might fulfill the entire WebRequestCondition).
scoped_refptr<URLMatcherConditionSet> url_matcher_condition_set() const {
return url_matcher_conditions_;
}
// Returns the condition attributes checked by this condition.
const WebRequestConditionAttributes condition_attributes() const {
return condition_attributes_;
}
// Returns a bit vector representing extensions::RequestStage. The bit vector
// contains a 1 for each request stage during which the condition can be
// tested.
int stages() const { return applicable_request_stages_; }
private:
scoped_refptr<URLMatcherConditionSet> url_matcher_conditions_;
WebRequestConditionAttributes condition_attributes_;
// Bit vector indicating all RequestStage during which all
// |condition_attributes_| can be evaluated.
int applicable_request_stages_;
DISALLOW_COPY_AND_ASSIGN(WebRequestCondition);
};
// This class stores a set of conditions that may be part of a WebRequestRule.
// If any condition is fulfilled, the WebRequestActions of the WebRequestRule
// can be triggered.
class WebRequestConditionSet {
public:
typedef std::vector<linked_ptr<json_schema_compiler::any::Any> > AnyVector;
typedef std::vector<linked_ptr<WebRequestCondition> > Conditions;
explicit WebRequestConditionSet(const Conditions& conditions);
~WebRequestConditionSet();
// Factory method that creates an WebRequestConditionSet according to the JSON
// array |conditions| passed by the extension API.
// Sets |error| and returns NULL in case of an error.
static scoped_ptr<WebRequestConditionSet> Create(
URLMatcherConditionFactory* url_matcher_condition_factory,
const AnyVector& conditions,
std::string* error);
const Conditions& conditions() const {
return conditions_;
}
// Returns whether any condition in the condition set is fulfilled
// based on a match |url_match| and the value of |request_data.request|.
// This function should be called for each URLMatcherConditionSet::ID
// that was found by the URLMatcher to ensure that the each trigger in
// |match_triggers_| is found.
bool IsFulfilled(
URLMatcherConditionSet::ID url_match,
const WebRequestRule::RequestData& request_data) const;
// Appends the URLMatcherConditionSet from all conditions to |condition_sets|.
void GetURLMatcherConditionSets(
URLMatcherConditionSet::Vector* condition_sets) const;
private:
Conditions conditions_;
typedef std::map<URLMatcherConditionSet::ID, WebRequestCondition*>
MatchTriggers;
MatchTriggers match_triggers_;
DISALLOW_COPY_AND_ASSIGN(WebRequestConditionSet);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_WEBREQUEST_WEBREQUEST_CONDITION_H_
|
