Re: [PATCH] emacs: prefer notmuch-emacs-version in User-Agent: header
authorMichal Sojka <sojkam1@fel.cvut.cz>
Sat, 27 Sep 2014 14:56:03 +0000 (16:56 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:04:47 +0000 (10:04 -0800)
2a/8bb55864df59ed539605d14e99e4b2aaa544f5 [new file with mode: 0644]

diff --git a/2a/8bb55864df59ed539605d14e99e4b2aaa544f5 b/2a/8bb55864df59ed539605d14e99e4b2aaa544f5
new file mode 100644 (file)
index 0000000..b5eb7ff
--- /dev/null
@@ -0,0 +1,219 @@
+Return-Path: <sojkam1@fel.cvut.cz>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id B7009431FBF\r
+       for <notmuch@notmuchmail.org>; Sat, 27 Sep 2014 07:56:18 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id saZRygGN6l0l for <notmuch@notmuchmail.org>;\r
+       Sat, 27 Sep 2014 07:56:13 -0700 (PDT)\r
+Received: from max.feld.cvut.cz (max.feld.cvut.cz [147.32.192.36])\r
+       by olra.theworths.org (Postfix) with ESMTP id A6176431FC0\r
+       for <notmuch@notmuchmail.org>; Sat, 27 Sep 2014 07:56:13 -0700 (PDT)\r
+Received: from localhost (unknown [192.168.200.7])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 0C15B19F36A8;\r
+       Sat, 27 Sep 2014 16:56:13 +0200 (CEST)\r
+X-Virus-Scanned: IMAP STYX AMAVIS\r
+Received: from max.feld.cvut.cz ([192.168.200.1])\r
+       by localhost (styx.feld.cvut.cz [192.168.200.7]) (amavisd-new,\r
+       port 10044)\r
+       with ESMTP id q7p8h-kshw9z; Sat, 27 Sep 2014 16:56:08 +0200 (CEST)\r
+Received: from imap.feld.cvut.cz (imap.feld.cvut.cz [147.32.192.34])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id C2A3C19F36A9;\r
+       Sat, 27 Sep 2014 16:56:08 +0200 (CEST)\r
+Received: from wsh by steelpick.2x.cz with local (Exim 4.84)\r
+       (envelope-from <sojkam1@fel.cvut.cz>)\r
+       id 1XXtPn-0005MB-1E; Sat, 27 Sep 2014 16:56:03 +0200\r
+From: Michal Sojka <sojkam1@fel.cvut.cz>\r
+To: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] emacs: prefer notmuch-emacs-version in User-Agent: header\r
+In-Reply-To: <1407496781-17458-1-git-send-email-tomi.ollila@iki.fi>\r
+References: <1407496781-17458-1-git-send-email-tomi.ollila@iki.fi>\r
+User-Agent: Notmuch/0.18.1+101~g56b0ff0 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sat, 27 Sep 2014 16:56:03 +0200\r
+Message-ID: <87oau1un7g.fsf@steelpick.2x.cz>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+Cc: tomi.ollila@iki.fi\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 27 Sep 2014 14:56:18 -0000\r
+\r
+Hi Tomi,\r
+\r
+On Fri, Aug 08 2014, Tomi Ollila wrote:\r
+> Now that we have `notmuch-emacs-version' defined in notmuch emacs MUA\r
+> use that as a part of User-Agent: header to provide more accurate\r
+> version information when sending emails.\r
+>\r
+> In case some incomplete installation of notmuch emacs MUA is used and\r
+> `notmuch-emacs-version' is defined as "unknown" then fall back to ask\r
+> version info from cli (as it used to be) -- the function to do that was\r
+> removed from `notmuch-version' to `notmuch-cli-version' to make things\r
+> clearer and more consistent.\r
+> ---\r
+>  NEWS                   | 14 ++++++++++++++\r
+>  emacs/notmuch-hello.el |  2 +-\r
+>  emacs/notmuch-lib.el   |  4 ++--\r
+>  emacs/notmuch-mua.el   | 11 ++++++++---\r
+>  4 files changed, 25 insertions(+), 6 deletions(-)\r
+>\r
+> diff --git a/NEWS b/NEWS\r
+> index f7aaedf91d07..9664146768f3 100644\r
+> --- a/NEWS\r
+> +++ b/NEWS\r
+> @@ -7,6 +7,20 @@ Library changes\r
+>  Add return status to notmuch_database_close and\r
+>  notmuch_database_destroy\r
+>  \r
+> +Emacs Interface\r
+> +---------------\r
+> +\r
+> +`notmuch-emacs-version` is used in `User-Agent` header\r
+> +\r
+> +  The value of recently introduced variable `notmuch-emacs-version` is\r
+> +  now used as a part of `User-Agent` header when sending emails.\r
+> +\r
+> +Removed `notmuch-version` function by renaming it to `notmuch-cli-version`\r
+> +\r
+> +  With existing variable `notmuch-emacs-version` the accompanied\r
+> +  function which retrieves the version of `notmuch-command` is\r
+> +  better named as `notmuch-cli-version`.\r
+> +\r
+>  nmbug-status\r
+>  ------------\r
+>  \r
+> diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el\r
+> index 65d062760a71..7bfa752d2a04 100644\r
+> --- a/emacs/notmuch-hello.el\r
+> +++ b/emacs/notmuch-hello.el\r
+> @@ -628,7 +628,7 @@ (defvar notmuch-emacs-version)\r
+>  (defun notmuch-hello-versions ()\r
+>    "Display the notmuch version(s)"\r
+>    (interactive)\r
+> -  (let ((notmuch-cli-version (notmuch-version)))\r
+> +  (let ((notmuch-cli-version (notmuch-cli-version)))\r
+>      (message "notmuch version %s"\r
+>           (if (string= notmuch-emacs-version notmuch-cli-version)\r
+>               notmuch-cli-version\r
+> diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+> index 19269e3c469b..ca18ff9d5487 100644\r
+> --- a/emacs/notmuch-lib.el\r
+> +++ b/emacs/notmuch-lib.el\r
+> @@ -192,8 +192,8 @@ (defun notmuch-assert-cli-sane ()\r
+>  "Perhaps you haven't run \"notmuch setup\" yet? Try running this\r
+>  on the command line, and then retry your notmuch command")))\r
+>  \r
+> -(defun notmuch-version ()\r
+> -  "Return a string with the notmuch version number."\r
+> +(defun notmuch-cli-version ()\r
+> +  "Return a string with the notmuch-command version number."\r
+>    (let ((long-string\r
+>       ;; Trim off the trailing newline.\r
+>       (substring (notmuch-command-to-string "--version") 0 -1)))\r
+> diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el\r
+> index 2c5888600b6c..dbf5df28669d 100644\r
+> --- a/emacs/notmuch-mua.el\r
+> +++ b/emacs/notmuch-mua.el\r
+> @@ -100,12 +100,17 @@ (defun notmuch-mua-user-agent-full ()\r
+>        " "\r
+>        (notmuch-mua-user-agent-emacs)))\r
+>  \r
+> +;; the following variable is defined as being defconst in notmuch-version.el\r
+> +(defvar notmuch-emacs-version)\r
+\r
+I don't like this part. It took me quite some time to figure out what's\r
+happening with notmuch-emacs-version so that we need defvar here. It\r
+seems that the same piece of code is also in notmuch-hello.el. What\r
+about introducing a function in notmuch-lib that could be used the get\r
+the best guess about emacs version? I think that something like the\r
+following diff would make things clearer.\r
+\r
+-Michal\r
+\r
+diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+index 19269e3..b883375 100644\r
+--- a/emacs/notmuch-lib.el\r
++++ b/emacs/notmuch-lib.el\r
+@@ -192,7 +192,7 @@ Otherwise the output will be returned"\r
+ "Perhaps you haven't run \"notmuch setup\" yet? Try running this\r
+ on the command line, and then retry your notmuch command")))\r
\r
+-(defun notmuch-version ()\r
++(defun notmuch-cli-version ()\r
+   "Return a string with the notmuch version number."\r
+   (let ((long-string\r
+         ;; Trim off the trailing newline.\r
+@@ -202,6 +202,15 @@ on the command line, and then retry your notmuch command")))\r
+        (match-string 2 long-string)\r
+       "unknown")))\r
\r
++(unless (require 'notmuch-version nil t)\r
++  (defconst notmuch-emacs-version "unknown"\r
++    "Placeholder variable when notmuch-version.el[c] is not available."))\r
++\r
++(defun notmuch-guess-emacs-version ()\r
++  (if (string= notmuch-emacs-version "unknown")\r
++      (notmuch-cli-version)\r
++    notmuch-emacs-version))\r
++\r
+ (defun notmuch-config-get (item)\r
+   "Return a value from the notmuch configuration."\r
+   (let* ((val (notmuch-command-to-string "config" "get" item))\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index b44a907..7245b2d 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -61,10 +61,6 @@\r
+ (require 'notmuch-message)\r
+ (require 'notmuch-parser)\r
\r
+-(unless (require 'notmuch-version nil t)\r
+-  (defconst notmuch-emacs-version "unknown"\r
+-    "Placeholder variable when notmuch-version.el[c] is not available."))\r
+-\r
+ (defcustom notmuch-search-result-format\r
+   `(("date" . "%12s ")\r
+     ("count" . "%-7s ")\r
+\r
+\r
+> +\r
+>  (defun notmuch-mua-user-agent-notmuch ()\r
+> -  "Generate a `User-Agent:' string suitable for notmuch."\r
+> -  (concat "Notmuch/" (notmuch-version) " (http://notmuchmail.org)"))\r
+> +  "Generate notmuch part of `User-Agent:' string suitable for notmuch."\r
+> +  (concat "Notmuch/" (if (string= notmuch-emacs-version "unknown")\r
+> +                     (notmuch-cli-version)\r
+> +                   notmuch-emacs-version) " (http://notmuchmail.org)"))\r
+>  \r
+>  (defun notmuch-mua-user-agent-emacs ()\r
+> -  "Generate a `User-Agent:' string suitable for notmuch."\r
+> +  "Generate emacs part of `User-Agent:' string suitable for notmuch."\r
+>    (concat "Emacs/" emacs-version " (" system-configuration ")"))\r
+>  \r
+>  (defun notmuch-mua-add-more-hidden-headers ()\r
+> -- \r
+> 2.0.0\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r