From f2d3c6ca51bfbf7620ddde9faf83ec5fd973abf5 Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Sun, 23 Jul 2023 23:05:13 +1000 Subject: Add a mediawiki API fetcher. Applicable to wikihow. Also clean up the code to reduce duplication with fetching and finding files. And fix when the wiki entry is under a directory naming itself which is common in mediawiki: both foo and foo/bar could be a valid wiki title. So locally files need to have an extension (by default .wiki). Also add the extension to auto-mode-alist. --- wiki-engine.el | 189 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 104 insertions(+), 85 deletions(-) (limited to 'wiki-engine.el') diff --git a/wiki-engine.el b/wiki-engine.el index c4de2e7..8f666ef 100644 --- a/wiki-engine.el +++ b/wiki-engine.el @@ -40,6 +40,39 @@ (error "Nil wiki-site or wiki-title!")) (wiki-engine-html-url wiki-site wiki-title)) +(defun wiki-fetch-url (url title &optional dir callback) + "Fetch URL asynchronously to a file in DIR. + +Then call CALLBACK which is a closure taking no argument. + +A non-nil TITLE overrides title inferred from the url." + (let ((cb (lambda (status) + (wiki-save-fetched-and-switch status title dir) + (when callback (funcall callback))))) + (url-retrieve url cb)) + ) + +(defun wiki-save-string-and-switch (to-insert title dir) + "Insert string TO-INSERT to TITLE under DIR and switch to buffer." + (let ((buffer (wiki-find-file title dir t)) + (coding-system-for-write 'utf-8)) + (with-current-buffer buffer + (insert to-insert) + (goto-char (point-min)) + (save-buffer) + (revert-buffer t t)) + (switch-to-buffer buffer))) + +(defun wiki-save-fetched-and-switch (status title dir) + "If STATUS is ok, insert response payload to TITLE under DIR. + +And switch to the corresponding buffer." + (when (plist-get status :error) + (error "Wiki fetch failed: %s" (plist-get status :error))) + (wiki-delete-http-header) + (let ((to-insert (buffer-string)) + (_ (kill-buffer))) + (wiki-save-string-and-switch to-insert title dir))) (defun wiki-engine-wiki-url (site title) "Construct the url to fetch wiki of TITLE from SITE." @@ -52,102 +85,86 @@ ('oddmuse (format "%s?action=download;id=%s" base-url title)) (_ (error "Unknown engine: %s" engine))))) -(defun wiki-engine-mediawiki-fetch (site-id title) - "Fetch a mediawiki entry describing TITLE. - -The site handle is passed as a symbol SITE-ID." - (let ((wiki-site-info (alist-get site-id wiki-sites))) - (cl-assert (eq (plist-get wiki-site-info :engine) 'mediawiki)) - (when (string-empty-p title) (setq title "Main Page")) - (unless (and wiki-fetch-prefer-local - (wiki-find-file - title - (wiki-locate-dir site-id))) - (wiki-fetch-url - (format "%s%s?action=raw" - (plist-get wiki-site-info :base-url) - title) - (wiki-locate-dir site-id) - (lambda () - (wiki-mode) - (setq-local wiki-site site-id - wiki-title title) - ) - )))) - -(defun wiki-engine-oddmuse-fetch (site-id title) - "Fetch an oddmuse entry describing TITLE. - -The site handle is passed as a symbol SITE-ID." - (let ((wiki-site-info (alist-get site-id wiki-sites))) - (cl-assert (eq (plist-get wiki-site-info :engine) 'oddmuse)) - (unless (and wiki-fetch-prefer-local - (wiki-find-file - title - (wiki-locate-dir site-id))) +(defun wiki-engine-simple-fetch (site-id title) + "A simple method to fetch TITLE from site with SITE-ID. + +If the site has a `local' engine, \"fetch\" locally. Otherwise, +if `wiki-fetch-prefer-local' is non-nil, try fetching locally, +and if the title cannot be found locally, fetch remotely." + (when (string-empty-p title) (setq title "Main Page")) + (let* ((engine (plist-get (alist-get site-id wiki-sites) :engine)) + (found-local + (when (or wiki-fetch-prefer-local (eq engine 'local)) + (wiki-find-file title (wiki-locate-dir site-id) + (eq engine 'local))))) + (if found-local + (switch-to-buffer found-local) (wiki-fetch-url - (format "%s?action=download;id=%s" - (plist-get wiki-site-info :base-url) - title) + (wiki-engine-wiki-url site-id title) + title (wiki-locate-dir site-id) (lambda () (wiki-mode) (setq-local wiki-site site-id - wiki-title title) - ) - title)))) - -(defun wiki-engine-moinmoin-fetch (site-id title) - "Fetch a moinmoin entry describing TITLE. - -The site handle is passed as a symbol SITE-ID." - (let ((wiki-site-info (alist-get site-id wiki-sites))) - (cl-assert (eq (plist-get wiki-site-info :engine) 'moinmoin)) - (unless (and wiki-fetch-prefer-local - (wiki-find-file - title - (wiki-locate-dir site-id))) - (wiki-fetch-url - (format "%s%s?action=raw" - (plist-get wiki-site-info :base-url) - title) - (wiki-locate-dir site-id) - (lambda () - (wiki-mode) - (setq-local wiki-site site-id - wiki-title title)) - title)))) + wiki-title title)))))) + +(defun wiki-engine-mediawiki-api-fetch (site-id title) + "Fetch TITLE from site with SITE-ID using mediawiki api." + (when (string-empty-p title) (setq title "Main Page")) + (let* ((engine (plist-get (alist-get site-id wiki-sites) :engine)) + (base-url (plist-get (alist-get site-id wiki-sites) :base-url)) + (found-local + (when (or wiki-fetch-prefer-local (eq engine 'local)) + (wiki-find-file title (wiki-locate-dir site-id) + (eq engine 'local))))) + (if found-local + (switch-to-buffer found-local) + (wiki-save-string-and-switch + (alist-get + '* (alist-get + 'main (alist-get + 'slots (elt + (alist-get + 'revisions + (cdr + (car + (alist-get + 'pages (alist-get + 'query + (wiki-url-fetch-json + (format + "%sapi.php?action=query&titles=%s&prop=revisions&rvprop=content&rvslots=main&format=json" + base-url + title) + )))))) + 0)))) + title + (wiki-locate-dir site-id)) + (wiki-mode) + (setq-local wiki-site site-id + wiki-title title)))) (defun wiki-locate-dir (site-id) "Locate the directory for a SITE-ID." (expand-file-name (format "%s" site-id) wiki-local-dir)) -(defun wiki-find-file (title &optional dir create-if-not-exists - extension) - "Find local TITLE in DIR. +(defun wiki-find-file (title &optional dir create-if-not-exists) + "Find local TITLE in DIR. Do not switch to buffer. -Returns the file-name if success, and nil otherwise. If +Return the buffer if success, and nil otherwise. If CREATE-IF-NOT-EXISTS is non-nil, creates the file is not found. -DIR defaults to `default-directory'. -EXTENSION is the file extension." +DIR defaults to `default-directory'." (interactive (list (read-file-name "Find wiki file: "))) (unless dir (setq dir default-directory)) (let ((file-name (expand-file-name - (if extension - (file-name-extension title extension) - title) + (concat title wiki-extension) dir))) (when (or (file-exists-p file-name) create-if-not-exists) - (find-file file-name) - (wiki-mode) - file-name))) - -(defalias #'wiki-local-fetch #'wiki-find-file) - -(defun wiki-engine-fetcher (wiki-site-info) - "Return the fetcher for the engine of WIKI-SITE-INFO." - (intern (format "wiki-engine-%s-fetch" - (plist-get wiki-site-info :engine)))) + (setq dir (file-name-directory file-name)) + (unless (file-exists-p dir) (make-directory dir t)) + (with-current-buffer (find-file-noselect file-name) + (wiki-mode) + (buffer-name))))) (defmacro defun-wiki-fetchers () "Defines all wiki fetcher functions." @@ -155,12 +172,14 @@ EXTENSION is the file extension." (mapcar (lambda (pair) (pcase-let ((`(,id . ,info) pair)) - `(defun ,(wiki-site-fetcher id) (title) - (interactive ,(format "sFetch title for %s: " - (plist-get info :display-name))) - (,(wiki-engine-fetcher info) ',id title)))) - (seq-filter #'cdr - wiki-sites) + (let ((engine-fetcher + (or (plist-get info :fetcher) + 'wiki-engine-simple-fetch))) + `(defun ,(wiki-site-fetcher id) (title) + (interactive ,(format "sFetch title for %s: " + (plist-get info :display-name))) + (,engine-fetcher ',id title))))) + (seq-filter #'cdr wiki-sites) ))) (defun-wiki-fetchers) -- cgit v1.2.3