--[[

        cmd_ban.lua v0.12 by blastbeat modified by pulsar

        - this script adds a command "ban" to ban users by sid/nick/cid
        - usage: [+!#]ban sid|nick|cid <SID>|<nick>|<CID> [<time> <reason>]
        - <time> are ban minutes; negative values means ban forever
        - <time> and <reason> are optional

        - changelog 0.12:
          - updated script api
          - regged hubcommand

        - changelog 0.11:
          - some clean ups

        - changelog 0.10:
          - added language module

        - changelog 0.09:
          - added usercommand

        - changelog 0.08:
          - added english and german language files

        - changelog 0.07:
          - added report function, removed opchat, some clean up

        - changelog 0.06:
          - updated script api, cached table lookups, cleaned up code

        - changelog 0.05:
          - added by_level to ban table

        - changelog 0.04:
          - renamend to cmd_ban.lua

        - changelog 0.03:
          - added ban by nick and cid
          - added perm ban via negative ban time
          - added public interface to banfile

        - changelog 0.02:
          - fixed typo
          - added opchat setting

]]--


--// settings begin //--

local scriptname = "cmd_ban"
local scriptversion = "0.12"

local cmd = "ban"    -- name of the command
local bans_path = "scripts/cmd_ban/bans.tbl"
local default_time = 20    -- default ban time are 20 minutes

local report = true    -- send status report?

local permission = {

    --// [ user_level = level means user_level can ban users with level max //--

    --[ 40 ] = 10,  -- svip to guest
    [ 60 ] = 50,  -- operator to server
    [ 70 ] = 60,  -- supervisor to operator
    [ 80 ] = 70,  -- admin to supervisor
    [ 100 ] = 100,  -- hubowner can ban all

}

local llevel = 60    -- minimum level to get a report
local minlevel = 40    -- min level to use this cmd (according permission table)

--// settings end //--

local bans = util.loadtable( bans_path ) or { }    -- load bans

--// caching table lookups //--

local os_date = os.date
local os_time = os.time
local utf_match = utf.match
local utf_format = utf.format
local os_difftime = os.difftime
local table_remove = table.remove
local util_savearray = util.savearray

local hub_getbot = hub.getbot
local hub_escapeto = hub.escapeto
local hub_escapefrom = hub.escapefrom
local hub_issidonline = hub.issidonline
local hub_iscidonline = hub.iscidonline
local hub_isnickonline = hub.isnickonline

local report_send

--// language //--

local scriptlang = cfg.get "language"

local lang, err = cfg.loadlanguage( scriptlang, scriptname ); lang = lang or { }; err = err and hub.debug( err )

local msg_denied = lang.msg_denied or "You are not allowed to use this command."
local msg_import = lang.msg_import or "Error while importing additional module."
local msg_reason = lang.msg_reason or "No reason."
local msg_usage = lang.msg_usage or "Usage: [+!#]ban sid|nick|cid <sid>|<nick>|<cid> [<time> <reason>]"
local msg_off = lang.msg_off or "User not found."
local msg_god = lang.msg_god or "You cannot ban gods."
local msg_ban = lang.msg_ban or "%s %s is banned here. Remaining ban time in seconds: "    -- do not delete '%s'!
local msg_ok = lang.msg_ok or "%s was banned by %s for %s minutes because: %s"

local help_title = lang.help_title or "ban"
local help_usage = lang.help_usage or "[+!#]ban sid|nick|cid <sid>|<nick>|<cid> [<time> <reason>]"
local help_desc = lang.help_desc or "bans user; <time> are ban minutes; negative values means ban forever"

--local ucmd_menu = lang.ucmd_menu or { "Ban user" }
local ucmd_menu1 = lang.ucmd_menu1 or { "Ban", "1 hour" }
local ucmd_menu2 = lang.ucmd_menu2 or { "Ban", "2 hours" }
local ucmd_menu3 = lang.ucmd_menu3 or { "Ban", "6 hours" }
local ucmd_menu4 = lang.ucmd_menu4 or { "Ban", "12 hours" }
local ucmd_menu5 = lang.ucmd_menu5 or { "Ban", "1 day" }
local ucmd_menu6 = lang.ucmd_menu6 or { "Ban", "2 days" }
local ucmd_menu7 = lang.ucmd_menu7 or { "Ban", "1 week" }
local ucmd_menu8 = lang.ucmd_menu8 or { "Ban", "other" }

local ucmd_time = lang.ucmd_time or "Time in minutes"
local ucmd_reason = lang.ucmd_reason or "Reason"

local hubcmd

local onbmsg = function( user, command, parameters )
    local hubbot = hub_getbot( )
    local level = user:level( )
    if not permission[ level ] then
        user:reply( msg_denied, hubbot )
        return PROCESSED
    end    
    local by, id = utf_match( parameters, "^(%S+) (%S+)" )
    local time = tonumber( utf_match( parameters, "^%S+ %S+ ([-]?%d+)" ) )
    local reason = ( time and utf_match( parameters, "^%S+ %S+ [-]?%d+ (.*)" ) ) or ( ( time == nil ) and utf_match( parameters, "^%S+ %S+ (.*)" ) )
    if not ( ( by == "sid" or by == "nick" or by == "cid" ) and id ) then
        user:reply( msg_usage, hubbot )
        return PROCESSED
    end
    local target = (
    by == "nick" and hub_isnickonline( id ) ) or
    ( by == "sid" and hub_issidonline( id ) ) or
    ( by == "cid" and hub_iscidonline( id ) )
    if not target then
        user:reply( msg_off, hubbot )
        return PROCESSED
    end
    if permission[ level ] < target:level( ) then
        user:reply( msg_god, hubbot )
        return PROCESSED
    end
    time = time or default_time
    reason = reason or msg_reason
    local bantime = time * 60
    local targetnick = target:nick( )
    local usernick = hub_escapefrom( user:nick( ) )
    local message = utf_format( msg_ok, hub_escapefrom( targetnick ), usernick, time, reason ) 
    bans[ #bans + 1 ] = {

        nick = targetnick,
        cid = target:cid( ),
        hash = target:hash( ),
        ip = target:ip( ),
        time = bantime,
        start = os_time( os_date( "*t" ) ),
        reason = reason,
        by_nick = user:nick( ),
        by_level = level

    }
    util_savearray( bans, bans_path )
    --target:reply( message, hubbot )
    local _ = report and report_send( message, llevel, nil, hubbot, hubbot )
    target:kill( "ISTA 230 " .. hub_escapeto( message ) .. " TL" .. bantime .. "\n" )
    user:reply( message, hubbot )
    return PROCESSED
end

hub.setlistener( "onConnect", { },
    function( user )
        local nick, cid, hash, ip = user:nick( ), user:cid( ), user:hash( ), user:ip( )
        local what, key, ban
        for i, bantbl in ipairs( bans ) do
            key = i
            ban = bantbl
            if ban.nick == nick then
                what = "nick"
                break
            elseif ban.cid == cid and ban.hash == hash then
                what = "cid"
                break
            elseif ban.ip == ip then
                what = "ip"
                break
            end
        end
        if what then
            local remaining, bantime, banstart = nil, tonumber( ban.time ), tonumber( ban.start )
            if bantime < 0 then
                remaining = 1    -- ban 1 sec forever ^^
            else
                remaining = ban.time - os_difftime( os_time( ), banstart )
            end
            if remaining > 0 then
                local message = utf_format( msg_ban, ban[ what ] ) .. remaining
                user:kill( "ISTA 231 " .. hub_escapeto( message ) .. " TL" .. remaining .. "\n" )
                return PROCESSED
            else
                table_remove( bans, key )
                util_savearray( bans, bans_path )
            end
        end
        return nil
    end
)

hub.setlistener( "onStart", { },
    function( )
        local etc_report = hub.import "etc_report"    -- import the report tool
        if not etc_report and report then
            error( msg_import )
        else
            report_send = etc_report.send
        end
        local help = hub.import "cmd_help"
        if help then
            help.reg( help_title, help_usage, help_desc, minlevel )    -- reg help
        end
        local ucmd = hub.import "etc_usercommands"    -- add usercommand
        if ucmd then
            --ucmd.add( ucmd_menu, cmd, { "sid", "%[userSID]", "%[line:" .. ucmd_time .. "]", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu1, cmd, { "sid", "%[userSID]", "60", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu2, cmd, { "sid", "%[userSID]", "120", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu3, cmd, { "sid", "%[userSID]", "360", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu4, cmd, { "sid", "%[userSID]", "720", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu5, cmd, { "sid", "%[userSID]", "1440", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu6, cmd, { "sid", "%[userSID]", "2880", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu7, cmd, { "sid", "%[userSID]", "10080", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
            ucmd.add( ucmd_menu8, cmd, { "sid", "%[userSID]", "%[line:" .. ucmd_time .. "]", "%[line:" .. ucmd_reason .. "]" }, { "CT2" }, minlevel )
        end
        hubcmd = hub.import "etc_hubcommands"    -- add hubcommand
        assert( hubcmd )
        assert( hubcmd.add( cmd, onbmsg ) )
        return nil
    end
)

hub.debug( "** Loaded "..scriptname.." "..scriptversion.." **" )

--// public //--

return {    -- export bans

    bans = bans,
    bans_path = bans_path,

}