blob: 86ac1258bdad81ba4215b9d86b27f9efdaf3aac8 [file] [log] [blame]
xunjieli413a68782015-06-16 17:15:431// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Chris Mumford3f0eda92018-07-23 14:51:175#ifndef EXTENSIONS_RENDERER_EXTENSION_THROTTLE_MANAGER_H_
6#define EXTENSIONS_RENDERER_EXTENSION_THROTTLE_MANAGER_H_
xunjieli413a68782015-06-16 17:15:437
8#include <map>
dchengf5d241082016-04-21 03:43:119#include <memory>
xunjieli413a68782015-06-16 17:15:4310#include <string>
11
avic9cec102015-12-23 00:39:2612#include "base/macros.h"
xunjieli413a68782015-06-16 17:15:4313#include "base/memory/ref_counted.h"
Chris Mumford3f0eda92018-07-23 14:51:1714#include "base/synchronization/lock.h"
15#include "extensions/renderer/extension_throttle_entry.h"
xunjieli413a68782015-06-16 17:15:4316#include "url/gurl.h"
17
Chris Mumford3f0eda92018-07-23 14:51:1718namespace blink {
19class WebURLRequest;
20} // namespace blink
21
xunjieli413a68782015-06-16 17:15:4322namespace content {
Chris Mumford3f0eda92018-07-23 14:51:1723class URLLoaderThrottle;
24} // namespace content
25
26namespace net {
27struct RedirectInfo;
28} // namespace net
29
30namespace network {
31struct ResourceResponseHead;
32} // namespace network
xunjieli413a68782015-06-16 17:15:4333
xunjieli413a68782015-06-16 17:15:4334namespace extensions {
35
Chris Mumford3f0eda92018-07-23 14:51:1736// This is a thread safe class that registers URL request throttler entries for
37// URLs being accessed in order to supervise traffic. URL requests for HTTP
38// contents should register their URLs in this manager on each request.
xunjieli413a68782015-06-16 17:15:4339//
40// ExtensionThrottleManager maintains a map of URL IDs to URL request
41// throttler entries. It creates URL request throttler entries when new URLs
42// are registered, and does garbage collection from time to time in order to
43// clean out outdated entries. URL ID consists of lowercased scheme, host, port
44// and path. All URLs converted to the same ID will share the same entry.
Chris Mumford3f0eda92018-07-23 14:51:1745class ExtensionThrottleManager {
xunjieli413a68782015-06-16 17:15:4346 public:
47 ExtensionThrottleManager();
Chris Mumford3f0eda92018-07-23 14:51:1748 virtual ~ExtensionThrottleManager();
xunjieli413a68782015-06-16 17:15:4349
Chris Mumford3f0eda92018-07-23 14:51:1750 // Creates a throttle which uses this class to prevent extensions from
51 // requesting a URL too often, if such a throttle is needed.
52 std::unique_ptr<content::URLLoaderThrottle> MaybeCreateURLLoaderThrottle(
53 const blink::WebURLRequest& request);
54
55 // Determine if a request to |request_url| with the given |request_load_flags|
56 // (see net/base/load_flags.h) should be rejected.
57 bool ShouldRejectRequest(const GURL& request_url, int request_load_flags);
58
59 // Determine if a redirect from the original |request_url| with the original
60 // |request_load_flags| (see net/base/load_flags.h) should be allowed to be
61 // redirected as specified by |redirect_info|.
62 bool ShouldRejectRedirect(const GURL& request_url,
63 int request_load_flags,
64 const net::RedirectInfo& redirect_info);
65
66 // Must be called when the |response_head| for a request has been received.
67 void WillProcessResponse(const GURL& response_url,
68 const network::ResourceResponseHead& response_head);
69
70 // Set the network status online state as specified in |is_online|.
71 void SetOnline(bool is_online);
72
73 void SetBackoffPolicyForTests(
74 std::unique_ptr<net::BackoffEntry::Policy> policy);
75
76 // Registers a new entry in this service and overrides the existing entry (if
77 // any) for the URL. The service will hold a reference to the entry.
78 // It is only used by unit tests.
Chris Mumfordc54b0c342018-07-23 21:29:4679 void OverrideEntryForTests(const GURL& url,
80 std::unique_ptr<ExtensionThrottleEntry> entry);
Chris Mumford3f0eda92018-07-23 14:51:1781
82 // Sets whether to ignore net::LOAD_MAYBE_USER_GESTURE of the request for
83 // testing. Otherwise, requests will not be throttled when they may have been
84 // throttled in response to a recent user gesture, though they're still
85 // counted for the purpose of throttling other requests.
86 void SetIgnoreUserGestureLoadFlagForTests(
87 bool ignore_user_gesture_load_flag_for_tests);
88
89 int GetNumberOfEntriesForTests() const { return url_entries_.size(); }
90
91 protected:
92 // Method that allows us to transform a URL into an ID that can be used in our
93 // map. Resulting IDs will be lowercase and consist of the scheme, host, port
94 // and path (without query string, fragment, etc.).
95 // If the URL is invalid, the invalid spec will be returned, without any
96 // transformation.
97 std::string GetIdFromUrl(const GURL& url) const;
xunjieli413a68782015-06-16 17:15:4398
xunjieli413a68782015-06-16 17:15:4399 // Must be called for every request, returns the URL request throttler entry
100 // associated with the URL. The caller must inform this entry of some events.
Chris Mumfordc54b0c342018-07-23 21:29:46101 // Please refer to extension_throttle_entry.h for further information.
102 ExtensionThrottleEntry* RegisterRequestUrl(const GURL& url);
xunjieli413a68782015-06-16 17:15:43103
Chris Mumford3f0eda92018-07-23 14:51:17104 // Method that does the actual work of garbage collecting.
105 void GarbageCollectEntries();
xunjielie484e2d62015-06-19 14:31:21106
Chris Mumford3f0eda92018-07-23 14:51:17107 private:
xunjieli413a68782015-06-16 17:15:43108 // Explicitly erases an entry.
109 // This is useful to remove those entries which have got infinite lifetime and
110 // thus won't be garbage collected.
111 // It is only used by unit tests.
112 void EraseEntryForTests(const GURL& url);
113
xunjieli413a68782015-06-16 17:15:43114 // Whether throttling is enabled or not.
115 void set_enforce_throttling(bool enforce);
116 bool enforce_throttling();
117
xunjieli413a68782015-06-16 17:15:43118 // Method that ensures the map gets cleaned from time to time. The period at
119 // which garbage collecting happens is adjustable with the
120 // kRequestBetweenCollecting constant.
121 void GarbageCollectEntriesIfNecessary();
122
xunjieli413a68782015-06-16 17:15:43123 // Maximum number of entries that we are willing to collect in our map.
124 static const unsigned int kMaximumNumberOfEntries;
125 // Number of requests that will be made between garbage collection.
126 static const unsigned int kRequestsBetweenCollecting;
127
Chris Mumfordc54b0c342018-07-23 21:29:46128 // Map that contains a list of URL ID (composed of the scheme, host, port and
129 // path) and their matching ExtensionThrottleEntry.
130 std::map<std::string, std::unique_ptr<ExtensionThrottleEntry>> url_entries_;
xunjieli413a68782015-06-16 17:15:43131
132 // This keeps track of how many requests have been made. Used with
133 // GarbageCollectEntries.
134 unsigned int requests_since_last_gc_;
135
136 // Valid after construction.
137 GURL::Replacements url_id_replacements_;
138
xunjieli413a68782015-06-16 17:15:43139 bool ignore_user_gesture_load_flag_for_tests_;
140
Chris Mumfordc54b0c342018-07-23 21:29:46141 // This is null when it is not set for tests.
dchengf5d241082016-04-21 03:43:11142 std::unique_ptr<net::BackoffEntry::Policy> backoff_policy_for_tests_;
xunjielie484e2d62015-06-19 14:31:21143
Chris Mumford3f0eda92018-07-23 14:51:17144 // Used to synchronize all public methods.
145 base::Lock lock_;
gab370841f22017-06-01 14:38:26146
xunjieli413a68782015-06-16 17:15:43147 DISALLOW_COPY_AND_ASSIGN(ExtensionThrottleManager);
148};
149
150} // namespace extensions
151
Chris Mumford3f0eda92018-07-23 14:51:17152#endif // EXTENSIONS_RENDERER_EXTENSION_THROTTLE_MANAGER_H_