Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: include/AdblockPlus/FilterEngine.h

Issue 29335462: Issue 3337 - Update adblockplus reference in libadblockplus to revision hg:813682c7161e (Closed)
Patch Set: add typedef for ContentTypeMask Created Feb. 9, 2016, 5:14 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « ensure_dependencies.py ('k') | lib/api.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* 1 /*
2 * This file is part of Adblock Plus <https://adblockplus.org/>, 2 * This file is part of Adblock Plus <https://adblockplus.org/>,
3 * Copyright (C) 2006-2016 Eyeo GmbH 3 * Copyright (C) 2006-2016 Eyeo GmbH
4 * 4 *
5 * Adblock Plus is free software: you can redistribute it and/or modify 5 * Adblock Plus is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 3 as 6 * it under the terms of the GNU General Public License version 3 as
7 * published by the Free Software Foundation. 7 * published by the Free Software Foundation.
8 * 8 *
9 * Adblock Plus is distributed in the hope that it will be useful, 9 * Adblock Plus is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
(...skipping 132 matching lines...) Expand 10 before | Expand all | Expand 10 after
143 * Main component of libadblockplus. 143 * Main component of libadblockplus.
144 * It handles: 144 * It handles:
145 * - Filter management and matching. 145 * - Filter management and matching.
146 * - Subscription management and synchronization. 146 * - Subscription management and synchronization.
147 * - Update checks for the application. 147 * - Update checks for the application.
148 */ 148 */
149 class FilterEngine 149 class FilterEngine
150 { 150 {
151 public: 151 public:
152 // Make sure to keep ContentType in sync with FilterEngine::contentTypes 152 // Make sure to keep ContentType in sync with FilterEngine::contentTypes
153 // and with RegExpFilter.typeMap from filterClasses.js.
153 /** 154 /**
154 * Possible resource content types. 155 * Possible resource content types.
155 */ 156 */
156 enum ContentType {CONTENT_TYPE_OTHER, CONTENT_TYPE_SCRIPT, 157 enum ContentType
157 CONTENT_TYPE_IMAGE, CONTENT_TYPE_STYLESHEET, 158 {
158 CONTENT_TYPE_OBJECT, CONTENT_TYPE_SUBDOCUMENT, 159 CONTENT_TYPE_OTHER = 1,
159 CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_XMLHTTPREQUEST, 160 CONTENT_TYPE_SCRIPT = 2,
160 CONTENT_TYPE_OBJECT_SUBREQUEST, CONTENT_TYPE_FONT, 161 CONTENT_TYPE_IMAGE = 4,
161 CONTENT_TYPE_MEDIA, CONTENT_TYPE_ELEMHIDE}; 162 CONTENT_TYPE_STYLESHEET = 8,
163 CONTENT_TYPE_OBJECT = 16,
164 CONTENT_TYPE_SUBDOCUMENT = 32,
165 CONTENT_TYPE_DOCUMENT = 64,
166 CONTENT_TYPE_PING = 1024,
167 CONTENT_TYPE_XMLHTTPREQUEST = 2048,
168 CONTENT_TYPE_OBJECT_SUBREQUEST = 4096,
169 CONTENT_TYPE_MEDIA = 16384,
170 CONTENT_TYPE_FONT = 32768,
171 CONTENT_TYPE_GENERICBLOCK = 0x20000000,
172 CONTENT_TYPE_ELEMHIDE = 0x40000000,
173 CONTENT_TYPE_GENERICHIDE = 0x80000000
174 };
175
176 /**
177 * Bitmask of `ContentType` values.
178 * The underlying type is signed 32 bit integer because it is actually used
179 * in JavaScript where it is converted into 32 bit signed integer.
180 */
181 typedef int32_t ContentTypeMask;
162 182
163 /** 183 /**
164 * Callback type invoked when an update becomes available. 184 * Callback type invoked when an update becomes available.
165 * The parameter is the download URL of the update. 185 * The parameter is the download URL of the update.
166 */ 186 */
167 typedef std::function<void(const std::string&)> UpdateAvailableCallback; 187 typedef std::function<void(const std::string&)> UpdateAvailableCallback;
168 188
169 /** 189 /**
170 * Callback type invoked when a manually triggered update check finishes. 190 * Callback type invoked when a manually triggered update check finishes.
171 * The parameter is an optional error message. 191 * The parameter is an optional error message.
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after
262 void SetShowNotificationCallback(const ShowNotificationCallback& value); 282 void SetShowNotificationCallback(const ShowNotificationCallback& value);
263 283
264 /** 284 /**
265 * Removes the callback invoked when a notification should be shown. 285 * Removes the callback invoked when a notification should be shown.
266 */ 286 */
267 void RemoveShowNotificationCallback(); 287 void RemoveShowNotificationCallback();
268 288
269 /** 289 /**
270 * Checks if any active filter matches the supplied URL. 290 * Checks if any active filter matches the supplied URL.
271 * @param url URL to match. 291 * @param url URL to match.
272 * @param contentType Content type of the requested resource. 292 * @param contentTypeMask Content type mask of the requested resource.
273 * @param documentUrl URL of the document requesting the resource. 293 * @param documentUrl URL of the document requesting the resource.
274 * Note that there will be more than one document if frames are 294 * Note that there will be more than one document if frames are
275 * involved, see 295 * involved, see
276 * Matches(const std::string&, const std::string&, const std::vector< std::string>&) const. 296 * Matches(const std::string&, const std::string&, const std::vector< std::string>&) const.
277 * @return Matching filter, or `null` if there was no match. 297 * @return Matching filter, or `null` if there was no match.
278 * @throw `std::invalid_argument`, if an invalid `contentType` was supplied. 298 * @throw `std::invalid_argument`, if an invalid `contentType` was supplied.
279 */ 299 */
280 FilterPtr Matches(const std::string& url, 300 FilterPtr Matches(const std::string& url,
281 ContentType contentType, 301 ContentTypeMask contentTypeMask,
282 const std::string& documentUrl) const; 302 const std::string& documentUrl) const;
283 303
284 /** 304 /**
285 * Checks if any active filter matches the supplied URL. 305 * Checks if any active filter matches the supplied URL.
286 * @param url URL to match. 306 * @param url URL to match.
287 * @param contentType Content type of the requested resource. 307 * @param contentTypeMask Content type mask of the requested resource.
288 * @param documentUrls Chain of documents requesting the resource, starting 308 * @param documentUrls Chain of documents requesting the resource, starting
289 * with the current resource's parent frame, ending with the 309 * with the current resource's parent frame, ending with the
290 * top-level frame. 310 * top-level frame.
291 * If the application is not capable of identifying the frame 311 * If the application is not capable of identifying the frame
292 * structure, e.g. because it is a proxy, it can be approximated 312 * structure, e.g. because it is a proxy, it can be approximated
293 * using `ReferrerMapping`. 313 * using `ReferrerMapping`.
294 * @return Matching filter, or a `null` if there was no match. 314 * @return Matching filter, or a `null` if there was no match.
295 * @throw `std::invalid_argument`, if an invalid `contentType` was supplied. 315 * @throw `std::invalid_argument`, if an invalid `contentType` was supplied.
296 */ 316 */
297 FilterPtr Matches(const std::string& url, 317 FilterPtr Matches(const std::string& url,
298 ContentType contentType, 318 ContentTypeMask contentTypeMask,
299 const std::vector<std::string>& documentUrls) const; 319 const std::vector<std::string>& documentUrls) const;
300 320
301 /** 321 /**
302 * Checks whether the document at the supplied URL is whitelisted. 322 * Checks whether the document at the supplied URL is whitelisted.
303 * @param url URL of the document. 323 * @param url URL of the document.
304 * @param documentUrls Chain of document URLs requesting the document, 324 * @param documentUrls Chain of document URLs requesting the document,
305 * starting with the current document's parent frame, ending with 325 * starting with the current document's parent frame, ending with
306 * the top-level frame. 326 * the top-level frame.
307 * If the application is not capable of identifying the frame 327 * If the application is not capable of identifying the frame
308 * structure, e.g. because it is a proxy, it can be approximated 328 * structure, e.g. because it is a proxy, it can be approximated
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after
422 442
423 private: 443 private:
424 JsEnginePtr jsEngine; 444 JsEnginePtr jsEngine;
425 bool initialized; 445 bool initialized;
426 bool firstRun; 446 bool firstRun;
427 int updateCheckId; 447 int updateCheckId;
428 static const std::map<ContentType, std::string> contentTypes; 448 static const std::map<ContentType, std::string> contentTypes;
429 449
430 void InitDone(JsValueList& params); 450 void InitDone(JsValueList& params);
431 FilterPtr CheckFilterMatch(const std::string& url, 451 FilterPtr CheckFilterMatch(const std::string& url,
432 ContentType contentType, 452 ContentTypeMask contentTypeMask,
433 const std::string& documentUrl) const; 453 const std::string& documentUrl) const;
434 void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params); 454 void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params);
435 void UpdateCheckDone(const std::string& eventName, 455 void UpdateCheckDone(const std::string& eventName,
436 UpdateCheckDoneCallback callback, JsValueList& params); 456 UpdateCheckDoneCallback callback, JsValueList& params);
437 void FilterChanged(FilterChangeCallback callback, JsValueList& params); 457 void FilterChanged(FilterChangeCallback callback, JsValueList& params);
438 void ShowNotification(const ShowNotificationCallback& callback, 458 void ShowNotification(const ShowNotificationCallback& callback,
439 const JsValueList& params); 459 const JsValueList& params);
440 FilterPtr GetWhitelistingFilter(const std::string& url, 460 FilterPtr GetWhitelistingFilter(const std::string& url,
441 ContentType contentType, const std::string& documentUrl) const; 461 ContentTypeMask contentTypeMask, const std::string& documentUrl) const;
442 FilterPtr GetWhitelistingFilter(const std::string& url, 462 FilterPtr GetWhitelistingFilter(const std::string& url,
443 ContentType contentType, 463 ContentTypeMask contentTypeMask,
444 const std::vector<std::string>& documentUrls) const; 464 const std::vector<std::string>& documentUrls) const;
445 }; 465 };
446 } 466 }
447 467
448 #endif 468 #endif
OLDNEW
« no previous file with comments | « ensure_dependencies.py ('k') | lib/api.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld