From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id wI+1GCbXUWH6cwEAgWs5BA (envelope-from ) for ; Mon, 27 Sep 2021 16:37:26 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id KK9BFCbXUWH/XwAAbx9fmQ (envelope-from ) for ; Mon, 27 Sep 2021 14:37:26 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id E44837155 for ; Mon, 27 Sep 2021 16:37:25 +0200 (CEST) Received: from localhost ([::1]:54966 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mUrky-0000Xq-Tv for larch@yhetil.org; Mon, 27 Sep 2021 10:37:24 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43242) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUrfI-0004DS-Hc for emacs-orgmode@gnu.org; Mon, 27 Sep 2021 10:31:32 -0400 Received: from ciao.gmane.io ([116.202.254.214]:41762) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUrfE-0004AZ-Nj for emacs-orgmode@gnu.org; Mon, 27 Sep 2021 10:31:32 -0400 Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1mUrfB-0007wV-Ie for emacs-orgmode@gnu.org; Mon, 27 Sep 2021 16:31:25 +0200 X-Injected-Via-Gmane: http://gmane.org/ To: emacs-orgmode@gnu.org From: Max Nikulin Subject: Re: [PATCH] org-protocol: decode "+" in query part as space (v3) Date: Mon, 27 Sep 2021 21:31:12 +0700 Message-ID: References: <878rzie21k.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------94AEBE93335C99273A899D6D" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 In-Reply-To: <878rzie21k.fsf@gnu.org> Content-Language: en-US Received-SPF: pass client-ip=116.202.254.214; envelope-from=geo-emacs-orgmode@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -2 X-Spam_score: -0.3 X-Spam_bar: / X-Spam_report: (-0.3 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, FORGED_GMAIL_RCVD=1, FORGED_MUA_MOZILLA=2.309, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25, NICE_REPLY_A=-3.136, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1632753446; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=/7imeHh0kS/HA3iz84tyLK5JUoYryJNsRdEBICaEbVA=; b=Tygmfp3TH2dSN6oSTU+OpAC96JY2dE5qWOmYW9b/NOODauIAM5AISu40MU0npFz6o0elWc FXPmBoDRxLD6tY521hWNlAhF/93+XrfQ3u+weGne0E48pgYpz88IV8wZ3R1SPz1kxK0/qd oiVlYWhIBagM29wc1Ger+le/VmpsDmAKaXw4g6tMduIhKb7kkR1JSGcAAan6LmG8DuZ5Js LBj0cnMw+yCCg8HesFNE+aJPRvIbcNdEWAzCJdyI2e1EmQyQoDm/NDHY+7KebLqIL/sjJI e1zb1XaBFNVwU6Q/VeKcAqd0/Zcv8IeS8IQBfMeuGUJoYwodUyEZrHOG/Is2HA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1632753446; a=rsa-sha256; cv=none; b=AvZh+u4DujwpVvgbRBA4zvj43GSq6GEXuInPZmnzdd3NQJE/Sv2auJMDDx2RdXIBHiqk5J 46Dpv/Yg01H4gMAqwtZUM3kIVKU1jZwjsNIRDIb2n3dtq5zVlkn9sXolku6v9/rhpJjEDK MpJ39Nh9Vb2ghl8tnjdcqH8IXOldR2eiIx4GPaT6/dJ/qlhGhnLt+3THJ0wlZtXrSKjjA2 VAVYFBo1dCN9SH+cjTZhpscC1NHWjkpEsLHGzB6n5/050eoyeuc9mpKghSP0/VaEVZT6Mq HwoZc58ebCH27cbfVR/fzgP6bjT7ty0rIG1O8zQeJ5qBmALhyOcljo65EG6pvw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -2.19 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=fail reason="SPF not aligned (relaxed), No valid DKIM" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: E44837155 X-Spam-Score: -2.19 X-Migadu-Scanner: scn1.migadu.com X-TUID: 7cbd4Xvf1hMn This is a multi-part message in MIME format. --------------94AEBE93335C99273A899D6D Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit On 27/09/2021 17:38, Bastien wrote: > Maxim Nikulin writes: > >> I have realized that only a half of new apostrophes in doc strings >> were properly escaped, so I am attaching updated patch. I still >> consider the change as a minor improvement. > > Probably given the delay, the patch does not apply anymore. > > Would you be able to reformat and resend it? Surprisingly there is no conflicts during rebase. I expected changed context in ORG-NEWS. --------------94AEBE93335C99273A899D6D Content-Type: text/x-patch; charset=UTF-8; name="0001-org-protocol.el-decode-in-query-part-as-space.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="0001-org-protocol.el-decode-in-query-part-as-space.patch" >From be23adf20852966b904583970bd106a5e8385ec7 Mon Sep 17 00:00:00 2001 From: Max Nikulin Date: Tue, 6 Apr 2021 21:30:06 +0700 Subject: [PATCH] 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 adf9c132c..96f55616f 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -19783,11 +19783,20 @@ slashes, and probably quote those for the shell. 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. @@ -19803,6 +19812,15 @@ using acapture template. 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)+ @@ -19810,6 +19828,10 @@ javascript:location.href='org-protocol://capture?template=x'+ '&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 53915d8e4..9d19a812c 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 e4578d421..703d0d7a0 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 -- 2.25.1 --------------94AEBE93335C99273A899D6D--