mirror of
git://git.sv.gnu.org/emacs.git
synced 2026-02-21 07:30:50 -08:00
This reverts almost all my recent changes to use curved quotes in docstrings and/or strings used for error diagnostics. There are a few exceptions, e.g., Bahá’í proper names. * admin/unidata/unidata-gen.el (unidata-gen-table): * lisp/abbrev.el (expand-region-abbrevs): * lisp/align.el (align-region): * lisp/allout.el (allout-mode, allout-solicit-alternate-bullet) (outlineify-sticky): * lisp/apropos.el (apropos-library): * lisp/bookmark.el (bookmark-default-annotation-text): * lisp/button.el (button-category-symbol, button-put) (make-text-button): * lisp/calc/calc-aent.el (math-read-if, math-read-factor): * lisp/calc/calc-embed.el (calc-do-embedded): * lisp/calc/calc-ext.el (calc-user-function-list): * lisp/calc/calc-graph.el (calc-graph-show-dumb): * lisp/calc/calc-help.el (calc-describe-key) (calc-describe-thing, calc-full-help): * lisp/calc/calc-lang.el (calc-c-language) (math-parse-fortran-vector-end, math-parse-tex-sum) (math-parse-eqn-matrix, math-parse-eqn-prime) (calc-yacas-language, calc-maxima-language, calc-giac-language) (math-read-giac-subscr, math-read-math-subscr) (math-read-big-rec, math-read-big-balance): * lisp/calc/calc-misc.el (calc-help, report-calc-bug): * lisp/calc/calc-mode.el (calc-auto-why, calc-save-modes) (calc-auto-recompute): * lisp/calc/calc-prog.el (calc-fix-token-name) (calc-read-parse-table-part, calc-user-define-invocation) (math-do-arg-check): * lisp/calc/calc-store.el (calc-edit-variable): * lisp/calc/calc-units.el (math-build-units-table-buffer): * lisp/calc/calc-vec.el (math-read-brackets): * lisp/calc/calc-yank.el (calc-edit-mode): * lisp/calc/calc.el (calc, calc-do, calc-user-invocation): * lisp/calendar/appt.el (appt-display-message): * lisp/calendar/diary-lib.el (diary-check-diary-file) (diary-mail-entries, diary-from-outlook): * lisp/calendar/icalendar.el (icalendar-export-region) (icalendar--convert-float-to-ical) (icalendar--convert-date-to-ical) (icalendar--convert-ical-to-diary) (icalendar--convert-recurring-to-diary) (icalendar--add-diary-entry): * lisp/calendar/time-date.el (format-seconds): * lisp/calendar/timeclock.el (timeclock-mode-line-display) (timeclock-make-hours-explicit, timeclock-log-data): * lisp/calendar/todo-mode.el (todo-prefix, todo-delete-category) (todo-item-mark, todo-check-format) (todo-insert-item--next-param, todo-edit-item--next-key) (todo-mode): * lisp/cedet/ede/pmake.el (ede-proj-makefile-insert-dist-rules): * lisp/cedet/mode-local.el (describe-mode-local-overload) (mode-local-print-binding, mode-local-describe-bindings-2): * lisp/cedet/semantic/complete.el (semantic-displayor-show-request): * lisp/cedet/srecode/srt-mode.el (srecode-macro-help): * lisp/cus-start.el (standard): * lisp/cus-theme.el (describe-theme-1): * lisp/custom.el (custom-add-dependencies, custom-check-theme) (custom--sort-vars-1, load-theme): * lisp/descr-text.el (describe-text-properties-1, describe-char): * lisp/dired-x.el (dired-do-run-mail): * lisp/dired.el (dired-log): * lisp/emacs-lisp/advice.el (ad-read-advised-function) (ad-read-advice-class, ad-read-advice-name, ad-enable-advice) (ad-disable-advice, ad-remove-advice, ad-set-argument) (ad-set-arguments, ad--defalias-fset, ad-activate) (ad-deactivate): * lisp/emacs-lisp/byte-opt.el (byte-compile-inline-expand) (byte-compile-unfold-lambda, byte-optimize-form-code-walker) (byte-optimize-while, byte-optimize-apply): * lisp/emacs-lisp/byte-run.el (defun, defsubst): * lisp/emacs-lisp/bytecomp.el (byte-compile-lapcode) (byte-compile-log-file, byte-compile-format-warn) (byte-compile-nogroup-warn, byte-compile-arglist-warn) (byte-compile-cl-warn) (byte-compile-warn-about-unresolved-functions) (byte-compile-file, byte-compile--declare-var) (byte-compile-file-form-defmumble, byte-compile-form) (byte-compile-normal-call, byte-compile-check-variable) (byte-compile-variable-ref, byte-compile-variable-set) (byte-compile-subr-wrong-args, byte-compile-setq-default) (byte-compile-negation-optimizer) (byte-compile-condition-case--old) (byte-compile-condition-case--new, byte-compile-save-excursion) (byte-compile-defvar, byte-compile-autoload) (byte-compile-lambda-form) (byte-compile-make-variable-buffer-local, display-call-tree) (batch-byte-compile): * lisp/emacs-lisp/cconv.el (cconv-convert, cconv--analyze-use): * lisp/emacs-lisp/chart.el (chart-space-usage): * lisp/emacs-lisp/check-declare.el (check-declare-scan) (check-declare-warn, check-declare-file) (check-declare-directory): * lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine) (checkdoc-message-text-engine): * lisp/emacs-lisp/cl-extra.el (cl-parse-integer) (cl--describe-class): * lisp/emacs-lisp/cl-generic.el (cl-defgeneric) (cl--generic-describe, cl-generic-generalizers): * lisp/emacs-lisp/cl-macs.el (cl--parse-loop-clause, cl-tagbody) (cl-symbol-macrolet): * lisp/emacs-lisp/cl.el (cl-unload-function, flet): * lisp/emacs-lisp/copyright.el (copyright) (copyright-update-directory): * lisp/emacs-lisp/edebug.el (edebug-read-list): * lisp/emacs-lisp/eieio-base.el (eieio-persistent-read): * lisp/emacs-lisp/eieio-core.el (eieio--slot-override) (eieio-oref): * lisp/emacs-lisp/eieio-opt.el (eieio-help-constructor): * lisp/emacs-lisp/eieio-speedbar.el: (eieio-speedbar-child-make-tag-lines) (eieio-speedbar-child-description): * lisp/emacs-lisp/eieio.el (defclass, change-class): * lisp/emacs-lisp/elint.el (elint-file, elint-get-top-forms) (elint-init-form, elint-check-defalias-form) (elint-check-let-form): * lisp/emacs-lisp/ert.el (ert-get-test, ert-results-mode-menu) (ert-results-pop-to-backtrace-for-test-at-point) (ert-results-pop-to-messages-for-test-at-point) (ert-results-pop-to-should-forms-for-test-at-point) (ert-describe-test): * lisp/emacs-lisp/find-func.el (find-function-search-for-symbol) (find-function-library): * lisp/emacs-lisp/generator.el (iter-yield): * lisp/emacs-lisp/gv.el (gv-define-simple-setter): * lisp/emacs-lisp/lisp-mnt.el (lm-verify): * lisp/emacs-lisp/macroexp.el (macroexp--obsolete-warning): * lisp/emacs-lisp/map-ynp.el (map-y-or-n-p): * lisp/emacs-lisp/nadvice.el (advice--make-docstring) (advice--make, define-advice): * lisp/emacs-lisp/package-x.el (package-upload-file): * lisp/emacs-lisp/package.el (package-version-join) (package-disabled-p, package-activate-1, package-activate) (package--download-one-archive) (package--download-and-read-archives) (package-compute-transaction, package-install-from-archive) (package-install, package-install-selected-packages) (package-delete, package-autoremove, describe-package-1) (package-install-button-action, package-delete-button-action) (package-menu-hide-package, package-menu--list-to-prompt) (package-menu--perform-transaction) (package-menu--find-and-notify-upgrades): * lisp/emacs-lisp/pcase.el (pcase-exhaustive, pcase--u1): * lisp/emacs-lisp/re-builder.el (reb-enter-subexp-mode): * lisp/emacs-lisp/ring.el (ring-previous, ring-next): * lisp/emacs-lisp/rx.el (rx-check, rx-anything) (rx-check-any-string, rx-check-any, rx-check-not, rx-=) (rx-repeat, rx-check-backref, rx-syntax, rx-check-category) (rx-form): * lisp/emacs-lisp/smie.el (smie-config-save): * lisp/emacs-lisp/subr-x.el (internal--check-binding): * lisp/emacs-lisp/tabulated-list.el (tabulated-list-put-tag): * lisp/emacs-lisp/testcover.el (testcover-1value): * lisp/emacs-lisp/timer.el (timer-event-handler): * lisp/emulation/viper-cmd.el (viper-toggle-parse-sexp-ignore-comments) (viper-toggle-search-style, viper-kill-buffer) (viper-brac-function): * lisp/emulation/viper-macs.el (viper-record-kbd-macro): * lisp/env.el (setenv): * lisp/erc/erc-button.el (erc-nick-popup): * lisp/erc/erc.el (erc-cmd-LOAD, erc-handle-login, english): * lisp/eshell/em-dirs.el (eshell/cd): * lisp/eshell/em-glob.el (eshell-glob-regexp) (eshell-glob-entries): * lisp/eshell/em-pred.el (eshell-parse-modifiers): * lisp/eshell/esh-opt.el (eshell-show-usage): * lisp/facemenu.el (facemenu-add-new-face) (facemenu-add-new-color): * lisp/faces.el (read-face-name, read-face-font, describe-face) (x-resolve-font-name): * lisp/files-x.el (modify-file-local-variable): * lisp/files.el (locate-user-emacs-file, find-alternate-file) (set-auto-mode, hack-one-local-variable--obsolete) (dir-locals-set-directory-class, write-file, basic-save-buffer) (delete-directory, copy-directory, recover-session) (recover-session-finish, insert-directory) (file-modes-char-to-who, file-modes-symbolic-to-number) (move-file-to-trash): * lisp/filesets.el (filesets-add-buffer, filesets-remove-buffer): * lisp/find-cmd.el (find-generic, find-to-string): * lisp/finder.el (finder-commentary): * lisp/font-lock.el (font-lock-fontify-buffer): * lisp/format.el (format-write-file, format-find-file) (format-insert-file): * lisp/frame.el (get-device-terminal, select-frame-by-name): * lisp/fringe.el (fringe--check-style): * lisp/gnus/nnmairix.el (nnmairix-widget-create-query): * lisp/help-fns.el (help-fns--key-bindings) (help-fns--compiler-macro, help-fns--parent-mode) (help-fns--obsolete, help-fns--interactive-only) (describe-function-1, describe-variable): * lisp/help.el (describe-mode) (describe-minor-mode-from-indicator): * lisp/image.el (image-type): * lisp/international/ccl.el (ccl-dump): * lisp/international/fontset.el (x-must-resolve-font-name): * lisp/international/mule-cmds.el (prefer-coding-system) (select-safe-coding-system-interactively) (select-safe-coding-system, activate-input-method) (toggle-input-method, describe-current-input-method) (describe-language-environment): * lisp/international/mule-conf.el (code-offset): * lisp/international/mule-diag.el (describe-character-set) (list-input-methods-1): * lisp/mail/feedmail.el (feedmail-run-the-queue): * lisp/mouse.el (minor-mode-menu-from-indicator): * lisp/mpc.el (mpc-playlist-rename): * lisp/msb.el (msb--choose-menu): * lisp/net/ange-ftp.el (ange-ftp-shell-command): * lisp/net/imap.el (imap-interactive-login): * lisp/net/mairix.el (mairix-widget-create-query): * lisp/net/newst-backend.el (newsticker--sentinel-work): * lisp/net/newst-treeview.el (newsticker--treeview-load): * lisp/net/rlogin.el (rlogin): * lisp/obsolete/iswitchb.el (iswitchb-possible-new-buffer): * lisp/obsolete/otodo-mode.el (todo-more-important-p): * lisp/obsolete/pgg-gpg.el (pgg-gpg-process-region): * lisp/obsolete/pgg-pgp.el (pgg-pgp-process-region): * lisp/obsolete/pgg-pgp5.el (pgg-pgp5-process-region): * lisp/org/ob-core.el (org-babel-goto-named-src-block) (org-babel-goto-named-result): * lisp/org/ob-fortran.el (org-babel-fortran-ensure-main-wrap): * lisp/org/ob-ref.el (org-babel-ref-resolve): * lisp/org/org-agenda.el (org-agenda-prepare): * lisp/org/org-clock.el (org-clock-notify-once-if-expired) (org-clock-resolve): * lisp/org/org-ctags.el (org-ctags-ask-rebuild-tags-file-then-find-tag): * lisp/org/org-feed.el (org-feed-parse-atom-entry): * lisp/org/org-habit.el (org-habit-parse-todo): * lisp/org/org-mouse.el (org-mouse-popup-global-menu) (org-mouse-context-menu): * lisp/org/org-table.el (org-table-edit-formulas): * lisp/org/ox.el (org-export-async-start): * lisp/proced.el (proced-log): * lisp/progmodes/ada-mode.el (ada-get-indent-case) (ada-check-matching-start, ada-goto-matching-start): * lisp/progmodes/ada-prj.el (ada-prj-display-page): * lisp/progmodes/ada-xref.el (ada-find-executable): * lisp/progmodes/ebrowse.el (ebrowse-tags-apropos): * lisp/progmodes/etags.el (etags-tags-apropos-additional): * lisp/progmodes/flymake.el (flymake-parse-err-lines) (flymake-start-syntax-check-process): * lisp/progmodes/python.el (python-shell-get-process-or-error) (python-define-auxiliary-skeleton): * lisp/progmodes/sql.el (sql-comint): * lisp/progmodes/verilog-mode.el (verilog-load-file-at-point): * lisp/progmodes/vhdl-mode.el (vhdl-widget-directory-validate): * lisp/recentf.el (recentf-open-files): * lisp/replace.el (query-replace-read-from) (occur-after-change-function, occur-1): * lisp/scroll-bar.el (scroll-bar-columns): * lisp/server.el (server-get-auth-key): * lisp/simple.el (execute-extended-command) (undo-outer-limit-truncate, list-processes--refresh) (compose-mail, set-variable, choose-completion-string) (define-alternatives): * lisp/startup.el (site-run-file, tty-handle-args, command-line) (command-line-1): * lisp/subr.el (noreturn, define-error, add-to-list) (read-char-choice, version-to-list): * lisp/term/common-win.el (x-handle-xrm-switch) (x-handle-name-switch, x-handle-args): * lisp/term/x-win.el (x-handle-parent-id, x-handle-smid): * lisp/textmodes/reftex-ref.el (reftex-label): * lisp/textmodes/reftex-toc.el (reftex-toc-rename-label): * lisp/textmodes/two-column.el (2C-split): * lisp/tutorial.el (tutorial--describe-nonstandard-key) (tutorial--find-changed-keys): * lisp/type-break.el (type-break-noninteractive-query): * lisp/wdired.el (wdired-do-renames, wdired-do-symlink-changes) (wdired-do-perm-changes): * lisp/whitespace.el (whitespace-report-region): Prefer grave quoting in source-code strings used to generate help and diagnostics. * lisp/faces.el (face-documentation): No need to convert quotes, since the result is a docstring. * lisp/info.el (Info-virtual-index-find-node) (Info-virtual-index, info-apropos): Simplify by generating only curved quotes, since info files are typically that ways nowadays anyway. * lisp/international/mule-diag.el (list-input-methods): Don’t assume text quoting style is curved. * lisp/org/org-bibtex.el (org-bibtex-fields): Revert my recent changes, going back to the old quoting style.
703 lines
25 KiB
EmacsLisp
703 lines
25 KiB
EmacsLisp
;;; org-feed.el --- Add RSS feed items to Org files
|
|
;;
|
|
;; Copyright (C) 2009-2015 Free Software Foundation, Inc.
|
|
;;
|
|
;; Author: Carsten Dominik <carsten at orgmode dot org>
|
|
;; Keywords: outlines, hypermedia, calendar, wp
|
|
;; Homepage: http://orgmode.org
|
|
;;
|
|
;; 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 <http://www.gnu.org/licenses/>.
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;;
|
|
;;; Commentary:
|
|
;;
|
|
;; This module allows to create and change entries in an Org-mode
|
|
;; file triggered by items in an RSS feed. The basic functionality is
|
|
;; geared toward simply adding new items found in a feed as outline nodes
|
|
;; to an Org file. Using hooks, arbitrary actions can be triggered for
|
|
;; new or changed items.
|
|
;;
|
|
;; Selecting feeds and target locations
|
|
;; ------------------------------------
|
|
;;
|
|
;; This module is configured through a single variable, `org-feed-alist'.
|
|
;; Here is an example, using a notes/tasks feed from reQall.com.
|
|
;;
|
|
;; (setq org-feed-alist
|
|
;; '(("ReQall"
|
|
;; "http://www.reqall.com/user/feeds/rss/a1b2c3....."
|
|
;; "~/org/feeds.org" "ReQall Entries")
|
|
;;
|
|
;; With this setup, the command `M-x org-feed-update-all' will
|
|
;; collect new entries in the feed at the given URL and create
|
|
;; entries as subheadings under the "ReQall Entries" heading in the
|
|
;; file "~/org/feeds.org". Each feed should normally have its own
|
|
;; heading - however see the `:drawer' parameter.
|
|
;;
|
|
;; Besides these standard elements that need to be specified for each
|
|
;; feed, keyword-value pairs can set additional options. For example,
|
|
;; to de-select transitional entries with a title containing
|
|
;;
|
|
;; "reQall is typing what you said",
|
|
;;
|
|
;; you could use the `:filter' argument:
|
|
;;
|
|
;; (setq org-feed-alist
|
|
;; '(("ReQall"
|
|
;; "http://www.reqall.com/user/feeds/rss/a1b2c3....."
|
|
;; "~/org/feeds.org" "ReQall Entries"
|
|
;; :filter my-reqall-filter)))
|
|
;;
|
|
;; (defun my-reqall-filter (e)
|
|
;; (if (string-match "reQall is typing what you said"
|
|
;; (plist-get e :title))
|
|
;; nil
|
|
;; e))
|
|
;;
|
|
;; See the docstring for `org-feed-alist' for more details.
|
|
;;
|
|
;;
|
|
;; Keeping track of previously added entries
|
|
;; -----------------------------------------
|
|
;;
|
|
;; Since Org allows you to delete, archive, or move outline nodes,
|
|
;; org-feed.el needs to keep track of which feed items have been handled
|
|
;; before, so that they will not be handled again. For this, org-feed.el
|
|
;; stores information in a special drawer, FEEDSTATUS, under the heading
|
|
;; that received the input of the feed. You should add FEEDSTATUS
|
|
;; to your list of drawers in the files that receive feed input:
|
|
;;
|
|
;; #+DRAWERS: PROPERTIES CLOCK LOGBOOK RESULTS FEEDSTATUS
|
|
;;
|
|
;; Acknowledgments
|
|
;; ---------------
|
|
;;
|
|
;; org-feed.el is based on ideas by Brad Bozarth who implemented a
|
|
;; similar mechanism using shell and awk scripts.
|
|
|
|
;;; Code:
|
|
|
|
(require 'org)
|
|
(require 'sha1)
|
|
|
|
(declare-function url-retrieve-synchronously "url" (url))
|
|
(declare-function xml-node-children "xml" (node))
|
|
(declare-function xml-get-children "xml" (node child-name))
|
|
(declare-function xml-get-attribute "xml" (node attribute))
|
|
(declare-function xml-get-attribute-or-nil "xml" (node attribute))
|
|
(declare-function xml-substitute-special "xml" (string))
|
|
|
|
(declare-function org-capture-escaped-% "org-capture" ())
|
|
(declare-function org-capture-inside-embedded-elisp-p "org-capture" ())
|
|
(declare-function org-capture-expand-embedded-elisp "org-capture" ())
|
|
|
|
(defgroup org-feed nil
|
|
"Options concerning RSS feeds as inputs for Org files."
|
|
:tag "Org Feed"
|
|
:group 'org)
|
|
|
|
(defcustom org-feed-alist nil
|
|
"Alist specifying RSS feeds that should create inputs for Org.
|
|
Each entry in this list specified an RSS feed tat should be queried
|
|
to create inbox items in Org. Each entry is a list with the following items:
|
|
|
|
name a custom name for this feed
|
|
URL the Feed URL
|
|
file the target Org file where entries should be listed
|
|
headline the headline under which entries should be listed
|
|
|
|
Additional arguments can be given using keyword-value pairs. Many of these
|
|
specify functions that receive one or a list of \"entries\" as their single
|
|
argument. An entry is a property list that describes a feed item. The
|
|
property list has properties for each field in the item, for example `:title'
|
|
for the `<title>' field and `:pubDate' for the publication date. In addition,
|
|
it contains the following properties:
|
|
|
|
`:item-full-text' the full text in the <item> tag
|
|
`:guid-permalink' t when the guid property is a permalink
|
|
|
|
Here are the keyword-value pair allows in `org-feed-alist'.
|
|
|
|
:drawer drawer-name
|
|
The name of the drawer for storing feed information. The default is
|
|
\"FEEDSTATUS\". Using different drawers for different feeds allows
|
|
several feeds to target the same inbox heading.
|
|
|
|
:filter filter-function
|
|
A function to select interesting entries in the feed. It gets a single
|
|
entry as parameter. It should return the entry if it is relevant, or
|
|
nil if it is not.
|
|
|
|
:template template-string
|
|
The default action on new items in the feed is to add them as children
|
|
under the headline for the feed. The template describes how the entry
|
|
should be formatted. If not given, it defaults to
|
|
`org-feed-default-template'.
|
|
|
|
:formatter formatter-function
|
|
Instead of relying on a template, you may specify a function to format
|
|
the outline node to be inserted as a child. This function gets passed
|
|
a property list describing a single feed item, and it should return a
|
|
string that is a properly formatted Org outline node of level 1.
|
|
|
|
:new-handler function
|
|
If adding new items as children to the outline is not what you want
|
|
to do with new items, define a handler function that is called with
|
|
a list of all new items in the feed, each one represented as a property
|
|
list. The handler should do what needs to be done, and org-feed will
|
|
mark all items given to this handler as \"handled\", i.e. they will not
|
|
be passed to this handler again in future readings of the feed.
|
|
When the handler is called, point will be at the feed headline.
|
|
|
|
:changed-handler function
|
|
This function gets passed a list of all entries that have been
|
|
handled before, but are now still in the feed and have *changed*
|
|
since last handled (as evidenced by a different sha1 hash).
|
|
When the handler is called, point will be at the feed headline.
|
|
|
|
:parse-feed function
|
|
This function gets passed a buffer, and should return a list
|
|
of entries, each being a property list containing the
|
|
`:guid' and `:item-full-text' keys. The default is
|
|
`org-feed-parse-rss-feed'; `org-feed-parse-atom-feed' is an
|
|
alternative.
|
|
|
|
:parse-entry function
|
|
This function gets passed an entry as returned by the parse-feed
|
|
function, and should return the entry with interesting properties added.
|
|
The default is `org-feed-parse-rss-entry'; `org-feed-parse-atom-entry'
|
|
is an alternative."
|
|
:group 'org-feed
|
|
:type '(repeat
|
|
(list :value ("" "http://" "" "")
|
|
(string :tag "Name")
|
|
(string :tag "Feed URL")
|
|
(file :tag "File for inbox")
|
|
(string :tag "Headline for inbox")
|
|
(repeat :inline t
|
|
(choice
|
|
(list :inline t :tag "Filter"
|
|
(const :filter)
|
|
(symbol :tag "Filter Function"))
|
|
(list :inline t :tag "Template"
|
|
(const :template)
|
|
(string :tag "Template"))
|
|
(list :inline t :tag "Formatter"
|
|
(const :formatter)
|
|
(symbol :tag "Formatter Function"))
|
|
(list :inline t :tag "New items handler"
|
|
(const :new-handler)
|
|
(symbol :tag "Handler Function"))
|
|
(list :inline t :tag "Changed items"
|
|
(const :changed-handler)
|
|
(symbol :tag "Handler Function"))
|
|
(list :inline t :tag "Parse Feed"
|
|
(const :parse-feed)
|
|
(symbol :tag "Parse Feed Function"))
|
|
(list :inline t :tag "Parse Entry"
|
|
(const :parse-entry)
|
|
(symbol :tag "Parse Entry Function"))
|
|
)))))
|
|
|
|
(defcustom org-feed-drawer "FEEDSTATUS"
|
|
"The name of the drawer for feed status information.
|
|
Each feed may also specify its own drawer name using the `:drawer'
|
|
parameter in `org-feed-alist'.
|
|
Note that in order to make these drawers behave like drawers, they must
|
|
be added to the variable `org-drawers' or configured with a #+DRAWERS
|
|
line."
|
|
:group 'org-feed
|
|
:type '(string :tag "Drawer Name"))
|
|
|
|
(defcustom org-feed-default-template "\n* %h\n %U\n %description\n %a\n"
|
|
"Template for the Org node created from RSS feed items.
|
|
This is just the default, each feed can specify its own.
|
|
Any fields from the feed item can be interpolated into the template with
|
|
%name, for example %title, %description, %pubDate etc. In addition, the
|
|
following special escapes are valid as well:
|
|
|
|
%h The title, or the first line of the description
|
|
%t The date as a stamp, either from <pubDate> (if present), or
|
|
the current date
|
|
%T Date and time
|
|
%u,%U Like %t,%T, but inactive time stamps
|
|
%a A link, from <guid> if that is a permalink, else from <link>
|
|
%(sexp) Evaluate elisp `(sexp)' and replace with the result, the simple
|
|
%-escapes above can be used as arguments, e.g. %(capitalize \\\"%h\\\")"
|
|
:group 'org-feed
|
|
:type '(string :tag "Template"))
|
|
|
|
(defcustom org-feed-save-after-adding t
|
|
"Non-nil means save buffer after adding new feed items."
|
|
:group 'org-feed
|
|
:type 'boolean)
|
|
|
|
(defcustom org-feed-retrieve-method 'url-retrieve-synchronously
|
|
"The method to be used to retrieve a feed URL.
|
|
This can be `curl' or `wget' to call these external programs, or it can be
|
|
an Emacs Lisp function that will return a buffer containing the content
|
|
of the file pointed to by the URL."
|
|
:group 'org-feed
|
|
:type '(choice
|
|
(const :tag "Internally with url.el" url-retrieve-synchronously)
|
|
(const :tag "Externally with curl" curl)
|
|
(const :tag "Externally with wget" wget)
|
|
(function :tag "Function")))
|
|
|
|
(defcustom org-feed-before-adding-hook nil
|
|
"Hook that is run before adding new feed items to a file.
|
|
You might want to commit the file in its current state to version control,
|
|
for example."
|
|
:group 'org-feed
|
|
:type 'hook)
|
|
|
|
(defcustom org-feed-after-adding-hook nil
|
|
"Hook that is run after new items have been added to a file.
|
|
Depending on `org-feed-save-after-adding', the buffer will already
|
|
have been saved."
|
|
:group 'org-feed
|
|
:type 'hook)
|
|
|
|
(defvar org-feed-buffer "*Org feed*"
|
|
"The buffer used to retrieve a feed.")
|
|
|
|
;;;###autoload
|
|
(defun org-feed-update-all ()
|
|
"Get inbox items from all feeds in `org-feed-alist'."
|
|
(interactive)
|
|
(let ((nfeeds (length org-feed-alist))
|
|
(nnew (apply '+ (mapcar 'org-feed-update org-feed-alist))))
|
|
(message "%s from %d %s"
|
|
(cond ((= nnew 0) "No new entries")
|
|
((= nnew 1) "1 new entry")
|
|
(t (format "%d new entries" nnew)))
|
|
nfeeds
|
|
(if (= nfeeds 1) "feed" "feeds"))))
|
|
|
|
;;;###autoload
|
|
(defun org-feed-update (feed &optional retrieve-only)
|
|
"Get inbox items from FEED.
|
|
FEED can be a string with an association in `org-feed-alist', or
|
|
it can be a list structured like an entry in `org-feed-alist'."
|
|
(interactive (list (org-completing-read "Feed name: " org-feed-alist)))
|
|
(if (stringp feed) (setq feed (assoc feed org-feed-alist)))
|
|
(unless feed
|
|
(error "No such feed in `org-feed-alist"))
|
|
(catch 'exit
|
|
(let ((name (car feed))
|
|
(url (nth 1 feed))
|
|
(file (nth 2 feed))
|
|
(headline (nth 3 feed))
|
|
(filter (nth 1 (memq :filter feed)))
|
|
(formatter (nth 1 (memq :formatter feed)))
|
|
(new-handler (nth 1 (memq :new-handler feed)))
|
|
(changed-handler (nth 1 (memq :changed-handler feed)))
|
|
(template (or (nth 1 (memq :template feed))
|
|
org-feed-default-template))
|
|
(drawer (or (nth 1 (memq :drawer feed))
|
|
org-feed-drawer))
|
|
(parse-feed (or (nth 1 (memq :parse-feed feed))
|
|
'org-feed-parse-rss-feed))
|
|
(parse-entry (or (nth 1 (memq :parse-entry feed))
|
|
'org-feed-parse-rss-entry))
|
|
feed-buffer inbox-pos new-formatted
|
|
entries old-status status new changed guid-alist e guid olds)
|
|
(setq feed-buffer (org-feed-get-feed url))
|
|
(unless (and feed-buffer (bufferp (get-buffer feed-buffer)))
|
|
(error "Cannot get feed %s" name))
|
|
(when retrieve-only
|
|
(throw 'exit feed-buffer))
|
|
(setq entries (funcall parse-feed feed-buffer))
|
|
(ignore-errors (kill-buffer feed-buffer))
|
|
(save-excursion
|
|
(save-window-excursion
|
|
(setq inbox-pos (org-feed-goto-inbox-internal file headline))
|
|
(setq old-status (org-feed-read-previous-status inbox-pos drawer))
|
|
;; Add the "handled" status to the appropriate entries
|
|
(setq entries (mapcar (lambda (e)
|
|
(setq e
|
|
(plist-put e :handled
|
|
(nth 1 (assoc
|
|
(plist-get e :guid)
|
|
old-status)))))
|
|
entries))
|
|
;; Find out which entries are new and which are changed
|
|
(dolist (e entries)
|
|
(if (not (plist-get e :handled))
|
|
(push e new)
|
|
(setq olds (nth 2 (assoc (plist-get e :guid) old-status)))
|
|
(if (and olds
|
|
(not (string= (sha1
|
|
(plist-get e :item-full-text))
|
|
olds)))
|
|
(push e changed))))
|
|
|
|
;; Parse the relevant entries fully
|
|
(setq new (mapcar parse-entry new)
|
|
changed (mapcar parse-entry changed))
|
|
|
|
;; Run the filter
|
|
(when filter
|
|
(setq new (delq nil (mapcar filter new))
|
|
changed (delq nil (mapcar filter new))))
|
|
|
|
(when (not (or new changed))
|
|
(message "No new items in feed %s" name)
|
|
(throw 'exit 0))
|
|
|
|
;; Get alist based on guid, to look up entries
|
|
(setq guid-alist
|
|
(append
|
|
(mapcar (lambda (e) (list (plist-get e :guid) e)) new)
|
|
(mapcar (lambda (e) (list (plist-get e :guid) e)) changed)))
|
|
|
|
;; Construct the new status
|
|
(setq status
|
|
(mapcar
|
|
(lambda (e)
|
|
(setq guid (plist-get e :guid))
|
|
(list guid
|
|
;; things count as handled if we handle them now,
|
|
;; or if they were handled previously
|
|
(if (assoc guid guid-alist) t (plist-get e :handled))
|
|
;; A hash, to detect changes
|
|
(sha1 (plist-get e :item-full-text))))
|
|
entries))
|
|
|
|
;; Handle new items in the feed
|
|
(when new
|
|
(if new-handler
|
|
(progn
|
|
(goto-char inbox-pos)
|
|
(funcall new-handler new))
|
|
;; No custom handler, do the default adding
|
|
;; Format the new entries into an alist with GUIDs in the car
|
|
(setq new-formatted
|
|
(mapcar
|
|
(lambda (e) (org-feed-format-entry e template formatter))
|
|
new)))
|
|
|
|
;; Insert the new items
|
|
(org-feed-add-items inbox-pos new-formatted))
|
|
|
|
;; Handle changed items in the feed
|
|
(when (and changed-handler changed)
|
|
(goto-char inbox-pos)
|
|
(funcall changed-handler changed))
|
|
|
|
;; Write the new status
|
|
;; We do this only now, in case something goes wrong above, so
|
|
;; that would would end up with a status that does not reflect
|
|
;; which items truely have been handled
|
|
(org-feed-write-status inbox-pos drawer status)
|
|
|
|
;; Normalize the visibility of the inbox tree
|
|
(goto-char inbox-pos)
|
|
(hide-subtree)
|
|
(show-children)
|
|
(org-cycle-hide-drawers 'children)
|
|
|
|
;; Hooks and messages
|
|
(when org-feed-save-after-adding (save-buffer))
|
|
(message "Added %d new item%s from feed %s to file %s, heading %s"
|
|
(length new) (if (> (length new) 1) "s" "")
|
|
name
|
|
(file-name-nondirectory file) headline)
|
|
(run-hooks 'org-feed-after-adding-hook)
|
|
(length new))))))
|
|
|
|
;;;###autoload
|
|
(defun org-feed-goto-inbox (feed)
|
|
"Go to the inbox that captures the feed named FEED."
|
|
(interactive
|
|
(list (if (= (length org-feed-alist) 1)
|
|
(car org-feed-alist)
|
|
(org-completing-read "Feed name: " org-feed-alist))))
|
|
(if (stringp feed) (setq feed (assoc feed org-feed-alist)))
|
|
(unless feed
|
|
(error "No such feed in `org-feed-alist"))
|
|
(org-feed-goto-inbox-internal (nth 2 feed) (nth 3 feed)))
|
|
|
|
;;;###autoload
|
|
(defun org-feed-show-raw-feed (feed)
|
|
"Show the raw feed buffer of a feed."
|
|
(interactive
|
|
(list (if (= (length org-feed-alist) 1)
|
|
(car org-feed-alist)
|
|
(org-completing-read "Feed name: " org-feed-alist))))
|
|
(if (stringp feed) (setq feed (assoc feed org-feed-alist)))
|
|
(unless feed
|
|
(error "No such feed in `org-feed-alist"))
|
|
(org-pop-to-buffer-same-window
|
|
(org-feed-update feed 'retrieve-only))
|
|
(goto-char (point-min)))
|
|
|
|
(defun org-feed-goto-inbox-internal (file heading)
|
|
"Find or create HEADING in FILE.
|
|
Switch to that buffer, and return the position of that headline."
|
|
(find-file file)
|
|
(widen)
|
|
(goto-char (point-min))
|
|
(if (re-search-forward
|
|
(concat "^\\*+[ \t]+" heading "[ \t]*\\(:.*?:[ \t]*\\)?$")
|
|
nil t)
|
|
(goto-char (match-beginning 0))
|
|
(goto-char (point-max))
|
|
(insert "\n\n* " heading "\n\n")
|
|
(org-back-to-heading t))
|
|
(point))
|
|
|
|
(defun org-feed-read-previous-status (pos drawer)
|
|
"Get the alist of old GUIDs from the entry at POS.
|
|
This will find DRAWER and extract the alist."
|
|
(save-excursion
|
|
(goto-char pos)
|
|
(let ((end (save-excursion (org-end-of-subtree t t))))
|
|
(if (re-search-forward
|
|
(concat "^[ \t]*:" drawer ":[ \t]*\n\\([^\000]*?\\)\n[ \t]*:END:")
|
|
end t)
|
|
(read (match-string 1))
|
|
nil))))
|
|
|
|
(defun org-feed-write-status (pos drawer status)
|
|
"Write the feed STATUS to DRAWER in entry at POS."
|
|
(save-excursion
|
|
(goto-char pos)
|
|
(let ((end (save-excursion (org-end-of-subtree t t)))
|
|
guid)
|
|
(if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*\n")
|
|
end t)
|
|
(progn
|
|
(goto-char (match-end 0))
|
|
(delete-region (point)
|
|
(save-excursion
|
|
(and (re-search-forward "^[ \t]*:END:" nil t)
|
|
(match-beginning 0)))))
|
|
(outline-next-heading)
|
|
(insert " :" drawer ":\n :END:\n")
|
|
(beginning-of-line 0))
|
|
(insert (pp-to-string status)))))
|
|
|
|
(defun org-feed-add-items (pos entries)
|
|
"Add the formatted items to the headline as POS."
|
|
(let (entry level)
|
|
(save-excursion
|
|
(goto-char pos)
|
|
(unless (looking-at org-complex-heading-regexp)
|
|
(error "Wrong position"))
|
|
(setq level (org-get-valid-level (length (match-string 1)) 1))
|
|
(org-end-of-subtree t t)
|
|
(skip-chars-backward " \t\n")
|
|
(beginning-of-line 2)
|
|
(setq pos (point))
|
|
(while (setq entry (pop entries))
|
|
(org-paste-subtree level entry 'yank))
|
|
(org-mark-ring-push pos))))
|
|
|
|
(defun org-feed-format-entry (entry template formatter)
|
|
"Format ENTRY so that it can be inserted into an Org file.
|
|
ENTRY is a property list. This function adds a `:formatted-for-org' property
|
|
and returns the full property list.
|
|
If that property is already present, nothing changes."
|
|
(require 'org-capture)
|
|
(if formatter
|
|
(funcall formatter entry)
|
|
(let (dlines time escape name tmp
|
|
v-h v-t v-T v-u v-U v-a)
|
|
(setq dlines (org-split-string (or (plist-get entry :description) "???")
|
|
"\n")
|
|
v-h (or (plist-get entry :title) (car dlines) "???")
|
|
time (or (if (plist-get entry :pubDate)
|
|
(org-read-date t t (plist-get entry :pubDate)))
|
|
(current-time))
|
|
v-t (format-time-string (org-time-stamp-format nil nil) time)
|
|
v-T (format-time-string (org-time-stamp-format t nil) time)
|
|
v-u (format-time-string (org-time-stamp-format nil t) time)
|
|
v-U (format-time-string (org-time-stamp-format t t) time)
|
|
v-a (if (setq tmp (or (and (plist-get entry :guid-permalink)
|
|
(plist-get entry :guid))
|
|
(plist-get entry :link)))
|
|
(concat "[[" tmp "]]\n")
|
|
""))
|
|
(with-temp-buffer
|
|
(insert template)
|
|
|
|
;; Simple %-escapes
|
|
;; before embedded elisp to support simple %-escapes as
|
|
;; arguments for embedded elisp
|
|
(goto-char (point-min))
|
|
(while (re-search-forward "%\\([a-zA-Z]+\\)" nil t)
|
|
(unless (org-capture-escaped-%)
|
|
(setq name (match-string 1)
|
|
escape (org-capture-inside-embedded-elisp-p))
|
|
(cond
|
|
((member name '("h" "t" "T" "u" "U" "a"))
|
|
(setq tmp (symbol-value (intern (concat "v-" name)))))
|
|
((setq tmp (plist-get entry (intern (concat ":" name))))
|
|
(save-excursion
|
|
(save-match-data
|
|
(beginning-of-line 1)
|
|
(when (looking-at
|
|
(concat "^\\([ \t]*\\)%" name "[ \t]*$"))
|
|
(setq tmp (org-feed-make-indented-block
|
|
tmp (org-get-indentation))))))))
|
|
(when tmp
|
|
;; escape string delimiters `"' when inside %() embedded lisp
|
|
(when escape
|
|
(setq tmp (replace-regexp-in-string "\"" "\\\\\"" tmp)))
|
|
(replace-match tmp t t))))
|
|
|
|
;; %() embedded elisp
|
|
(org-capture-expand-embedded-elisp)
|
|
|
|
(decode-coding-string
|
|
(buffer-string) (detect-coding-region (point-min) (point-max) t))))))
|
|
|
|
(defun org-feed-make-indented-block (s n)
|
|
"Add indentation of N spaces to a multiline string S."
|
|
(if (not (string-match "\n" s))
|
|
s
|
|
(mapconcat 'identity
|
|
(org-split-string s "\n")
|
|
(concat "\n" (make-string n ?\ )))))
|
|
|
|
(defun org-feed-skip-http-headers (buffer)
|
|
"Remove HTTP headers from BUFFER, and return it.
|
|
Assumes headers are indeed present!"
|
|
(with-current-buffer buffer
|
|
(widen)
|
|
(goto-char (point-min))
|
|
(search-forward "\n\n")
|
|
(delete-region (point-min) (point))
|
|
buffer))
|
|
|
|
(defun org-feed-get-feed (url)
|
|
"Get the RSS feed file at URL and return the buffer."
|
|
(cond
|
|
((eq org-feed-retrieve-method 'url-retrieve-synchronously)
|
|
(org-feed-skip-http-headers (url-retrieve-synchronously url)))
|
|
((eq org-feed-retrieve-method 'curl)
|
|
(ignore-errors (kill-buffer org-feed-buffer))
|
|
(call-process "curl" nil org-feed-buffer nil "--silent" url)
|
|
org-feed-buffer)
|
|
((eq org-feed-retrieve-method 'wget)
|
|
(ignore-errors (kill-buffer org-feed-buffer))
|
|
(call-process "wget" nil org-feed-buffer nil "-q" "-O" "-" url)
|
|
org-feed-buffer)
|
|
((functionp org-feed-retrieve-method)
|
|
(funcall org-feed-retrieve-method url))))
|
|
|
|
(defun org-feed-parse-rss-feed (buffer)
|
|
"Parse BUFFER for RSS feed entries.
|
|
Returns a list of entries, with each entry a property list,
|
|
containing the properties `:guid' and `:item-full-text'."
|
|
(let ((case-fold-search t)
|
|
entries beg end item guid entry)
|
|
(with-current-buffer buffer
|
|
(widen)
|
|
(goto-char (point-min))
|
|
(while (re-search-forward "<item\\>.*?>" nil t)
|
|
(setq beg (point)
|
|
end (and (re-search-forward "</item>" nil t)
|
|
(match-beginning 0)))
|
|
(setq item (buffer-substring beg end)
|
|
guid (if (string-match "<guid\\>.*?>\\(.*?\\)</guid>" item)
|
|
(org-match-string-no-properties 1 item)))
|
|
(setq entry (list :guid guid :item-full-text item))
|
|
(push entry entries)
|
|
(widen)
|
|
(goto-char end))
|
|
(nreverse entries))))
|
|
|
|
(defun org-feed-parse-rss-entry (entry)
|
|
"Parse the `:item-full-text' field for xml tags and create new properties."
|
|
(require 'xml)
|
|
(with-temp-buffer
|
|
(insert (plist-get entry :item-full-text))
|
|
(goto-char (point-min))
|
|
(while (re-search-forward "<\\([a-zA-Z]+\\>\\).*?>\\([^\000]*?\\)</\\1>"
|
|
nil t)
|
|
(setq entry (plist-put entry
|
|
(intern (concat ":" (match-string 1)))
|
|
(xml-substitute-special (match-string 2)))))
|
|
(goto-char (point-min))
|
|
(unless (re-search-forward "isPermaLink[ \t]*=[ \t]*\"false\"" nil t)
|
|
(setq entry (plist-put entry :guid-permalink t))))
|
|
entry)
|
|
|
|
(defun org-feed-parse-atom-feed (buffer)
|
|
"Parse BUFFER for Atom feed entries.
|
|
Returns a list of entries, with each entry a property list,
|
|
containing the properties `:guid' and `:item-full-text'.
|
|
|
|
The `:item-full-text' property actually contains the sexp
|
|
formatted as a string, not the original XML data."
|
|
(require 'xml)
|
|
(with-current-buffer buffer
|
|
(widen)
|
|
(let ((feed (car (xml-parse-region (point-min) (point-max)))))
|
|
(mapcar
|
|
(lambda (entry)
|
|
(list
|
|
:guid (car (xml-node-children (car (xml-get-children entry 'id))))
|
|
:item-full-text (prin1-to-string entry)))
|
|
(xml-get-children feed 'entry)))))
|
|
|
|
(defun org-feed-parse-atom-entry (entry)
|
|
"Parse the `:item-full-text' as a sexp and create new properties."
|
|
(let ((xml (car (read-from-string (plist-get entry :item-full-text)))))
|
|
;; Get first <link href='foo'/>.
|
|
(setq entry (plist-put entry :link
|
|
(xml-get-attribute
|
|
(car (xml-get-children xml 'link))
|
|
'href)))
|
|
;; Add <title/> as :title.
|
|
(setq entry (plist-put entry :title
|
|
(xml-substitute-special
|
|
(car (xml-node-children
|
|
(car (xml-get-children xml 'title)))))))
|
|
(let* ((content (car (xml-get-children xml 'content)))
|
|
(type (xml-get-attribute-or-nil content 'type)))
|
|
(when content
|
|
(cond
|
|
((string= type "text")
|
|
;; We like plain text.
|
|
(setq entry (plist-put entry :description
|
|
(xml-substitute-special
|
|
(car (xml-node-children content))))))
|
|
((string= type "html")
|
|
;; TODO: convert HTML to Org markup.
|
|
(setq entry (plist-put entry :description
|
|
(xml-substitute-special
|
|
(car (xml-node-children content))))))
|
|
((string= type "xhtml")
|
|
;; TODO: convert XHTML to Org markup.
|
|
(setq entry (plist-put entry :description
|
|
(prin1-to-string
|
|
(xml-node-children content)))))
|
|
(t
|
|
(setq entry (plist-put entry :description
|
|
(format-message
|
|
"Unknown `%s' content." type)))))))
|
|
entry))
|
|
|
|
(provide 'org-feed)
|
|
|
|
;; Local variables:
|
|
;; generated-autoload-file: "org-loaddefs.el"
|
|
;; End:
|
|
|
|
;;; org-feed.el ends here
|