Files
urlbot-native/urlbot.py
2015-11-30 19:17:40 +01:00

283 lines
8.3 KiB
Python
Executable File

#!/usr/bin/python3
# -*- coding: utf-8 -*-
import random
import re
import sys
from common import (
conf_load, conf_save,
extract_title,
rate_limit_classes,
RATE_GLOBAL,
RATE_CHAT,
RATE_NO_SILENCE,
RATE_EVENT,
# rate_limited,
rate_limit,
RATE_URL, conf_set)
from idlebot import IdleBot, start
from plugins import (
plugins as plugin_storage,
ptypes_COMMAND,
plugin_enabled_get,
ptypes_PARSE,
register_event,
else_command
)
try:
from local_config import conf, set_conf
except ImportError:
sys.stderr.write('''
%s: E: local_config.py isn't tracked because of included secrets and
%s site specific configurations. Rename local_config.py.skel and
%s adjust to your needs.
'''[1:] % (
sys.argv[0],
' ' * len(sys.argv[0]),
' ' * len(sys.argv[0])
))
sys.exit(1)
class UrlBot(IdleBot):
def __init__(self, jid, password, rooms, nick):
super(UrlBot, self).__init__(jid, password, rooms, nick)
self.hist_ts = {p: [] for p in rate_limit_classes}
self.hist_flag = {p: True for p in rate_limit_classes}
self.add_event_handler('message', self.message)
self.priority = 100
for r in self.rooms:
self.add_event_handler('muc::%s::got_online' % r, self.muc_online)
def muc_message(self, msg_obj):
return super(UrlBot, self).muc_message(msg_obj) and self.handle_msg(msg_obj)
def message(self, msg_obj):
if 'groupchat' == msg_obj['type']:
return
else:
self.logger.info("Got the following PM: %s" % str(msg_obj))
def muc_online(self, msg_obj):
"""
Hook for muc event "user joins"
"""
# don't react to yourself
if msg_obj['muc']['nick'] == self.nick:
return
# TODO: move this to a undirected plugin, maybe new plugin type
arg_user = msg_obj['muc']['nick']
arg_user_key = arg_user.lower()
blob_userrecords = conf_load().get('user_records', {})
if arg_user_key in blob_userrecords:
records = blob_userrecords[arg_user_key]
if not records:
return
self.send_message(
mto=msg_obj['from'].bare,
mbody='%s, there %s %d message%s for you:\n%s' % (
arg_user,
'is' if 1 == len(records) else 'are',
len(records),
'' if 1 == len(records) else 's',
'\n'.join(records)
),
mtype='groupchat'
)
self.logger.info('sent %d offline records to room %s' % (
len(records), msg_obj['from'].bare
))
if conf('persistent_locked'):
self.logger.warn("couldn't get exclusive lock")
return False
set_conf('persistent_locked', True)
blob = conf_load()
if 'user_records' not in blob:
blob['user_records'] = {}
if arg_user_key in blob['user_records']:
blob['user_records'].pop(arg_user_key)
conf_save(blob)
set_conf('persistent_locked', False)
# @rate_limited(10)
def send_reply(self, message, msg_obj=None):
"""
Send a reply to a message
"""
if self.show:
self.logger.warn("I'm muted! (status: %s)" % self.show)
return
set_conf('request_counter', conf('request_counter') + 1)
if str is not type(message):
message = '\n'.join(message)
# check other bots, add nospoiler with urls
def _prevent_panic(message, room):
if 'http' in message:
other_bots = conf_load().get("other_bots", ())
users = self.plugin['xep_0045'].getRoster(room)
if set(users).intersection(set(other_bots)):
message = '(nospoiler) %s' % message
return message
if conf('debug_mode', False):
print(message)
else:
if msg_obj:
message = _prevent_panic(message, msg_obj['from'].bare)
self.send_message(
mto=msg_obj['from'].bare,
mbody=message,
mtype='groupchat'
)
else: # unset msg_obj == broadcast
for room in self.rooms:
message = _prevent_panic(message, room)
self.send_message(
mto=room,
mbody=message,
mtype='groupchat'
)
def handle_msg(self, msg_obj):
"""
called for incoming messages
:param msg_obj:
:returns nothing
"""
content = msg_obj['body']
if 'has set the subject to:' in content:
return
if sys.argv[0] in content:
self.logger.info('silenced, this is my own log')
return
if 'nospoiler' in content:
self.logger.info('no spoiler for: ' + content)
return
self.data_parse_commands(msg_obj)
self.data_parse_other(msg_obj)
def data_parse_commands(self, msg_obj):
"""
react to a message with the bots nick
:param msg_obj: dictionary with incoming message parameters
:returns: nothing
"""
global got_hangup
data = msg_obj['body']
words = data.split()
if 2 > len(words): # need at least two words
return None
# don't reply if beginning of the text matches bot_user
if not data.startswith(conf('bot_user')):
return None
if 'hangup' in data:
self.logger.warn('received hangup: ' + data)
got_hangup = True
sys.exit(1)
reply_user = msg_obj['mucnick']
# TODO: check how several commands/plugins in a single message behave (also with rate limiting)
reacted = False
for plugin in plugin_storage[ptypes_COMMAND]:
if not plugin_enabled_get(plugin):
continue
ret = plugin(
data=data,
cmd_list=[pl.plugin_name for pl in plugin_storage[ptypes_COMMAND]],
parser_list=[pl.plugin_name for pl in plugin_storage[ptypes_PARSE]],
reply_user=reply_user,
msg_obj=msg_obj,
argv=words[1:]
)
if ret:
self._run_action(ret, plugin, msg_obj)
reacted = True
if not reacted and rate_limit(RATE_GLOBAL):
ret = else_command({'reply_user': reply_user})
if ret:
if 'msg' in ret:
self.send_reply(ret['msg'], msg_obj)
def data_parse_other(self, msg_obj):
"""
react to any message
:param msg_obj: incoming message parameters
:return:
"""
data = msg_obj['body']
reply_user = msg_obj['mucnick']
for plugin in plugin_storage[ptypes_PARSE]:
if not plugin_enabled_get(plugin):
continue
ret = plugin(reply_user=reply_user, data=data)
if ret:
self._run_action(ret, plugin, msg_obj)
def _run_action(self, action, plugin, msg_obj):
"""
Execute the plugin's execution plan
:param action: dict with event and/or msg
:param plugin: plugin obj
:param msg_obj: xmpp message obj
"""
if 'event' in action:
event = action["event"]
if 'msg' in event:
register_event(event["time"], self.send_reply, [event['msg']])
elif 'command' in event:
command = event["command"]
if rate_limit(RATE_EVENT):
register_event(event["time"], command[0], command[1])
if 'msg' in action and rate_limit(RATE_CHAT | plugin.ratelimit_class):
self.send_reply(action['msg'], msg_obj)
if 'presence' in action:
presence = action['presence']
conf_set('presence', presence)
self.status = presence.get('msg')
self.show = presence.get('status')
self.send_presence(pstatus=self.status, pshow=self.show)
# self.reconnect(wait=True)
if '__main__' == __name__:
start(UrlBot, True)