catdog2/urlbot-native
1
0
Fork 0
Code Issues Pull Requests Releases Activity

introduce configobj as configuration backend

Browse Source
This commit is contained in:
Thorsten
2015-12-20 12:36:08 +01:00
parent 9c3f7dae0f
commit c29ce94a3d
8 changed files with 153 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -1,4 +1,7 @@
.*swp
*.pyc
local_config.ini
# legacy
local_config.py
urlbot.persistent

6
common.py
View File

@@ -9,7 +9,7 @@ import sys
import time
import urllib.request
from collections import namedtuple
from local_config import conf
import config
RATE_NO_LIMIT = 0x00
RATE_GLOBAL = 0x01
@@ -27,12 +27,12 @@ USER_AGENT = 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) ' \
def conf_save(obj):
with open(conf('persistent_storage'), 'wb') as config_file:
with open(config.get('persistent_storage'), 'wb') as config_file:
return pickle.dump(obj, config_file)
def conf_load():
path = conf('persistent_storage')
path = config.get('persistent_storage')
if os.path.isfile(path):
with open(path, 'rb') as fd:
fd.seek(0)

48
config.py Normal file
View File

@@ -0,0 +1,48 @@
"""
Interface to access:
- local configuration
- shared configuration
- shared runtime state
All configuration is stored in a single ini-file and
persistent state is pickle-dumped into a binary file.
TODO: check lock safety
TODO: manage persistent state in configobj
"""
import json
import logging
import sys
from configobj import ConfigObj
from validate import Validator
__initialized = False
__config_store = ConfigObj('local_config.ini', configspec='local_config.ini.spec')
validator = Validator()
result = __config_store.validate(validator)
if not result:
print('Config file validation failed!')
sys.exit(1)
else:
__initialized = True
__config_store.write()
def get(key):
if not __initialized:
raise RuntimeError("not __initialized")
try:
return __config_store[key]
except KeyError as e:
logger = logging.getLogger(__name__)
logger.warn('conf(): unknown key ' + str(key))
print(json.dumps(__config_store, indent=2))
raise
def set(key, val):
__config_store[key] = val
__config_store.write()
return None

26
idlebot.py
View File

