1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-16 19:00:55 -08:00
emacs/lisp/gnus/nnfeed.el
Sean Whitton 8903106bb7 Mark if-let and when-let obsolete
* lisp/subr.el (if-let*, when-let*, if-let, when-let): Mark
if-let and when-let obsolete (bug#73853 and elsewhere).  Move
docstring text around so that if-let* and when-let* descriptions
no longer refer to if-let and when-let.

* etc/NEWS: Announce the change.

* admin/admin.el (reminder-for-release-blocking-bugs):
* doc/misc/erc.texi (display-buffer):
* lisp/ansi-color.el (ansi-color-apply)
(ansi-color--face-vec-face):
* lisp/ansi-osc.el (ansi-osc-apply-on-region)
(ansi-osc-hyperlink):
* lisp/arc-mode.el (archive-goto-file)
(archive-next-file-displayer):
* lisp/auth-source-pass.el (auth-source-pass-search)
(auth-source-pass--parse-data)
(auth-source-pass--find-match-many):
* lisp/autorevert.el (auto-revert-notify-rm-watch):
* lisp/buff-menu.el (Buffer-menu-unmark-all-buffers)
(Buffer-menu-group-by-root):
* lisp/calendar/parse-time.el (parse-iso8601-time-string):
* lisp/cedet/pulse.el (pulse-tick):
* lisp/comint.el (comint--fontify-input-ppss-flush-indirect)
(comint--intersect-regions):
* lisp/completion-preview.el (completion-preview--try-table)
(completion-preview--capf-wrapper, completion-preview--update):
* lisp/cus-edit.el (setopt--set)
(custom-dirlocals-maybe-update-cons, custom-dirlocals-validate):
* lisp/custom.el (load-theme):
* lisp/descr-text.el (describe-char):
* lisp/desktop.el (desktop--emacs-pid-running-p):
* lisp/dired-x.el (menu):
* lisp/dired.el (dired-font-lock-keywords)
(dired-insert-directory, dired--insert-disk-space, dired-mode):
* lisp/dnd.el (dnd-handle-multiple-urls):
* lisp/dom.el (dom-remove-attribute):
* lisp/emacs-lisp/byte-opt.el (byte-optimize-form-code-walker):
* lisp/emacs-lisp/bytecomp.el (bytecomp--custom-declare):
* lisp/emacs-lisp/comp-common.el (comp-function-type-spec):
* lisp/emacs-lisp/comp-cstr.el (comp--all-classes)
(comp-cstr-set-range-for-arithm, comp--cstr-union-1-no-mem)
(comp-cstr-intersection-no-mem, comp-cstr-fixnum-p)
(comp-cstr-type-p):
* lisp/emacs-lisp/comp-run.el (comp-subr-trampoline-install)
(native--compile-async):
* lisp/emacs-lisp/comp.el (comp--get-function-cstr)
(comp--function-pure-p, comp--intern-func-in-ctxt)
(comp--addr-to-bb-name, comp--emit-assume, comp--maybe-add-vmvar)
(comp--add-call-cstr, comp--compute-dominator-tree)
(comp--dom-tree-walker, comp--ssa-rename)
(comp--function-call-maybe-fold, comp--fwprop-call)
(comp--call-optim-func):
* lisp/emacs-lisp/edebug.el (edebug-global-prefix)
(edebug-remove-instrumentation):
* lisp/emacs-lisp/eieio.el (initialize-instance):
* lisp/emacs-lisp/ert-x.el (ert-resource-directory):
* lisp/emacs-lisp/ert.el (ert--expand-should-1)
(ert-test-location, ert-write-junit-test-report)
(ert-test--erts-test):
* lisp/emacs-lisp/icons.el (icon-complete-spec, icon-string)
(icons--create):
* lisp/emacs-lisp/lisp-mode.el (lisp--local-defform-body-p):
* lisp/emacs-lisp/loaddefs-gen.el
(loaddefs-generate--make-autoload)
(loaddefs-generate--parse-file):
* lisp/emacs-lisp/multisession.el
(multisession-edit-mode--revert, multisession-edit-value):
* lisp/emacs-lisp/package-vc.el (package-vc--read-archive-data)
(package-vc--version, package-vc--clone):
* lisp/emacs-lisp/package.el (package--reload-previously-loaded):
* lisp/emacs-lisp/pp.el (pp--insert-lisp):
* lisp/emacs-lisp/subr-x.el (add-display-text-property):
* lisp/emacs-lisp/tabulated-list.el (tabulated-list-print):
* lisp/emacs-lisp/timer.el (run-at-time):
* lisp/emacs-lisp/vtable.el (vtable-goto-table)
(vtable-goto-column, vtable-update-object, vtable--insert-line)
(vtable--compute-widths, vtable--make-keymap):
* lisp/emacs-lisp/warnings.el (display-warning):
* lisp/epa-file.el (epa-file-insert-file-contents):
* lisp/epa.el (epa-show-key):
* lisp/erc/erc-backend.el (erc--split-line, erc--conceal-prompt)
(PRIVMSG, erc--get-isupport-entry):
* lisp/erc/erc-button.el (erc-button-add-nickname-buttons)
(erc--button-next):
* lisp/erc/erc-common.el (erc--find-group):
* lisp/erc/erc-fill.el (erc-fill, erc-fill-static)
(erc-fill--wrap-escape-hidden-speaker)
(erc-fill--wrap-unmerge-on-date-stamp)
(erc-fill--wrap-massage-initial-message-post-clear)
(erc-fill-wrap, erc-fill--wrap-rejigger-region):
* lisp/erc/erc-goodies.el (erc--scrolltobottom-all)
(erc--keep-place-indicator-on-window-buffer-change)
(keep-place-indicator, erc--keep-place-indicator-adjust-on-clear)
(erc-keep-place-move, erc--command-indicator-display):
* lisp/erc/erc-ibuffer.el (erc-members):
* lisp/erc/erc-join.el (erc-join--remove-requested-channel)
(erc-autojoin--join):
* lisp/erc/erc-networks.el
(erc-networks--id-qualifying-init-parts, erc-networks--id-reload)
(erc-networks--id-ensure-comparable)
(erc-networks--reclaim-orphaned-target-buffers)
(erc-networks--server-select):
* lisp/erc/erc-nicks.el (erc-nicks-invert)
(erc-nicks--redirect-face-widget-link, erc-nicks--highlight)
(erc-nicks--highlight-button)
(erc-nicks--list-faces-help-button-action, erc-nicks-list-faces)
(erc-nicks-refresh, erc-nicks--colors-from-faces)
(erc-nicks--track-prioritize)
(erc-nicks--remember-face-for-track):
* lisp/erc/erc-notify.el (querypoll, erc--querypoll-get-next)
(erc--querypoll-on-352, erc--querypoll-send):
* lisp/erc/erc-sasl.el (erc-sasl--read-password):
* lisp/erc/erc-services.el
(erc-services-issue-ghost-and-retry-nick):
* lisp/erc/erc-speedbar.el (erc-speedbar--ensure, nickbar)
(erc-speedbar-toggle-nicknames-window-lock)
(erc-speedbar--compose-nicks-face):
* lisp/erc/erc-stamp.el (erc-stamp--recover-on-reconnect)
(erc-stamp-prefix-log-filter, erc--conceal-prompt)
(erc--insert-timestamp-left, erc-insert-timestamp-right)
(erc-stamp--defer-date-insertion-on-post-modify)
(erc-insert-timestamp-left-and-right)
(erc-stamp--redo-right-stamp-post-clear)
(erc-stamp--reset-on-clear, erc-stamp--dedupe-date-stamps):
* lisp/erc/erc-status-sidebar.el (bufbar)
(erc-status-sidebar-prefer-target-as-name)
(erc-status-sidebar-default-allsort, erc-status-sidebar-click):
* lisp/erc/erc-track.el (erc-track--shortened-names-get)
(erc-track--setup, erc-track--select-mode-line-face)
(erc-track-modified-channels, erc-track--collect-faces-in)
(erc-track--switch-buffer, erc-track--replace-killed-buffer):
* lisp/erc/erc-truncate.el (erc-truncate--setup)
(erc-truncate-buffer):
* lisp/erc/erc.el (erc--ensure-query-member)
(erc--ensure-query-members, erc--remove-channel-users-but)
(erc--cusr-change-status, erc--find-mode, erc--update-modules)
(erc-log-irc-protocol, erc--refresh-prompt)
(erc--restore-important-text-props)
(erc--order-text-properties-from-hash, erc-send-input-line)
(erc-cmd-IGNORE, erc--unignore-user, erc-cmd-QUERY)
(erc-cmd-BANLIST, erc--speakerize-nick)
(erc--format-speaker-input-message, erc-channel-receive-names)
(erc-send-current-line, erc-format-target-and/or-network)
(erc-kill-buffer-function, erc-restore-text-properties)
(erc--get-eq-comparable-cmd):
* lisp/eshell/em-alias.el (eshell-maybe-replace-by-alias--which)
(eshell-maybe-replace-by-alias):
* lisp/eshell/em-glob.el (eshell-glob-convert):
* lisp/eshell/em-pred.el (eshell-pred-user-or-group)
(eshell-pred-file-time, eshell-pred-file-type)
(eshell-pred-file-mode, eshell-pred-file-links)
(eshell-pred-file-size):
* lisp/eshell/em-prompt.el (eshell-forward-paragraph)
(eshell-next-prompt):
* lisp/eshell/esh-arg.el (eshell-resolve-current-argument):
* lisp/eshell/esh-cmd.el (eshell-do-eval, eshell/which)
(eshell-plain-command--which, eshell-plain-command):
* lisp/eshell/esh-io.el (eshell-duplicate-handles)
(eshell-protect-handles, eshell-get-target, eshell-close-target):
* lisp/eshell/esh-proc.el (eshell-sentinel):
* lisp/eshell/esh-var.el (eshell-parse-variable-ref)
(eshell-get-variable, eshell-set-variable):
* lisp/faces.el (face-at-point):
* lisp/ffap.el (ffap-in-project):
* lisp/filenotify.el (file-notify--rm-descriptor):
* lisp/files-x.el (read-dir-locals-file)
(connection-local-update-profile-variables)
(connection-local-value):
* lisp/files.el (file-remote-p, abbreviate-file-name)
(set-auto-mode, hack-local-variables)
(revert-buffer-restore-read-only):
* lisp/find-dired.el (find-dired-sort-by-filename):
* lisp/font-lock.el (font-lock--filter-keywords):
* lisp/gnus/gnus-art.el (article-emojize-symbols):
* lisp/gnus/gnus-int.el (gnus-close-server):
* lisp/gnus/gnus-search.el (gnus-search-transform)
(gnus-search-indexed-parse-output, gnus-search-server-to-engine):
* lisp/gnus/gnus-sum.el (gnus-collect-urls, gnus-shorten-url):
* lisp/gnus/gnus.el (gnus-check-backend-function):
* lisp/gnus/message.el (message-send-mail):
* lisp/gnus/mml.el (mml-generate-mime, mml-insert-mime-headers):
* lisp/gnus/nnatom.el (nnatom--read-feed, nnatom--read-article)
(nnatom--read-article-or-group-authors, nnatom--read-publish)
(nnatom--read-update, nnatom--read-links):
* lisp/gnus/nnfeed.el (nnfeed--read-server, nnfeed--write-server)
(nnfeed--parse-feed, nnfeed--group-data, nnfeed-retrieve-article)
(nnfeed-retrieve-headers, nnfeed--print-part)
(nnfeed-request-article, nnfeed-request-group)
(nnfeed-request-list, nnfeed--group-description)
(nnfeed-request-group-description)
(nnfeed-request-list-newsgroups, nnfeed-request-rename-group):
* lisp/gnus/nnmh.el (nnmh-update-gnus-unreads):
* lisp/help-fns.el (help-find-source)
(help-fns--insert-menu-bindings, help-fns--mention-first-release)
(help-fns--mention-shortdoc-groups)
(help-fns--customize-variable-version)
(help-fns--face-custom-version-info, describe-mode):
* lisp/help-mode.el (help-make-xrefs):
* lisp/help.el (help-key-description, help--describe-command):
* lisp/hfy-cmap.el (htmlfontify-load-rgb-file):
* lisp/ibuf-ext.el (ibuffer-jump-to-filter-group)
(ibuffer-kill-filter-group, ibuffer-kill-line)
(ibuffer-save-filter-groups, ibuffer-save-filters, filename)
(basename, file-extension, ibuffer-diff-buffer-with-file-1)
(ibuffer-mark-by-file-name-regexp)
(ibuffer-mark-by-content-regexp):
* lisp/ibuf-macs.el (ibuffer-aif, ibuffer-awhen):
* lisp/ibuffer.el (ibuffer-mouse-toggle-mark)
(ibuffer-toggle-marks, ibuffer-mark-interactive)
(ibuffer-compile-format, process, ibuffer-map-lines):
* lisp/image.el (image--compute-map)
(image--compute-original-map):
* lisp/image/exif.el (exif-parse-buffer):
* lisp/image/image-converter.el (image-convert-p, image-convert)
(image-converter--find-converter):
* lisp/image/image-dired-util.el
(image-dired-file-name-at-point):
* lisp/image/image-dired.el (image-dired-track-original-file)
(image-dired--on-file-in-dired-buffer)
(image-dired--with-thumbnail-buffer)
(image-dired-jump-original-dired-buffer)
(image-dired--slideshow-step, image-dired-display-image):
* lisp/image/wallpaper.el (wallpaper--init-action-kill)
(wallpaper--find-setter, wallpaper--find-command)
(wallpaper--find-command-args, wallpaper--x-monitor-name):
* lisp/info-look.el (info-lookup-interactive-arguments)
(info-complete)::(:mode):
* lisp/info.el (info-pop-to-buffer, Info-read-node-name-1):
* lisp/international/emoji.el (emoji--adjust-displayable-1)
(emoji--add-recent):
* lisp/jsonrpc.el (jsonrpc--call-deferred)
(jsonrpc--process-sentinel, jsonrpc--remove):
* lisp/keymap.el (keymap-local-lookup):
* lisp/mail/emacsbug.el (report-emacs-bug-hook)
(submit-emacs-patch):
* lisp/mail/ietf-drums.el (ietf-drums-parse-addresses):
* lisp/mail/mailclient.el (mailclient-send-it):
* lisp/mail/rfc6068.el (rfc6068-parse-mailto-url):
* lisp/mail/undigest.el (rmail-digest-parse-mixed-mime):
* lisp/minibuffer.el (completion-metadata-get)
(completions--after-change)
(minibuffer-visible-completions--filter):
* lisp/net/browse-url.el (browse-url-url-at-point)
(browse-url-file-url, browse-url-emacs):
* lisp/net/dbus.el (dbus-byte-array-to-string)
(dbus-monitor-goto-serial):
* lisp/net/dictionary.el (dictionary-search):
* lisp/net/eww.el (eww--download-directory)
(eww-auto-rename-buffer, eww-open-in-new-buffer, eww-submit)
(eww-follow-link, eww-read-alternate-url)
(eww-copy-alternate-url):
* lisp/net/goto-addr.el (goto-address-at-point):
* lisp/net/mailcap.el (mailcap-mime-info):
* lisp/net/rcirc.el (rcirc, rcirc-connect, rcirc-send-string)
(rcirc-kill-buffer-hook, rcirc-print, rcirc-when)
(rcirc-color-attributes, rcirc-handler-NICK)
(rcirc-handler-TAGMSG, rcirc-handler-BATCH):
* lisp/net/shr.el (shr-descend, shr-adaptive-fill-function)
(shr-correct-dom-case, shr-tag-a):
* lisp/net/sieve.el (sieve-manage-quit):
* lisp/outline.el (outline-cycle-buffer):
* lisp/pcmpl-git.el (pcmpl-git--tracked-file-predicate):
* lisp/proced.el (proced-auto-update-timer):
* lisp/progmodes/bug-reference.el
(bug-reference-try-setup-from-vc):
* lisp/progmodes/c-ts-common.el (c-ts-common--fill-paragraph):
* lisp/progmodes/c-ts-mode.el (c-ts-mode--preproc-offset)
(c-ts-mode--anchor-prev-sibling, c-ts-mode-indent-defun):
* lisp/progmodes/compile.el (compilation-error-properties)
(compilation-find-file-1):
* lisp/progmodes/eglot.el (eglot--check-object)
(eglot--read-server, eglot-upgrade-eglot)
(eglot-handle-notification, eglot--CompletionParams)
(eglot-completion-at-point, eglot--sig-info)
(eglot-register-capability):
* lisp/progmodes/elisp-mode.el
(emacs-lisp-native-compile-and-load)
(elisp-eldoc-var-docstring-with-value):
* lisp/progmodes/erts-mode.el (erts-mode--goto-start-of-test):
* lisp/progmodes/flymake.el (flymake--update-eol-overlays)
(flymake-eldoc-function):
* lisp/progmodes/gdb-mi.el (gdb-breakpoints-list-handler-custom)
(gdb-frame-handler):
* lisp/progmodes/go-ts-mode.el (go-ts-mode-docstring)
(go-ts-mode--comment-on-previous-line-p)
(go-ts-mode--get-test-regexp-at-point)
(go-ts-mode-test-this-file):
* lisp/progmodes/grep.el (lgrep, rgrep-default-command)
(grep-file-at-point):
* lisp/progmodes/perl-mode.el (perl--end-of-format-p):
* lisp/progmodes/php-ts-mode.el
(php-ts-mode--anchor-prev-sibling, php-ts-mode--indent-defun):
* lisp/progmodes/project.el (project--other-place-command)
(project--find-default-from, project--transplant-file-name)
(project-prefixed-buffer-name, project--remove-from-project-list)
(project-prompt-project-name, project-remember-projects-under)
(project--switch-project-command)
(project-uniquify-dirname-transform, project-mode-line-format):
* lisp/progmodes/python.el
(python-font-lock-keywords-maximum-decoration)
(python--treesit-fontify-union-types)
(python-shell-get-process-name, python-shell-restart)
(python-shell-completion-at-point, python-ffap-module-path)
(python-util-comint-end-of-output-p, python--import-sources)
(python-add-import, python-remove-import, python-fix-imports):
* lisp/progmodes/xref.el (xref--add-log-current-defun):
* lisp/repeat.el (repeat-echo-message-string):
* lisp/saveplace.el (save-place-dired-hook):
* lisp/server.el (server-save-buffers-kill-terminal):
* lisp/shadowfile.el (shadow-make-fullname)
(shadow-contract-file-name, shadow-define-literal-group):
* lisp/shell.el (shell-highlight-undef-mode):
* lisp/simple.el (command-completion-using-modes-p)
(command-execute, file-user-uid, file-group-gid)
(first-completion, last-completion, switch-to-completions):
* lisp/startup.el (startup--load-user-init-file):
* lisp/tab-line.el (tab-line-tabs-buffer-group-by-project):
* lisp/tar-mode.el (tar-goto-file, tar-next-file-displayer):
* lisp/term/android-win.el (android-encode-select-string)
(gui-backend-set-selection):
* lisp/term/haiku-win.el (haiku-dnd-convert-string)
(haiku-select-encode-xstring, haiku-select-encode-utf-8-string):
* lisp/textmodes/emacs-news-mode.el (emacs-news--buttonize):
* lisp/textmodes/ispell.el (ispell-completion-at-point):
* lisp/textmodes/sgml-mode.el (sgml-validate)
(html-mode--complete-at-point):
* lisp/textmodes/tex-mode.el (tex-recenter-output-buffer)
(xref-backend-references):
* lisp/thingatpt.el (thing-at-point-file-at-point)
(thing-at-point-face-at-point):
* lisp/thread.el (thread-list--get-status):
* lisp/time.el (world-clock-copy-time-as-kill, world-clock):
* lisp/touch-screen.el (touch-screen-handle-touch):
* lisp/treesit.el (treesit-language-at, treesit-node-at)
(treesit-node-on, treesit-buffer-root-node)
(treesit-node-field-name, treesit-local-parsers-at)
(treesit-local-parsers-on, treesit--cleanup-local-range-overlays)
(treesit-font-lock-recompute-features)
(treesit-font-lock-fontify-region, treesit-transpose-sexps)
(treesit-add-log-current-defun, treesit-major-mode-setup)
(treesit--explorer-refresh, treesit-install-language-grammar):
* lisp/url/url.el (url-retrieve-synchronously):
* lisp/vc/smerge-mode.el (smerge-diff):
* lisp/vc/vc-dir.el (vc-dir):
* lisp/vc/vc-dispatcher.el (vc-do-async-command):
* lisp/vc/vc-git.el (vc-git-dir--branch-headers)
(vc-git-dir--stash-headers, vc-git--log-edit-summary-check)
(vc-git-stash-list):
* lisp/vc/vc.el (vc-responsible-backend, vc-buffer-sync-fileset)
(vc-clone):
* lisp/visual-wrap.el (visual-wrap--apply-to-line):
* lisp/wid-edit.el (widget-text)
(widget-editable-list-insert-before):
* lisp/window-tool-bar.el
(window-tool-bar--keymap-entry-to-string):
* lisp/window.el (display-buffer, display-buffer-full-frame)
(window-point-context-set, window-point-context-use)
(window-point-context-use-default-function):
* lisp/xdg.el (xdg-current-desktop):
* lisp/xwidget.el (xwidget-webkit-callback):
* lisp/yank-media.el (yank-media--get-selection)
(yank-media-types):
* test/lisp/comint-tests.el
(comint-tests/test-password-function):
* test/lisp/completion-preview-tests.el
(completion-preview-tests--capf):
* test/lisp/cus-edit-tests.el (with-cus-edit-test):
* test/lisp/erc/erc-scenarios-base-local-modules.el
(-phony-sblm-):
* test/lisp/erc/erc-scenarios-stamp.el
(erc-scenarios-stamp--on-post-modify):
* test/lisp/erc/erc-services-tests.el
(erc-services-tests--asp-parse-entry):
* test/lisp/erc/erc-tests.el (erc-modules--internal-property)
(erc--find-mode, erc-tests--update-modules):
* test/lisp/erc/resources/erc-d/erc-d-i.el
(erc-d-i--parse-message):
* test/lisp/erc/resources/erc-d/erc-d-t.el
(erc-d-t-kill-related-buffers, erc-d-t-with-cleanup):
* test/lisp/erc/resources/erc-d/erc-d-tests.el
(erc-d-i--parse-message--irc-parser-tests):
* test/lisp/erc/resources/erc-d/erc-d-u.el
(erc-d-u--read-exchange-slowly):
* test/lisp/erc/resources/erc-d/erc-d.el (erc-d--expire)
(erc-d--finalize-done, erc-d--command-handle-all):
* test/lisp/erc/resources/erc-scenarios-common.el
(erc-scenarios-common-with-cleanup):
* test/lisp/erc/resources/erc-tests-common.el
(erc-tests--common-display-message)
(erc-tests-common-create-subprocess):
* test/lisp/ibuffer-tests.el (ibuffer-test-Bug25058):
* test/lisp/international/mule-tests.el
(mule-cmds-tests--ucs-names-missing-names):
* test/lisp/progmodes/python-tests.el
(python-tests-get-shell-interpreter)
(python-tests--get-interpreter-info):
* test/lisp/progmodes/ruby-ts-mode-tests.el
(ruby-ts-resource-file):
* test/lisp/replace-tests.el (replace-tests-with-undo):
* test/src/emacs-tests.el (emacs-tests--seccomp-debug):
* test/src/process-tests.el (process-tests--emacs-command)
(process-tests--emacs-binary, process-tests--dump-file):
* test/src/treesit-tests.el (treesit--ert-test-defun-navigation):
Replace use of the now-obsolete if-let and when-let.
2024-10-24 16:50:07 +08:00

691 lines
30 KiB
EmacsLisp

;;; nnfeed.el --- Generic feed backend for Gnus -*- lexical-binding: t -*-
;; Copyright (C) 2023 Free Software Foundation, Inc.
;; Author: Daniel Semyonov <daniel@dsemy.com>
;; This file is part of GNU Emacs.
;; nnfeed 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.
;; nnfeed 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 nnfeed. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Generic Gnus backend (intended) for implementing backends for web
;; feeds (Atom, RSS).
;;
;; This backend is abstract - it doesn't implement a parser for any
;; specific web feed type, and so can't be used independently.
;;
;; Instead, it implements a generic parser, feed data storage and most
;; of the Gnus backend interface; the intended use for this backend is
;; to be a source of inheritance for backends supporting new web feed
;; types.
;;
;; To implement new backends, use `nnfeed-define-basic-backend-interface':
;;
;; ...
;; (require 'nnfeed)
;;
;; (nnoo-declare nnfoo nnfeed)
;;
;; (nnfeed-define-basic-backend-interface nnfoo)
;; ...
;; [ definitions of parsing functions, see the "Feed parser interface"
;; section for more information. ]
;;
;; (defvoo nnfoo-read-feed-function #'nnfoo--read-feed
;; nil nnfeed-read-feed-function)
;; ...
;; (gnus-declare-backend (symbol-name nnfeed-backend) 'none 'address)
;;
;; (provide 'nnfoo)
;;
;;; Code:
(eval-when-compile
(require 'subr-x))
(require 'gnus)
(require 'nnoo)
(defgroup nnfeed nil
"Generic feed backend for Gnus."
:group 'gnus)
(defcustom nnfeed-date-format "%F %X%p"
"Format of displayed dates (see function `format-time-string')."
:type 'string)
(nnoo-declare nnfeed)
(defvoo nnfeed-backend nil
"Symbol which identifies this backend.")
(defvoo nnfeed-status-string nil
"Last status message reported by this backend.")
;; This macro should be used to define inheriting backends.
(defmacro nnfeed-define-basic-backend-interface (backend)
"Define a basic set of functions and variables for BACKEND."
`(progn
(defvoo ,(nnoo-symbol backend 'backend) ',backend nil nnfeed-backend)
(defvoo ,(nnoo-symbol backend 'status-string)
nil nil nnfeed-status-string)
(defvoo ,(nnoo-symbol backend 'group) nil nil nnfeed-group)
(defvoo ,(nnoo-symbol backend 'servers)
(make-hash-table :test 'equal) nil nnfeed-servers)
(defvoo ,(nnoo-symbol backend 'group-article-ids)
(make-hash-table :test 'equal) nil nnfeed-group-article-ids)
(defvoo ,(nnoo-symbol backend 'group-articles)
(make-hash-table :test 'eql) nil nnfeed-group-articles)
(defvoo ,(nnoo-symbol backend 'group-article-max-num) 0 nil
nnfeed-group-article-max-num)
(defvoo ,(nnoo-symbol backend 'group-article-mix-num) 1 nil
nnfeed-group-article-min-num)
,@(mapcar (lambda (fun)
`(deffoo ,(nnoo-symbol backend fun) (&optional server)
(,(nnoo-symbol 'nnoo fun) ',backend server)))
'(server-opened status-message))
(deffoo ,(nnoo-symbol backend 'open-server) (server &optional defs)
(nnfeed-open-server server defs ',backend))
(nnoo-import ,backend (nnfeed))))
;;;; Feed parser interface:
;; The following set of server variables define a parser for a
;; specific web feed type.
;; An inheriting backend doesn't necessarily have to define all of
;; these functions (see the comments below for more information).
;; Apart from this set of variables there is also
;; `nnfeed-print-content-function' which can optionally be defined
;; by an inheriting backend to allow more advanced control over the
;; printing of articles.
(defvoo nnfeed-read-feed-function #'ignore
"Function returning a Lisp object representing a feed (or part of it).
It should accept two arguments, the address of a feed and the name of
a group (or nil).
If a group name is supplied, it should return a representation of only
the group (as if it was extracted from the feed with
`nnfeed-read-group-function').")
(defvoo nnfeed-read-group-function #'ignore
"Function returning a cons cell of a group and remaining data from a feed.
The returned group can be represented by any Lisp object.
It should accept a single argument, a Lisp object representing a feed
\(as can be returned by this function or `nnfeed-read-feed-function').")
(defvoo nnfeed-read-article-function #'ignore
"Function returning a cons cell of an article and remaining data from a group.
The returned article can be represented by any Lisp object.
It should accept two arguments, a Lisp object representing a group
\(as can be returned by this function or `nnfeed-read-group-function'),
and a flag indicating whether the last article was not new or updated.")
(defvoo nnfeed-read-title-function #'ignore
"Function returning the title of a group (a string).
It should accept a single argument, a Lisp object representing a group
\(as returned by `nnfeed-read-group-function').")
;; Optional.
(defvoo nnfeed-read-description-function #'ignore
"Function returning the description of a group (a string), or nil.
It should accept a single argument, a Lisp object representing a group
\(as returned by `nnfeed-read-group-function').")
;; Either this function or `nnfeed-read-author-function' is required.
(defvoo nnfeed-read-group-author-function #'ignore
"Function returning the author of a group (a string), or nil.
It should accept a single argument, a Lisp object representing a group
\(as returned by `nnfeed-read-group-function')..")
(defvoo nnfeed-read-id-function #'ignore
"Function returning the ID of an article.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
(defvoo nnfeed-read-subject-function #'ignore
"Function returning the subject of an article (a string), or nil.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
;; Either this function or `nnfeed-read-update-date-function' is required.
(defvoo nnfeed-read-publish-date-function #'ignore
"Function returning the publish date of an article (a time value), or nil.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
;; Either this function or `nnfeed-read-publish-date-function' is required.
(defvoo nnfeed-read-update-date-function #'ignore
"Function returning the update date of an article (a time value), or nil.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
;; Either this function or `nnfeed-read-group-author-function' is required.
(defvoo nnfeed-read-author-function #'ignore
"Function returning the author of an article (a string), or nil.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
(defvoo nnfeed-read-headers-function #'ignore
"Function returning an alist of article-wide MIME headers.
Each element of this alist maps a MIME header (a symbol,
i.e. `Content-Type') to its value. As a special case, `:boundary'
maps to a string which will serve as the boundary between article
parts. This must be supplied if a custom boundary is used in a
multipart content type header. The default boundary is \"-_nnfeed_-\",
and is automatically modified to match the name of the back end.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
;; As mentioned in their docstrings, the last two parsing functions
;; can optionally return any Lisp representation they want, provided
;; an appropriate `nnfeed-print-content-function' is defined. This
;; means they are also not _strictly_ required.
(defvoo nnfeed-read-links-function #'ignore
"Function returning all links contained in an article.
With the default `nnfeed-print-content-function', it should return a
list of links, where each link is an alist mapping MIME content types
to links formatted for display in a part of that type. Each content
type may also be a list of content types.
Otherwise, it could return any Lisp object.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
(defvoo nnfeed-read-parts-function #'ignore
"Function returning an alist associating parts of an article to their headers.
With the default `nnfeed-print-content-function', each part should be a
string. Otherwise, it can be any Lisp object. The \"headers\" of
each part should be a list where each element is either a cons of a
MIME header (a symbol, i.e. `Content-Type') and its value (a string),
or any other Lisp object. MIME headers will be printed, the rest will
be passed on to `nnfeed-print-content-function', which recognizes the
following extra data by default:
- `links', if present, will cause links to be printed in the part.
It should accept a single argument, a Lisp object representing an article
\(as returned by `nnfeed-read-article-function').")
;;;; Feed data storage:
;; This section defines the data types used to store feed data, and
;; functions to read and write it.
;; All variables in this section are automatically defined by
;; `nnfeed-define-basic-backend-interface'.
(defvoo nnfeed-servers (make-hash-table :test 'equal)
"Hash table mapping known servers to their groups.
Each value in this table should itself be a hash table mapping known
group names to their data, which should be a vector of the form
[GROUP IDS ARTICLES MAX MIN DESCRIPTION], where:
- GROUP is the \"real\" group name (the name known to the server).
- IDS is a hash table mapping article IDs to their numbers.
- ARTICLES is a hash table mapping article numbers to articles and
their attributes (see `nnfeed-group-articles').
- MAX is the maximum article number.
- MIN is the minimum article number.
- DESCRIPTION is the group description.")
(defvoo nnfeed-group-names (make-hash-table :test 'equal)
"Hash table mapping real group names to their custom name.")
(defun nnfeed--server-address (server)
"Return SERVER's real address."
(if (string-suffix-p "-ephemeral" server)
(setq server (or (cadr (assq (nnoo-symbol nnfeed-backend 'address)
(cddr (gnus-server-to-method
(concat
(symbol-name nnfeed-backend) ":"
server)))))
server))
server))
(defun nnfeed--server-file (server)
"Return the file containing data for SERVER."
(expand-file-name (format "%s/%s.eld"
(string-trim (symbol-name nnfeed-backend)
"nn")
(gnus-newsgroup-savable-name
(nnfeed--server-address server)))
gnus-directory))
(defun nnfeed--read-server (server)
"Read SERVER's information from storage."
(if-let* ((f (nnfeed--server-file server))
((file-readable-p f)))
(with-temp-buffer
(insert-file-contents f)
(goto-char (point-min))
(puthash server (read (current-buffer)) nnfeed-servers))
(nnheader-report nnfeed-backend "Can't read %s" server)))
(defun nnfeed--write-server (server)
"Write SERVER's information to storage."
(if-let* ((f (nnfeed--server-file server))
((file-writable-p f)))
(if-let* ((s (gethash server nnfeed-servers))
((hash-table-p s)))
(with-temp-file f
(insert ";;;; -*- mode: lisp-data -*- DO NOT EDIT\n")
(prin1 s (current-buffer))
(insert "\n")
t)
t)
(nnheader-report nnfeed-backend "Can't write %s" f)))
;; The following function uses the parsing functions defined in the last
;; section to parse a feed (or just one group from it).
;; This is the only place where these parsing functions are used; the Gnus
;; backend interface extracts all required information from the parsed feed.
(defun nnfeed--parse-feed (feed &optional group)
"Parse GROUP from FEED into a new or existing server.
If GROUP is omitted or nil, parse the entire FEED."
(let* ((feed (nnfeed--server-address feed))
(s (or (gethash feed nnfeed-servers) (nnfeed--read-server feed)
(make-hash-table :test 'equal)))
(name group) ; (Maybe) fake name (or nil)
(group (aref (gethash group s `[,group]) 0)) ; Real name (or nil)
data)
(when (setq data (funcall nnfeed-read-feed-function feed group))
(while-let ((cg (or (and name (cons data)) ; `data' is a single group
(funcall nnfeed-read-group-function data)))
(cg (prog1 (car cg) (setq data (cdr cg)))))
(let* ((name (funcall nnfeed-read-title-function cg)) ; Real name
(group (gethash name nnfeed-group-names name)) ; (Maybe) fake name
(info (gnus-get-info
(concat (symbol-name nnfeed-backend) "+" feed ":" group)))
(g (or (gethash group s)
`[ ,name ,(make-hash-table :test 'equal)
,(make-hash-table :test 'eql) nil 1 ""]))
(desc (funcall nnfeed-read-description-function cg))
(ids (aref g 1))
(articles (aref g 2))
(max (aref g 3))
(max (if max max
(setq max 0) ; Find max article number
(dolist ; remembered by Gnus.
( r (cons (gnus-info-read info)
(gnus-info-marks info))
max)
(mapc (lambda (x)
(let ((x (if (consp x)
(if (< (car x) (cdr x))
(cdr x) (car x))
x)))
(when (< max x) (setq max x))))
(if (symbolp (car r)) (cdr r) r)))))
(group-author (funcall nnfeed-read-group-author-function cg))
stale)
(and desc (aset g 5 desc))
(while-let ((article (funcall nnfeed-read-article-function cg stale))
(article (prog1 (car article) (setq cg (cdr article)))))
(when-let* ((id (funcall nnfeed-read-id-function article))
(id (format "<%s@%s.%s>" id name nnfeed-backend)))
(let* ((num (gethash id ids))
(update (funcall nnfeed-read-update-date-function article))
(prev-update (aref (gethash num articles
'[nil nil nil nil nil])
4)))
(if (or (null num) ; New article ID.
(and (null prev-update) update)
(and prev-update update
(time-less-p prev-update update)))
(let* ((num (or num (aset g 3 (setq max (1+ max)))))
(publish (funcall nnfeed-read-publish-date-function
article)))
(setf
(gethash id (aref g 1)) num
(gethash num (aref g 2))
`[ ,id
,(or (funcall nnfeed-read-author-function article)
group-author group)
,(or (funcall nnfeed-read-subject-function article)
"no subject")
,(or publish update '(0 0)) ; published
,(or update publish '(0 0)) ; updated
,(funcall nnfeed-read-links-function article)
,(funcall nnfeed-read-parts-function article)
,(funcall nnfeed-read-headers-function article)]
stale nil))
(setq stale t)))))
(puthash group g s)))
(puthash feed s nnfeed-servers))))
;;;; Gnus backend functions:
;; The following two sections define a Gnus backend interface based on
;; the parsed data from the last section.
;; All server variables in this section are automatically defined by
;; `nnfeed-define-basic-backend-interface'.
;; For more information about these functions see the "Back End
;; Interface" section of the Gnus manual.
(defvoo nnfeed-group nil
"Name of the current group.")
(defvoo nnfeed-group-article-ids (make-hash-table :test 'equal)
"Hash table mapping article IDs to their article number.")
(defvoo nnfeed-group-articles (make-hash-table :test 'eql)
"Hash table mapping article numbers to articles and their attributes.
Each value in this table should be a vector of the form
[ID FROM SUBJECT DATE UPDATED LINKS PARTS HEADERS], where:
- ID is the ID of the article.
- FROM is the author of the article or group.
- SUBJECT is the subject of the article.
- DATE is the date the article was published, or last updated (time value).
- UPDATE is the date the article was last updated, or published (time value).
- LINKS is a collection of links (any Lisp object).
- PARTS is an alist associating the content of each part of the
article to its headers.
- HEADERS is an alist associating article-wide MIME headers to their value.")
(defvoo nnfeed-group-article-max-num 0
"Maximum article number for the current group.")
(defvoo nnfeed-group-article-min-num 1
"Minimum article number for the current group.")
(nnoo-define-basics nnfeed)
(defun nnfeed--current-server-no-prefix ()
"Remove the \"<backend>+\" prefix from the current server."
(string-remove-prefix (concat (symbol-name nnfeed-backend) "+")
(nnoo-current-server nnfeed-backend)))
(defun nnfeed--group-data (group server)
"Get parsed data for GROUP from SERVER."
(when-let* ((server (nnfeed--server-address server))
(s (gethash server nnfeed-servers))
((hash-table-p s)))
(gethash group s)))
(defun nnfeed-retrieve-article (article group)
"Retrieve headers for ARTICLE from GROUP."
(if-let* ((a (gethash article (aref group 2))))
(insert (format "221 %s Article retrieved.
From: %s\nSubject: %s\nDate: %s\nMessage-ID: %s\n.\n"
article
(aref a 1)
(aref a 2)
(format-time-string "%F %H:%M" (aref a 3))
(aref a 0)))
(insert "404 Article not found.\n.\n")))
(deffoo nnfeed-retrieve-headers (articles &optional group server _fetch-old)
(if-let* ((server (or server (nnfeed--current-server-no-prefix)))
(g (or (nnfeed--group-data group server)
`[ nil ,nnfeed-group-article-ids ,nnfeed-group-articles
nil nil nil])))
(with-current-buffer nntp-server-buffer
(erase-buffer)
(or (and (stringp (car articles))
(mapc (lambda (a)
(nnfeed-retrieve-article
(gethash a (aref g 2)) g))
articles))
(and (numberp (car articles))
(range-map (lambda (a) (nnfeed-retrieve-article a g))
articles)))
'headers)
(nnheader-report nnfeed-backend "Group %s not found" (or group ""))))
(deffoo nnfeed-open-server (server &optional defs backend)
(let ((backend (or backend 'nnfeed))
(a (nnfeed--server-address server))
s)
(nnoo-change-server backend server defs)
(when (setq s (or (gethash a nnfeed-servers) (nnfeed--read-server server)))
(maphash (lambda (group g)
(setq g (aref g 0))
(unless (string= group g)
(puthash g group nnfeed-group-names)))
s))
(setq a (nnfeed--server-file server))
(or s (condition-case _ (make-directory (file-name-parent-directory a) t)
(:success (file-writable-p a))
(t nil))
(and (nnoo-close-server nnfeed-backend server)
(nnheader-report
nnfeed-backend "Server file %s not readable or writable"
server)))))
(deffoo nnfeed-request-close ()
(when (hash-table-p nnfeed-servers)
(maphash (lambda (server _) (nnfeed--write-server server)) nnfeed-servers)
(setq nnfeed-servers (make-hash-table :test 'equal)))
(setq nnfeed-status-string nil)
t)
;; The default content printing function, which should be suitable for
;; most inheriting backends.
(defun nnfeed--print-content (content attributes links)
"Return CONTENT formatted according to ATTRIBUTES, with LINKS possibly added."
(let ((links (and (memq 'links attributes) links)))
(when (or content links)
(concat
(and content (format "%s\n\n" content))
(mapconcat (lambda (link)
(cdr (assoc (cdr (assq 'Content-Type attributes)) link
(lambda (types type)
(if (stringp types) (string= types type)
(member type types))))))
links)))))
(defvoo nnfeed-print-content-function #'nnfeed--print-content
"Function returning a single piece of content for an article (a string).
It should accept three arguments, a part and its attributes (as returned
by `nnfeed-read-parts-function'), and links (as returned by
`nnfeed-read-links-function').")
(defun nnfeed--print-part (content headers mime links)
"Print part of an article using its CONTENT, HEADERS, and LINKS.
Only HEADERS of a type included in MIME are considered."
(concat
(mapconcat (lambda (header)
(when-let* ((m (car-safe header))
((member m mime)))
(format "%s: %s\n" m (cdr header))))
headers)
"\n"
(funcall nnfeed-print-content-function content headers links)))
(deffoo nnfeed-request-article (article &optional group server to-buffer)
(if-let* ((server (or server (nnfeed--current-server-no-prefix)))
(g (or (nnfeed--group-data group server)
(and (setq group nnfeed-group)
`[ nil ,nnfeed-group-article-ids
,nnfeed-group-articles
,nnfeed-group-article-max-num
,nnfeed-group-article-min-num nil])))
(num (or (and (stringp article)
(gethash article (aref g 1)))
(and (numberp article) article)))
((and (<= num (aref g 3))
(>= num (aref g 4))))
(a (gethash num (aref g 2))))
(with-current-buffer (or to-buffer nntp-server-buffer)
(erase-buffer)
(let* ((links (aref a 5))
(parts (aref a 6))
(headers (aref a 7))
(boundary (or (cdr (assq :boundary headers))
(format "-_%s_-" nnfeed-backend)))
(multi (length> parts 1))
(mime '( Content-Type Content-Disposition
Content-Transfer-Encoding)))
(insert (format
"Subject: %s\nFrom: %s\nDate: %s\nMessage-ID: %s\n"
(aref a 2) (aref a 1)
(format-time-string
nnfeed-date-format (or (aref a 3) '(0 0)))
(aref a 0))
(if (assq 'MIME-Version headers) "" "MIME-Version: 1.0\n")
(mapconcat (lambda (header)
(unless (keywordp (car header))
(format "%s: %s\n" (car header) (cdr header))))
headers)
(if multi
(if (assq 'Content-Type headers) ""
(format
"Content-Type: multipart/alternative; boundary=%s\n"
boundary))
(prog1 (nnfeed--print-part
(caar parts) (cdar parts) mime links)
(setq parts nil)))
(mapconcat (lambda (part)
(format "--%s\n%s\n" boundary
(nnfeed--print-part
(car part) (cdr part) mime links)))
parts)
(if multi (format "--%s--" boundary) "\n")))
`(,group . ,num))
(nnheader-report nnfeed-backend "No such article")))
(deffoo nnfeed-request-group (group &optional server fast _info)
(with-current-buffer nntp-server-buffer
(erase-buffer)
(if-let* ((server (or server (nnfeed--current-server-no-prefix)))
(g (or (if fast (nnfeed--group-data group server)
(setq server (nnfeed--parse-feed server group))
(and (hash-table-p server) (gethash group server)))
`[ ,group ,(make-hash-table :test 'equal)
,(make-hash-table :test 'eql) 0 1 ""])))
(progn
(setq nnfeed-group group
nnfeed-group-article-ids (aref g 1)
nnfeed-group-articles (aref g 2)
nnfeed-group-article-max-num (aref g 3)
nnfeed-group-article-min-num (aref g 4))
(insert (format "211 %s %s %s \"%s\""
(hash-table-count nnfeed-group-article-ids)
nnfeed-group-article-min-num
nnfeed-group-article-max-num group))
t)
(insert "404 group not found")
(nnheader-report nnfeed-backend "Group %s not found" group))))
(deffoo nnfeed-close-group (group &optional server)
(and (string= group nnfeed-group)
(setq nnfeed-group nil
nnfeed-group-article-ids (make-hash-table :test 'equal)
nnfeed-group-articles (make-hash-table :test 'eql)
nnfeed-group-article-max-num 0
nnfeed-group-article-min-num 1))
(setq server (or server (nnfeed--current-server-no-prefix)))
(nnfeed--write-server server))
(deffoo nnfeed-request-list (&optional server)
(with-current-buffer nntp-server-buffer
(erase-buffer)
(when-let* ((p (point))
(s (nnfeed--parse-feed
(or server (nnfeed--current-server-no-prefix))))
((hash-table-p s)))
(maphash (lambda (group g)
(insert (format "\"%s\" %s %s y\n"
group (aref g 3) (aref g 4))))
s)
(not (= (point) p)))))
(deffoo nnfeed-request-post (&optional _server)
(nnheader-report nnfeed-backend "%s is a read only backend" nnfeed-backend))
;;;; Optional back end functions:
(deffoo nnfeed-retrieve-groups (_groups &optional server)
(nnfeed-request-list server)
'active)
(deffoo nnfeed-request-type (_group &optional _article)
'unknown)
;; FIXME: Works incorrectly when a group name contains spaces as Gnus actually
;; separates the group name from the description with either a tab or a space.
(defun nnfeed--group-description (name group)
"Return a description line for a GROUP called NAME."
(when-let* ((desc (aref group 5))
((not (string-blank-p desc))))
(insert name "\t" desc "\n")))
(deffoo nnfeed-request-group-description (group &optional server)
(when-let* ((server (or server (nnfeed--current-server-no-prefix)))
(g (nnfeed--group-data group server)))
(with-current-buffer nntp-server-buffer
(erase-buffer)
(nnfeed--group-description group g)
t)))
(deffoo nnfeed-request-list-newsgroups (&optional server)
(when-let* ((server (or server (nnfeed--current-server-no-prefix)))
(s (gethash (nnfeed--server-address server) nnfeed-servers))
((hash-table-p s)))
(with-current-buffer nntp-server-buffer
(erase-buffer)
(maphash #'nnfeed--group-description s)
t)))
(deffoo nnfeed-request-rename-group (group new-name &optional server)
(when-let* ((server (or server (nnfeed--current-server-no-prefix)))
(a (nnfeed--server-address server))
(s (or (gethash a nnfeed-servers)
(and ; Open the server to add it to `nnfeed-servers'
(save-match-data
(nnfeed-open-server
server
(cdr ; Get defs and backend.
(assoc a (cdr (assq nnfeed-backend nnoo-state-alist))
(lambda (car key)
(and (stringp car)
(string-match
(concat
"\\`\\(\\(nn[[:alpha:]]+\\)\\+\\)?"
(regexp-quote key) "\\'")
car)
(setq server car)))))
(if (match-string 1 server)
(intern (match-string 2 server)) 'nnfeed)))
(gethash a nnfeed-servers))))
(g (or (nnfeed--group-data group a)
`[ ,group ,(make-hash-table :test 'equal)
,(make-hash-table :test 'eql) nil 1 ""])))
(puthash new-name g s)
(puthash group new-name nnfeed-group-names)
(remhash group s)
(and (string= group nnfeed-group)
(setq nnfeed-group new-name))
t))
(provide 'nnfeed)
;;; nnfeed.el ends here