]>
gitweb.pimeys.fr Git - bots/parrot.git/blob - parrot.py
2 # -*- encoding: utf-8 -*-
4 """ Un bot IRC qui enregistre et ressort des citations """
15 # Oui, j'ai recodé ma version d'irclib pour pouvoir rattrapper les SIGHUP
16 sys
.path
.insert(0, "/home/vincent/scripts/python-myirclib")
20 from commands
import getstatusoutput
as ex
24 #: Module définissant les erreurs
26 #: Module de gestion des quotes
29 quote_pattern
= re
.compile(config
.quote_regexp
, flags
=re
.UNICODE
)
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
],)
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
)
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"))
46 if config
.debug_stdout
:
47 print chain
.encode("utf-8")
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é
58 if blackit
: # Il n'est pas exempté et matche la blacklist
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."""
66 return chain
.decode("utf8")
67 except UnicodeDecodeError as exc
:
68 raise errors
.UnicodeBotError
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)
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
87 self
.quotedb
= quotes
.QuoteDB()
93 """Récuère le nick effectif du bot sur le serveur."""
94 return self
.serv
.get_nickname()
95 nick
= property(_getnick
)
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
))
102 serv
.nick(config
.irc_pseudo
)
104 def pourmoi(self
, serv
, message
):
105 """Renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
107 pseudo
= pseudo
.decode("utf-8")
109 if message
[:size
] == pseudo
and len(message
) > size
and message
[size
] == ":":
110 return (True, message
[size
+1:].lstrip(" "))
112 return (False, message
)
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"))
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"))
126 def reload_quotes(self
):
127 """ Recharge la base de données des quotes et recompile la regexp de quote """
129 self
.quote_pattern
= re
.compile(config
.quote_regexp
, flags
=re
.UNICODE
)
131 def execute_reload(self
, auteur
=None):
132 """Recharge la config."""
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
)
142 return True, u
"Config reloaded"
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"))
150 "reload" : execute_reload
,
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
)
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]"))
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
)
171 self
.serv
.privmsg(asked_where
, "%s: %s" % (asked_by
, message
))
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")
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é).")
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")
191 self
.chanlist
= ["#bot"]
192 for c
in self
.chanlist
:
193 log(self
.serveur
, "JOIN %s" % (c
))
196 def on_privmsg(self
, serv
, ev
):
197 """À la réception d'un message en privé."""
198 if ignore_event(serv
, ev
):
200 message
= ev
.arguments()[0]
201 auteur
= irclib
.nm_to_n(ev
.source())
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"))
208 message
= message
.split()
209 cmd
= message
[0].lower()
210 notunderstood
= False
212 op
,overop
=auteur
in self
.ops
, auteur
in self
.overops
214 helpmsg
= config
.helpmsg_default
216 helpmsg
+= config
.helpmsg_ops
218 helpmsg
+= config
.helpmsg_overops
220 helpmsgs
= config
.helpdico
.get(message
[1].lower(), ["Commande inconnue.", None, None])
221 helpmsg
= helpmsgs
[0]
222 if op
and helpmsgs
[1]:
224 helpmsg
+= "\n" + helpmsgs
[1]
226 helpmsg
= helpmsgs
[1]
227 if overop
and helpmsgs
[2]:
229 helpmsg
+= "\n" + helpmsgs
[2]
231 helpmsg
= helpmsgs
[2]
232 for ligne
in helpmsg
.split("\n"):
233 serv
.privmsg(auteur
, ligne
.encode("utf-8"))
235 if auteur
in self
.ops
:
237 if message
[1] in self
.chanlist
:
238 serv
.privmsg(auteur
, "Je suis déjà sur %s" % (message
[1]))
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
))
245 serv
.privmsg(auteur
, "Channels : " + " ".join(self
.chanlist
))
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]")
256 serv
.privmsg(auteur
, "Non, je reste !")
257 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
259 serv
.privmsg(auteur
, "Je ne suis pas sur %s" % (message
[1]))
263 if auteur
in self
.overops
:
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]))
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
))
273 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
276 elif cmd
== u
"nostay":
277 if auteur
in self
.overops
:
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
))
284 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
285 serv
.privmsg(auteur
, "Je ne stay pas sur %s." % (message
[1]))
289 if auteur
in self
.overops
:
290 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
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")
300 elif cmd
== u
"reload":
301 if auteur
in self
.ops
:
302 self
.execute_something("reload", {"auteur" : auteur
}, place
=auteur
, auteur
=auteur
)
305 elif cmd
== u
"quiet":
306 if auteur
in self
.ops
:
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]")
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]")
316 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
319 elif cmd
== u
"noquiet":
320 if auteur
in self
.ops
:
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]")
327 serv
.privmsg(auteur
, "Je ne me la ferme pas sur %s." % (message
[1]))
328 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
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>")
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>")
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>]")
356 if auteur
in self
.overops
:
357 serv
.privmsg(auteur
, " ".join(self
.ops
))
360 elif cmd
== u
"overops":
361 if auteur
in self
.overops
:
362 serv
.privmsg(auteur
, " ".join(self
.overops
))
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
)
372 serv
.privmsg(auteur
, "Je n'ai pas compris. Essayez HELP…")
374 def on_pubmsg(self
, serv
, ev
):
375 """À la réception d'un message sur un channel."""
376 if ignore_event(serv
, ev
):
378 auteur
= irclib
.nm_to_n(ev
.source())
380 message
= ev
.arguments()[0]
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"))
387 pour_moi
, message
= self
.pourmoi(serv
, message
)
388 if pour_moi
and message
.split()!=[]:
389 cmd
= message
.split()[0].lower()
391 args
= " ".join(message
.split()[1:])
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]")
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
):
411 log(self
.serveur
, canal
, auteur
, message
+ "[successful]")
412 if canal
in self
.chanlist
:
413 self
.chanlist
.remove(canal
)
415 serv
.privmsg(canal
,(u
"%s: %s" % (auteur
, random
.choice(config
.leave_fail_messages
))).encode("utf8"))
416 log(self
.serveur
, canal
, auteur
, message
+ "[failed]")
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
)
425 # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
426 match
= quote_pattern
.match(message
)
428 d
= match
.groupdict()
429 if self
.quotedb
.store(d
["author"], d
["content"]):
430 serv
.privmsg(canal
, (u
"%s: Ce sera retenu, répété, amplifié" % (auteur
,)).encode("utf-8"))
433 serv
.privmsg(canal
, (u
"%s: Je le savais déjà." % (auteur
,)).encode("utf-8"))
434 if message
.startswith(u
"!quote"):
435 if message
.strip() == u
"!quote":
436 q
= self
.quotedb
.random()
437 serv
.privmsg(canal
, str(q
))
438 elif message
.startswith("!quote "):
439 author
= message
[7:].strip()
441 q
= self
.quotedb
.randomfrom(author
)
443 serv
.privmsg(canal
, (u
"Pas de quote de %s en mémoire." % author
).encode("utf-8"))
445 serv
.privmsg(canal
, str(q
))
447 def on_action(self
, serv
, ev
):
448 """À la réception d'une action."""
449 if ignore_event(serv
, ev
):
451 action
= ev
.arguments()[0]
452 auteur
= irclib
.nm_to_n(ev
.source())
453 channel
= ev
.target()
455 action
= bot_unicode(action
)
456 except errors
.UnicodeBotError
:
457 if config
.utf8_trigger
and not channel
in self
.quiet_channels
:
458 serv
.privmsg(channel
, (u
"%s: %s"%(auteur
,random
.choice(config
.utf8_fail_answers
))).encode("utf8"))
462 def on_kick(self
, serv
, ev
):
463 """À la réception d'une action."""
464 auteur
= irclib
.nm_to_n(ev
.source())
465 channel
= ev
.target()
466 victime
= ev
.arguments()[0]
467 raison
= ev
.arguments()[1]
468 if victime
== self
.nick
:
469 log(self
.serveur
, "%s kické de %s par %s (raison : %s)" % (victime
, channel
, auteur
, raison
))
474 def start_as_daemon(self
, outfile
):
475 sys
.stderr
= Logger(outfile
)
479 class Logger(object):
480 """Pour écrire ailleurs que sur stdout"""
481 def __init__(self
, filename
="parrot.full.log"):
482 self
.filename
= filename
484 def write(self
, message
):
485 f
= open(self
.filename
, "a")
490 """Exécution principale : lecture des paramètres et lancement du bot."""
491 if len(sys
.argv
) == 1:
492 print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
493 print " --outfile sans --no-output ni --daemon n'a aucun effet"
495 serveur
= sys
.argv
[1]
496 if "--daemon" in sys
.argv
:
497 thisfile
= os
.path
.realpath(__file__
)
498 thisdirectory
= thisfile
.rsplit("/", 1)[0]
499 os
.chdir(thisdirectory
)
503 if "debug" in sys
.argv
or "--debug" in sys
.argv
:
507 if "--quiet" in sys
.argv
:
508 config
.debug_stdout
= False
510 "irc" : "irc.crans.org",
511 "crans" : "irc.crans.org",
512 "irc.crans.org" : "irc.crans.org"}
513 if "--no-output" in sys
.argv
or "--daemon" in sys
.argv
:
514 outfile
= "/var/log/bots/parrot.full.log"
517 if arg
[0].strip('-') in ["out", "outfile", "logfile"]:
519 sys
.stdout
= Logger(outfile
)
521 serveur
= serveurs
[serveur
]
523 print "Server Unknown : %s" % (serveur
)
525 parrot
= Parrot(serveur
,debug
)
526 # Si on reçoit un SIGHUP, on reload la config
527 def sighup_handler(signum
, frame
):
528 parrot
.execute_reload(auteur
="SIGHUP")
529 signal
.signal(signal
.SIGHUP
, sighup_handler
)
532 child_pid
= os
.fork()
535 parrot
.start_as_daemon(outfile
)
537 # on enregistre le pid de parrot
538 pidfile
= "/var/run/bots/parrot.pid"
541 if arg
[0].strip('-') in ["pidfile"]:
543 f
= open(pidfile
, "w")
544 f
.write("%s\n" % child_pid
)
549 if __name__
== "__main__":