X-Git-Url: https://git.distorted.org.uk/~mdw/ircbot/blobdiff_plain/200873633854ff35ca47b1392c73c80fcfbcda75..534e26a9446218a12c0ac24ab6c95fb451d48a07:/bot.tcl

diff --git a/bot.tcl b/bot.tcl
index 598223b..140ff1c 100755
--- a/bot.tcl
+++ b/bot.tcl
@@ -1,20 +1,23 @@
-#!/usr/bin/tclsh8.2
+# Core bot code
 
-set host chiark
-set port 6667
-if {![info exists nick]} { set nick Blight }
-if {![info exists ownfullname]} { set ownfullname "here to Help" }
-set ownmailaddr blight@chiark.greenend.org.uk
-
-if {![info exists globalsecret]} {
-    set gsfile [open /dev/urandom r]
-    fconfigure $gsfile -translation binary
-    set globalsecret [read $gsfile 32]
-    binary scan $globalsecret H* globalsecret
-    close $gsfile
-    unset gsfile
+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
+
 proc manyset {list args} {
     foreach val $list var $args {
 	upvar 1 $var my
@@ -45,8 +48,69 @@ proc try_except_finally {try except finally} {
     }
 }
 
-proc sendout {command args} {
+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} {
+	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]
@@ -59,10 +123,20 @@ proc sendout {command args} {
     }
     set args [lreplace $args 0 -1 $command]
     set string [join $args { }]
-    puts "[clock seconds] -> $string"
-    puts $sock $string
+    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
+    }
 }
 
+proc sendout {command args} { eval sendout_priority [list 0 $command] $args }
+    
 proc log {data} {
     puts $data
 }
@@ -89,7 +163,7 @@ proc bgerror {msg} {
 proc onread {args} {
     global sock nick calling_nick errorInfo errorCode
     
-    if {[gets $sock line] == -1} { set terminate 1; return }
+    if {[gets $sock line] == -1} { fail "EOF/error on input" }
     regsub -all "\[^ -\176\240-\376\]" $line ? line
     set org $line
     
@@ -149,7 +223,9 @@ proc sendprivmsg {dest l} {
 	sendout [expr {[ischan $dest] ? "PRIVMSG" : "NOTICE"}] $dest $v
     }
 }
-proc sendaction {dest what} { sendout PRIVMSG $dest "\001ACTION $what\001" }
+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] }
 
