├── .eslintrc.json ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── neue-bibliothek.yml │ └── neue-nachrichtenseite.yml └── workflows │ ├── ci.yml │ ├── release.yml │ └── sites.yml ├── .gitignore ├── .husky └── pre-commit ├── .prettierrc.json ├── LICENSE ├── README.md ├── assets ├── mvp.css └── social.png ├── babel.config.js ├── dist.sh ├── generate_icons.sh ├── icons ├── bibbot-1024.png ├── bibbot-128.png ├── bibbot-16.png ├── bibbot-19.png ├── bibbot-192.png ├── bibbot-256.png ├── bibbot-288.png ├── bibbot-32.png ├── bibbot-38.png ├── bibbot-48.png ├── bibbot-512.png ├── bibbot-64.png ├── bibbot-96.png ├── bibbot-alpha-1024.png ├── bibbot-alpha-128.png ├── bibbot-alpha-16.png ├── bibbot-alpha-19.png ├── bibbot-alpha-192.png ├── bibbot-alpha-256.png ├── bibbot-alpha-288.png ├── bibbot-alpha-32.png ├── bibbot-alpha-38.png ├── bibbot-alpha-48.png ├── bibbot-alpha-512.png ├── bibbot-alpha-64.png ├── bibbot-alpha-96.png ├── bibbot-mono-1024.png ├── bibbot-mono-128.png ├── bibbot-mono-16.png ├── bibbot-mono-19.png ├── bibbot-mono-192.png ├── bibbot-mono-256.png ├── bibbot-mono-288.png ├── bibbot-mono-32.png ├── bibbot-mono-38.png ├── bibbot-mono-48.png ├── bibbot-mono-512.png ├── bibbot-mono-64.png ├── bibbot-mono-96.png ├── bibbot.svg ├── bibbot_monochrome.svg └── bibbot_simple.svg ├── index.html ├── manifest.json ├── options └── options.html ├── package-lock.json ├── package.json ├── playwright.config.ts ├── popup ├── popup.css └── popup.html ├── privacy.md ├── rollup.config.js ├── src ├── background.ts ├── const.ts ├── content.ts ├── converters.ts ├── extractor.ts ├── global.d.ts ├── options.ts ├── popup.ts ├── providers.ts ├── reader.ts ├── services.ts ├── sitebot.ts ├── sites.ts ├── sourcebot.ts ├── sources.ts ├── stats.ts ├── tabrunner.ts ├── test_utils.ts ├── types.ts ├── ui.ts ├── update.ts └── utils.ts ├── tests ├── content_test.ts ├── extension.spec.ts ├── fixtures.ts ├── index.d.ts ├── sites.spec.ts └── tsconfig.json ├── tsconfig.json └── updates.json /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "globals": { 4 | "browser": true, 5 | "chrome": true 6 | }, 7 | "parser": "@typescript-eslint/parser", 8 | "plugins": [ 9 | "@typescript-eslint" 10 | ], 11 | "rules": { 12 | "no-use-before-define": "off", 13 | "@typescript-eslint/no-use-before-define": "off" 14 | }, 15 | "extends": [ 16 | "standard", 17 | "plugin:@typescript-eslint/recommended", 18 | "prettier" 19 | ] 20 | } -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [stefanw] 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: true 2 | contact_links: 3 | - name: Austausch, Fragen, Hilfe 4 | url: https://github.com/stefanw/bibbot/discussions 5 | about: Nutzt das 'Discussions'-Forum für Austausch, Fragen und Hilfe -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/neue-bibliothek.yml: -------------------------------------------------------------------------------- 1 | name: Neue Bibliothek 2 | description: Neue Bibliothek vorschlagen 3 | title: "[Bibliothek]: " 4 | labels: ["provider"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Bitte fülle das Formular aus, um eine neue Bibliothek vorzuschlagen. 10 | - type: input 11 | id: name 12 | attributes: 13 | label: Name der Bibliothek 14 | validations: 15 | required: true 16 | - type: input 17 | id: web 18 | attributes: 19 | label: Webseite der Bibliothek 20 | validations: 21 | required: true 22 | - type: dropdown 23 | id: source 24 | attributes: 25 | label: Angebotene Pressedatenbank 26 | description: Welche Pressedatenbank wird von der Bibliothek angeboten? 27 | options: 28 | - Genios 29 | - Nexis Uni 30 | validations: 31 | required: true 32 | - type: input 33 | id: source_url 34 | attributes: 35 | label: URL zur Pressedatenbank 36 | validations: 37 | required: true 38 | - type: textarea 39 | id: description 40 | attributes: 41 | label: Weitere Details 42 | description: Falls es weitere Informationen gibt, die für die Aufnahme der Bibliothek relevant sind, kannst du sie hier eintragen. 43 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/neue-nachrichtenseite.yml: -------------------------------------------------------------------------------- 1 | name: Neue Nachrichtenseite 2 | description: Neue Nachrichtenseite vorschlagen 3 | title: "[Nachrichtenseite]: " 4 | labels: ["site"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Bitte fülle das Formular aus, um eine neue Nachrichtenseite vorzuschlagen. 10 | - type: input 11 | id: url 12 | attributes: 13 | label: URL der Nachrichtenseite 14 | validations: 15 | required: true 16 | - type: input 17 | id: example 18 | attributes: 19 | label: URL zu einem Artikel mit Paywall 20 | validations: 21 | required: true 22 | - type: dropdown 23 | id: source 24 | attributes: 25 | label: Ist die Nachrichtenseite in einer Pressedatenbank enthalten? 26 | options: 27 | - Genios 28 | - Nexis Uni 29 | multiple: true 30 | validations: 31 | required: true 32 | - type: input 33 | id: source_url 34 | attributes: 35 | label: URL zu der Quellenseite in der Pressedatenbank 36 | validations: 37 | required: true 38 | - type: textarea 39 | id: description 40 | attributes: 41 | label: Weitere Details 42 | description: Falls es weitere Informationen gibt, die für die Aufnahme der Nachrichtenseite relevant sind, kannst du sie hier eintragen. 43 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Run tests 2 | on: 3 | push: 4 | branches: [ main ] 5 | pull_request: 6 | branches: [ main ] 7 | jobs: 8 | test: 9 | timeout-minutes: 20 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v3 13 | - uses: actions/setup-node@v3 14 | with: 15 | node-version: 18 16 | - name: Install dependencies 17 | run: npm ci 18 | - name: Running lint and type check 19 | run: npm run lint && npm run check-types 20 | - name: Build project and create dist files 21 | run: "./dist.sh" 22 | - name: Install Playwright Browsers 23 | run: npx playwright install --with-deps 24 | - name: Run Playwright tests 25 | run: xvfb-run npm run test-extension 26 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | # Sequence of patterns matched against refs/tags 4 | tags: 5 | - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 6 | 7 | name: Create Release 8 | 9 | jobs: 10 | build: 11 | name: Create Release 12 | environment: Release 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Checkout code 16 | uses: actions/checkout@v2 17 | - name: actions/setup-node 18 | uses: actions/setup-node@v2 19 | with: 20 | node-version: '16' 21 | - name: Install build environment 22 | run: npm ci 23 | 24 | # Run lint, type-checking and tests before release 25 | - name: Running lint and type check 26 | run: npm run lint && npm run check-types 27 | - name: Create build of test content script 28 | run: npm run build 29 | 30 | # FIXME: Tests too flaky, disabled for release 31 | # - name: Run the tests 32 | # run: npm run test 33 | 34 | - name: Set tag name in env 35 | run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV 36 | - name: Build project and create dist files 37 | run: "./dist.sh" 38 | - name: Create Release 39 | id: create_release 40 | uses: actions/create-release@v1 41 | env: 42 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token 43 | with: 44 | tag_name: ${{ env.RELEASE_VERSION }} 45 | release_name: Release ${{ env.RELEASE_VERSION }} 46 | body: "" 47 | draft: false 48 | prerelease: false 49 | - name: Upload Release Asset 50 | id: upload-release-asset 51 | uses: actions/upload-release-asset@v1 52 | env: 53 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 54 | with: 55 | upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 56 | asset_path: ./dist/bibbot.zip 57 | asset_name: bibbot-${{ env.RELEASE_VERSION }}.zip 58 | asset_content_type: application/zip 59 | - name: "web-ext build" 60 | id: web-ext-build 61 | uses: kewisch/action-web-ext@fe10addf5d5e5ba6b78ffde720dd488a27d10e8c 62 | with: 63 | cmd: build 64 | source: ./dist/bibbot 65 | - name: "web-ext sign" 66 | id: web-ext-sign 67 | uses: kewisch/action-web-ext@fe10addf5d5e5ba6b78ffde720dd488a27d10e8c 68 | with: 69 | cmd: sign 70 | source: ${{ steps.web-ext-build.outputs.target }} 71 | channel: listed 72 | apiKey: ${{ secrets.FIREFOX_API_KEY }} 73 | apiSecret: ${{ secrets.FIREFOX_API_SECRET }} 74 | timeout: 900000 75 | # # Because it's listed, we are not getting a signed asset anymore 76 | # - name: Upload Release XPI Asset 77 | # id: upload-release-xpi-asset 78 | # uses: actions/upload-release-asset@v1 79 | # env: 80 | # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 81 | # with: 82 | # upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 83 | # asset_path: ${{ steps.web-ext-sign.outputs.target }} 84 | # asset_name: bibbot-${{ env.RELEASE_VERSION }}.xpi 85 | # asset_content_type: application/x-xpinstall 86 | - name: Trigger GitHub pages rebuild 87 | run: | 88 | curl --fail --request POST \ 89 | --url https://api.github.com/repos/${{ github.repository }}/pages/builds \ 90 | --header "Authorization: Bearer $USER_TOKEN" 91 | env: 92 | # You must create a personal token with repo access as GitHub does 93 | # not yet support server-to-server page builds. 94 | USER_TOKEN: ${{ secrets.USER_TOKEN }} 95 | - name: "Publish to Chrome Web Store" 96 | uses: trmcnvn/chrome-addon@7fc5a5ad3ff597dc64d6a13de7dcaa8515328be7 97 | with: 98 | extension: edafomjglmkfbiieocpflnhfdmikkhbo 99 | zip: ./dist/bibbot.zip 100 | client-id: ${{ secrets.CHROME_CLIENT_ID }} 101 | client-secret: ${{ secrets.CHROME_CLIENT_SECRET }} 102 | refresh-token: ${{ secrets.CHROME_REFRESH_TOKEN }} 103 | -------------------------------------------------------------------------------- /.github/workflows/sites.yml: -------------------------------------------------------------------------------- 1 | name: Run site tests 2 | on: 3 | push: 4 | branches: [ main ] 5 | pull_request: 6 | branches: [ main ] 7 | schedule: 8 | - cron: '42 23 * * 6' 9 | jobs: 10 | test: 11 | timeout-minutes: 20 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | - uses: actions/setup-node@v3 16 | with: 17 | node-version: 18 18 | - name: Install dependencies 19 | run: npm ci 20 | - name: Running lint and type check 21 | run: npm run lint && npm run check-types 22 | - name: Build 23 | run: npm run build 24 | - name: Install Playwright Browsers 25 | run: npx playwright install --with-deps 26 | - name: Run Playwright tests 27 | run: npm run test-sites 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.zip 2 | .vscode/ 3 | screenshots/* 4 | build/ 5 | test_build/ 6 | dist/ 7 | safari-build/output/ 8 | _site/ 9 | node_modules/ 10 | /test-results/ 11 | /playwright-report/ 12 | /blob-report/ 13 | /playwright/.cache/ 14 | safari-build/ -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | npm run lint 2 | npm run check-types 3 | npm run build 4 | -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "semi": false, 3 | "singleQuote": true 4 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BibBot 2 | 3 | [Official website](https://stefanw.github.io/bibbot/) 4 | 5 | ## Development 6 | 7 | This uses rollup to build the extension files. Install and run like this: 8 | 9 | ```sh 10 | npm install 11 | 12 | # Run this during development 13 | npm start 14 | ``` 15 | 16 | ## Extension overview 17 | 18 | The extension has four different entry points: 19 | 20 | - The content script in `src/content.ts` runs on the news article page, communicates with background script 21 | - the background script in `src/background.ts` which opens new tabs, navigates them around and scrapes the content 22 | - the options page in `src/options.ts` is the options page for the extension 23 | - the popup in `popup/` is opened when the extension icon in the toolbar is clicked 24 | 25 | These are the relevant players: 26 | 27 | - `src/providers.ts` contains libraries that you authenticate against and that grant access 28 | - `src/sources.ts` contains databases that you can get access to through providers 29 | - `src/sites.ts` contains news sites, how to extract their meta data and which source could provide access 30 | 31 | For details on how to construct any of these entities, have a look at `src/types.ts` 32 | 33 | Additionally user data like credentials and chosen provider is stored via `browser.storage.sync`. 34 | 35 | 36 | ## Tests 37 | 38 | There is a test setup for sites using [Playwright](https://playwright.dev/) that can be run with: 39 | 40 | ```bash 41 | # install dependencies 42 | npm ci 43 | # Run linting and type checking 44 | npm run lint 45 | npm run check-types 46 | # Always run build before tests, as test uses build files! 47 | npm run build 48 | # Run tests 49 | npm run test 50 | # Run tests with actual browser window for one domain 51 | npm run test -- --headed -g "zeit.de" 52 | ``` 53 | 54 | Add testing data to site objects like this: 55 | 56 | ```javascript 57 | // ... 58 | 'www.example.com': { 59 | examples: [ 60 | { 61 | url: 'http://example.com/article.html', 62 | selectors: { 63 | query: 'The string resulting from query selector' 64 | } 65 | } 66 | ], 67 | // optional setup async function 68 | testSetup: async (page) => { 69 | // page is playwright page 70 | // use this for initial page setup 71 | }, 72 | // ... 73 | ``` 74 | 75 | 76 | ## Release 77 | 78 | 1. Run `npm version ` 79 | 2. `git push --tags origin main` 80 | 3. GitHub release Action will build, test, create release, sign Firefox extension, submit to Chrome Web Store and update website. 81 | -------------------------------------------------------------------------------- /assets/mvp.css: -------------------------------------------------------------------------------- 1 | /* MVP.css v1.12 - https://github.com/andybrewer/mvp */ 2 | 3 | :root { 4 | --active-brightness: 0.85; 5 | --border-radius: 5px; 6 | --box-shadow: 2px 2px 10px; 7 | --color-accent: #029d74; 8 | --color-bg: #fff; 9 | --color-bg-secondary: #e9e9e9; 10 | --color-link: #029d74; 11 | --color-secondary: #920de9; 12 | --color-secondary-accent: #920de90b; 13 | --color-shadow: #f4f4f4; 14 | --color-table: #029d74; 15 | --color-text: #000; 16 | --color-text-secondary: #999; 17 | --font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; 18 | --hover-brightness: 1.2; 19 | --justify-important: center; 20 | --justify-normal: left; 21 | --line-height: 1.5; 22 | --width-card: 285px; 23 | --width-card-medium: 460px; 24 | --width-card-wide: 800px; 25 | --width-content: 1080px; 26 | } 27 | 28 | @media (prefers-color-scheme: dark) { 29 | :root { 30 | --color-accent: #029d74; 31 | --color-bg: #333; 32 | --color-bg-secondary: #555; 33 | --color-link: #029d74; 34 | --color-secondary: #e20de9; 35 | --color-secondary-accent: #e20de94f; 36 | --color-shadow: #bbbbbb20; 37 | --color-table: #029d74; 38 | --color-text: #f7f7f7; 39 | --color-text-secondary: #aaa; 40 | } 41 | } 42 | 43 | /* Layout */ 44 | article aside { 45 | background: var(--color-secondary-accent); 46 | border-left: 4px solid var(--color-secondary); 47 | padding: 0.01rem 0.8rem; 48 | } 49 | 50 | body { 51 | background: var(--color-bg); 52 | color: var(--color-text); 53 | font-family: var(--font-family); 54 | line-height: var(--line-height); 55 | margin: 0; 56 | overflow-x: hidden; 57 | padding: 0; 58 | } 59 | 60 | footer, 61 | header, 62 | main { 63 | margin: 0 auto; 64 | max-width: var(--width-content); 65 | padding: 3rem 1rem; 66 | } 67 | 68 | hr { 69 | background-color: var(--color-bg-secondary); 70 | border: none; 71 | height: 1px; 72 | margin: 2rem 0; 73 | width: 100%; 74 | } 75 | 76 | section { 77 | display: flex; 78 | flex-wrap: wrap; 79 | justify-content: var(--justify-important); 80 | } 81 | 82 | section img, 83 | article img { 84 | max-width: 100%; 85 | } 86 | 87 | section pre { 88 | overflow: auto; 89 | } 90 | 91 | section aside { 92 | border: 1px solid var(--color-bg-secondary); 93 | border-radius: var(--border-radius); 94 | box-shadow: var(--box-shadow) var(--color-shadow); 95 | margin: 1rem; 96 | padding: 1.25rem; 97 | width: var(--width-card); 98 | } 99 | 100 | section aside:hover { 101 | box-shadow: var(--box-shadow) var(--color-bg-secondary); 102 | } 103 | 104 | [hidden] { 105 | display: none; 106 | } 107 | 108 | /* Headers */ 109 | article header, 110 | div header, 111 | main header { 112 | padding-top: 0; 113 | } 114 | 115 | header { 116 | text-align: var(--justify-important); 117 | } 118 | 119 | header a b, 120 | header a em, 121 | header a i, 122 | header a strong { 123 | margin-left: 0.5rem; 124 | margin-right: 0.5rem; 125 | } 126 | 127 | header nav img { 128 | margin: 1rem 0; 129 | } 130 | 131 | section header { 132 | padding-top: 0; 133 | width: 100%; 134 | } 135 | 136 | /* Nav */ 137 | nav { 138 | align-items: center; 139 | display: flex; 140 | font-weight: bold; 141 | justify-content: space-between; 142 | margin-bottom: 7rem; 143 | } 144 | 145 | nav ul { 146 | list-style: none; 147 | padding: 0; 148 | } 149 | 150 | nav ul li { 151 | display: inline-block; 152 | margin: 0 0.5rem; 153 | position: relative; 154 | text-align: left; 155 | } 156 | 157 | /* Nav Dropdown */ 158 | nav ul li:hover ul { 159 | display: block; 160 | } 161 | 162 | nav ul li ul { 163 | background: var(--color-bg); 164 | border: 1px solid var(--color-bg-secondary); 165 | border-radius: var(--border-radius); 166 | box-shadow: var(--box-shadow) var(--color-shadow); 167 | display: none; 168 | height: auto; 169 | left: -2px; 170 | padding: .5rem 1rem; 171 | position: absolute; 172 | top: 1.7rem; 173 | white-space: nowrap; 174 | width: auto; 175 | z-index: 1; 176 | } 177 | 178 | nav ul li ul::before { 179 | /* fill gap above to make mousing over them easier */ 180 | content: ""; 181 | position: absolute; 182 | left: 0; 183 | right: 0; 184 | top: -0.5rem; 185 | height: 0.5rem; 186 | } 187 | 188 | nav ul li ul li, 189 | nav ul li ul li a { 190 | display: block; 191 | } 192 | 193 | /* Typography */ 194 | code, 195 | samp { 196 | background-color: var(--color-accent); 197 | border-radius: var(--border-radius); 198 | color: var(--color-text); 199 | display: inline-block; 200 | margin: 0 0.1rem; 201 | padding: 0 0.5rem; 202 | } 203 | 204 | details { 205 | margin: 1.3rem 0; 206 | } 207 | 208 | details summary { 209 | font-weight: bold; 210 | cursor: pointer; 211 | } 212 | 213 | h1, 214 | h2, 215 | h3, 216 | h4, 217 | h5, 218 | h6 { 219 | line-height: var(--line-height); 220 | } 221 | 222 | mark { 223 | padding: 0.1rem; 224 | } 225 | 226 | ol li, 227 | ul li { 228 | padding: 0.2rem 0; 229 | } 230 | 231 | p { 232 | margin: 0.75rem 0; 233 | padding: 0; 234 | width: 100%; 235 | } 236 | 237 | pre { 238 | margin: 1rem 0; 239 | max-width: var(--width-card-wide); 240 | padding: 1rem 0; 241 | } 242 | 243 | pre code, 244 | pre samp { 245 | display: block; 246 | max-width: var(--width-card-wide); 247 | padding: 0.5rem 2rem; 248 | white-space: pre-wrap; 249 | } 250 | 251 | small { 252 | color: var(--color-text-secondary); 253 | } 254 | 255 | sup { 256 | background-color: var(--color-secondary); 257 | border-radius: var(--border-radius); 258 | color: var(--color-bg); 259 | font-size: xx-small; 260 | font-weight: bold; 261 | margin: 0.2rem; 262 | padding: 0.2rem 0.3rem; 263 | position: relative; 264 | top: -2px; 265 | } 266 | 267 | /* Links */ 268 | a { 269 | color: var(--color-link); 270 | display: inline-block; 271 | font-weight: bold; 272 | text-decoration: none; 273 | } 274 | 275 | a:active { 276 | filter: brightness(var(--active-brightness)); 277 | text-decoration: underline; 278 | } 279 | 280 | a:hover { 281 | filter: brightness(var(--hover-brightness)); 282 | text-decoration: underline; 283 | } 284 | 285 | a b, 286 | a em, 287 | a i, 288 | a strong, 289 | button, 290 | input[type="submit"] { 291 | border-radius: var(--border-radius); 292 | display: inline-block; 293 | font-size: medium; 294 | font-weight: bold; 295 | line-height: var(--line-height); 296 | margin: 0.5rem 0; 297 | padding: 1rem 2rem; 298 | } 299 | 300 | button, 301 | input[type="submit"] { 302 | font-family: var(--font-family); 303 | } 304 | 305 | button:active, 306 | input[type="submit"]:active { 307 | filter: brightness(var(--active-brightness)); 308 | } 309 | 310 | button:hover, 311 | input[type="submit"]:hover { 312 | cursor: pointer; 313 | filter: brightness(var(--hover-brightness)); 314 | } 315 | 316 | a b, 317 | a strong, 318 | button, 319 | input[type="submit"] { 320 | background-color: var(--color-link); 321 | border: 2px solid var(--color-link); 322 | color: var(--color-bg); 323 | } 324 | 325 | a em, 326 | a i { 327 | border: 2px solid var(--color-link); 328 | border-radius: var(--border-radius); 329 | color: var(--color-link); 330 | display: inline-block; 331 | padding: 1rem 2rem; 332 | } 333 | 334 | article aside a { 335 | color: var(--color-secondary); 336 | } 337 | 338 | /* Images */ 339 | figure { 340 | margin: 0; 341 | padding: 0; 342 | } 343 | 344 | figure img { 345 | max-width: 100%; 346 | } 347 | 348 | figure figcaption { 349 | color: var(--color-text-secondary); 350 | } 351 | 352 | /* Forms */ 353 | button:disabled, 354 | input:disabled { 355 | background: var(--color-bg-secondary); 356 | border-color: var(--color-bg-secondary); 357 | color: var(--color-text-secondary); 358 | cursor: not-allowed; 359 | } 360 | 361 | button[disabled]:hover, 362 | input[type="submit"][disabled]:hover { 363 | filter: none; 364 | } 365 | 366 | form { 367 | border: 1px solid var(--color-bg-secondary); 368 | border-radius: var(--border-radius); 369 | box-shadow: var(--box-shadow) var(--color-shadow); 370 | display: block; 371 | max-width: var(--width-card-wide); 372 | min-width: var(--width-card); 373 | padding: 1.5rem; 374 | text-align: var(--justify-normal); 375 | } 376 | 377 | form header { 378 | margin: 1.5rem 0; 379 | padding: 1.5rem 0; 380 | } 381 | 382 | input, 383 | label, 384 | select, 385 | textarea { 386 | display: block; 387 | font-size: inherit; 388 | max-width: var(--width-card-wide); 389 | } 390 | 391 | input[type="checkbox"], 392 | input[type="radio"] { 393 | display: inline-block; 394 | } 395 | 396 | input[type="checkbox"]+label, 397 | input[type="radio"]+label { 398 | display: inline-block; 399 | font-weight: normal; 400 | position: relative; 401 | top: 1px; 402 | } 403 | 404 | input[type="range"] { 405 | padding: 0.4rem 0; 406 | } 407 | 408 | input, 409 | select, 410 | textarea { 411 | border: 1px solid var(--color-bg-secondary); 412 | border-radius: var(--border-radius); 413 | margin-bottom: 1rem; 414 | padding: 0.4rem 0.8rem; 415 | } 416 | 417 | input[type="text"], 418 | textarea { 419 | width: calc(100% - 1.6rem); 420 | } 421 | 422 | input[readonly], 423 | textarea[readonly] { 424 | background-color: var(--color-bg-secondary); 425 | } 426 | 427 | label { 428 | font-weight: bold; 429 | margin-bottom: 0.2rem; 430 | } 431 | 432 | /* Popups */ 433 | dialog { 434 | border: 1px solid var(--color-bg-secondary); 435 | border-radius: var(--border-radius); 436 | box-shadow: var(--box-shadow) var(--color-shadow); 437 | position: fixed; 438 | top: 50%; 439 | left: 50%; 440 | transform: translate(-50%, -50%); 441 | width: 50%; 442 | z-index: 999; 443 | } 444 | 445 | /* Tables */ 446 | table { 447 | border: 1px solid var(--color-bg-secondary); 448 | border-radius: var(--border-radius); 449 | border-spacing: 0; 450 | display: inline-block; 451 | max-width: 100%; 452 | overflow-x: auto; 453 | padding: 0; 454 | white-space: nowrap; 455 | } 456 | 457 | table td, 458 | table th, 459 | table tr { 460 | padding: 0.4rem 0.8rem; 461 | text-align: var(--justify-important); 462 | } 463 | 464 | table thead { 465 | background-color: var(--color-table); 466 | border-collapse: collapse; 467 | border-radius: var(--border-radius); 468 | color: var(--color-bg); 469 | margin: 0; 470 | padding: 0; 471 | } 472 | 473 | table thead th:first-child { 474 | border-top-left-radius: var(--border-radius); 475 | } 476 | 477 | table thead th:last-child { 478 | border-top-right-radius: var(--border-radius); 479 | } 480 | 481 | table thead th:first-child, 482 | table tr td:first-child { 483 | text-align: var(--justify-normal); 484 | } 485 | 486 | table tr:nth-child(even) { 487 | background-color: var(--color-accent); 488 | } 489 | 490 | /* Quotes */ 491 | blockquote { 492 | display: block; 493 | font-size: x-large; 494 | line-height: var(--line-height); 495 | margin: 1rem auto; 496 | max-width: var(--width-card-medium); 497 | padding: 1.5rem 1rem; 498 | text-align: var(--justify-important); 499 | } 500 | 501 | blockquote footer { 502 | color: var(--color-text-secondary); 503 | display: block; 504 | font-size: small; 505 | line-height: var(--line-height); 506 | padding: 1.5rem 0; 507 | } 508 | 509 | /* Custom Extras */ 510 | 511 | body { 512 | font-size: 18px; 513 | } 514 | header { 515 | padding: 1rem; 516 | } 517 | main { 518 | padding: 0 1rem; 519 | } 520 | 521 | form { 522 | margin: 0 auto; 523 | } 524 | 525 | form header { 526 | margin: 0; 527 | padding: 0.5rem 0; 528 | } 529 | 530 | fieldset { 531 | margin-top: 2rem; 532 | } 533 | 534 | select { 535 | max-width: 100%; 536 | } 537 | 538 | div { 539 | max-width: 600px; 540 | } 541 | 542 | p a { 543 | display: inline; 544 | } 545 | 546 | sup { 547 | font-size: small; 548 | } 549 | 550 | @keyframes fade { 551 | 0%,100% { opacity: 0; } 552 | 20% { opacity: 1; } 553 | } 554 | 555 | .fade { 556 | animation: fade 3s linear forwards; 557 | } 558 | 559 | details:target { 560 | outline: 1px solid darkred; 561 | } 562 | 563 | .logo { 564 | transform: translate(0, 15px); 565 | width: 2em; 566 | } 567 | -------------------------------------------------------------------------------- /assets/social.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/assets/social.png -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [['@babel/preset-env', { targets: { node: 'current' } }]] 3 | } 4 | -------------------------------------------------------------------------------- /dist.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -ex 3 | 4 | mkdir -p dist 5 | rm -f dist/bibbot.zip 6 | npm run build 7 | zip -r -FS dist/bibbot.zip LICENSE README.md assets/* build/* icons/* manifest.json options/* popup/* 8 | 9 | rm -rf dist/bibbot 10 | unzip dist/bibbot.zip -d dist/bibbot 11 | -------------------------------------------------------------------------------- /generate_icons.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | pushd icons 4 | sed 's/#029d74/#333/g' bibbot_simple.svg > bibbot_monochrome.svg 5 | 6 | for height in 16 19 32 38 48 64 96 128 192 256 288 512 1024 7 | do 8 | 9 | rsvg-convert -b "#fff" -h $height bibbot_simple.svg > bibbot-$height.png 10 | rsvg-convert -h $height bibbot.svg > bibbot-alpha-$height.png 11 | rsvg-convert -b "#fff" -h $height bibbot_monochrome.svg > bibbot-mono-$height.png 12 | 13 | done 14 | 15 | popd -------------------------------------------------------------------------------- /icons/bibbot-1024.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-1024.png -------------------------------------------------------------------------------- /icons/bibbot-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-128.png -------------------------------------------------------------------------------- /icons/bibbot-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-16.png -------------------------------------------------------------------------------- /icons/bibbot-19.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-19.png -------------------------------------------------------------------------------- /icons/bibbot-192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-192.png -------------------------------------------------------------------------------- /icons/bibbot-256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-256.png -------------------------------------------------------------------------------- /icons/bibbot-288.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-288.png -------------------------------------------------------------------------------- /icons/bibbot-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-32.png -------------------------------------------------------------------------------- /icons/bibbot-38.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-38.png -------------------------------------------------------------------------------- /icons/bibbot-48.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-48.png -------------------------------------------------------------------------------- /icons/bibbot-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-512.png -------------------------------------------------------------------------------- /icons/bibbot-64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-64.png -------------------------------------------------------------------------------- /icons/bibbot-96.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-96.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-1024.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-1024.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-128.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-16.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-19.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-19.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-192.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-256.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-288.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-288.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-32.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-38.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-38.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-48.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-48.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-512.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-64.png -------------------------------------------------------------------------------- /icons/bibbot-alpha-96.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-alpha-96.png -------------------------------------------------------------------------------- /icons/bibbot-mono-1024.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-1024.png -------------------------------------------------------------------------------- /icons/bibbot-mono-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-128.png -------------------------------------------------------------------------------- /icons/bibbot-mono-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-16.png -------------------------------------------------------------------------------- /icons/bibbot-mono-19.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-19.png -------------------------------------------------------------------------------- /icons/bibbot-mono-192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-192.png -------------------------------------------------------------------------------- /icons/bibbot-mono-256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-256.png -------------------------------------------------------------------------------- /icons/bibbot-mono-288.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-288.png -------------------------------------------------------------------------------- /icons/bibbot-mono-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-32.png -------------------------------------------------------------------------------- /icons/bibbot-mono-38.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-38.png -------------------------------------------------------------------------------- /icons/bibbot-mono-48.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-48.png -------------------------------------------------------------------------------- /icons/bibbot-mono-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-512.png -------------------------------------------------------------------------------- /icons/bibbot-mono-64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-64.png -------------------------------------------------------------------------------- /icons/bibbot-mono-96.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stefanw/bibbot/b8a48efca92e1c0ce510e5607a46049888d18897/icons/bibbot-mono-96.png -------------------------------------------------------------------------------- /icons/bibbot.svg: -------------------------------------------------------------------------------- 1 | 2 | 24 | 25 | 27 | image/svg+xml 28 | 30 | 31 | 32 | 33 | 34 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 57 | 94 | 95 | 102 | 112 | 122 | 151 | 156 | 161 | 166 | 171 | 176 | 181 | 186 | 191 | 196 | 201 | 206 | 211 | 212 | 251 | 252 | 257 | 263 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | 401 | 402 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | -------------------------------------------------------------------------------- /icons/bibbot_monochrome.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | image/svg+xml 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /icons/bibbot_simple.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | image/svg+xml 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | 5 | 6 | 7 | BibBot – Mit Bibliothekszugang durch die Paywall 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 |
34 |

