Initial release

This is a matrix bot which announces the lol hackerspace's
open / closed state to a list of matrix rooms, it is based
on rumqtt and matrix-rust-sdk. The bot connects to the
configured matrix homeserver and an MQTT broker broadcasting
changes in the door sensor state
This commit is contained in:
2026-09-14 09:18:54 +00:00
commit aa47e38536
9 changed files with 4401 additions and 0 deletions
+100
View File
@@ -0,0 +1,100 @@
/**
* matrix-lolopener v0.1.0
*
* Copyright (C) 2026 The 1312 Media Collective
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
use serde::Deserialize;
use std::{fs, io, fmt};
#[derive(Deserialize, Debug, Clone)]
pub struct MQTTConfig {
pub id: String,
pub host: String,
pub port: u16,
pub topic: String,
}
#[derive(Deserialize, Debug)]
#[serde(untagged)]
pub enum AuthConfig {
PasswordAuthConfig {
username: String,
password: String,
},
TokenAuthConfig {
user_id: String,
device_id: String,
access_token: String,
}
}
#[derive(Deserialize, Debug)]
pub struct Config {
pub mqtt: MQTTConfig,
pub rooms: Vec<String>,
#[serde(flatten)]
pub auth: AuthConfig,
pub homeserver_uri: String
}
impl Config {
pub fn load(config_file: &str) -> Result<Self> {
let serialized_config = fs::read_to_string(config_file).map_err(|e| {
match e.kind() {
io::ErrorKind::NotFound => Error::FileNotFoundError(config_file.into()),
io::ErrorKind::PermissionDenied => Error::PermissionDeniedError(),
_ => e.into(),
}
})?;
let config: Config = serde_yaml::from_str(&serialized_config)?;
Ok(config)
}
}
#[derive(Debug)]
#[allow(dead_code)] // we use Debug, so inner fields are never read
pub enum Error {
FileNotFoundError(String),
PermissionDeniedError(),
InvalidFormatError(serde_yaml::Error),
IoError(io::Error),
}
impl From<serde_yaml::Error> for Error {
fn from(e: serde_yaml::Error) -> Self {
Self::InvalidFormatError(e)
}
}
impl From<io::Error> for Error {
fn from(e: io::Error) -> Self {
Self::IoError(e)
}
}
impl std::error::Error for Error {}
impl fmt::Display for Error {
fn fmt(&self, fmt: &mut fmt::Formatter) -> std::result::Result<(), fmt::Error> {
write!(fmt, "{self:?}")
}
}
pub type Result<T> = std::result::Result<T, Error>;
+88
View File
@@ -0,0 +1,88 @@
/**
* matrix-lolopener v0.1.0
*
* Copyright (C) 2026 The 1312 Media Collective
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
mod config;
mod matrix;
mod mqtt;
use tokio::{
sync::{Notify, broadcast},
task::JoinHandle,
};
use crate::{
config::Config,
matrix::login_and_sync,
mqtt::{MQTT, StatusMessage},
};
use std::sync::Arc;
use tracing::{ info, debug };
#[tokio::main]
async fn main() -> anyhow::Result<()> {
tracing_subscriber::fmt::init();
let config = Config::load("config.yml").unwrap_or_else(|e| {
panic!("Failed to load config: {e:?}")
});
let config = Arc::new(config);
let matrix_ready = Arc::new(Notify::new());
// This channel is used for sending messages to the matrix module,
// it holds a tuple with an HTML message and a list of rooms to post to
let (bcast_tx, bcast_rx) = broadcast::channel::<(String, Vec<String>)>(1024);
let handle: JoinHandle<_> = (|| {
let matrix_ready = Arc::clone(&matrix_ready);
let config = Arc::clone(&config);
tokio::spawn(async move {
debug!("Waiting until matrix is ready");
matrix_ready.notified().await;
info!("Matrix is ready");
let mut mqtt = MQTT::new(config.mqtt.clone()).await;
mqtt.subscribe(|status: StatusMessage| {
let msg = match status {
StatusMessage { contact: true, .. } => "🔴 Le LOL est fermé :(",
StatusMessage { contact: false, .. } => "🟢 Le LOL est ouvert :)",
};
debug!("Sending msg {}", msg);
//XXX: Panic if the matrix module can't get the message
bcast_tx.send((msg.into(), config.rooms.clone())).unwrap();
()
}).await.unwrap(); //XXX: Panic if the mqtt broker fails
})
})();
login_and_sync(
config.homeserver_uri.clone().into(),
&config.auth,
matrix_ready,
bcast_rx
).await?;
handle.abort();
handle.await?;
Ok(())
}
+187
View File
@@ -0,0 +1,187 @@
/**
* matrix-lolopener v0.1.0
*
* Copyright (C) 2024 The 1312 Media Collective
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
use matrix_sdk::{
matrix_auth::{
MatrixAuth,
MatrixSession,
MatrixSessionTokens
},
SessionMeta,
config::SyncSettings,
ruma::events::room::{
member::StrippedRoomMemberEvent,
message::RoomMessageEventContent
},
ruma::{RoomId, OwnedUserId, device_id},
Client, Room
};
use tokio::{
time::{sleep, Duration},
sync::{broadcast, Notify},
task
};
use std::sync::Arc;
use tracing::{error, info};
use std::error::Error;
use crate::config::AuthConfig;
async fn on_stripped_state_member(
room_member: StrippedRoomMemberEvent,
client: Client,
room: Room,
) {
if room_member.state_key != client.user_id().unwrap() {
return;
}
tokio::spawn(async move {
info!("Autojoining room {}", room.room_id());
let mut delay = 2;
while let Err(err) = room.join().await {
// retry autojoin due to synapse sending invites, before the
// invited user can join for more information see
// https://github.com/matrix-org/synapse/issues/4345
error!("Failed to join room {} ({err:?}), retrying in {delay}s", room.room_id());
sleep(Duration::from_secs(delay)).await;
delay *= 2;
if delay > 3600 {
error!("Can't join room {} ({err:?})", room.room_id());
break;
}
}
info!("Successfully joined room {}", room.room_id());
});
}
async fn send_to_room(
msg: &String,
room: Room,
) -> Result<(), Box<dyn Error>> {
info!("Joining room {}", room.room_id());
match room.client().join_room_by_id(room.room_id()).await {
Ok(_) => {
info!("Posting to room {}", room.room_id());
room.send(RoomMessageEventContent::text_html(msg.clone(), msg)).await?;
return Ok(());
},
Err(e) => {
error!("Failed to join room {e:?}");
return Err(e.into());
}
};
}
async fn login(
auth_config: &AuthConfig,
matrix_auth: MatrixAuth
) -> anyhow::Result<()> {
match auth_config {
AuthConfig::PasswordAuthConfig{username, password} => {
matrix_auth.login_username(username, password)
.initial_device_display_name("bender v0.2.0").await?;
},
AuthConfig::TokenAuthConfig{user_id, device_id, access_token} => {
matrix_auth.restore_session(
MatrixSession {
meta: SessionMeta {
user_id: <OwnedUserId>::try_from(user_id.as_str())?,
device_id: device_id!(device_id.as_str()).to_owned(),
},
tokens: MatrixSessionTokens {
access_token: access_token.to_owned(),
refresh_token: None,
}
}
).await?;
},
}
Ok(())
}
pub async fn login_and_sync(
homeserver_url: String,
auth_config: &AuthConfig,
ready: Arc<Notify>,
mut rx: broadcast::Receiver<(String, Vec<String>)>
) -> anyhow::Result<()> {
// We are not reading encrypted messages, so we don't care about session persistence
let client = Client::builder().homeserver_url(homeserver_url).build().await?;
login(auth_config, client.matrix_auth()).await?;
client.add_event_handler(on_stripped_state_member);
// make sure we already re-joined rooms before sending events
let sync_token = client.sync_once(SyncSettings::default()).await?.next_batch;
// since we called `sync_once` before we entered our sync loop
// we must pass that sync token to `sync`
let settings = SyncSettings::default().token(sync_token);
// make sure all waiters have had a chance to register.
// Ideally the notified futures would be created before spawning
// the feed reader tasks but that would require the Notified structs to
// live for 'static, which I dislike.
task::yield_now().await;
info!("Matrix is ready, notifying waiters");
ready.notify_waiters();
loop {
tokio::select! {
res = client.sync(settings.clone()) => match res {
Ok(_) => return Ok(()),
Err(e) => {
error!("Sync error: {e:?}");
()
}
},
recv = rx.recv() => match recv {
Ok((msg, rooms)) => {
let msg = &msg.clone();
for r in rooms {
match client.get_room(<&RoomId>::try_from(r.as_str())
.expect(format!("Invalid Room ID: {}", r).as_str())) {
Some(room) => match send_to_room(msg, room).await {
Ok(_) => info!("Done sending to room {}", r),
Err(e) => error!("Cannot send to room {}: {e:?}", r),
},
None => error!("Room {} not found in matrix state store", r)
};
}
},
Err(e) => {
panic!("Broadcast channel is lagging: {e:?}");
}
}
}
}
}
+123
View File
@@ -0,0 +1,123 @@
/**
* matrix-lolopener v0.1.0
*
* Copyright (C) 2026 The 1312 Media Collective
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
use rumqttc::{
MqttOptions,
AsyncClient,
EventLoop,
Event,
Incoming,
QoS,
};
use std::{
time::Duration,
fmt,
};
use serde::Deserialize;
use tracing::{ info, debug };
use crate::config::MQTTConfig;
#[derive(Deserialize, Debug)]
pub struct StatusMessage {
pub contact: bool,
}
pub struct MQTT {
config: MQTTConfig,
client: AsyncClient,
eventloop: EventLoop,
}
impl MQTT {
pub async fn new(config: MQTTConfig) -> Self {
let mut mqttoptions = MqttOptions::new(config.id.clone(), config.host.clone(), config.port);
mqttoptions.set_keep_alive(Duration::from_secs(5));
let (client, eventloop) = AsyncClient::new(mqttoptions, 1);
let mqtt = MQTT {
config: config,
client: client,
eventloop: eventloop,
};
mqtt
}
pub async fn subscribe<F: Fn(StatusMessage)>(&mut self, callback: F) -> Result<()> {
self.client.subscribe(self.config.topic.clone(), QoS::AtMostOnce).await?;
loop {
let notification = self.eventloop.poll().await?;
debug!("Notification = {:?}", notification);
match notification {
Event::Incoming(Incoming::Publish(p)) => {
let msg: StatusMessage = serde_json::from_slice(p.payload.as_ref())?;
info!("Message: {:?}", msg);
callback(msg);
},
_ => (),
}
}
#[allow(unreachable_code)]
Ok(())
}
}
#[derive(Debug)]
#[allow(dead_code)] // we use Debug, so inner fields are never read
pub enum Error {
MQTTClientError(rumqttc::ClientError),
MQTTConnectionError(rumqttc::ConnectionError),
InvalidFormatError(serde_json::Error),
}
impl From<rumqttc::ClientError> for Error {
fn from(e: rumqttc::ClientError) -> Self {
Self::MQTTClientError(e)
}
}
impl From<rumqttc::ConnectionError> for Error {
fn from(e: rumqttc::ConnectionError) -> Self {
Self::MQTTConnectionError(e)
}
}
impl From<serde_json::Error> for Error {
fn from(e: serde_json::Error) -> Self {
Self::InvalidFormatError(e)
}
}
impl std::error::Error for Error {}
impl fmt::Display for Error {
fn fmt(&self, fmt: &mut fmt::Formatter) -> std::result::Result<(), fmt::Error> {
write!(fmt, "{self:?}")
}
}
pub type Result<T> = std::result::Result<T, Error>;