From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "J.P." Newsgroups: gmane.emacs.bugs,gmane.emacs.erc.general Subject: bug#70127: 29.3; ERC 5.6-git: /ignore timeouts are not cancelled/reset Date: Tue, 02 Apr 2024 11:23:37 -0700 Message-ID: <87edbnei8m.fsf@neverwas.me> References: <87y19xarh5.fsf@tilde.club> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36884"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 70127@debbugs.gnu.org, emacs-erc@gnu.org To: Alcor Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Apr 02 20:24:23 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rrio2-0009M7-Ew for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 02 Apr 2024 20:24:23 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rrinn-0005yS-Ug; Tue, 02 Apr 2024 14:24:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rrinf-0005ww-I2 for bug-gnu-emacs@gnu.org; Tue, 02 Apr 2024 14:24:00 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rrinf-0001Ju-A3 for bug-gnu-emacs@gnu.org; Tue, 02 Apr 2024 14:23:59 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rrinj-0004RU-2i for bug-gnu-emacs@gnu.org; Tue, 02 Apr 2024 14:24:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "J.P." Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 02 Apr 2024 18:24:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 70127 X-GNU-PR-Package: emacs Original-Received: via spool by 70127-submit@debbugs.gnu.org id=B70127.171208223517013 (code B ref 70127); Tue, 02 Apr 2024 18:24:03 +0000 Original-Received: (at 70127) by debbugs.gnu.org; 2 Apr 2024 18:23:55 +0000 Original-Received: from localhost ([127.0.0.1]:56318 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rrinX-0004Pq-N2 for submit@debbugs.gnu.org; Tue, 02 Apr 2024 14:23:55 -0400 Original-Received: from mail-108-mta201.mxroute.com ([136.175.108.201]:37079) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rrinU-0004PX-8r for 70127@debbugs.gnu.org; Tue, 02 Apr 2024 14:23:50 -0400 Original-Received: from filter006.mxroute.com ([136.175.111.2] filter006.mxroute.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta201.mxroute.com (ZoneMTA) with ESMTPSA id 18ea00d77a90003bea.001 for <70127@debbugs.gnu.org> (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384); Tue, 02 Apr 2024 18:23:40 +0000 X-Zone-Loop: f21e0b5fedab5c01993d0098b095e0b053151243922f X-Originating-IP: [136.175.111.2] DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=neverwas.me ; s=x; h=Content-Type:MIME-Version:Message-ID:Date:References:In-Reply-To: Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=JneM+YKufMwnfxGUwRPR3GGAq81+cBp+6vKmW6BN2dw=; b=YLfAu0vlyql22qhb3xFLFwTC+I zmQkEB+CJQ/va0bdWiypweHbgyEFUZDT3E9pgUK8ZGz61d5v5V9jp3uEqWUQvYCaG0j+8MrW0IbfF URhLkWLkpBoDDO0E7xct7eQVy65ck3rZggFLmM9fIUjM7ds3ZyRpLY0Ay+GbNY8IkZse8CgX3PFBz VG0DV4NyVvzHx8BkGiuDKjZ6EsH9yob93FdRBez+sdB/wUz+15GP6rYNybuJbSLip09CfA5YG51Ru 8/Lo+e8rewzY/ZnbFSIiaLRaHqkYiMdhEh0FtKrrygUloiYO1gTXbMGwzEbWobO6X0Y+n28SKcSGV FT77QTcw==; In-Reply-To: <87y19xarh5.fsf@tilde.club> (Alcor via General discussion about's message of "Mon, 01 Apr 2024 20:05:26 +0200") X-Authenticated-Id: masked@neverwas.me X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:282539 gmane.emacs.erc.general:2497 Archived-At: --=-=-= Content-Type: text/plain Alcor via General discussion about ERC writes: > Severity: wishlist > > On Erc (5.6snapshot0.20240323.151032): > > 1. /IGNORE a specific nick with an explicit timeout (e.g. 5m) > 2. /IGNORE the same nick again with a different timeout (e.g. 10m) > > Expected behavior: > > The /IGNORE'ed nick is unignored after 10 minutes. > > Observed behavior: > > The /IGNORE'ed nick is unignored after 5 minutes, afterwhich it is > unignored again after 10 minutes. The latter command is a no-op though, > as the nick would be already unignored at that point. I'm taking the liberty of "extending" this bug to include a somewhat related issue. I suppose that's bad practice, but it'll allow us to roll the original request into the fix without much hassle. >From Emacs -Q: 1. M-x erc RET localhost RET RET RET RET 2. /ignore foo RET 3. Hit RET to forgo adding a timer (doesn't impact result) 4. /unignore fool RET ; note the trailing "l" 5. Answer "y" when asked whether to remove "foo" 6. /ignore RET 7. Notice "foo" is still listed and still appears in `erc-ignore-list' The attached patch tries to address this issue as well as the original UX problem regarding rustic timeout handling, with ideas borrowed from Alcor's gist shared on the emacs-erc list. Not to keep harping on this, but I'd much rather we rewrite the ignore and lurker stuff completely and move it to a new module in a new file. Anyone feeling up to the challenge, please step forward. Thanks. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-5.6-Allow-updating-of-IGNORE-timeouts-in-ERC.patch >From 61d5b7ae9eb7adb1b04383dae1498c957f0608b5 Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Mon, 1 Apr 2024 15:27:47 -0700 Subject: [PATCH] [5.6] Allow updating of /IGNORE timeouts in ERC * lisp/erc/erc.el (erc--read-time-period, erc--decode-time-period): Move body of former, now a superficial wrapper, to latter, a new function. (erc--labeled-time-duration): New function. (erc--get-ignore-timer-args): New function. (erc--find-ignore-timer): New function to search through `timer-list' to find registered timer. (erc-cmd-IGNORE): Refactor. Add new optional `timespec' parameter. Update an existing timer instead of always creating one, and display time remaining in "ignore list" output. Pass server buffer instead of current buffer to timer callbacks because `erc--unignore-user' displays its messages in the `active' buffer, not necessarily the issuing one. However, doing this does discard potentially useful information. If ever reverting, we can change the `cl-find' :test in `erc--find-ignore-timer' to something that compares the `erc-server-process' of both buffers. ;; ;; Something like: ;; ;; (defun erc--ignore-timers-equal-p (a b) ;; (and (equal (car a) (car b)) ;; (eq (buffer-local-value 'erc-server-process (cadr a)) ;; (buffer-local-value 'erc-server-process (cadr b))))) ;; (erc-cmd-UNIGNORE): Pass `erc-ignore-list' member matching `user' parameter to `erc--unignore-user' instead of original, raw parameter, along with the server buffer. (erc--unignore-user): Cancel existing timer and don't bother switching to server buffer since we're already there. (erc-message-english-ignore-list): New variable. * test/lisp/erc/erc-scenarios-ignore.el: New file. * test/lisp/erc/erc-tests.el (erc--read-time-period): New test. (erc-cmd-UNIGNORE): New test. (Bug#70127) --- lisp/erc/erc.el | 92 ++++++++++++++++++++------- test/lisp/erc/erc-scenarios-ignore.el | 79 +++++++++++++++++++++++ test/lisp/erc/erc-tests.el | 24 +++++++ 3 files changed, 172 insertions(+), 23 deletions(-) create mode 100644 test/lisp/erc/erc-scenarios-ignore.el diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 0750463a4e7..909712c8db7 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -4191,8 +4191,11 @@ erc--read-time-period If input is blank, this function returns nil. Otherwise it returns the time spec converted to a number of seconds." - (let ((period (string-trim - (read-string prompt nil 'erc--read-time-period-history)))) + (erc--decode-time-period + (string-trim (read-string prompt nil 'erc--read-time-period-history)))) + +(defun erc--decode-time-period (period) + (progn (cond ;; Blank input. ((zerop (length period)) @@ -4223,36 +4226,76 @@ erc--read-time-period (user-error "%s is not a valid time period" period)) (decoded-time-period time)))))) -(defun erc-cmd-IGNORE (&optional user) - "Ignore USER. This should be a regexp matching nick!user@host. -If no USER argument is specified, list the contents of `erc-ignore-list'." +(defun erc--labeled-time-duration (secs) + "Return a string with hour/minute/second labels for duration SECS." + (let* ((hours (floor secs 3600)) + (minutes (floor (mod secs 3600) 60)) + (seconds (mod secs 60))) + (cond ((>= secs 3600) (format "%dh%dm%ds" hours minutes (round seconds))) + ((>= secs 60) (format "%dm%ds" minutes (round seconds))) + (t (format "%ds" (round seconds)))))) + +(defun erc--get-ignore-timer-args (inst) + ;; The `cl-struct' `pcase' pattern and `cl-struct-slot-value' emit + ;; warnings when compiling because `timer' is un-`:named'. + (when (and (timerp inst) + (eq (aref inst (cl-struct-slot-offset 'timer 'function)) + 'erc--unignore-user)) + (aref inst (cl-struct-slot-offset 'timer 'args)))) + +(defun erc--find-ignore-timer (&rest args) + "Find an existing ignore timer." + (cl-find args timer-list :key #'erc--get-ignore-timer-args :test #'equal)) + +(defun erc-cmd-IGNORE (&optional user timespec) + "Drop messages from senders, like nick!user@host, matching regexp USER. +With human-readable TIMESPEC, ignore messages from matched senders for +the specified duration, like \"20m\". Without USER, list the contents +of `erc-ignore-list'." (if user - (let ((quoted (regexp-quote user))) + (let ((quoted (regexp-quote user)) + (prompt "Add a timeout? (Blank for no, or a time spec like 2h): ") + timeout msg) (when (and (not (string= user quoted)) (y-or-n-p (format "Use regexp-quoted form (%s) instead? " quoted))) (setq user quoted)) - (let ((timeout - (erc--read-time-period - "Add a timeout? (Blank for no, or a time spec like 2h): ")) - (buffer (current-buffer))) + (unless timespec + (setq timespec + (read-string prompt nil 'erc--read-time-period-history))) + (setq timeout (erc--decode-time-period (string-trim timespec)) + msg (if timeout + (format "Now ignoring %s for %s" user + (erc--labeled-time-duration timeout)) + (format "Now ignoring %s" user))) + (erc-with-server-buffer (when timeout - (run-at-time timeout nil - (lambda () - (erc--unignore-user user buffer)))) - (erc-display-message nil 'notice 'active - (format "Now ignoring %s" user)) - (erc-with-server-buffer (add-to-list 'erc-ignore-list user)))) + (if-let ((existing (erc--find-ignore-timer user (current-buffer)))) + (timer-set-time existing (timer-relative-time nil timeout)) + (run-at-time timeout nil #'erc--unignore-user user + (current-buffer)))) + (erc-display-message nil 'notice 'active msg) + (cl-pushnew user erc-ignore-list :test #'equal))) (if (null (erc-with-server-buffer erc-ignore-list)) (erc-display-message nil 'notice 'active "Ignore list is empty") (erc-display-message nil 'notice 'active "Ignore list:") - (mapc (lambda (item) - (erc-display-message nil 'notice 'active item)) - (erc-with-server-buffer erc-ignore-list)))) + (erc-with-server-buffer + (let ((seen (copy-sequence erc-ignore-list))) + (dolist (timer timer-list) + (when-let ((args (erc--get-ignore-timer-args timer)) + ((eq (current-buffer) (nth 1 args))) + (user (car args)) + (delta (- (timer-until timer (current-time)))) + (duration (erc--labeled-time-duration delta))) + (setq seen (delete user seen)) + (erc-display-message nil 'notice 'active 'ignore-list + ?p user ?s duration))) + (dolist (pattern seen) + (erc-display-message nil 'notice 'active pattern)))))) t) (defun erc-cmd-UNIGNORE (user) - "Remove the user specified in USER from the ignore list." + "Remove the first pattern in `erc-ignore-list' matching USER." (let ((ignored-nick (car (erc-with-server-buffer (erc-member-ignore-case (regexp-quote user) erc-ignore-list))))) @@ -4264,16 +4307,18 @@ erc-cmd-UNIGNORE (erc-display-message nil 'notice 'active (format "%s is not currently ignored!" user)))) (when ignored-nick - (erc--unignore-user user (current-buffer)))) + (erc--unignore-user ignored-nick (erc-server-buffer)))) t) (defun erc--unignore-user (user buffer) (when (buffer-live-p buffer) (with-current-buffer buffer + (cl-assert (erc--server-buffer-p)) (erc-display-message nil 'notice 'active (format "No longer ignoring %s" user)) - (erc-with-server-buffer - (setq erc-ignore-list (delete user erc-ignore-list)))))) + (setq erc-ignore-list (delete user erc-ignore-list)) + (when-let ((existing (erc--find-ignore-timer user buffer))) + (cancel-timer existing))))) (defvar erc--pre-clear-functions nil "Abnormal hook run when truncating buffers. @@ -9299,6 +9344,7 @@ english . "\n\n*** Connection failed! Re-establishing connection...\n") (disconnected-noreconnect . "\n\n*** Connection failed! Not re-establishing connection.\n") + (ignore-list . "%-8p %s") (reconnecting . "Reconnecting in %ms: attempt %i/%n ...") (reconnect-canceled . "Canceled %u reconnect timer with %cs to go...") (finished . "\n\n*** ERC finished ***\n") diff --git a/test/lisp/erc/erc-scenarios-ignore.el b/test/lisp/erc/erc-scenarios-ignore.el new file mode 100644 index 00000000000..c830e9d2c87 --- /dev/null +++ b/test/lisp/erc/erc-scenarios-ignore.el @@ -0,0 +1,79 @@ +;;; erc-scenarios-ignore.el --- Misc commands for ERC -*- lexical-binding: t -*- + +;; Copyright (C) 2023-2024 Free Software Foundation, Inc. + +;; This file is part of GNU Emacs. + +;; GNU Emacs is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; GNU Emacs is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with GNU Emacs. If not, see . + +;;; Commentary: + +;; TODO add test covering the same ignored speaker in two different +;; channels on the same server: they should be ignored in both. + +;;; Code: + +(require 'ert-x) +(eval-and-compile + (let ((load-path (cons (ert-resource-directory) load-path))) + (require 'erc-scenarios-common))) + +(ert-deftest erc-scenarios-ignore/basic () + :tags '(:expensive-test) + (erc-scenarios-common-with-cleanup + ((erc-scenarios-common-dialog "base/assoc/multi-net") + (erc-server-flood-penalty 0.1) + (dumb-server-foonet (erc-d-run "localhost" t 'foonet)) + (dumb-server-barnet (erc-d-run "localhost" t 'barnet)) + (erc-autojoin-channels-alist '((foonet "#chan") (barnet "#chan"))) + (port-foonet (process-contact dumb-server-foonet :service)) + (port-barnet (process-contact dumb-server-barnet :service)) + (expect (erc-d-t-make-expecter))) + + (ert-info ("Connect to two networks") + (with-current-buffer (erc :server "127.0.0.1" + :port port-barnet + :nick "tester" + :password "changeme" + :full-name "tester")) + (with-current-buffer (erc :server "127.0.0.1" + :port port-foonet + :nick "tester" + :password "changeme" + :full-name "tester") + (funcall expect 10 "debug mode"))) + + (with-current-buffer (erc-d-t-wait-for 10 (get-buffer "#chan@foonet")) + (funcall expect 10 " tester, welcome!") + (funcall expect 10 " tester, welcome!") + (erc-scenarios-common-say "/ignore alice 1m") + (erc-scenarios-common-say "/ignore mike 1h") + (funcall expect 10 "ignoring alice for 1m0s") + (funcall expect 10 " alice: Signior Iachimo") + (erc-scenarios-common-say "/ignore") + (funcall expect 10 "alice 60s") + (funcall expect 10 "mike 59m60s") + (funcall expect -0.1 "") + (funcall expect 10 " alice: The ground is bloody") + (erc-scenarios-common-say "/unignore alice") + (funcall expect 10 "")) + + ;; No messages were ignored on network barnet. + (with-current-buffer (erc-d-t-wait-for 10 (get-buffer "#chan@barnet")) + (funcall expect 10 " tester, welcome!") + (funcall expect 10 " tester, welcome!") + (funcall expect 10 " joe: Whipp'd") + (funcall expect 10 " joe: Double")))) + +;;; erc-scenarios-ignore.el ends here diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index 3e8ddef3731..ad6074ab6d3 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -50,6 +50,30 @@ erc--read-time-period (cl-letf (((symbol-function 'read-string) (lambda (&rest _) "1d"))) (should (equal (erc--read-time-period "foo: ") 86400)))) +(ert-deftest erc--labeled-time-duration () + (should (equal (erc--labeled-time-duration 10) "10s")) + (should (equal (erc--labeled-time-duration 10.1) "10s")) + (should (equal (erc--labeled-time-duration 100) "1m40s")) + (should (equal (erc--labeled-time-duration 100.1) "1m40s")) + (should (equal (erc--labeled-time-duration 1000) "16m40s"))) + +;; This asserts that the first pattern on file matching a supplied +;; `user' parameter will be removed after confirmation. +(ert-deftest erc-cmd-UNIGNORE () + (should (local-variable-if-set-p 'erc-ignore-list)) + (erc-tests-common-make-server-buf) + + (setq erc-ignore-list (list ".")) ; match anything + (ert-simulate-keys (list ?\r) + (erc-cmd-IGNORE "abc")) + (should (equal erc-ignore-list '("abc" "."))) + + (cl-letf (((symbol-function 'y-or-n-p) #'always)) + (erc-cmd-UNIGNORE "abcdef") + (should (equal erc-ignore-list '("."))) + (erc-cmd-UNIGNORE "foo")) + (should-not erc-ignore-list)) + (ert-deftest erc-with-all-buffers-of-server () (let (proc-exnet proc-onet -- 2.44.0 --=-=-=--