mirror of
https://github.com/org-roam/org-roam
synced 2025-08-01 12:17:21 -05:00
b2ee5f2c68
* org-roam-protocol.el (org-roam-protocol-open-ref): Replicate default `org-protocol' behaviour temporarily for storing links * org-roam-capture.el (org-roam-capture--capture): Prevent stored link from being reset When capturing a web-page with org-roam-protocol, a link is now temporarily stored in `org-store-link-plist' via `org-link-store-props'. This is to allow the forwarding of properties to `org-capture', one of them being `:initial' which contains the content of the selected text in the browser.
119 lines
4.8 KiB
EmacsLisp
119 lines
4.8 KiB
EmacsLisp
;;; org-roam-protocol.el --- Protocol handler for roam:// links -*- coding: utf-8; lexical-binding: t; -*-
|
|
|
|
;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
|
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
|
;; URL: https://github.com/org-roam/org-roam
|
|
;; Keywords: org-mode, roam, convenience
|
|
;; Version: 1.2.2
|
|
;; Package-Requires: ((emacs "26.1") (org "9.3"))
|
|
|
|
;; This file is NOT part of GNU Emacs.
|
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation; either version 3, or (at your option)
|
|
;; any later version.
|
|
;;
|
|
;; This program 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 General Public License for more details.
|
|
;;
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
;; Boston, MA 02110-1301, USA.
|
|
|
|
;;; Commentary:
|
|
;;
|
|
;; We extend org-protocol, adding custom Org-roam handlers. The setup
|
|
;; instructions for `org-protocol' can be found in org-protocol.el.
|
|
;;
|
|
;; We define 2 protocols:
|
|
;;
|
|
;; 1. "roam-file": This protocol simply opens the file given by the FILE key
|
|
;; 2. "roam-ref": This protocol creates or opens a note with the given REF
|
|
;;
|
|
;;; Code:
|
|
(require 'org-protocol)
|
|
(require 'org-roam)
|
|
(require 'ol) ;; for org-link-decode
|
|
|
|
;;;; Functions
|
|
(defun org-roam-protocol-open-ref (info)
|
|
"Process an org-protocol://roam-ref?ref= style url with INFO.
|
|
|
|
It opens or creates a note with the given ref.
|
|
|
|
javascript:location.href = \\='org-protocol://roam-ref?template=r&ref=\\='+ \\
|
|
encodeURIComponent(location.href) + \\='&title=\\=' \\
|
|
encodeURIComponent(document.title) + \\='&body=\\=' + \\
|
|
encodeURIComponent(window.getSelection())"
|
|
(when-let* ((alist (org-roam--plist-to-alist info))
|
|
(decoded-alist (mapcar (lambda (k.v)
|
|
(let ((key (car k.v))
|
|
(val (cdr k.v)))
|
|
(cons key (org-link-decode val)))) alist)))
|
|
(unless (assoc 'ref decoded-alist)
|
|
(error "No ref key provided"))
|
|
(when-let ((title (cdr (assoc 'title decoded-alist))))
|
|
(push (cons 'slug (funcall org-roam-title-to-slug-function title)) decoded-alist))
|
|
(let* ((parts
|
|
(pcase (org-protocol-parse-parameters info)
|
|
;; New style links are parsed as a plist.
|
|
((let `(,(pred keywordp) . ,_) info) info)
|
|
;; Old style links, with or without template key, are
|
|
;; parsed as a list of strings.
|
|
(p
|
|
(let ((k (if (= 1 (length (car p)))
|
|
'(:template :url :title :body)
|
|
'(:url :title :body))))
|
|
(org-protocol-assign-parameters p k)))))
|
|
(ref (and (plist-get parts :ref)
|
|
(org-protocol-sanitize-uri (plist-get parts :ref))))
|
|
(type (and ref
|
|
(string-match "^\\([a-z]+\\):" ref)
|
|
(match-string 1 ref)))
|
|
(title (or (plist-get parts :title) ""))
|
|
(region (or (plist-get parts :body) ""))
|
|
(orglink
|
|
(if (null ref) title
|
|
(org-link-make-string ref (or (org-string-nw-p title) ref)))))
|
|
(org-link-store-props :type type
|
|
:link ref
|
|
:description title
|
|
:annotation orglink
|
|
:initial region
|
|
:query parts))
|
|
(let* ((org-roam-capture-templates org-roam-capture-ref-templates)
|
|
(org-roam-capture--context 'ref)
|
|
(org-roam-capture--info decoded-alist)
|
|
(template (cdr (assoc 'template decoded-alist))))
|
|
(raise-frame)
|
|
(org-roam-capture--capture nil template)
|
|
(org-roam-message "Item captured.")))
|
|
nil)
|
|
|
|
(defun org-roam-protocol-open-file (info)
|
|
"This handler simply opens the file with emacsclient.
|
|
|
|
INFO is an alist containing additional information passed by the protocol URL.
|
|
It should contain the FILE key, pointing to the path of the file to open.
|
|
|
|
Example protocol string:
|
|
|
|
org-protocol://roam-file?file=/path/to/file.org"
|
|
(when-let ((file (plist-get info :file)))
|
|
(raise-frame)
|
|
(org-roam--find-file file))
|
|
nil)
|
|
|
|
(push '("org-roam-ref" :protocol "roam-ref" :function org-roam-protocol-open-ref)
|
|
org-protocol-protocol-alist)
|
|
(push '("org-roam-file" :protocol "roam-file" :function org-roam-protocol-open-file)
|
|
org-protocol-protocol-alist)
|
|
|
|
(provide 'org-roam-protocol)
|
|
|
|
;;; org-roam-protocol.el ends here
|