Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefansundin/privatkopiera
:vhs: Tillägg till Chrome och Firefox för att privatkopiera enklare från nätet.
https://github.com/stefansundin/privatkopiera
addon chrome extension firefox
Last synced: 17 days ago
JSON representation
:vhs: Tillägg till Chrome och Firefox för att privatkopiera enklare från nätet.
- Host: GitHub
- URL: https://github.com/stefansundin/privatkopiera
- Owner: stefansundin
- License: gpl-3.0
- Created: 2016-03-19T19:17:26.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T06:47:35.000Z (10 months ago)
- Last Synced: 2024-10-11T00:55:13.445Z (about 1 month ago)
- Topics: addon, chrome, extension, firefox
- Language: JavaScript
- Homepage: https://stefansundin.github.io/privatkopiera/
- Size: 2.31 MB
- Stars: 83
- Watchers: 7
- Forks: 17
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Website: https://stefansundin.github.io/privatkopiera/
Chrome Web Store: https://chromewebstore.google.com/detail/privatkopiera/jhjhnecocacdbhlkjgpdacoibidhmgdf
Firefox Addons: https://addons.mozilla.org/addon/privatkopiera/
Icon: https://commons.wikimedia.org/wiki/File:VHS_diagonal.svg
## Development
The [extension](extension) directory contains the source code, which you can load directly in Chrome.
The [firefox](firefox) directory contains modifications necessary for the extension to run in Firefox (currently only the manifest file is different). You must run `./make-xpi.sh` to copy over the other files, after which you can load the extension in `about:debugging`.
### Bootstrap
To build the custom Bootstrap theme you need Node.js installed and then you can run:
```shell
cd bootstrap
npm install
npm run build
```
If you don't have Node.js or you don't want it, then you can get the default Bootstrap theme by running:
```shell
curl -f -o extension/css/bootstrap.min.css https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css
```
Or just download the file and put it there manually.
### Formatting
The JavaScript code is formatted with prettier. The HTML is formatted with the built-in VS Code formatter.
### Why are there more `executeScript` calls than seems necessary?
The extension performs all of its network requests through the host page, using `chrome.scripting.executeScript()`, for a number of reasons:
1. Any `POST` request made in the extension will cause Chrome to add an `Origin: chrome-extension://jhjhnecocacdbhlkjgpdacoibidhmgdf` header. This header is easy to detect and block by websites (see [#185](https://github.com/stefansundin/privatkopiera/issues/185)). By making the network request from the host page instead, the `Origin` header will look normal from the website's point of view. There's [a Chrome bug](https://bugs.chromium.org/p/chromium/issues/detail?id=966223) about this.
2. The extension can avoid asking for host permissions when the user uses Privatkopiera on a website for the first time. This makes for a better experience since granting new permissions is not foolproof and at least one user reported that they didn't understand how to proceed (see [#184](https://github.com/stefansundin/privatkopiera/issues/184)).
3. Some websites have permissive CORS permissions initially, but then later make it more restrictive. This makes for an impossible situation since the only workaround would be to ask for host permissions prematurely, even though they may not be required at the time.
### `executeScript` error handling
Firefox has better error handling in its `chrome.scripting.executeScript()` implementation and populates an [`error`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/scripting/executeScript#error) key in the `InjectionResult` if an error was raised in the script. An [issue](https://bugs.chromium.org/p/chromium/issues/detail?id=1271527) has been filed to hopefully get the same support in Chrome.
Due to this, where appropriate, return values from `executeScript` are an object with `result` or `error` keys depending on what happened. The complicated scripts are also wrapped in a `try-catch` clause. This looks funky but will have to do until the situation in Chrome improves.