chiark / gitweb /
Split IRC core stuff off ?
[ircbot] / bot.tcl
diff --git a/bot.tcl b/bot.tcl
index 0733d2c3fb5470eb89b0a6feae8c9d553da5d868..da2a4728978226e8558288b2787eba167c2330aa 100755 (executable)
--- a/bot.tcl
+++ b/bot.tcl
 # Core bot code
 
-proc defset {varname val} {
-    upvar #0 $varname var
-    if {![info exists var]} { set var $val }
-}
-
-# must set host
-defset port 6667
-
-defset nick testbot
-defset ownfullname "testing bot"
-defset ownmailaddr test-irc-bot@example.com
-
-defset musthaveping_ms 10000
-defset out_maxburst 6
-defset out_interval 2100
-defset out_lag_lag 5000
-defset out_lag_very 25000
-
-defset marktime_min 300
-defset marktime_join_startdelay 5000
-
-proc manyset {list args} {
-    foreach val $list var $args {
-       upvar 1 $var my
-       set my $val
-    }
-}
-
-proc try_except_finally {try except finally} {
-    global errorInfo errorCode
-    set er [catch { uplevel 1 $try } emsg]
-    if {$er} {
-       set ei $errorInfo
-       set ec $errorCode
-       if {[catch { uplevel 1 $except } emsg3]} {
-           append ei "\nALSO ERROR HANDLING ERROR:\n$emsg3"
-       }
-    }
-    set er2 [catch { uplevel 1 $finally } emsg2]
-    if {$er} {
-       if {$er2} {
-           append ei "\nALSO ERROR CLEANING UP:\n$emsg2"
-       }
-       return -code $er -errorinfo $ei -errorcode $ec $emsg
-    } elseif {$er2} {
-       return -code $er2 -errorinfo $errorInfo -errorcode $errorCode $emsg2
-    } else {
-       return $emsg
-    }
-}
+source irccore.tcl
 
