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
 166     ### Surcharge des events du Bot
 167     def on_welcome(self, serv, ev):
 168         """À l'arrivée sur le serveur."""
 169         self.serv = serv # ça serv ira :)
 170         self.give_me_my_pseudo(serv)
 171         serv.privmsg("NickServ", "IDENTIFY %s" % (config.irc_password))
 172         log(self.serveur, "Connected")
 173         if self.debug:
 174             self.chanlist = ["#bot"]
 175         for c in self.chanlist:
 176             log(self.serveur, "JOIN %s" % (c))
 177             serv.join(c)
 178
 179     def on_privmsg(self, serv, ev):
 180         """À la réception d'un message en privé."""
 181         if ignore_event(serv, ev):
 182             return
 183         message = ev.arguments()[0]
 184         auteur = irclib.nm_to_n(ev.source())
 185         try:
 186             message = bot_unicode(message)
 187         except errors.UnicodeBotError:
 188             if config.utf8_trigger:
 189                 serv.privmsg(auteur, random.choice(config.utf8_fail_answers).encode("utf8"))
 190             return
 191         message = message.split()
 192         cmd = message[0].lower()
 193         notunderstood = False
 194         if cmd == u"help":
 195             op,overop=auteur in self.ops, auteur in self.overops
 196             if len(message)==1:
 197                 helpmsg = config.helpmsg_default
 198                 if op:
 199                     helpmsg += config.helpmsg_ops
 200                 if overop:
 201                     helpmsg += config.helpmsg_overops
 202             else:
 203                 helpmsgs = config.helpdico.get(message[1].lower(), ["Commande inconnue.", None, None])
 204                 helpmsg = helpmsgs[0]
 205                 if op and helpmsgs[1]:
 206                     if helpmsg:
 207                         helpmsg += "\n" + helpmsgs[1]
 208                     else:
 209                         helpmsg = helpmsgs[1]
 210                 if overop and helpmsgs[2]:
 211                     if helpmsg:
 212                         helpmsg += "\n" + helpmsgs[2]
 213                     else:
 214                         helpmsg = helpmsgs[2]
 215             for ligne in helpmsg.split("\n"):
 216                 serv.privmsg(auteur, ligne.encode("utf-8"))
 217         elif cmd == u"join":
 218             if auteur in self.ops:
 219                 if len(message) > 1:
 220                     if message[1] in self.chanlist:
 221                         serv.privmsg(auteur, "Je suis déjà sur %s" % (message[1]))
 222                     else:
 223                         serv.join(message[1])
 224                         self.chanlist.append(message[1])
 225                         serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 226                         log(self.serveur, "priv", auteur, " ".join(message))
 227                 else:
 228                     serv.privmsg(auteur, "Channels : " + " ".join(self.chanlist))
 229             else:
 230                 notunderstood = True
 231         elif cmd == u"leave":
 232             if auteur in self.ops and len(message) > 1:
 233                 if message[1] in self.chanlist:
 234                     if not (message[1] in self.stay_channels) or auteur in self.overops:
 235                         self.quitter(message[1].encode("utf-8"), " ".join(message[2:]))
 236                         self.chanlist.remove(message[1])
 237                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 238                     else:
 239                         serv.privmsg(auteur, "Non, je reste !")
 240                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 241                 else:
 242                     serv.privmsg(auteur, "Je ne suis pas sur %s" % (message[1]))
 243             else:
 244                 notunderstood = True
 245         elif cmd == u"stay":
 246             if auteur in self.overops:
 247                 if len(message) > 1:
 248                     if message[1] in self.stay_channels:
 249                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 250                         serv.privmsg(auteur, "Je stay déjà sur %s." % (message[1]))
 251                     else:
 252                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 253                         self.stay_channels.append(message[1])
 254                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 255                 else:
 256                     serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 257             else:
 258                 notunderstood = True
 259         elif cmd == u"nostay":
 260             if auteur in self.overops:
 261                 if len(message) > 1:
 262                     if message[1] in self.stay_channels:
 263                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 264                         self.stay_channels.remove(message[1])
 265                         serv.privmsg(auteur, "Stay channels : " + " ".join(self.stay_channels))
 266                     else:
 267                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 268                         serv.privmsg(auteur, "Je ne stay pas sur %s." % (message[1]))
 269             else:
 270                 notunderstood = True
 271         elif cmd == u"die":
 272             if auteur in self.overops:
 273                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 274                 self.mourir()
 275             else:
 276                 notunderstood = True
 277         elif cmd == u"crash":
 278             if auteur in self.overops:
 279                 log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 280                 self.crash(auteur, "priv")
 281             else:
 282                 notunderstood = True
 283         elif cmd == u"reload":
 284             if auteur in self.ops:
 285                 self.execute_something("reload", {"auteur" : auteur}, place=auteur, auteur=auteur)
 286             else:
 287                 notunderstood = True
 288         elif cmd == u"quiet":
 289             if auteur in self.ops:
 290                 if len(message) > 1:
 291                     if message[1] in self.quiet_channels:
 292                         serv.privmsg(auteur, "Je me la ferme déjà sur %s" % (message[1]))
 293                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 294                     else:
 295                         self.quiet_channels.append(message[1])
 296                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 297                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 298                 else:
 299                     serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 300             else:
 301                 notunderstood = True
 302         elif cmd == u"noquiet":
 303             if auteur in self.ops:
 304                 if len(message) > 1:
 305                     if message[1] in self.quiet_channels:
 306                         self.quiet_channels.remove(message[1])
 307                         serv.privmsg(auteur, "Quiet channels : " + " ".join(self.quiet_channels))
 308                         log(self.serveur, "priv", auteur, " ".join(message) + "[successful]")
 309                     else:
 310                         serv.privmsg(auteur, "Je ne me la ferme pas sur %s." % (message[1]))
 311                         log(self.serveur, "priv", auteur, " ".join(message) + "[failed]")
 312             else:
 313                 notunderstood = True
 314         elif cmd == u"say":
 315             if auteur in self.overops and len(message) > 2:
 316                 serv.privmsg(message[1].encode("utf-8"), (u" ".join(message[2:])).encode("utf-8"))
 317                 log(self.serveur, "priv", auteur, " ".join(message))
 318             elif len(message) <= 2:
 319                 serv.privmsg(auteur, "Syntaxe : SAY <channel> <message>")
 320             else:
 321                 notunderstood = True
 322         elif cmd == u"do":
 323             if auteur in self.overops and len(message) > 2:
 324                 serv.action(message[1], " ".join(message[2:]))
 325                 log(self.serveur, "priv", auteur, " ".join(message))
 326             elif len(message) <= 2:
 327                 serv.privmsg(auteur, "Syntaxe : DO <channel> <action>")
 328             else:
 329                 notunderstood = True
 330         elif cmd == u"kick":
 331             if auteur in self.overops and len(message) > 2:
 332                 serv.kick(message[1].encode("utf-8"), message[2].encode("utf-8"), " ".join(message[3:]).encode("utf-8"))
 333                 log(self.serveur, "priv", auteur, " ".join(message))
 334             elif len(message) <= 2:
 335                 serv.privmsg(auteur, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
 336             else:
 337                 notunderstood = True
 338         elif cmd == u"ops":
 339             if auteur in self.overops:
 340                 serv.privmsg(auteur, " ".join(self.ops))
 341             else:
 342                 notunderstood = True
 343         elif cmd == u"overops":
 344             if auteur in self.overops:
 345                 serv.privmsg(auteur, " ".join(self.overops))
 346             else:
 347                 notunderstood = True
 348         else:
 349             notunderstood = True
 350         if notunderstood:
 351             serv.privmsg(auteur, "Je n'ai pas compris. Essayez HELP…")
 352
 353     def on_pubmsg(self, serv, ev):
 354         """À la réception d'un message sur un channel."""
 355         if ignore_event(serv, ev):
 356             return
 357         auteur = irclib.nm_to_n(ev.source())
 358         canal = ev.target()
 359         message = ev.arguments()[0]
 360         try:
 361             message = bot_unicode(message)
 362         except errors.UnicodeBotError:
 363             if config.utf8_trigger and not canal in self.quiet_channels:
 364                 serv.privmsg(canal, (u"%s: %s"% ( auteur, random.choice(config.utf8_fail_answers))).encode("utf8"))
 365             return
 366         pour_moi, message = self.pourmoi(serv, message)
 367         if pour_moi and message.split()!=[]:
 368             cmd = message.split()[0].lower()
 369             try:
 370                 args = " ".join(message.split()[1:])
 371             except:
 372                 args = ""
 373             if cmd in [u"meurs", u"die", u"crève"]:
 374                 if auteur in self.overops:
 375                     log(self.serveur, canal, auteur, message + "[successful]")
 376                     self.mourir()
 377                 else:
 378                     serv.privmsg(canal,(u"%s: %s"%(auteur, random.choice(config.quit_fail_messages))).encode("utf8"))
 379                     log(self.serveur, canal, auteur, message + "[failed]")
 380             elif cmd == u"reload":
 381                 if auteur in self.ops:
 382                     self.execute_something("reload", {"auteur" : auteur}, place=canal, auteur=auteur)
 383             elif cmd == u"crash":
 384                 if auteur in self.overops:
 385                     self.crash(auteur, canal)
 386             elif cmd in [u"part", u"leave", u"dégage", u"va-t-en"]:
 387                 if auteur in self.ops and (not (canal in self.stay_channels)
 388                                            or auteur in self.overops):
 389                     self.quitter(canal)
 390                     log(self.serveur, canal, auteur, message + "[successful]")
 391                     if canal in self.chanlist:
 392                         self.chanlist.remove(canal)
 393                 else:
 394                     serv.privmsg(canal,(u"%s: %s" % (auteur, random.choice(config.leave_fail_messages))).encode("utf8"))
 395                     log(self.serveur, canal, auteur, message + "[failed]")
 396
 397             elif cmd in [u"ping"] and not canal in self.quiet_channels:
 398                 serv.privmsg(canal, "%s: pong" % (auteur))
 399         else:
 400             # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
 401             match = quote_pattern.match(message)
 402             if match:
 403                 d = match.groupdict()
 404                 if self.quotedb.store(d["author"], d["content"]):
 405                     serv.privmsg(canal, (u"%s: Ce sera retenu, répété, amplifié" % (auteur,)).encode("utf-8"))
 406                     self.quotedb.save()
 407                 else:
 408                     serv.privmsg(canal, (u"%s: Je le savais déjà." % (auteur,)).encode("utf-8"))
 409             if message.startswith(u"!quote"):
 410                 if message.strip() == u"!quote":
 411                     q = self.quotedb.random()
 412                     serv.privmsg(canal, str(q))
 413                 elif message.startswith("!quote "):
 414                     author = message[7:].strip()
 415                     try:
 416                         q = self.quotedb.randomfrom(author)
 417                     except IndexError:
 418                         serv.privmsg(canal, (u"Pas de quote de %s en mémoire." % author).encode("utf-8"))
 419                         return
 420                     serv.privmsg(canal, str(q))
 421
 422     def on_action(self, serv, ev):
 423         """À la réception d'une action."""
 424         if ignore_event(serv, ev):
 425             return
 426         action = ev.arguments()[0]
 427         auteur = irclib.nm_to_n(ev.source())
 428         channel = ev.target()
 429         try:
 430             action = bot_unicode(action)
 431         except errors.UnicodeBotError:
 432             if config.utf8_trigger and not channel in self.quiet_channels:
 433                 serv.privmsg(channel, (u"%s: %s"%(auteur,random.choice(config.utf8_fail_answers))).encode("utf8"))
 434             return
 435         mypseudo = self.nick
 436
 437     def on_kick(self, serv, ev):
 438         """À la réception d'une action."""
 439         auteur = irclib.nm_to_n(ev.source())
 440         channel = ev.target()
 441         victime = ev.arguments()[0]
 442         raison = ev.arguments()[1]
 443         if victime == self.nick:
 444             log(self.serveur, "%s kické de %s par %s (raison : %s)" % (victime, channel, auteur, raison))
 445             time.sleep(2)
 446             serv.join(channel)
 447
 448     ### .fork trick
 449     def start_as_daemon(self, outfile):
 450         sys.stderr = Logger(outfile)
 451         self.start()
 452
 453
 454 class Logger(object):
 455     """Pour écrire ailleurs que sur stdout"""
 456     def __init__(self, filename="parrot.full.log"):
 457         self.filename = filename
 458
 459     def write(self, message):
 460         f = open(self.filename, "a")
 461         f.write(message)
 462         f.close()
 463
 464 def main():
 465     """Exécution principale : lecture des paramètres et lancement du bot."""
 466     if len(sys.argv) == 1:
 467         print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
 468         print "        --outfile sans --no-output ni --daemon n'a aucun effet"
 469         exit(1)
 470     serveur = sys.argv[1]
 471     if "--daemon" in sys.argv:
 472         thisfile = os.path.realpath(__file__)
 473         thisdirectory = thisfile.rsplit("/", 1)[0]
 474         os.chdir(thisdirectory)
 475         daemon = True
 476     else:
 477         daemon = False
 478     if "debug" in sys.argv or "--debug" in sys.argv:
 479         debug = True
 480     else:
 481         debug = False
 482     if "--quiet" in sys.argv:
 483         config.debug_stdout = False
 484     serveurs = {
 485               "irc" : "irc.crans.org",
 486               "crans" : "irc.crans.org",
 487               "irc.crans.org" : "irc.crans.org"}
 488     if "--no-output" in sys.argv or "--daemon" in sys.argv:
 489         outfile = "/var/log/bots/parrot.full.log"
 490         for arg in sys.argv:
 491             arg = arg.split("=")
 492             if arg[0].strip('-') in ["out", "outfile", "logfile"]:
 493                 outfile = arg[1]
 494         sys.stdout = Logger(outfile)
 495     try:
 496         serveur = serveurs[serveur]
 497     except KeyError:
 498         print "Server Unknown : %s" % (serveur)
 499         exit(404)
 500     parrot = Parrot(serveur,debug)
 501     # Si on reçoit un SIGHUP, on reload la config
 502     def sighup_handler(signum, frame):
 503         parrot.execute_reload(auteur="SIGHUP")
 504     signal.signal(signal.SIGHUP, sighup_handler)
 505     # Daemonization
 506     if daemon:
 507         child_pid = os.fork()
 508         if child_pid == 0:
 509             os.setsid()
 510             parrot.start_as_daemon(outfile)
 511         else:
 512             # on enregistre le pid de parrot
 513             pidfile = "/var/run/bots/parrot.pid"
 514             for arg in sys.argv:
 515                 arg = arg.split("=")
 516                 if arg[0].strip('-') in ["pidfile"]:
 517                     pidfile = arg[1]
 518             f = open(pidfile, "w")
 519             f.write("%s\n" % child_pid)
 520             f.close()
 521     else:
 522         parrot.start()
 523
 524 if __name__ == "__main__":
 525     main()