@@ -5,19 +5,7 @@ import time
import sys
from common import VERSION, EVENTLOOP_DELAY, conf_load
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 you needs.
'''[1:] % (
sys.argv[0],
' ' * len(sys.argv[0]),
' ' * len(sys.argv[0])
))
sys.exit(1)
import config
from sleekxmpp import ClientXMPP
@@ -61,7 +49,7 @@ class IdleBot(ClientXMPP):
# don't talk to yourself
if msg_obj['mucnick'] == self.nick or 'groupchat' != msg_obj['type']:
return False
elif msg_obj['body'].startswith(conf('bot_user')) and 'hangup' in msg_obj['body']:
elif msg_obj['body'].startswith(config.get('bot_nickname')) and 'hangup' in msg_obj['body']:
self.logger.warn("got 'hangup' from '%s': '%s'" % (
msg_obj['mucnick'], msg_obj['body']
))
@@ -83,20 +71,20 @@ class IdleBot(ClientXMPP):
def start(botclass, active=False):
logging.basicConfig(
level=conf('loglevel', logging.INFO),
level=config.get('loglevel'),
format=sys.argv[0] + ' %(asctime)s %(levelname).1s %(funcName)-15s %(message)s'
)
logger = logging.getLogger(__name__)
logger.info(VERSION)
jid = conf('jid')
jid = config.get('jid')
if '/' not in jid:
jid = '%s/%s' % (jid, botclass.__name__)
bot = botclass(
jid=jid,
password=conf('password'),
rooms=conf('rooms'),
nick=conf('bot_user')
password=config.get('password'),
rooms=config.get('rooms'),
nick=config.get('bot_nickname')
)
import plugins

35
local_config.ini.spec Normal file
View File

@@ -0,0 +1,35 @@
jid = string
password = string
rooms = string_list(default=list('spielwiese@chat.debianforum.de',))
src-url = string
bot_nickname = string
bot_owner = string
# rate limiting
hist_max_count = integer(default=5)
hist_max_time = integer(default=10*60)
# statistics
uptime = integer(default=0)
request_counter = integer(default=0)
persistent_storage = string(default='urlbot.persistent')
persistent_locked = boolean(default=false)
# the "dice" feature will use more efficient random data (0) for given users
enhanced-random-user = string_list(default=list())
# the "moin" feature will be "disabled" for given users
moin-modified-user = string_list(default=list())
moin-disabled-user = string_list(default=list())
tea_steep_time = integer(default=220)
image_preview = boolean(default=true)
dsa_watcher_interval = integer(default=900)
last_dsa = integer # TODO broken
loglevel = option('ERROR', WARN', 'INFO', 'DEBUG', default='INFO')
debug_mode = boolean(default=false)

82
plugins.py
View File

@@ -12,7 +12,7 @@ import urllib.request
from common import conf_load, conf_save, RATE_GLOBAL, RATE_NO_SILENCE, VERSION, RATE_INTERACTIVE, BUFSIZ, \
USER_AGENT, extract_title, RATE_FUN, RATE_NO_LIMIT, conf_get, RATE_URL
from local_config import set_conf, conf
import config
from string_constants import excuses, moin_strings_hi, moin_strings_bye, cakes
ptypes_PARSE = 'parser'
@@ -37,11 +37,11 @@ def plugin_enabled_get(urlbot_plugin):
def plugin_enabled_set(plugin, enabled):
if conf('persistent_locked'):
if config.get('persistent_locked'):
log.warn("couldn't get exclusive lock")
return False
set_conf('persistent_locked', True)
config.set('persistent_locked', True)
blob = conf_load()
if 'plugin_conf' not in blob:
@@ -53,7 +53,7 @@ def plugin_enabled_set(plugin, enabled):
blob['plugin_conf'][plugin.plugin_name]['enabled'] = enabled
conf_save(blob)
set_conf('persistent_locked', False)
config.set('persistent_locked', False)
return True
@@ -180,11 +180,11 @@ def parse_moin(**args):
for w in words:
if d.lower() == w.lower():
if args['reply_user'] in conf('moin-disabled-user'):
if args['reply_user'] in config.get('moin-disabled-user'):
log.info('moin blacklist match')
return
if args['reply_user'] in conf('moin-modified-user'):
if args['reply_user'] in config.get('moin-modified-user'):
log.info('being "quiet" for %s' % w)
return {
'msg': '/me %s' % random.choice([
@@ -213,9 +213,9 @@ def parse_latex(**args):
}
@pluginfunction('me-action', 'reacts to /me.*%{bot_user}', ptypes_PARSE, ratelimit_class=RATE_FUN | RATE_GLOBAL)
@pluginfunction('me-action', 'reacts to /me.*%{bot_nickname}', ptypes_PARSE, ratelimit_class=RATE_FUN | RATE_GLOBAL)
def parse_slash_me(**args):
if args['data'].lower().startswith('/me') and (conf('bot_user') in args['data'].lower()):
if args['data'].lower().startswith('/me') and (config.get('bot_nickname') in args['data'].lower()):
log.info('sent /me reply')
me_replys = [
@@ -324,7 +324,7 @@ def command_source(argv, **_):
log.info('sent source URL')
return {
'msg': 'My source code can be found at %s' % conf('src-url')
'msg': 'My source code can be found at %s' % config.get('src-url')
}
@@ -353,7 +353,7 @@ def command_dice(argv, **args):
)
for i in range(count):
if args['reply_user'] in conf('enhanced-random-user'):
if args['reply_user'] in config.get('enhanced-random-user'):
rnd = 0 # this might confuse users. good.
log.info('sent random (enhanced)')
else:
@@ -394,19 +394,19 @@ def command_uptime(argv, **args):
if 'uptime' != argv[0]:
return
u = int(conf('uptime') + time.time())
u = int(config.get('uptime') + time.time())
plural_uptime = 's'
plural_request = 's'
if 1 == u:
plural_uptime = ''
if 1 == conf('request_counter'):
if 1 == config.get('request_counter'):
plural_request = ''
log.info('sent statistics')
return {
'msg': args['reply_user'] + (''': happily serving for %d second%s, %d request%s so far.''' % (
u, plural_uptime, int(conf('request_counter')), plural_request))
u, plural_uptime, int(config.get('request_counter')), plural_request))
}
@@ -443,16 +443,16 @@ def command_info(argv, **args):
questions, please talk to my master %s. I'm rate limited.
To make me exit immediately, highlight me with 'hangup' in the message
(emergency only, please). For other commands, highlight me with 'help'.''' % (
conf('bot_owner')))
config.get('bot_owner')))
}
@pluginfunction('teatimer', 'sets a tea timer to $1 or currently %d seconds' % conf('tea_steep_time'), ptypes_COMMAND)
@pluginfunction('teatimer', 'sets a tea timer to $1 or currently %d seconds' % config.get('tea_steep_time'), ptypes_COMMAND)
def command_teatimer(argv, **args):
if 'teatimer' != argv[0]:
return
steep = conf('tea_steep_time')
steep = config.get('tea_steep_time')
if len(argv) > 1:
try:
@@ -544,7 +544,7 @@ def command_show_blacklist(argv, **args):
'' if not argv1 else ' (limited to %s)' % argv1
)
] + [
b for b in conf('url_blacklist') if not argv1 or argv1 in b
b for b in config.get('url_blacklist') if not argv1 or argv1 in b
]
}
@@ -592,12 +592,12 @@ def command_usersetting(argv, **args):
# display current value
return usersetting_get(argv, args)
if conf('persistent_locked'):
if config.get('persistent_locked'):
return {
'msg': args['reply_user'] + ''': couldn't get exclusive lock'''
}
set_conf('persistent_locked', True)
config.set('persistent_locked', True)
blob = conf_load()
if 'user_pref' not in blob:
@@ -609,7 +609,7 @@ def command_usersetting(argv, **args):
blob['user_pref'][arg_user][arg_key] = 'on' == arg_val
conf_save(blob)
set_conf('persistent_locked', False)
config.set('persistent_locked', False)
# display value written to db
return usersetting_get(argv, args)
@@ -824,12 +824,12 @@ def command_record(argv, **args):
message = '%s (%s): ' % (args['reply_user'], time.strftime('%F.%T'))
message += ' '.join(argv[2:])
if conf('persistent_locked'):
if config.get('persistent_locked'):
return {
'msg': "%s: couldn't get exclusive lock" % args['reply_user']
}
set_conf('persistent_locked', True)
config.set('persistent_locked', True)
blob = conf_load()
if 'user_records' not in blob:
@@ -841,7 +841,7 @@ def command_record(argv, **args):
blob['user_records'][target_user].append(message)
conf_save(blob)
set_conf('persistent_locked', False)
config.set('persistent_locked', False)
return {
'msg': '%s: message saved for %s' % (args['reply_user'], target_user)
@@ -911,12 +911,12 @@ def command_dsa_watcher(argv, **_):
if result:
package = result.groups()[0]
if conf('persistent_locked'):
if config.get('persistent_locked'):
msg = "couldn't get exclusive lock"
log.warn(msg)
out.append(msg)
else:
set_conf('persistent_locked', True)
config.set('persistent_locked', True)
blob = conf_load()
if 'plugin_conf' not in blob:
@@ -928,7 +928,7 @@ def command_dsa_watcher(argv, **_):
blob['plugin_conf']['last_dsa'] += 1
conf_save(blob)
set_conf('persistent_locked', False)
config.set('persistent_locked', False)
msg = (
'new Debian Security Announce found (%s): %s' % (str(package).replace(' - security update', ''), url))
@@ -937,7 +937,7 @@ def command_dsa_watcher(argv, **_):
log.info('no dsa for %d, trying again...' % dsa)
# that's good, no error, just 404 -> DSA not released yet
crawl_at = time.time() + conf('dsa_watcher_interval')
crawl_at = time.time() + config.get('dsa_watcher_interval')
# register_event(crawl_at, command_dsa_watcher, (['dsa-watcher', 'crawl'],))
msg = 'next crawl set to %s' % time.strftime('%F.%T', time.localtime(crawl_at))
@@ -1002,8 +1002,8 @@ def remove_from_botlist(argv, **args):
blob = conf_load()
if args['reply_user'] != conf('bot_owner'):
return {'msg': "only %s may do this!" % conf('bot_owner')}
if args['reply_user'] != config.get('bot_owner'):
return {'msg': "only %s may do this!" % config.get('bot_owner')}
if argv[1] in blob.get('other_bots', ()):
blob['other_bots'].pop(blob['other_bots'].index(argv[1]))
@@ -1019,14 +1019,14 @@ def set_status(argv, **args):
if 'set-status' != argv[0] or len(argv) != 2:
return
if argv[1] == 'mute' and args['reply_user'] == conf('bot_owner'):
if argv[1] == 'mute' and args['reply_user'] == config.get('bot_owner'):
return {
'presence': {
'status': 'xa',
'msg': 'I\'m muted now. You can unmute me with "%s: set_status unmute"' % conf("bot_user")
'msg': 'I\'m muted now. You can unmute me with "%s: set_status unmute"' % config.get("bot_nickname")
}
}
elif argv[1] == 'unmute' and args['reply_user'] == conf('bot_owner'):
elif argv[1] == 'unmute' and args['reply_user'] == config.get('bot_owner'):
return {
'presence': {
'status': None,
@@ -1037,7 +1037,7 @@ def set_status(argv, **args):
@pluginfunction('reset-jobs', "reset joblist", ptypes_COMMAND, ratelimit_class=RATE_NO_LIMIT)
def reset_jobs(argv, **args):
if 'reset-jobs' != argv[0] or args['reply_user'] != conf('bot_owner'):
if 'reset-jobs' != argv[0] or args['reply_user'] != config.get('bot_owner'):
return
else:
joblist.clear()
@@ -1056,9 +1056,21 @@ def resolve_url_title(**args):
if not result:
return
url_blacklist = [
r'^.*heise\.de/.*-[0-9]+\.html$',
r'^.*wikipedia\.org/wiki/.*$',
r'^.*blog\.fefe\.de/\?ts=[0-9a-f]+$',
r'^.*ibash\.de/zitat.*$',
r'^.*golem\.de/news/.*$'
r'^.*paste\.debian\.net/((hidden|plainh?)/)?[0-9a-f]+/?$',
r'^.*example\.(org|net|com).*$',
r'^.*sprunge\.us/.*$',
r'^.*ftp\...\.debian\.org.*$'
]
out = []
for url in result:
if any([re.match(b, url) for b in conf('url_blacklist')]):
if any([re.match(b, url) for b in url_blacklist]):
log.info('url blacklist match for ' + url)
break
@@ -1081,7 +1093,7 @@ def resolve_url_title(**args):
title = title.strip()
message = 'Title: %s' % title
elif 1 == status:
if conf('image_preview'):
if config.get('image_preview'):
# of course it's fake, but it looks interesting at least
char = r""",._-+=\|/*`~"'"""
message = 'No text but %s, 1-bit ASCII art preview: [%c]' % (

2
requirements.txt Normal file
View File

@@ -0,0 +1,2 @@
sleekxmpp
configobj

28
urlbot.py
View File

@@ -26,19 +26,7 @@ from plugins import (
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)
import config
class UrlBot(IdleBot):
@@ -108,11 +96,11 @@ class UrlBot(IdleBot):
self.logger.info('sent %d offline records to room %s',
len(records), msg_obj['from'].bare)
if conf('persistent_locked'):
if config.get('persistent_locked'):
self.logger.warning("couldn't get exclusive lock")
return False
set_conf('persistent_locked', True)
config.set('persistent_locked', True)
blob = conf_load()
if 'user_records' not in blob:
@@ -122,7 +110,7 @@ class UrlBot(IdleBot):
blob['user_records'].pop(arg_user_key)
conf_save(blob)
set_conf('persistent_locked', False)
config.set('persistent_locked', False)
# @rate_limited(10)
def send_reply(self, message, msg_obj=None):
@@ -133,7 +121,7 @@ class UrlBot(IdleBot):
self.logger.warning("I'm muted! (status: %s)", self.show)
return
set_conf('request_counter', conf('request_counter') + 1)
config.set('request_counter', config.get('request_counter') + 1)
if str is not type(message):
message = '\n'.join(message)
@@ -171,7 +159,7 @@ class UrlBot(IdleBot):
message = '(nospoiler) %s' % message
return message
if conf('debug_mode', False):
if config.get('debug_mode'):
print(message)
else:
if msg_obj:
@@ -230,8 +218,8 @@ class UrlBot(IdleBot):
if len(words) < 2: # 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')):
# don't reply if beginning of the text matches bot_nickname
if not data.startswith(config.get('bot_nickname')):
return None
if 'hangup' in data: