Updating Doom Emacs.

.emacs.d/modules/app/irc/README.org

@@ -7,8 +7,11 @@
 - [[#description][Description]]
   - [[#module-flags][Module Flags]]
   - [[#plugins][Plugins]]
-- [[#dependencies][Dependencies]]
 - [[#prerequisites][Prerequisites]]
+  - [[#macos][macOS]]
+  - [[#debian--ubuntu][Debian / Ubuntu]]
+  - [[#arch-linux][Arch Linux]]
+  - [[#nixos][NixOS]]
 - [[#features][Features]]
   - [[#an-irc-client-in-emacs][An IRC Client in Emacs]]
 - [[#configuration][Configuration]]
@@ -17,7 +20,7 @@
 - [[#troubleshooting][Troubleshooting]]
 
 * Description
-This module turns adds an IRC client to Emacs with OS notifications.
+This module turns Emacs into an IRC client, capable of OS notifications.
 
 ** Module Flags
 This module provides no flags.
@@ -26,11 +29,27 @@ This module provides no flags.
 + [[https://github.com/jorgenschaefer/circe][circe]]
 + [[https://github.com/eqyiel/circe-notifications][circe-notifications]]
 
-* Dependencies
-This module requires =gnutls-cli= or =openssl= for secure connections.
-
 * Prerequisites
-This module has no direct prerequisites.
+This module requires =gnutls= for secure IRC connections to work.
+
+** macOS
+#+BEGIN_SRC sh
+brew install gnutls
+#+END_SRC
+
+** Debian / Ubuntu
+#+BEGIN_SRC sh
+apt install gnutls-bin
+#+END_SRC
+
+** Arch Linux
+#+BEGIN_SRC sh
+pacman -S gnutls
+#+END_SRC
+** NixOS
+#+BEGIN_SRC nix
+environment.systemPackages = [ pkgs.gnutls ];
+#+END_SRC
 
 * Features
 ** An IRC Client in Emacs
@@ -54,20 +73,23 @@ When in a circe buffer these keybindings will be available.
 | ~circe-reconnect~           | =SPC m R= | Reconnect the current server                 |
 
 * Configuration
-Use ~set-irc-server!~ to configure IRC servers. Its second argument (a plist)
+Use ~set-irc-server! SERVER PLIST~ to configure IRC servers. Its second argument (a plist)
 takes the same arguments as ~circe-network-options~.
 
 #+BEGIN_SRC emacs-lisp :tangle no
-(set-irc-server! "chat.freenode.net"
-  `(:tls t
-    :nick "doom"
-    :sasl-username "myusername"
-    :sasl-password "mypassword"
-    :channels ("#emacs")))
+;; if you omit =:host=, ~SERVER~ will be used instead.
+(after! circe
+  (set-irc-server! "chat.freenode.net"
+    `(:tls t
+      :port 6697
+      :nick "doom"
+      :sasl-username "myusername"
+      :sasl-password "mypassword"
+      :channels ("#emacs"))))
 #+END_SRC
 
-*It is a obviously a bad idea to store auth-details in plaintext,* so here are
-some ways to avoid that:
+However, *it is a obviously a bad idea to store your password in plaintext,* so
+here are ways to avoid that:
 
 ** Pass: the unix password manager
 [[https://www.passwordstore.org/][Pass]] is my tool of choice. I use it to manage my passwords. If you activate the
@@ -80,6 +102,7 @@ password store.
 #+BEGIN_SRC emacs-lisp :tangle no
 (set-irc-server! "chat.freenode.net"
   `(:tls t
+    :port 6697
     :nick "doom"
     :sasl-username ,(+pass-get-user   "irc/freenode.net")
     :sasl-password ,(+pass-get-secret "irc/freenode.net")
@@ -105,10 +128,10 @@ Note that =+pass-get-user= tries to find your username by looking for the fields
 listed in =+pass-user-fields= (by default =login=, =user==, =username== and
 =email=)=). An example configuration looks like
 
-#+BEGIN_SRC txt :tangle no
+#+begin_example
 mysecretpassword
 username: myusername
-#+END_SRC
+#+end_example
 
 ** Emacs' auth-source API
 ~auth-source~ is built into Emacs. As suggested [[https://github.com/jorgenschaefer/circe/wiki/Configuration#safer-password-management][in the circe wiki]], you can store

.emacs.d/modules/app/irc/autoload/irc.el

@@ -3,15 +3,18 @@
 (defvar +irc--workspace-name "*IRC*")
 
 (defun +irc-setup-wconf (&optional inhibit-workspace)
-  (unless inhibit-workspace
-    (+workspace-switch +irc--workspace-name t))
+  (when (and (featurep! :ui workspaces)
+             (not inhibit-workspace))
+    (+workspace-switch +irc--workspace-name 'auto-create))
   (let ((buffers (doom-buffers-in-mode 'circe-mode nil t)))
-    (if buffers
-        (ignore (switch-to-buffer (car buffers)))
-      (require 'circe)
-      (delete-other-windows)
-      (switch-to-buffer (doom-fallback-buffer))
-      t)))
+    (if (not (member (window-buffer) buffers))
+        (if buffers
+            (ignore (switch-to-buffer (car buffers)))
+          (require 'circe)
+          (delete-other-windows)
+          (switch-to-buffer (doom-fallback-buffer))
+          t)
+      (user-error "IRC buffer is already active and selected"))))
 
 ;;;###autoload
 (defun =irc (&optional inhibit-workspace)
@@ -20,17 +23,12 @@
 If INHIBIT-WORKSPACE (the universal argument) is non-nil, don't spawn a new
 workspace for it."
   (interactive "P")
-  (cond ((and (featurep! :ui workspaces)
-              (+workspace-exists-p +irc--workspace-name))
-         (+workspace-switch +irc--workspace-name))
-        ((not (+irc-setup-wconf inhibit-workspace))
-         (user-error "Couldn't start up a workspace for IRC")))
-  (if (doom-buffers-in-mode 'circe-mode (buffer-list) t)
-      (message "Circe buffers are already open")
-    (if circe-network-options
-        (cl-loop for network in circe-network-options
-                 collect (circe (car network)))
-      (call-interactively #'circe))))
+  (+irc-setup-wconf inhibit-workspace)
+  (cond ((doom-buffers-in-mode 'circe-mode (doom-buffer-list) t)
+         (message "Circe buffers are already open"))
+        (circe-network-options
+         (mapc #'circe (mapcar #'car circe-network-options)))
+        ((call-interactively #'circe))))
 
 ;;;###autoload
 (defun +irc/connect (&optional inhibit-workspace)
@@ -52,16 +50,17 @@ workspace for it."
 (defun +irc/quit ()
   "Kill current circe session and workgroup."
   (interactive)
-  (if (y-or-n-p "Really kill IRC session?")
-      (let (circe-channel-killed-confirmation
-            circe-server-killed-confirmation)
-        (when +irc--defer-timer
-          (cancel-timer +irc--defer-timer))
-        (disable-circe-notifications)
-        (mapc #'kill-buffer (doom-buffers-in-mode 'circe-mode (buffer-list) t))
-        (when (equal (+workspace-current-name) +irc--workspace-name)
-          (+workspace/delete +irc--workspace-name)))
-    (message "Aborted")))
+  (unless (y-or-n-p "Really kill IRC session?")
+    (user-error "Aborted"))
+  (let (circe-channel-killed-confirmation
+        circe-server-killed-confirmation)
+    (when +irc--defer-timer
+      (cancel-timer +irc--defer-timer))
+    (disable-circe-notifications)
+    (mapc #'kill-buffer (doom-buffers-in-mode 'circe-mode (buffer-list) t))
+    (when (featurep! :ui workspaces)
+      (when (equal (+workspace-current-name) +irc--workspace-name)
+        (+workspace/delete +irc--workspace-name)))))
 
 ;;;###autoload
 (defun +irc/ivy-jump-to-channel (&optional this-server)
@@ -93,7 +92,7 @@ argument) is non-nil only show channels in current server."
 
 ;;;###autoload
 (defun +irc/tracking-next-buffer ()
-  "Dissables switching to an unread buffer unless in the irc workspace."
+  "Disables switching to an unread buffer unless in the irc workspace."
   (interactive)
   (when (derived-mode-p 'circe-mode)
     (tracking-next-buffer)))
@@ -106,13 +105,12 @@ argument) is non-nil only show channels in current server."
 (defun +circe-buffer-p (buf)
   "Return non-nil if BUF is a `circe-mode' buffer."
   (with-current-buffer buf
-    (and (derived-mode-p 'circe-mode)
-         (eq (safe-persp-name (get-current-persp))
-             +irc--workspace-name))))
+    (derived-mode-p 'circe-mode)))
 
 ;;;###autoload
 (defun +irc--add-circe-buffer-to-persp-h ()
-  (when (bound-and-true-p persp-mode)
+  (when (and (bound-and-true-p persp-mode)
+             (+workspace-exists-p +irc--workspace-name))
     (let ((persp (get-current-persp))
           (buf (current-buffer)))
       ;; Add a new circe buffer to irc workspace when we're in another workspace

.emacs.d/modules/app/irc/autoload/settings.el

@@ -1,9 +1,17 @@
 ;;; app/irc/autoload/settings.el -*- lexical-binding: t; -*-
 
 ;;;###autodef
-(defun set-irc-server! (server letvars)
+(defun set-irc-server! (server plist)
   "Registers an irc SERVER for circe.
 
+SERVER can either be a name for the network (in which case you must specify a
+:host), or it may be the hostname itself, in which case it will be used as the
+:host.
+
 See `circe-network-options' for details."
   (after! circe
-    (push (cons server letvars) circe-network-options)))
+    (unless (plist-member plist :host)
+      (plist-put! plist :host server))
+    (setf (alist-get server circe-network-options
+                     nil nil #'equal)
+          plist)))

.emacs.d/modules/app/irc/config.el

@@ -48,7 +48,6 @@ playback.")
 
 (use-package! circe
   :commands circe circe-server-buffers
-  :init (setq circe-network-defaults nil)
   :config
   (setq circe-default-quit-message nil
         circe-default-part-message nil
@@ -93,6 +92,26 @@ playback.")
   (add-hook 'doom-real-buffer-functions #'+circe-buffer-p)
   (add-hook 'circe-channel-mode-hook #'turn-on-visual-line-mode)
   (add-hook 'circe-mode-hook #'+irc--add-circe-buffer-to-persp-h)
+  (add-hook 'circe-mode-hook #'turn-off-smartparens-mode)
+
+  ;; HACK Fix #1862: circe hangs on TLS connections when using OpenSSL versions
+  ;;      > 1.1.0, where tls.el does not correctly determine the end of the info
+  ;;      block. This fixes proposed in jorgenschaefer/circe#340
+  (setq-hook! 'circe-mode-hook
+    tls-end-of-info
+    (concat "\\("
+            ;; `openssl s_client' regexp. See ssl/ssl_txt.c lines 219-220.
+            ;; According to apps/s_client.c line 1515 `---' is always the last
+            ;; line that is printed by s_client before the real data.
+            "^    Verify return code: .+\n\\(\\|^    Extended master secret: .+\n\\)\\(\\|^    Max Early Data: .+\n\\)---\n\\|"
+            ;; `gnutls' regexp. See src/cli.c lines 721-.
+            "^- Simple Client Mode:\n"
+            "\\(\n\\|"                           ; ignore blank lines
+            ;; According to GnuTLS v2.1.5 src/cli.c lines 640-650 and 705-715 in
+            ;; `main' the handshake will start after this message. If the
+            ;; handshake fails, the programs will abort.
+            "^\\*\\*\\* Starting TLS handshake\n\\)*"
+            "\\)"))
 
   (defadvice! +irc--circe-run-disconnect-hook-a (&rest _)
     "Runs `+irc-disconnect-hook' after circe disconnects."
@@ -175,7 +194,7 @@ playback.")
   (define-key lui-mode-map "\C-u" #'lui-kill-to-beginning-of-line)
   (setq lui-fill-type nil)
 
-  (when (featurep! :tools flyspell)
+  (when (featurep! :checkers spell)
     (setq lui-flyspell-p t))
 
   (after! evil

.emacs.d/modules/app/irc/packages.el

@@ -1,5 +1,5 @@
 ;; -*- no-byte-compile: t; -*-
 ;;; app/irc/packages.el
 
-(package! circe)
-(package! circe-notifications)
+(package! circe :pin "e5bf5f89741a9c43aa406491e94dd8d58c302fb4")
+(package! circe-notifications :pin "291149ac12877bbd062da993479d3533a26862b0")