Implemented CTCP version and ping.
[lurk.git] / lirc.el
diff --git a/lirc.el b/lirc.el
index db78af8..e6f47fb 100644 (file)
--- a/lirc.el
+++ b/lirc.el
@@ -1,4 +1,4 @@
-;;; lirc.el --- Lambdalabs irc client  -*- lexical-binding:t -*-
+;;; lirc.el --- Lightweight irc client  -*- lexical-binding:t -*-
 
 ;; Copyright (C) 2021 Tim Vaughan
 
@@ -28,7 +28,7 @@
 
 ;;; Code:
 
-(provide 'lerc)
+(provide 'lirc)
 
 ;;; Customizations
 ;;
 (defcustom lirc-port 6667
   "Default port.")
 
-(defcustom lirc-prompt "> "
+(defcustom lirc-prompt-string "> "
   "Prompt.")
 
 ;;; Faces
 ;;
 
+(defface lirc-text
+  '((t :inherit font-lock-preprocessor-face))
+  "Face used for Lirc text.")
+
+(defface lirc-your-nick
+  '((t :inherit font-lock-constant-face))
+  "Face used for highlighting your nick.")
+
+(defface lirc-prompt
+  '((t :inherit org-level-2))
+  "Face used for the prompt.")
+
+(defface lirc-channel
+  '((t :inherit org-list-dt))
+  "Face used for the channel name in the prompt.")
+
 ;;; Global variables
 ;;
 
-(defvar lirc-current-channel nil)
-(defvar lirc-channel-list nil)
+(defvar lirc-version "Lirc v0.1")
+
+
+;;; Network process
+;;
 
 (defvar lirc-response "")
 
 (defun lirc-filter (proc string)
   (dolist (line (split-string (concat lirc-response string) "\n"))
     (if (string-suffix-p "\r" line)
-        (lirc-process-msg-string (string-trim line))
+        (lirc-eval-msg-string (string-trim line))
       (setq lirc-response line))))
 
 (defun lirc-get-process ()
@@ -79,6 +98,9 @@
                             :nowait t
                             :buffer "*lirc*"))))
 
+;;; Messages
+;;
+
 (defun lirc-as-string (obj)
   (if obj
       (with-output-to-string (princ obj))
   (rx
    (opt (: "@" (group (* (not (or "\n" "\r" ";" " ")))))
         (* whitespace))
-   (opt (: ":" (group (* (not (or "\n" "\r" " ")))))
+   (opt (: ":" (: (group (* (not (any space "!" "@"))))
+                  (* (not (any space)))))
         (* whitespace))
    (group (: (* (not whitespace))))
    (* whitespace)
-   (opt (group (+ not-newline)))))
+   (opt (group (+ not-newline))))
+  "Regex used to parse IRC messages.
+Note that this regex is incomplete.  Noteably, we discard the non-nick
+portion of the source component of the message, as LIRC doesn't use this.")
 
 (defun lirc-string->msg (string)
   (if (string-match lirc-msg-regex string)
          (concat ":" (elt params (- (length params) 1)))
        nil))))
 
