X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=murk.el;h=64bc81d9e3be728b85ccb0e2b092ed23025644f1;hb=9bef2f474186f9fbbcd1a2ad2c3e1f30e0328d3c;hp=652b3c21fcc4135e2e73702724d2f79791d7cb5d;hpb=266f254c2ea3dc544bf5d13dbc5e30f2f6d361b5;p=lurk.git diff --git a/murk.el b/murk.el index 652b3c2..64bc81d 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 @@ -38,19 +42,28 @@ :group 'network) (defcustom murk-default-nick "plugd" - "Default nick.") + "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 - '(("debug" "localhost" 6667 :notls) + '(("debug" "localhost" 6697) ("libera" "irc.libera.chat" 6697) - ("tilde" "tilde.chat" 6697)) - "IRC networks.") + ("tilde" "tilde.chat" 6697) + ("freenode" "chat.freenode.net" 6697) + ("mbr" "mbrserver.com" 6667 :notls)) + "IRC networks." + :type '(alist :key-type string)) + +(defcustom murk-show-joins nil + "Set to non-nil to be notified of joins, parts and quits.") (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 @@ -138,10 +151,12 @@ This includes the process and the response string.") (list server process nick ""))) (defun murk-connection-remove (server) - (setq murk-connection-table (assoc-delete-all server murk-connection-table))) + (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) @@ -149,7 +164,7 @@ This includes the process and the response string.") (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-connection-remove server) @@ -182,7 +197,7 @@ 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))) @@ -198,7 +213,7 @@ 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.")))) + (murk-display-error "No server connection established")))) ;;; Server messages @@ -244,13 +259,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)) @@ -269,14 +284,14 @@ 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 nil) used for messages +;; Each server has a special context (server) used for messages ;; to/from the server itself. (defvar murk-contexts nil @@ -284,7 +299,7 @@ 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)) @@ -298,9 +313,20 @@ The head of this list is always the current context.") (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-server-context-p (ctx) (not (cdr ctx))) +(defun murk-context-server (ctx) + (elt ctx 0)) + +(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)) @@ -314,18 +340,78 @@ The head of this list is always the current context.") (defun murk-remove-server-contexts (server) (setq murk-contexts - (assoc-delete-all server 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-name ctx) "@" + (concat (murk-context-channel ctx) "@" (murk-context-server ctx)))) +(defun murk-string->context (string) + (if (not (string-prefix-p "#" string)) + (murk-get-context string) + (let* ((parts (string-split string "@")) + (channel (elt parts 0)) + (server (elt parts 1))) + (murk-get-context server channel)))) + +(defun murk-get-context (server &optional channel) + (if channel + (let ((test-ctx (list server channel))) + (seq-find (lambda (ctx) + (equal (seq-take ctx 2) test-ctx)) + murk-contexts)) + (car (member (list 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-switch-to-context (ctx) + (setq murk-contexts + (let* ((new-head (memq ctx murk-contexts)) + (new-tail (take (- (length murk-contexts) + (length new-head))))) + (append new-head new-tail)))) + +(defun murk-add-context-users (ctx users) + (murk-set-context-users + ctx + (cl-union users (murk-context-users ctx)))) + +(defun murk-del-context-user (ctx user) + (murk-set-context-users + ctx + (delete user (murk-context-users ctx)))) + +(defun murk-del-server-user (server user) + (dolist (ctx murk-contexts) + (if (equal (murk-context-server ctx) server) + (murk-del-context-user ctx user)))) + +(defun murk-rename-server-user (server old-nick new-nick) + (dolist (ctx murk-contexts) + (when (and (equal (murk-context-server ctx) server) + (member old-nick (murk-context-users ctx))) + (murk-del-context-user ctx old-nick) + (murk-add-context-users ctx (list new-nick))))) ;;; 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))) @@ -359,15 +445,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*") @@ -433,6 +529,26 @@ 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-action (server from to action-text) + (let ((context (if (string-prefix-p "#" to) + (murk-get-context server to) + (murk-get-context server)))) + (murk-display-string + context + (concat (murk-context->string context) " *") + from " " action-text))) + (defun murk-display-notice (context &rest notices) (murk-display-string context @@ -458,8 +574,6 @@ The head of this list is always the current context.") (with-selected-window window (recenter -1)))))) - - (defconst murk-url-regex (rx (: (group (+ alpha)) @@ -543,13 +657,47 @@ The head of this list is always the current context.") ("PONG") - ("001" + ("001" ; RPL_WELCOME (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" ; RPL_NOTOPIC + (let* ((params (murk-msg-params msg)) + (channel (elt params 1)) + (ctx (murk-get-context server channel))) + (murk-display-notice ctx "No topic set."))) + + ("332" ; RPL_TOPIC + (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)) " "))) @@ -557,11 +705,20 @@ The head of this list is always the current context.") (guard (equal (murk-connection-nick server) (murk-msg-src msg)))) (let ((channel (car (murk-msg-params msg)))) - (murk-add-context (list server channel)) + (murk-add-context (list server channel nil)) (murk-display-notice (murk-current-context) "Joining channel " channel " on " server) (murk-render-prompt))) + ("JOIN" + (let* ((channel (car (murk-msg-params msg))) + (nick (murk-msg-src msg)) + (ctx (murk-get-context server channel))) + (murk-add-context-users ctx (list nick)) + (if murk-show-joins + (murk-display-notice ctx nick " joined channel " channel + " on " server)))) + ((and "PART" (guard (equal (murk-connection-nick server) (murk-msg-src msg)))) @@ -570,13 +727,79 @@ The head of this list is always the current context.") (murk-remove-context (list server channel)) (murk-render-prompt))) + ("PART" + (let* ((channel (car (murk-msg-params msg))) + (nick (murk-msg-src msg)) + (ctx (murk-get-context server channel))) + (murk-del-context-user ctx nick) + (if murk-show-joins + (murk-display-notice ctx nick " left channel " channel + " on " server)))) + + ((and "NICK" + (guard (equal (murk-connection-nick server) + (murk-msg-src msg)))) + (let ((new-nick (car (murk-msg-params msg))) + (old-nick (murk-connection-nick server))) + (murk-set-connection-nick server new-nick) + (murk-rename-server-user server old-nick new-nick) + (murk-display-notice nil "Nick set to " new-nick " on " server))) + + ("NICK" + (let ((old-nick (murk-msg-src msg)) + (new-nick (car (murk-msg-params msg)))) + (murk-display-notice nil old-nick " is now known as " new-nick + " on " server) + (murk-rename-server-user server old-nick new-nick))) + + ("TOPIC" + (let ((channel (car (murk-msg-params msg))) + (nick (murk-msg-src msg)) + (topic (cadr (murk-msg-params msg)))) + (murk-display-notice (murk-get-context server channel) + nick " set the topic: " topic))) + ("QUIT" (let ((nick (murk-msg-src msg)) (reason (mapconcat 'identity (murk-msg-params msg) " "))) - (murk-del-user nick) + (murk-del-server-user server 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 server from to action-text)) + + (_ + (murk-display-message server from to text))))) + (_ (murk-display-notice nil (murk-msg->string msg)))))) @@ -586,13 +809,18 @@ 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) + ("SHOWJOINS" "Toggles display of joins/parts." murk-command-showjoins murk-boolean-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) + ("LIST" "Display details of one or more channels." murk-command-list) + ("TOPIC" "Set/query topic for current channel." murk-command-topic) + ("USERS" "List nicks of users in current context." murk-command-users) ("MSG" "Send private message to user." murk-command-msg murk-nick-completions) + ("ME" "Display action." murk-command-me) ("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.") @@ -626,11 +854,26 @@ 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-clear (params) - (if (not params) - (murk-clear-buffer) - (dolist (context params) - (murk-clear-context context)))) +(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-showjoins (params) + (setq murk-show-joins + (if params + (if (equal (upcase (car params)) "ON") + t + nil) + (not murk-show-joins))) + (murk-display-notice nil "Joins/parts will now be " + (if murk-show-joins "shown" "hidden") ".")) (defun murk-command-connect (params) (if params @@ -639,10 +882,10 @@ The head of this list is always the current context.") (murk-connect network)) (murk-display-notice nil "Usage: /connect "))) -(defun murk-command-networks (params) +(defun murk-command-networks (_params) (murk-display-notice nil "Currently-known networks:") (dolist (row murk-networks) - (seq-let (network server port &rest others) row + (seq-let (network server port &rest _others) row (murk-display-notice nil "\t" network " [" server " " (number-to-string port) "]"))) @@ -651,7 +894,7 @@ The head of this list is always the current context.") (defun murk-command-quit (params) (let ((ctx (murk-current-context))) (if (not ctx) - (murk-display-error "No current context.") + (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) @@ -668,10 +911,82 @@ The head of this list is always the current context.") (let* ((server (murk-context-server (murk-current-context))) (channel (if params (car params) - (murk-context-name (murk-current-context))))) + (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.")))) + (murk-display-error "No current channel to leave")))) + +(defun murk-command-nick (params) + (if params + (let ((new-nick (string-join params " ")) + (ctx (murk-current-context))) + (if ctx + (murk-send-msg (murk-context-server ctx) + (murk-msg nil nil "NICK" new-nick)) + (murk-display-error "No current connection"))) + (murk-display-notice nil "Usage: /nick "))) + +(defun murk-command-list (params) + (let ((ctx (murk-current-context))) + (if ctx + (if (not params) + (murk-display-notice nil "This command can generate lots of output. Use `/LIST -yes' if you really want this, or `/LIST ' to reduce the output.") + (let ((server (murk-context-server ctx))) + (if (equal (upcase (car params)) "-YES") + (murk-send-msg server (murk-msg nil nil "LIST")) + (murk-send-msg server (murk-msg nil nil "LIST" + (car params)))))) + (murk-display-error "No current connection")))) + +(defun murk-command-topic (params) + (let ((ctx (murk-current-context))) + (if (and ctx (not (murk-server-context-p ctx))) + (let ((server (murk-context-server ctx)) + (channel (murk-context-channel ctx))) + (if params + (murk-send-msg server + (murk-msg nil nil "TOPIC" channel + (string-join params " "))) + (murk-send-msg server + (murk-msg nil nil "TOPIC" channel)))) + (murk-display-notice nil "No current channel.")))) + +(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 ")))) + +(defun murk-command-me (params) + (let* ((ctx (murk-current-context)) + (server (murk-context-server ctx))) + (if (and ctx (not (murk-server-context-p ctx))) + (if params + (let* ((channel (murk-context-channel ctx)) + (my-nick (murk-connection-nick server)) + (action (string-join params " ")) + (ctcp-text (concat "\01ACTION " action "\01"))) + (murk-send-msg server + (murk-msg nil nil "PRIVMSG" + (list channel ctcp-text))) + (murk-display-action server my-nick channel action)) + (murk-display-notice nil "Usage: /me ")) + (murk-display-notice nil "No current channel.")))) + +(defun murk-command-users (_params) + (let ((ctx (murk-current-context))) + (if (and ctx (not (murk-server-context-p ctx))) + (let ((channel (murk-context-channel ctx)) + (server (murk-context-server ctx)) + (users (murk-context-users ctx))) + (murk-display-notice ctx "Users in " channel " on " server ":") + (murk-display-notice ctx (string-join users " "))) + (murk-display-notice nil "No current channel.")))) ;;; Command entering @@ -694,16 +1009,20 @@ The head of this list is always the current context.") (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 @@ -749,6 +1068,16 @@ The head of this list is always the current context.") (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)) @@ -773,7 +1102,7 @@ The head of this list is always the current context.") (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-get-context-users murk-current-context)) + (let* ((users (murk-context-users (murk-current-context))) (users-no@ (mapcar (lambda (u) (car (split-string u "@" t))) users))) @@ -788,6 +1117,9 @@ The head of this list is always the current context.") (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)) @@ -812,5 +1144,4 @@ The head of this list is always the current context.") (murk-setup-buffer)) "Started murk.") - ;;; murk.el ends here