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, flags=re.UNICODE)
  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.reload_quotes()
  89
  90
  91     ### Utilitaires
  92     def _getnick(self):
  93         """Récuère le nick effectif du bot sur le serveur."""
  94         return self.serv.get_nickname()
  95     nick = property(_getnick)
  96
  97     def give_me_my_pseudo(self, serv):
  98         """Récupère le pseudo auprès de NickServ."""
  99         serv.privmsg("NickServ", "GHOST %s %s" % (config.irc_pseudo, config.irc_password))
 100         serv.privmsg("NickServ", "RELEASE %s %s" % (config.irc_pseudo, config.irc_password))
 101         time.sleep(0.3)
 102         serv.nick(config.irc_pseudo)
 103
 104     def pourmoi(self, serv, message):
 105         """Renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
 106         pseudo = self.nick
 107         pseudo = pseudo.decode("utf-8")
 108         size = len(pseudo)
 109         if message[:size] == pseudo and len(message) > size and message[size] == ":":
 110             return (True, message[size+1:].lstrip(" "))
 111         else:
 112             return (False, message)
 113
 114     ### Exécution d'actions
 115     def quitter(self, chan, leave_message=None):
 116         """Quitter un channel avec un message customisable."""
 117         if leave_message == None:
 118             leave_message = random.choice(config.leave_messages)
 119         self.serv.part(chan, message=leave_message.encode("utf8"))
 120
 121     def mourir(self):
 122         """Se déconnecter du serveur IRC avec un message customisable."""
 123         quit_message = random.choice(config.quit_messages)
 124         self.die(msg=quit_message.encode("utf8"))
 125
 126     def reload_quotes(self):
 127         """ Recharge la base de données des quotes et recompile la regexp de quote """
 128         self.quotedb.load()
 129         self.quote_pattern = re.compile(config.quote_regexp, flags=re.UNICODE)
 130
 131     def execute_reload(self, auteur=None):
 132         """Recharge la config."""
 133         reload(config)
 134         self.reload_quotes()
 135         if auteur in [None, "SIGHUP"]:
 136             towrite = "Config reloaded" + " (SIGHUP received)" * (auteur == "SIGHUP")
 137             for to in config.report_bugs_to:
 138                 self.serv.privmsg(to, towrite)
 139             log(self.serveur, towrite)
 140             return True, None
 141         else:
 142             return True, u"Config reloaded"
 143
 144     def crash(self, who="nobody", chan="nowhere"):
 145         """Fait crasher le bot."""
 146         where = "en privé" if chan == "priv" else "sur le chan %s" % chan
 147         raise errors.CrashError((u"Crash demandé par %s %s" % (who, where)).encode("utf-8"))
 148
 149     ACTIONS = {
 150         "reload" : execute_reload,
 151         }
 152
 153     def execute_something(self, something, params, place=None, auteur=None):
 154         """Exécute une action et répond son résultat à ``auteur``
 155            sur un chan ou en privé en fonction de ``place``"""
 156         action = self.ACTIONS[something]
 157         success, message = action(self, **params)
 158         if message:
 159             if irclib.is_channel(place):
 160                 message = "%s: %s" % (auteur, message.encode("utf-8"))
 161             self.serv.privmsg(place, message)
 162         log(self.serveur, place, auteur, something + "%r" % params + ("[successful]" if success else "[failed]"))
 163
 164
 165     def acknowledge(self, asked_by, asked_where, message):
 166         """Répond quelque chose au demandeur d'une action.
 167            ``asked_where=None`` signifie en privé."""
 168         if asked_where is None:
 169             self.serv.privmsg(asked_by, message)
 170         else:
 171             self.serv.privmsg(asked_where, "%s: %s" % (asked_by, message))
 172
 173     def dump(self, asked_by, asked_where=None):
 174         """Dumpe les quotes.  ``asked_where=None`` signifie en privé."""
 175         quotes.dump(self.quotedb)
 176         self.acknowledge(asked_by, asked_where, "Quotes dumpées")
 177
 178     def restore(self, asked_by, asked_where=None):
 179         """Restaure les quotes à partir du dump.  ``asked_where=None`` signifie en privé."""
 180         self.quotedb = quotes.restore()
 181         self.acknowledge(asked_by, asked_where, "Quotes restaurées à partir du dump (pas de backup effectué).")
 182
 183     ### Surcharge des events du Bot
 184     def on_welcome(self, serv, ev):
 185         """À l'arrivée sur le serveur."""
 186         self.serv = serv # ça serv ira :)
 187         self.give_me_my_pseudo(serv)
 188         serv.privmsg("NickServ", "IDENTIFY %s" % (config.irc_password))
 189         log(self.serveur, "Connected")
 190         if self.debug:
 191             self.chanlist = ["#bot"]
 192         for c in self.chanlist:
 193             log(self.serveur, "JOIN %s" % (c))
 194             serv.join(c)
 195
 196     def on_privmsg(self, serv, ev):
 197         """À la réception d'un message en privé."""
 198         if ignore_event(serv, ev):
 199             return
 200         message = ev.arguments()[0]
 201         auteur = irclib.nm_to_n(ev.source())
 202         try:
 203             message = bot_unicode(message)
 204         except errors.UnicodeBotError:
 205             if config.utf8_trigger:
 206                 serv.privmsg(auteur, random.choice(config.utf8_fail_answers).encode("utf8"))
 207             return
 208         message = message.split()
 209         cmd = message[0].lower()
 210         notunderstood = False
 211         if cmd == u"help":
 212             op,overop=auteur in self.ops, auteur in self.overops
 213             if len(message)==1:
 214                 helpmsg = config.helpmsg_default
 215                 if op:
 216                     helpmsg += config.helpmsg_ops
 217                 if overop:
 218                     helpmsg += config.helpmsg_overops
 219             else:
 220                 helpmsgs = config.helpdico.get(message[1].lower(), ["Commande inconnue.", None, None])
 221                 helpmsg = helpmsgs[0]
 222                 if op and helpmsgs[1]:
 223                     if helpmsg:
 224                         helpmsg += "\n" + helpmsgs[1]
 225                     else:
 226                         helpmsg = helpmsgs[1]
 227                 if overop and helpmsgs[2]:
 228                     if helpmsg:
 229                         helpmsg += "\n" + helpmsgs[2]
 230                     else:
 231                         helpmsg = helpmsgs[2]
 232             for ligne in helpmsg.split("\n"):
 233                 serv.privmsg(auteur, ligne.encode("utf-8"))
 234         elif cmd == u"join":
 235             if auteur in self.ops:
 236                 if len(message) > 1:
 237                     if message[1] in self.chanlist:
 238                         serv.privmsg(auteur, "Je suis déjà sur %s" % (message[1]))
 239                     else:
 240                         serv.join(message[1])
 241                         self.chanlist.append(message[1])
 242                         serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 243                         log(self.serveur, "priv", auteur, " ".join(message))
 244                 else:
 245                     serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 246             else:
 247                 notunderstood = True
 248         elif cmd == u"leave":
 249             if auteur in self.ops and len(message) > 1:
 250                 if message[1] in self.chanlist:
 251                     if not (message[1] in self.stay_channels) or auteur in self.overops:
 252                         self.quitter(message[1].encode("utf-8"), " ".join(message[2:]))
 253                         self.chanlist.remove(message[1])
 254                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 255                     else:
 256                         serv.privmsg(auteur, "Non, je reste !")
 257                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 258                 else:
 259                     serv.privmsg(auteur, "Je ne suis pas sur %s" % (message[1]))
 260             else:
 261                 notunderstood = True
 262         elif cmd == u"stay":
 263             if auteur in self.overops:
 264                 if len(message) > 1:
 265                     if message[1] in self.stay_channels:
 266                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 267                         serv.privmsg(auteur, "Je stay déjà sur %s." % (message[1]))
 268                     else:
 269                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 270                         self.stay_channels.append(message[1])
 271                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 272                 else:
 273                     serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 274             else:
 275                 notunderstood = True
 276         elif cmd == u"nostay":
 277             if auteur in self.overops:
 278                 if len(message) > 1:
 279                     if message[1] in self.stay_channels:
 280                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 281                         self.stay_channels.remove(message[1])
 282                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 283                     else:
 284                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 285                         serv.privmsg(auteur, "Je ne stay pas sur %s." % (message[1]))
 286             else:
 287                 notunderstood = True
 288         elif cmd == u"die":
 289             if auteur in self.overops:
 290                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 291                 self.mourir()
 292             else:
 293                 notunderstood = True
 294         elif cmd == u"crash":
 295             if auteur in self.overops:
 296                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 297                 self.crash(auteur, "priv")
 298             else:
 299                 notunderstood = True
 300         elif cmd == u"reload":
 301             if auteur in self.ops:
 302                 self.execute_something("reload", {"auteur" : auteur}, place=auteur, auteur=auteur)
 303             else:
 304                 notunderstood = True
 305         elif cmd == u"quiet":
 306             if auteur in self.ops:
 307                 if len(message) > 1:
 308                     if message[1] in self.quiet_channels:
 309                         serv.privmsg(auteur, "Je me la ferme déjà sur %s" % (message[1]))
 310                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 311                     else:
 312                         self.quiet_channels.append(message[1])
 313                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 314                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 315                 else:
 316                     serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 317             else:
 318                 notunderstood = True
 319         elif cmd == u"noquiet":
 320             if auteur in self.ops:
 321                 if len(message) > 1:
 322                     if message[1] in self.quiet_channels:
 323                         self.quiet_channels.remove(message[1])
 324                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 325                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 326                     else:
 327                         serv.privmsg(auteur, "Je ne me la ferme pas sur %s." % (message[1]))
 328                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 329             else:
 330                 notunderstood = True
 331         elif cmd == u"say":
 332             if auteur in self.overops and len(message) > 2:
 333                 serv.privmsg(message[1].encode("utf-8"), (u" ".join(message[2:])).encode("utf-8"))
 334                 log(self.serveur, "priv", auteur, " ".join(message))
 335             elif len(message) <= 2:
 336                 serv.privmsg(auteur, "Syntaxe : SAY <channel> <message>")
 337             else:
 338                 notunderstood = True
 339         elif cmd == u"do":
 340             if auteur in self.overops and len(message) > 2:
 341                 serv.action(message[1], " ".join(message[2:]))
 342                 log(self.serveur, "priv", auteur, " ".join(message))
 343             elif len(message) <= 2:
 344                 serv.privmsg(auteur, "Syntaxe : DO <channel> <action>")
 345             else:
 346                 notunderstood = True
 347         elif cmd == u"kick":
 348             if auteur in self.overops and len(message) > 2:
 349                 serv.kick(message[1].encode("utf-8"), message[2].encode("utf-8"), " ".join(message[3:]).encode("utf-8"))
 350                 log(self.serveur, "priv", auteur, " ".join(message))
 351             elif len(message) <= 2:
 352                 serv.privmsg(auteur, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
 353             else:
 354                 notunderstood = True
 355         elif cmd == u"ops":
 356             if auteur in self.overops:
 357                 serv.privmsg(auteur, " ".join(self.ops))
 358             else:
 359                 notunderstood = True
 360         elif cmd == u"overops":
 361             if auteur in self.overops:
 362                 serv.privmsg(auteur, " ".join(self.overops))
 363             else:
 364                 notunderstood = True
 365         elif cmd == u"dump" and auteur in self.ops:
 366             self.dump(asked_by=auteur)
 367         elif cmd == u"restore" and auteur in self.overops:
 368             self.restore(asked_by=auteur)
 369         else:
 370             notunderstood = True
 371         if notunderstood:
 372             serv.privmsg(auteur, "Je n'ai pas compris. Essayez HELP…")
 373
 374     def on_pubmsg(self, serv, ev):
 375         """À la réception d'un message sur un channel."""
 376         if ignore_event(serv, ev):
 377             return
 378         auteur = irclib.nm_to_n(ev.source())
 379         canal = ev.target()
 380         message = ev.arguments()[0]
 381         try:
 382             message = bot_unicode(message)
 383         except errors.UnicodeBotError:
 384             if config.utf8_trigger and not canal in self.quiet_channels:
 385                 serv.privmsg(canal, (u"%s: %s"% ( auteur, random.choice(config.utf8_fail_answers))).encode("utf8"))
 386             return
 387         pour_moi, message = self.pourmoi(serv, message)
 388         if pour_moi and message.split()!=[]:
 389             cmd = message.split()[0].lower()
 390             try:
 391                 args = " ".join(message.split()[1:])
 392             except:
 393                 args = ""
 394             if cmd in [u"meurs", u"die", u"crève"]:
 395                 if auteur in self.overops:
 396                     log(self.serveur, canal, auteur, message + "[successful]")
 397                     self.mourir()
 398                 else:
 399                     serv.privmsg(canal,(u"%s: %s"%(auteur, random.choice(config.quit_fail_messages))).encode("utf8"))
 400                     log(self.serveur, canal, auteur, message + "[failed]")
 401             elif cmd == u"reload":
 402                 if auteur in self.ops:
 403                     self.execute_something("reload", {"auteur" : auteur}, place=canal, auteur=auteur)
 404             elif cmd == u"crash":
 405                 if auteur in self.overops:
 406                     self.crash(auteur, canal)
 407             elif cmd in [u"part", u"leave", u"dégage", u"va-t-en"]:
 408                 if auteur in self.ops and (not (canal in self.stay_channels)
 409                                            or auteur in self.overops):
 410                     self.quitter(canal)
 411                     log(self.serveur, canal, auteur, message + "[successful]")
 412                     if canal in self.chanlist:
 413                         self.chanlist.remove(canal)
 414                 else:
 415                     serv.privmsg(canal,(u"%s: %s" % (auteur, random.choice(config.leave_fail_messages))).encode("utf8"))
 416                     log(self.serveur, canal, auteur, message + "[failed]")
 417
 418             elif cmd in [u"ping"] and not canal in self.quiet_channels:
 419                 serv.privmsg(canal, "%s: pong" % (auteur))
 420             elif cmd in [u"dump"]:
 421                 self.dump(asked_by=auteur, asked_where=canal)
 422             elif cmd in [u"restore"] and auteur in self.overops:
 423                 self.restore(asked_by=auteur, asked_where=canal)
 424             elif cmd in [u"display"]:
 425                 self.serv.privmsg(canal, "%s: %s" % (auteur, config.quote_display_url.encode("utf-8")))
 426         else:
 427             # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
 428             match = quote_pattern.match(message)
 429             if match:
 430                 d = match.groupdict()
 431                 if self.quotedb.store(d["author"], d["content"]):
 432                     serv.privmsg(canal, (u"%s: Ce sera retenu, répété, amplifié" % (auteur,)).encode("utf-8"))
 433                     self.quotedb.save()
 434                 else:
 435                     serv.privmsg(canal, (u"%s: Je le savais déjà." % (auteur,)).encode("utf-8"))
 436             if message.startswith(u"!quote"):
 437                 if message.strip() == u"!quote":
 438                     q = self.quotedb.random()
 439                     serv.privmsg(canal, str(q))
 440                 elif message.startswith("!quote "):
 441                     author = message[7:].strip()
 442                     try:
 443                         q = self.quotedb.randomfrom(author)
 444                     except IndexError:
 445                         serv.privmsg(canal, (u"Pas de quote de %s en mémoire." % author).encode("utf-8"))
 446                         return
 447                     serv.privmsg(canal, str(q))
 448
 449     def on_action(self, serv, ev):
 450         """À la réception d'une action."""
 451         if ignore_event(serv, ev):
 452             return
 453         action = ev.arguments()[0]
 454         auteur = irclib.nm_to_n(ev.source())
 455         channel = ev.target()
 456         try:
 457             action = bot_unicode(action)
 458         except errors.UnicodeBotError:
 459             if config.utf8_trigger and not channel in self.quiet_channels:
 460                 serv.privmsg(channel, (u"%s: %s"%(auteur,random.choice(config.utf8_fail_answers))).encode("utf8"))
 461             return
 462         mypseudo = self.nick
 463
 464     def on_kick(self, serv, ev):
 465         """À la réception d'une action."""
 466         auteur = irclib.nm_to_n(ev.source())
 467         channel = ev.target()
 468         victime = ev.arguments()[0]
 469         raison = ev.arguments()[1]
 470         if victime == self.nick:
 471             log(self.serveur, "%s kické de %s par %s (raison : %s)" % (victime, channel, auteur, raison))
 472             time.sleep(2)
 473             serv.join(channel)
 474
 475     ### .fork trick
 476     def start_as_daemon(self, outfile):
 477         sys.stderr = Logger(outfile)
 478         self.start()
 479
 480
 481 class Logger(object):
 482     """Pour écrire ailleurs que sur stdout"""
 483     def __init__(self, filename="parrot.full.log"):
 484         self.filename = filename
 485
 486     def write(self, message):
 487         f = open(self.filename, "a")
 488         f.write(message)
 489         f.close()
 490
 491 def main():
 492     """Exécution principale : lecture des paramètres et lancement du bot."""
 493     if len(sys.argv) == 1:
 494         print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
 495         print "        --outfile sans --no-output ni --daemon n'a aucun effet"
 496         exit(1)
 497     serveur = sys.argv[1]
 498     if "--daemon" in sys.argv:
 499         thisfile = os.path.realpath(__file__)
 500         thisdirectory = thisfile.rsplit("/", 1)[0]
 501         os.chdir(thisdirectory)
 502         daemon = True
 503     else:
 504         daemon = False
 505     if "debug" in sys.argv or "--debug" in sys.argv:
 506         debug = True
 507     else:
 508         debug = False
 509     if "--quiet" in sys.argv:
 510         config.debug_stdout = False
 511     serveurs = {
 512               "irc" : "irc.crans.org",
 513               "crans" : "irc.crans.org",
 514               "irc.crans.org" : "irc.crans.org"}
 515     if "--no-output" in sys.argv or "--daemon" in sys.argv:
 516         outfile = "/var/log/bots/parrot.full.log"
 517         for arg in sys.argv:
 518             arg = arg.split("=")
 519             if arg[0].strip('-') in ["out", "outfile", "logfile"]:
 520                 outfile = arg[1]
 521         sys.stdout = Logger(outfile)
 522     try:
 523         serveur = serveurs[serveur]
 524     except KeyError:
 525         print "Server Unknown : %s" % (serveur)
 526         exit(404)
 527     parrot = Parrot(serveur,debug)
 528     # Si on reçoit un SIGHUP, on reload la config
 529     def sighup_handler(signum, frame):
 530         parrot.execute_reload(auteur="SIGHUP")
 531     signal.signal(signal.SIGHUP, sighup_handler)
 532     # Daemonization
 533     if daemon:
 534         child_pid = os.fork()
 535         if child_pid == 0:
 536             os.setsid()
 537             parrot.start_as_daemon(outfile)
 538         else:
 539             # on enregistre le pid de parrot
 540             pidfile = "/var/run/bots/parrot.pid"
 541             for arg in sys.argv:
 542                 arg = arg.split("=")
 543                 if arg[0].strip('-') in ["pidfile"]:
 544                     pidfile = arg[1]
 545             f = open(pidfile, "w")
 546             f.write("%s\n" % child_pid)
 547             f.close()
 548     else:
 549         parrot.start()
 550
 551 if __name__ == "__main__":
 552     main()