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#58797: 29.0.50; Revise format of stored message tags in ERC Date: Wed, 26 Oct 2022 06:20:32 -0700 Message-ID: <87fsfa4t7j.fsf@neverwas.me> 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="7859"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: emacs-erc@gnu.org To: 58797@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Oct 26 15:23:22 2022 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 1ongNM-0001lY-MM for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 26 Oct 2022 15:23:21 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ongLC-0003WS-Px; Wed, 26 Oct 2022 09:21:06 -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 1ongL9-0003Uq-5K; Wed, 26 Oct 2022 09:21:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ongL8-0005cf-Nx; Wed, 26 Oct 2022 09:21:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ongL8-0000Zi-Ep; Wed, 26 Oct 2022 09:21:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "J.P." Original-Sender: "Debbugs-submit" Resent-CC: emacs-erc@gnu.org, bug-gnu-emacs@gnu.org Resent-Date: Wed, 26 Oct 2022 13:21:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 58797 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org X-Debbugs-Original-Xcc: emacs-erc@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.16667904582175 (code B ref -1); Wed, 26 Oct 2022 13:21:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 26 Oct 2022 13:20:58 +0000 Original-Received: from localhost ([127.0.0.1]:53695 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ongL3-0000Yz-Ag for submit@debbugs.gnu.org; Wed, 26 Oct 2022 09:20:58 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:34550) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ongKz-0000Yq-0S for submit@debbugs.gnu.org; Wed, 26 Oct 2022 09:20:54 -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 1ongKp-0002to-PP for bug-gnu-emacs@gnu.org; Wed, 26 Oct 2022 09:20:47 -0400 Original-Received: from mail-108-mta63.mxroute.com ([136.175.108.63]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ongKl-0005W0-Un for bug-gnu-emacs@gnu.org; Wed, 26 Oct 2022 09:20:42 -0400 Original-Received: from mail-111-mta2.mxroute.com ([136.175.111.2] filter006.mxroute.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta63.mxroute.com (ZoneMTA) with ESMTPSA id 1841473a9070006e99.001 for (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256); Wed, 26 Oct 2022 13:20:35 +0000 X-Zone-Loop: c2b41119ea888c53565df724e1fea2c97835cf8fc80b 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:Subject:To:From:Sender: Reply-To:Cc:Content-Transfer-Encoding:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=qNMzeoKtUffNd0MPHPh5WiSMtI60ACmfHL8DQm3oTrw=; b=FJW7BGwbTNtwXbavELSe3ollPE gQerdtz+wesKaj5vI/xmFM6KcX6Sj+EnDAeC6LZ3U0mz/55KNAaK6QcITmEqErbVy107A0+Rtqmzv k4/NHRYp6xDGldioUQYM0v3Q5eqcmS1XBtHm5IriITxJJephETHBEAf9gMjf47RJ7Bdo0C4NkROi8 uJ0Lvdi2Qgh2T+SvzUmUH5WKZU/XejFRT6UK8G3j4WZHmt0IIek1FEHruljF9ucCanpR8vwYMaIUr LYTH4QtY+sEnN8NLjsEKjxfbZodXsCjuQfFH8yb8TZKPxDqDdtn65ewdnZkz1JlgzG1uLCPSCisfS dRjorEpw==; X-Authenticated-Id: masked@neverwas.me Received-SPF: pass client-ip=136.175.108.63; envelope-from=jp@neverwas.me; helo=mail-108-mta63.mxroute.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: , Original-Sender: "bug-gnu-emacs" Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:246228 gmane.emacs.erc.general:1930 Archived-At: --=-=-= Content-Type: text/plain Tags: patch I'm proposing we change the format (type) of the "tags" field in the `erc-response' struct from (STRING . LIST) where LIST contains at most one (possibly empty) string, to (SYMBOL . OPT-STRING) where OPT-STRING, when non-nil, is a nonempty string. For ERC 5.5 and Emacs 29, this change would merely manifest as a warning when first encountered. In subsequent releases, it would still be reserved only for users who opt in by activating optional modules. Rationale below. Thanks, J.P. Imagined FAQ: Why bother? In the existing implementation, all code accessing a processed tag value must check that it's both non-nil and nonempty. This stands to become a common occurrence with the arrival of IRCv3 in future releases. The majority of instances will only contain one item (a timestamp) and will persist beyond the parsing stage as text properties in ERC buffers. And since we need to redo the parsing anyway to abide by all the escaping rules and other spec minutiae, we might as well make the processed goods as easy to manage as possible, no? Isn't this a breaking change? Yes. But I believe preserving backward compatibility (by adding an additional field and keeping the old one around) is less important in this case because the field currently goes unused in ERC's client code and is likely underused in user code (based on a cursory survey of Melpa packages, popular shared configs, and wiki snippets). While message tags *are* currently parsed when present, the field is only ever written to and never again accessed (on account of ERC's lack of general IRCv3 support). That said, the library function as well as the `erc-response' structure are indeed public (exported). There is also the matter of authoritative intent to consider. The doc string for the function `erc-parse-tags' describes its return type as being an alist of "(tag . value)". For anyone willing to entertain "value" as meaning "logical tag value," this change becomes a belated bug fix. Why now? Why not wait? It's true that the main benefit of doing this won't be felt for a couple more ERC releases. As stated above, the immediate effect of this change will merely be as a warning for any user code that depends on this field. This approach seems somewhat in keeping with the overall Emacs policy for function and variable deprecation. In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.34, cairo version 1.17.6) of 2022-10-26 built on localhost Repository revision: 832bd2dfe51b2b9ea5e0e56e0e6ee60b2d8ae2ed Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12014000 System Description: Fedora Linux 36 (Workstation Edition) Configured using: 'configure --enable-check-lisp-object-type --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3' PKG_CONFIG_PATH=:/usr/lib64/pkgconfig:/usr/share/pkgconfig' Configured features: ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG JSON LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS WEBP X11 XDBE XIM XINPUT2 XPM GTK3 ZLIB Important settings: value of $LANG: en_US.UTF-8 value of $XMODIFIERS: @im=ibus locale-coding-system: utf-8-unix Major mode: Lisp Interaction Minor modes in effect: tooltip-mode: t global-eldoc-mode: t eldoc-mode: t show-paren-mode: t electric-indent-mode: t mouse-wheel-mode: t tool-bar-mode: t menu-bar-mode: t file-name-shadow-mode: t global-font-lock-mode: t font-lock-mode: t blink-cursor-mode: t line-number-mode: t indent-tabs-mode: t transient-mark-mode: t auto-composition-mode: t auto-encryption-mode: t auto-compression-mode: t Load-path shadows: None found. Features: (shadow sort mail-extr emacsbug message mailcap yank-media puny dired dired-loaddefs rfc822 mml mml-sec password-cache epa derived epg rfc6068 epg-config gnus-util text-property-search time-date subr-x mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader cl-loaddefs cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils rmc iso-transl tooltip cconv eldoc paren electric uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock font-lock syntax font-core term/tty-colors frame minibuffer nadvice seq simple cl-generic indonesian philippine cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european ethiopic indian cyrillic chinese composite emoji-zwj charscript charprop case-table epa-hook jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs theme-loaddefs faces cus-face macroexp files window text-properties overlay sha1 md5 base64 format env code-pages mule custom widget keymap hashtable-print-readable backquote threads dbusbind inotify lcms2 dynamic-setting system-font-setting font-render-setting cairo move-toolbar gtk x-toolkit xinput2 x multi-tty make-network-process emacs) Memory information: ((conses 16 36089 6500) (symbols 48 5118 0) (strings 32 13124 1756) (string-bytes 1 372990) (vectors 16 9304) (vector-slots 8 147959 9387) (floats 8 21 29) (intervals 56 220 0) (buffers 1000 10)) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Warn-of-future-breaking-change-to-erc-response.tags.patch >From 44cb69befc28ae4e14499521fb2f8a09d7acaf5c Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Mon, 24 Oct 2022 22:58:13 -0700 Subject: [PATCH] Warn of future breaking change to erc-response.tags * lisp/erc/erc-backend.el (erc-parse-tags-format): New option to determine type of the `erc-response' "tags" field. (erc-parse-tags): Defer to internal generic function. (erc--parse-tags): New function to hold original `erc-parse-tags' implementation. (erc--parse-message-tags): New generic function that conditionally calls `erc--parse-tags', perhaps emitting a warning beforehand. (erc-parse-server-response): Call `erc--parse-message-tags'. --- lisp/erc/erc-backend.el | 59 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 3 deletions(-) diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index df9efe4b0c..9854e863c3 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -992,8 +992,39 @@ erc-send-ctcp-notice ;;;; Handling responses +(defcustom erc-tags-format 'overridable + "Shape of the `tags' alist in `erc-response' objects. +When set to `legacy', pre-5.5 parsing behavior takes effect for +the tags portion of every message. The resulting alist contains +conses of the form (STRING . LIST), in which LIST is comprised of +at most one (possibly empty) string. + +When nil, ERC only parses tags if an active module defines an +implementation. It otherwise ignores them. In such cases, each +alist element is a cons of a symbol and an optional, non-empty +string. + +With the default value of `overridable', ERC behaves as it does +with `legacy' except that it emits a warning whenever first +encountering a message containing tags in a given Emacs session. +But it only does so when a module implementing overriding, +non-legacy behavior isn't already active in the current network +context. + +Note that future bundled modules providing IRCv3 functionality +may not be compatible with the legacy format. User code should +eventually transition to expecting this \"5.5+ variant\" and set +this option to nil." + :package-version '(ERC . "5.4.1") ; FIXME increment on next release + :type '(choice (const nil) + (const legacy) + (const overridable))) + (defun erc-parse-tags (string) "Parse IRCv3 tags list in STRING to a (tag . value) alist." + (erc--parse-message-tags string)) + +(defun erc--parse-tags (string) (let ((tags) (tag-strings (split-string string ";"))) (dolist (tag-string tag-strings tags) @@ -1003,6 +1034,28 @@ erc-parse-tags `(,pair)) tags))))) +;; One benefit of this function being internal is to avoid having to +;; define a separate method just to ensure an `erc-tags-format' value +;; of `legacy' always wins. The downside is that module code must +;; take care to preserve that promise manually. + +(cl-defgeneric erc--parse-message-tags (string) + "Parse STRING into an alist of (TAG . VALUE) conses. +TAG is a symbol. VALUE is nil or a non-empty string. Composite +raw input values containing commas are never split but always +left as a single string." + (when erc-tags-format + (unless (or (eq erc-tags-format 'legacy) + (get 'erc-parse-tags 'erc-v3-warned-p)) + (put 'erc-parse-tags 'erc-v3-warned-p t) + (display-warning + 'ERC + (concat + "Legacy ERC tags behavior is currently in effect, but other modules," + " including those bundled with ERC, may override this in future" + " releases. See `erc-tags-format' for more info."))) + (erc--parse-tags string))) + (defun erc-parse-server-response (proc string) "Parse and act upon a complete line from an IRC server. PROC is the process (connection) from which STRING was received. @@ -1012,9 +1065,9 @@ erc-parse-server-response (let* ((tag-list (when (eq (aref string 0) ?@) (substring string 1 (string-search " " string)))) - (msg (make-erc-response :unparsed string :tags (when tag-list - (erc-parse-tags - tag-list)))) + (msg (make-erc-response :unparsed string :tags + (when tag-list + (erc--parse-message-tags tag-list)))) (string (if tag-list (substring string (+ 1 (string-search " " string))) string)) -- 2.37.3 --=-=-=--