murk.el

   1 ;;; MURK --- Multiserver Unibuffer iRc Klient -*- lexical-binding:t -*-
   2
   3 ;; Copyright (C) 2024 plugd
   4
   5 ;; Author: plugd <plugd@thelambdalab.xyz>
   6 ;; Created: 11 May 2024
   7 ;; Version: 0.0
   8 ;; Keywords: network
   9 ;; Homepage: http://thelambdalab.xyz/murk
  10 ;; Package-Requires: ((emacs "26"))
  11
  12 ;; This file is not part of GNU Emacs.
  13
  14 ;; This program is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; This program is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with this file.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 (provide 'murk)
  32
  33
  34 ;;; Customizations
  35
  36 (defgroup murk nil
  37   "Multiserver Unibuffer iRc Klient"
  38   :group 'network)
  39
  40 (defcustom murk-default-nick "plugd"
  41   "Default nick.")
  42
  43 (defcustom murk-default-quit-msg "Bye"
  44   "Default quit message when none supplied.")
  45
  46 (defcustom murk-networks
  47   '(("debug" "localhost" 6667 :notls)
  48     ("libera" "irc.libera.chat" 6697)
  49     ("tilde" "tilde.chat" 6697))
  50   "IRC networks.")
  51
  52 (defcustom murk-display-header t
  53   "If non-nil, use buffer header to display information on current host and channel.")
  54
  55
  56 ;;; Faces
  57 ;;
  58
  59 (defface murk-text
  60   '((t :inherit default))
  61   "Face used for murk text.")
  62
  63 (defface murk-prompt
  64   '((t :inherit font-lock-keyword-face))
  65   "Face used for the prompt.")
  66
  67 (defface murk-context
  68   '((t :inherit murk-context))
  69   "Face used for the context name in the prompt.")
  70
  71 (defface murk-faded
  72   '((t :inherit shadow))
  73   "Face used for faded murk text.")
  74
  75 (defface murk-timestamp
  76   '((t :inherit shadow))
  77   "Face used for timestamps.")
  78
  79 (defface murk-error
  80   '((t :inherit error))
  81   "Face used for murk error text.")
  82
  83 (defface murk-notice
  84   '((t :inherit warning))
  85   "Face used for murk notice text.")
  86
  87
  88 ;;; Global variables
  89 ;;
  90
  91 (defvar murk-version "Murk v0.0"
  92   "Value of this string is used in response to CTCP version queries.")
  93
  94 (defvar murk-notice-prefix "-!-")
  95 (defvar murk-error-prefix "!!!")
  96 (defvar murk-prompt-string ">")
  97
  98 (defvar murk-debug nil
  99   "If non-nil, enable debug mode.")
 100
 101
 102 ;;; Utility procedures
 103 ;;
 104
 105 (defun murk--filtered-join (&rest args)
 106   (string-join (seq-filter (lambda (el) el) args) " "))
 107
 108 (defun murk--as-string (obj)
 109   (if obj
 110       (with-output-to-string (princ obj))
 111     nil))
 112
 113
 114 ;;; Network processes
 115 ;;
 116
 117 (defvar murk-connection-table nil
 118   "An alist associating servers to connection information.
 119 This includes the process and the response string.")
 120
 121 (defun murk-connection-process (server)
 122   (elt (assoc server murk-connection-table) 1))
 123
 124 (defun murk-connection-nick (server)
 125   (elt (assoc server murk-connection-table) 2))
 126
 127 (defun murk-set-connection-nick (server nick)
 128   (setf (elt (assoc server murk-connection-table) 2) nick))
 129
 130 (defun murk-connection-response (server)
 131   (elt (assoc server murk-connection-table) 3))
 132
 133 (defun murk-set-connection-response (server string)
 134   (setf (elt (assoc server murk-connection-table) 3) string))
 135
 136 (defun murk-connection-new (server process nick)
 137   (add-to-list 'murk-connection-table
 138                (list server process nick "")))
 139
 140 (defun murk-connection-remove (server)
 141   (setq murk-connection-table (assoc-delete-all server murk-connection-table)))
 142
 143 (defun murk-make-server-filter (server)
 144   (lambda (proc string)
 145     (dolist (line (split-string (concat (murk-connection-response server) string)
 146                                 "\n"))
 147       (if (string-suffix-p "\r" line)
 148           (murk-eval-msg-string server (string-trim line))
 149         (murk-set-connection-response server line)))))
 150
 151 (defun murk-make-server-sentinel (server)
 152   (lambda (proc string)
 153     (unless (equal "open" (string-trim string))
 154       (murk-display-error "Disconnected from server.")
 155       (murk-connection-remove server)
 156       (murk-remove-server-contexts server)
 157       (murk-render-prompt))))
 158
 159 (defun murk-start-process (server)
 160   (let* ((row (assoc server murk-networks))
 161          (host (elt row 1))
 162          (port (elt row 2))
 163          (flags (seq-drop row 3)))
 164     (make-network-process :name (concat "murk-" server)
 165                           :host host
 166                           :service port
 167                           :family nil
 168                           :filter (murk-make-server-filter server)
 169                           :sentinel (murk-make-server-sentinel server)
 170                           :nowait nil
 171                           :tls-parameters (if (memq :notls flags)
 172                                               nil
 173                                             (cons 'gnutls-x509pki
 174                                                   (gnutls-boot-parameters
 175                                                    :type 'gnutls-x509pki
 176                                                    :hostname host)))
 177                           :buffer "*murk*")))
 178
 179 (defvar murk-ping-period 60)
 180
 181 ;; IDEA: Have a single ping timer which pings all connected hosts
 182
 183 (defun murk-connect (server)
 184   (if (assoc server murk-connection-table)
 185       (murk-display-error "Already connected to this network.")
 186     (if (not (assoc server murk-networks))
 187         (murk-display-error "Network '" server "' is unknown.")
 188       (let ((proc (murk-start-process server)))
 189         (murk-connection-new server proc murk-default-nick))
 190       (murk-send-msg server (murk-msg nil nil "USER" murk-default-nick 0 "*" murk-default-nick))
 191       (murk-send-msg server (murk-msg nil nil "NICK" murk-default-nick))
 192       (murk-add-context (list server))
 193       (murk-render-prompt))))
 194
 195 (defun murk-send-msg (server msg)
 196   (if murk-debug
 197       (murk-display-string nil nil (murk-msg->string msg)))
 198   (let ((proc (murk-connection-process server)))
 199     (if (and proc (eq (process-status proc) 'open))
 200         (process-send-string proc (concat (murk-msg->string msg) "\r\n"))
 201       (murk-display-error "No server connection established."))))
 202
 203
 204 ;;; Server messages
 205 ;;
 206
 207 (defun murk-msg (tags src cmd &rest params)
 208   (list (murk--as-string tags)
 209         (murk--as-string src)
 210         (upcase (murk--as-string cmd))
 211         (mapcar #'murk--as-string
 212                 (if (and params (listp (elt params 0)))
 213                     (elt params 0)
 214                   params))))
 215
 216 (defun murk-msg-tags (msg) (elt msg 0))
 217 (defun murk-msg-src (msg) (elt msg 1))
 218 (defun murk-msg-cmd (msg) (elt msg 2))
 219 (defun murk-msg-params (msg) (elt msg 3))
 220 (defun murk-msg-trail (msg)
 221   (let ((params (murk-msg-params msg)))
 222     (if params
 223         (elt params (- (length params) 1)))))
 224
 225 (defvar murk-msg-regex
 226   (rx
 227    (opt (: "@" (group (* (not (or "\n" "\r" ";" " ")))))
 228         (* whitespace))
 229    (opt (: ":" (: (group (* (not (any space "!" "@"))))
 230                   (* (not (any space)))))
 231         (* whitespace))
 232    (group (: (* (not whitespace))))
 233    (* whitespace)
 234    (opt (group (+ not-newline))))
 235   "Regex used to parse IRC messages.
 236 Note that this regex is incomplete.  Noteably, we discard the non-nick
 237 portion of the source component of the message, as mURK doesn't use this.")
 238
 239 (defun murk-string->msg (string)
 240   (if (string-match murk-msg-regex string)
 241       (let* ((tags (match-string 1 string))
 242              (src (match-string 2 string))
 243              (cmd (upcase (match-string 3 string)))
 244              (params-str (match-string 4 string))
 245              (params
 246               (if params-str
 247                   (let* ((idx (cl-search ":" params-str))
 248                          (l (split-string (string-trim (substring params-str 0 idx))))
 249                          (r (if idx (list (substring params-str (+ 1 idx))) nil)))
 250                     (append l r))
 251                 nil)))
 252         (apply #'murk-msg (append (list tags src cmd) params)))
 253     (error "Failed to parse string " string)))
 254
 255 (defun murk-msg->string (msg)
 256   (let ((tags (murk-msg-tags msg))
 257         (src (murk-msg-src msg))
 258         (cmd (murk-msg-cmd msg))
 259         (params (murk-msg-params msg)))
 260     (murk--filtered-join
 261      (if tags (concat "@" tags) nil)
 262      (if src (concat ":" src) nil)
 263      cmd
 264      (if (> (length params) 1)
 265          (string-join (seq-take params (- (length params) 1)) " ")
 266        nil)
 267      (if (> (length params) 0)
 268          (concat ":" (elt params (- (length params) 1)))
 269        nil))))
 270
 271
 272 ;;; Contexts and Servers
 273 ;;
 274
 275 ;; A context is a list (server name ...) where name is a string
 276 ;; representing either a channel name or nick, and server is a symbol
 277 ;; identifying the server.
 278 ;;
 279 ;; Each server has a special context (server nil) used for messages
 280 ;; to/from the server itself.
 281
 282 (defvar murk-contexts nil
 283   "List of currently-available contexts.
 284 The head of this list is always the current context.")
 285
 286 (defun murk-current-context ()
 287   "Returns the current context."
 288   (if murk-contexts
 289       (car murk-contexts)
 290     nil))
 291
 292 (defun murk-contexts-equal (c1 c2)
 293   (if (murk-server-context-p c1)
 294       (and (murk-server-context-p c2)
 295            (equal (murk-context-server c1)
 296                   (murk-context-server c2)))
 297     (and (not (murk-server-context-p c2))
 298          (equal (seq-take c1 2)
 299                 (seq-take c2 2)))))
 300
 301 (defun murk-context-server (ctx) (elt ctx 0))
 302 (defun murk-context-name (ctx) (elt ctx 1))
 303 (defun murk-context-users (ctx) (seq-drop ctx 2))
 304 (defun murk-server-context-p (ctx) (not (cdr ctx)))
 305
 306 (defun murk-add-context (ctx)
 307   (add-to-list 'murk-contexts ctx))
 308
 309 (defun murk-remove-context (ctx)
 310   (setq murk-contexts
 311         (seq-remove
 312          (lambda (this-ctx)
 313            (murk-contexts-equal this-ctx ctx))
 314          murk-contexts)))
 315
 316 (defun murk-remove-server-contexts (server)
 317   (setq murk-contexts
 318         (assoc-delete-all server murk-contexts)))
 319
 320 (defun murk-context->string (ctx)
 321    (if (murk-server-context-p ctx)
 322        (concat "[" (murk-context-server ctx) "]")
 323      (concat (murk-context-name ctx) "@"
 324              (murk-context-server ctx))))
 325
 326 (defun murk-get-context (server &optional name)
 327   (if name
 328       (assoc server murk-contexts)
 329     (let ((test-ctx (list server name)))
 330       (seq-find (lambda (ctx)
 331                   (equal (seq-take ctx 2) test-ctx))
 332                 murk-contexts))))
 333
 334 ;;; Buffer
 335 ;;
 336
 337 (defun murk-render-prompt ()
 338   (with-current-buffer "*murk*"
 339     (let ((update-point (= murk-input-marker (point)))
 340           (update-window-points (mapcar (lambda (w)
 341                                           (list (= (window-point w) murk-input-marker)
 342                                                 w))
 343                                         (get-buffer-window-list nil nil t))))
 344       (save-excursion
 345         (set-marker-insertion-type murk-prompt-marker nil)
 346         (set-marker-insertion-type murk-input-marker t)
 347         (let ((inhibit-read-only t))
 348           (delete-region murk-prompt-marker murk-input-marker)
 349           (goto-char murk-prompt-marker)
 350           (insert
 351            (propertize (let ((ctx (murk-current-context)))
 352                          (if ctx
 353                              (murk-context->string ctx)
 354                            ""))
 355                        'face 'murk-context
 356                        'read-only t)
 357            (propertize murk-prompt-string
 358                        'face 'murk-prompt
 359                        'read-only t)
 360            (propertize " " ; Need this to be separate to mark it as rear-nonsticky
 361                        'read-only t
 362                        'rear-nonsticky t)))
 363         (set-marker-insertion-type murk-input-marker nil))
 364       (if update-point
 365           (goto-char murk-input-marker))
 366       (dolist (v update-window-points)
 367         (if (car v)
 368             (set-window-point (cadr v) murk-input-marker))))))
 369
 370 (defvar murk-prompt-marker nil
 371   "Marker for prompt position in murk buffer.")
 372
 373 (defvar murk-input-marker nil
 374   "Marker for prompt position in murk buffer.")
 375
 376 (defun murk-setup-header ()
 377   (with-current-buffer "*murk*"
 378     (setq-local header-line-format
 379                 '((:eval
 380                    (let* ((ctx (murk-current-context)))
 381                      (if ctx
 382                          (let ((server (murk-context-server ctx)))
 383                            (concat
 384                             "Network: " server ", "
 385                             (if (murk-server-context-p ctx)
 386                                 "Server"
 387                               (concat
 388                                "Channel: "
 389                                (murk-context-name ctx)
 390                                " ("
 391                                (number-to-string
 392                                 (length (murk-context-users ctx)))
 393                                ")"))))
 394                        "No connection")))))))
 395
 396 (defun murk-setup-buffer ()
 397   (with-current-buffer (get-buffer-create "*murk*")
 398     (setq-local scroll-conservatively 1)
 399     (setq-local buffer-invisibility-spec nil)
 400     (if (markerp murk-prompt-marker)
 401         (set-marker murk-prompt-marker (point-max))
 402       (setq murk-prompt-marker (point-max-marker)))
 403     (if (markerp murk-input-marker)
 404         (set-marker murk-input-marker (point-max))
 405       (setq murk-input-marker (point-max-marker)))
 406     (goto-char (point-max))
 407     (murk-render-prompt)
 408     (if murk-display-header
 409         (murk-setup-header))))
 410
 411 (defun murk-clear-buffer ()
 412   "Completely erase all non-prompt and non-input text from murk buffer."
 413   (with-current-buffer "*murk*"
 414     (let ((inhibit-read-only t))
 415       (delete-region (point-min) murk-prompt-marker))))
 416
 417
 418 ;;; Output formatting and highlighting
 419 ;;
 420
 421 (defun murk--fill-strings (col indent &rest strings)
 422   (with-temp-buffer
 423     (setq buffer-invisibility-spec nil)
 424     (let ((fill-column col)
 425           (adaptive-fill-regexp (rx-to-string `(= ,indent anychar))))
 426       (apply #'insert strings)
 427       (fill-region (point-min) (point-max) nil t)
 428       (buffer-string))))
 429
 430 (defun murk-display-string (context prefix &rest strings)
 431   (with-current-buffer "*murk*"
 432     (save-excursion
 433       (goto-char murk-prompt-marker)
 434       (let* ((inhibit-read-only t)
 435              (old-pos (marker-position murk-prompt-marker))
 436              (padded-timestamp (concat (format-time-string "%H:%M ")))
 437              (padded-prefix (if prefix (concat prefix " ") ""))
 438              (context-atom (if context (intern (murk-context->string context)) nil)))
 439         (insert-before-markers
 440          (murk--fill-strings
 441           80
 442           (+ (length padded-timestamp)
 443              (length padded-prefix))
 444           (propertize padded-timestamp
 445                       'face 'murk-timestamp
 446                       'read-only t
 447                       'context context
 448                       'invisible context-atom)
 449           (propertize padded-prefix
 450                       'read-only t
 451                       'context context
 452                       'invisible context-atom)
 453           (murk-add-formatting
 454            (propertize (concat (apply #'murk-buttonify-urls strings) "\n")
 455                        'read-only t
 456                        'context context
 457                        'invisible context-atom)))))))
 458   (murk-scroll-windows-to-last-line))
 459
 460 (defun murk-display-message (server from to text)
 461   (let ((context (if (string-prefix-p "#" to)
 462                      (murk-get-context server to)
 463                    (murk-get-context server))))
 464     (murk-display-string
 465      context
 466      (if (murk-server-context-p context)
 467          (concat "[" from " -> " to "]")
 468        (concat (murk-context->string context) " <" from ">"))
 469      text)))
 470
 471 (defun murk-display-notice (context &rest notices)
 472   (murk-display-string
 473    context
 474    (propertize murk-notice-prefix 'face 'murk-notice)
 475    (apply #'concat notices)))
 476
 477 (defun murk-display-error (&rest messages)
 478   (murk-display-string
 479    nil
 480    (propertize murk-error-prefix 'face 'murk-error)
 481    (apply #'concat messages)))
 482
 483 (defun murk--start-of-final-line ()
 484   (with-current-buffer "*murk*"
 485     (save-excursion
 486       (goto-char (point-max))
 487       (line-beginning-position))))
 488
 489 (defun murk-scroll-windows-to-last-line ()
 490   (with-current-buffer "*murk*"
 491     (dolist (window (get-buffer-window-list))
 492       (if (>= (window-point window) (murk--start-of-final-line))
 493           (with-selected-window window
 494             (recenter -1))))))
 495
 496
 497
 498 (defconst murk-url-regex
 499   (rx (:
 500        (group (+ alpha))
 501        "://"
 502        (group (or (+ (any alnum "." "-"))
 503                   (+ (any alnum ":"))))
 504        (opt (group (: ":" (+ digit))))
 505        (opt (group (: "/"
 506                       (opt
 507                        (* (any alnum "-/.,#:%=&_?~@+"))
 508                        (any alnum "-/#:%=&_~@+")))))))
 509   "Imperfect regex used to find URLs in plain text.")
 510
 511 (defun murk-click-url (button)
 512   (browse-url (button-get button 'url)))
 513
 514 (defun murk-buttonify-urls (&rest strings)
 515   "Turn substrings which look like urls in STRING into clickable buttons."
 516   (with-temp-buffer
 517     (apply #'insert strings)
 518     (goto-char (point-min))
 519     (while (re-search-forward murk-url-regex nil t)
 520       (let ((url (match-string 0)))
 521         (make-text-button (match-beginning 0)
 522                           (match-end 0)
 523                           'action #'murk-click-url
 524                           'url url
 525                           'follow-link t
 526                           'face 'button
 527                           'help-echo "Open URL in browser.")))
 528     (buffer-string)))
 529
 530 (defun murk-add-formatting (string)
 531   (with-temp-buffer
 532     (insert string)
 533     (goto-char (point-min))
 534     (let ((bold nil)
 535           (italics nil)
 536           (underline nil)
 537           (strikethrough nil)
 538           (prev-point (point)))
 539       (while (re-search-forward (rx (or (any "\x02\x1D\x1F\x1E\x0F")
 540                                         (: "\x03" (+ digit) (opt "," (* digit)))))
 541                                 nil t)
 542         (let ((beg (+ (match-beginning 0) 1)))
 543           (if bold
 544               (add-face-text-property prev-point beg '(:weight bold)))
 545           (if italics
 546               (add-face-text-property prev-point beg '(:slant italic)))
 547           (if underline
 548               (add-face-text-property prev-point beg '(:underline t)))
 549           (if strikethrough
 550               (add-face-text-property prev-point beg '(:strike-through t)))
 551           (pcase (match-string 0)
 552             ("\x02" (setq bold (not bold)))
 553             ("\x1D" (setq italics (not italics)))
 554             ("\x1F" (setq underline (not underline)))
 555             ("\x1E" (setq strikethrough (not strikethrough)))
 556             ("\x0F" ; Reset
 557              (setq bold nil)
 558              (setq italics nil)
 559              (setq underline nil)
 560              (setq strikethrough nil))
 561             (_))
 562           (delete-region (match-beginning 0) (match-end 0))
 563           (setq prev-point (point)))))
 564     (buffer-string)))
 565
 566
 567 ;;; Message evaluation
 568 ;;
 569
 570 (defun murk-eval-msg-string (server string)
 571   (if murk-debug
 572       (murk-display-string nil nil string))
 573   (let* ((msg (murk-string->msg string)))
 574     (pcase (murk-msg-cmd msg)
 575       ("PING"
 576        (murk-send-msg server
 577         (murk-msg nil nil "PONG" (murk-msg-params msg))))
 578
 579       ("PONG")
 580
 581       ("001"
 582        (let* ((params (murk-msg-params msg))
 583               (nick (elt params 0))
 584               (text (string-join (seq-drop params 1) " ")))
 585          (murk-set-connection-nick server nick)
 586          (murk-display-notice nil text)))
 587
 588       ((rx (= 3 (any digit)))
 589        (murk-display-notice nil (mapconcat 'identity (cdr (murk-msg-params msg)) " ")))
 590
 591       ((and "JOIN"
 592             (guard (equal (murk-connection-nick server)
 593                           (murk-msg-src msg))))
 594        (let ((channel (car (murk-msg-params msg))))
 595          (murk-add-context (list server channel))
 596          (murk-display-notice (murk-current-context)
 597                               "Joining channel " channel " on " server)
 598          (murk-render-prompt)))
 599
 600       ((and "PART"
 601             (guard (equal (murk-connection-nick server)
 602                           (murk-msg-src msg))))
 603        (let ((channel (car (murk-msg-params msg))))
 604          (murk-display-notice (murk-current-context) "Left channel " channel)
 605          (murk-remove-context (list server channel))
 606          (murk-render-prompt)))
 607
 608       ("QUIT"
 609        (let ((nick (murk-msg-src msg))
 610              (reason (mapconcat 'identity (murk-msg-params msg) " ")))
 611          (murk-del-user nick)
 612          (if murk-show-joins
 613              (murk-display-notice nil nick " quit: " reason))))
 614
 615       ("PRIVMSG"
 616        (let* ((from (murk-msg-src msg))
 617               (params (murk-msg-params msg))
 618               (to (car params))
 619               (text (cadr params)))
 620          (pcase text
 621            ("\01VERSION\01"
 622             (let ((version-string (concat murk-version " - running on GNU Emacs " emacs-version)))
 623               (murk-send-msg server
 624                              (murk-msg nil nil "NOTICE"
 625                                        (list from (concat "\01VERSION "
 626                                                           version-string
 627                                                           "\01")))))
 628             (murk-display-notice nil "CTCP version request received from "
 629                                  from " on " server))
 630
 631            ((rx (let ping (: "\01PING " (* (not "\01")) "\01")))
 632             (murk-send-msg server (lurk-msg nil nil "NOTICE" (list from ping)))
 633             (murk-display-notice nil "CTCP ping received from " from " on " server))
 634
 635            ("\01USERINFO\01"
 636             (murk-display-notice nil "CTCP userinfo request from " from
 637                                  " on " server " (no response sent)"))
 638
 639            ("\01CLIENTINFO\01"
 640             (murk-display-notice nil "CTCP clientinfo request from " from
 641                                  " on " server " (no response sent)"))
 642
 643            ((rx (: "\01ACTION " (let action-text (* (not "\01"))) "\01"))
 644             (murk-display-action from to action-text))
 645
 646            (_
 647             (murk-display-message server from to text)))))
 648
 649       (_
 650        (murk-display-notice nil (murk-msg->string msg))))))
 651
 652 ;;; Commands
 653 ;;
 654
 655 (defvar murk-command-table
 656   '(("DEBUG" "Toggle debug mode on/off." murk-command-debug murk-boolean-completions)
 657     ("HEADER" "Toggle display of header." murk-command-header murk-boolean-completions)
 658     ("NETWORKS" "List known IRC networks." murk-command-networks)
 659     ("CONNECT" "Connect to an IRC network." murk-command-connect murk-network-completions)
 660     ("QUIT" "Disconnect from current network." murk-command-quit)
 661     ("JOIN" "Join one or more channels." murk-command-join)
 662     ("PART" "Leave channel." murk-command-part murk-context-completions)
 663     ("NICK" "Change nick." murk-command-nick)
 664     ("MSG" "Send private message to user." murk-command-msg murk-nick-completions)
 665     ("CLEAR" "Clear buffer text." murk-command-clear murk-context-completions)
 666     ("HELP" "Display help on client commands." murk-command-help murk-help-completions))
 667   "Table of commands explicitly supported by murk.")
 668
 669 (defun murk-boolean-completions ()
 670   '("on" "off"))
 671
 672 (defun murk-network-completions ()
 673   (mapcar (lambda (row) (car row)) murk-networks))
 674
 675 (defun murk-command-help (params)
 676   (if params
 677       (let* ((cmd-str (upcase (car params)))
 678              (row (assoc cmd-str murk-command-table #'equal)))
 679         (if row
 680             (progn
 681               (murk-display-notice nil "Help for \x02" cmd-str "\x02:")
 682               (murk-display-notice nil "  " (elt row 1)))
 683           (murk-display-notice nil "No such (client-interpreted) command.")))
 684     (murk-display-notice nil "Client-interpreted commands:")
 685     (dolist (row murk-command-table)
 686       (murk-display-notice nil "  \x02" (elt row 0) "\x02: " (elt row 1)))
 687     (murk-display-notice nil "Use /HELP COMMAND to display information about a specific command.")))
 688
 689 (defun murk-command-debug (params)
 690   (setq murk-debug
 691         (if params
 692             (if (equal (upcase (car params)) "ON")
 693                 t
 694               nil)
 695           (not murk-debug)))
 696   (murk-display-notice nil "Debug mode now " (if murk-debug "on" "off") "."))
 697
 698 (defun murk-command-header (params)
 699   (if
 700       (if params
 701           (equal (upcase (car params)) "ON")
 702         (not header-line-format))
 703       (progn
 704         (murk-setup-header)
 705         (murk-display-notice nil "Header enabled."))
 706     (setq-local header-line-format nil)
 707     (murk-display-notice nil "Header disabled.")))
 708
 709 (defun murk-command-clear (params)
 710   (if (not params)
 711       (murk-clear-buffer)
 712     (dolist (context params)
 713       (murk-clear-context context))))
 714
 715 (defun murk-command-connect (params)
 716   (if params
 717       (let ((network (car params)))
 718         (murk-display-notice nil "Attempting to connect to " network "...")
 719         (murk-connect network))
 720     (murk-display-notice nil "Usage: /connect <network>")))
 721
 722 (defun murk-command-networks (params)
 723   (murk-display-notice nil "Currently-known networks:")
 724   (dolist (row murk-networks)
 725     (seq-let (network server port &rest others) row
 726       (murk-display-notice nil "\t" network
 727                            " [" server
 728                            " " (number-to-string port) "]")))
 729   (murk-display-notice nil "(Modify the `murk-networks' variable to add more.)"))
 730
 731 (defun murk-command-quit (params)
 732   (let ((ctx (murk-current-context)))
 733     (if (not ctx)
 734         (murk-display-error "No current context.")
 735       (let ((quit-msg (if params (string-join params " ") murk-default-quit-msg)))
 736         (murk-send-msg
 737          (murk-context-server ctx)
 738          (murk-msg nil nil "QUIT" quit-msg))))))
 739
 740 (defun murk-command-join (params)
 741   (if params
 742       (let ((server (murk-context-server (murk-current-context))))
 743         (dolist (channel params)
 744           (murk-send-msg server (murk-msg nil nil "JOIN" channel))))
 745     (murk-display-notice nil "Usage: /join channel [channel2 ...]")))
 746
 747 (defun murk-command-part (params)
 748   (let* ((server (murk-context-server (murk-current-context)))
 749          (channel (if params
 750                       (car params)
 751                     (murk-context-name (murk-current-context)))))
 752     (if channel
 753         (murk-send-msg server (murk-msg nil nil "PART" channel))
 754       (murk-display-error "No current channel to leave."))))
 755
 756 (defun murk-command-msg (params)
 757   (let ((server (murk-context-server (murk-current-context))))
 758     (if (and params (>= (length params) 2))
 759         (let ((to (car params))
 760               (text (string-join (cdr params) " ")))
 761           (murk-send-msg server (lurk-msg nil nil "PRIVMSG" to text))
 762           (murk-display-message server
 763                                 (murk-connection-nick server)
 764                                 to text))
 765       (murk-display-notice nil "Usage: /msg <nick> <message>"))))
 766
 767 ;;; Command entering
 768 ;;
 769
 770 (defun murk-enter-string (string)
 771   (if (string-prefix-p "/" string)
 772       (pcase string
 773         ((rx (: "/" (let cmd-str (+ (not whitespace)))
 774                 (opt (+ whitespace)
 775                      (let params-str (+ anychar))
 776                      string-end)))
 777          (let ((command-row (assoc (upcase  cmd-str) murk-command-table #'equal))
 778                (params (if params-str
 779                            (split-string params-str nil t)
 780                          nil)))
 781            (if (and command-row (elt command-row 2))
 782                (funcall (elt command-row 2) params)
 783              (murk-send-msg
 784               (murk-context-server (murk-current-context))
 785               (murk-msg nil nil (upcase cmd-str) params)))))
 786         (_
 787          (murk-display-error "Badly formed command.")))
 788     (unless (string-empty-p string)
 789       (if (murk-current-context)
 790           (let ((server (murk-context-server (murk-current-context))))
 791             (murk-send-msg server
 792                            (murk-msg nil nil "PRIVMSG"
 793                                      (murk-context-name (murk-current-context))
 794                                      string))
 795             (murk-display-message server
 796                                   murk-nick
 797                                   (murk-context->string (murk-current-context))
 798                                   string))
 799         (murk-display-error "No current context.")))))
 800
 801
 802 ;;; Command history
 803 ;;
 804
 805 (defvar murk-history nil
 806   "Commands and messages sent in current session.")
 807
 808 (defvar murk-history-index nil)
 809
 810 (defun murk-history-cycle (delta)
 811   (when murk-history
 812     (with-current-buffer "*murk*"
 813       (if murk-history-index
 814           (setq murk-history-index
 815                 (max 0
 816                      (min (- (length murk-history) 1)
 817                           (+ delta murk-history-index))))
 818         (setq murk-history-index 0))
 819       (delete-region murk-input-marker (point-max))
 820       (insert (elt murk-history murk-history-index)))))
 821
 822
 823 ;;; Interactive commands
 824 ;;
 825
 826 (defun murk-enter ()
 827   "Enter current contents of line after prompt."
 828   (interactive)
 829   (with-current-buffer "*murk*"
 830     (let ((line (buffer-substring murk-input-marker (point-max))))
 831       (push line murk-history)
 832       (setq murk-history-index nil)
 833       (let ((inhibit-read-only t))
 834         (delete-region murk-input-marker (point-max)))
 835       (murk-enter-string line))))
 836
 837 (defun murk-history-next ()
 838   (interactive)
 839   (murk-history-cycle -1))
 840
 841 (defun murk-history-prev ()
 842   (interactive)
 843   (murk-history-cycle +1))
 844
 845 (defun murk-complete-input ()
 846   (interactive)
 847   (let ((completion-ignore-case t))
 848     (when (>= (point) murk-input-marker)
 849       (pcase (buffer-substring murk-input-marker (point))
 850         ((rx (: "/" (let cmd-str (+ (not whitespace))) (+ " ") (* (not whitespace)) string-end))
 851          (let ((space-idx (save-excursion
 852                             (re-search-backward " " murk-input-marker t)))
 853                (table-row (assoc (upcase cmd-str) murk-command-table #'equal)))
 854            (if (and table-row (elt table-row 3))
 855                (let* ((completions-nospace (funcall (elt table-row 3)))
 856                       (completions (mapcar (lambda (el) (concat el " ")) completions-nospace)))
 857                  (completion-in-region (+ 1 space-idx) (point) completions)))))
 858         ((rx (: "/" (* (not whitespace)) string-end))
 859          (message (buffer-substring murk-input-marker (point)))
 860          (completion-in-region murk-input-marker (point)
 861                                (mapcar (lambda (row) (concat "/" (car row) " "))
 862                                        murk-command-table)))
 863         (_
 864          (let* ((end (max murk-input-marker (point)))
 865                 (space-idx (save-excursion
 866                              (re-search-backward " " murk-input-marker t)))
 867                 (start (if space-idx (+ 1 space-idx) murk-input-marker)))
 868            (unless (string-prefix-p "/" (buffer-substring start end))
 869              (let* ((users (murk-get-context-users murk-current-context))
 870                     (users-no@ (mapcar
 871                                 (lambda (u) (car (split-string u "@" t)))
 872                                 users)))
 873                (completion-in-region start end users-no@)))))))))
 874
 875 ;;; Mode
 876 ;;
 877
 878 (defvar murk-mode-map
 879   (let ((map (make-sparse-keymap)))
 880     (define-key map (kbd "RET") 'murk-enter)
 881     (define-key map (kbd "TAB") 'murk-complete-input)
 882     (define-key map (kbd "<C-up>") 'murk-history-prev)
 883     (define-key map (kbd "<C-down>") 'murk-history-next)
 884     (when (fboundp 'evil-define-key*)
 885       (evil-define-key* 'motion map
 886         (kbd "TAB") 'murk-complete-input))
 887     map))
 888
 889 (define-derived-mode murk-mode text-mode "murk"
 890   "Major mode for murk.")
 891
 892 (when (fboundp 'evil-set-initial-state)
 893   (evil-set-initial-state 'murk-mode 'insert))
 894
 895 ;;; Main start procedure
 896 ;;
 897
 898 (defun murk ()
 899   "Start murk or just switch to the murk buffer if one already exists."
 900   (interactive)
 901   (if (get-buffer "*murk*")
 902       (switch-to-buffer "*murk*")
 903     (switch-to-buffer "*murk*")
 904     (murk-mode)
 905     (murk-setup-buffer))
 906   "Started murk.")
 907
 908
 909 ;;; murk.el ends here