echo/src/main.rs
Jean 9ed40a2e7f
All checks were successful
CI / check (push) Successful in 3m48s
License (AGPL-3.0) and graceful shutdown
Add the AGPL-3.0 license (matching Orbit) and set it in Cargo.toml so
the crate metadata is complete. Handle SIGTERM/Ctrl-C: the run loop now
selects against a shutdown signal and exits cleanly, so systemctl stop
returns promptly instead of waiting out the kill timeout (every event is
already fsync'd, so nothing is lost either way). Verified: on SIGTERM the
daemon logs and exits 0.
2026-07-15 12:05:39 +00:00

238 lines
7.9 KiB
Rust

// Core lives in src/; the pseudo-clients and the ircd link are external module
// crates (echo-nickserv, echo-chanserv, echo-inspircd), each depending
// only on the echo-api SDK.
mod config;
mod engine;
mod gossip;
mod grpc;
mod jsonrpc;
mod link;
mod proto;
use anyhow::Result;
use std::sync::Arc;
use std::time::{SystemTime, UNIX_EPOCH};
use tokio::sync::Mutex;
use engine::Engine;
use echo_botserv::BotServ;
use echo_chanserv::ChanServ;
use echo_memoserv::MemoServ;
use echo_statserv::StatServ;
use echo_hostserv::HostServ;
use echo_operserv::OperServ;
use echo_diceserv::DiceServ;
use echo_infoserv::InfoServ;
use echo_reportserv::ReportServ;
use echo_groupserv::GroupServ;
use echo_chanfix::ChanFix;
use echo_helpserv::HelpServ;
use echo_example::ExampleServ;
use echo_inspircd::InspIrcd;
use echo_nickserv::NickServ;
#[tokio::main]
async fn main() -> Result<()> {
tracing_subscriber::fmt()
.with_env_filter(
tracing_subscriber::EnvFilter::try_from_default_env()
.unwrap_or_else(|_| "echo=debug".into()),
)
.init();
let path = std::env::args().nth(1).unwrap_or_else(|| "config.toml".to_string());
let cfg = config::Config::load(&path)?;
let ts = SystemTime::now().duration_since(UNIX_EPOCH)?.as_secs();
let proto = Box::new(InspIrcd::new(
cfg.server.name.clone(),
cfg.server.description.clone(),
cfg.server.sid.clone(),
cfg.uplink.password.clone(),
cfg.server.protocol,
ts,
));
// Bring up the service modules named in [modules] (default: the full
// standard suite — every pseudo-client). Each keeps a fixed uid suffix so
// its identity is stable no matter which others are enabled.
let enabled = |name: &str| cfg.modules.services.iter().any(|s| s == name);
let mut services: Vec<Box<dyn engine::service::Service>> = Vec::new();
if enabled("nickserv") {
services.push(Box::new(NickServ {
uid: format!("{}AAAAAA", cfg.server.sid),
guest_nick: cfg.server.guest_nick.clone(),
guest_seq: (ts % 100_000) as u32,
}));
}
if enabled("chanserv") {
services.push(Box::new(ChanServ {
uid: format!("{}AAAAAB", cfg.server.sid),
}));
}
if enabled("botserv") {
services.push(Box::new(BotServ {
uid: format!("{}AAAAAD", cfg.server.sid),
}));
}
if enabled("memoserv") {
services.push(Box::new(MemoServ {
uid: format!("{}AAAAAE", cfg.server.sid),
}));
}
if enabled("statserv") {
services.push(Box::new(StatServ {
uid: format!("{}AAAAAF", cfg.server.sid),
}));
}
if enabled("hostserv") {
services.push(Box::new(HostServ {
uid: format!("{}AAAAAG", cfg.server.sid),
}));
}
if enabled("operserv") {
services.push(Box::new(OperServ {
uid: format!("{}AAAAAH", cfg.server.sid),
}));
}
if enabled("diceserv") {
services.push(Box::new(DiceServ {
uid: format!("{}AAAAAI", cfg.server.sid),
}));
}
if enabled("infoserv") {
services.push(Box::new(InfoServ {
uid: format!("{}AAAAAJ", cfg.server.sid),
}));
}
if enabled("reportserv") {
services.push(Box::new(ReportServ {
uid: format!("{}AAAAAK", cfg.server.sid),
}));
}
if enabled("groupserv") {
services.push(Box::new(GroupServ {
uid: format!("{}AAAAAL", cfg.server.sid),
}));
}
if enabled("chanfix") {
services.push(Box::new(ChanFix {
uid: format!("{}AAAAAM", cfg.server.sid),
}));
}
if enabled("helpserv") {
services.push(Box::new(HelpServ {
uid: format!("{}AAAAAN", cfg.server.sid),
}));
}
if enabled("example") {
services.push(Box::new(ExampleServ {
uid: format!("{}AAAAAC", cfg.server.sid),
}));
}
let (gossip_tx, _) = tokio::sync::broadcast::channel::<engine::db::LogEntry>(1024);
let mut db = engine::db::Db::open("echo.db.jsonl", &cfg.server.sid);
db.scram_iterations = cfg.server.scram_iterations;
db.set_outbound(gossip_tx.clone());
db.set_email_enabled(cfg.email.is_some());
db.set_external_accounts(cfg.auth.as_ref().is_some_and(|a| a.external));
if let Some(email) = &cfg.email {
db.set_email_brand(&email.brand);
db.set_email_accent(&email.accent);
db.set_email_logo(&email.logo);
}
let engine = Arc::new(Mutex::new(Engine::new(services, db)));
// Channel for services-initiated actions to reach the uplink (drained by the link loop).
let (irc_tx, irc_rx) = tokio::sync::mpsc::unbounded_channel();
engine.lock().await.set_irc_out(irc_tx);
engine.lock().await.set_opers(cfg.opers());
engine.lock().await.set_sid(cfg.server.sid.clone());
engine.lock().await.set_log_channel(cfg.log.as_ref().map(|l| l.channel.clone()));
if let Some(expire) = &cfg.expire {
engine.lock().await.set_expiry(expire.account_ttl(), expire.channel_ttl(), expire.warn_ttl());
}
if let Some(session) = &cfg.session {
engine.lock().await.set_session_limit(session.limit());
}
if let Some(gossip) = cfg.gossip.clone() {
tracing::info!(peers = cfg.peer.len(), "starting gossip");
tokio::spawn(gossip::run(engine.clone(), gossip, cfg.peer.clone(), cfg.server.sid.clone(), gossip_tx.clone()));
}
// Directory replication for websites (Django, etc.) — subscribes to the same
// committed-entry stream gossip does, so a website sees the account/channel
// directory update in real time without touching IRC at all.
if let Some(grpc_cfg) = cfg.grpc.clone() {
tokio::spawn(grpc::run(engine.clone(), grpc_cfg, gossip_tx));
}
// JSON-RPC stats endpoint (plain HTTP), for a website's stats pages.
if let Some(jsonrpc_cfg) = cfg.jsonrpc.clone() {
tokio::spawn(jsonrpc::run(engine.clone(), jsonrpc_cfg));
}
// Periodically fold log churn into a snapshot when it grows past the accounts.
{
let engine = engine.clone();
tokio::spawn(async move {
loop {
tokio::time::sleep(std::time::Duration::from_secs(1800)).await;
let mut e = engine.lock().await;
e.expire_sweep();
if let Err(err) = e.maybe_compact() {
tracing::warn!(%err, "compaction failed");
}
}
});
}
// ChanFix scores op-time on a shorter cadence so the fix has fresh data.
if enabled("chanfix") {
let engine = engine.clone();
tokio::spawn(async move {
loop {
tokio::time::sleep(std::time::Duration::from_secs(300)).await;
engine.lock().await.chanfix_tick();
}
});
}
let addr = format!("{}:{}", cfg.uplink.host, cfg.uplink.port);
tracing::info!(server = %cfg.server.name, %addr, "linking to uplink");
// Run until the uplink loop ends or the process is asked to stop. Every
// committed change is already fsync'd, so a clean stop loses nothing; this
// just lets systemd stop us without waiting out the kill timeout.
tokio::select! {
res = link::run(proto, engine, &addr, irc_rx, cfg.email.clone()) => res,
_ = shutdown_signal() => {
tracing::info!("received shutdown signal, exiting");
Ok(())
}
}
}
// Resolve on Ctrl-C or SIGTERM (systemd stop).
async fn shutdown_signal() {
let ctrl_c = tokio::signal::ctrl_c();
#[cfg(unix)]
{
use tokio::signal::unix::{signal, SignalKind};
let mut term = match signal(SignalKind::terminate()) {
Ok(s) => s,
Err(_) => {
let _ = ctrl_c.await;
return;
}
};
tokio::select! {
_ = ctrl_c => {}
_ = term.recv() => {}
}
}
#[cfg(not(unix))]
{
let _ = ctrl_c.await;
}
}