35 | 36 | BibBot 37 |

38 | 39 | {{ release.tag_name }} 40 |

41 | Browser-Erweiterung, um Premiumangebote deutscher Nachrichtenseiten über Ihren Bibliothekszugang zu nutzen. 42 |

43 |

44 | 45 | Download für Chrome 46 | 47 | 48 | Download für Firefox 49 | 50 | 51 | Download für Safari 52 | 53 |

54 |
55 |
56 |
57 |
58 |

59 | Für die Nutzung des Add-Ons benötigen Sie ein Benutzerkonto bei einer Bibliothek mit Zugang zu einer digitalen Pressedatenbank. Das haben viele Bibliotheken als Teil ihres digitalen Angebots. 60 |

61 |

62 | Ein Bibliothekskonto kostet meistens nicht mehr als 10 Euro im Jahr – das ist wesentlich günstiger als jedes einzelne Abo bei einer Nachrichtenseite und dafür bekommen Sie Zugang zu den Texten einer Vielzahl von Nachrichtenseiten + viele weitere digitale Medien. 63 |

64 |
65 | So funktioniert das Add-On 66 |

Wenn die Extension einen Artikel mit Paywall auf einer der unterstützten Nachrichtenseiten findet, dann:

67 |
    68 |
  1. Öffnet sich im Hintergrund ein neues Tab, wo sich falls nötig bei Ihrer Bibliothek eingeloggt wird
    2. 69 |
  2. In der Pressedatenbank wird automatisch im Hintergrund der Artikel gesucht
    3. 70 |
  3. Wird der Artikel in der Pressedatenbank gefunden, dann wird der Artikeltext in das Layout der Nachrichtenseite eingesetzt.
    4. 71 |
72 |

Der Vorgang dauert im Regelfall wenige Sekunden.

73 |
74 |
75 | Das kann schief gehen 76 |

Es kann passieren, dass BibBot den Artikel nicht findet. Folgende Gründe sind möglich:

77 |
    78 |
  • 79 | ggf. ist der Artikel online-exklusiv und nicht über die Pressedatenbank verfügbar 80 |
    • 81 |
  • 82 | Der Titel des Online-Artikels kann sich von der Druckausgabe unterscheiden, das macht das Auffinden schwierig.
    → Nutzen Sie das neue Tab am Ende Ihrer Tableiste um selbst nach Stichworten zum Artikel zu suchen. 83 |
    • 84 |
  • 85 | Artikel aus der gedruckten Ausgabe sind ggf. erst später in der Pressedatenbank verfügbar.
    → Da müssen Sie leider Geduld haben. 86 |
    • 87 |
