org-protocol.el 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  1. ;;; org-protocol.el --- Intercept Calls from Emacsclient to Trigger Custom Actions -*- lexical-binding: t; -*-
  2. ;;
  3. ;; Copyright (C) 2008-2019 Free Software Foundation, Inc.
  4. ;;
  5. ;; Authors: Bastien Guerry <bzg@gnu.org>
  6. ;; Daniel M German <dmg AT uvic DOT org>
  7. ;; Sebastian Rose <sebastian_rose AT gmx DOT de>
  8. ;; Ross Patterson <me AT rpatterson DOT net>
  9. ;; Maintainer: Sebastian Rose <sebastian_rose AT gmx DOT de>
  10. ;; Keywords: org, emacsclient, wp
  11. ;; This file is part of GNU Emacs.
  12. ;;
  13. ;; GNU Emacs is free software: you can redistribute it and/or modify
  14. ;; it under the terms of the GNU General Public License as published by
  15. ;; the Free Software Foundation, either version 3 of the License, or
  16. ;; (at your option) any later version.
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. ;; GNU General Public License for more details.
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  23. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Intercept calls from emacsclient to trigger custom actions.
  27. ;;
  28. ;; This is done by advising `server-visit-files' to scan the list of filenames
  29. ;; for `org-protocol-the-protocol' and sub-protocols defined in
  30. ;; `org-protocol-protocol-alist' and `org-protocol-protocol-alist-default'.
  31. ;;
  32. ;; Any application that supports calling external programs with an URL
  33. ;; as argument may be used with this functionality.
  34. ;;
  35. ;;
  36. ;; Usage:
  37. ;; ------
  38. ;;
  39. ;; 1.) Add this to your init file (.emacs probably):
  40. ;;
  41. ;; (add-to-list 'load-path "/path/to/org-protocol/")
  42. ;; (require 'org-protocol)
  43. ;;
  44. ;; 3.) Ensure emacs-server is up and running.
  45. ;; 4.) Try this from the command line (adjust the URL as needed):
  46. ;;
  47. ;; $ emacsclient \
  48. ;; org-protocol://store-link?url=http:%2F%2Flocalhost%2Findex.html&title=The%20title
  49. ;;
  50. ;; 5.) Optionally add custom sub-protocols and handlers:
  51. ;;
  52. ;; (setq org-protocol-protocol-alist
  53. ;; '(("my-protocol"
  54. ;; :protocol "my-protocol"
  55. ;; :function my-protocol-handler-function)))
  56. ;;
  57. ;; A "sub-protocol" will be found in URLs like this:
  58. ;;
  59. ;; org-protocol://sub-protocol?key=val&key2=val2
  60. ;;
  61. ;; If it works, you can now setup other applications for using this feature.
  62. ;;
  63. ;;
  64. ;; As of March 2009 Firefox users follow the steps documented on
  65. ;; http://kb.mozillazine.org/Register_protocol, Opera setup is described here:
  66. ;; http://www.opera.com/support/kb/view/535/
  67. ;;
  68. ;;
  69. ;; Documentation
  70. ;; -------------
  71. ;;
  72. ;; org-protocol.el comes with and installs handlers to open sources of published
  73. ;; online content, store and insert the browser's URLs and cite online content
  74. ;; by clicking on a bookmark in Firefox, Opera and probably other browsers and
  75. ;; applications:
  76. ;;
  77. ;; * `org-protocol-open-source' uses the sub-protocol \"open-source\" and maps
  78. ;; URLs to local filenames defined in `org-protocol-project-alist'.
  79. ;;
  80. ;; * `org-protocol-store-link' stores an Org link (if Org is present) and
  81. ;; pushes the browsers URL to the `kill-ring' for yanking. This handler is
  82. ;; triggered through the sub-protocol \"store-link\".
  83. ;;
  84. ;; * Call `org-protocol-capture' by using the sub-protocol \"capture\". If
  85. ;; Org is loaded, Emacs will pop-up a capture buffer and fill the
  86. ;; template with the data provided. I.e. the browser's URL is inserted as an
  87. ;; Org-link of which the page title will be the description part. If text
  88. ;; was select in the browser, that text will be the body of the entry.
  89. ;;
  90. ;; You may use the same bookmark URL for all those standard handlers and just
  91. ;; adjust the sub-protocol used:
  92. ;;
  93. ;; location.href='org-protocol://sub-protocol?url='+
  94. ;; encodeURIComponent(location.href)+'&title='+
  95. ;; encodeURIComponent(document.title)+'&body='+
  96. ;; encodeURIComponent(window.getSelection())
  97. ;;
  98. ;; The handler for the sub-protocol \"capture\" detects an optional template
  99. ;; char that, if present, triggers the use of a special template.
  100. ;; Example:
  101. ;;
  102. ;; location.href='org-protocol://capture?template=x'+ ...
  103. ;;
  104. ;; uses template ?x.
  105. ;;
  106. ;; Note that using double slashes is optional from org-protocol.el's point of
  107. ;; view because emacsclient squashes the slashes to one.
  108. ;;
  109. ;;
  110. ;; provides: 'org-protocol
  111. ;;
  112. ;;; Code:
  113. (require 'org)
  114. (declare-function org-publish-get-project-from-filename "ox-publish"
  115. (filename &optional up))
  116. (declare-function server-edit "server" (&optional arg))
  117. (defvar org-capture-link-is-already-stored)
  118. (defvar org-capture-templates)
  119. (defgroup org-protocol nil
  120. "Intercept calls from emacsclient to trigger custom actions.
  121. This is done by advising `server-visit-files' to scan the list of filenames
  122. for `org-protocol-the-protocol' and sub-protocols defined in
  123. `org-protocol-protocol-alist' and `org-protocol-protocol-alist-default'."
  124. :version "22.1"
  125. :group 'convenience
  126. :group 'org)
  127. ;;; Variables:
  128. (defconst org-protocol-protocol-alist-default
  129. '(("org-capture" :protocol "capture" :function org-protocol-capture :kill-client t)
  130. ("org-store-link" :protocol "store-link" :function org-protocol-store-link)
  131. ("org-open-source" :protocol "open-source" :function org-protocol-open-source))
  132. "Default protocols to use.
  133. See `org-protocol-protocol-alist' for a description of this variable.")
  134. (defconst org-protocol-the-protocol "org-protocol"
  135. "This is the protocol to detect if org-protocol.el is loaded.
  136. `org-protocol-protocol-alist-default' and `org-protocol-protocol-alist' hold
  137. the sub-protocols that trigger the required action. You will have to define
  138. just one protocol handler OS-wide (MS-Windows) or per application (Linux).
  139. That protocol handler should call emacsclient.")
  140. ;;; User variables:
  141. (defcustom org-protocol-reverse-list-of-files t
  142. "Non-nil means re-reverse the list of filenames passed on the command line.
  143. The filenames passed on the command line are passed to the emacs-server in
  144. reverse order. Set to t (default) to re-reverse the list, i.e. use the
  145. sequence on the command line. If nil, the sequence of the filenames is
  146. unchanged."
  147. :group 'org-protocol
  148. :type 'boolean)
  149. (defcustom org-protocol-project-alist nil
  150. "Map URLs to local filenames for `org-protocol-open-source' (open-source).
  151. Each element of this list must be of the form:
  152. (module-name :property value property: value ...)
  153. where module-name is an arbitrary name. All the values are strings.
  154. Possible properties are:
  155. :online-suffix - the suffix to strip from the published URLs
  156. :working-suffix - the replacement for online-suffix
  157. :base-url - the base URL, e.g. http://www.example.com/project/
  158. Last slash required.
  159. :working-directory - the local working directory. This is, what base-url will
  160. be replaced with.
  161. :redirects - A list of cons cells, each of which maps a regular
  162. expression to match to a path relative to :working-directory.
  163. Example:
  164. (setq org-protocol-project-alist
  165. \\='((\"https://orgmode.org/worg/\"
  166. :online-suffix \".php\"
  167. :working-suffix \".org\"
  168. :base-url \"https://orgmode.org/worg/\"
  169. :working-directory \"/home/user/org/Worg/\")
  170. (\"http://localhost/org-notes/\"
  171. :online-suffix \".html\"
  172. :working-suffix \".org\"
  173. :base-url \"http://localhost/org/\"
  174. :working-directory \"/home/user/org/\"
  175. :rewrites ((\"org/?$\" . \"index.php\")))
  176. (\"Hugo based blog\"
  177. :base-url \"https://www.site.com/\"
  178. :working-directory \"~/site/content/post/\"
  179. :online-suffix \".html\"
  180. :working-suffix \".md\"
  181. :rewrites ((\"\\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\\)\" . \".md\")))))
  182. The last line tells `org-protocol-open-source' to open
  183. /home/user/org/index.php, if the URL cannot be mapped to an existing
  184. file, and ends with either \"org\" or \"org/\".
  185. Consider using the interactive functions `org-protocol-create' and
  186. `org-protocol-create-for-org' to help you filling this variable with valid contents."
  187. :group 'org-protocol
  188. :type 'alist)
  189. (defcustom org-protocol-protocol-alist nil
  190. "Register custom handlers for org-protocol.
  191. Each element of this list must be of the form:
  192. (module-name :protocol protocol :function func :kill-client nil)
  193. protocol - protocol to detect in a filename without trailing
  194. colon and slashes. See rfc1738 section 2.1 for more
  195. on this. If you define a protocol \"my-protocol\",
  196. `org-protocol-check-filename-for-protocol' will search
  197. filenames for \"org-protocol:/my-protocol\" and
  198. trigger your action for every match. `org-protocol'
  199. is defined in `org-protocol-the-protocol'. Double and
  200. triple slashes are compressed to one by emacsclient.
  201. function - function that handles requests with protocol and takes
  202. one argument. If a new-style link (key=val&key2=val2)
  203. is given, the argument will be a property list with
  204. the values from the link. If an old-style link is
  205. given (val1/val2), the argument will be the filename
  206. with all protocols stripped.
  207. If the function returns nil, emacsclient and -server
  208. do nothing. Any non-nil return value is considered a
  209. valid filename and thus passed to the server.
  210. `org-protocol.el' provides some support for handling
  211. old-style filenames, if you follow the conventions
  212. used for the standard handlers in
  213. `org-protocol-protocol-alist-default'. See
  214. `org-protocol-parse-parameters'.
  215. kill-client - If t, kill the client immediately, once the sub-protocol is
  216. detected. This is necessary for actions that can be interrupted by
  217. `C-g' to avoid dangling emacsclients. Note that all other command
  218. line arguments but the this one will be discarded. Greedy handlers
  219. still receive the whole list of arguments though.
  220. Here is an example:
  221. (setq org-protocol-protocol-alist
  222. \\='((\"my-protocol\"
  223. :protocol \"my-protocol\"
  224. :function my-protocol-handler-function)
  225. (\"your-protocol\"
  226. :protocol \"your-protocol\"
  227. :function your-protocol-handler-function)))"
  228. :group 'org-protocol
  229. :type '(alist))
  230. (defcustom org-protocol-default-template-key nil
  231. "The default template key to use.
  232. This is usually a single character string but can also be a
  233. string with two characters."
  234. :group 'org-protocol
  235. :type '(choice (const nil) (string)))
  236. (defcustom org-protocol-data-separator "/+\\|\\?"
  237. "The default data separator to use.
  238. This should be a single regexp string."
  239. :group 'org-protocol
  240. :version "24.4"
  241. :package-version '(Org . "8.0")
  242. :type 'string)
  243. ;;; Helper functions:
  244. (defun org-protocol-sanitize-uri (uri)
  245. "Sanitize slashes to double-slashes in URI.
  246. Emacsclient compresses double and triple slashes."
  247. (when (string-match "^\\([a-z]+\\):/" uri)
  248. (let* ((splitparts (split-string uri "/+")))
  249. (setq uri (concat (car splitparts) "//" (mapconcat 'identity (cdr splitparts) "/")))))
  250. uri)
  251. (defun org-protocol-split-data (data &optional unhexify separator)
  252. "Split the DATA argument for an org-protocol handler function.
  253. If UNHEXIFY is non-nil, hex-decode each split part. If UNHEXIFY
  254. is a function, use that function to decode each split part. The
  255. string is split at each occurrence of SEPARATOR (regexp). If no
  256. SEPARATOR is specified or SEPARATOR is nil, assume \"/+\". The
  257. results of that splitting are returned as a list."
  258. (let* ((sep (or separator "/+\\|\\?"))
  259. (split-parts (split-string data sep)))
  260. (if unhexify
  261. (if (fboundp unhexify)
  262. (mapcar unhexify split-parts)
  263. (mapcar 'org-link-unescape split-parts))
  264. split-parts)))
  265. (defun org-protocol-flatten-greedy (param-list &optional strip-path replacement)
  266. "Transform PARAM-LIST into a flat list for greedy handlers.
  267. Greedy handlers might receive a list like this from emacsclient:
  268. \((\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\"))
  269. where \"/dir/\" is the absolute path to emacsclient's working directory. This
  270. function transforms it into a flat list using `org-protocol-flatten' and
  271. transforms the elements of that list as follows:
  272. If STRIP-PATH is non-nil, remove the \"/dir/\" prefix from all members of
  273. param-list.
  274. If REPLACEMENT is string, replace the \"/dir/\" prefix with it.
  275. The first parameter, the one that contains the protocols, is always changed.
  276. Everything up to the end of the protocols is stripped.
  277. Note, that this function will always behave as if
  278. `org-protocol-reverse-list-of-files' was set to t and the returned list will
  279. reflect that. emacsclient's first parameter will be the first one in the
  280. returned list."
  281. (let* ((l (org-protocol-flatten (if org-protocol-reverse-list-of-files
  282. param-list
  283. (reverse param-list))))
  284. (trigger (car l))
  285. (len 0)
  286. dir
  287. ret)
  288. (when (string-match "^\\(.*\\)\\(org-protocol:/+[a-zA-z0-9][-_a-zA-z0-9]*:/+\\)\\(.*\\)" trigger)
  289. (setq dir (match-string 1 trigger))
  290. (setq len (length dir))
  291. (setcar l (concat dir (match-string 3 trigger))))
  292. (if strip-path
  293. (progn
  294. (dolist (e l ret)
  295. (setq ret
  296. (append ret
  297. (list
  298. (if (stringp e)
  299. (if (stringp replacement)
  300. (setq e (concat replacement (substring e len)))
  301. (setq e (substring e len)))
  302. e)))))
  303. ret)
  304. l)))
  305. (defalias 'org-protocol-flatten
  306. (if (fboundp 'flatten-tree) 'flatten-tree
  307. (lambda (list)
  308. "Transform LIST into a flat list.
  309. Greedy handlers might receive a list like this from emacsclient:
  310. \((\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\"))
  311. where \"/dir/\" is the absolute path to emacsclients working directory.
  312. This function transforms it into a flat list."
  313. (if list
  314. (if (consp list)
  315. (append (org-protocol-flatten (car list))
  316. (org-protocol-flatten (cdr list)))
  317. (list list))))))
  318. (defun org-protocol-parse-parameters (info &optional new-style default-order)
  319. "Return a property list of parameters from INFO.
  320. If NEW-STYLE is non-nil, treat INFO as a query string (ex:
  321. url=URL&title=TITLE). If old-style links are used (ex:
  322. org-protocol://store-link/url/title), assign them to attributes
  323. following DEFAULT-ORDER.
  324. If no DEFAULT-ORDER is specified, return the list of values.
  325. If INFO is already a property list, return it unchanged."
  326. (if (listp info)
  327. info
  328. (if new-style
  329. (let ((data (org-protocol-convert-query-to-plist info))
  330. result)
  331. (while data
  332. (setq result
  333. (append
  334. result
  335. (list
  336. (pop data)
  337. (org-link-unescape (pop data))))))
  338. result)
  339. (let ((data (org-protocol-split-data info t org-protocol-data-separator)))
  340. (if default-order
  341. (org-protocol-assign-parameters data default-order)
  342. data)))))
  343. (defun org-protocol-assign-parameters (data default-order)
  344. "Return a property list of parameters from DATA.
  345. Key names are taken from DEFAULT-ORDER, which should be a list of
  346. symbols. If DEFAULT-ORDER is shorter than the number of values
  347. specified, the rest of the values are treated as :key value pairs."
  348. (let (result)
  349. (while default-order
  350. (setq result
  351. (append result
  352. (list (pop default-order)
  353. (pop data)))))
  354. (while data
  355. (setq result
  356. (append result
  357. (list (intern (concat ":" (pop data)))
  358. (pop data)))))
  359. result))
  360. ;;; Standard protocol handlers:
  361. (defun org-protocol-store-link (fname)
  362. "Process an org-protocol://store-link style url.
  363. Additionally store a browser URL as an org link. Also pushes the
  364. link's URL to the `kill-ring'.
  365. Parameters: url, title (optional), body (optional)
  366. Old-style links such as org-protocol://store-link://URL/TITLE are
  367. also recognized.
  368. The location for a browser's bookmark has to look like this:
  369. javascript:location.href = \\
  370. \\='org-protocol://store-link?url=\\=' + \\
  371. encodeURIComponent(location.href) + \\='&title=\\=' + \\
  372. encodeURIComponent(document.title);
  373. Don't use `escape()'! Use `encodeURIComponent()' instead. The
  374. title of the page could contain slashes and the location
  375. definitely will.
  376. The sub-protocol used to reach this function is set in
  377. `org-protocol-protocol-alist'.
  378. FNAME should be a property list. If not, an old-style link of the
  379. form URL/TITLE can also be used."
  380. (let* ((splitparts (org-protocol-parse-parameters fname nil '(:url :title)))
  381. (uri (org-protocol-sanitize-uri (plist-get splitparts :url)))
  382. (title (plist-get splitparts :title)))
  383. (when (boundp 'org-stored-links)
  384. (push (list uri title) org-stored-links))
  385. (kill-new uri)
  386. (message "`%s' to insert new org-link, `%s' to insert `%s'"
  387. (substitute-command-keys "`\\[org-insert-link]'")
  388. (substitute-command-keys "`\\[yank]'")
  389. uri))
  390. nil)
  391. (defun org-protocol-capture (info)
  392. "Process an org-protocol://capture style url with INFO.
  393. The sub-protocol used to reach this function is set in
  394. `org-protocol-protocol-alist'.
  395. This function detects an URL, title and optional text, separated
  396. by `/'. The location for a browser's bookmark looks like this:
  397. javascript:location.href = \\='org-protocol://capture?url=\\='+ \\
  398. encodeURIComponent(location.href) + \\='&title=\\=' \\
  399. encodeURIComponent(document.title) + \\='&body=\\=' + \\
  400. encodeURIComponent(window.getSelection())
  401. By default, it uses the character `org-protocol-default-template-key',
  402. which should be associated with a template in `org-capture-templates'.
  403. You may specify the template with a template= query parameter, like this:
  404. javascript:location.href = \\='org-protocol://capture?template=b\\='+ ...
  405. Now template ?b will be used."
  406. (let* ((parts
  407. (pcase (org-protocol-parse-parameters info)
  408. ;; New style links are parsed as a plist.
  409. ((let `(,(pred keywordp) . ,_) info) info)
  410. ;; Old style links, with or without template key, are
  411. ;; parsed as a list of strings.
  412. (p
  413. (let ((k (if (= 1 (length (car p)))
  414. '(:template :url :title :body)
  415. '(:url :title :body))))
  416. (org-protocol-assign-parameters p k)))))
  417. (template (or (plist-get parts :template)
  418. org-protocol-default-template-key))
  419. (url (and (plist-get parts :url)
  420. (org-protocol-sanitize-uri (plist-get parts :url))))
  421. (type (and url
  422. (string-match "^\\([a-z]+\\):" url)
  423. (match-string 1 url)))
  424. (title (or (plist-get parts :title) ""))
  425. (region (or (plist-get parts :body) ""))
  426. (orglink
  427. (if (null url) title
  428. (org-make-link-string url (or (org-string-nw-p title) url))))
  429. ;; Avoid call to `org-store-link'.
  430. (org-capture-link-is-already-stored t))
  431. ;; Only store link if there's a URL to insert later on.
  432. (when url (push (list url title) org-stored-links))
  433. (org-store-link-props :type type
  434. :link url
  435. :description title
  436. :annotation orglink
  437. :initial region
  438. :query parts)
  439. (raise-frame)
  440. (org-capture nil template)
  441. (message "Item captured.")
  442. ;; Make sure we do not return a string, as `server-visit-files',
  443. ;; through `server-edit', would interpret it as a file name.
  444. nil))
  445. (defun org-protocol-convert-query-to-plist (query)
  446. "Convert QUERY key=value pairs in the URL to a property list."
  447. (when query
  448. (apply 'append (mapcar (lambda (x)
  449. (let ((c (split-string x "=")))
  450. (list (intern (concat ":" (car c))) (cadr c))))
  451. (split-string query "&")))))
  452. (defun org-protocol-open-source (fname)
  453. "Process an org-protocol://open-source?url= style URL with FNAME.
  454. Change a filename by mapping URLs to local filenames as set
  455. in `org-protocol-project-alist'.
  456. The location for a browser's bookmark should look like this:
  457. javascript:location.href = \\='org-protocol://open-source?url=\\=' + \\
  458. encodeURIComponent(location.href)"
  459. ;; As we enter this function for a match on our protocol, the return value
  460. ;; defaults to nil.
  461. (let ((result nil)
  462. (f (org-protocol-sanitize-uri
  463. (plist-get (org-protocol-parse-parameters fname nil '(:url))
  464. :url))))
  465. (catch 'result
  466. (dolist (prolist org-protocol-project-alist)
  467. (let* ((base-url (plist-get (cdr prolist) :base-url))
  468. (wsearch (regexp-quote base-url)))
  469. (when (string-match wsearch f)
  470. (let* ((wdir (plist-get (cdr prolist) :working-directory))
  471. (strip-suffix (plist-get (cdr prolist) :online-suffix))
  472. (add-suffix (plist-get (cdr prolist) :working-suffix))
  473. ;; Strip "[?#].*$" if `f' is a redirect with another
  474. ;; ending than strip-suffix here:
  475. (f1 (substring f 0 (string-match "\\([\\?#].*\\)?$" f)))
  476. (start-pos (+ (string-match wsearch f1) (length base-url)))
  477. (end-pos (string-match
  478. (regexp-quote strip-suffix) f1))
  479. ;; We have to compare redirects without suffix below:
  480. (f2 (concat wdir (substring f1 start-pos end-pos)))
  481. (the-file (concat f2 add-suffix)))
  482. ;; Note: the-file may still contain `%C3' et al here because browsers
  483. ;; tend to encode `&auml;' in URLs to `%25C3' - `%25' being `%'.
  484. ;; So the results may vary.
  485. ;; -- start redirects --
  486. (unless (file-exists-p the-file)
  487. (message "File %s does not exist.\nTesting for rewritten URLs." the-file)
  488. (let ((rewrites (plist-get (cdr prolist) :rewrites)))
  489. (when rewrites
  490. (message "Rewrites found: %S" rewrites)
  491. (dolist (rewrite rewrites)
  492. ;; Try to match a rewritten URL and map it to
  493. ;; a real file. Compare redirects without
  494. ;; suffix.
  495. (when (string-match (car rewrite) f1)
  496. (let ((replacement
  497. (concat (directory-file-name
  498. (replace-match "" nil nil f1 1))
  499. (cdr rewrite))))
  500. (throw 'result (concat wdir replacement))))))))
  501. ;; -- end of redirects --
  502. (if (file-readable-p the-file)
  503. (throw 'result the-file))
  504. (if (file-exists-p the-file)
  505. (message "%s: permission denied!" the-file)
  506. (message "%s: no such file or directory." the-file))))))
  507. result)))
  508. ;;; Core functions:
  509. (defun org-protocol-check-filename-for-protocol (fname restoffiles _client)
  510. "Check if `org-protocol-the-protocol' and a valid protocol are used in FNAME.
  511. Sub-protocols are registered in `org-protocol-protocol-alist' and
  512. `org-protocol-protocol-alist-default'. This is how the matching is done:
  513. (string-match \"protocol:/+sub-protocol\\\\(://\\\\|\\\\?\\\\)\" ...)
  514. protocol and sub-protocol are regexp-quoted.
  515. Old-style links such as \"protocol://sub-protocol://param1/param2\" are
  516. also recognized.
  517. If a matching protocol is found, the protocol is stripped from
  518. fname and the result is passed to the protocol function as the
  519. first parameter. The second parameter will be non-nil if FNAME
  520. uses key=val&key2=val2-type arguments, or nil if FNAME uses
  521. val/val2-type arguments. If the function returns nil, the
  522. filename is removed from the list of filenames passed from
  523. emacsclient to the server. If the function returns a non-nil
  524. value, that value is passed to the server as filename.
  525. If the handler function is greedy, RESTOFFILES will also be passed to it.
  526. CLIENT is ignored."
  527. (let ((sub-protocols (append org-protocol-protocol-alist
  528. org-protocol-protocol-alist-default)))
  529. (catch 'fname
  530. (let ((the-protocol (concat (regexp-quote org-protocol-the-protocol)
  531. ":/+")))
  532. (when (string-match the-protocol fname)
  533. (dolist (prolist sub-protocols)
  534. (let ((proto
  535. (concat the-protocol
  536. (regexp-quote (plist-get (cdr prolist) :protocol))
  537. "\\(:/+\\|\\?\\)")))
  538. (when (string-match proto fname)
  539. (let* ((func (plist-get (cdr prolist) :function))
  540. (greedy (plist-get (cdr prolist) :greedy))
  541. (split (split-string fname proto))
  542. (result (if greedy restoffiles (cadr split)))
  543. (new-style (string= (match-string 1 fname) "?")))
  544. (when (plist-get (cdr prolist) :kill-client)
  545. (message "Greedy org-protocol handler. Killing client.")
  546. (server-edit))
  547. (when (fboundp func)
  548. (unless greedy
  549. (throw 'fname
  550. (if new-style
  551. (funcall func (org-protocol-parse-parameters
  552. result new-style))
  553. (warn "Please update your Org Protocol handler \
  554. to deal with new-style links.")
  555. (funcall func result))))
  556. ;; Greedy protocol handlers are responsible for
  557. ;; parsing their own filenames.
  558. (funcall func result)
  559. (throw 'fname t))))))))
  560. fname)))
  561. (defadvice server-visit-files (before org-protocol-detect-protocol-server activate)
  562. "Advice server-visit-flist to call `org-protocol-modify-filename-for-protocol'."
  563. (let ((flist (if org-protocol-reverse-list-of-files
  564. (reverse (ad-get-arg 0))
  565. (ad-get-arg 0)))
  566. (client (ad-get-arg 1)))
  567. (catch 'greedy
  568. (dolist (var flist)
  569. ;; `\' to `/' on windows. FIXME: could this be done any better?
  570. (let ((fname (expand-file-name (car var))))
  571. (setq fname (org-protocol-check-filename-for-protocol
  572. fname (member var flist) client))
  573. (if (eq fname t) ;; greedy? We need the t return value.
  574. (progn
  575. (ad-set-arg 0 nil)
  576. (throw 'greedy t))
  577. (if (stringp fname) ;; probably filename
  578. (setcar var fname)
  579. (ad-set-arg 0 (delq var (ad-get-arg 0))))))))))
  580. ;;; Org specific functions:
  581. (defun org-protocol-create-for-org ()
  582. "Create an Org protocol project for the current file's project.
  583. The visited file needs to be part of a publishing project in
  584. `org-publish-project-alist' for this to work. The function
  585. delegates most of the work to `org-protocol-create'."
  586. (interactive)
  587. (require 'ox-publish)
  588. (let ((all (or (org-publish-get-project-from-filename buffer-file-name))))
  589. (if all (org-protocol-create (cdr all))
  590. (message "%s"
  591. (substitute-command-keys
  592. "Not in an Org project. \
  593. Did you mean `\\[org-protocol-create]'?")))))
  594. (defun org-protocol-create (&optional project-plist)
  595. "Create a new org-protocol project interactively.
  596. An org-protocol project is an entry in
  597. `org-protocol-project-alist' which is used by
  598. `org-protocol-open-source'. Optionally use PROJECT-PLIST to
  599. initialize the defaults for this project. If PROJECT-PLIST is
  600. the cdr of an element in `org-publish-project-alist', reuse
  601. :base-directory, :html-extension and :base-extension."
  602. (interactive)
  603. (let ((working-dir (expand-file-name
  604. (or (plist-get project-plist :base-directory)
  605. default-directory)))
  606. (base-url "https://orgmode.org/worg/")
  607. (strip-suffix (or (plist-get project-plist :html-extension) ".html"))
  608. (working-suffix (if (plist-get project-plist :base-extension)
  609. (concat "." (plist-get project-plist :base-extension))
  610. ".org"))
  611. (insert-default-directory t)
  612. (minibuffer-allow-text-properties nil))
  613. (setq base-url (read-string "Base URL of published content: " base-url nil base-url t))
  614. (or (string-suffix-p "/" base-url)
  615. (setq base-url (concat base-url "/")))
  616. (setq working-dir
  617. (expand-file-name
  618. (read-directory-name "Local working directory: " working-dir working-dir t)))
  619. (or (string-suffix-p "/" working-dir)
  620. (setq working-dir (concat working-dir "/")))
  621. (setq strip-suffix
  622. (read-string
  623. (concat "Extension to strip from published URLs (" strip-suffix "): ")
  624. strip-suffix nil strip-suffix t))
  625. (setq working-suffix
  626. (read-string
  627. (concat "Extension of editable files (" working-suffix "): ")
  628. working-suffix nil working-suffix t))
  629. (when (yes-or-no-p "Save the new org-protocol-project to your init file? ")
  630. (setq org-protocol-project-alist
  631. (cons `(,base-url . (:base-url ,base-url
  632. :working-directory ,working-dir
  633. :online-suffix ,strip-suffix
  634. :working-suffix ,working-suffix))
  635. org-protocol-project-alist))
  636. (customize-save-variable 'org-protocol-project-alist org-protocol-project-alist))))
  637. (provide 'org-protocol)
  638. ;;; org-protocol.el ends here