Compare commits

..

30 commits

Author SHA1 Message Date
Tulir Asokan
b771b79b91 Install aiodns and brotli in Docker image to speed up aiohttp
Some checks failed
Python lint / lint (push) Has been cancelled
2025-08-27 20:45:19 +03:00
Tulir Asokan
87bb7fc854 Also allow setting extra content in send_markdown
Some checks failed
Python lint / lint (push) Has been cancelled
2025-08-26 12:01:36 +03:00
Tulir Asokan
94c4e5aaaf Allow specifying extra content in reply/respond
Some checks are pending
Python lint / lint (push) Waiting to run
2025-08-26 11:59:22 +03:00
Tulir Asokan
beaba079ca Update Alpine and Node 2025-08-20 10:26:10 +03:00
Tulir Asokan
905c91c285 Fix default value for profile when creating client
Some checks failed
Python lint / lint (push) Has been cancelled
2025-08-19 12:28:11 +03:00
Tulir Asokan
93e0ebd24e Catch errors when updating profile from server 2025-08-19 12:25:03 +03:00
Tulir Asokan
ff19278d24 Update mautrix-python
Some checks failed
Python lint / lint (push) Has been cancelled
2025-08-12 10:12:00 +03:00
Tulir Asokan
43a14513f0 Update mautrix-python again
Some checks are pending
Python lint / lint (push) Waiting to run
2025-08-11 22:50:25 +03:00
Tulir Asokan
97dc989394 Check creator power when following tombstones 2025-08-11 22:28:30 +03:00
Tulir Asokan
4c01a49310 Don't cut off body if there's nothing there
Some checks failed
Python lint / lint (push) Has been cancelled
2025-08-09 22:00:29 +03:00
Tulir Asokan
a4a39b7f90 Clarify what ui_base_path does
[skip ci]
2025-08-08 19:55:10 +03:00
Tulir Asokan
10383d526f Ignore tombstones with non-empty state key 2025-05-14 17:18:18 +03:00
Tulir Asokan
ac3f0c34cc Reduce limit when plaintext body is cut off 2025-05-14 17:18:02 +03:00
Tulir Asokan
9109047ef2 Bump version to 0.5.2 2025-05-06 00:10:47 +03:00
Tulir Asokan
59cfff99f1 Adjust log 2025-05-05 01:29:43 +03:00
Tulir Asokan
80b65d6a2f Improve tombstone handling 2025-05-05 00:59:20 +03:00
Tulir Asokan
f0ade0a043 Clarify type of admins map
[skip ci]
2025-05-04 00:43:44 +03:00
Tulir Asokan
fe4d2f02bb Fix clearing PluginWebApp
Fixes #233
2025-01-28 16:56:16 +02:00
Tulir Asokan
c09eb195f8 Add comment 2025-01-28 16:56:16 +02:00
Binesh Bannerjee
094e1eca35
Fix autojoin and online flags not being applied if set during client creation (#258) 2025-01-22 20:10:39 +02:00
Tulir Asokan
c3458eab58 Bump version to 0.5.1 2025-01-03 12:40:46 +02:00
Tulir Asokan
6c7d0754f8 Add Python 3.13 to classifiers 2025-01-03 12:32:04 +02:00
Tulir Asokan
01b5f53d90 Update Alpine and Node 2025-01-03 12:31:01 +02:00
Tulir Asokan
813fee7a2c Update linters 2025-01-03 12:26:51 +02:00
Tulir Asokan
46aed7e1d2 Relax asyncpg and aiosqlite version requirement 2025-01-03 12:26:25 +02:00
nexy7574
48cc00f591
Update asyncpg dependency to fix python 3.13 support (#256) 2025-01-02 11:18:06 +02:00
Tulir Asokan
bceacb97a0 Cut off plaintext body if the event is too long 2024-10-04 00:59:39 +03:00
Dominik Rimpf
dd58135c94
Update media endpoints in management frontend (#253) 2024-10-04 00:59:34 +03:00
Tulir Asokan
472fb9f6ac Remove outdated comment
[skip ci]
2024-09-08 00:58:55 +03:00
jkhsjdhjs
65be63fdd2
Fix PluginWebApp base path handling (#240)
Previously, the webapp handler would match without respect to the trailing slash, e.g. matching "foo"
for "foo2". This behavior is changed to respect the trailing slash.

Fixes #239
2024-08-24 18:47:24 +03:00
18 changed files with 121 additions and 33 deletions

View file

@ -9,14 +9,14 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
python-version: "3.13"
- uses: isort/isort-action@master
with:
sortPaths: "./maubot"
- uses: psf/black@stable
with:
src: "./maubot"
version: "24.2.0"
version: "24.10.0"
- name: pre-commit
run: |
pip install pre-commit

View file

@ -10,7 +10,7 @@ default:
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
build frontend:
image: node:20-alpine
image: node:24-alpine
stage: build frontend
before_script: []
variables:

View file

@ -1,6 +1,6 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
rev: v5.0.0
hooks:
- id: trailing-whitespace
exclude_types: [markdown]
@ -8,7 +8,7 @@ repos:
- id: check-yaml
- id: check-added-large-files
- repo: https://github.com/psf/black
rev: 24.2.0
rev: 24.10.0
hooks:
- id: black
language_version: python3

View file

@ -1,3 +1,30 @@
# v0.5.2 (2025-05-05)
* Improved tombstone handling to ensure that the tombstone sender has
permissions to invite users to the target room.
* Fixed autojoin and online flags not being applied if set during client
creation (thanks to [@bnsh] in [#258]).
* Fixed plugin web apps not being cleared properly when unloading plugins.
[@bnsh]: https://github.com/bnsh
[#258]: https://github.com/maubot/maubot/pull/258
# v0.5.1 (2025-01-03)
* Updated Docker image to Alpine 3.21.
* Updated media upload/download endpoints in management frontend
(thanks to [@domrim] in [#253]).
* Fixed plugin web app base path not including a trailing slash
(thanks to [@jkhsjdhjs] in [#240]).
* Changed markdown parsing to cut off plaintext body if necessary to allow
longer formatted messages.
* Updated dependencies to fix Python 3.13 compatibility.
[@domrim]: https://github.com/domrim
[@jkhsjdhjs]: https://github.com/jkhsjdhjs
[#253]: https://github.com/maubot/maubot/pull/253
[#240]: https://github.com/maubot/maubot/pull/240
# v0.5.0 (2024-08-24)
* Dropped Python 3.9 support.

View file

@ -1,9 +1,9 @@
FROM node:20 AS frontend-builder
FROM node:24 AS frontend-builder
COPY ./maubot/management/frontend /frontend
RUN cd /frontend && yarn --prod && yarn build
FROM alpine:3.20
FROM alpine:3.22
RUN apk add --no-cache \
python3 py3-pip py3-setuptools py3-wheel \
@ -11,6 +11,8 @@ RUN apk add --no-cache \
su-exec \
yq \
py3-aiohttp \
py3-aiodns \
py3-brotli \
py3-attrs \
py3-bcrypt \
py3-cffi \

View file

@ -1,4 +1,4 @@
FROM alpine:3.20
FROM alpine:3.22
RUN apk add --no-cache \
python3 py3-pip py3-setuptools py3-wheel \

View file

@ -1 +1 @@
__version__ = "0.5.0"
__version__ = "0.5.2"

View file

@ -350,11 +350,41 @@ class Client(DBClient):
}
async def _handle_tombstone(self, evt: StateEvent) -> None:
if evt.state_key != "":
return
if not evt.content.replacement_room:
self.log.info(f"{evt.room_id} tombstoned with no replacement, ignoring")
return
is_joined = await self.client.state_store.is_joined(
evt.content.replacement_room,
self.client.mxid,
)
if is_joined:
self.log.debug(
f"Ignoring tombstone from {evt.room_id} to {evt.content.replacement_room} "
f"sent by {evt.sender}: already joined to replacement room"
)
return
self.log.debug(
f"Following tombstone from {evt.room_id} to {evt.content.replacement_room} "
f"sent by {evt.sender}"
)
_, server = self.client.parse_user_id(evt.sender)
await self.client.join_room(evt.content.replacement_room, servers=[server])
room_id = await self.client.join_room(evt.content.replacement_room, servers=[server])
power_levels = await self.client.get_state_event(room_id, EventType.ROOM_POWER_LEVELS)
create_event = await self.client.get_state_event(
room_id, EventType.ROOM_CREATE, format="event"
)
if power_levels.get_user_level(evt.sender, create_event) < power_levels.invite:
self.log.warning(
f"{evt.room_id} was tombstoned into {room_id} by {evt.sender},"
" but the sender doesn't have invite power levels, leaving..."
)
await self.client.leave_room(
room_id,
f"Followed tombstone from {evt.room_id} by {evt.sender},"
" but sender doesn't have sufficient power level for invites",
)
async def _handle_invite(self, evt: StrippedStateEvent) -> None:
if evt.state_key == self.id and evt.content.membership == Membership.INVITE:
@ -474,8 +504,14 @@ class Client(DBClient):
self.start_sync()
async def _update_remote_profile(self) -> None:
profile = await self.client.get_profile(self.id)
self.remote_displayname, self.remote_avatar_url = profile.displayname, profile.avatar_url
try:
profile = await self.client.get_profile(self.id)
self.remote_displayname, self.remote_avatar_url = (
profile.displayname,
profile.avatar_url,
)
except Exception:
self.log.warning("Failed to update own profile from server", exc_info=True)
async def delete(self) -> None:
try:

View file

@ -1,5 +1,4 @@
# The full URI to the database. SQLite and Postgres are fully supported.
# Other DBMSes supported by SQLAlchemy may or may not work.
# Format examples:
# SQLite: sqlite:filename.db
# Postgres: postgresql://username:password@hostname/dbname
@ -55,7 +54,8 @@ server:
port: 29316
# Public base URL where the server is visible.
public_url: https://example.com
# The base path for the UI.
# The base path for the UI. Note that this does not change the API path.
# Add a path prefix to public_url if you want everything on a subpath.
ui_base_path: /_matrix/maubot
# The base path for plugin endpoints. The instance ID will be appended directly.
plugin_base_path: /_matrix/maubot/plugin/
@ -79,8 +79,9 @@ homeservers:
# When this is empty, `mbc auth --register` won't work, but `mbc auth` (login) will.
secret: null
# List of administrator users. Plaintext passwords will be bcrypted on startup. Set empty password
# to prevent normal login. Root is a special user that can't have a password and will always exist.
# List of administrator users. Each key is a username and the value is the password.
# Plaintext passwords will be bcrypted on startup. Set empty password to prevent normal login.
# Root is a special user that can't have a password and will always exist.
admins:
root: ""

View file

@ -78,8 +78,8 @@ async def _create_client(user_id: UserID | None, data: dict) -> web.Response:
)
client.enabled = data.get("enabled", True)
client.sync = data.get("sync", True)
client.autojoin = data.get("autojoin", True)
client.online = data.get("online", True)
await client.update_autojoin(data.get("autojoin", True), save=False)
await client.update_online(data.get("online", True), save=False)
client.displayname = data.get("displayname", "disable")
client.avatar_url = data.get("avatar_url", "disable")
await client.update()

View file

@ -205,7 +205,7 @@ export const getClients = () => defaultGet("/clients")
export const getClient = id => defaultGet(`/clients/${id}`)
export async function uploadAvatar(id, data, mime) {
const resp = await fetch(`${BASE_PATH}/proxy/${id}/_matrix/media/r0/upload`, {
const resp = await fetch(`${BASE_PATH}/proxy/${id}/_matrix/media/v3/upload`, {
headers: getHeaders(mime),
body: data,
method: "POST",
@ -217,8 +217,9 @@ export function getAvatarURL({ id, avatar_url }) {
if (!avatar_url?.startsWith("mxc://")) {
return null
}
avatar_url = avatar_url.substr("mxc://".length)
return `${BASE_PATH}/proxy/${id}/_matrix/media/r0/download/${avatar_url}?access_token=${
avatar_url = avatar_url.substring("mxc://".length)
// Note: the maubot backend will replace the query param with an authorization header
return `${BASE_PATH}/proxy/${id}/_matrix/client/v1/media/download/${avatar_url}?access_token=${
localStorage.accessToken}`
}

View file

@ -70,9 +70,9 @@ class Client extends BaseMainView {
get initialState() {
return {
id: "",
displayname: "",
displayname: "disable",
homeserver: "",
avatar_url: "",
avatar_url: "disable",
access_token: "",
device_id: "",
fingerprint: null,

View file

@ -15,7 +15,7 @@
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import Awaitable
from typing import Any, Awaitable
from html import escape
import asyncio
@ -62,7 +62,10 @@ async def parse_formatted(
html = message
else:
return message, escape(message)
return (await MaubotHTMLParser().parse(html)).text, html
text = (await MaubotHTMLParser().parse(html)).text
if len(text) > 100 and len(text) + len(html) > 40000:
text = text[:100] + "[long message cut off]"
return text, html
class MaubotMessageEvent(MessageEvent):
@ -85,6 +88,7 @@ class MaubotMessageEvent(MessageEvent):
reply: bool | str = False,
in_thread: bool | None = None,
edits: EventID | MessageEvent | None = None,
extra_content: dict[str, Any] | None = None,
) -> EventID:
"""
Respond to the message.
@ -104,6 +108,7 @@ class MaubotMessageEvent(MessageEvent):
the root if necessary.
edits: An event ID or MessageEvent to edit. If set, the reply and in_thread parameters
are ignored, as edits can't change the reply or thread status.
extra_content: Extra content to add to the event.
Returns:
The ID of the response event.
@ -140,6 +145,9 @@ class MaubotMessageEvent(MessageEvent):
)
else:
content.set_reply(self)
if extra_content:
for k, v in extra_content.items():
content[k] = v
return await self.client.send_message_event(self.room_id, event_type, content)
def reply(
@ -149,6 +157,7 @@ class MaubotMessageEvent(MessageEvent):
markdown: bool = True,
allow_html: bool = False,
in_thread: bool | None = None,
extra_content: dict[str, Any] | None = None,
) -> Awaitable[EventID]:
"""
Reply to the message. The parameters are the same as :meth:`respond`,
@ -166,6 +175,7 @@ class MaubotMessageEvent(MessageEvent):
thread. If set to ``False``, the response will never be in a thread. If set to
``True``, the response will always be in a thread, creating one with this event as
the root if necessary.
extra_content: Extra content to add to the event.
Returns:
The ID of the response event.
@ -177,6 +187,7 @@ class MaubotMessageEvent(MessageEvent):
reply=True,
in_thread=in_thread,
allow_html=allow_html,
extra_content=extra_content,
)
def mark_read(self) -> Awaitable[None]:
@ -253,14 +264,18 @@ class MaubotMatrixClient(MatrixClient):
markdown: str,
*,
allow_html: bool = False,
render_markdown: bool = True,
msgtype: MessageType = MessageType.TEXT,
edits: EventID | MessageEvent | None = None,
relates_to: RelatesTo | None = None,
extra_content: dict[str, Any] = None,
**kwargs,
) -> EventID:
content = TextMessageEventContent(msgtype=msgtype, format=Format.HTML)
content.body, content.formatted_body = await parse_formatted(
markdown, allow_html=allow_html
markdown,
allow_html=allow_html,
render_markdown=render_markdown,
)
if relates_to:
if edits:
@ -268,6 +283,9 @@ class MaubotMatrixClient(MatrixClient):
content.relates_to = relates_to
elif edits:
content.set_edit(edits)
if extra_content:
for k, v in extra_content.items():
content[k] = v
return await self.send_message(room_id, content, **kwargs)
def dispatch_event(self, event: Event, source: SyncStream) -> list[asyncio.Task]:

View file

@ -40,6 +40,8 @@ class PluginWebApp(web.UrlDispatcher):
self._resources = []
self._named_resources = {}
self._middleware = []
self._resource_index = {}
self._matched_sub_app_resources = []
async def handle(self, request: web.Request) -> web.StreamResponse:
match_info = await self.resolve(request)

View file

@ -64,14 +64,14 @@ class MaubotServer:
if request.path.startswith(path):
request = request.clone(
rel_url=request.rel_url.with_path(
request.rel_url.path[len(path) :]
request.rel_url.path[len(path) - 1 :]
).with_query(request.query_string)
)
return await app.handle(request)
return web.Response(status=404)
def get_instance_subapp(self, instance_id: str) -> tuple[PluginWebApp, str]:
subpath = self.config["server.plugin_base_path"] + instance_id
subpath = self.config["server.plugin_base_path"] + instance_id + "/"
url = self.config["server.public_url"] + subpath
try:
return self.plugin_routes[subpath], url
@ -82,7 +82,7 @@ class MaubotServer:
def remove_instance_webapp(self, instance_id: str) -> None:
try:
subpath = self.config["server.plugin_base_path"] + instance_id
subpath = self.config["server.plugin_base_path"] + instance_id + "/"
self.plugin_routes.pop(subpath).clear()
except KeyError:
return

View file

@ -1,4 +1,4 @@
FROM docker.io/alpine:3.20
FROM docker.io/alpine:3.21
RUN apk add --no-cache \
python3 py3-pip py3-setuptools py3-wheel \

View file

@ -1,8 +1,8 @@
mautrix>=0.20.6,<0.21
mautrix>=0.20.9rc3,<0.21
aiohttp>=3,<4
yarl>=1,<2
asyncpg>=0.20,<0.30
aiosqlite>=0.16,<0.21
asyncpg>=0.20,<1
aiosqlite>=0.16,<1
commonmark>=0.9,<1
ruamel.yaml>=0.15.35,<0.19
attrs>=18.1.0

View file

@ -53,6 +53,7 @@ setuptools.setup(
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
],
entry_points="""
[console_scripts]