Composants principaux¶
LXMFBot¶
La classe principale du bot, qui gère le routage des messages, le traitement des commandes et le cycle de vie du bot.
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", ou "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, # ou 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,
)
Méthodes principales¶
get_landlock_status(): renvoie la disponibilité et l'état d'activation de la sandbox Landlock LSM pour le processus du botrun(delay=10): démarre la boucle principale du botsend(destination, message, title="Reply", lxmf_fields=None, stamp_cost=None, opportunistic=None): envoie un message à une destination, avec en option des champs LXMF personnalisés, une surcharge du coût de tampon, et un envoi opportuniste (essaie la livraison directe, puis bascule immédiatement sur la propagation si configuré).send_with_attachment(destination, message, attachment, title="Reply", stamp_cost=None, opportunistic=None): envoie un message avec une pièce jointecommand(name, description="No description provided", admin_only=False, threaded=False): décorateur pour enregistrer des commandes. Définissezthreaded=Truepour exécuter le callback de la commande dans un thread séparé. Les commandes prennent en charge les arguments avec annotations de type pour la conversion automatique.intent(name, examples): décorateur pour enregistrer des gestionnaires d'intentions NLP.nlp.export_model(): exporte les données du modèle NLP entraîné.nlp.import_model(model_data): importe des données de modèle NLP précédemment exportées.request_link(destination_hash, callback=None, app_name="lxmf", *aspects): demande un lien RNS vers une destination. Permet unapp_nameet desaspectspersonnalisés (par défaut "lxmf" et "delivery").on_link(callback): enregistre un gestionnaire pour les liens RNS entrants.load_extension(name): charge un module d'extension cog par nom (par ex. "cogs.utility").reload_extension(name): recharge un module d'extension cog.add_cog(cog_instance): ajoute une instance de classe cog au bot.remove_cog(cog_name): retire un cog du bot par son nom de classe.on_first_message(): décorateur pour gérer les premiers messages des utilisateurson_message(): décorateur pour gérer tous les messages (appelé avant le traitement des commandes)on_reaction(): décorateur pour gérer les réactions entrantes. Les gestionnaires reçoivent(sender, reaction)où reaction porte les clésreaction_to,reaction_emojietreaction_senderreact(destination, message_hash, reaction): envoie une réaction à un message via le champ LXMFFIELD_REACTIONvalidate(): exécute les vérifications de validation sur la configuration du botconnect_rrc(hub_hash, rooms=None, nick=None, dest_name=None, auto_reconnect=None): se connecte à un hub RRC en tant que clientdisconnect_rrc(hub_hash=None): déconnecte une ou toutes les sessions de hubs RRCon_rrc(callback=None): décorateur ou enregistrement de gestionnaire pour les événements RRC (handler(event, client, payload))rrc: instanceRRCManagerpour les sessions multi-hubs
Commandes structurées via les champs LXMF¶
Les bots peuvent recevoir des commandes envoyées via le champ LXMF
FIELD_COMMANDS (0x09) et répondre automatiquement avec
FIELD_RESULTS (0x0A). Cela permet des flux requête/réponse
structurés en parallèle des commandes textuelles normales.
Les FIELD_COMMANDS entrants sont analysés et routés dans le même
registre de commandes que les commandes textuelles, en partageant les
vérifications de permissions, l'analyse des arguments annotés, le
threading et le 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 contient le dict brut des champs LXMF
# ctx.request_id est renseigné automatiquement si la commande en incluait un
ctx.reply("Bot is online")
# Envoi d'une commande structurée depuis un autre client LXMF :
# lxm.fields[FIELD_COMMANDS] = {"command": "status", "args": [], "request_id": "abc123"}
# router.handle_outbound(lxm)
# La réponse du bot inclut automatiquement FIELD_RESULTS avec la réponse et le request_id.
Pour désactiver le traitement des commandes par champs, définissez
lxmf_commands_enabled=False dans BotConfig.
Réactions¶
Les réactions voyagent dans le champ LXMF FIELD_REACTION (0x40)
d'un message par ailleurs vide. pack_reaction et unpack_reaction
construisent et analysent ce champ.
from lxmfy import pack_reaction, unpack_reaction
# Envoyer une réaction à un message
bot.react(destination_hash, message_hash_hex, "thumbs up emoji")
# Recevoir des réactions
@bot.on_reaction()
def on_reaction(sender, reaction):
# reaction["reaction_to"] - hachage hex du message cible
# reaction["reaction_emoji"] - texte de la réaction (16 caractères max)
# reaction["reaction_sender"] - expéditeur
print(f"{sender} reacted {reaction['reaction_emoji']} to {reaction['reaction_to']}")
return True
Le texte de réaction est limité à 16 caractères imprimables. Le champ
brut reste disponible dans ctx.fields et msg.fields pour la
compatibilité.
Stockage¶
Le framework fournit trois backends de stockage :
JSONStorage¶
SQLiteStorage¶
MemoryStorage¶
Commandes¶
Enregistrement et traitement des commandes :
@bot.command(name="hello", description="Says hello")
def hello(ctx):
ctx.reply(f"Hello {ctx.sender}!")
Arguments avec annotations de type¶
Les commandes analysent et convertissent automatiquement les arguments d'après les annotations de type de la fonction de callback.
@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}")
Système d'aide¶
Le framework inclut un générateur d'aide interactif qui produit des menus d'aide catégorisés à partir des métadonnées des cogs et des commandes.
# La commande help est enregistrée automatiquement.
# Les utilisateurs peuvent utiliser '/help' ou '/help <command>'
Commandes en thread¶
Pour les opérations longues ou bloquantes qui n'interagissent pas directement avec le Reticulum Network Stack, vous pouvez exécuter les commandes dans un thread séparé pour garder le bot réactif.
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) # S'exécute dans un thread séparé
ctx.reply("Long task completed!")
Sécurité des threads
Les fonctions marquées threaded=True ne doivent pas interagir
directement avec le Reticulum Network Stack (RNS) ni avec les
composants qui dépendent de lxmfy.transport.py, car ils ne sont
généralement pas thread-safe. Utilisez ctx.reply() pour renvoyer
des messages à l'utilisateur depuis une commande en thread.
Événements¶
Système d'événements pour gérer les différents événements du bot :
@bot.events.on("message_received", EventPriority.HIGHEST)
def handle_message(event):
# Traiter l'événement message
pass
Tests¶
Les tests du projet incluent des scénarios de fiabilité et de charge dans la suite de tests du dépôt. Utilisez le lanceur de tests du dépôt pour les exécuter.
Suite avancée de fiabilité¶
Le framework inclut une suite étendue de tests automatisés pour les environnements difficiles :
- Manifold Testing : valide la topologie mathématique de l'espace vectoriel des intentions NLP.
- Chaos Engineering : simule le bit rot, les pannes de carte SD et la corruption du stockage.
- Temporal Drift : vérifie la résilience face aux sauts d'horloge système (±1 an).
- Leak Detection : suivi à long terme de la mémoire, des descripteurs de fichiers et des threads.
Permissions¶
Système de permissions pour contrôler l'accès aux fonctions du bot :
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¶
Système de middleware pour traiter les messages et les événements :
@bot.middleware.register(MiddlewareType.PRE_COMMAND)
def pre_command_middleware(ctx):
# Traitement avant l'exécution de la commande
pass
Pièces jointes¶
Prise en charge de l'envoi de fichiers, d'images et d'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)
Apparence de l'icône (champ LXMF)¶
Vous pouvez définir une icône personnalisée pour votre bot, que les
clients LXMF compatibles peuvent afficher. Elle utilise le champ
LXMF.FIELD_ICON_APPEARANCE.
from lxmfy import IconAppearance, pack_icon_appearance_field
import LXMF # Requis pour LXMF.FIELD_ICON_APPEARANCE
# Définir l'apparence de l'icône
icon_data = IconAppearance(
icon_name="smart_toy", # Nom depuis Material Symbols
fg_color=b'\xFF\xFF\xFF', # Premier plan blanc (3 octets)
bg_color=b'\x4A\x90\xE2' # Arrière-plan bleu (3 octets)
)
# L'empaqueter au format du champ LXMF
icon_lxmf_field = pack_icon_appearance_field(icon_data)
# Envoyer un message avec cette icône
bot.send(
destination_hash_str,
"Hello from your friendly bot!",
title="Bot Message",
lxmf_fields=icon_lxmf_field
)
# Vous pouvez aussi la combiner avec d'autres champs, comme des pièces jointes :
# 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)
Planificateur¶
Système de planification de tâches :
@bot.scheduler.schedule(name="daily_task", cron_expr="0 0 * * *")
def daily_task():
# Exécution quotidienne à minuit
pass
Signatures¶
LXMFy fournit des options de configuration pour la signature et la vérification cryptographiques intégrées de LXMF :
from lxmfy import LXMFBot
bot = LXMFBot(
name="SecureBot",
signature_verification_enabled=True, # Activer les vérifications de signature
require_message_signatures=False # Mettre True pour rejeter les messages non signés
)
Gestion des signatures
LXMF gère automatiquement toute la signature et la vérification
cryptographiques via les identités RNS. Le SignatureManager de
LXMFy est une couche de configuration qui :
- Contrôle si la vérification des signatures est appliquée
- Détermine la politique pour les messages non signés (accepter ou rejeter)
- S'intègre au système de permissions (par ex. contourner la vérification pour les utilisateurs de confiance)
Les opérations cryptographiques réelles sont effectuées par LXMF/RNS, pas par LXMFy.
Sandbox Landlock LSM¶
Sur les noyaux Linux prenant en charge Landlock (5.13+), LXMFy peut restreindre l'accès au système de fichiers pour le processus du bot et pour les cogs en scripts externes.
Sandbox du processus du bot
Quand landlock_enabled=True (défaut) et hors test_mode, le bot
appelle apply_landlock_sandbox() pendant l'initialisation. Les
répertoires système sont en lecture seule. Le stockage du bot, la
config, les cogs, la config Reticulum et les chemins temporaires
restent inscriptibles.
bot = LXMFBot(
name="SecureBot",
landlock_enabled=True,
)
status = bot.get_landlock_status()
# clés de status : landlock_kernel_supported, landlock_requested,
# landlock_auto_enabled, landlock_disabled_by_env, landlock_active
Surcharge par variable d'environnement
LXMFY_LANDLOCK=0: désactive Landlock même sur les noyaux compatiblesLXMFY_LANDLOCK=1: tente Landlock sous Linux quelle que soit l'auto-détection- non définie : suit
landlock_enabledet l'auto-détection du noyau
Sandbox des cogs externes
Les cogs en scripts utilisent external_cogs_sandbox_type. En mode
auto, Landlock est préféré quand il est disponible car il ne requiert
aucun outil externe. Voir le guide Création de
bots pour la liste complète des options de sandbox.
Épinglage d'identité¶
LXMFy prend en charge un épinglage d'identité optionnel pour empêcher l'usurpation si une identité est remplacée ou compromise. Quand il est activé, le bot "épingle" une adresse LXMF à la première clé publique vue.
Méthodes de SignatureManager¶
Le SignatureManager est disponible via bot.signature_manager quand
signature_verification_enabled=True :
should_verify_message(sender): détermine si un message d'un expéditeur donné doit être vérifiéhandle_unsigned_message(sender, message_hash): traite les messages sans signature valide selon la politique
Fonctionnement des signatures LXMF¶
LXMF signe automatiquement tous les messages sortants avec l'identité
RNS de l'expéditeur pendant l'opération pack(). À la réception, LXMF
valide les signatures et fournit :
message.signature_validated: booléen indiquant si la signature est validemessage.unverified_reason: code de raison si la validation a échoué (par ex.SIGNATURE_INVALID,SOURCE_UNKNOWN)
LXMFy utilise ces propriétés LXMF intégrées pour appliquer la politique de signature de votre bot.
Livraison des messages¶
LXMFy fournit des fonctions de livraison de messages avancées, dont les nœuds de propagation et les réessais automatiques :
Nœuds de propagation¶
Envoyez des messages via des nœuds de propagation précis pour une meilleure fiabilité sur le réseau Reticulum :
# Configurer le nœud de propagation une fois, au niveau config/runtime
bot.set_propagation_node("<propagation_node_hash>")
# Envoyer avec le comportement de livraison configuré
bot.send(
destination_hash,
"Message content"
)
# Le hachage du nœud de propagation doit être un nœud de propagation LXMF valide
# sur le réseau Reticulum
Réessais automatiques¶
Configurez les réessais automatiques pour les livraisons directes échouées :
bot = LXMFBot(
name="ReliableBot",
direct_delivery_retries=5, # Réessayer la livraison directe jusqu'à 5 fois
propagation_fallback_enabled=True
)
bot.send(destination_hash, "Important message")
# direct_delivery_retries vaut 3 par défaut
# La logique de réessai gère automatiquement les callbacks de livraison
Le système de réessais suit les tentatives de livraison par destination et réessaie automatiquement les livraisons échouées. Les livraisons réussies remettent le compteur de réessais à zéro pour cette destination.
Persistance des messages¶
Les messages sortants peuvent être persistés sur disque pour garantir
leur livraison même après un redémarrage du bot. La persistance est
activée par défaut. La file sortante en mémoire est bornée
(message_queue_size, défaut 50) et supprime le plus ancien message
quand elle est pleine. Les hachages de destination invalides ne sont
pas restaurés.
Gestionnaires de messages¶
LXMFy fournit des décorateurs pour gérer différents types de messages entrants :
Gestionnaire de premier message¶
Gérez le premier message de chaque utilisateur :
@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 # Renvoyer True pour arrêter le traitement
Gestionnaire de messages général¶
Gérez tous les messages entrants avant le traitement des commandes :
@bot.on_message()
def handle_all_messages(sender, message):
content = message.content.decode("utf-8").strip()
# Logique personnalisée ici
if content.startswith("echo:"):
bot.send(sender, content[5:])
return True # Arrêter le traitement
return False # Continuer vers le traitement des commandes
Les gestionnaires de messages sont appelés dans cet ordre : 1.
Gestionnaire de premier message (si c'est le premier message de cet
expéditeur) 2. Gestionnaires de messages généraux (enregistrés avec
on_message()) 3. Traitement des commandes (si le message commence par
le préfixe de commande)
Reticulum Relay Chat (RRC)¶
Les bots peuvent rejoindre des hubs RRC via
des liens RNS avec des enveloppes CBOR. Paquet : lxmfy.rrc.
Options de BotConfig¶
rrc_enabled(bool, défautFalse) : connecte les hubs configurés au démarragerrc_hubs(liste de hachages hex) : hachages de destination des hubsrrc_rooms(liste de str) : salons à rejoindre automatiquement après WELCOMErrc_nick(str ou None) : pseudo dans HELLO et les messages de salonrrc_dest_name(str, défaut"rrc.hub") : nom de destination utilisé pour construire la destination du hubrrc_auto_reconnect(bool, défautTrue) : reconnecte après une perte de lienrrc_persist_sessions(bool, défautTrue) : persiste les hubs et les salons entre les redémarragesreticulum_config_dir(str ou None) : répertoire de config Reticulum. Définissable aussi viaLXMFY_RETICULUM_CONFIG_DIR. Utilisez la même config que MeshChatX (souvent~/.reticulum) pour que les annonces des hubs soient visibles.
Exemple¶
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}")
# API d'exécution
# 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()
Types exportés¶
RRCClient: session mono-hubRRCManager: gestionnaire multi-hubs (bot.rrc)RRCMessage: charge utile d'événement de salon (kind,room,text,nick,src,mention, ...)RRC_VERSION: constante de version du protocole réseau
Les événements courants passés aux gestionnaires @bot.on_rrc
incluent status, welcome, joined, parted, msg, notice,
action, motd, error et rtt.
Modèles¶
Le framework inclut plusieurs modèles de bots prêts à l'emploi :
EchoBot¶
Bot echo simple qui répète les messages :
NoteBot¶
Bot de prise de notes avec stockage JSON :
ReminderBot¶
Bot de rappels avec stockage SQLite :
RRCBot¶
Bot de salon RRC qui rejoint les hubs configurés et répond aux
@mentions. Utilise par défaut le hub
664fc0e8d2e448658e37bb3f34e6c88f, le salon #general et
~/.reticulum quand il est disponible.
from lxmfy.templates import RRCBot
bot = RRCBot(
hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rooms=["general"],
nick="RRCBot",
reticulum_config_dir="~/.reticulum",
)
bot.run()
Outils CLI¶
Le framework fournit des outils en ligne de commande pour la gestion des bots :
# Créer un nouveau bot
lxmfy create mybot
# Créer un bot depuis un modèle
lxmfy create --template echo mybot
lxmfy create --template rrc my_rrc_bot
# Exécuter un bot à partir d'un modèle
lxmfy run echo
lxmfy run rrc
# Tester la vérification des signatures avec un message
lxmfy signatures test
# Activer la vérification des signatures
lxmfy signatures enable
# Désactiver la vérification des signatures
lxmfy signatures disable
Gestion des erreurs¶
Capturez les erreurs d'arrêt et d'exécution autour de bot.run() :
try:
bot.run()
except KeyboardInterrupt:
bot.cleanup()
except Exception as e:
logger.error(f"Error running bot: {str(e)}")
Référence des modules¶
Généré à partir des docstrings des sources.
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 |