2012-08-23 16:20:45 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
|
|
# Nemubot is a modulable IRC bot, built around XML configuration files.
|
|
|
|
# Copyright (C) 2012 Mercier Pierre-Olivier
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU Affero General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2014-08-14 10:49:38 +00:00
|
|
|
import logging
|
2012-08-23 16:20:45 +00:00
|
|
|
import queue
|
2012-11-02 11:10:37 +00:00
|
|
|
import re
|
2012-08-23 16:20:45 +00:00
|
|
|
import threading
|
2012-08-29 16:08:09 +00:00
|
|
|
import traceback
|
|
|
|
import sys
|
2012-08-23 16:20:45 +00:00
|
|
|
|
2012-11-02 11:10:37 +00:00
|
|
|
import bot
|
2014-08-13 15:11:33 +00:00
|
|
|
from server.DCC import DCC
|
2012-08-23 16:20:45 +00:00
|
|
|
from message import Message
|
2014-09-18 05:57:06 +00:00
|
|
|
from response import Response
|
2012-11-02 11:10:37 +00:00
|
|
|
import server
|
2012-08-23 16:20:45 +00:00
|
|
|
|
2014-08-27 05:57:00 +00:00
|
|
|
logger = logging.getLogger("nemubot.consumer")
|
2014-08-14 10:49:38 +00:00
|
|
|
|
2012-10-04 11:36:25 +00:00
|
|
|
class MessageConsumer:
|
2014-08-29 14:33:45 +00:00
|
|
|
|
2012-10-04 11:36:25 +00:00
|
|
|
"""Store a message before treating"""
|
2014-08-29 14:33:45 +00:00
|
|
|
|
2014-09-11 15:23:07 +00:00
|
|
|
def __init__(self, srv, msg):
|
2012-10-04 11:36:25 +00:00
|
|
|
self.srv = srv
|
|
|
|
|
2014-09-11 15:23:07 +00:00
|
|
|
self.msgs = [ msg ]
|
2014-09-01 17:21:54 +00:00
|
|
|
self.responses = None
|
2012-11-02 11:51:16 +00:00
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-09-01 17:21:54 +00:00
|
|
|
def first_treat(self, msg):
|
|
|
|
"""Qualify a new message/response
|
|
|
|
|
|
|
|
Argument:
|
|
|
|
msg -- The Message or Response to qualify
|
|
|
|
"""
|
|
|
|
|
|
|
|
if not hasattr(msg, "qual") or msg.qual is None:
|
|
|
|
# Assume this is a message with no particulariry
|
|
|
|
msg.qual = "def"
|
|
|
|
|
|
|
|
# Define the source server if not already done
|
|
|
|
if not hasattr(msg, "server") or msg.server is None:
|
|
|
|
msg.server = self.srv.id
|
|
|
|
|
|
|
|
if isinstance(msg, Message):
|
|
|
|
if msg.cmd == "PRIVMSG" or msg.cmd == "NOTICE":
|
|
|
|
msg.is_owner = (msg.nick == self.srv.owner)
|
|
|
|
msg.private = msg.private or (len(msg.receivers) == 1 and msg.receivers[0] == self.srv.nick)
|
|
|
|
if msg.private:
|
|
|
|
msg.qual = "ask"
|
|
|
|
|
|
|
|
# Remove nemubot:
|
|
|
|
if msg.qual != "cmd" and msg.text.find(self.srv.nick) == 0 and len(msg.text) > len(self.srv.nick) + 2 and msg.text[len(self.srv.nick)] == ":":
|
|
|
|
msg.text = msg.text[len(self.srv.nick) + 1:].strip()
|
|
|
|
msg.qual = "ask"
|
|
|
|
|
|
|
|
return msg
|
|
|
|
|
|
|
|
|
|
|
|
def pre_treat(self, hm):
|
|
|
|
"""Modify input Messages
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
hm -- Hooks manager
|
|
|
|
"""
|
|
|
|
|
|
|
|
new_msg = list()
|
|
|
|
new_msg += self.msgs
|
|
|
|
self.msgs = list()
|
|
|
|
|
|
|
|
while len(new_msg) > 0:
|
|
|
|
msg = new_msg.pop(0)
|
|
|
|
for h in hm.get_hooks("pre", msg.cmd, msg.qual):
|
|
|
|
if h.match(message=msg, server=self.srv):
|
|
|
|
res = h.run(msg)
|
|
|
|
if isinstance(res, list):
|
|
|
|
for i in xrange(len(res)):
|
|
|
|
if res[i] == msg:
|
|
|
|
res.pop(i)
|
|
|
|
break
|
|
|
|
new_msg += res
|
|
|
|
elif res is not None and res != msg:
|
|
|
|
new_msg.append(res)
|
|
|
|
msg = None
|
|
|
|
break
|
|
|
|
elif res is None or res == False:
|
|
|
|
msg = None
|
|
|
|
break
|
|
|
|
if msg is not None:
|
|
|
|
self.msgs.append(msg)
|
|
|
|
|
|
|
|
|
|
|
|
def in_treat(self, hm):
|
|
|
|
"""Treat Messages and store responses
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
hm -- Hooks manager
|
|
|
|
"""
|
|
|
|
|
|
|
|
self.responses = list()
|
|
|
|
for msg in self.msgs:
|
2014-09-12 06:12:55 +00:00
|
|
|
for h in hm.get_hooks("in", msg.cmd, msg.qual):
|
|
|
|
if h.match(message=msg, server=self.srv):
|
|
|
|
res = h.run(msg)
|
|
|
|
if isinstance(res, list):
|
2014-09-18 05:57:06 +00:00
|
|
|
for r in res:
|
|
|
|
if isinstance(r, Response):
|
|
|
|
r.set_sender(msg.sender)
|
2014-09-12 06:12:55 +00:00
|
|
|
self.responses += res
|
|
|
|
elif res is not None:
|
2014-09-18 05:57:06 +00:00
|
|
|
if isinstance(res, Response):
|
|
|
|
res.set_sender(msg.sender)
|
2014-09-12 06:12:55 +00:00
|
|
|
self.responses.append(res)
|
2014-09-01 17:21:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
def post_treat(self, hm):
|
|
|
|
"""Modify output Messages
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
hm -- Hooks manager
|
|
|
|
"""
|
|
|
|
|
|
|
|
new_msg = list()
|
|
|
|
new_msg += self.responses
|
|
|
|
self.responses = list()
|
|
|
|
|
|
|
|
while len(new_msg) > 0:
|
|
|
|
msg = self.first_treat(new_msg.pop(0))
|
|
|
|
for h in hm.get_hooks("post"):
|
|
|
|
if h.match(message=msg, server=self.srv):
|
|
|
|
res = h.run(msg)
|
|
|
|
if isinstance(res, list):
|
|
|
|
for i in xrange(len(res)):
|
|
|
|
if res[i] == msg:
|
|
|
|
res.pop(i)
|
|
|
|
break
|
|
|
|
new_msg += res
|
|
|
|
elif res is not None and res != msg:
|
|
|
|
new_msg.append(res)
|
|
|
|
msg = None
|
|
|
|
break
|
|
|
|
elif res is None or res == False:
|
|
|
|
msg = None
|
|
|
|
break
|
|
|
|
if msg is not None:
|
|
|
|
self.responses.append(msg)
|
2012-11-04 03:28:24 +00:00
|
|
|
|
2012-11-02 11:51:16 +00:00
|
|
|
|
2012-11-02 11:10:37 +00:00
|
|
|
def run(self, context):
|
|
|
|
"""Create, parse and treat the message"""
|
2012-10-04 11:36:25 +00:00
|
|
|
try:
|
2014-09-11 15:23:07 +00:00
|
|
|
for msg in self.msgs:
|
|
|
|
self.first_treat(msg)
|
2014-09-01 17:21:54 +00:00
|
|
|
|
|
|
|
# Run pre-treatment: from Message to [ Message ]
|
|
|
|
self.pre_treat(context.hooks)
|
|
|
|
|
|
|
|
# Run in-treatment: from Message to [ Response ]
|
|
|
|
if len(self.msgs) > 0:
|
|
|
|
self.in_treat(context.hooks)
|
|
|
|
|
|
|
|
# Run post-treatment: from Response to [ Response ]
|
|
|
|
if self.responses is not None and len(self.responses) > 0:
|
|
|
|
self.post_treat(context.hooks)
|
2012-10-04 11:36:25 +00:00
|
|
|
except:
|
2014-09-11 15:23:07 +00:00
|
|
|
logger.exception("Error occurred during the processing of the message: %s", self.msgs[0].raw)
|
2012-10-04 11:36:25 +00:00
|
|
|
|
2014-09-01 17:21:54 +00:00
|
|
|
for res in self.responses:
|
|
|
|
to_server = None
|
|
|
|
if res.server is None:
|
|
|
|
to_server = self.srv
|
|
|
|
res.server = self.srv.id
|
|
|
|
elif isinstance(res.server, str) and res.server in context.servers:
|
|
|
|
to_server = context.servers[res.server]
|
2012-11-02 11:10:37 +00:00
|
|
|
|
2014-09-01 17:21:54 +00:00
|
|
|
if to_server is None:
|
|
|
|
logger.error("The server defined in this response doesn't "
|
|
|
|
"exist: %s", res.server)
|
2014-09-18 05:57:06 +00:00
|
|
|
continue
|
2012-10-04 11:36:25 +00:00
|
|
|
|
2014-09-01 17:21:54 +00:00
|
|
|
# Sent the message only if treat_post authorize it
|
|
|
|
to_server.send_response(res)
|
2012-11-02 11:51:16 +00:00
|
|
|
|
2012-10-04 11:36:25 +00:00
|
|
|
class EventConsumer:
|
|
|
|
"""Store a event before treating"""
|
2012-11-02 11:10:37 +00:00
|
|
|
def __init__(self, evt, timeout=20):
|
2012-10-04 11:36:25 +00:00
|
|
|
self.evt = evt
|
|
|
|
self.timeout = timeout
|
|
|
|
|
2012-11-02 11:51:16 +00:00
|
|
|
|
2012-11-02 11:10:37 +00:00
|
|
|
def run(self, context):
|
2012-10-04 11:36:25 +00:00
|
|
|
try:
|
|
|
|
self.evt.launch_check()
|
|
|
|
except:
|
2014-08-27 05:57:00 +00:00
|
|
|
logger.exception("Error during event end")
|
2012-10-04 11:36:25 +00:00
|
|
|
if self.evt.next is not None:
|
2012-11-02 11:10:37 +00:00
|
|
|
context.add_event(self.evt, self.evt.id)
|
|
|
|
|
|
|
|
|
2012-10-04 11:36:25 +00:00
|
|
|
|
2012-08-23 16:20:45 +00:00
|
|
|
class Consumer(threading.Thread):
|
2012-10-04 11:36:25 +00:00
|
|
|
"""Dequeue and exec requested action"""
|
2012-08-23 16:20:45 +00:00
|
|
|
def __init__(self, context):
|
|
|
|
self.context = context
|
|
|
|
self.stop = False
|
|
|
|
threading.Thread.__init__(self)
|
|
|
|
|
|
|
|
def run(self):
|
|
|
|
try:
|
|
|
|
while not self.stop:
|
2012-10-04 11:36:25 +00:00
|
|
|
stm = self.context.cnsr_queue.get(True, 20)
|
2012-11-02 11:10:37 +00:00
|
|
|
stm.run(self.context)
|
2014-07-17 10:01:04 +00:00
|
|
|
self.context.cnsr_queue.task_done()
|
2012-08-31 03:21:19 +00:00
|
|
|
|
2012-08-23 16:20:45 +00:00
|
|
|
except queue.Empty:
|
|
|
|
pass
|
|
|
|
finally:
|
2012-10-04 11:36:25 +00:00
|
|
|
self.context.cnsr_thrd_size -= 2
|
2014-07-17 10:01:04 +00:00
|
|
|
self.context.cnsr_thrd.remove(self)
|