update comments

[erebus.git] / modules / admin_user.py

# Erebus IRC bot - Author: Erebus Team
# vim: fileencoding=utf-8
# Global-user management (glevel)
# This file is released into the public domain; see http://unlicense.org/

# module info
modinfo = {
	'author': 'Erebus Team',
	'license': 'public domain',
	'compatible': [0], # compatible module API versions
	'depends': [], # other modules required to work properly?
	'softdeps': ['help'], # modules which are preferred but not required
}
# note: softdeps will be loaded before this module, IF not disabled in the configuration (autoload.module = 0) (and if it exists)
# however, if it is disabled it will be silently ignored, and if it is unloaded at runtime it won't cause this one to unload.
#
# basically, softdeps are things this module will use if available, but does not require (no errors will occur if it's not loaded)
# for example, @lib.help() will attempt to use the help module, but swallow errors if it is not loaded

# preamble
import modlib
lib = modlib.modlib(__name__)
modstart = lib.modstart
modstop = lib.modstop

# module code

def _resolve_user(s):
	if s.startswith("#"):
		return lib.parent.User(s, s[1:])
	else:
		return lib.parent.user(s, create=False)

def _resolve_level(s):
	try:
		i = int(s)
		return i
	except ValueError:
		su = s.upper()
		if su == "ANYONE":
			su = "AUTHED" # resolve to 0 instead of -1
		if su in lib.glevs:
			return lib.glevs[su]
	return None

@lib.hook(('glevel','glev','adduser','setuser'), needchan=False, glevel=1)
@lib.help('<nick|#auth> <level>', "adds or sets a user's global level", "global level is any positive integer, 0 to delete a user, or -2 to ignore a user", "-2: ignored; 0: no special access (anyone); 1: known; 50: staff; 75: admin; 100: owner", "alternately you may use one of those keywords", "non-admins may only change their own level, and only to 0", "admins may only set lower access levels and may not set the access level of a user with higher access")
@lib.argsEQ(2)
def glevel(bot, user, chan, realtarget, *args):
	target_s = args[0]
	level_s = args[1]
	target = _resolve_user(target_s)
	level = _resolve_level(level_s)

	if target is None:
		user.msg('User not found (try #auth)')
		return
	if target.auth is None:
		user.msg('User is not authed')
		return
	if level is None:
		user.msg("Level is unknown, must be an integer or one of %s" % (', '.join(lib.glevs.keys())))
		return
	if level != -2 and level < 0:
		user.msg("Level must -2, 0, or a positive integer")
		return

	# Skip checks if the user is setting their own level to 0, or if the user is OWNER
	if not (target == user and level == 0) and user.glevel != lib.OWNER:
		if user.glevel <= lib.ADMIN:
			user.msg("I'm afraid I can't let you do that. You can only reset your own level to 0.")
			return
		if user.glevel <= target.glevel:
			user.msg("I'm afraid I can't let you do that. Your current access level is not higher than theirs.")
			return
		if user.glevel <= level:
			user.msg("I'm afraid I can't let you do that. Your current access level is not higher than you are trying to set.")
			return

	if target.setlevel(level):
		user.msg("The glevel of #%s has been updated successfully" % (target.auth))
	else:
		user.msg("Failed to update the level")