├── fiduswriter └── phplist │ ├── __init__.py │ ├── tests │ ├── __init__.py │ └── test_phplist.py │ ├── static │ └── js │ │ ├── plugins │ │ └── confirm_account │ │ │ └── phplist.js │ │ └── modules │ │ └── phplist │ │ ├── templates.js │ │ └── index.js │ ├── locale │ ├── bg │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ ├── de │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ ├── es │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ ├── fr │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ ├── it │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ ├── pt_BR │ │ └── LC_MESSAGES │ │ │ ├── djangojs.mo │ │ │ └── djangojs.po │ └── BASE │ │ └── LC_MESSAGES │ │ └── djangojs.po │ ├── apps.py │ ├── urls.py │ └── views.py ├── dev-requirements.txt ├── MANIFEST.in ├── ci ├── .coveragerc └── configuration.py ├── .gitignore ├── pyproject.toml ├── setup.py ├── README.md ├── .pre-commit-config.yaml ├── stylelint.config.js ├── .github └── workflows │ └── main.yml ├── lint └── django_import_resolver.js ├── biome.json └── LICENSE /fiduswriter/phplist/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fiduswriter/phplist/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /dev-requirements.txt: -------------------------------------------------------------------------------- 1 | pre-commit==4.0.1 2 | fiduswriter 3 | -------------------------------------------------------------------------------- /fiduswriter/phplist/static/js/plugins/confirm_account/phplist.js: -------------------------------------------------------------------------------- 1 | export {ConfirmAccountPHPList} from "../../modules/phplist" 2 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.rst 3 | recursive-include fiduswriter/phplist/static * 4 | recursive-include fiduswriter/phplist/locale * 5 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/bg/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/bg/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/de/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/de/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/es/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/es/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/fr/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/fr/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/it/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/it/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/pt_BR/LC_MESSAGES/djangojs.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiduswriter/fiduswriter-phplist/main/fiduswriter/phplist/locale/pt_BR/LC_MESSAGES/djangojs.mo -------------------------------------------------------------------------------- /fiduswriter/phplist/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class Config(AppConfig): 5 | name = "phplist" 6 | default_auto_field = "django.db.models.AutoField" 7 | -------------------------------------------------------------------------------- /ci/.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | parallel = True 3 | concurrency = thread,multiprocessing 4 | sigterm = True 5 | relative_files = True 6 | omit = 7 | *migrations* 8 | venv/* 9 | *virtualenv* 10 | configuration.py 11 | -------------------------------------------------------------------------------- /ci/configuration.py: -------------------------------------------------------------------------------- 1 | INSTALLED_APPS = ["phplist"] 2 | 3 | PHPLIST_BASE_URL = "http://localhost:9999/" 4 | PHPLIST_LOGIN = "login" 5 | PHPLIST_PASSWORD = "password" 6 | PHPLIST_SECRET = "secret" 7 | PHPLIST_LIST_ID = "4" 8 | -------------------------------------------------------------------------------- /fiduswriter/phplist/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import re_path 2 | 3 | from . import views 4 | 5 | urlpatterns = [ 6 | re_path( 7 | "^subscribe_email/$", 8 | views.subscribe_email, 9 | name="phplist_subscribe_email", 10 | ), 11 | ] 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *~ 3 | dist/ 4 | fiduswriter_phplist.egg-info/ 5 | build/ 6 | __pycache__/ 7 | venv/ 8 | fiduswriter/.transpile 9 | fiduswriter/media 10 | fiduswriter/static-libs 11 | fiduswriter/static-transpile 12 | fiduswriter/static-collected 13 | fiduswriter/.coveragerc 14 | fiduswriter/configuration.py 15 | fiduswriter/fiduswriter.sql 16 | fiduswriter/screenshots 17 | .direnv/ 18 | .envrc 19 | -------------------------------------------------------------------------------- /fiduswriter/phplist/static/js/modules/phplist/templates.js: -------------------------------------------------------------------------------- 1 | export const formQuestion = () => 2 | ` 3 | ${gettext("Yes")} 4 | ${gettext("No")} 5 | 6 | ${gettext("I would like to receive information about news and updates to the service by email.")} 7 | ` 8 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/BASE/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # FIRST AUTHOR , YEAR. 5 | # 6 | #, fuzzy 7 | msgid "" 8 | msgstr "" 9 | "Project-Id-Version: PACKAGE VERSION\n" 10 | "Report-Msgid-Bugs-To: \n" 11 | "POT-Creation-Date: 2018-05-17 22:24+0200\n" 12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" 13 | "Last-Translator: FULL NAME \n" 14 | "Language-Team: LANGUAGE \n" 15 | "Language: \n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | 20 | #: static/js/modules/phplist/templates.js:3 21 | msgid "Yes" 22 | msgstr "" 23 | 24 | #: static/js/modules/phplist/templates.js:4 25 | msgid "No" 26 | msgstr "" 27 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/it/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: it\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "Iscritto alla mailing list" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "sì" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "No" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Vorrei ricevere informazioni su novità e aggiornamenti del servizio via e-" 30 | "mail." 31 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/bg/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: bg\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "Абонирани сте за имейл списък" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "да" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "Не" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Бих искал да получавам информация за новини и актуализации на услугата по " 30 | "имейл." 31 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/de/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: de\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "E-Mail-Liste abonniert" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "Ja" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "Nein" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Ich möchte Informationen über Neuigkeiten und Aktualisierungen des Dienstes " 30 | "per E-Mail erhalten." 31 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/pt_BR/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: pt-br\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "Inscrito na lista de e-mail" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "Sim" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "Não" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Gostaria de receber informações sobre notícias e atualizações do serviço por " 30 | "e-mail." 31 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/es/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: es\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "Suscrito a la lista de correo electrónico" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "Sí" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "No" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Me gustaría recibir información sobre noticias y actualizaciones del " 30 | "servicio por correo electrónico." 31 | -------------------------------------------------------------------------------- /fiduswriter/phplist/locale/fr/LC_MESSAGES/djangojs.po: -------------------------------------------------------------------------------- 1 | msgid "" 2 | msgstr "" 3 | "Project-Id-Version: Fidus Writer phplist\n" 4 | "Report-Msgid-Bugs-To: \n" 5 | "POT-Creation-Date: 2021-11-17 22:04+0000\n" 6 | "Language: fr\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "X-Generator: POEditor.com\n" 11 | 12 | #: phplist/static/js/modules/phplist/index.js:31 13 | msgid "Subscribed to email list" 14 | msgstr "Abonné à la liste de diffusion" 15 | 16 | #: phplist/static/js/modules/phplist/templates.js:1 17 | msgid "Yes" 18 | msgstr "Oui" 19 | 20 | #: phplist/static/js/modules/phplist/templates.js:1 21 | msgid "No" 22 | msgstr "Non" 23 | 24 | #: phplist/static/js/modules/phplist/templates.js:1 25 | msgid "" 26 | "I would like to receive information about news and updates to the service by " 27 | "email." 28 | msgstr "" 29 | "Je souhaite recevoir des informations sur les nouveautés et mises à jour du " 30 | "service par courrier éléctronique." 31 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=65.6.3", "wheel", "babel"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "fiduswriter-phplist" 7 | description = "A Fidus Writer plugin to integrate with an emaillist using PHPList." 8 | version = "4.0.0" 9 | readme = "README.md" 10 | license = {text = "AGPL-3.0-or-later"} 11 | authors = [ 12 | {email = "johannes@fiduswriter.org", name = "Johannes Wilm"}, 13 | ] 14 | classifiers=[ 15 | "Environment :: Web Environment", 16 | "Framework :: Django", 17 | "Framework :: Django :: 4.1", 18 | "Intended Audience :: Developers", 19 | "License :: OSI Approved :: GNU Affero General Public License v3", 20 | "Operating System :: OS Independent", 21 | "Programming Language :: Python", 22 | "Programming Language :: Python :: 3", 23 | "Topic :: Internet :: WWW/HTTP", 24 | "Topic :: Internet :: WWW/HTTP :: Dynamic Content", 25 | ] 26 | 27 | [project.urls] 28 | repository = "https://www.github.com/fiduswriter/fiduswriter-phplist" 29 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from glob import glob 3 | from setuptools import find_namespace_packages, setup 4 | from setuptools.command.build_py import build_py as _build_py 5 | 6 | 7 | # From https://github.com/pypa/setuptools/pull/1574 8 | class build_py(_build_py): 9 | def find_package_modules(self, package, package_dir): 10 | modules = super().find_package_modules(package, package_dir) 11 | patterns = self._get_platform_patterns( 12 | self.exclude_package_data, 13 | package, 14 | package_dir, 15 | ) 16 | 17 | excluded_module_files = [] 18 | for pattern in patterns: 19 | excluded_module_files.extend(glob(pattern)) 20 | 21 | for f in excluded_module_files: 22 | for module in modules: 23 | if module[2] == f: 24 | modules.remove(module) 25 | return modules 26 | 27 | 28 | os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) 29 | 30 | setup( 31 | packages=find_namespace_packages(), 32 | include_package_data=True, 33 | exclude_package_data={ 34 | "": ["configuration.py", "django-admin.py", "build/*"] 35 | }, 36 | cmdclass={"build_py": build_py}, 37 | ) 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | FidusWriter-PHPList 2 | ===== 3 | 4 | FidusWriter-PHPList is a Fidus writer plugin to connect a Fidus Writer instance 5 | with an email list using PHPList. It allows users signing up on the Fidus Writer instance to also sign up for the email list. 6 | 7 | 8 | Installation 9 | ----------- 10 | 11 | 1. Install PHPList 3.X if you haven't done so already. Install Fidus Writer with the command: 12 | 13 | pip install fiduswriter[phplist] 14 | 15 | 2. Create an email list within PHPList if you don't have one already. Take note of the list ID. 16 | 17 | 3. Within PHPList, install the REST API plugin. 18 | 19 | 4. Setup an admin user with access rights to manage subscriber lists within PHPList. 20 | 21 | 5. Add "phplist" to your INSTALLED_APPS setting in the configuration.py file 22 | like this:: 23 | 24 | INSTALLED_APPS += ( 25 | ... 26 | 'phplist', 27 | ) 28 | 29 | 6. Add these settings to configuration.py:: 30 | 31 | PHPLIST_BASE_URL # The URL of your PHPList installation 32 | PHPLIST_LOGIN # The PHPList user's username created in step 4 33 | PHPLIST_PASSWORD # The PHPList user's password created in step 4 34 | PHPLIST_SECRET (optional) # If you have set an obligatory secret within the PHPLIst REST API, set it here as well. 35 | PHPLIST_LIST_ID # The email list id found in step 2. 36 | 37 | 7. (Re)start your Fidus Writer server. 38 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/psf/black-pre-commit-mirror 3 | rev: 24.10.0 4 | hooks: 5 | - id: black 6 | args: [--line-length=79] 7 | language_version: python3.13 8 | - repo: https://github.com/pycqa/flake8 9 | rev: '7.1.1' 10 | hooks: 11 | - id: flake8 12 | entry: flake8 --extend-ignore E203,E501 13 | - repo: https://github.com/biomejs/pre-commit 14 | rev: "75149f4e3b63c4df805860d7b04186d56dcbc05c" 15 | hooks: 16 | - id: biome-check 17 | #entry: biome check --files-ignore-unknown=true --no-errors-on-unmatched --fix --unsafe 18 | additional_dependencies: ["@biomejs/biome@1.9.2"] 19 | - repo: https://github.com/awebdeveloper/pre-commit-stylelint 20 | rev: "4200758f4cb2f53dd06898dd8dca35e4b8cfb785" 21 | hooks: 22 | - id: stylelint 23 | additional_dependencies: 24 | [ 25 | "stylelint@15.11.0", 26 | "stylelint-config-standard@34.0.0", 27 | "stylelint-value-no-unknown-custom-properties@5.0.0", 28 | "postcss@8.4.32", 29 | ] 30 | - repo: local 31 | hooks: 32 | - id: django-import-resolver 33 | name: Django Import Resolver 34 | entry: node lint/django_import_resolver.js 35 | language: node 36 | files: \.js$ 37 | additional_dependencies: ["acorn@8.10.0"] 38 | -------------------------------------------------------------------------------- /fiduswriter/phplist/static/js/modules/phplist/index.js: -------------------------------------------------------------------------------- 1 | import {addAlert, deactivateWait, post} from "../common" 2 | 3 | import {formQuestion} from "./templates" 4 | 5 | export class ConfirmAccountPHPList { 6 | constructor({page}) { 7 | this.confirmAccount = page 8 | } 9 | 10 | init() { 11 | this.addToForm() 12 | } 13 | 14 | addToForm() { 15 | this.confirmAccount.confirmQuestionsTemplates.push(formQuestion) 16 | this.confirmAccount.formChecks.push(() => 17 | document.querySelector("input[name=emaillist]:checked") 18 | ) 19 | this.confirmAccount.confirmMethods.push(() => { 20 | const emailListRadio = document.querySelector( 21 | "input[name=emaillist]:checked" 22 | ) 23 | if (!emailListRadio || emailListRadio.value === "no") { 24 | return 25 | } 26 | const email = this.confirmAccount.email 27 | return post("/api/phplist/subscribe_email/", {email}) 28 | .then(() => { 29 | deactivateWait() 30 | if (emailListRadio) { 31 | addAlert("info", gettext("Subscribed to email list")) 32 | } 33 | // Wait while message is shown 34 | return new Promise(resolve => 35 | setTimeout(() => resolve(), 3000) 36 | ) 37 | }) 38 | .catch(error => console.error(error)) 39 | }) 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /stylelint.config.js: -------------------------------------------------------------------------------- 1 | const path = require("path") 2 | const {execSync} = require("child_process") 3 | 4 | function getFidusWriterPath() { 5 | try { 6 | const fwPath = execSync( 7 | "python -c \"import fiduswriter; print(next(filter(lambda path: '/site-packages/' in path, fiduswriter.__path__), ''))\"" 8 | ) 9 | .toString() 10 | .trim() 11 | if (fwPath) { 12 | return fwPath 13 | } 14 | throw new Error("Fidus Writer not found") 15 | } catch (error) { 16 | console.error( 17 | "Failed to find Fidus Writer installation:", 18 | error.message 19 | ) 20 | process.exit(1) 21 | } 22 | } 23 | 24 | const fidusWriterPath = getFidusWriterPath() 25 | 26 | module.exports = { 27 | extends: "stylelint-config-standard", 28 | plugins: ["stylelint-value-no-unknown-custom-properties"], 29 | rules: { 30 | "color-hex-length": "long", 31 | "max-nesting-depth": 2, 32 | "csstools/value-no-unknown-custom-properties": [ 33 | true, 34 | { 35 | importFrom: [ 36 | path.join(fidusWriterPath, "base/static/css/colors.css") 37 | ] 38 | } 39 | ], 40 | "selector-class-pattern": [ 41 | "^(([a-z][a-z0-9]*)(-[a-z0-9]+)*)|(ProseMirror(-[a-z0-9]+)*)$", 42 | { 43 | message: 44 | "Selector should use lowercase and separate words with hyphens (selector-class-pattern)" 45 | } 46 | ] 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | - develop 8 | pull_request: 9 | branches: 10 | - main 11 | - develop 12 | 13 | # Allows you to run this workflow manually from the Actions tab 14 | workflow_dispatch: 15 | 16 | jobs: 17 | pre-commit: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - uses: actions/checkout@v4 21 | - uses: actions/setup-python@v5 22 | with: 23 | python-version: "3.13" 24 | - name: Install dependencies 25 | run: | 26 | pip install pip --upgrade 27 | if grep version pyproject.toml | grep -q "dev"; 28 | then pip install https://github.com/fiduswriter/fiduswriter/archive/develop.zip; 29 | else pip install https://github.com/fiduswriter/fiduswriter/archive/main.zip; 30 | fi 31 | - uses: pre-commit/action@v3.0.1 32 | test: 33 | runs-on: ubuntu-latest 34 | steps: 35 | - name: Set up Python 36 | uses: actions/setup-python@v5 37 | with: 38 | python-version: "3.13" 39 | - name: Set up Node 40 | uses: actions/setup-node@v4 41 | with: 42 | node-version: 22 43 | - uses: actions/checkout@v4 44 | - uses: nanasess/setup-chromedriver@master 45 | - name: Install dependencies 46 | run: | 47 | sudo apt update 48 | sudo apt install libjpeg-dev gettext zlib1g-dev git build-essential 49 | if grep version pyproject.toml | grep -q "dev"; 50 | then pip install https://github.com/fiduswriter/fiduswriter/archive/develop.zip; 51 | else pip install https://github.com/fiduswriter/fiduswriter/archive/main.zip; 52 | fi 53 | cd fiduswriter 54 | mv ../ci/configuration.py ./ 55 | mv ../ci/.coveragerc ./ 56 | pip install requests[security] 57 | pip install coverage 58 | pip install coveralls 59 | pip install selenium 60 | pip install packaging 61 | pip install webdriver-manager 62 | pip install wheel 63 | pip install pip --upgrade 64 | coverage run $(which fiduswriter) setup --no-static 65 | - name: Run test phplist 66 | uses: nick-invision/retry@v3 67 | with: 68 | timeout_minutes: 8 69 | max_attempts: 3 70 | retry_on: error 71 | command: | 72 | cd fiduswriter 73 | coverage run $(which fiduswriter) test phplist 74 | - name: Coveralls 75 | run: | 76 | cd fiduswriter 77 | coverage combine 78 | coveralls --service=github 79 | env: 80 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 81 | -------------------------------------------------------------------------------- /fiduswriter/phplist/views.py: -------------------------------------------------------------------------------- 1 | import re 2 | from httpx import AsyncClient, HTTPError 3 | from urllib.parse import urlencode, urljoin 4 | 5 | from django.views.decorators.http import require_POST 6 | from django.http import HttpResponse 7 | from django.conf import settings 8 | 9 | from allauth.account.models import EmailAddress 10 | 11 | 12 | @require_POST 13 | async def subscribe_email(request): 14 | if ( 15 | not hasattr(settings, "PHPLIST_BASE_URL") 16 | or not settings.PHPLIST_BASE_URL 17 | ): 18 | return HttpResponse() 19 | url = urljoin(settings.PHPLIST_BASE_URL, "/admin/") 20 | login_data = { 21 | "cmd": "login", 22 | "login": settings.PHPLIST_LOGIN, 23 | "password": settings.PHPLIST_PASSWORD, 24 | } 25 | if hasattr(settings, "PHPLIST_SECRET"): 26 | login_data["secret"] = settings.PHPLIST_SECRET 27 | try: 28 | async with AsyncClient() as client: 29 | response = await client.post( 30 | url, 31 | params={"page": "importsimple"}, 32 | headers={ 33 | "Content-Type": "application/x-www-form-urlencoded", 34 | }, 35 | content=urlencode(login_data), 36 | ) 37 | response.raise_for_status() 38 | except HTTPError: 39 | return HttpResponse(status=500) 40 | # 41 | session_cookie = response.headers["Set-Cookie"] 42 | formtoken_match = re.search( 43 | r' { 45 | if (subdir.isDirectory()) { 46 | const staticPath = path.join(rootDir, subdir.name, "static") 47 | if ( 48 | fs.existsSync(staticPath) && 49 | fs.lstatSync(staticPath).isDirectory() 50 | ) { 51 | appsPaths.push(path.join(rootDir, subdir.name)) 52 | } 53 | } 54 | }) 55 | return appsPaths 56 | } 57 | 58 | function resolveFilelocation(source, file, appsPaths) { 59 | const returnValue = {found: false, path: null} 60 | const fullPath = path.resolve(path.dirname(file), source) 61 | 62 | if (fullPath.includes("/plugins/")) { 63 | returnValue.found = true 64 | returnValue.path = null 65 | return returnValue 66 | } 67 | 68 | // Check in plugin and fidus writer apps 69 | appsPaths.find(appPath => { 70 | const resolvedPath = fullPath.replace( 71 | /.*\/static\/js\//g, 72 | `${appPath}/static/js/` 73 | ) 74 | if (isFile(`${resolvedPath}.js`)) { 75 | returnValue.path = `${resolvedPath}.js` 76 | returnValue.found = true 77 | return true 78 | } 79 | if (isFile(`${resolvedPath}/index.js`)) { 80 | returnValue.path = `${resolvedPath}/index.js` 81 | returnValue.found = true 82 | return true 83 | } 84 | 85 | return false 86 | }) 87 | 88 | return returnValue 89 | } 90 | 91 | function checkExports(filePath, importedNames, sourcePath) { 92 | const content = fs.readFileSync(filePath, "utf-8") 93 | const ast = acorn.parse(content, { 94 | sourceType: "module", 95 | ecmaVersion: "latest" 96 | }) 97 | 98 | const exportedNames = new Set() 99 | 100 | ast.body.forEach(node => { 101 | if (node.type === "ExportNamedDeclaration") { 102 | if (node.declaration) { 103 | if (node.declaration.id) { 104 | exportedNames.add(node.declaration.id.name) 105 | } else if (node.declaration.declarations) { 106 | node.declaration.declarations.forEach(decl => { 107 | if (decl.id && decl.id.name) { 108 | exportedNames.add(decl.id.name) 109 | } 110 | }) 111 | } 112 | } 113 | if (node.specifiers) { 114 | node.specifiers.forEach(spec => { 115 | exportedNames.add(spec.exported.name) 116 | }) 117 | } 118 | } else if (node.type === "ExportDefaultDeclaration") { 119 | exportedNames.add("default") 120 | } 121 | }) 122 | 123 | importedNames.forEach(name => { 124 | if (!exportedNames.has(name)) { 125 | console.error( 126 | `Unresolved export: ${name} not found in ${filePath}, imported in ${sourcePath}` 127 | ) 128 | process.exit(1) 129 | } 130 | }) 131 | } 132 | 133 | function checkImports(file, appsPaths) { 134 | const content = fs.readFileSync(file, "utf-8") 135 | const importRegex = 136 | /import\s+(?:(\*\s+as\s+\w+)|(\w+)|(\{[^}]+\}))\s+from\s+['"](.*)['"]/g 137 | let match 138 | while ((match = importRegex.exec(content)) !== null) { 139 | const source = match[4] 140 | // Skip non-relative imports 141 | if (!source.startsWith(".") && !source.startsWith("..")) { 142 | continue 143 | } 144 | if (EXCEPTIONS.includes(source)) { 145 | continue 146 | } 147 | const result = resolveFilelocation(source, file, appsPaths) 148 | if (!result.found) { 149 | console.error(`Unresolved import: ${source} in file ${file}`) 150 | process.exit(1) 151 | } 152 | 153 | const importedNames = [] 154 | if (match[1]) { 155 | // import * as name 156 | importedNames.push("*") 157 | } else if (match[2]) { 158 | // import name 159 | importedNames.push("default") 160 | } else if (match[3]) { 161 | // import { name1, name2 } 162 | const names = match[3] 163 | .replace(/[{}]/g, "") 164 | .split(",") 165 | .map(name => name.trim()) 166 | importedNames.push(...names) 167 | } 168 | if (!result.path) { 169 | // Plugin - final path cannot be checked yet. 170 | return 171 | } 172 | checkExports(result.path, importedNames, file) 173 | } 174 | } 175 | 176 | const pluginPath = path.resolve(__dirname, "../fiduswriter") 177 | const pluginAppsPaths = getAppsPaths(pluginPath) 178 | 179 | const fidusWriterPath = getFidusWriterPath() 180 | const fidusWriterAppsPaths = getAppsPaths(fidusWriterPath) 181 | 182 | const appsPaths = pluginAppsPaths.concat(fidusWriterAppsPaths) 183 | 184 | const files = process.argv.slice(2) 185 | files.forEach(file => checkImports(file, appsPaths)) 186 | -------------------------------------------------------------------------------- /biome.json: -------------------------------------------------------------------------------- 1 | { 2 | "formatter": { 3 | "enabled": true, 4 | "useEditorconfig": true, 5 | "formatWithErrors": false, 6 | "indentStyle": "space", 7 | "indentWidth": 4, 8 | "lineEnding": "lf", 9 | "lineWidth": 80, 10 | "attributePosition": "auto", 11 | "bracketSpacing": true, 12 | "ignore": [ 13 | "**/.transpile-cache/", 14 | "**/venv/", 15 | "**/static-transpile/", 16 | "**/static-libs/", 17 | "**/static-collected/", 18 | "**/node-modules/", 19 | "**/testing/", 20 | "**/.eslintrc.mjs", 21 | "**/*.json", 22 | "**/*.html", 23 | "**/.direnv", 24 | "**/venv", 25 | "**/.transpile", 26 | "**/.babelrc", 27 | "**/sw-template.js" 28 | ] 29 | }, 30 | "linter": { 31 | "enabled": true, 32 | "rules": { 33 | "recommended": false, 34 | "complexity": { 35 | "noExtraBooleanCast": "error", 36 | "noMultipleSpacesInRegularExpressionLiterals": "error", 37 | "noUselessCatch": "off", 38 | "noUselessConstructor": "off", 39 | "noUselessLabel": "error", 40 | "noUselessLoneBlockStatements": "error", 41 | "noUselessRename": "error", 42 | "noUselessStringConcat": "error", 43 | "noUselessTernary": "off", 44 | "noUselessUndefinedInitialization": "error", 45 | "noVoid": "error", 46 | "noWith": "error", 47 | "useLiteralKeys": "off" 48 | }, 49 | "correctness": { 50 | "noConstAssign": "error", 51 | "noConstantCondition": "error", 52 | "noEmptyCharacterClassInRegex": "error", 53 | "noEmptyPattern": "error", 54 | "noGlobalObjectCalls": "error", 55 | "noInnerDeclarations": "error", 56 | "noInvalidConstructorSuper": "error", 57 | "noInvalidUseBeforeDeclaration": "off", 58 | "noNewSymbol": "error", 59 | "noNonoctalDecimalEscape": "error", 60 | "noPrecisionLoss": "error", 61 | "noSelfAssign": "error", 62 | "noSetterReturn": "error", 63 | "noSwitchDeclarations": "error", 64 | "noUndeclaredVariables": "error", 65 | "noUnreachable": "error", 66 | "noUnreachableSuper": "error", 67 | "noUnsafeFinally": "error", 68 | "noUnsafeOptionalChaining": "error", 69 | "noUnusedLabels": "error", 70 | "noUnusedVariables": "error", 71 | "useArrayLiterals": "error", 72 | "useIsNan": "error", 73 | "useValidForDirection": "error", 74 | "useYield": "error" 75 | }, 76 | "security": { "noGlobalEval": "error" }, 77 | "style": { 78 | "noArguments": "off", 79 | "noCommaOperator": "error", 80 | "noNegationElse": "off", 81 | "noParameterAssign": "off", 82 | "noRestrictedGlobals": { "level": "error", "options": {} }, 83 | "noVar": "error", 84 | "noYodaExpression": "off", 85 | "useBlockStatements": "error", 86 | "useCollapsedElseIf": "off", 87 | "useConsistentBuiltinInstantiation": "error", 88 | "useConst": "warn", 89 | "useDefaultSwitchClause": "off", 90 | "useNumericLiterals": "error", 91 | "useShorthandAssign": "off", 92 | "useSingleVarDeclarator": "off", 93 | "useTemplate": "off" 94 | }, 95 | "suspicious": { 96 | "noAsyncPromiseExecutor": "error", 97 | "noCatchAssign": "error", 98 | "noClassAssign": "error", 99 | "noCompareNegZero": "error", 100 | "noControlCharactersInRegex": "off", 101 | "noDebugger": "error", 102 | "noDoubleEquals": "off", 103 | "noDuplicateCase": "error", 104 | "noDuplicateClassMembers": "error", 105 | "noDuplicateObjectKeys": "error", 106 | "noDuplicateParameters": "error", 107 | "noEmptyBlockStatements": "off", 108 | "noFallthroughSwitchClause": "error", 109 | "noFunctionAssign": "error", 110 | "noGlobalAssign": "error", 111 | "noImportAssign": "error", 112 | "noLabelVar": "error", 113 | "noMisleadingCharacterClass": "error", 114 | "noPrototypeBuiltins": "off", 115 | "noRedeclare": "error", 116 | "noSelfCompare": "error", 117 | "noShadowRestrictedNames": "error", 118 | "noSparseArray": "error", 119 | "noUnsafeNegation": "error", 120 | "useAwait": "error", 121 | "useGetterReturn": "error", 122 | "useValidTypeof": "error" 123 | } 124 | }, 125 | "ignore": [ 126 | "**/.transpile-cache/", 127 | "**/venv/", 128 | "**/static-transpile/", 129 | "**/static-libs/", 130 | "**/static-collected/", 131 | "**/testing/", 132 | "**/manifest.json", 133 | "**/sw-template.js" 134 | ] 135 | }, 136 | "javascript": { 137 | "formatter": { 138 | "jsxQuoteStyle": "double", 139 | "quoteProperties": "asNeeded", 140 | "trailingCommas": "none", 141 | "semicolons": "asNeeded", 142 | "indentWidth": 4, 143 | "arrowParentheses": "asNeeded", 144 | "bracketSameLine": true, 145 | "quoteStyle": "double", 146 | "attributePosition": "auto", 147 | "bracketSpacing": false 148 | }, 149 | "globals": [ 150 | "settings_MEDIA_MAX_SIZE", 151 | "settings_SOCIALACCOUNT_OPEN", 152 | "settings_REGISTRATION_OPEN", 153 | "gettext", 154 | "interpolate", 155 | "settings_USE_SERVICE_WORKER", 156 | "transpile_VERSION", 157 | "settings_TEST_SERVER", 158 | "settings_DEBUG", 159 | "settings_SOURCE_MAPS", 160 | "settings_STATIC_URL", 161 | "settings_PASSWORD_LOGIN", 162 | "process", 163 | "staticUrl", 164 | "settings_CONTACT_EMAIL", 165 | "settings_IS_FREE", 166 | "settings_FOOTER_LINKS", 167 | "settings_BRANDING_LOGO" 168 | ] 169 | } 170 | } 171 | -------------------------------------------------------------------------------- /fiduswriter/phplist/tests/test_phplist.py: -------------------------------------------------------------------------------- 1 | import time 2 | import sys 3 | import multiprocessing 4 | from http.server import BaseHTTPRequestHandler, HTTPServer 5 | import socket 6 | import requests 7 | from urllib.parse import urljoin 8 | from urllib.parse import parse_qs 9 | 10 | from selenium.webdriver.common.by import By 11 | from selenium.webdriver.support import expected_conditions as EC 12 | from selenium.webdriver.support.wait import WebDriverWait 13 | from selenium.common.exceptions import StaleElementReferenceException 14 | from channels.testing import ChannelsLiveServerTestCase 15 | from django.test import override_settings 16 | 17 | from testing.selenium_helper import SeleniumHelper 18 | from testing.mail import get_outbox, empty_outbox, delete_outbox 19 | 20 | 21 | # From https://realpython.com/testing-third-party-apis-with-mock-servers/ 22 | class MockServerRequestHandler(BaseHTTPRequestHandler): 23 | def do_POST(self): 24 | if self.path != "/admin/?page=importsimple": 25 | self.send_response(requests.codes.not_found) 26 | self.end_headers() 27 | return 28 | content_length = int(self.headers["Content-Length"]) 29 | form = parse_qs(self.rfile.read(content_length).decode("utf-8")) 30 | if "cmd" in form and form["cmd"][0] == "login": 31 | self.send_response(requests.codes.ok) 32 | self.send_header("Set-Cookie", "fish=2000") 33 | self.end_headers() 34 | self.wfile.write( 35 | ''.encode( 36 | "utf-8" 37 | ) 38 | ) 39 | elif "importcontent" in form: 40 | self.send_response(requests.codes.ok) 41 | self.end_headers() 42 | self.wfile.write( 43 | "Email has been subscribed!".encode( 44 | "utf-8" 45 | ) 46 | ) 47 | else: 48 | self.send_response(requests.codes.not_found) 49 | self.end_headers() 50 | return 51 | 52 | 53 | def get_free_port(): 54 | s = socket.socket(socket.AF_INET, type=socket.SOCK_STREAM) 55 | s.bind(("localhost", 0)) 56 | address, port = s.getsockname() 57 | s.close() 58 | return port 59 | 60 | 61 | MAIL_STORAGE_NAME = "phplist" 62 | 63 | SERVER_PORT = get_free_port() 64 | 65 | 66 | @override_settings(MAIL_STORAGE_NAME=MAIL_STORAGE_NAME) 67 | @override_settings(EMAIL_BACKEND="testing.mail.EmailBackend") 68 | @override_settings(PHPLIST_BASE_URL="") 69 | class PHPlistTestNotAvailable(SeleniumHelper, ChannelsLiveServerTestCase): 70 | fixtures = ["initial_documenttemplates.json", "initial_styles.json"] 71 | 72 | @classmethod 73 | def start_server(cls, port): 74 | httpd = HTTPServer(("", port), MockServerRequestHandler) 75 | httpd.serve_forever() 76 | 77 | @classmethod 78 | def setUpClass(cls): 79 | super().setUpClass() 80 | cls.base_url = cls.live_server_url 81 | driver_data = cls.get_drivers(1) 82 | cls.driver = driver_data["drivers"][0] 83 | cls.client = driver_data["clients"][0] 84 | cls.driver.implicitly_wait(driver_data["wait_time"]) 85 | cls.wait_time = driver_data["wait_time"] 86 | cls.server = multiprocessing.Process( 87 | target=cls.start_server, args=(SERVER_PORT,) 88 | ) 89 | cls.server.daemon = True 90 | cls.server.start() 91 | 92 | def tearDown(self): 93 | self.driver.execute_script("window.localStorage.clear()") 94 | self.driver.execute_script("window.sessionStorage.clear()") 95 | super().tearDown() 96 | empty_outbox(MAIL_STORAGE_NAME) 97 | if "coverage" in sys.modules.keys(): 98 | # Cool down 99 | time.sleep(self.wait_time / 3) 100 | 101 | @classmethod 102 | def tearDownClass(cls): 103 | cls.driver.quit() 104 | cls.server.terminate() 105 | delete_outbox(MAIL_STORAGE_NAME) 106 | super().tearDownClass() 107 | 108 | def test_signup_yes(self): 109 | self.signup(self.driver, True, False, False) 110 | 111 | def test_signup_no(self): 112 | self.signup(self.driver, False, False, False) 113 | 114 | def assertInfoAlert(self, message): 115 | i = 0 116 | message_found = False 117 | while i < 100: 118 | i = i + 1 119 | try: 120 | if ( 121 | self.driver.find_element( 122 | By.CSS_SELECTOR, 123 | "body #alerts-outer-wrapper .alerts-info", 124 | ).text 125 | == message 126 | ): 127 | message_found = True 128 | break 129 | else: 130 | time.sleep(0.1) 131 | continue 132 | except StaleElementReferenceException: 133 | time.sleep(0.1) 134 | continue 135 | self.assertTrue(message_found) 136 | 137 | def signup(self, driver, list=False, signed_up=False, setting=False): 138 | driver.get(urljoin(self.base_url, "/account/sign-up/")) 139 | 140 | driver.find_element(By.ID, "id-username").send_keys( 141 | f"username_{list}_{signed_up}_{setting}" 142 | ) 143 | driver.find_element(By.ID, "id-password1").send_keys("password") 144 | driver.find_element(By.ID, "id-password2").send_keys("password") 145 | driver.find_element(By.ID, "id-email").send_keys( 146 | f"my.no.{list}.{signed_up}.{setting}@email.com" 147 | ) 148 | driver.find_element(By.ID, "signup-submit").click() 149 | time.sleep(1) 150 | signup_link = self.find_urls(get_outbox(MAIL_STORAGE_NAME)[-1].body)[0] 151 | driver.get(signup_link) 152 | driver.find_element(By.ID, "terms-check").click() 153 | driver.find_element(By.ID, "test-check").click() 154 | if list: 155 | answer = "yes" 156 | else: 157 | answer = "no" 158 | driver.find_element( 159 | By.CSS_SELECTOR, 160 | 'input[name="emaillist"][value="{}"]'.format(answer), 161 | ).click() 162 | submit_button = driver.find_element(By.ID, "submit") 163 | submit_button.click() 164 | 165 | if signed_up: 166 | self.assertInfoAlert("Subscribed to email list") 167 | WebDriverWait(driver, self.wait_time).until( 168 | EC.staleness_of(submit_button) 169 | ) 170 | self.assertEqual( 171 | driver.find_element(By.CSS_SELECTOR, ".fw-contents h1").text, 172 | "Thanks for verifying!", 173 | ) 174 | 175 | 176 | @override_settings(MAIL_STORAGE_NAME=MAIL_STORAGE_NAME) 177 | @override_settings(EMAIL_BACKEND="testing.mail.EmailBackend") 178 | @override_settings(PHPLIST_BASE_URL="http://localhost:{}/".format(SERVER_PORT)) 179 | @override_settings(PHPLIST_LOGIN="login") 180 | @override_settings(PHPLIST_PASSWORD="password") 181 | @override_settings(PHPLIST_LIST_ID="1") 182 | class PHPlistTestAvailable(SeleniumHelper, ChannelsLiveServerTestCase): 183 | fixtures = ["initial_documenttemplates.json", "initial_styles.json"] 184 | 185 | @classmethod 186 | def start_server(cls, port): 187 | httpd = HTTPServer(("", port), MockServerRequestHandler) 188 | httpd.serve_forever() 189 | 190 | @classmethod 191 | def setUpClass(cls): 192 | super().setUpClass() 193 | cls.base_url = cls.live_server_url 194 | driver_data = cls.get_drivers(1) 195 | cls.driver = driver_data["drivers"][0] 196 | cls.client = driver_data["clients"][0] 197 | cls.driver.implicitly_wait(driver_data["wait_time"]) 198 | cls.wait_time = driver_data["wait_time"] 199 | cls.server = multiprocessing.Process( 200 | target=cls.start_server, args=(SERVER_PORT,) 201 | ) 202 | cls.server.daemon = True 203 | cls.server.start() 204 | 205 | def tearDown(self): 206 | self.driver.execute_script("window.localStorage.clear()") 207 | self.driver.execute_script("window.sessionStorage.clear()") 208 | super().tearDown() 209 | empty_outbox(MAIL_STORAGE_NAME) 210 | if "coverage" in sys.modules.keys(): 211 | # Cool down 212 | time.sleep(self.wait_time / 3) 213 | 214 | @classmethod 215 | def tearDownClass(cls): 216 | cls.driver.quit() 217 | cls.server.terminate() 218 | delete_outbox(MAIL_STORAGE_NAME) 219 | super().tearDownClass() 220 | 221 | def test_signup_no(self): 222 | self.signup(self.driver, False, False, True) 223 | 224 | def test_signup_yes(self): 225 | self.signup(self.driver, True, True, True) 226 | 227 | def assertInfoAlert(self, message): 228 | i = 0 229 | message_found = False 230 | while i < 100: 231 | i = i + 1 232 | try: 233 | if ( 234 | self.driver.find_element( 235 | By.CSS_SELECTOR, 236 | "body #alerts-outer-wrapper .alerts-info", 237 | ).text 238 | == message 239 | ): 240 | message_found = True 241 | break 242 | else: 243 | time.sleep(0.1) 244 | continue 245 | except StaleElementReferenceException: 246 | time.sleep(0.1) 247 | continue 248 | self.assertTrue(message_found) 249 | 250 | def signup(self, driver, list=False, signed_up=False, setting=False): 251 | driver.get(urljoin(self.base_url, "/account/sign-up/")) 252 | 253 | driver.find_element(By.ID, "id-username").send_keys( 254 | f"username_{list}_{signed_up}_{setting}" 255 | ) 256 | driver.find_element(By.ID, "id-password1").send_keys("password") 257 | driver.find_element(By.ID, "id-password2").send_keys("password") 258 | driver.find_element(By.ID, "id-email").send_keys( 259 | f"my.no.{list}.{signed_up}.{setting}@email.com" 260 | ) 261 | driver.find_element(By.ID, "signup-submit").click() 262 | time.sleep(1) 263 | signup_link = self.find_urls(get_outbox(MAIL_STORAGE_NAME)[-1].body)[0] 264 | driver.get(signup_link) 265 | driver.find_element(By.ID, "terms-check").click() 266 | driver.find_element(By.ID, "test-check").click() 267 | if list: 268 | answer = "yes" 269 | else: 270 | answer = "no" 271 | driver.find_element( 272 | By.CSS_SELECTOR, 273 | 'input[name="emaillist"][value="{}"]'.format(answer), 274 | ).click() 275 | submit_button = driver.find_element(By.ID, "submit") 276 | submit_button.click() 277 | 278 | if signed_up: 279 | self.assertInfoAlert("Subscribed to email list") 280 | WebDriverWait(driver, self.wait_time).until( 281 | EC.staleness_of(submit_button) 282 | ) 283 | self.assertEqual( 284 | driver.find_element(By.CSS_SELECTOR, ".fw-contents h1").text, 285 | "Thanks for verifying!", 286 | ) 287 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------