88 |

Außerdem kann es sein, dass Ihre gewünschte Nachrichtenseite noch nicht unterstützt wird. Eine Liste der unterstützten Seiten finden Sie im weiter unten.

89 |
90 |
91 | Aktuell unterstützte Bibliotheksseiten 92 |
    93 |

    94 | Fehlt Ihre Bibliothek mit Digitalangebot? Dann können Sie auf der Entwicklungsplattform GitHub einen Vorschlag machen. 95 |

    96 |
    97 |
    98 | Aktuell unterstützte Nachrichtenseiten 99 |
      100 |

      101 | Fehlt Ihnen eine Seite? Dann können Sie auf der Entwicklungsplattform GitHub einen Vorschlag machen. 102 |

      103 |
      104 |
      105 | Erweiterung für Safari 106 |
      107 | {% assign latest_safari = false %} 108 | {% for release in site.github.releases %} 109 | {% for asset in release.assets %} 110 | {% if asset.name == "BibBot-Safari-macOS.zip" %} 111 | {% assign latest_safari = asset.browser_download_url %} 112 | {% break %} 113 | {% endif %} 114 | {% endfor %} 115 | {% if latest_safari != false %} 116 | {% break %} 117 | {% endif %} 118 | {% endfor %} 119 |
      120 | 121 | Download der Safari-Erweiterung 122 | 123 |

      124 | Um die Safari-Version zu nutzen: 125 |

        126 |
      1. Safari öffnen
        2. 127 |
      2. Entwickler-Menü aktivieren: „Safari“ > „Einstellungen“, klicke auf „Erweitert“ und wähle dann „Menü ,Entwickler’ in der Menüleiste anzeigen“ (Siehe Safari-Benutzerhandbuch)
        3. 128 |
      3. Im Entwickler-Menü in der Menüleiste: ganz unten Haken setzen bei "Erlaube Unsignierte Erweiterungen"
        4. 129 |
      4. Heruntergeladenes ZIP-Archiv entpacken, App öffnen und Sicherheitshinweis bestätigen
        5. 130 |
      5. Unter „Safari“ > „Einstellungen“ unter „Erweiterungen“ dem BibBot per Haken aktivieren
        6. 131 |
      6. BibBot über die BibBot-Einstellungsseite konfigurieren
        7. 132 |
      133 |

      134 |
      135 |
      136 |
      137 |
      138 | 149 | 182 | 183 | 184 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "manifest_version": 3, 3 | "name": "BibBot", 4 | "version": "0.40.2", 5 | "description": "Vereinfacht die Suche nach Artikeln in der Bibliothek", 6 | "icons": { 7 | "48": "icons/bibbot-48.png", 8 | "96": "icons/bibbot-96.png", 9 | "128": "icons/bibbot-128.png", 10 | "256": "icons/bibbot-256.png", 11 | "512": "icons/bibbot-512.png", 12 | "1024": "icons/bibbot-1024.png" 13 | }, 14 | "permissions": [ 15 | "activeTab", 16 | "tabs", 17 | "storage", 18 | "scripting" 19 | ], 20 | "host_permissions": [ 21 | "https://*.genios.de/*" 22 | ], 23 | "optional_host_permissions": [ 24 | "https://www.munzinger.de/*", 25 | "https://www.voebb.de/*", 26 | "https://www.wiso-net.de/*", 27 | "https://*.stbhannover.idm.oclc.org/*", 28 | "https://*.han.landesbibliothek.at/*", 29 | "https://*.stadtbibliothek.leipzig.de/*", 30 | "https://*.ezp-lhd.itk-rheinland.de/*", 31 | "https://*.ub-proxy.fernuni-hagen.de/*", 32 | "https://*.ezproxy.stadt-koeln.de/*", 33 | "https://*.stb-aachen.idm.oclc.org/*", 34 | "https://login.slub-dresden.de/*", 35 | "https://www-wiso-net-de.wwwdb.dbod.de/*", 36 | "https://*.bsb-muenchen.de/*", 37 | "https://go.openathens.net/*", 38 | "https://katalog.dortmund.de/*", 39 | "https://advance-lexis-com.eu1.proxy.openathens.net/*", 40 | "https://*.bonn.idm.oclc.org/*", 41 | "https://online-service2.nuernberg.de/*", 42 | "https://*.webopac.wuppertal.de:1443/*", 43 | "https://ssl.muenchen.de/*" 44 | ], 45 | "background": { 46 | "service_worker": "build/background.js", 47 | "scripts": [ 48 | "build/background.js" 49 | ], 50 | "persistent": false, 51 | "type": "module" 52 | }, 53 | "content_scripts": [ 54 | { 55 | "matches": [ 56 | "https://www.spiegel.de/*", 57 | "https://www.zeit.de/*", 58 | "https://www.wiwo.de/*", 59 | "https://www.welt.de/*", 60 | "https://www.tagesspiegel.de/*", 61 | "https://www.sueddeutsche.de/*", 62 | "https://sz-magazin.sueddeutsche.de/*", 63 | "https://www.handelsblatt.com/*", 64 | "https://www.berliner-zeitung.de/*", 65 | "https://www.morgenpost.de/*", 66 | "https://www.nordkurier.de/*", 67 | "https://www.abendblatt.de/*", 68 | "https://www.moz.de/*", 69 | "https://www.noz.de/*", 70 | "https://www.waz.de/*", 71 | "https://www.heise.de/*", 72 | "https://www.maz-online.de/*", 73 | "https://www.lr-online.de/*", 74 | "https://www.nachrichten.at/*", 75 | "https://ga.de/*", 76 | "https://www.ksta.de/*", 77 | "https://www.rundschau-online.de/*", 78 | "https://rp-online.de/*", 79 | "https://www.tagesanzeiger.ch/*", 80 | "https://www.falter.at/*", 81 | "https://www.stuttgarter-zeitung.de/*", 82 | "https://www.stuttgarter-nachrichten.de/*", 83 | "https://www.ostsee-zeitung.de/*", 84 | "https://www.stimme.de/*", 85 | "https://kurier.at/*", 86 | "https://freizeit.at/*", 87 | "https://www.diepresse.com/*", 88 | "https://www.sn.at/*", 89 | "https://www.kleinezeitung.at/*", 90 | "https://www.vn.at/*", 91 | "https://www.thueringer-allgemeine.de/*", 92 | "https://www.mopo.de/*", 93 | "https://www.saechsische.de/*", 94 | "https://www.freiepresse.de/*", 95 | "https://www.haz.de/*", 96 | "https://www.lvz.de/*", 97 | "https://www.dnn.de/*", 98 | "https://www.swp.de/*", 99 | "https://www.ruhrnachrichten.de/*", 100 | "https://www.businessinsider.de/*", 101 | "https://www.badische-zeitung.de/*", 102 | "https://www.stern.de/*", 103 | "https://www.mittelbayerische.de/*", 104 | "https://www.tagblatt.de/*", 105 | "https://www.mz.de/*", 106 | "https://www.capital.de/*", 107 | "https://www.iz.de/*", 108 | "https://www.shz.de/*", 109 | "https://www.aerztezeitung.de/*", 110 | "https://www.geo.de/*", 111 | "https://www.nzz.ch/*", 112 | "https://www.manager-magazin.de/*", 113 | "https://www.nwzonline.de/*", 114 | "https://www.saarbruecker-zeitung.de/*", 115 | "https://www.idowa.de/*", 116 | "https://www.aachener-zeitung.de/*", 117 | "https://www.nn.de/*" 118 | ], 119 | "js": [ 120 | "build/content.js" 121 | ], 122 | "run_at": "document_end", 123 | "all_frames": true 124 | } 125 | ], 126 | "content_security_policy": { 127 | "extension_pages": "default-src 'self'" 128 | }, 129 | "options_ui": { 130 | "open_in_tab": true, 131 | "page": "options/options.html" 132 | }, 133 | "action": { 134 | "default_icon": { 135 | "19": "icons/bibbot-mono-19.png", 136 | "38": "icons/bibbot-mono-38.png", 137 | "48": "icons/bibbot-mono-48.png", 138 | "96": "icons/bibbot-mono-96.png", 139 | "128": "icons/bibbot-mono-128.png", 140 | "256": "icons/bibbot-mono-256.png", 141 | "512": "icons/bibbot-mono-512.png", 142 | "1024": "icons/bibbot-mono-1024.png" 143 | }, 144 | "default_popup": "popup/popup.html", 145 | "default_title": "BibBot" 146 | }, 147 | "browser_specific_settings": { 148 | "gecko": { 149 | "id": "voebbot@stefanwehrmeyer.com", 150 | "strict_min_version": "101.0" 151 | } 152 | } 153 | } -------------------------------------------------------------------------------- /options/options.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | BibBot - Einstellungen 7 | 8 | 9 | 10 | 11 |
      12 |

      13 | 14 | BibBot 15 | 16 |

      17 |

      18 | Deutsche Nachrichtenseiten über die Bib lesen 19 |

      20 |
      21 |
      22 |
      23 |
      24 |
      25 | Notwendige Einrichtung des Add-Ons 26 |

      27 | Sie benötigen ein Benutzerkonto bei einer der unterstützten Bibliotheken. 28 | Ein Bibliotheks-Konto ist wesentlich günstiger als jedes einzelne Abo bei einer Nachrichtenseite und dafür bekommen Sie Zugang zu den Texten einer Vielzahl von Nachrichtenseiten + viele weitere digitale Medien. 29 |

      30 |
      31 |
      32 | So funktioniert das Add-On 33 |

      Wenn die Extension einen nicht frei verfügbaren Artikel auf einer der unterstützten Nachrichtenseiten findet, dann:

      34 |
        35 |
      1. Öffnet sich im Hintergrund ein neues Tab, wo sich falls nötig mit dem angegebenen Bibliothekszugang eingeloggt wird
        2. 36 |
      2. Beim Pressedatenbank-Partner der Bibliothek (z.B. Genios) wird automatisch im Hintergrund der Artikel gesucht
        3. 37 |
      3. Wird der Artikel in der Pressedatenbank gefunden, dann wird der Artikeltext in das Layout der Nachrichtenseite eingesetzt.
        4. 38 |
      39 |

      Der Vorgang dauert im Regelfall wenige Sekunden.

      40 |
      41 |
      42 | Das kann schief gehen 43 |

      Es kann passieren, dass BibBot den Artikel nicht findet. Folgende Gründe sind möglich:

      44 |
        45 |
      • 46 | ggf. ist der Artikel online-exklusiv und nicht über die Pressedatenbank verfügbar 47 |
        • 48 |
      • 49 | Der Titel des Online-Artikels kann sich von der Druckausgabe unterscheiden, das macht das Auffinden schwierig.
        → Nutzen Sie das neue Tab am Ende Ihrer Tableiste um selbst nach Stichworten zum Artikel zu suchen. 50 |
        • 51 |
      • 52 | Artikel aus der gedruckten Ausgabe sind ggf. erst später in der Pressedatenbank verfügbar.
        → Da müssen Sie leider Geduld haben. 53 |
        • 54 |
      55 |

      Außerdem kann es sein, dass Ihre gewünschte Nachrichtenseite noch nicht unterstützt wird. Eine Liste der unterstützten Seiten finden Sie im nächsten Abschnitt.

      56 |
      57 |
      58 | Aktuell unterstützte Bibliotheksseiten 59 |
        60 |

        61 | Fehlt Ihre Bibliothek mit Digitalangebot? Dann können Sie auf der Entwicklungsplattform GitHub einen Vorschlag machen. 62 |

        63 |
        64 |
        65 | Aktuell unterstützte Nachrichtenseiten 66 |
          67 |

          68 | Fehlt Ihnen eine Seite? Dann können Sie auf der Entwicklungsplattform GitHub einen Vorschlag machen. 69 |

          70 |
          71 |
          72 |
          73 |
          74 |
          75 |

          Einstellungen

          76 |
          77 |

          Bibliotheks-Zugangsdaten

          78 | 79 | 81 |

          Bibliotheks-Optionen

          82 |
          83 | 88 |

          89 | 90 | Hinweis: Ihr Daten (inkl. Passwort) werden im Klartext gespeichert, so dass diese automatisch ausgefüllt werden können.
          91 |           92 |

          93 |

          Wollen Sie wissen, ob sich ein direktes Abo bei einem Medium lohnt?

          94 | 98 | 99 | Die Anzahl der erfolgreich in der Bibliothek gefundenen Artikel können pro Nachrichtenseite gezählt werden. 100 | Diese Daten werden nur für Sie im Browser gespeichert. 101 | 102 | 103 |
          104 | Weitere Einstellungen 105 | 106 |

          BibBot auf diesen Seiten deaktivieren

          107 |

          Wenn Sie auf diesen Seiten ein Abo haben, können Sie BibBot für diese Seiten deaktivieren.

          108 | 110 | CMD/Strg gedrückt halten, um mehrere auszuwählen 111 | 112 |

          Artikel später lesen

          113 |

          114 | Wenn ein Artikel gefunden wurde, können Sie über den Button „Später lesen“ den Titel, die URL und den Artikelinhalt an eine URL per POST-Formular schicken. 115 | Das können Sie zum Beispiel nutzen, um eine Privatkopie des Inhalts anzulegen zum späteren Lesen. 116 |

          117 | 120 |
          121 | 122 | 123 | Bitte lesen Sie sich vor Benutzung die Nutzungsbedingungen und Datenschutzerklärungen der Anbieter, die Sie nutzen möchten, durch. 124 | Durch die Nutzung dieses Add-Ons stimmen Sie den Nutzungsbedingungen und Datenschutzerklärungen der Anbieter zu. 125 | 129 | 130 | 131 |
          132 |

          133 | Kurz gucken, ob es funktioniert? 134 |

          135 |

          136 | 137 | Klicken Sie hier, um als Test einen Paywall-Artikel zu öffnen. 138 | 139 |

          140 | 141 |
          142 | 152 | 153 | 154 | 155 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "bibbot", 3 | "version": "0.40.2", 4 | "description": "BibBot removes paywalls of German media sites", 5 | "devDependencies": { 6 | "@babel/core": "^7.20.12", 7 | "@babel/preset-env": "^7.20.2", 8 | "@playwright/test": "^1.41.1", 9 | "@rollup/plugin-commonjs": "^24.0.0", 10 | "@rollup/plugin-node-resolve": "^15.0.1", 11 | "@rollup/plugin-typescript": "^10.0.1", 12 | "@types/chrome": "^0.0.287", 13 | "@types/node": "^20.10.6", 14 | "@types/webextension-polyfill": "^0.9.2", 15 | "@typescript-eslint/eslint-plugin": "^5.62.0", 16 | "@typescript-eslint/parser": "^5.62.0", 17 | "eslint": "^8.57.1", 18 | "eslint-config-prettier": "^9.1.0", 19 | "eslint-config-standard": "^17.0.0", 20 | "eslint-plugin-import": "^2.26.0", 21 | "eslint-plugin-node": "^11.1.0", 22 | "eslint-plugin-promise": "^6.1.1", 23 | "husky": "^9.1.7", 24 | "node-fetch": "^3.3.0", 25 | "prettier": "^3.4.1", 26 | "prettier-eslint": "^16.3.0", 27 | "rollup": "^3.9.1", 28 | "typescript": "^5.5.4", 29 | "typescript-eslint": "^8.16.0", 30 | "webextension-polyfill": "^0.10.0" 31 | }, 32 | "scripts": { 33 | "start": "rollup --bundleConfigAsCjs -c -w", 34 | "build": "rollup --bundleConfigAsCjs -c", 35 | "lint": "eslint src tests", 36 | "check-types": "tsc --noemit", 37 | "test-sites": "npx playwright test tests/sites.spec.ts --reporter list", 38 | "test-extension": "npx playwright test tests/extension.spec.ts --reporter dot --headed", 39 | "test": "npx playwright test", 40 | "version": "gsed -i '4s/\"version\": \".*\",/\"version\": \"'\"$(jq -r .version package.json)\"'\",/' manifest.json && git add manifest.json", 41 | "prepare": "husky" 42 | }, 43 | "repository": { 44 | "type": "git", 45 | "url": "git+https://github.com/stefanw/bibbot.git" 46 | }, 47 | "author": "Stefan Wehrmeyer", 48 | "license": "GPL-3.0-or-later", 49 | "bugs": { 50 | "url": "https://github.com/stefanw/bibbot/issues" 51 | }, 52 | "homepage": "https://stefanw.github.io/bibbot/" 53 | } 54 | -------------------------------------------------------------------------------- /playwright.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig, devices } from '@playwright/test' 2 | 3 | /** 4 | * Read environment variables from file. 5 | * https://github.com/motdotla/dotenv 6 | */ 7 | // require('dotenv').config(); 8 | 9 | /** 10 | * See https://playwright.dev/docs/test-configuration. 11 | */ 12 | export default defineConfig({ 13 | testDir: './tests', 14 | /* Run tests in files in parallel */ 15 | fullyParallel: true, 16 | /* Fail the build on CI if you accidentally left test.only in the source code. */ 17 | forbidOnly: !!process.env.CI, 18 | /* Retry on CI only */ 19 | retries: process.env.CI ? 2 : 0, 20 | /* Opt out of parallel tests on CI. */ 21 | workers: process.env.CI ? 1 : undefined, 22 | /* Reporter to use. See https://playwright.dev/docs/test-reporters */ 23 | reporter: 'html', 24 | /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ 25 | use: { 26 | /* Base URL to use in actions like `await page.goto('/')`. */ 27 | // baseURL: 'http://127.0.0.1:3000', 28 | 29 | /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ 30 | trace: 'on-first-retry', 31 | }, 32 | 33 | /* Configure projects for major browsers */ 34 | projects: [ 35 | { 36 | name: 'chromium', 37 | use: { ...devices['Desktop Chrome'] }, 38 | }, 39 | 40 | // { 41 | // name: 'firefox', 42 | // use: { ...devices['Desktop Firefox'] } 43 | // }, 44 | 45 | // { 46 | // name: 'webkit', 47 | // use: { ...devices['Desktop Safari'] } 48 | // }, 49 | 50 | /* Test against mobile viewports. */ 51 | // { 52 | // name: 'Mobile Chrome', 53 | // use: { ...devices['Pixel 5'] }, 54 | // }, 55 | // { 56 | // name: 'Mobile Safari', 57 | // use: { ...devices['iPhone 12'] }, 58 | // }, 59 | ], 60 | }) 61 | -------------------------------------------------------------------------------- /popup/popup.css: -------------------------------------------------------------------------------- 1 | body { 2 | padding: 10px; 3 | min-width: 160px; 4 | } 5 | 6 | h3 { 7 | margin-top: 3px; 8 | margin-bottom: 5px; 9 | } 10 | 11 | a { 12 | text-decoration: underline; 13 | } 14 | 15 | p { 16 | margin-bottom: 0; 17 | } 18 | 19 | ul { 20 | list-style-type: none; 21 | padding-left: 10px; 22 | margin-top: 0; 23 | max-height: 200px; 24 | overflow-y: scroll; 25 | } -------------------------------------------------------------------------------- /popup/popup.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |

          11 | Schematischer Roboter 12 | BibBot 13 |

          14 |

          15 | Einstellungen 16 |

          17 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /privacy.md: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | # Datenschutzerklärung 5 | 6 | ## Betreiber 7 | 8 | [Siehe Impressum.](https://stefanwehrmeyer.com/impressum/) 9 | 10 | ## Datenerhebung 11 | 12 | Die Browser-Erweiterung speichert Daten nur lokal auf dem Endgerät des Nutzers. Eine Übertragung findet nicht statt. 13 | 14 | ## Hosting 15 | 16 | Unser Hoster erhebt in sog. Logfiles folgende Daten, die Ihr Browser übermittelt: 17 | 18 | IP-Adresse, die Adresse der vorher besuchten Website (Referer Anfrage-Header), Datum und Uhrzeit der Anfrage, Zeitzonendifferenz zur Greenwich Mean Time, Inhalt der Anforderung, HTTP-Statuscode, übertragene Datenmenge, Website, von der die Anforderung kommt und Informationen zu Browser und Betriebssystem. 19 | 20 | Das ist erforderlich, um unsere Website anzuzeigen und die Stabilität und Sicherheit zu gewährleisten. Dies entspricht unserem berechtigten Interesse im Sinne des Art. 6 Abs. 1 S. 1 lit. f DSGVO. 21 | 22 | Es erfolgt kein Tracking und wir haben auf diese Daten keinen direkten Zugriff, sondern erhalten lediglich eine anonymisierte, statistische Zusammenfassung. Diese beinhaltet die Adresse der vorher besuchten Seite, die Häufigkeit der jeweils aufgerufenen Seiten und die Anzahl eindeutiger Besucher. Diese Daten führen wir nicht mit anderen Daten zusammen. 23 | 24 | Wir setzen für die Zurverfügungstellung unserer Website folgenden Hoster ein: 25 | 26 | GitHub Inc. 27 | 88 Colin P Kelly Jr St 28 | San Francisco, CA 94107 29 | United States 30 | 31 | Dieser ist Empfänger Ihrer personenbezogenen Daten. Dies entspricht unserem berechtigten Interesse im Sinne des Art. 6 Abs. 1 S. 1 lit. f DSGVO, selbst keinen Server in unseren Räumlichkeiten vorhalten zu müssen. Serverstandort ist USA. 32 | 33 | Weitere Informationen zu Widerspruchs- und Beseitigungsmöglichkeiten gegenüber GitHub finden Sie unter: [https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-privacy-statement#github-pages](https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-privacy-statement#github-pages) 34 | 35 | Sie haben das Recht der Verarbeitung zu widersprechen. Ob der Widerspruch erfolgreich ist, ist im Rahmen einer Interessenabwägung zu ermitteln. 36 | 37 | Die Daten werden gelöscht, sobald der Zweck der Verarbeitung entfällt. 38 | 39 | Die Verarbeitung der unter diesem Abschnitt angegebenen Daten ist weder gesetzlich noch vertraglich vorgeschrieben. Die Funktionsfähigkeit der Website ist ohne die Verarbeitung nicht gewährleistet. 40 | 41 | GitHub hat Compliance-Maßnahmen für internationale Datenübermittlungen umgesetzt. Diese gelten für alle weltweiten Aktivitäten, bei denen GitHub personenbezogene Daten von natürlichen Personen in der EU verarbeitet. Diese Maßnahmen basieren auf den EU-Standardvertragsklauseln (SCCs). Weitere Informationen finden Sie unter: [https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-data-protection-addendum#attachment-1--the-standard-contractual-clauses-processors](https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-data-protection-addendum#attachment-1--the-standard-contractual-clauses-processors) 42 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import commonjs from '@rollup/plugin-commonjs' 2 | import { nodeResolve } from '@rollup/plugin-node-resolve' 3 | import typescript from '@rollup/plugin-typescript' 4 | 5 | export default [ 6 | { 7 | input: 'src/background.ts', 8 | output: { 9 | file: 'build/background.js', 10 | format: 'cjs' 11 | }, 12 | plugins: [commonjs(), nodeResolve(), typescript()] 13 | }, 14 | { 15 | input: 'src/content.ts', 16 | output: { 17 | file: 'build/content.js', 18 | format: 'cjs' 19 | }, 20 | plugins: [commonjs(), nodeResolve(), typescript()] 21 | }, 22 | { 23 | input: 'src/options.ts', 24 | output: { 25 | file: 'build/options.js', 26 | format: 'cjs' 27 | }, 28 | plugins: [commonjs(), nodeResolve(), typescript()] 29 | }, 30 | { 31 | input: 'src/popup.ts', 32 | output: { 33 | file: 'build/popup.js', 34 | format: 'cjs' 35 | }, 36 | plugins: [commonjs(), nodeResolve(), typescript()] 37 | }, 38 | { 39 | input: 'tests/content_test.ts', 40 | output: { 41 | file: 'test_build/content_test.js', 42 | format: 'cjs' 43 | }, 44 | plugins: [commonjs(), nodeResolve(), typescript()] 45 | } 46 | ] 47 | -------------------------------------------------------------------------------- /src/background.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | import Reader from './reader.js' 4 | import update from './update.js' 5 | 6 | function openOptionsPage(details: browser.Runtime.OnInstalledDetailsType) { 7 | if (details.reason === 'install') { 8 | browser.runtime.openOptionsPage() 9 | } else if (details.reason === 'update' && details.previousVersion) { 10 | console.log('Extension was updated, running update scripts...') 11 | update.run_update( 12 | browser.runtime.getManifest().version, 13 | details.previousVersion, 14 | ) 15 | } 16 | } 17 | 18 | browser.runtime.onInstalled.addListener(openOptionsPage) 19 | 20 | function portConnected(port: browser.Runtime.Port) { 21 | const reader = new Reader(port) 22 | reader.start() 23 | } 24 | 25 | browser.runtime.onConnect.addListener(portConnected) 26 | -------------------------------------------------------------------------------- /src/const.ts: -------------------------------------------------------------------------------- 1 | import { StorageItems } from './types.js' 2 | 3 | export const LOG_NAME = 'BibBot' 4 | export const PORT_NAME = 'port-from-cs' 5 | export const INIT_MESSAGE = 'init' 6 | export const GOTOTAB_MESSAGE = 'gototab' 7 | export const SUCCESS_MESSAGE = 'success' 8 | export const FAILED_MESSAGE = 'failed' 9 | export const ABORT_MESSAGE = 'abort' 10 | export const STATUS_MESSAGE = 'status' 11 | export const DEFAULT_PROVIDER = 'voebb.de' 12 | 13 | export const storageDefaults: StorageItems = { 14 | installDate: null, 15 | provider: DEFAULT_PROVIDER, 16 | keepStats: true, 17 | stats: {}, 18 | providerOptions: {}, 19 | saveArticle: null, 20 | disabledSites: [], 21 | } 22 | -------------------------------------------------------------------------------- /src/content.ts: -------------------------------------------------------------------------------- 1 | import sites from './sites.js' 2 | import SiteBot from './sitebot.js' 3 | 4 | const domain = document.location.host 5 | const site = sites[domain] 6 | 7 | if (site !== undefined) { 8 | const siteBot = new SiteBot(site, document.body, domain) 9 | if (siteBot.site.waitOnLoad) { 10 | if (document.readyState === 'complete') { 11 | siteBot.start(siteBot.site.waitOnLoad) 12 | } else { 13 | window.addEventListener('load', () => { 14 | siteBot.start(siteBot.site.waitOnLoad) 15 | }) 16 | } 17 | } else { 18 | siteBot.start() 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/converters.ts: -------------------------------------------------------------------------------- 1 | export default { 2 | preToParagraph: (htmlArr: string[]) => { 3 | return htmlArr.map((html) => { 4 | html = html.replace(/]+>/, '').replace(/<\/pre>/, '') 5 | // Remove ems (highlighting query) 6 | html = html.replace(//g, '').replace(/<\/em>/g, '') 7 | // Funny use of /// and // . for interviews for handelsblatt.com 8 | html = html.replace(/\/\/\//g, '\n\n') 9 | html = html.replace(/\s+\/\/\s+\./g, '\n\n') 10 | 11 | const doubleBreakCount = (html.match(/\n\n/g) || []).length 12 | let paragrahBreak = '\n\n' 13 | if (doubleBreakCount < 2) { 14 | paragrahBreak = '\n' 15 | } 16 | 17 | const parts = html.split(paragrahBreak) 18 | let content = `

          ${parts.join('

          ')}

          ` 19 | // Replace empty paragraphs 20 | content = content.replace(/

          <\/p>/g, '') 21 | return content 22 | }) 23 | }, 24 | } 25 | -------------------------------------------------------------------------------- /src/extractor.ts: -------------------------------------------------------------------------------- 1 | import { 2 | ArticleInfo, 3 | ElementSelector, 4 | ExtractorInterface, 5 | FormattedDateRange, 6 | RawArticleInfo, 7 | Site, 8 | SiteBotInterface, 9 | StringSelector, 10 | } from './types.js' 11 | 12 | class Extractor implements ExtractorInterface { 13 | site: Site 14 | siteBot: SiteBotInterface 15 | root: HTMLElement 16 | main: HTMLElement | null 17 | 18 | constructor(site, root, siteBot) { 19 | this.site = site 20 | this.root = root 21 | this.siteBot = siteBot 22 | this.main = null 23 | } 24 | 25 | shouldExtract() { 26 | if (this.site.start) { 27 | const result = this.site.start(this.root, this.getPaywall()) 28 | if (result) { 29 | // determined not worth it 30 | return false 31 | } 32 | } else { 33 | this.hidePaywall() 34 | } 35 | return true 36 | } 37 | 38 | getPaywall() { 39 | return this.runSelectorQueryElement(this.site.selectors.paywall) 40 | } 41 | 42 | hasPaywall() { 43 | return this.getPaywall() !== null 44 | } 45 | 46 | hidePaywall() { 47 | if (this.hasPaywall()) { 48 | this.getPaywall().style.display = 'none' 49 | } 50 | } 51 | 52 | showPaywall() { 53 | this.getPaywall().style.display = 'block' 54 | } 55 | 56 | getMainContentArea() { 57 | if (this.main) { 58 | return this.main 59 | } 60 | const main = this.runSelectorQueryElement(this.site.selectors.main) 61 | if (this.site.insertAfterMain) { 62 | const newMain = document.createElement('div') 63 | main.parentNode.insertBefore(newMain, main.nextSibling) 64 | this.main = newMain 65 | } else { 66 | this.main = main 67 | } 68 | return this.main 69 | } 70 | 71 | getLoadingArea() { 72 | if (this.site.selectors.loader) { 73 | return this.runSelectorQueryElement(this.site.selectors.loader) 74 | } 75 | return null 76 | } 77 | 78 | runSelectorQueryElement(selector: ElementSelector): HTMLElement | null { 79 | if (typeof selector === 'function') { 80 | return selector(this.root, this.siteBot) 81 | } 82 | let result = null 83 | if (Array.isArray(selector)) { 84 | for (const s of selector) { 85 | result = this.runSelectorQueryElement(s) 86 | if (result !== null) { 87 | return result 88 | } 89 | } 90 | return null 91 | } 92 | return this.root.querySelector(selector) 93 | } 94 | 95 | runSelectorQuery(selector: StringSelector): string { 96 | const result = this._runSelectorQuery(selector) 97 | if (result === null) { 98 | return '' 99 | } 100 | if (result instanceof window.HTMLElement) { 101 | return result.innerText 102 | } 103 | return result 104 | } 105 | 106 | _runSelectorQuery(selector: StringSelector): string | HTMLElement | null { 107 | if (typeof selector === 'function') { 108 | return selector(this.root) 109 | } 110 | if (Array.isArray(selector)) { 111 | for (const s of selector) { 112 | const result = this.runSelectorQuery(s) 113 | if (result !== '') { 114 | return result 115 | } 116 | } 117 | return '' 118 | } 119 | 120 | const parts = selector.split('@') 121 | const hasAttribute = parts.length > 1 122 | 123 | const result = this.root.querySelector(parts[0]) 124 | if (result === null) { 125 | return '' 126 | } 127 | 128 | if (hasAttribute) { 129 | return result.attributes[parts[1]].value.trim() 130 | } else { 131 | return result.textContent.trim() 132 | } 133 | } 134 | 135 | extractDateQuery(dateValue: string, range): FormattedDateRange { 136 | const defaultValue: FormattedDateRange = { 137 | dateStart: '', 138 | dateEnd: '', 139 | } 140 | if (!dateValue) { 141 | return defaultValue 142 | } 143 | let date 144 | if (dateValue.match(/(\d{4})-(\d{2})-(\d{2})/)) { 145 | date = new Date(dateValue) 146 | } else { 147 | let match = dateValue.match(/(\d{1,2})\.(\d{1,2})\.(\d{4})/) 148 | if (!match) { 149 | match = dateValue.match(/(\d{1,2})\. ([^ ]+) (\d{4})/) 150 | if (match) { 151 | const monthNames = [ 152 | 'Januar', 153 | 'Februar', 154 | 'März', 155 | 'April', 156 | 'Mai', 157 | 'Juni', 158 | 'Juli', 159 | 'August', 160 | 'September', 161 | 'Oktober', 162 | 'November', 163 | 'Dezember', 164 | ] 165 | const monthIndex = monthNames.findIndex((x) => x === match[2]) 166 | if (monthIndex === -1) { 167 | return defaultValue 168 | } 169 | date = new Date(`${match[3]}-${monthIndex + 1}-${match[1]}`) 170 | } else { 171 | return defaultValue 172 | } 173 | } else { 174 | date = new Date(`${match[3]}-${match[2]}-${match[1]}`) 175 | } 176 | if (isNaN(date)) { 177 | return defaultValue 178 | } 179 | } 180 | const formatDate = (d) => 181 | `${String(d.getDate()).padStart(2, '0')}.${String(d.getMonth() + 1).padStart(2, '0')}.${d.getFullYear()}` 182 | const day = 24 * 60 * 60 * 1000 183 | const dateStart = new Date(date.getTime() - day * range[0]) 184 | const dateEnd = new Date(date.getTime() + day * range[1]) 185 | const dateRange: FormattedDateRange = { 186 | dateStart: formatDate(dateStart), 187 | dateEnd: formatDate(dateEnd), 188 | } 189 | return dateRange 190 | } 191 | 192 | extractArticleInfo(): ArticleInfo { 193 | const articleInfoSelectors = ['query', 'edition', 'date'] 194 | const articleInfo: RawArticleInfo = {} 195 | for (const key of articleInfoSelectors) { 196 | if (this.site.selectors[key]) { 197 | const selector = this.site.selectors[key] 198 | const result = this.runSelectorQuery(selector) 199 | articleInfo[key] = result 200 | } 201 | } 202 | return { 203 | query: articleInfo.query, 204 | edition: articleInfo.edition, 205 | ...this.extractDateQuery(articleInfo.date, this.site.dateRange || [4, 1]), 206 | } 207 | } 208 | } 209 | 210 | export default Extractor 211 | -------------------------------------------------------------------------------- /src/global.d.ts: -------------------------------------------------------------------------------- 1 | import { Page } from '@playwright/test' 2 | 3 | declare global { 4 | type PlaywrightPage = Page 5 | interface Window { 6 | bibbotObserver?: MutationObserver 7 | // random window stuff from news sites that we need to deal with 8 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 9 | oonObj: any 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/options.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | import { storageDefaults } from './const.js' 4 | import providers from './providers.js' 5 | import sites from './sites.js' 6 | import { StorageItems } from './types.js' 7 | 8 | type InputOptions = { 9 | provider?: HTMLInputElement 10 | keepStats?: HTMLInputElement 11 | saveArticle?: HTMLInputElement 12 | disableSites?: HTMLSelectElement 13 | } 14 | 15 | let currentPermissions: browser.Permissions.AnyPermissions | null = null 16 | 17 | function showOptions() { 18 | const provider = (document.getElementById('provider')).value 19 | ;([ 20 | ...document.getElementsByClassName('provider-options-container'), 21 | ]).forEach((el) => { 22 | el.hidden = true 23 | }) 24 | document.getElementById(provider + '.options').hidden = null 25 | checkPermissions() 26 | } 27 | 28 | function getInputs() { 29 | const inputs: InputOptions = {} 30 | ;['provider', 'keepStats', 'saveArticle', 'disableSites'].forEach((id) => { 31 | inputs[id] = ( 32 | document.getElementById(id) 33 | ) 34 | }) 35 | return inputs 36 | } 37 | 38 | function restore() { 39 | browser.storage.sync.get(storageDefaults).then(function (items) { 40 | const inputs = getInputs() 41 | inputs.provider.value = items.provider 42 | inputs.keepStats.checked = items.keepStats 43 | inputs.saveArticle.value = items.saveArticle || '' 44 | 45 | if (items.providerOptions) { 46 | for (const providerKey in providers) { 47 | const provider = providers[providerKey] 48 | for (const optionKey in provider.options) { 49 | const option = provider.options[optionKey] 50 | const input = ( 51 | document.getElementById(providerKey + '.options.' + option.id) 52 | ) 53 | input.value = 54 | items.providerOptions[providerKey + '.options.' + option.id] || '' 55 | } 56 | } 57 | } 58 | showOptions() 59 | 60 | // disableSites 61 | Object.keys(sites) 62 | .sort() 63 | .forEach((domain) => { 64 | inputs.disableSites.appendChild( 65 | new Option( 66 | domain, 67 | domain, 68 | false, 69 | items.disabledSites.includes(domain), 70 | ), 71 | ) 72 | }) 73 | 74 | if (items.installDate === null) { 75 | // first run 76 | browser.storage.sync.set({ 77 | installDate: new Date().getTime(), 78 | }) 79 | document.querySelector('#setup').setAttribute('open', 'true') 80 | } 81 | }) 82 | 83 | const sortedProviders = [] 84 | for (const providerKey in providers) { 85 | sortedProviders.push({ 86 | key: providerKey, 87 | name: providers[providerKey].name, 88 | }) 89 | } 90 | sortedProviders.sort((a, b) => a.name.localeCompare(b.name)) 91 | 92 | const providerSelect = document.getElementById('provider') 93 | const providerList = document.getElementById('providers') 94 | const providerOptions = document.getElementById('provider-options') 95 | for (const sortedProvider of sortedProviders) { 96 | const providerKey = sortedProvider.key 97 | const provider = providers[providerKey] 98 | const option = document.createElement('option') 99 | option.value = providerKey 100 | option.innerText = provider.name 101 | providerSelect.appendChild(option) 102 | 103 | const listItem = document.createElement('li') 104 | const listItemA = document.createElement('a') 105 | listItemA.href = provider.web 106 | listItemA.innerText = provider.name 107 | listItem.appendChild(listItemA) 108 | providerList.appendChild(listItem) 109 | 110 | const optionsContainer = document.createElement('div') as HTMLElement 111 | optionsContainer.classList.add('provider-options-container') 112 | optionsContainer.id = providerKey + '.options' 113 | optionsContainer.hidden = true 114 | for (const optionKey in provider.options) { 115 | const option = provider.options[optionKey] 116 | 117 | const label = document.createElement('label') 118 | label.innerText = option.display 119 | const input = document.createElement('input') 120 | input.type = option.type 121 | input.name = providerKey + '.options.' + option.id 122 | input.id = providerKey + '.options.' + option.id 123 | 124 | optionsContainer.appendChild(label) 125 | optionsContainer.appendChild(input) 126 | } 127 | providerOptions.appendChild(optionsContainer) 128 | } 129 | 130 | Array.from( 131 | document.querySelector('form').querySelectorAll('input, select'), 132 | ).forEach((el) => { 133 | el.addEventListener('change', () => save()) 134 | el.addEventListener('keyup', () => save()) 135 | }) 136 | 137 | window 138 | .fetch('/manifest.json') 139 | .then((response) => response.json()) 140 | .then((data) => { 141 | const domains = data.content_scripts[0].matches.map((url) => 142 | url.replace('https://', '').replace('/*', ''), 143 | ) 144 | const ul = document.getElementById('newssites') 145 | domains.forEach((domain) => { 146 | const li = document.createElement('li') 147 | li.innerText = domain 148 | ul.appendChild(li) 149 | }) 150 | }) 151 | 152 | checkPermissions() 153 | } 154 | 155 | function save() { 156 | const providerOptions = {} 157 | for (const providerKey in providers) { 158 | const provider = providers[providerKey] 159 | for (const optionKey in provider.options) { 160 | const option = provider.options[optionKey] 161 | const input = ( 162 | document.getElementById(providerKey + '.options.' + option.id) 163 | ) 164 | providerOptions[providerKey + '.options.' + option.id] = input.value 165 | } 166 | } 167 | const inputs = getInputs() 168 | const provider = inputs.provider.value 169 | 170 | const disabledSites = Array.from(inputs.disableSites.selectedOptions).map( 171 | ({ value }) => value, 172 | ) 173 | const values: StorageItems = { 174 | keepStats: inputs.keepStats.checked, 175 | provider, 176 | providerOptions, 177 | saveArticle: inputs.saveArticle.value, 178 | disabledSites, 179 | } 180 | if (!values.keepStats) { 181 | values.stats = {} 182 | } 183 | 184 | browser.storage.sync.set(values) 185 | requestPermissions(providers[provider].permissions) 186 | console.log('saved!') 187 | } 188 | 189 | async function getPermissions( 190 | refresh = false, 191 | ): Promise { 192 | if (currentPermissions !== null && !refresh) { 193 | return Promise.resolve(currentPermissions) 194 | } 195 | return browser.permissions.getAll().then((permissions) => { 196 | currentPermissions = permissions 197 | return permissions 198 | }) 199 | } 200 | 201 | async function checkPermissions(): Promise { 202 | const inputs = getInputs() 203 | const provider = inputs.provider.value 204 | const neededPermissions = await getNeededPermissions( 205 | providers[provider].permissions, 206 | ) 207 | console.log('Missing permissions', neededPermissions) 208 | const needed = neededPermissions.length > 0 209 | if (needed) { 210 | document.getElementById('refresh-permissions').hidden = null 211 | } else { 212 | document.getElementById('refresh-permissions').hidden = true 213 | } 214 | return needed 215 | } 216 | 217 | async function getNeededPermissions( 218 | providerPermissions: string[] | undefined, 219 | ): Promise { 220 | if (!providerPermissions) { 221 | return [] 222 | } 223 | const neededPermissions = [] 224 | const permissions = await getPermissions() 225 | console.log(providerPermissions, permissions.origins) 226 | providerPermissions.forEach((p) => { 227 | if (!permissions.origins.includes(p)) { 228 | neededPermissions.push(p) 229 | } 230 | }) 231 | return neededPermissions 232 | } 233 | 234 | async function requestNeededPermissions() { 235 | const inputs = getInputs() 236 | const provider = inputs.provider.value 237 | await requestPermissions(providers[provider].permissions) 238 | } 239 | 240 | async function requestPermissions(providerPermissions) { 241 | if (!providerPermissions) { 242 | return 243 | } 244 | const neededPermissions = await getNeededPermissions(providerPermissions) 245 | if (neededPermissions.length > 0) { 246 | const granted = await browser.permissions.request({ 247 | origins: neededPermissions, 248 | }) 249 | console.log('Permissions granted?', granted) 250 | await getPermissions(true) 251 | await checkPermissions() 252 | return true 253 | } 254 | return Promise.resolve(false) 255 | } 256 | 257 | document.querySelector('form').addEventListener('submit', (e) => { 258 | e.preventDefault() 259 | save() 260 | }) 261 | 262 | document.getElementById('provider').addEventListener('change', showOptions) 263 | document.addEventListener('DOMContentLoaded', restore) 264 | document.getElementById('version').innerText = 265 | 'v' + browser.runtime.getManifest().version 266 | document 267 | .getElementById('refresh-permissions-button') 268 | .addEventListener('click', requestNeededPermissions) 269 | -------------------------------------------------------------------------------- /src/popup.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | document.querySelector('#settings').addEventListener('click', () => { 4 | browser.runtime.openOptionsPage() 5 | console.log('open options page') 6 | }) 7 | 8 | const defaults = { 9 | keepStats: true, 10 | stats: {}, 11 | } 12 | browser.storage.sync.get(defaults).then(function (items) { 13 | if (!items.keepStats) { 14 | return 15 | } 16 | const ul = document.createElement('ul') 17 | let count = 0 18 | for (const domain in items.stats) { 19 | const domainLabel = domain.replace(/^www\./, '') 20 | const li = document.createElement('li') 21 | li.innerHTML = `${domainLabel}: ${items.stats[domain]}` 22 | ul.appendChild(li) 23 | count += items.stats[domain] 24 | } 25 | if (count > 0) { 26 | const stats: HTMLElement = document.querySelector('#stats') 27 | stats.style.display = 'block' 28 | document.body.appendChild(ul) 29 | } 30 | }) 31 | -------------------------------------------------------------------------------- /src/reader.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | import { Runtime } from 'webextension-polyfill' 3 | 4 | import { 5 | ABORT_MESSAGE, 6 | FAILED_MESSAGE, 7 | GOTOTAB_MESSAGE, 8 | INIT_MESSAGE, 9 | STATUS_MESSAGE, 10 | SUCCESS_MESSAGE, 11 | storageDefaults, 12 | } from './const.js' 13 | import SourceBot from './sourcebot.js' 14 | import { increaseStats } from './stats.js' 15 | import { BibbotOptions, InitMessage, Message } from './types.js' 16 | 17 | let storageItems: BibbotOptions 18 | 19 | function retrieveStorage() { 20 | return browser.storage.sync.get(storageDefaults).then(function (items) { 21 | storageItems = { 22 | keepStats: items.keepStats, 23 | provider: items.provider, 24 | providerOptions: items.providerOptions, 25 | saveArticle: items.saveArticle, 26 | disabledSites: items.disabledSites, 27 | } 28 | }) 29 | } 30 | 31 | class Reader { 32 | port: Runtime.Port 33 | senderTabId: number | null 34 | storageUpdated?: Promise 35 | sourceBot?: SourceBot 36 | sourceId?: string 37 | domain?: string 38 | 39 | constructor(port) { 40 | this.port = port 41 | 42 | this.senderTabId = null 43 | if (port.sender && port.sender.tab) { 44 | this.senderTabId = port.sender.tab.id 45 | } 46 | this.onMessage = this.onMessage.bind(this) 47 | this.onDisconnect = this.onDisconnect.bind(this) 48 | this.botCallback = this.botCallback.bind(this) 49 | } 50 | 51 | start() { 52 | this.storageUpdated = retrieveStorage() 53 | this.port.onMessage.addListener(this.onMessage) 54 | this.port.onDisconnect.addListener(this.onDisconnect) 55 | } 56 | 57 | onMessage(message: Message) { 58 | if (message.type === INIT_MESSAGE) { 59 | this.storageUpdated.then(() => { 60 | if (storageItems.disabledSites.includes(message.domain)) { 61 | this.postMessage({ 62 | type: ABORT_MESSAGE, 63 | }) 64 | this.cleanUp() 65 | return 66 | } 67 | this.retrieveArticle(message) 68 | }) 69 | } else if (message.type === GOTOTAB_MESSAGE) { 70 | if (this.sourceBot) { 71 | this.sourceBot.activateTab() 72 | } 73 | } 74 | } 75 | 76 | onDisconnect() { 77 | this.cleanUp() 78 | } 79 | 80 | postMessage(message: Message) { 81 | try { 82 | this.port.postMessage(message) 83 | } catch (e) { 84 | console.error(e) 85 | this.cleanUp() 86 | } 87 | } 88 | 89 | retrieveArticle(message: InitMessage) { 90 | this.sourceId = message.source 91 | this.domain = message.domain 92 | this.sourceBot = new SourceBot( 93 | message.source, 94 | storageItems.provider, 95 | storageItems.providerOptions, 96 | message.sourceParams, 97 | message.articleInfo, 98 | this.botCallback, 99 | ) 100 | this.sourceBot.run() 101 | } 102 | 103 | botCallback(event: Message) { 104 | if (event.type === STATUS_MESSAGE) { 105 | this.sendStatusMessage(event) 106 | } else if (event.type === FAILED_MESSAGE) { 107 | this.fail(event) 108 | } else if (event.type === SUCCESS_MESSAGE) { 109 | this.success(event) 110 | } else { 111 | this.cleanUp() 112 | throw new Error('Unknown type') 113 | } 114 | } 115 | 116 | sendStatusMessage(event) { 117 | this.postMessage(event) 118 | } 119 | 120 | success(event) { 121 | if (storageItems.keepStats) { 122 | increaseStats(this.domain) 123 | } 124 | this.postMessage({ 125 | type: SUCCESS_MESSAGE, 126 | content: event.content, 127 | saveArticle: storageItems.saveArticle, 128 | }) 129 | } 130 | 131 | fail(event) { 132 | this.postMessage({ 133 | type: FAILED_MESSAGE, 134 | message: event.message, 135 | }) 136 | this.cleanUp() 137 | } 138 | 139 | cleanUp() { 140 | this.port.onMessage.removeListener(this.onMessage) 141 | this.port.onDisconnect.removeListener(this.onDisconnect) 142 | } 143 | } 144 | 145 | export default Reader 146 | -------------------------------------------------------------------------------- /src/services.ts: -------------------------------------------------------------------------------- 1 | import { COLOR } from './ui.js' 2 | 3 | function escapeHTML(html: string) { 4 | // eslint-disable-next-line no-control-regex 5 | return html.replace(/[\x26\x0A<>'"]/g, function (r) { 6 | return '&#' + r.charCodeAt(0) + ';' 7 | }) 8 | } 9 | 10 | const addSharingButton = ( 11 | main: HTMLElement, 12 | content: string, 13 | postUrl: string, 14 | ) => { 15 | const html = `

          16 | 17 | 18 | 19 | 22 |
          ` 23 | main.innerHTML = html + main.innerHTML 24 | window.setTimeout(function () { 25 | document 26 | .querySelector('#bibbot-post-popup') 27 | .addEventListener('submit', function () { 28 | console.log('Opening in popup') 29 | window.open('', 'bibbot', 'width=600,height=400,resizeable,scrollbars') 30 | this.target = 'bibbot_postpopup' 31 | }) 32 | }, 100) 33 | } 34 | 35 | export { addSharingButton } 36 | -------------------------------------------------------------------------------- /src/sitebot.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | import { 4 | ABORT_MESSAGE, 5 | FAILED_MESSAGE, 6 | GOTOTAB_MESSAGE, 7 | INIT_MESSAGE, 8 | LOG_NAME, 9 | PORT_NAME, 10 | STATUS_MESSAGE, 11 | SUCCESS_MESSAGE, 12 | } from './const.js' 13 | import { 14 | BOT_ID, 15 | FAILED_HTML, 16 | LOADER_HTML, 17 | LOADER_ID, 18 | MESSAGE_ID, 19 | STYLES, 20 | } from './ui.js' 21 | 22 | import Extractor from './extractor.js' 23 | import { addSharingButton } from './services.js' 24 | import { 25 | GoToTabMessage, 26 | InitMessage, 27 | Message, 28 | Site, 29 | SiteBotInterface, 30 | } from './types.js' 31 | 32 | class SiteBot implements SiteBotInterface { 33 | site: Site 34 | root: HTMLElement 35 | domain: string | null 36 | shadow: ShadowRoot | null 37 | container: HTMLElement | null 38 | extractor: Extractor 39 | port?: browser.Runtime.Port | null 40 | 41 | constructor(site: Site, root: HTMLElement, domain = null) { 42 | this.site = site 43 | this.root = root 44 | this.domain = domain 45 | this.extractor = new Extractor(site, root, this) 46 | this.shadow = null 47 | this.container = null 48 | 49 | this.onDisconnect = this.onDisconnect.bind(this) 50 | this.onMessage = this.onMessage.bind(this) 51 | } 52 | 53 | start(delay?: boolean | number) { 54 | if (typeof delay === 'number') { 55 | window.setTimeout(() => this.start(), delay) 56 | return 57 | } 58 | if (!this.extractor.hasPaywall()) { 59 | return 60 | } 61 | const articleInfo = this.startInfoExtraction() 62 | console.log(LOG_NAME, 'ArticleInfo', articleInfo) 63 | if (articleInfo) { 64 | this.startBackgroundConnection(articleInfo) 65 | } 66 | } 67 | 68 | setupUI() { 69 | if (this.shadow) { 70 | return 71 | } 72 | let loadingArea = this.extractor.getLoadingArea() 73 | if (loadingArea === null) { 74 | loadingArea = this.extractor.getMainContentArea() 75 | } 76 | const shadowHost = document.createElement('div') 77 | 78 | loadingArea.parentNode.insertBefore(shadowHost, loadingArea.nextSibling) 79 | 80 | this.shadow = shadowHost.attachShadow({ mode: 'open' }) 81 | this.shadow.innerHTML = STYLES 82 | this.container = document.createElement('div') 83 | this.shadow.appendChild(this.container) 84 | } 85 | 86 | startInfoExtraction() { 87 | if (!this.extractor.shouldExtract()) { 88 | return 89 | } 90 | this.setupUI() 91 | this.showLoading() 92 | try { 93 | return this.extractor.extractArticleInfo() 94 | } catch (e) { 95 | console.error(LOG_NAME, e) 96 | this.showUpdate('Beim Extrahieren der Artikeldaten trat ein Fehler auf.') 97 | return null 98 | } 99 | } 100 | 101 | startBackgroundConnection(articleInfo) { 102 | this.connectPort() 103 | const message: InitMessage = { 104 | type: INIT_MESSAGE, 105 | source: this.site.source, 106 | sourceParams: this.site.sourceParams, 107 | domain: this.domain, 108 | articleInfo, 109 | } 110 | this.postMessage(message) 111 | } 112 | 113 | runSelectorQuery(selector) { 114 | return this.extractor.runSelectorQuery(selector) 115 | } 116 | 117 | hidePaywall() { 118 | if (this.extractor.hasPaywall()) { 119 | this.extractor.getPaywall().style.display = 'none' 120 | } 121 | } 122 | 123 | showPaywall() { 124 | this.extractor.getPaywall().style.display = 'block' 125 | } 126 | 127 | showLoading() { 128 | this.container.innerHTML = LOADER_HTML 129 | } 130 | 131 | hideLoading() { 132 | const loader: HTMLElement = this.shadow.querySelector(`#${LOADER_ID}`) 133 | loader.style.display = 'none' 134 | } 135 | 136 | hideBot() { 137 | const bot: HTMLElement = this.shadow.querySelector(`#${BOT_ID}`) 138 | bot.style.display = 'none' 139 | } 140 | 141 | showUpdate(text) { 142 | const message: HTMLElement = this.shadow.querySelector(`#${MESSAGE_ID}`) 143 | message.innerText = text 144 | } 145 | 146 | showInteractionRequired() { 147 | this.hideLoading() 148 | const btnId = 'bibbot-goto' 149 | const html = `` 150 | this.shadow.querySelector(`#${MESSAGE_ID}`).innerHTML = html 151 | this.shadow.querySelector(`#${btnId}`).addEventListener('click', (e) => { 152 | e.preventDefault() 153 | const message: GoToTabMessage = { 154 | type: GOTOTAB_MESSAGE, 155 | } 156 | this.postMessage(message) 157 | }) 158 | } 159 | 160 | connectPort() { 161 | this.port = browser.runtime.connect({ name: PORT_NAME }) 162 | this.port.onMessage.addListener(this.onMessage) 163 | this.port.onDisconnect.addListener(this.onDisconnect) 164 | return this.port 165 | } 166 | 167 | postMessage(message: Message) { 168 | this.port.postMessage(message) 169 | } 170 | 171 | onDisconnect() { 172 | this.port.onMessage.removeListener(this.onMessage) 173 | this.port.onDisconnect.removeListener(this.onDisconnect) 174 | } 175 | 176 | onMessage(event: Message) { 177 | console.log(LOG_NAME, event) 178 | if (event.type === ABORT_MESSAGE) { 179 | this.showPaywall() 180 | this.hideBot() 181 | return 182 | } 183 | if (event.type === STATUS_MESSAGE) { 184 | if (event.action === 'interaction_required') { 185 | this.showInteractionRequired() 186 | } else if (event.message) { 187 | this.showUpdate(event.message) 188 | } 189 | return 190 | } 191 | 192 | if (event.type === FAILED_MESSAGE) { 193 | this.hideLoading() 194 | this.fail() 195 | return 196 | } 197 | if (event.type === SUCCESS_MESSAGE) { 198 | this.showArticle(event.content, event.saveArticle) 199 | this.hideBot() 200 | return 201 | } 202 | 203 | throw new Error('Unknown message type') 204 | } 205 | 206 | fail() { 207 | this.shadow.querySelector(`#${MESSAGE_ID}`).innerHTML = FAILED_HTML 208 | this.showPaywall() 209 | } 210 | 211 | showArticle(content, saveArticleUrl) { 212 | const main = this.extractor.getMainContentArea() 213 | content = content.join('') 214 | if (this.site.mimic) { 215 | if (typeof this.site.mimic === 'function') { 216 | content = this.site.mimic(content, main) 217 | } else { 218 | const mimic = this.root.querySelector(this.site.mimic) 219 | if (mimic !== null) { 220 | content = `
          ${content}
          ` 221 | } 222 | } 223 | } 224 | if (this.site.paragraphStyle) { 225 | let className = this.site.paragraphStyle.className || '' 226 | let style = this.site.paragraphStyle.style || '' 227 | if (this.site.paragraphStyle.selector) { 228 | const example = this.root.querySelector( 229 | this.site.paragraphStyle.selector, 230 | ) 231 | if (example !== null) { 232 | className = example.className || className 233 | style = example.attributes.getNamedItem('style')?.value || style 234 | } 235 | } 236 | content = content.replace( 237 | /

          /g, 238 | `

          `, 239 | ) 240 | } 241 | 242 | if (this.site.insertContent) { 243 | this.site.insertContent(this, main, content) 244 | } else { 245 | main.innerHTML = content 246 | } 247 | if (saveArticleUrl) { 248 | addSharingButton(main, content, saveArticleUrl) 249 | } 250 | } 251 | } 252 | 253 | export default SiteBot 254 | -------------------------------------------------------------------------------- /src/sourcebot.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | import { FAILED_MESSAGE, STATUS_MESSAGE, SUCCESS_MESSAGE } from './const.js' 4 | import providers from './providers.js' 5 | import sources from './sources.js' 6 | import TabRunner from './tabrunner.js' 7 | import { 8 | ArticleInfo, 9 | Message, 10 | Provider, 11 | SiteSourceParams, 12 | Source, 13 | } from './types.js' 14 | import { interpolate } from './utils.js' 15 | 16 | enum PHASE { 17 | LOGIN = 'login', 18 | SEARCH = 'search', 19 | } 20 | 21 | class SourceBot { 22 | step: number 23 | phase: PHASE 24 | sourceId: string 25 | providerId: string 26 | provider: Provider 27 | source: Source 28 | sourceParams: SiteSourceParams 29 | articleInfo: ArticleInfo 30 | providerOptions: object 31 | userData: object 32 | callback: (message: Message) => void 33 | tabId: number 34 | tabRunner: TabRunner 35 | done: boolean 36 | 37 | constructor( 38 | sourceId, 39 | providerId, 40 | providerOptions, 41 | sourceParams, 42 | articleInfo, 43 | callback, 44 | ) { 45 | this.step = 0 46 | this.phase = PHASE.LOGIN 47 | 48 | this.providerId = providerId 49 | this.provider = providers[providerId] 50 | 51 | this.sourceId = this.provider.defaultSource || sourceId 52 | this.source = sources[this.sourceId] 53 | 54 | this.sourceParams = sourceParams 55 | this.articleInfo = articleInfo 56 | this.providerOptions = providerOptions 57 | this.callback = callback 58 | this.userData = Object.assign( 59 | { 60 | bibName: this.provider.bibName || this.provider.name, 61 | }, 62 | this.providerOptions, 63 | ) 64 | ;['options.username', 'options.password'].forEach((key) => { 65 | const confValue = this.userData[`${this.providerId}.${key}`] 66 | if (confValue !== undefined) { 67 | this.userData[key] = confValue 68 | } 69 | }) 70 | 71 | this.onTabUpdated = this.onTabUpdated.bind(this) 72 | this.done = false 73 | } 74 | 75 | getParams() { 76 | return Object.assign( 77 | {}, 78 | this.source.defaultParams || {}, 79 | this.provider.params[this.sourceId], 80 | this.sourceParams, 81 | ) 82 | } 83 | 84 | async run() { 85 | const url = this.makeUrl(this.provider.start || this.source.start) 86 | const tab = await browser.tabs.create({ 87 | url, 88 | active: false, 89 | }) 90 | this.tabId = tab.id 91 | console.log('tab created', tab.id) 92 | this.tabRunner = new TabRunner(tab.id, this.userData) 93 | browser.tabs.onUpdated.addListener(this.onTabUpdated) 94 | } 95 | 96 | cleanUp() { 97 | browser.tabs.onUpdated.removeListener(this.onTabUpdated) 98 | } 99 | 100 | onTabUpdated(tabId, changeInfo) { 101 | if (this.done) { 102 | this.cleanUp() 103 | return 104 | } 105 | if (tabId !== this.tabId) { 106 | return 107 | } 108 | if (changeInfo.status === 'complete') { 109 | console.log('tab load complete', tabId) 110 | this.runNextSourceStep() 111 | } 112 | } 113 | 114 | async runNextSourceStep() { 115 | const loggedIn = await this.isLoggedIn() 116 | if (loggedIn) { 117 | this.step = 0 118 | this.phase = PHASE.SEARCH 119 | } 120 | await this.runActionsOfCurrentStep() 121 | } 122 | 123 | async isLoggedIn() { 124 | if (this.phase === PHASE.LOGIN && this.step === 0) { 125 | const result = await (chrome.scripting || browser.scripting).executeScript({ 126 | target: { 127 | tabId: this.tabId, 128 | }, 129 | func: (selector) => document.querySelector(selector) !== null, 130 | args: [this.source.loggedIn], 131 | }) 132 | console.log('loggedin?', result[0].result) 133 | return result[0].result 134 | } 135 | return false 136 | } 137 | 138 | getActionList() { 139 | return this.provider[this.phase] || this.source[this.phase] 140 | } 141 | 142 | getActions() { 143 | const actionList = this.getActionList() 144 | const actions = actionList[this.step] 145 | if (Array.isArray(actions)) { 146 | return actions 147 | } 148 | throw new Error('Unknown action in source') 149 | } 150 | 151 | isFinalStep() { 152 | return ( 153 | this.phase === PHASE.SEARCH && 154 | this.step === this.source[this.phase].length - 1 155 | ) 156 | } 157 | 158 | handleAction(action) { 159 | if (action.message) { 160 | // message does not need to run through tabrunner 161 | this.callback({ 162 | type: STATUS_MESSAGE, 163 | message: action.message, 164 | }) 165 | return null 166 | } 167 | if (action.url) { 168 | // recreate action.url with interpolated url 169 | action = Object.assign({}, action) 170 | action.url = this.makeUrl(action.url) 171 | } 172 | return action 173 | } 174 | 175 | async runActionsOfCurrentStep() { 176 | const actions = this.getActions() 177 | 178 | let result 179 | let skipWait = false 180 | for (let action of actions) { 181 | action = this.handleAction(action) 182 | if (action === null) { 183 | continue 184 | } 185 | try { 186 | result = await this.tabRunner.runAction(action) 187 | } catch (e) { 188 | this.fail(e.toString()) 189 | return 190 | } 191 | if (typeof result === 'function') { 192 | if (!result(this)) { 193 | this.cleanUp() 194 | return 195 | } 196 | } 197 | if (action.skipToNext && result === true) { 198 | skipWait = true 199 | break 200 | } 201 | } 202 | const isFinalStep = this.isFinalStep() 203 | if (isFinalStep) { 204 | this.finalize(result) 205 | return 206 | } 207 | // Move to next step and wait for tab update event 208 | this.step += 1 209 | const actionList = this.getActionList() 210 | if (this.step > actionList.length - 1) { 211 | if (this.phase === PHASE.LOGIN) { 212 | this.phase = PHASE.SEARCH 213 | } 214 | this.step = 0 215 | } 216 | if (skipWait) { 217 | await this.runNextSourceStep() 218 | } 219 | } 220 | 221 | finalize(result: string) { 222 | this.done = true 223 | if (result.length > 0) { 224 | this.callback({ 225 | type: SUCCESS_MESSAGE, 226 | content: result, 227 | }) 228 | 229 | browser.tabs.remove(this.tabId) 230 | this.cleanUp() 231 | } else { 232 | this.fail('failed to find content') 233 | } 234 | } 235 | 236 | fail(message) { 237 | console.error(message) 238 | this.callback({ 239 | type: FAILED_MESSAGE, 240 | message, 241 | }) 242 | this.cleanUp() 243 | } 244 | 245 | makeUrl(url) { 246 | if (typeof url === 'function') { 247 | return url(this.articleInfo, this.getParams()) 248 | } 249 | url = interpolate(url, this.articleInfo, '', encodeURIComponent) 250 | const params = this.getParams() 251 | url = interpolate(url, params, 'source', encodeURIComponent) 252 | return url 253 | } 254 | 255 | activateTab() { 256 | browser.tabs.update(this.tabId, { 257 | active: true, 258 | }) 259 | } 260 | } 261 | 262 | export default SourceBot 263 | -------------------------------------------------------------------------------- /src/sources.ts: -------------------------------------------------------------------------------- 1 | import { ArticleInfo, SiteSourceParams, Sources } from './types.js' 2 | 3 | const sources: Sources = { 4 | 'www.munzinger.de': { 5 | loggedIn: ".metanav-a[href='/search/logout']", 6 | start: 7 | 'https://{source.domain.raw}/search/go/spiegel/aktuell.jsp?portalid={source.portalId}', 8 | defaultParams: { 9 | domain: 'www.munzinger.de', 10 | // reverse-proxied portals such as www-munzinger-de.stbhannover.idm.oclc.org may not use portalId, 11 | // adding an empty ?portalid= parameter works in these cases 12 | portalId: '', 13 | }, 14 | login: [ 15 | [ 16 | { click: '.gdprcookie-buttons button', optional: true }, 17 | { fill: { selector: '#user-input', key: 'options.username' } }, 18 | { fill: { selector: '#pwd-bezeichnung', key: 'options.password' } }, 19 | { click: 'input[src="/grafiken/button-login.gif"]' }, 20 | ], 21 | ], 22 | search: [ 23 | [ 24 | { message: 'Artikel wird gesucht...' }, 25 | { 26 | url: 'https://{source.domain.raw}/search/query?template=%2Fpublikationen%2Fspiegel%2Fresult.jsp&query.id=query-spiegel&query.key=gQynwrIS&query.commit=yes&query.scope=spiegel&query.index-order=personen&query.facets=yes&facet.path=%2Fspiegel&facet.activate=yes&hitlist.highlight=yes&hitlist.sort=-field%3Aisort&query.Titel={query}&query.Ausgabe={edition}&query.Ressort=&query.Signatur=&query.Person=&query.K%C3%B6rperschaft=&query.Ort=&query.Text={overline}', 27 | }, 28 | ], 29 | [ 30 | { click: '.gdprcookie-buttons button', optional: true }, 31 | { extract: '.mitte-text' }, 32 | ], 33 | ], 34 | }, 35 | 'genios.de': { 36 | loggedIn: 37 | ':is(#header__login[auth=true], #header__login__buttons > button:nth-child(4))', 38 | start: '{source.scheme.raw}{source.domain.raw}/', 39 | defaultParams: { 40 | domain: 'www.genios.de', 41 | scheme: 'https://', 42 | }, 43 | login: [ 44 | [ 45 | { fill: { selector: '#ad_fo_el_1', key: 'options.username' } }, 46 | { event: { selector: '#ad_fo_el_1', event: 'input' } }, 47 | { fill: { selector: '#ad_fo_el_2', key: 'options.password' } }, 48 | { event: { selector: '#ad_fo_el_2', event: 'input' } }, 49 | { click: '#ad_fo_el_termsAndConditions' }, 50 | { click: '#ad_fo_el_privacyPolicy' }, 51 | { click: '#ad_fo_el_rememberMe' }, 52 | { click: '#submit' }, 53 | ], 54 | ], 55 | search: [ 56 | [ 57 | { message: 'Artikel wird gesucht...' }, 58 | { 59 | url: (articleInfo: ArticleInfo, sourceParams: SiteSourceParams) => { 60 | const params = [ 61 | `requestText=${encodeURIComponent(articleInfo.query)}`, 62 | 'size=10', 63 | 'sort=BY_DATE', 64 | 'order=desc', 65 | 'resultListType=DEFAULT', 66 | 'view=list', 67 | ] 68 | if (articleInfo.dateStart) { 69 | params.push(`date=from_${articleInfo.dateStart}`) 70 | } 71 | if (articleInfo.dateEnd) { 72 | params.push(`date=to_${articleInfo.dateEnd}`) 73 | } 74 | sourceParams.sourceNames?.forEach((sourceName) => { 75 | params.push(`source=${encodeURIComponent(sourceName)}`) 76 | }) 77 | 78 | return `${sourceParams.scheme}${sourceParams.domain}/searchResult/Alle?${params.join('&')}` 79 | }, 80 | }, 81 | ], 82 | [ 83 | { message: 'Artikel wird aufgerufen...' }, 84 | { 85 | failOnMissing: '.tooltip.article__text__title', 86 | failure: 'Artikel nicht gefunden', 87 | }, 88 | { 89 | href: '.article__text__panelBody__details.js_open_full_document_modal', 90 | }, 91 | ], 92 | [ 93 | { captcha: '#layer_captcha' }, 94 | { 95 | extract: '#content pre.text, .divDocument pre.textCompact', 96 | convert: 'preToParagraph', 97 | }, 98 | ], 99 | ], 100 | }, 101 | 'old.genios.de': { 102 | loggedIn: '.boxMyGeniosLink', 103 | start: '{source.scheme.raw}{source.domain.raw}/', 104 | defaultParams: { 105 | domain: 'www.genios.de', 106 | scheme: 'https://', 107 | }, 108 | login: [ 109 | [ 110 | { 111 | fill: { selector: '#bibLoginLayer_number', key: 'options.username' }, 112 | }, 113 | { 114 | fill: { 115 | selector: '#bibLoginLayer_password', 116 | key: 'options.password', 117 | }, 118 | }, 119 | { click: '#bibLoginLayer_terms' }, 120 | { click: '#bibLoginLayer_gdpr' }, 121 | { click: '#bibLoginLayer_c0' }, 122 | ], 123 | ], 124 | search: [ 125 | [ 126 | { message: 'Artikel wird gesucht...' }, 127 | { 128 | url: '{source.scheme.raw}{source.domain.raw}/dosearch?explicitSearch=true&q={query}&dbShortcut={source.dbShortcut}&TI%2CUT%2CDZ%2CBT%2COT%2CSL=&AU=&KO=&MM%2COW%2CUF%2CMF%2CAO%2CTP%2CVM%2CNN%2CNJ%2CKV%2CZ2=&CT%2CDE%2CZ4%2CKW=&Z3%2CCN%2CCE%2CKC%2CTC%2CVC=&DT_from={dateStart}&DT_to={dateEnd}&timeFilterType=selected&timeFilter=NONE&x=59&y=11', 129 | }, 130 | ], 131 | [ 132 | { message: 'Artikel wird aufgerufen...' }, 133 | { failOnMissing: '.boxHeader', failure: 'Artikel nicht gefunden' }, 134 | { href: '.hitContent a' }, 135 | ], 136 | [ 137 | { captcha: '#layer_captcha' }, 138 | { 139 | extract: '.divDocument pre.text, .divDocument pre.textCompact', 140 | convert: 'preToParagraph', 141 | }, 142 | ], 143 | ], 144 | }, 145 | 'www.nexisuni.com': { 146 | loggedIn: "button[aria-label='Search']", 147 | start: '{source.startUrl.raw}', 148 | defaultParams: {}, 149 | login: [], 150 | search: [ 151 | [ 152 | { message: 'Artikel wird gesucht...' }, 153 | { 154 | url: 'https://{source.domain.raw}/search/?pdqttype=and&earg=pdpsf&pdtimeline={dateStart}+to+{dateEnd}%7Cdatebetween&pdsearchterms={query}&pdquerytemplateid=urn%3Aquerytemplate%3A78338d18781c574d11af5fa2f7097c99~%5ENachrichten', 155 | }, 156 | ], 157 | [ 158 | { message: 'Artikel wird aufgerufen...' }, 159 | { failOnMissing: '.doc-title', failure: 'Artikel nicht gefunden' }, 160 | { click: '.doc-title a' }, 161 | ], 162 | [{ extract: '.doc-content > span p' }], 163 | ], 164 | }, 165 | } 166 | 167 | export default sources 168 | -------------------------------------------------------------------------------- /src/stats.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | function increaseStats(domain: string) { 4 | const isPrivate = browser.extension.inIncognitoContext 5 | if (isPrivate) { 6 | return 7 | } 8 | browser.storage.sync.get({ stats: {} }).then(function (items) { 9 | items.stats[domain] = (items.stats[domain] || 0) + 1 10 | browser.storage.sync.set({ 11 | stats: items.stats, 12 | }) 13 | }) 14 | } 15 | 16 | export { increaseStats } 17 | -------------------------------------------------------------------------------- /src/tabrunner.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | import { Action, ActionCode, Actions } from './types.js' 3 | 4 | import { STATUS_MESSAGE } from './const.js' 5 | import converters from './converters.js' 6 | 7 | class TabRunner { 8 | tabId: number 9 | userData: object 10 | 11 | constructor(tabId, userData) { 12 | this.tabId = tabId 13 | this.userData = userData 14 | } 15 | 16 | async runActions(actions: Actions) { 17 | let result 18 | for (const action of actions) { 19 | result = await this.runAction(action) 20 | } 21 | return result 22 | } 23 | 24 | async runAction(action: Action) { 25 | console.log('Running', action) 26 | const actionCode: ActionCode | null = this.getActionCode(action) 27 | return await this.runScript(actionCode) 28 | } 29 | 30 | async runScript(actionCode) { 31 | if (actionCode === null) { 32 | return 33 | } 34 | let result 35 | if (actionCode.localFunc) { 36 | result = await actionCode.localFunc(this) 37 | } else { 38 | result = await (chrome.scripting || browser.scripting).executeScript({ 39 | target: { 40 | tabId: this.tabId, 41 | }, 42 | func: actionCode.func, 43 | args: actionCode.args, 44 | }) 45 | result = result[0].result 46 | } 47 | if (actionCode.resultFunc) { 48 | return actionCode.resultFunc(result) 49 | } 50 | return result 51 | } 52 | 53 | getActionCode(action: Action): ActionCode | null { 54 | if ('fill' in action) { 55 | let val 56 | if (action.fill.key && this.userData[action.fill.key]) { 57 | val = this.userData[action.fill.key] 58 | } else if (action.fill.providerKey) { 59 | val = this.userData[action.fill.providerKey] 60 | } else if (action.fill.value) { 61 | val = action.fill.value 62 | } else { 63 | return null 64 | } 65 | return { 66 | func: (selector, val, wait) => { 67 | const inner = () => { 68 | const el: HTMLInputElement = document.querySelector(selector) 69 | el.value = val 70 | } 71 | if (wait) { 72 | window.setTimeout(inner, wait) 73 | } else { 74 | inner() 75 | } 76 | return true 77 | }, 78 | args: [action.fill.selector, val, action.wait || null], 79 | } 80 | } else if ('event' in action) { 81 | return { 82 | func: (selector, event) => { 83 | document.querySelector(selector).dispatchEvent(new Event(event)) 84 | }, 85 | args: [action.event.selector, action.event.event], 86 | } 87 | } else if ('failOnMissing' in action) { 88 | return { 89 | func: (selector) => document.querySelector(selector) !== null, 90 | args: [action.failOnMissing], 91 | resultFunc: (result) => { 92 | if (result === true) { 93 | return result 94 | } 95 | throw new Error(action.failure) 96 | }, 97 | } 98 | } else if ('func' in action) { 99 | return { 100 | func: action.func, 101 | args: [this.userData], 102 | } 103 | } else if ('click' in action) { 104 | return { 105 | func: (selector, optional, wait) => { 106 | const inner = () => { 107 | const el: HTMLButtonElement = document.querySelector(selector) 108 | if (!optional || el !== null) { 109 | el.click() 110 | } 111 | } 112 | if (wait) { 113 | window.setTimeout(inner, wait) 114 | } else { 115 | inner() 116 | } 117 | return true 118 | }, 119 | args: [action.click, !!action.optional, action.wait || null], 120 | } 121 | } else if ('url' in action) { 122 | return { 123 | func: (url: string) => { 124 | document.location.href = url 125 | }, 126 | args: [typeof action.url === 'function' ? '' : action.url], 127 | } 128 | } else if ('href' in action) { 129 | return { 130 | func: (selector) => { 131 | document.location.href = document.querySelector(selector).href 132 | }, 133 | args: [action.href], 134 | } 135 | } else if ('captcha' in action) { 136 | return { 137 | func: (selector) => document.querySelector(selector) === null, 138 | args: [action.captcha], 139 | resultFunc: (result) => { 140 | if (result === true) { 141 | return result 142 | } 143 | return (sourceBot) => { 144 | sourceBot.callback({ 145 | type: STATUS_MESSAGE, 146 | action: 'interaction_required', 147 | }) 148 | return false 149 | } 150 | }, 151 | } 152 | } else if ('extract' in action) { 153 | return { 154 | func: (selector) => 155 | Array.from(document.querySelectorAll(selector)).map( 156 | (el) => el.outerHTML, 157 | ), 158 | args: [action.extract], 159 | resultFunc: (result) => { 160 | if (result.length > 0 && action.convert) { 161 | result = converters[action.convert](result) 162 | } 163 | return result 164 | }, 165 | } 166 | } 167 | } 168 | } 169 | 170 | export default TabRunner 171 | -------------------------------------------------------------------------------- /src/test_utils.ts: -------------------------------------------------------------------------------- 1 | const getContentPassConsent = ({ pageChanges = false }) => { 2 | return async (page) => { 3 | try { 4 | const locator = page.getByText('Akzeptieren und weiter') 5 | await locator.textContent({ timeout: 1000 }) 6 | await locator.click() 7 | } catch (e) { 8 | return 9 | } 10 | if (pageChanges) { 11 | await page.waitForNavigation() 12 | } 13 | } 14 | } 15 | 16 | const getConsentCdnSetup = ({ 17 | pageChanges = false, 18 | framePart = 'consent-cdn', 19 | button = '#notice button.sp_choice_type_11', 20 | }) => { 21 | return async (page) => { 22 | console.log('consent setup: find frame') 23 | const frame = page 24 | .frames() 25 | .find((frame) => frame.url().indexOf(framePart) !== -1) 26 | if (!frame) { 27 | return 28 | } 29 | console.log('consent setup: find element') 30 | const element = await frame.waitForSelector(button, { timeout: 5000 }) 31 | if (!element) { 32 | return 33 | } 34 | console.log('consent setup: click button') 35 | const finalStep = [frame.click(button)] 36 | if (pageChanges) { 37 | finalStep.push(page.waitForNavigation()) 38 | } 39 | await Promise.all(finalStep) 40 | } 41 | } 42 | 43 | const getCmpBoxConsent = () => { 44 | return async (page) => { 45 | const consent = '.cmpboxbtn.cmpboxbtnyes' 46 | await page.waitForSelector(consent) 47 | await page.click(consent) 48 | } 49 | } 50 | 51 | const consentShadowRoot = ({ 52 | docSelector = '.needsclick', 53 | shadowSelector = '.cmp-button-accept-all', 54 | }) => { 55 | return async (page) => { 56 | const count = await page.locator(docSelector).count() 57 | if (count > 0) { 58 | await page 59 | .locator(docSelector) 60 | .evaluate( 61 | (node, shadowSelector) => 62 | node.shadowRoot.querySelector(shadowSelector).click(), 63 | shadowSelector, 64 | ) 65 | } 66 | } 67 | } 68 | 69 | export { 70 | consentShadowRoot, 71 | getCmpBoxConsent, 72 | getConsentCdnSetup, 73 | getContentPassConsent, 74 | } 75 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | import SourceBot from './sourcebot' 2 | import TabRunner from './tabrunner' 3 | 4 | type TestExample = { 5 | url: string 6 | selectors: { query: string } 7 | } 8 | 9 | export type SourceIdentifier = 10 | | 'genios.de' 11 | | 'www.munzinger.de' 12 | | 'www.nexisuni.com' 13 | | 'old.genios.de' 14 | export type DefaultSourceParams = { 15 | domain?: string 16 | scheme?: string 17 | portalId?: '' 18 | } 19 | type GeniosSourceParams = { 20 | dbShortcut?: string 21 | sourceNames?: string[] 22 | } 23 | export type SiteSourceParams = DefaultSourceParams & GeniosSourceParams 24 | 25 | // eslint-disable-next-line no-use-before-define 26 | export type StringSelector = string | string[] | ((root: HTMLElement) => string) 27 | // eslint-disable-next-line no-use-before-define 28 | export type ElementSelector = 29 | | string 30 | | string[] 31 | | ((root: HTMLElement, siteBot: SiteBotInterface) => HTMLElement) 32 | type DateRange = [offsetBefore: number, offsetAfter: number] 33 | export type FormattedDateRange = { 34 | dateStart: string 35 | dateEnd: string 36 | } 37 | 38 | type Mimicer = string | ((content: string, main: HTMLElement) => string) 39 | type ParagraphStyle = { 40 | className?: string 41 | style?: string 42 | selector?: string 43 | } 44 | 45 | export type RawArticleInfo = { 46 | query?: string 47 | edition?: string 48 | date?: string 49 | } 50 | 51 | export type ArticleInfo = { 52 | query?: string 53 | edition?: string 54 | dateStart?: string 55 | dateEnd?: string 56 | } 57 | 58 | export interface ExtractorInterface { 59 | shouldExtract(): boolean 60 | extractArticleInfo(): ArticleInfo 61 | runSelectorQuery(StringSelector): string 62 | getMainContentArea(): HTMLElement 63 | hasPaywall(): boolean 64 | } 65 | 66 | export interface SiteBotInterface { 67 | extractor: ExtractorInterface 68 | start(): void 69 | hideBot(): void 70 | startInfoExtraction(): ArticleInfo 71 | runSelectorQuery(StringSelector): string 72 | } 73 | 74 | export interface PartialSite { 75 | selectors: { 76 | query: StringSelector 77 | paywall: ElementSelector 78 | main: ElementSelector 79 | loader?: ElementSelector 80 | date?: StringSelector 81 | headline?: StringSelector 82 | edition?: StringSelector 83 | } 84 | start?: (root: HTMLElement, paywall: HTMLElement) => boolean | void 85 | mimic?: Mimicer 86 | insertAfterMain?: boolean 87 | insertContent?: ( 88 | siteBot: SiteBotInterface, 89 | main: HTMLElement, 90 | content: string, 91 | ) => void 92 | waitOnLoad?: boolean | number 93 | paragraphStyle?: ParagraphStyle 94 | source: SourceIdentifier 95 | dateRange?: DateRange 96 | testSetup?: (page: PlaywrightPage) => Promise 97 | examples?: TestExample[] 98 | } 99 | 100 | export interface Site extends PartialSite { 101 | sourceParams: SiteSourceParams 102 | } 103 | 104 | export type Sites = { 105 | [key: string]: Site 106 | } 107 | 108 | export type ProviderField = 'username' | 'password' | 'city' | 'name' 109 | 110 | export type ProviderStorageOptions = { 111 | [key in ProviderField]?: string 112 | } 113 | 114 | export interface BibbotOptions { 115 | provider: string 116 | keepStats: boolean 117 | providerOptions: ProviderStorageOptions 118 | saveArticle: string | null 119 | disabledSites: string[] 120 | } 121 | 122 | export interface StorageItems extends BibbotOptions { 123 | installDate?: number | null 124 | stats?: { 125 | [key: string]: number 126 | } 127 | } 128 | 129 | export type InitMessage = { 130 | type: 'init' 131 | source: SourceIdentifier 132 | sourceParams: SiteSourceParams 133 | domain: string 134 | articleInfo: ArticleInfo 135 | } 136 | 137 | export type AbortMessage = { 138 | type: 'abort' 139 | } 140 | 141 | export type GoToTabMessage = { 142 | type: 'gototab' 143 | } 144 | 145 | export type StatusMessage = { 146 | type: 'status' 147 | message: string 148 | action?: 'interaction_required' 149 | } 150 | 151 | export type SuccessMessage = { 152 | type: 'success' 153 | content: string 154 | saveArticle?: string | null 155 | } 156 | 157 | export type FailedMessage = { 158 | type: 'failed' 159 | message: string 160 | } 161 | 162 | export type Message = 163 | | InitMessage 164 | | GoToTabMessage 165 | | StatusMessage 166 | | SuccessMessage 167 | | FailedMessage 168 | | AbortMessage 169 | 170 | export type FillAction = { 171 | fill: { 172 | selector: string 173 | key?: string 174 | providerKey?: string 175 | value?: string 176 | } 177 | wait?: number 178 | } 179 | export type ClickAction = { 180 | click: string 181 | optional?: boolean 182 | skipToNext?: boolean 183 | wait?: number 184 | } 185 | export type MessageAction = { 186 | message: string 187 | } 188 | export type UrlAction = { 189 | url: 190 | | string 191 | | ((articleInfo: ArticleInfo, sourceParams: SiteSourceParams) => string) 192 | } 193 | export type FuncAction = { 194 | // eslint-disable-next-line no-use-before-define 195 | func: (userData: object) => void 196 | } 197 | export type HrefAction = { 198 | href: string 199 | } 200 | export type FailOnMissingAction = { 201 | failOnMissing: string 202 | failure: string 203 | } 204 | export type CaptchaAction = { 205 | captcha: string 206 | } 207 | export type EventAction = { 208 | event: { 209 | selector: string 210 | event: 'change' | 'input' 211 | } 212 | } 213 | export type ExtractAction = { 214 | extract: string 215 | convert?: string 216 | } 217 | 218 | export type Action = 219 | | FillAction 220 | | ClickAction 221 | | FuncAction 222 | | MessageAction 223 | | UrlAction 224 | | HrefAction 225 | | FailOnMissingAction 226 | | CaptchaAction 227 | | ExtractAction 228 | | EventAction 229 | export type Actions = Action[] 230 | 231 | export type ClickActionCode = { 232 | func: (selector: string, optional: boolean, wait?: number) => void 233 | args: [string, boolean, number] 234 | } 235 | 236 | export type FillActionCode = { 237 | func: (selector: string, value: string, wait?: number) => void 238 | args: [string, string, number | undefined] 239 | } 240 | 241 | export type LocalActionCode = { 242 | localFunc: (siteBot: TabRunner) => void | ((sourceBot: SourceBot) => void) 243 | } 244 | 245 | export type ActionCode = 246 | | ClickActionCode 247 | | FillActionCode 248 | | LocalActionCode 249 | | { 250 | func?: (...args: string[]) => void 251 | args?: string[] 252 | } 253 | | { 254 | func?: (...args: string[]) => boolean 255 | args?: string[] 256 | resultFunc?: (result: boolean) => boolean 257 | } 258 | | { 259 | func?: (userData: object) => void 260 | args?: object[] 261 | } 262 | | { 263 | func?: (...args: string[]) => string[] 264 | args?: string[] 265 | resultFunc?: (result: string[]) => string[] 266 | } 267 | 268 | export type Source = { 269 | loggedIn: string 270 | start: string 271 | defaultParams: DefaultSourceParams 272 | login: Actions[] 273 | search: Actions[] 274 | } 275 | 276 | export type Sources = { 277 | [key in SourceIdentifier]: Source 278 | } 279 | 280 | export type ProviderOptions = { 281 | id: ProviderField 282 | display: string 283 | type: 'text' | 'password' 284 | } 285 | 286 | export type ProviderSourceParams = { 287 | domain?: string 288 | scheme?: string 289 | portalId?: string 290 | startUrl?: string 291 | } 292 | 293 | export interface DefaultProvider { 294 | name: string 295 | bibName?: string 296 | web: string 297 | params: { 298 | [key in SourceIdentifier]?: ProviderSourceParams 299 | } 300 | defaultSource?: SourceIdentifier 301 | start?: string 302 | login: Actions[] 303 | options: ProviderOptions[] 304 | } 305 | export interface Provider extends DefaultProvider { 306 | permissions: string[] 307 | } 308 | 309 | export type Providers = { 310 | [key: string]: Provider 311 | } 312 | -------------------------------------------------------------------------------- /src/ui.ts: -------------------------------------------------------------------------------- 1 | export const COLOR = '#029d74' 2 | export const ICON = 3 | 'data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%2072%2072%22%3E%3Cstyle%3E%3C%21%5BCDATA%5B.B%7Bstroke-linejoin%3Around%7D.C%7Bstroke-width%3A1.954%7D.D%7Bfill%3A%23029d74%7D.E%7Bstroke%3A%23029d74%7D%5D%5D%3E%3C/style%3E%3Cpath%20d%3D%22M51.2%2067.839c.2%200%20.4-.2.4-.4v-1.3c0-.2-.2-.4-.4-.4H15.9c-.2%200-.4-.2-.4-.4v-36.2c0-.1.1-.3.3-.4.2%200%2037.2-6.4%2040.5-7.6.1-.1.2%200%20.2.2v38.753c0%20.3.2.5.4.5h1.2a.47.47%200%200%200%20.5-.5V18.339c0-.2-.1-.3-.4-.2-4.1%201.6-44.5%209.2-44.5%209.2-.2.1-.3.2-.3.4v39.6c0%20.2.2.411.4.4h37.4z%22%20class%3D%22D%22/%3E%3Cg%20fill%3D%22none%22%20class%3D%22E%22%3E%3Cpath%20d%3D%22M19.958%2049.862h32.13v10.463h-32.13z%22%20class%3D%22B%20C%22/%3E%3Cpath%20d%3D%22M23.006%2052.876v4.756zm2.604%200v4.756zm2.603%200v4.756zm2.603%200v4.756zm2.604%200v4.756zm2.603%200v4.756zm2.604%200v4.756zm2.603%200v4.756zm2.604%200v4.756zm2.603%200v4.756zm2.604%200v4.756z%22%20stroke-width%3D%221.002%22/%3E%3Ccircle%20cx%3D%2226.982%22%20cy%3D%2237.291%22%20r%3D%224.518%22%20class%3D%22B%20C%22/%3E%3C/g%3E%3Cpath%20d%3D%22M28.843%2037.422a1.94%201.94%200%201%201-3.882.026%201.94%201.94%200%201%201%203.881-.079%22%20class%3D%22D%22/%3E%3Cellipse%20cx%3D%2245.018%22%20cy%3D%2237.291%22%20rx%3D%224.517%22%20ry%3D%224.518%22%20fill%3D%22none%22%20class%3D%22B%20C%20E%22/%3E%3Cpath%20d%3D%22M46.88%2037.422a1.94%201.94%200%201%201-3.882.026%201.94%201.94%200%201%201%203.881-.079%22%20class%3D%22D%22/%3E%3Cg%20transform%3D%22rotate%28349.739%2037.884%20157.84%29%22%20fill%3D%22none%22%20class%3D%22E%22%3E%3Ccircle%20cx%3D%2259.093%22%20cy%3D%2213.372%22%20r%3D%224.518%22%20class%3D%22B%20C%22/%3E%3Cpath%20d%3D%22M59.093%2025.018v-2.547-5.432z%22%20stroke-width%3D%222.891%22/%3E%3C/g%3E%3C/svg%3E' 4 | export const MESSAGE_ID = 'bibbot-message' 5 | export const BOT_ID = 'bibbot-loader' 6 | export const LOADER_ID = 'bibbot-loading' 7 | 8 | export const CSS = ` 9 | #${LOADER_ID} { 10 | display: flex; 11 | font-size: 35px; 12 | animation: bibbot-working 2s ease-in-out 0s infinite; 13 | } 14 | 15 | @keyframes bibbot-working { 16 | 0% { 17 | transform: translate(-60px, 0) rotateY(180deg); 18 | } 19 | 40% { 20 | transform: translate(60px, 0) rotateY(180deg) ; 21 | } 22 | 50% { 23 | transform: translate(60px, 0) rotateY(0deg) ; 24 | } 25 | 90% { 26 | transform: translate(-60px, 0) rotateY(0deg); 27 | } 28 | 100% { 29 | transform: translate(-60px, 0) rotateY(180deg); 30 | } 31 | } 32 | #${BOT_ID} { 33 | border: 5px solid ${COLOR}; 34 | padding: 10px 10px 60px; 35 | margin: 20px auto; 36 | display: flex; 37 | align-items: center; 38 | justify-content: center; 39 | flex-direction: column; 40 | } 41 | h2 { 42 | color: ${COLOR}; 43 | font-family: sans-serif; 44 | font-size: 1.2rem; 45 | } 46 | #${MESSAGE_ID} { 47 | 48 | font-family: sans-serif; 49 | font-size: 0.9rem; 50 | color: ${COLOR}; 51 | max-width: 400px; 52 | } 53 | ` 54 | 55 | export const LOADER_HTML = ` 56 |

          57 |

          BibBot

          58 |
          59 | BibBot 60 |
          61 |

          Pressedatenbank wird aufgerufen...

          62 |
          ` 63 | 64 | export const STYLES = ` 65 | 66 | ` 67 | 68 | export const FAILED_HTML = `Artikel konnte nicht gefunden werden 69 |
            70 |
          • Titel können sich von der Druckausgabe unterscheiden. Nutzen Sie das offene Tab um nach Stichworten zu suchen.
            • 71 |
          • ggf. ist der Artikel online exklusiv oder das Medium nicht über Ihre Bibliothek verfügbar
            • 72 |
          • Artikel aus der gedruckten Ausgabe sind ggf. erst später verfügbar.
            • 73 |
          ` 74 | -------------------------------------------------------------------------------- /src/update.ts: -------------------------------------------------------------------------------- 1 | import * as browser from 'webextension-polyfill' 2 | 3 | export default { 4 | run_update: (currentVersion, previousVersion) => { 5 | if (previousVersion <= '0.11.0') { 6 | // Storage of user options now is provider dependent 7 | // Move the options for VOEBB to provider specific storage 8 | console.log( 9 | 'Update from < 0.12.0 - Changing from user options to provider dependent user options', 10 | ) 11 | 12 | const defaults = { 13 | username: null, 14 | password: null, 15 | } 16 | 17 | browser.storage.sync.get(defaults).then( 18 | (items) => { 19 | if (items.username && items.password) { 20 | console.log('Found credentials') 21 | 22 | const newStorage = { 23 | providerOptions: {}, 24 | } 25 | 26 | newStorage.providerOptions['voebb.de.options.username'] = 27 | items.username 28 | newStorage.providerOptions['voebb.de.options.password'] = 29 | items.password 30 | browser.storage.sync 31 | .set(newStorage) 32 | .catch((e) => 33 | console.log('Failes to save new entries to storage:', e), 34 | ) 35 | browser.storage.sync 36 | .remove(['username', 'password']) 37 | .catch((e) => console.log('Failed to remove old entries:', e)) 38 | } else { 39 | console.log( 40 | "There isn't any username or any password set, skipping", 41 | ) 42 | } 43 | }, 44 | (e) => console.log('Failed to fetch old credentials:', e), 45 | ) 46 | } 47 | }, 48 | } 49 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | const ident = (x) => x 2 | 3 | function interpolate( 4 | str, 5 | params, 6 | prefix = '', 7 | converter = ident, 8 | fallback = '', 9 | ) { 10 | if (prefix.length > 0) { 11 | prefix = `${prefix}\\.` 12 | } 13 | for (const key in params) { 14 | str = str.replace( 15 | new RegExp(`{${prefix}${key}}`), 16 | converter(params[key] || fallback), 17 | ) 18 | str = str.replace( 19 | new RegExp(`{${prefix}${key}\\.raw}`), 20 | params[key] || fallback, 21 | ) 22 | } 23 | return str 24 | } 25 | 26 | const escapeJsString = (str) => { 27 | // prettier-ignore 28 | return str.replace(/\\/g, '\\\\').replace(/'/g, '\\\'') 29 | } 30 | 31 | export { escapeJsString, interpolate } 32 | -------------------------------------------------------------------------------- /tests/content_test.ts: -------------------------------------------------------------------------------- 1 | import Extractor from '../src/extractor.js' 2 | import sites from '../src/sites.js' 3 | 4 | const domain = document.location.host 5 | const site = sites[domain] 6 | 7 | if (site !== undefined) { 8 | window.extractor = new Extractor(site, document, null) 9 | } 10 | -------------------------------------------------------------------------------- /tests/extension.spec.ts: -------------------------------------------------------------------------------- 1 | import { expect, test } from './fixtures' 2 | 3 | const EXAMPLE_URL = 4 | 'https://www.zeit.de/2021/11/soziale-ungleichheit-identitaetspolitik-diskriminierung-armut-bildung' 5 | 6 | test('content script', async ({ page, context }) => { 7 | const serviceWorkerPromise = context.waitForEvent('serviceworker') 8 | 9 | await page.goto(EXAMPLE_URL) 10 | const shadowNode = await page 11 | .locator('.article-body > div:last-child') 12 | .first() 13 | const shadowHTML = await shadowNode.evaluate( 14 | (node) => node.shadowRoot.innerHTML, 15 | ) 16 | await expect(shadowHTML).toContain('BibBot') 17 | await expect(shadowHTML).toContain('Pressedatenbank wird aufgerufen...') 18 | // library login page is opened in a new tab 19 | // but not as a popup from current page, instead via the background script 20 | 21 | await serviceWorkerPromise 22 | 23 | let tries = 0 24 | let newPage 25 | while (newPage === undefined && tries < 3) { 26 | const pages = context.pages() 27 | console.log( 28 | tries, 29 | pages.map((p) => p.url()), 30 | ) 31 | newPage = pages.find( 32 | (p) => p.url().indexOf('https://www.voebb.de/oidcp/authorize') !== -1, 33 | ) 34 | if (newPage !== undefined) { 35 | break 36 | } 37 | await new Promise((resolve) => setTimeout(resolve, 1000)) 38 | tries += 1 39 | } 40 | expect(newPage).toBeTruthy() 41 | }) 42 | 43 | test('popup page', async ({ page, extensionId, context }) => { 44 | await page.goto(`chrome-extension://${extensionId}/popup/popup.html`) 45 | await expect(page.locator('body')).toContainText('BibBot') 46 | const settingsLink = await page.locator('#settings') 47 | await expect(settingsLink).toHaveText('Einstellungen') 48 | await settingsLink.click() 49 | 50 | const pages = context.pages() 51 | console.log(pages.map((p) => p.url())) 52 | const newPage = pages.find( 53 | (p) => 54 | p 55 | .url() 56 | .indexOf(`chrome-extension://${extensionId}/options/options.html`) !== 57 | -1, 58 | ) 59 | expect(newPage).toBeTruthy() 60 | }) 61 | 62 | test('option page', async ({ page, extensionId }) => { 63 | await page.goto(`chrome-extension://${extensionId}/options/options.html`) 64 | await expect(page.locator('body')).toContainText('BibBot') 65 | }) 66 | -------------------------------------------------------------------------------- /tests/fixtures.ts: -------------------------------------------------------------------------------- 1 | import { test as base, chromium, type BrowserContext } from '@playwright/test' 2 | import path from 'path' 3 | 4 | export const test = base.extend<{ 5 | context: BrowserContext 6 | extensionId: string 7 | }>({ 8 | // eslint-disable-next-line no-empty-pattern 9 | context: async ({}, use) => { 10 | const pathToExtension = path.join(__dirname, '../dist/bibbot') 11 | const context = await chromium.launchPersistentContext('', { 12 | headless: false, 13 | args: [ 14 | `--disable-extensions-except=${pathToExtension}`, 15 | `--load-extension=${pathToExtension}`, 16 | ], 17 | }) 18 | await use(context) 19 | await context.close() 20 | }, 21 | extensionId: async ({ context }, use) => { 22 | // for manifest v2: 23 | // let [background] = context.backgroundPages() 24 | // if (!background) { 25 | // background = await context.waitForEvent('backgroundpage') 26 | // } 27 | 28 | // for manifest v3: 29 | let [background] = context.serviceWorkers() 30 | if (!background) { 31 | background = await context.waitForEvent('serviceworker') 32 | } 33 | 34 | const extensionId = background.url().split('/')[2] 35 | await use(extensionId) 36 | }, 37 | }) 38 | export const expect = test.expect 39 | -------------------------------------------------------------------------------- /tests/index.d.ts: -------------------------------------------------------------------------------- 1 | import { ExtractorInterface } from '../src/types.js' 2 | 3 | declare global { 4 | interface Window { 5 | extractor: ExtractorInterface 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /tests/sites.spec.ts: -------------------------------------------------------------------------------- 1 | import { expect, test } from '@playwright/test' 2 | import * as fs from 'fs' 3 | import sites from '../src/sites.js' 4 | 5 | const siteTests = [] 6 | 7 | for (const siteDomain in sites) { 8 | const site = sites[siteDomain] 9 | if (site.examples) { 10 | site.examples.forEach((example, i) => { 11 | siteTests.push({ 12 | testSetup: site.testSetup, 13 | siteDomain, 14 | example, 15 | exampleIndex: i, 16 | selectors: site.selectors, 17 | }) 18 | }) 19 | } 20 | } 21 | 22 | for (const site of siteTests) { 23 | const siteDomain = site.siteDomain 24 | const example = site.example 25 | const exampleIndex = site.exampleIndex 26 | 27 | test.describe(`testing with ${siteDomain}${exampleIndex > 0 ? `[${exampleIndex}]` : ''}`, () => { 28 | let needsSetup = true 29 | test.beforeEach(async ({ page }) => { 30 | if (!needsSetup) { 31 | return 32 | } 33 | console.log('beforeall', siteDomain) 34 | await page.goto(example.url, { waitUntil: 'load' }) 35 | 36 | // Run some site-specific test setup, like GDPR clicks 37 | if (site.testSetup) { 38 | console.log('test setup', siteDomain) 39 | await site.testSetup(page) 40 | } 41 | console.log('inject script', siteDomain) 42 | await page.evaluate( 43 | fs.readFileSync('./test_build/content_test.js', 'utf8'), 44 | ) 45 | if (typeof site.waitOnLoad === 'number') { 46 | console.log('waiting', siteDomain) 47 | await page.waitForTimeout(site.waitOnLoad) 48 | } 49 | needsSetup = false 50 | }) 51 | test(`Detect extractors for ${siteDomain}`, async ({ page }) => { 52 | console.log('paywall', siteDomain) 53 | 54 | await page.waitForSelector(site.selectors.paywall, { state: 'attached' }) 55 | 56 | const result = await page.evaluate(async () => { 57 | return window.extractor.hasPaywall() 58 | }) 59 | expect(result).toBe(true) 60 | 61 | console.log('main area', siteDomain) 62 | const foundMain = await page.evaluate(async () => { 63 | return window.extractor.getMainContentArea() !== null 64 | }) 65 | expect(foundMain).toBe(true) 66 | 67 | console.log('info extraction', siteDomain) 68 | const articleInfo = await page.evaluate(async () => { 69 | if (!window.extractor.shouldExtract()) { 70 | return null 71 | } 72 | return window.extractor.extractArticleInfo() 73 | }) 74 | if (example.selectors) { 75 | for (const key in example.selectors) { 76 | expect(articleInfo[key]).toBe(example.selectors[key]) 77 | } 78 | } 79 | }) 80 | }) 81 | } 82 | -------------------------------------------------------------------------------- /tests/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", // This must be specified if "paths" is. 4 | "esModuleInterop": true 5 | }, 6 | "moduleResolution": "nodenext", 7 | "include": ["./*"] 8 | } 9 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "outDir": "./build", 5 | "target": "es6", 6 | "skipLibCheck": true, 7 | "esModuleInterop": true 8 | }, 9 | "moduleResolution": "nodenext", 10 | "include": ["./src/**/*", "./tests/content_test.ts", "./tests/index.d.ts"] 11 | } -------------------------------------------------------------------------------- /updates.json: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | { 4 | "addons": { 5 | "voebbot@stefanwehrmeyer.com": { 6 | "updates": [ 7 | {% for release in site.github.releases %} 8 | {% assign short_version = release.tag_name | remove_first:'v' %} 9 | { 10 | "version": "{{ short_version }}", 11 | "update_link": "https://github.com/stefanw/bibbot/releases/download/v{{ short_version }}/bibbot-v{{ short_version }}.xpi" 12 | }{% if forloop.last == false %},{% endif %} 13 | {% endfor %} 14 | ] 15 | } 16 | } 17 | } --------------------------------------------------------------------------------