lisp/org-protocol.el

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