Favor ISUPPORT params for MODE processing in ERC
* etc/ERC-NEWS: Mention shift toward CHANMODES ISUPPORT parameter for
dictating MODE parsing behavior.
* lisp/erc/erc-backend.el (erc--init-channel-modes, erc--update-modes,
erc-set-modes, erc-update-modes): Forward declarations, the last two
being removals.
(erc-server-MODE, erc-server-221): Use `erc--update-modes' instead of
`erc-update-modes'.
(erc-server-324): Use `erc--init-channel-modes' instead of
`erc-set-modes'.
* lisp/erc/erc-common.el (erc--channel-mode-types): New struct for
stashing processed \"CHANMODES\" data for the current server.
* lisp/erc/erc.el (erc-channel-modes): Fix doc string.
(erc-set-initial-user-mode): Display a local notice when requesting
redundant user MODE operations.
(erc-set-modes, erc-parse-modes, erc-update-modes): Deprecate for
reasons explained in associated ERC-NEWS entry.
(erc--update-membership-prefix): New function, a helper for specifying
arguments to the rather unruly `erc-update-current-channel-member'.
(erc--channel-modes): New variable to record channel-mode state in a
hash table.
(erc--channel-mode-types): New variable and getter to stash
and retrieve server-local instance of the struct of the same name.
(erc--process-channel-modes): New function to parse channel-mode
changes, dispatch handlers for unary modes, and update the local
variables `erc-channel-modes' and `erc--channel-modes'.
(erc--user-modes): New local variable for remembering user modes per
server. New function of the same name, a "getter" for the variable.
(erc--parse-user-modes): New function to parse user modes only.
(erc--update-user-modes): New function to update and sort
`erc--user-modes'.
(erc--update-channel-modes): New function to replace much of
`erc-update-modes', currently a thin wrapper around
`erc--process-channel-modes' to ensure it updates status prefixes.
(erc--update-modes): New function to call appropriate mode-updating
function for the current buffer.
(erc--init-channel-modes): New function to update channel mode letters
without status prefixes.
(erc--handle-channel-mode): New generic function, a placeholder for an
eventual API to handle specific "unary" mode letters, meaning those
that specify a single parameter for setting or unsetting.
(erc-update-channel-limit): Update doc string and answer question
posed by ancient comment.
(erc-message-english-user-mode-redundant-add,
erc-message-english-user-mode-redundant-drop): New English catalog
messages.
* test/lisp/erc/erc-scenarios-base-chan-modes.el: New file.
* test/lisp/erc/erc-tests.el (erc-parse-modes,
erc--update-channel-modes, erc--update-user-modes, erc--user-modes,
erc--parse-user-modes): New tests.
* test/lisp/erc/resources/base/modes/chan-changed.eld: New test data
file. (Bug#67220)
2023-11-14 21:10:39 -08:00
|
|
|
;;; erc-scenarios-base-chan-modes.el --- Channel mode scenarios -*- lexical-binding: t -*-
|
|
|
|
|
2024-01-02 10:30:05 +08:00
|
|
|
;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
|
Favor ISUPPORT params for MODE processing in ERC
* etc/ERC-NEWS: Mention shift toward CHANMODES ISUPPORT parameter for
dictating MODE parsing behavior.
* lisp/erc/erc-backend.el (erc--init-channel-modes, erc--update-modes,
erc-set-modes, erc-update-modes): Forward declarations, the last two
being removals.
(erc-server-MODE, erc-server-221): Use `erc--update-modes' instead of
`erc-update-modes'.
(erc-server-324): Use `erc--init-channel-modes' instead of
`erc-set-modes'.
* lisp/erc/erc-common.el (erc--channel-mode-types): New struct for
stashing processed \"CHANMODES\" data for the current server.
* lisp/erc/erc.el (erc-channel-modes): Fix doc string.
(erc-set-initial-user-mode): Display a local notice when requesting
redundant user MODE operations.
(erc-set-modes, erc-parse-modes, erc-update-modes): Deprecate for
reasons explained in associated ERC-NEWS entry.
(erc--update-membership-prefix): New function, a helper for specifying
arguments to the rather unruly `erc-update-current-channel-member'.
(erc--channel-modes): New variable to record channel-mode state in a
hash table.
(erc--channel-mode-types): New variable and getter to stash
and retrieve server-local instance of the struct of the same name.
(erc--process-channel-modes): New function to parse channel-mode
changes, dispatch handlers for unary modes, and update the local
variables `erc-channel-modes' and `erc--channel-modes'.
(erc--user-modes): New local variable for remembering user modes per
server. New function of the same name, a "getter" for the variable.
(erc--parse-user-modes): New function to parse user modes only.
(erc--update-user-modes): New function to update and sort
`erc--user-modes'.
(erc--update-channel-modes): New function to replace much of
`erc-update-modes', currently a thin wrapper around
`erc--process-channel-modes' to ensure it updates status prefixes.
(erc--update-modes): New function to call appropriate mode-updating
function for the current buffer.
(erc--init-channel-modes): New function to update channel mode letters
without status prefixes.
(erc--handle-channel-mode): New generic function, a placeholder for an
eventual API to handle specific "unary" mode letters, meaning those
that specify a single parameter for setting or unsetting.
(erc-update-channel-limit): Update doc string and answer question
posed by ancient comment.
(erc-message-english-user-mode-redundant-add,
erc-message-english-user-mode-redundant-drop): New English catalog
messages.
* test/lisp/erc/erc-scenarios-base-chan-modes.el: New file.
* test/lisp/erc/erc-tests.el (erc-parse-modes,
erc--update-channel-modes, erc--update-user-modes, erc--user-modes,
erc--parse-user-modes): New tests.
* test/lisp/erc/resources/base/modes/chan-changed.eld: New test data
file. (Bug#67220)
2023-11-14 21:10:39 -08:00
|
|
|
|
|
|
|
;; 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 <https://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
(require 'ert-x)
|
|
|
|
(eval-and-compile
|
|
|
|
(let ((load-path (cons (ert-resource-directory) load-path)))
|
|
|
|
(require 'erc-scenarios-common)))
|
|
|
|
|
|
|
|
;; This asserts that a bug present in ERC 5.4+ is now absent.
|
|
|
|
;; Previously, ERC would attempt to parse a nullary channel mode as if
|
|
|
|
;; it were a status prefix update, which led to a wrong-type error.
|
|
|
|
;; This test does not address similar collisions with unary modes,
|
|
|
|
;; such as "MODE +q foo!*@*", but it should.
|
|
|
|
(ert-deftest erc-scenarios-base-chan-modes--plus-q ()
|
|
|
|
:tags '(:expensive-test)
|
|
|
|
(erc-scenarios-common-with-cleanup
|
|
|
|
((erc-scenarios-common-dialog "base/modes")
|
|
|
|
(erc-server-flood-penalty 0.1)
|
|
|
|
(dumb-server (erc-d-run "localhost" t 'chan-changed))
|
|
|
|
(erc-modules (cons 'fill-wrap erc-modules))
|
|
|
|
(erc-autojoin-channels-alist '((Libera.Chat "#chan")))
|
|
|
|
(expect (erc-d-t-make-expecter)))
|
|
|
|
|
|
|
|
(ert-info ("Connect to Libera.Chat")
|
|
|
|
(with-current-buffer (erc :server "127.0.0.1"
|
|
|
|
:port (process-contact dumb-server :service)
|
|
|
|
:nick "tester"
|
|
|
|
:full-name "tester")
|
|
|
|
(funcall expect 5 "changed mode")))
|
|
|
|
|
|
|
|
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
|
|
|
|
(should-not erc-channel-key)
|
|
|
|
(should-not erc-channel-user-limit)
|
|
|
|
|
|
|
|
(ert-info ("Receive notice that mode has changed")
|
|
|
|
(erc-d-t-wait-for 10 (equal erc-channel-modes '("n" "t")))
|
|
|
|
(erc-scenarios-common-say "ready before")
|
|
|
|
(funcall expect 10 "<Chad> before")
|
|
|
|
(funcall expect 10 " has changed mode for #chan to +Qu")
|
|
|
|
(erc-d-t-wait-for 10 (equal erc-channel-modes '("Q" "n" "t" "u"))))
|
|
|
|
|
|
|
|
(ert-info ("Key stored locally")
|
|
|
|
(erc-scenarios-common-say "ready key")
|
|
|
|
(funcall expect 10 "<Chad> doing key")
|
|
|
|
(funcall expect 10 " has changed mode for #chan to +k hunter2")
|
|
|
|
(should (equal erc-channel-key "hunter2")))
|
|
|
|
|
|
|
|
(ert-info ("Limit stored locally")
|
|
|
|
(erc-scenarios-common-say "ready limit")
|
|
|
|
(funcall expect 10 "<Chad> doing limit")
|
|
|
|
(funcall expect 10 " has changed mode for #chan to +l 3")
|
|
|
|
(erc-d-t-wait-for 10 (eql erc-channel-user-limit 3))
|
|
|
|
(should (equal erc-channel-modes '("Q" "n" "t" "u"))))
|
|
|
|
|
|
|
|
(ert-info ("Modes removed and local state deletion succeeds")
|
|
|
|
(erc-scenarios-common-say "ready drop")
|
|
|
|
(funcall expect 10 "<Chad> dropping")
|
|
|
|
(funcall expect 10 " has changed mode for #chan to -lu")
|
|
|
|
(funcall expect 10 " has changed mode for #chan to -Qk *")
|
|
|
|
(erc-d-t-wait-for 10 (equal erc-channel-modes '("n" "t"))))
|
|
|
|
|
|
|
|
(should-not erc-channel-key)
|
|
|
|
(should-not erc-channel-user-limit)
|
|
|
|
(funcall expect 10 "<Chad> after"))))
|
|
|
|
|
Actually derive channel membership from PREFIX in ERC
* lisp/erc/erc-backend.el (erc--with-isupport-data): Add comment for
possibly superior alternate implementation.
* lisp/erc/erc-common.el (erc--get-isupport-entry): Use helper to
initialize traditional prefix slots in overridden well-known
constructor.
(erc--parsed-prefix): Reverse order of characters in the `letters'
and `statuses' slots, in their defaults and also their definitions.
(erc--strpos): New function, a utility for finding a single character
in a string.
* lisp/erc/erc.el (erc--define-channel-user-status-compat-getter):
Modify to query advertised value for associated mode letter at runtime
instead of baking it in.
(erc-channel-user-voice, erc-channel-user-halfop, erc-channel-user-op,
erc-channel-user-admin, erc-channel-user-owner): Supply second
argument for fallback mode letter.
(erc--cusr-status-p, erc--cusr-change-status): New functions for
querying and modifying `erc-channel-user' statuses.
(erc-send-input-line): Update speaker time in own nick's
`erc-channel-member' entry.
(erc-get-channel-membership-prefix): Adapt code to prefer advertised
prefix for mode letter.
(erc--parsed-prefix): Save "reversed" `letters' and `statuses' so that
they're ordered from lowest to highest semantically.
(erc--get-prefix-flag, erc--init-cusr-fallback-status,
erc--compute-cusr-fallback-status): New functions for retrieving
internal prefix values and massaging hard-coded traditional prefixes
so they're compatible with existing `erc-channel-member' update code.
(erc--partition-prefixed-names): New function, separated for testing
and for conversion to a generic in the future when ERC supports
extensions that list member rolls in a different format.
(erc-channel-receive-names): Refactor to use new status-aware update
and init workhorse functions for updating and initializing a
`erc-channel-members' entry.
(erc--create-current-channel-member): New "status-aware" function
comprising the `addp' path of `erc-update-current-channel-member'.
(erc--update-current-channel-member): New "status-aware" function
comprising the "update" path of `erc-update-current-channel-member',
which ran when an existing `erc-channel-members' entry for the queried
nick was found.
(erc-update-current-channel-member): Split code body into two
constituent functions, both for readability and for usability, so
callers can more explicitly request the desired operation in a
"status-aware" manner.
(erc--update-membership-prefix): Remove unused function, originally
meant to be new in ERC 5.6.
(erc--process-channel-modes): Call `erc--cusr-change-status' instead
of `erc--update-membership-prefix'.
(erc--shuffle-nuh-nickward): New utility function to ensure code like
`erc--partition-prefixed-names' can use `erc--parse-nuh' in a
practical and relatively convenient way in the near future.
* test/lisp/erc/erc-scenarios-base-chan-modes.el
(erc-scenarios-base-chan-modes--speaker-status): New test.
* test/lisp/erc/erc-tests.el (erc--parsed-prefix): Reverse expected
order of various slot values in `erc--parsed-prefix' objects.
(erc--get-prefix-flag, erc--init-cusr-fallback-status,
erc--compute-cusr-fallback-status, erc--cusr-status-p,
erc--cusr-change-status): New tests.
(erc--update-channel-modes, erc-process-input-line): Use newly
available utilities imported from common library.
* test/lisp/erc/resources/base/modes/speaker-status.eld: New file.
(Bug#67220)
2024-01-17 21:42:02 -08:00
|
|
|
;; This asserts proper recognition of nonstandard prefixes advertised
|
|
|
|
;; via the "PREFIX=" ISUPPORT parameter. Note that without the IRCv3
|
|
|
|
;; `multi-prefix' extension, we can't easily sync a user's channel
|
|
|
|
;; membership status on receipt of a 352/353 by parsing the "flags"
|
|
|
|
;; parameter because even though servers remember multiple prefixes,
|
|
|
|
;; they only ever return the one with the highest rank. For example,
|
|
|
|
;; if on receipt of a 352, we were to "update" someone we believe to
|
|
|
|
;; be @+ by changing them to a to @, we'd be guilty of willful
|
|
|
|
;; munging. And if they later lose that @, we'd then see them as null
|
|
|
|
;; when in fact they're still +. However, we *could* use a single
|
|
|
|
;; degenerate prefix to "validate" an existing record to ensure
|
|
|
|
;; correctness of our processing logic, but it's unclear how such a
|
|
|
|
;; discrepancy ought to be handled beyond asking the user to file a
|
|
|
|
;; bug.
|
|
|
|
(ert-deftest erc-scenarios-base-chan-modes--speaker-status ()
|
|
|
|
:tags '(:expensive-test)
|
|
|
|
(erc-scenarios-common-with-cleanup
|
|
|
|
((erc-scenarios-common-dialog "base/modes")
|
|
|
|
(erc-server-flood-penalty 0.1)
|
|
|
|
(dumb-server (erc-d-run "localhost" t 'speaker-status))
|
|
|
|
(erc-show-speaker-membership-status t)
|
|
|
|
(erc-autojoin-channels-alist '(("." "#chan")))
|
|
|
|
(expect (erc-d-t-make-expecter)))
|
|
|
|
|
|
|
|
(ert-info ("Connect to foonet")
|
|
|
|
(with-current-buffer (erc :server "127.0.0.1"
|
|
|
|
:port (process-contact dumb-server :service)
|
|
|
|
:nick "tester"
|
|
|
|
:user "tester")
|
|
|
|
(funcall expect 5 "Here on foonet, we provide services")))
|
|
|
|
|
|
|
|
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
|
|
|
|
|
|
|
|
(ert-info ("Prefixes printed correctly in 353")
|
|
|
|
(funcall expect 10 "chan: +alice @fsbot -bob !foop"))
|
|
|
|
|
|
|
|
(ert-info ("Speakers honor option `erc-show-speaker-membership-status'")
|
|
|
|
(funcall expect 10 "<-bob> alice: Of that which hath")
|
|
|
|
(funcall expect 10 "<+alice> Hie you, make haste")
|
|
|
|
(funcall expect 10 "<!foop> hi"))
|
|
|
|
|
|
|
|
(ert-info ("Status conferred and rescinded")
|
|
|
|
(funcall expect 10 "*** foop (user@netadmin.example.net) has changed ")
|
|
|
|
(funcall expect 10 "mode for #chan to +v bob")
|
|
|
|
(funcall expect 10 "<+bob> alice: Fair as a text B")
|
|
|
|
(funcall expect 10 "<+alice> bob: Even as Apemantus")
|
|
|
|
(funcall expect 10 "mode for #chan to -v bob")
|
|
|
|
(funcall expect 10 "<-bob> alice: That's the way")
|
|
|
|
(funcall expect 10 "<+alice> Give it the beasts"))
|
|
|
|
|
|
|
|
;; If it had instead overwritten it, our two states would be
|
|
|
|
;; out of sync. (See comment above.)
|
|
|
|
(ert-info ("/WHO output confirms server shadowed V status")
|
|
|
|
(erc-scenarios-common-say "/who #chan")
|
|
|
|
(funcall expect 10 '(: "bob" (+ " ") "H-"))
|
|
|
|
(funcall expect 10 "<-bob> alice: Remains in danger")
|
|
|
|
(erc-cmd-QUIT "")))))
|
|
|
|
|
Favor ISUPPORT params for MODE processing in ERC
* etc/ERC-NEWS: Mention shift toward CHANMODES ISUPPORT parameter for
dictating MODE parsing behavior.
* lisp/erc/erc-backend.el (erc--init-channel-modes, erc--update-modes,
erc-set-modes, erc-update-modes): Forward declarations, the last two
being removals.
(erc-server-MODE, erc-server-221): Use `erc--update-modes' instead of
`erc-update-modes'.
(erc-server-324): Use `erc--init-channel-modes' instead of
`erc-set-modes'.
* lisp/erc/erc-common.el (erc--channel-mode-types): New struct for
stashing processed \"CHANMODES\" data for the current server.
* lisp/erc/erc.el (erc-channel-modes): Fix doc string.
(erc-set-initial-user-mode): Display a local notice when requesting
redundant user MODE operations.
(erc-set-modes, erc-parse-modes, erc-update-modes): Deprecate for
reasons explained in associated ERC-NEWS entry.
(erc--update-membership-prefix): New function, a helper for specifying
arguments to the rather unruly `erc-update-current-channel-member'.
(erc--channel-modes): New variable to record channel-mode state in a
hash table.
(erc--channel-mode-types): New variable and getter to stash
and retrieve server-local instance of the struct of the same name.
(erc--process-channel-modes): New function to parse channel-mode
changes, dispatch handlers for unary modes, and update the local
variables `erc-channel-modes' and `erc--channel-modes'.
(erc--user-modes): New local variable for remembering user modes per
server. New function of the same name, a "getter" for the variable.
(erc--parse-user-modes): New function to parse user modes only.
(erc--update-user-modes): New function to update and sort
`erc--user-modes'.
(erc--update-channel-modes): New function to replace much of
`erc-update-modes', currently a thin wrapper around
`erc--process-channel-modes' to ensure it updates status prefixes.
(erc--update-modes): New function to call appropriate mode-updating
function for the current buffer.
(erc--init-channel-modes): New function to update channel mode letters
without status prefixes.
(erc--handle-channel-mode): New generic function, a placeholder for an
eventual API to handle specific "unary" mode letters, meaning those
that specify a single parameter for setting or unsetting.
(erc-update-channel-limit): Update doc string and answer question
posed by ancient comment.
(erc-message-english-user-mode-redundant-add,
erc-message-english-user-mode-redundant-drop): New English catalog
messages.
* test/lisp/erc/erc-scenarios-base-chan-modes.el: New file.
* test/lisp/erc/erc-tests.el (erc-parse-modes,
erc--update-channel-modes, erc--update-user-modes, erc--user-modes,
erc--parse-user-modes): New tests.
* test/lisp/erc/resources/base/modes/chan-changed.eld: New test data
file. (Bug#67220)
2023-11-14 21:10:39 -08:00
|
|
|
;;; erc-scenarios-base-chan-modes.el ends here
|