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

Side by Side Diff: lib/filterHits.js

Issue 6337686776315904: Issue 394 - hit statistics tool data collection (Closed)
Patch Set: Use Downloader to send the data to server Created April 6, 2016, 3 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 | « lib/contentPolicy.js ('k') | lib/prefs.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 /*
2 * This file is part of Adblock Plus <https://adblockplus.org/>,
3 * Copyright (C) 2006-2016 Eyeo GmbH
4 *
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
7 * published by the Free Software Foundation.
8 *
9 * Adblock Plus is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
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/>.
16 */
17
18 let {Services} = Cu.import("resource://gre/modules/Services.jsm", null);
19 let {FileUtils} = Cu.import("resource://gre/modules/FileUtils.jsm", null);
20 let {setTimeout, clearTimeout} = Cu.import("resource://gre/modules/Timer.jsm", n ull);
21
22 let {IO} = require("io");
23 let {Prefs} = require("prefs");
24 let {Downloader, Downloadable, MILLIS_IN_SECOND, MILLIS_IN_MINUTE,
25 MILLIS_IN_HOUR, MILLIS_IN_DAY} = require("downloader");
26 let {FilterNotifier} = require("filterNotifier");
27 let {DownloadableSubscription} = require("subscriptionClasses");
28
29 const CHECK_INTERVAL = MILLIS_IN_HOUR;
30 const INITIAL_DELAY = MILLIS_IN_MINUTE * 2;
31 const PUSH_INTERVAL = MILLIS_IN_DAY * 7;
32
33 /**
34 * The value of storage statement normal execution constant
35 * @type Number
36 */
37 const REASON_FINISHED = Components.interfaces.mozIStorageStatementCallback.REASO N_FINISHED;
38
39 /**
40 * This class collects filter hits statistics in a SQLite database
41 * and sends them to the server when user opt-in for that
42 * @class
43 */
44 let FilterHits = exports.FilterHits =
45 {
46 /**
47 * Used to prevent timers running in parallel
48 * @type Number
49 */
50 _prefToggleTimeout: 0,
51
52 get connection()
53 {
54 if (!this.storageFile)
55 return null;
56
57 let connection = Services.storage.openDatabase(this.storageFile);
58 if (!connection.tableExists("filtersubscriptions"))
59 {
60 connection.executeSimpleSQL("CREATE TABLE filtersubscriptions " +
61 "(id INTEGER, subscriptions TEXT, PRIMARY KEY" +
62 "(id), UNIQUE(subscriptions))");
63 }
64 if (!connection.tableExists("filterhits"))
65 {
66 connection.executeSimpleSQL("CREATE TABLE filterhits (filter TEXT, " +
67 "host TEXT, thirdParty INTEGER, hitCount INTEGER, lastHit INTEGER, " +
68 "subscriptions INTEGER NOT NULL, PRIMARY KEY(filter, host, " +
69 "thirdParty), FOREIGN KEY(subscriptions) REFERENCES "+
70 "filtersubscriptions(id))");
71 }
72 Object.defineProperty(this, "connection",
73 {
74 value: connection
75 });
76 return connection;
77 },
78
79 /**
80 * @return nsIFile SQLite database file with filter hits data
81 */
82 get storageFile()
83 {
84 let file = IO.resolveFilePath(Prefs.data_directory);
85 if (file)
86 file.append("adblockplus.sqlite");
87
88 Object.defineProperty(this, "storageFile",
89 {
90 value: file
91 });
92 return file;
93 },
94
95 /**
96 * Called on module startup.
97 */
98 init: function()
99 {
100 if (!Prefs.sendstats_status.lastPush)
101 {
102 Prefs.sendstats_status.lastPush = Date.now();
103 this._saveFilterHitPrefs();
104 }
105 Prefs.addListener(name =>
106 {
107 if (name == "sendstats")
108 {
109 if (this._prefToggleTimeout)
110 clearTimeout(this._prefToggleTimeout);
111 this._prefToggleTimeout = setTimeout(() =>
112 {
113 if (!Prefs.sendstats)
114 this.resetFilterHits();
115 }, 1000);
116 }
117 });
118
119 let downloader = new Downloader(this._getDownloadables.bind(this),
120 INITIAL_DELAY, CHECK_INTERVAL);
121 downloader.onExpirationChange = this._onExpirationChange.bind(this);
122 downloader.generateRequestData = this._generateFilterHitsData.bind(this);
123 downloader.onDownloadSuccess = this._onDownloadSuccess.bind(this);
124 downloader.validResponses.push(204);
125 onShutdown.add(() => downloader.cancel());
126 },
127
128 /**
129 * Yields a Downloadable instance for the filter hits push.
130 */
131 _getDownloadables: function*()
132 {
133 let downloadable = new Downloadable(Prefs.sendstats_url);
134 if (Prefs.sendstats_status.lastError)
135 downloadable.lastError = Prefs.sendstats_status.lastError;
136 if (Prefs.sendstats_status.lastCheck)
137 downloadable.lastCheck = Prefs.sendstats_status.lastCheck;
138 if (Prefs.sendstats_status.lastPush)
139 {
140 downloadable.softExpiration = Prefs.sendstats_status.lastPush + PUSH_INTER VAL;
saroyanm 2016/04/06 15:15:45 I'm not sure regarding this, should we specify sof
141 downloadable.hardExpiration = Prefs.sendstats_status.lastPush + PUSH_INTER VAL;
142 }
143 yield downloadable;
144 },
145
146 _onExpirationChange: function(downloadable)
147 {
148 Prefs.sendstats_status.lastCheck = downloadable.lastCheck;
149 this._saveFilterHitPrefs();
150 },
151
152 _saveFilterHitPrefs: function()
153 {
154 Prefs.sendstats_status = JSON.parse(JSON.stringify(Prefs.sendstats_status));
155 },
156
157 _onDownloadSuccess: function(downloadable, responseText, errorCallback, redire ctCallback)
158 {
159 Prefs.sendstats_status.lastError = 0;
160 Prefs.sendstats_status.lastPush = Date.now();
161 this._saveFilterHitPrefs();
162 },
163
164 /**
165 * Increases the filter hit count
166 * @param {Filter} filter
167 * @param {String} host
168 */
169 increaseFilterHits: function(filter, host, thirdParty)
170 {
171 let subscriptions = filter.subscriptions;
172 let downloadableSubscriptions = [];
173 for (let i = 0; i < subscriptions.length; i++)
174 {
175 if (subscriptions[i] instanceof DownloadableSubscription)
176 downloadableSubscriptions.push(subscriptions[i].url);
177 }
178
179 if (downloadableSubscriptions.length == 0)
180 return;
181
182 if (!this.connection)
183 return;
184
185 let statements = [];
186 let filterSubscriptions = JSON.stringify(downloadableSubscriptions);
187 let subscriptionStatement = this.connection.createStatement("INSERT OR " +
188 "IGNORE INTO filtersubscriptions (subscriptions) VALUES " +
189 "(:subscriptions)");
190 subscriptionStatement.params.subscriptions = filterSubscriptions;
191 statements.push(subscriptionStatement);
192 let filterHitStatement = this.connection.createStatement("INSERT OR " +
193 "REPLACE INTO filterhits (filter, host, thirdParty, hitCount, lastHit, " +
194 "subscriptions) VALUES (:filter, :host, :thirdParty, COALESCE ((SELECT " +
195 "hitCount FROM filterhits WHERE filter=:filter AND host=:host AND " +
196 "thirdParty=:thirdParty), 0) + 1, :lastHit, (SELECT id " +
197 "FROM filtersubscriptions WHERE subscriptions=:subscriptions))");
198 filterHitStatement.params.filter = filter.text;
199 filterHitStatement.params.host = host;
200 filterHitStatement.params.lastHit = roundToHours(filter.lastHit);
201 filterHitStatement.params.thirdParty = thirdParty;
202 filterHitStatement.params.subscriptions = filterSubscriptions;
203 statements.push(filterHitStatement);
204
205 this.connection.executeAsync(statements, statements.length,
206 {
207 handleError: (error) =>
208 {
209 Cu.reportError("Error updating filter hits: " + error.message);
210 },
211 handleCompletion: (reason) =>
212 {
213 if (reason != REASON_FINISHED)
214 Cu.reportError("Updating filter hits canceled or aborted: " + reason);
215 }
216 });
217 },
218
219 /**
220 * Remove all local collected filter hits data
221 */
222 resetFilterHits: function()
223 {
224 if (!this.connection)
225 return;
226
227 this.connection.executeSimpleSQL("DELETE FROM filterhits");
228 this.connection.executeSimpleSQL("DELETE FROM filtersubscriptions");
229 },
230
231 _generateFilterHitsData: function(downloadable)
232 {
233 return {
234 then: (resolve) =>
235 {
236 if (!this.connection)
237 return;
238
239 let statement = this.connection.createStatement("SELECT filterhits.*, " +
240 "filtersubscriptions.subscriptions FROM filterhits LEFT JOIN " +
241 "filtersubscriptions filtersubscriptions ON " +
242 "filterhits.subscriptions=filtersubscriptions.id");
243 statement.executeAsync(
244 {
245 handleResult: (result) =>
246 {
247 let filters = Object.create(null);
248 for (let row = result.getNextRow(); row;
249 row = result.getNextRow())
250 {
251 let filterText = row.getResultByName("filter");
252 let host = row.getResultByName("host");
253 let matchType = (row.getResultByName("thirdParty") ?
254 "thirdParty" : "firstParty");
255 let hitCount = row.getResultByName("hitCount");
256 let lastHit = row.getResultByName("lastHit");
257 let subscriptions = row.getResultByName("subscriptions");
258
259 if (!(filterText in filters))
260 filters[filterText] = Object.create(null);
261
262 let filter = filters[filterText];
263 filter.subscriptions = subscriptions;
264 filter[matchType] = Object.create(null);
265 filter[matchType][host] = {"hits": hitCount, latest: lastHit};
266 }
267 resolve({timeSincePush: roundToHours(Date.now() -
268 Prefs.sendstats_status.lastPush), "filters": filters});
269 },
270 handleError: (error) =>
271 {
272 Prefs.sendstats_status.lastError = Date.now();
273 this._saveFilterHitPrefs();
274 Cu.reportError("Error loading filter hits:" + error.message);
275 },
276 handleCompletion: (reason) =>
277 {
278 if (reason != REASON_FINISHED)
279 {
280 Prefs.sendstats_status.lastError = Date.now();
281 this._saveFilterHitPrefs();
282 Cu.reportError("Loading of filter hits canceled or aborted: " +
283 reason);
284 }
285 }
286 });
287 }
288 }
289 },
290 };
291
292 function roundToHours(timestamp)
293 {
294 return Math.round(timestamp / MILLIS_IN_HOUR) *
295 (MILLIS_IN_HOUR / MILLIS_IN_SECOND);
296 }
297
298 FilterHits.init();
OLDNEW
« no previous file with comments | « lib/contentPolicy.js ('k') | lib/prefs.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld