Add an updated build

.gitignore

@@ -1,14 +1,14 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
+node_modules
+.web-extension-id
+web-ext-artifacts/
+sign-firefox-extension.sh
 
 # testing
 /coverage
 
-# production
-/build
-
 # misc
 .DS_Store
 .env
@@ -17,4 +17,4 @@ yarn-debug.log*
 yarn-error.log*
 
 # WebStorm
-.idea/
+.idea/

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "rules"]
-	path = data
-	url = https://gitlab.com/anti-tracking/ClearURLs/rules.git
-	branch = master

README.md

@@ -1,106 +1,87 @@
-<a href="https://www.paypal.me/KevinRoebert" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/Paypal.png" alt="Buy Me A Coffee" height="55"></a>
+This is a fork of [ClearURLs/Addon](https://github.com/ClearURLs/Addon) with some modifications. The
-<a href="https://liberapay.com/kroeb" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/LiberaPay.png" alt="Buy Me A Coffee" height="55"></a>
+main change is moving the data/rule files to this repo instead of loading them from a gitlab page
-<a href="https://www.buymeacoffee.com/KevinRoebert" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/BuyMeACoffee.png" alt="Buy Me A Coffee" height="55"></a>
+that the original author hosts. This removes the risk of a bad actor gaining control over that URL
-
+and making changes that lead to arbitrary code execution or redirecting your browser to arbitrary
-[<img src="https://blog.mozilla.org/addons/files/2020/04/get-the-addon-fx-apr-2020.svg" alt="for Firefox" height="60px">](https://addons.mozilla.org/firefox/addon/clearurls/) [<img src="https://gitlab.com/KevinRoebert/ClearUrls/-/raw/master/promotion/MEA-button.png" alt="for Edge" height="60px">](https://microsoftedge.microsoft.com/addons/detail/mdkdmaickkfdekbjdoojfalpbkgaddei) [<img src="https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/HRs9MPufa1J1h5glNhut.png" alt="for Chrome" height="60px">](https://chrome.google.com/webstore/detail/clearurls/lckanjgmijmafbedllaakclkaicjfmnk)
+URLs.
-
+
-# <sub><img src="https://gitlab.com/KevinRoebert/ClearUrls/raw/master/img/clearurls.svg" width="64px" height="64px"></sub> ClearURLs [![Gitter](https://badges.gitter.im/ClearURLs/ClearURLs.svg)](https://gitter.im/ClearURLs/ClearURLs)
+## Install
-
+
-**ClearURLs** is an add-on based on the new WebExtensions technology and is optimized for *Firefox* and *Chrome* based browsers.
+**Firefox**
-
+* I have a signed xpi that you can immediately install. Open `build/` and drag the xpi into Firefox.
-This extension will automatically remove tracking elements from URLs to help protect your privacy when browse through the Internet, 
+  It may take a few seconds for the browser to display the extension installation dialog box.
-which is regularly updated by us and can be found [here](https://gitlab.com/anti-tracking/ClearURLs/rules/-/raw/master/data.min.json).
+* You can also find the signed Firefox files in the project's [Releases page](https://github.com/sir-pinecone/clear-urls-browser-extension/releases).
-
+
-## Application
+**Chrome**
-Many websites use tracking elements in the URL (e.g. `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale`) to mark your online activity. 
+* Go to Chrome extensions page.
-All that tracking code is not necessary for a website to be displayed or work correctly and can therefore be removed—that is exactly what ClearURLs does.
+* Toggle the developer mode (top-right of page).
-
+* Click `Load unpacked`.
-Another common example are Amazon URLs. If you search for a product on Amazon you will see a very long URL, such as: 
+* Select this project's root folder.
-```
+
-https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011
+## Development
-```
+
-
+### Local Testing
-Indeed most of the above URL is tracking code. Once ClearURLs has cleaned the address, it will look like this:
+
-`https://www.amazon.com/dp/exampleProduct`
+* Firefox: open about:debugging and click `Load Temporary Add-on...` then select `manifest.json` file.
-
+* Chrome: follow the install steps from above.
-## Features
+
-
+## Signing and Building
-* Removes tracking from URLs automatically in the background
+
-* Blocks some common ad domains (optional)
+### Firefox
-* Has a built-in tool to clean up multiple URLs at once
+* Install web-ext with `$ npm install --global web-ext`
-* Supports redirection to the destination, without tracking services as middleman
+* Generate an unlisted xpi with:
-* Adds an entry to the context menu so that links can be copied quickly and cleanly
+  `web-ext sign --api-key <your JWT issuer> --api-secret <your JWT secret>`
-* Blocks hyperlink auditing, also known as *ping tracking* (see also [this article](https://html.spec.whatwg.org/multipage/links.html#hyperlink-auditing))
+    * You can obtain these keys from https://addons.mozilla.org/en-US/developers/addon/api/key/
-* Prevents ETag tracking
+* The signed xpi will be in `web-ext-artifacts/`. Drag this into Firefox to install it.
-* Prevents tracking injection over history API (see also: [The replaceState() method](https://developer.mozilla.org/en-US/docs/Web/API/History_API#The_replaceState()_method))
+* Alternatively use the private sign-firefox-extension.sh script (not included in the repo) which places the xpi in `build/`.
-* Prevents Google from rewriting the search results (to include tracking elements)
+
-* Prevents Yandex from rewriting the search results (to include tracking elements)
+---
-
+
-## Permissons
+**ClearURLs** is an add-on based on the new WebExtensions technology and is optimized for *Firefox* and *Chrome* based browsers.
-Reasoning for needed permissions can be found under [here](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
+
-
+This extension will automatically remove tracking elements from URLs to help protect your privacy when browse through the Internet,
-## Screenshot
+which is regularly updated by us and can be found [here](https://gitlab.com/anti-tracking/ClearURLs/rules/-/raw/master/data.min.json).
-![Interface (version 1.14.0)](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/promotion/screens/Popup_v_1.14.0.png)
+
-
+## Application
-## CI/CD Artifacts Download (for Firefox- and Chrome-Dev only)
+Many websites use tracking elements in the URL (e.g. `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale`) to mark your online activity.
-Here you can download the packed files for the Firefox- and Chrome-Dev:
+All that tracking code is not necessary for a website to be displayed or work correctly and can therefore be removed—that is exactly what ClearURLs does.
-
+
-[<img src="promotion/download-128.png"/>](https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/ClearUrls.zip?job=bundle%20addon)
+Another common example are Amazon URLs. If you search for a product on Amazon you will see a very long URL, such as:
-
+```
-## Test
+https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011
-If you want to test whether ClearURLs works correctly on your system, you can go to this test page: [https://test.clearurls.xyz/](https://test.clearurls.xyz/)
+```
-
+
-## Contribute
+Indeed most of the above URL is tracking code. Once ClearURLs has cleaned the address, it will look like this:
-If you have any suggestions or complaints, please [create an issue.](https://gitlab.com/KevinRoebert/ClearUrls/issues/new)
+`https://www.amazon.com/dp/exampleProduct`
-
+
-**Note: If you have any suggestions or complaints regarding the rules, please [create an issue in this repo](https://gitlab.com/anti-tracking/ClearURLs/rules/-/issues/new) or email us rules.support (at) clearurls.xyz (this mail will automatically create a new issue in this repo).**
+## Features
-
+
-### Translate ClearURLs
+* Removes tracking from URLs automatically in the background
-You want to help translating ClearURLs into many languages? – Nice
+* Blocks some common ad domains (optional)
-
+* Has a built-in tool to clean up multiple URLs at once
-You can choose between two options to contribute. You can create a merge request, or you can use the POEditor to translate ClearURLs.
+* Supports redirection to the destination, without tracking services as middleman
-
+* Adds an entry to the context menu so that links can be copied quickly and cleanly
-*Hint: The description field in the translation files are only an information for what the translation is used. 
+* Blocks hyperlink auditing, also known as *ping tracking* (see also [this article](https://html.spec.whatwg.org/multipage/links.html#hyperlink-auditing))
-It is not necessary to translate the description field; in the most cases it is empty.*
+* Prevents ETag tracking
-
+* Prevents tracking injection over history API (see also: [The replaceState() method](https://developer.mozilla.org/en-US/docs/Web/API/History_API#The_replaceState()_method))
-#### Merge request
+* Prevents Google from rewriting the search results (to include tracking elements)
-If you want to create a merge request, you must open the path [`_locales/en/messages.json`](https://github.com/KevinRoebert/ClearUrls/blob/master/_locales/en/messages.json) in the ClearURLs repo 
+* Prevents Yandex from rewriting the search results (to include tracking elements)
-and translate the english terms into terms of your language. Once you have translated all the terms, you make a pull request of your translation. 
+
-Please push your translation into the folder `_locales/{language code}/messages.json`.
+## Permissons
-
+Reasoning for needed permissions can be found under [here](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
-#### POEditor
+
-[<img src="https://poeditor.com/public/images/logo/logo.svg" alt="https://poeditor.com/join/project/vKTpQWWvk2" width="150">](https://poeditor.com/join/project/vKTpQWWvk2)
+## Copyright
-
+We use some third-party scripts in our add-on. The authors and licenses are listed below.
-## Projects that use parts of ClearURLs
+-   [WebExtension browser API Polyfill](https://github.com/mozilla/webextension-polyfill) |
-
+    Copyright by Mozilla |
-* [Uroute](https://github.com/walterl/uroute) used ClearURLs to filter/clean URL before launching browser
+    [MPL-2.0](https://github.com/mozilla/webextension-polyfill/blob/master/LICENSE)
-* [Scrub](https://gitlab.com/CrunchBangDev/cbd-cogs/-/tree/master/Scrub) used ClearURLs to filter/clean URLs as cog for the Red Discord bot
+-   [Bootstrap v4.3.1](https://github.com/twbs/bootstrap/tree/v4.3.1) |
-* [Unalix](https://github.com/AmanoTeam/Unalix) a simple Python module that removes tracking fields from URLs and unshort shortened URLs
+    Copyright 2011-2016 Twitter, Inc. |
-* [Unalix-nim](https://github.com/AmanoTeam/Unalix-nim) a simple Nim library that removes tracking fields from URLs and unshort shortened URLs
+    [MIT](https://github.com/twbs/bootstrap/blob/master/LICENSE)
-
+-   [jQuery v3.4.1](https://github.com/jquery/jquery/tree/3.4.1) |
-## Recommended by...
+    Copyright JS Foundation and other contributors |
-*  [ghacks-user.js](https://github.com/ghacksuserjs/ghacks-user.js/wiki/4.1-Extensions)
+    [MIT](https://jquery.org/license/)
-*  [Awesome Humane Tech List](https://github.com/humanetech-community/awesome-humane-tech#tracking)
+-   [DataTables v1.10.20](https://github.com/DataTables/DataTables/tree/master) |  Copyright (c) 2008-2015 SpryMedia Limited | [MIT](https://datatables.net/license/)
-*  [PrivacyTools](https://www.privacytools.io/browsers/#addons)
+-   [Pickr v1.7.0](https://github.com/Simonwep/pickr/tree/1.7.0) | Copyright (c) 2018 - 2020 Simon Reinisch |
-*  [New York Times Wirecutter](https://www.nytimes.com/wirecutter/reviews/our-favorite-ad-blockers-and-browser-extensions-to-protect-privacy/#cleaner-links-clearurls)
+    [MIT](https://github.com/Simonwep/pickr/blob/master/LICENSE)
-*  ClearURLs is part of Mozilla's recommended extensions program
+-   [Font Awesome v5.12.0](https://github.com/FortAwesome/Font-Awesome/tree/5.12.0) | Copyright (c) @fontawesome |
-
+    [Font Awesome Free License](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt)
-## Permissions
-Reasoning for needed permissions you can find under [this discussion](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
-
-## Copyright
-We use some third-party scripts in our add-on. The authors and licenses are listed below.
--   [WebExtension browser API Polyfill](https://github.com/mozilla/webextension-polyfill) |
-    Copyright by Mozilla |
-    [MPL-2.0](https://github.com/mozilla/webextension-polyfill/blob/master/LICENSE)
--   [Bootstrap v4.3.1](https://github.com/twbs/bootstrap/tree/v4.3.1) |
-    Copyright 2011-2016 Twitter, Inc. |
-    [MIT](https://github.com/twbs/bootstrap/blob/master/LICENSE)
--   [jQuery v3.4.1](https://github.com/jquery/jquery/tree/3.4.1) |
-    Copyright JS Foundation and other contributors |
-    [MIT](https://jquery.org/license/)
--   [DataTables v1.10.20](https://github.com/DataTables/DataTables/tree/master) |  Copyright (c) 2008-2015 SpryMedia Limited | [MIT](https://datatables.net/license/)
--   [Pickr v1.7.0](https://github.com/Simonwep/pickr/tree/1.7.0) | Copyright (c) 2018 - 2020 Simon Reinisch |
-    [MIT](https://github.com/Simonwep/pickr/blob/master/LICENSE)
--   [Font Awesome v5.12.0](https://github.com/FortAwesome/Font-Awesome/tree/5.12.0) | Copyright (c) @fontawesome |
-    [Font Awesome Free License](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt)

core_js/storage.js

@@ -193,8 +193,8 @@ function initSettings() {
     storage.log = {"log": []};
     storage.statisticsStatus = true;
     storage.badged_color = "#ffa500";
-    storage.hashURL = "https://rules2.clearurls.xyz/rules.minify.hash";
+    storage.hashURL = "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
-    storage.ruleURL = "https://rules2.clearurls.xyz/data.minify.json";
+    storage.ruleURL = "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
     storage.contextMenuEnabled = true;
     storage.historyListenerEnabled = true;
     storage.localHostsSkipping = true;
@@ -221,27 +221,23 @@ function initSettings() {
 function replaceOldURLs(url) {
     switch (url) {
         case "https://raw.githubusercontent.com/KevinRoebert/ClearUrls/master/data/rules.hash?flush_cache=true":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://raw.githubusercontent.com/KevinRoebert/ClearUrls/master/data/data.json?flush_cache=true":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/rules.hash":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/rules.min.hash?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.min.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.minify.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/data.minify.json?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/rules.minify.hash?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
-        case "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json":
-            return "https://rules2.clearurls.xyz/data.minify.json";
-        case "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash":
-            return "https://rules2.clearurls.xyz/rules.minify.hash";
         default:
             return url;
     }

data

@@ -1 +0,0 @@
-Subproject commit 7a180c3dbd2a48aeeb1271919f6a9218b4d45354

data/rules.minify.hash

@@ -0,0 +1 @@
+18ece9513135aefb68fdffa0e4d18b1ae441dc57076d1715bffb4bee27ec8963

manifest.json

@@ -1,10 +1,10 @@
 {
     "manifest_version": 2,
     "name": "ClearURLs",
-    "version": "1.21.0",
+    "version": "1.22.0",
     "author": "Kevin Röbert",
-    "description": "__MSG_extension_description__",
+    "description": "Removes tracking info from URLs. Forked from github.com/ClearURLs/Addon",
-    "homepage_url": "https://gitlab.com/KevinRoebert/ClearUrls",
+    "homepage_url": "https://git.michael.is/michael/clear-urls-browser-extension",
     "default_locale": "en",
     "icons": {
         "16": "img/clearurls_16x16.png",
@@ -19,6 +19,11 @@
         "96": "img/clearurls_96x96.png",
         "128": "img/clearurls_128x128.png"
     },
+    "browser_specific_settings": {
+        "gecko": {
+            "id": "{8460283f-b310-4e55-8c07-ebd5eefdc9b3}"
+        }
+    },
     "browser_action": {
         "browser_style": true,
         "default_icon": {

package-lock.json

@@ -0,0 +1,6 @@
+{
+  "name": "clear-urls",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {}
+}