pax_global_header 0000666 0000000 0000000 00000000064 14777004470 0014524 g ustar 00root root 0000000 0000000 52 comment=7513a77829258bbb73439897fd4010791e34f3d6
matridge/ 0000775 0000000 0000000 00000000000 14777004470 0012664 5 ustar 00root root 0000000 0000000 matridge/.copier-answers.yml 0000664 0000000 0000000 00000002362 14777004470 0016431 0 ustar 00root root 0000000 0000000 # Do not edit manually!
# Changes here will be overwritten by copier.
# https://copier.readthedocs.io/
_commit: c2c396f
_src_path: git+https://codeberg.org/slidge/legacy-module-template
authors:
- email: nicoco@nicoco.fr
name: Nicolas Cedilnik
ci_id: 14069
container_build_files:
- uv.lock
- pyproject.toml
container_build_native: false
container_builder_deps:
- git
- make
- cargo
- cmake
- g++
container_builder_deps_backports: []
container_debian_version: bookworm
container_dev_custom_hot_reload: ''
container_dev_extra_lines: ''
container_python_version: '3.13'
container_requires_rustup: false
container_runtime_deps: []
custom_build_system: ''
custom_readme_head: ''
custom_readme_tail: ''
debian_bundle: true
dependencies:
- matrix-nio[e2e]>=0.25,<0.26
- beautifulsoup4>=4.12.2,<5
- async-lru>=2.0.3,<3
- slidge-style-parser>=0.1.6
- slidge>=0.2.5,<0.3
dev_dependencies:
- types-beautifulsoup4>=4.12.0.20241020
intersphinx_mappings: []
lint_excludes: []
mypy_ignores:
- nio.*
native_builds: false
pre_commit_custom_hooks: ''
project_name: matridge
repology: slidge-matridge
requires_lottie: false
silo:
lib:
name: nio
url: https://matrix-nio.readthedocs.io/
name: Matrix
url: https://matrix.org
uv_sources: []
wheels: false
matridge/.gitignore 0000664 0000000 0000000 00000000144 14777004470 0014653 0 ustar 00root root 0000000 0000000 __pycache__
.mypy_cache
.pytest_cache
.ruff_cache
.idea
dist
docs/build
persistent
.venv
*.egg-info
matridge/.pre-commit-config.yaml 0000664 0000000 0000000 00000002356 14777004470 0017153 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
default_stages: [pre-commit]
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- id: check-merge-conflict
args: [--assume-in-merge]
- repo: https://github.com/astral-sh/uv-pre-commit
rev: 0.5.21
hooks:
- id: uv-lock
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: v0.9.2
hooks:
- id: ruff
args: [ --fix ]
- id: ruff-format
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v9.20.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ['@commitlint/config-conventional']
- repo: local
hooks:
- id: mypy
name: Static type check with mypy
entry: .venv/bin/mypy
language: system
pass_filenames: false
files: .*\.py
- id: pytest-check
name: pytest-check
entry: .venv/bin/pytest tests
language: system
pass_filenames: false
always_run: true
matridge/.woodpecker/ 0000775 0000000 0000000 00000000000 14777004470 0015104 5 ustar 00root root 0000000 0000000 matridge/.woodpecker/autoupdate-deps.yaml 0000664 0000000 0000000 00000000415 14777004470 0021074 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
when:
event: [cron, manual]
cron: lockfile
steps:
refresh-deps:
image: codeberg.org/slidge/woodpecker-uv-update-lockfile:latest
pull: true
settings:
token:
from_secret: CODEBERG_TOKEN
matridge/.woodpecker/container.yaml 0000664 0000000 0000000 00000002660 14777004470 0017756 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
when:
event: [push, tag]
path:
- "matridge/**"
- Dockerfile
- pyproject.toml
- uv.lock
- .woodpecker/container.yaml
labels:
platform: linux/amd64
clone:
- name: clone-deep
image: woodpeckerci/plugin-git
settings:
tags: true
partial: false
variables:
- &settings
repo: codeberg.org/${CI_REPO_OWNER}/matridge
username: ${CI_REPO_OWNER}
password:
from_secret: CODEBERG_TOKEN
registry: codeberg.org
target: matridge
# this only caches one of the two platforms unfortunately
# https://github.com/docker/buildx/discussions/1382
# https://github.com/docker/buildx/issues/1044
cache_images:
- codeberg.org/${CI_REPO_OWNER}/matridge:buildcache
platforms: linux/amd64,linux/arm64
steps:
build-tag:
image: woodpeckerci/plugin-docker-buildx
when:
event: [tag]
settings:
<<: *settings
tags:
- latest
- ${CI_COMMIT_TAG}
build-branch:
when:
event: [push]
image: woodpeckerci/plugin-docker-buildx
settings:
<<: *settings
tags:
- ${CI_COMMIT_BRANCH}
build-ci:
when:
event: [push]
branch: ${CI_REPO_DEFAULT_BRANCH}
image: woodpeckerci/plugin-docker-buildx
settings:
<<: *settings
target: ci
tag: ci
cache_images:
- codeberg.org/${CI_REPO_OWNER}/matridge:buildcache-ci
matridge/.woodpecker/docs.yaml 0000664 0000000 0000000 00000001012 14777004470 0016712 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
when:
event: [push, tag, pull_request]
path: ["matridge/**/*.py", "docs/**/*", "uv.lock", ".woodpecker/docs.yaml"]
steps:
build:
image: codeberg.org/${CI_REPO_OWNER}/matridge:ci
pull: true
commands:
- uv sync --all-groups --all-extras
- cd docs && make html
publish:
image: codeberg.org/slidge/woodpecker-publish-pages
pull: true
when:
event: [push, tag]
settings:
token:
from_secret: CODEBERG_TOKEN
matridge/.woodpecker/package.yaml 0000664 0000000 0000000 00000002260 14777004470 0017363 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
when:
event: [push, tag]
path: ["matridge/**/*", "pyproject.toml", "README.md"]
branch: main
variables:
- &ci-image codeberg.org/${CI_REPO_OWNER}/matridge:ci
clone:
- name: clone-deep
image: woodpeckerci/plugin-git
settings:
tags: true
partial: false
steps:
changelog:
image: codeberg.org/slidge/woodpecker-generate-changelog
pull: true
build:
image: *ci-image
pull: true
commands:
- uv build
codeberg-pypi:
when:
event: [push, tag]
image: *ci-image
depends_on: build
environment:
CODEBERG_TOKEN:
from_secret: CODEBERG_TOKEN
commands:
- uv publish --index codeberg --token $CODEBERG_TOKEN
pypi:
image: *ci-image
depends_on: build
when:
event: tag
environment:
PYPI_TOKEN:
from_secret: PYPI_TOKEN
commands:
- uv publish --token $PYPI_TOKEN
codeberg-release:
image: woodpeckerci/plugin-release
depends_on: [changelog, build]
when:
event: tag
settings:
files:
- dist/matridge*
api_key:
from_secret: CODEBERG_TOKEN
note: CHANGELOG
matridge/.woodpecker/test.yaml 0000664 0000000 0000000 00000001210 14777004470 0016741 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
when:
event: [push, pull_request]
path: [pyproject.toml, uv.lock, "**/*.py", ".woodpecker/test.yaml"]
variables:
- &ci-image codeberg.org/${CI_REPO_OWNER}/matridge:ci
steps:
update-venv:
image: *ci-image
pull: true
commands:
- uv sync --all-groups --all-extras
ruff:
image: *ci-image
depends_on: update-venv
commands:
- ruff check
- ruff format --check
mypy:
image: *ci-image
depends_on: update-venv
commands:
- mypy
test:
image: *ci-image
depends_on: update-venv
commands:
- python -m pytest tests
matridge/CONTRIBUTING.md 0000664 0000000 0000000 00000010730 14777004470 0015116 0 ustar 00root root 0000000 0000000 # Contributing
We are really happy to welcome new contributors to matridge!
Before starting anything, please join [our chat room](xmpp:slidge@conference.nicoco.fr?join)
to say hi and see if anyone is already working on the bug you want to fix or
the feature you want to implement.
## Quickstart
To start hacking on matridge, you need to:
1. Clone the repository: `git clone https://codeberg.org/slidge/matridge`.
2. Install the required dependencies. (see below)
3. Spin up a development XMPP server for matridge to connect to. (see below)
### Easy mode: docker-compose
The easiest way to achieve 2 and 3 at the same time is to use the provided
`docker-compose.yml` file. Run ``docker compose up`` (or ``podman-compose up``)
in the directory of the repository you just cloned. It will:
- spin up a [prosody](https://prosody.im) instance configured for development;
- launch matridge in a dedicated container, with hot code reload.
You will then be able to connect to that prosody using any XMPP client, using
"test@localhost" as JID and "password" as password. We recommended
[gajim](https://gajim.org) which lets you start a different profile than your
main profile: `gajim -p slidge -c ~/.local/share/gajim-slidge`.
To avoid having to accept self-signed certificates, you can add prosody's
certificate to your local store. In debian, you can do that with:
```bash
# download the certificate
curl https://codeberg.org/slidge/prosody-dev-container/raw/branch/main/localhost.crt | sudo tee /usr/local/share/ca-certificates/localhost.crt
# set the right perms
chmod 600 /usr/local/share/ca-certificates/localhost.crt
# import it
sudo update-ca-certificates
```
### Slightly harder mode: setting up a virtualenv
In some situations, developing in containers is not optimal, for instance if
you want to attach an interactive debugger to the matridge process.
matridge defines its dependencies in a [PEP 517](https://peps.python.org/pep-0517/)-compliant
`pyproject.toml` file. This means that you can use different tools to set up a
virtualenv with the appropriate dependencies.
We recommend using [uv](https://docs.astral.sh/uv/) which is fast and has some
nice features. By running ``uv sync --frozen --all-groups --all-extras``, a
standard virtualenv will be installed in `./.venv`. You can then activate it
with `source .venv/bin/activate` and launch `matridge --help`.
NB: you will need to set up a local XMPP server. An easy way to do that is to
use the `slidge-prosody-dev` container: `docker run --network host codeberg.org/slidge/prosody-slidge-dev`.
With it you will be able to launch matridge with
``matridge --jid slidge.localhost --secret secret --debug --home-dir ./persistent``.
### Hacking on slidge core simultaneously
Maybe you will discover that what you want to change, add or fix is not part
of matridge but part of slidge core. To modify slidge core, first you
need to clone [the slidge repo](https://codeberg.org/slidge/slidge) somewhere
on your computer.
Let's assume you cloned `slidge` in the same root dir as `matridge`,
e.g., `~/src/matridge` and `~/src/slidge`.
With the `docker-compose`-based dev setup, you will need to add an additional
mount for the slidge dir, e.g., `../slidge:/build/slidge`. If you opted for
the virtualenv solution, you can install slidge in your virtualenv in editable
mode with `[uv] pip install -e ../slidge`.
## Guidelines
matridge uses these tools to ensure some level of code quality:
- [mypy](https://www.mypy-lang.org/)
for static type checking,
- [ruff](https://docs.astral.sh/ruff/)
to detect common python mistakes and enforce a consistent style,
- [pytest](https://docs.pytest.org/en/stable/)
for automated tests.
Commit messages should be in the form of
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), with
some additional types defined in [./commitlinx.config.js](https://codeberg.org/slidge/matridge/src/branch/main/commitlint.config.js).
This makes it possible to automatically generate changelogs on releases, it
is worth it! We use [git-cliff](https://git-cliff.org/) for this. You don't have
to install git-cliff locally, the magic happens in CI.
We recommended setting up [pre-commit](https://pre-commit.com/) to ensure that
these pass for each commit: `pre-commit install && pre-commit install --hook-type commit-msg`.
Make a new git branch, commit your changes, push it to your fork and open a
pull request!
NB: we also accept contributions without pull requests. Just push your changes
somewhere and tell us where to pull via the group chat.
matridge/Dockerfile 0000664 0000000 0000000 00000006137 14777004470 0014665 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
# Builder
# *******
FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim AS builder
# install git for setuptools scm
RUN apt-get update -y && \
apt-get install \
git \
make \
cargo \
cmake \
g++ \
-y --no-install-recommends && \
rm -rf /var/lib/apt/lists/*
WORKDIR /build
ENV UV_PROJECT_ENVIRONMENT=/venv
ENV PATH="/venv/bin:/root/.cargo/bin:$PATH"
# By making the venv relocatable, we can copy it to /workspace/.venv in CI, and only update
# dependencies that might be out-of-date. If uv.lock is not modified, then updating
# the .venv is a no-op.
# This allows us to not wait on the CI container build for the test workflows to run,
# and also to run workflows for pull requests that modify the lockfile. In this,
# situation, updating the CI container is not an option.
RUN uv venv $UV_PROJECT_ENVIRONMENT --relocatable
COPY uv.lock pyproject.toml README.md .
COPY matridge matridge
# install dependencies in /venv
# .git/ needs to be mounted for setuptools-scm to set the version
RUN --mount=source=.git,target=/build/.git,type=bind \
uv sync --no-dev
# CI container
# ************
FROM builder AS ci
# In CI we copy /venv to .venv, then update it for the whole workflow.
RUN --mount=source=.git,target=/build/.git,type=bind \
uv sync --all-groups --no-install-project
ENV UV_PROJECT_ENVIRONMENT=.venv
ENV UV_LINK_MODE=copy
ENV PATH="/woodpecker/src/codeberg.org/slidge/matridge/.venv/bin:$PATH"
# Dev container
# *************
FROM builder AS dev
# copy "localhost" certs from the prosody slidge dev container, so
COPY --from=codeberg.org/slidge/prosody-slidge-dev:latest \
/etc/prosody/certs/localhost.crt \
/usr/local/share/ca-certificates/
RUN update-ca-certificates
RUN apt-get update -y \
&& apt-get install -y --no-install-recommends \
libmagic1 \
media-types \
shared-mime-info \
&& rm -rf /var/lib/apt/lists/*
RUN uv pip install watchdog[watchmedo]
COPY --from=ci /venv /venv
ENTRYPOINT ["watchmedo", "auto-restart", \
"--pattern", "*.py", \
"--directory", "/build/matridge", \
"--recursive", \
"matridge", "--", \
"--jid", "slidge.localhost", \
"--secret", "secret", \
"--debug", \
"--upload-service", "upload.localhost", \
"--admins", "test@localhost", \
"--dev-mode"]
# Prod container
# **************
FROM docker.io/python:3.13-slim-bookworm AS matridge
ENV PYTHONUNBUFFERED=1
ENV PATH="/venv/bin:$PATH"
STOPSIGNAL SIGINT
WORKDIR /var/lib/slidge
# libmagic1: to guess mime type from files
# media-types: to determine file name suffix based on file type
RUN apt-get update -y \
&& apt-get install -y --no-install-recommends \
libmagic1 \
media-types \
shared-mime-info \
&& rm -rf /var/lib/apt/lists/*
RUN addgroup --system --gid 10000 slidge
RUN adduser --system --uid 10000 --ingroup slidge --home /var/lib/slidge slidge
USER slidge
COPY --from=builder /venv /venv
COPY --from=builder /build/matridge /venv/lib/python3.13/site-packages/matridge
ENTRYPOINT ["matridge"]
matridge/LICENSE 0000664 0000000 0000000 00000103333 14777004470 0013674 0 ustar 00root root 0000000 0000000 GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
.
matridge/README.md 0000664 0000000 0000000 00000003227 14777004470 0014147 0 ustar 00root root 0000000 0000000 # matridge
A
[feature-rich](https://slidge.im/docs/matridge/main/user/features.html)
[Matrix](https://matrix.org) to
[XMPP](https://xmpp.org/) puppeteering
[gateway](https://xmpp.org/extensions/xep-0100.html), based on
[slidge](https://slidge.im) and
[nio](https://matrix-nio.readthedocs.io/).
[](https://ci.codeberg.org/repos/14069)
[](https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr)
[](https://pypi.org/project/matridge/)
[](https://repology.org/project/slidge-matridge/versions)
matridge lets you chat with users of Matrix without leaving your favorite XMPP client.
## Quickstart
```sh
docker run codeberg.org/slidge/matridge \ # works with podman too
--jid matrix.example.org \ # can be whatever you want it to be
--secret some-secret \ # must match your XMPP server config
--home-dir /somewhere/writeable # for data persistence
```
Use the `:latest` tag for the latest release, `:vX.X.X` for release X.X.X, and `:main`
for the bleeding edge.
If you do not like containers, other installation methods are detailed
[in the docs](https://slidge.im/docs/matridge/main/admin/install.html).
## Documentation
Hosted on [codeberg pages](https://slidge.im/docs/matridge/main/).
## Contributing
Contributions are **very** welcome, and we tried our best to make it easy
to start hacking on matridge. See [CONTRIBUTING.md](./CONTRIBUTING.md).
matridge/assets/ 0000775 0000000 0000000 00000000000 14777004470 0014166 5 ustar 00root root 0000000 0000000 matridge/assets/matrix_outline.png 0000664 0000000 0000000 00000011064 14777004470 0017741 0 ustar 00root root 0000000 0000000 PNG
IHDR u: pHYs ki ki tEXtSoftware www.inkscape.org< tEXtTitle Matrix (protocol) logo@x IDATx{pTeo ` @} "X,!׀e Ȋl;2X:)ԁхA (̊f,eY* AG$@L @z8M!ITJ{~Oy< 7v F[DA둂$b w ~vj^H}ϙ3gMOOW^~Aڷo {ywuyyy㣏>27 6D (H"$
'۳b
jZn7ުU+ڶmp]vVi={4Ç띮AAJNN C"3mډh)S@)PS /|ˁJ vE%>#;SAZ d9H8 ZBAҦIĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 v# @ ;trP __gk낳 >C ?|z4)x)d`0HZ6s{ˆ}l[{aޡGu| -f4 |~CKao87 shBu3x
_k
5#0;<-; ԃ̑#Gp@RR۷'55oӿILL T5S 7 ˼l#GO~~>ObΟ?O|VINN&99ݻs7-ԩS]㬙.Ͽ,MT4`f>cvΝ;oUݻkOLLdԨQs=̘1^z'
) 8ۨ`Jrssy뭷ͥUׯ ;I&Ѷm[$}q6r &Y_v[YYYFٰaCGqժb֭deeQPPVQQA^^ yyy}:s̡~c8-<~8,[kq+L:3gRXXR ~:͖| [uV B^^^T:}vF ɉ'|&Os_kƍ ήkΝ 6o k1JdFAr9s>˗PVVy ;v >|aJAuu5G mPTTDff&ku8HdBArN"2RYY̙3ʊbvIM}l L͛#'_v=
]
䣪ٳg{E+ 9rE
w1cưwHvі.]ʶm|-d9ҥKD+״}vo[3|6K/\)S8|pEqDp6kF,[,>ϥK>}: BSVVƼy|Zݕ8W7
+4FNbW?|ᇑP>s1J Jɓ̟? 4ʺu먮 ?p WbBϺ=pO Һu"++Yf^&)J<ͣf_ݷ#%DBʪUo߾ 0 =zBee%q1
(//7m^z%̙ŋ}l֭ׯ 556mڐHEE%%%:uǏ_SS; ֮]ŋiժCAjx&NȌ3;v,]^v˗/'Cvv6Ν [ :Ă GԪU+f͚7n IIIsY>|Mv MB݁sn
RLn5D-x衇8z(;v`Μ9e˖dddzj
xg|?aegg7h/lM֠2{lrrrgԨQt^;v] MX4 зo_ 8ݻw$''rJG:>l۶͛7ӧO4h{aժUŅ]v7% )Ҧٺu+Ɂ^>s)'78w&\s3΅yĈ#cر|} ӹsgrrr2d%'νM<
hsaOp8ke˖ѭ[ <{,G [oR4´0Q|̘1-[7<8Fg<{.sk?;0zh.]dwdrss8-vIJJJUoyL`8 R8k[huՃ, Xz5={-:68v͕v1|jKJJ^p? 3ji|ηvƍ3qIwQ@5%1 V 33Ӱj .sξE1y0j-Xz8}뚶 \- 1QgpLjcUzه~iӦYUUUu>0 ӽv 05_Zl{LFF\vCP{9ERRwqig5qtΝ~v܋8GߑC- oʔ)MgÇ5]P.^;MILiԩK}~ N qg8 jKZ#5ڵc`{9 R M [~EL>ԣG0S7{hl
V`x#lmxs/g
V pkb6H6E" W~<p_6X;tp{1 WB%nXZ`
wY0
R#\A֭h
y6H[68@"<%jArmZ$LJ]=CdK˖-ݧbJuhh߰p~,u#ln{+ΘwZn>3R ~Ɣ
H=.lk(Ik$
R ܧpK5P (Hק뀂$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 4ȑ#IKK3cǎ&bɔթS'zBIiiI])))&DJ
͛SZ`jÆ
BhNĀ$bo6lo iډ
D zq;\/yM;
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 PD (H"$
IĀ$b@A1 |3!8"uIy& >
LiwA$ H7M;D˗/sy .zEEEmPΜ9Ä ӇW_}5EInnniP.^Ȟ={ndРAA+}$
IĀ>R߾}Ydy#]t1S!VX3gMOOx< V(+H7M;
]A IENDB` matridge/assets/matrix_outline.svg 0000664 0000000 0000000 00000006257 14777004470 0017764 0 ustar 00root root 0000000 0000000
matridge/commitlint.config.js 0000664 0000000 0000000 00000001623 14777004470 0016647 0 ustar 00root root 0000000 0000000 // DO NOT EDIT
// Generated from .copier-answers.yml
//
// This files defines the allowed "headers" for the commit messages.
// Following the rules makes the changelog generation easier.
// They come from angular conventions, unless commented.
const Configuration = {
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum':
[
2,
'always',
[
'build',
'chore',
'ci',
'docs',
'feat',
'fix',
'perf',
'refactor',
'revert',
'style',
'test',
'compat', // workaround to play nice with non-compliant clients or servers; ideally reverted once fixed upstream
'cfix', // fixes an unreleased commit, should not appear in changelog
'imprv', // improvement of an existing feature
]
],
},
}
module.exports = Configuration
matridge/doap.xml 0000664 0000000 0000000 00000014163 14777004470 0014336 0 ustar 00root root 0000000 0000000
matridgeA feature-rich Matrix/XMPP gatewayenPythonLinuxNicococompleteOnly groups are supported, even 1:1 chats show as groups.completeFor typing notifications.completeThere are no recipient-generated receipts (except read marks) in matrix, but slidge will emit delivery receipts when the matrix server acks a message.completecompletecompletecompletecompleteFor read markers.completeFor attachments.partialMessage received from XMPP will have their bodies parsed for Message Styling tags, plus "||spoiler||". Messages received from Matrix will not be parsed and converted.completeMatrix's redacted events are mapped to retraction when the sender and the redacter match.completeMatrix's redacted events are mapped to retraction when the sender and the redacter do not match.completecomplete
matridge/docker-compose.yml 0000664 0000000 0000000 00000001201 14777004470 0016313 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
services:
slidge:
build:
context: .
target: dev
network_mode: service:prosody
volumes:
- ./matridge:/build/matridge
- ./persistent:/var/lib/slidge/slidge.localhost
depends_on:
prosody:
condition: service_started
prosody:
image: codeberg.org/slidge/prosody-slidge-dev:latest
ports:
- "127.0.0.1:5281:5281" # XMPP port for clients to connect to
- "127.0.0.1:5222:5222" # prosody's http_file_share
- "127.0.0.1:4444:4444" # for nginx (optional, no-upload)
- "127.0.0.1:8888:80" # for movim (optional)
matridge/docs/ 0000775 0000000 0000000 00000000000 14777004470 0013614 5 ustar 00root root 0000000 0000000 matridge/docs/Makefile 0000664 0000000 0000000 00000001176 14777004470 0015261 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
matridge/docs/source/ 0000775 0000000 0000000 00000000000 14777004470 0015114 5 ustar 00root root 0000000 0000000 matridge/docs/source/admin/ 0000775 0000000 0000000 00000000000 14777004470 0016204 5 ustar 00root root 0000000 0000000 matridge/docs/source/admin/config.rst 0000664 0000000 0000000 00000003133 14777004470 0020203 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
Configuration
=============
Minimal setup
-------------
For a minimal ``prosody `` based setup, add these lines at the bottom of
``/etc/prosody/prosody.cfg.lua``:
.. code-block:: lua
Component "matridge.example.org"
component_secret = "secret"
And start matridge with:
.. code-block:: bash
matridge \
--jid matridge.example.org \
--secret secret \
--home-dir /somewhere/writable
Advanced usage
--------------
Refer to the `slidge admin docs `_ for more
advanced setups and examples of configuration for other XMPP servers.
You will probably want to add support for `attachments `_
received from Matrix, and setup matridge as a `privileged component `_
for better UX.
matridge-specific config
------------------------
All `generic slidge configuration options `_
apply.
matridge provides the additional component-wide options displayed in the table below.
They can be used:
* in an INI config file by starting matridge with ``-c /path/to/file.ini``;
* as command line arguments, prepended with ``--``, e.g., ``--some-option=value``;
* as environment variables, upper case, prepended with ``MATRIDGE_``, and with dashes substituted with underscores, e.g., ``MATRIDGE_SOME_OPTION=value``.
.. config-obj:: matridge.config
matridge/docs/source/admin/index.rst 0000664 0000000 0000000 00000000502 14777004470 0020042 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
==========
For admins
==========
If you are the administrator of an XMPP server and want to set up matridge,
this part of the documentation is made for you.
.. toctree::
install
config
matridge/docs/source/admin/install.rst 0000664 0000000 0000000 00000004242 14777004470 0020406 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
Installation
------------
Containers
~~~~~~~~~~
A container is built on every push to the git repository and uploaded to `the codeberg package
registry `__.
.. code:: sh
docker run codeberg.org/slidge/matridge # works with podman too
Use the ``:latest`` tag for the latest release, ``:vX.X.X`` for release
X.X.X, and ``:main`` for the bleeding edge.
Distribution packages
~~~~~~~~~~~~~~~~~~~~~
matridge is available in the official repositories of a few linux distributions.
.. image:: https://repology.org/badge/vertical-allrepos/slidge-matridge.svg
:alt: Packaging status
:target: https://repology.org/project/slidge-matridge/versions
Python packages
~~~~~~~~~~~~~~~
.. image:: https://badge.fury.io/py/matridge.svg
:alt: PyPI package version
:target: https://pypi.org/project/matridge/
matridge is available on the `python package index (PyPI) `__.
If you are not familiar with python packaging, we recommend using `pipx `__ to
set up matridge and its dependencies, isolated from the rest of your system.
.. code:: sh
# for the latest stable release published to PyPI, if any
pipx install matridge
matridge --help
Bleeding edge versions are also available on `codeberg's python index `_.
.. code:: sh
# for the bleeding edge
pipx install matridge \
--pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/ --pre'
Unofficial debian package
~~~~~~~~~~~~~~~~~~~~~~~~~
If you are using debian you might be interested in installing the
`slidge (unofficial) debian
package `__ which bundles matridge
along with other slidge-based XMPP gateways.
Follow the instructions in the repository README; edit
``/etc/slidge/conf.d/common.conf`` and
``/etc/slidge/matrix.conf``; run
``sudo systemctl start slidge@matrix``; watch the logs with
``sudo journalctl -u slidge@matrix -f``.
matridge/docs/source/codeberg.svg 0000664 0000000 0000000 00000001626 14777004470 0017414 0 ustar 00root root 0000000 0000000
matridge/docs/source/conf.py 0000664 0000000 0000000 00000003054 14777004470 0016415 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
import os
from datetime import datetime
from pathlib import Path
from slidge import __version__ as slidge_version
project = "matridge"
copyright = f"{datetime.today().year}, the {project} contributors"
author = f"the {project} contributors"
branch = os.getenv("CI_COMMIT_BRANCH", "main")
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.extlinks",
"sphinx.ext.viewcode",
"sphinx.ext.autodoc.typehints",
"autoapi.extension",
"slidge_sphinx_extensions.doap",
"slidge_sphinx_extensions.config_obj",
"sphinx_mdinclude",
]
autodoc_typehints = "description"
# Include __init__ docstrings
autoclass_content = "both"
autoapi_python_class_content = "both"
autoapi_type = "python"
autoapi_dirs = ["../../matridge"]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"slixmpp": ("https://slixmpp.readthedocs.io/en/latest/", None),
"slidge": (f"https://slidge.im/docs/slidge/{slidge_version}/", None),
}
extlinks = {"xep": ("https://xmpp.org/extensions/xep-%s.html", "XEP-%s")}
html_theme = "furo"
html_theme_options = {
"source_edit_link": f"https://codeberg.org/slidge/{project}/_edit/{branch}/docs/source/{{filename}}",
"source_view_link": f"https://codeberg.org/slidge/{project}/src/branch/{branch}/docs/source/{{filename}}",
"footer_icons": [
{
"name": "Codeberg",
"url": f"https://codeberg.org/slidge/{project}",
"html": Path("codeberg.svg").read_text(),
},
],
}
matridge/docs/source/contributing.rst 0000664 0000000 0000000 00000000247 14777004470 0020360 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
.. mdinclude:: ../../CONTRIBUTING.md
matridge/docs/source/index.rst 0000664 0000000 0000000 00000001434 14777004470 0016757 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
matridge
========
.. sidebar:: Useful links
`Source `_
`Chat room `_
`Bug tracker `_
A
`feature-rich `_
`Matrix `_ to
`XMPP `_ puppeteering
`gateway `_, based on
`slidge `_ and
`nio `_.
.. toctree::
:maxdepth: 3
admin/index
user/index
contributing
autoapi/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
matridge/docs/source/user/ 0000775 0000000 0000000 00000000000 14777004470 0016072 5 ustar 00root root 0000000 0000000 matridge/docs/source/user/features.rst 0000664 0000000 0000000 00000000572 14777004470 0020446 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
Features
--------
The table below lists the notable features for matridge.
Refer to `xmpp.org `_ for a longer version,
including all XEPs supported by `slidge `_.
.. doap:: ../../../doap.xml
matridge/docs/source/user/index.rst 0000664 0000000 0000000 00000000417 14777004470 0017735 0 ustar 00root root 0000000 0000000 ..
DO NOT EDIT
This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
For users
=========
You want to use a matridge instance? You have come to the right place.
.. toctree::
registration
usage
features
matridge/docs/source/user/registration.rst 0000664 0000000 0000000 00000001224 14777004470 0021335 0 ustar 00root root 0000000 0000000 Registration
============
To start using a matridge instance, you need to create an account by
registering with it. The instance has a unique XMPP (aka JID) address, which is
usually just a domain name (e.g., "matrix.example.org"), without a
username or local part.
There are two ways to register, depending on your client:
- If your client supports adhoc commands (such as Movim, Gajim, or Cheogram),
you can use the "Register" command with the matridge instance's
address.
- If your client does not support adhoc commands (such as Conversations), you
can register by sending a text message that says "register" to the
matridge instance's address.
matridge/docs/source/user/usage.rst 0000664 0000000 0000000 00000001602 14777004470 0017727 0 ustar 00root root 0000000 0000000 Usage
=====
Be patient
----------
Matrix the protocol, Python the language, and slidge the implementation are all **slow**.
Just wait, it takes time to log in, join rooms and send messages: this is all expected.
Everything is a MUC
-------------------
Standard XMPP direct messages are not supported.
Direct channels rooms (1:1 messages) are group chats of 2 participants.
E2EE
----
End-to-end encryption is not possible, but you can use end-to-bridge encryption.
First, verify your slidge session using another client using the emoji verification workflow.
Then you will have to either "verify", "ignore", or "blacklist" the keys
corresponding to your rooms and your other sessions.
This can be done using the adhoc or chat command "verify" (send "verify" to
the JID of matridge, eg ``matridge.example.com``).
If you don't really care about all this, you can use the shortcut "verify all".
matridge/matridge/ 0000775 0000000 0000000 00000000000 14777004470 0014460 5 ustar 00root root 0000000 0000000 matridge/matridge/__init__.py 0000664 0000000 0000000 00000001312 14777004470 0016566 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
import sys
from importlib.metadata import PackageNotFoundError, version
from slidge import entrypoint
# import everything for automatic subclasses discovery by slidge core
from . import command, config, contact, gateway, group, session
try:
__version__ = version("matridge")
except PackageNotFoundError:
# package is not installed
__version__ = "dev"
def main():
if len(sys.argv) == 2 and sys.argv[1] == "--version":
print("matridge version", __version__)
exit(0)
entrypoint("matridge")
__all__ = (
"__version__",
"command",
"config",
"contact",
"gateway",
"group",
"main",
"session",
)
matridge/matridge/__main__.py 0000664 0000000 0000000 00000000126 14777004470 0016551 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# Generated from .copier-answers.yml
from matridge import main
main()
matridge/matridge/command.py 0000664 0000000 0000000 00000014056 14777004470 0016456 0 ustar 00root root 0000000 0000000 from typing import Union
import nio
from nio.crypto import OlmDevice, TrustState
from slidge.command import Command, CommandAccess, Form, FormField, TableResult
from slidge.command.base import FormValues
from slidge.command.categories import CONTACTS, GROUPS
from slixmpp.exceptions import XMPPError
from .group import MUC
from .session import Session
class ListSpaces(Command):
NAME = "🌌 Matrix spaces"
CHAT_COMMAND = NODE = "spaces"
CATEGORY = GROUPS
HELP = "List the matrix spaces you're part of"
ACCESS = CommandAccess.USER_LOGGED
async def run(self, session: Session, _ifrom, *args: str) -> Form: # type:ignore
spaces = list[nio.MatrixRoom]()
for room in session.matrix.rooms.values():
if room.children:
spaces.append(room)
spaces = sorted(spaces, key=lambda r: r.name)
return Form(
title=self.NAME,
instructions="Choose a space to list its children rooms. "
"NB: as of now, you can also see rooms that you are a member of.",
handler=self.finish, # type:ignore
handler_args=(spaces,),
fields=[
FormField(
"space",
label="Matrix space",
type="list-single",
options=[
{"label": room.display_name, "value": str(i)}
for i, room in enumerate(spaces)
],
)
],
)
@staticmethod
async def finish(
form_values: FormValues,
session: Session,
_ifrom,
rooms: list[nio.MatrixRoom],
):
space = rooms[int(form_values["space"])] # type:ignore
mucs = list[MUC]()
for room_id in space.children:
try:
mucs.append(await session.bookmarks.by_legacy_id(room_id))
except XMPPError:
continue
mucs = sorted(mucs, key=lambda muc: muc.name)
return TableResult(
fields=[FormField("name"), FormField("jid", type="jid-single")],
description=f"Rooms of '{space.display_name}'",
jids_are_mucs=True,
items=[{"name": muc.name, "jid": str(muc.jid)} for muc in mucs],
)
class ManageTrust(Command):
NAME = "🤝 Manage trust in devices"
CATEGORY = CONTACTS
CHAT_COMMAND = NODE = "verify"
HELP = "Manage which OLM keys you trust or not."
ACCESS = CommandAccess.USER_LOGGED
HUMAN_STATES = {0: "unset", 1: "verified", 2: "blacklisted", 3: "ignored"}
def __human_device(self, d: OlmDevice, state=True):
r = f"{d.ed25519} of {d.user_id}"
if state:
return r + f" ({self.HUMAN_STATES[d.trust_state.value]})"
return r
async def run(
self,
session: Session, # type:ignore
_ifrom,
*args: str,
) -> Union[Form, str]:
devices = list[OlmDevice](session.matrix.olm.device_store)
device_dict = {d.id: d for d in devices}
# this part if for chat commands only
if args:
if args[0] == "all":
return await self.step2(
{
"device": list(device_dict.keys()), # type:ignore
"new_state": "verified",
},
session,
None,
device_dict,
)
else:
return await self.step2(
{"device": args[0].upper(), "new_state": "verified"},
session,
None,
device_dict,
)
return Form(
title=self.NAME,
instructions="Choose the session(s) which trust state you want to change",
handler=self.step2, # type:ignore
handler_args=(device_dict,),
fields=[
FormField(
"device",
label="Device(s)",
type="list-multi",
options=[
{"label": self.__human_device(d), "value": d.id}
for d in devices
],
),
FormField(
"new_state",
label="What new status do you want to give the selected devices?",
type="list-single",
options=[
{"label": v, "value": v} for v in self.HUMAN_STATES.values()
],
),
],
)
async def step2(
self,
form_values: FormValues,
session: Session,
_ifrom,
devices: dict[str, OlmDevice],
):
new_state = form_values["new_state"]
matrix = session.matrix
result = ""
for device_name in form_values["device"]: # type:ignore
device = devices[device_name]
change = False
if new_state == "unset":
if device.trust_state == TrustState.verified:
change = matrix.unverify_device(device)
elif device.trust_state == TrustState.ignored:
change = matrix.unignore_device(device)
elif device.trust_state == TrustState.blacklisted:
change = matrix.unblacklist_device(device)
elif new_state == "verified":
change = session.matrix.verify_device(device)
elif new_state == "blacklisted":
change = session.matrix.blacklist_device(device)
elif new_state == "ignored":
change = session.matrix.ignore_device(device)
if change:
result += (
f"\nThe status of {self.__human_device(device, False)} "
f"is now {new_state}."
)
else:
result += (
f"\nThe status of {self.__human_device(device, False)} "
f"has not changed."
)
return result or "Nothing was changed."
matridge/matridge/config.py 0000664 0000000 0000000 00000001773 14777004470 0016307 0 ustar 00root root 0000000 0000000 MAX_HISTORY_FETCH = 100
MAX_HISTORY_FETCH__DOC = (
"Number of events to fetch to back-fill MUC history before slidge starts up."
)
MAX_PARTICIPANTS_FETCH = 10
MAX_PARTICIPANTS_FETCH__DOC = (
"Number of participants to fetch when joining a group. "
"Higher values will make joining slower, and participants will appear when "
"they speak or if they spoke in the back-filled events. "
"Participants with power levels > 50 (ie, admins) will be fetched."
)
NIO_VERBOSE = False
NIO_VERBOSE__DOC = (
"Set this to True to respect the global log level from the matrix lib. "
"It's REALLY verbose, so the default is to use WARNING."
)
PARSE_MESSAGE_STYLING = True
PARSE_MESSAGE_STYLING__DOC = """
Convert Message Styling (XEP-0393) message bodies to Matrix custom HTML.
Supported markup:
_underline_
*bold*
~strikethrough~
`code span`
```code block```
>quote
||spoiler
\\_escape style_
"""
REACTION_CACHE_SIZE = 10000
REACTION_CACHE_SIZE__DOC = "Emoji reaction cache size, in number of messages"
matridge/matridge/contact.py 0000664 0000000 0000000 00000004502 14777004470 0016466 0 ustar 00root root 0000000 0000000 import asyncio
from datetime import datetime, timedelta
from typing import TYPE_CHECKING
import nio
from aiohttp import ClientConnectionError
from slidge import LegacyContact, LegacyRoster
from slixmpp.exceptions import XMPPError
if TYPE_CHECKING:
from .session import Session
class Contact(LegacyContact[str]):
"""
We don't implement direct messages but the what's parsed here will propagate
to MUC participants.
"""
session: "Session"
async def update_info(self):
# Because of slidge core's design, at this point we don't know which room
# the contact is in, so we have to iterate over rooms, which is better than
# issuing a full profile fetch
for _, room in self.session.matrix.rooms.items():
user = room.users.get(self.legacy_id)
if user is not None:
break
else:
raise XMPPError("item-not-found", "We don't know this user")
self.name = user.display_name
if mxc := user.avatar_url:
self.avatar = await self.session.matrix.mxc_to_http(mxc)
else:
self.avatar = None
async def fetch_vcard(self):
try:
resp = await self.session.matrix.get_profile(self.legacy_id)
except (ClientConnectionError, TimeoutError, asyncio.TimeoutError) as e:
raise XMPPError("remote-server-timeout", str(e))
if not isinstance(resp, nio.ProfileGetResponse):
raise XMPPError("internal-server-error", str(resp))
if resp.other_info:
self.set_vcard(note=str(resp.other_info))
def update_presence(self, p: nio.PresenceEvent):
kw = dict(status=p.status_msg)
if last := p.last_active_ago is not None:
kw["last_seen"] = datetime.now() - timedelta(seconds=last)
if p.currently_active:
self.online(**kw)
else:
self.away(**kw)
class Roster(LegacyRoster[str, Contact]):
session: "Session"
async def jid_username_to_legacy_id(self, jid_username: str):
u = await super().jid_username_to_legacy_id(jid_username)
if not u.startswith("@"):
raise XMPPError(
"bad-request",
f"'{jid_username}' is not a valid matrix username. "
"Matrix usernames starts with @",
)
return u
matridge/matridge/gateway.py 0000664 0000000 0000000 00000006050 14777004470 0016474 0 ustar 00root root 0000000 0000000 import asyncio
import logging
from shutil import rmtree
from typing import TYPE_CHECKING, Optional
from nio.responses import LoginError
from slidge import BaseGateway, FormField, global_config
from slixmpp import JID
from slixmpp.exceptions import XMPPError
from . import config, reactions
from .matrix import AuthenticationClient
from .util import Credentials
if TYPE_CHECKING:
from .session import Session
class Gateway(BaseGateway):
REGISTRATION_FIELDS = [
FormField(var="homeserver", label="Home Server", required=True),
FormField(var="username", label="User name", required=True),
FormField(var="password", label="Password", required=True, private=True),
FormField(
var="device",
label="Device name",
value=f"matridge on {getattr(global_config, 'JID', 'dev')}",
required=True,
),
]
REGISTRATION_INSTRUCTIONS: str = "Enter your credentials"
COMPONENT_NAME = "Matrix (slidge)"
COMPONENT_TYPE = "matrix"
COMPONENT_AVATAR = (
"https://codeberg.org/slidge/matridge/raw/branch/main/assets/matrix_outline.png"
)
ROSTER_GROUP: str = "matrix"
MARK_ALL_MESSAGES = False
PROPER_RECEIPTS = True
GROUPS = True
DB_PURGE_SLEEP = 3600 * 24
PREFERENCES = BaseGateway.PREFERENCES + [
FormField(
var="trust_everything",
label="Always trust new encryption keys. "
"This is unsafe if you need perfect bridge to end encryption.",
value="false",
required=True,
type="boolean",
)
]
def __init__(self):
super().__init__()
if not config.NIO_VERBOSE:
logging.getLogger("peewee").setLevel(logging.WARNING)
logging.getLogger("nio.responses").setLevel(logging.FATAL)
logging.getLogger("nio.rooms").setLevel(logging.WARNING)
self._db_purge_task = self.loop.create_task(self._db_purge())
async def _db_purge(self):
await asyncio.sleep(self.DB_PURGE_SLEEP)
reactions.purge_old_messages(config.REACTION_CACHE_SIZE)
async def validate(
self, user_jid: JID, registration_form: dict[str, Optional[str]]
) -> Credentials:
client = AuthenticationClient(
registration_form["homeserver"], # type:ignore
registration_form["username"], # type:ignore
user_jid,
)
await client.fix_homeserver()
resp = await client.login(
registration_form["password"], # type:ignore
registration_form["device"], # type:ignore
)
if isinstance(resp, LoginError):
log.debug("Failed login: %r", resp)
raise XMPPError("not-authorized", f"Could not login: {resp}")
return client.get_credentials(resp)
async def unregister(self, user):
session: "Session" = self.get_session_from_user(user) # type: ignore
session.matrix.stop_listen()
await session.matrix.logout()
rmtree(session.matrix.store_path)
log = logging.getLogger(__name__)
matridge/matridge/group.py 0000664 0000000 0000000 00000013205 14777004470 0016167 0 ustar 00root root 0000000 0000000 import typing
import nio
from slidge.group import LegacyBookmarks, LegacyMUC, LegacyParticipant, MucType
from slidge.util.types import HoleBound
from slixmpp.exceptions import XMPPError
from . import config
from .util import MatrixMixin, server_timestamp_to_datetime
if typing.TYPE_CHECKING:
from .session import Session
class Participant(MatrixMixin, LegacyParticipant):
session: "Session"
muc: "MUC"
def set_affiliation_from_power_level(self, power_level: int) -> None:
if power_level == 100:
self.affiliation = "owner"
self.role = "moderator"
elif power_level >= 50:
self.affiliation = "admin"
self.role = "moderator"
else:
self.affiliation = "member"
self.role = "participant"
class Bookmarks(LegacyBookmarks):
session: "Session"
async def fill(self):
self.log.debug("Filling rooms")
for room in self.session.matrix.rooms:
try:
await self.by_legacy_id(room)
except XMPPError as e:
self.log.debug(
"%s is not a group chat or trouble getting it: %r", room, e
)
class MUC(LegacyMUC[str, str, Participant, str]):
session: "Session"
type = MucType.CHANNEL_NON_ANONYMOUS
async def get_room(self):
try:
return self.session.matrix.rooms[self.legacy_id]
except KeyError:
raise XMPPError("item-not-found", f"No room named {self.legacy_id}")
async def get_message(self, msg_id: str) -> typing.Optional[nio.Event]:
return await self.session.matrix.get_event(self.legacy_id, msg_id)
async def update_info(self):
room = await self.get_room()
if new := room.replacement_room:
raise XMPPError("redirect", f"{new}")
self.log.debug("Children: %s", room.children)
if room.children:
raise XMPPError("bad-request", "This is not a real room but a 'space'")
self.user_nick = room.user_name(self.session.matrix.user_id)
self.log.debug("User nick: %s", self.user_nick)
self.name = room.display_name
self.log.debug("Avatar: %s", room.room_avatar_url)
self.n_participants = room.member_count
self.subject = room.topic
if room.room_avatar_url:
self.avatar = await self.session.matrix.mxc_to_http(room.room_avatar_url)
elif room.member_count == 2:
# if 1:1 set room avatar to other users's avatar
for user_id, user in list(room.users.items()):
if user_id == self.session.matrix.user_id:
continue
if user.avatar_url is None:
break
self.avatar = await self.session.matrix.mxc_to_http(user.avatar_url)
break
async def fill_participants(self):
room = await self.get_room()
if not room.members_synced:
resp = await self.session.matrix.joined_members(self.legacy_id)
if isinstance(resp, nio.JoinedMembersResponse):
self.log.debug(
"Joined members response: %s participants", len(resp.members)
)
else:
self.log.debug("Joined members error: %s", resp)
power_levels = room.power_levels.users
i = 0
if len(room.users.items()) > config.MAX_PARTICIPANTS_FETCH:
# matrix groups are huge
self.KEEP_BACKFILLED_PARTICIPANTS = True
for user_id, user in list(room.users.items()):
power_level = power_levels.get(user_id, 0)
if power_level < 50 and i > config.MAX_PARTICIPANTS_FETCH:
continue
try:
p = await self.get_participant_by_legacy_id(user.user_id)
except XMPPError:
continue
p.set_affiliation_from_power_level(power_level)
if power_level < 50:
i += 1
yield p
async def backfill(
self,
after: HoleBound | None = None,
before: HoleBound | None = None,
):
after_date = None if after is None else after.timestamp
before_date = None if before is None else before.timestamp
async for event in self.session.matrix.fetch_history(
self.legacy_id,
config.MAX_HISTORY_FETCH,
):
if not isinstance(event, nio.RoomMessage):
self.log.debug("Not back-filling with %s", type(event))
when = server_timestamp_to_datetime(event)
if after_date is not None and when <= after_date:
continue
if before_date is not None and when >= before_date:
continue
try:
participant = await self.session.matrix.get_participant(
await self.get_room(), event
)
except XMPPError as e:
# maybe deleted profiles?
self.log.debug(
"Something is wrong with participant %s, falling back to using matrix ID as nickname: %s",
event.sender,
e,
)
participant = await self.get_participant(event.sender)
await participant.send_matrix_message(event, archive_only=True)
# FIXME: this breaks everything, probably because of parallel calls
# to sync()
# if isinstance(event, nio.UnknownEvent) and event.type == "m.reaction":
# await self.session.matrix.on_reaction(
# await self.get_room(), event, when=when, archive_only=True
# )
# continue
matridge/matridge/matrix.py 0000664 0000000 0000000 00000051202 14777004470 0016336 0 ustar 00root root 0000000 0000000 import logging
import time
from asyncio import Task, create_task, sleep
from functools import wraps
from typing import TYPE_CHECKING, AsyncIterator, Awaitable, Callable, Optional, Union
import nio
from async_lru import alru_cache
from nio import Event
from slidge.core import config as global_config
from slidge.util.types import LegacyAttachment
from slixmpp import JID
from slixmpp.exceptions import XMPPError
from . import config
from .reactions import ReactionCache
from .util import Credentials, get_replace, server_timestamp_to_datetime
if TYPE_CHECKING:
from .group import MUC, Participant
from .session import Session
def catch_all(coro: Callable[["Client", nio.MatrixRoom, nio.Event], Awaitable[None]]):
@wraps(coro)
async def wrapped(self: "Client", room: nio.MatrixRoom, event: nio.Event, *a, **kw):
event_id = getattr(event, "event_id", None)
async with self.session.send_lock:
if event_id in self.session.events_to_ignore:
self.log.debug("Ignoring an event matridge has sent: %s", event_id)
return
try:
return await coro(self, room, event, *a, **kw)
except XMPPError as e:
self.log.debug(
"Exception raised in matrix client callback %s", coro, exc_info=e
)
except Exception as e:
self.log.exception(
"Exception raised in matrix client callback %s", coro, exc_info=e
)
return wrapped
class AuthenticationClient(nio.AsyncClient):
def __init__(
self, server: str, handle: str, jid: JID, log: Optional[logging.Logger] = None
):
if not server.startswith("http"):
server = "https://" + server
self.store_path = store_path = global_config.HOME_DIR / (jid.bare + "_state")
store_path.mkdir(exist_ok=True)
cfg = nio.AsyncClientConfig(
store_sync_tokens=True,
max_limit_exceeded=0,
max_timeouts=0,
encryption_enabled=True,
)
super().__init__(server, handle, store_path=str(store_path), config=cfg)
if log:
self.log = log
else:
self.log = logging.getLogger(__name__)
def get_credentials(self, resp: nio.LoginResponse) -> Credentials:
return {
"homeserver": self.homeserver,
"user_id": resp.user_id,
"device_id": resp.device_id,
"access_token": resp.access_token,
}
async def fix_homeserver(self):
"""
Uses https://$HOMESERVER/.well-known/matrix/client to fix the homeserver
URL.
"""
response = await self.discovery_info()
if isinstance(response, nio.DiscoveryInfoResponse):
self.homeserver = response.homeserver_url
class Client(AuthenticationClient):
MIN_RETRY_TIME = 3
MAX_RETRY_TIME = 300
REQUEST_TIMEOUT = 60
CONSIDER_SUCCESSFUL = 10
def __init__(self, server: str, handle: str, session: "Session"):
super().__init__(server, handle, session.user.jid, session.log)
self.__sync_task: Optional[Task] = None
self.session = session
self.reactions = ReactionCache(self)
def load(self):
stored = self.session.user.legacy_module_data
self.access_token: str = stored["access_token"] # type:ignore
self.user_id: str = stored["user_id"] # type:ignore
self.device_id: str = stored["device_id"] # type:ignore
async def login_token(self):
self.load()
await self.fix_homeserver()
self.load_store()
def __add_event_handlers(self):
self.add_event_callback(self.on_event, nio.Event) # type:ignore
self.add_event_callback(self.on_message, nio.RoomMessage) # type:ignore
self.add_event_callback(self.on_avatar, nio.RoomAvatarEvent) # type:ignore
self.add_event_callback(self.on_topic, nio.RoomTopicEvent) # type:ignore
self.add_event_callback(self.on_name, nio.RoomNameEvent) # type:ignore
self.add_event_callback(self.on_sticker, nio.StickerEvent) # type:ignore
self.add_event_callback(self.on_member, nio.RoomMemberEvent) # type:ignore
self.add_event_callback(self.on_redact, nio.RedactionEvent) # type:ignore
self.add_event_callback(self.on_reaction, nio.ReactionEvent) # type:ignore
self.add_event_callback(self.on_power_levels, nio.PowerLevelsEvent) # type:ignore
self.add_presence_callback(self.on_presence, nio.PresenceEvent) # type:ignore
self.add_ephemeral_callback(self.on_receipt, nio.ReceiptEvent) # type:ignore
self.add_ephemeral_callback(
self.on_typing, # type:ignore
nio.TypingNoticeEvent,
)
self.add_to_device_callback(
self.on_key_verification, # type:ignore
(nio.KeyVerificationEvent, nio.UnknownToDeviceEvent),
)
async def __get_muc(self, room: Union[nio.MatrixRoom, str]) -> "MUC":
room_id = room.room_id if isinstance(room, nio.MatrixRoom) else room
return await self.session.bookmarks.by_legacy_id(room_id)
async def __sync_forever(self):
attempts = 0
while True:
start = time.time()
try:
await self.sync_forever(timeout=self.REQUEST_TIMEOUT)
except Exception as e:
duration = time.time() - start
if duration < self.CONSIDER_SUCCESSFUL:
attempts += 1
wait = min(attempts * self.MIN_RETRY_TIME, self.MAX_RETRY_TIME)
else:
attempts = 0
wait = self.MIN_RETRY_TIME
if attempts < 2:
self.log.debug(
"Sync task has raised %r, retrying in %s", e, wait, exc_info=e
)
else:
self.log.error(
"Sync task has raised %r, retrying in %s", e, wait, exc_info=e
)
await sleep(wait)
else:
break
async def get_participant(
self, room: nio.MatrixRoom, event: nio.Event
) -> "Participant":
muc = await self.__get_muc(room)
self.log.debug(
"sender (%s) == me (%s)? %s",
event.sender,
self.session.contacts.user_legacy_id,
event.sender == self.session.contacts.user_legacy_id,
)
return await muc.get_participant_by_legacy_id(event.sender)
async def listen(self):
# we need to sync full state or else we don't get the list of all rooms
resp = await self.sync(full_state=True)
self.log.debug("Sync")
if isinstance(resp, nio.SyncError):
raise PermissionError(resp)
self.__add_event_handlers()
self.__sync_task = create_task(self.__sync_forever())
def stop_listen(self):
if self.__sync_task is None:
return
self.__sync_task.cancel()
async def fetch_history(self, room_id: str, limit: int) -> AsyncIterator[Event]:
sync_resp = await self.sync()
if isinstance(sync_resp, nio.SyncError):
return
resp = await self.room_messages(
room_id,
limit=limit,
start=sync_resp.next_batch,
message_filter={"types": ["m.room.message"]},
)
if not isinstance(resp, nio.RoomMessagesResponse):
self.log.warning("Could not fill history.", sync_resp)
return
for event in resp.chunk:
yield event
@catch_all
async def on_event(self, room: nio.MatrixRoom, event: nio.Event):
if config.NIO_VERBOSE:
self.log.debug("Event %s '%s': %r", type(event), room, event)
@catch_all
async def on_message(self, room: nio.MatrixRoom, event: nio.RoomMessage):
self.log.debug("Message: %s", event)
participant = await self.get_participant(room, event)
await participant.send_matrix_message(event)
async def on_presence(self, presence: nio.PresenceEvent):
if presence.user_id == self.session.contacts.user_legacy_id:
return
try:
contact = await self.session.contacts.by_legacy_id(presence.user_id)
except XMPPError as e:
self.log.debug("Ignoring presence: %s", presence, exc_info=e)
return
contact.update_presence(presence)
@catch_all
async def on_avatar(self, room: nio.MatrixRoom, event: nio.RoomAvatarEvent):
muc = await self.__get_muc(room)
muc.avatar = event.avatar_url
@catch_all
async def on_topic(self, room: nio.MatrixRoom, event: nio.RoomTopicEvent):
muc = await self.__get_muc(room)
participant = await self.get_participant(room, event)
muc.subject = event.topic
muc.subject_setter = participant.name
muc.subject_date = server_timestamp_to_datetime(event)
@catch_all
async def on_name(self, room: nio.MatrixRoom, event: nio.RoomNameEvent):
muc = await self.__get_muc(room)
muc.name = event.name
@catch_all
async def on_sticker(self, room: nio.MatrixRoom, event: nio.StickerEvent):
participant = await self.get_participant(room, event)
resp = await self.download(event.url)
if isinstance(resp, nio.DownloadResponse):
await participant.send_files(
[LegacyAttachment(data=resp.body, caption=event.body)]
)
else:
self.log.error("Failed to download sticker: %r", resp)
@catch_all
async def on_member(self, room: nio.MatrixRoom, event: nio.RoomMemberEvent):
muc = await self.__get_muc(room)
participant = await self.get_participant(room, event)
if event.membership == "join" and participant.contact:
participant.set_affiliation_from_power_level(
room.power_levels.get_user_level(participant.contact.legacy_id)
)
elif event.membership == "leave":
if participant.is_user:
await self.session.bookmarks.remove(muc)
else:
muc.remove_participant(participant)
elif event.membership == "ban":
# TODO: handle bans in slidge core
pass
elif event.membership == "invite":
# TODO: what's that event exactly?
pass
@catch_all
async def on_typing(self, room: nio.MatrixRoom, event: nio.TypingNoticeEvent):
muc = await self.__get_muc(room)
for user_id in event.users:
participant = await muc.get_participant_by_legacy_id(user_id)
participant.composing()
@catch_all
async def on_receipt(self, room: nio.MatrixRoom, event: nio.ReceiptEvent):
muc = await self.__get_muc(room)
for receipt in event.receipts:
if receipt.receipt_type == "m.read":
participant = await muc.get_participant_by_legacy_id(receipt.user_id)
participant.displayed(receipt.event_id)
@catch_all
async def on_reaction(self, room: nio.MatrixRoom, event: nio.ReactionEvent, **kw):
self.log.debug("Reaction2")
source = event.source
msg_id = await self.get_original_id(room.room_id, event.reacts_to)
sender = source["sender"]
emoji = event.key
with self.reactions.session() as s:
await self.reactions.add(
s, room.room_id, msg_id, sender, emoji, event.event_id
)
reactions = await self.reactions.get(s, room.room_id, msg_id, sender)
s.commit()
participant = await self.get_participant(room, event)
participant.react(msg_id, reactions, **kw)
@catch_all
async def on_redact(self, room: nio.MatrixRoom, event: nio.RedactionEvent):
self.log.debug("Redaction: %s", event)
redacter = await self.get_participant(room, event)
with self.reactions.session() as s:
if reaction_target := self.reactions.remove(s, room.room_id, event.redacts):
msg_id = await self.get_original_id(room.room_id, reaction_target.event)
reactions = await self.reactions.get(
s, reaction_target.room, msg_id, event.sender
)
redacter.react(msg_id, reactions)
s.commit()
return
redacted_event = await self.get_event(room.room_id, event.redacts)
if redacted_event and event.sender == redacted_event.sender:
redacter.retract(event.redacts)
else:
redacter.moderate(event.redacts, event.reason)
async def on_power_levels(self, room: nio.MatrixRoom, event: nio.PowerLevelsEvent):
muc = await self.__get_muc(room)
for user_id, power_level in event.power_levels.users.items():
participant = await muc.get_participant_by_legacy_id(user_id)
participant.set_affiliation_from_power_level(power_level)
@alru_cache(maxsize=1000)
async def get_original_id(self, room_id: str, event_id: str) -> str:
event = await self.get_event(room_id, event_id)
if event is None:
return event_id
# no need to check recursively because replacements must refer to
# the original event
return get_replace(event.source) or event_id
@alru_cache(maxsize=100)
async def get_event(self, room_id: str, event_id: str) -> Optional[nio.Event]:
resp = await self.session.matrix.room_get_event(room_id, event_id)
if isinstance(resp, nio.RoomGetEventError):
return None
return resp.event
async def on_key_verification(
self, event: nio.KeyVerificationEvent | nio.UnknownToDeviceEvent
):
# TODO: once https://github.com/matrix-nio/matrix-nio/issues/430 is fixed, we should be able to simplify
# this by ditching UnknownToDeviceEvent
# Thanks to DomNomNom from the nio Channel,
# cf https://github.com/wreald/matrix-nio/commit/5cb8e99965bcb622101b1d
content = event.source.get("content", {})
if event.source.get("type") == "m.key.verification.request":
self.session.send_gateway_message(
"Got verification request. Waiting for other device to accept SAS method…"
)
methods = content.get("methods")
if "m.sas.v1" not in methods:
self.session.send_gateway_message(
"Received a device verification request, but other device does not support SAS authentication. "
f"Methods: {methods}."
)
return
txid = content.get("transaction_id")
ready_event = nio.ToDeviceMessage(
type="m.key.verification.ready",
recipient=event.sender,
recipient_device=content.get("from_device"),
content={
"from_device": self.device_id,
"methods": ["m.sas.v1"],
"transaction_id": txid,
},
)
resp = await self.to_device(ready_event, txid)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(f"to_device failed with {resp}")
elif isinstance(event, nio.KeyVerificationStart): # first step
if "emoji" not in event.short_authentication_string:
self.session.send_gateway_message(
"Received a device verification request, but other device does not support emoji verification "
f"{event.short_authentication_string}."
)
return
resp = await self.accept_key_verification(event.transaction_id)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(
f"accept_key_verification failed with {resp}"
)
sas = self.key_verifications.get(event.transaction_id)
if sas is None:
self.session.send_gateway_message(f"transaction_id could not be found")
return
todevice_msg = sas.share_key()
resp = await self.to_device(todevice_msg)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(f"❌ to_device failed with {resp}")
elif isinstance(event, nio.KeyVerificationCancel): # anytime
self.session.send_gateway_message(
f"Verification has been cancelled by {event.sender} "
f'for reason "{event.reason}".'
)
elif isinstance(event, nio.KeyVerificationKey): # second step
sas = self.key_verifications.get(event.transaction_id)
if sas is None:
self.session.send_gateway_message(f"transaction_id could not be found")
return
self.session.send_gateway_message(f"{sas.get_emoji()}")
yn = await self.session.input("Do the emojis match? (Y/N) (C for Cancel) ")
if yn.lower() == "y":
resp = await self.confirm_short_auth_string(event.transaction_id)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(
f"confirm_short_auth_string failed with {resp}"
)
# Extra step in new flow: once we have completed the SAS
# verification successfully, send a 'done' to-device event
# to the other device to assert that the verification was
# successful.
done_message = nio.ToDeviceMessage(
type="m.key.verification.done",
recipient=event.sender,
recipient_device=sas.other_olm_device.device_id,
content={
"transaction_id": sas.transaction_id,
},
)
resp = await self.to_device(done_message, sas.transaction_id)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(f"'done' failed with {resp}")
elif yn.lower() == "n": # no, don't match, reject
resp = await self.cancel_key_verification(
event.transaction_id, reject=True
)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(
f"cancel_key_verification failed with {resp}"
)
else: # C or anything for cancel
self.session.send_gateway_message(
"Cancelled by user! Verification will be cancelled."
)
resp = await self.cancel_key_verification(
event.transaction_id, reject=False
)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(
f"cancel_key_verification failed with {resp}"
)
elif isinstance(event, nio.KeyVerificationMac): # third step
sas = self.key_verifications.get(event.transaction_id)
if sas is None:
self.session.send_gateway_message(f"transaction_id could not be found")
return
try:
todevice_msg = sas.get_mac()
except nio.LocalProtocolError as e:
# e.g. it might have been cancelled by ourselves
self.session.send_gateway_message(
f"Cancelled or protocol error: Reason: {e}.\n"
f"Verification with {event.sender} not concluded. "
"Try again?"
)
else:
resp = await self.to_device(todevice_msg)
if isinstance(resp, nio.ToDeviceError):
self.session.send_gateway_message(f"to_device failed with {resp}")
elif event.source.get("type") == "m.key.verification.done":
# Final step, other device acknowledges verification success.
txid = content.get("transaction_id")
sas = self.key_verifications[txid]
self.session.send_gateway_message(
f"sas.we_started_it = {sas.we_started_it}\n"
f"sas.sas_accepted = {sas.sas_accepted}\n"
f"sas.canceled = {sas.canceled}\n"
f"sas.timed_out = {sas.timed_out}\n"
f"sas.verified = {sas.verified}\n"
f"sas.verified_devices = {sas.verified_devices}\n"
)
self.session.send_gateway_message("Emoji verification was successful!")
else:
self.session.send_gateway_message(
f"Received unexpected event type {type(event)}. "
f"Event is {event}. Event will be ignored."
)
matridge/matridge/reactions.py 0000664 0000000 0000000 00000016652 14777004470 0017033 0 ustar 00root root 0000000 0000000 from asyncio import Lock
from collections import namedtuple
from contextlib import contextmanager
from datetime import datetime
from typing import TYPE_CHECKING, AsyncIterator, Iterator, Literal, overload
import nio
import sqlalchemy as sa
from sqlalchemy import orm
if TYPE_CHECKING:
from matridge.matrix import Client
ReactionTarget = namedtuple("ReactionTarget", ["room", "event"])
class Base(orm.DeclarativeBase):
pass
class Room(Base):
__tablename__ = "rooms"
__table_args__ = (sa.Index("rooms_room_id", "room_id", unique=True),)
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
room_id: orm.Mapped[str] = orm.mapped_column()
messages: orm.Mapped[list["Message"]] = orm.relationship(
"Message", back_populates="room"
)
class Message(Base):
__tablename__ = "messages"
__table_args__ = (
sa.Index("messages_event_id", "room_id", "event_id", unique=True),
)
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
event_id: orm.Mapped[str] = orm.mapped_column()
added: orm.Mapped[datetime] = orm.mapped_column(default=sa.func.now())
room_id: orm.Mapped[int] = orm.mapped_column(sa.ForeignKey("rooms.id"))
room: orm.Mapped[Room] = orm.relationship("Room", back_populates="messages")
reactions: orm.Mapped[list["Reaction"]] = orm.relationship(
"Reaction", back_populates="message", cascade="all, delete-orphan"
)
class Reaction(Base):
__tablename__ = "reactions"
__table_args__ = (
sa.Index("reactions_event_id", "event_id", "message_id", unique=True),
)
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
event_id: orm.Mapped[str] = orm.mapped_column()
sender: orm.Mapped[str] = orm.mapped_column()
emoji: orm.Mapped[str] = orm.mapped_column()
message_id: orm.Mapped[int] = orm.mapped_column(sa.ForeignKey("messages.id"))
message: orm.Mapped[Message] = orm.relationship(
"Message", back_populates="reactions"
)
class ReactionCache:
"""
To avoid fetching history on each matrix reaction event, we store the
"reaction state" per message.
This is because matrix reaction events are atomic, unlike XMPP reactions
which contain the full state in each event.
"""
def __init__(self, client: "Client"):
self.matrix = client
self.log = client.session.log
@contextmanager
def session(self) -> Iterator[orm.Session]:
with Session() as session:
yield session
async def _fetch_if_needed(
self, session: orm.Session, target: ReactionTarget
) -> tuple[Message, bool]:
# we use a lock to prevent parallel calls to _fetch for the same target
if target in _locks:
del_lock = False
lock = _locks[target]
else:
del_lock = True
lock = _locks[target] = Lock()
async with lock:
room = session.scalar(sa.select(Room).filter_by(room_id=target.room))
if room is None:
room = Room(room_id=target.room)
session.add(room)
message = session.scalar(
sa.select(Message).filter_by(room=room, event_id=target.event)
)
fetch = message is None
if fetch:
message = Message(room=room, event_id=target.event)
session.add(message)
async for reaction in self._fetch(target.room, target.event):
reaction.message = message
session.add(reaction)
if del_lock:
del _locks[target]
assert message is not None
return message, fetch
async def _fetch(self, room: str, event_id: str) -> AsyncIterator[Reaction]:
self.log.debug("fetching reactions for %s", event_id)
async for event in self.matrix.room_get_event_relations(
room, event_id, nio.api.RelationshipType.annotation
):
if not isinstance(event, nio.ReactionEvent):
self.log.warning("got a non-reaction event: %s", event)
continue
if not event.reacts_to == event_id:
self.log.warning(
"request reaction on %s but got reaction on %s",
event_id,
event.reacts_to,
)
continue
yield Reaction(
event_id=event.event_id, sender=event.sender, emoji=event.key
)
async def add(
self,
session: orm.Session,
room: str,
msg: str,
sender: str,
emoji: str,
reaction_event: str,
) -> None:
target = ReactionTarget(room=room, event=msg)
message, fetched = await self._fetch_if_needed(session, target)
if fetched:
# no need to add the reaction if we fetched, because we fetched the reaction
# we want to add already
return
reaction = Reaction(
event_id=reaction_event, sender=sender, emoji=emoji, message=message
)
session.add(reaction)
@overload
async def get(
self,
session: orm.Session,
room: str,
msg: str,
sender: str,
with_event_ids: Literal[False],
) -> set[str]: ...
@overload
async def get(
self, session: orm.Session, room: str, msg: str, sender: str
) -> set[str]: ...
@overload
async def get(
self,
session: orm.Session,
room: str,
msg: str,
sender: str,
with_event_ids: Literal[True],
) -> dict[str, str]: ...
async def get(
self,
session: orm.Session,
room: str,
msg: str,
sender: str,
with_event_ids=False,
):
message, _ = await self._fetch_if_needed(
session, ReactionTarget(room=room, event=msg)
)
stmt = sa.select(Reaction).filter_by(message=message, sender=sender)
reactions = session.scalars(stmt).all()
if with_event_ids:
return {r.emoji: r.event_id for r in reactions}
else:
return set(r.emoji for r in reactions)
@staticmethod
def remove(
session: orm.Session, room_id: str, event_id: str
) -> ReactionTarget | None:
room = session.scalar(sa.select(Room).filter_by(room_id=room_id))
if room is None:
return None
stmt = (
sa.select(Reaction)
.options(orm.joinedload(Reaction.message))
.join(Reaction.message)
.filter(Message.room_id == room.id, Reaction.event_id == event_id)
)
reaction = session.scalar(stmt)
if reaction is None:
return None
session.delete(reaction)
return ReactionTarget(room=room.room_id, event=reaction.message.event_id)
def purge_old_messages(limit: int):
with Session() as session:
current_message_count = session.query(Message).count()
if current_message_count <= limit:
return
stmt = sa.delete(Message).where(
Message.id.in_(
sa.select(Message.id)
.order_by(Message.added)
.limit(current_message_count - limit)
)
)
session.execute(stmt)
session.commit()
__all__ = ("ReactionCache", "purge_old_messages")
_locks = dict[ReactionTarget, Lock]()
engine = sa.create_engine(f"sqlite:///:memory:")
Base.metadata.create_all(engine)
Session = orm.sessionmaker(engine)
matridge/matridge/session.py 0000664 0000000 0000000 00000025546 14777004470 0016531 0 ustar 00root root 0000000 0000000 import io
import json
from asyncio import Lock
from typing import Any, Iterable, Optional, Union
import aiohttp
import nio
from slidge import BaseSession, global_config
from slidge.util.types import (
LegacyMessageType,
LegacyThreadType,
LinkPreview,
Mention,
PseudoPresenceShow,
ResourceDict,
)
from slixmpp.exceptions import XMPPError
from . import config
from .contact import Contact, Roster
from .group import MUC, Bookmarks, Participant
from .matrix import Client
from .util import get_content
Sender = Union[Contact, Participant]
Recipient = Union[MUC, Contact]
class Session(BaseSession[str, Recipient]):
bookmarks: Bookmarks
contacts: Roster
matrix: Client
MESSAGE_IDS_ARE_THREAD_IDS = True
def __init__(self, *a):
super().__init__(*a)
self.events_to_ignore = set[str]()
self.migrate_shelf()
self.send_lock = Lock()
def migrate_shelf(self):
store_path = global_config.HOME_DIR / self.user_jid.bare
if not store_path.exists():
return
user = self.user
with store_path.open("r") as f:
user.legacy_module_data = json.load(f)
self.xmpp.store.users.update(user)
self.log.info(
"Credentials info transferred from %s to the slidge DB", store_path
)
store_path.unlink()
async def login(self):
f = self.user.legacy_module_data
self.matrix = Client(f["homeserver"], f["user_id"], self) # type:ignore
await self.matrix.login_token()
await self.matrix.listen()
self.contacts.user_legacy_id = self.matrix.user_id # type:ignore
return f"Logged in as {self.matrix.user}"
async def logout(self):
self.matrix.stop_listen()
async def __relates_to(
self,
room_id: str,
content: dict[str, Any],
reply_to_msg_id: Optional[str],
thread: Optional[str],
):
relates_to = dict[str, Any]()
if reply_to_msg_id:
relates_to["m.in_reply_to"] = {
"event_id": await self.matrix.get_original_id(room_id, reply_to_msg_id)
}
if thread:
relates_to["rel_type"] = "m.thread"
relates_to["event_id"] = thread
if relates_to:
content["m.relates_to"] = relates_to
async def __handle_response(self, response: nio.Response):
self.log.debug("Send response: %s", response)
if isinstance(response, nio.RoomSendError):
raise XMPPError("internal-server-error", str(response))
assert isinstance(response, nio.RoomSendResponse)
i = response.event_id
self.events_to_ignore.add(i)
return i
async def __room_send(
self, chat: MUC, content: dict, message_type="m.room.message"
):
await self.matrix.room_typing(chat.legacy_id, False)
async with self.send_lock:
response = await self.matrix.room_send(
chat.legacy_id,
message_type=message_type,
content=content,
ignore_unverified_devices=self.user.preferences.get(
"trust_everything", False
),
)
return await self.__handle_response(response)
async def on_text(
self,
chat: Recipient,
text: str,
*,
reply_to_msg_id: Optional[str] = None,
reply_to_fallback_text: Optional[str] = None,
reply_to: Optional[Sender] = None, # type: ignore
thread: Optional[str] = None, # type: ignore
link_previews: Iterable[LinkPreview] = (),
mentions: Optional[list[Mention]] = None,
) -> Optional[LegacyMessageType]:
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
content = get_content(text, mentions)
await self.__relates_to(chat.legacy_id, content, reply_to_msg_id, thread)
return await self.__room_send(chat, content)
async def on_file(
self,
chat: Recipient,
url: str,
*,
http_response: aiohttp.ClientResponse,
reply_to_msg_id: Optional[str] = None,
reply_to_fallback_text: Optional[str] = None,
reply_to: Optional[Sender] = None, # type: ignore
thread: Optional[str] = None, # type: ignore
) -> Optional[LegacyMessageType]:
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
filename = url.split("/")[-1]
content_type = http_response.content_type
resp, _ = await self.matrix.upload(
io.BytesIO(await http_response.read()),
content_type,
filename,
filesize=http_response.content_length,
)
self.log.debug("Upload response: %s %r", type(resp), resp)
if not isinstance(resp, nio.UploadResponse):
raise XMPPError("internal-server-error", str(resp))
content = {
"msgtype": "m.image" if content_type.startswith("image") else "m.file",
"body": filename,
"url": resp.content_uri,
}
await self.__relates_to(chat.legacy_id, content, reply_to_msg_id, thread)
return await self.__room_send(chat, content)
async def on_composing(
self, chat: Recipient, thread: Optional[LegacyThreadType] = None
):
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
await self.matrix.room_typing(chat.legacy_id)
async def on_paused(
self, chat: Recipient, thread: Optional[LegacyThreadType] = None
):
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
await self.matrix.room_typing(chat.legacy_id, False)
async def on_displayed(
self,
chat: Recipient,
legacy_msg_id: LegacyMessageType,
thread: Optional[LegacyThreadType] = None,
):
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
resp = await self.matrix.update_receipt_marker(chat.legacy_id, legacy_msg_id)
self.log.debug("Displayed response: %s", resp)
async def on_correct(
self,
chat: Recipient,
text: str,
legacy_msg_id: str,
*,
thread: Optional[str] = None, # type: ignore
link_previews: Iterable[LinkPreview] = (),
mentions: Optional[list[Mention]] = None,
) -> Optional[str]:
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
content = {
"msgtype": "m.text",
"body": "* " + text,
"m.new_content": get_content(text, mentions),
"m.relates_to": {"rel_type": "m.replace", "event_id": legacy_msg_id},
}
await self.__relates_to(chat.legacy_id, content, None, thread)
return await self.__room_send(chat, content)
async def on_react(
self,
chat: Recipient,
legacy_msg_id: str,
emojis: list[str],
thread: Optional[LegacyThreadType] = None,
):
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
new_emojis = set(emojis)
with self.matrix.reactions.session() as session:
old_emojis = await self.matrix.reactions.get(
session,
chat.legacy_id,
legacy_msg_id,
self.matrix.user_id,
with_event_ids=True,
)
for old_emoji, event in old_emojis.items():
if old_emoji in new_emojis:
new_emojis.remove(old_emoji)
else:
await self.on_retract(chat, event)
self.matrix.reactions.remove(session, chat.legacy_id, event)
for emoji in new_emojis:
content = {
"m.relates_to": {
"rel_type": "m.annotation",
"event_id": legacy_msg_id,
"key": emoji,
},
}
i = await self.__room_send(chat, content, "m.reaction")
await self.matrix.reactions.add(
session,
chat.legacy_id,
legacy_msg_id,
self.matrix.user_id,
emoji,
i,
)
session.commit()
async def on_retract(
self,
chat: Recipient,
legacy_msg_id: str,
thread: Optional[str] = None, # type: ignore
):
if isinstance(chat, Contact):
raise XMPPError("bad-request", "Matridge does not implement 1:1 chats")
resp = await self.matrix.room_redact(chat.legacy_id, legacy_msg_id)
self.log.debug("Redact response: %s", resp)
if isinstance(resp, nio.RoomRedactError):
raise XMPPError("internal-server-error", str(resp))
assert isinstance(resp, nio.RoomRedactResponse)
self.events_to_ignore.add(resp.event_id)
async def on_presence(
self,
resource: str,
show: PseudoPresenceShow,
status: str,
resources: dict[str, ResourceDict],
merged_resource: Optional[ResourceDict],
):
if not merged_resource:
resp = await self.matrix.set_presence("offline")
else:
resp = await self.matrix.set_presence(
PRESENCE_DICT[merged_resource["show"]],
merged_resource["status"] or None,
)
self.log.debug("Set presence response: %s", resp)
async def on_avatar(
self,
bytes_: Optional[bytes],
hash_: Optional[str],
type_: Optional[str],
width: Optional[int],
height: Optional[int],
) -> None:
if bytes_:
resp, _ = await self.matrix.upload(
io.BytesIO(bytes_), type_, filesize=len(bytes_)
)
self.log.debug("Upload response: %s %r", type(resp), resp)
if not isinstance(resp, nio.UploadResponse):
raise XMPPError("internal-server-error", str(resp))
uri = resp.content_uri
else:
uri = ""
await self.matrix.set_avatar(uri)
async def on_leave_group(
self,
muc_legacy_id: str, # type:ignore
):
resp = await self.matrix.room_leave(muc_legacy_id)
self.log.debug("Leave response: %s", resp)
# This prevents the room being re-listed when the user calls the
# "groups" command which in turn calls Bookmarks.fill().
del self.matrix.rooms[muc_legacy_id]
PRESENCE_DICT: dict[PseudoPresenceShow, str] = {
"": "online",
"chat": "online",
"away": "unavailable",
"xa": "unavailable",
"dnd": "unavailable",
}
matridge/matridge/util.py 0000664 0000000 0000000 00000016471 14777004470 0016020 0 ustar 00root root 0000000 0000000 import logging
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Optional, TypedDict
from urllib.parse import quote
import bs4
import nio
from slidge.core.mixins import MessageMixin
from slidge.util.types import LegacyAttachment, Mention, MessageReference
from slidge_style_parser import format_for_matrix
from slixmpp.exceptions import XMPPError
from . import config
if TYPE_CHECKING:
from .group import MUC
from .session import Session
class MatrixMixin(MessageMixin):
session: "Session"
muc: "MUC"
log: logging.Logger
async def __get_reply_to(self, msg: nio.RoomMessage) -> Optional[MessageReference]:
reply_to_msg_id = get_reply_to(msg.source)
if not reply_to_msg_id:
return None
reply_to = MessageReference(legacy_id=reply_to_msg_id)
if event := await self.muc.get_message(reply_to_msg_id):
self.log.debug("Get Message Event: %r", event)
try:
author = await self.muc.get_participant_by_legacy_id(event.sender)
except XMPPError as e:
# maybe deleted profiles?
self.log.debug(
"Something is wrong with participant %s, falling back to using matrix ID as nickname: %s",
event.sender,
e,
)
author = await self.muc.get_participant(event.sender)
self.log.debug("Author: %r", author)
reply_to.author = author
if isinstance(event, nio.RoomMessage):
reply_to.body = get_body(event)
return reply_to
async def __add_reply_to(self, msg: nio.RoomMessage, replace: str, kwargs: dict):
if replace is None:
kwargs["reply_to"] = await self.__get_reply_to(msg)
return
kwargs["correction"] = True
original = await self.muc.get_message(replace)
if not isinstance(original, nio.RoomMessage):
self.log.warning(
"Reply to something else than a message, or couldn't fetch it: %s",
original,
)
return
kwargs["reply_to"] = await self.__get_reply_to(original)
async def __get_attachments(self, msg: nio.RoomMessage, **kwargs):
if isinstance(msg, nio.RoomMessageMedia):
return [
LegacyAttachment(
url=await self.session.matrix.mxc_to_http(msg.url),
legacy_file_id=quote(msg.url),
name=get_body(msg) or None,
)
]
if isinstance(msg, nio.RoomEncryptedMedia):
return await self.__get_encrytped_attachments(msg)
return []
async def __get_encrytped_attachments(self, msg: nio.RoomMessage):
resp = await self.session.matrix.download(mxc=msg.url, filename=None)
if isinstance(resp, nio.DownloadError):
return []
else:
media_data = resp.body
decrypted_data = nio.crypto.attachments.decrypt_attachment(
media_data,
msg.source["content"]["file"]["key"]["k"],
msg.source["content"]["file"]["hashes"]["sha256"],
msg.source["content"]["file"]["iv"],
)
return [
LegacyAttachment(
data=bytes(decrypted_data),
legacy_file_id=quote(msg.url),
name=get_body(msg) or None,
)
]
async def send_matrix_message(
self,
msg: nio.RoomMessage,
replace=None,
replacement_event_id=None,
archive_only=False,
):
self.log.debug("Message: %s", msg.source)
if id_and_new := get_new_message(msg):
replace, new = id_and_new
return await self.send_matrix_message(
new, replace, msg.event_id, archive_only
)
kwargs = dict(
archive_only=archive_only,
when=server_timestamp_to_datetime(msg),
correction_event_id=replacement_event_id,
)
await self.__add_reply_to(msg, replace, kwargs)
attachments = await self.__get_attachments(msg, **kwargs)
await self.send_files(
attachments,
msg.event_id,
body=None if attachments else get_body(msg),
thread=get_rel(msg.source, "m.thread") or msg.event_id,
**kwargs,
)
def strip_reply_fallback(formatted_body: str) -> str:
obj = bs4.BeautifulSoup(formatted_body, "html.parser")
if mx_reply := obj.find("mx-reply"):
if isinstance(mx_reply, bs4.Tag):
mx_reply.decompose()
return str(obj.text)
def get_reply_to(source: dict) -> Optional[str]:
return (
source.get("content", {})
.get("m.relates_to", {})
.get("m.in_reply_to", {})
.get("event_id")
)
def get_replace(source: dict):
return get_rel(source, "m.replace")
def get_rel(source: dict, rel_type: str) -> Optional[str]:
content = source.get("content")
if not content:
return None
relates_to = content.get("m.relates_to")
if not relates_to:
return None
if relates_to.get("rel_type") != rel_type:
return None
return relates_to.get("event_id")
def get_new_content(source: dict) -> Optional[nio.RoomMessage]:
content = source.get("content")
if not content:
return None
new_content = content.get("m.new_content")
return new_content
def get_new_message(msg: nio.RoomMessage):
replace = get_rel(msg.source, "m.replace")
if not replace:
return
return replace, nio.RoomMessage.parse_event(
{
"content": get_new_content(msg.source),
"origin_server_ts": msg.server_timestamp,
"sender": msg.sender,
"event_id": replace,
}
)
def get_body(msg: nio.RoomMessage):
if (
isinstance(msg, nio.RoomMessageFormatted)
and msg.format == "org.matrix.custom.html"
):
relates_to = msg.source.get("content", {}).get("m.relates_to", {})
if relates_to.get("rel_type") == "m.replace" or relates_to.get("m.in_reply_to"):
body = strip_reply_fallback(msg.formatted_body)
else:
body = msg.body
else:
body = getattr(msg, "body", "")
if isinstance(msg, nio.RoomMessageEmote):
body = "/me " + body
return body
def server_timestamp_to_datetime(event: nio.Event):
return datetime.fromtimestamp(event.server_timestamp / 1000, tz=timezone.utc)
def get_content(text: str, mentions: Optional[list[Mention]] = None):
if text.startswith("/me "):
text = text.removeprefix("/me ").lstrip()
content = {"msgtype": "m.emote", "body": text}
else:
content = {"msgtype": "m.text", "body": text}
if config.PARSE_MESSAGE_STYLING:
formatted_body = format_for_matrix(
text, [(m.contact.legacy_id, m.start, m.end) for m in mentions or []]
)
content["formatted_body"] = formatted_body
content["format"] = "org.matrix.custom.html"
if mentions:
content["m.mentions"] = {
"user_ids": [m.contact.legacy_id for m in mentions] # type:ignore
}
return content
log = logging.getLogger()
class Credentials(TypedDict):
homeserver: str
user_id: str
device_id: str
access_token: str
matridge/pyproject.toml 0000664 0000000 0000000 00000011641 14777004470 0015603 0 ustar 00root root 0000000 0000000 # DO NOT EDIT
# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
[project]
name = "matridge"
description = "A Matrix/XMPP gateway"
authors = [
{name = "Nicolas Cedilnik", email = "nicoco@nicoco.fr"},
]
readme = "README.md"
license = "AGPL-3.0-or-later"
classifiers = [
"Topic :: Internet :: XMPP",
]
requires-python = ">= 3.11"
keywords = ["xmpp", "gateway", "bridge", "instant messaging", "chat", "matrix"]
dynamic = ["version"]
dependencies = [
"matrix-nio[e2e]>=0.25,<0.26",
"beautifulsoup4>=4.12.2,<5",
"async-lru>=2.0.3,<3",
"slidge-style-parser>=0.1.6",
"slidge>=0.2.5,<0.3",
]
[project.urls]
Homepage = "https://codeberg.org/slidge/matridge"
Issues = "https://codeberg.org/slidge/matridge/issues"
Repository = "https://codeberg.org/slidge/matridge"
"Chat room" = "https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr"
Documentation = "https://slidge.im/docs/matridge/main"
changelog = "https://codeberg.org/slidge/matridge/releases"
[project.scripts]
matridge = "matridge:main"
[dependency-groups]
dev = [
"furo>=2024.8.6",
"mypy>=1.14.1",
"pytest>=8.3.4",
"pytest-asyncio>=0.25.3",
"ruff>=0.9.1",
"slidge-sphinx-extensions>=0.1.0",
"sphinx-autoapi>=3.4.0",
"sphinx-mdinclude>=0.6.2",
"types-beautifulsoup4>=4.12.0.20241020",
]
[tool.pytest.ini_options]
asyncio_default_fixture_loop_scope = "session"
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"
[tool.setuptools.packages.find]
include = ["matridge"]
[tool.setuptools_scm]
# this should not be any problem and fixes compatibility with pycharm
# when installing anything (such as slidge core) in editable mode
[tool.uv]
config-settings = { editable_mode = "compat" }
[tool.uv.sources]
slidge-sphinx-extensions = { index = "codeberg" }
[[tool.uv.index]]
name = "pypi"
url = "https://pypi.org/simple"
[[tool.uv.index]]
name = "codeberg"
url = "https://codeberg.org/api/packages/slidge/pypi/simple"
publish-url = "https://codeberg.org/api/packages/slidge/pypi"
[tool.mypy]
files = ["matridge"]
exclude = [
"tests",
]
check_untyped_defs = true
strict = false
[[tool.mypy.overrides]]
module = [
"slidge_style_parser.*",
"nio.*",
]
ignore_missing_imports = true
[tool.ruff]
line-length = 88
exclude = [
"tests",
]
[tool.ruff.lint]
select = ["I"]
[tool.git-cliff.remote.gitea]
owner = "slidge"
repo = "matridge"
[tool.git-cliff.changelog]
header = """
# Changes
"""
body = """
{% for group, all_commits in commits | group_by(attribute="group") %}
{%- if group == "cfix" %}{% continue %}{%- endif %}
## {{ group | striptags | trim | upper_first }}
{% for commit in all_commits %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | split(pat="\n") | first | upper_first | trim }} \
([`{{ commit.id | truncate(length=7, end="") }}`](./commit/{{ commit.id -}})\
{% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
{%- for cfix_commit in commits | filter(attribute="group", value="cfix") -%}
{%- if cfix_commit.scope and commit.id is starting_with(cfix_commit.scope) -%}
, [`{{ cfix_commit.id | truncate(length=7, end="") }}`](./commit/{{ cfix_commit.id }}){% if cfix_commit.remote.username %} by @{{ cfix_commit.remote.username }}{%- endif -%}
{%- endif -%}
{%- endfor -%})\
{% endfor %}
{% endfor %}\n
"""
footer = """
"""
[tool.git-cliff.git]
conventional_commits = true
filter_unconventional = false
commit_parsers = [
{ message = "^feat", group = "🚀 Features" },
{ message = "^imprv", group = "✨ Improvements" },
{ message = "^fix", group = "🐛 Bug Fixes" },
{ message = "^compat", group = "💑 Compatibility" },
{ message = "^refactor", group = "🚜 Refactor" },
{ message = "^doc", group = "📚 Documentation" },
{ message = "^perf", group = "⚡ Performance" },
{ message = "^style", group = "🎨 Styling" },
{ message = "^test", group = "🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^build\\(lockfile\\)", skip = true },
{ message = "^chore\\(lockfile\\)", skip = true },
{ message = "^chore|^ci", group = "⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "🛡️ Security" },
{ message = "^revert", group = "◀️ Revert" },
{ message = "^cfix", group = "cfix" },
{ message = ".*", group = "💼 Other" },
]
matridge/tests/ 0000775 0000000 0000000 00000000000 14777004470 0014026 5 ustar 00root root 0000000 0000000 matridge/tests/test_base.py 0000664 0000000 0000000 00000000337 14777004470 0016354 0 ustar 00root root 0000000 0000000 from slidge.util.test import SlidgeTest
import matridge
class TestMatridge(SlidgeTest):
def test_base(self):
self.recv("")
reply = self.next_sent()
assert reply["type"] == "error"
matridge/tests/test_conversion.py 0000664 0000000 0000000 00000013203 14777004470 0017623 0 ustar 00root root 0000000 0000000 import nio
from matridge.util import strip_reply_fallback, get_body
def test_reply_to():
reply = {
"content": {
"body": "> dddd\n\n * for update a list of users i modified the updategroupparticipants functions",
"format": "org.matrix.custom.html",
"formatted_body": '
* for update a list of users i modified the updategroupparticipants functions",
"m.new_content": {
"body": "for update a list of users i modified the updategroupparticipants functions",
"format": "org.matrix.custom.html",
"formatted_body": "for update a list of users i modified the updategroupparticipants functions",
"msgtype": "m.text",
},
"m.relates_to": {
"event_id": "asdasda",
"rel_type": "m.replace",
},
"msgtype": "m.text",
},
"origin_server_ts": 1688997470785,
"sender": "@asdasd:matrix.org",
"type": "m.room.message",
"unsigned": {"age": 75665575},
"event_id": "asdasd",
"room_id": "!whatsmeow-v9:maunium.net",
}
event = nio.Event.parse_event(reply)
assert (
get_body(event)
== " * for update a list of users i modified the updategroupparticipants functions"
)
reply = {
"content": {
"body": "> <@nicocool:matrix.org> asdfasdf\n\nsadfsadf",
"format": "org.matrix.custom.html",
"formatted_body": '