org-protocol.el 26 KB

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