path: root/gnu/packages/matrix.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2020 Alex ter Weele <alex.ter.weele@gmail.com>
;;; Copyright © 2020 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2020, 2021, 2022 Michael Rohleder <mike@rohleder.de>
;;; Copyright © 2020 Giacomo Leidi <therewasa@fishinthecalculator.me>
;;; Copyright © 2022 Aleksandr Vityazev <avityazev@posteo.org>
;;; Copyright © 2022 Morgan Smith <Morgan.J.Smith@outlook.com>
;;; Copyright © 2023 Miguel Ángel Moreno <mail@migalmoreno.com>
;;; Copyright © 2023 conses <contact@conses.eu>
;;; Copyright © 2025 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2025 Arjan Adriaanse <arjan@adriaan.se>
;;; Copyright © 2025 Sharlatan Hellseher <sharlatanus@gmail.com>
;;; Copyright © 2026 Zheng Junjie <z572@z572.online>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix 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 General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages matrix)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (gnu packages base)
  #:use-module (gnu packages check)
  #:use-module (gnu packages crypto)
  #:use-module (gnu packages databases)
  #:use-module (gnu packages glib)
  #:use-module (gnu packages golang)
  #:use-module (gnu packages golang-build)
  #:use-module (gnu packages golang-crypto)
  #:use-module (gnu packages golang-web)
  #:use-module (gnu packages golang-xyz)
  #:use-module (gnu packages monitoring)
  #:use-module (gnu packages python-build)
  #:use-module (gnu packages python-check)
  #:use-module (gnu packages python-crypto)
  #:use-module (gnu packages python-web)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages rust)
  #:use-module (gnu packages tls)
  #:use-module (gnu packages xml)
  #:use-module (guix build-system cargo)
  #:use-module (guix build-system go)
  #:use-module (guix build-system pyproject)
  #:use-module (guix download)
  #:use-module (guix gexp)
  #:use-module (guix git-download)
  #:use-module (guix packages))

(define-public mautrix-whatsapp
  (package
    (name "mautrix-whatsapp")
    (version "0.11.2")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/mautrix/whatsapp")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0wn9kldhh865w5mbg3cl61m0db9nr7zl1j8lqs2dixsaihv1lbnx"))))
    (build-system go-build-system)
    (arguments
     (list
      #:install-source? #f
      #:tests? #f ; no tests provided
      #:import-path "go.mau.fi/mautrix-whatsapp/cmd/mautrix-whatsapp"
      #:unpack-path "go.mau.fi/mautrix-whatsapp"
      #:build-flags
      #~(list (string-append "-ldflags=-X main.Tag=" #$version))
      #:embed-files
      #~(list
         ;; go.mau.fi/whatsmeow/proto/<...> pattern <...>.pb.raw: cannot embed
         ;; irregular file <...>.pb.raw
         ".*\\.pb\\.raw$"
         ;; maunium.net/go/mautrix/bridgev2/database/upgrades/upgrades.go
         ;; maunium.net/go/mautrix/crypto/sql_store_upgrade/upgrade.go
         ;; maunium.net/go/mautrix/sqlstatestore/statestore.go
         ;;
         ;; pattern *.sql: cannot embed irregular file <...>.sql
         ".*\\.sql"
         ;; golang.org/x/net/publicsuffix/table.go:63:12: pattern
         ;; data/children: cannot embed irregular file data/children
         "children"
         ;; golang.org/x/net/publicsuffix/table.go:48:12: pattern data/nodes:
         ;; cannot embed irregular file data/nodes
         "nodes"
         ;; golang.org/x/net/publicsuffix/table.go:33:12: pattern data/text:
         ;; cannot embed irregular file data/text
         "text"
         ;; maunium.net/go/mautrix/bridgev2/matrix/mxmain/config.go:17:12:
         ;; pattern example-config.yaml: cannot embed irregular file
         ;; example-config.yaml
         "example-config\\.yaml"
         ;; go.mau.fi/webp/webp.go:14:12: pattern internal: cannot embed
         ;; directory internal: contains no embeddable files
         ".*\\.c"
         ".*\\.h")))
    (native-inputs
     (list olm
           go-github-com-gorilla-mux
           go-github-com-gorilla-websocket
           go-github-com-lib-pq
           go-github-com-rs-zerolog
           go-go-mau-fi-util
           go-go-mau-fi-webp
           go-go-mau-fi-whatsmeow
           go-golang-org-x-exp
           go-golang-org-x-image
           go-golang-org-x-net
           go-golang-org-x-sync
           go-google-golang-org-protobuf
           go-gopkg-in-yaml-v3
           go-maunium-net-go-mautrix))
    (home-page "https://go.mau.fi/mautrix-whatsapp")
    (synopsis "Matrix <-> WhatsApp puppeting bridge")
    (description
     "This package provides a @code{Matrix<->WhatsApp} puppeting bridge based
on @url{https://github.com/tulir/whatsmeow, whatsmeow}.")
    (license license:agpl3+)))

