Kernkomponenten¶
LXMFBot¶
Die Hauptklasse des Bots. Sie übernimmt das Routing von Nachrichten, die Befehlsverarbeitung und die Verwaltung des Bot-Lebenszyklus.
from lxmfy import LXMFBot
bot = LXMFBot(
name="MyBot",
announce=600,
announce_immediately=True,
admins=set(),
hot_reloading=False,
rate_limit=5,
cooldown=60,
max_warnings=3,
warning_timeout=300,
command_prefix="/",
cogs_dir="cogs",
cogs_enabled=True,
permissions_enabled=False,
storage_type="json", # "json", "sqlite" oder "memory"
storage_path="data",
first_message_enabled=True,
event_logging_enabled=True,
max_logged_events=1000,
event_middleware_enabled=True,
announce_enabled=True,
signature_verification_enabled=False,
require_message_signatures=False,
identity_pinning_enabled=False,
message_persistence_enabled=True,
dynamic_cogs_enabled=True,
external_cogs_enabled=True,
external_cogs_sandbox_enabled=True,
external_cogs_sandbox_type="auto", # "auto", "landlock", "bwrap", "firejail", "none"
external_cogs_timeout=30,
landlock_enabled=True,
nlp_enabled=False,
nlp_threshold=0.5,
link_support_enabled=False,
lxmf_commands_enabled=True,
message_queue_size=50,
reticulum_config_dir=None, # oder LXMFY_RETICULUM_CONFIG_DIR / "~/.reticulum"
rrc_enabled=False,
rrc_hubs=[],
rrc_rooms=[],
rrc_nick=None,
rrc_dest_name="rrc.hub",
rrc_auto_reconnect=True,
rrc_persist_sessions=True,
)
Wichtige Methoden¶
get_landlock_status(): Verfügbarkeit und Aktivierungsstatus der Landlock-LSM-Sandbox für den Bot-Prozess zurückgebenrun(delay=10): Hauptschleife des Bots startensend(destination, message, title="Reply", lxmf_fields=None, stamp_cost=None, opportunistic=None): Nachricht an ein Ziel senden, optional mit eigenen LXMF-Feldern, Überschreibung der Stamp-Kosten und opportunistischem Versand (versucht Direktzustellung, greift bei Konfiguration sofort auf Propagation zurück).send_with_attachment(destination, message, attachment, title="Reply", stamp_cost=None, opportunistic=None): Nachricht mit Anhang sendencommand(name, description="No description provided", admin_only=False, threaded=False): Dekorator zur Registrierung von Befehlen. Mitthreaded=Trueläuft der Befehls-Callback in einem separaten Thread. Befehle unterstützen typannotierte Argumente für automatische Konvertierung.intent(name, examples): Dekorator zur Registrierung von NLP-Intent-Handlern.nlp.export_model(): Trainierte NLP-Modelldaten exportieren.nlp.import_model(model_data): Zuvor exportierte NLP-Modelldaten importieren.request_link(destination_hash, callback=None, app_name="lxmf", *aspects): RNS-Link zu einem Ziel anfordern. Erlaubt eigenesapp_nameundaspects(Standard "lxmf" und "delivery").on_link(callback): Handler für eingehende RNS-Links registrieren.load_extension(name): Cog-Erweiterungsmodul anhand des Namens laden (z. B. "cogs.utility").reload_extension(name): Cog-Erweiterungsmodul neu laden.add_cog(cog_instance): Cog-Klasseninstanz zum Bot hinzufügen.remove_cog(cog_name): Cog anhand seines Klassennamens entfernen.on_first_message(): Dekorator zur Verarbeitung erster Nachrichten von Benutzernon_message(): Dekorator zur Verarbeitung aller Nachrichten (wird vor der Befehlsverarbeitung aufgerufen)on_reaction(): Dekorator zur Verarbeitung eingehender Reaktionen. Handler erhalten(sender, reaction), wobei reaction die Schlüsselreaction_to,reaction_emojiundreaction_senderenthältreact(destination, message_hash, reaction): Reaktion auf eine Nachricht über das LXMF-FeldFIELD_REACTIONsendenvalidate(): Validierungsprüfungen der Bot-Konfiguration ausführenconnect_rrc(hub_hash, rooms=None, nick=None, dest_name=None, auto_reconnect=None): Als Client mit einem RRC-Hub verbindendisconnect_rrc(hub_hash=None): Eine oder alle RRC-Hub-Sitzungen trennenon_rrc(callback=None): Dekorator oder Handler-Registrierung für RRC-Ereignisse (handler(event, client, payload))rrc:RRCManager-Instanz für Sitzungen mit mehreren Hubs
Strukturierte Befehle über LXMF-Felder¶
Bots können Befehle empfangen, die über das LXMF-Feld
FIELD_COMMANDS (0x09) gesendet werden, und antworten automatisch
mit FIELD_RESULTS (0x0A). Damit sind strukturierte
Anfrage/Antwort-Workflows neben normalen Textbefehlen möglich.
Eingehende FIELD_COMMANDS werden geparst und über dieselbe
Befehlsregistrierung wie Textbefehle geroutet, mit gemeinsamen
Berechtigungsprüfungen, typannotiertem Argument-Parsing, Threading und
Middleware.
from lxmfy import LXMFBot, FIELD_COMMANDS, FIELD_RESULTS, pack_result, unpack_commands
bot = LXMFBot(name="FieldBot")
@bot.command(name="status", description="Return bot status")
def status_cmd(ctx):
# ctx.fields enthält das rohe LXMF-Felder-Dict
# ctx.request_id wird automatisch gesetzt, wenn der Befehl eine enthielt
ctx.reply("Bot is online")
# Senden eines strukturierten Befehls von einem anderen LXMF-Client:
# lxm.fields[FIELD_COMMANDS] = {"command": "status", "args": [], "request_id": "abc123"}
# router.handle_outbound(lxm)
# Die Bot-Antwort enthält automatisch FIELD_RESULTS mit Antwort und request_id.
Um die Verarbeitung von Feldbefehlen zu deaktivieren,
lxmf_commands_enabled=False in BotConfig setzen.
Reaktionen¶
Reaktionen werden als LXMF-Feld FIELD_REACTION (0x40) in einer
ansonsten leeren Nachricht übertragen. pack_reaction und
unpack_reaction erzeugen und parsen dieses Feld.
from lxmfy import pack_reaction, unpack_reaction
# Eine Reaktion auf eine Nachricht senden
bot.react(destination_hash, message_hash_hex, "thumbs up emoji")
# Reaktionen empfangen
@bot.on_reaction()
def on_reaction(sender, reaction):
# reaction["reaction_to"] - Hex-Hash der Zielnachricht
# reaction["reaction_emoji"] - Reaktionstext (bis zu 16 Zeichen)
# reaction["reaction_sender"] - Absender
print(f"{sender} reacted {reaction['reaction_emoji']} to {reaction['reaction_to']}")
return True
Der Reaktionstext ist auf 16 druckbare Zeichen begrenzt. Das Rohfeld
bleibt in ctx.fields und msg.fields verfügbar (Kompatibilität).
Speicher¶
Das Framework bietet drei Speicher-Backends:
JSONStorage¶
SQLiteStorage¶
MemoryStorage¶
Befehle¶
Befehlsregistrierung und -verarbeitung:
@bot.command(name="hello", description="Says hello")
def hello(ctx):
ctx.reply(f"Hello {ctx.sender}!")
Typannotierte Argumente¶
Befehle parsen und konvertieren Argumente automatisch anhand der Typannotationen in der Callback-Funktion.
@bot.command(name="add", description="Adds two numbers")
def add(ctx, a: int, b: int):
result = a + b
ctx.reply(f"The result is {result}")
Hilfesystem¶
Das Framework enthält einen interaktiven Hilfe-Generator, der kategorisierte Hilfemenüs auf Basis der Cog- und Command-Metadaten erzeugt.
# Der help-Befehl wird automatisch registriert.
# Benutzer können '/help' oder '/help <command>' verwenden
Befehle in separaten Threads¶
Für lang laufende oder blockierende Operationen, die nicht direkt mit dem Reticulum Network Stack interagieren, können Befehle in einem separaten Thread laufen, damit der Bot reaktionsfähig bleibt.
import time
@bot.command(name="long_task", description="Performs a long-running task in a separate thread", threaded=True)
def long_task_command(ctx):
ctx.reply("Starting a long task... please wait.")
time.sleep(10) # Läuft in einem separaten Thread
ctx.reply("Long task completed!")
Threadsicherheit
Funktionen mit threaded=True dürfen nicht direkt mit dem
Reticulum Network Stack (RNS) oder Komponenten interagieren, die
auf lxmfy.transport.py aufbauen, da diese im Allgemeinen nicht
threadsicher sind. Verwenden Sie ctx.reply(), um aus einem
Threaded-Befehl heraus Nachrichten an den Benutzer zu senden.
Ereignisse¶
Ereignissystem zur Verarbeitung verschiedener Bot-Ereignisse:
@bot.events.on("message_received", EventPriority.HIGHEST)
def handle_message(event):
# Nachrichtenereignis verarbeiten
pass
Testen¶
Die Projekt-Tests umfassen Zuverlässigkeits- und Stresstest-Szenarien in der Testsuite des Repositorys. Führen Sie sie mit dem Test-Runner des Repositorys aus.
Erweiterte Zuverlässigkeits-Testsuite¶
Das Framework enthält eine umfangreiche Suite automatisierter Tests für raue Umgebungsbedingungen:
- Manifold Testing: Validiert die mathematische Topologie des NLP-Intent-Vektorraums.
- Chaos Engineering: Simuliert Bitrott, SD-Karten-Ausfall und Speicherkorruption.
- Temporal Drift: Prüft die Robustheit gegenüber Systemuhrsprüngen (±1 Jahr).
- Leak Detection: Langzeit-Überwachung von Speicher, Dateideskriptoren und Threads.
Berechtigungen¶
Berechtigungssystem zur Zugriffskontrolle auf Bot-Funktionen:
from lxmfy import DefaultPerms
@bot.command(name="admin", description="Admin command", admin_only=True)
def admin_command(ctx):
if ctx.is_admin:
ctx.reply("Admin command executed")
Middleware¶
Middleware-System zur Verarbeitung von Nachrichten und Ereignissen:
@bot.middleware.register(MiddlewareType.PRE_COMMAND)
def pre_command_middleware(ctx):
# Vor der Befehlsausführung verarbeiten
pass
Anhänge¶
Unterstützung für das Senden von Dateien, Bildern und Audio:
from lxmfy import Attachment, AttachmentType
attachment = Attachment(
type=AttachmentType.IMAGE,
name="image.jpg",
data=image_data,
format="jpg"
)
bot.send_with_attachment(destination, "Here's an image", attachment)
Icon-Darstellung (LXMF-Feld)¶
Sie können für Ihren Bot ein eigenes Icon setzen, das kompatible
LXMF-Clients anzeigen können. Dabei wird
LXMF.FIELD_ICON_APPEARANCE verwendet.
from lxmfy import IconAppearance, pack_icon_appearance_field
import LXMF # Erforderlich für LXMF.FIELD_ICON_APPEARANCE
# Icon-Darstellung definieren
icon_data = IconAppearance(
icon_name="smart_toy", # Name aus Material Symbols
fg_color=b'\xFF\xFF\xFF', # Weißer Vordergrund (3 Bytes)
bg_color=b'\x4A\x90\xE2' # Blauer Hintergrund (3 Bytes)
)
# In das LXMF-Feldformat packen
icon_lxmf_field = pack_icon_appearance_field(icon_data)
# Nachricht mit diesem Icon senden
bot.send(
destination_hash_str,
"Hello from your friendly bot!",
title="Bot Message",
lxmf_fields=icon_lxmf_field
)
# Kann auch mit anderen Feldern kombiniert werden, z. B. Anhängen:
# attachment_field = pack_attachment(some_attachment)
# combined_fields = {**icon_lxmf_field, **attachment_field}
# bot.send(destination, "Message with icon and attachment", lxmf_fields=combined_fields)
Scheduler¶
System zur Aufgabenplanung:
@bot.scheduler.schedule(name="daily_task", cron_expr="0 0 * * *")
def daily_task():
# Läuft täglich um Mitternacht
pass
Signaturen¶
LXMFy bietet Konfigurationsoptionen für die in LXMF eingebaute kryptografische Nachrichtensignierung und -prüfung:
from lxmfy import LXMFBot
bot = LXMFBot(
name="SecureBot",
signature_verification_enabled=True, # Signaturprüfung aktivieren
require_message_signatures=False # Auf True setzen, um unsignierte Nachrichten abzulehnen
)
Verarbeitung von Signaturen
LXMF führt alle kryptografischen Signatur- und Prüfoperationen
automatisch mit RNS-Identitäten aus. Der SignatureManager von
LXMFy ist eine Konfigurationsschicht, die:
- steuert, ob die Signaturprüfung erzwungen wird
- die Richtlinie für unsignierte Nachrichten festlegt (annehmen oder ablehnen)
- sich in das Berechtigungssystem integriert (z. B. Prüfung für vertrauenswürdige Benutzer umgehen)
Die eigentlichen kryptografischen Operationen führt LXMF/RNS aus, nicht LXMFy.
Landlock-LSM-Sandbox¶
Auf Linux-Kerneln mit Landlock-Unterstützung (5.13+) kann LXMFy den Dateisystemzugriff für den Bot-Prozess und für externe Skript-Cogs einschränken.
Sandbox des Bot-Prozesses
Wenn landlock_enabled=True (Standard) und der Bot nicht im
test_mode läuft, ruft der Bot apply_landlock_sandbox() während
der Initialisierung auf. Systemverzeichnisse sind nur lesbar.
Bot-Speicher, Konfiguration, Cogs, Reticulum-Konfiguration und
Temp-Pfade bleiben schreibbar.
bot = LXMFBot(
name="SecureBot",
landlock_enabled=True,
)
status = bot.get_landlock_status()
# status-Schlüssel: landlock_kernel_supported, landlock_requested,
# landlock_auto_enabled, landlock_disabled_by_env, landlock_active
Überschreibung per Umgebungsvariable
LXMFY_LANDLOCK=0: Landlock auch auf unterstützten Kerneln deaktivierenLXMFY_LANDLOCK=1: Landlock unter Linux unabhängig von der Auto-Erkennung versuchen- nicht gesetzt:
landlock_enabledund Kernel-Auto-Erkennung folgen
Sandbox für externe Cogs
Skript-Cogs verwenden external_cogs_sandbox_type. Im Modus auto
wird Landlock bevorzugt, wenn verfügbar, da keine externen Werkzeuge
nötig sind. Die vollständige Liste der Sandbox-Optionen steht in der
Anleitung Bots erstellen.
Identitäts-Pinning¶
LXMFy unterstützt optionales Identitäts-Pinning, um Identitätsdiebstahl zu verhindern, falls eine Identität rotiert oder kompromittiert wird. Wenn aktiviert, "pinnt" der Bot eine LXMF-Adresse an den zuerst gesehenen öffentlichen Schlüssel.
SignatureManager-Methoden¶
Der SignatureManager ist als bot.signature_manager verfügbar,
wenn signature_verification_enabled=True:
should_verify_message(sender): Feststellen, ob eine Nachricht des gegebenen Absenders geprüft werden sollhandle_unsigned_message(sender, message_hash): Nachrichten ohne gültige Signatur gemäß Richtlinie behandeln
Wie LXMF-Signaturen funktionieren¶
LXMF signiert alle ausgehenden Nachrichten automatisch mit der
RNS-Identität des Absenders während der pack()-Operation. Beim
Empfang validiert LXMF die Signaturen und stellt bereit:
message.signature_validated: Boolescher Wert, ob die Signatur gültig istmessage.unverified_reason: Grundcode, falls die Validierung fehlschlug (z. B.SIGNATURE_INVALID,SOURCE_UNKNOWN)
LXMFy nutzt diese eingebauten LXMF-Eigenschaften, um die Signaturrichtlinie Ihres Bots durchzusetzen.
Nachrichtenzustellung¶
LXMFy bietet erweiterte Zustellfunktionen, darunter Propagationsknoten und automatische Wiederholungen:
Propagationsknoten¶
Nachrichten über bestimmte Propagationsknoten senden, um die Zustellzuverlässigkeit im Reticulum-Netzwerk zu erhöhen:
# Propagationsknoten einmalig auf Konfigurations-/Laufzeitebene setzen
bot.set_propagation_node("<propagation_node_hash>")
# Mit konfiguriertem Zustellverhalten senden
bot.send(
destination_hash,
"Message content"
)
# Der Propagationsknoten-Hash sollte ein gültiger LXMF-Propagationsknoten
# im Reticulum-Netzwerk sein
Automatische Wiederholungen¶
Automatische Wiederholungsversuche für fehlgeschlagene Direktzustellungen konfigurieren:
bot = LXMFBot(
name="ReliableBot",
direct_delivery_retries=5, # Direktzustellung bis zu 5-mal wiederholen
propagation_fallback_enabled=True
)
bot.send(destination_hash, "Important message")
# direct_delivery_retries ist standardmäßig 3
# Die Wiederholungslogik verarbeitet Zustell-Callbacks automatisch
Das Wiederholungssystem verfolgt Zustellversuche pro Ziel und wiederholt fehlgeschlagene Zustellungen automatisch. Erfolgreiche Zustellungen setzen den Zähler für dieses Ziel zurück.
Nachrichten-Persistenz¶
Ausgehende Nachrichten können auf die Festplatte persistiert werden,
damit sie auch nach einem Neustart des Bots zugestellt werden.
Persistenz ist standardmäßig aktiviert. Die Ausgangswarteschlange im
Speicher ist begrenzt (message_queue_size, Standard 50) und
verwirft bei Volllast die älteste Nachricht. Ungültige Ziel-Hashes
werden nicht wiederhergestellt.
Nachrichten-Handler¶
LXMFy stellt Dekoratoren für verschiedene Arten eingehender Nachrichten bereit:
Handler für erste Nachrichten¶
Die erste Nachricht jedes Benutzers verarbeiten:
@bot.on_first_message()
def welcome_user(sender, message):
content = message.content.decode("utf-8")
bot.send(sender, f"Welcome! You said: {content}")
return True # True zurückgeben, um die weitere Verarbeitung zu stoppen
Allgemeiner Nachrichten-Handler¶
Alle eingehenden Nachrichten vor der Befehlsverarbeitung verarbeiten:
@bot.on_message()
def handle_all_messages(sender, message):
content = message.content.decode("utf-8").strip()
# Eigene Logik hier
if content.startswith("echo:"):
bot.send(sender, content[5:])
return True # Weitere Verarbeitung stoppen
return False # Weiter zur Befehlsverarbeitung
Nachrichten-Handler werden in dieser Reihenfolge aufgerufen:
1. Handler für erste Nachrichten (wenn dies die erste Nachricht
dieses Absenders ist) 2. Allgemeine Nachrichten-Handler (registriert
mit on_message()) 3. Befehlsverarbeitung (wenn die Nachricht mit
dem Befehlspräfix beginnt)
Reticulum Relay Chat (RRC)¶
Bots können RRC-Hubs über RNS-Links mit
CBOR-Envelopes beitreten. Paket: lxmfy.rrc.
BotConfig-Optionen¶
rrc_enabled(bool, StandardFalse): Konfigurierte Hubs beim Start verbindenrrc_hubs(Liste von Hex-Hashes): Ziel-Hashes der Hubsrrc_rooms(Liste von Strings): Räume, die nach WELCOME automatisch betreten werdenrrc_nick(String oder None): Nickname in HELLO und Raumnachrichtenrrc_dest_name(String, Standard"rrc.hub"): Zielname zum Aufbau der Hub-Destinationrrc_auto_reconnect(bool, StandardTrue): Nach Link-Verlust neu verbindenrrc_persist_sessions(bool, StandardTrue): Hubs und Räume über Neustarts hinweg speichernreticulum_config_dir(String oder None): Reticulum-Konfigurationsverzeichnis. Kann auch überLXMFY_RETICULUM_CONFIG_DIRgesetzt werden. Dieselbe Konfiguration wie MeshChatX verwenden (oft~/.reticulum), damit Hub-Announces sichtbar sind.
Beispiel¶
from lxmfy import LXMFBot, RRCMessage
bot = LXMFBot(
name="RoomBot",
reticulum_config_dir="~/.reticulum",
rrc_enabled=True,
rrc_hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rrc_rooms=["general"],
rrc_nick="RoomBot",
)
@bot.on_rrc
def on_rrc(event, client, payload):
if event == "msg" and isinstance(payload, RRCMessage) and payload.mention:
client.send_message(payload.room, f"Hi {payload.nick}")
# Laufzeit-API
# bot.connect_rrc(hub_hash, rooms=["general"])
# bot.rrc.send_message("general", "hello")
# bot.rrc.send_notice("general", "notice")
# bot.rrc.send_action("general", "waves")
# bot.rrc.join("ops")
# bot.rrc.part("ops")
# bot.rrc.status()
# bot.disconnect_rrc()
Exportierte Typen¶
RRCClient: Sitzung mit einem HubRRCManager: Manager für mehrere Hubs (bot.rrc)RRCMessage: Payload eines Raumereignisses (kind,room,text,nick,src,mention, ...)RRC_VERSION: Konstante der Wire-Protokollversion
Übliche Ereignisse, die an @bot.on_rrc-Handler übergeben werden:
status, welcome, joined, parted, msg, notice, action,
motd, error und rtt.
Vorlagen¶
Das Framework enthält mehrere einsatzbereite Bot-Vorlagen:
EchoBot¶
Einfacher Echo-Bot, der Nachrichten wiederholt:
NoteBot¶
Notizen-Bot mit JSON-Speicher:
ReminderBot¶
Erinnerungs-Bot mit SQLite-Speicher:
RRCBot¶
RRC-Raum-Bot, der konfigurierten Hubs beitritt und auf @mentions
antwortet. Standardmäßig Hub 664fc0e8d2e448658e37bb3f34e6c88f,
Raum #general und ~/.reticulum, falls verfügbar.
from lxmfy.templates import RRCBot
bot = RRCBot(
hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rooms=["general"],
nick="RRCBot",
reticulum_config_dir="~/.reticulum",
)
bot.run()
CLI-Werkzeuge¶
Das Framework stellt Kommandozeilen-Werkzeuge für die Bot-Verwaltung bereit:
# Neuen Bot erstellen
lxmfy create mybot
# Bot aus Vorlage erstellen
lxmfy create --template echo mybot
lxmfy create --template rrc my_rrc_bot
# Vorlagen-Bot ausführen
lxmfy run echo
lxmfy run rrc
# Signaturprüfung mit einer Nachricht testen
lxmfy signatures test
# Signaturprüfung aktivieren
lxmfy signatures enable
# Signaturprüfung deaktivieren
lxmfy signatures disable
Fehlerbehandlung¶
Shutdown- und Laufzeitfehler rund um bot.run() abfangen:
try:
bot.run()
except KeyboardInterrupt:
bot.cleanup()
except Exception as e:
logger.error(f"Error running bot: {str(e)}")
Modulreferenz¶
Wird aus den Docstrings des Quellcodes generiert.
Bases: AnnounceMixin, DispatchMixin, CogMixin, InboundMixin, OutboundMixin, LinkMixin, RRCMixin, PropagationMixin
Main bot class for handling LXMF messages and commands.
This class manages the bot's lifecycle, including: - Message routing and delivery - Command registration and execution - Cog (extension) loading and management - Spam protection - Admin privileges
Source code in lxmfy/core.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 | |
__init__(name=None, **kwargs)
¶
Initialize a new LXMFBot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str | None
|
Optional bot name, same as the name config key. |
None
|
**kwargs
|
Any
|
Override default configuration settings |
{}
|
Source code in lxmfy/core.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | |
cleanup()
¶
Clean up resources.
Source code in lxmfy/core.py
diagnose_connectivity(destination=None, *, request_path=False, wait=0.0)
¶
Run a connectivity doctor report for this bot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str | None
|
Optional peer hash to include in send diagnosis. |
None
|
request_path
|
bool
|
Request a path when probing destination. |
False
|
wait
|
float
|
Seconds to wait for path discovery. |
0.0
|
Returns:
| Type | Description |
|---|---|
dict
|
Structured doctor report dict. |
Source code in lxmfy/core.py
diagnose_destination(destination, *, request_path=False, wait=0.0)
¶
Probe path and identity for a destination hash.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str
|
Hex destination hash. |
required |
request_path
|
bool
|
Whether to request a path if missing. |
False
|
wait
|
float
|
Seconds to wait for a path after requesting. |
0.0
|
Returns:
| Type | Description |
|---|---|
dict
|
Dict describing identity/path status and hints. |
Source code in lxmfy/core.py
get_debugger()
¶
get_landlock_status()
¶
Return Landlock LSM sandbox availability and activation state.
on_delivery_event(callback=None)
¶
Subscribe to the outbound delivery event stream.
Usable as bot.on_delivery_event(fn) or as a decorator @bot.on_delivery_event(). Subscribers receive event dicts with ts, stage (queued, deferred, dispatched, delivered, failed, cancelled, dropped), and destination/message_id/hash/reason fields when available.
Source code in lxmfy/core.py
request_page(destination_hash, page_path, field_data=None)
¶
Request a page from a destination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination_hash
|
str
|
The destination hash. |
required |
page_path
|
str
|
The path to the page. |
required |
field_data
|
dict | None
|
Optional field data to send with the request. |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
The response from the destination. |
Source code in lxmfy/core.py
run(delay=10)
¶
Run the bot
Source code in lxmfy/core.py
Configuration settings for LXMFBot.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the bot. Defaults to "LXMFBot". |
announce |
int
|
The announce interval in seconds. Defaults to 600. |
announce_immediately |
bool
|
Whether to announce immediately on startup. Defaults to True. |
admins |
set
|
A set of admin identity hashes. Defaults to an empty set. |
hot_reloading |
bool
|
Whether to enable hot reloading of cogs. Defaults to False. |
rate_limit |
int
|
The maximum number of messages allowed per cooldown period. Defaults to 5. |
cooldown |
int
|
The cooldown period in seconds. Defaults to 60. |
max_warnings |
int
|
The maximum number of spam warnings before action is taken. Defaults to 3. |
warning_timeout |
int
|
The duration in seconds for which a spam warning is active. Defaults to 300. |
command_prefix |
str
|
The prefix for bot commands. Defaults to "/". |
cogs_dir |
str
|
The directory to load cogs from. Defaults to "cogs". |
cogs_enabled |
bool
|
Whether to enable cogs. Defaults to True. |
permissions_enabled |
bool
|
Whether to enable the permission system. Defaults to False. |
storage_type |
str
|
The type of storage to use ("json" or "sqlite"). Defaults to "json". |
storage_path |
str
|
The path to the storage file or directory. Defaults to "data". |
first_message_enabled |
bool
|
Whether to enable first message handling. Defaults to True. |
event_logging_enabled |
bool
|
Whether to enable event logging. Defaults to True. |
max_logged_events |
int
|
The maximum number of events to log. Defaults to 1000. |
event_middleware_enabled |
bool
|
Whether to enable event middleware. Defaults to True. |
announce_enabled |
bool
|
Whether to enable bot announcements. Defaults to True. |
signature_verification_enabled |
bool
|
Whether to enable cryptographic signature verification for incoming messages. Defaults to False. |
require_message_signatures |
bool
|
Whether to reject unsigned messages when signature verification is enabled. Defaults to False. |
require_stamps |
bool
|
Whether to reject messages with invalid stamps. Defaults to False. |
request_unknown_identities |
bool
|
Whether to request unknown identities from the network when a message is received from an unknown source. Defaults to False. |
stamp_cost |
int
|
Stamp cost required for messages to this bot. Outbound cost still comes from the peer announce unless send() overrides it. None disables inbound stamps. Defaults to None. |
include_tickets |
bool
|
Include reply tickets on outbound messages so peers that require stamps can answer without stamp generation. Defaults to True. |
direct_delivery_retries |
int
|
Number of times to retry direct delivery before falling back to propagation. Defaults to 3. |
propagation_fallback_enabled |
bool
|
Whether to use propagation nodes as fallback after direct delivery fails. Defaults to True. |
propagation_node |
str
|
The destination hash of the outbound propagation node. If None and autopeer_propagation is True, automatically discovers nodes. Defaults to None. |
autopeer_propagation |
bool
|
Whether to automatically discover and peer with propagation nodes from announces. Defaults to False. |
autopeer_maxdepth |
int
|
Maximum hop depth for auto-peering with propagation nodes. None = no limit. Defaults to 4. |
enable_propagation_node |
bool
|
Whether to run this bot as a propagation node. Defaults to False. |
message_storage_limit_mb |
float
|
Maximum storage for propagation node messages in megabytes. Only applies when enable_propagation_node is True. Defaults to 500 MB. |
config_path |
str
|
The path to the bot configuration directory. If None, defaults to "config" in the current working directory. Defaults to None. |
reticulum_config_dir |
str
|
The Reticulum config directory used for RNS shared instance/auth state. If None, uses LXMFY_RETICULUM_CONFIG_DIR when set, otherwise discovers the user/system Reticulum config (/etc/reticulum, ~/.config/reticulum, ~/.reticulum), and only then falls back to config_path. Isolated bot configs force share_instance=No to avoid RPC digest rejection with NomadNet/Columba. |
test_mode |
bool
|
Whether to run in test mode (skips RNS initialization). Defaults to False. |
log_level |
str or int or None
|
Logging level for lxmfy's own logger ("DEBUG", "INFO", "WARNING", ...). None leaves logging untouched. Defaults to "INFO". |
loglevel |
int
|
RNS log level (0-7) passed to RNS.Reticulum. None uses the Reticulum config file setting. Defaults to None. |
pending_sends_enabled |
bool
|
Hold outbound messages when the destination identity is not yet known, retrying on announces and periodic sweeps. Defaults to True. |
pending_sends_max |
int
|
Maximum deferred messages kept for unknown destinations. Oldest are dropped beyond this. Defaults to 200. |
pending_sends_ttl |
int
|
Seconds a deferred message is kept before being dropped. Defaults to 604800 (7 days). |
pending_sends_retry |
int
|
Minimum seconds between deferred-send sweeps in run(). Defaults to 300. |
announce_display_name_file |
str
|
Optional filename under config_path whose UTF-8 contents override the bot display name for LXMF delivery announces. If unset, |
Source code in lxmfy/config.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | |
__post_init__()
¶
Post-initialization to ensure admins is a set.
Source code in lxmfy/config.py
__str__()
¶
Return a string representation of the BotConfig object.
Source code in lxmfy/config.py
Represents a generic attachment.
Attributes:
| Name | Type | Description |
|---|---|---|
type |
AttachmentType
|
The type of the attachment (AttachmentType). |
name |
str
|
The name of the attachment. |
data |
bytes
|
The binary data of the attachment. |
format |
str | None
|
Optional format specifier (e.g., "png" for images). |
Source code in lxmfy/attachments.py
Bases: IntEnum
Enumerates the different types of attachments supported.
FILE: Represents a generic file attachment. IMAGE: Represents an image attachment. AUDIO: Represents an audio attachment.
Source code in lxmfy/attachments.py
Bases: Flag
Default permission set
Source code in lxmfy/permissions.py
Manages permissions, roles, and user assignments
Source code in lxmfy/permissions.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | |
assign_role(user, role_name)
¶
Assign a role to a user
Source code in lxmfy/permissions.py
create_role(name, permissions, priority=0, description=None)
¶
Create a new role
Source code in lxmfy/permissions.py
delete_role(name)
¶
Delete a role
Source code in lxmfy/permissions.py
get_user_permissions(user)
¶
Get combined permissions for a user
Source code in lxmfy/permissions.py
has_permission(user, permission)
¶
Check if user has specific permission
load_data()
¶
Load permission data from storage
Source code in lxmfy/permissions.py
remove_role(user, role_name)
¶
Remove a role from a user
Source code in lxmfy/permissions.py
save_data()
¶
Save permission data to storage
Source code in lxmfy/permissions.py
Manages scheduled tasks and background processes.
Source code in lxmfy/scheduler.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
__init__(bot)
¶
Initialize the TaskScheduler.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Any
|
The bot instance. |
required |
Source code in lxmfy/scheduler.py
add_task(name, callback, cron_expr)
¶
Add a scheduled task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task. |
required |
callback
|
Callable
|
The function to execute when the task runs. |
required |
cron_expr
|
str
|
A cron-style expression defining when the task should run. |
required |
Source code in lxmfy/scheduler.py
remove_task(name)
¶
Remove a scheduled task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task to remove. |
required |
schedule(name, cron_expr)
¶
Decorator to schedule a task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task. |
required |
cron_expr
|
str
|
The cron expression for the task. |
required |
Source code in lxmfy/scheduler.py
start()
¶
A scheduled task with cron-style timing.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the task. |
callback |
Callable
|
The function to execute when the task runs. |
cron_expr |
str
|
A cron-style expression defining when the task should run (min hour day month weekday). |
last_run |
Optional[datetime]
|
The last time the task was run. |
enabled |
bool
|
Whether the task is currently enabled. |
Source code in lxmfy/scheduler.py
should_run(current_time)
¶
Check if the task should run at the given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
current_time
|
datetime
|
The current datetime. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the task should run, False otherwise. |
Source code in lxmfy/scheduler.py
Facade for the underlying storage backend.
Source code in lxmfy/storage.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 | |
__init__(backend)
¶
Initialize a new Storage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
backend
|
StorageBackend
|
The storage backend to use. |
required |
delete(key)
¶
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
get_role_data(role_name)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_name
|
str
|
The name of the role. |
required |
Returns:
| Type | Description |
|---|---|
dict
|
The role data. |
get_user_roles(user_hash)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_hash
|
str
|
The hash of the user. |
required |
Returns:
| Type | Description |
|---|---|
list[str]
|
The list of roles for the user. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |
set_role_data(role_name, data)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_name
|
str
|
The name of the role. |
required |
data
|
dict
|
The role data. |
required |
set_user_roles(user_hash, roles)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_hash
|
str
|
The hash of the user. |
required |
roles
|
list[str]
|
The list of roles for the user. |
required |
Bases: StorageBackend
JSON file-based storage backend.
Source code in lxmfy/storage.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
__init__(directory)
¶
Initialize a new JSONStorage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
directory
|
str
|
The directory to store the JSON files in. |
required |
Source code in lxmfy/storage.py
delete(key)
¶
Delete a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to delete. |
required |
Source code in lxmfy/storage.py
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
Source code in lxmfy/storage.py
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |
Source code in lxmfy/storage.py
Bases: StorageBackend
SQLite database storage backend.
Source code in lxmfy/storage.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | |
__init__(database_path)
¶
Initialize a new SQLiteStorage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
database_path
|
str
|
The path to the SQLite database file. |
required |
Source code in lxmfy/storage.py
delete(key)
¶
Delete a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to delete. |
required |
Source code in lxmfy/storage.py
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
Source code in lxmfy/storage.py
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
Source code in lxmfy/storage.py
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |