bitbot-3.11-fork/modules/karma.py

184 lines
6.7 KiB
Python
Raw Normal View History

#--depends-on commands
#--depends-on config
#--depends-on permissions
2016-03-29 11:56:58 +00:00
import re, time
from src import EventManager, ModuleManager, utils
2016-03-29 11:56:58 +00:00
KARMA_DELAY_SECONDS = 3
REGEX_WORD = re.compile(r"^([^(\s,:]+)(?:[:,])?\s*(\+\+|--)\s*$")
2019-12-10 10:51:37 +00:00
REGEX_WORD_START = re.compile(r"^(\+\+|--)(?:\s*)([^(\s,:]+)\s*$")
REGEX_PARENS = re.compile(r"\(([^)]+)\)(\+\+|--)")
@utils.export("channelset", utils.BoolSetting("karma-pattern",
"Enable/disable parsing ++/-- karma format"))
class Module(ModuleManager.BaseModule):
def _karma_str(self, karma):
karma_str = str(karma)
if karma < 0:
return utils.irc.color(str(karma), utils.consts.RED)
elif karma > 0:
return utils.irc.color(str(karma), utils.consts.LIGHTGREEN)
2019-10-12 06:23:58 +00:00
else:
return utils.irc.color(str(karma), utils.consts.YELLOW)
@utils.hook("new.user")
2016-03-29 11:56:58 +00:00
def new_user(self, event):
event["user"]._last_positive_karma = None
event["user"]._last_negative_karma = None
def _check_throttle(self, user, positive):
timestamp = None
if positive:
timestamp = user._last_positive_karma
else:
timestamp = user._last_negative_karma
return timestamp == None or (time.time()-timestamp
) >= KARMA_DELAY_SECONDS
def _set_throttle(self, user, positive):
if positive:
user._last_positive_karma = time.time()
else:
user._last_negative_karma = time.time()
2016-03-29 11:56:58 +00:00
def _get_target(self, server, target):
target = target.strip()
if not " " in target and server.has_user(target):
return server.get_user_nickname(server.get_user(target).get_id())
return target.lower()
def _change_karma(self, server, sender, target, positive):
if not self._check_throttle(sender, positive):
return False, "Try again in a couple of seconds"
2019-12-01 10:32:40 +00:00
target = self._get_target(server, target)
setting = "karma-%s" % target
karma = sender.get_setting(setting, 0)
karma += 1 if positive else -1
if karma == 0:
sender.del_setting(setting)
else:
sender.set_setting(setting, karma)
self._set_throttle(sender, positive)
karma_str = self._karma_str(karma)
karma_total = sum(self._get_karma(server, target).values())
karma_total = self._karma_str(karma_total)
return True, "%s now has %s karma (%s from %s)" % (
target, karma_total, karma_str, sender.nickname)
@utils.hook("command.regex", pattern=REGEX_WORD)
@utils.hook("command.regex", pattern=REGEX_PARENS)
@utils.kwarg("command", "karma")
@utils.kwarg("priority", EventManager.PRIORITY_HIGH)
# high priority to make `++asd++` count as `++` on `++help`
def regex_word(self, event):
if event["target"].get_setting("karma-pattern", False):
event.eat()
target = event["match"].group(1)
positive = event["match"].group(2)=="++"
success, message = self._change_karma(
event["server"], event["user"], target, positive)
event["stdout" if success else "stderr"].write(message)
2019-12-10 10:49:12 +00:00
@utils.hook("command.regex", pattern=REGEX_WORD_START)
@utils.kwarg("command", "karma")
def regex_word_start(self, event):
if event["target"].get_setting("karma-pattern", False):
target = event["match"].group(2)
positive = event["match"].group(1)=="++"
success, message = self._change_karma(
event["server"], event["user"], target, positive)
event["stdout" if success else "stderr"].write(message)
@utils.hook("received.command.addpoint")
@utils.hook("received.command.rmpoint")
@utils.kwarg("min_args", 1)
2020-01-26 02:59:16 +00:00
@utils.spec("!<target>string")
def changepoint(self, event):
positive = event["command"] == "addpoint"
success, message = self._change_karma(
2020-01-26 02:59:16 +00:00
event["server"], event["user"], event["spec"][0], positive)
event["stdout" if success else "stderr"].write(message)
@utils.hook("received.command.karma")
2016-03-29 11:56:58 +00:00
def karma(self, event):
"""
:help: Get your or someone else's karma
:usage: [target]
"""
2016-03-29 11:56:58 +00:00
if event["args"]:
target = event["args"]
else:
target = event["user"].nickname
target = self._get_target(event["server"], target)
karma = sum(self._get_karma(event["server"], target).values())
karma = self._karma_str(karma)
event["stdout"].write("%s has %s karma" % (target, karma))
2018-08-18 17:28:27 +00:00
@utils.hook("received.command.karmawho")
@utils.spec("!<target>string")
def karmawho(self, event):
target = event["spec"][0]
karma = self._get_karma(event["server"], target, True)
2020-09-29 15:36:43 +00:00
karma = sorted(list(karma.items()),
key=lambda k: abs(k[1]),
reverse=True)
parts = ["%s (%d)" % (n, v) for n, v in karma]
event["stdout"].write("%s has karma from: %s" %
(target, ", ".join(parts)))
def _get_karma(self, server, target, own=False):
settings = dict(server.get_all_user_settings("karma-%s" % target))
target_lower = server.irc_lower(target)
if target_lower in settings and not own:
del settings[target_lower]
return settings
@utils.hook("received.command.resetkarma")
@utils.kwarg("min_args", 2)
@utils.kwarg("help", "Reset a specific karma to 0")
@utils.kwarg("permission", "resetkarma")
2020-01-26 02:59:16 +00:00
@utils.spec("!'by !<nickname>ouser")
@utils.spec("!'for !<target>string")
2018-08-18 17:28:27 +00:00
def reset_karma(self, event):
2020-01-26 02:59:16 +00:00
subcommand = event["spec"][0]
if subcommand == "by":
2020-01-26 02:59:16 +00:00
target_user = event["spec"][1]
karma = target_user.find_setting(prefix="karma-")
for setting, _ in karma:
target_user.del_setting(setting)
if karma:
event["stdout"].write("Cleared karma by %s" %
target_user.nickname)
else:
event["stderr"].write("No karma to clear by %s" %
target_user.nickname)
elif subcommand == "for":
2020-01-26 02:59:16 +00:00
setting = "karma-%s" % event["spec"][1]
karma = event["server"].get_all_user_settings(setting)
for nickname, value in karma:
user = event["server"].get_user(nickname)
user.del_setting(setting)
if karma:
2020-01-26 02:59:16 +00:00
event["stdout"].write("Cleared karma for %s" % event["spec"][1])
else:
2020-01-26 02:59:16 +00:00
event["stderr"].write("No karma to clear for %s"
% event["spec"][1])
2018-08-18 17:28:27 +00:00
else:
raise utils.EventError("Unknown subcommand '%s'" % subcommand)