Mikubot-2/otouto/plugins/administration.lua

--[[
	administration.lua
	Version 1.10
	Part of the otouto project.
	© 2016 topkecleon <drew@otou.to>
	GNU General Public License, version 2

	This plugin provides self-hosted, single-realm group administration.
	It requires tg (http://github.com/vysheng/tg) with supergroup support.
	For more documentation, read the the manual (otou.to/rtfm).

	Remember to load this before blacklist.lua.

	Important notices about updates will be here!

	1.9 - Added flag antihammer. Groups with antihammer enabled will not be
	 affected by global bans. However, users who are hammer'd from an anti-
	 hammer group will also be banned locally. Added autobanning after (default)
	 3 autokicks. Threshold onfigurable with antiflood. Autokick counters reset
	 within twenty-four hours. Merged antisquig action into generic. There is no
	 automatic migration; simply add the following to database.administration:
		autokick_timer = 0
		groups[*].flags[6] = false
		groups[*].autoban = 3
		groups[*].autokicks = {}b

	1.9.1 - Returned to non-toggled promotions/bans (too many complaints!).

	1.10 - Added /ahelp $command support. No migration required. All actions
	 have been reworked to be more elegant. Style has been slightly changed (no
	 more weak-looking, italic group names). Added some (but not many) comments.

	1.10.1 - Bug fixes and minor improvements. :^)

	1.10.2 - Fixed bug in antibot. Further, ranks 2+ will be automatically made
	 group admins when they join a group.

	1.10.3 - /gadd now supports arguments to enable flags immediately, eg:
	 "/gadd 1 4 5" will add a grouo with the unlisted, antibot, and antiflood
	 flags.

]]--

local JSON = require('dkjson')
local drua = dofile('drua-tg.lua')
local bindings = require('otouto.bindings')
local utilities = require('otouto.utilities')

local administration = {}

function administration:init(config)
	-- Build the administration db if nonexistent.
	if not self.database.administration then
		self.database.administration = {
			admins = {},
			groups = {},
			activity = {},
			autokick_timer = os.date('%d')
		}
	end

	self.admin_temp = {
		help = {},
		flood = {}
	}

	drua.PORT = config.cli_port or 4567

	administration.flags = administration.init_flags(config.cmd_pat)
	administration.init_command(self, config)

	administration.doc = '`Returns a list of administrated groups.\nUse '..config.cmd_pat..'ahelp for more administrative commands.`'

	-- In the worst case, don't send errors in reply to random messages.
	administration.error = false

end

function administration.init_flags(cmd_pat) return {
	[1] = {
		name = 'unlisted',
		desc = 'Removes this group from the group listing.',
		short = 'This group is unlisted.',
		enabled = 'This group is no longer listed in '..cmd_pat..'groups.',
		disabled = 'This group is now listed in '..cmd_pat..'groups.'
	},
	[2] = {
		name = 'antisquig',
		desc = 'Automatically removes users who post Arabic script or RTL characters.',
		short = 'This group does not allow Arabic script or RTL characters.',
		enabled = 'Users will now be removed automatically for posting Arabic script and/or RTL characters.',
		disabled = 'Users will no longer be removed automatically for posting Arabic script and/or RTL characters.',
		kicked = 'You were automatically kicked from GROUPNAME for posting Arabic script and/or RTL characters.'
	},
	[3] = {
		name = 'antisquig++',
		desc = 'Automatically removes users whose names contain Arabic script or RTL characters.',
		short = 'This group does not allow users whose names contain Arabic script or RTL characters.',
		enabled = 'Users whose names contain Arabic script and/or RTL characters will now be removed automatically.',
		disabled = 'Users whose names contain Arabic script and/or RTL characters will no longer be removed automatically.',
		kicked = 'You were automatically kicked from GROUPNAME for having a name which contains Arabic script and/or RTL characters.'
	},
	[4] = {
		name = 'antibot',
		desc = 'Prevents the addition of bots by non-moderators.',
		short = 'This group does not allow users to add bots.',
		enabled = 'Non-moderators will no longer be able to add bots.',
		disabled = 'Non-moderators will now be able to add bots.'
	},
	[5] = {
		name = 'antiflood',
		desc = 'Prevents flooding by rate-limiting messages per user.',
		short = 'This group automatically removes users who flood.',
		enabled = 'Users will now be removed automatically for excessive messages. Use '..cmd_pat..'antiflood to configure limits.',
		disabled = 'Users will no longer be removed automatically for excessive messages.',
		kicked = 'You were automatically kicked from GROUPNAME for flooding.'
	},
	[6] = {
		name = 'antihammer',
		desc = 'Allows globally banned users to enter this group. Note that users hammered in this group will also be banned locally.',
		short = 'This group does not acknowledge global bans.',
		enabled = 'This group will no longer remove users for being globally banned.',
		disabled = 'This group will now remove users for being globally banned.'
	}
} end

administration.antiflood = {
	text = 10,
	voice = 10,
	audio = 10,
	contact = 10,
	photo = 20,
	video = 20,
	location = 20,
	document = 20,
	sticker = 30
}

administration.ranks = {
	[0] = 'Banned',
	[1] = 'Users',
	[2] = 'Moderators',
	[3] = 'Governors',
	[4] = 'Administrators',
	[5] = 'Owner'
}

