[elpa] externals/org 09dc3fa 83/85: org-protocol.el: decode "+" in query part as space

[ELPA Syncer]

branch: externals/org
commit 09dc3fa3044df640dc26c52f2de309911f83b509
Author: Max Nikulin <manikulin@gmail.com>
Commit: Bastien <bzg@gnu.org>

    org-protocol.el: decode "+" in query part as space
    
    * lisp/org-protocol.el (org-protocol-convert-query-to-plist):
    Replace "+" chars by spaces before passing parameter string
    to decoder.  Allow making org-protocol URIs with help of URLSearchParams
    JavaScript class.
    * lisp/org-protocol.el doc/org-manual.org etc/ORG-NEWS: Add examples
    demonstrating new opportunity for browser bookmarklets.
    
    Make parsing of URI parameters a bit closer to URL standard
    https://url.spec.whatwg.org/#urlencoded-parsing
---
 doc/org-manual.org   | 22 ++++++++++++++++++++++
 etc/ORG-NEWS         | 11 +++++++++++
 lisp/org-protocol.el | 48 ++++++++++++++++++++++++++++++++++++++++++------
 3 files changed, 75 insertions(+), 6 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index adf9c13..96f5561 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -19784,10 +19784,19 @@ To use this feature from a browser, add a bookmark 
with an arbitrary
 name, e.g., =Org: store-link= and enter this as /Location/:
 
 #+begin_example
+javascript:location.href='org-protocol://store-link?' +
+      new URLSearchParams({url:location.href, title:document.title});
+#+end_example
+
+Title is an optional parameter.  Another expression was recommended earlier:
+
+#+begin_example
 javascript:location.href='org-protocol://store-link?url='+
       encodeURIComponent(location.href);
 #+end_example
 
+The latter form is compatible with older Org versions from 9.0 to 9.4.
+
 *** The ~capture~ protocol
 :PROPERTIES:
 :DESCRIPTION: Fill a buffer with external information.
@@ -19804,12 +19813,25 @@ To use this feature, add a bookmark with an arbitrary 
name, e.g.,
 =Org: capture=, and enter this as =Location=:
 
 #+begin_example
+javascript:location.href='org-protocol://capture?' +
+      new URLSearchParams({
+            template: 'x', url: window.location.href,
+            title: document.title, body: window.getSelection()});
+#+end_example
+
+You might have seen another expression:
+
+#+begin_example
 javascript:location.href='org-protocol://capture?template=x'+
       '&url='+encodeURIComponent(window.location.href)+
       '&title='+encodeURIComponent(document.title)+
       '&body='+encodeURIComponent(window.getSelection());
 #+end_example
 
+It is a bit more cluttered than the former one, but it is compatible with
+previous Org versions 9.0-9.4. In these versions encoding of space as "+"
+character was not supported by URI decoder.
+
 #+vindex: org-protocol-default-template-key
 The capture template to be used can be specified in the bookmark (like
 =X= above).  If unspecified, the template key is set in the variable
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 53915d8..9d19a81 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -517,6 +517,17 @@ Use =org-get-previous-sibling= instead.  This is just a 
rename to have
 a more consistent naming.  E.g. recall the pair of funtctions
 =next-line= / =previous-line=.
 
+*** Make org-protocol compatible with =URLSearchParams= JavaScript class
+
+Decoder of query part of org-protocol URI recognizes "+" as an encoded
+space characters now, so it is possible to avoid call to =encodeURIComponent=
+for each parameter and use more readable expression in bookmarklet:
+
+#+begin_example
+'org-protocol://store-link?' + new URLSearchParams({
+      url: location.href, title: document.title})
+#+end_example
+
 * Version 9.4
 ** Incompatible changes
 *** Possibly broken internal file links: please check and fix
diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
index e4578d4..703d0d7 100644
--- a/lisp/org-protocol.el
+++ b/lisp/org-protocol.el
@@ -94,6 +94,15 @@
 ;; You may use the same bookmark URL for all those standard handlers and just
 ;; adjust the sub-protocol used:
 ;;
