members.py 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. """Registre des membres vus par le bot (noms, anciens pseudos, réglages de la mémoire), dans un fichier JSON."""
  2. from __future__ import annotations
  3. import asyncio
  4. import json
  5. import logging
  6. from datetime import datetime
  7. from pathlib import Path
  8. from .files import write_atomic
  9. logger = logging.getLogger("chatbot.members")
  10. FILE_VERSION = 1
  11. # Noms Discord d'un membre : nom d'utilisateur (unique), nom d'affichage, pseudo sur le serveur.
  12. NAME_KEYS = ("username", "global_name", "nickname")
  13. # Anciens pseudos gardés par membre, du plus ancien au plus récent.
  14. MAX_FORMER_NAMES = 5
  15. class MemberRegistry:
  16. """Garde, pour chaque membre vu (auteur d'un message lu par le bot, ou membre mentionné), ses noms
  17. actuels et ses anciens pseudos, s'il a été prévenu de la mémoire et s'il l'a désactivée.
  18. Le fichier n'est réécrit que si quelque chose change : pas d'écriture à chaque message."""
  19. def __init__(self, file_path: Path):
  20. self.file_path = file_path
  21. # Raison pour laquelle le fichier est illisible, ou None. Repartir d'un registre vide oublierait
  22. # qui a désactivé la mémoire : la mémoire est alors coupée, et le fichier n'est jamais réécrit.
  23. self.broken: str | None = None
  24. self._data: dict[str, dict] = self._load()
  25. self._save_lock = asyncio.Lock()
  26. # Dernière sauvegarde ratée (disque plein, droits) : le fichier est en retard sur _data. La
  27. # suivante, quelle qu'elle soit, réécrit tout et rattrape ce retard.
  28. self._unsaved = False
  29. # ------------------------------------------------------------------ accès
  30. def get(self, member_id: int | str) -> dict | None:
  31. return self._data.get(str(member_id))
  32. def members(self) -> dict[str, dict]:
  33. """Tous les membres connus, par identifiant."""
  34. return self._data
  35. def memory_enabled(self, member_id: int | str) -> bool:
  36. """La mémoire est activée par défaut, y compris pour un membre encore inconnu."""
  37. entry = self.get(member_id)
  38. return entry is None or entry["memory"]
  39. def notified(self, member_id: int | str) -> bool:
  40. """Le membre a reçu la présentation de la mémoire : avant, rien n'est noté sur lui."""
  41. entry = self.get(member_id)
  42. return entry is not None and entry["notified"]
  43. async def see(self, member_id: int, username: str, global_name: str | None,
  44. nickname: str | None = None, in_guild: bool = True) -> None:
  45. """Enregistre un membre ou met ses noms à jour ; un nom remplacé rejoint les anciens pseudos.
  46. in_guild=False (message privé) : le pseudo sur le serveur n'est pas connu, il reste inchangé."""
  47. names = {"username": username, "global_name": global_name or None}
  48. if in_guild:
  49. names["nickname"] = nickname or None
  50. key = str(member_id)
  51. entry = self._data.get(key)
  52. if entry is None:
  53. self._data[key] = {
  54. **{name_key: None for name_key in NAME_KEYS}, **names,
  55. "former_names": [], "notified": False, "memory": True,
  56. "first_seen": datetime.now().strftime("%Y-%m-%d"),
  57. }
  58. logger.info("Nouveau membre dans le registre : %s (%s)", display_name(self._data[key]), key)
  59. await self._save()
  60. return
  61. old_names = [entry[name_key] for name_key in NAME_KEYS if entry[name_key]]
  62. changed = False
  63. for name_key, value in names.items():
  64. if entry[name_key] != value:
  65. entry[name_key] = value
  66. changed = True
  67. if not changed:
  68. return
  69. current = {entry[name_key] for name_key in NAME_KEYS if entry[name_key]}
  70. former = [name for name in entry["former_names"] if name not in current]
  71. for name in old_names:
  72. if name not in current and name not in former:
  73. former.append(name)
  74. entry["former_names"] = former[-MAX_FORMER_NAMES:]
  75. logger.info("Noms mis à jour dans le registre : %s (%s)", display_name(entry), key)
  76. await self._save()
  77. async def set_notified(self, member_id: int | str) -> None:
  78. """Le membre a été prévenu de la mémoire : il ne le sera plus."""
  79. if (entry := self.get(member_id)) is not None and not entry["notified"]:
  80. entry["notified"] = True
  81. await self._save()
  82. async def set_memory(self, member_id: int | str, enabled: bool) -> bool:
  83. """Active ou désactive la mémoire pour ce membre. Renvoie False si le réglage n'a pas pu être
  84. enregistré : il s'applique quand même, mais serait perdu à un redémarrage avant la prochaine
  85. sauvegarde réussie."""
  86. if (entry := self.get(member_id)) is None:
  87. return True
  88. if entry["memory"] != enabled:
  89. entry["memory"] = enabled
  90. logger.info("Mémoire %s pour %s (%s)", "activée" if enabled else "désactivée", display_name(entry), member_id)
  91. elif not self._unsaved:
  92. return True
  93. return await self._save()
  94. # ------------------------------------------------------------ internes
  95. def _load(self) -> dict[str, dict]:
  96. if not self.file_path.exists():
  97. return {}
  98. try:
  99. # -sig : BOM laissé par certains éditeurs Windows (Bloc-notes) après une correction à la main.
  100. raw = json.loads(self.file_path.read_text(encoding="utf-8-sig"))
  101. if not isinstance(raw, dict) or not isinstance(raw.get("members"), dict):
  102. raise ValueError("« members » absent ou n'est pas un dictionnaire")
  103. return {key: self._sanitize(key, value) for key, value in raw["members"].items()}
  104. except (ValueError, OSError) as exc: # JSON invalide, mauvais encodage ou structure inattendue
  105. self.broken = str(exc)
  106. logger.error("Registre des membres illisible (%s) : mémoire des membres coupée jusqu'à sa "
  107. "réparation. Corrige %s puis redémarre le bot ; le supprimer repartirait de zéro, "
  108. "en réactivant la mémoire de ceux qui l'avaient désactivée.", exc, self.file_path)
  109. return {}
  110. @staticmethod
  111. def _sanitize(key: str, value) -> dict:
  112. """Une entrée du fichier, complétée si besoin. ValueError si elle est illisible, ou si on ne sait
  113. pas si la mémoire est activée : la croire activée reviendrait à noter sur qui l'a désactivée."""
  114. if not isinstance(value, dict) or not isinstance(value.get("username"), str):
  115. raise ValueError(f"membre {key} : entrée illisible")
  116. if not isinstance(value.get("memory"), bool):
  117. raise ValueError(f"membre {key} : « memory » doit valoir true ou false")
  118. entry = {name_key: value.get(name_key) if isinstance(value.get(name_key), str) else None for name_key in NAME_KEYS}
  119. former = value.get("former_names")
  120. entry["former_names"] = [n for n in former if isinstance(n, str)] if isinstance(former, list) else []
  121. entry["notified"] = value.get("notified") is True
  122. entry["memory"] = value["memory"]
  123. entry["first_seen"] = value.get("first_seen") if isinstance(value.get("first_seen"), str) else None
  124. return entry
  125. async def _save(self) -> bool:
  126. """Écrit le registre ; renvoie False s'il n'a pas pu l'être."""
  127. if self.broken:
  128. return False # le fichier illisible attend sa réparation : l'écraser perdrait les désactivations
  129. payload = {"version": FILE_VERSION, "members": self._data}
  130. text = json.dumps(payload, ensure_ascii=False, indent=2)
  131. async with self._save_lock:
  132. try:
  133. await asyncio.to_thread(write_atomic, self.file_path, text)
  134. except OSError as exc:
  135. logger.error("Impossible de sauvegarder le registre des membres : %s", exc)
  136. self._unsaved = True
  137. return False
  138. self._unsaved = False
  139. return True
  140. def display_name(entry: dict) -> str:
  141. """Le nom affiché sur le serveur : pseudo, sinon nom d'affichage, sinon nom d'utilisateur."""
  142. return entry["nickname"] or entry["global_name"] or entry["username"]
  143. def with_username(name: str, username: str) -> str:
  144. """« Johnounet (johnk) » : le nom affiché, libre et non unique, suivi du nom d'utilisateur, unique,
  145. pour que personne ne puisse se faire passer pour un autre en prenant son pseudo. Seul s'il est
  146. identique au nom affiché (« Penta » et « penta »)."""
  147. return name if name.casefold() == username.casefold() else f"{name} ({username})"