all plugins: cleanup, early return, use argv0 instead of data

plugins.py

@@ -139,11 +139,13 @@ def command_command(args):
 		return {
 			'name': 'command',
 			'desc': 'lists commands',
-			'args': ('data', 'reply_user', 'cmd_list'),
+			'args': ('argv0', 'reply_user', 'cmd_list'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'command' in args['data']:
+	if 'command' != args['argv0'] and 'commands' != args['argv0']:
+		return
+
 	logger('plugin', 'sent command list')
 	return {
 		'msg': args['reply_user'] + ': known commands: ' + str(args['cmd_list']).strip('[]')
@@ -154,40 +156,29 @@ def command_help(args):
 		return {
 			'name': 'help',
 			'desc': 'print help for a command',
-			'args': ('data', 'reply_user', 'cmd_list'),
+			'args': ('argv0', 'argv1', 'reply_user', 'cmd_list'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	cmd = None
-	flag = False
+	if 'help' != args['argv0']:
+		return
 
-	for word in args['data'].split():
-		if True == flag:
-			cmd = word
-			break
-
-		if 'help' == word:
-			flag = True
-
-	if False == flag:  # no match on 'help'
-		return None
-
-	if None == cmd:
+	if None == args['argv1']:
 		logger('plugin', 'empty help request, sent all commands')
-		args['data'] += 'command'  # this is a little hacky...
+		args['argv0'] = 'command'  # this is a little hacky...
 		return command_command(args)
 
-	if not cmd in [p['name'] for p in plugins['command']]:
-		logger('plugin', 'no help found for %s' % cmd)
+	if not args['argv1'] in [p['name'] for p in plugins['command']]:
+		logger('plugin', 'no help found for %s' % args['argv1'])
 		return {
-			'msg': args['reply_user'] + ': no such command: %s' % cmd
+			'msg': args['reply_user'] + ': no such command: %s' % args['argv1']
 		}
 
 	for p in plugins['command']:
-		if cmd == p['name']:
-			logger('plugin', 'sent help for %s' % cmd)
+		if args['argv1'] == p['name']:
+			logger('plugin', 'sent help for %s' % args['argv1'])
 			return {
-				'msg': args['reply_user'] + ': help for %s: %s' % (cmd, p['desc'])
+				'msg': args['reply_user'] + ': help for %s: %s' % (args['argv1'], p['desc'])
 			}
 
 
@@ -196,11 +187,13 @@ def command_version(args):
 		return {
 			'name': 'version',
 			'desc': 'prints version',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'version' in args['data']:
+	if 'version' != args['argv0']:
+		return
+
 	logger('plugin', 'sent version string')
 	return {
 		'msg': args['reply_user'] + (''': I'm running ''' + VERSION)
@@ -211,20 +204,23 @@ def command_klammer(args):
 		return {
 			'name': 'klammer',
 			'desc': 'prints an anoying paper clip aka. Karl Klammer',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'klammer' in args['data']:
+	if 'klammer' != args['argv0']:
+		return
+
 	logger('plugin', 'sent karl klammer')
 	return {
 		'msg': (
-				args['reply_user'] + r''':  _, Was moechten''',
-				args['reply_user'] + r''': ( _\_   Sie tun?''',
-				args['reply_user'] + r''':  \0 O\          ''',
-				args['reply_user'] + r''':   \\ \\  [ ] ja ''',
-				args['reply_user'] + r''':    \`' ) [ ] noe''',
-				args['reply_user'] + r''':     `''         '''
+			args['reply_user'] + ',',
+			r''' _, Was moechten''',
+			r'''( _\_   Sie tun?''',
+			r''' \0 O\          ''',
+			r'''  \\ \\  [ ] ja ''',
+			r'''   \`' ) [ ] noe''',
+			r'''    `''         '''
 		)
 	}
 
@@ -233,17 +229,20 @@ def command_unicode(args):
 		return {
 			'name': 'unikot',
 			'desc': 'prints an unicode string',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'unikot' in args['data']:
+	if 'unikot' != args['argv0']:
+		return
+
 	logger('plugin', 'sent some unicode')
 	return {
 		'msg': (
-				args['reply_user'] + ''': ┌────────┐''',
-				args['reply_user'] + ''': │Unicode!│''',
-				args['reply_user'] + ''': └────────┘'''
+			args['reply_user'] + ''', here's some''',
+			'''┌────────┐''',
+			'''│Unicode!│''',
+			'''└────────┘'''
 		)
 	}
 
@@ -252,11 +251,13 @@ def command_source(args):
 		return {
 			'name': 'source',
 			'desc': 'prints git URL',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'source' in args['data']:
+	if 'source' != args['argv0']:
+		return
+
 	logger('plugin', 'sent source URL')
 	return {
 		'msg': 'My source code can be found at %s' % conf('src-url')
@@ -267,11 +268,13 @@ def command_dice(args):
 		return {
 			'name': 'dice',
 			'desc': 'rolls a dice',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_INTERACTIVE
 		}
 
-	if 'dice' in args['data']:
+	if 'dice' != args['argv0']:
+		return
+
 	if args['reply_user'] in conf('enhanced-random-user'):
 		rnd = 0  # this might confuse users. good.
 		logger('plugin', 'sent random (enhanced)')
@@ -289,11 +292,13 @@ def command_uptime(args):
 		return {
 			'name': 'uptime',
 			'desc': 'prints uptime',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'uptime' in args['data']:
+	if 'uptime' != args['argv0']:
+		return
+
 	u = int(conf('uptime') + time.time())
 	plural_uptime = 's'
 	plural_request = 's'
@@ -313,11 +318,13 @@ def command_ping(args):
 		return {
 			'name': 'ping',
 			'desc': 'sends pong',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_INTERACTIVE
 		}
 
-	if 'ping' in args['data']:
+	if 'ping' != args['argv0']:
+		return
+
 	rnd = random.randint(0, 3)  # 1:4
 	if 0 == rnd:
 		msg = args['reply_user'] + ''': peng (You're dead now.)'''
@@ -338,11 +345,13 @@ def command_info(args):
 		return {
 			'name': 'info',
 			'desc': 'prints info message',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'info' in args['data']:
+	if 'info' != args['argv0']:
+		return
+
 	logger('plugin', 'sent long info')
 	return {
 		'msg': args['reply_user'] + (''': I'm a bot, my job is to extract <title> tags from posted URLs. In case I'm annoying or for further questions, please talk to my master %s. I'm rate limited and shouldn't post more than %d messages per %d seconds. To make me exit immediately, highlight me with 'hangup' in the message (emergency only, please). For other commands, highlight me with 'command'.''' % (conf('bot_owner'), conf('hist_max_count'), conf('hist_max_time')))
@@ -357,7 +366,9 @@ def command_teatimer(args):
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'teatimer' == args['argv0']:
+	if 'teatimer' != args['argv0']:
+		return
+
 	steep = conf('tea_steep_time')
 
 	if None != args['argv1']:
@@ -379,6 +390,8 @@ def command_teatimer(args):
 			'msg': args['reply_user'] + ': time format error: ' + str(e)
 		}
 
+# FIXME: this is currently broken because the msg_obj gets modified by the very
+#        first reply and can't be reused to .reply() with another message
 	register_event(ready, send_reply, (args['reply_user'] + ': Your tea is ready!', args['msg_obj']))
 
 	return {
@@ -392,17 +405,19 @@ def command_decode(args):
 		return {
 			'name': 'decode',
 			'desc': 'prints the long description of an unicode character',
-			'args': ('data', 'reply_user'),
+			'args': ('argv0', 'argv1', 'reply_user'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if not 'decode' in args['data']:
+	if 'decode' != args['argv0']:
 		return
 
-	d = args['data'].split()
+	if None == args['argv1']:
+		return {
+			'msg': args['reply_user'] + ': usage: decode {single character}'
+		}
 
-	if 4 == len(d):
-		char = d[3][0]
+	char = args['argv1']
 	char_esc = str(char.encode('unicode_escape'))[3:-1]
 	logger('plugin', 'decode called for %s' % char)
 
@@ -417,27 +432,24 @@ def command_decode(args):
 	return {
 		'msg': args['reply_user'] + ': %s (%s) is called "%s"' % (char, char_esc, uni_name)
 	}
-	else:
-		return {
-			'msg': args['reply_user'] + ': usage: decode {single character}'
-		}
 
 def command_show_blacklist(args):
 	if 'register' == args:
 		return {
 			'name': 'show-blacklist',
 			'desc': 'show the current URL blacklist, optionally filtered',
-			'args': ('data', 'reply_user', 'argv1'),
+			'args': ('argv0', 'reply_user', 'argv1'),
 			'ratelimit_class': RATE_GLOBAL
 		}
 
-	if 'show-blacklist' in args['data']:
+	if 'show-blacklist' != args['argv0']:
+		return
+
 	logger('plugin', 'sent URL blacklist')
 
 	return {
-			'msg': [
-				args['reply_user'] + ': URL blacklist: ' + b
-				for b in conf('url_blacklist')
+		'msg': [args['reply_user'] + ': URL blacklist: '] + [
+			b for b in conf('url_blacklist')
 			if not args['argv1'] or args['argv1'] in b
 		]
 	}
@@ -534,11 +546,13 @@ def command_cake(args):
 #		return {
 #			'name': 'dummy',
 #			'desc': 'dummy description',
-#			'args': ('data', 'reply_user'),
+#			'args': ('argv0', 'reply_user'),
 #			'ratelimit_class': RATE_GLOBAL
 #		}
 #
-#	if 'dummy' in args['data']:
+#	if 'dummy' != args['argv0']:
+#		return
+#
 #	logger('plugin', 'dummy plugin called')
 #
 #	return {