]>
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()
92 """Récuère le nick effectif du bot sur le serveur."""
93 return self
.serv
.get_nickname()
94 nick
= property(_getnick
)
96 def give_me_my_pseudo(self
, serv
):
97 """Récupère le pseudo auprès de NickServ."""
98 serv
.privmsg("NickServ", "GHOST %s %s" % (config
.irc_pseudo
, config
.irc_password
))
99 serv
.privmsg("NickServ", "RELEASE %s %s" % (config
.irc_pseudo
, config
.irc_password
))
101 serv
.nick(config
.irc_pseudo
)
103 def pourmoi(self
, serv
, message
):
104 """Renvoie (False, lemessage) ou (True, le message amputé de "pseudo: ")"""
106 pseudo
= pseudo
.decode("utf-8")
108 if message
[:size
] == pseudo
and len(message
) > size
and message
[size
] == ":":
109 return (True, message
[size
+1:].lstrip(" "))
111 return (False, message
)
113 ### Exécution d'actions
114 def quitter(self
, chan
, leave_message
=None):
115 """Quitter un channel avec un message customisable."""
116 if leave_message
== None:
117 leave_message
= random
.choice(config
.leave_messages
)
118 self
.serv
.part(chan
, message
=leave_message
.encode("utf8"))
121 """Se déconnecter du serveur IRC avec un message customisable."""
122 quit_message
= random
.choice(config
.quit_messages
)
123 self
.die(msg
=quit_message
.encode("utf8"))
125 def execute_reload(self
, auteur
=None):
126 """Recharge la config."""
129 if auteur
in [None, "SIGHUP"]:
130 towrite
= "Config reloaded" + " (SIGHUP received)" * (auteur
== "SIGHUP")
131 for to
in config
.report_bugs_to
:
132 self
.serv
.privmsg(to
, towrite
)
133 log(self
.serveur
, towrite
)
136 return True, u
"Config reloaded"
138 def crash(self
, who
="nobody", chan
="nowhere"):
139 """Fait crasher le bot."""
140 where
= "en privé" if chan
== "priv" else "sur le chan %s" % chan
141 raise errors
.CrashError((u
"Crash demandé par %s %s" % (who
, where
)).encode("utf-8"))
144 "reload" : execute_reload
,
147 def execute_something(self
, something
, params
, place
=None, auteur
=None):
148 """Exécute une action et répond son résultat à ``auteur``
149 sur un chan ou en privé en fonction de ``place``"""
150 action
= self
.ACTIONS
[something
]
151 success
, message
= action(self
, **params
)
153 if irclib
.is_channel(place
):
154 message
= "%s: %s" % (auteur
, message
.encode("utf-8"))
155 self
.serv
.privmsg(place
, message
)
156 log(self
.serveur
, place
, auteur
, something
+ "%r" % params
+ ("[successful]" if success
else "[failed]"))
158 ### Gestion des quotes
159 def enregistrer(self
, author
, content
, timestamp
):
161 quotes
.save(self
.quotelist
, config
.quote_file
)
164 ### Surcharge des events du Bot
165 def on_welcome(self
, serv
, ev
):
166 """À l'arrivée sur le serveur."""
167 self
.serv
= serv
# ça serv ira :)
168 self
.give_me_my_pseudo(serv
)
169 serv
.privmsg("NickServ", "IDENTIFY %s" % (config
.irc_password
))
170 log(self
.serveur
, "Connected")
172 self
.chanlist
= ["#bot"]
173 for c
in self
.chanlist
:
174 log(self
.serveur
, "JOIN %s" % (c
))
177 def on_privmsg(self
, serv
, ev
):
178 """À la réception d'un message en privé."""
179 if ignore_event(serv
, ev
):
181 message
= ev
.arguments()[0]
182 auteur
= irclib
.nm_to_n(ev
.source())
184 message
= bot_unicode(message
)
185 except errors
.UnicodeBotError
:
186 if config
.utf8_trigger
:
187 serv
.privmsg(auteur
, random
.choice(config
.utf8_fail_answers
).encode("utf8"))
189 message
= message
.split()
190 cmd
= message
[0].lower()
191 notunderstood
= False
193 op
,overop
=auteur
in self
.ops
, auteur
in self
.overops
195 helpmsg
= config
.helpmsg_default
197 helpmsg
+= config
.helpmsg_ops
199 helpmsg
+= config
.helpmsg_overops
201 helpmsgs
= config
.helpdico
.get(message
[1].lower(), ["Commande inconnue.", None, None])
202 helpmsg
= helpmsgs
[0]
203 if op
and helpmsgs
[1]:
205 helpmsg
+= "\n" + helpmsgs
[1]
207 helpmsg
= helpmsgs
[1]
208 if overop
and helpmsgs
[2]:
210 helpmsg
+= "\n" + helpmsgs
[2]
212 helpmsg
= helpmsgs
[2]
213 for ligne
in helpmsg
.split("\n"):
214 serv
.privmsg(auteur
, ligne
.encode("utf-8"))
216 if auteur
in self
.ops
:
218 if message
[1] in self
.chanlist
:
219 serv
.privmsg(auteur
, "Je suis déjà sur %s" % (message
[1]))
221 serv
.join(message
[1])
222 self
.chanlist
.append(message
[1])
223 serv
.privmsg(auteur
, "Channels : " + " ".join(self
.chanlist
))
224 log(self
.serveur
, "priv", auteur
, " ".join(message
))
226 serv
.privmsg(auteur
, "Channels : " + " ".join(self
.chanlist
))
229 elif cmd
== u
"leave":
230 if auteur
in self
.ops
and len(message
) > 1:
231 if message
[1] in self
.chanlist
:
232 if not (message
[1] in self
.stay_channels
) or auteur
in self
.overops
:
233 self
.quitter(message
[1].encode("utf-8"), " ".join(message
[2:]))
234 self
.chanlist
.remove(message
[1])
235 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
237 serv
.privmsg(auteur
, "Non, je reste !")
238 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
240 serv
.privmsg(auteur
, "Je ne suis pas sur %s" % (message
[1]))
244 if auteur
in self
.overops
:
246 if message
[1] in self
.stay_channels
:
247 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
248 serv
.privmsg(auteur
, "Je stay déjà sur %s." % (message
[1]))
250 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
251 self
.stay_channels
.append(message
[1])
252 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
254 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
257 elif cmd
== u
"nostay":
258 if auteur
in self
.overops
:
260 if message
[1] in self
.stay_channels
:
261 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
262 self
.stay_channels
.remove(message
[1])
263 serv
.privmsg(auteur
, "Stay channels : " + " ".join(self
.stay_channels
))
265 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
266 serv
.privmsg(auteur
, "Je ne stay pas sur %s." % (message
[1]))
270 if auteur
in self
.overops
:
271 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
275 elif cmd
== u
"crash":
276 if auteur
in self
.overops
:
277 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
278 self
.crash(auteur
, "priv")
281 elif cmd
== u
"reload":
282 if auteur
in self
.ops
:
283 self
.execute_something("reload", {"auteur" : auteur
}, place
=auteur
, auteur
=auteur
)
286 elif cmd
== u
"quiet":
287 if auteur
in self
.ops
:
289 if message
[1] in self
.quiet_channels
:
290 serv
.privmsg(auteur
, "Je me la ferme déjà sur %s" % (message
[1]))
291 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
293 self
.quiet_channels
.append(message
[1])
294 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
295 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
297 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
300 elif cmd
== u
"noquiet":
301 if auteur
in self
.ops
:
303 if message
[1] in self
.quiet_channels
:
304 self
.quiet_channels
.remove(message
[1])
305 serv
.privmsg(auteur
, "Quiet channels : " + " ".join(self
.quiet_channels
))
306 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[successful]")
308 serv
.privmsg(auteur
, "Je ne me la ferme pas sur %s." % (message
[1]))
309 log(self
.serveur
, "priv", auteur
, " ".join(message
) + "[failed]")
313 if auteur
in self
.overops
and len(message
) > 2:
314 serv
.privmsg(message
[1].encode("utf-8"), (u
" ".join(message
[2:])).encode("utf-8"))
315 log(self
.serveur
, "priv", auteur
, " ".join(message
))
316 elif len(message
) <= 2:
317 serv
.privmsg(auteur
, "Syntaxe : SAY <channel> <message>")
321 if auteur
in self
.overops
and len(message
) > 2:
322 serv
.action(message
[1], " ".join(message
[2:]))
323 log(self
.serveur
, "priv", auteur
, " ".join(message
))
324 elif len(message
) <= 2:
325 serv
.privmsg(auteur
, "Syntaxe : DO <channel> <action>")
329 if auteur
in self
.overops
and len(message
) > 2:
330 serv
.kick(message
[1].encode("utf-8"), message
[2].encode("utf-8"), " ".join(message
[3:]).encode("utf-8"))
331 log(self
.serveur
, "priv", auteur
, " ".join(message
))
332 elif len(message
) <= 2:
333 serv
.privmsg(auteur
, "Syntaxe : KICK <channel> <pseudo> [<raison>]")
337 if auteur
in self
.overops
:
338 serv
.privmsg(auteur
, " ".join(self
.ops
))
341 elif cmd
== u
"overops":
342 if auteur
in self
.overops
:
343 serv
.privmsg(auteur
, " ".join(self
.overops
))
349 serv
.privmsg(auteur
, "Je n'ai pas compris. Essayez HELP…")
351 def on_pubmsg(self
, serv
, ev
):
352 """À la réception d'un message sur un channel."""
353 if ignore_event(serv
, ev
):
355 auteur
= irclib
.nm_to_n(ev
.source())
357 message
= ev
.arguments()[0]
359 message
= bot_unicode(message
)
360 except errors
.UnicodeBotError
:
361 if config
.utf8_trigger
and not canal
in self
.quiet_channels
:
362 serv
.privmsg(canal
, (u
"%s: %s"% ( auteur
, random
.choice(config
.utf8_fail_answers
))).encode("utf8"))
364 pour_moi
, message
= self
.pourmoi(serv
, message
)
365 if pour_moi
and message
.split()!=[]:
366 cmd
= message
.split()[0].lower()
368 args
= " ".join(message
.split()[1:])
371 if cmd
in [u
"meurs", u
"die", u
"crève"]:
372 if auteur
in self
.overops
:
373 log(self
.serveur
, canal
, auteur
, message
+ "[successful]")
376 serv
.privmsg(canal
,(u
"%s: %s"%(auteur
, random
.choice(config
.quit_fail_messages
))).encode("utf8"))
377 log(self
.serveur
, canal
, auteur
, message
+ "[failed]")
378 elif cmd
== u
"reload":
379 if auteur
in self
.ops
:
380 self
.execute_something("reload", {"auteur" : auteur
}, place
=canal
, auteur
=auteur
)
381 elif cmd
== u
"crash":
382 if auteur
in self
.overops
:
383 self
.crash(auteur
, canal
)
384 elif cmd
in [u
"part", u
"leave", u
"dégage", u
"va-t-en"]:
385 if auteur
in self
.ops
and (not (canal
in self
.stay_channels
)
386 or auteur
in self
.overops
):
388 log(self
.serveur
, canal
, auteur
, message
+ "[successful]")
389 if canal
in self
.chanlist
:
390 self
.chanlist
.remove(canal
)
392 serv
.privmsg(canal
,(u
"%s: %s" % (auteur
, random
.choice(config
.leave_fail_messages
))).encode("utf8"))
393 log(self
.serveur
, canal
, auteur
, message
+ "[failed]")
395 elif cmd
in [u
"ping"] and not canal
in self
.quiet_channels
:
396 serv
.privmsg(canal
, "%s: pong" % (auteur
))
398 # Vu que ce bot est prévu pour parser des quotes il va falloir bosser ici
399 match
= quote_pattern
.match(message
)
401 d
= match
.groupdict()
402 if self
.quotedb
.store(d
["author"], d
["content"]):
403 serv
.privmsg(canal
, (u
"%s: Ce sera retenu, répété, amplifié" % (auteur
,)).encode("utf-8"))
406 serv
.privmsg(canal
, (u
"%s: Je le savais déjà." % (auteur
,)).encode("utf-8"))
407 if message
.startswith(u
"!quote"):
408 if message
.strip() == u
"!quote":
409 q
= self
.quotedb
.random()
410 serv
.privmsg(canal
, str(q
))
411 elif message
.startswith("!quote "):
412 author
= message
[7:].strip()
414 q
= self
.quotedb
.randomfrom(author
)
416 serv
.privmsg(canal
, (u
"Pas de quote de %s en mémoire." % author
).encode("utf-8"))
418 serv
.privmsg(canal
, str(q
))
420 def on_action(self
, serv
, ev
):
421 """À la réception d'une action."""
422 if ignore_event(serv
, ev
):
424 action
= ev
.arguments()[0]
425 auteur
= irclib
.nm_to_n(ev
.source())
426 channel
= ev
.target()
428 action
= bot_unicode(action
)
429 except errors
.UnicodeBotError
:
430 if config
.utf8_trigger
and not channel
in self
.quiet_channels
:
431 serv
.privmsg(channel
, (u
"%s: %s"%(auteur
,random
.choice(config
.utf8_fail_answers
))).encode("utf8"))
435 def on_kick(self
, serv
, ev
):
436 """À la réception d'une action."""
437 auteur
= irclib
.nm_to_n(ev
.source())
438 channel
= ev
.target()
439 victime
= ev
.arguments()[0]
440 raison
= ev
.arguments()[1]
441 if victime
== self
.nick
:
442 log(self
.serveur
, u
"%s kické de %s par %s (raison : %s)" % (victime
, channel
.decode("utf-8"), auteur
, raison
))
447 def start_as_daemon(self
, outfile
):
448 sys
.stderr
= Logger(outfile
)
452 class Logger(object):
453 """Pour écrire ailleurs que sur stdout"""
454 def __init__(self
, filename
="parrot.full.log"):
455 self
.filename
= filename
457 def write(self
, message
):
458 f
= open(self
.filename
, "a")
463 """Exécution principale : lecture des paramètres et lancement du bot."""
464 if len(sys
.argv
) == 1:
465 print "Usage : parrot.py <serveur> [--debug] [--no-output] [--daemon [--pidfile]] [--outfile]"
466 print " --outfile sans --no-output ni --daemon n'a aucun effet"
468 serveur
= sys
.argv
[1]
469 if "--daemon" in sys
.argv
:
470 thisfile
= os
.path
.realpath(__file__
)
471 thisdirectory
= thisfile
.rsplit("/", 1)[0]
472 os
.chdir(thisdirectory
)
476 if "debug" in sys
.argv
or "--debug" in sys
.argv
:
480 if "--quiet" in sys
.argv
:
481 config
.debug_stdout
= False
483 "irc" : "irc.crans.org",
484 "crans" : "irc.crans.org",
485 "irc.crans.org" : "irc.crans.org"}
486 if "--no-output" in sys
.argv
or "--daemon" in sys
.argv
:
487 outfile
= "/var/log/bots/parrot.full.log"
490 if arg
[0].strip('-') in ["out", "outfile", "logfile"]:
492 sys
.stdout
= Logger(outfile
)
494 serveur
= serveurs
[serveur
]
496 print "Server Unknown : %s" % (serveur
)
498 parrot
= Parrot(serveur
,debug
)
499 # Si on reçoit un SIGHUP, on reload la config
500 def sighup_handler(signum
, frame
):
501 parrot
.execute_reload(auteur
="SIGHUP")
502 signal
.signal(signal
.SIGHUP
, sighup_handler
)
505 child_pid
= os
.fork()
508 parrot
.start_as_daemon(outfile
)
510 # on enregistre le pid de parrot
511 pidfile
= "/var/run/bots/parrot.pid"
514 if arg
[0].strip('-') in ["pidfile"]:
516 f
= open(pidfile
, "w")
517 f
.write("%s\n" % child_pid
)
522 if __name__
== "__main__":