parrot.py

   1 #!/usr/bin/python
   2 # -*- encoding: utf-8 -*-
   3
   4 """ Un bot IRC qui enregistre et ressort des citations """
   5
   6 import threading
   7 import random
   8 import time
   9 import json
  10 import re
  11 import os
  12 import signal
  13 import sys
  14
  15 # Oui, j'ai recodé ma version d'irclib pour pouvoir rattrapper les SIGHUP
  16 sys.path.insert(0, "/home/vincent/scripts/python-myirclib")
  17 import irclib
  18 import ircbot
  19
  20 from commands import getstatusoutput as ex
  21
  22 #: Config du bot
  23 import config
  24 #: Module définissant les erreurs
  25 import errors
  26 #: Module de gestion des quotes
  27 import quotes
  28
  29 quote_pattern = re.compile(config.quote_regexp)
  30
  31 def get_config_logfile(serveur):
  32     """Renvoie le nom du fichier de log en fonction du ``serveur`` et de la config."""
  33     serveurs = {"irc.crans.org" : "crans"}
  34     return config.logfile_template % (serveurs[serveur],)
  35
  36 def log(serveur, channel, auteur=None, message=None):
  37     """Enregistre une ligne de log."""
  38     if auteur == message == None:
  39         # alors c'est que c'est pas un channel mais juste une ligne de log
  40         chain = u"%s %s" % (time.strftime("%F %T"), channel)
  41     else:
  42         chain = u"%s [%s:%s] %s" % (time.strftime("%F %T"), channel, auteur, message)
  43     f = open(get_config_logfile(serveur), "a")
  44     f.write((chain + u"\n").encode("utf-8"))
  45     f.close()
  46     if config.debug_stdout:
  47         print chain.encode("utf-8")
  48
  49 def ignore_event(serv, ev):
  50     """Retourne ``True`` si il faut ignorer cet évènement."""
  51     for (blackmask, exceptlist) in config.blacklisted_masks:
  52         usermask = ev.source()
  53         blackit = bool(irclib.mask_matches(usermask, blackmask))
  54         exceptit = any([bool(irclib.mask_matches(usermask, exceptmask)) for exceptmask in exceptlist])
  55         if exceptit: # Il est exempté
  56             return False
  57         else:
  58             if blackit: # Il n'est pas exempté et matche la blacklist
  59                 return True
  60
  61
  62 def bot_unicode(chain):
  63     """Essaye de décoder ``chain`` en UTF-8.
  64        Lève une py:class:`errors.UnicodeBotError` en cas d'échec."""
  65     try:
  66         return chain.decode("utf8")
  67     except UnicodeDecodeError as exc:
  68         raise errors.UnicodeBotError
  69
  70
  71 class Parrot(ircbot.SingleServerIRCBot):
  72     """Classe principale : définition du bot."""
  73     def __init__(self, serveur, debug=False):
  74         temporary_pseudo = config.irc_pseudo + str(random.randrange(10000,100000))
  75         ircbot.SingleServerIRCBot.__init__(self, [(serveur, 6667)],
  76                               temporary_pseudo, "Parrot, le bot irc. [Codé par 20-100]", 10)
  77         self.debug = debug
  78         self.serveur = serveur
  79         self.overops = config.overops
  80         self.ops = self.overops + config.ops
  81         self.report_bugs_to = config.report_bugs_to
  82         self.chanlist = config.chanlist
  83         self.stay_channels = config.stay_channels
  84         self.quiet_channels = config.quiet_channels
  85         self.last_perdu = 0
  86
  87         self.quotedb = quotes.QuoteDB()
  88         self.quotedb.load()
  89
  90     ### Utilitaires
  91     def _getnick(self):
  92         """Récuère le nick effectif du bot sur le serveur."""
  93         return self.serv.get_nickname()
  94     nick = property(_getnick)
  95
  96     def give_me_my_pseudo(self, serv):
  97         """Récupère le pseudo auprès de NickServ."""
  98         serv.privmsg("NickServ", "RECOVER %s %s" % (config.irc_pseudo, config.irc_password))
  99         serv.privmsg("NickServ", "RELEASE %s %s" % (config.irc_pseudo, config.irc_password))
 100         time.sleep(0.3)
 101         serv.nick(config.irc_pseudo)
 102
 103     def pourmoi(self, serv, message):
 104         """Renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
 105         pseudo = self.nick
 106         pseudo = pseudo.decode("utf-8")
 107         size = len(pseudo)
 108         if message[:size] == pseudo and len(message) > size and message[size] == ":":
 109             return (True, message[size+1:].lstrip(" "))
 110         else:
 111             return (False, message)
 112
 113     ### Exécution d'actions
 114     def quitter(self, chan, leave_message=None):
 115         """Quitter un channel avec un message customisable."""
 116         if leave_message == None:
 117             leave_message = random.choice(config.leave_messages)
 118         self.serv.part(chan, message=leave_message.encode("utf8"))
 119
 120     def mourir(self):
 121         """Se déconnecter du serveur IRC avec un message customisable."""
 122         quit_message = random.choice(config.quit_messages)
 123         self.die(msg=quit_message.encode("utf8"))
 124
 125     def execute_reload(self, auteur=None):
 126         """Recharge la config."""
 127         reload(config)
 128         isit.regexp_compile()
 129         if auteur in [None, "SIGHUP"]:
 130             towrite = "Config reloaded" + " (SIGHUP received)" * (auteur == "SIGHUP")
 131             for to in config.report_bugs_to:
 132                 self.serv.privmsg(to, towrite)
 133             log(self.serveur, towrite)
 134             return True, None
 135         else:
 136             return True, u"Config reloaded"
 137
 138     def crash(self, who="nobody", chan="nowhere"):
 139         """Fait crasher le bot."""
 140         where = "en privé" if chan == "priv" else "sur le chan %s" % chan
 141         raise errors.CrashError((u"Crash demandé par %s %s" % (who, where)).encode("utf-8"))
 142
 143     ACTIONS = {
 144         "reload" : execute_reload,
 145         }
 146
 147     def execute_something(self, something, params, place=None, auteur=None):
 148         """Exécute une action et répond son résultat à ``auteur``
 149            sur un chan ou en privé en fonction de ``place``"""
 150         action = self.ACTIONS[something]
 151         success, message = action(self, **params)
 152         if message:
 153             if irclib.is_channel(place):
 154                 message = "%s: %s" % (auteur, message.encode("utf-8"))
 155             self.serv.privmsg(place, message)
 156         log(self.serveur, place, auteur, something + "%r" % params + ("[successful]" if success else "[failed]"))
 157
 158     ### Gestion des quotes
 159     def enregistrer(self, author, content, timestamp):
 160
 161         quotes.save(self.quotelist, config.quote_file)
 162
 163
 164     ### Surcharge des events du Bot
 165     def on_welcome(self, serv, ev):
 166         """À l'arrivée sur le serveur."""
 167         self.serv = serv # ça serv ira :)
 168         self.give_me_my_pseudo(serv)
 169         serv.privmsg("NickServ", "IDENTIFY %s" % (config.irc_password))
 170         log(self.serveur, "Connected")
 171         if self.debug:
 172             self.chanlist = ["#bot"]
 173         for c in self.chanlist:
 174             log(self.serveur, "JOIN %s" % (c))
 175             serv.join(c)
 176
 177     def on_privmsg(self, serv, ev):
 178         """À la réception d'un message en privé."""
 179         if ignore_event(serv, ev):
 180             return
 181         message = ev.arguments()[0]
 182         auteur = irclib.nm_to_n(ev.source())
 183         try:
 184             message = bot_unicode(message)
 185         except errors.UnicodeBotError:
 186             if config.utf8_trigger:
 187                 serv.privmsg(auteur, random.choice(config.utf8_fail_answers).encode("utf8"))
 188             return
 189         message = message.split()
 190         cmd = message[0].lower()
 191         notunderstood = False
 192         if cmd == u"help":
 193             op,overop=auteur in self.ops, auteur in self.overops
 194             if len(message)==1:
 195                 helpmsg = config.helpmsg_default
 196                 if op:
 197                     helpmsg += config.helpmsg_ops
 198                 if overop:
 199                     helpmsg += config.helpmsg_overops
 200             else:
 201                 helpmsgs = config.helpdico.get(message[1].lower(), ["Commande inconnue.", None, None])
 202                 helpmsg = helpmsgs[0]
 203                 if op and helpmsgs[1]:
 204                     if helpmsg:
 205                         helpmsg += "\n" + helpmsgs[1]
 206                     else:
 207                         helpmsg = helpmsgs[1]
 208                 if overop and helpmsgs[2]:
 209                     if helpmsg:
 210                         helpmsg += "\n" + helpmsgs[2]
 211                     else:
 212                         helpmsg = helpmsgs[2]
 213             for ligne in helpmsg.split("\n"):
 214                 serv.privmsg(auteur, ligne.encode("utf-8"))
 215         elif cmd == u"join":
 216             if auteur in self.ops:
 217                 if len(message) > 1:
 218                     if message[1] in self.chanlist:
 219                         serv.privmsg(auteur, "Je suis déjà sur %s" % (message[1]))
 220                     else:
 221                         serv.join(message[1])
 222                         self.chanlist.append(message[1])
 223                         serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 224                         log(self.serveur, "priv", auteur, " ".join(message))
 225                 else:
 226                     serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 227             else:
 228                 notunderstood = True
 229         elif cmd == u"leave":
 230             if auteur in self.ops and len(message) > 1:
 231                 if message[1] in self.chanlist:
 232                     if not (message[1] in self.stay_channels) or auteur in self.overops:
 233                         self.quitter(message[1].encode("utf-8"), " ".join(message[2:]))
 234                         self.chanlist.remove(message[1])
 235                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 236                     else:
 237                         serv.privmsg(auteur, "Non, je reste !")
 238                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 239                 else:
 240                     serv.privmsg(auteur, "Je ne suis pas sur %s" % (message[1]))
 241             else:
 242                 notunderstood = True
 243         elif cmd == u"stay":
 244             if auteur in self.overops:
 245                 if len(message) > 1:
 246                     if message[1] in self.stay_channels:
 247                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 248                         serv.privmsg(auteur, "Je stay déjà sur %s." % (message[1]))
 249                     else:
 250                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 251                         self.stay_channels.append(message[1])
 252                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 253                 else:
 254                     serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 255             else:
 256                 notunderstood = True
 257         elif cmd == u"nostay":
 258             if auteur in self.overops:
 259                 if len(message) > 1:
 260                     if message[1] in self.stay_channels:
 261                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 262                         self.stay_channels.remove(message[1])
 263                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 264                     else:
 265                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 266                         serv.privmsg(auteur, "Je ne stay pas sur %s." % (message[1]))
 267             else:
 268                 notunderstood = True
 269         elif cmd == u"die":
 270             if auteur in self.overops:
 271                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 272                 self.mourir()
 273             else:
 274                 notunderstood = True
 275         elif cmd == u"crash":
 276             if auteur in self.overops:
 277                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 278                 self.crash(auteur, "priv")
 279             else:
 280                 notunderstood = True
 281         elif cmd == u"reload":
 282             if auteur in self.ops:
 283                 self.execute_something("reload", {"auteur" : auteur}, place=auteur, auteur=auteur)
 284             else:
 285                 notunderstood = True
 286         elif cmd == u"quiet":
 287             if auteur in self.ops:
 288                 if len(message) > 1:
 289                     if message[1] in self.quiet_channels:
 290                         serv.privmsg(auteur, "Je me la ferme déjà sur %s" % (message[1]))
 291                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 292                     else:
 293                         self.quiet_channels.append(message[1])
 294                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 295                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 296                 else:
 297                     serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 298             else:
 299                 notunderstood = True
 300         elif cmd == u"noquiet":
 301             if auteur in self.ops:
 302                 if len(message) > 1:
 303                     if message[1] in self.quiet_channels:
 304                         self.quiet_channels.remove(message[1])
 305                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 306                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 307                     else:
 308                         serv.privmsg(auteur, "Je ne me la ferme pas sur %s." % (message[1]))
 309                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 310             else:
 311                 notunderstood = True
 312         elif cmd == u"say":
 313             if auteur in self.overops and len(message) > 2:
 314                 serv.privmsg(message[1].encode("utf-8"), (u" ".join(message[2:])).encode("utf-8"))
 315                 log(self.serveur, "priv", auteur, " ".join(message))
 316             elif len(message) <= 2:
 317                 serv.privmsg(auteur, "Syntaxe : SAY <channel> <message>")
 318             else:
 319                 notunderstood = True
 320         elif cmd == u"do":
 321             if auteur in self.overops and len(message) > 2:
 322                 serv.action(message[1], " ".join(message[2:]))
 323                 log(self.serveur, "priv", auteur, " ".join(message))
 324             elif len(message) <= 2:
 325                 serv.privmsg(auteur, "Syntaxe : DO <channel> <action>")
 326             else:
 327                 notunderstood = True
 328         elif cmd == u"kick":
 329             if auteur in self.overops and len(message) > 2:
 330                 serv.kick(message[1].encode("utf-8"), message[2].encode("utf-8"), " ".join(message[3:]).encode("utf-8"))
 331                 log(self.serveur, "priv", auteur, " ".join(message))
 332             elif len(message) <= 2:
 333                 serv.privmsg(auteur, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
 334             else:
 335                 notunderstood = True
 336         elif cmd == u"ops":
 337             if auteur in self.overops:
 338                 serv.privmsg(auteur, " ".join(self.ops))
 339             else:
 340                 notunderstood = True
 341         elif cmd == u"overops":
 342             if auteur in self.overops:
 343                 serv.privmsg(auteur, " ".join(self.overops))
 344             else:
 345                 notunderstood = True
 346         else:
 347             notunderstood = True
 348         if notunderstood:
 349             serv.privmsg(auteur, "Je n'ai pas compris. Essayez HELP…")
 350
 351     def on_pubmsg(self, serv, ev):
 352         """À la réception d'un message sur un channel."""
 353         if ignore_event(serv, ev):
 354             return
 355         auteur = irclib.nm_to_n(ev.source())
 356         canal = ev.target()
 357         message = ev.arguments()[0]
 358         try:
 359             message = bot_unicode(message)
 360         except errors.UnicodeBotError:
 361             if config.utf8_trigger and not canal in self.quiet_channels:
 362                 serv.privmsg(canal, (u"%s: %s"% ( auteur, random.choice(config.utf8_fail_answers))).encode("utf8"))
 363             return
 364         pour_moi, message = self.pourmoi(serv, message)
 365         if pour_moi and message.split()!=[]:
 366             cmd = message.split()[0].lower()
 367             try:
 368                 args = " ".join(message.split()[1:])
 369             except:
 370                 args = ""
 371             if cmd in [u"meurs", u"die", u"crève"]:
 372                 if auteur in self.overops:
 373                     log(self.serveur, canal, auteur, message + "[successful]")
 374                     self.mourir()
 375                 else:
 376                     serv.privmsg(canal,(u"%s: %s"%(auteur, random.choice(config.quit_fail_messages))).encode("utf8"))
 377                     log(self.serveur, canal, auteur, message + "[failed]")
 378             elif cmd == u"reload":
 379                 if auteur in self.ops:
 380                     self.execute_something("reload", {"auteur" : auteur}, place=canal, auteur=auteur)
 381             elif cmd == u"crash":
 382                 if auteur in self.overops:
 383                     self.crash(auteur, canal)
 384             elif cmd in [u"part", u"leave", u"dégage", u"va-t-en"]:
 385                 if auteur in self.ops and (not (canal in self.stay_channels)
 386                                            or auteur in self.overops):
 387                     self.quitter(canal)
 388                     log(self.serveur, canal, auteur, message + "[successful]")
 389                     if canal in self.chanlist:
 390                         self.chanlist.remove(canal)
 391                 else:
 392                     serv.privmsg(canal,(u"%s: %s" % (auteur, random.choice(config.leave_fail_messages))).encode("utf8"))
 393                     log(self.serveur, canal, auteur, message + "[failed]")
 394
 395             elif cmd in [u"ping"] and not canal in self.quiet_channels:
 396                 serv.privmsg(canal, "%s: pong" % (auteur))
 397         else:
 398             # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
 399             match = quote_pattern.match(message)
 400             if match:
 401                 d = match.groupdict()
 402                 if self.quotedb.store(d["author"], d["content"]):
 403                     serv.privmsg(canal, (u"%s: Ce sera retenu, répété, amplifié" % (auteur,)).encode("utf-8"))
 404                     self.quotedb.save()
 405                 else:
 406                     serv.privmsg(canal, (u"%s: Je le savais déjà." % (auteur,)).encode("utf-8"))
 407             if message.startswith(u"!quote"):
 408                 if message.strip() == u"!quote":
 409                     q = self.quotedb.random()
 410                     serv.privmsg(canal, str(q))
 411                 elif message.startswith("!quote "):
 412                     author = message[7:].strip()
 413                     try:
 414                         q = self.quotedb.randomfrom(author)
 415                     except IndexError:
 416                         serv.privmsg(canal, (u"Pas de quote de %s en mémoire." % author).encode("utf-8"))
 417                         return
 418                     serv.privmsg(canal, str(q))
 419
 420     def on_action(self, serv, ev):
 421         """À la réception d'une action."""
 422         if ignore_event(serv, ev):
 423             return
 424         action = ev.arguments()[0]
 425         auteur = irclib.nm_to_n(ev.source())
 426         channel = ev.target()
 427         try:
 428             action = bot_unicode(action)
 429         except errors.UnicodeBotError:
 430             if config.utf8_trigger and not channel in self.quiet_channels:
 431                 serv.privmsg(channel, (u"%s: %s"%(auteur,random.choice(config.utf8_fail_answers))).encode("utf8"))
 432             return
 433         mypseudo = self.nick
 434
 435     def on_kick(self, serv, ev):
 436         """À la réception d'une action."""
 437         auteur = irclib.nm_to_n(ev.source())
 438         channel = ev.target()
 439         victime = ev.arguments()[0]
 440         raison = ev.arguments()[1]
 441         if victime == self.nick:
 442             log(self.serveur, u"%s kické de %s par %s (raison : %s)" % (victime, channel.decode("utf-8"), auteur, raison))
 443             time.sleep(2)
 444             serv.join(channel)
 445
 446     ### .fork trick
 447     def start_as_daemon(self, outfile):
 448         sys.stderr = Logger(outfile)
 449         self.start()
 450
 451
 452 class Logger(object):
 453     """Pour écrire ailleurs que sur stdout"""
 454     def __init__(self, filename="parrot.full.log"):
 455         self.filename = filename
 456
 457     def write(self, message):
 458         f = open(self.filename, "a")
 459         f.write(message)
 460         f.close()
 461
 462 def main():
 463     """Exécution principale : lecture des paramètres et lancement du bot."""
 464     if len(sys.argv) == 1:
 465         print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
 466         print "        --outfile sans --no-output ni --daemon n'a aucun effet"
 467         exit(1)
 468     serveur = sys.argv[1]
 469     if "--daemon" in sys.argv:
 470         thisfile = os.path.realpath(__file__)
 471         thisdirectory = thisfile.rsplit("/", 1)[0]
 472         os.chdir(thisdirectory)
 473         daemon = True
 474     else:
 475         daemon = False
 476     if "debug" in sys.argv or "--debug" in sys.argv:
 477         debug = True
 478     else:
 479         debug = False
 480     if "--quiet" in sys.argv:
 481         config.debug_stdout = False
 482     serveurs = {
 483               "irc" : "irc.crans.org",
 484               "crans" : "irc.crans.org",
 485               "irc.crans.org" : "irc.crans.org"}
 486     if "--no-output" in sys.argv or "--daemon" in sys.argv:
 487         outfile = "/var/log/bots/parrot.full.log"
 488         for arg in sys.argv:
 489             arg = arg.split("=")
 490             if arg[0].strip('-') in ["out", "outfile", "logfile"]:
 491                 outfile = arg[1]
 492         sys.stdout = Logger(outfile)
 493     try:
 494         serveur = serveurs[serveur]
 495     except KeyError:
 496         print "Server Unknown : %s" % (serveur)
 497         exit(404)
 498     parrot = Parrot(serveur,debug)
 499     # Si on reçoit un SIGHUP, on reload la config
 500     def sighup_handler(signum, frame):
 501         parrot.execute_reload(auteur="SIGHUP")
 502     signal.signal(signal.SIGHUP, sighup_handler)
 503     # Daemonization
 504     if daemon:
 505         child_pid = os.fork()
 506         if child_pid == 0:
 507             os.setsid()
 508             parrot.start_as_daemon(outfile)
 509         else:
 510             # on enregistre le pid de parrot
 511             pidfile = "/var/run/bots/parrot.pid"
 512             for arg in sys.argv:
 513                 arg = arg.split("=")
 514                 if arg[0].strip('-') in ["pidfile"]:
 515                     pidfile = arg[1]
 516             f = open(pidfile, "w")
 517             f.write("%s\n" % child_pid)
 518             f.close()
 519     else:
 520         parrot.start()
 521
 522 if __name__ == "__main__":
 523     main()