Initial commit

Author: Zegnat

LICENSE

@@ -0,0 +1,12 @@
+Copyright (C) 2018 by Martijn van der Ven <[email protected]>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -0,0 +1,51 @@
+# ![](logo/discourse-64.png) Discourse HTML
+
+A super simple [Browser Extension][] for redirecting [Discourse][] community
+websites to their HTML versions, rather than their [js;dr][] defaults.
+
+1. Automatically [append `?_escaped_fragment_`][] to any known Discourse URL.
+
+2. Offer an options page for the user to configure Discourse URLs.
+
+## Differences from spec
+
+The extension was created with [the Browser Extensions specification][spec] in
+mind. It turns out this is very hard to do while also supporting real
+life browsers.
+
+* This extension uses the [`options_ui` manifest key][] instead of the
+  [`options_page` manifest key][] from the spec.
+* This extension asks for the non-standard `storage` permission to use the [Web
+  Storage API][].
+
+Any other differences should be reported and either documented here or fixed
+as bugs.
+
+## Code Style
+
+This extension follows the [JavaScript Standard Style][]. I apologise if you
+love semicolons. Make sure to run it under the WebExtensions environment:
+
+```
+standard --env webextensions
+```
+
+## Licenses
+
+* The official logo [`discourse.png`][] is “®, Civilized Discourse Construction 
+  Kit, Inc.” and was used as a base for this extension’s logo.
+
+* Everything else is released under the BSD Zero Clause License (0BSD).
+  Please see the [`LICENSE`](LICENSE) file for more information.
+
+[Browser Extension]: https://browserext.github.io/
+[Discourse]: https://www.discourse.org/
+[js;dr]: https://indieweb.org/js;dr
+[append `?_escaped_fragment_`]: https://news.ycombinator.com/item?id=14247848
+[pull requests]: https://help.github.com/articles/creating-a-pull-request/
+[spec]: https://browserext.github.io/browserext/
+[`options_ui` manifest key]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/options_ui
+[`options_page` manifest key]: https://browserext.github.io/browserext/#list-of-keys
+[Web Storage API]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage
+[JavaScript Standard Style]: https://standardjs.com/
+[`discourse.png`]: https://github.com/discourse/discourse/blob/96b46170941f9ef8f492a993b0fbcbf591a1e9ae/images/discourse.png

logo/discourse-32.png

@@ -0,0 +1,30 @@
+{
+    "name": "Discourse HTML",
+    "version": "1.0",
+    "description": "Redirects Discourse community websites to their HTML versions, rather than their js;dr defaults.",
+    "icons": {
+        "32": "logo/discourse-32.png",
+        "64": "logo/discourse-64.png"
+    },
+    "developer": {
+        "name": "Martijn van der Ven",
+        "url": "https://vanderven.se/martijn/"
+    },
+    "background": {
+        "scripts": [
+            "src/background.js"
+        ],
+        "persistent": true
+    },
+    "options_ui": {
+        "browser_style": true,
+        "page": "src/options.html"
+    },
+    "manifest_version": 2,
+    "permissions": [
+        "webRequest",
+        "webRequestBlocking",
+        "<all_urls>",
+        "storage"
+    ]
+}

logo/discourse-64.png

@@ -0,0 +1,30 @@
+'use strict'
+
+const trigger = '_escaped_fragment_'
+
+function rewriter (request) {
+  let url = new window.URL(request.url)
+  if (url.searchParams.has(trigger) === false) {
+    url.searchParams.set(trigger, '')
+    return { 'redirectUrl': url.href }
+  }
+}
+function register (patterns) {
+  browser.webRequest.onBeforeRequest.removeListener(rewriter)
+  if (patterns.length > 0) {
+    browser.webRequest.onBeforeRequest.addListener(
+      rewriter,
+      {urls: patterns, types: ['main_frame', 'sub_frame']},
+      ['blocking']
+    )
+  }
+}
+
+browser.storage.onChanged.addListener(({patterns}) => {
+  if (patterns !== undefined) {
+    register(patterns.newValue)
+  }
+})
+
+browser.storage.local.get({patterns: []})
+  .then(({patterns}) => register(patterns))

manifest.json

@@ -0,0 +1,75 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Discourse HTML Options</title>
+    <style>
+table {
+  margin: 2em 0 0;
+  border-collapse: collapse;
+  border: none;
+}
+th, td {
+  padding: 0;
+}
+th, label {
+  font-weight: bold;
+  text-align: left;
+}
+p, caption {
+  margin: 0 0 .6em;
+  text-align: left;
+}
+label {
+  display: block;
+  margin-bottom: 6px;
+}
+input {
+  font-size: inherit;
+  font-family: inherit;
+  line-height: inherit;
+  display: inline-block;
+  width: 40em;
+  padding-top: .3em;
+  padding-bottom: .3em;
+}
+button {
+  font-size: inherit;
+  font-family: inherit;
+  line-height: inherit;
+  margin-left: 1em;
+}
+th + th {
+  padding-left: 1em;
+}
+th, td {
+  padding-bottom: 6px;
+}
+    </style>
+  </head>
+  <body>
+    <p>Add a <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns">match pattern</a> for a Discourse instance to enable URL rewriting.</p>
+    <form>
+      <label>Pattern</label>
+      <input type="text"><button type="submit">Add</button>
+    </form>
+    <table>
+      <caption>Enabled match patterns</caption>
+      <thead>
+        <tr>
+          <th>Pattern</th>
+          <th>Actions</th>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+    <template>
+      <tr>
+        <td><input type="text" readonly></td>
+        <td><button>Remove</button></td>
+      </tr>
+    </template>
+    <script src="options.js"></script>
+  </body>
+</html>

src/background.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const input = document.querySelector('input')
+const tbody = document.querySelector('tbody')
+const template = document.querySelector('template').content
+let cache = []
+
+function drawTable (patterns) {
+  cache = patterns
+  tbody.innerHTML = ''
+  for (let pattern of patterns) {
+    template.querySelector('input').value = pattern
+    tbody.appendChild(document.importNode(template, true))
+  }
+}
+
+document.querySelector('form').addEventListener('submit', submit => {
+  submit.preventDefault()
+  let pattern = input.value
+  if (pattern.length > 0) {
+    input.value = ''
+    browser.storage.local.set({
+      patterns: [pattern, ...cache].filter((v, i, a) => a.indexOf(v) === i)
+    })
+  }
+})
+
+tbody.addEventListener('click', click => {
+  if (click.target.nodeName === 'BUTTON') {
+    let pattern = click.target.parentNode.parentNode.querySelector('input').value
+    browser.storage.local.set({patterns: cache.filter(item => item !== pattern)})
+  }
+})
+
+browser.storage.onChanged.addListener(({patterns}) => {
+  if (patterns !== undefined) {
+    drawTable(patterns.newValue)
+  }
+})
+
+browser.storage.local.get({patterns: []})
+  .then(({patterns}) => drawTable(patterns))

src/options.html

@@ -0,0 +1,6 @@
+module.exports = {
+  ignoreFiles: [
+    'README.md',
+    'web-ext-config.js'
+  ]
+}