diff options
Diffstat (limited to 'js/abp-hide-filters.js')
| -rw-r--r-- | js/abp-hide-filters.js | 681 |
1 files changed, 681 insertions, 0 deletions
diff --git a/js/abp-hide-filters.js b/js/abp-hide-filters.js new file mode 100644 index 0000000..3f4bfdd --- /dev/null +++ b/js/abp-hide-filters.js @@ -0,0 +1,681 @@ +/******************************************************************************* + + µBlock - a Chromium browser extension to block requests. + Copyright (C) 2014 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 +*/ + +/* jshint bitwise: false */ +/* global µBlock */ + +/******************************************************************************/ + +µBlock.abpHideFilters = (function(){ + + +/******************************************************************************/ + +var µb = µBlock; +var pageHostname = ''; +//var filterTestCount = 0; +//var bucketTestCount = 0; + +/******************************************************************************/ +/* +var histogram = function(label, buckets) { + var h = [], + bucket; + for ( var k in buckets ) { + if ( buckets.hasOwnProperty(k) === false ) { + continue; + } + bucket = buckets[k]; + h.push({ + k: k, + n: bucket instanceof FilterBucket ? bucket.filters.length : 1 + }); + } + + console.log('Histogram %s', label); + + var total = h.length; + h.sort(function(a, b) { return b.n - a.n; }); + + // Find indices of entries of interest + var target = 3; + for ( var i = 0; i < total; i++ ) { + if ( h[i].n === target ) { + console.log('\tEntries with only %d filter(s) start at index %s (key = "%s")', target, i, h[i].k); + target -= 1; + } + } + + h = h.slice(0, 50); + + h.forEach(function(v) { + console.log('\tkey="%s" count=%d', v.k, v.n); + }); + console.log('\tTotal buckets count: %d', total); +}; +*/ +/******************************************************************************/ + +// Pure id- and class-based filters +// Examples: +// #A9AdsMiddleBoxTop +// .AD-POST + +var FilterPlain = function(s) { + this.s = s; +}; + +FilterPlain.prototype.retrieve = function(s, out) { + if ( s === this.s ) { + out.push(this.s); + } +}; + +/******************************************************************************/ + +// Id- and class-based filters with extra selector stuff following. +// Examples: +// #center_col > div[style="font-size:14px;margin-right:0;min-height:5px"] ... +// #adframe:not(frameset) +// .l-container > #fishtank + +var FilterPlainMore = function(s) { + this.s = s; +}; + +FilterPlainMore.prototype.retrieve = function(s, out) { + if ( s === this.s.slice(0, s.length) ) { + out.push(this.s); + } +}; + +/******************************************************************************/ + +// Any selector specific to a hostname +// Examples: +// search.snapdo.com###ABottomD +// facebook.com##.-cx-PRIVATE-fbAdUnit__root +// sltrib.com###BLContainer + div[style="height:90px;"] +// myps3.com.au##.Boxer[style="height: 250px;"] +// lindaikeji.blogspot.com##a > img[height="600"] +// japantimes.co.jp##table[align="right"][width="250"] +// mobilephonetalk.com##[align="center"] > b > a[href^="http://tinyurl.com/"] + +var FilterHostname = function(s, hostname) { + this.s = s; + this.hostname = hostname; +}; + +FilterHostname.prototype.retrieve = function(s, out) { + if ( pageHostname.slice(-this.hostname.length) === this.hostname ) { + out.push(this.s); + } +}; + +/******************************************************************************/ +/******************************************************************************/ + +// TODO: evaluate the gain (if any) from avoiding the use of an array for when +// there are only two filters (or three, etc.). I suppose there is a specific +// number of filters below which using an array is more of an overhead than +// using a couple of property members. +// i.e. FilterBucket2, FilterBucket3, FilterBucketN. + +var FilterBucket = function(a, b) { + this.filters = [a, b]; +}; + +FilterBucket.prototype.add = function(a) { + this.filters.push(a); +}; + +FilterBucket.prototype.retrieve = function(s, out) { + var i = this.filters.length; + //filterTestCount += i - 1; + while ( i-- ) { + this.filters[i].retrieve(s, out); + } +}; + +/******************************************************************************/ +/******************************************************************************/ + +var FilterParser = function() { + this.s = ''; + this.prefix = ''; + this.suffix = ''; + this.anchor = 0; + this.filterType = '#'; + this.hostnames = []; + this.invalid = false; + this.unsupported = false; + this.reParser = /^\s*([^#]*)(##|#@#)(.+)\s*$/; + this.rePlain = /^([#.][\w-]+)/; + this.rePlainMore = /^[#.][\w-]+[^\w-]/; + this.reElement = /^[a-z]/i; +}; + +/******************************************************************************/ + +FilterParser.prototype.reset = function() { + this.s = ''; + this.prefix = ''; + this.suffix = ''; + this.anchor = ''; + this.filterType = '#'; + this.hostnames = []; + this.invalid = false; + return this; +}; + +/******************************************************************************/ + +FilterParser.prototype.parse = function(s) { + // important! + this.reset(); + + var matches = this.reParser.exec(s); + if ( matches === null || matches.length !== 4 ) { + this.invalid = true; + return this; + } + + // Remember original string + this.s = s; + this.prefix = matches[1]; + this.anchor = matches[2]; + this.suffix = matches[3]; + + // 2014-05-23: + // https://github.com/gorhill/httpswitchboard/issues/260 + // Any sequence of `#` longer than one means the line is not a valid + // cosmetic filter. + if ( this.suffix.indexOf('##') >= 0 ) { + this.invalid = true; + return this; + } + + this.filterType = this.anchor.charAt(1); + if ( this.prefix !== '' ) { + this.hostnames = this.prefix.split(/\s*,\s*/); + } + return this; +}; + +/******************************************************************************/ + +FilterParser.prototype.isPlainMore = function() { + return this.rePlainMore.test(this.suffix); +}; + +/******************************************************************************/ + +FilterParser.prototype.isElement = function() { + return this.reElement.test(this.suffix); +}; + +/******************************************************************************/ + +FilterParser.prototype.extractPlain = function() { + var matches = this.rePlain.exec(this.suffix); + if ( matches && matches.length === 2 ) { + return matches[1]; + } + return ''; +}; + +/******************************************************************************/ +/******************************************************************************/ + +var FilterContainer = function() { + this.filterParser = new FilterParser(); + this.acceptedCount = 0; + this.processedCount = 0; + this.filters = {}; + this.hideUnfiltered = []; + this.donthideUnfiltered = []; + this.rejected = []; +}; + +/******************************************************************************/ + +// Reset all, thus reducing to a minimum memory footprint of the context. + +FilterContainer.prototype.reset = function() { + this.filterParser.reset(); + this.acceptedCount = 0; + this.processedCount = 0; + this.filters = {}; + this.hideUnfiltered = []; + this.donthideUnfiltered = []; + this.rejected = []; +}; + +/******************************************************************************/ + +FilterContainer.prototype.add = function(s) { + var parsed = this.filterParser.parse(s); + if ( parsed.invalid ) { + return false; + } + + this.processedCount += 1; + + //if ( s === 'mail.google.com##.nH.adC > .nH > .nH > .u5 > .azN' ) { + // debugger; + //} + + // hostname-based filters: with a hostname, narrowing is good enough, no + // need to further narrow. + if ( parsed.hostnames.length ) { + return this.addHostnameFilter(parsed); + } + + // no specific hostname, narrow using class or id. + var selectorType = parsed.suffix.charAt(0); + if ( selectorType === '#' || selectorType === '.' ) { + return this.addPlainFilter(parsed); + } + + // no specific hostname, no class, no id. + // TO IMPLEMENT + // My idea of implementation so far is to return a pre-built container + // of these very generic filter, and let the content script sort out + // what it needs from it. Filters in that category are mostly + // `a[href^="..."]` kind of filters. + // Content script side, the unsorted container of selectors could be used + // in a querySelectorAll() to figure which rules apply (if any), or they + // could just all be injected undiscriminately (not good). + if ( parsed.filterType === '#' ) { + this.hideUnfiltered.push(parsed.suffix); + } else { + this.donthideUnfiltered.push(parsed.suffix); + } + this.acceptedCount += 1; + + return true; +}; + +/******************************************************************************/ + +FilterContainer.prototype.chunkify = function(selectors) { + var chunkified = [], chunk; + for (;;) { + chunk = selectors.splice(0, 10); + if ( chunk.length === 0 ) { + break; + } + chunkified.push(chunk.join(',')); + } + return chunkified; +}; + +/******************************************************************************/ + +FilterContainer.prototype.freeze = function() { + this.hideUnfiltered = this.chunkify(this.hideUnfiltered); + this.donthideUnfiltered = this.chunkify(this.donthideUnfiltered); + + this.filterParser.reset(); + + //console.log('µBlock> adp-hide-filters.js: %d filters accepted', this.acceptedCount); + //console.log('µBlock> adp-hide-filters.js: %d filters processed', this.processedCount); + //console.log('µBlock> adp-hide-filters.js: coverage is %s%', (this.acceptedCount * 100 / this.processedCount).toFixed(1)); + //console.log('µBlock> adp-hide-filters.js: unfiltered hide selectors:', this.hideUnfiltered); + //console.log('µBlock> adp-hide-filters.js: unfiltered dont hide selectors:', this.donthideUnfiltered); + //console.log('µBlock> adp-hide-filters.js: rejected selectors:', this.rejected); + + // histogram('allFilters', this.filters); +}; + +/******************************************************************************/ + +// Is +// 3 unicode chars +// | | | | +// +// 00000000 TTTTTTTT PP PP PP PP PP PP PP PP SS SS SS SS SS SS SS SS +// | | | +// | | | +// | | | +// | | ls 2-bit of 8 suffix chars +// | | +// | +-- ls 2-bit of 8 prefix chars +// | +// | +// +-- filter type ('#'=hide '@'=unhide) +// + +var makePrefixHash = function(type, prefix) { + // Ref: Given a URL, returns a unique 4-character long hash string + // Based on: FNV32a + // http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source + // The rest is custom, suited for µBlock. + var len = prefix.length; + var i2 = len >> 1; + var i4 = len >> 2; + var i8 = len >> 3; + var hint = (0x811c9dc5 ^ prefix.charCodeAt(0)) >>> 0; + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i4); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i4+i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i2); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i2+i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(i2+i4); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= prefix.charCodeAt(len-1); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + return String.fromCharCode(type.charCodeAt(0), hint & 0xFFFF, 0); +}; + +var makeSuffixHash = function(type, suffix) { + var len = suffix.length; + var i2 = len >> 1; + var i4 = len >> 2; + var i8 = len >> 3; + var hint = (0x811c9dc5 ^ suffix.charCodeAt(0)) >>> 0; + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i4); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i4+i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i2); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i2+i8); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(i2+i4); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + hint ^= suffix.charCodeAt(len-1); + hint += (hint<<1) + (hint<<4) + (hint<<7) + (hint<<8) + (hint<<24); + hint >>>= 0; + return String.fromCharCode(type.charCodeAt(0), 0, hint & 0x0FFF); +}; + +/** +Histogram for above hash generator: + +Histogram allFilters + Entries with only 3 filter(s) start at index 2706 (key = "#ꍵ") + Entries with only 2 filter(s) start at index 4349 (key = "#냶") + Entries with only 1 filter(s) start at index 6896 (key = "#퀛") + key="#싣" count=141 + key="#隁" count=57 + key="#Ꚇ" count=48 + key="#" count=45 + key="#캃" count=36 + key="#력" count=33 + key="#끻" count=30 + key="#ｕ" count=26 + key="#" count=25 + key="#Ꮳ" count=24 + key="#鵲" count=23 + key="#䙇" count=20 + key="#ḇ" count=19 + key="#睅" count=19 + key="#㔽" count=19 + key="#뻧" count=18 + key="#䕀" count=18 + key="#퉫" count=17 + key="#筙" count=17 + key="#㮰" count=17 + key="#鯛" count=16 + key="#" count=16 + key="#꣱" count=16 + key="#ü" count=16 + key="#告" count=16 + key="#╡" count=16 + key="#㰁" count=16 + key="#৹" count=16 + key="#镳" count=15 + key="#碇" count=15 + key="#৾" count=15 + key="#貿" count=15 + key="#š" count=15 + key="#" count=15 + key="#" count=14 + key="#ຏ" count=14 + key="#낶" count=14 + key="#瑻" count=14 + key="#ৡ" count=14 + key="#" count=13 + key="#ᯋ" count=13 + key="#⼒" count=13 + key="#腫" count=13 + key="#겚" count=13 + key="#耏" count=13 + key="#匋" count=13 + key="#튦" count=13 + key="#ﰹ" count=13 + key="#㭴" count=13 + key="#" count=13 + Total buckets count: 12098 +*/ + +/******************************************************************************/ + +FilterContainer.prototype.addPlainFilter = function(parsed) { + // Verify whether the plain selector is followed by extra selector stuff + if ( parsed.isPlainMore() ) { + return this.addPlainMoreFilter(parsed); + } + var f = new FilterPlain(parsed.suffix); + var hash = makeSuffixHash(parsed.filterType, parsed.suffix); + this.addFilterEntry(hash, f); + this.acceptedCount += 1; +}; + +/******************************************************************************/ + +FilterContainer.prototype.addPlainMoreFilter = function(parsed) { + var selectorSuffix = parsed.extractPlain(); + if ( selectorSuffix === '' ) { + return; + } + var f = new FilterPlainMore(parsed.suffix); + var hash = makeSuffixHash(parsed.filterType, selectorSuffix); + this.addFilterEntry(hash, f); + this.acceptedCount += 1; +}; + +/******************************************************************************/ + +// rhill 2014-05-20: When a domain exists, just specify a generic selector. + +FilterContainer.prototype.addHostnameFilter = function(parsed) { + var µburi = µBlock.URI; + var f, hash; + var hostnames = parsed.hostnames; + var i = hostnames.length, hostname; + while ( i-- ) { + hostname = hostnames[i]; + if ( !hostname ) { + continue; + } + f = new FilterHostname(parsed.suffix, hostname); + hash = makePrefixHash(parsed.filterType, µburi.domainFromHostname(hostname)); + this.addFilterEntry(hash, f); + } + this.acceptedCount += 1; +}; + +/******************************************************************************/ + +FilterContainer.prototype.addFilterEntry = function(hash, f) { + var bucket = this.filters[hash]; + if ( bucket === undefined ) { + this.filters[hash] = f; + } else if ( bucket instanceof FilterBucket ) { + bucket.add(f); + } else { + this.filters[hash] = new FilterBucket(bucket, f); + } +}; + +/******************************************************************************/ + +FilterContainer.prototype.retrieveGenericSelectors = function(request) { + if ( µb.userSettings.parseAllABPHideFilters !== true ) { + return; + } + + if ( !request.selectors ) { + return; + } + + //quickProfiler.start('FilterContainer.retrieve()'); + + //filterTestCount = 0; + //bucketTestCount = 0; + + var r = { + hide: [], + donthide: [], + hideUnfiltered: [], + donthideUnfiltered: [] + }; + + var hash, bucket; + var hideSelectors = r.hide; + var selectors = request.selectors; + var i = selectors.length; + var selector; + while ( i-- ) { + selector = selectors[i]; + if ( !selector ) { + continue; + } + hash = makeSuffixHash('#', selector); + if ( bucket = this.filters[hash] ) { + //bucketTestCount += 1; + //filterTestCount += 1; + bucket.retrieve(selector, hideSelectors); + } + } + + r.hideUnfiltered = this.hideUnfiltered; + r.donthideUnfiltered = this.donthideUnfiltered; + + //quickProfiler.stop(); + +/* + console.log( + 'µBlock> abp-hide-filters.js: "%s"\n\t%d selectors in => %d/%d filters/buckets tested => %d selectors out', + url, + inSelectors.length, + //filterTestCount, + //bucketTestCount, + hideSelectors.length + donthideSelectors.length + ); +*/ + + return r; +}; + +/******************************************************************************/ + +FilterContainer.prototype.retrieveDomainSelectors = function(request) { + if ( µb.userSettings.parseAllABPHideFilters !== true ) { + return; + } + + if ( !request.locationURL ) { + return; + } + + //quickProfiler.start('FilterContainer.retrieve()'); + + //filterTestCount = 0; + //bucketTestCount = 0; + + var hostname = pageHostname = µb.URI.hostnameFromURI(request.locationURL); + var r = { + domain: µb.URI.domainFromHostname(hostname), + hide: [], + donthide: [] + }; + var bucket; + var hash = makePrefixHash('#', r.domain); + if ( bucket = this.filters[hash] ) { + //bucketTestCount += 1; + //filterTestCount += 1; + bucket.retrieve(null, r.hide); + } + hash = makePrefixHash('@', r.domain); + if ( bucket = this.filters[hash] ) { + //bucketTestCount += 1; + //filterTestCount += 1; + bucket.retrieve(null, r.donthide); + } + + //quickProfiler.stop(); + +/* + console.log( + 'µBlock> abp-hide-filters.js: "%s"\n\t%d selectors in => %d/%d filters/buckets tested => %d selectors out', + url, + inSelectors.length, + //filterTestCount, + //bucketTestCount, + hideSelectors.length + donthideSelectors.length + ); +*/ + + return r; +}; + +/******************************************************************************/ + +FilterContainer.prototype.getFilterCount = function() { + return this.acceptedCount; +}; + +/******************************************************************************/ + +return new FilterContainer(); + +/******************************************************************************/ + +})(); + +/******************************************************************************/ |