chiark / gitweb /
Change telling => tell in many places. Improve some comments.
[ircbot] / bot.tcl
diff --git a/bot.tcl b/bot.tcl
index 01113635984261ec7cf107ea807355c0de497859..315163fd8e02284a849a5d9ed7b0600e8dba6a9d 100755 (executable)
--- a/bot.tcl
+++ b/bot.tcl
@@ -145,31 +145,36 @@ proc looking_whenwhere {when where} {
     return $str
 }
 
-proc check_telling {nl event} {
-    # for all except `talk' we delay 750ms
+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.
     switch -exact $event {
-       none {
-       }
+       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 {
+           tell_event_core $nl $event
        }
        default {
-           error "check_telling $nl $event"
+           error "tell_event $nl $event"
        }
     }
 }
 
-proc check_telling_core {nl event} {
-    # event is `talk' or `act'
+proc tell_event_core {nl event} {
+    # event is `talk', `act' or `ident'
     # 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 }   ?
+FIXME - implement pass stuff       set stt [list $u passed $now]
+FIXME - implement tells_delete_msgs catch { unset stt }   ?
+FIXME - document the extra param to recordlastseen
     set iml [msgdb_get $nl inbound]
     if {![llength $iml]} return
 
@@ -177,8 +182,10 @@ FIXME - implement tells_delete                 catch { unset stt }   ?
     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 }
+       manyset $telling u_last stt telling_when
+       if {![info exists u] || "$u_last" != "$u"} {
+           unset telling; unset stt; unset telling_when
+       }
     }
 
     if {![info exists stt]} {
@@ -188,41 +195,55 @@ FIXME - implement tells_delete                catch { unset stt }   ?
 
     set ago [expr {$now - $telling_when}]
 
+    # Now we have the components of a telling state
+    #   u     - nick_unique (unset if not visible)
+    #   stt   - state: norecord, 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
+    #      n   NORECORD (MESSAGES)
+    #      m   MENTIONED
+    #      p   PASSED
     #   event
     #      t   talk
     #      a   act
-    #      c   come
+    #      i   ident
     #   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)
+
+    set evstate {}
+
+    append evstate [string range $stt 0 0]
+    append evstate [string range $event 0 0]
 
     manyset [nickdb_get $n tellsec] 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 ? "sl" : "ss"}] }
+       default { append evstate "#$sec#" }
     }
 
-    append evstate [string range $stt 0 0]
+    upvar #0 nick_username($nl) nu
+    if {[info exists nu] && "$nu" == "[nickdb_get $nl username]"} {
+       append evstate i
+    } else {
+       append evstate u
+    }
     
     manyset [nickdb_set $n tellrel] rel relint relwithin
     switch -exact $rel {
@@ -234,49 +255,47 @@ 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"}]
-
     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
+       }
+       nt????? - mt????? -
+       pt???uu - pt???rs - pt???rl - pt???p? {
+           # ignore (any other `talk's) - act handles these
+           return
+       }
+       ni????? - naii??? - nas?i?? - mi????? - pa????l {
+           # pass and then stuff
+           
+
+           return
+       }
+       nas?u?? {
+           sendprivmsg $nl {You have messages (so identify yourself please).}]
+           set stt mentioned
+       }
+       masl??? {
+           sendprivmsg $nl {Don't forget about your messages.}]
+       }
+       pi????? {
+           return
+       }
+       mass??? - pa????v - pa????s {
+           # too soon
+           return
        }
        * {
-           error "check_telling_core nl=$nl evstate=$evstate ?"
+           error "tell_event_core nl=$nl evstate=$evstate ?"
        }
     }
+    if {![info exists u]} {
+       catch { unset telling }
+    } else {
+       set telling [list $u $stt $now]
+    }
 }
 
 proc recordlastseen_n {n how here} {
@@ -287,7 +306,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]} {
@@ -730,6 +749,11 @@ set default_settings_nick {
     tellsec insecure
     tellrel {remind 3600 30}
 }
+# also:
+#  inbound: concatenation of many   sender time_t text
+#  outbound: concatenation of many   recipient time_t count
+#   neither are sorted particularly; only one entry per recipient in
+#   output; both sender and recipient are cased
 
 set default_settings_chan {
     autojoin 1
@@ -1557,6 +1581,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 {