@@ -159,8 +235,10 @@ proc prefix_none {} {
 }
 
 proc msg_PING {p c s1} {
+    global musthaveping_after
     prefix_none
     sendout PONG $s1
+    if {[info exists musthaveping_after]} connected
 }
 
 proc check_nick {n} {
@@ -354,8 +432,8 @@ proc chanmode_o1 {m g p chan} {
     set who [chanmode_arg]
     recordlastseen_n $n "being nice to $who" 1
     if {"[irctolower $who]" == "[irctolower $nick]"} {
-	set nl [irctolower $n]
-	upvar #0 nick_unique($n) u
+	set nlower [irctolower $n]
+	upvar #0 nick_unique($nlower) u
 	if {[chandb_exists $chan]} {
 	    sendprivmsg $n Thanks.
 	} elseif {![info exists u]} {
@@ -401,27 +479,58 @@ proc msg_MODE {p c dest modelist args} {
     }
 }
 
-proc channel_noone_seen {chan} {
-    global nick_onchans
-    foreach n [array names nick_onchans] {
-	upvar #0 nick_onchans($n) oc
-	set oc [grep tc {"$tc" != "$chan"} $oc]
+proc leaving {lchan} {
+    foreach luser [array names nick_onchans] {
+	upvar #0 nick_onchans($luser) oc
+	set oc [grep tc {"$tc" != "$lchan"} $oc]
+    }
+    upvar #0 chan_nicks($lchan) nlist
+    unset nlist
+}
+
+proc dojoin {lchan} {
+    global chan_nicks
+    sendout JOIN $lchan
+    set chan_nicks($lchan) {}
+}
+
+proc check_justme {lchan} {
+    global nick
+    upvar #0 chan_nicks($lchan) nlist
+    if {[llength $nlist] != 1} return
+    if {"[lindex $nlist 0]" != "$nick"} return
+    if {[chandb_exists $lchan]} {
+	set mode [chandb_get $lchan mode]
+	if {"$mode" != "*"} {
+	    sendout MODE $lchan $mode
+	}
+    } else {
+	sendout PART $lchan
+	leaving $lchan
     }
 }
 
 proc process_kickpart {chan user} {
     global nick
     check_nick $user
+    set luser [irctolower $user]
+    set lchan [irctolower $chan]
     if {![ischan $chan]} { error "not a channel" }
-    if {"[irctolower $user]" == "[irctolower $nick]"} {
-	channel_noone_seen $chan
+    if {"$luser" == "[irctolower $nick]"} {
+	leaving $lchan
+    } else {
+	upvar #0 nick_onchans($luser) oc
+	upvar #0 chan_nicks($lchan) nlist
+	set oc [grep tc {"$tc" != "$lchan"} $oc]
+	set nlist [grep tn {"$tn" != "$luser"} $nlist]
+	nick_case $user
+	if {![llength $oc]} {
+	    nick_forget $luser
+	} else {
+	    check_justme $lchan
+	}
     }
-    upvar #0 nick_onchans($user) oc
-    set lc [irctolower $chan]
-    set oc [grep tc {"$tc" != "$lc"} $oc]
-    if {![llength $oc]} { nick_forget $user }
-    nick_case $user
-}    
+}
 
 proc msg_KICK {p c chans users comment} {
     set chans [split $chans ,]
@@ -439,19 +548,35 @@ proc msg_KILL {p c user why} {
 
 set nick_counter 0
 set nick_arys {onchans username unique}
+# nick_onchans($luser) -> [list ... $lchan ...]
+# nick_username($luser) -> <securely known local username>
+# nick_unique($luser) -> <counter>
+# nick_case($luser) -> $user  (valid even if no longer visible)
 
-proc nick_forget {n} {
-    global nick_arys
+# chan_nicks($lchan) -> [list ... $luser ...]
+
+proc lnick_forget {luser} {
+    global nick_arys chan_nicks
     foreach ary $nick_arys {
-	upvar #0 nick_${ary}($n) av
+	upvar #0 nick_${ary}($luser) av
 	catch { unset av }
     }
-    nick_case $n
+    foreach lch [array names chan_nicks] {
+	upvar #0 chan_nicks($lch) nlist
+	set nlist [grep tn {"$tn" != "$luser"} $nlist]
+	check_justme $lch
+    }
 }
 
-proc nick_case {n} {
+proc nick_forget {user} {
+    global nick_arys chan_nicks
+    lnick_forget [irctolower $user]
+    nick_case $user
+}
+
+proc nick_case {user} {
     global nick_case
-    set nick_case([irctolower $n]) $n
+    set nick_case([irctolower $user]) $user
 }
 
 proc msg_NICK {p c newnick} {
@@ -465,12 +590,20 @@ proc msg_NICK {p c newnick} {
 	if {[info exists new]} { error "nick collision ?! $ary $n $newnick" }
 	if {[info exists old]} { set new $old; unset old }
     }
+    upvar #0 nick_onchans($new)
+    set luser [irctolower $n]
+    set lusernew [irctolower $newnick]
+    foreach ch $oc {
+	upvar #0 chan_nicks($ch) nlist
+	set nlist [grep tn {"$tn" != "$luser"} $nlist]
+	lappend nlist $lusernew
+    }
     nick_case $newnick
 }
 
 proc nick_ishere {n} {
     global nick_counter
-    upvar #0 nick_unique($n) u
+    upvar #0 nick_unique([irctolower $n]) u
     if {![info exists u]} { set u [incr nick_counter].$n.[clock seconds] }
     nick_case $n
 }
@@ -478,7 +611,7 @@ proc nick_ishere {n} {
 proc msg_JOIN {p c chan} {
     prefix_nick
     recordlastseen_n $n "joining $chan" 1
-    upvar #0 nick_onchans($n) oc
+    upvar #0 nick_onchans([irctolower $n]) oc
     lappend oc [irctolower $chan]
     nick_ishere $n
 }
@@ -518,7 +651,7 @@ proc msg_PRIVMSG {p c dest text} {
 	manyset $rv priv_msgs pub_msgs priv_acts pub_acts
 	foreach {td val} [list $n $priv_acts $output $pub_acts] {
 	    foreach l [split $val "\n"] {
-		sendaction $td $l
+		sendaction_priority 0 $td $l
 	    }
 	}
 	foreach {td val} [list $n $priv_msgs $output $pub_msgs] {
@@ -530,7 +663,7 @@ proc msg_PRIVMSG {p c dest text} {
 }
 
 proc msg_INVITE {p c n chan} {
-    after 1000 [list sendout JOIN $chan]
+    after 1000 [list dojoin [irctolower $chan]]
 }
 
 proc grep {var predicate list} {
@@ -544,28 +677,39 @@ proc grep {var predicate list} {
 
 proc msg_353 {p c dest type chan nicklist} {
     global names_chans nick_onchans
-    if {![info exists names_chans]} { set names_chans {} }
-    set chan [irctolower $chan]
-    lappend names_chans $chan
-    channel_noone_seen $chan
-    foreach n [split $nicklist { }] {
-	regsub {^[@+]} $n {} n
-	if {![string length $n]} continue
-	check_nick $n
-	upvar #0 nick_onchans($n) oc
-	lappend oc $chan
-	nick_ishere $n
+    set lchan [irctolower $chan]
+    upvar #0 chan_nicks($lchan) nlist
+    lappend names_chans $lchan
+    if {![info exists nlist]} {
+	# We don't think we're on this channel, so ignore it !
+	# Unfortunately, because we don't get a reply to PART,
+	# we have to remember ourselves whether we're on a channel,
+	# and ignore stuff if we're not, to avoid races.  Feh.
+	return
+    }
+    set nlist_new {}
+    foreach user [split $nicklist { }] {
+	regsub {^[@+]} $user {} user
+	if {![string length $user]} continue
+	check_nick $user
+	set luser [irctolower $user]
+	upvar #0 nick_onchans($luser) oc
+	lappend oc $lchan
+	lappend nlist_new $luser
+	nick_ishere $user
     }
+    set nlist $nlist_new
 }
 
 proc msg_366 {p c args} {
     global names_chans nick_onchans
-    if {[llength names_chans] > 1} {
-	foreach n [array names nick_onchans] {
-	    upvar #0 nick_onchans($n) oc
+    set lchan [irctolower $c]
+    foreach luser [array names nick_onchans] {
+	upvar #0 nick_onchans($luser) oc
+	if {[llength names_chans] > 1} {
 	    set oc [grep tc {[lsearch -exact $tc $names_chans] >= 0} $oc]
-	    if {![llength $oc]} { nick_forget $n }
 	}
+	if {![llength $oc]} { lnick_forget $n }
     }
     unset names_chans
 }
@@ -639,6 +783,18 @@ proc loadhelp {} {
 }
 
 def_ucmd help {
+    if {[set lag [out_lagged]]} {
+	if {[ischan $dest]} { set replyto $dest } else { set replyto $n }
+	if {$lag > 1} {
+	    sendaction_priority 1 $replyto \
+		"is very lagged.  Please ask for help again later."
+	    ucmdr {} {}
+	} else {
+	    sendaction_priority 1 $replyto \
+		"is lagged.  Your help will arrive shortly ..."
+	}
+    }
+    
     upvar #0 help_topics([irctolower [string trim $text]]) info
     if {![info exists info]} { ucmdr "No help on $text, sorry." {} }
     ucmdr $info {}
@@ -675,23 +831,37 @@ proc somedb__head {} {
 proc def_somedb {name arglist body} {
     foreach {nickchan fprefix} {nick users/n chan chans/c} {
 	proc ${nickchan}db_$name $arglist \
-		"set nickchan $nickchan; set fprefix $fprefix; somedb__head; $body"
+            "set nickchan $nickchan; set fprefix $fprefix; $body"
+    }
+}
+
+def_somedb list {} {
+    set list {}
+    foreach path [glob -nocomplain -path $fprefix *] {
+	binary scan $path "A[string length $fprefix]A*" afprefix thinghex
+	if {"$afprefix" != "$fprefix"} { error "wrong prefix $path $afprefix" }
+	lappend list [binary format H* $thinghex]
     }
+    return $list
+}
+
+proc def_somedb_id {name arglist body} {
+    def_somedb $name [concat id $arglist] "somedb__head; $body"
 }
 
-def_somedb exists {id} {
+def_somedb_id exists {} {
     return [info exists iddbe]
 }
 
-def_somedb delete {id} {
+def_somedb_id delete {} {
     catch { unset iddbe }
     file delete $idfn
 }
 
 set default_settings_nick {timeformat ks}
-set default_settings_chan {autojoin 1}
+set default_settings_chan {autojoin 1  mode *}
 
-def_somedb set {id args} {
+def_somedb_id set {args} {
     upvar #0 default_settings_$nickchan def
     if {![info exists iddbe]} { set iddbe $def }
     foreach {key value} [concat $iddbe $args] { set a($key) $value }
@@ -709,10 +879,10 @@ def_somedb set {id args} {
     set iddbe $newval
 }
 
-def_somedb get {id key} {
+def_somedb_id get {key} {
     upvar #0 default_settings_$nickchan def
     if {[info exists iddbe]} {
-	set l $iddbe
+	set l [concat $iddbe $def]
     } else {
 	set l $def
     }
@@ -744,7 +914,8 @@ proc nick_securitycheck {strict} {
 	    return
 	}
     }
-    upvar #0 nick_username($n) nu
+    set luser [irctolower $n]
+    upvar #0 nick_username($luser) nu
     if {![info exists nu]} {
 	error "nick $n is secure, you must identify yourself first."
     }
@@ -755,7 +926,8 @@ proc nick_securitycheck {strict} {
 
 proc channel_securitycheck {channel n} {
     # You must also call `nick_securitycheck 1'
-    if {[lsearch -exact [irctolower [chandb_get $channel managers]] $n] < 0} {
+    set mgrs [chandb_get $channel managers]
+    if {[lsearch -exact [irctolower $mgrs] [irctolower $n]] < 0} {
 	error "you are not a manager of $channel"
     }
 }
@@ -807,12 +979,28 @@ def_chancmd autojoin {
 	default { error "channel autojoin must be `yes' or `no' }
     }
     chandb_set $chan autojoin $nv
+    ucmdr [expr {$nv ? "I will join #chan when I'm restarted " : \
+	    "I won't join #chan when I'm restarted "}] {}
+}
+
+def_chancmd mode {
+    set mode [ta_word]
+    if {"$mode" != "*" && ![regexp {^(([-+][imnpst]+)+)$} $mode mode]} {
+	error {channel mode must be * or match ([-+][imnpst]+)+}
+    }
+    chandb_set $chan mode $mode
+    if {"$mode" == "*"} {
+	ucmdr "I won't ever change the mode of #chan." {}
+    } else {
+	ucmdr "Whenever I'm alone on #chan, I'll set the mode to $mode." {}
+    }
 }
 
 def_chancmd show {
     if {[chandb_exists $chan]} {
 	set l "Settings for $chan: autojoin "
 	append l [lindex {no yes} [chandb_get $chan autojoin]]
+	append l ", mode " [chandb_get $chan mode] "."
 	append l "\nManagers: "
 	append l [join [chandb_get $chan managers] " "]
 	ucmdr {} $l
@@ -859,7 +1047,7 @@ def_ucmd channel {
 	    channel_securitycheck $target $n
 	} else {
 	    upvar #0 chan_initialop([irctolower $target]) io
-	    upvar #0 nick_unique($n) u
+	    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" }
@@ -877,21 +1065,22 @@ def_ucmd who {
 	set target $n
 	set myself [expr {"$target" != "$n"}]
     }
-    upvar #0 nick_case([irctolower $target]) nc
+    set ltarget [irctolower $target]
+    upvar #0 nick_case($ltarget) ctarget
     set nshow $target
-    if {[info exists nc]} {
-	upvar #0 nick_onchans($nc) oc
-	upvar #0 nick_username($nc) nu
-	if {[info exists oc]} { set nshow $nc }
+    if {[info exists ctarget]} {
+	upvar #0 nick_onchans($ltarget) oc
+	upvar #0 nick_username($ltarget) nu
+	if {[info exists oc]} { set nshow $ctarget }
     }
-    if {![nickdb_exists $target]} {
+    if {![nickdb_exists $ltarget]} {
 	set ol "$nshow is not a registered nick."
     } elseif {[string length [set username [nickdb_get $target username]]]} {
 	set ol "The nick $nshow belongs to the user $username."
     } else {
 	set ol "The nick $nshow is registered (but not to a username)."
     }
-    if {![info exists nc] || ![info exists oc]} {
+    if {![info exists ctarget] || ![info exists oc]} {
 	if {$myself} {
 	    append ol "\nI can't see $nshow on anywhere."
 	} else {
@@ -914,9 +1103,10 @@ def_ucmd register {
     check_notonchan
     set old [nickdb_exists $n]
     if {$old} { nick_securitycheck 0 }
+    set luser [irctolower $n]
     switch -exact [string tolower [string trim $text]] {
 	{} {
-	    upvar #0 nick_username($n) nu
+	    upvar #0 nick_username($luser) nu
 	    if {![info exists nu]} {
 		ucmdr {} \
  "You must identify yourself before using `register'.  See `help identify', or use `register insecure'."
@@ -1016,14 +1206,15 @@ def_ucmd identpass {
     ta_nomore
     prefix_nick
     check_notonchan
-    upvar #0 nick_onchans($n) onchans
+    set luser [irctolower $n]
+    upvar #0 nick_onchans($luser) onchans
     if {![info exists onchans] || ![llength $onchans]} {
 	ucmdr "You must be on a channel with me to identify yourself." {}
     }
     check_username $username
     exec userv --timeout 3 $username << "$passmd5\n" > /dev/null \
 	    irc-identpass $n
-    upvar #0 nick_username($n) rec_username
+    upvar #0 nick_username($luser) rec_username
     set rec_username $username
     ucmdr "Pleased to see you, $username." {}
 }
@@ -1101,19 +1292,62 @@ def_ucmd seen {
     ucmdr {} $rstr
 }
 
-if {![info exists sock]} {
+proc ensure_globalsecret {} {
+    global globalsecret
+    
+    if {[info exists globalsecret]} return
+    set gsfile [open /dev/urandom r]
+    fconfigure $gsfile -translation binary
+    set globalsecret [read $gsfile 32]
+    binary scan $globalsecret H* globalsecret
+    close $gsfile
+    unset gsfile
+}
+
+proc ensure_outqueue {} {
+    out__vars
+    if {[info exists out_queue]} return
+    set out_creditms [expr {$out_maxburst*$out_interval}]
+    set out_creditat [clock seconds]
+    set out_queue {}
+    set out_lag_reported 0
+    set out_lag_reportwhen $out_creditat
+}
+
+proc fail {msg} {
+    logerror "failing: $msg"
+    exit 1
+}
+
+proc ensure_connecting {} {
+    global sock ownfullname host port nick
+    global musthaveping_ms musthaveping_after
+    
+    if {[info exists sock]} return
     set sock [socket $host $port]
     fconfigure $sock -buffering line
-    #fconfigure $sock -translation binary
     fconfigure $sock -translation crlf
 
     sendout USER blight 0 * $ownfullname
     sendout NICK $nick
     fileevent $sock readable onread
+
+    set musthaveping_after [after $musthaveping_ms \
+	    {fail "no ping within timeout"}]
 }
 
-loadhelp
+proc connected {} {
+    global musthaveping_after
 
-#if {![regexp {tclsh} $argv0]} {
-#    vwait terminate
-#}
+    after cancel $musthaveping_after
+    unset musthaveping_after
+
+    foreach chan [chandb_list] {
+	if {[chandb_get $chan autojoin]} { dojoin $chan }
+    }
+}
+
+ensure_globalsecret
+ensure_outqueue
+loadhelp
+ensure_connecting