chiark / gitweb /
Bugfixes. tellme cmd
[ircbot] / bot.tcl
diff --git a/bot.tcl b/bot.tcl
index 01113635984261ec7cf107ea807355c0de497859..ad4de2c35d40443b92d1e15a12286a95af3b6ae7 100755 (executable)
--- a/bot.tcl
+++ b/bot.tcl
@@ -145,86 +145,136 @@ proc looking_whenwhere {when where} {
     return $str
 }
 
-proc check_telling {nl event} {
-    # for all except `talk' we delay 750ms
-    switch -exact $event {
-       none {
+proc tell_getcstate {} {
+    # uses nl from caller's context
+    # imports telling (as the nick_telling) and u
+    # sets stt, telling_when
+    uplevel 1 {
+       upvar #0 nick_telling($nl) telling
+       upvar #0 nick_unique($nl) u
+
+       if {[info exists telling]} {
+           manyset $telling u_last stt telling_when
+           if {![info exists u] || "$u_last" != "$u"} {
+               set stt undelivered
+           }
+       } else {
+           set stt undelivered
+           set telling_when 0
        }
+    }
+}
+
+proc tell_event {nl event} {
+    # For `act' we *haven't* yet done the 750ms delay; we implement
+    # that here.  Also, here we turn `talk' into `talk' now and `act'
+    # later.  We also support the psuedo-event `none'.  The del msg
+    # and new msg events are handled by the command procedures, not here.
+    global calling_nick
+    if {[info exists calling_nick]} { set save $calling_nick }
+    set r DELAYED
+    switch -exact $event {
+       none { }
        talk {
-           check_telling_core $nl talk
-           check_telling_core $nl act
+           tell_event_core $nl talk
+           tell_event $nl act
        }
        act {
-           after 750 [list check_telling_core $nl $event]
+           after 750 [list tell_event_core $nl $event]
+       }
+       ident - msgsarrive {
+           tell_event_core $nl $event
+       }
+       tellme {
+           set r [tell_event_core $nl TELLME]
        }
        default {
-           error "check_telling $nl $event"
+           error "tell_event $nl $event"
        }
     }
+    if {[info exists save]} { set calling_nick $save }
+    return $r
 }
 
-proc check_telling_core {nl event} {
-    # event is `talk' or `act'
-    # When user talks we actually get talk now and act later
-FIXME - make it be called with come
-FIXME - implement all cmds
-FIXME - implement tells_deliver            set stt [list $u passed $now]
-FIXME - implement tells_delete                     catch { unset stt }   ?
-    set iml [msgdb_get $nl inbound]
-    if {![llength $iml]} return
-
-    upvar #0 nick_telling($nl) telling
-    upvar #0 nick_unique($nl) u
-
-    if {[info exists telling]} {
-       manyset $telling u2 stt telling_when
-       if {"$u2" != "$u"} { unset telling; unset stt; unset telling_when }
+proc tell_event_core {nl event} {
+    global tell_event_teventi errorInfo
+    set tell_event_teventi "*$event* $nl"
+    if {[catch {
+       tell_event_core1 $nl $event
+    } emsg]} {
+       log_intern "tell event error" "$emsg >$errorInfo<"
+       set emsg ERROR
+    } else {
+       log_intern "tell event" "done $tell_event_teventi $emsg"
     }
+    return $emsg
+}
 
-    if {![info exists stt]} {
-       set stt norecord
-       set telling_when $now
-    }
+proc tell_event_core1 {nl event} {
+    # event is `talk', `act', `ident', `msgsarrive' or `TELLME'
+    # When user talks we actually get talk now and act later
+    global calling_nick
+    set calling_nick $nl
+    set iml [msgsdb_get $nl inbound]
+    if {![llength $iml]} { return nomsgs }
 
+    set now [clock seconds]
+    tell_getcstate
     set ago [expr {$now - $telling_when}]
 
+    # Now we have the components of a telling state
+    #   u     - nick_unique (unset if not visible)
+    #   stt   - state: undelivered, mentioned, passede
+    #   ago   - how long ago since we did anything
+
+    # We compute an evstate to dispatch on as follows:
+
     # evstate is string of letters
+    #   current state
+    #      u   UNDELIVERED (MESSAGES)
+    #      m   MENTIONED
+    #      p   PASSED
     #   event
     #      t   talk
     #      a   act
-    #      c   come
+    #      i   ident
+    #      m   msgsarrive
+    #      T   tellme (user command)
     #   security level and timing
     #      ii  Insecure
     #      ss  Secure and soon (before interval)
     #      sl  Secure and late (after interval)
-    #   current state
-    #      n   NORECORD
-    #      m   MENTIONED
-    #      p   PASSED
+    #   current identification
+    #      i   Identified
+    #      u   Unidentified
     #   reliability and timing
     #      uu  Unreliable
     #      rv  Remind, very soon (before within-interval)
     #      rs  Remind, soon (between)
-    #      rl  Remind, late (aftr every-interval)
+    #      rl  Remind, late (after every-interval)
     #      ps  Pester, soon (before interval)
     #      pl  Pester, late (after interval)
-    #   current identification
-    #      i   Identified
-    #      u   Unidentified
-    #   current visibility
-    #      v   Visible
-    #      h   Hidden (invisible, no unique)
 
-    manyset [nickdb_get $n tellsec] sec secwhen
+    set evstate {}
+
+    append evstate [string range $stt 0 0]
+    append evstate [string range $event 0 0]
+
+    manyset [nickdb_get_sec_effective $nl] sec secwhen
     switch -exact $sec {
-       insecure { set evstate ii }
-       secure { set evstate [expr {$ago<$secwhen ? "sl" : "ss"}] }
-       default { set evstate "#$sec#" }
+       insecure { append evstate ii }
+       secure { append evstate [expr {$ago<$secwhen ? "ss" : "sl"}] }
+       default { append evstate "#$sec#" }
     }
 
-    append evstate [string range $stt 0 0]
+    upvar #0 nick_username($nl) nu
+    if {[info exists nu] && "$nu" == "[nickdb_get_username $nl]"} {
+       append evstate i
+    } else {
+       append evstate u
+    }
     
-    manyset [nickdb_set $n tellrel] rel relint relwithin
+    manyset [nickdb_get $nl tellrel] rel relint relwithin
     switch -exact $rel {
        unreliable { append evstate uu }
        remind { append evstate [expr {
@@ -234,52 +284,96 @@ FIXME - implement tells_delete                catch { unset stt }   ?
        default { append evstate "#$rel#" }
     }
 
-    upvar #0 nick_username($nl) nu
-    if {[info exists nu] && "$nu" == "[nickdb_get $nl username]"} {
-       append evstate i
-    } else {
-       append evstate u
-    }
-
-    append evstate [expr {[info exists u] ? "v" : "h"}]
-
+    global tell_event_teventi
+    set tell_event_teventi "$evstate $ago $nl"
     switch -glob $evstate {
-       t??prv?v {
+       pt???rv {
            # consider delivered:
            #  (very recently passed, and the user talks)
-           tells_delete {} $nl
-       }
-       t??????? {
-           # ignore
-           #   (any other `talk's)
-       }
-       ?iin???? - ?iip?l?? - ?ii????? -
-       ?s?n??iv - ?s?m??iv - ?s?p?liv {
-           # pass messages
-           #  (insecure and not passed recently, or just arriving;
-           #   secure and not passed recently)
-           tells_deliver $nl
-       }
-       ?ssp???? - ???p?s?? - ???p?v?? {
-           # ignore
-           #  (recently mentioned or passed
-           #   immediate `talk' thing)
-       }
-       ?s?n???? - ?slm???? - cs?????? {
-           # mention messages
-           #  (secure and not mentioned recently or just arriving,
-           #           and should not pass)
-           sendprivmsg $nl \
-                   {You have messages (so identify yourself please).}]
-           set stt [list $u mentioned $now]
+           tell_delete_msgs {} $nl
+           return delivered
+       }
+       pm????? {
+           # oops, messages passed are now out of date
+           catch_restoreei { unset telling }
+           return reset
+       }
+       ?m????? {
+           # ignore new msgs if we haven't passed yet
+           return ignorenew
+       }
+       ut????? - mt????? -
+       pt???uu - pt???rs - pt???rl - pt???p? {
+           # ignore (any other `talk's) - act handles these
+           return ignoretalk
+       }
+       ui????? -
+       uaii?uu - uaii??l - uas?i?l -
+       mi????? - pa????l -
+       ?Tii??? - ?Ts?i?? {
+           # pass and then stuff
+           if {[llength $iml] == 3} {
+               manyset $iml sender sentwhen msg
+               sendprivmsg $nl \
+ "$sender asked me [showinterval [expr {$now-$sentwhen}]]\
+ to tell you: $msg"
+            } else {
+               sendprivmsg $nl \
+ "I have [expr {[llength $iml]/3}] messages for you:"
+               while {[llength $iml] >= 3} {
+                   manyset [lrange $iml 0 2] sender sentwhen msg
+                   set iml [lrange $iml 3 end]
+                   sendprivmsg $nl \
+ " [showintervalsecs [expr {$now-$sentwhen}] 1] <$sender> $msg"
+               }
+           }
+           if {"$rel" == "unreliable"} {
+               tell_delete_msgs {} $nl
+               return toldunreliable
+           }
+           set stt passed
+           set re passed
+       }
+       uaslu?? {
+           sendprivmsg $nl {You have messages (so identify yourself please).}
+           set stt mentioned
+           set re mentioned
+       }
+       ?Ts?u?? {
+           sendprivmsg $nl {You must identify yourself to see your messages.}
+           return ignoreuitm
+       }
+       masl??? {
+           sendprivmsg $nl {Don't forget about your messages.}
+           return remind
+       }
+       pi????? {
+           return ignorepi
+       }
+       mass??? - pa????v - pa????s -
+       uaii??v - uaii??s -
+       uas?i?v - uas?i?s -
+       uassu?? {
+           # too soon
+           return ignoresoon
        }
        * {
-           error "check_telling_core nl=$nl evstate=$evstate ?"
+           error "tell_event_core nl=$nl evstate=$evstate ?"
        }
     }
+    if {![info exists u]} {
+       set telling [list {} undelivered $now]
+    } else {
+       set telling [list $u $stt $now]
+    }
+    return $re
 }
 
 proc recordlastseen_n {n how here} {
+    # here is:
+    #   0 - nick was seen leaving (or changing to another nicks or some such)
+    #   1 - nick was seen doing something else
+    #   2 - nick was seen talking on channel
     global lastseen lookedfor
     set nl [irctolower $n]
     set now [clock seconds]
@@ -287,7 +381,7 @@ proc recordlastseen_n {n how here} {
 
     if {!$here} return
 
-    check_telling $nl [lindex {none act talk} $here]
+    tell_event $nl [lindex {none act talk} $here]
 
     upvar #0 lookedfor($nl) lf
     if {[info exists lf]} {
@@ -377,8 +471,8 @@ proc chanmode_o1 {m g p chan} {
        } else {
            set chan_initialop([irctolower $chan]) $u
            sendprivmsg $n \
- "Thanks. You can use `channel manager ...' to register this channel."
-           if {![nickdb_exists $n] || ![string length [nickdb_get $n username]]} {
+ "Thanks.  You can use `channel manager ...' to register this channel."
+           if {![string length [nickdb_get_username $n username]]} {
                sendprivmsg $n \
  "(But to do that you must register your nick securely first.)"
            }
@@ -727,7 +821,7 @@ def_somedb_id delete {} {
 set default_settings_nick {
     timeformat ks
     marktime off
-    tellsec insecure
+    tellsec {secure 600}
     tellrel {remind 3600 30}
 }
 
@@ -746,6 +840,8 @@ set default_settings_msgs {
 }
 # inbound -> [<nick> <time_t> <message>] ...
 # outbound -> [<nick> <time_t(earliest)> <count>] ...
+#   neither are sorted particularly; only one entry per recipient in
+#   output; both sender and recipient are cased
 
 def_somedb_id set {args} {
     upvar #0 default_settings_$nickchan def
@@ -1140,18 +1236,149 @@ def_ucmd channel {
     channel/$subcmd
 }
 
+proc nickdb_get_username {n} {
+    if {![nickdb_exists $n]} { return "" }
+    return [nickdb_get $n username]
+}
+
+proc nickdb_get_sec_effective {n} {
+    set l [nickdb_get $n tellsec]
+    set u [nickdb_get_username $n]
+    if {"[lindex $l 0]" == "secure" && ![string length $u]} { set l insecure }
+    return $l
+}
+
+proc tell_peernicks {text} {
+    set text [irctolower [string trim $text]]
+    set senders [split $text " "]
+    foreach sender $senders {
+       if {[catch { check_nick $sender } emsg]} {
+           error "invalid sender nick `$sender': $emsg" $errorInfo $errorCode
+       }
+    }
+    return $senders
+}
+
+proc msgsdb_set_maydelete {n key l otherkey} {
+    msgsdb_set $n $key $l
+    if {[llength $l]} return
+    if {[llength [msgsdb_get $n $otherkey]]} return
+    msgsdb_delete $n
+}
+
+proc tell_delete_msgs {lsenders lrecip} {
+    set ninbound {}
+    set ndel 0
+    foreach {s t m} [msgsdb_get $lrecip inbound] {
+       if {[llength $lsenders]} {
+           if {[lsearch -exact $lsenders [irctolower $s]] == -1} {
+               lappend ninbound $s $t $m
+               continue
+           }
+       }
+       set rsenders($s) 1
+       incr ndel
+    }
+    msgsdb_set_maydelete $lrecip inbound $ninbound outbound
+    if {![llength $ninbound]} {
+       upvar #0 nick_telling($lrecip) telling
+       catch { unset telling }
+    }
+    foreach s [array names rsenders] {
+       set noutbound {}
+       foreach {r t c} [msgsdb_get $s outbound] {
+           if {"[irctolower $r]" == "$lrecip"} continue
+           lappend noutbound $r $t $c
+       }
+       msgsdb_set_maydelete $s outbound $noutbound inbound
+    }
+    return $ndel
+}
+
+def_ucmd untell {
+    prefix_nick
+    check_notonchan
+    nick_securitycheck 0
+    set recipients [tell_peernicks $text]
+    if {![llength $recipients]} {
+       usererror "You must say which recipients' messages from you to forget."
+    }
+    set ndel 0
+    foreach recip $recipients {
+       incr ndel [tell_delete_msgs [irctolower $n] $recip]
+    }
+    ucmdr "Removed $ndel as yet undelivered message(s)." {}
+}
+
+def_ucmd delmsg {
+    global errorInfo errorCode
+    prefix_nick
+    set nl [irctolower $n]
+    check_notonchan
+    manyset [nickdb_get_sec_effective $n] sec secwhen
+    switch -exact $sec {
+       insecure { }
+       refuse - mailto {
+           usererror \
+ "There are no messages to delete\
+ because your message disposition prevents them from being left."
+       }
+       secure {
+           nick_securitycheck 1
+       }
+       default {
+           error "delmsg sec $sec"
+       }
+    }
+    tell_getcstate
+    if {"$stt" != "passed"} {
+       usererror \
+ "There are message(s) you've not yet seen; I'll deliver them to you now.\
+  If you actually want to delete them, just tell me `delmsg' again."
+    }
+    set senders [tell_peernicks $text]
+    set ndel [tell_delete_msgs [irctolower $senders] [irctolower $n]]
+    if {!$ndel} {
+       if {[llength $senders]} {
+           ucmdr "No relevant incoming messages to delete." {}
+       } else {
+           ucmdr "No incoming messages to delete." {}
+       }
+    }
+    switch -exact [llength $senders] {
+       0 { ucmdr {} {} "deletes your $ndel message(s)." }
+       1 { ucmdr {} {} "deletes your $ndel message(s) from $senders." }
+       default {
+           ucmdr {} {} "deletes your $ndel message(s) from\
+ [lreplace $senders end end] and [lindex $senders end]."
+       }
+    }
+}
+
+def_ucmd tellme {
+    prefix_nick
+    ta_nomore
+    check_notonchan
+    switch -exact [tell_event [irctolower $n] tellme] {
+       ERROR - INVALID { ucmdr {} {is ill.  Help!} }
+       nomsgs { ucmdr {You have no messages.} {} }
+       default { }
+    }
+}
+
 def_ucmd tell {
     global nick_case ownmailaddr ownfullname
     
     prefix_nick
     set target [ta_word]
     if {![string length $text]} { error "tell them what?" }
+    if {[string length $text] > 400} { error "message too long" }
 
     set ltarget [irctolower $target]
     set ctarget $target
     if {[info exists nick_case($ltarget)]} { set ctarget $nick_case($ltarget) }
 
-    manyset [nickdb_get $target tellsec] sec mailtoint mailwhy
+    manyset [nickdb_get_sec_effective $target] sec mailtoint mailwhy
     manyset [nickdb_get $target tellrel] rel relint relwithin
     switch -exact $sec {
        insecure - secure {
@@ -1192,6 +1419,7 @@ def_ucmd tell {
                }
            }
            append msg .
+           tell_event $ltarget msgsarrive
            ucmdr $msg {}
        }
        mailto {
@@ -1321,15 +1549,22 @@ proc def_setting {opt show_body set_body} {
         $set_body"
 }
 
-proc tellme_sec_desc {v} {
+proc tellme_sec_desc {v n} {
     manyset $v sec mailtoint
     switch -exact $sec {
        insecure {
            return "I'll tell you your messages whenever I see you."
        }
        secure {
-           return \
+           if {[string length [nickdb_get_username $n]]} {
+               return \
  "I'll keep the bodies of your messages private until you identify yourself, reminding you every [showintervalsecs $mailtoint 1]."
+           } else {
+               return \
+ "I'll tell you your messages whenever I see you.\
+  (Secure message delivery is enabled, but your nick is not registered\
+ securely.  See `help register'.)"
+           }
        }
        refuse {
            return "I shan't accept messages for you."
@@ -1347,7 +1582,8 @@ proc tellme_rel_desc {v} {
     manyset $v rel every within
     switch -exact $rel {
        unreliable {
-           return "As soon as I've told you, I'll forget the message - note that this means messages can get lost !"
+           return "As soon as I've told you message(s), I'll forget them\
+ - note that this means messages can get lost !"
        }
        pester {
            set u {}
@@ -1359,7 +1595,8 @@ proc tellme_rel_desc {v} {
            error "bad tellrel $rel"
        }
     }
-    return "I'll remind you every [showintervalsecs $every 1] until you say delmsg$u."
+    return "After delivering messages, I'll remind you every\
+ [showintervalsecs $every 1] until you say delmsg$u."
 }
 
 def_setting timeformat {
@@ -1413,9 +1650,25 @@ def_setting security {
     }
 } {}
 
+proc tellme_setting_sec_simple {} {
+    uplevel 1 {
+       ta_nomore
+       set sr sec
+       set v $setting
+    }
+}
+
+proc tellme_setting_neednomsgs {} {
+    uplevel 1 {
+       if {[llength [msgsdb_get $n inbound]]} {
+           usererror "You must delete the messages you have, first."
+       }
+    }
+}
+
 def_setting tellme {
     set secv [nickdb_get $n tellsec]
-    set ms [tellme_sec_desc $secv]
+    set ms [tellme_sec_desc $secv $n]
     manyset $secv sec
     switch -exact $sec {
        insecure - secure {
@@ -1429,18 +1682,26 @@ def_setting tellme {
 } {
     set setting [string tolower [ta_word]]
     switch -exact $setting {
-       insecure - secure - refuse {
+       insecure {
+           tellme_setting_sec_simple
+       }
+       secure {
+           set every [ta_interval_optional 60 600]
            ta_nomore
-           if {"$setting" == "refuse" && [llength [msgsdb_get $n inbound]]} {
-               usererror "You must delete the messages you have, first."
-           }
            set sr sec
-           set v $setting
+           set v [list secure $every]
+       }
+       refuse {
+           telling_setting_neednomsgs
+           telling_setting_sec_simple
        }
        mailto {
-           set u [nickdb_get $n username]
-           if {![string length $u]} {
-               usererror "Sorry, you must register secure to have your messages mailed (to prevent the use of this feature for spamming)."
+           telling_setting_neednomsgs
+            
+           if {[string length [set u [nickdb_get_username $n]]]} {
+               usererror \
+ "Sorry, you must register securely to have your messages mailed\
+ (to prevent the use of this feature for spamming).  See `help register'."
            }
            set sr sec
            set v [list mailto [ta_word] $u]
@@ -1449,21 +1710,19 @@ def_setting tellme {
            manyset [nickdb_get $n tellsec] sec
            switch -exact $sec {
                refuse - mailto {
-                   error "can't change message delivery conditions when message disposition prevents messages from being left"
+                   usererror \
+ "You can't change your message delivery conditions when\
+ your message disposition prevents messages from being left."
                }
            }
            set sr rel
            set v $setting
            if {"$setting" != "unreliable"} {
-               set every [parse_interval [ta_word] 300]
+               set every [parse_interval_optional 300 3600]
                lappend v $every
            }
            if {"$setting" == "remind"} {
-               if {[ta_anymore]} {
-                   set within [parse_interval [ta_word] 5]
-               } else {
-                   set within 30
-               }
+               set within [ta_interval_optional 5 30]
                if {$within > $every} {
                    error "remind interval must be at least time to respond"
                }
@@ -1541,12 +1800,12 @@ def_ucmd set {
 }
 
 def_ucmd identpass {
-    set username [ta_word]
-    set passmd5 [md5sum "[ta_word]\n"]
-    ta_nomore
     prefix_nick
     check_notonchan
     set luser [irctolower $n]
+    set username [ta_word]
+    set passmd5 [md5sum "[ta_word]\n"]
+    ta_nomore
     upvar #0 nick_onchans($luser) onchans
     if {![info exists onchans] || ![llength $onchans]} {
        ucmdr "You must be on a channel with me to identify yourself." {}
@@ -1557,6 +1816,7 @@ def_ucmd identpass {
     upvar #0 nick_username($luser) rec_username
     set rec_username $username
     ucmdr "Pleased to see you, $username." {}
+    tell_event $luser ident
 }
 
 def_ucmd summon {
@@ -1655,7 +1915,7 @@ proc lnick_marktime_start {luser why ms mentiontold} {
     set mt [nickdb_get $luser marktime]
     if {"$mt" == "off"} {
        lnick_marktime_cancel $luser
-       after $ms [list lnick_checktold $luser]
+       if {$mentiontold} { after $ms [list lnick_checktold $luser] }
     } else {
        lnick_marktime_doafter $luser $why $ms $mentiontold
     }
@@ -1666,7 +1926,7 @@ proc lnick_marktime_now {luser why mentiontold} {
     global calling_nick
     set calling_nick $luser
     sendprivmsg $luser [lnick_pingstring $why $oc ""]
-    if {$mentiontold} { lnick_checktold $luser }
+    if {$mentiontold} { after 150 [list lnick_checktold $luser] }
     lnick_marktime_reset $luser
 }    
 
@@ -1716,7 +1976,7 @@ def_ucmd ping {
        }
        if {[llength $oc]} { lnick_marktime_reset $ln }
     }
-    lnick_checktold $ln
+    after 150 [list lnick_checktold $ln]
     ucmdr {} [lnick_pingstring "Pong!" $oc $text]
 }