├── .eslintignore ├── .eslintrc.js ├── .gitignore ├── LICENSE ├── README.md ├── addon ├── background.js ├── experiment │ ├── api.js │ └── schema.json ├── manifest.json.tmpl └── reader-script.js └── package.json /.eslintignore: -------------------------------------------------------------------------------- 1 | addon/build 2 | Profile 3 | web-ext-artifacts 4 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | "env": { 3 | "es6": true, 4 | "webextensions": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:mozilla/recommended" 9 | ], 10 | "parserOptions": { 11 | "ecmaVersion": 8, 12 | "sourceType": "module" 13 | }, 14 | "plugins": [ 15 | "mozilla" 16 | ], 17 | "root": true, 18 | "rules": { 19 | "eqeqeq": "error", 20 | "no-console": "warn", 21 | "space-before-function-paren": "off", 22 | "no-console": ["error", {"allow": ["error", "info", "trace", "warn"]}] 23 | } 24 | }; 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | web-ext-artifacts 3 | addon.xpi 4 | addon/build 5 | addon/manifest.json 6 | .DS_Store 7 | /Profile 8 | /package-lock.json 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sticky Reader Mode 2 | 3 | A browser extension that adds a preference to Reader Mode pages, which will default to using Reader Mode on that site. 4 | 5 | Note: usually homepages won't be considered an "article" and so they won't default to Reader Mode. 6 | 7 | ## Installation 8 | 9 | To test it out: 10 | 11 | ```sh 12 | $ npm install 13 | $ npm start 14 | # Or if the wrong Firefox is used: 15 | $ FIREFOX="/Application/Firefox Nightly.app" npm start 16 | ``` 17 | 18 | Then on `about:debugging` click **Load Temporary Add-on...** and select `addon/manifest.json` 19 | 20 | Note that `web-ext run` does not work due to the permissions and experiment API this uses. You must manually reload through `about:debugging`, and note that `manifest.json.tmpl` edits won't be reflected by default. 21 | -------------------------------------------------------------------------------- /addon/background.js: -------------------------------------------------------------------------------- 1 | let readableHostnames = {}; 2 | let lastReadable = new Map(); 3 | let recentRedirects = new Map(); 4 | 5 | function reporter(func) { 6 | return async function(...args) { 7 | try { 8 | return func.apply(this, args); 9 | } catch (e) { 10 | console.error("Error in function:", e); 11 | console.error(e.stack); 12 | throw e; 13 | } 14 | }; 15 | } 16 | 17 | browser.tabs.onUpdated.addListener(reporter(async (tabId, changeInfo, newTabInfo) => { 18 | let url = changeInfo.url; 19 | if (changeInfo.isArticle && !url) { 20 | // We recently found we can use the article view 21 | url = newTabInfo.url; 22 | } 23 | if (recentRedirects.get(tabId)) { 24 | url = newTabInfo.url; 25 | recentRedirects.clear(); 26 | } 27 | // console.info("Tab update:", url, changeInfo.url, newTabInfo.url); 28 | if (!url) { 29 | // Then the URL didn't update 30 | return; 31 | } 32 | if (url.startsWith("about:reader")) { 33 | // We can't use manifest.json content_scripts on about:reader, as the matcher doesn't work. But we can inject it here: 34 | // Sometimes executeScript just stalls, this at least emits an error message in that case: 35 | let timeoutId = setTimeout(() => { 36 | console.error("Could not attach content script to about:reader", tabId, url); 37 | }, 2000); 38 | await browser.tabs.executeScript(tabId, { 39 | file: "reader-script.js" 40 | }); 41 | clearTimeout(timeoutId); 42 | let origUrl = readerUrlToNormal(url); 43 | let domain = makeDomain(origUrl); 44 | browser.tabs.sendMessage(tabId, { 45 | type: "setValue", 46 | checked: !!readableHostnames[domain] 47 | }); 48 | lastReadable.set(tabId, origUrl); 49 | } else { 50 | if (url === lastReadable.get(tabId)) { 51 | console.info("User exited reader mode on tab, no reader toggle:", tabId, url); 52 | return; 53 | } 54 | lastReadable.delete(tabId); 55 | let domain = makeDomain(url); 56 | let readable = readableHostnames[domain]; 57 | if (readable && newTabInfo.isArticle) { 58 | console.info("Turning reader mode on for:", url, "and remembering:", makeUrlPattern(url)); 59 | readableHostnames[domain][makeUrlPattern(url)] = true; 60 | saveHostnames(); 61 | await browser.tabs.toggleReaderMode(tabId); 62 | } 63 | } 64 | })); 65 | 66 | if (browser.openInReaderMode && browser.openInReaderMode.open) { 67 | browser.webRequest.onBeforeRequest.addListener((event) => { 68 | let tabId = event.tabId; 69 | let url = event.url; 70 | let domain = makeDomain(url); 71 | let pat = makeUrlPattern(url); 72 | if (readableHostnames[domain] && readableHostnames[domain][pat]) { 73 | if (url === lastReadable.get(tabId)) { 74 | console.info("User exited reader mode on tab, no automatic redirect:", tabId, url); 75 | return {}; 76 | } 77 | lastReadable.delete(tabId); 78 | console.info("Redirecting request to reader mode:", url); 79 | setTimeout(() => { 80 | recentRedirects.set(tabId, url); 81 | lastReadable.set(tabId, url); 82 | browser.openInReaderMode.open(tabId, url); 83 | }); 84 | return {cancel: true}; 85 | } 86 | if (domain && !readableHostnames[domain]) { 87 | lastReadable.delete(tabId); 88 | } 89 | return {}; 90 | }, {urls: ["http://*/*", "https://*/*"], types: ["main_frame"]}, ["blocking"]); 91 | } else { 92 | console.error("Sticky Readable error: browser.openInReaderMode API was not loaded"); 93 | } 94 | 95 | function makeUrlPattern(url) { 96 | if (url.includes("?p=")) { 97 | // A WordPress-specific pattern... 98 | url = url.replace(/\?p=([^&]*)&?/, (m) => "/" + m[1] + "?"); 99 | } 100 | let urlObj = new URL(url); 101 | let path = urlObj.pathname.replace(/\/\/+/g, "/"); 102 | path = path.replace(/\/[^/]+/g, "/*"); 103 | return urlObj.hostname + path; 104 | } 105 | 106 | function makeDomain(url) { 107 | return (new URL(url)).hostname; 108 | } 109 | 110 | function readerUrlToNormal(url) { 111 | if (!url.startsWith("about:reader?")) { 112 | throw new Error("Bad Reader URL"); 113 | } 114 | let match = /url=([^&"?]+)/.exec(url); 115 | if (!match) { 116 | throw new Error("Reader URL doesn't have url= param"); 117 | } 118 | return decodeURIComponent(match[1]); 119 | } 120 | 121 | async function saveHostnames() { 122 | await browser.storage.sync.set({readableHostnames}); 123 | } 124 | 125 | browser.runtime.onMessage.addListener((message, sender) => { 126 | if (message.type === "setValue") { 127 | let url = sender.tab.url; 128 | let pat = makeUrlPattern(readerUrlToNormal(url)); 129 | let domain = makeDomain(readerUrlToNormal(url)); 130 | if (message.checked) { 131 | readableHostnames[domain] = {[pat]: true}; 132 | console.info("Default reader mode on", domain); 133 | } else { 134 | // FIXME: should iterate all hostnames for any additional patterns 135 | delete readableHostnames[domain]; 136 | console.info("Removing default reader mode on", domain); 137 | } 138 | saveHostnames(); 139 | } else { 140 | console.warn("Received unexpected message:", message); 141 | } 142 | }); 143 | 144 | async function init() { 145 | let result = await browser.storage.sync.get(["readableHostnames"]); 146 | if (result) { 147 | readableHostnames = result.readableHostnames || {}; 148 | } 149 | console.info("Loaded sticky readable hosts:", Object.keys(readableHostnames).join(", ")); 150 | for (let tab of await browser.tabs.query({})) { 151 | let url = tab.url; 152 | if (url.startsWith("about:reader")) { 153 | let origUrl = readerUrlToNormal(url); 154 | lastReadable.set(tab.id, origUrl); 155 | } 156 | } 157 | } 158 | 159 | init(); 160 | -------------------------------------------------------------------------------- /addon/experiment/api.js: -------------------------------------------------------------------------------- 1 | /* global ExtensionAPI:false */ 2 | 3 | const { classes: Cc, interfaces: Ci, utils: Cu } = Components; 4 | Cu.import("resource://gre/modules/Services.jsm"); 5 | 6 | function getTabOrActive(tabId) { 7 | let tabTracker = ChromeUtils.import("resource://gre/modules/Extension.jsm", {}).Management.global.tabTracker; 8 | if (tabId !== null) { 9 | return tabTracker.getTab(tabId); 10 | } 11 | return tabTracker.activeTab; 12 | } 13 | 14 | this.openInReaderMode = class API extends ExtensionAPI { 15 | getAPI(context) { 16 | return { 17 | openInReaderMode: { 18 | open(tabId, url) { 19 | // eslint-disable-next-line mozilla/use-services 20 | let nativeTab = getTabOrActive(tabId); 21 | let systemPrincipal = Services.scriptSecurityManager.getSystemPrincipal(); 22 | url = context.uri.resolve(url); 23 | if (!context.checkLoadURL(url, {dontReportErrors: true})) { 24 | return Promise.reject({message: `Illegal URL: ${url}`}); 25 | } 26 | url = `about:reader?url=${encodeURIComponent(url)}`; 27 | let options = { 28 | triggeringPrincipal: systemPrincipal, 29 | }; 30 | nativeTab.linkedBrowser.loadURI(url, options); 31 | return true; 32 | } 33 | } 34 | }; 35 | } 36 | }; 37 | -------------------------------------------------------------------------------- /addon/experiment/schema.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "namespace": "openInReaderMode", 4 | "description": "Opens a page directly in Reader Mode", 5 | "functions": [ 6 | { 7 | "name": "open", 8 | "type": "function", 9 | "description": "Opens a page directly in Reader Mode.", 10 | "async": false, 11 | "parameters": [ 12 | { 13 | "type": "number", 14 | "name": "tabId" 15 | }, 16 | { 17 | "type": "string", 18 | "name": "url" 19 | } 20 | ] 21 | } 22 | ] 23 | } 24 | ] 25 | -------------------------------------------------------------------------------- /addon/manifest.json.tmpl: -------------------------------------------------------------------------------- 1 | { 2 | "manifest_version": 2, 3 | "name": "Sticky Reader Mode", 4 | "version": "{{version}}", 5 | "description": "{{description}}", 6 | "icons": { 7 | "256": "generic-fox.png" 8 | }, 9 | "author": "{{{author}}}", 10 | "homepage_url": "{{{homepage}}}", 11 | "applications": { 12 | "gecko": { 13 | "id": "sticky-reader-mode@mozilla.org", 14 | "strict_min_version": "57.0a1" 15 | } 16 | }, 17 | "background": { 18 | "scripts": [ 19 | "background.js" 20 | ] 21 | }, 22 | "experiment_apis": { 23 | "openInReaderMode": { 24 | "schema": "experiment/schema.json", 25 | "parent": { 26 | "scopes": ["addon_parent"], 27 | "script": "experiment/api.js", 28 | "paths": [["openInReaderMode"]] 29 | } 30 | } 31 | }, 32 | "permissions": [ 33 | "tabs", 34 | "storage", 35 | "webRequest", 36 | "webRequestBlocking", 37 | "mozillaAddons", 38 | "about:reader*", 39 | "" 40 | ] 41 | } 42 | -------------------------------------------------------------------------------- /addon/reader-script.js: -------------------------------------------------------------------------------- 1 | // This script might get added multiple times: 2 | // FIXME: let's not add it multiple times! 3 | if (this.hasLoaded === undefined) { 4 | this.hasLoaded = false; 5 | } 6 | 7 | (function () { 8 | 9 | if (hasLoaded) { 10 | return; 11 | } 12 | 13 | let checkbox; 14 | 15 | function addCheckbox() { 16 | let element = document.querySelector(".domain.reader-domain"); 17 | if (!element) { 18 | setTimeout(addCheckbox, 100); 19 | return; 20 | } 21 | let label = document.createElement("label"); 22 | label.setAttribute("for", "sticky-checkbox"); 23 | label.style.fontSize = "0.8em"; 24 | label.innerHTML = ` 25 | 26 | always use Reader Mode for articles on this site 27 | `; 28 | element.insertAdjacentElement("afterend", label); 29 | checkbox = label.querySelector("input"); 30 | checkbox.addEventListener("change", () => { 31 | updateCheckbox(checkbox.checked); 32 | }); 33 | } 34 | 35 | // Takes the link site name 36 | // and rewrites it to site name article 37 | function adjustLink() { 38 | let link = document.querySelector(".domain.reader-domain"); 39 | if (!link || !link.href) { 40 | // Rendering hasn't finished 41 | setTimeout(adjustLink, 100); 42 | return; 43 | } 44 | let siteLink = document.createElement("a"); 45 | siteLink.className = "domain"; 46 | siteLink.textContent = link.textContent; 47 | siteLink.href = (new URL(link.href)).origin; 48 | link.textContent = "article"; 49 | link.parentNode.insertBefore(siteLink, link); 50 | link.parentNode.insertBefore(document.createTextNode(" "), link); 51 | } 52 | 53 | try { 54 | addCheckbox(); 55 | adjustLink(); 56 | } catch (e) { 57 | console.error("Error adding UI:", e + "", e.stack); 58 | } 59 | 60 | browser.runtime.onMessage.addListener((message) => { 61 | if (message.type === "setValue") { 62 | checkbox.checked = message.checked; 63 | } else { 64 | console.warn("Unexpected message:", message); 65 | } 66 | }); 67 | 68 | function updateCheckbox(checked) { 69 | browser.runtime.sendMessage({type: "setValue", checked: checkbox.checked}); 70 | } 71 | 72 | })(); 73 | 74 | this.hasLoaded = true; 75 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sticky-reader-mode", 3 | "description": " A browser extension to turn on Reader Mode automatically on sites where you've used it before", 4 | "version": "0.1.0", 5 | "author": "Ian Bicking", 6 | "bugs": { 7 | "url": "https://github.com/ianb/sticky-reader-mode/issues" 8 | }, 9 | "dependencies": {}, 10 | "devDependencies": { 11 | "addons-linter": "^0.37.0", 12 | "eslint": "^4.16.0", 13 | "eslint-plugin-mozilla": "^0.6.0", 14 | "eslint-plugin-no-unsanitized": "^2.0.2", 15 | "fx-runner": "^1.0.9", 16 | "mustache": "^2.3.0", 17 | "npm-run-all": "^4.1.2", 18 | "web-ext": "^2.4.0" 19 | }, 20 | "homepage": "https://github.com/ianb/sticky-reader-mode/", 21 | "license": "MPL-2.0", 22 | "private": true, 23 | "repository": { 24 | "type": "git", 25 | "url": "git+https://github.com/ianb/sticky-reader-mode.git" 26 | }, 27 | "scripts": { 28 | "start": "npm-run-all build run", 29 | "lint": "npm-run-all lint:*", 30 | "lint:addon": "npm run package && addons-linter ./addon.xpi -o text", 31 | "lint:js": "eslint .", 32 | "build": "mkdir -p addon/build && npm-run-all build:*", 33 | "build:manifest": "node -e 'let input = JSON.parse(fs.readFileSync(\"package.json\")); input.version = input.version.slice(0, -1) + Math.floor((Date.now() - new Date(new Date().getFullYear().toString()).getTime()) / 3600000); console.log(JSON.stringify(input))' | mustache - addon/manifest.json.tmpl > addon/manifest.json", 34 | "build:web-ext": "web-ext build --source-dir=addon --overwrite-dest --ignore-files '*.tmpl' && mv web-ext-artifacts/*.zip addon.xpi", 35 | "package": "npm run build", 36 | "run:web-ext": "echo 'Note: this does not work!' && read && mkdir -p ./Profile && web-ext run --source-dir=addon -p ./Profile --browser-console --keep-profile-changes -f ${FIREFOX:-nightly}", 37 | "run": "echo \"****************************************************************************\" && echo \"** After startup, install addon/manifest.json as a Temporary Add-on\" && echo && mkdir -p ./Profile && fx-runner start -b \"${FIREFOX:-nightly}\" -p ./Profile/ --no-remote --foreground --new-instance --binary-args \"-jsconsole about:debugging\"", 38 | "test": "npm run lint" 39 | } 40 | } 41 | --------------------------------------------------------------------------------