standalone logger + logging of cosmetic filters

This commit is contained in:
gorhill 2015-04-30 09:12:50 -04:00
parent 803a0c54f5
commit 715b8e6329
12 changed files with 514 additions and 209 deletions

View File

@ -22,6 +22,7 @@
<script src="js/messaging.js"></script> <script src="js/messaging.js"></script>
<script src="js/profiler.js"></script> <script src="js/profiler.js"></script>
<script src="js/storage.js"></script> <script src="js/storage.js"></script>
<script src="js/logger.js"></script>
<script src="js/pagestore.js"></script> <script src="js/pagestore.js"></script>
<script src="js/tab.js"></script> <script src="js/tab.js"></script>
<script src="js/traffic.js"></script> <script src="js/traffic.js"></script>

View File

@ -68,18 +68,32 @@ input:focus {
direction: ltr; direction: ltr;
width: 100%; width: 100%;
} }
#content table tr.docBoundary {
background-color: #666;
color: white;
text-align: center;
}
#content table tr.docBoundary > td:first-child {
padding: 1em 0;
white-space: normal;
word-break: break-all;
word-wrap: break-word;
}
#content table tr.blocked { #content table tr.blocked {
background-color: rgba(192, 0, 0, 0.1) background-color: rgba(192, 0, 0, 0.1);
} }
#content table tr.allowed { #content table tr.allowed {
background-color: rgba(0, 160, 0, 0.1) background-color: rgba(0, 160, 0, 0.1);
} }
#content table tr.allowed.mirrored { #content table tr.allowed.mirrored {
background-color: rgba(255, 255, 0, 0.3) background-color: rgba(255, 255, 0, 0.3);
} }
#content table tr.maindoc { #content table tr.maindoc {
background-color: #eee; background-color: #eee;
} }
#content table tr.cosmetic {
background-color: rgba(255, 255, 0, 0.1);
}
body:not(.filterOff) #content table tr.hidden { body:not(.filterOff) #content table tr.hidden {
display: none; display: none;
} }

View File