+;;     javascript:location.href='org-protocol://sub-protocol?'+
+;;           new URLSearchParams({
+;;                 url: location.href,
+;;                 title: document.title,
+;;                 body: window.getSelection()})
+;;
+;; Alternatively use the following expression that encodes space as \"%20\"
+;; instead of \"+\", so it is compatible with Org versions from 9.0 to 9.4:
+;;
 ;;     location.href='org-protocol://sub-protocol?url='+
 ;;           encodeURIComponent(location.href)+'&title='+
 ;;           encodeURIComponent(document.title)+'&body='+
@@ -103,6 +112,11 @@
 ;; char that, if present, triggers the use of a special template.
 ;; Example:
 ;;
+;;     location.href='org-protocol://capture?'+
+;;           new URLSearchParams({template:'x', /* ... */})
+;;
+;; or
+;;
 ;;     location.href='org-protocol://capture?template=x'+ ...
 ;;
 ;;  uses template ?x.
@@ -427,7 +441,12 @@ Parameters: url, title (optional), body (optional)
 Old-style links such as org-protocol://store-link://URL/TITLE are
 also recognized.
 
-The location for a browser's bookmark has to look like this:
+The location for a browser's bookmark may look like this:
+
+  javascript:location.href = \\='org-protocol://store-link?\\=' +
+       new URLSearchParams({url:location.href, title:document.title});
+
+or to keep compatibility with Org versions from 9.0 to 9.4 it may be:
 
   javascript:location.href = \\
       \\='org-protocol://store-link?url=\\=' + \\
@@ -436,7 +455,9 @@ The location for a browser's bookmark has to look like this:
 
 Don't use `escape()'!  Use `encodeURIComponent()' instead.  The
 title of the page could contain slashes and the location
-definitely will.
+definitely will.  Org 9.4 and earlier could not decode \"+\"
+to space, that is why less readable latter expression may be necessary
+for backward compatibility.
 
 The sub-protocol used to reach this function is set in
 `org-protocol-protocol-alist'.
@@ -464,6 +485,14 @@ The sub-protocol used to reach this function is set in
 This function detects an URL, title and optional text, separated
 by `/'.  The location for a browser's bookmark looks like this:
 
+  javascript:location.href = \\='org-protocol://capture?\\=' +
+        new URLSearchParams({
+              url: location.href,
+              title: document.title,
+              body: window.getSelection()})
+
+or to keep compatibility with Org versions from 9.0 to 9.4:
+
   javascript:location.href = \\='org-protocol://capture?url=\\='+ \\
         encodeURIComponent(location.href) + \\='&title=\\=' + \\
         encodeURIComponent(document.title) + \\='&body=\\=' + \\
@@ -519,10 +548,11 @@ Now template ?b will be used."
 (defun org-protocol-convert-query-to-plist (query)
   "Convert QUERY key=value pairs in the URL to a property list."
   (when query
-    (apply 'append (mapcar (lambda (x)
-                            (let ((c (split-string x "=")))
-                              (list (intern (concat ":" (car c))) (cadr c))))
-                          (split-string query "&")))))
+    (let ((plus-decoded (replace-regexp-in-string "\\+" " " query t t)))
+      (apply 'append (mapcar (lambda (x)
+                              (let ((c (split-string x "=")))
+                                (list (intern (concat ":" (car c))) (cadr c))))
+                            (split-string plus-decoded "&"))))))
 
 (defun org-protocol-open-source (fname)
   "Process an org-protocol://open-source?url= style URL with FNAME.
@@ -532,6 +562,12 @@ in `org-protocol-project-alist'.
 
 The location for a browser's bookmark should look like this:
 
+  javascript:location.href = \\='org-protocol://open-source?\\=' +
+        new URLSearchParams({url: location.href})
+
+or if you prefer to keep compatibility with older Org versions (9.0 to 9.4),
+consider the following expression:
+
   javascript:location.href = \\='org-protocol://open-source?url=\\=' + \\
         encodeURIComponent(location.href)"
   ;; As we enter this function for a match on our protocol, the return value