megatwitter (v2)

.editorconfig

@@ -8,11 +8,8 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.py]
-max_line_length = 99
-
-[*.{yaml,yml,py}]
+[*.{yaml,yml,sql}]
 indent_style = space
 
-[{.gitlab-ci.yml,.pre-commit-config.yaml}]
+[{.gitlab-ci.yml,.github/workflows/*.yml}]
 indent_size = 2

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,14 @@
+---
+name: Bug report
+about: If something is definitely wrong in the bridge (rather than just a setup issue),
+  file a bug report. Remember to include relevant logs.
+labels: bug
+
+---
+
+<!--
+Remember to include relevant logs, the bridge version and any other details.
+
+If you aren't sure what's needed, ask in the Matrix room rather than opening an
+incomplete issue. Issues with insufficient detail will likely just be ignored.
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Troubleshooting docs & FAQ
+    url: https://docs.mau.fi/bridges/general/troubleshooting.html
+    about: Check this first if you're having problems setting up the bridge.
+  - name: Support room
+    url: https://matrix.to/#/#twitter:maunium.net
+    about: For setup issues not answered by the troubleshooting docs, ask in the Matrix room.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,6 @@
+---
+name: Enhancement request
+about: Submit a feature request or other suggestion
+labels: enhancement
+
+---

.github/workflows/go.yml

@@ -0,0 +1,36 @@
+name: Go
+
+on: [push, pull_request]
+
+env:
+  GOTOOLCHAIN: local
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: ["1.22", "1.23"]
+    name: Lint ${{ matrix.go-version == '1.23' && '(latest)' || '(old)' }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+
+      - name: Install libolm
+        run: sudo apt-get install libolm-dev libolm3
+
+      - name: Install dependencies
+        run: |
+          go install golang.org/x/tools/cmd/goimports@latest
+          go install honnef.co/go/tools/cmd/staticcheck@latest
+          export PATH="$HOME/go/bin:$PATH"
+
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]

.github/workflows/stale.yml

@@ -0,0 +1,29 @@
+name: 'Lock old issues'
+
+on:
+  schedule:
+    - cron: '0 18 * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+#  pull-requests: write
+#  discussions: write
+
+concurrency:
+  group: lock-threads
+
+jobs:
+  lock-stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v5
+        id: lock
+        with:
+          issue-inactive-days: 90
+          process-only: issues
+      - name: Log processed threads
+        run: |
+          if [ '${{ steps.lock.outputs.issues }}' ]; then
+            echo "Issues:" && echo '${{ steps.lock.outputs.issues }}' | jq -r '.[] | "https://github.com/\(.owner)/\(.repo)/issues/\(.issue_number)"'
+          fi

.gitignore

@@ -1,19 +1,8 @@
-/.idea/
-
-/.venv
-/env/
-pip-selfcheck.json
-*.pyc
-__pycache__
-/build
-/dist
-/*.egg-info
-/.eggs
+./mautrix-twitter
+logs/
+*.db*
+*.yaml
+!example-config.yaml
+!.pre-commit-config.yaml
 /start
-
-/config.yaml
-/registration.yaml
-*.log*
-*.db
-*.pickle
-*.bak
+/pkg/mautrix

.gitlab-ci.yml

@@ -1,3 +1,3 @@
 include:
 - project: 'mautrix/ci'
-  file: '/python.yml'
+  file: '/gov2-as-default.yml'

.pre-commit-config.yaml

@@ -1,20 +1,28 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
         exclude_types: [markdown]
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-added-large-files
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
+
+  - repo: https://github.com/tekwizely/pre-commit-golang
+    rev: v1.0.0-rc.1
     hooks:
-      - id: black
-        language_version: python3
-        files: ^(mautwitdm|mautrix_twitter)/.*\.pyi?$
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+      - id: go-imports-repo
+        args:
+          - "-local"
+          - "go.mau.fi/mautrix-twitter"
+          - "-w"
+      - id: go-vet-repo-mod
+      - id: go-staticcheck-repo-mod
+      - id: go-mod-tidy
+
+  - repo: https://github.com/beeper/pre-commit-go
+    rev: v0.3.1
     hooks:
-      - id: isort
-        files: ^(mautwitdm|mautrix_twitter)/.*\.pyi?$
+      - id: zerolog-ban-msgf
+      - id: zerolog-use-stringer
+      - id: prevent-literal-http-methods

Dockerfile.ci

@@ -0,0 +1,15 @@
+FROM alpine:3.20
+
+ENV UID=1337 \
+    GID=1337
+
+RUN apk add --no-cache ffmpeg su-exec ca-certificates bash jq curl yq-go
+
+ARG EXECUTABLE=./mautrix-twitter
+COPY $EXECUTABLE /usr/bin/mautrix-twitter
+COPY ./docker-run.sh /docker-run.sh
+ENV BRIDGEV2=1
+VOLUME /data
+WORKDIR /data
+
+CMD ["/docker-run.sh"]

LICENSE.exceptions

@@ -0,0 +1,12 @@
+The mautrix-twitter developers grant the following special exceptions:
+
+* to Beeper the right to embed the program in the Beeper clients and servers,
+  and use and distribute the collective work without applying the license to
+  the whole.
+* to Element the right to distribute compiled binaries of the program as a part
+  of the Element Server Suite and other server bundles without applying the
+  license.
+
+All exceptions are only valid under the condition that any modifications to
+the source code of mautrix-twitter remain publicly available under the terms
+of the GNU AGPL version 3 or later.

ROADMAP.md

@@ -1,41 +1,37 @@
 # Features & roadmap
 
 * Matrix → Twitter
-  * [ ] Message content
+  * [x] Message content
     * [x] Text
-    * [ ] Formatting
-    * [ ] Media
+    * [ ] ~~Formatting~~ (not supported by Twitter)
+    * [x] Media
       * [x] Images
       * [x] Videos
       * [x] Gifs
   * [x] Message reactions
-  * [ ] Typing notifications
+  * [x] Typing notifications
   * [x] Read receipts
 * Twitter → Matrix
-  * [ ] Message content
+  * [x] Message content
     * [x] Text
-    * [ ] Formatting
+    * [ ] ~~Formatting~~ (not supported by Twitter)
     * [x] Media
       * [x] Images
       * [x] Videos
       * [x] Gifs
   * [x] Message reactions
-  * [x] Message history
-    * [x] When creating portal
-    * [x] Missed messages
+  * [ ] Message history
+    * [ ] When creating portal
+    * [ ] Missed messages
   * [x] Avatars
   * [ ] † Typing notifications
   * [ ] † Read receipts
 * Misc
   * [x] Automatic portal creation
-    * [x] At startup
+    * [ ] At startup
     * [x] When receiving invite or message
-  * [x] Provisioning API for logging in
   * [ ] Private chat creation by inviting Matrix puppet of Twitter user to new room
   * [ ] Option to use own Matrix account for messages sent from other Twitter clients
-    * [x] Automatic login with shared secret
-    * [ ] Manual login with `login-matrix`
-  * [x] E2EE in Matrix rooms
+  * [ ] E2EE in Matrix rooms
 
-† Information not automatically sent from source, i.e. implementation may not be possible
-‡ Maybe, i.e. this feature may or may not be implemented at some point
+† Implementation is impossible / really difficult  at the current state of the mautrix-go framework

build.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+MAUTRIX_VERSION=$(cat go.mod | grep 'maunium.net/go/mautrix ' | awk '{ print $2 }' | head -n1)
+GO_LDFLAGS="-s -w -X main.Tag=$(git describe --exact-match --tags 2>/dev/null) -X main.Commit=$(git rev-parse HEAD) -X 'main.BuildTime=`date -Iseconds`' -X 'maunium.net/go/mautrix.GoModVersion=$MAUTRIX_VERSION'"
+go build -ldflags="$GO_LDFLAGS" ./cmd/mautrix-twitter "$@"

cmd/mautrix-twitter/legacymigrate.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	_ "embed"
+
+	up "go.mau.fi/util/configupgrade"
+	"maunium.net/go/mautrix/bridgev2/bridgeconfig"
+)
+
+const legacyMigrateRenameTables = `
+ALTER TABLE portal RENAME TO portal_old;
+ALTER TABLE puppet RENAME TO puppet_old;
+ALTER TABLE message RENAME TO message_old;
+ALTER TABLE reaction RENAME TO reaction_old;
+ALTER TABLE "user" RENAME TO user_old;
+`
+
+//go:embed legacymigrate.sql
+var legacyMigrateCopyData string
+
+func migrateLegacyConfig(helper up.Helper) {
+	helper.Set(up.Str, "mautrix.bridge.e2ee", "encryption", "pickle_key")
+	bridgeconfig.CopyToOtherLocation(helper, up.Int, []string{"bridge", "displayname_max_length"}, []string{"network", "displayname_max_length"})
+}