@ -55,6 +55,7 @@ if ( vAPI.contentscriptEndInjected ) {
return; return;
} }
vAPI.contentscriptEndInjected = true; vAPI.contentscriptEndInjected = true;
vAPI.styles = vAPI.styles || [];
/******************************************************************************/ /******************************************************************************/
/******************************************************************************/ /******************************************************************************/
@ -187,7 +188,7 @@ var uBlockCollapser = (function() {
} }
if ( selectors.length !== 0 ) { if ( selectors.length !== 0 ) {
messager.send({ messager.send({
what: 'injectedSelectors', what: 'cosmeticFiltersInjected',
type: 'net', type: 'net',
hostname: window.location.hostname, hostname: window.location.hostname,
selectors: selectors selectors: selectors
@ -385,7 +386,7 @@ var uBlockCollapser = (function() {
processHighHighGenericsAsync(); processHighHighGenericsAsync();
} }
} }
if ( hideSelectors.length ) { if ( hideSelectors.length !== 0 ) {
addStyleTag(hideSelectors); addStyleTag(hideSelectors);
} }
contextNodes.length = 0; contextNodes.length = 0;
@ -400,7 +401,7 @@ var uBlockCollapser = (function() {
// - Injecting a style tag // - Injecting a style tag
var addStyleTag = function(selectors) { var addStyleTag = function(selectors) {
var selectorStr = selectors.toString(); var selectorStr = selectors.join(',\n');
hideElements(selectorStr); hideElements(selectorStr);
var style = document.createElement('style'); var style = document.createElement('style');
// The linefeed before the style block is very important: do no remove! // The linefeed before the style block is very important: do no remove!
@ -408,9 +409,10 @@ var uBlockCollapser = (function() {
var parent = document.body || document.documentElement; var parent = document.body || document.documentElement;
if ( parent ) { if ( parent ) {
parent.appendChild(style); parent.appendChild(style);
vAPI.styles.push(style);
} }
messager.send({ messager.send({
what: 'injectedSelectors', what: 'cosmeticFiltersInjected',
type: 'cosmetic', type: 'cosmetic',
hostname: window.location.hostname, hostname: window.location.hostname,
selectors: selectors selectors: selectors
@ -701,6 +703,7 @@ var uBlockCollapser = (function() {
idsFromNodeList(selectNodes('[id]')); idsFromNodeList(selectNodes('[id]'));
classesFromNodeList(selectNodes('[class]')); classesFromNodeList(selectNodes('[class]'));
retrieveGenericSelectors(); retrieveGenericSelectors();
messager.send({ what: 'cosmeticFiltersActivated' });
} }
}; };

View File

@ -53,6 +53,7 @@ if ( vAPI.contentscriptStartInjected ) {
return; return;
} }
vAPI.contentscriptStartInjected = true; vAPI.contentscriptStartInjected = true;
vAPI.styles = vAPI.styles || [];
/******************************************************************************/ /******************************************************************************/
@ -99,6 +100,7 @@ var cosmeticFilters = function(details) {
var parent = document.head || document.documentElement; var parent = document.head || document.documentElement;
if ( parent ) { if ( parent ) {
parent.appendChild(style); parent.appendChild(style);
vAPI.styles.push(style);
} }
} }
vAPI.donthideCosmeticFilters = donthideCosmeticFilters; vAPI.donthideCosmeticFilters = donthideCosmeticFilters;
@ -121,6 +123,8 @@ var netFilters = function(details) {
}; };
var filteringHandler = function(details) { var filteringHandler = function(details) {
var styleTagCount = vAPI.styles.length;
vAPI.skipCosmeticFiltering = !details || details.skipCosmeticFiltering; vAPI.skipCosmeticFiltering = !details || details.skipCosmeticFiltering;
if ( details ) { if ( details ) {
if ( details.cosmeticHide.length !== 0 || details.cosmeticDonthide.length !== 0 ) { if ( details.cosmeticHide.length !== 0 || details.cosmeticDonthide.length !== 0 ) {
@ -129,8 +133,12 @@ var filteringHandler = function(details) {
if ( details.netHide.length !== 0 ) { if ( details.netHide.length !== 0 ) {
netFilters(details); netFilters(details);
} }
// The port will never be used again at this point, disconnecting allows }
// the browser to flush this script from memory.
// This is just to inform the background process that cosmetic filters were
// actually injected.
if ( vAPI.styles.length !== styleTagCount ) {
localMessager.send({ what: 'cosmeticFiltersActivated' });
} }
// https://github.com/chrisaljoudi/uBlock/issues/587 // https://github.com/chrisaljoudi/uBlock/issues/587
@ -139,7 +147,8 @@ var filteringHandler = function(details) {
// cleaned right after browser launch. // cleaned right after browser launch.
vAPI.contentscriptStartInjected = details && details.ready; vAPI.contentscriptStartInjected = details && details.ready;
// Cleanup before leaving // The port will never be used again at this point, disconnecting allows
// the browser to flush this script from memory.
localMessager.close(); localMessager.close();
}; };

96
src/js/cosmetic-logger.js Normal file
View File

@ -0,0 +1,96 @@
/*******************************************************************************
uBlock - a browser extension to block requests.
Copyright (C) 2015 Raymond Hill
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see {http://www.gnu.org/licenses/}.
Home: https://github.com/gorhill/uBlock
*/
/* global vAPI, HTMLDocument */
/******************************************************************************/
(function() {
'use strict';
/******************************************************************************/
// https://github.com/gorhill/uBlock/issues/464
if ( document instanceof HTMLDocument === false ) {
//console.debug('cosmetic-logger.js > not a HTLMDocument');
return;
}
// This can happen
if ( !vAPI ) {
//console.debug('cosmetic-logger.js > vAPI not found');
return;
}
/******************************************************************************/
var loggedSelectors = vAPI.loggedSelectors || {};
var injectedSelectors = [];
var reProperties = /\s*\{[^}]+\}\s*/;
var i;
var styles = vAPI.styles || [];
i = styles.length;
while ( i-- ) {
injectedSelectors = injectedSelectors.concat(styles[i].textContent.replace(reProperties, '').split(/\s*,\n\s*/));
}
if ( injectedSelectors.length === 0 ) {
return;
}
var matchedSelectors = [];
var selector;
i = injectedSelectors.length;
while ( i-- ) {
selector = injectedSelectors[i];
if ( loggedSelectors.hasOwnProperty(selector) ) {
continue;
}
if ( document.querySelector(selector) === null ) {
continue;
}
loggedSelectors[selector] = true;
matchedSelectors.push(selector);
}
vAPI.loggedSelectors = loggedSelectors;
/******************************************************************************/
var localMessager = vAPI.messaging.channel('cosmetic-*.js');
localMessager.send({
what: 'logCosmeticFilteringData',
pageURL: window.location.href,
matchedSelectors: matchedSelectors
}, function() {
localMessager.close();
});
/******************************************************************************/
})();
/******************************************************************************/

View File

@ -37,7 +37,8 @@ var inspectedTabId = '';
var doc = document; var doc = document;
var body = doc.body; var body = doc.body;
var tbody = doc.querySelector('#content tbody'); var tbody = doc.querySelector('#content tbody');
var rowJunkyard = []; var row1Junkyard = [];
var row4Junkyard = [];
var reFilter = null; var reFilter = null;
var filterTargetTestResult = true; var filterTargetTestResult = true;
var maxEntries = 0; var maxEntries = 0;
@ -106,7 +107,7 @@ var renderURL = function(url, filter) {
/******************************************************************************/ /******************************************************************************/
var createRow = function() { var createRow = function() {
var tr = rowJunkyard.pop(); var tr = row4Junkyard.pop();
if ( tr ) { if ( tr ) {
tr.className = ''; tr.className = '';
return tr; return tr;
@ -121,8 +122,35 @@ var createRow = function() {
/******************************************************************************/ /******************************************************************************/
var createGap = function(url) {
var tr = row1Junkyard.pop();
if ( !tr ) {
tr = doc.createElement('tr');
tr.classList.add('docBoundary');
tr.appendChild(doc.createElement('td'));
tr.cells[0].setAttribute('colspan', '4');
}
tr.cells[0].textContent = url;
tbody.insertBefore(tr, tbody.firstChild);
};
/******************************************************************************/
var renderLogEntry = function(entry) { var renderLogEntry = function(entry) {
var tr = createRow(); var tr = createRow();
// If the request is that of a root frame, insert a gap in the table
// in order to visually separate entries for different documents.
if ( entry.type === 'main_frame' ) {
createGap(entry.url);
tr.classList.add('maindoc');
}
// Cosmetic filter?
if ( entry.result.charAt(0) === 'c' ) {
tr.classList.add('cosmetic');
}
if ( entry.result.charAt(1) === 'b' ) { if ( entry.result.charAt(1) === 'b' ) {
tr.classList.add('blocked'); tr.classList.add('blocked');
tr.cells[0].textContent = ' -\u00A0'; tr.cells[0].textContent = ' -\u00A0';
@ -135,9 +163,11 @@ var renderLogEntry = function(entry) {
} else { } else {
tr.cells[0].textContent = ''; tr.cells[0].textContent = '';
} }
if ( entry.type === 'main_frame' ) { if ( entry.type === 'main_frame' ) {
tr.classList.add('maindoc'); tr.classList.add('maindoc');
} }
var filterText = entry.result.slice(3); var filterText = entry.result.slice(3);
if ( entry.result.lastIndexOf('sa', 0) === 0 ) { if ( entry.result.lastIndexOf('sa', 0) === 0 ) {
filterText = '@@' + filterText; filterText = '@@' + filterText;
@ -198,8 +228,17 @@ var truncateLog = function(size) {
size = 25000; size = 25000;
} }
size = Math.min(size, 25000); size = Math.min(size, 25000);
var tr;
while ( tbody.childElementCount > size ) { while ( tbody.childElementCount > size ) {
rowJunkyard.push(tbody.removeChild(tbody.lastElementChild)); tr = tbody.lastElementChild;
// https://github.com/gorhill/uBlock/issues/123
// Triage according to row type.
if ( tr.cells.length === 1 ) {
row1Junkyard.push(tr);
} else {
row4Junkyard.push(tr);
}
tbody.removeChild(tr);
} }
}; };
@ -225,8 +264,17 @@ var readLogBuffer = function() {
/******************************************************************************/ /******************************************************************************/
var clearBuffer = function() { var clearBuffer = function() {
var tr;
while ( tbody.firstChild !== null ) { while ( tbody.firstChild !== null ) {
rowJunkyard.push(tbody.removeChild(tbody.firstChild)); tr = tbody.lastElementChild;
// https://github.com/gorhill/uBlock/issues/123
// Triage according to row type.
if ( tr.cells.length === 1 ) {
row1Junkyard.push(tr);
} else {
row4Junkyard.push(tr);
}
tbody.removeChild(tr);
} }
}; };

214
src/js/logger.js Normal file
View File

@ -0,0 +1,214 @@
/*******************************************************************************
uBlock Origin - a browser extension to block requests.
Copyright (C) 2015 Raymond Hill
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see {http://www.gnu.org/licenses/}.
Home: https://github.com/gorhill/uBlock
*/
/* global µBlock */
/******************************************************************************/
/******************************************************************************/
µBlock.logger = (function() {
'use strict';
/******************************************************************************/
/******************************************************************************/
var LogEntry = function(details, result) {
this.init(details, result);
};
/******************************************************************************/
var logEntryFactory = function(details, result) {
var entry = logEntryJunkyard.pop();
if ( entry ) {
return entry.init(details, result);
}
return new LogEntry(details, result);
};
var logEntryJunkyard = [];
var logEntryJunkyardMax = 100;
/******************************************************************************/
LogEntry.prototype.init = function(details, result) {
this.tstamp = Date.now();
this.url = details.requestURL;
this.hostname = details.requestHostname;
this.type = details.requestType;
this.result = result;
return this;
};
/******************************************************************************/
LogEntry.prototype.dispose = function() {
this.url = this.hostname = this.type = this.result = '';
if ( logEntryJunkyard.length < logEntryJunkyardMax ) {
logEntryJunkyard.push(this);
}
};
/******************************************************************************/
/******************************************************************************/
var LogBuffer = function() {
this.lastReadTime = 0;
this.size = 50;
this.buffer = new Array(this.size);
this.readPtr = 0;
this.writePtr = 0;
};
/******************************************************************************/
LogBuffer.prototype.dispose = function() {
var entry;
var i = this.buffer.length;
while ( i-- ) {
entry = this.buffer[i];
if ( entry instanceof LogEntry ) {
entry.dispose();
}
}
this.buffer = null;
return null;
};
/******************************************************************************/
LogBuffer.prototype.writeOne = function(details, result) {
// Reusing log entry = less memory churning
var entry = this.buffer[this.writePtr];
if ( entry instanceof LogEntry === false ) {
this.buffer[this.writePtr] = logEntryFactory(details, result);
} else {
entry.init(details, result);
}
this.writePtr += 1;
if ( this.writePtr === this.size ) {
this.writePtr = 0;
}
// Grow the buffer between 1.5x-2x the current size
if ( this.writePtr === this.readPtr ) {
var toMove = this.buffer.slice(0, this.writePtr);
var minSize = Math.ceil(this.size * 1.5);
this.size += toMove.length;
if ( this.size < minSize ) {
this.buffer = this.buffer.concat(toMove, new Array(minSize - this.size));
this.writePtr = this.size;
} else {
this.buffer = this.buffer.concat(toMove);
this.writePtr = 0;
}
this.size = this.buffer.length;
}
};
/******************************************************************************/
LogBuffer.prototype.readAll = function() {
var out;
if ( this.readPtr < this.writePtr ) {
out = this.buffer.slice(this.readPtr, this.writePtr);
} else if ( this.writePtr < this.readPtr ) {
out = this.buffer.slice(this.readPtr).concat(this.buffer.slice(0, this.writePtr));
} else {
out = [];
}
this.readPtr = this.writePtr;
this.lastReadTime = Date.now();
return out;
};
/******************************************************************************/
/******************************************************************************/
// Tab id to log buffer instances
var logBuffers = {};
// After 30 seconds without being read, a buffer will be considered unused, and
// thus removed from memory.
var logBufferObsoleteAfter = 30 * 1000;
/******************************************************************************/
var writeOne = function(tabId, details, result) {
if ( logBuffers.hasOwnProperty(tabId) === false ) {
return;
}
var logBuffer = logBuffers[tabId];
logBuffer.writeOne(details, result);
};
/******************************************************************************/
var readAll = function(tabId) {
if ( logBuffers.hasOwnProperty(tabId) === false ) {
logBuffers[tabId] = new LogBuffer();
}
return logBuffers[tabId].readAll();
};
/******************************************************************************/
var isObserved = function(tabId) {
return logBuffers.hasOwnProperty(tabId);
};
/******************************************************************************/
var loggerJanitor = function() {
var logBuffer;
var obsolete = Date.now() - logBufferObsoleteAfter;
for ( var tabId in logBuffers ) {
if ( logBuffers.hasOwnProperty(tabId) === false ) {
continue;
}
logBuffer = logBuffers[tabId];
if ( logBuffer.lastReadTime < obsolete ) {
logBuffer.dispose();
delete logBuffers[tabId];
}
}
setTimeout(loggerJanitor, loggerJanitorPeriod);
};
// The janitor will look for stale log buffer every 2 minutes.
var loggerJanitorPeriod = 2 * 60 * 1000;
setTimeout(loggerJanitor, loggerJanitorPeriod);
/******************************************************************************/
return {
writeOne: writeOne,
readAll: readAll,
isObserved: isObserved
};
/******************************************************************************/
/******************************************************************************/
})();
/******************************************************************************/

View File

@ -50,6 +50,8 @@ var onMessage = function(request, sender, callback) {
break; break;
} }
var tabId = sender && sender.tab ? sender.tab.id : 0;
// Sync // Sync
var response; var response;
@ -59,6 +61,17 @@ var onMessage = function(request, sender, callback) {
µb.contextMenuClientY = request.clientY; µb.contextMenuClientY = request.clientY;
break; break;
case 'cosmeticFiltersInjected':
// Is this a request to cache selectors?
µb.cosmeticFilteringEngine.addToSelectorCache(request);
/* falls through */
case 'cosmeticFiltersActivated':
// Net-based cosmetic filters are of no interest for logging purpose.
if ( µb.logger.isObserved(tabId) && request.type !== 'net' ) {
µb.logCosmeticFilters(tabId);
}
break;
case 'forceUpdateAssets': case 'forceUpdateAssets':
µb.assetUpdater.force(); µb.assetUpdater.force();
break; break;
@ -463,9 +476,9 @@ var filterRequests = function(pageStore, details) {
/******************************************************************************/ /******************************************************************************/
var onMessage = function(details, sender, callback) { var onMessage = function(request, sender, callback) {
// Async // Async
switch ( details.what ) { switch ( request.what ) {
default: default:
break; break;
} }
@ -478,21 +491,17 @@ var onMessage = function(details, sender, callback) {
pageStore = µb.pageStoreFromTabId(sender.tab.id); pageStore = µb.pageStoreFromTabId(sender.tab.id);
} }
switch ( details.what ) { switch ( request.what ) {
case 'retrieveGenericCosmeticSelectors': case 'retrieveGenericCosmeticSelectors':
response = { response = {
shutdown: !pageStore || !pageStore.getNetFilteringSwitch(), shutdown: !pageStore || !pageStore.getNetFilteringSwitch(),
result: null result: null
}; };
if ( !response.shutdown && pageStore.getGenericCosmeticFilteringSwitch() ) { if ( !response.shutdown && pageStore.getGenericCosmeticFilteringSwitch() ) {
response.result = µb.cosmeticFilteringEngine.retrieveGenericSelectors(details); response.result = µb.cosmeticFilteringEngine.retrieveGenericSelectors(request);
} }
break; break;
case 'injectedSelectors':
µb.cosmeticFilteringEngine.addToSelectorCache(details);
break;
// Evaluate many requests // Evaluate many requests
case 'filterRequests': case 'filterRequests':
response = { response = {
@ -500,7 +509,7 @@ var onMessage = function(details, sender, callback) {
result: null result: null
}; };
if(!response.shutdown) { if(!response.shutdown) {
response.result = filterRequests(pageStore, details); response.result = filterRequests(pageStore, request);
} }
break; break;
@ -520,6 +529,73 @@ vAPI.messaging.listen('contentscript-end.js', onMessage);
/******************************************************************************/ /******************************************************************************/
/******************************************************************************/ /******************************************************************************/
// cosmetic-*.js
(function() {
'use strict';
/******************************************************************************/
var µb = µBlock;
/******************************************************************************/
var logCosmeticFilters = function(tabId, details) {
if ( µb.logger.isObserved(tabId) === false ) {
return;
}
var context = {
requestURL: details.pageURL,
requestHostname: µb.URI.hostnameFromURI(details.pageURL),
requestType: 'dom'
};
var selectors = details.matchedSelectors;
selectors.sort();
for ( var i = 0; i < selectors.length; i++ ) {
µb.logger.writeOne(tabId, context, 'cb:##' + selectors[i]);
}
};
/******************************************************************************/
var onMessage = function(request, sender, callback) {
// Async
switch ( request.what ) {
default:
break;
}
// Sync
var response;
var tabId = sender && sender.tab ? sender.tab.id : 0;
switch ( request.what ) {
case 'logCosmeticFilteringData':
logCosmeticFilters(tabId, request);
break;
default:
return vAPI.messaging.UNHANDLED;
}
callback(response);
};
vAPI.messaging.listen('cosmetic-*.js', onMessage);
/******************************************************************************/
})();
/******************************************************************************/
/******************************************************************************/
// element-picker.js // element-picker.js
(function() { (function() {
@ -1134,10 +1210,7 @@ var onMessage = function(request, sender, callback) {
switch ( request.what ) { switch ( request.what ) {
case 'readLogBuffer': case 'readLogBuffer':
var pageStore = µb.pageStoreFromTabId(request.tabId); response = µb.logger.readAll(request.tabId);
if ( pageStore ) {
response = pageStore.logBuffer.readAll();
}
break; break;
default: default:

View File

@ -45,178 +45,6 @@ var µb = µBlock;
/******************************************************************************/ /******************************************************************************/
/******************************************************************************/ /******************************************************************************/
var LogEntry = function(details, result) {
this.init(details, result);
};
/******************************************************************************/
var logEntryFactory = function(details, result) {
var entry = logEntryJunkyard.pop();
if ( entry ) {
return entry.init(details, result);
}
return new LogEntry(details, result);
};
var logEntryJunkyard = [];
var logEntryJunkyardMax = 100;
/******************************************************************************/
LogEntry.prototype.init = function(details, result) {
this.tstamp = Date.now();
this.url = details.requestURL;
this.hostname = details.requestHostname;
this.type = details.requestType;
this.result = result;
return this;
};
/******************************************************************************/
LogEntry.prototype.dispose = function() {
this.url = this.hostname = this.type = this.result = '';
if ( logEntryJunkyard.length < logEntryJunkyardMax ) {
logEntryJunkyard.push(this);
}
};
/******************************************************************************/
var LogBuffer = function() {
this.lastReadTime = 0;
this.size = 50;
this.buffer = null;
this.readPtr = 0;
this.writePtr = 0;
};
/******************************************************************************/
var logBufferFactory = function() {
return new LogBuffer();
};
var liveLogBuffers = [];
/******************************************************************************/
LogBuffer.prototype.dispose = function() {
if ( this.buffer === null ) {
return null;
}
var entry;
var i = this.buffer.length;
while ( i-- ) {
entry = this.buffer[i];
if ( entry instanceof LogEntry ) {
entry.dispose();
}
}
this.buffer = null;
return null;
};
/******************************************************************************/
LogBuffer.prototype.start = function() {
if ( this.buffer === null ) {
this.buffer = new Array(this.size);
this.readPtr = 0;
this.writePtr = 0;
liveLogBuffers.push(this);
}
};
/******************************************************************************/
LogBuffer.prototype.stop = function() {
this.dispose();
this.buffer = null;
// The janitor will remove us from the live pool eventually.
};
/******************************************************************************/
LogBuffer.prototype.writeOne = function(details, result) {
if ( this.buffer === null ) {
return;
}
// Reusing log entry = less memory churning
var entry = this.buffer[this.writePtr];
if ( entry instanceof LogEntry === false ) {
this.buffer[this.writePtr] = logEntryFactory(details, result);
} else {
entry.init(details, result);
}
this.writePtr += 1;
if ( this.writePtr === this.size ) {
this.writePtr = 0;
}
// Grow the buffer between 1.5x-2x the current size
if ( this.writePtr === this.readPtr ) {
var toMove = this.buffer.slice(0, this.writePtr);
var minSize = Math.ceil(this.size * 1.5);
this.size += toMove.length;
if ( this.size < minSize ) {
this.buffer = this.buffer.concat(toMove, new Array(minSize - this.size));
this.writePtr = this.size;
} else {
this.buffer = this.buffer.concat(toMove);
this.writePtr = 0;
}
this.size = this.buffer.length;
}
};
/******************************************************************************/
LogBuffer.prototype.readAll = function() {
var out;
if ( this.buffer === null ) {
this.start();
out = [];
} else if ( this.readPtr < this.writePtr ) {
out = this.buffer.slice(this.readPtr, this.writePtr);
} else if ( this.writePtr < this.readPtr ) {
out = this.buffer.slice(this.readPtr).concat(this.buffer.slice(0, this.writePtr));
} else {
out = [];
}
this.readPtr = this.writePtr;
this.lastReadTime = Date.now();
return out;
};
/******************************************************************************/
var logBufferJanitor = function() {
var logBuffer;
var obsolete = Date.now() - logBufferObsoleteAfter;
var i = liveLogBuffers.length;
while ( i-- ) {
logBuffer = liveLogBuffers[i];
if ( logBuffer.lastReadTime < obsolete ) {
logBuffer.stop();
liveLogBuffers.splice(i, 1);
}
}
setTimeout(logBufferJanitor, logBufferJanitorPeriod);
};
// The janitor will look for stale log buffer every 2 minutes.
var logBufferJanitorPeriod = 2 * 60 * 1000;
// After 30 seconds without being read, a buffer will be considered unused, and
// thus removed from memory.
var logBufferObsoleteAfter = 30 * 1000;
setTimeout(logBufferJanitor, logBufferJanitorPeriod);
/******************************************************************************/
/******************************************************************************/
// To mitigate memory churning // To mitigate memory churning
var netFilteringResultCacheEntryJunkyard = []; var netFilteringResultCacheEntryJunkyard = [];
var netFilteringResultCacheEntryJunkyardMax = 200; var netFilteringResultCacheEntryJunkyardMax = 200;
@ -483,12 +311,6 @@ PageStore.prototype.init = function(tabId) {
.matchStringExactType(context, tabContext.normalURL, 'cosmetic-filtering') .matchStringExactType(context, tabContext.normalURL, 'cosmetic-filtering')
.charAt(1) === 'b'; .charAt(1) === 'b';
// Preserve old buffer if there is one already, it may be in use, and
// overwritting it would required another read to restart it.
if ( this.logBuffer instanceof LogBuffer === false ) {
this.logBuffer = logBufferFactory();
}
return this; return this;
}; };
@ -538,7 +360,6 @@ PageStore.prototype.dispose = function() {
this.hostnameToCountMap = null; this.hostnameToCountMap = null;
this.disposeFrameStores(); this.disposeFrameStores();
this.netFilteringCache = this.netFilteringCache.dispose(); this.netFilteringCache = this.netFilteringCache.dispose();
this.logBuffer = this.logBuffer.dispose();
if ( pageStoreJunkyard.length < pageStoreJunkyardMax ) { if ( pageStoreJunkyard.length < pageStoreJunkyardMax ) {
pageStoreJunkyard.push(this); pageStoreJunkyard.push(this);
} }
@ -703,7 +524,6 @@ PageStore.prototype.filterRequest = function(context) {
return result; return result;
}; };
// Cache only what is worth it if logging is disabled
// http://jsperf.com/string-indexof-vs-object // http://jsperf.com/string-indexof-vs-object
var collapsibleRequestTypes = 'image sub_frame object'; var collapsibleRequestTypes = 'image sub_frame object';
@ -766,7 +586,6 @@ PageStore.prototype.logRequest = function(context, result) {
µb.localSettings.blockedRequestCount++; µb.localSettings.blockedRequestCount++;
} }
µb.localSettingsModifyTime = now; µb.localSettingsModifyTime = now;
this.logBuffer.writeOne(context, result);
}; };
/******************************************************************************/ /******************************************************************************/

View File

@ -470,6 +470,7 @@ vAPI.tabs.onPopup = function(details) {
if ( pageStore ) { if ( pageStore ) {
pageStore.logRequest(context, result); pageStore.logRequest(context, result);
} }
µb.logger.writeOne(details.openerTabId, context, result);
// Not blocked // Not blocked
if ( µb.isAllowResult(result) ) { if ( µb.isAllowResult(result) ) {

View File

@ -92,6 +92,7 @@ var onBeforeRequest = function(details) {
// Possible outcomes: blocked, allowed-passthru, allowed-mirror // Possible outcomes: blocked, allowed-passthru, allowed-mirror
pageStore.logRequest(requestContext, result); pageStore.logRequest(requestContext, result);
µb.logger.writeOne(tabId, requestContext, result);
// Not blocked // Not blocked
if ( µb.isAllowResult(result) ) { if ( µb.isAllowResult(result) ) {
@ -152,7 +153,7 @@ var onBeforeRootFrameRequest = function(details) {
if ( pageStore ) { if ( pageStore ) {
pageStore.logRequest(context, result); pageStore.logRequest(context, result);
} }
return; µb.logger.writeOne(tabId, context, result);
}; };
/******************************************************************************/ /******************************************************************************/
@ -225,6 +226,7 @@ var onBeforeBehindTheSceneRequest = function(details) {
} }
pageStore.logRequest(context, result); pageStore.logRequest(context, result);
µb.logger.writeOne(vAPI.noTabId, context, result);
// Not blocked // Not blocked
if ( µb.isAllowResult(result) ) { if ( µb.isAllowResult(result) ) {
@ -272,6 +274,7 @@ var onHeadersReceived = function(details) {
var result = pageStore.filterRequestNoCache(context); var result = pageStore.filterRequestNoCache(context);
pageStore.logRequest(context, result); pageStore.logRequest(context, result);
µb.logger.writeOne(tabId, context, result);
// Don't block // Don't block
if ( µb.isAllowResult(result) ) { if ( µb.isAllowResult(result) ) {
@ -318,6 +321,7 @@ var onRootFrameHeadersReceived = function(details) {
var result = pageStore.filterRequest(context); var result = pageStore.filterRequest(context);
pageStore.logRequest(context, result); pageStore.logRequest(context, result);
µb.logger.writeOne(tabId, context, result);
// Don't block // Don't block
if ( µb.isAllowResult(result) ) { if ( µb.isAllowResult(result) ) {

View File

@ -318,4 +318,27 @@ var matchWhitelistDirective = function(url, hostname, directive) {
/******************************************************************************/ /******************************************************************************/
µBlock.logCosmeticFilters = (function() {
var tabIdToTimerMap = {};
var injectNow = function(tabId) {
delete tabIdToTimerMap[tabId];
vAPI.tabs.injectScript(tabId, { file: 'js/cosmetic-logger.js' });
};
var injectAsync = function(tabId) {
if ( tabIdToTimerMap.hasOwnProperty(tabId) ) {
return;
}
tabIdToTimerMap[tabId] = setTimeout(
injectNow.bind(null, tabId),
100
);
};
return injectAsync;
})();
/******************************************************************************/
})(); })();