]>
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 # Je veux pouvoir éditer ce que crée ce bot
32 def get_config_logfile(serveur
):
33 """Renvoie le nom du fichier de log en fonction du ``serveur`` et de la config."""
34 serveurs
= {"irc.crans.org" : "crans"}
35 return config
.logfile_template
% (serveurs
[serveur
],)
37 def log(serveur
, channel
, auteur
=None, message
=None):
38 """Enregistre une ligne de log."""
39 if auteur
== message
== None:
40 # alors c'est que c'est pas un channel mais juste une ligne de log
41 chain
= u
"%s %s" % (time
.strftime("%F %T"), channel
)
43 chain
= u
"%s [%s:%s] %s" % (time
.strftime("%F %T"), channel
, auteur
, message
)
44 f
= open(get_config_logfile(serveur
), "a")
45 f
.write((chain
+ u
"\n").encode("utf-8"))
47 if config
.debug_stdout
:
48 print chain
.encode("utf-8")
50 def ignore_event(serv
, ev
):
51 """Retourne ``True`` si il faut ignorer cet évènement."""
52 for (blackmask
, exceptlist
) in config
.blacklisted_masks
:
53 usermask
= ev
.source()
54 blackit
= bool(irclib
.mask_matches(usermask
, blackmask
))
55 exceptit
= any([bool(irclib
.mask_matches(usermask
, exceptmask
)) for exceptmask
in exceptlist
])
56 if exceptit
: # Il est exempté
59 if blackit
: # Il n'est pas exempté et matche la blacklist
63 def bot_unicode(chain
):
64 """Essaye de décoder ``chain`` en UTF-8.
65 Lève une py:class:`errors.UnicodeBotError` en cas d'échec."""
67 return chain
.decode("utf8")
68 except UnicodeDecodeError as exc
:
69 raise errors
.UnicodeBotError
72 class Parrot(ircbot
.SingleServerIRCBot
):
73 """Classe principale : définition du bot."""
74 def __init__(self
, serveur
, debug
=False):
75 temporary_pseudo
= config
.irc_pseudo
+ str(random
.randrange(10000,100000))
76 ircbot
.SingleServerIRCBot
.__init
__(self
, [(serveur
, 6667)],
77 temporary_pseudo
, "Parrot, le bot irc. [Codé par 20-100]", 10)
79 self
.serveur
= serveur
80 self
.overops
= config
.overops
81 self
.ops
= self
.overops
+ config
.ops
82 self
.report_bugs_to
= config
.report_bugs_to
83 self
.chanlist
= config
.chanlist
84 self
.stay_channels
= config
.stay_channels
85 self
.quiet_channels
= config
.quiet_channels
88 self
.quotedb
= quotes
.QuoteDB()
94 """Récuère le nick effectif du bot sur le serveur."""
95 return self
.serv
.get_nickname()
96 nick
= property(_getnick
)
98 def give_me_my_pseudo(self
, serv
):
99 """Récupère le pseudo auprès de NickServ."""
100 serv
.privmsg("NickServ", "GHOST %s %s" % (config
.irc_pseudo
, config
.irc_password
))
101 serv
.privmsg("NickServ", "RELEASE %s %s" % (config
.irc_pseudo
, config
.irc_password
))
103 serv
.nick(config
.irc_pseudo
)
105 def pourmoi(self
, serv
, message
):
106 """Renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
108 pseudo
= pseudo
.decode("utf-8")
110 if message
[:size
] == pseudo
and len(message
) > size
and message
[size
] == ":":
111 return (True, message
[size
+1:].lstrip(" "))
113 return (False, message
)
115 ### Exécution d'actions
116 def quitter(self
, chan
, leave_message
=None):
117 """Quitter un channel avec un message customisable."""
118 if leave_message
== None:
119 leave_message
= random
.choice(config
.leave_messages
)
120 self
.serv
.part(chan
, message
=leave_message
.encode("utf8"))
123 """Se déconnecter du serveur IRC avec un message customisable."""
124 quit_message
= random
.choice(config
.quit_messages
)
125 self
.die(msg
=quit_message
.encode("utf8"))
127 def reload_quotes(self
):
128 """ Recharge la base de données des quotes et recompile la regexp de quote """
130 self
.quote_pattern
= re
.compile(config
.quote_regexp
, flags
=re
.UNICODE
)
132 def execute_reload(self
, auteur
=None):
133 """Recharge la config."""
136 if auteur
in [None, "SIGHUP"]:
137 towrite
= "Config reloaded" + " (SIGHUP received)" * (auteur
== "SIGHUP")
138 for to
in config
.report_bugs_to
:
139 self
.serv
.privmsg(to
, towrite
)
140 log(self
.serveur
, towrite
)
143 return True, u
"Config reloaded"
145 def crash(self
, who
="nobody", chan
="nowhere"):
146 """Fait crasher le bot."""
147 where
= "en privé" if chan
== "priv" else "sur le chan %s" % chan
148 raise errors
.CrashError((u
"Crash demandé par %s %s" % (who
, where
)).encode("utf-8"))
151 "reload" : execute_reload
,
154 def execute_something(self
, something
, params
, place
=None, auteur
=None):
155 """Exécute une action et répond son résultat à ``auteur``
156 sur un chan ou en privé en fonction de ``place``"""
157 action
= self
.ACTIONS
[something
]
158 success
, message
= action(self
, **params
)
160 if irclib
.is_channel(place
):
161 message
= "%s: %s" % (auteur
, message
.encode("utf-8"))
162 self
.serv
.privmsg(place
, message
)
163 log(self
.serveur
, place
, auteur
, something
+ "%r" % params
+ ("[successful]" if success
else "[failed]"))
166 def acknowledge(self
, asked_by
, asked_where
, message
):
167 """Répond quelque chose au demandeur d'une action.
168 ``asked_where=None`` signifie en privé."""
169 if asked_where
is None:
170 self
.serv
.privmsg(asked_by
, message
)
172 self
.serv
.privmsg(asked_where
, "%s: %s" % (asked_by
, message
))
174 def dump(self
, asked_by
, asked_where
=None):
175 """Dumpe les quotes. ``asked_where=None`` signifie en privé."""
176 quotes
.dump(self
.quotedb
)
177 self
.acknowledge(asked_by
, asked_where
, "Quotes dumpées")
179 def restore(self
, asked_by
, asked_where
=None):
180 """Restaure les quotes à partir du dump. ``asked_where=None`` signifie en privé."""
181 self
.quotedb
= quotes
.restore()
182 self
.acknowledge(asked_by
, asked_where
, "Quotes restaurées à partir du dump (pas de backup effectué).")
184 ### Surcharge des events du Bot
185 def on_welcome(self
, serv
, ev
):
186 """À l'arrivée sur le serveur."""
187 self
.serv
= serv
# ça serv ira :)
188 self
.give_me_my_pseudo(serv
)
189 serv
.privmsg("NickServ", "IDENTIFY %s" % (config
.irc_password
))
190 log(self
.serveur
, "Connected")
192 self
.chanlist
= ["#bot"]
193 for c
in self
.chanlist
:
194 log(self
.serveur
, "JOIN %s" % (c
))
197 def on_privmsg(self
, serv
, ev
):
198 """À la réception d'un message en privé."""
199 if ignore_event(serv
, ev
):
201 message
= ev
.arguments()[0]
202 auteur
= irclib
.nm_to_n(ev
.source())
204 message
= bot_unicode(message
)
205 except errors
.UnicodeBotError
:
206 if config
.utf8_trigger
:
207 serv
.privmsg(auteur
, random
.choice(config
.utf8_fail_answers
).encode("utf8"))
209 message
= message
.split()
210 cmd
= message
[0].lower()
211 notunderstood
= False
213 op
,overop
=auteur
in self
.ops
, auteur
in self
.overops
215 helpmsg
= config
.helpmsg_default
217 helpmsg
+= config
.helpmsg_ops
219 helpmsg
+= config
.helpmsg_overops
221 helpmsgs
= config
.helpdico
.get(message
[1].lower(), ["Commande inconnue.", None, None])
222 helpmsg
= helpmsgs
[0]
223 if op
and helpmsgs
[1]:
225 helpmsg
+= "\n" + helpmsgs
[1]
227 helpmsg
= helpmsgs
[1]
228 if overop
and helpmsgs
[2]:
230 helpmsg
+= "\n" + helpmsgs
[2]
232 helpmsg
= helpmsgs
[2]
233 for ligne
in helpmsg
.split("\n"):
234 serv
.privmsg(auteur
, ligne
.encode("utf-8"))
236 if auteur
in self
.ops
:
238 if message
[1] in self
.chanlist
:
239 serv
.privmsg(auteur
, "Je suis déjà sur %s" % (message
[1]))
241 serv
.join(message
[1])
242 self
.chanlist
.append(message
[1])
243 serv
.privmsg(auteur
, "Channels : " + " ".join(self
.chanlist
))
244 log(self
.serveur
, "priv", auteur
, " ".join(message
))
246 serv
.privmsg(auteur
, "Channels : " + " ".join(self
.chanlist
))
249 elif cmd
== u
"leave":
250 if auteur
in self
.ops
and len(message
) > 1:
251 if message
[1] in self
.chanlist
:
252 if not (message
[1] in self
.stay_channels
) or auteur
in self
.overops
:
253 self
.quitter(message
[1].encode("utf-8"), " ".join(message
[2:]))
254 self
.chanlist
.remove(message
[1])
255 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
257 serv
.privmsg(auteur
, "Non, je reste !")
258 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
260 serv
.privmsg(auteur
, "Je ne suis pas sur %s" % (message
[1]))
264 if auteur
in self
.overops
:
266 if message
[1] in self
.stay_channels
:
267 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
268 serv
.privmsg(auteur
, "Je stay déjà sur %s." % (message
[1]))
270 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
271 self
.stay_channels
.append(message
[1])
272 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
274 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
277 elif cmd
== u
"nostay":
278 if auteur
in self
.overops
:
280 if message
[1] in self
.stay_channels
:
281 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
282 self
.stay_channels
.remove(message
[1])
283 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
285 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
286 serv
.privmsg(auteur
, "Je ne stay pas sur %s." % (message
[1]))
290 if auteur
in self
.overops
:
291 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
295 elif cmd
== u
"crash":
296 if auteur
in self
.overops
:
297 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
298 self
.crash(auteur
, "priv")
301 elif cmd
== u
"reload":
302 if auteur
in self
.ops
:
303 self
.execute_something("reload", {"auteur" : auteur
}, place
=auteur
, auteur
=auteur
)
306 elif cmd
== u
"quiet":
307 if auteur
in self
.ops
:
309 if message
[1] in self
.quiet_channels
:
310 serv
.privmsg(auteur
, "Je me la ferme déjà sur %s" % (message
[1]))
311 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
313 self
.quiet_channels
.append(message
[1])
314 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
315 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
317 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
320 elif cmd
== u
"noquiet":
321 if auteur
in self
.ops
:
323 if message
[1] in self
.quiet_channels
:
324 self
.quiet_channels
.remove(message
[1])
325 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
326 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
328 serv
.privmsg(auteur
, "Je ne me la ferme pas sur %s." % (message
[1]))
329 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
333 if auteur
in self
.overops
and len(message
) > 2:
334 serv
.privmsg(message
[1].encode("utf-8"), (u
" ".join(message
[2:])).encode("utf-8"))
335 log(self
.serveur
, "priv", auteur
, " ".join(message
))
336 elif len(message
) <= 2:
337 serv
.privmsg(auteur
, "Syntaxe : SAY <channel> <message>")
341 if auteur
in self
.overops
and len(message
) > 2:
342 serv
.action(message
[1], " ".join(message
[2:]))
343 log(self
.serveur
, "priv", auteur
, " ".join(message
))
344 elif len(message
) <= 2:
345 serv
.privmsg(auteur
, "Syntaxe : DO <channel> <action>")
349 if auteur
in self
.overops
and len(message
) > 2:
350 serv
.kick(message
[1].encode("utf-8"), message
[2].encode("utf-8"), " ".join(message
[3:]).encode("utf-8"))
351 log(self
.serveur
, "priv", auteur
, " ".join(message
))
352 elif len(message
) <= 2:
353 serv
.privmsg(auteur
, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
357 if auteur
in self
.overops
:
358 serv
.privmsg(auteur
, " ".join(self
.ops
))
361 elif cmd
== u
"overops":
362 if auteur
in self
.overops
:
363 serv
.privmsg(auteur
, " ".join(self
.overops
))
366 elif cmd
== u
"dump" and auteur
in self
.ops
:
367 self
.dump(asked_by
=auteur
)
368 elif cmd
== u
"restore" and auteur
in self
.overops
:
369 self
.restore(asked_by
=auteur
)
373 serv
.privmsg(auteur
, "Je n'ai pas compris. Essayez HELP…")
375 def on_pubmsg(self
, serv
, ev
):
376 """À la réception d'un message sur un channel."""
377 if ignore_event(serv
, ev
):
379 auteur
= irclib
.nm_to_n(ev
.source())
381 message
= ev
.arguments()[0]
383 message
= bot_unicode(message
)
384 except errors
.UnicodeBotError
:
385 if config
.utf8_trigger
and not canal
in self
.quiet_channels
:
386 serv
.privmsg(canal
, (u
"%s: %s"% ( auteur
, random
.choice(config
.utf8_fail_answers
))).encode("utf8"))
388 pour_moi
, message
= self
.pourmoi(serv
, message
)
389 if pour_moi
and message
.split()!=[]:
390 cmd
= message
.split()[0].lower()
392 args
= " ".join(message
.split()[1:])
395 if cmd
in [u
"meurs", u
"die", u
"crève"]:
396 if auteur
in self
.overops
:
397 log(self
.serveur
, canal
, auteur
, message
+ "[successful]")
400 serv
.privmsg(canal
,(u
"%s: %s"%(auteur
, random
.choice(config
.quit_fail_messages
))).encode("utf8"))
401 log(self
.serveur
, canal
, auteur
, message
+ "[failed]")
402 elif cmd
== u
"reload":
403 if auteur
in self
.ops
:
404 self
.execute_something("reload", {"auteur" : auteur
}, place
=canal
, auteur
=auteur
)
405 elif cmd
== u
"crash":
406 if auteur
in self
.overops
:
407 self
.crash(auteur
, canal
)
408 elif cmd
in [u
"part", u
"leave", u
"dégage", u
"va-t-en"]:
409 if auteur
in self
.ops
and (not (canal
in self
.stay_channels
)
410 or auteur
in self
.overops
):
412 log(self
.serveur
, canal
, auteur
, message
+ "[successful]")
413 if canal
in self
.chanlist
:
414 self
.chanlist
.remove(canal
)
416 serv
.privmsg(canal
,(u
"%s: %s" % (auteur
, random
.choice(config
.leave_fail_messages
))).encode("utf8"))
417 log(self
.serveur
, canal
, auteur
, message
+ "[failed]")
419 elif cmd
in [u
"ping"] and not canal
in self
.quiet_channels
:
420 serv
.privmsg(canal
, "%s: pong" % (auteur
))
421 elif cmd
in [u
"dump"]:
422 self
.dump(asked_by
=auteur
, asked_where
=canal
)
423 elif cmd
in [u
"restore"] and auteur
in self
.overops
:
424 self
.restore(asked_by
=auteur
, asked_where
=canal
)
425 elif cmd
in [u
"display"]:
426 self
.serv
.privmsg(canal
, "%s: %s" % (auteur
, config
.quote_display_url
.encode("utf-8")))
428 # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
429 match
= self
.quote_pattern
.match(message
)
431 d
= match
.groupdict()
432 if self
.quotedb
.store(d
["author"], d
["content"]):
433 serv
.privmsg(canal
, (u
"%s: Ce sera retenu, répété, amplifié" % (auteur
,)).encode("utf-8"))
436 serv
.privmsg(canal
, (u
"%s: Je le savais déjà." % (auteur
,)).encode("utf-8"))
437 if message
.startswith(u
"!quote"):
438 if message
.strip() == u
"!quote":
439 q
= self
.quotedb
.random()
440 serv
.privmsg(canal
, str(q
))
441 elif message
.startswith("!quote "):
442 author
= message
[7:].strip()
444 q
= self
.quotedb
.randomfrom(author
)
446 serv
.privmsg(canal
, (u
"Pas de quote de %s en mémoire." % author
).encode("utf-8"))
448 serv
.privmsg(canal
, str(q
))
449 elif message
.startswith(u
"!author"):
450 words
= message
.split()
451 cmd
= words
[0].lstrip("!")
452 regexp
= cmd
in ["author-r", "authorreg", "author-reg", "author-regex"]
453 search
= u
" ".join(words
[1:])
454 authors
= self
.quotedb
.search_authors(search
, regexp
)
455 if len(authors
) > config
.search_max_authors
:
456 authors
= authors
[:config
.search_max_authors
+1] + [unicode(len(authors
) - config
.search_max_authors
)]
458 serv
.privmsg(canal
, "%s: %s" % (auteur
, (u
" ".join(authors
)).encode("utf-8")))
460 serv
.privmsg(canal
, "%s: Pas d'auteur correspondant à la recherche.")
462 def on_action(self
, serv
, ev
):
463 """À la réception d'une action."""
464 if ignore_event(serv
, ev
):
466 action
= ev
.arguments()[0]
467 auteur
= irclib
.nm_to_n(ev
.source())
468 channel
= ev
.target()
470 action
= bot_unicode(action
)
471 except errors
.UnicodeBotError
:
472 if config
.utf8_trigger
and not channel
in self
.quiet_channels
:
473 serv
.privmsg(channel
, (u
"%s: %s"%(auteur
,random
.choice(config
.utf8_fail_answers
))).encode("utf8"))
477 def on_kick(self
, serv
, ev
):
478 """À la réception d'une action."""
479 auteur
= irclib
.nm_to_n(ev
.source())
480 channel
= ev
.target()
481 victime
= ev
.arguments()[0]
482 raison
= ev
.arguments()[1]
483 if victime
== self
.nick
:
484 log(self
.serveur
, "%s kické de %s par %s (raison : %s)" % (victime
, channel
, auteur
, raison
))
489 def start_as_daemon(self
, outfile
):
490 sys
.stderr
= Logger(outfile
)
494 class Logger(object):
495 """Pour écrire ailleurs que sur stdout"""
496 def __init__(self
, filename
="parrot.full.log"):
497 self
.filename
= filename
499 def write(self
, message
):
500 f
= open(self
.filename
, "a")
505 """Exécution principale : lecture des paramètres et lancement du bot."""
506 if len(sys
.argv
) == 1:
507 print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
508 print " --outfile sans --no-output ni --daemon n'a aucun effet"
510 serveur
= sys
.argv
[1]
511 if "--daemon" in sys
.argv
:
512 thisfile
= os
.path
.realpath(__file__
)
513 thisdirectory
= thisfile
.rsplit("/", 1)[0]
514 os
.chdir(thisdirectory
)
518 if "debug" in sys
.argv
or "--debug" in sys
.argv
:
522 if "--quiet" in sys
.argv
:
523 config
.debug_stdout
= False
525 "irc" : "irc.crans.org",
526 "crans" : "irc.crans.org",
527 "irc.crans.org" : "irc.crans.org"}
528 if "--no-output" in sys
.argv
or "--daemon" in sys
.argv
:
529 outfile
= "/var/log/bots/parrot.full.log"
532 if arg
[0].strip('-') in ["out", "outfile", "logfile"]:
534 sys
.stdout
= Logger(outfile
)
536 serveur
= serveurs
[serveur
]
538 print "Server Unknown : %s" % (serveur
)
540 parrot
= Parrot(serveur
,debug
)
541 # Si on reçoit un SIGHUP, on reload la config
542 def sighup_handler(signum
, frame
):
543 parrot
.execute_reload(auteur
="SIGHUP")
544 signal
.signal(signal
.SIGHUP
, sighup_handler
)
547 child_pid
= os
.fork()
550 parrot
.start_as_daemon(outfile
)
552 # on enregistre le pid de parrot
553 pidfile
= "/var/run/bots/parrot.pid"
556 if arg
[0].strip('-') in ["pidfile"]:
558 f
= open(pidfile
, "w")
559 f
.write("%s\n" % child_pid
)
564 if __name__
== "__main__":