egg-tcls: tj.tcl comparison

comparison tj.tcl @ 644:77c9feb5dcee

tj: Add numerous comments.

author	Matti Hamalainen <ccr@tnsp.org>
date	Tue, 16 Feb 2021 13:06:50 +0200
parents	5cbff6baebef
children	cf62cdc44568

comparison

equal deleted inserted replaced

-:1b743b80524b
+:77c9feb5dcee
 set rdesc "*"
 if {![tj_get_id $rarg rindex uid]} {
 set uid [tj_get_default_id $uhand]
 }
+# Do we have any arguments left?
 if {![utl_arg_get $rarglist rindex rarg 1]} {
 tj_msg $upublic $unick $uchan "help_set"
 return 1
 }
 } elseif {[regexp {(\+|\-)?(\d+)} $rarg -> dsign rdays]} {
 # Check for days
 if {$dsign == "-"} { set rdays [expr -$rdays] }
+# Check for hours
 set rhours 0
 if {[utl_arg_get $rarglist rindex rarg 0]} {
 if {[regexp {(\+|\-)?(\d+)} $rarg -> hsign rhours]} {
 if {$hsign == "-"} { set rhours [expr -$rhours] }
 incr rindex
 }
+# Get description, if any
 tj_arg_rest $rarglist $rindex rdesc
+# Validate hours parameters a bit
 if {$rhours < -24 || $rhours > 24} {
 tj_msg $upublic $unick $uchan "err_invalid_hours" [list $rhours]
 return 1
 }
 }
 # Compute target timestamp
 set rstamp [expr $uclock + ($rdays * 24 * 60 * 60) + ($rhours * 60 * 60)]
 } else {
-# Only description, if any
+# Only description was specified
 incr rindex -1
 tj_arg_rest $rarglist $rindex rdesc
 set rstamp "invalid"
 }
 set usql "SELECT * FROM tj WHERE uid LIKE '[utl_escape $uid]'"
 tj_dbh eval $usql {
 set umode 0
 set cid $id
 set ctarget $utarget
+# If description has not been set, fetch previous
 if {$rdesc == "*"} {
 set rdesc $udesc
 }
 incr nres
 }
-# Check for DB sanity
+# Check for DB sanity at this point
 if {$nres > 1} {
+# If we have more than one result for this ID, there's been
+# some kind of mistake at some point.
 tj_msg $upublic $unick $uchan "err_db_corrupt" [list $nres]
 tj_log "too many $nres fatal error piip"
 return 1
 }
 # Check if we are trying to add a new entry without valid timestamp
 if {$rstamp == "invalid"} {
+# Yes, if mode is "new", we should error out
 if {$umode} {
 tj_msg $upublic $unick $uchan "err_missing_timestamp"
 return 1
 }
+# Otherwise we are updating, so just use the old timestamp
 set rdate $ctarget
 set ustamp [utl_sql_datetime_to_stamp $ctarget]
 } else {
+# Timestamp was okay
 set rdate [utl_sql_stamp_to_datetime $rstamp]
 set ustamp $rstamp
 }
+# If description has not been set, use default
 if {$rdesc == "*"} {
 set rdesc $tj_default_desc
 }
 set utjstr [tj_get_tj_str_delta $ustamp $uclock]
 set udate [tj_ctime $ustamp]
-# Max reminders ..
+# Check against max reminders ..
 set usql "SELECT COUNT(*) FROM tj WHERE uuser='[utl_escape $uhand]'"
 if {[catch {set nitems [tj_dbh onecolumn $usql]} uerrmsg]} {
 tj_msg $upublic $unick $uchan "err_sql" [list $uerrmsg]
 tj_log "$uerrmsg on SQL:\n$usql"
 return 1
 }
-# Check for maximum reminders
 if {$nitems >= $tj_max_items} {
+# User has too many set already
 tj_msg $upublic $unick $uchan "err_too_many" [list $nitems $tj_max_items]
 return 1
 }
 set ucreated [utl_sql_stamp_to_datetime $uclock]
 tj_log "$uerrmsg on SQL:\n$usql"
 return 1
 }
 }
+# Do a query
 set usql "SELECT * FROM tj WHERE uuser='[utl_escape $uhand]' AND uid LIKE '[utl_escape $uid]'"
 tj_dbh eval $usql {
 set utjstr [tj_get_tj_str_delta [utl_sql_datetime_to_stamp $utarget] $uclock]
 tj_msg $upublic $unick $uchan "tj_updated" [list $id $uid $uhand $udesc $udate $utjstr]
 tj_log "tj_updated $id:$uid:$uhand:$udesc:$utarget"
 }
 }
 } elseif {[tj_cmd_match "remind" $rcmd]} {
+# XXX TODO MAYBE .. reminder functionality .. perhaps some day.
 # !tj remind #<id> <<dd.mm.yyyy [hh:mm]>|<message>>
 # !tj remind #<id> <<dd.mm [hh:mm]>|<message>>
 if {[llength $rarglist] < 3} {
 tj_msg $upublic $unick $uchan "help_add"
 return 1
 set uname [tj_correct_handle $uname]
 } else {
 set uname $uhand
 }
+# First, get count of items
 set usql "SELECT COUNT(*) FROM tj WHERE uuser='[utl_escape $uname]'"
 if {[catch {set nitems [tj_dbh onecolumn $usql]} uerrmsg]} {
 tj_msg $upublic $unick $uchan "err_sql" [list $uerrmsg]
 tj_log "$uerrmsg on SQL:\n$usql"
 return 1
 }
+# Then, list items
 set nitem 0
 set usql "SELECT * FROM tj WHERE uuser='[utl_escape $uname]' ORDER BY ucreated"
 tj_dbh eval $usql {
 incr nitem
 set qtarget [utl_sql_datetime_to_stamp $utarget]
 if {![utl_arg_get $rarglist rindex rarg 0] || ![tj_get_id $rarg rindex uid]} {
 tj_msg $upublic $unick $uchan "help_delete"
 return 1
 }
+# Check if the desired item exists
 set usql "SELECT COUNT(*) FROM tj WHERE uuser='[utl_escape $uhand]' AND uid LIKE '[utl_escape $uid]'"
 if {[catch {set nitems [tj_dbh onecolumn $usql]} uerrmsg]} {
 tj_msg $upublic $unick $uchan "err_sql" [list $uerrmsg]
 tj_log "$uerrmsg on SQL:\n$usql"
 return 1
 }
 if {$nitems == 0} {
+# No, error out
 tj_msg $upublic $unick $uchan "err_no_such_id" [list $uid]
 return 1
 }
+# Delete it
 set usql "DELETE FROM tj WHERE uuser='[utl_escape $uhand]' AND uid LIKE '[utl_escape $uid]'"
 if {[catch {set ndone [tj_dbh onecolumn $usql]} uerrmsg]} {
 tj_msg $upublic $unick $uchan "err_sql" [list $uerrmsg]
 tj_log "$uerrmsg on SQL:\n$usql"
 return 1

Mercurial > hg > egg-tcls

comparison tj.tcl @ 644:77c9feb5dcee