-proc out__vars {} {
-    uplevel 1 {
-       global out_queue out_creditms out_creditat out_interval out_maxburst
-       global out_lag_lag out_lag_very
-#set pr [lindex [info level 0] 0]
-#puts $pr>[clock seconds]|$out_creditat|$out_creditms|[llength $out_queue]<
-    }
-}
-
-proc out_lagged {} {
-    out__vars
-    if {[llength $out_queue]*$out_interval > $out_lag_very} {
-       return 2
-    } elseif {[llength $out_queue]*$out_interval > $out_lag_lag} {
+proc unlogged_content_msg {prefix params} {
+    if {![regexp {^[&#+!]} [lindex $params 0]] ||
+        [regexp {^![a-z][-a-z]*[a-z]( .*)?$} [lindex $params 1]]} {
        return 1
-    } else {
-       return 0
-    }
-}
-
-proc out_restart {} {
-    out__vars
-    
-    set now [clock seconds]
-    incr out_creditms [expr {($now - $out_creditat) * 1000}]
-    set out_creditat $now
-    if {$out_creditms > $out_maxburst*$out_interval} {
-       set out_creditms [expr {$out_maxburst*$out_interval}]
-    }
-    out_runqueue $now
-}
-
-proc out_runqueue {now} {
-    global sock
-    out__vars
-    
-    while {[llength $out_queue] && $out_creditms >= $out_interval} {
-#puts rq>$now|$out_creditat|$out_creditms|[llength $out_queue]<
-       manyset [lindex $out_queue 0] orgwhen msg
-       set out_queue [lrange $out_queue 1 end]
-       if {[llength $out_queue]} {
-           append orgwhen "+[expr {$now - $orgwhen}]"
-           append orgwhen "([llength $out_queue])"
-       }
-       puts "$orgwhen -> $msg"
-       puts $sock $msg
-       incr out_creditms -$out_interval
-    }
-    if {[llength $out_queue]} {
-       after $out_interval out_nextmessage
-    }
-}
-
-proc out_nextmessage {} {
-    out__vars
-    set now [clock seconds]
-    incr out_creditms $out_interval
-    set out_creditat $now
-    out_runqueue $now
-}
-
-proc sendout_priority {priority command args} {
-    global sock out_queue
-    if {[llength $args]} {
-       set la [lindex $args end]
-       set args [lreplace $args end end]
-       foreach i $args {
-           if {[regexp {[: ]} $i]} {
-               error "bad argument in output $i ($command $args)"
-           }
-       }
-       lappend args :$la
-    }
-    set args [lreplace $args 0 -1 $command]
-    set string [join $args { }]
-    set now [clock seconds]
-    set newe [list $now $string]
-    if {$priority} {
-       set out_queue [concat [list $newe] $out_queue]
-    } else {
-       lappend out_queue $newe
-    }
-    if {[llength $out_queue] == 1} {
-       out_restart
     }
+    # on-channel message, ignore
+    set chan [lindex $params 0]
+    upvar #0 chan_lastactivity([irctolower $chan]) la
+    set la [clock seconds]
+    catch { recordlastseen_p $prefix "talking on $chan" 1 }
+    return
 }
 
-proc sendout {command args} { eval sendout_priority [list 0 $command] $args }
-    
-proc log {data} {
-    puts $data
-}
-
-proc logerror {data} {
-    log $data
-}
-
-proc saveeic {} {
-    global saveei saveec errorInfo errorCode
-
-    set saveei $errorInfo
-    set saveec $errorCode
-
-    puts ">$saveec|$saveei<"
-}
-
-proc bgerror {msg} {
-    global save
-    logerror $msg
-    saveeic
-}
-
-proc onread {args} {
-    global sock nick calling_nick errorInfo errorCode
-    
-    if {[gets $sock line] == -1} { fail "EOF/error on input" }
-    regsub -all "\[^ -\176\240-\376\]" $line ? line
-    set org $line
-    
-    set ei $errorInfo
-    set ec $errorCode
-    catch { unset calling_nick }
-    set errorInfo $ei
-    set errorCode $ec
-    
-    if {[regexp -nocase {^:([^ ]+) (.*)} $line dummy prefix remain]} {
-       set line $remain
-       if {[regexp {^([^!]+)!} $prefix dummy maybenick]} {
-           set calling_nick $maybenick
-           if {"[irctolower $maybenick]" == "[irctolower $nick]"} return
-       }
-    } else {
-       set prefix {}
-    }
-    if {![string length $line]} { return }
-    if {![regexp -nocase {^([0-9a-z]+) *(.*)} $line dummy command line]} {
-       log "bad command: $org"
-       return
-    }
-    set command [string toupper $command]
-    set params {}
-    while {[regexp {^([^ :]+) *(.*)} $line dummy thisword line]} {
-       lappend params $thisword
-    }
-    if {[regexp {^:(.*)} $line dummy thisword]} {
-       lappend params $thisword
-    } elseif {[string length $line]} {
-       log "junk at end: $org"
-       return
-    }
-    if {"$command" == "PRIVMSG" &&
-        [regexp {^[&#+!]} [lindex $params 0]] &&
-        ![regexp {^![a-z][-a-z]*[a-z]( .*)?$} [lindex $params 1]]} {
-       # on-channel message, ignore
-       set chan [lindex $params 0]
-       upvar #0 chan_lastactivity([irctolower $chan]) la
-       set la [clock seconds]
-       catch { recordlastseen_p $prefix "talking on $chan" 1 }
-       return
-    }
-    log "[clock seconds] <- $org"
-    set procname msg_$command
-    if {[catch { info body $procname }]} { return }
-    if {[catch {
-       eval [list $procname $prefix $command] $params
-    } emsg]} {
-       logerror "error: $emsg ($prefix $command $params)"
-       saveeic
-    }
-}
-
-proc sendprivmsg {dest l} {
-    foreach v [split $l "\n"] {
-       sendout [expr {[ischan $dest] ? "PRIVMSG" : "NOTICE"}] $dest $v
-    }
-}
-proc sendaction_priority {priority dest what} {
-    sendout_priority $priority PRIVMSG $dest "\001ACTION $what\001"
-}
-proc msendprivmsg {dest ll} { foreach l $ll { sendprivmsg $dest $l } }
-proc msendprivmsg_delayed {delay dest ll} { after $delay [list msendprivmsg $dest $ll] }
+proc usererror {emsg} { error $emsg {} {BLIGHT USER} }
 
 proc prefix_none {} {
     upvar 1 p p
     if {[string length $p]} { error "prefix specified" }
 }
 
-proc msg_PING {p c s1} {
-    global musthaveping_after
-    prefix_none
-    sendout PONG $s1
-    if {[info exists musthaveping_after]} connected
-}
-
-proc check_nick {n} {
-    if {[regexp -nocase {[^][\\`_^{|}a-z0-9-]} $n]} { error "bad char in nick" }
-    if {[regexp {^[-0-9]} $n]} { error "bad nick start" }
-}
-
-proc ischan {dest} {
-    return [regexp {^[&#+!]} $dest]
-}
-
-proc irctolower {v} {
-    foreach {from to} [list "\\\[" "{" \
-                         "\\\]" "}" \
-                         "\\\\" "|" \
-                         "~"    "^"] {
-       regsub -all $from $v $to v
-    }
-    return [string tolower $v]
-}
-
 proc prefix_nick {} {
     global nick
     upvar 1 p p
@@ -275,11 +33,11 @@ proc prefix_nick {} {
     }
 }
 
-proc showintervalsecs {howlong} {
-    return [showintervalsecs/[opt timeformat] $howlong]
+proc showintervalsecs {howlong abbrev} {
+    return [showintervalsecs/[opt timeformat] $howlong $abbrev]
 }
 
-proc showintervalsecs/ks {howlong} {
+proc showintervalsecs/ks {howlong abbrev} {
     if {$howlong < 1000} {
        return "${howlong}s"
     } else {
@@ -298,15 +56,19 @@ proc showintervalsecs/ks {howlong} {
     }
 }
 
-proc format_qty {qty unit} {
+proc format_qty {qty unit abbrev} {
     set o $qty
-    append o " "
-    append o $unit
-    if {$qty != 1} { append o s }
+    if {$abbrev} {
+       append o [string range $unit 0 0]
+    } else {
+       append o " "
+       append o $unit
+       if {$qty != 1} { append o s }
+    }
     return $o
 }
 
-proc showintervalsecs/hms {qty} {
+proc showintervalsecs/hms {qty abbrev} {
     set ul {second 60 minute 60 hour 24 day 7 week}
     set remainv 0
     while {[llength $ul] > 1 && $qty >= [set uv [lindex $ul 1]]} {
@@ -315,10 +77,10 @@ proc showintervalsecs/hms {qty} {
        set qty [expr {($qty-$remainv)/$uv}]
        set ul [lreplace $ul 0 1]
     }
-    set o [format_qty $qty [lindex $ul 0]]
+    set o [format_qty $qty [lindex $ul 0] $abbrev]
     if {$remainv} {
-       append o " "
-       append o [format_qty $remainv $remainu]
+       if {!$abbrev} { append o " " }
+       append o [format_qty $remainv $remainu $abbrev]
     }
     return $o
 }
@@ -327,7 +89,7 @@ proc showinterval {howlong} {
     if {$howlong <= 0} {
        return {just now}
     } else {
-       return "[showintervalsecs $howlong] ago"
+       return "[showintervalsecs $howlong 0] ago"
     }
 }
 
@@ -685,6 +447,8 @@ proc msg_QUIT {p c why} {
 }
 
 proc msg_PRIVMSG {p c dest text} {
+    global errorCode
+    
     prefix_nick
     if {[ischan $dest]} {
        recordlastseen_n $n "invoking me in $dest" 1
@@ -700,11 +464,12 @@ proc msg_PRIVMSG {p c dest text} {
        set ucmd [ta_word]
        set procname ucmd/[string tolower $ucmd]
        if {[catch { info body $procname }]} {
-           error "unknown command; try help for help"
+           usererror "Unknown command; try help for help."
        }
        $procname $p $dest
     } rv]} {
-       sendprivmsg $n "error: $rv"
+       if {"$errorCode" != "BLIGHT USER"} { set rv "error: $rv" }
+       sendprivmsg $n $rv
     } else {
        manyset $rv priv_msgs pub_msgs priv_acts pub_acts
        foreach {td val} [list $n $priv_acts $output $pub_acts] {
@@ -979,16 +744,18 @@ proc opt {key} {
 
 proc check_notonchan {} {
     upvar 1 dest dest
-    if {[ischan $dest]} { error "that command must be sent privately" }
+    if {[ischan $dest]} { usererror "That command must be sent privately." }
 }
 
 proc nick_securitycheck {strict} {
     upvar 1 n n
-    if {![nickdb_exists $n]} { error "you are unknown to me, use `register'." }
+    if {![nickdb_exists $n]} {
+       usererror "You are unknown to me, use `register'."
+    }
     set wantu [nickdb_get $n username]
     if {![string length $wantu]} {
        if {$strict} {
-           error "that feature is only available to secure users, sorry."
+           usererror "That feature is only available to secure users, sorry."
        } else {
            return
        }
@@ -996,19 +763,25 @@ proc nick_securitycheck {strict} {
     set luser [irctolower $n]
     upvar #0 nick_username($luser) nu
     if {![info exists nu]} {
-       error "nick $n is secure, you must identify yourself first."
+       usererror "Nick $n is secure, you must identify yourself first."
     }
     if {"$wantu" != "$nu"} {
-       error "you are the wrong user - the nick $n belongs to $wantu, not $nu"
+       usererror "You are the wrong user -\
+               the nick $n belongs to $wantu, not $nu."
     }
 }
 
-proc channel_securitycheck {channel n} {
-    # You must also call `nick_securitycheck 1'
+proc channel_ismanager {channel n} {
     set mgrs [chandb_get $channel managers]
-    if {[lsearch -exact [irctolower $mgrs] [irctolower $n]] < 0} {
-       error "you are not a manager of $channel"
+    return [expr {[lsearch -exact [irctolower $mgrs] [irctolower $n]] >= 0}]
+}
+
+proc channel_securitycheck {channel} {
+    upvar n n
+    if {![channel_ismanager $channel $n]} {
+       usererror "You are not a manager of $channel."
     }
+    nick_securitycheck 1
 }
 
 proc def_chancmd {name body} {
@@ -1126,7 +899,7 @@ def_chancmd topic {
            ucmdr "Topic $what list for $chan: $ta_listop_ev" {}
        }
        default {
-           error "unknown channel topic subcommand - see help channel"
+           usererror "Unknown channel topic subcommand - see help channel."
        }
     }
 }
@@ -1188,16 +961,17 @@ proc channelmgr_monoop {} {
     if {[ta_anymore]} { set target [ta_word] }
     ta_nomore
     if {![info exists target]} {
-       error "you must specify, or invoke me on, the relevant channel"
+       usererror "You must specify, or invoke me on, the relevant channel."
     }
     if {![info exists chan_nicks([irctolower $target])]} {
-       error "I am not on $target."
+       usererror "I am not on $target."
     }
     if {![ischan $target]} { error "not a valid channel" }
 
-    if {![chandb_exists $target]} { error "$target is not a managed channel." }
-    nick_securitycheck 1
-    channel_securitycheck $target $n
+    if {![chandb_exists $target]} {
+       usererror "$target is not a managed channel."
+    }
+    channel_securitycheck $target
 }
 
 def_ucmd op {
@@ -1211,7 +985,8 @@ def_ucmd leave {
 }
 
 def_ucmd invite {
-    global chan_nicks
+    global chan_nicks errorCode errorInfo
+    prefix_nick
     
     if {[ischan $dest]} {
        set target $dest
@@ -1221,23 +996,43 @@ def_ucmd invite {
        set onchan 0
     }
     set ltarget [irctolower $target]
-    if {![ischan $target]} { error "$target is not a channel." }
-    if {![info exists chan_nicks($ltarget)]} { error "I am not on $target." }
-    set ui [chandb_get $ltarget userinvite]
-    if {"$ui" == "pub" && !$onchan} {
-       error "Invitations to $target must be made with !invite."
+    if {![ischan $target]} { error "$target is not a channel" }
+    if {![info exists chan_nicks($ltarget)]} {
+       usererror "I am not on $target."
     }
-    if {"$ui" != "all"} {
-       prefix_nick
-       if {[lsearch -exact $chan_nicks($ltarget) [irctolower $n]] < 0} {
- error "Invitations to $target may only be made by a user on the channel."
+    set ui [chandb_get $ltarget userinvite]
+    if {[catch {
+       if {"$ui" == "pub" && !$onchan} {
+           usererror "Invitations to $target must be made there with !invite."
+       }
+       if {"$ui" != "all"} {
+           if {[lsearch -exact $chan_nicks($ltarget) [irctolower $n]] < 0} {
+               usererror "Invitations to $target may only be made\
+                       by a user on the channel."
+           }
+       }
+       if {"$ui" == "none"} {
+           usererror "Sorry, I've not been authorised\
+                   to invite people to $target."
+       }
+    } emsg]} {
+       if {"$errorCode" == "BLIGHT USER" && [channel_ismanager $target $n]} {
+           if {[catch {
+               nick_securitycheck 1
+           } emsg2]} {
+               if {"$errorCode" == "BLIGHT USER"} {
+                   usererror "$emsg2  Therefore you can't use your\
+                           channel manager privilege.  $emsg"
+               } else {
+                   error $error $errorInfo $errorCode
+               }
+           }
+       } else {
+           error $emsg $errorInfo $errorCode
        }
-    }
-    if {"$ui" == "none"} {
-       error "Sorry, I've not been authorised to invite people to $target."
     }
     if {![ta_anymore]} {
-       error "You have to say who to invite."
+       usererror "You have to say who to invite."
     }
     set invitees {}
     while {[ta_anymore]} {
@@ -1258,7 +1053,7 @@ def_ucmd invite {
            append who " and [lindex $invitees [llength $invitees]]"
        }
     }
-    ucmdr {} "invites $who to $target."
+    ucmdr {} {} {} "invites $who to $target."
 }
 
 def_ucmd channel {
@@ -1279,17 +1074,25 @@ def_ucmd channel {
     if {![info exists target]} { error "privately, you must specify a channel" }
     set procname channel/$subcmd
     if {"$subcmd" != "show"} {
-       if {[catch { info body $procname }]} { error "unknown channel setting $subcmd" }
+       if {[catch { info body $procname }]} {
+           usererror "unknown channel setting $subcmd."
+       }
        prefix_nick
-       nick_securitycheck 1
        if {[chandb_exists $target]} {
-           channel_securitycheck $target $n
+           channel_securitycheck $target
        } else {
+           nick_securitycheck 1
            upvar #0 chan_initialop([irctolower $target]) io
            upvar #0 nick_unique([irctolower $n]) u
-           if {![info exists io]} { error "$target is not a managed channel" }
-           if {"$io" != "$u"} { error "you are not the interim manager of $target" }
-           if {"$subcmd" != "manager"} { error "use `channel manager' first" }
+           if {![info exists io]} {
+               usererror "$target is not a managed channel."
+           }
+           if {"$io" != "$u"} {
+               usererror "You are not the interim manager of $target."
+           }
+           if {"$subcmd" != "manager"} {
+               usererror "Please use `channel manager' first."
+           }
        }
     }
     channel/$subcmd
@@ -1406,7 +1209,7 @@ proc marktime_desc {mt} {
     } elseif {"$mt" == "once"} {
        return "I will send you one informational message when I see you."
     } else {
-       return "I'll send you a message every [showintervalsecs $mt]."
+       return "I'll send you a message every [showintervalsecs $mt 0]."
     }
 }
 
@@ -1530,7 +1333,7 @@ def_ucmd summon {
        set idletime [expr {$now - $idlesince}]
        set ls $now
        ucmdr {} {} {} "invites $target ($tty[expr {
-           $idletime > 10 ? ", idle for [showintervalsecs $idletime]" : ""
+           $idletime > 10 ? ", idle for [showintervalsecs $idletime 0]" : ""
        }]) to [expr {
            [ischan $dest] ? "join us here" : "talk to you"
        }]."
@@ -1549,7 +1352,7 @@ def_ucmd seen {
     ta_nomore
     set now [clock seconds]
     if {"$nlower" == "[irctolower $nick]"} {
-       error "I am not self-aware."
+       usererror "I am not self-aware."
     } elseif {![info exists lastseen($nlower)]} {
        set rstr "I've never seen $ncase."
     } else {
@@ -1628,7 +1431,8 @@ proc lnick_pingstring {why oc apstring} {
            upvar #0 chan_lastactivity($ch) la
            if {![info exists la]} continue
            if {$la <= $best_la} continue
-           set activity "$ch [showintervalsecs [expr {[clock seconds]-$la}]]"
+           set since [showintervalsecs [expr {[clock seconds]-$la}] 1]
+           set activity "$ch $since"
            set best_la $la
        }
     } else {