From 475a6b9e9ab5a47f8ea15c5b7e17f38d596b51a4 Mon Sep 17 00:00:00 2001 From: hackademix Date: Tue, 18 Sep 2018 23:43:28 +0200 Subject: Initial refactoring and unhiding of contact finder / complaint UI. --- contact_finder.js | 297 -------------------------- content/contactFinder.css | 56 +++++ content/contactFinder.js | 297 ++++++++++++++++++++++++++ html/display_panel/content/panel-styles.css | 6 - html/preferences_panel/preferences_panel.html | 10 +- html/preferences_panel/prefs.css | 4 - main_background.js | 38 +++- 7 files changed, 386 insertions(+), 322 deletions(-) delete mode 100644 contact_finder.js create mode 100644 content/contactFinder.css create mode 100644 content/contactFinder.js diff --git a/contact_finder.js b/contact_finder.js deleted file mode 100644 index 48f9c27..0000000 --- a/contact_finder.js +++ /dev/null @@ -1,297 +0,0 @@ -/** -* GNU LibreJS - A browser add-on to block nonfree nontrivial JavaScript. -* * -* Copyright (C) 2017 Nathan Nichols, Loic J. Duros, Nik Nyby -* -* This file is part of GNU LibreJS. -* -* GNU LibreJS 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. -* -* GNU LibreJS 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 GNU LibreJS. If not, see . -*/ - -// TO TEST THE CONTACT FINDER: -// - open the manifest.json -// - add a comma after the closing bracket of the key "background" -// - Copy and paste this after it: -/* - "content_scripts": [{"matches": [""],"js": ["contact_finder.js"]}] -*/ -// Now, the contact finder will load on every page and you can test it where ever you want. - - -//********************************************************************************************* -//Regexes taken from "contact_regex.js" in the current LibreJS -//Copyright (C) 2011, 2012, 2014 Loic J. Duros -//Copyright (C) 2014, 2015 Nik Nyby - -console.log("contact_finder.js"); - -// email address regexp -var reEmail = /^mailto\:(admin|feedback|webmaster|info|contact|support|comments|team|help)\@[a-z0-9.\-]+\.[a-z]{2,4}$/i; - -var reAnyEmail = /^mailto\:.*?\@[a-z0-9\.\-]+\.[a-z]{2,4}$/i; - -// twitter address regexp -var reTwitter = /twitter\.com\/(\!?#\/)?[a-z0-9]*/i; - -// identi.ca address regexp -var reIdentiCa = /identi\.ca\/(?!notice\/)[a-z0-9]*/i; - -/** - * contactSearchStrings - * Contains arrays of strings classified by language - * and by degree of certainty. - */ -var contactStr = { - 'da': { - 'certain': [ - '^[\\s]*Kontakt os[\\s]*$', - '^[\\s]*Email Os[\\s]*$', - '^[\\s]*Kontakt[\\s]*$' - ], - 'probable': ['^[\\s]Kontakt', '^[\\s]*Email'], - 'uncertain': [ - '^[\\s]*Om Us', - '^[\\s]*Om', - 'Hvem vi er' - ] - }, - 'en': { - 'certain': [ - '^[\\s]*Contact Us[\\s]*$', - '^[\\s]*Email Us[\\s]*$', - '^[\\s]*Contact[\\s]*$', - '^[\\s]*Feedback[\\s]*$', - '^[\\s]*Web.?site Feedback[\\s]*$' - ], - 'probable': ['^[\\s]Contact', '^[\\s]*Email'], - 'uncertain': [ - '^[\\s]*About Us', - '^[\\s]*About', - 'Who we are', - 'Who I am', - 'Company Info', - 'Customer Service' - ] - }, - 'es': { - 'certain': [ - '^[\\s]*contáctenos[\\s]*$', - '^[\\s]*Email[\\s]*$' - ], - 'probable': ['^[\\s]contáctenos', '^[\\s]*Email'], - 'uncertain': [ - 'Acerca de nosotros' - ] - }, - 'fr': { - 'certain': [ - '^[\\s]*Contactez nous[\\s]*$', - '^[\\s]*(Nous )?contacter[\\s]*$', - '^[\\s]*Email[\\s]*$', - '^[\\s]*Contact[\\s]*$', - '^[\\s]*Commentaires[\\s]*$' - ], - 'probable': ['^[\\s]Contact', '^[\\s]*Email'], - 'uncertain': [ - '^[\\s]*(A|À) propos', - 'Qui nous sommes', - 'Qui suis(-| )?je', - 'Info', - 'Service Client(e|è)le' - ] - } -}; - -var usaPhoneNumber = new RegExp(/(?:\+ ?1 ?)?\(?[2-9]{1}[0-9]{2}\)?(?:\-|\.| )?[0-9]{3}(?:\-|\.| )[0-9]{4}(?:[^0-9])/mg); -// Taken from http://emailregex.com/ -var email_regex = new RegExp(/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/g); -//********************************************************************************************* - -var prefs; - -/** -* -* Creates a transparent floating button from a name string and a callback -* -* -*/ -function new_debug_button(name_text,callback){ - if(document.getElementById("abc123_main_div") !== null){ - document.getElementById("abc123_main_div").remove(); - } - console.log("adding button"); - if(document.getElementById("abc123_main_div") === null){ - var to_insert = '
'; - document.body.insertAdjacentHTML('afterbegin', to_insert); - } - var button_html = '
'; - document.getElementById("abc123_main_div").insertAdjacentHTML('afterbegin', button_html); document.getElementById("abc123_button_complain").addEventListener("click",callback); - -} -/** -* returns input with all elements not of type string removed -*/ -function remove_not_str(a){ - var new_a = []; - for(var i in a){ - if(typeof(a[i]) == "string"){ - new_a.push(a[i]) - } - } - return new_a; -} -/** -* Tests all links on the page for regexes under a certain certainty level. -* -* Will return either the first regex match from the selected certainty level or all regexes that -* match on that certainty level. -* -* certainty_lvl can be "certain" > "probable" > "uncertain" -*/ -function attempt(certainty_lvl, first=true){ - // There needs to be some kind of max so that people can't troll by for example leaving a comment with a bunch of emails - // to cause LibreJS users to slow down. - var fail_flag = true; - var flag; - var matches = []; - var result = []; - var str_under_test = ""; - for(var i in document.links){ - if( typeof(document.links[i].innerText) != "string" || typeof(document.links[i].href) != "string"){ - continue; - } - str_under_test = document.links[i].innerText + " " + document.links[i].href; - flag = true; - for(var j in contactStr){ - for(var k in contactStr[j][certainty_lvl]){ - if(flag){ - result = []; - result = str_under_test.match(new RegExp(contactStr[j][certainty_lvl][k],"g")); - result = remove_not_str(result); - if(result !== undefined && typeof(result[0]) == "string" ){ - if(first){ - return {"fail":false,"result":document.links[i]}; - } else{ - //console.log(document.links[i].href + " matched " + contactStr[j][certainty_lvl][k]); - matches.push(document.links[i]); - fail_flag = false; - flag = false; - } - } - } - } - } - } - return {"fail":fail_flag,"result":matches}; -} - -/** -* "LibreJS detects contact pages, email addresses that are likely to be owned by the -* maintainer of the site, Twitter and identi.ca links, and phone numbers." -*/ -function find_contacts(){ - var all = document.documentElement.innerText; - var phone_num = []; - var twitlinks = []; - var identi = []; - var contact_pages = []; - var res = attempt("certain"); - var flag = true; - var type = ""; - if(res["fail"] == false){ - type = "certain"; - res = res["result"]; - flag = false; - } - if(flag){ - res = attempt("probable"); - if(res["fail"] == false){ - type = "probable"; - res = res["result"]; - flag = false; - } - } - if(flag){ - res = attempt("uncertain"); - if(res["fail"] == false){ - type = "uncertain"; - res = res["result"]; - flag = false; - } - } - if(flag){ - return res; - } - return [type,res]; -} -// need to have this so the handler doesn't take too long -function handler(){ - var res = find_contacts(); - if(document.getElementById("librejs_contactfinder") != null){ - document.getElementById("librejs_contactfinder").remove(); - } - var to_insert; - if("fail" in res){ - to_insert = '
'+ - "Contact finder failed."; - } else{ - if(typeof(res[1]) == "string"){ - to_insert = ''; - - setTimeout(function(){document.getElementById("librejs_contactfinder").remove()}, 7500); - document.body.insertAdjacentHTML("afterbegin",to_insert); - return 0; - -} - -function main(){ - new_debug_button("Complain to website",handler); -} - -var myPort = browser.runtime.connect({name:"contact_finder"}); - -myPort.onMessage.addListener(function(m) { - prefs = m; - main(); -}); diff --git a/content/contactFinder.css b/content/contactFinder.css new file mode 100644 index 0000000..e9ce93e --- /dev/null +++ b/content/contactFinder.css @@ -0,0 +1,56 @@ +#_LibreJS_CF_panel { + opacity: 0.8 !important; + font-family: sans-serif !important; + font-size: 1.2em !important; + color: #000 !important; + z-index: 2147483647 !important; + background-color: #eee !important; + position: fixed !important; + display:inline-block !important; + border: 2px solid #444 !important; + text-align: center !important; + width: 50% !important; + top: 25% !important; + bottom: 25% !important; + left: 25% !important; + right: 25% !important; + transition: width .5s !important; +} +#_LibreJS_CF_panel:hover { + opacity: 1 !important; +} +#_LibreJS_CF_panel h3, #LibreJS_CF_panel h4, #LibreJS_CF_panel h5 { + font-family: sans-serif !important; + color: #000 !important; + background: transparent !important; + font-weight: bold !important; + text-align: center !important; + border: none !important; + padding: 0 !important; + margin: .8em !important; +} + +#_libreJS_CF_panel a { + text-decoration: none !important; + color: #840 !important; + border: none !important; +} + +#_libreJS_CF_panel a:hover { + text-decoration: none !important; + color: #c60 !important; + border-bottom: 1px solid #840 !important; +} + + +#_LibreJS_CF_panel h3 { + font-size: 2em !important; +} + +#_LibreJS_CF_panel h4 { + font-size: 1.8em !important; +} + +#_LibreJS_CF_panel h5 { + font-size: 1.5em !important; +} diff --git a/content/contactFinder.js b/content/contactFinder.js new file mode 100644 index 0000000..48f9c27 --- /dev/null +++ b/content/contactFinder.js @@ -0,0 +1,297 @@ +/** +* GNU LibreJS - A browser add-on to block nonfree nontrivial JavaScript. +* * +* Copyright (C) 2017 Nathan Nichols, Loic J. Duros, Nik Nyby +* +* This file is part of GNU LibreJS. +* +* GNU LibreJS 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. +* +* GNU LibreJS 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 GNU LibreJS. If not, see . +*/ + +// TO TEST THE CONTACT FINDER: +// - open the manifest.json +// - add a comma after the closing bracket of the key "background" +// - Copy and paste this after it: +/* + "content_scripts": [{"matches": [""],"js": ["contact_finder.js"]}] +*/ +// Now, the contact finder will load on every page and you can test it where ever you want. + + +//********************************************************************************************* +//Regexes taken from "contact_regex.js" in the current LibreJS +//Copyright (C) 2011, 2012, 2014 Loic J. Duros +//Copyright (C) 2014, 2015 Nik Nyby + +console.log("contact_finder.js"); + +// email address regexp +var reEmail = /^mailto\:(admin|feedback|webmaster|info|contact|support|comments|team|help)\@[a-z0-9.\-]+\.[a-z]{2,4}$/i; + +var reAnyEmail = /^mailto\:.*?\@[a-z0-9\.\-]+\.[a-z]{2,4}$/i; + +// twitter address regexp +var reTwitter = /twitter\.com\/(\!?#\/)?[a-z0-9]*/i; + +// identi.ca address regexp +var reIdentiCa = /identi\.ca\/(?!notice\/)[a-z0-9]*/i; + +/** + * contactSearchStrings + * Contains arrays of strings classified by language + * and by degree of certainty. + */ +var contactStr = { + 'da': { + 'certain': [ + '^[\\s]*Kontakt os[\\s]*$', + '^[\\s]*Email Os[\\s]*$', + '^[\\s]*Kontakt[\\s]*$' + ], + 'probable': ['^[\\s]Kontakt', '^[\\s]*Email'], + 'uncertain': [ + '^[\\s]*Om Us', + '^[\\s]*Om', + 'Hvem vi er' + ] + }, + 'en': { + 'certain': [ + '^[\\s]*Contact Us[\\s]*$', + '^[\\s]*Email Us[\\s]*$', + '^[\\s]*Contact[\\s]*$', + '^[\\s]*Feedback[\\s]*$', + '^[\\s]*Web.?site Feedback[\\s]*$' + ], + 'probable': ['^[\\s]Contact', '^[\\s]*Email'], + 'uncertain': [ + '^[\\s]*About Us', + '^[\\s]*About', + 'Who we are', + 'Who I am', + 'Company Info', + 'Customer Service' + ] + }, + 'es': { + 'certain': [ + '^[\\s]*contáctenos[\\s]*$', + '^[\\s]*Email[\\s]*$' + ], + 'probable': ['^[\\s]contáctenos', '^[\\s]*Email'], + 'uncertain': [ + 'Acerca de nosotros' + ] + }, + 'fr': { + 'certain': [ + '^[\\s]*Contactez nous[\\s]*$', + '^[\\s]*(Nous )?contacter[\\s]*$', + '^[\\s]*Email[\\s]*$', + '^[\\s]*Contact[\\s]*$', + '^[\\s]*Commentaires[\\s]*$' + ], + 'probable': ['^[\\s]Contact', '^[\\s]*Email'], + 'uncertain': [ + '^[\\s]*(A|À) propos', + 'Qui nous sommes', + 'Qui suis(-| )?je', + 'Info', + 'Service Client(e|è)le' + ] + } +}; + +var usaPhoneNumber = new RegExp(/(?:\+ ?1 ?)?\(?[2-9]{1}[0-9]{2}\)?(?:\-|\.| )?[0-9]{3}(?:\-|\.| )[0-9]{4}(?:[^0-9])/mg); +// Taken from http://emailregex.com/ +var email_regex = new RegExp(/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/g); +//********************************************************************************************* + +var prefs; + +/** +* +* Creates a transparent floating button from a name string and a callback +* +* +*/ +function new_debug_button(name_text,callback){ + if(document.getElementById("abc123_main_div") !== null){ + document.getElementById("abc123_main_div").remove(); + } + console.log("adding button"); + if(document.getElementById("abc123_main_div") === null){ + var to_insert = '
'; + document.body.insertAdjacentHTML('afterbegin', to_insert); + } + var button_html = '
'; + document.getElementById("abc123_main_div").insertAdjacentHTML('afterbegin', button_html); document.getElementById("abc123_button_complain").addEventListener("click",callback); + +} +/** +* returns input with all elements not of type string removed +*/ +function remove_not_str(a){ + var new_a = []; + for(var i in a){ + if(typeof(a[i]) == "string"){ + new_a.push(a[i]) + } + } + return new_a; +} +/** +* Tests all links on the page for regexes under a certain certainty level. +* +* Will return either the first regex match from the selected certainty level or all regexes that +* match on that certainty level. +* +* certainty_lvl can be "certain" > "probable" > "uncertain" +*/ +function attempt(certainty_lvl, first=true){ + // There needs to be some kind of max so that people can't troll by for example leaving a comment with a bunch of emails + // to cause LibreJS users to slow down. + var fail_flag = true; + var flag; + var matches = []; + var result = []; + var str_under_test = ""; + for(var i in document.links){ + if( typeof(document.links[i].innerText) != "string" || typeof(document.links[i].href) != "string"){ + continue; + } + str_under_test = document.links[i].innerText + " " + document.links[i].href; + flag = true; + for(var j in contactStr){ + for(var k in contactStr[j][certainty_lvl]){ + if(flag){ + result = []; + result = str_under_test.match(new RegExp(contactStr[j][certainty_lvl][k],"g")); + result = remove_not_str(result); + if(result !== undefined && typeof(result[0]) == "string" ){ + if(first){ + return {"fail":false,"result":document.links[i]}; + } else{ + //console.log(document.links[i].href + " matched " + contactStr[j][certainty_lvl][k]); + matches.push(document.links[i]); + fail_flag = false; + flag = false; + } + } + } + } + } + } + return {"fail":fail_flag,"result":matches}; +} + +/** +* "LibreJS detects contact pages, email addresses that are likely to be owned by the +* maintainer of the site, Twitter and identi.ca links, and phone numbers." +*/ +function find_contacts(){ + var all = document.documentElement.innerText; + var phone_num = []; + var twitlinks = []; + var identi = []; + var contact_pages = []; + var res = attempt("certain"); + var flag = true; + var type = ""; + if(res["fail"] == false){ + type = "certain"; + res = res["result"]; + flag = false; + } + if(flag){ + res = attempt("probable"); + if(res["fail"] == false){ + type = "probable"; + res = res["result"]; + flag = false; + } + } + if(flag){ + res = attempt("uncertain"); + if(res["fail"] == false){ + type = "uncertain"; + res = res["result"]; + flag = false; + } + } + if(flag){ + return res; + } + return [type,res]; +} +// need to have this so the handler doesn't take too long +function handler(){ + var res = find_contacts(); + if(document.getElementById("librejs_contactfinder") != null){ + document.getElementById("librejs_contactfinder").remove(); + } + var to_insert; + if("fail" in res){ + to_insert = '
'+ + "Contact finder failed."; + } else{ + if(typeof(res[1]) == "string"){ + to_insert = ''; + + setTimeout(function(){document.getElementById("librejs_contactfinder").remove()}, 7500); + document.body.insertAdjacentHTML("afterbegin",to_insert); + return 0; + +} + +function main(){ + new_debug_button("Complain to website",handler); +} + +var myPort = browser.runtime.connect({name:"contact_finder"}); + +myPort.onMessage.addListener(function(m) { + prefs = m; + main(); +}); diff --git a/html/display_panel/content/panel-styles.css b/html/display_panel/content/panel-styles.css index cbf5cf5..0d849e4 100644 --- a/html/display_panel/content/panel-styles.css +++ b/html/display_panel/content/panel-styles.css @@ -149,9 +149,3 @@ span.blocked { width: 100%; text-align: center; } - - - -#complain { - display: none; /* TODO: Complaint to owner UI */ -} diff --git a/html/preferences_panel/preferences_panel.html b/html/preferences_panel/preferences_panel.html index effb724..70d3b86 100644 --- a/html/preferences_panel/preferences_panel.html +++ b/html/preferences_panel/preferences_panel.html @@ -71,15 +71,9 @@
Complaint email defaults - + - +
diff --git a/html/preferences_panel/prefs.css b/html/preferences_panel/prefs.css index b52d6c5..3ac498e 100644 --- a/html/preferences_panel/prefs.css +++ b/html/preferences_panel/prefs.css @@ -85,7 +85,3 @@ input[type="text"] { background: #ffe; color: #800; } - -#section-complaint { - display: none; /* TODO: Complaint to owner UI */ -} diff --git a/main_background.js b/main_background.js index 5b745c1..fdd895e 100644 --- a/main_background.js +++ b/main_background.js @@ -372,7 +372,7 @@ function connected(p) { // invoke_contact_finder if(m["invoke_contact_finder"] !== undefined){ contact_finder = true; - inject_contact_finder(); + await injectContactFinder(); } // a debug feature (maybe give the user an option to do this?) if(m["deletelocalstorage"] !== undefined){ @@ -1120,11 +1120,35 @@ var listManager = new ListManager(whitelist, blacklist, .map(script => script.hash) ); + +async function initDefaults() { + let defaults = { + pref_subject: "Issues with Javascript on your website", + pref_body: `Please consider using a free license for the Javascript on your website. + +[Message generated by LibreJS. See https://www.gnu.org/software/librejs/ for more information] +` + }; + let keys = Object.keys(defaults); + let prefs = await browser.storage.local.get(keys); + let changed = false; + for (let k of keys) { + if (!(k in prefs)) { + prefs[k] = defaults[k]; + changed = true; + } + } + if (changed) { + await browser.storage.local.set(prefs); + } +} + /** * Initializes various add-on functions * only meant to be called once when the script starts */ -async function init_addon(){ +async function init_addon() { + await initDefaults(); await whitelist.load(); browser.runtime.onConnect.addListener(connected); browser.storage.onChanged.addListener(options_listener); @@ -1154,11 +1178,11 @@ async function init_addon(){ /** * Loads the contact finder on the given tab ID. */ -function inject_contact_finder(tab_id){ - function executed(result) { - dbg_print("[TABID:"+tab_id+"]"+"finished executing contact finder: " + result); - } - var executing = browser.tabs.executeScript(tab_id, {file: "/contact_finder.js"}, executed); +async function injectContactFinder(tabId){ + await Promise.all([ + browser.tabs.executeScript(tabId, {file: "/content/contactFinder.js"}), + browser.tabs.insertCSS(tabId, {file: "/content/contactFinder.css", cssOrigin: "user"}) + ]); } init_addon(); -- cgit v1.2.3