Add TODOs

[tt.git] / tt

diff --git a/tt b/tt
index 0b590e3..32606b8 100755 (executable)
--- a/tt
+++ b/tt
@@ -1,6 +1,42 @@
 #! /usr/bin/env racket
 ; vim: filetype=racket
 
+; TODO write
+; TODO caching (use cache by default, unless explicitly asked for update)
+; TODO timeline limits
+; TODO user-defined feed sets (a la twitter lists)
+; TODO feed set operations
+; TODO timeline as a result of a query (feed set op + filter expressions)
+; TODO named timelines
+; TODO CLI params
+; TODO config files
+; TODO parse mentions:
+; - @<source.nick source.url> | @<source.url>
+; TODO highlight mentions
+; TODO filter on mentions
+; TODO highlight hashtags
+; TODO filter on hashtags
+; TODO hashtags as channels? initial hashtag special?
+; TODO query language
+; TODO concurrency
+; TODO console logger colors by level ('error)
+; TODO file logger ('debug)
+; TODO commands:
+; - r | read
+;   - see timeline ops above
+; - w | write
+;   - arg or stdin
+;   - nick expand to URI
+; - q | query
+;   - see timeline ops above
+;   - see hashtag and channels above
+; - d | download
+; - u | upload
+;   - calls user-configured command to upload user's own feed file to their server
+; TODO user-agent format: <client>/<version> (+<source.url>; @<source.nick>)
+;   - requires configurability
+;   - ref: https://twtxt.readthedocs.io/en/latest/user/discoverability.html
+
 #lang racket
 
 (require racket/date)
@@ -11,8 +47,16 @@
 (struct msg  (tm_epoch tm_rfc3339 nick text))
 (struct feed (nick uri))
 
-(define (str->lines str)
-  (string-split str (regexp "[\r\n]+")))
+(define (msg-print odd m)
+  (printf "~a \033[1;37m<~a>\033[0m \033[0;~am~a\033[0m~n"
+          (date->string (seconds->date [msg-tm_epoch m]) #t)
+          [msg-nick m]
+          [if odd 36 33]
+          [msg-text m]))
+
+(define re-msg-begin
+  ; TODO Zulu offset. Maybe in several formats. Which ones?
+  (pregexp "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}"))
 
 (define (str->msg nick str)
   (if (not (regexp-match? re-msg-begin str))
@@ -37,6 +81,9 @@
                                    [rfc3339-record:year   t])])
           (msg tm_epoch tm_rfc3339 nick tok_text))))))
 
+(define (str->lines str)
+  (string-split str (regexp "[\r\n]+")))
+
 (define (str->msgs nick str)
   (filter-map (λ (line) (str->msg nick line)) (str->lines str)))
 
@@ -50,52 +97,36 @@
   ; TODO Handle redirects
   (if (= status 200) body (raise status)))
 
-(define re-msg-begin
-  ; TODO Zulu offset. Maybe in several formats. Which ones?
-  (let ([timestamp "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}"])
-    (pregexp (string-append "^" timestamp))))
-
-(define (msg-print odd m)
-  (printf "~a \033[1;37m<~a>\033[0m \033[0;~am~a\033[0m~n"
-          (date->string (seconds->date [msg-tm_epoch m]) #t)
-          [msg-nick m]
-          [if odd 36 33]
-          [msg-text m]))
-
 (define (timeline-print timeline)
   (for ([msg timeline]
         [i   (in-naturals)])
     (msg-print (odd? i) msg)))
 
+(define (feed->msgs feed)
+  (log-info "downloading feed nick:~a uri:~a"
+            (feed-nick feed)
+            (feed-uri feed))
+  (with-handlers
+    ([exn:fail:network?
+       (λ (e)
+          (log-error "network error nick:~a uri:~a  exn:~a"
+                     (feed-nick feed)
+                     (feed-uri feed)
+                     e)
+          #f)]
+     [integer?
+       (λ (status)
+          (log-error "http error nick:~a uri:~a  status:~a"
+                     (feed-nick feed)
+                     (feed-uri feed)
+                     status)
+          #f)])
+    (str->msgs [feed-nick feed] [uri-fetch (feed-uri feed)])))
+
+; TODO timeline contract : time-sorted list of messages
 (define (timeline feeds)
-  (let* ([timelines
-           (filter-map
-             (λ (feed)
-                (log-info "processing feed nick:~a uri:~a"
-                          (feed-nick feed)
-                          (feed-uri feed))
-                (with-handlers
-                  ([exn:fail:network?
-                     (λ (e)
-                        (log-error "network error nick:~a uri:~a  exn:~a"
-                                   (feed-nick feed)
-                                   (feed-uri feed)
-                                   e)
-                        #f)]
-                   [integer?
-                     (λ (status)
-                        (log-error "http error nick:~a uri:~a  status:~a"
-                                   (feed-nick feed)
-                                   (feed-uri feed)
-                                   status)
-                        #f)])
-                  (str->msgs [feed-nick feed] [uri-fetch (feed-uri feed)])))
-             feeds)]
-         [timeline
-           (append* timelines)]
-         [timeline
-           (sort timeline (λ (a b) [< (msg-tm_epoch a) (msg-tm_epoch b)]))])
-    timeline))
+  (sort (append* (filter-map feed->msgs feeds))
+        (λ (a b) [< (msg-tm_epoch a) (msg-tm_epoch b)])))
 
 (define (we-are-twtxt)
   (let* ([uri
@@ -106,6 +137,7 @@
            (str->lines payload)]
          [feeds
            (map (λ (line)
+                   ; TODO validation
                    (define toks (string-split line))
                    (feed
                      [list-ref toks 0]
@@ -113,7 +145,7 @@
                 lines)])
     feeds))
 
-(define (logging)
+(define (setup-logging)
   (define logger (make-logger #f #f 'debug #f))
   (define log-chan (make-log-receiver logger 'debug))
   (void (thread (λ ()
@@ -128,11 +160,12 @@
   (current-logger logger))
 
 (define (main)
-  (logging)
-  (define feeds (we-are-twtxt))
+  (setup-logging)
   (current-http-response-auto #f)
-  (current-http-user-agent "tt 0.0.0")
+  (current-http-user-agent "xandkar/tt 0.0.0")
   (date-display-format 'rfc2822)
+
+  (define feeds (we-are-twtxt))
   (timeline-print (timeline feeds)))
 
 (main)