function administration:get_rank(target, chat, config)

	target = tostring(target)
	chat = tostring(chat)

	-- Return 5 if the target is the bot or its owner.
	if tonumber(target) == config.admin or tonumber(target) == self.info.id then
		return 5
	end

	-- Return 4 if the target is an administrator.
	if self.database.administration.admins[target] then
		return 4
	end

	if chat and self.database.administration.groups[chat] then
		-- Return 3 if the target is the governor of the chat.
		if self.database.administration.groups[chat].governor == tonumber(target) then
			return 3
		-- Return 2 if the target is a moderator of the chat.
		elseif self.database.administration.groups[chat].mods[target] then
			return 2
		-- Return 0 if the target is banned from the chat.
		elseif self.database.administration.groups[chat].bans[target] then
			return 0
		-- Return 1 if antihammer is enabled.
		elseif self.database.administration.groups[chat].flags[6] then
			return 1
		end
	end

	-- Return 0 if the target is blacklisted (and antihammer is not enabled).
	if self.database.blacklist[target] then
		return 0
	end

	-- Return 1 if the target is a regular user.
	return 1

end

function administration:get_target(msg, config)
	local target = utilities.user_from_message(self, msg)
	if target.id then
		target.rank = administration.get_rank(self, target.id_str, msg.chat.id, config)
	end
	return target
end

function administration:mod_format(id)
	id = tostring(id)
	local user = self.database.users[id] or { first_name = 'Unknown' }
	local name = utilities.build_name(user.first_name, user.last_name)
	name = utilities.markdown_escape(name)
	local output = '• ' .. name .. ' `[' .. id .. ']`\n'
	return output
end

function administration:get_desc(chat_id, config)

	local group = self.database.administration.groups[tostring(chat_id)]
	local t = {}
	if group.link then
		table.insert(t, '*Welcome to* [' .. group.name .. '](' .. group.link .. ')*!*')
	else
		table.insert(t, '*Welcome to ' .. group.name .. '!*')
	end
	if group.motd then
		table.insert(t, '*Message of the Day:*\n' .. group.motd)
	end
	if #group.rules > 0 then
		local rulelist = '*Rules:*\n'
		for i = 1, #group.rules do
			rulelist = rulelist .. '*' .. i .. '.* ' .. group.rules[i] .. '\n'
		end
		table.insert(t, utilities.trim(rulelist))
	end
	local flaglist = ''
	for i = 1, #administration.flags do
		if group.flags[i] then
			flaglist = flaglist .. '• ' .. administration.flags[i].short .. '\n'
		end
	end
	if flaglist ~= '' then
		table.insert(t, '*Flags:*\n' .. utilities.trim(flaglist))
	end
	if group.governor then
		local gov = self.database.users[tostring(group.governor)]
		local s = utilities.md_escape(utilities.build_name(gov.first_name, gov.last_name)) .. ' `[' .. gov.id .. ']`'
		table.insert(t, '*Governor:* ' .. s)
	end
	local modstring = ''
	for k,_ in pairs(group.mods) do
		modstring = modstring .. administration.mod_format(self, k)
	end
	if modstring ~= '' then
		table.insert(t, '*Moderators:*\n' .. utilities.trim(modstring))
	end
	table.insert(t, 'Run '..config.cmd_pat..'ahelp@' .. self.info.username .. ' for a list of commands.')
	return table.concat(t, '\n\n')

end

function administration:update_desc(chat, config)
	local group = self.database.administration.groups[tostring(chat)]
	local desc = 'Welcome to ' .. group.name .. '!\n'
	if group.motd then desc = desc .. group.motd .. '\n' end
	if group.governor then
		local gov = self.database.users[tostring(group.governor)]
		desc = desc .. '\nGovernor: ' .. utilities.build_name(gov.first_name, gov.last_name) .. ' [' .. gov.id .. ']\n'
	end
	local s = '\n'..config.cmd_pat..'desc@' .. self.info.username .. ' for more information.'
	desc = desc:sub(1, 250-s:len()) .. s
	drua.channel_set_about(chat, desc)
end

function administration:kick_user(chat, target, reason, config)
	drua.kick_user(chat, target)
	local victim = target
	if self.database.users[tostring(target)] then
		victim = utilities.build_name(
				self.database.users[tostring(target)].first_name,
				self.database.users[tostring(target)].last_name
			) .. ' [' .. victim .. ']'
	end
	local group = self.database.administration.groups[tostring(chat)].name
	utilities.handle_exception(self, victim..' kicked from '..group, reason, config)
end

