blob: 0e204b14e6c4df87d1dee9bcea60a4806161e674 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
;;; wiki-utils.el -- wiki utility functions -*- lexical-binding: t -*-
;; Copyright (C) 2023 Free Software Foundation, Inc.
;; Author: Yuchen Pei <id@ypei.org>
;; This file is part of wiki.el.
;; wiki.el is free software: you can redistribute it and/or modify it under
;; the terms of the GNU Affero General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; wiki.el 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 Affero General
;; Public License for more details.
;; You should have received a copy of the GNU Affero General Public
;; License along with wiki.el. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; wiki utility functions.
;;; Code:
(require 'url-parse)
(defvar wiki-local-dir (locate-user-emacs-file "wiki")
"Path to local directory of wiki files.")
(defvar wiki-fetch-prefer-local t
"If non-nil, visit the local file if exists when fetching.")
(defun wiki-fetch-url (url dir &optional callback title)
"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."
(interactive "sURL: ")
(let ((file-name (expand-file-name
(or title (wiki-make-file-name-from-url url))
dir))
(cb (lambda (status file-name)
(wiki-fetch-url-save-and-switch status file-name)
(when callback (funcall callback)))))
(url-retrieve url cb (list file-name)))
)
(defun wiki-fetch-url-save-and-switch (status file-name)
"Fetch url to FILE-NAME if STATUS is ok.
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))
(buffer (find-file-noselect file-name))
(coding-system-for-write 'utf-8))
(kill-buffer)
(with-current-buffer buffer
(insert to-insert)
(goto-char (point-min))
(save-buffer)
(revert-buffer t t))
(switch-to-buffer buffer))
)
(defun wiki-delete-http-header ()
"Delete the http header in current buffer.
Assuming the current buffer to be a `url-retrieve' response buffer."
(delete-region (point-min) (progn (wiki-skip-http-header) (point))))
(defun wiki-skip-http-header ()
"Skip the http header in current buffer.
Assuming the current buffer to be a `url-retrieve' response buffer."
(goto-char (point-min))
(re-search-forward "\r?\n\r?\n"))
(defun wiki-make-file-name-from-url (url)
"Make a file name from URL."
(file-name-nondirectory
(directory-file-name
(car (url-path-and-query (url-generic-parse-url
(url-unhex-string url)))))))
;; TODO: add wikihow; generalise fandom
;; TODO: default engine to mediawiki
(defvar wiki-sites
'((local)
(archwiki :base-url "https://wiki.archlinux.org/title/"
:engine mediawiki
:display-name "ArchWiki")
(debian-wiki :base-url "https://wiki.debian.org/"
:engine moinmoin
:display-name "Debian Wiki")
(emacswiki :base-url "https://www.emacswiki.org/emacs/"
:engine oddmuse
:display-name "EmacsWiki")
(esp :base-url "https://wiki.endsoftwarepatents.org/wiki/"
:engine mediawiki
:display-name "ESP Wiki")
(fandom-recipes :base-url "https://recipes.fandom.com/wiki/"
:engine mediawiki
:display-name "Fandom Recipes Wiki")
(fsd :base-url "https://directory.fsf.org/wiki/"
:engine mediawiki
:display-name "Free Software Directory")
(haskell-wiki :base-url "https://wiki.haskell.org/"
:engine mediawiki
:display-name "Haskell Wiki")
(libreplanet :base-url "https://libreplanet.org/wiki/"
:engine mediawiki
:display-name "Libreplanet Wiki")
(oddmuse :base-url "https://oddmuse.org/wiki/"
:engine oddmuse
:display-name "Oddmuse")
(parabolawiki :base-url "https://wiki.parabola.nu/"
:engine mediawiki
:display-name "ParabolaWiki")
(python-wiki :base-url "https://wiki.python.org/moin/"
:engine moinmoin
:display-name "Python Wiki")
(termux-wiki :base-url "https://wiki.termux.com/wiki/"
:engine mediawiki
:display-name "Termux Wiki")
(ubuntu-wiki :base-url "https://wiki.ubuntu.com/"
:engine moinmoin
:display-name "Ubuntu Wiki")
(ubuntu-community-help-wiki
:base-url "https://help.ubuntu.com/community/"
:engine moinmoin
:display-name "Ubuntu Community Help Wiki")
(wikiindex :base-url "https://wikiindex.org/"
:engine mediawiki
:display-name "WikiIndex")
(wikipedia-en :base-url "https://en.wikipedia.org/wiki/"
:engine mediawiki
:display-name "Wikipedia EN")
(wikipedia-zh :base-url "https://zh.wikipedia.org/wiki/"
:engine mediawiki
:display-name "Wikipedia ZH")
(wikivoyage-en :base-url "https://en.wikivoyage.org/wiki/"
:engine mediawiki
:display-name "Wikivoyage EN")
(wiktionary-en :base-url "https://en.wiktionary.org/wiki/"
:engine mediawiki
:display-name "Wiktionary EN")
)
"Alist of wiki sites.
Each item is in the form of (identifier . properties), where
identifier is a symbol, and properties is a plist of the site.
One of the sites is (local), meaning a local filesystem.")
(defun wiki-site-fetcher (site-id)
"Return the fetcher function for wiki site with SITE-ID."
(if site-id
(intern (format "wiki-%s-fetch" site-id))
'wiki-find-file))
(provide 'wiki-utils)
;;; wiki-utils.el ends here
|