-(defun lirc-display-string (string)
-  (with-current-buffer "*lirc*"
-    (let ((inhibit-read-only t))
-      (save-excursion
-        (goto-char (point-max))
-        (insert (propertize (concat string "\n") 'read-only t))))))
 
-(defun lirc-process-msg-string (string)
-  (let* ((msg (lirc-string->msg string)))
-    (cond
-     ((equal (lirc-msg-cmd msg) "PING")
-      (lirc-send-msg
-       (lirc-msg nil nil "PONG" (lirc-msg-params msg))))
-     ((string-match (rx (= 3 digit)) (lirc-msg-cmd msg))
-      (lirc-display-string (string-join (cdr (lirc-msg-params msg)) " ")))
-     (t
-      (lirc-display-string (lirc-msg->string msg))))))
+;;; Channels
+;;
+
+(defvar lirc-current-channel nil)
+(defvar lirc-channel-list nil)
+
+(defun lirc-add-channel (channel-name)
+  (add-to-list 'lirc-channel-list
+               (list channel-name)))
+
+(defun lirc-del-channel (channel-name)
+  (setq lirc-channel-list
+        (assoc-delete-all channel-name lirc-channel-list)))
+
+(defun lirc-get-channel-users (channel-name)
+  (cdr (assoc channel-name lirc-channel-list)))
+
+(defun lirc-set-channel-users (channel-name users)
+  (setcdr (assoc channel-name lirc-channel-list) users))
+
+(defun lirc-add-channel-users (channel-name &rest users)
+  (let ((current-users (lirc-get-channel-users channel-name)))
+    (lirc-set-channel-users channel-name (append users current-users))))
+
+(defun lirc-del-channel-users (channel-name &rest users)
+  (let ((current-users (lirc-get-channel-users channel-name)))
+    (lirc-set-channel-users channel-name
+                            (cl-set-difference current-users users :test #'equal))))
+
+
+;;; Buffer
+;;
+
+(defun lirc-display-string (&rest strings)
+  (with-current-buffer (get-buffer-create "*lirc*")
+    (save-excursion
+      (goto-char lirc-prompt-marker)
+      (let ((inhibit-read-only t))
+        (insert-before-markers
+         (propertize (concat (format-time-string "%H:%M") " ")
+                     'face 'lirc-text
+                     'read-only t)
+         (propertize (concat (apply #'concat strings) "\n")
+                     'read-only t))))))
 
 (defun lirc-connect ()
   (lirc-send-msg (lirc-msg nil nil "USER" lirc-user-name 0 "*" lirc-full-name))
 (defun lirc-send-msg (msg)
   (let ((proc (lirc-get-process)))
     (process-send-string proc (concat (lirc-msg->string msg) "\r\n"))))
+
+(defun lirc-render-prompt ()
+  (with-current-buffer "*lirc*"
+    (set-marker-insertion-type lirc-prompt-marker nil)
+    (set-marker-insertion-type lirc-input-marker t)
+    (save-excursion
+      (let ((inhibit-read-only t))
+        (delete-region lirc-prompt-marker lirc-input-marker)
+        (goto-char lirc-prompt-marker)
+        (insert
+         (propertize (if lirc-current-channel
+                         lirc-current-channel
+                       "[no channel]")
+                     'face 'lirc-channel
+                     'read-only t)
+         (propertize lirc-prompt-string
+                     'face 'lirc-prompt
+                     'read-only t
+                     'rear-nonsticky t)))))
+  (set-marker-insertion-type lirc-input-marker nil))
   
+(defvar lirc-prompt-marker nil
+  "Marker for prompt position in LIRC buffer.")
+
+(defvar lirc-input-marker nil
+  "Marker for prompt position in LIRC buffer.")
+
+(defun lirc-setup-buffer ()
+  (with-current-buffer (get-buffer-create "*lirc*")
+    (if (markerp lirc-prompt-marker)
+        (set-marker lirc-prompt-marker (point-max))
+      (setq lirc-prompt-marker (point-max-marker)))
+    (if (markerp lirc-input-marker)
+        (set-marker lirc-input-marker (point-max))
+      (setq lirc-input-marker (point-max-marker)))
+    (lirc-render-prompt)
+    (goto-char (point-max))
+    (recenter -1)))
+
+
+;;; Output formatting
+;;
+
+(defun lirc-display-action (channel nick action)
+  (lirc-display-string (concat " * "
+                               (propertize (concat nick " " action)
+                                           'face 'lirc-text))))
+
+(defun lirc-display-message (channel nick message)
+  (lirc-display-string
+   (concat
+    (propertize (concat channel " ")
+                'face 'lirc-text)
+    (propertize (concat "<" nick "> ")
+                'face
+                (if (equal nick lirc-nick)
+                    'lirc-your-nick
+                  'lirc-text))
+    (propertize message 'face 'lirc-text))))
+
+(defun lirc-display-notice (&rest notices)
+  (lirc-display-string "*** " (apply #'concat notices)))
+
+;;; Message evaluation
+;;
+
+(defun lirc-eval-msg-string (string)
+  ;; (lirc-display-string string)
+  (let* ((msg (lirc-string->msg string)))
+    (pcase (lirc-msg-cmd msg)
+      ("PING"
+       (lirc-send-msg
+        (lirc-msg nil nil "PONG" (lirc-msg-params msg))))
+
+      ("353" ; NAMEREPLY
+       (let* ((params (lirc-msg-params msg))
+              (channel (elt params 2))
+              (names (split-string (elt params 3))))
+         (apply #'lirc-add-channel-users (cons channel names))))
+
+      ((rx (= 3 (any digit)))
+       (lirc-display-notice (mapconcat 'identity (cdr (lirc-msg-params msg)) " ")))
+
+      ((and "JOIN"
+            (guard (equal lirc-nick (lirc-msg-src msg))))
+       (let ((channel (car (lirc-msg-params msg))))
+         (setq lirc-current-channel channel)
+         (lirc-add-channel channel)
+         (lirc-render-prompt)))
+
+      ("JOIN"
+       (let ((channel (car (lirc-msg-params msg)))
+             (nick (lirc-msg-src msg)))
+         (lirc-add-channel-users channel nick)))
+
+      ((and "PART"
+            (guard (equal lirc-nick (lirc-msg-src msg))))
+       (setq lirc-current-channel nil)
+       (lirc-del-channel (car (lirc-msg-params msg)))
+       (lirc-render-prompt))
+
+      ("PART"
+       (let ((channel (car (lirc-msg-params msg)))
+             (nick (lirc-msg-src msg)))
+         (lirc-del-channel-users channel nick)
+         (lirc-display-notice nick " left channel " channel)))
+
+      ("QUIT"
+       (let ((nick (lirc-msg-src msg))
+             (reason (mapconcat 'identity (lirc-msg-params msg) " ")))
+         (lirc-del-users nick)
+         (lirc-display-notice nick " quit: " reason)))
+
+      ((and "NICK"
+            (guard (equal lirc-nick (lirc-msg-src msg))))
+       (setq lirc-nick (car (lirc-msg-params msg)))
+       (lirc-display-notice "Set nick to " lirc-nick))
+
+      ("NOTICE"
+       (let ((nick (lirc-msg-src msg))
+             (channel (car (lirc-msg-params msg)))
+             (text (cadr (lirc-msg-params msg))))
+         (pcase text
+           ((rx (: "\01VERSION "
+                   (let version (* (not "\01")))
+                   "\01"))
+            (lirc-display-notice "CTCP version reply from " nick ": " version)))))
+
+      ("PRIVMSG"
+       (let ((nick (lirc-msg-src msg))
+             (channel (car (lirc-msg-params msg)))
+             (text (cadr (lirc-msg-params msg))))
+         (pcase text
+           ((rx (: "\01ACTION "
+                   (let action (* (not "\01")))
+                   "\01"))
+            (lirc-display-action nick action))
+
+           ("\01VERSION\01"
+            (let ((version-string (concat lirc-version " - running on GNU Emacs " emacs-version)))
+              (lirc-send-msg (lirc-msg nil nil "NOTICE"
+                                       (list nick (concat "\01VERSION "
+                                                          version-string
+                                                          "\01")))))
+            (lirc-display-notice "CTCP version request received from " nick))
+
+           ((rx (let ping (: "\01PING " (* (not "\01")) "\01")))
+            (lirc-send-msg (lirc-msg nil nil "NOTICE" (list nick ping)))
+            (lirc-display-notice "CTCP ping received from " nick))
+
+           ("\01USERINFO\01"
+            (lirc-display-notice "CTCP userinfo request from " nick " (no response sent)"))
+
+           (_
+            (lirc-display-message channel nick text)))))
+      (_
+       (lirc-display-string (lirc-msg->string msg))))))
+
+
+;;; Command entering
+;;
+
+(defun lirc-enter-string (string)
+  (if (string-prefix-p "/" string)
+      (pcase (substring string 1)
+        ((rx (: "TOPIC" " " (let new-topic (* not-newline))))
+         (lirc-send-msg (lirc-msg nil nil "TOPIC" lirc-current-channel new-topic)))
+
+        ((rx (: "me" " " (let action (* not-newline))))
+         (lirc-send-msg (lirc-msg nil nil "PRIVMSG"
+                                  (list lirc-current-channel
+                                        (concat "\01ACTION " action "\01"))))
+         (lirc-display-action lirc-nick action))
+
+        ((rx (: "VERSION" " " (let nick (* (not whitespace)))))
+         (lirc-send-msg (lirc-msg nil nil "PRIVMSG"
+                                  (list nick "\01VERSION\01")))
+         (lirc-display-notice "CTCP version request sent to " nick))
+
+        ((rx "PART")
+         (lirc-send-msg (lirc-msg nil nil "PART" lirc-current-channel)))
+
+        ((rx (: (let cmd-str (+ (not whitespace)))
+                (opt (: " " (let params-str (* not-newline))))))
+         (lirc-send-msg (lirc-msg nil nil (upcase cmd-str)
+                                  (if params-str
+                                      (split-string params-str)
+                                    nil)))))
+
+    (unless (string-empty-p string)
+      (lirc-send-msg (lirc-msg nil nil "PRIVMSG" lirc-current-channel string))
+      (lirc-display-message lirc-current-channel lirc-nick string))))
+
+(defun lirc-enter ()
+  "Enter current contents of line after prompt."
+  (interactive)
+  (with-current-buffer "*lirc*"
+    (lirc-enter-string
+     (buffer-substring lirc-input-marker (point-max)))
+    (let ((inhibit-read-only t))
+      (delete-region lirc-input-marker (point-max)))))
+
+
+
+;;; Mode
+;;
+
+(defvar lirc-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map (kbd "RET") 'lirc-enter)
+    map))
+
+(define-derived-mode lirc-mode text-mode "lirc"
+  "Major mode for LIRC.")
+
+(when (fboundp 'evil-set-initial-state)
+  (evil-set-initial-state 'lirc-mode 'insert))
+
+;;; Main start procedure
+;;
 
 (defun lirc ()
   "Switch to *lirc* buffer."
   (interactive)
-  (pop-to-buffer-same-window "*lirc*")
+  (if (get-buffer "*lirc*")
+      (switch-to-buffer "*lirc*")
+    (switch-to-buffer "*lirc*"))
   (lirc-mode)
-  (lirc-connect))
+  (lirc-setup-buffer)
+  (lirc-connect)
+  "Started LIRC.")
 
-(define-derived-mode lirc-mode text-mode "lirc"
-  "Major mode for LIRC.")
 
 
 ;;; lirc.el ends here
-:bs-mbpr348.d.ethz.ch