(define-public pantalaimon
  (package
    (name "pantalaimon")
    (version "0.10.6")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/matrix-org/pantalaimon")
              (commit version)))
       (file-name (git-file-name name version))
       (sha256
        (base32 "07cf5k0b1i5pfplmx2p5l3ba76jjfzzcky9ylj7593k7nrm5drl3"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      #:test-flags
      #~(list "tests"
              ;; These tests hang.
              "--ignore=tests/proxy_test.py"
              "-k" "not test_start_loop")
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'create-pytest-ini
            (lambda _
              (call-with-output-file "pytest.ini"
                (lambda (port)
                  (format port "[pytest]
asyncio_mode = auto")))))
          (add-after 'unpack 'relax-requirements
            (lambda _
              (substitute* "setup.py"
                ;; Newer version is packaged.
                (("\"matrix-nio\\[e2e\\] >= 0\\.24, < 0\\.25\\.2\"")
                 "\"matrix-nio[e2e] >= 0.24, <= 0.25.2\""))))
          (add-after 'install 'install-doc
            (lambda _
              (with-directory-excursion "docs/man"
                (let ((man (string-append #$output "/share/man")))
                  (install-file "panctl.1" (string-append man "/man1"))
                  (install-file "pantalaimon.5" (string-append man "/man5"))
                  (install-file "pantalaimon.8"
                                (string-append man "/man8")))))))))
    (native-inputs
     (list python-aioresponses
           python-faker
           python-pytest
           python-pytest-aiohttp
           python-pytest-asyncio
           python-setuptools))
    (propagated-inputs
     (list python-aiohttp
           python-attrs
           python-cachetools
           python-click
           python-dbus-1.2
           python-janus
           python-keyring
           python-logbook
           python-matrix-nio
           python-notify2
           python-peewee
           python-platformdirs
           python-prompt-toolkit
           python-pydbus
           python-pygobject))
    (home-page "https://github.com/matrix-org/pantalaimon")
    (synopsis "Matrix proxy daemon that adds E2E encryption capabilities")
    (description
     "Pantalaimon is an end-to-end encryption aware Matrix reverse proxy
daemon.  Pantalaimon acts as a good man in the middle that handles the
encryption for you.  Messages are transparently encrypted and decrypted for
clients inside of pantalaimon.")
    (license license:asl2.0)))

(define-public python-matrix-client
  (package
    (name "python-matrix-client")
    (version "0.3.2")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/matrix-org/matrix-python-sdk")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "01ppn2vxyd7c01ww9bicj7qlyycdyf89b2wbikdb9d2k1h03rfml"))))
    (build-system pyproject-build-system)
    (propagated-inputs (list python-requests))
    (native-inputs (list python-pytest python-responses python-setuptools))
    (home-page "https://github.com/matrix-org/matrix-python-sdk")
    (synopsis "Client-Server SDK for Matrix")
    (description "This package provides client-server SDK for Matrix.")
    (license license:asl2.0)))

(define-public python-matrix-common
  (package
    (name "python-matrix-common")
    (version "1.3.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/matrix-org/matrix-python-common")
              (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1ryih7xladx9888gwi71q78d9f92zjr066jj3ksgcjkfp3djdxjk"))))
    (build-system pyproject-build-system)
    (arguments
     (list #:test-backend #~'custom
           #:test-flags #~(list "-m" "twisted.trial" "tests")))
    (native-inputs
     (list python-setuptools
           python-twisted))
    (propagated-inputs
     (list python-attrs))
    (home-page "https://github.com/matrix-org/matrix-python-common")
    (synopsis "Common utilities for Synapse, Sydent and Sygnal")
    (description
     "This package contains code used by Synapse, Sydent, and Sygnal.")
    (license license:asl2.0)))

(define-public python-matrix-nio
  (package
    (name "python-matrix-nio")
    (version "0.25.2")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/poljar/matrix-nio.git")
             (commit version)))
       (file-name (git-file-name name version))
       (sha256
        (base32 "07prfdnkr13d0pvzhnicwnpn562fwq9zx05d6wza230s7vj0mmk4"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      #:test-flags
      #~(list "tests"
              "-k" (string-join
                    ;; This test requires an Internet connection
                    (list "not test_connect_wrapper"
                          ;; XXX: fixture 'event_loop' not found
                          "test_sync_forever"
                          "test_stop_sync_forever")
                    " and not "))
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'relax-requirements
            (lambda _
              (substitute* "pyproject.toml"
                (("\"cachetools~=.*\"")
                 "\"cachetools\""))))
          (add-after 'unpack 'fix-tests
            (lambda _
              (substitute* "tests/helpers.py"
                (("from nio.crypto import OlmAccount, OlmDevice")
                 "from nio.crypto.device import OlmDevice
from nio.crypto.sessions import OlmAccount")))))))
    (native-inputs
     (list python-aioresponses
           python-faker
           python-hpack
           python-hyperframe
           python-hypothesis
           python-pytest
           python-pytest-aiohttp
           python-pytest-asyncio
           python-pytest-benchmark
           python-setuptools))
    (propagated-inputs
     (list python-aiofiles
           python-aiohttp
           python-aiohttp-socks
           python-atomicwrites
           python-cachetools
           python-h11
           python-h2
           python-jsonschema
           python-olm
           python-peewee
           python-pycryptodome
           python-unpaddedbase64))
    (home-page "https://github.com/poljar/matrix-nio")
    (synopsis
     "Python Matrix client library, designed according to sans I/O principles")
    (description
     "Matrix nio is a multilayered Matrix client library.  The underlying base
layer doesn't do any network IO on its own, but on top of that is a full
fledged batteries-included asyncio layer using aiohttp.")
    (license license:isc)))

(define-public python-matrix-synapse-ldap3
  (package
    (name "python-matrix-synapse-ldap3")
    (version "0.1.4")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/matrix-org/matrix-synapse-ldap3")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1p49h4k216iwap3axws7ffz94zn25j85f7kkv3wky1fvsb8i1r4h"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      #:tests? #f     ; tests require synapse, creating a circular dependency.
      #:phases
      #~(modify-phases %standard-phases
          ;; Also, auth_provider.py attempts to import synapse.
          (delete 'sanity-check))))
    (native-inputs (list python-setuptools))
    (propagated-inputs
     (list python-twisted python-ldap3 python-service-identity))
    (home-page "https://github.com/matrix-org/matrix-synapse-ldap3")
    (synopsis "LDAP3 auth provider for Synapse")
    (description
     "This package allows Synapse to use LDAP as a password provider.
This lets users log in to Synapse with their username and password from
an LDAP server.")
    (license license:asl2.0)))

(define-public python-synapse-s3-storage-provider
  (package
    (name "python-synapse-s3-storage-provider")
    (version "1.6.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/matrix-org/synapse-s3-storage-provider")
              (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "03y72439z718wjapdgqcw1qajpc917djsf4jhp2qrgv9l71rrrk9"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      #:test-backend #~'custom
      #:test-flags #~(list "-m" "twisted.trial" "test_s3")))
    (native-inputs
     (list python-setuptools
           python-mock synapse))
    (propagated-inputs
     (list python-boto3
           python-botocore
           python-humanize
           python-psycopg2
           python-pyyaml
           python-tqdm
           python-twisted))
    (home-page "https://github.com/matrix-org/synapse-s3-storage-provider")
    (synopsis "Synapse storage provider to fetch and store media in Amazon S3")
    (description
     "This package implements a storage provider for Synapse, enabling it to
fetch and store media in Amazon S3.")
    (license license:asl2.0)))

(define-public synapse
  (package
    (name "synapse")
    (version "1.140.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/element-hq/synapse")
              (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0iidr727jw178596ijls670k8i7v7kjbn8w0jhkihf2hy8wnfkcy"))))
    (build-system pyproject-build-system)
    (arguments
     (list
      #:modules
      '(((guix build cargo-build-system) #:prefix cargo:)
        (guix build pyproject-build-system)
        (guix build utils))
      #:imported-modules
      `(,@%cargo-build-system-modules
        ,@%pyproject-build-system-modules)
      #:test-backend #~'custom
      ;; XXX: The complete test suite takes about 2h+ to finish and require
      ;; running database, run just unittests.
      ;; See: <.github/workflows/tests.yml>.
      ;;
      ;; tests: skips=169, successes=4245
      #:test-flags
      #~(list "-m" "twisted.trial"
              "--temp-directory=/tmp/_trial_temp"
              (string-append "--jobs="
                             (number->string (min 4 (parallel-job-count))))
              "tests")
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'prepare-cargo-build-system
            (lambda args
              (for-each
               (lambda (phase)
                 (format #t "Running cargo phase: ~a~%" phase)
                 (apply (assoc-ref cargo:%standard-phases phase)
                        #:cargo-target #$(cargo-triplet)
                        args))
               '(unpack-rust-crates
                 configure
                 check-for-pregenerated-files
                 patch-cargo-checksums))))
          (add-after 'unpack 'disable-failing-tests
            (lambda _
              (substitute* "tests/handlers/test_user_directory.py"
                (("def test_search_punctuation")
                 "def __off_test_search_punctuation"))
              (substitute* "tests/storage/test_room_search.py"
                ;; twisted.trial.unittest.FailTest: 0 != 1 : expected 'quick
                ;; brown' to match 'the quick brown fox jumps over the lazy
                ;; dog'
                (("def test_sqlite_search")
                 "def __off_test_sqlite_search")
                ;; twisted.trial.unittest.FailTest: 0 != 1
                (("def test_null_byte")
                 "def __off_test_null_byte"))))
          (add-after 'build 'install-rust-library
            (lambda _
              (copy-file "target/release/libsynapse.so"
                         "synapse/synapse_rust.so"))))))
    (inputs (cargo-inputs 'synapse))
    (propagated-inputs
     (list python-attrs
           python-bcrypt
           python-bleach
           python-canonicaljson
           python-cryptography
           python-ijson
           python-immutabledict
           python-jinja2
           python-jsonschema
           python-matrix-common
           python-msgpack
           python-multipart
           python-netaddr
           python-packaging
           python-phonenumbers
           python-pillow
           python-prometheus-client
           python-pyasn1
           python-pyasn1-modules
           python-pydantic
           python-pymacaroons
           python-pyopenssl
           python-pyyaml
           python-service-identity
           python-signedjson
           python-sortedcontainers
           python-treq
           python-twisted
           python-typing-extensions
           python-unpaddedbase64
           ;; [all]
           python-authlib
           python-hiredis
           python-idna
           python-lxml
           python-matrix-synapse-ldap3
           python-parameterized
           python-psycopg2
           python-psycopg2cffi
           python-pympler
           python-pysaml2
           python-txredisapi))
    (native-inputs
     (list (libc-utf8-locales-for-target)        ;for tests
           openssl
           postgresql
           python-poetry-core
           python-pyperf
           python-setuptools-rust
           rust
           (list rust "cargo")
           tzdata-for-tests
           xmlsec))
    (home-page "https://github.com/element-hq/synapse")
    (synopsis "Matrix reference homeserver")
    (description
     "Synapse is a reference \"homeserver\" implementation of Matrix from the
core development team at matrix.org, written in Python/Twisted.  It is
intended to showcase the concept of Matrix and let folks see the spec in the
context of a codebase and let you run your own homeserver and generally help
bootstrap the ecosystem.")
    (license license:asl2.0)))