function administration.init_command(self_, config)
	administration.commands = {

		{ -- generic, mostly autokicks
			triggers = { '' },

			privilege = 0,
			interior = true,

			action = function(self, msg, group, config)

				local rank = administration.get_rank(self, msg.from.id, msg.chat.id, config)
				local user = {}

				if rank < 2 then

					-- banned
					if rank == 0 then
						user.do_kick = true
						user.dont_unban = true
						user.reason = 'banned'
						user.output = 'Sorry, you are banned from ' .. msg.chat.title .. '.'
					elseif group.flags[2] and ( -- antisquig
						msg.text:match(utilities.char.arabic)
						or msg.text:match(utilities.char.rtl_override)
						or msg.text:match(utilities.char.rtl_mark)
					) then
						user.do_kick = true
						user.reason = 'antisquig'
						user.output = administration.flags[2].kicked:gsub('GROUPNAME', msg.chat.title)
					elseif group.flags[3] and ( -- antisquig++
						msg.from.name:match(utilities.char.arabic)
						or msg.from.name:match(utilities.char.rtl_override)
						or msg.from.name:match(utilities.char.rtl_mark)
					) then
						user.do_kick = true
						user.reason = 'antisquig++'
						user.output = administration.flags[3].kicked:gsub('GROUPNAME', msg.chat.title)
					end

					-- antiflood
					if group.flags[5] then
						if not group.antiflood then
							group.antiflood = JSON.decode(JSON.encode(administration.antiflood))
						end
						if not self.admin_temp.flood[msg.chat.id_str] then
							self.admin_temp.flood[msg.chat.id_str] = {}
						end
						if not self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = 0
						end
						if msg.sticker then -- Thanks Brazil for discarding switches.
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.sticker
						elseif msg.photo then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.photo
						elseif msg.document then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.document
						elseif msg.audio then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.audio
						elseif msg.contact then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.contact
						elseif msg.video then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.video
						elseif msg.location then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.location
						elseif msg.voice then
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.voice
						else
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] + group.antiflood.text
						end
						if self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] > 99 then
							user.do_kick = true
							user.reason = 'antiflood'
							user.output = administration.flags[5].kicked:gsub('GROUPNAME', msg.chat.title)
							self.admin_temp.flood[msg.chat.id_str][msg.from.id_str] = nil
						end
					end

				end

				local new_user = user
				local new_rank = rank

				if msg.new_chat_participant then

					-- I hate typing this out.
					local noob = msg.new_chat_participant

					-- We'll make a new table for the new guy, unless he's also
					-- the original guy.
					if msg.new_chat_participant.id ~= msg.from.id then
						new_user = {}
						new_rank = administration.get_rank(self,noob.id, msg.chat.id, config)
					end

					if new_rank == 0 then
						new_user.do_kick = true
						new_user.dont_unban = true
						new_user.reason = 'banned'
						new_user.output = 'Sorry, you are banned from ' .. msg.chat.title .. '.'
					elseif new_rank == 1 then
						if group.flags[3] and ( -- antisquig++
							noob.name:match(utilities.char.arabic)
							or noob.name:match(utilities.char.rtl_override)
							or noob.name:match(utilities.char.rtl_mark)
						) then
							new_user.do_kick = true
							new_user.reason = 'antisquig++'
							new_user.output = administration.flags[3].kicked:gsub('GROUPNAME', msg.chat.title)
						elseif ( -- antibot
							group.flags[4]
							and noob.username
							and noob.username:match('bot$')
							and rank < 2
						) then
							new_user.do_kick = true
							new_user.reason = 'antibot'
						end
					else
						-- Make the new user a group admin if he's a mod or higher.
						if msg.chat.type == 'supergroup' then
							drua.channel_set_admin(msg.chat.id, msg.new_chat_participant.id, 2)
						end
					end

				elseif msg.new_chat_title then
					if rank < 3 then
						drua.rename_chat(msg.chat.id, group.name)
					else
						group.name = msg.new_chat_title
						if group.grouptype == 'supergroup' then
							administration.update_desc(self, msg.chat.id, config)
						end
					end
				elseif msg.new_chat_photo then
					if group.grouptype == 'group' then
						if rank < 3 then
							drua.set_photo(msg.chat.id, group.photo)
						else
							group.photo = drua.get_photo(msg.chat.id)
						end
					else
						group.photo = drua.get_photo(msg.chat.id)
					end
				elseif msg.delete_chat_photo then
					if group.grouptype == 'group' then
						if rank < 3 then
							drua.set_photo(msg.chat.id, group.photo)
						else
							group.photo = nil
						end
					else
						group.photo = nil
					end
				end

				if new_user ~= user and new_user.do_kick then
					administration.kick_user(self, msg.chat.id, msg.new_chat_participant.id, new_user.reason, config)
					if new_user.output then
						utilities.send_message(self, msg.new_chat_participant.id, new_user.output)
					end
					if not new_user.dont_unban and msg.chat.type == 'supergroup' then
						bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } )
					end
				end

				if group.flags[5] and user.do_kick and not user.dont_unban then
					if group.autokicks[msg.from.id_str] then
						group.autokicks[msg.from.id_str] = group.autokicks[msg.from.id_str] + 1
					else
						group.autokicks[msg.from.id_str] = 1
					end
					if group.autokicks[msg.from.id_str] >= group.autoban then
						group.autokicks[msg.from.id_str] = 0
						group.bans[msg.from.id_str] = true
						user.dont_unban = true
						user.reason = 'antiflood autoban: ' .. user.reason
						user.output = user.output .. '\nYou have been banned for being autokicked too many times.'
					end
				end

				if user.do_kick then
					administration.kick_user(self, msg.chat.id, msg.from.id, user.reason, config)
					if user.output then
						utilities.send_message(self, msg.from.id, user.output)
					end
					if not user.dont_unban and msg.chat.type == 'supergroup' then
						bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } )
					end
				end

				if msg.new_chat_participant and not new_user.do_kick then
					local output = administration.get_desc(self, msg.chat.id, config)
					utilities.send_message(self, msg.new_chat_participant.id, output, true, nil, true)
				end

				-- Last active time for group listing.
				if msg.text:len() > 0 then
					for i,v in pairs(self.database.administration.activity) do
						if v == msg.chat.id_str then
							table.remove(self.database.administration.activity, i)
							table.insert(self.database.administration.activity, 1, msg.chat.id_str)
						end
					end
				end

				return true

			end
		},

		{ -- /groups
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('groups').table,

			command = 'groups',
			privilege = 1,
			interior = false,
			doc = 'Returns a list of administrated groups.',

			action = function(self, msg, group, config)
				local output = ''
				for _,v in ipairs(self.database.administration.activity) do
					local group = self.database.administration.groups[v]
					if not group.flags[1] then -- no unlisted groups
						if group.link then
							output = output ..  '• [' .. utilities.md_escape(group.name) .. '](' .. group.link .. ')\n'
						else
							output = output ..  '• ' .. group.name .. '\n'
						end
					end
				end
				if output == '' then
					output = 'There are currently no listed groups.'
				else
					output = '*Groups:*\n' .. output
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /ahelp
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('ahelp', true).table,

			command = 'ahelp \\[command]',
			privilege = 1,
			interior = false,
			doc = 'Returns a list of realm-related commands for your rank (in a private message), or command-specific help.',

			action = function(self, msg, group, config)
				local rank = administration.get_rank(self, msg.from.id, msg.chat.id, config)
				local input = utilities.get_word(msg.text_lower, 2)
				if input then
					input = input:gsub('^'..config.cmd_pat..'', '')
					local doc
					for _,action in ipairs(administration.commands) do
						if action.keyword == input then
							doc = ''..config.cmd_pat..'' .. action.command:gsub('\\','') .. '\n' .. action.doc
							break
						end
					end
					if doc then
						local output = '*Help for* _' .. input .. '_ :\n```\n' .. doc .. '\n```'
						utilities.send_message(self, msg.chat.id, output, true, nil, true)
					else
						local output = 'Sorry, there is no help for that command.\n'..config.cmd_pat..'ahelp@'..self.info.username
						utilities.send_reply(self, msg, output)
					end
				else
					local output = '*Commands for ' .. administration.ranks[rank] .. ':*\n'
					for i = 1, rank do
						for _, val in ipairs(self.admin_temp.help[i]) do
							output = output .. '• ' .. config.cmd_pat .. val .. '\n'
						end
					end
					output = output .. 'Arguments: <required> \\[optional]'
					if utilities.send_message(self, msg.from.id, output, true, nil, true) then
						if msg.from.id ~= msg.chat.id then
							utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.')
						end
					else
						utilities.send_message(self, msg.chat.id, output, true, nil, true)
					end
				end
			end
		},

		{ -- /ops
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('ops'):t('oplist').table,

			command = 'ops',
			privilege = 1,
			interior = true,
			doc = 'Returns a list of moderators and the governor for the group.',

			action = function(self, msg, group, config)
				local modstring = ''
				for k,_ in pairs(group.mods) do
					modstring = modstring .. administration.mod_format(self, k)
				end
				if modstring ~= '' then
					modstring = '*Moderators for ' .. msg.chat.title .. ':*\n' .. modstring
				end
				local govstring = ''
				if group.governor then
					local gov = self.database.users[tostring(group.governor)]
					govstring = '*Governor:* ' .. utilities.md_escape(utilities.build_name(gov.first_name, gov.last_name)) .. ' `[' .. gov.id .. ']`'
				end
				local output = utilities.trim(modstring) ..'\n\n' .. utilities.trim(govstring)
				if output == '\n\n' then
					output = 'There are currently no moderators for this group.'
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end

		},

		{ -- /desc
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('desc'):t('description').table,

			command = 'description',
			privilege = 1,
			interior = true,
			doc = 'Returns a description of the group (in a private message), including its motd, rules, flags, governor, and moderators.',

			action = function(self, msg, group, config)
				local output = administration.get_desc(self, msg.chat.id, config)
				if utilities.send_message(self, msg.from.id, output, true, nil, true) then
					if msg.from.id ~= msg.chat.id then
						utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.')
					end
				else
					utilities.send_message(self, msg.chat.id, output, true, nil, true)
				end
			end
		},

		{ -- /rules
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('rules?', true).table,

			command = 'rules \\[i]',
			privilege = 1,
			interior = true,
			doc = 'Returns the group\'s list of rules, or a specific rule.',

			action = function(self, msg, group, config)
				local output
				local input = utilities.get_word(msg.text_lower, 2)
				input = tonumber(input)
				if #group.rules > 0 then
					if input and group.rules[input] then
						output = '*' .. input .. '.* ' .. group.rules[input]
					else
						output = '*Rules for ' .. msg.chat.title .. ':*\n'
						for i,v in ipairs(group.rules) do
							output = output .. '*' .. i .. '.* ' .. v .. '\n'
						end
					end
				else
					output = 'No rules have been set for ' .. msg.chat.title .. '.'
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /motd
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('motd').table,

			command = 'motd',
			privilege = 1,
			interior = true,
			doc = 'Returns the group\'s message of the day.',

			action = function(self, msg, group, config)
				local output = 'No MOTD has been set for ' .. msg.chat.title .. '.'
				if group.motd then
					output = '*MOTD for ' .. msg.chat.title .. ':*\n' .. group.motd
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /link
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('link').table,

			command = 'link',
			privilege = 1,
			interior = true,
			doc = 'Returns the group\'s link.',

			action = function(self, msg, group, config)
				local output = 'No link has been set for ' .. msg.chat.title .. '.'
				if group.link then
					output = '[' .. msg.chat.title .. '](' .. group.link .. ')'
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /kickme
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('leave'):t('kickme').table,

			command = 'kickme',
			privilege = 1,
			interior = true,
			doc = 'Removes the user from the group.',

			action = function(self, msg, group, config)
				if administration.get_rank(self, msg.from.id, nil, config) == 5 then
					utilities.send_reply(self, msg, 'I can\'t let you do that, '..msg.from.name..'.')
				else
					administration.kick_user(self, msg.chat.id, msg.from.id, 'kickme', config)
					utilities.send_message(self, msg.chat.id, 'Goodbye, ' .. msg.from.name .. '!', true)
					if msg.chat.type == 'supergroup' then
						bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } )
					end
				end
			end
		},

		{ -- /kick
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('kick', true).table,

			command = 'kick <user>',
			privilege = 2,
			interior = true,
			doc = 'Removes a user from the group. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				elseif target.rank > 1 then
					utilities.send_reply(self, msg, target.name .. ' is too privileged to be kicked.')
				else
					administration.kick_user(self, msg.chat.id, target.id, 'kicked by ' .. msg.from.name, config)
					utilities.send_message(self, msg.chat.id, target.name .. ' has been kicked.')
					if msg.chat.type == 'supergroup' then
						bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } )
					end
				end
			end
		},

		{ -- /ban
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('ban', true).table,

			command = 'ban <user>',
			privilege = 2,
			interior = true,
			doc = 'Bans a user from the group. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				elseif target.rank > 1 then
					utilities.send_reply(self, msg, target.name .. ' is too privileged to be banned.')
				elseif group.bans[target.id_str] then
					utilities.send_reply(self, msg, target.name .. ' is already banned.')
				else
					administration.kick_user(self, msg.chat.id, target.id, 'banned by '..msg.from.name, config)
					utilities.send_reply(self, msg, target.name .. ' has been banned.')
					group.bans[target.id_str] = true
				end
			end
		},

		{ -- /unban
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('unban', true).table,

			command = 'unban <user>',
			privilege = 2,
			interior = true,
			doc = 'Unbans a user from the group. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					if not group.bans[target.id_str] then
						utilities.send_reply(self, msg, target.name .. ' is not banned.')
					else
						group.bans[target.id_str] = nil
						utilities.send_reply(self, msg, target.name .. ' has been unbanned.')
					end
					if msg.chat.type == 'supergroup' then
						bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } )
					end
				end
			end
		},

		{ -- /setrules
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('setrules', true).table,

			command = 'setrules <rules>',
			privilege = 3,
			interior = true,
			doc = 'Sets the group\'s rules. Rules will be automatically numbered. Separate rules with a new line. Markdown is supported. Pass "--" to delete the rules.',

			action = function(self, msg, group, config)
				local input = msg.text:match('^'..config.cmd_pat..'setrules[@'..self.info.username..']*(.+)')
				if input == ' --' or input == ' ' .. utilities.char.em_dash then
					group.rules = {}
					utilities.send_reply(self, msg, 'The rules have been cleared.')
				elseif input then
					group.rules = {}
					input = utilities.trim(input) .. '\n'
					local output = '*Rules for ' .. msg.chat.title .. ':*\n'
					local i = 1
					for l in input:gmatch('(.-)\n') do
						output = output .. '*' .. i .. '.* ' .. l .. '\n'
						i = i + 1
						table.insert(group.rules, utilities.trim(l))
					end
					utilities.send_message(self, msg.chat.id, output, true, nil, true)
				else
					utilities.send_reply(self, msg, 'Please specify the new rules.')
				end
			end
		},

		{ -- /changerule
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('changerule', true).table,

			command = 'changerule <i> <rule>',
			privilege = 3,
			interior = true,
			doc = 'Changes a single rule. Pass "--" to delete the rule. If i is a number for which there is no rule, adds a rule by the next incremented number.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text)
				local output = 'usage: `'..config.cmd_pat..'changerule <i> <newrule>`'
				if input then
					local rule_num = tonumber(input:match('^%d+'))
					local new_rule = utilities.input(input)
					if not rule_num then
						output = 'Please specify which rule you want to change.'
					elseif not new_rule then
						output = 'Please specify the new rule.'
					elseif new_rule == '--' or new_rule == utilities.char.em_dash then
						if group.rules[rule_num] then
							table.remove(group.rules, rule_num)
							output = 'That rule has been deleted.'
						else
							output = 'There is no rule with that number.'
						end
					else
						if not group.rules[rule_num] then
							rule_num = #group.rules + 1
						end
						group.rules[rule_num] = new_rule
						output = '*' .. rule_num .. '*. ' .. new_rule
					end
				end
				utilities.send_reply(self, msg, output, true)
			end
		},

		{ -- /setmotd
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('setmotd', true).table,

			command = 'setmotd <motd>',
			privilege = 2,
			interior = true,
			doc = 'Sets the group\'s message of the day. Markdown is supported. Pass "--" to delete the message.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text)
				if not input and msg.reply_to_message and msg.reply_to_message.text:len() > 0 then
					input = msg.reply_to_message.text
				end
				if input then
					if input == '--' or input == utilities.char.em_dash then
						group.motd = nil
						utilities.send_reply(self, msg, 'The MOTD has been cleared.')
					else
						input = utilities.trim(input)
						group.motd = input
						local output = '*MOTD for ' .. msg.chat.title .. ':*\n' .. input
						utilities.send_message(self, msg.chat.id, output, true, nil, true)
					end
					if group.grouptype == 'supergroup' then
						administration.update_desc(self, msg.chat.id, config)
					end
				else
					utilities.send_reply(self, msg, 'Please specify the new message of the day.')
				end
			end
		},

		{ -- /setlink
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('setlink', true).table,

			command = 'setlink <link>',
			privilege = 3,
			interior = true,
			doc = 'Sets the group\'s join link. Pass "--" to regenerate the link.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text)
				if input == '--' or input == utilities.char.em_dash then
					group.link = drua.export_link(msg.chat.id)
					utilities.send_reply(self, msg, 'The link has been regenerated.')
				elseif input then
					group.link = input
					local output = '[' .. msg.chat.title .. '](' .. input .. ')'
					utilities.send_message(self, msg.chat.id, output, true, nil, true)
				else
					utilities.send_reply(self, msg, 'Please specify the new link.')
				end
			end
		},

		{ -- /alist
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('alist').table,

			command = 'alist',
			privilege = 3,
			interior = true,
			doc = 'Returns a list of administrators. Owner is denoted with a star character.',

			action = function(self, msg, config)
				local output = '*Administrators:*\n'
				output = output .. administration.mod_format(self, config.admin):gsub('\n', ' ★\n')
				for id,_ in pairs(self.database.administration.admins) do
					output = output .. administration.mod_format(self, id)
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /flags
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('flags?', true).table,

			command = 'flag \\[i]',
			privilege = 3,
			interior = true,
			doc = 'Returns a list of flags or toggles the specified flag.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text)
				if input then
					input = utilities.get_word(input, 1)
					input = tonumber(input)
					if not input or not administration.flags[input] then
						input = false
					end
				end
				if not input then
					local output = '*Flags for ' .. msg.chat.title .. ':*\n'
					for i,v in ipairs(administration.flags) do
						local status = group.flags[i] or false
						output = output .. '`[' .. i .. ']` *' .. v.name .. '*` = ' .. tostring(status) .. '`\n• ' .. v.desc .. '\n'
					end
					utilities.send_message(self, msg.chat.id, output, true, nil, true)
				elseif group.flags[input] == true then
					group.flags[input] = false
					utilities.send_reply(self, msg, administration.flags[input].disabled)
				else
					group.flags[input] = true
					utilities.send_reply(self, msg, administration.flags[input].enabled)
				end
			end
		},

		{ -- /antiflood
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('antiflood', true).table,

			command = 'antiflood \\[<type> <i>]',
			privilege = 3,
			interior = true,
			doc = 'Returns a list of antiflood values or sets one.',

			action = function(self, msg, group, config)
				if not group.flags[5] then
					utilities.send_message(self, msg.chat.id, 'antiflood is not enabled. Use `'..config.cmd_pat..'flag 5` to enable it.', true, nil, true)
				else
					if not group.antiflood then
						group.antiflood = JSON.decode(JSON.encode(administration.antiflood))
					end
					local input = utilities.input(msg.text_lower)
					local output
					if input then
						local key, val = input:match('(%a+) (%d+)')
						if not key or not val or not tonumber(val) then
							output = 'Not a valid message type or number.'
						elseif key == 'autoban' then
							group.autoban = tonumber(val)
							output = 'Users will now be autobanned after *' .. val .. '* autokicks.'
						else
							group.antiflood[key] = tonumber(val)
							output = '*' .. key:gsub('^%l', string.upper) .. '* messages are now worth *' .. val .. '* points.'
						end
					else
						output = 'usage: `'..config.cmd_pat..'antiflood <type> <i>`\nexample: `'..config.cmd_pat..'antiflood text 5`\nUse this command to configure the point values for each message type. When a user reaches 100 points, he is kicked. The points are reset each minute. The current values are:\n'
						for k,v in pairs(group.antiflood) do
							output = output .. '*'..k..':* `'..v..'`\n'
						end
						output = output .. 'Users will be banned automatically after *' .. group.autoban .. '* autokicks. Configure this with the *autoban* keyword.'
					end
					utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true)
				end
			end
		},

		{ -- /mod
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('mod', true).table,

			command = 'mod <user>',
			privilege = 3,
			interior = true,
			doc = 'Promotes a user to a moderator. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					if target.rank > 1 then
						utilities.send_reply(self, msg, target.name .. ' is already a moderator or greater.')
					else
						group.bans[target.id_str] = nil
						group.mods[target.id_str] = true
						utilities.send_reply(self, msg, target.name .. ' is now a moderator.')
					end
					if group.grouptype == 'supergroup' then
						drua.channel_set_admin(msg.chat.id, target.id, 2)
					end
				end
			end
		},

		{ -- /demod
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('demod', true).table,

			command = 'demod <user>',
			privilege = 3,
			interior = true,
			doc = 'Demotes a moderator to a user. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					if not group.mods[target.id_str] then
						utilities.send_reply(self, msg, target.name .. ' is not a moderator.')
					else
						group.mods[target.id_str] = nil
						utilities.send_reply(self, msg, target.name .. ' is no longer a moderator.')
					end
					if group.grouptype == 'supergroup' then
						drua.channel_set_admin(msg.chat.id, target.id, 0)
					end
				end
			end
		},

		{ -- /gov
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('gov', true).table,

			command = 'gov <user>',
			privilege = 4,
			interior = true,
			doc = 'Promotes a user to the governor. The current governor will be replaced. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					if group.governor == target.id then
						utilities.send_reply(self, msg, target.name .. ' is already the governor.')
					else
						group.bans[target.id_str] = nil
						group.mods[target.id_str] = nil
						group.governor = target.id
						utilities.send_reply(self, msg, target.name .. ' is the new governor.')
					end
					if group.grouptype == 'supergroup' then
						drua.channel_set_admin(msg.chat.id, target.id, 2)
						administration.update_desc(self, msg.chat.id, config)
					end
				end
			end
		},

		{ -- /degov
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('degov', true).table,

			command = 'degov <user>',
			privilege = 4,
			interior = true,
			doc = 'Demotes the governor to a user. The administrator will become the new governor. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					if group.governor ~= target.id then
						utilities.send_reply(self, msg, target.name .. ' is not the governor.')
					else
						group.governor = msg.from.id
						utilities.send_reply(self, msg, target.name .. ' is no longer the governor.')
					end
					if group.grouptype == 'supergroup' then
						drua.channel_set_admin(msg.chat.id, target.id, 0)
						administration.update_desc(self, msg.chat.id, config)
					end
				end
			end
		},

		{ -- /hammer
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('hammer', true).table,

			command = 'hammer <user>',
			privilege = 4,
			interior = false,
			doc = 'Bans a user from all groups. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				elseif target.rank > 3 then
					utilities.send_reply(self, msg, target.name .. ' is too privileged to be globally banned.')
				elseif self.database.blacklist[target.id_str] then
					utilities.send_reply(self, msg, target.name .. ' is already globally banned.')
				else
					administration.kick_user(self, msg.chat.id, target.id, 'hammered by '..msg.from.name, config)
					self.database.blacklist[target.id_str] = true
					for k,v in pairs(self.database.administration.groups) do
						if not v.flags[6] then
							v.mods[target.id_str] = nil
							drua.kick_user(k, target.id)
						end
					end
					local output = target.name .. ' has been globally banned.'
					if group.flags[6] == true then
						group.mods[target.id_str] = nil
						group.bans[target.id_str] = true
						output = target.name .. ' has been globally and locally banned.'
					end
					utilities.send_reply(self, msg, output)
				end
			end
		},

		{ -- /unhammer
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('unhammer', true).table,

			command = 'unhammer <user>',
			privilege = 4,
			interior = false,
			doc = 'Removes a global ban. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				elseif not self.database.blacklist[target.id_str] then
					utilities.send_reply(self, msg, target.name .. ' is not globally banned.')
				else
					self.database.blacklist[target.id_str] = nil
					utilities.send_reply(self, msg, target.name .. ' has been globally unbanned.')
				end
				if msg.chat.type == 'supergroup' then
					bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } )
				end
			end
		},

		{ -- /admin
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('admin', true).table,

			command = 'admin <user>',
			privilege = 5,
			interior = false,
			doc = 'Promotes a user to an administrator. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				elseif target.rank >= 4 then
					utilities.send_reply(self, msg, target.name .. ' is already an administrator or greater.')
				else
					for _,g in pairs(self.database.administration.groups) do
						g.mods[target.id_str] = nil
					end
					self.database.administration.admins[target.id_str] = true
					utilities.send_reply(self, msg, target.name .. ' is now an administrator.')
				end
				if group.grouptype == 'supergroup' then
					drua.channel_set_admin(msg.chat.id, target.id, 2)
				end
			end
		},

		{ -- /deadmin
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('deadmin', true).table,

			command = 'deadmin <user>',
			privilege = 5,
			interior = false,
			doc = 'Demotes an administrator to a user. The target may be specified via reply, username, or ID.',

			action = function(self, msg, group, config)
				local target = administration.get_target(self, msg, config)
				if target.err then
					utilities.send_reply(self, msg, target.err)
				else
					for chat_id, group in pairs(self.database.administration.groups) do
						if group.grouptype == 'supergroup' then
							drua.channel_set_admin(chat_id, target.id, 0)
						end
					end
					if target.rank ~= 4 then
						utilities.send_reply(self, msg, target.name .. ' is not an administrator.')
					else
						self.database.administration.admins[target.id_str] = nil
						utilities.send_reply(self, msg, target.name .. ' is no longer an administrator.')
					end
				end
			end
		},

		{ -- /gadd
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('gadd', true).table,

			command = 'gadd [i] ...',
			privilege = 5,
			interior = false,
			doc = 'Adds a group to the administration system. Pass numbers as arguments to enable those flags immediately. For example, this would add the group and enable the unlisted flag, antibot, and antiflood:\n/gadd 1 4 5',

			action = function(self, msg, group, config)
				if msg.chat.id == msg.from.id then
					utilities.send_message(self, msg.chat.id, 'No.')
				elseif self.database.administration.groups[msg.chat.id_str] then
					utilities.send_reply(self, msg, 'I am already administrating this group.')
				else
					local flags = {}
					for i = 1, #administration.flags do
						flags[i] = false
					end
					local input = utilities.input(msg.text)
					if input then
						local index = utilities.index(input)
						for _, i in ipairs(index) do
							i = tonumber(i)
							if i and i < #administration.flags and i > 0 then
								flags[i] = true
							end
						end
					end
					self.database.administration.groups[msg.chat.id_str] = {
						mods = {},
						governor = msg.from.id,
						bans = {},
						flags = flags,
						rules = {},
						grouptype = msg.chat.type,
						name = msg.chat.title,
						link = drua.export_link(msg.chat.id),
						photo = drua.get_photo(msg.chat.id),
						founded = os.time(),
						autokicks = {},
						autoban = 3
					}
					administration.update_desc(self, msg.chat.id, config)
					table.insert(self.database.administration.activity, msg.chat.id_str)
					utilities.send_reply(self, msg, 'I am now administrating this group.')
					drua.channel_set_admin(msg.chat.id, self.info.id, 2)
				end
			end
		},

		{ -- /grem
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('grem', true):t('gremove', true).table,

			command = 'gremove \\[chat]',
			privilege = 5,
			interior = false,
			doc = 'Removes a group from the administration system.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text) or msg.chat.id_str
				local output
				if self.database.administration.groups[input] then
					local chat_name = self.database.administration.groups[input].name
					self.database.administration.groups[input] = nil
					for i,v in ipairs(self.database.administration.activity) do
						if v == input then
							table.remove(self.database.administration.activity, i)
						end
					end
					output = 'I am no longer administrating _' .. utilities.md_escape(chat_name) .. '_.'
				else
					if input == msg.chat.id_str then
						output = 'I do not administrate this group.'
					else
						output = 'I do not administrate that group.'
					end
				end
				utilities.send_message(self, msg.chat.id, output, true, nil, true)
			end
		},

		{ -- /glist
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('glist', false).table,

			command = 'glist',
			privilege = 5,
			interior = false,
			doc = 'Returns a list (in a private message) of all administrated groups with their governors and links.',

			action = function(self, msg, group, config)
				local output = ''
				if utilities.table_size(self.database.administration.groups) > 0 then
					for k,v in pairs(self.database.administration.groups) do
						output = output .. '[' .. utilities.md_escape(v.name) .. '](' .. v.link .. ') `[' .. k .. ']`\n'
						if v.governor then
							local gov = self.database.users[tostring(v.governor)]
							output = output .. '★ ' .. utilities.md_escape(utilities.build_name(gov.first_name, gov.last_name)) .. ' `[' .. gov.id .. ']`\n'
						end
					end
				else
					output = 'There are no groups.'
				end
				if utilities.send_message(self, msg.from.id, output, true, nil, true) then
					if msg.from.id ~= msg.chat.id then
						utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.')
					end
				end
			end
		},

		{ -- /broadcast
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('broadcast', true).table,

			command = 'broadcast <message>',
			privilege = 5,
			interior = false,
			doc = 'Broadcasts a message to all administrated groups.',

			action = function(self, msg, group, config)
				local input = utilities.input(msg.text)
				if not input then
					utilities.send_reply(self, msg, 'Give me something to broadcast.')
				else
					input = '*Admin Broadcast:*\n' .. input
					for id,_ in pairs(self.database.administration.groups) do
						utilities.send_message(self, id, input, true, nil, true)
					end
				end
			end
		},

		{ -- /buildwall :^)
			triggers = utilities.triggers(self_.info.username, config.cmd_pat):t('buildwall').table,
			privilege = 3,
			interior = true,
			action = function(self, msg, group, config)
				for i = 2, 5 do
					group.flags[i] = true
				end
				utilities.send_message(self, msg.chat.id, 'antisquig, antisquig++, antibot, and antiflood have been enabled.')
			end
		}

	}

	-- These could be merged, but load time doesn't matter.

	-- Generate trigger table.
	administration.triggers = {}
	for _, command in ipairs(administration.commands) do
		for _, trigger in ipairs(command.triggers) do
			table.insert(administration.triggers, trigger)
		end
	end

	-- Generate help messages.
	self_.database.administration.help = {}
	for i,_ in ipairs(administration.ranks) do
		self_.admin_temp.help[i] = {}
	end
	for _,v in ipairs(administration.commands) do
		if v.command then
			table.insert(self_.admin_temp.help[v.privilege], v.command)
		end
	end

	-- Generate ahelp keywords.
	for _,v in ipairs(administration.commands) do
		if v.command and v.doc then
			v.keyword = utilities.get_word(v.command, 1)
		end
	end
end

function administration:action(msg, config)
	for _,command in ipairs(administration.commands) do
		for _,trigger in pairs(command.triggers) do
			if msg.text_lower:match(trigger) then
				if command.interior and not self.database.administration.groups[msg.chat.id_str] then
					break
				end
				if administration.get_rank(self, msg.from.id, msg.chat.id, config) < command.privilege then
					break
				end
				local res = command.action(self, msg, self.database.administration.groups[msg.chat.id_str], config)
				if res ~= true then
					return res
				end
			end
		end
	end
	return true
end

function administration:cron()
	self.admin_temp.flood = {}
	if os.date('%d') ~= self.database.administration.autokick_timer then
		self.database.administration.autokick_timer = os.date('%d')
		for _,v in pairs(self.database.administration.groups) do
			v.autokicks = {}
		end
	end
end

administration.command = 'groups'

return administration