X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=murk.el;h=ffe10e6d0e2da03645e8c9104f61f84898532130;hb=af0002ab9d15c31a8286dcbd8335e0637eae5d9c;hp=6ae751999f0c3589350c62d25803bd6b229568ea;hpb=075a68ab59c557bc8ba6eccd4e64fcb02a74e1fc;p=lurk.git diff --git a/murk.el b/murk.el index 6ae7519..ffe10e6 100644 --- a/murk.el +++ b/murk.el @@ -1,13 +1,13 @@ -;;; MURK --- Multiserver Unibuffer iRc Klient -*- lexical-binding:t -*- +;;; murk.el --- Multiserver Unibuffer iRc Klient -*- lexical-binding:t -*- ;; Copyright (C) 2024 plugd ;; Author: plugd ;; Created: 11 May 2024 ;; Version: 0.0 -;; Keywords: network ;; Homepage: http://thelambdalab.xyz/murk -;; Package-Requires: ((emacs "26")) +;; Keywords: comm +;; Package-Requires: ((emacs "26.1")) ;; This file is not part of GNU Emacs. @@ -26,10 +26,14 @@ ;;; Commentary: +;; A very simple IRC server which uses only a single buffer. + ;;; Code: (provide 'murk) +(require 'cl-lib) + ;;; Customizations @@ -37,19 +41,25 @@ "Multiserver Unibuffer iRc Klient" :group 'network) -(defcustom murk-nick "plugd" - "Default nick.") +(defcustom murk-default-nick "plugd" + "Default nick." + :type '(string)) (defcustom murk-default-quit-msg "Bye" - "Default quit message when none supplied.") + "Default quit message when none supplied." + :type '(string)) (defcustom murk-networks - '(("libera" "irc.libera.chat" 6697) - ("tilde" "tilde.chat" 6697)) - "IRC networks.") + '(("debug" "localhost" 6667 :notls) + ("libera" "irc.libera.chat" 6697) + ("tilde" "tilde.chat" 6697) + ("freenode" "chat.freenode.net" 6697)) + "IRC networks." + :type '(alist :key-type string)) (defcustom murk-display-header t - "If non-nil, use buffer header to display information on current host and channel.") + "If non-nil, use buffer header to display current host and channel." + :type '(boolean)) ;;; Faces @@ -97,6 +107,7 @@ (defvar murk-debug nil "If non-nil, enable debug mode.") + ;;; Utility procedures ;; @@ -108,6 +119,7 @@ (with-output-to-string (princ obj)) nil)) + ;;; Network processes ;; @@ -118,30 +130,42 @@ This includes the process and the response string.") (defun murk-connection-process (server) (elt (assoc server murk-connection-table) 1)) -(defun murk-connection-response (server) +(defun murk-connection-nick (server) (elt (assoc server murk-connection-table) 2)) +(defun murk-set-connection-nick (server nick) + (setf (elt (assoc server murk-connection-table) 2) nick)) + +(defun murk-connection-response (server) + (elt (assoc server murk-connection-table) 3)) + (defun murk-set-connection-response (server string) - (setf (elt (assoc server murk-connection-table) 2) string)) + (setf (elt (assoc server murk-connection-table) 3) string)) + +(defun murk-connection-new (server process nick) + (add-to-list 'murk-connection-table + (list server process nick ""))) -(defun murk-connection-close (server) - (setq murk-connection-table (assoc-delete-all server murk-connection-table))) +(defun murk-connection-remove (server) + (setq murk-connection-table + (seq-remove (lambda (row) (equal (car row) server)) + murk-connection-table))) (defun murk-make-server-filter (server) - (lambda (proc string) + (lambda (_proc string) (dolist (line (split-string (concat (murk-connection-response server) string) "\n")) (if (string-suffix-p "\r" line) (murk-eval-msg-string server (string-trim line)) - (murk-set-connection-response line))))) + (murk-set-connection-response server line))))) (defun murk-make-server-sentinel (server) - (lambda (proc string) + (lambda (_proc string) (unless (equal "open" (string-trim string)) (murk-display-error "Disconnected from server.") - (murk-remove-contexts-for-server server) - (murk-render-prompt) - (murk-connection-close server)))) + (murk-connection-remove server) + (murk-remove-server-contexts server) + (murk-render-prompt)))) (defun murk-start-process (server) (let* ((row (assoc server murk-networks)) @@ -169,14 +193,15 @@ This includes the process and the response string.") (defun murk-connect (server) (if (assoc server murk-connection-table) - (murk-display-error "Already connected to this network.") + (murk-display-error "Already connected to this network") (if (not (assoc server murk-networks)) (murk-display-error "Network '" server "' is unknown.") (let ((proc (murk-start-process server))) - (add-to-list murk-connection-table - (list server proc ""))) - (murk-send-msg server (murk-msg nil nil "USER" murk-nick 0 "*" murk-nick)) - (murk-send-msg server (murk-msg nil nil "NICK" murk-nick))))) + (murk-connection-new server proc murk-default-nick)) + (murk-send-msg server (murk-msg nil nil "USER" murk-default-nick 0 "*" murk-default-nick)) + (murk-send-msg server (murk-msg nil nil "NICK" murk-default-nick)) + (murk-add-context (list server)) + (murk-render-prompt)))) (defun murk-send-msg (server msg) (if murk-debug @@ -184,8 +209,8 @@ This includes the process and the response string.") (let ((proc (murk-connection-process server))) (if (and proc (eq (process-status proc) 'open)) (process-send-string proc (concat (murk-msg->string msg) "\r\n")) - (murk-display-error "No server connection established.") - (error "No server connection established")))) + (murk-display-error "No server connection established")))) + ;;; Server messages ;; @@ -230,13 +255,13 @@ portion of the source component of the message, as mURK doesn't use this.") (params-str (match-string 4 string)) (params (if params-str - (let* ((idx (cl-search ":" params-str)) + (let* ((idx (seq-position params-str ?:)) (l (split-string (string-trim (substring params-str 0 idx)))) (r (if idx (list (substring params-str (+ 1 idx))) nil))) (append l r)) nil))) (apply #'murk-msg (append (list tags src cmd) params))) - (error "Failed to parse string " string))) + (error "Failed to parse string %s" string))) (defun murk-msg->string (msg) (let ((tags (murk-msg-tags msg)) @@ -255,12 +280,12 @@ portion of the source component of the message, as mURK doesn't use this.") nil)))) -;;; Contexts and Servers +;;; Contexts ;; -;; A context is a list (server name ...) where name is a string -;; representing either a channel name or nick, and server is a symbol -;; identifying the server. +;; A context is a list (server channel users) identifying the server +;; and channel. The tail of the list contains the nicks of users +;; present in the channel. ;; ;; Each server has a special context (server) used for messages ;; to/from the server itself. @@ -270,17 +295,79 @@ portion of the source component of the message, as mURK doesn't use this.") The head of this list is always the current context.") (defun murk-current-context () - "Returns the current context." + "Return the current context." (if murk-contexts (car murk-contexts) nil)) +(defun murk-contexts-equal (c1 c2) + (if (murk-server-context-p c1) + (and (murk-server-context-p c2) + (equal (murk-context-server c1) + (murk-context-server c2))) + (and (not (murk-server-context-p c2)) + (equal (seq-take c1 2) + (seq-take c2 2))))) + (defun murk-context-server (ctx) (elt ctx 0)) -(defun murk-context-name (ctx) (elt ctx 1)) +(defun murk-context-channel (ctx) (elt ctx 1)) +(defun murk-context-users (ctx) (elt ctx 2)) +(defun murk-set-context-users (ctx users) + (setcar (cddr ctx) users)) +(defun murk-server-context-p (ctx) (not (cdr ctx))) + +(defun murk-add-context (ctx) + (add-to-list 'murk-contexts ctx)) + +(defun murk-remove-context (ctx) + (setq murk-contexts + (seq-remove + (lambda (this-ctx) + (murk-contexts-equal this-ctx ctx)) + murk-contexts))) + +(defun murk-remove-server-contexts (server) + (setq murk-contexts + (seq-remove (lambda (row) (equal (car row) server)) + murk-contexts))) + +(defun murk-context->string (ctx) + (if (murk-server-context-p ctx) + (concat "[" (murk-context-server ctx) "]") + (concat (murk-context-channel ctx) "@" + (murk-context-server ctx)))) + +(defun murk-get-context (server &optional name) + (if name + (let ((test-ctx (list server name))) + (seq-find (lambda (ctx) + (equal (seq-take ctx 2) test-ctx)) + murk-contexts)) + (assoc server murk-contexts))) + +(defun murk-cycle-contexts (&optional reverse) + (setq murk-contexts + (if reverse + (let ((nminus1 (- (length murk-contexts) 1))) + (cons + (elt murk-contexts nminus1) + (seq-take murk-contexts nminus1))) + (append (cdr murk-contexts) (list (car murk-contexts)))))) + +(defun murk-add-context-users (ctx users) + (murk-set-context-users + ctx + (cl-union users (murk-context-users ctx)))) ;;; Buffer ;; +(defvar murk-prompt-marker nil + "Marker for prompt position in murk buffer.") + +(defvar murk-input-marker nil + "Marker for prompt position in murk buffer.") + (defun murk-render-prompt () (with-current-buffer "*murk*" (let ((update-point (= murk-input-marker (point))) @@ -297,8 +384,8 @@ The head of this list is always the current context.") (insert (propertize (let ((ctx (murk-current-context))) (if ctx - (concat (murk-context-name) "@" (murk-context-server ctx)) - "")) + (murk-context->string ctx) + "")) 'face 'murk-context 'read-only t) (propertize murk-prompt-string @@ -314,15 +401,25 @@ The head of this list is always the current context.") (if (car v) (set-window-point (cadr v) murk-input-marker)))))) -(defvar murk-prompt-marker nil - "Marker for prompt position in murk buffer.") - -(defvar murk-input-marker nil - "Marker for prompt position in murk buffer.") - (defun murk-setup-header () - ;; To do - ) + (with-current-buffer "*murk*" + (setq-local header-line-format + '((:eval + (let* ((ctx (murk-current-context))) + (if ctx + (let ((server (murk-context-server ctx))) + (concat + "Network: " server ", " + (if (murk-server-context-p ctx) + "Server" + (concat + "Channel: " + (murk-context-channel ctx) + " (" + (number-to-string + (length (murk-context-users ctx))) + ")")))) + "No connection"))))))) (defun murk-setup-buffer () (with-current-buffer (get-buffer-create "*murk*") @@ -358,11 +455,6 @@ The head of this list is always the current context.") (fill-region (point-min) (point-max) nil t) (buffer-string)))) -(defun murk-context->string (context) - (if context - (concat (murk-context-name) "@" (murk-context-server context)) - nil)) - (defun murk-display-string (context prefix &rest strings) (with-current-buffer "*murk*" (save-excursion @@ -393,6 +485,17 @@ The head of this list is always the current context.") 'invisible context-atom))))))) (murk-scroll-windows-to-last-line)) +(defun murk-display-message (server from to text) + (let ((context (if (string-prefix-p "#" to) + (murk-get-context server to) + (murk-get-context server)))) + (murk-display-string + context + (if (murk-server-context-p context) + (concat "[" from " -> " to "]") + (concat (murk-context->string context) " <" from ">")) + text))) + (defun murk-display-notice (context &rest notices) (murk-display-string context @@ -418,8 +521,6 @@ The head of this list is always the current context.") (with-selected-window window (recenter -1)))))) - - (defconst murk-url-regex (rx (: (group (+ alpha)) @@ -503,6 +604,108 @@ The head of this list is always the current context.") ("PONG") + ("001" + (let* ((params (murk-msg-params msg)) + (nick (elt params 0)) + (text (string-join (seq-drop params 1) " "))) + (murk-set-connection-nick server nick) + (murk-display-notice nil text))) + + ("353" ; NAMEREPLY + (let* ((params (murk-msg-params msg)) + (channel (elt params 2)) + (names (split-string (elt params 3))) + (ctx (murk-get-context server channel))) + (if ctx + (murk-add-context-users ctx names) + (murk-display-notice nil "Users in " channel + ": " (string-join names " "))))) + + ("366" ; ENDOFNAMES + (let* ((params (murk-msg-params msg)) + (channel (elt params 1)) + (ctx (murk-get-context server channel))) + (if ctx + (murk-display-notice + ctx + (murk--as-string (length (murk-context-users ctx))) + " users in " channel) + (murk-display-notice nil "End of " channel " names list.")))) + + ("331" + (let* ((params (murk-msg-params msg)) + (channel (elt params 1)) + (ctx (murk-get-context server channel))) + (murk-display-notice ctx "No topic set."))) + + ("332" + (let* ((params (murk-msg-params msg)) + (channel (elt params 1)) + (topic (elt params 2)) + (ctx (murk-get-context server channel))) + (murk-display-notice ctx "Topic: " topic))) + + ((rx (= 3 (any digit))) + (murk-display-notice nil (mapconcat 'identity (cdr (murk-msg-params msg)) " "))) + + ((and "JOIN" + (guard (equal (murk-connection-nick server) + (murk-msg-src msg)))) + (let ((channel (car (murk-msg-params msg)))) + (murk-add-context (list server channel nil)) + (murk-display-notice (murk-current-context) + "Joining channel " channel " on " server) + (murk-render-prompt))) + + ((and "PART" + (guard (equal (murk-connection-nick server) + (murk-msg-src msg)))) + (let ((channel (car (murk-msg-params msg)))) + (murk-display-notice (murk-current-context) "Left channel " channel) + (murk-remove-context (list server channel)) + (murk-render-prompt))) + + ("QUIT" + (let ((nick (murk-msg-src msg)) + (reason (mapconcat 'identity (murk-msg-params msg) " "))) + (murk-del-user nick) + (if murk-show-joins + (murk-display-notice nil nick " quit: " reason)))) + + ("PRIVMSG" + (let* ((from (murk-msg-src msg)) + (params (murk-msg-params msg)) + (to (car params)) + (text (cadr params))) + (pcase text + ("\01VERSION\01" + (let ((version-string (concat murk-version " - running on GNU Emacs " emacs-version))) + (murk-send-msg server + (murk-msg nil nil "NOTICE" + (list from (concat "\01VERSION " + version-string + "\01"))))) + (murk-display-notice nil "CTCP version request received from " + from " on " server)) + + ((rx (let ping (: "\01PING " (* (not "\01")) "\01"))) + (murk-send-msg server (murk-msg nil nil "NOTICE" (list from ping))) + (murk-display-notice nil "CTCP ping received from " from " on " server)) + + ("\01USERINFO\01" + (murk-display-notice nil "CTCP userinfo request from " from + " on " server " (no response sent)")) + + ("\01CLIENTINFO\01" + (murk-display-notice nil "CTCP clientinfo request from " from + " on " server " (no response sent)")) + + ((rx (: "\01ACTION " (let action-text (* (not "\01"))) "\01")) + (murk-display-action from to action-text)) + + (_ + (murk-display-message server from to text))))) + (_ (murk-display-notice nil (murk-msg->string msg)))))) @@ -512,15 +715,23 @@ The head of this list is always the current context.") (defvar murk-command-table '(("DEBUG" "Toggle debug mode on/off." murk-command-debug murk-boolean-completions) ("HEADER" "Toggle display of header." murk-command-header murk-boolean-completions) - ("CONNECT" "Connect to an IRC network." murk-command-connect murk-network-completions) ("NETWORKS" "List known IRC networks." murk-command-networks) + ("CONNECT" "Connect to an IRC network." murk-command-connect murk-network-completions) ("QUIT" "Disconnect from current network." murk-command-quit) + ("JOIN" "Join one or more channels." murk-command-join) + ("PART" "Leave channel." murk-command-part murk-context-completions) ("NICK" "Change nick." murk-command-nick) ("MSG" "Send private message to user." murk-command-msg murk-nick-completions) ("CLEAR" "Clear buffer text." murk-command-clear murk-context-completions) ("HELP" "Display help on client commands." murk-command-help murk-help-completions)) "Table of commands explicitly supported by murk.") +(defun murk-boolean-completions () + '("on" "off")) + +(defun murk-network-completions () + (mapcar (lambda (row) (car row)) murk-networks)) + (defun murk-command-help (params) (if params (let* ((cmd-str (upcase (car params))) @@ -544,12 +755,74 @@ The head of this list is always the current context.") (not murk-debug))) (murk-display-notice nil "Debug mode now " (if murk-debug "on" "off") ".")) +(defun murk-command-header (params) + (if + (if params + (equal (upcase (car params)) "ON") + (not header-line-format)) + (progn + (murk-setup-header) + (murk-display-notice nil "Header enabled.")) + (setq-local header-line-format nil) + (murk-display-notice nil "Header disabled."))) + (defun murk-command-clear (params) (if (not params) (murk-clear-buffer) (dolist (context params) (murk-clear-context context)))) +(defun murk-command-connect (params) + (if params + (let ((network (car params))) + (murk-display-notice nil "Attempting to connect to " network "...") + (murk-connect network)) + (murk-display-notice nil "Usage: /connect "))) + +(defun murk-command-networks (_params) + (murk-display-notice nil "Currently-known networks:") + (dolist (row murk-networks) + (seq-let (network server port &rest _others) row + (murk-display-notice nil "\t" network + " [" server + " " (number-to-string port) "]"))) + (murk-display-notice nil "(Modify the `murk-networks' variable to add more.)")) + +(defun murk-command-quit (params) + (let ((ctx (murk-current-context))) + (if (not ctx) + (murk-display-error "No current context") + (let ((quit-msg (if params (string-join params " ") murk-default-quit-msg))) + (murk-send-msg + (murk-context-server ctx) + (murk-msg nil nil "QUIT" quit-msg)))))) + +(defun murk-command-join (params) + (if params + (let ((server (murk-context-server (murk-current-context)))) + (dolist (channel params) + (murk-send-msg server (murk-msg nil nil "JOIN" channel)))) + (murk-display-notice nil "Usage: /join channel [channel2 ...]"))) + +(defun murk-command-part (params) + (let* ((server (murk-context-server (murk-current-context))) + (channel (if params + (car params) + (murk-context-channel (murk-current-context))))) + (if channel + (murk-send-msg server (murk-msg nil nil "PART" channel)) + (murk-display-error "No current channel to leave")))) + +(defun murk-command-msg (params) + (let ((server (murk-context-server (murk-current-context)))) + (if (and params (>= (length params) 2)) + (let ((to (car params)) + (text (string-join (cdr params) " "))) + (murk-send-msg server (murk-msg nil nil "PRIVMSG" to text)) + (murk-display-message server + (murk-connection-nick server) + to text)) + (murk-display-notice nil "Usage: /msg ")))) ;;; Command entering ;; @@ -567,18 +840,24 @@ The head of this list is always the current context.") nil))) (if (and command-row (elt command-row 2)) (funcall (elt command-row 2) params) - (murk-send-msg (murk-msg nil nil (upcase cmd-str) params))))) + (murk-send-msg + (murk-context-server (murk-current-context)) + (murk-msg nil nil (upcase cmd-str) params))))) (_ - (murk-display-error "Badly formed command."))) + (murk-display-error "Badly formed command"))) (unless (string-empty-p string) - (if (murk-current-context) - (progn - (murk-send-msg server - (murk-msg nil nil "PRIVMSG" - (murk-context-name murk-current-context) - string)) - (murk-display-message murk-nick (murk-context->string (murk-current-context)) string)) - (murk-display-error "No current context."))))) + (let ((ctx (murk-current-context))) + (if ctx + (if (not (murk-server-context-p ctx)) + (let ((server (murk-context-server ctx)) + (channel (murk-context-channel ctx))) + (murk-send-msg server + (murk-msg nil nil "PRIVMSG" channel string)) + (murk-display-message server + (murk-connection-nick server) + channel string)) + (murk-display-error "No current channel")) + (murk-display-error "No current context")))))) ;;; Command history @@ -616,6 +895,53 @@ The head of this list is always the current context.") (delete-region murk-input-marker (point-max))) (murk-enter-string line)))) +(defun murk-history-next () + (interactive) + (murk-history-cycle -1)) + +(defun murk-history-prev () + (interactive) + (murk-history-cycle +1)) + +(defun murk-cycle-contexts-forward () + (interactive) + (murk-cycle-contexts) + (murk-render-prompt)) + +(defun murk-cycle-contexts-reverse () + (interactive) + (murk-cycle-contexts t) + (murk-render-prompt)) + +(defun murk-complete-input () + (interactive) + (let ((completion-ignore-case t)) + (when (>= (point) murk-input-marker) + (pcase (buffer-substring murk-input-marker (point)) + ((rx (: "/" (let cmd-str (+ (not whitespace))) (+ " ") (* (not whitespace)) string-end)) + (let ((space-idx (save-excursion + (re-search-backward " " murk-input-marker t))) + (table-row (assoc (upcase cmd-str) murk-command-table #'equal))) + (if (and table-row (elt table-row 3)) + (let* ((completions-nospace (funcall (elt table-row 3))) + (completions (mapcar (lambda (el) (concat el " ")) completions-nospace))) + (completion-in-region (+ 1 space-idx) (point) completions))))) + ((rx (: "/" (* (not whitespace)) string-end)) + (message (buffer-substring murk-input-marker (point))) + (completion-in-region murk-input-marker (point) + (mapcar (lambda (row) (concat "/" (car row) " ")) + murk-command-table))) + (_ + (let* ((end (max murk-input-marker (point))) + (space-idx (save-excursion + (re-search-backward " " murk-input-marker t))) + (start (if space-idx (+ 1 space-idx) murk-input-marker))) + (unless (string-prefix-p "/" (buffer-substring start end)) + (let* ((users (murk-context-users (murk-current-context))) + (users-no@ (mapcar + (lambda (u) (car (split-string u "@" t))) + users))) + (completion-in-region start end users-no@))))))))) ;;; Mode ;; @@ -624,6 +950,11 @@ The head of this list is always the current context.") (let ((map (make-sparse-keymap))) (define-key map (kbd "RET") 'murk-enter) (define-key map (kbd "TAB") 'murk-complete-input) + (define-key map (kbd "") 'murk-history-prev) + (define-key map (kbd "") 'murk-history-next) + (define-key map (kbd "") 'murk-cycle-contexts-forward) + (define-key map (kbd "") 'murk-cycle-contexts-reverse) + (define-key map (kbd "") 'murk-cycle-contexts-reverse) (when (fboundp 'evil-define-key*) (evil-define-key* 'motion map (kbd "TAB") 'murk-complete-input)) @@ -648,5 +979,4 @@ The head of this list is always the current context.") (murk-setup-buffer)) "Started murk.") - ;;; murk.el ends here