matrix2051

Matrix2051

お気に入りのIRCクライアントからマトリックスに参加してください

Matrix2051（または略してM51）は、Matrixに裏打ちされたIRCサーバーです。また、IRCサーバーの代わりにMatrix Homeserversに接続するIRCバウンサーとして見ることもできます。言い換えると：

         IRC client
  (eg. weechat or hexchat)
             |
             |     IRC protocol
             v
         Matrix2051
             |
             |     Matrix protocol
             v
     Your Homeserver
     (eg. matrix.org)

目標：

1. IRCユーザーがマトリックスに簡単に参加できるようにします
2. 既存のリレーボットをサポートして、既存のIRC/マトリックスブリッジよりもIRCで動作するリレーを許可します
3. ブリードエッジIRCV3の実装
4. 非常に簡単にインストールできます。これはつまり：
   1. できるだけ少ない構成とデータベース（理想的にはゼロ）
   2. 小さなdepenenciesのセット。

ノンゴール：

1. ホストされたサービスであること（スパム対策が必要であり、それは多くの作業です）。
2. TLSサポート（前のポイントを参照）。 LocalHostで実行するだけです。本当にリモートである必要がある場合は、VPNまたは逆プロキシを介してアクセスしてください。
3. IRC接続ごとの複数のアカウントまたは他のプロトコル（アラビットルビー）に接続します。これは、目標1および4と矛盾しています。
4. 両方のプロトコルによってネイティブにない機能を実装する（つまり、privmsgを使用することに互いに散布するサービスボットは必要ありません）

主な機能

• 登録とパスワード認証
• 部屋に参加します
• メッセージの送信と受信（フォーマット、マルチライン、ハイライト、返信、メッセージへの反応をサポート）
• 部分的なIRCV3チャティストリーサポート。 Gamjaが働くのに十分です。オープンなchathistoryの問題
• 部分的なディスプレイ名のサポート

欠点

• 直接チャットは通常のチャンネルとして表示され、ランダムな名前が表示されます
• 実際のIRCネットワークのように「感じ」ません（まだ？）
• ユーザーIDとルーム名は不快なほど長いです
• #matrix：matrix.orgのような巨大な部屋のニックリストを読み込む
• HEXカラーサポートのないIRCクライアントは、色の代わりにゴミが表示されます。 （マトリックスでは色付きのテキストは非常に珍しいようですが）
• 高度なIRCV3サポートのIRCクライアントは、多くの機能を逃しています：引用返信、反応、表示名。

スクリーンショット

このスクリーンショットに関する2つのメモ：

• メッセージの編集は、IRCによってまだサポートされていないため、フォールバックでレンダリングされます。
• Irccloudの返信は色付きアイコンでレンダリングされ、これらのアイコンをクリックすると、スレッド全体を示す列が開きます。他のクライアントは、返信を異なってレンダリングする場合があります。

使用法

• システムの依存関係をインストールします。たとえば、debian： sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
• Elixir依存関係をインストール： mix deps.get
• すべてが機能していることを確認するためにテストを実行します： mix test
• 実行： mix run matrix2051.exs
• クライアントをlocalhost:2051に接続し、次の構成を使用します。
  • SSL/TLSはありません
  • SASLユーザー名：フルマトリックスID（ user:homeserver.example.org ）
  • SASLパスワード：マトリックスパスワード

Webクライアントと連携するための追加の指示については、以下を参照してください。

より生産指向のガイドについては、 INSTALL.md参照してください。

建築

• matrix2051.exsはm51.applicationを開始します。これはm51.supervisorを開始します。
  • config.ex ：Global Config Agent
  • irc_server.ex ：IRCクライアントから接続を受信するDynamicSupervisor 。

irc_server.ex接続を受信するたびに、 irc_conn/supervisor.exが生成されます。

• irc_conn/state.ex ：接続の状態を保存します
• irc_conn/writer.ex ：genserverソケットを保持し、それにラインを書き込むことができます（および将来のラインのバッチ）
• irc_conn/handler.ex ：読者からの着信コマンドを忙しくするタスク、単純なコマンドへの回答、より複雑なコマンドを派遣する
• matrix_client/state.ex ：Matrix Homeserverへの接続の状態を保持します
• matrix_client/client.ex ：マトリックスHomeserverへの1つの接続を単一のユーザーとして処理する
• matrix_client/sender.ex ：Matrix Homeserverにイベントを送信し、障害時に再試行します
• matrix_client/poller.ex ：Matrix Homeserverに新しいイベントを繰り返し尋ねます（初期同期を含む）
• irc_conn/reader.ex ：入ってくる行を忙しくするタスクをハンドラーに送信します

ユーティリティ：

• matrix/raw_client.ex ：低レベルのマトリックスクライアント / HTTPリクエストの周りの薄いラッパー
• irc/command.ex ：IRCラインの操作。いくつかの機能をサポートしていないクライアントの「ダウングレード」を含む。
• irc/word_wrap.ex ：ジェネリックラインラッピング
• format/ ：IRCのフォーマットとorg.matrix.custom.htmlを変換します
• matrix_client/chat_history.ex ：IRCクライアントが要求した場合、Matrixからメッセージ履歴を取得します

質問

なぜ？

多くの優れたIRCクライアントがいますが、私が好きなマトリックスクライアントを見つけることができません。しかし、一部のコミュニティはIRCからマトリックスに移動しているので、私はこれを書いて、快適なクライアントと一緒に参加できるようにしました。

これはまた、最新のIRCV3機能を簡単にプロトタイプする方法であり、マトリックスプロトコルを学ぶための方法です。

どのIRCクライアントがサポートされていますか？

理論的には、IRCクライアントは機能するはずです。特に、Gamja、Irccloud、The Lounge、およびWeechatでテストします。

クライアントに問題がある場合は、問題を開いてください。

どのマトリックスホームサーバーがサポートされていますか？

理論的には、マトリックス仕様を読んでこれを書いたように、いずれにしても。実際には、これはシナプスでのみテストされています。

顕著な例外は登録です。マトリックス自体が登録を指定しないため、シナプス固有のAPIを使用します。

Homeserverに問題がある場合は問題を開きます（ダミーログイン/パスワードを使用して接続できます）。

機能x、y、...をサポートする予定ですか？

執筆時点で、マトリックスとIRC/IRCV3の両方がそれらをサポートする場合、Matrix2051はおそらくそうするでしょう。オープンな「強化」の問題のリストを見てください。

マトリックスのモデルはIRCのモデルとは大きく異なるため、顕著な例外は直接的なメッセージです。

Webクライアントに接続できますか？

Webクライアントを接続するには、WebSocket Gatewayが必要です。 Matrix2051は、KiwiircのWebIrcgatewayでテストされました（古いGoバージョンで実行する必要がある場合は、このパッチを試してください）。

Gamjaを使用してMatrix2051に接続するように構成する方法は次のとおりです。

[ fileserving ]
enabled = true
webroot = " /path/to/gamja "


[ upstream . 1 ]
hostname = " localhost "
port = 2051
tls = false
# Connection timeout in seconds
timeout = 20
# Throttle the lines being written by X per second
throttle = 100
webirc = " "
serverpassword = " "

名前は何ですか？

これはXKCD 1782への参照です：

私はまだ質問があります、どうすればあなたに連絡できますか？

＃matrix2051にIRC.Interlinked.meに参加します。 （いいえ、私は自分のドッグフードを食べていません、私はまだ「ネイティブ」IRCを好みます。）