├── helm └── mautrix-twilio │ ├── .gitignore │ ├── .editorconfig │ ├── requirements.yaml │ ├── templates │ ├── serviceaccount.yaml │ ├── service.yaml │ ├── NOTES.txt │ ├── _helpers.tpl │ ├── configmap.yaml │ └── deployment.yaml │ ├── requirements.lock │ ├── Chart.yaml │ ├── .helmignore │ └── values.yaml ├── optional-requirements.txt ├── mautrix_twilio ├── util │ ├── __init__.py │ └── color_log.py ├── __init__.py ├── formatter │ ├── __init__.py │ ├── from_whatsapp.py │ └── from_matrix.py ├── twilio │ ├── __init__.py │ ├── api.py │ ├── data.py │ ├── webhook.py │ └── request_validator.py ├── db │ ├── __init__.py │ ├── puppet.py │ ├── portal.py │ └── message.py ├── sqlstatestore.py ├── context.py ├── user.py ├── matrix.py ├── __main__.py ├── config.py ├── puppet.py └── portal.py ├── .dockerignore ├── requirements.txt ├── README.md ├── .gitignore ├── .editorconfig ├── alembic ├── script.py.mako ├── env.py └── versions │ └── 8e87452589a1_initial_revision.py ├── alembic.ini ├── Dockerfile ├── .gitlab-ci.yml ├── docker-run.sh ├── setup.py ├── example-config.yaml └── LICENSE /helm/mautrix-twilio/.gitignore: -------------------------------------------------------------------------------- 1 | charts/* 2 | -------------------------------------------------------------------------------- /optional-requirements.txt: -------------------------------------------------------------------------------- 1 | phonenumbers 2 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{yaml,yml}] 2 | indent_size = 2 3 | -------------------------------------------------------------------------------- /mautrix_twilio/util/__init__.py: -------------------------------------------------------------------------------- 1 | from .color_log import ColorFormatter 2 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .editorconfig 2 | .codeclimate.yml 3 | *.png 4 | *.md 5 | .venv 6 | -------------------------------------------------------------------------------- /mautrix_twilio/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.1.0.dev1" 2 | __author__ = "Tulir Asokan " 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp 2 | SQLAlchemy 3 | alembic 4 | ruamel.yaml 5 | commonmark 6 | python-magic 7 | mautrix 8 | -------------------------------------------------------------------------------- /mautrix_twilio/formatter/__init__.py: -------------------------------------------------------------------------------- 1 | from .from_matrix import matrix_to_whatsapp 2 | from .from_whatsapp import whatsapp_to_matrix 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mautrix-twilio 2 | A Matrix-Twilio relaybot bridge. 3 | 4 | ## Discussion 5 | Matrix room: [`#twilio:maunium.net`](https://matrix.to/#/#twilio:maunium.net) 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | *.pyc 3 | *.egg-info 4 | /build 5 | /dist 6 | 7 | config.yaml 8 | registration.yaml 9 | !example-config.yaml 10 | 11 | *.log 12 | *.log.* 13 | 14 | *.db 15 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/requirements.yaml: -------------------------------------------------------------------------------- 1 | dependencies: 2 | - name: postgresql 3 | version: 6.5.0 4 | repository: https://kubernetes-charts.storage.googleapis.com/ 5 | condition: postgresql.enabled 6 | -------------------------------------------------------------------------------- /mautrix_twilio/twilio/__init__.py: -------------------------------------------------------------------------------- 1 | from .data import (TwilioUserID, TwilioMessageID, TwilioMessageEvent, TwilioStatusEvent, 2 | TwilioMessageStatus) 3 | from .api import TwilioClient 4 | from .webhook import TwilioHandler 5 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/serviceaccount.yaml: -------------------------------------------------------------------------------- 1 | {{- if .Values.serviceAccount.create -}} 2 | apiVersion: v1 3 | kind: ServiceAccount 4 | metadata: 5 | name: {{ template "mautrix-twilio.serviceAccountName" . }} 6 | labels: 7 | {{ include "mautrix-twilio.labels" . | indent 4 }} 8 | {{- end -}} 9 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/requirements.lock: -------------------------------------------------------------------------------- 1 | dependencies: 2 | - name: postgresql 3 | repository: https://kubernetes-charts.storage.googleapis.com/ 4 | version: 6.5.0 5 | digest: sha256:85139e9d4207e49c11c5f84d7920d0135cffd3d427f3f3638d4e51258990de2a 6 | generated: "2019-10-23T22:57:33.770418415+03:00" 7 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | indent_size = 4 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [*.py] 12 | max_line_length = 99 13 | indent_style = space 14 | 15 | [*.{yaml, yml}] 16 | indent_style = space 17 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/Chart.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | name: mautrix-twilio 3 | version: 0.1.0 4 | appVersion: "0.1.0" 5 | description: A Matrix-Twilio relaybot bridge. 6 | keywords: 7 | - matrix 8 | - bridge 9 | - twilio 10 | - whatsapp 11 | maintainers: 12 | - name: Tulir Asokan 13 | email: tulir@maunium.net 14 | sources: 15 | - https://github.com/tulir/mautrix-twilio 16 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/.helmignore: -------------------------------------------------------------------------------- 1 | # Patterns to ignore when building packages. 2 | # This supports shell glob matching, relative path matching, and 3 | # negation (prefixed with !). Only one pattern per line. 4 | .DS_Store 5 | # Common VCS dirs 6 | .git/ 7 | .gitignore 8 | .bzr/ 9 | .bzrignore 10 | .hg/ 11 | .hgignore 12 | .svn/ 13 | # Common backup files 14 | *.swp 15 | *.bak 16 | *.tmp 17 | *~ 18 | # Various IDEs 19 | .project 20 | .idea/ 21 | *.tmproj 22 | .vscode/ 23 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/service.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Service 3 | metadata: 4 | name: {{ include "mautrix-twilio.fullname" . }} 5 | labels: 6 | {{ include "mautrix-twilio.labels" . | indent 4 }} 7 | spec: 8 | type: {{ .Values.service.type }} 9 | ports: 10 | - port: {{ .Values.service.port }} 11 | targetPort: http 12 | protocol: TCP 13 | name: http 14 | selector: 15 | app.kubernetes.io/name: {{ include "mautrix-twilio.name" . }} 16 | app.kubernetes.io/instance: {{ .Release.Name }} 17 | -------------------------------------------------------------------------------- /alembic/script.py.mako: -------------------------------------------------------------------------------- 1 | """${message} 2 | 3 | Revision ID: ${up_revision} 4 | Revises: ${down_revision | comma,n} 5 | Create Date: ${create_date} 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | ${imports if imports else ""} 11 | 12 | # revision identifiers, used by Alembic. 13 | revision = ${repr(up_revision)} 14 | down_revision = ${repr(down_revision)} 15 | branch_labels = ${repr(branch_labels)} 16 | depends_on = ${repr(depends_on)} 17 | 18 | 19 | def upgrade(): 20 | ${upgrades if upgrades else "pass"} 21 | 22 | 23 | def downgrade(): 24 | ${downgrades if downgrades else "pass"} 25 | -------------------------------------------------------------------------------- /alembic.ini: -------------------------------------------------------------------------------- 1 | [alembic] 2 | script_location = alembic 3 | 4 | [loggers] 5 | keys = root,sqlalchemy,alembic 6 | 7 | [handlers] 8 | keys = console 9 | 10 | [formatters] 11 | keys = generic 12 | 13 | [logger_root] 14 | level = WARN 15 | handlers = console 16 | qualname = 17 | 18 | [logger_sqlalchemy] 19 | level = WARN 20 | handlers = 21 | qualname = sqlalchemy.engine 22 | 23 | [logger_alembic] 24 | level = INFO 25 | handlers = 26 | qualname = alembic 27 | 28 | [handler_console] 29 | class = StreamHandler 30 | args = (sys.stderr,) 31 | level = NOTSET 32 | formatter = generic 33 | 34 | [formatter_generic] 35 | format = %(levelname)-5.5s [%(name)s] %(message)s 36 | datefmt = %H:%M:%S 37 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM docker.io/alpine:3.10 2 | 3 | ENV UID=1337 \ 4 | GID=1337 5 | 6 | RUN apk add --no-cache \ 7 | py3-pillow \ 8 | py3-aiohttp \ 9 | py3-magic \ 10 | py3-sqlalchemy \ 11 | py3-psycopg2 \ 12 | py3-ruamel.yaml \ 13 | # Indirect dependencies 14 | #commonmark 15 | py3-future \ 16 | #alembic 17 | py3-mako \ 18 | py3-dateutil \ 19 | py3-markupsafe \ 20 | py3-six \ 21 | py3-idna \ 22 | # Other dependencies 23 | ca-certificates \ 24 | su-exec 25 | 26 | COPY . /opt/mautrix-twilio 27 | WORKDIR /opt/mautrix-twilio 28 | RUN pip3 install .[phonenumbers] 29 | 30 | VOLUME /data 31 | 32 | CMD ["/opt/mautrix-twilio/docker-run.sh"] 33 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/NOTES.txt: -------------------------------------------------------------------------------- 1 | Your registration file is below. Save it into a YAML file and give the path to that file to synapse: 2 | 3 | id: {{ .Values.appservice.id }} 4 | as_token: {{ .Values.appservice.asToken }} 5 | hs_token: {{ .Values.appservice.hsToken }} 6 | namespaces: 7 | users: 8 | - exclusive: true 9 | regex: "@{{ .Values.bridge.username_template | replace "{userid}" ".+"}}:{{ .Values.homeserver.domain }}" 10 | {{- if .Values.appservice.communityID }} 11 | group_id: {{ .Values.appservice.communityID }} 12 | {{- end }} 13 | aliases: 14 | - exclusive: true 15 | regex: "@{{ .Values.bridge.alias_template | replace "{groupname}" ".+"}}:{{ .Values.homeserver.domain }}" 16 | {{- if .Values.appservice.communityID }} 17 | group_id: {{ .Values.appservice.communityID }} 18 | {{- end }} 19 | url: {{ .Values.appservice.address }} 20 | sender_localpart: {{ .Values.appservice.botUsername }} 21 | rate_limited: false 22 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | image: docker:stable 2 | 3 | stages: 4 | - build 5 | - push 6 | 7 | default: 8 | before_script: 9 | - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY 10 | 11 | build: 12 | stage: build 13 | script: 14 | - docker pull $CI_REGISTRY_IMAGE:latest || true 15 | - docker build --pull --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA . 16 | - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA 17 | 18 | push latest: 19 | stage: push 20 | only: 21 | - master 22 | variables: 23 | GIT_STRATEGY: none 24 | script: 25 | - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA 26 | - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:latest 27 | - docker push $CI_REGISTRY_IMAGE:latest 28 | 29 | push tag: 30 | stage: push 31 | variables: 32 | GIT_STRATEGY: none 33 | except: 34 | - master 35 | script: 36 | - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA 37 | - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME 38 | - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME 39 | -------------------------------------------------------------------------------- /docker-run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # Define functions. 4 | function fixperms { 5 | chown -R $UID:$GID /data /opt/mautrix-twilio 6 | } 7 | 8 | cd /opt/mautrix-twilio 9 | 10 | if [ ! -f /data/config.yaml ]; then 11 | cp example-config.yaml /data/config.yaml 12 | echo "Didn't find a config file." 13 | echo "Copied default config file to /data/config.yaml" 14 | echo "Modify that config file to your liking." 15 | echo "Start the container again after that to generate the registration file." 16 | fixperms 17 | exit 18 | fi 19 | 20 | # Replace database path in config. 21 | sed -i "s#sqlite:///mautrix-twilio.db#sqlite:////data/mautrix-twilio.db#" /data/config.yaml 22 | 23 | # Check that database is in the right state 24 | alembic -x config=/data/config.yaml upgrade head 25 | 26 | if [ ! -f /data/registration.yaml ]; then 27 | python3 -m mautrix_twilio -g -c /data/config.yaml -r /data/registration.yaml 28 | echo "Didn't find a registration file." 29 | echo "Generated one for you." 30 | echo "Copy that over to synapses app service directory." 31 | fixperms 32 | exit 33 | fi 34 | 35 | fixperms 36 | exec su-exec $UID:$GID python3 -m mautrix_twilio -c /data/config.yaml 37 | -------------------------------------------------------------------------------- /mautrix_twilio/util/color_log.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from mautrix.util.color_log import ColorFormatter as BaseColorFormatter, PREFIX, RESET 17 | 18 | TWILIO_COLOR = PREFIX + "35;1m" # magenta 19 | 20 | 21 | class ColorFormatter(BaseColorFormatter): 22 | def _color_name(self, module: str) -> str: 23 | if module.startswith("twilio"): 24 | return TWILIO_COLOR + module + RESET 25 | return super()._color_name(module) 26 | -------------------------------------------------------------------------------- /mautrix_twilio/db/__init__.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from sqlalchemy.engine.base import Engine 17 | 18 | from mautrix.bridge.db import UserProfile, RoomState 19 | 20 | from .puppet import Puppet 21 | from .portal import Portal 22 | from .message import Message 23 | 24 | 25 | def init(db_engine: Engine) -> None: 26 | for table in (UserProfile, RoomState, Puppet, Portal, Message): 27 | table.db = db_engine 28 | table.t = table.__table__ 29 | table.c = table.t.c 30 | table.column_names = table.c.keys() 31 | -------------------------------------------------------------------------------- /mautrix_twilio/db/puppet.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, TYPE_CHECKING 17 | 18 | from sqlalchemy import Column, String, Boolean 19 | from sqlalchemy.sql import expression 20 | 21 | from mautrix.util.db import Base 22 | 23 | if TYPE_CHECKING: 24 | from ..twilio import TwilioUserID 25 | 26 | 27 | class Puppet(Base): 28 | __tablename__ = "puppet" 29 | 30 | twid: 'TwilioUserID' = Column(String(127), primary_key=True) 31 | matrix_registered: bool = Column(Boolean, nullable=False, server_default=expression.false()) 32 | 33 | @classmethod 34 | def get_by_twid(cls, twid: 'TwilioUserID') -> Optional['Puppet']: 35 | return cls._select_one_or_none(cls.c.twid == twid) 36 | -------------------------------------------------------------------------------- /mautrix_twilio/sqlstatestore.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from mautrix.types import UserID 17 | from mautrix.bridge.db import SQLStateStore as BaseSQLStateStore 18 | 19 | from . import puppet as pu 20 | 21 | 22 | class SQLStateStore(BaseSQLStateStore): 23 | def is_registered(self, user_id: UserID) -> bool: 24 | puppet = pu.Puppet.get_by_mxid(user_id, create=False) 25 | if puppet: 26 | return puppet.is_registered 27 | return super().is_registered(user_id) 28 | 29 | def registered(self, user_id: UserID) -> None: 30 | puppet = pu.Puppet.get_by_mxid(user_id, create=True) 31 | if puppet: 32 | puppet.is_registered = True 33 | puppet.save() 34 | else: 35 | super().registered(user_id) 36 | -------------------------------------------------------------------------------- /mautrix_twilio/db/portal.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, TYPE_CHECKING 17 | 18 | from sqlalchemy import Column, String 19 | 20 | from mautrix.util.db import Base 21 | from mautrix.types import RoomID 22 | 23 | if TYPE_CHECKING: 24 | from ..twilio import TwilioUserID 25 | 26 | 27 | class Portal(Base): 28 | __tablename__ = "portal" 29 | 30 | twid: 'TwilioUserID' = Column(String(127), primary_key=True) 31 | mxid: RoomID = Column(String(255), nullable=True) 32 | 33 | @classmethod 34 | def get_by_twid(cls, twid: 'TwilioUserID') -> Optional['Portal']: 35 | return cls._select_one_or_none(cls.c.twid == twid) 36 | 37 | @classmethod 38 | def get_by_mxid(cls, mxid: RoomID) -> Optional['Portal']: 39 | return cls._select_one_or_none(cls.c.mxid == mxid) 40 | -------------------------------------------------------------------------------- /alembic/env.py: -------------------------------------------------------------------------------- 1 | from alembic import context 2 | from sqlalchemy import engine_from_config, pool 3 | from logging.config import fileConfig 4 | 5 | import sys 6 | from os.path import abspath, dirname 7 | 8 | sys.path.insert(0, dirname(dirname(abspath(__file__)))) 9 | 10 | from mautrix.util.db import Base 11 | from mautrix_twilio.config import Config 12 | import mautrix_twilio.db 13 | 14 | config = context.config 15 | mxtw_config_path = context.get_x_argument(as_dictionary=True).get("config", "config.yaml") 16 | mxtw_config = Config(mxtw_config_path, None, None) 17 | mxtw_config.load() 18 | config.set_main_option("sqlalchemy.url", 19 | mxtw_config.get("appservice.database", "sqlite:///mautrix-twilio.db")) 20 | fileConfig(config.config_file_name) 21 | target_metadata = Base.metadata 22 | 23 | 24 | def run_migrations_offline(): 25 | url = config.get_main_option("sqlalchemy.url") 26 | context.configure( 27 | url=url, target_metadata=target_metadata, literal_binds=True) 28 | 29 | with context.begin_transaction(): 30 | context.run_migrations() 31 | 32 | 33 | def run_migrations_online(): 34 | connectable = engine_from_config( 35 | config.get_section(config.config_ini_section), 36 | prefix='sqlalchemy.', 37 | poolclass=pool.NullPool) 38 | 39 | with connectable.connect() as connection: 40 | context.configure( 41 | connection=connection, 42 | target_metadata=target_metadata 43 | ) 44 | 45 | with context.begin_transaction(): 46 | context.run_migrations() 47 | 48 | 49 | if context.is_offline_mode(): 50 | run_migrations_offline() 51 | else: 52 | run_migrations_online() 53 | -------------------------------------------------------------------------------- /mautrix_twilio/formatter/from_whatsapp.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Match, Tuple, Optional 17 | import re 18 | 19 | italic = re.compile(r"([\s>~*]|^)_(.+?)_([^a-zA-Z\d]|$)") 20 | bold = re.compile(r"([\s>_~]|^)\*(.+?)\\*([^a-zA-Z\d]|$)") 21 | strike = re.compile(r"([\s>_*]|^)~(.+?)~([^a-zA-Z\d]|$)") 22 | code_block = re.compile("```((?:.|\n)+?)```") 23 | 24 | 25 | def code_block_repl(match: Match) -> str: 26 | text = match.group(1) 27 | if "\n" in text: 28 | return f"
{text}
" 29 | return f"{text}" 30 | 31 | 32 | def whatsapp_to_matrix(text: str) -> Tuple[Optional[str], str]: 33 | html = italic.sub(r"\1\2\3", text) 34 | html = bold.sub(r"\1\2\3", html) 35 | html = strike.sub(r"\1\2\3", html) 36 | html = code_block.sub(code_block_repl, html) 37 | if html != text: 38 | return html.replace("\n", "
"), text 39 | return None, text 40 | -------------------------------------------------------------------------------- /mautrix_twilio/context.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Tuple, TYPE_CHECKING 17 | from asyncio import AbstractEventLoop 18 | 19 | from mautrix.appservice import AppService 20 | 21 | from .config import Config 22 | 23 | if TYPE_CHECKING: 24 | from .matrix import MatrixHandler 25 | from .twilio import TwilioHandler, TwilioClient 26 | 27 | 28 | class Context: 29 | az: AppService 30 | config: Config 31 | twc: 'TwilioClient' 32 | loop: AbstractEventLoop 33 | mx: Optional['MatrixHandler'] 34 | tw: Optional['TwilioHandler'] 35 | 36 | def __init__(self, az: AppService, config: Config, twc: 'TwilioClient', loop: AbstractEventLoop 37 | ) -> None: 38 | self.az = az 39 | self.config = config 40 | self.twc = twc 41 | self.loop = loop 42 | self.mx = None 43 | self.tw = None 44 | 45 | @property 46 | def core(self) -> Tuple[AppService, Config, AbstractEventLoop]: 47 | return self.az, self.config, self.loop 48 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | import glob 3 | import mautrix_twilio 4 | 5 | try: 6 | long_desc = open("README.md").read() 7 | except IOError: 8 | long_desc = "Failed to read README.md" 9 | 10 | setuptools.setup( 11 | name="mautrix-twilio", 12 | version=mautrix_twilio.__version__, 13 | url="https://github.com/tulir/mautrix-twilio", 14 | 15 | author="Tulir Asokan", 16 | author_email="tulir@maunium.net", 17 | 18 | description="A Matrix-Twilio relaybot bridge.", 19 | long_description=long_desc, 20 | long_description_content_type="text/markdown", 21 | 22 | packages=setuptools.find_packages(), 23 | 24 | install_requires=[ 25 | "aiohttp>=3.0.1,<4", 26 | "mautrix>=0.4.0.dev70,<0.5.0", 27 | "ruamel.yaml>=0.15.94,<0.17", 28 | "commonmark>=0.8,<0.10", 29 | "python-magic>=0.4,<0.5", 30 | "SQLAlchemy>=1.2,<2", 31 | "alembic>=1,<2", 32 | ], 33 | extras_require={ 34 | "phonenumbers": ["phonenumbers>=8,<9"], 35 | }, 36 | 37 | classifiers=[ 38 | "Development Status :: 2 - Pre-Alpha", 39 | "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", 40 | "Topic :: Communications :: Chat", 41 | "Framework :: AsyncIO", 42 | "Programming Language :: Python", 43 | "Programming Language :: Python :: 3", 44 | "Programming Language :: Python :: 3.6", 45 | "Programming Language :: Python :: 3.7", 46 | ], 47 | entry_points=""" 48 | [console_scripts] 49 | mautrix-twilio=mautrix_twilio.__main__:main 50 | """, 51 | data_files=[ 52 | (".", ["example-config.yaml", "alembic.ini"]), 53 | ("alembic", ["alembic/env.py"]), 54 | ("alembic/versions", glob.glob("alembic/versions/*.py")) 55 | ], 56 | ) 57 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/_helpers.tpl: -------------------------------------------------------------------------------- 1 | {{/* 2 | Expand the name of the chart. 3 | */}} 4 | {{- define "mautrix-twilio.name" -}} 5 | {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} 6 | {{- end -}} 7 | 8 | {{/* 9 | Create a default fully qualified app name. 10 | We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). 11 | If release name contains chart name it will be used as a full name. 12 | */}} 13 | {{- define "mautrix-twilio.fullname" -}} 14 | {{- if .Values.fullnameOverride -}} 15 | {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} 16 | {{- else -}} 17 | {{- $name := default .Chart.Name .Values.nameOverride -}} 18 | {{- if contains $name .Release.Name -}} 19 | {{- .Release.Name | trunc 63 | trimSuffix "-" -}} 20 | {{- else -}} 21 | {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} 22 | {{- end -}} 23 | {{- end -}} 24 | {{- end -}} 25 | 26 | {{/* 27 | Create chart name and version as used by the chart label. 28 | */}} 29 | {{- define "mautrix-twilio.chart" -}} 30 | {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} 31 | {{- end -}} 32 | 33 | {{/* 34 | Common labels 35 | */}} 36 | {{- define "mautrix-twilio.labels" -}} 37 | app.kubernetes.io/name: {{ include "mautrix-twilio.name" . }} 38 | helm.sh/chart: {{ include "mautrix-twilio.chart" . }} 39 | app.kubernetes.io/instance: {{ .Release.Name }} 40 | {{- if .Chart.AppVersion }} 41 | app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} 42 | {{- end }} 43 | app.kubernetes.io/managed-by: {{ .Release.Service }} 44 | {{- end -}} 45 | 46 | {{/* 47 | Create the name of the service account to use 48 | */}} 49 | {{- define "mautrix-twilio.serviceAccountName" -}} 50 | {{- if .Values.serviceAccount.create -}} 51 | {{ default (include "mautrix-twilio.fullname" .) .Values.serviceAccount.name }} 52 | {{- else -}} 53 | {{ default "default" .Values.serviceAccount.name }} 54 | {{- end -}} 55 | {{- end -}} 56 | -------------------------------------------------------------------------------- /mautrix_twilio/user.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Dict, Optional, TYPE_CHECKING 17 | 18 | from mautrix.types import UserID 19 | from mautrix.bridge import BaseUser 20 | 21 | from . import puppet as pu 22 | from .config import Config 23 | 24 | if TYPE_CHECKING: 25 | from .context import Context 26 | 27 | config: Config 28 | 29 | 30 | class User(BaseUser): 31 | by_mxid: Dict[UserID, 'User'] = {} 32 | 33 | is_whitelisted: bool 34 | is_admin: bool 35 | 36 | def __init__(self, mxid: UserID) -> None: 37 | super().__init__() 38 | self.mxid = mxid 39 | self.by_mxid[self.mxid] = self 40 | self.command_status = None 41 | self.is_whitelisted, self.is_admin = config.get_permissions(self.mxid) 42 | self.log = self.log.getChild(self.mxid) 43 | 44 | @classmethod 45 | def get(cls, mxid: UserID) -> Optional['User']: 46 | if pu.Puppet.get_twid_from_mxid(mxid) is not None or mxid == cls.az.bot_mxid: 47 | return None 48 | try: 49 | return cls.by_mxid[mxid] 50 | except KeyError: 51 | return cls(mxid) 52 | 53 | 54 | def init(context: 'Context') -> None: 55 | global config 56 | User.az, config, User.loop = context.core 57 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/configmap.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: ConfigMap 3 | metadata: 4 | name: {{ template "mautrix-twilio.fullname" . }} 5 | labels: 6 | app.kubernetes.io/managed-by: {{ .Release.Service }} 7 | app.kubernetes.io/instance: {{ .Release.Name }} 8 | helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }} 9 | app.kubernetes.io/name: {{ template "mautrix-twilio.name" . }} 10 | data: 11 | config.yaml: | 12 | homeserver: 13 | address: {{ .Values.homeserver.address }} 14 | public_address: {{ .Values.homeserver.publicAddress }} 15 | domain: {{ .Values.homeserver.domain }} 16 | verify_ssl: {{ .Values.homeserver.verifySSL }} 17 | 18 | appservice: 19 | address: http://{{ include "mautrix-twilio.fullname" . }}:{{ .Values.service.port }} 20 | 21 | hostname: 0.0.0.0 22 | port: {{ .Values.service.port }} 23 | max_body_size: {{ .Values.appservice.maxBodySize }} 24 | 25 | {{- if .Values.postgresql.enabled }} 26 | database: "postgres://postgres:{{ .Values.postgresql.postgresqlPassword }}@{{ .Release.Name }}-postgresql/{{ .Values.postgresql.postgresqlDatabase }}" 27 | {{- else }} 28 | database: {{ .Values.appservice.database | quote }} 29 | {{- end }} 30 | 31 | public: 32 | {{- toYaml .Values.appservice.public | nindent 8 }} 33 | 34 | provisioning: 35 | {{- toYaml .Values.appservice.provisioning | nindent 8 }} 36 | 37 | id: {{ .Values.appservice.id }} 38 | bot_username: {{ .Values.appservice.botUsername }} 39 | bot_displayname: {{ .Values.appservice.botDisplayname }} 40 | bot_avatar: {{ .Values.appservice.botAvatar }} 41 | 42 | community_id: {{ .Values.appservice.communityID }} 43 | 44 | as_token: {{ .Values.appservice.asToken }} 45 | hs_token: {{ .Values.appservice.hsToken }} 46 | 47 | bridge: 48 | {{- toYaml .Values.bridge | nindent 6 }} 49 | 50 | twilio: 51 | {{- toYaml .Values.twilio | nindent 6 }} 52 | 53 | logging: 54 | {{- toYaml .Values.logging | nindent 6 }} 55 | registration.yaml: "" 56 | -------------------------------------------------------------------------------- /mautrix_twilio/db/message.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Iterable, TYPE_CHECKING 17 | 18 | from sqlalchemy import Column, String, and_ 19 | 20 | from mautrix.util.db import Base 21 | from mautrix.types import RoomID, EventID 22 | 23 | if TYPE_CHECKING: 24 | from ..twilio import TwilioUserID, TwilioMessageID 25 | 26 | 27 | class Message(Base): 28 | __tablename__ = "message" 29 | 30 | mxid: EventID = Column(String(255)) 31 | mx_room: RoomID = Column(String(255)) 32 | tw_receiver: 'TwilioUserID' = Column(String(127), primary_key=True) 33 | twid: 'TwilioMessageID' = Column(String(127), primary_key=True) 34 | 35 | @classmethod 36 | def get_all_by_twid(cls, twid: 'TwilioMessageID', tw_receiver: 'TwilioUserID' 37 | ) -> Iterable['Message']: 38 | return cls._select_all(cls.c.twid == twid, cls.c.tw_receiver == tw_receiver) 39 | 40 | @classmethod 41 | def get_by_twid(cls, twid: 'TwilioMessageID', tw_receiver: 'TwilioUserID' 42 | ) -> Optional['Message']: 43 | return cls._select_one_or_none(and_(cls.c.twid == twid, cls.c.tw_receiver == tw_receiver)) 44 | 45 | @classmethod 46 | def get_by_mxid(cls, mxid: EventID, mx_room: RoomID) -> Optional['Message']: 47 | return cls._select_one_or_none(and_(cls.c.mxid == mxid, cls.c.mx_room == mx_room)) 48 | -------------------------------------------------------------------------------- /mautrix_twilio/matrix.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional 17 | import asyncio 18 | 19 | from mautrix.types import UserID, RoomID, Event, MessageEvent, StateEvent 20 | from mautrix.appservice import AppService 21 | from mautrix.bridge import BaseMatrixHandler 22 | 23 | from .config import Config 24 | 25 | from . import user as u, portal as po, puppet as pu 26 | 27 | 28 | class MatrixHandler(BaseMatrixHandler): 29 | def __init__(self, az: AppService, config: Config, 30 | loop: Optional[asyncio.AbstractEventLoop] = None) -> None: 31 | super(MatrixHandler, self).__init__(az, config, loop=loop) 32 | 33 | async def get_user(self, user_id: UserID) -> 'u.User': 34 | return u.User.get(user_id) 35 | 36 | async def get_portal(self, room_id: RoomID) -> 'po.Portal': 37 | return po.Portal.get_by_mxid(room_id) 38 | 39 | async def get_puppet(self, user_id: UserID) -> 'pu.Puppet': 40 | return pu.Puppet.get_by_mxid(user_id) 41 | 42 | @staticmethod 43 | async def allow_bridging_message(user: 'u.User', portal: 'po.Portal') -> bool: 44 | return user.is_whitelisted 45 | 46 | def filter_matrix_event(self, evt: Event) -> bool: 47 | if not isinstance(evt, (MessageEvent, StateEvent)): 48 | return True 49 | return (evt.sender == self.az.bot_mxid 50 | or pu.Puppet.get_twid_from_mxid(evt.sender) is not None) 51 | -------------------------------------------------------------------------------- /mautrix_twilio/__main__.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from mautrix.bridge import Bridge 17 | 18 | from .config import Config 19 | from .twilio import TwilioHandler, TwilioClient 20 | from .matrix import MatrixHandler 21 | from .sqlstatestore import SQLStateStore 22 | from .context import Context 23 | from .puppet import init as init_puppet 24 | from .portal import init as init_portal 25 | from .user import init as init_user 26 | from .db import init as init_db 27 | from . import __version__ 28 | 29 | 30 | class TwilioBridge(Bridge): 31 | name = "mautrix-twilio" 32 | command = "python -m mautrix-twilio" 33 | description = "A Matrix-Twilio relaybot bridge." 34 | version = __version__ 35 | config_class = Config 36 | matrix_class = MatrixHandler 37 | state_store_class = SQLStateStore 38 | 39 | config: Config 40 | twilio: TwilioHandler 41 | twilio_client: TwilioClient 42 | 43 | def prepare_bridge(self) -> None: 44 | init_db(self.db) 45 | self.twilio_client = TwilioClient(config=self.config, loop=self.loop) 46 | context = Context(az=self.az, config=self.config, twc=self.twilio_client, loop=self.loop) 47 | context.mx = self.matrix = MatrixHandler(self.az, self.config, self.loop) 48 | context.tw = self.twilio = TwilioHandler(context) 49 | init_user(context) 50 | init_portal(context) 51 | init_puppet(context) 52 | self.az.app.add_subapp(self.config["twilio.webhook_path"], self.twilio.app) 53 | 54 | 55 | TwilioBridge().run() 56 | -------------------------------------------------------------------------------- /mautrix_twilio/twilio/api.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Dict, Optional 17 | import asyncio 18 | import logging 19 | 20 | from aiohttp import ClientSession, BasicAuth 21 | 22 | from .data import TwilioUserID, TwilioAccountID 23 | from ..config import Config 24 | 25 | 26 | class TwilioClient: 27 | log: logging.Logger = logging.getLogger("twilio.out") 28 | base_url: str = "https://api.twilio.com/2010-04-01" 29 | http: ClientSession 30 | sender_id: TwilioUserID 31 | account_id: TwilioAccountID 32 | 33 | def __init__(self, config: Config, loop: asyncio.AbstractEventLoop) -> None: 34 | self.sender_id = config["twilio.sender_id"] 35 | self.account_id = config["twilio.account_id"] 36 | self.http = ClientSession(loop=loop, auth=BasicAuth(self.account_id, 37 | config["twilio.secret"])) 38 | 39 | async def send_message(self, receiver: TwilioUserID, body: Optional[str] = None, 40 | media: Optional[str] = None) -> Dict[str, str]: 41 | data = { 42 | "From": self.sender_id, 43 | "To": receiver, 44 | } 45 | if body: 46 | data["Body"] = body 47 | if media: 48 | data["MediaUrl"] = media 49 | self.log.debug(f"Sending message {data}") 50 | resp = await self.http.post(f"{self.base_url}/Accounts/{self.account_id}/Messages.json", 51 | data=data) 52 | return await resp.json() 53 | -------------------------------------------------------------------------------- /alembic/versions/8e87452589a1_initial_revision.py: -------------------------------------------------------------------------------- 1 | """Initial revision 2 | 3 | Revision ID: 8e87452589a1 4 | Revises: 5 | Create Date: 2019-09-22 01:10:14.783562 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | 11 | from mautrix.bridge.db.mx_room_state import PowerLevelType 12 | 13 | 14 | # revision identifiers, used by Alembic. 15 | revision = '8e87452589a1' 16 | down_revision = None 17 | branch_labels = None 18 | depends_on = None 19 | 20 | 21 | def upgrade(): 22 | # ### commands auto generated by Alembic - please adjust! ### 23 | op.create_table('message', 24 | sa.Column('mxid', sa.String(length=255), nullable=True), 25 | sa.Column('mx_room', sa.String(length=255), nullable=True), 26 | sa.Column('tw_receiver', sa.String(length=127), nullable=False), 27 | sa.Column('twid', sa.String(length=127), nullable=False), 28 | sa.PrimaryKeyConstraint('tw_receiver', 'twid') 29 | ) 30 | op.create_table('mx_room_state', 31 | sa.Column('room_id', sa.String(length=255), nullable=False), 32 | sa.Column('power_levels', PowerLevelType(), nullable=True), 33 | sa.PrimaryKeyConstraint('room_id') 34 | ) 35 | op.create_table('mx_user_profile', 36 | sa.Column('room_id', sa.String(length=255), nullable=False), 37 | sa.Column('user_id', sa.String(length=255), nullable=False), 38 | sa.Column('membership', sa.Enum('JOIN', 'LEAVE', 'INVITE', 'BAN', 'KNOCK', name='membership'), nullable=False), 39 | sa.Column('displayname', sa.String(), nullable=True), 40 | sa.Column('avatar_url', sa.String(length=255), nullable=True), 41 | sa.PrimaryKeyConstraint('room_id', 'user_id') 42 | ) 43 | op.create_table('portal', 44 | sa.Column('twid', sa.String(length=127), nullable=False), 45 | sa.Column('mxid', sa.String(length=255), nullable=True), 46 | sa.PrimaryKeyConstraint('twid') 47 | ) 48 | op.create_table('puppet', 49 | sa.Column('twid', sa.String(length=127), nullable=False), 50 | sa.Column('matrix_registered', sa.Boolean(), server_default=sa.false(), nullable=False), 51 | sa.PrimaryKeyConstraint('twid') 52 | ) 53 | # ### end Alembic commands ### 54 | 55 | 56 | def downgrade(): 57 | # ### commands auto generated by Alembic - please adjust! ### 58 | op.drop_table('puppet') 59 | op.drop_table('portal') 60 | op.drop_table('mx_user_profile') 61 | op.drop_table('mx_room_state') 62 | op.drop_table('message') 63 | # ### end Alembic commands ### 64 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/templates/deployment.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: {{ include "mautrix-twilio.fullname" . }} 5 | labels: 6 | {{- include "mautrix-twilio.labels" . | nindent 4 }} 7 | spec: 8 | replicas: 1 9 | selector: 10 | matchLabels: 11 | app.kubernetes.io/name: {{ include "mautrix-twilio.name" . }} 12 | app.kubernetes.io/instance: {{ .Release.Name }} 13 | template: 14 | {{- if .Values.podAnnotations }} 15 | annotations: 16 | {{- toYaml .Values.podAnnotations | nindent 6 }} 17 | {{- end }} 18 | metadata: 19 | labels: 20 | app.kubernetes.io/name: {{ include "mautrix-twilio.name" . }} 21 | app.kubernetes.io/instance: {{ .Release.Name }} 22 | spec: 23 | serviceAccountName: {{ template "mautrix-twilio.serviceAccountName" . }} 24 | containers: 25 | - name: {{ .Chart.Name }} 26 | securityContext: 27 | {{- toYaml .Values.securityContext | nindent 12 }} 28 | image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" 29 | imagePullPolicy: {{ .Values.image.pullPolicy }} 30 | volumeMounts: 31 | - mountPath: /data 32 | name: config-volume 33 | ports: 34 | - name: http 35 | containerPort: {{ .Values.service.port }} 36 | protocol: TCP 37 | livenessProbe: 38 | httpGet: 39 | path: /_matrix/mau/live 40 | port: http 41 | initialDelaySeconds: 60 42 | periodSeconds: 5 43 | readinessProbe: 44 | httpGet: 45 | path: /_matrix/mau/ready 46 | port: http 47 | initialDelaySeconds: 60 48 | periodSeconds: 5 49 | resources: 50 | {{- toYaml .Values.resources | nindent 12 }} 51 | volumes: 52 | - name: config-volume 53 | configMap: 54 | name: {{ template "mautrix-twilio.fullname" . }} 55 | 56 | securityContext: 57 | {{- toYaml .Values.podSecurityContext | nindent 8 }} 58 | {{- with .Values.nodeSelector }} 59 | nodeSelector: 60 | {{- toYaml . | nindent 8 }} 61 | {{- end }} 62 | {{- with .Values.affinity }} 63 | affinity: 64 | {{- toYaml . | nindent 8 }} 65 | {{- end }} 66 | {{- with .Values.tolerations }} 67 | tolerations: 68 | {{- toYaml . | nindent 8 }} 69 | {{- end }} 70 | -------------------------------------------------------------------------------- /mautrix_twilio/formatter/from_matrix.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import cast 17 | 18 | from mautrix.util.formatter import (MatrixParser as BaseMatrixParser, MarkdownString, EntityType) 19 | 20 | 21 | def matrix_to_whatsapp(html: str) -> str: 22 | return MatrixParser.parse(html).text 23 | 24 | 25 | class WhatsAppFormatString(MarkdownString): 26 | def format(self, entity_type: EntityType, **kwargs) -> 'WhatsAppFormatString': 27 | prefix = suffix = "" 28 | if entity_type == EntityType.BOLD: 29 | prefix = suffix = "*" 30 | elif entity_type == EntityType.ITALIC: 31 | prefix = suffix = "_" 32 | elif entity_type == EntityType.STRIKETHROUGH: 33 | prefix = suffix = "~" 34 | elif entity_type == EntityType.URL: 35 | if kwargs['url'] != self.text: 36 | suffix = f" ({kwargs['url']})" 37 | elif entity_type in (EntityType.PREFORMATTED, EntityType.INLINE_CODE): 38 | prefix = suffix = "```" 39 | elif entity_type == EntityType.BLOCKQUOTE: 40 | children = self.trim().split("\n") 41 | children = [child.prepend("> ") for child in children] 42 | return self.join(children, "\n") 43 | elif entity_type == EntityType.HEADER: 44 | prefix = "#" * kwargs["size"] + " " 45 | else: 46 | return self 47 | 48 | self.text = f"{prefix}{self.text}{suffix}" 49 | return self 50 | 51 | 52 | class MatrixParser(BaseMatrixParser[WhatsAppFormatString]): 53 | fs = WhatsAppFormatString 54 | 55 | @classmethod 56 | def parse(cls, data: str) -> WhatsAppFormatString: 57 | return cast(WhatsAppFormatString, super().parse(data)) 58 | 59 | -------------------------------------------------------------------------------- /mautrix_twilio/config.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Dict, Tuple, List, Any 17 | 18 | from mautrix.types import UserID 19 | from mautrix.bridge.config import BaseBridgeConfig, ConfigUpdateHelper 20 | 21 | 22 | class Config(BaseBridgeConfig): 23 | def do_update(self, helper: ConfigUpdateHelper) -> None: 24 | super().do_update(helper) 25 | 26 | copy, copy_dict = helper.copy, helper.copy_dict 27 | 28 | copy("homeserver.public_address") 29 | 30 | copy("appservice.community_id") 31 | 32 | copy("bridge.username_template") 33 | copy("bridge.command_prefix") 34 | 35 | copy("bridge.invite_users") 36 | 37 | copy("bridge.federate_rooms") 38 | copy("bridge.initial_state") 39 | 40 | copy_dict("bridge.permissions") 41 | 42 | copy("twilio.account_id") 43 | copy("twilio.sender_id") 44 | copy("twilio.secret") 45 | copy("twilio.webhook_path") 46 | 47 | def _get_permissions(self, key: str) -> Tuple[bool, bool]: 48 | level = self["bridge.permissions"].get(key, "") 49 | admin = level == "admin" 50 | user = level == "user" or admin 51 | return user, admin 52 | 53 | def get_permissions(self, mxid: UserID) -> Tuple[bool, bool]: 54 | permissions = self["bridge.permissions"] or {} 55 | if mxid in permissions: 56 | return self._get_permissions(mxid) 57 | 58 | homeserver = mxid[mxid.index(":") + 1:] 59 | if homeserver in permissions: 60 | return self._get_permissions(homeserver) 61 | 62 | return self._get_permissions("*") 63 | 64 | @property 65 | def namespaces(self) -> Dict[str, List[Dict[str, Any]]]: 66 | homeserver = self["homeserver.domain"] 67 | 68 | username_format = self["bridge.username_template"].lower().format(userid=".+") 69 | group_id = ({"group_id": self["appservice.community_id"]} 70 | if self["appservice.community_id"] else {}) 71 | 72 | return { 73 | "users": [{ 74 | "exclusive": True, 75 | "regex": f"@{username_format}:{homeserver}", 76 | **group_id, 77 | }], 78 | } 79 | -------------------------------------------------------------------------------- /mautrix_twilio/twilio/data.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import NewType 17 | 18 | import attr 19 | from attr import dataclass 20 | 21 | from mautrix.types import SerializableAttrs, SerializableEnum 22 | 23 | TwilioMessageID = NewType('TwilioMessageID', str) 24 | TwilioUserID = NewType('TwilioUserID', str) 25 | TwilioAccountID = NewType('TwilioAccountID', str) 26 | 27 | 28 | class TwilioEventType(SerializableEnum): 29 | DELIVERED = "DELIVERED" 30 | READ = "READ" 31 | UNDELIVERED = "UNDELIVERED" 32 | 33 | 34 | class TwilioMessageStatus(SerializableEnum): 35 | # Statuses only returned by the send endpoint 36 | ACCEPTED = "accepted" 37 | QUEUED = "queued" 38 | SENDING = "sending" 39 | 40 | # Statuses that can come from the status webhook 41 | SENT = "sent" 42 | FAILED = "failed" 43 | DELIVERED = "delivered" 44 | UNDELIVERED = "undelivered" 45 | READ = "read" 46 | 47 | # Statuses only for received messages 48 | RECEIVING = "receiving" 49 | RECEIVED = "received" 50 | 51 | 52 | @dataclass 53 | class TwilioMedia(SerializableAttrs['TwilioMedia']): 54 | mime_type: str = attr.ib(default=None, metadata={"json": "MediaContentType0"}) 55 | url: str = attr.ib(default=None, metadata={"json": "MediaUrl0"}) 56 | 57 | 58 | @dataclass 59 | class TwilioMessageEvent(SerializableAttrs['TwilioEvent']): 60 | id: TwilioMessageID = attr.ib(metadata={"json": "MessageSid"}) 61 | receiver: TwilioUserID = attr.ib(metadata={"json": "To"}) 62 | sender: TwilioUserID = attr.ib(metadata={"json": "From"}) 63 | status: TwilioMessageStatus = attr.ib(metadata={"json": "SmsStatus"}) 64 | 65 | body: str = attr.ib(metadata={"json": "Body"}) 66 | segments: str = attr.ib(metadata={"json": "NumSegments"}) 67 | media: TwilioMedia = attr.ib(default=None, metadata={"flatten": True}) 68 | 69 | 70 | @dataclass 71 | class TwilioStatusEvent(SerializableAttrs['TwilioEvent']): 72 | id: TwilioMessageID = attr.ib(metadata={"json": "MessageSid"}) 73 | receiver: TwilioUserID = attr.ib(metadata={"json": "To"}) 74 | sender: TwilioUserID = attr.ib(metadata={"json": "From"}) 75 | status: TwilioMessageStatus = attr.ib(metadata={"json": "SmsStatus"}) 76 | 77 | event_type: TwilioEventType = attr.ib(default=None, metadata={"json": "EventType"}) 78 | -------------------------------------------------------------------------------- /mautrix_twilio/twilio/webhook.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Tuple, Any, TYPE_CHECKING 17 | import logging 18 | import asyncio 19 | 20 | from aiohttp import web 21 | 22 | from .request_validator import RequestValidator 23 | from .data import TwilioMessageEvent, TwilioStatusEvent 24 | from .. import portal as po 25 | 26 | if TYPE_CHECKING: 27 | from ..context import Context 28 | 29 | 30 | class TwilioHandler: 31 | log: logging.Logger = logging.getLogger("twilio.in") 32 | app: web.Application 33 | validator: RequestValidator 34 | 35 | def __init__(self, context: 'Context') -> None: 36 | self.loop = context.loop or asyncio.get_event_loop() 37 | self.app = web.Application(loop=self.loop) 38 | self.app.router.add_route("POST", "/receive", self.receive) 39 | self.app.router.add_route("POST", "/status", self.status) 40 | self.validator = RequestValidator(token=context.config["twilio.secret"]) 41 | 42 | async def _validate_request(self, request: web.Request, type_class: Any 43 | ) -> Tuple[Any, Optional[web.Response]]: 44 | data = dict(**await request.post()) 45 | try: 46 | signature = request.headers["X-Twilio-Signature"] 47 | except KeyError: 48 | return None, web.Response(status=400, text="Missing signature") 49 | is_valid = self.validator.validate(request.url, data, signature) 50 | if not is_valid: 51 | return None, web.Response(status=401, text="Invalid signature") 52 | return type_class.deserialize(data), None 53 | 54 | async def receive(self, request: web.Request) -> web.Response: 55 | data, err = await self._validate_request(request, TwilioMessageEvent) 56 | if err is not None: 57 | return err 58 | self.log.debug(f"Received Twilio message event: {data}") 59 | portal = po.Portal.get_by_twid(data.sender) 60 | await portal.handle_twilio_message(data) 61 | return web.Response(status=204) 62 | 63 | async def status(self, request: web.Request) -> web.Response: 64 | data, err = await self._validate_request(request, TwilioStatusEvent) 65 | if err is not None: 66 | return err 67 | self.log.debug(f"Received Twilio status event: {data}") 68 | portal = po.Portal.get_by_twid(data.receiver) 69 | await portal.handle_twilio_status(data) 70 | return web.Response(status=204) 71 | -------------------------------------------------------------------------------- /mautrix_twilio/twilio/request_validator.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | 17 | # This is based on https://github.com/twilio/twilio-python/blob/master/twilio/request_validator.py 18 | # with changes to remove antiquated python support and use yarl for all URL processing. 19 | 20 | from typing import Dict, Union 21 | from hashlib import sha1, sha256 22 | import base64 23 | import hmac 24 | 25 | from yarl import URL 26 | 27 | 28 | class RequestValidator: 29 | def __init__(self, token: str) -> None: 30 | self.token = token.encode("utf-8") 31 | 32 | def _compute_signature(self, url: URL, params: Dict[str, str]) -> bytes: 33 | """ 34 | Compute the signature for a given request. 35 | 36 | Args: 37 | url: Full URI that Twilio requested on your server. 38 | params: Dictionary of POST variables. 39 | 40 | Returns: 41 | The computed signature. 42 | """ 43 | signature_data = str(url) 44 | for key, value in sorted(params.items()): 45 | signature_data += key + value 46 | return hmac.new(self.token, signature_data.encode("utf-8"), sha1).digest() 47 | 48 | @staticmethod 49 | def _compute_hash(body) -> str: 50 | """ 51 | Compute the SHA256 hash for the given data. 52 | 53 | Args: 54 | body: The request body. 55 | 56 | Returns: 57 | The hex-formatted sha256 hash. 58 | """ 59 | return sha256(body.encode("utf-8")).hexdigest().strip() 60 | 61 | def validate(self, url: URL, params: Union[str, bytes, Dict[str, str]], 62 | signature: str) -> bool: 63 | """ 64 | Validate a request from Twilio. 65 | 66 | Args: 67 | url: Full URI that Twilio requested on your server. 68 | params: Dictionary of POST variables or string of POST body for JSON requests. 69 | signature: The signature in the X-Twilio-Signature header. 70 | 71 | Returns: 72 | True if the request passes validation, False if not. 73 | """ 74 | 75 | url = url.with_scheme("https").with_port(None) 76 | try: 77 | decoded_signature = base64.b64decode(signature) 78 | except Exception: 79 | return False 80 | 81 | if "bodySHA256" in url.query and isinstance(params, (str, bytes)): 82 | valid_body_hash = hmac.compare_digest(self._compute_hash(params), 83 | url.query["bodySHA256"]) 84 | valid_signature = hmac.compare_digest(self._compute_signature(url, {}), 85 | decoded_signature) 86 | return valid_body_hash and valid_signature 87 | else: 88 | return hmac.compare_digest(self._compute_signature(url, params or {}), 89 | decoded_signature) 90 | -------------------------------------------------------------------------------- /helm/mautrix-twilio/values.yaml: -------------------------------------------------------------------------------- 1 | image: 2 | repository: dock.mau.dev/tulir/mautrix-twilio 3 | tag: latest 4 | pullPolicy: IfNotPresent 5 | 6 | nameOverride: "" 7 | fullnameOverride: "" 8 | 9 | serviceAccount: 10 | # Specifies whether a service account should be created 11 | create: true 12 | # The name of the service account to use. 13 | # If not set and create is true, a name is generated using the fullname template 14 | name: 15 | 16 | service: 17 | type: ClusterIP 18 | port: 29322 19 | 20 | resources: {} 21 | # limits: 22 | # cpu: 100m 23 | # memory: 128Mi 24 | # requests: 25 | # cpu: 100m 26 | # memory: 128Mi 27 | 28 | nodeSelector: {} 29 | 30 | tolerations: [] 31 | 32 | affinity: {} 33 | 34 | # Postgres pod configs 35 | postgresql: 36 | enabled: true 37 | postgresqlDatabase: mxtw 38 | postgresqlPassword: SET TO RANDOM STRING 39 | persistence: 40 | size: 2Gi 41 | resources: 42 | requests: 43 | memory: 256Mi 44 | cpu: 100m 45 | 46 | # Homeserver details 47 | homeserver: 48 | # The address that this appservice can use to connect to the homeserver. 49 | address: https://example.com 50 | # The address that Twilio can use to download media from the homeserver. 51 | publicAddress: https://matrix.example.com 52 | # The domain of the homeserver (for MXIDs, etc). 53 | domain: example.com 54 | # Whether or not to verify the SSL certificate of the homeserver. 55 | # Only applies if address starts with https:// 56 | verifySSL: true 57 | 58 | # Application service host/registration related details 59 | # Changing these values requires regeneration of the registration. 60 | appservice: 61 | # The full URI to the database. SQLite and Postgres are fully supported. 62 | # Other DBMSes supported by SQLAlchemy may or may not work. 63 | # Format examples: 64 | # SQLite: sqlite:///filename.db 65 | # Postgres: postgres://username:password@hostname/dbname 66 | database: postgres://username:password@hostname/dbname 67 | 68 | # The maximum body size of appservice API requests (from the homeserver) in mebibytes 69 | # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s 70 | maxBodySize: 1 71 | 72 | id: twilio 73 | botUsername: twiliobot 74 | # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty 75 | # to leave display name/avatar as-is. 76 | botDisplayname: Twilio bridge bot 77 | botAvatar: mxc://maunium.net/FYuKJHaCrSeSpvBJfHwgYylP 78 | 79 | # Community ID for bridged users (changes registration file) and rooms. 80 | # Must be created manually. 81 | communityID: false 82 | 83 | # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. 84 | asToken: SET TO RANDOM STRING 85 | hsToken: SET TO RANDOM STRING 86 | 87 | # The keys below can be used to override the configs in the base config: 88 | # https://github.com/tulir/mautrix-twilio/blob/master/example-config.yaml 89 | # Note that the "appservice" and "homeserver" sections are above and slightly different than the base. 90 | 91 | # Bridge config 92 | bridge: 93 | # Localpart template of MXIDs for remote users. 94 | # {userid} is replaced with the phone number of the user (plain/E.164 international format). 95 | username_template: "twilio_whatsapp_{userid}" 96 | # Displayname template for remote users. 97 | # {displayname} is replaced with the phone number of the user (human-readable international format). 98 | alias_template: "twilio_whatsapp_{groupname}" 99 | 100 | # List of users to always invite to newly created portal rooms. 101 | invite_users: [] 102 | 103 | # Permissions for using the bridge. 104 | # Permitted values: 105 | # user - Use the bridge with puppeting. 106 | # admin - Use and administrate the bridge. 107 | # Permitted keys: 108 | # * - All Matrix users 109 | # domain - All users on that homeserver 110 | # mxid - Specific user 111 | permissions: 112 | "example.com": "user" 113 | "@admin:example.com": "admin" 114 | 115 | # Twilio webhook settings. 116 | twilio: 117 | # Twilio account ID 118 | account_id: AC1082dcd0e9ae51404f6cae3581edfbff 119 | # Twilio phone number to send messages from. 120 | sender_id: whatsapp:+1415550199 121 | # Your Twilio auth token (get from Twilio dashboard front page) 122 | secret: 2035141f21a001604e763c009aa3be4c 123 | # Path prefix for webhook endpoints. Subpaths are /status and /receive. 124 | # Note that the webhook must be put behind a reverse proxy with https. 125 | webhook_path: /twilio 126 | -------------------------------------------------------------------------------- /mautrix_twilio/puppet.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Dict, TYPE_CHECKING 17 | 18 | from mautrix.types import UserID 19 | from mautrix.bridge import BasePuppet 20 | from mautrix.util.simple_template import SimpleTemplate 21 | 22 | from .config import Config 23 | from .db import Puppet as DBPuppet 24 | from .twilio import TwilioUserID 25 | 26 | if TYPE_CHECKING: 27 | from .context import Context 28 | 29 | try: 30 | import phonenumbers 31 | except ImportError: 32 | phonenumbers = None 33 | 34 | config: Config 35 | 36 | 37 | class Puppet(BasePuppet): 38 | hs_domain: str 39 | twid_template: SimpleTemplate[int] = SimpleTemplate("whatsapp:+{number}", "number", type=int) 40 | mxid_template: SimpleTemplate[str] 41 | displayname_template: SimpleTemplate[str] 42 | 43 | by_twid: Dict[TwilioUserID, 'Puppet'] = {} 44 | 45 | twid: TwilioUserID 46 | _formatted_number: Optional[str] 47 | 48 | _db_instance: Optional[DBPuppet] 49 | 50 | def __init__(self, twid: TwilioUserID, is_registered: bool = False, 51 | db_instance: Optional[DBPuppet] = None) -> None: 52 | super().__init__() 53 | self.twid = twid 54 | self.is_registered = is_registered 55 | self._formatted_number = None 56 | self._db_instance = db_instance 57 | self.intent = self.az.intent.user(self.mxid) 58 | self.log = self.log.getChild(self.twid) 59 | self.by_twid[self.twid] = self 60 | 61 | @property 62 | def phone_number(self) -> int: 63 | return self.twid_template.parse(self.twid) 64 | 65 | @property 66 | def formatted_phone_number(self) -> str: 67 | if not self._formatted_number: 68 | parsed = phonenumbers.parse(f"+{self.phone_number}") 69 | fmt = phonenumbers.PhoneNumberFormat.INTERNATIONAL 70 | self._formatted_number = phonenumbers.format_number(parsed, fmt) 71 | return self._formatted_number 72 | 73 | @property 74 | def mxid(self) -> UserID: 75 | return UserID(self.mxid_template.format_full(str(self.phone_number))) 76 | 77 | @property 78 | def displayname(self) -> str: 79 | return self.displayname_template.format_full(self.formatted_phone_number) 80 | 81 | @property 82 | def db_instance(self) -> DBPuppet: 83 | if not self._db_instance: 84 | self._db_instance = DBPuppet(twid=self.twid, matrix_registered=self.is_registered) 85 | return self._db_instance 86 | 87 | @classmethod 88 | def from_db(cls, db_puppet: DBPuppet) -> 'Puppet': 89 | return cls(twid=db_puppet.twid, is_registered=db_puppet.matrix_registered, 90 | db_instance=db_puppet) 91 | 92 | def save(self) -> None: 93 | self.db_instance.edit(matrix_registered=self.is_registered) 94 | 95 | async def update_displayname(self) -> None: 96 | await self.intent.set_displayname(self.displayname) 97 | 98 | @classmethod 99 | def get_by_twid(cls, twid: TwilioUserID, create: bool = True) -> Optional['Puppet']: 100 | try: 101 | return cls.by_twid[twid] 102 | except KeyError: 103 | pass 104 | 105 | db_puppet = DBPuppet.get_by_twid(twid) 106 | if db_puppet: 107 | return cls.from_db(db_puppet) 108 | 109 | if create: 110 | puppet = cls(twid) 111 | puppet.db_instance.insert() 112 | return puppet 113 | 114 | return None 115 | 116 | @classmethod 117 | def get_by_mxid(cls, mxid: UserID, create: bool = True) -> Optional['Puppet']: 118 | twid = cls.get_twid_from_mxid(mxid) 119 | if twid: 120 | return cls.get_by_twid(twid, create) 121 | 122 | return None 123 | 124 | @classmethod 125 | def get_twid_from_mxid(cls, mxid: UserID) -> Optional[TwilioUserID]: 126 | parsed = cls.mxid_template.parse(mxid) 127 | if parsed: 128 | return TwilioUserID(cls.twid_template.format_full(parsed)) 129 | return None 130 | 131 | @classmethod 132 | def get_mxid_from_twid(cls, twid: TwilioUserID) -> UserID: 133 | return UserID(cls.mxid_template.format_full(str(cls.twid_template.parse(twid)))) 134 | 135 | 136 | def init(context: 'Context') -> None: 137 | global config 138 | Puppet.az, config, Puppet.loop = context.core 139 | Puppet.mx = context.mx 140 | Puppet.hs_domain = config["homeserver"]["domain"] 141 | Puppet.mxid_template = SimpleTemplate(config["bridge.username_template"], "userid", 142 | prefix="@", suffix=f":{Puppet.hs_domain}", type=str) 143 | Puppet.displayname_template = SimpleTemplate(config["bridge.displayname_template"], 144 | "displayname", type=str) 145 | -------------------------------------------------------------------------------- /example-config.yaml: -------------------------------------------------------------------------------- 1 | # Homeserver details 2 | homeserver: 3 | # The address that this appservice can use to connect to the homeserver. 4 | address: http://localhost:8008 5 | # The address that Twilio can use to download media from the homeserver. 6 | public_address: https://matrix.example.com 7 | # The domain of the homeserver (for MXIDs, etc). 8 | domain: example.com 9 | # Whether or not to verify the SSL certificate of the homeserver. 10 | # Only applies if address starts with https:// 11 | verify_ssl: true 12 | 13 | # Application service host/registration related details 14 | # Changing these values requires regeneration of the registration. 15 | appservice: 16 | # The address that the homeserver can use to connect to this appservice. 17 | address: http://localhost:29322 18 | 19 | # The hostname and port where this appservice should listen. 20 | hostname: 0.0.0.0 21 | port: 29322 22 | # The maximum body size of appservice API requests (from the homeserver) in mebibytes 23 | # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s 24 | max_body_size: 1 25 | 26 | # The full URI to the database. SQLite and Postgres are fully supported. 27 | # Other DBMSes supported by SQLAlchemy may or may not work. 28 | # Format examples: 29 | # SQLite: sqlite:///filename.db 30 | # Postgres: postgres://username:password@hostname/dbname 31 | database: sqlite:///mautrix-twilio.db 32 | 33 | # The unique ID of this appservice. 34 | id: twilio 35 | # Username of the appservice bot. 36 | bot_username: twiliobot 37 | # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty 38 | # to leave display name/avatar as-is. 39 | bot_displayname: Twilio bridge bot 40 | bot_avatar: mxc://maunium.net/FYuKJHaCrSeSpvBJfHwgYylP 41 | 42 | # Community ID for bridged users (changes registration file) and rooms. 43 | # Must be created manually. 44 | community_id: null 45 | 46 | # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. 47 | as_token: "This value is generated when generating the registration" 48 | hs_token: "This value is generated when generating the registration" 49 | 50 | # Bridge config 51 | bridge: 52 | # Localpart template of MXIDs for remote users. 53 | # {userid} is replaced with the phone number of the user (plain/E.164 international format). 54 | username_template: "twilio_whatsapp_{userid}" 55 | # Displayname template for remote users. 56 | # {displayname} is replaced with the phone number of the user (human-readable international format). 57 | displayname_template: "{displayname} (WhatsApp)" 58 | 59 | # The prefix for commands. Only required in non-management rooms. 60 | command_prefix: "!tw" 61 | # List of users to always invite to newly created portal rooms. 62 | invite_users: [] 63 | # Template for text messages. 64 | message_template: "$message
- $displayname" 65 | # Whether or not Matrix m.notice-type messages should be bridged. 66 | bridge_notices: false 67 | # Whether or not created rooms should have federation enabled. 68 | # If false, created portal rooms will never be federated. 69 | federate_rooms: true 70 | # Initial room state for created rooms. 71 | initial_state: 72 | m.room.power_levels: 73 | events_default: 0 74 | users_default: 0 75 | state_default: 50 76 | events: 77 | m.room.avatar: 0 78 | m.room.name: 0 79 | m.room.topic: 0 80 | 81 | # Permissions for using the bridge. 82 | # Permitted values: 83 | # user - Use the bridge with puppeting. 84 | # admin - Use and administrate the bridge. 85 | # Permitted keys: 86 | # * - All Matrix users 87 | # domain - All users on that homeserver 88 | # mxid - Specific user 89 | permissions: 90 | "example.com": "user" 91 | "@admin:example.com": "admin" 92 | 93 | # Twilio webhook settings. 94 | twilio: 95 | # Twilio account ID 96 | account_id: AC1082dcd0e9ae51404f6cae3581edfbff 97 | # Twilio phone number to send messages from. 98 | sender_id: whatsapp:+1415550199 99 | # Your Twilio auth token (get from Twilio dashboard front page) 100 | secret: 2035141f21a001604e763c009aa3be4c 101 | # Path prefix for webhook endpoints. Subpaths are /status and /receive. 102 | # Note that the webhook must be put behind a reverse proxy with https. 103 | webhook_path: /twilio 104 | 105 | # Python logging configuration. 106 | # 107 | # See section 16.7.2 of the Python documentation for more info: 108 | # https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema 109 | logging: 110 | version: 1 111 | formatters: 112 | colored: 113 | (): mautrix_twilio.util.ColorFormatter 114 | format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" 115 | normal: 116 | format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" 117 | handlers: 118 | file: 119 | class: logging.handlers.RotatingFileHandler 120 | formatter: normal 121 | filename: ./mautrix-twilio.log 122 | maxBytes: 10485760 123 | backupCount: 10 124 | console: 125 | class: logging.StreamHandler 126 | formatter: colored 127 | loggers: 128 | mau: 129 | level: DEBUG 130 | twilio: 131 | level: DEBUG 132 | aiohttp: 133 | level: INFO 134 | root: 135 | level: DEBUG 136 | handlers: [file, console] 137 | -------------------------------------------------------------------------------- /mautrix_twilio/portal.py: -------------------------------------------------------------------------------- 1 | # mautrix-twilio - A Matrix-Twilio relaybot bridge. 2 | # Copyright (C) 2019 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Dict, Optional, List, Any, TYPE_CHECKING 17 | from string import Template 18 | from html import escape 19 | import mimetypes 20 | import asyncio 21 | 22 | from mautrix.types import (RoomID, UserID, EventID, EventType, StrippedStateEvent, MessageType, 23 | MessageEventContent, TextMessageEventContent, Format, FileInfo, 24 | MediaMessageEventContent, PowerLevelStateEventContent) 25 | from mautrix.bridge import BasePortal 26 | from mautrix.appservice import IntentAPI 27 | 28 | from .db import Portal as DBPortal, Message as DBMessage 29 | from .twilio import (TwilioUserID, TwilioMessageID, TwilioClient, TwilioMessageEvent, 30 | TwilioStatusEvent, TwilioMessageStatus) 31 | from .formatter import whatsapp_to_matrix, matrix_to_whatsapp 32 | from . import puppet as p, user as u 33 | 34 | if TYPE_CHECKING: 35 | from .context import Context 36 | 37 | 38 | class Portal(BasePortal): 39 | homeserver_address: str 40 | message_template: Template 41 | bridge_notices: bool 42 | federate_rooms: bool 43 | invite_users: List[UserID] 44 | initial_state: Dict[str, Dict[str, Any]] 45 | 46 | twc: TwilioClient 47 | 48 | by_mxid: Dict[RoomID, 'Portal'] = {} 49 | by_twid: Dict[TwilioUserID, 'Portal'] = {} 50 | 51 | twid: TwilioUserID 52 | mxid: Optional[RoomID] 53 | 54 | _db_instance: DBPortal 55 | 56 | _main_intent: Optional[IntentAPI] 57 | _create_room_lock: asyncio.Lock 58 | _send_lock: asyncio.Lock 59 | 60 | def __init__(self, twid: TwilioUserID, mxid: Optional[RoomID] = None, 61 | db_instance: Optional[DBPortal] = None) -> None: 62 | super().__init__() 63 | self.twid = twid 64 | self.mxid = mxid 65 | 66 | self._db_instance = db_instance 67 | self._main_intent = None 68 | self._create_room_lock = asyncio.Lock() 69 | self._send_lock = asyncio.Lock() 70 | self.log = self.log.getChild(self.twid) 71 | 72 | self.by_twid[self.twid] = self 73 | if self.mxid: 74 | self.by_mxid[self.mxid] = self 75 | 76 | @property 77 | def db_instance(self) -> DBPortal: 78 | if not self._db_instance: 79 | self._db_instance = DBPortal(twid=self.twid, mxid=self.mxid) 80 | return self._db_instance 81 | 82 | @classmethod 83 | def from_db(cls, db_portal: DBPortal) -> 'Portal': 84 | return Portal(twid=db_portal.twid, mxid=db_portal.mxid, db_instance=db_portal) 85 | 86 | def save(self) -> None: 87 | self.db_instance.edit(mxid=self.mxid) 88 | 89 | def delete(self) -> None: 90 | self.by_twid.pop(self.twid, None) 91 | self.by_mxid.pop(self.mxid, None) 92 | if self._db_instance: 93 | self._db_instance.delete() 94 | 95 | @property 96 | def main_intent(self) -> IntentAPI: 97 | if not self._main_intent: 98 | self._main_intent = p.Puppet.get_by_twid(self.twid).intent 99 | return self._main_intent 100 | 101 | async def create_matrix_room(self) -> RoomID: 102 | if self.mxid: 103 | return self.mxid 104 | async with self._create_room_lock: 105 | try: 106 | return await self._create_matrix_room() 107 | except Exception: 108 | self.log.exception("Failed to create portal") 109 | 110 | async def _create_matrix_room(self) -> RoomID: 111 | if self.mxid: 112 | return self.mxid 113 | 114 | self.log.debug("Creating Matrix room") 115 | puppet = p.Puppet.get_by_twid(self.twid) 116 | await puppet.update_displayname() 117 | creation_content = { 118 | "m.federate": self.federate_rooms 119 | } 120 | initial_state = {EventType.find(event_type): StrippedStateEvent.deserialize({ 121 | "type": event_type, 122 | "state_key": "", 123 | "content": content 124 | }) for event_type, content in self.initial_state.items()} 125 | if EventType.ROOM_POWER_LEVELS not in initial_state: 126 | initial_state[EventType.ROOM_POWER_LEVELS] = StrippedStateEvent( 127 | type=EventType.ROOM_POWER_LEVELS, content=PowerLevelStateEventContent()) 128 | plc = initial_state[EventType.ROOM_POWER_LEVELS].content 129 | plc.users[self.az.bot_mxid] = 100 130 | plc.users[self.main_intent.mxid] = 100 131 | for user_id in self.invite_users: 132 | plc.users.setdefault(user_id, 100) 133 | self.mxid = await self.main_intent.create_room(name=puppet.displayname, 134 | invitees=[self.az.bot_mxid, 135 | *self.invite_users], 136 | is_direct=True, 137 | creation_content=creation_content, 138 | initial_state=list(initial_state.values())) 139 | if not self.mxid: 140 | raise Exception("Failed to create room: no mxid received") 141 | self.save() 142 | self.log.debug(f"Matrix room created: {self.mxid}") 143 | self.by_mxid[self.mxid] = self 144 | await self.main_intent.join_room_by_id(self.mxid) 145 | return self.mxid 146 | 147 | async def handle_twilio_message(self, message: TwilioMessageEvent) -> None: 148 | if not await self.create_matrix_room(): 149 | return 150 | mxid = None 151 | 152 | if message.media: 153 | resp = await self.az.http_session.get(message.media.url) 154 | data = await resp.read() 155 | mime = message.media.mime_type 156 | mxc = await self.main_intent.upload_media(data, mime) 157 | msgtype = MessageType.FILE 158 | if mime.startswith("image/"): 159 | msgtype = MessageType.IMAGE 160 | elif mime.startswith("video/"): 161 | msgtype = MessageType.VIDEO 162 | elif mime.startswith("audio/"): 163 | msgtype = MessageType.AUDIO 164 | ext = mimetypes.guess_extension(mime) 165 | content = MediaMessageEventContent(body=f"{message.id}{ext}", msgtype=msgtype, url=mxc, 166 | info=FileInfo(size=len(data), mimetype=mime)) 167 | mxid = await self.main_intent.send_message(self.mxid, content) 168 | 169 | if message.body: 170 | html, text = whatsapp_to_matrix(message.body) 171 | content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text) 172 | if html is not None: 173 | content.format = Format.HTML 174 | content.formatted_body = html 175 | mxid = await self.main_intent.send_message(self.mxid, content) 176 | 177 | if not mxid: 178 | mxid = await self.main_intent.send_notice(self.mxid, "Message with unknown content") 179 | 180 | msg = DBMessage(mxid=mxid, mx_room=self.mxid, tw_receiver=self.twid, twid=message.id) 181 | msg.insert() 182 | 183 | async def handle_twilio_status(self, status: TwilioStatusEvent) -> None: 184 | if not self.mxid: 185 | return 186 | async with self._send_lock: 187 | msg = DBMessage.get_by_twid(status.id, self.twid) 188 | if status.status == TwilioMessageStatus.DELIVERED: 189 | await self.az.intent.mark_read(self.mxid, msg.mxid) 190 | elif status.status == TwilioMessageStatus.READ: 191 | await self.main_intent.mark_read(self.mxid, msg.mxid) 192 | elif status.status == TwilioMessageStatus.UNDELIVERED: 193 | await self.az.intent.react(self.mxid, msg.mxid, "\u274c") 194 | elif status.status == TwilioMessageStatus.FAILED: 195 | await self.az.intent.react(self.mxid, msg.mxid, "\u274c") 196 | 197 | async def handle_matrix_message(self, sender: 'u.User', message: MessageEventContent, 198 | event_id: EventID) -> None: 199 | async with self._send_lock: 200 | if message.msgtype == MessageType.TEXT or (message.msgtype == MessageType.NOTICE 201 | and self.bridge_notices): 202 | localpart, _ = self.az.intent.parse_user_id(sender.mxid) 203 | html = (message.formatted_body if message.format == Format.HTML 204 | else escape(message.body)) 205 | html = self.message_template.safe_substitute( 206 | message=html, mxid=sender.mxid, localpart=localpart, 207 | displayname=await self.az.intent.get_room_displayname(self.mxid, sender.mxid)) 208 | text = matrix_to_whatsapp(html) 209 | resp = await self.twc.send_message(self.twid, text) 210 | elif message.msgtype in (MessageType.AUDIO, MessageType.VIDEO, MessageType.IMAGE, 211 | MessageType.FILE): 212 | url = f"{self.homeserver_address}/_matrix/media/r0/download/{message.url[6:]}" 213 | resp = await self.twc.send_message(self.twid, media=url) 214 | else: 215 | self.log.debug(f"Ignoring unknown message {message}") 216 | return 217 | self.log.debug(f"Twilio send response: {resp}") 218 | DBMessage(mxid=event_id, mx_room=self.mxid, tw_receiver=self.twid, 219 | twid=TwilioMessageID(resp["sid"])).insert() 220 | 221 | @classmethod 222 | def get_by_mxid(cls, mxid: RoomID) -> Optional['Portal']: 223 | try: 224 | return cls.by_mxid[mxid] 225 | except KeyError: 226 | pass 227 | 228 | db_portal = DBPortal.get_by_mxid(mxid) 229 | if db_portal: 230 | return cls.from_db(db_portal) 231 | 232 | return None 233 | 234 | @classmethod 235 | def get_by_twid(cls, twid: TwilioUserID, create: bool = True) -> Optional['Portal']: 236 | try: 237 | return cls.by_twid[twid] 238 | except KeyError: 239 | pass 240 | 241 | db_portal = DBPortal.get_by_twid(twid) 242 | if db_portal: 243 | return cls.from_db(db_portal) 244 | 245 | if create: 246 | portal = cls(twid=twid) 247 | portal.db_instance.insert() 248 | return portal 249 | 250 | return None 251 | 252 | 253 | def init(context: 'Context') -> None: 254 | Portal.az, config, Portal.loop = context.core 255 | Portal.twc = context.twc 256 | Portal.homeserver_address = config["homeserver.public_address"] 257 | Portal.message_template = Template(config["bridge.message_template"]) 258 | Portal.bridge_notices = config["bridge.bridge_notices"] 259 | Portal.federate_rooms = config["bridge.federate_rooms"] 260 | Portal.invite_users = config["bridge.invite_users"] 261 | Portal.initial_state = config["bridge.initial_state"] 262 | -------------------------------------------------------------------------------- /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 by 637 | 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 | --------------------------------------------------------------------------------