chiark / gitweb /
finished tell_delete_msgs. Maybe all right. Check fixmes and test.
[ircbot] / bot.tcl
diff --git a/bot.tcl b/bot.tcl
index 4ea4fd8cdd1702be8c2f0f992b17d671683a5181..dc8ed93883837fd0be46a44973cf7335a87a882e 100755 (executable)
--- a/bot.tcl
+++ b/bot.tcl
@@ -18,7 +18,7 @@ proc privmsg_unlogged {prefix ischan params} {
     set chan [lindex $params 0]
     upvar #0 chan_lastactivity([irctolower $chan]) la
     set la [clock seconds]
-    catch_logged { recordlastseen_p $prefix "talking on $chan" 1 }
+    catch_logged { recordlastseen_p $prefix "talking on $chan" 2 }
     return 1
 }
 
@@ -145,11 +145,191 @@ proc looking_whenwhere {when where} {
     return $str
 }
 
+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 }
+    switch -exact $event {
+       none { }
+       talk {
+           tell_event_core $nl talk
+           tell_event $nl act
+       }
+       act {
+           after 750 [list tell_event_core $nl $event]
+       }
+       ident {
+           tell_event_core $nl $event
+       }
+       default {
+           error "tell_event $nl $event"
+       }
+    }
+    if {[info exists save]} { set calling_nick $save }
+}
+
+proc tell_event_core {nl event} {
+    # event is `talk', `act' or `ident'
+    # When user talks we actually get talk now and act later
+FIXME - implement all cmds
+FIXME - implement tells_delete_msgs catch { unset stt }   ?
+FIXME - document the extra param to recordlastseen
+    global calling_nick
+    set calling_nick $nl
+    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 u_last stt telling_when
+       if {![info exists u] || "$u_last" != "$u"} {
+           unset telling; unset stt; unset telling_when
+       }
+    }
+
+    if {![info exists stt]} {
+       set stt norecord
+       set telling_when $now
+    }
+
+    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
+    #      i   ident
+    #   security level and timing
+    #      ii  Insecure
+    #      ss  Secure and soon (before interval)
+    #      sl  Secure and late (after interval)
+    #   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 (after every-interval)
+    #      ps  Pester, soon (before interval)
+    #      pl  Pester, late (after interval)
+
+    set evstate {}
+
+    append evstate [string range $stt 0 0]
+    append evstate [string range $event 0 0]
+
+    manyset [tell_effective_sec $n] sec secwhen
+    switch -exact $sec {
+       insecure { append evstate ii }
+       secure { append evstate [expr {$ago<$secwhen ? "sl" : "ss"}] }
+       default { append evstate "#$sec#" }
+    }
+
+    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 {
+       unreliable { append evstate uu }
+       remind { append evstate [expr {
+           $ago<$relwithin ? "rv" : $ago<$relint ? "rs" : "rl"
+       }]}
+       pester { append evstate [expr {$ago<$relint ? "ps" : "pl"}] }
+       default { append evstate "#$rel#" }
+    }
+
+    switch -glob $evstate {
+       pt???rv {
+           # consider delivered:
+           #  (very recently passed, and the user talks)
+           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
+           if {[length $iml] == 3} {
+               manyset $iml sender sentwhen msg
+               sendprivmsg $nl \
+ "$sender asked me [showintervalsecs [expr {$now-$sentwhen}] 0]\
+ to tell you: $msg"
+            } else {
+               sendprivmsg $nl \
+ "Here are the [expr {[llength $iml]/3}] messages there are 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
+           }
+           set stt passed
+       }
+       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 "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} {
     global lastseen lookedfor
-    set lastseen([irctolower $n]) [list $n [clock seconds] $how]
+    set nl [irctolower $n]
+    set now [clock seconds]
+    set lastseen($nl) [list $n $now $how]
+
     if {!$here} return
-    upvar #0 lookedfor([irctolower $n]) lf
+
+    tell_event $nl [lindex {none act talk} $here]
+
+    upvar #0 lookedfor($nl) lf
     if {[info exists lf]} {
        switch -exact [llength $lf] {
            0 {
@@ -237,7 +417,7 @@ 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."
+ "Thanks.  You can use `channel manager ...' to register this channel."
            if {![nickdb_exists $n] || ![string length [nickdb_get $n username]]} {
                sendprivmsg $n \
  "(But to do that you must register your nick securely first.)"
@@ -363,9 +543,10 @@ 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_unique($luser) -> <includes-counter>
 # nick_case($luser) -> $user  (valid even if no longer visible)
 # nick_markid($luser) -> <after id for marktime>
+# nick_telling($luser) -> <unique> mentioned|passed <when>
 
 # chan_nicks($lchan) -> [list ... $luser ...]
 # chan_lastactivity($lchan) -> [clock seconds]
@@ -429,6 +610,7 @@ proc nick_ishere {n} {
 
 proc msg_JOIN {p c chan} {
     prefix_nick
+    nick_ishere $n
     recordlastseen_n $n "joining $chan" 1
     set nl [irctolower $n]
     set lchan [irctolower $chan]
@@ -440,7 +622,6 @@ proc msg_JOIN {p c chan} {
     }
     lappend oc $lchan
     lappend nlist $nl
-    nick_ishere $n
 }
 proc msg_PART {p c chan args} {
     prefix_nick
@@ -586,7 +767,7 @@ def_somedb_id delete {} {
 set default_settings_nick {
     timeformat ks
     marktime off
-    tellsec insecure
+    tellsec {secure 600}
     tellrel {remind 3600 30}
 }
 
@@ -605,6 +786,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
@@ -999,18 +1182,110 @@ def_ucmd channel {
     channel/$subcmd
 }
 
+proc tell_effective_sec {n} {
+    set l [nickdb_get $n tellsec]
+    set u [nickdb_get $n username]
+    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 tell_delete_msgs {lsenders lrecip} {
+FIXME - check callers pass l* not mixed case
+    set ninbound {}
+    set ndel 0
+    foreach {s t m} [msgsdb_get $recip inbound] {
+       if {[llength $senders]} {
+           if {[lsearch -exact $senders [irctolower $s]] == -1} {
+               lappend ninbound $s $t $m
+               continue
+           }
+       }
+       set rsenders($s) 1
+       incr ndel
+    }
+    msgsdb_set $recip inbound $ninbound
+    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 $s outbound $noutbound
+    }
+    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 $n $recip]
+    }
+    ucmdr "Removed $ndel as yet undelivered message(s)." {}
+}
+
+def_ucmd delmsg {
+    global errorInfo errorCode
+    prefix_nick
+    check_notonchan
+    manyset [tell_effective_sec $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"
+       }
+    }
+    set senders [tell_peernicks $text]
+    set ndel [tell_delete_msgs [irctolower $senders] [irctolower $n]]
+    if {!$ndel} { ucmdr "No incoming messages deleted." {} }
+    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 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 [tell_effective_sec $target] sec mailtoint mailwhy
     manyset [nickdb_get $target tellrel] rel relint relwithin
     switch -exact $sec {
        insecure - secure {
@@ -1180,15 +1455,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 $n username]]} {
+               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."
@@ -1272,9 +1554,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 {
@@ -1288,18 +1586,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
+            set u [nickdb_get $n username]
+           if {[string length $u]} {
+               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]
@@ -1308,21 +1614,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"
                }
@@ -1416,6 +1720,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 {