helixbot.py

   1 #!/usr/bin/python
   2 # -*- encoding: utf-8 -*-
   3
   4 """ Codé par 20-100
   5
   6 Un bot IRC qui donne les réponses de Helix the fossil.
   7 """
   8
   9 import sys
  10 import os
  11 import ircbot
  12 import random
  13 import time
  14 import re
  15 import signal
  16 from commands import getstatusoutput as ex
  17
  18 # Oui, j'ai recodé ma version d'irclib pour pouvoir rattrapper les SIGHUP
  19 sys.path.insert(0, "/home/vincent/scripts/python-myirclib")
  20 import irclib
  21
  22 # on récupère la config
  23 import config
  24
  25
  26 def get_config_logfile(serveur):
  27     """Renvoie le nom du fichier de log en fonction du serveur."""
  28     serveurs = {"acoeur.crans.org" : "acoeur", "irc.crans.org" : "crans"}
  29     return config.logfile_template % (serveurs[serveur])
  30
  31 def log(serveur, channel, auteur=None, message=None):
  32     import os
  33     print "\n", serveur, channel, auteur, message, get_config_logfile(serveur), os.getenv("USER")
  34     print os.getcwd()
  35     f = open(get_config_logfile(serveur), "a")
  36     if auteur == message == None:
  37         # alors c'est que c'est pas un channel mais juste une ligne de log
  38         chain = "%s %s" % (time.strftime("%F %T"), channel)
  39     else:
  40         chain = "%s [%s:%s] %s" % (time.strftime("%F %T"), channel, auteur, message)
  41     f.write(chain+"\n")
  42     if config.debug_stdout:
  43         print chain
  44     f.close()
  45
  46 def is_something(chain, matches, avant=u".*(?:^| )", apres=u"(?:$|\.| |,|;).*", case_sensitive=False, debug=False):
  47     if case_sensitive:
  48         chain = unicode(chain, "utf8")
  49     else:
  50         chain = unicode(chain, "utf8").lower()
  51     allmatches = "("+"|".join(matches)+")"
  52     reg = (avant+allmatches+apres).lower()
  53     o = re.match(reg, chain)
  54     return o
  55
  56 def is_tag(chain):
  57     return is_something(chain, config.tag_triggers)
  58 def is_tesla(chain):
  59     return is_something(chain, config.tesla_triggers, avant=u"^", apres=u"$", debug=True)
  60
  61
  62 class UnicodeBotError(Exception):
  63     pass
  64 def bot_unicode(chain):
  65     try:
  66         unicode(chain, "utf8")
  67     except UnicodeDecodeError as exc:
  68         raise UnicodeBotError
  69
  70 class HelixBot(ircbot.SingleServerIRCBot):
  71     def __init__(self, serveur, debug=False):
  72         temporary_pseudo = config.irc_pseudo + str(random.randrange(10000, 100000))
  73         ircbot.SingleServerIRCBot.__init__(self, [(serveur, 6667)],
  74                               temporary_pseudo, config.ircname, 10)
  75         self.debug = debug
  76         self.serveur = serveur
  77         self.overops = config.overops
  78         self.ops = self.overops+config.ops
  79         self.chanlist = config.chanlist
  80         self.stay_channels = config.stay_channels
  81         self.quiet_channels = config.quiet_channels
  82
  83     def give_me_my_pseudo(self, serv):
  84         serv.privmsg("NickServ", "RECOVER %s %s" % (config.irc_pseudo, config.irc_password))
  85         serv.privmsg("NickServ", "RELEASE %s %s" % (config.irc_pseudo, config.irc_password))
  86         time.sleep(0.3)
  87         serv.nick(config.irc_pseudo)
  88
  89     def on_welcome(self, serv, ev):
  90         self.serv = serv # ça serv ira :)
  91         self.give_me_my_pseudo(serv)
  92         serv.privmsg("NickServ", "identify %s" % (config.irc_password))
  93         log(self.serveur, "Connected")
  94         if self.debug:
  95             self.chanlist = ["#bot"]
  96         for c in self.chanlist:
  97             log(self.serveur, "JOIN %s" % (c))
  98             serv.join(c)
  99
 100     def pourmoi(self, serv, message):
 101         """renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
 102         pseudo = self.nick
 103         size = len(pseudo)
 104         if message[:size]  == pseudo and len(message)>size and message[size] == ":":
 105             return (True, message[size+1:].lstrip(" "))
 106         else:
 107             return (False, message)
 108
 109     def on_privmsg(self, serv, ev):
 110         message = ev.arguments()[0]
 111         auteur = irclib.nm_to_n(ev.source())
 112         try:
 113             bot_unicode(message)
 114         except UnicodeBotError:
 115             if config.utf8_trigger:
 116                 serv.privmsg(auteur, random.choice(config.utf8_fail_answers).encode("utf8"))
 117             return
 118         message = message.split()
 119         cmd = message[0].lower()
 120         notunderstood = False
 121         if cmd == "help":
 122             helpdico = {"help":["""HELP <commande>
 123  Affiche de l'aide sur la commande""", None, None],
 124  "join": [None, """JOIN <channel>
 125  Me fait rejoindre le channel""", None],
 126  "leave": [None, """LEAVE <channel>
 127  Me fait quitter le channel (sauf s'il est dans ma stay_list).""", None],
 128  "quiet": [None, """QUIET <channel>
 129  Me rend silencieux sur le channel.""", None],
 130  "noquiet": [None, """NOQUIET <channel>
 131  Me rend la parole sur le channel.""", None],
 132  "say": [None, None, """SAY <channel> <message>
 133  Me fait parler sur le channel."""],
 134  "do": [None, None, """DO <channel> <action>
 135  Me fait faitre une action (/me) sur le channel."""],
 136  "stay": [None, None, """STAY <channel>
 137  Ajoute le channel à ma stay_list."""],
 138  "nostay": [None, None, """NOSTAY <channel>
 139  Retire le channel de ma stay_list."""],
 140  "ops": [None, None, """OPS
 141  Affiche la liste des ops."""],
 142  "overops": [None, None, """OVEROPS
 143  Affiche la liste des overops."""],
 144  "kick": [None, None, """KICK <channel> <pseudo> [<raison>]
 145  Kicke <pseudo> du channel (Il faut bien entendu que j'y sois op)."""],
 146  "die": [None, None, """DIE
 147  Me déconnecte du serveur IRC."""]
 148  }
 149             helpmsg_default = "Liste des commandes disponibles :\nHELP"
 150             helpmsg_ops = " JOIN LEAVE QUIET NOQUIET RECONNECT"
 151             helpmsg_overops = " SAY DO STAY NOSTAY OPS OVEROPS KICK DIE"
 152             op, overop = auteur in self.ops, auteur in self.overops
 153             if len(message) == 1:
 154                 helpmsg = helpmsg_default
 155                 if op:
 156                     helpmsg += helpmsg_ops
 157                 if overop:
 158                     helpmsg += helpmsg_overops
 159             else:
 160                 helpmsgs = helpdico.get(message[1].lower(), ["Commande inconnue.", None, None])
 161                 helpmsg = helpmsgs[0]
 162                 if op and helpmsgs[1]:
 163                     if helpmsg:
 164                         helpmsg += "\n"+helpmsgs[1]
 165                     else:
 166                         helpmsg = helpmsgs[1]
 167                 if overop and helpmsgs[2]:
 168                     if helpmsg:
 169                         helpmsg += "\n"+helpmsgs[2]
 170                     else:
 171                         helpmsg = helpmsgs[2]
 172             for ligne in helpmsg.split("\n"):
 173                 serv.privmsg(auteur, ligne)
 174         elif cmd == "join":
 175             if auteur in self.ops:
 176                 if len(message)>1:
 177                     if message[1] in self.chanlist:
 178                         serv.privmsg(auteur, "Je suis déjà sur %s" % (message[1]))
 179                     else:
 180                         serv.join(message[1])
 181                         self.chanlist.append(message[1])
 182                         serv.privmsg(auteur, "Channels : "+" ".join(self.chanlist))
 183                         log(self.serveur, "priv", auteur, " ".join(message))
 184                 else:
 185                     serv.privmsg(auteur, "Channels : "+" ".join(self.chanlist))
 186             else:
 187                 notunderstood = True
 188         elif cmd == "leave":
 189             if auteur in self.ops and len(message)>1:
 190                 if message[1] in self.chanlist:
 191                     if not (message[1] in self.stay_channels) or auteur in self.overops:
 192                         self.quitter(message[1], " ".join(message[2:]))
 193                         self.chanlist.remove(message[1])
 194                         log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 195                     else:
 196                         serv.privmsg(auteur, "Non, je reste !")
 197                         log(self.serveur, "priv", auteur, " ".join(message)+"[failed]")
 198                 else:
 199                     serv.privmsg(auteur, "Je ne suis pas sur %s" % (message[1]))
 200             else:
 201                 notunderstood = True
 202         elif cmd == "stay":
 203             if auteur in self.overops:
 204                 if len(message)>1:
 205                     if message[1] in self.stay_channels:
 206                         log(self.serveur, "priv", auteur, " ".join(message)+"[failed]")
 207                         serv.privmsg(auteur, "Je stay déjà sur %s." % (message[1]))
 208                     else:
 209                         log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 210                         self.stay_channels.append(message[1])
 211                         serv.privmsg(auteur, "Stay channels : "+" ".join(self.stay_channels))
 212                 else:
 213                     serv.privmsg(auteur, "Stay channels : "+" ".join(self.stay_channels))
 214             else:
 215                 notunderstood = True
 216         elif cmd == "nostay":
 217             if auteur in self.overops:
 218                 if len(message)>1:
 219                     if message[1] in self.stay_channels:
 220                         log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 221                         self.stay_channels.remove(message[1])
 222                         serv.privmsg(auteur, "Stay channels : "+" ".join(self.stay_channels))
 223                     else:
 224                         log(self.serveur, "priv", auteur, " ".join(message)+"[failed]")
 225                         serv.privmsg(auteur, "Je ne stay pas sur %s." % (message[1]))
 226
 227             else:
 228                 notunderstood = True
 229         elif cmd == "die":
 230             if auteur in self.overops:
 231                 log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 232                 self.mourir()
 233             else:
 234                 notunderstood = True
 235         elif cmd == "quiet":
 236             if auteur in self.ops:
 237                 if len(message)>1:
 238                     if message[1] in self.quiet_channels:
 239                         serv.privmsg(auteur, "Je me la ferme déjà sur %s" % (message[1]))
 240                         log(self.serveur, "priv", auteur, " ".join(message)+"[failed]")
 241                     else:
 242                         self.quiet_channels.append(message[1])
 243                         serv.privmsg(auteur, "Quiet channels : "+" ".join(self.quiet_channels))
 244                         log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 245                 else:
 246                     serv.privmsg(auteur, "Quiet channels : "+" ".join(self.quiet_channels))
 247             else:
 248                 notunderstood = True
 249         elif cmd == "noquiet":
 250             if auteur in self.ops:
 251                 if len(message)>1:
 252                     if message[1] in self.quiet_channels:
 253                         self.quiet_channels.remove(message[1])
 254                         serv.privmsg(auteur, "Quiet channels : "+" ".join(self.quiet_channels))
 255                         log(self.serveur, "priv", auteur, " ".join(message)+"[successful]")
 256                     else:
 257                         serv.privmsg(auteur, "Je ne me la ferme pas sur %s." % (message[1]))
 258                         log(self.serveur, "priv", auteur, " ".join(message)+"[failed]")
 259             else:
 260                 notunderstood = True
 261         elif cmd == "say":
 262             if auteur in self.overops and len(message)>2:
 263                 serv.privmsg(message[1], " ".join(message[2:]))
 264                 log(self.serveur, "priv", auteur, " ".join(message))
 265             elif len(message) <= 2:
 266                 serv.privmsg(auteur, "Syntaxe : SAY <channel> <message>")
 267             else:
 268                 notunderstood = True
 269         elif cmd == "do":
 270             if auteur in self.overops and len(message)>2:
 271                 serv.action(message[1], " ".join(message[2:]))
 272                 log(self.serveur, "priv", auteur, " ".join(message))
 273             elif len(message) <= 2:
 274                 serv.privmsg(auteur, "Syntaxe : DO <channel> <action>")
 275             else:
 276                 notunderstood = True
 277         elif cmd == "kick":
 278             if auteur in self.overops and len(message)>2:
 279                 serv.kick(message[1], message[2], " ".join(message[3:]))
 280                 log(self.serveur, "priv", auteur, " ".join(message))
 281             elif len(message) <= 2:
 282                 serv.privmsg(auteur, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
 283             else:
 284                 notunderstood = True
 285         elif cmd == "ops":
 286             if auteur in self.overops:
 287                 serv.privmsg(auteur, " ".join(self.ops))
 288             else:
 289                 notunderstood = True
 290         elif cmd == "overops":
 291             if auteur in self.overops:
 292                 serv.privmsg(auteur, " ".join(self.overops))
 293             else:
 294                 notunderstood = True
 295         else:
 296             notunderstood = True
 297         if notunderstood:
 298             serv.privmsg(auteur, "Je n'ai pas compris. Essayez HELP…")
 299
 300     def on_pubmsg(self, serv, ev):
 301         auteur = irclib.nm_to_n(ev.source())
 302         canal = ev.target()
 303         message = ev.arguments()[0]
 304         try:
 305             bot_unicode(message)
 306         except UnicodeBotError:
 307             if config.utf8_trigger and not canal in self.quiet_channels:
 308                 serv.privmsg(canal, (u"%s: %s" % (auteur, random.choice(config.utf8_fail_answers))).encode("utf8"))
 309             return
 310         pour_moi, message = self.pourmoi(serv, message)
 311         if pour_moi and message.split() != []:
 312             cmd = message.split()[0].lower()
 313             try:
 314                 args = " ".join(message.split()[1:])
 315             except:
 316                 args = ""
 317             if cmd in ["meurs", "die", "crève"]:
 318                 if auteur in self.overops:
 319                     log(self.serveur, canal, auteur, message+"[successful]")
 320                     self.mourir()
 321                 else:
 322                     serv.privmsg(canal, ("%s: %s" % (auteur, random.choice(config.quit_fail_messages))).encode("utf8"))
 323                     log(self.serveur, canal, auteur, message+"[failed]")
 324
 325             elif cmd in ["part", "leave", "dégage", "va-t-en", "tut'tiresailleurs, c'estmesgalets"]:
 326                 if auteur in self.ops and (not (canal in self.stay_channels)
 327                                            or auteur in self.overops):
 328                     self.quitter(canal)
 329                     log(self.serveur, canal, auteur, message+"[successful]")
 330                     if canal in self.chanlist:
 331                         self.chanlist.remove(canal)
 332                 else:
 333                     serv.privmsg(canal, ("%s: %s" % (auteur, random.choice(config.leave_fail_messages))).encode("utf8"))
 334                     log(self.serveur, canal, auteur, message+"[failed]")
 335
 336             elif cmd in ["deviens", "pseudo"]:
 337                 if auteur in self.ops:
 338                     become = args
 339                     serv.nick(become)
 340                     log(self.serveur, canal, auteur, message+"[successful]")
 341
 342             elif cmd in ["ping"] and not canal in self.quiet_channels:
 343                 serv.privmsg(canal, "%s: pong" % (auteur))
 344             if is_tag(message) and not canal in self.quiet_channels:
 345                 if auteur in self.ops:
 346                     action = random.choice(config.tag_actions)
 347                     serv.action(canal, action.encode("utf8"))
 348                     self.quiet_channels.append(canal)
 349                 else:
 350                     answer = random.choice(config.tag_answers)
 351                     for ligne in answer.split("\n"):
 352                         serv.privmsg(canal, "%s: %s" % (auteur, ligne.encode("utf8")))
 353             elif (any([re.match(trig, message) for trig in config.fossil_triggers]) and
 354                   not canal in self.quiet_channels):
 355                 answer = random.choice(config.fossil_answers)
 356                 serv.privmsg(canal, "%s: %s" % (auteur, answer))
 357         else:
 358             pass
 359
 360     def on_action(self, serv, ev):
 361         action = ev.arguments()[0]
 362         auteur = irclib.nm_to_n(ev.source())
 363         channel = ev.target()
 364         try:
 365             bot_unicode(action)
 366         except UnicodeBotError:
 367             if config.utf8_trigger and not channel in self.quiet_channels:
 368                 serv.privmsg(channel, (u"%s: %s" % (auteur, random.choice(config.utf8_fail_answers))).encode("utf8"))
 369             return
 370         mypseudo = self.nick
 371
 372
 373     def on_kick(self, serv, ev):
 374         auteur = irclib.nm_to_n(ev.source())
 375         channel = ev.target()
 376         victime = ev.arguments()[0]
 377         raison = ev.arguments()[1]
 378         if victime == self.nick:
 379             log(self.serveur, "%s kické de %s par %s (raison : %s)" % (victime, channel, auteur, raison))
 380             time.sleep(2)
 381             serv.join(channel)
 382             return # pas de réaction verbale au kick
 383             l1, l2 = config.kick_answers, config.kick_actions
 384             n1, n2 = len(l1), len(l2)
 385             i = random.randrange(n1+n2)
 386             if i >= n1:
 387                 serv.action(channel, l2[i-n1].format(auteur).encode("utf8"))
 388             else:
 389                 serv.privmsg(channel, l1[i].format(auteur).encode("utf8"))
 390
 391     def quitter(self, chan, leave_message=None):
 392         if leave_message == None:
 393             leave_message = random.choice(config.leave_messages)
 394         self.serv.part(chan, message=leave_message.encode("utf8"))
 395
 396     def mourir(self):
 397         quit_message = random.choice(config.quit_messages)
 398         self.die(msg=quit_message.encode("utf8"))
 399
 400     def _getnick(self):
 401         return self.serv.get_nickname()
 402     nick = property(_getnick)
 403
 404     ### .fork trick
 405     def start_as_daemon(self, outfile):
 406         sys.stderr = Logger(outfile)
 407         self.start()
 408
 409 class Logger(object):
 410     """Pour écrire ailleurs que sur stdout"""
 411     def __init__(self, filename="basile.full.log"):
 412         self.filename = filename
 413
 414     def write(self, message):
 415         f = open(self.filename, "a")
 416         f.write(message)
 417         f.close()
 418
 419 def main():
 420     """Exécution principale : lecture des paramètres et lancement du bot."""
 421     if len(sys.argv) == 1:
 422         print "Usage : helixbot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
 423         print "        --outfile sans --no-output ni --daemon n'a aucun effet"
 424         exit(1)
 425     serveur = sys.argv[1]
 426     if "--daemon" in sys.argv:
 427         thisfile = os.path.realpath(__file__)
 428         thisdirectory = thisfile.rsplit("/", 1)[0]
 429         os.chdir(thisdirectory)
 430         daemon = True
 431     else:
 432         daemon = False
 433     if "debug" in sys.argv or "--debug" in sys.argv:
 434         debug = True
 435     else:
 436         debug = False
 437     if "--quiet" in sys.argv:
 438         config.debug_stdout = False
 439     serveurs = {"a♡" : "acoeur.crans.org",
 440               "acoeur" : "acoeur.crans.org",
 441               "acoeur.crans.org" : "acoeur.crans.org",
 442               "irc" : "irc.crans.org",
 443               "crans" : "irc.crans.org",
 444               "irc.crans.org" : "irc.crans.org"}
 445     if "--no-output" in sys.argv or "--daemon" in sys.argv:
 446         outfile = "/var/log/bots/helixbot.full.log"
 447         for arg in sys.argv:
 448             arg = arg.split("=")
 449             if arg[0].strip('-') in ["out", "outfile", "logfile"]:
 450                 outfile = arg[1]
 451         sys.stdout = Logger(outfile)
 452     try:
 453         serveur = serveurs[serveur]
 454     except KeyError:
 455         print "Server Unknown : %s" % (serveur)
 456         exit(404)
 457     helix = HelixBot(serveur,debug)
 458     # Si on reçoit un SIGHUP, on reload la config
 459     def sighup_handler(signum, frame):
 460         helix.execute_reload(auteur="SIGHUP")
 461     signal.signal(signal.SIGHUP, sighup_handler)
 462     # Daemonization
 463     if daemon:
 464         child_pid = os.fork()
 465         if child_pid == 0:
 466             os.setsid()
 467             helix.start_as_daemon(outfile)
 468         else:
 469             # on enregistre le pid de basile
 470             pidfile = "/var/run/bots/helixbot.pid"
 471             for arg in sys.argv:
 472                 arg = arg.split("=")
 473                 if arg[0].strip('-') in ["pidfile"]:
 474                     pidfile = arg[1]
 475             f = open(pidfile, "w")
 476             f.write("%s\n" % child_pid)
 477             f.close()
 478     else:
 479         helix.start()
 480
 481 if __name__ == "__main__":
 482     main()