matrix2051 Скачать - matrix2051 Скачать исходный код

matrix2051

AI Исходный код

1.0.0

Скачать

Matrix2051

Присоединяйтесь к Matrix от вашего любимого клиента IRC

Matrix2051 (или M51 для короткому) - это IRC -сервер, поддерживаемый Matrix. Вы также можете видеть это как вышибала IRC, который соединяется с домиками Matrix вместо IRC -серверов. Другими словами:

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

Цели:

Облегчить пользователям IRC плавно присоединиться к Matrix
Поддержать существующие ретранс -розы
Руководитель кровотечения IRCV3
Очень легко установить. Это означает:
1. максимально небольшая конфигурация и база данных (в идеале ноль)
2. Небольшой набор декораций.

Не предстоящие:

Будучи размещенным сервисом (это потребует противоречиев спама, и это большая работа).
Поддержка TLS (см. Предыдущий пункт). Просто запустите его на Localhost. Если вам действительно нужно, чтобы он был удаленным, обратитесь к нему через VPN или обратный прокси.
Подключение к нескольким учетным записям на соединение IRC или к другим протоколам (à la bitlbee). Это конфликт с целями 1 и 4.
Реализация любых функций, не назначенных по обоим протоколам (т. Е. Нет необходимости в ботах обслуживания, которые вы взаимодействуете с использованием Privmsg)

Основные особенности

Регистрация и аутентификация пароля
Вместительными комнатами
Отправка и получение сообщений (поддерживает форматирование, многослойные, выделения, ответа, реагирование на сообщения)
Частичная поддержка Chathistory IRCV3; Достаточно для того, чтобы Gamja работал. Открытые проблемы с чатисторией
Поддержка частичного отображения имени

Недостатки

Прямые чаты отображаются как обычные каналы, со случайными именами
Разве «не чувствует себя», как настоящая сеть IRC (пока?)
Идентификаторы пользователей и названия номеров неудобно длинные
Загрузка списка огромных комнат, таких как #Matrix: Matrix.org перегружает некоторые клиенты IRC
Клиенты IRC без поддержки с шестигранными цветами увидят немного мусора вместо цветов. (Хотя цветной текст кажется очень редким на матрице)
Клиенты IRC без продвинутой работы IRCV3. Пропустить многие функции: цитата ответов, реагирует, отображает имена.

Скриншот

Две заметки на этом скриншоте:

Редакты сообщений отображаются с запасным, так как изменения сообщений еще не поддерживаются IRC,
Ответы на irccloud отображаются с цветными значками, и нажатие этих значков открывает столбец, показывающий весь поток. Другие клиенты могут отображать ответы по -разному.

Использование

Установить системные зависимости. Например, на Debian: sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
Установите зависимости эликсира: mix deps.get
Запустите тесты, чтобы убедиться, что все работает: mix test
Запуск: mix run matrix2051.exs
Подключите клиент к localhost:2051 , со следующей конфигурацией:
- Нет SSL/TLS
- SASL USERNAME: ваш полный идентификатор матрицы ( user:homeserver.example.org )
- Пароль SASL: ваш матричный пароль

Смотрите ниже дополнительные инструкции для работы с веб -клиентами.

Смотрите INSTALL.md для более ориентированного на производство руководства.

Архитектура

matrix2051.exs запускает M51.Application, которая начинается с M51.supervisor, который контролирует:
- config.ex : global config Agent
- irc_server.ex : DynamicSupervisor , который получает подключения от клиентов IRC.

Каждый раз, когда irc_server.ex получает соединение, он порождает irc_conn/supervisor.ex , который контролирует:

irc_conn/state.ex : хранит состояние соединения
irc_conn/writer.ex : genserver удерживает гнездо и позволяет писать строки (и партии строк в будущем)
irc_conn/handler.ex : Задача задачей Занятия в входящих командах от читателя, отвечает на простые и отправляет более сложные команды
matrix_client/state.ex : сохраняет состояние соединения с матрицей HomeServer
matrix_client/client.ex : обрабатывает одно подключение к Matrix HomeServer, как один пользователь
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 : Извлекать историю сообщений из Matrix, по запросу клиента IRC

Вопросы

Почему?

Есть много замечательных клиентов IRC, но я не могу найти клиента Matrix, который мне нравится. Тем не менее, некоторые сообщества переходят от IRC в Матрицу, поэтому я написал это, чтобы я мог присоединиться к ним с удобным клиентом.

Это также способ легко прототипа последних функций IRCV3 и для меня изучить протокол матрицы.

Какие клиенты IRC поддерживаются?

Теоретически, любой клиент IRC должен работать. В частности, я проверяю это с Gamja, Irccloud, The Lounge и WeeChat.

Пожалуйста, откройте проблему, если у вашего клиента есть какие -либо проблемы.

Какие домики матрицы поддерживаются?

Теоретически, как я писал это, прочитав матричные характеристики. На практике это тестируется только с синапсом.

Заметным исключением является регистрация, которая использует специфический для синапса API в качестве самой матрицы, не указывает регистрацию.

Пожалуйста, откройте проблему, если у вас есть какие -либо проблемы с вашим HomeServer (фиктивное логин/пароль, который я могу использовать для подключения к нему, будет оценена).

Вы планируете поддержать функции x, y, ...?

На момент написания, если и матрица, и IRC/IRCV3 поддерживают их, Matrix2051, вероятно, будет. Взгляните на список проблем с открытыми «улучшением».

Примечательным исключением являются прямые сообщения, потому что модель Matrix значительно отличается от IRC.

Могу ли я связаться с веб -клиентом?

Чтобы подключить веб -клиентов, вам нужен шлюз WebSocket. Matrix2051 была протестирована с помощью Webircgageway Kiwiirc (попробуйте этот патч, если вам нужно запустить его в старых версиях GO).

Вот как вы можете настроить его для подключения к Matrix2051 с Gamja:

[ 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 = " "