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

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

Issue 5768603836088320: Issue 1564-Fix FilterEngine::Matches for allowing request which is whitelisted in the ascendant node
Patch Set: fix according to comments and add some tests Created Nov. 26, 2014, 10:35 a.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 | « no previous file | src/ReferrerMapping.cpp » ('j') | src/ReferrerMapping.cpp » ('J')
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 <http://adblockplus.org/>, 2 * This file is part of Adblock Plus <http://adblockplus.org/>,
3 * Copyright (C) 2006-2014 Eyeo GmbH 3 * Copyright (C) 2006-2014 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
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details. 12 * GNU General Public License for more details.
13 * 13 *
14 * You should have received a copy of the GNU General Public License 14 * You should have received a copy of the GNU General Public License
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.
16 */ 16 */
17 17
18 #ifndef ADBLOCK_PLUS_REFERRER_MAPPING_H 18 #ifndef ADBLOCK_PLUS_REFERRER_MAPPING_H
19 #define ADBLOCK_PLUS_REFERRER_MAPPING_H 19 #define ADBLOCK_PLUS_REFERRER_MAPPING_H
20 20
21 #include <list> 21 #include <list>
22 #include <map> 22 #include <map>
23 #include <string> 23 #include <string>
24 #include <vector> 24 #include <vector>
25 #include "FilterEngine.h"
25 26
26 namespace AdblockPlus 27 namespace AdblockPlus
27 { 28 {
28 /** 29 /**
29 * Stores a mapping between URLs and their referrers. 30 * Stores a mapping between URLs and their referrers.
30 * This can be used to build a chain of referrers for any URL 31 * This can be used to build a frame structure for any URL
31 * (see `BuildReferrerChain()`), which approximates the frame structure, see 32 * (see `BuildFrameStructure()`), it's useful for FilterEngine::Matches().
32 * FilterEngine::Matches().
33 */ 33 */
34 class ReferrerMapping 34 class ReferrerMapping
35 { 35 {
36 public: 36 public:
37 /// The type for URL.
38 typedef std::string Url;
39
40 /// Contains the ordered list of URLs.
Wladimir Palant 2014/12/09 21:20:03 Nit: *an* ordered list
41 typedef std::vector<Url> Urls;
42
43 /// Indicates whether the URL is a frame or not.
44 enum FrameIndicator
45 {
46 FRAME_INDICATOR_NOT_A_FRAME = 0, FRAME_INDICATOR_FRAME= 1
Wladimir Palant 2014/12/09 21:20:03 Extreme nit: articles seem wrong in constant names
sergei 2014/12/12 17:07:07 I know, I thought about it but don't remember the
47 };
37 /** 48 /**
38 * Constructor. 49 * Constructor.
39 * @param maxCachedUrls Number of URL mappings to store. The higher the 50 * @param maxCachedUrls Number of URL mappings to store. The higher the
40 * better - clients typically cache requests, and a single cached 51 * better - clients typically cache requests, and a single cached
41 * request will break the referrer chain. 52 * request will break the referrer chain.
42 */ 53 */
43 ReferrerMapping(const int maxCachedUrls = 5000); 54 ReferrerMapping(const int maxCachedUrls = 5000);
44 55
45 /** 56 /**
46 * Records the refferer for a URL. 57 * Records the refferer for a URL.
47 * @param url Request URL. 58 * @param url Request URL.
48 * @param referrer Request referrer. 59 * @param referrer Request referrer.
60 * @param isFrame Indicates whether the url is a frame.
49 */ 61 */
50 void Add(const std::string& url, const std::string& referrer); 62 void Add(const Url& url, const Url& referrer, FrameIndicator isFrame);
51 63
52 /** 64 /**
53 * Builds a chain of referrers for the supplied URL. 65 * Builds a frame structure for the supplied URL.
54 * This should reconstruct a document's parent frame URLs. 66 * This should reconstruct a document's parent frame URLs.
55 * @param url URL to build the chain for. 67 * @param url URL to build the chain for.
56 * @return List of URLs, starting with `url`. 68 * @return List of URLs, finishing with `url`.
57 */ 69 */
58 std::vector<std::string> BuildReferrerChain(const std::string& url) const; 70 Urls BuildFrameStructure(const Url& url) const;
59 71
60 private: 72 private:
61 const int maxCachedUrls; 73 const int maxCachedUrls;
62 std::map<std::string, std::string> mapping; 74 struct RequestInfo
63 std::list<std::string> cachedUrls; 75 {
76 explicit RequestInfo(const Url& referrerArg = Url(),
77 FrameIndicator frameIndicatorArg = FrameIndicator::FRAME_INDICATOR_NOT_A _FRAME)
Wladimir Palant 2014/12/09 21:20:03 Shouldn't you have that default value in method Ad
sergei 2014/12/12 17:07:07 These default arguments are required by std::map,
78 : referrer(referrerArg), frameIndicator(frameIndicatorArg)
79 {
80 }
81 bool IsFrame() const
82 {
83 return frameIndicator == FrameIndicator::FRAME_INDICATOR_FRAME;
84 }
85 Url referrer;
86 FrameIndicator frameIndicator;
87 };
88 typedef std::map<Url, RequestInfo> ReferrerMap;
89 ReferrerMap mapping;
90 std::list<Url> cachedUrls;
64 }; 91 };
65 } 92 }
66 93
67 #endif 94 #endif
OLDNEW
« no previous file with comments | « no previous file | src/ReferrerMapping.cpp » ('j') | src/ReferrerMapping.cpp » ('J')

Powered by Google App Engine
This is Rietveld