code.delx.au - gnu-emacs/blob - lisp/gnus/nnir.el

   1 ;;; nnir.el --- search mail with various search engines -*- coding: utf-8 -*-
   2
   3 ;; Copyright (C) 1998-2016 Free Software Foundation, Inc.
   4
   5 ;; Author: Kai Großjohann <grossjohann@ls6.cs.uni-dortmund.de>
   6 ;; Swish-e and Swish++ backends by:
   7 ;;   Christoph Conrad <christoph.conrad@gmx.de>.
   8 ;; IMAP backend by: Simon Josefsson <jas@pdc.kth.se>.
   9 ;; IMAP search by: Torsten Hilbrich <torsten.hilbrich <at> gmx.net>
  10 ;; IMAP search improved by Daniel Pittman  <daniel@rimspace.net>.
  11 ;; nnmaildir support for Swish++ and Namazu backends by:
  12 ;;   Justus Piater <Justus <at> Piater.name>
  13 ;; Keywords: news mail searching ir
  14
  15 ;; This file is part of GNU Emacs.
  16
  17 ;; GNU Emacs is free software: you can redistribute it and/or modify
  18 ;; it under the terms of the GNU General Public License as published by
  19 ;; the Free Software Foundation, either version 3 of the License, or
  20 ;; (at your option) any later version.
  21
  22 ;; GNU Emacs is distributed in the hope that it will be useful,
  23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 ;; GNU General Public License for more details.
  26
  27 ;; You should have received a copy of the GNU General Public License
  28 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  29
  30 ;;; Commentary:
  31
  32 ;; What does it do?  Well, it allows you to search your mail using
  33 ;; some search engine (imap, namazu, swish-e, gmane and others -- see
  34 ;; later) by typing `G G' in the Group buffer.  You will then get a
  35 ;; buffer which shows all articles matching the query, sorted by
  36 ;; Retrieval Status Value (score).
  37
  38 ;; When looking at the retrieval result (in the Summary buffer) you
  39 ;; can type `A W' (aka M-x gnus-warp-to-article RET) on an article.  You
  40 ;; will be warped into the group this article came from. Typing `A T'
  41 ;; (aka M-x gnus-summary-refer-thread RET) will warp to the group and
  42 ;; also show the thread this article is part of.
  43
  44 ;; The Lisp setup may involve setting a few variables and setting up the
  45 ;; search engine. You can define the variables in the server definition
  46 ;; like this :
  47 ;;   (setq gnus-secondary-select-methods '(
  48 ;;       (nnimap "" (nnimap-address "localhost")
  49 ;;                  (nnir-search-engine namazu)
  50 ;;       )))
  51 ;; The main variable to set is `nnir-search-engine'.  Choose one of
  52 ;; the engines listed in `nnir-engines'.  (Actually `nnir-engines' is
  53 ;; an alist, type `C-h v nnir-engines RET' for more information; this
  54 ;; includes examples for setting `nnir-search-engine', too.)
  55
  56 ;; If you use one of the local indices (namazu, find-grep, swish) you
  57 ;; must also set up a search engine backend.
  58
  59 ;; 1. Namazu
  60 ;;
  61 ;; The Namazu backend requires you to have one directory containing all
  62 ;; index files, this is controlled by the `nnir-namazu-index-directory'
  63 ;; variable.  To function the `nnir-namazu-remove-prefix' variable must
  64 ;; also be correct, see the documentation for `nnir-namazu-remove-prefix'
  65 ;; above.
  66 ;;
  67 ;; It is particularly important not to pass any any switches to namazu
  68 ;; that will change the output format.  Good switches to use include
  69 ;; `--sort', `--ascending', `--early' and `--late'.  Refer to the Namazu
  70 ;; documentation for further information on valid switches.
  71 ;;
  72 ;; To index my mail with the `mknmz' program I use the following
  73 ;; configuration file:
  74 ;;
  75 ;; ,----
  76 ;; | package conf;  # Don't remove this line!
  77 ;; |
  78 ;; | # Paths which will not be indexed. Don't use `^' or `$' anchors.
  79 ;; | $EXCLUDE_PATH = "spam|sent";
  80 ;; |
  81 ;; | # Header fields which should be searchable. case-insensitive
  82 ;; | $REMAIN_HEADER = "from|date|message-id|subject";
  83 ;; |
  84 ;; | # Searchable fields. case-insensitive
  85 ;; | $SEARCH_FIELD = "from|date|message-id|subject";
  86 ;; |
  87 ;; | # The max length of a word.
  88 ;; | $WORD_LENG_MAX = 128;
  89 ;; |
  90 ;; | # The max length of a field.
  91 ;; | $MAX_FIELD_LENGTH = 256;
  92 ;; `----
  93 ;;
  94 ;; My mail is stored in the directories ~/Mail/mail/, ~/Mail/lists/ and
  95 ;; ~/Mail/archive/, so to index them I go to the directory set in
  96 ;; `nnir-namazu-index-directory' and issue the following command.
  97 ;;
  98 ;;      mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
  99 ;;
 100 ;; For maximum searching efficiency I have a cron job set to run this
 101 ;; command every four hours.
 102
 103 ;; 2. find-grep
 104 ;;
 105 ;; The find-grep engine simply runs find(1) to locate eligible
 106 ;; articles and searches them with grep(1).  This, of course, is much
 107 ;; slower than using a proper search engine but OTOH doesn't require
 108 ;; maintenance of an index and is still faster than using any built-in
 109 ;; means for searching.  The method specification of the server to
 110 ;; search must include a directory for this engine to work (E.g.,
 111 ;; `nnml-directory').  The tools must be POSIX compliant.  GNU Find
 112 ;; prior to version 4.2.12 (4.2.26 on Linux due to incorrect ARG_MAX
 113 ;; handling) does not work.
 114 ;; ,----
 115 ;; |    ;; find-grep configuration for searching the Gnus Cache
 116 ;; |
 117 ;; |    (nnml "cache"
 118 ;; |          (nnml-get-new-mail nil)
 119 ;; |          (nnir-search-engine find-grep)
 120 ;; |          (nnml-directory "~/News/cache/")
 121 ;; |          (nnml-active-file "~/News/cache/active"))
 122 ;; `----
 123
 124 ;; Developer information:
 125
 126 ;; I have tried to make the code expandable.  Basically, it is divided
 127 ;; into two layers.  The upper layer is somewhat like the `nnvirtual'
 128 ;; backend: given a specification of what articles to show from
 129 ;; another backend, it creates a group containing exactly those
 130 ;; articles.  The lower layer issues a query to a search engine and
 131 ;; produces such a specification of what articles to show from the
 132 ;; other backend.
 133
 134 ;; The interface between the two layers consists of the single
 135 ;; function `nnir-run-query', which dispatches the search to the
 136 ;; proper search function.  The argument of `nnir-run-query' is an
 137 ;; alist with two keys: 'nnir-query-spec and 'nnir-group-spec. The
 138 ;; value for 'nnir-query-spec is an alist. The only required key/value
 139 ;; pair is (query . "query") specifying the search string to pass to
 140 ;; the query engine. Individual engines may have other elements. The
 141 ;; value of 'nnir-group-spec is a list with the specification of the
 142 ;; groups/servers to search.  The format of the 'nnir-group-spec is
 143 ;; (("server1" ("group11" "group12")) ("server2" ("group21"
 144 ;; "group22"))). If any of the group lists is absent then all groups
 145 ;; on that server are searched.
 146
 147 ;; The output of `nnir-run-query' is supposed to be a vector, each
 148 ;; element of which should in turn be a three-element vector.  The
 149 ;; first element should be full group name of the article, the second
 150 ;; element should be the article number, and the third element should
 151 ;; be the Retrieval Status Value (RSV) as returned from the search
 152 ;; engine.  An RSV is the score assigned to the document by the search
 153 ;; engine.  For Boolean search engines, the RSV is always 1000 (or 1
 154 ;; or 100, or whatever you like).
 155
 156 ;; The sorting order of the articles in the summary buffer created by
 157 ;; nnir is based on the order of the articles in the above mentioned
 158 ;; vector, so that's where you can do the sorting you'd like.  Maybe
 159 ;; it would be nice to have a way of displaying the search result
 160 ;; sorted differently?
 161
 162 ;; So what do you need to do when you want to add another search
 163 ;; engine?  You write a function that executes the query.  Temporary
 164 ;; data from the search engine can be put in `nnir-tmp-buffer'.  This
 165 ;; function should return the list of articles as a vector, as
 166 ;; described above.  Then, you need to register this backend in
 167 ;; `nnir-engines'.  Then, users can choose the backend by setting
 168 ;; `nnir-search-engine' as a server variable.
 169
 170 ;;; Code:
 171
 172 ;;; Setup:
 173
 174 (require 'nnoo)
 175 (require 'gnus-group)
 176 (require 'message)
 177 (require 'gnus-util)
 178 (eval-when-compile
 179   (require 'cl))
 180
 181 ;;; Internal Variables:
 182
 183 (defvar nnir-memo-query nil
 184   "Internal: stores current query.")
 185
 186 (defvar nnir-memo-server nil
 187   "Internal: stores current server.")
 188
 189 (defvar nnir-artlist nil
 190   "Internal: stores search result.")
 191
 192 (defvar nnir-search-history ()
 193   "Internal: the history for querying search options in nnir")
 194
 195 (defconst nnir-tmp-buffer " *nnir*"
 196   "Internal: temporary buffer.")
 197
 198
 199 ;; Imap variables
 200
 201 (defvar nnir-imap-search-arguments
 202   '(("whole message" . "TEXT")
 203     ("subject" . "SUBJECT")
 204     ("to" . "TO")
 205     ("from" . "FROM")
 206     ("body" . "BODY")
 207     ("imap" . ""))
 208   "Mapping from user readable keys to IMAP search items for use in nnir")
 209
 210 (defvar nnir-imap-search-other "HEADER %S"
 211   "The IMAP search item to use for anything other than
 212   `nnir-imap-search-arguments'. By default this is the name of an
 213   email header field")
 214
 215 (defvar nnir-imap-search-argument-history ()
 216   "The history for querying search options in nnir")
 217
 218 ;;; Helper macros
 219
 220 ;; Data type article list.
 221
 222 (defmacro nnir-artlist-length (artlist)
 223   "Returns number of articles in artlist."
 224   `(length ,artlist))
 225
 226 (defmacro nnir-artlist-article (artlist n)
 227   "Returns from ARTLIST the Nth artitem (counting starting at 1)."
 228   `(when (> ,n 0)
 229      (elt ,artlist (1- ,n))))
 230
 231 (defmacro nnir-artitem-group (artitem)
 232   "Returns the group from the ARTITEM."
 233   `(elt ,artitem 0))
 234
 235 (defmacro nnir-artitem-number (artitem)
 236   "Returns the number from the ARTITEM."
 237   `(elt ,artitem 1))
 238
 239 (defmacro nnir-artitem-rsv (artitem)
 240   "Returns the Retrieval Status Value (RSV, score) from the ARTITEM."
 241   `(elt ,artitem 2))
 242
 243 (defmacro nnir-article-group (article)
 244   "Returns the group for ARTICLE"
 245   `(nnir-artitem-group (nnir-artlist-article nnir-artlist ,article)))
 246
 247 (defmacro nnir-article-number (article)
 248   "Returns the number for ARTICLE"
 249   `(nnir-artitem-number (nnir-artlist-article nnir-artlist ,article)))
 250
 251 (defmacro nnir-article-rsv (article)
 252   "Returns the rsv for ARTICLE"
 253   `(nnir-artitem-rsv (nnir-artlist-article nnir-artlist ,article)))
 254
 255 (defsubst nnir-article-ids (article)
 256   "Returns the pair `(nnir id . real id)' of ARTICLE"
 257   (cons article (nnir-article-number article)))
 258
 259 (defmacro nnir-categorize (sequence keyfunc &optional valuefunc)
 260   "Sorts a sequence into categories and returns a list of the form
 261 `((key1 (element11 element12)) (key2 (element21 element22))'.
 262 The category key for a member of the sequence is obtained
 263 as `(keyfunc member)' and the corresponding element is just
 264 `member'. If `valuefunc' is non-nil, the element of the list
 265 is `(valuefunc member)'."
 266   `(unless (null ,sequence)
 267      (let (value)
 268        (mapc
 269         (lambda (member)
 270           (let ((y (,keyfunc member))
 271                 (x ,(if valuefunc
 272                         `(,valuefunc member)
 273                       'member)))
 274             (if (assoc y value)
 275                 (push x (cadr (assoc y value)))
 276               (push (list y (list x)) value))))
 277         ,sequence)
 278        value)))
 279
 280 ;;; Finish setup:
 281
 282 (require 'gnus-sum)
 283
 284 (nnoo-declare nnir)
 285 (nnoo-define-basics nnir)
 286
 287 (gnus-declare-backend "nnir" 'mail 'virtual)
 288
 289
 290 ;;; User Customizable Variables:
 291
 292 (defgroup nnir nil
 293   "Search groups in Gnus with assorted search engines."
 294   :group 'gnus)
 295
 296 (defcustom nnir-ignored-newsgroups ""
 297   "A regexp to match newsgroups in the active file that should
 298   be skipped when searching."
 299   :version "24.1"
 300   :type '(regexp)
 301   :group 'nnir)
 302
 303 (defcustom nnir-summary-line-format nil
 304   "The format specification of the lines in an nnir summary buffer.
 305
 306 All the items from `gnus-summary-line-format' are available, along
 307 with three items unique to nnir summary buffers:
 308
 309 %Z    Search retrieval score value (integer)
 310 %G    Article original full group name (string)
 311 %g    Article original short group name (string)
 312
 313 If nil this will use `gnus-summary-line-format'."
 314   :version "24.1"
 315   :type '(choice (const :tag "gnus-summary-line-format" nil) string)
 316   :group 'nnir)
 317
 318 (defcustom nnir-retrieve-headers-override-function nil
 319   "If non-nil, a function that accepts an article list and group
 320 and populates the `nntp-server-buffer' with the retrieved
 321 headers. Must return either 'nov or 'headers indicating the
 322 retrieved header format.
 323
 324 If this variable is nil, or if the provided function returns nil for a search
 325 result, `gnus-retrieve-headers' will be called instead."
 326   :version "24.1"
 327   :type '(choice (const :tag "gnus-retrieve-headers" nil) function)
 328   :group 'nnir)
 329
 330 (defcustom nnir-imap-default-search-key "whole message"
 331   "The default IMAP search key for an nnir search. Must be one of
 332   the keys in `nnir-imap-search-arguments'. To use raw imap queries
 333   by default set this to \"imap\"."
 334   :version "24.1"
 335   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
 336                            nnir-imap-search-arguments))
 337   :group 'nnir)
 338
 339 (defcustom nnir-swish++-configuration-file
 340   (expand-file-name "~/Mail/swish++.conf")
 341   "Configuration file for swish++."
 342   :type '(file)
 343   :group 'nnir)
 344
 345 (defcustom nnir-swish++-program "search"
 346   "Name of swish++ search executable."
 347   :type '(string)
 348   :group 'nnir)
 349
 350 (defcustom nnir-swish++-additional-switches '()
 351   "A list of strings, to be given as additional arguments to swish++.
 352
 353 Note that this should be a list.  I.e., do NOT use the following:
 354     (setq nnir-swish++-additional-switches \"-i -w\") ; wrong
 355 Instead, use this:
 356     (setq nnir-swish++-additional-switches \\='(\"-i\" \"-w\"))"
 357   :type '(repeat (string))
 358   :group 'nnir)
 359
 360 (defcustom nnir-swish++-remove-prefix (concat (getenv "HOME") "/Mail/")
 361   "The prefix to remove from each file name returned by swish++
 362 in order to get a group name (albeit with / instead of .).  This is a
 363 regular expression.
 364
 365 This variable is very similar to `nnir-namazu-remove-prefix', except
 366 that it is for swish++, not Namazu."
 367   :type '(regexp)
 368   :group 'nnir)
 369
 370 ;; Swish-E.
 371 ;; URL: http://swish-e.org/
 372 ;; Variables `nnir-swish-e-index-file', `nnir-swish-e-program' and
 373 ;; `nnir-swish-e-additional-switches'
 374
 375 (make-obsolete-variable 'nnir-swish-e-index-file
 376                         'nnir-swish-e-index-files "Emacs 23.1")
 377 (defcustom nnir-swish-e-index-file
 378   (expand-file-name "~/Mail/index.swish-e")
 379   "Index file for swish-e.
 380 This could be a server parameter.
 381 It is never consulted once `nnir-swish-e-index-files', which should be
 382 used instead, has been customized."
 383   :type '(file)
 384   :group 'nnir)
 385
 386 (defcustom nnir-swish-e-index-files
 387   (list nnir-swish-e-index-file)
 388   "List of index files for swish-e.
 389 This could be a server parameter."
 390   :type '(repeat (file))
 391   :group 'nnir)
 392
 393 (defcustom nnir-swish-e-program "swish-e"
 394   "Name of swish-e search executable.
 395 This cannot be a server parameter."
 396   :type '(string)
 397   :group 'nnir)
 398
 399 (defcustom nnir-swish-e-additional-switches '()
 400   "A list of strings, to be given as additional arguments to swish-e.
 401
 402 Note that this should be a list.  I.e., do NOT use the following:
 403     (setq nnir-swish-e-additional-switches \"-i -w\") ; wrong
 404 Instead, use this:
 405     (setq nnir-swish-e-additional-switches \\='(\"-i\" \"-w\"))
 406
 407 This could be a server parameter."
 408   :type '(repeat (string))
 409   :group 'nnir)
 410
 411 (defcustom nnir-swish-e-remove-prefix (concat (getenv "HOME") "/Mail/")
 412   "The prefix to remove from each file name returned by swish-e
 413 in order to get a group name (albeit with / instead of .).  This is a
 414 regular expression.
 415
 416 This variable is very similar to `nnir-namazu-remove-prefix', except
 417 that it is for swish-e, not Namazu.
 418
 419 This could be a server parameter."
 420   :type '(regexp)
 421   :group 'nnir)
 422
 423 ;; HyREX engine, see <URL:http://ls6-www.cs.uni-dortmund.de/>
 424
 425 (defcustom nnir-hyrex-program "nnir-search"
 426   "Name of the nnir-search executable."
 427   :type '(string)
 428   :group 'nnir)
 429
 430 (defcustom nnir-hyrex-additional-switches '()
 431   "A list of strings, to be given as additional arguments for nnir-search.
 432 Note that this should be a list. I.e., do NOT use the following:
 433     (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
 434 Instead, use this:
 435     (setq nnir-hyrex-additional-switches \\='(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
 436   :type '(repeat (string))
 437   :group 'nnir)
 438
 439 (defcustom nnir-hyrex-index-directory (getenv "HOME")
 440   "Index directory for HyREX."
 441   :type '(directory)
 442   :group 'nnir)
 443
 444 (defcustom nnir-hyrex-remove-prefix (concat (getenv "HOME") "/Mail/")
 445   "The prefix to remove from each file name returned by HyREX
 446 in order to get a group name (albeit with / instead of .).
 447
 448 For example, suppose that HyREX returns file names such as
 449 \"/home/john/Mail/mail/misc/42\".  For this example, use the following
 450 setting:  (setq nnir-hyrex-remove-prefix \"/home/john/Mail/\")
 451 Note the trailing slash.  Removing this prefix gives \"mail/misc/42\".
 452 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
 453 arrive at the correct group name, \"mail.misc\"."
 454   :type '(directory)
 455   :group 'nnir)
 456
 457 ;; Namazu engine, see <URL:http://www.namazu.org/>
 458
 459 (defcustom nnir-namazu-program "namazu"
 460   "Name of Namazu search executable."
 461   :type '(string)
 462   :group 'nnir)
 463
 464 (defcustom nnir-namazu-index-directory (expand-file-name "~/Mail/namazu/")
 465   "Index directory for Namazu."
 466   :type '(directory)
 467   :group 'nnir)
 468
 469 (defcustom nnir-namazu-additional-switches '()
 470   "A list of strings, to be given as additional arguments to namazu.
 471 The switches `-q', `-a', and `-s' are always used, very few other switches
 472 make any sense in this context.
 473
 474 Note that this should be a list.  I.e., do NOT use the following:
 475     (setq nnir-namazu-additional-switches \"-i -w\") ; wrong
 476 Instead, use this:
 477     (setq nnir-namazu-additional-switches \\='(\"-i\" \"-w\"))"
 478   :type '(repeat (string))
 479   :group 'nnir)
 480
 481 (defcustom nnir-namazu-remove-prefix (concat (getenv "HOME") "/Mail/")
 482   "The prefix to remove from each file name returned by Namazu
 483 in order to get a group name (albeit with / instead of .).
 484
 485 For example, suppose that Namazu returns file names such as
 486 \"/home/john/Mail/mail/misc/42\".  For this example, use the following
 487 setting:  (setq nnir-namazu-remove-prefix \"/home/john/Mail/\")
 488 Note the trailing slash.  Removing this prefix gives \"mail/misc/42\".
 489 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
 490 arrive at the correct group name, \"mail.misc\"."
 491   :type '(directory)
 492   :group 'nnir)
 493
 494 (defcustom nnir-notmuch-program "notmuch"
 495   "Name of notmuch search executable."
 496   :version "24.1"
 497   :type '(string)
 498   :group 'nnir)
 499
 500 (defcustom nnir-notmuch-additional-switches '()
 501   "A list of strings, to be given as additional arguments to notmuch.
 502
 503 Note that this should be a list.  I.e., do NOT use the following:
 504     (setq nnir-notmuch-additional-switches \"-i -w\") ; wrong
 505 Instead, use this:
 506     (setq nnir-notmuch-additional-switches \\='(\"-i\" \"-w\"))"
 507   :version "24.1"
 508   :type '(repeat (string))
 509   :group 'nnir)
 510
 511 (defcustom nnir-notmuch-remove-prefix (concat (getenv "HOME") "/Mail/")
 512   "The prefix to remove from each file name returned by notmuch
 513 in order to get a group name (albeit with / instead of .).  This is a
 514 regular expression.
 515
 516 This variable is very similar to `nnir-namazu-remove-prefix', except
 517 that it is for notmuch, not Namazu."
 518   :version "24.1"
 519   :type '(regexp)
 520   :group 'nnir)
 521
 522 ;;; Developer Extension Variable:
 523
 524 (defvar nnir-engines
 525   `((imap    nnir-run-imap
 526              ((criteria
 527                "Imap Search in"                   ; Prompt
 528                ,(mapcar 'car nnir-imap-search-arguments) ; alist for completing
 529                nil                                ; allow any user input
 530                nil                                ; initial value
 531                nnir-imap-search-argument-history  ; the history to use
 532                ,nnir-imap-default-search-key      ; default
 533                )))
 534     (gmane   nnir-run-gmane
 535              ((gmane-author . "Gmane Author: ")))
 536     (swish++ nnir-run-swish++
 537              ((swish++-group . "Swish++ Group spec (regexp): ")))
 538     (swish-e nnir-run-swish-e
 539              ((swish-e-group . "Swish-e Group spec (regexp): ")))
 540     (namazu  nnir-run-namazu
 541              ())
 542     (notmuch nnir-run-notmuch
 543              ())
 544     (hyrex   nnir-run-hyrex
 545              ((hyrex-group . "Hyrex Group spec (regexp): ")))
 546     (find-grep nnir-run-find-grep
 547                ((grep-options . "Grep options: "))))
 548   "Alist of supported search engines.
 549 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
 550 ENGINE is a symbol designating the searching engine.  FUNCTION is also
 551 a symbol, giving the function that does the search.  The third element
 552 ARGS is a list of cons pairs (PARAM . PROMPT).  When issuing a query,
 553 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
 554
 555 The value of `nnir-search-engine' must be one of the ENGINE symbols.
 556 For example, for searching a server using namazu include
 557     (nnir-search-engine namazu)
 558 in the server definition.  Note that you have to set additional
 559 variables for most backends.  For example, the `namazu' backend
 560 needs the variables `nnir-namazu-program',
 561 `nnir-namazu-index-directory' and `nnir-namazu-remove-prefix'.
 562
 563 Add an entry here when adding a new search engine.")
 564
 565 (defcustom nnir-method-default-engines  '((nnimap . imap) (nntp . gmane))
 566   "Alist of default search engines keyed by server method."
 567   :version "24.1"
 568   :group 'nnir
 569   :type `(repeat (cons (choice (const nnimap) (const nntp) (const nnspool)
 570                                (const nneething) (const nndir) (const nnmbox)
 571                                (const nnml) (const nnmh) (const nndraft)
 572                                (const nnfolder) (const nnmaildir))
 573                        (choice
 574                         ,@(mapcar (lambda (elem) (list 'const (car elem)))
 575                                   nnir-engines)))))
 576
 577 ;; Gnus glue.
 578
 579 (declare-function gnus-group-topic-name "gnus-topic" ())
 580
 581 (defun gnus-group-make-nnir-group (nnir-extra-parms &optional specs)
 582   "Create an nnir group.  Prompt for a search query and determine
 583 the groups to search as follows: if called from the *Server*
 584 buffer search all groups belonging to the server on the current
 585 line; if called from the *Group* buffer search any marked groups,
 586 or the group on the current line, or all the groups under the
 587 current topic. Calling with a prefix-arg prompts for additional
 588 search-engine specific constraints. A non-nil `specs' arg must be
 589 an alist with `nnir-query-spec' and `nnir-group-spec' keys, and
 590 skips all prompting."
 591   (interactive "P")
 592   (let* ((group-spec
 593           (or (cdr (assq 'nnir-group-spec specs))
 594             (if (gnus-server-server-name)
 595                 (list (list (gnus-server-server-name)))
 596               (nnir-categorize
 597                (or gnus-group-marked
 598                    (if (gnus-group-group-name)
 599                        (list (gnus-group-group-name))
 600                      (cdr (assoc (gnus-group-topic-name) gnus-topic-alist))))
 601                gnus-group-server))))
 602          (query-spec
 603           (or (cdr (assq 'nnir-query-spec specs))
 604             (apply
 605              'append
 606              (list (cons 'query
 607                          (read-string "Query: " nil 'nnir-search-history)))
 608              (when nnir-extra-parms
 609                (mapcar
 610                 (lambda (x)
 611                   (nnir-read-parms (nnir-server-to-search-engine (car x))))
 612                 group-spec))))))
 613     (gnus-group-read-ephemeral-group
 614      (concat "nnir-" (message-unique-id))
 615      (list 'nnir "nnir")
 616      nil
 617 ;     (cons (current-buffer) gnus-current-window-configuration)
 618      nil
 619      nil nil
 620      (list
 621       (cons 'nnir-specs (list (cons 'nnir-query-spec query-spec)
 622                               (cons 'nnir-group-spec group-spec)))
 623       (cons 'nnir-artlist nil)))))
 624
 625 (defun gnus-summary-make-nnir-group (nnir-extra-parms)
 626   "Search a group from the summary buffer."
 627   (interactive "P")
 628   (gnus-warp-to-article)
 629   (let ((spec
 630          (list
 631           (cons 'nnir-group-spec
 632                 (list (list
 633                        (gnus-group-server gnus-newsgroup-name)
 634                        (list gnus-newsgroup-name)))))))
 635     (gnus-group-make-nnir-group nnir-extra-parms spec)))
 636
 637
 638 ;; Gnus backend interface functions.
 639
 640 (deffoo nnir-open-server (server &optional definitions)
 641   ;; Just set the server variables appropriately.
 642   (let ((backend (car (gnus-server-to-method server))))
 643     (if backend
 644         (nnoo-change-server backend server definitions)
 645       (add-hook 'gnus-summary-mode-hook 'nnir-mode)
 646       (nnoo-change-server 'nnir server definitions))))
 647
 648 (deffoo nnir-request-group (group &optional server dont-check info)
 649   (nnir-possibly-change-group group server)
 650   (let ((pgroup (gnus-group-guess-full-name-from-command-method group))
 651         length)
 652     ;; Check for cached search result or run the query and cache the
 653     ;; result.
 654     (unless (and nnir-artlist dont-check)
 655       (gnus-group-set-parameter
 656        pgroup 'nnir-artlist
 657        (setq nnir-artlist
 658              (nnir-run-query
 659               (gnus-group-get-parameter pgroup 'nnir-specs t))))
 660       (nnir-request-update-info pgroup (gnus-get-info pgroup)))
 661     (with-current-buffer nntp-server-buffer
 662       (if (zerop (setq length (nnir-artlist-length nnir-artlist)))
 663           (progn
 664             (nnir-close-group group)
 665             (nnheader-report 'nnir "Search produced empty results."))
 666         (nnheader-insert "211 %d %d %d %s\n"
 667                          length    ; total #
 668                          1         ; first #
 669                          length    ; last #
 670                          group)))) ; group name
 671   nnir-artlist)
 672
 673 (deffoo nnir-retrieve-headers (articles &optional group server fetch-old)
 674   (with-current-buffer nntp-server-buffer
 675     (let ((gnus-inhibit-demon t)
 676           (articles-by-group (nnir-categorize
 677                               articles nnir-article-group nnir-article-ids))
 678           headers)
 679       (while (not (null articles-by-group))
 680         (let* ((group-articles (pop articles-by-group))
 681                (artgroup (car group-articles))
 682                (articleids (cadr group-articles))
 683                (artlist (sort (mapcar 'cdr articleids) '<))
 684                (server (gnus-group-server artgroup))
 685                (gnus-override-method (gnus-server-to-method server))
 686                parsefunc)
 687           ;; (nnir-possibly-change-group nil server)
 688           (erase-buffer)
 689           (case (setq gnus-headers-retrieved-by
 690                       (or
 691                        (and
 692                         nnir-retrieve-headers-override-function
 693                         (funcall nnir-retrieve-headers-override-function
 694                                  artlist artgroup))
 695                        (gnus-retrieve-headers artlist artgroup nil)))
 696             (nov
 697              (setq parsefunc 'nnheader-parse-nov))
 698             (headers
 699              (setq parsefunc 'nnheader-parse-head))
 700             (t (error "Unknown header type %s while requesting articles \
 701                     of group %s" gnus-headers-retrieved-by artgroup)))
 702           (goto-char (point-min))
 703           (while (not (eobp))
 704             (let* ((novitem (funcall parsefunc))
 705                    (artno (and novitem
 706                                (mail-header-number novitem)))
 707                    (art (car (rassq artno articleids))))
 708               (when art
 709                 (mail-header-set-number novitem art)
 710                 (push novitem headers))
 711               (forward-line 1)))))
 712       (setq headers
 713             (sort headers
 714                   (lambda (x y)
 715                     (< (mail-header-number x) (mail-header-number y)))))
 716       (erase-buffer)
 717       (mapc 'nnheader-insert-nov headers)
 718       'nov)))
 719
 720 (deffoo nnir-request-article (article &optional group server to-buffer)
 721   (nnir-possibly-change-group group server)
 722   (if (and (stringp article)
 723            (not (eq 'nnimap (car (gnus-server-to-method server)))))
 724       (nnheader-report
 725        'nnir
 726        "nnir-request-article only groks message ids for nnimap servers: %s"
 727        server)
 728     (save-excursion
 729       (let ((article article)
 730             query)
 731         (when (stringp article)
 732           (setq gnus-override-method (gnus-server-to-method server))
 733           (setq query
 734                 (list
 735                  (cons 'query (format "HEADER Message-ID %s" article))
 736                  (cons 'criteria "")
 737                  (cons 'shortcut t)))
 738           (unless (and nnir-artlist (equal query nnir-memo-query)
 739                        (equal server nnir-memo-server))
 740             (setq nnir-artlist (nnir-run-imap query server)
 741                   nnir-memo-query query
 742                   nnir-memo-server server))
 743           (setq article 1))
 744         (unless (zerop (nnir-artlist-length nnir-artlist))
 745           (let ((artfullgroup (nnir-article-group article))
 746                 (artno (nnir-article-number article)))
 747             (message "Requesting article %d from group %s"
 748                      artno artfullgroup)
 749             (if to-buffer
 750                 (with-current-buffer to-buffer
 751                   (let ((gnus-article-decode-hook nil))
 752                     (gnus-request-article-this-buffer artno artfullgroup)))
 753               (gnus-request-article artno artfullgroup))
 754             (cons artfullgroup artno)))))))
 755
 756 (deffoo nnir-request-move-article (article group server accept-form
 757                                            &optional last internal-move-group)
 758   (nnir-possibly-change-group group server)
 759   (let* ((artfullgroup (nnir-article-group article))
 760          (artno (nnir-article-number article))
 761          (to-newsgroup (nth 1 accept-form))
 762          (to-method (gnus-find-method-for-group to-newsgroup))
 763          (from-method (gnus-find-method-for-group artfullgroup))
 764          (move-is-internal (gnus-server-equal from-method to-method)))
 765     (unless (gnus-check-backend-function
 766              'request-move-article artfullgroup)
 767       (error "The group %s does not support article moving" artfullgroup))
 768     (gnus-request-move-article
 769      artno
 770      artfullgroup
 771      (nth 1 from-method)
 772      accept-form
 773      last
 774      (and move-is-internal
 775           to-newsgroup          ; Not respooling
 776           (gnus-group-real-name to-newsgroup)))))
 777
 778 (deffoo nnir-request-expire-articles (articles group &optional server force)
 779   (nnir-possibly-change-group group server)
 780   (if force
 781     (let ((articles-by-group (nnir-categorize
 782                               articles nnir-article-group nnir-article-ids))
 783           not-deleted)
 784       (while (not (null articles-by-group))
 785         (let* ((group-articles (pop articles-by-group))
 786                (artgroup (car group-articles))
 787                (articleids (cadr group-articles))
 788                (artlist (sort (mapcar 'cdr articleids) '<)))
 789           (unless (gnus-check-backend-function 'request-expire-articles
 790                                                artgroup)
 791             (error "The group %s does not support article deletion" artgroup))
 792           (unless (gnus-check-server (gnus-find-method-for-group artgroup))
 793             (error "Couldn't open server for group %s" artgroup))
 794           (push (gnus-request-expire-articles
 795                  artlist artgroup force)
 796                 not-deleted)))
 797       (sort (delq nil not-deleted) '<))
 798     articles))
 799
 800 (deffoo nnir-warp-to-article ()
 801   (nnir-possibly-change-group gnus-newsgroup-name)
 802   (let* ((cur (if (> (gnus-summary-article-number) 0)
 803                   (gnus-summary-article-number)
 804                 (error "Can't warp to a pseudo-article")))
 805          (backend-article-group (nnir-article-group cur))
 806          (backend-article-number (nnir-article-number cur))
 807          (quit-config (gnus-ephemeral-group-p gnus-newsgroup-name)))
 808
 809     ;; what should we do here? we could leave all the buffers around
 810     ;; and assume that we have to exit from them one by one. or we can
 811     ;; try to clean up directly
 812
 813     ;;first exit from the nnir summary buffer.
 814 ;    (gnus-summary-exit)
 815     ;; and if the nnir summary buffer in turn came from another
 816     ;; summary buffer we have to clean that summary up too.
 817  ;   (when (not (eq (cdr quit-config) 'group))
 818 ;      (gnus-summary-exit))
 819     (gnus-summary-read-group-1 backend-article-group t t  nil
 820                                nil (list backend-article-number))))
 821
 822 (deffoo nnir-request-update-mark (group article mark)
 823   (let ((artgroup (nnir-article-group article))
 824         (artnumber (nnir-article-number article)))
 825     (or (and artgroup
 826              artnumber
 827              (gnus-request-update-mark artgroup artnumber mark))
 828         mark)))
 829
 830 (deffoo nnir-request-set-mark (group actions &optional server)
 831   (nnir-possibly-change-group group server)
 832   (let (mlist)
 833     (dolist (action actions)
 834       (destructuring-bind (range action marks) action
 835         (let ((articles-by-group (nnir-categorize
 836                                   (gnus-uncompress-range range)
 837                                   nnir-article-group nnir-article-number)))
 838           (dolist (artgroup articles-by-group)
 839             (push (list
 840                    (car artgroup)
 841                    (list (gnus-compress-sequence
 842                           (sort (cadr artgroup) '<)) action marks)) mlist)))))
 843     (dolist (request (nnir-categorize  mlist car cadr))
 844       (gnus-request-set-mark (car request) (cadr request)))))
 845
 846
 847 (deffoo nnir-request-update-info (group info &optional server)
 848   (nnir-possibly-change-group group server)
 849   ;; clear out all existing marks.
 850   (gnus-info-set-marks info nil)
 851   (gnus-info-set-read info nil)
 852   (let ((group (gnus-group-guess-full-name-from-command-method group))
 853         (articles-by-group
 854          (nnir-categorize
 855           (gnus-uncompress-range (cons 1 (nnir-artlist-length nnir-artlist)))
 856           nnir-article-group nnir-article-ids)))
 857     (gnus-set-active group
 858                      (cons 1 (nnir-artlist-length nnir-artlist)))
 859     (while (not (null articles-by-group))
 860       (let* ((group-articles (pop articles-by-group))
 861              (articleids (reverse (cadr group-articles)))
 862              (group-info (gnus-get-info (car group-articles)))
 863              (marks (gnus-info-marks group-info))
 864              (read (gnus-info-read group-info)))
 865         (gnus-info-set-read
 866          info
 867          (gnus-add-to-range
 868           (gnus-info-read info)
 869           (delq nil
 870                   (mapcar
 871                    #'(lambda (art)
 872                      (when (gnus-member-of-range (cdr art) read) (car art)))
 873                    articleids))))
 874         (dolist (mark marks)
 875           (destructuring-bind (type . range) mark
 876             (gnus-add-marked-articles
 877              group type
 878              (delq nil
 879                      (mapcar
 880                       #'(lambda (art)
 881                         (when (gnus-member-of-range (cdr art) range) (car art)))
 882                       articleids)))))))))
 883
 884
 885 (deffoo nnir-close-group (group &optional server)
 886   (nnir-possibly-change-group group server)
 887   (let ((pgroup (gnus-group-guess-full-name-from-command-method group)))
 888     (when (and nnir-artlist (not (gnus-ephemeral-group-p pgroup)))
 889       (gnus-group-set-parameter  pgroup 'nnir-artlist nnir-artlist))
 890     (setq nnir-artlist nil)
 891     (when (gnus-ephemeral-group-p pgroup)
 892       (gnus-kill-ephemeral-group pgroup)
 893       (setq gnus-ephemeral-servers
 894             (delq (assq 'nnir gnus-ephemeral-servers)
 895                   gnus-ephemeral-servers)))))
 896 ;; (gnus-opened-servers-remove
 897 ;;  (car (assoc  '(nnir "nnir-ephemeral" (nnir-address "nnir"))
 898 ;;              gnus-opened-servers))))
 899
 900
 901
 902
 903 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
 904   "Ask `nnir-compose-result' to construct a result vector,
 905 and if it is non-nil, add it to artlist."
 906   `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
 907      (when (not (null result))
 908        (push result ,artlist))))
 909
 910 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
 911
 912 ;; Helper function currently used by the Swish++ and Namazu backends;
 913 ;; perhaps useful for other backends as well
 914 (defun nnir-compose-result (dirnam article score prefix server)
 915   "Extract the group from dirnam, and create a result vector
 916 ready to be added to the list of search results."
 917
 918   ;; remove nnir-*-remove-prefix from beginning of dirnam filename
 919   (when (string-match (concat "^" prefix) dirnam)
 920     (setq dirnam (replace-match "" t t dirnam)))
 921
 922   (when (file-readable-p (concat prefix dirnam article))
 923     ;; remove trailing slash and, for nnmaildir, cur/new/tmp
 924     (setq dirnam
 925           (substring dirnam 0
 926                      (if (string-match "\\`nnmaildir:" (gnus-group-server server))
 927                          -5 -1)))
 928
 929     ;; Set group to dirnam without any leading dots or slashes,
 930     ;; and with all subsequent slashes replaced by dots
 931     (let ((group (replace-regexp-in-string
 932                   "[/\\]" "."
 933                   (replace-regexp-in-string "^[./\\]" "" dirnam nil t)
 934                   nil t)))
 935
 936     (vector (gnus-group-full-name group server)
 937             (if (string-match "\\`nnmaildir:" (gnus-group-server server))
 938                 (nnmaildir-base-name-to-article-number
 939                  (substring article 0 (string-match ":" article))
 940                  group nil)
 941               (string-to-number article))
 942             (string-to-number score)))))
 943
 944 ;;; Search Engine Interfaces:
 945
 946 (autoload 'nnimap-change-group "nnimap")
 947 (declare-function nnimap-buffer "nnimap" ())
 948 (declare-function nnimap-command "nnimap" (&rest args))
 949
 950 ;; imap interface
 951 (defun nnir-run-imap (query srv &optional groups)
 952   "Run a search against an IMAP back-end server.
 953 This uses a custom query language parser; see `nnir-imap-make-query' for
 954 details on the language and supported extensions."
 955   (save-excursion
 956     (let ((qstring (cdr (assq 'query query)))
 957           (server (cadr (gnus-server-to-method srv)))
 958           (defs (caddr (gnus-server-to-method srv)))
 959           (criteria (or (cdr (assq 'criteria query))
 960                         (cdr (assoc nnir-imap-default-search-key
 961                                     nnir-imap-search-arguments))))
 962           (gnus-inhibit-demon t)
 963           (groups (or groups (nnir-get-active srv))))
 964       (message "Opening server %s" server)
 965       (apply
 966        'vconcat
 967        (catch 'found
 968          (mapcar
 969           #'(lambda (group)
 970             (let (artlist)
 971               (condition-case ()
 972                   (when (nnimap-change-group
 973                          (gnus-group-short-name group) server)
 974                     (with-current-buffer (nnimap-buffer)
 975                       (message "Searching %s..." group)
 976                       (let ((arts 0)
 977                             (result (nnimap-command "UID SEARCH %s"
 978                                                     (if (string= criteria "")
 979                                                         qstring
 980                                                       (nnir-imap-make-query
 981                                                        criteria qstring)))))
 982                         (mapc
 983                          (lambda (artnum)
 984                            (let ((artn (string-to-number artnum)))
 985                              (when (> artn 0)
 986                                (push (vector group artn 100)
 987                                      artlist)
 988                                (when (assq 'shortcut query)
 989                                  (throw 'found (list artlist)))
 990                                (setq arts (1+ arts)))))
 991                          (and (car result)
 992                               (cdr (assoc "SEARCH" (cdr result)))))
 993                         (message "Searching %s... %d matches" group arts)))
 994                     (message "Searching %s...done" group))
 995                 (quit nil))
 996               (nreverse artlist)))
 997           groups))))))
 998
 999 (defun nnir-imap-make-query (criteria qstring)
1000   "Parse the query string and criteria into an appropriate IMAP search
1001 expression, returning the string query to make.
1002
1003 This implements a little language designed to return the expected results
1004 to an arbitrary query string to the end user.
1005
1006 The search is always case-insensitive, as defined by RFC2060, and supports
1007 the following features (inspired by the Google search input language):
1008
1009 Automatic \"and\" queries
1010     If you specify multiple words then they will be treated as an \"and\"
1011     expression intended to match all components.
1012
1013 Phrase searches
1014     If you wrap your query in double-quotes then it will be treated as a
1015     literal string.
1016
1017 Negative terms
1018     If you precede a term with \"-\" then it will negate that.
1019
1020 \"OR\" queries
1021     If you include an upper-case \"OR\" in your search it will cause the
1022     term before it and the term after it to be treated as alternatives.
1023
1024 In future the following will be added to the language:
1025  * support for date matches
1026  * support for location of text matching within the query
1027  * from/to/etc headers
1028  * additional search terms
1029  * flag based searching
1030  * anything else that the RFC supports, basically."
1031   ;; Walk through the query and turn it into an IMAP query string.
1032   (nnir-imap-query-to-imap criteria (nnir-imap-parse-query qstring)))
1033
1034
1035 (defun nnir-imap-query-to-imap (criteria query)
1036   "Turn a s-expression format query into IMAP."
1037   (mapconcat
1038    ;; Turn the expressions into IMAP text
1039    (lambda (item)
1040      (nnir-imap-expr-to-imap criteria item))
1041    ;; The query, already in s-expr format.
1042    query
1043    ;; Append a space between each expression
1044    " "))
1045
1046
1047 (defun nnir-imap-expr-to-imap (criteria expr)
1048   "Convert EXPR into an IMAP search expression on CRITERIA"
1049   ;; What sort of expression is this, eh?
1050   (cond
1051    ;; Simple string term
1052    ((stringp expr)
1053     (format "%s %S" criteria expr))
1054    ;; Trivial term: and
1055    ((eq expr 'and) nil)
1056    ;; Composite term: or expression
1057    ((eq (car-safe expr) 'or)
1058     (format "OR %s %s"
1059             (nnir-imap-expr-to-imap criteria (second expr))
1060             (nnir-imap-expr-to-imap criteria (third expr))))
1061    ;; Composite term: just the fax, mam
1062    ((eq (car-safe expr) 'not)
1063     (format "NOT (%s)" (nnir-imap-query-to-imap criteria (rest expr))))
1064    ;; Composite term: just expand it all.
1065    ((and (not (null expr)) (listp expr))
1066     (format "(%s)" (nnir-imap-query-to-imap criteria expr)))
1067    ;; Complex value, give up for now.
1068    (t (error "Unhandled input: %S" expr))))
1069
1070
1071 (defun nnir-imap-parse-query (string)
1072   "Turn STRING into an s-expression based query based on the IMAP
1073 query language as defined in `nnir-imap-make-query'.
1074
1075 This involves turning individual tokens into higher level terms
1076 that the search language can then understand and use."
1077   (with-temp-buffer
1078     ;; Set up the parsing environment.
1079     (insert string)
1080     (goto-char (point-min))
1081     ;; Now, collect the output terms and return them.
1082     (let (out)
1083       (while (not (nnir-imap-end-of-input))
1084         (push (nnir-imap-next-expr) out))
1085       (reverse out))))
1086
1087
1088 (defun nnir-imap-next-expr (&optional count)
1089   "Return the next expression from the current buffer."
1090   (let ((term (nnir-imap-next-term count))
1091         (next (nnir-imap-peek-symbol)))
1092     ;; Are we looking at an 'or' expression?
1093     (cond
1094      ;; Handle 'expr or expr'
1095      ((eq next 'or)
1096       (list 'or term (nnir-imap-next-expr 2)))
1097      ;; Anything else
1098      (t term))))
1099
1100
1101 (defun nnir-imap-next-term (&optional count)
1102   "Return the next TERM from the current buffer."
1103   (let ((term (nnir-imap-next-symbol count)))
1104     ;; What sort of term is this?
1105     (cond
1106      ;; and -- just ignore it
1107      ((eq term 'and) 'and)
1108      ;; negated term
1109      ((eq term 'not) (list 'not (nnir-imap-next-expr)))
1110      ;; generic term
1111      (t term))))
1112
1113
1114 (defun nnir-imap-peek-symbol ()
1115   "Return the next symbol from the current buffer, but don't consume it."
1116   (save-excursion
1117     (nnir-imap-next-symbol)))
1118
1119 (defun nnir-imap-next-symbol (&optional count)
1120   "Return the next symbol from the current buffer, or nil if we are
1121 at the end of the buffer.  If supplied COUNT skips some symbols before
1122 returning the one at the supplied position."
1123   (when (and (numberp count) (> count 1))
1124     (nnir-imap-next-symbol (1- count)))
1125   (let ((case-fold-search t))
1126     ;; end of input stream?
1127     (unless (nnir-imap-end-of-input)
1128       ;; No, return the next symbol from the stream.
1129       (cond
1130        ;; negated expression -- return it and advance one char.
1131        ((looking-at "-") (forward-char 1) 'not)
1132        ;; quoted string
1133        ((looking-at "\"") (nnir-imap-delimited-string "\""))
1134        ;; list expression -- we parse the content and return this as a list.
1135        ((looking-at "(")
1136         (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
1137        ;; keyword input -- return a symbol version
1138        ((looking-at "\\band\\b") (forward-char 3) 'and)
1139        ((looking-at "\\bor\\b")  (forward-char 2) 'or)
1140        ((looking-at "\\bnot\\b") (forward-char 3) 'not)
1141        ;; Simple, boring keyword
1142        (t (let ((start (point))
1143                 (end (if (search-forward-regexp "[[:blank:]]" nil t)
1144                          (prog1
1145                              (match-beginning 0)
1146                            ;; unskip if we hit a non-blank terminal character.
1147                            (when (string-match "[^[:blank:]]" (match-string 0))
1148                              (backward-char 1)))
1149                        (goto-char (point-max)))))
1150             (buffer-substring start end)))))))
1151
1152 (defun nnir-imap-delimited-string (delimiter)
1153   "Return a delimited string from the current buffer."
1154   (let ((start (point)) end)
1155     (forward-char 1)                    ; skip the first delimiter.
1156     (while (not end)
1157       (unless (search-forward delimiter nil t)
1158         (error "Unmatched delimited input with %s in query" delimiter))
1159       (let ((here (point)))
1160         (unless (equal (buffer-substring (- here 2) (- here 1)) "\\")
1161           (setq end (point)))))
1162     (buffer-substring (1+ start) (1- end))))
1163
1164 (defun nnir-imap-end-of-input ()
1165   "Are we at the end of input?"
1166   (skip-chars-forward "[[:blank:]]")
1167   (looking-at "$"))
1168
1169
1170 ;; Swish++ interface.
1171 ;; -cc- Todo
1172 ;; Search by
1173 ;; - group
1174 ;; Sort by
1175 ;; - rank (default)
1176 ;; - article number
1177 ;; - file size
1178 ;; - group
1179 (defun nnir-run-swish++ (query server &optional group)
1180   "Run QUERY against swish++.
1181 Returns a vector of (group name, file name) pairs (also vectors,
1182 actually).
1183
1184 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
1185 Windows NT 4.0."
1186
1187   ;; (when group
1188   ;;   (error "The swish++ backend cannot search specific groups"))
1189
1190   (save-excursion
1191     (let ( (qstring (cdr (assq 'query query)))
1192            (groupspec (cdr (assq 'swish++-group query)))
1193            (prefix (nnir-read-server-parm 'nnir-swish++-remove-prefix server))
1194            artlist
1195            ;; nnml-use-compressed-files might be any string, but probably this
1196            ;; is sufficient.  Note that we can't only use the value of
1197            ;; nnml-use-compressed-files because old articles might have been
1198            ;; saved with a different value.
1199            (article-pattern (if (string-match "\\`nnmaildir:"
1200                                               (gnus-group-server server))
1201                                 ":[0-9]+"
1202                               "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
1203            score artno dirnam filenam)
1204
1205       (when (equal "" qstring)
1206         (error "swish++: You didn't enter anything"))
1207
1208       (set-buffer (get-buffer-create nnir-tmp-buffer))
1209       (erase-buffer)
1210
1211       (if groupspec
1212           (message "Doing swish++ query %s on %s..." qstring groupspec)
1213         (message "Doing swish++ query %s..." qstring))
1214
1215       (let* ((cp-list `( ,nnir-swish++-program
1216                          nil            ; input from /dev/null
1217                          t              ; output
1218                          nil            ; don't redisplay
1219                          "--config-file" ,(nnir-read-server-parm 'nnir-swish++-configuration-file server)
1220                          ,@(nnir-read-server-parm 'nnir-swish++-additional-switches server)
1221                          ,qstring       ; the query, in swish++ format
1222                          ))
1223              (exitstatus
1224               (progn
1225                 (message "%s args: %s" nnir-swish++-program
1226                          (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1227                 (apply 'call-process cp-list))))
1228         (unless (or (null exitstatus)
1229                     (zerop exitstatus))
1230           (nnheader-report 'nnir "Couldn't run swish++: %s" exitstatus)
1231           ;; swish++ failure reason is in this buffer, show it if
1232           ;; the user wants it.
1233           (when (> gnus-verbose 6)
1234             (display-buffer nnir-tmp-buffer))))
1235
1236       ;; The results are output in the format of:
1237       ;; V 4.7 Linux
1238       ;; rank relative-path-name file-size file-title
1239       ;; V 5.0b2:
1240       ;; rank relative-path-name file-size topic??
1241       ;; where rank is an integer from 1 to 100.
1242       (goto-char (point-min))
1243       (while (re-search-forward
1244               "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t)
1245         (setq score (match-string 1)
1246               filenam (match-string 2)
1247               artno (file-name-nondirectory filenam)
1248               dirnam (file-name-directory filenam))
1249
1250         ;; don't match directories
1251         (when (string-match article-pattern artno)
1252           (when (not (null dirnam))
1253
1254             ;; maybe limit results to matching groups.
1255             (when (or (not groupspec)
1256                       (string-match groupspec dirnam))
1257               (nnir-add-result dirnam artno score prefix server artlist)))))
1258
1259       (message "Massaging swish++ output...done")
1260
1261       ;; Sort by score
1262       (apply 'vector
1263              (sort artlist
1264                    (function (lambda (x y)
1265                                (> (nnir-artitem-rsv x)
1266                                   (nnir-artitem-rsv y)))))))))
1267
1268 ;; Swish-E interface.
1269 (defun nnir-run-swish-e (query server &optional group)
1270   "Run given query against swish-e.
1271 Returns a vector of (group name, file name) pairs (also vectors,
1272 actually).
1273
1274 Tested with swish-e-2.0.1 on Windows NT 4.0."
1275
1276   ;; swish-e crashes with empty parameter to "-w" on commandline...
1277   ;; (when group
1278   ;;   (error "The swish-e backend cannot search specific groups"))
1279
1280   (save-excursion
1281     (let ((qstring (cdr (assq 'query query)))
1282           (prefix
1283            (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server)
1284                (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1285           artlist score artno dirnam group )
1286
1287       (when (equal "" qstring)
1288         (error "swish-e: You didn't enter anything"))
1289
1290       (set-buffer (get-buffer-create nnir-tmp-buffer))
1291       (erase-buffer)
1292
1293       (message "Doing swish-e query %s..." query)
1294       (let* ((index-files
1295               (or (nnir-read-server-parm
1296                    'nnir-swish-e-index-files server)
1297                   (error "Missing parameter `nnir-swish-e-index-files'")))
1298              (additional-switches
1299               (nnir-read-server-parm
1300                'nnir-swish-e-additional-switches server))
1301              (cp-list `(,nnir-swish-e-program
1302                         nil             ; input from /dev/null
1303                         t               ; output
1304                         nil             ; don't redisplay
1305                         "-f" ,@index-files
1306                         ,@additional-switches
1307                         "-w"
1308                         ,qstring        ; the query, in swish-e format
1309                         ))
1310              (exitstatus
1311               (progn
1312                 (message "%s args: %s" nnir-swish-e-program
1313                          (mapconcat 'identity (cddddr cp-list) " "))
1314                 (apply 'call-process cp-list))))
1315         (unless (or (null exitstatus)
1316                     (zerop exitstatus))
1317           (nnheader-report 'nnir "Couldn't run swish-e: %s" exitstatus)
1318           ;; swish-e failure reason is in this buffer, show it if
1319           ;; the user wants it.
1320           (when (> gnus-verbose 6)
1321             (display-buffer nnir-tmp-buffer))))
1322
1323       ;; The results are output in the format of:
1324       ;; rank path-name file-title file-size
1325       (goto-char (point-min))
1326       (while (re-search-forward
1327               "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t)
1328         (setq score (match-string 1)
1329               artno (match-string 3)
1330               dirnam (file-name-directory (match-string 2)))
1331
1332         ;; don't match directories
1333         (when (string-match "^[0-9]+$" artno)
1334           (when (not (null dirnam))
1335
1336             ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1337             (when (string-match (concat "^" prefix) dirnam)
1338               (setq dirnam (replace-match "" t t dirnam)))
1339
1340             (setq dirnam (substring dirnam 0 -1))
1341             ;; eliminate all ".", "/", "\" from beginning. Always matches.
1342             (string-match "^[./\\]*\\(.*\\)$" dirnam)
1343             ;; "/" -> "."
1344             (setq group (replace-regexp-in-string
1345                          "/" "." (match-string 1 dirnam)))
1346             ;; Windows "\\" -> "."
1347             (setq group (replace-regexp-in-string "\\\\" "." group))
1348
1349             (push (vector (gnus-group-full-name group server)
1350                           (string-to-number artno)
1351                           (string-to-number score))
1352                   artlist))))
1353
1354       (message "Massaging swish-e output...done")
1355
1356       ;; Sort by score
1357       (apply 'vector
1358              (sort artlist
1359                    (function (lambda (x y)
1360                                (> (nnir-artitem-rsv x)
1361                                   (nnir-artitem-rsv y)))))))))
1362
1363 ;; HyREX interface
1364 (defun nnir-run-hyrex (query server &optional group)
1365   (save-excursion
1366     (let ((artlist nil)
1367           (groupspec (cdr (assq 'hyrex-group query)))
1368           (qstring (cdr (assq 'query query)))
1369           (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server))
1370           score artno dirnam)
1371       (when (and (not groupspec) group)
1372         (setq groupspec
1373               (regexp-opt
1374                (mapcar (lambda (x) (gnus-group-real-name x)) group))))
1375       (set-buffer (get-buffer-create nnir-tmp-buffer))
1376       (erase-buffer)
1377       (message "Doing hyrex-search query %s..." query)
1378       (let* ((cp-list
1379               `( ,nnir-hyrex-program
1380                  nil                    ; input from /dev/null
1381                  t                      ; output
1382                  nil                    ; don't redisplay
1383                  "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server) ; index directory
1384                  ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server)
1385                  ,qstring          ; the query, in hyrex-search format
1386                  ))
1387              (exitstatus
1388               (progn
1389                 (message "%s args: %s" nnir-hyrex-program
1390                          (mapconcat 'identity (cddddr cp-list) " "))
1391                 (apply 'call-process cp-list))))
1392         (unless (or (null exitstatus)
1393                     (zerop exitstatus))
1394           (nnheader-report 'nnir "Couldn't run hyrex-search: %s" exitstatus)
1395           ;; nnir-search failure reason is in this buffer, show it if
1396           ;; the user wants it.
1397           (when (> gnus-verbose 6)
1398             (display-buffer nnir-tmp-buffer)))) ;; FIXME: Don't clear buffer !
1399       (message "Doing hyrex-search query \"%s\"...done" qstring)
1400       (sit-for 0)
1401       ;; nnir-search returns:
1402       ;;   for nnml/nnfolder: "filename mailid weight"
1403       ;;   for nnimap:        "group mailid weight"
1404       (goto-char (point-min))
1405       (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1406       ;; HyREX doesn't search directly in groups -- so filter out here.
1407       (when groupspec
1408         (keep-lines groupspec))
1409       ;; extract data from result lines
1410       (goto-char (point-min))
1411       (while (re-search-forward
1412               "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t)
1413         (setq dirnam (match-string 1)
1414               artno (match-string 2)
1415               score (match-string 3))
1416         (when (string-match prefix dirnam)
1417           (setq dirnam (replace-match "" t t dirnam)))
1418         (push (vector (gnus-group-full-name
1419                        (replace-regexp-in-string "/" "." dirnam) server)
1420                       (string-to-number artno)
1421                       (string-to-number score))
1422               artlist))
1423       (message "Massaging hyrex-search output...done.")
1424       (apply 'vector
1425              (sort artlist
1426                    (function (lambda (x y)
1427                                (if (string-lessp (nnir-artitem-group x)
1428                                                  (nnir-artitem-group y))
1429                                    t
1430                                  (< (nnir-artitem-number x)
1431                                     (nnir-artitem-number y)))))))
1432       )))
1433
1434 ;; Namazu interface
1435 (defun nnir-run-namazu (query server &optional group)
1436   "Run given query against Namazu.  Returns a vector of (group name, file name)
1437 pairs (also vectors, actually).
1438
1439 Tested with Namazu 2.0.6 on a GNU/Linux system."
1440   ;; (when group
1441   ;;   (error "The Namazu backend cannot search specific groups"))
1442   (save-excursion
1443     (let ((article-pattern (if (string-match "\\`nnmaildir:"
1444                                              (gnus-group-server server))
1445                                ":[0-9]+"
1446                              "^[0-9]+$"))
1447           artlist
1448           (qstring (cdr (assq 'query query)))
1449           (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server))
1450           score group article
1451           (process-environment (copy-sequence process-environment)))
1452       (setenv "LC_MESSAGES" "C")
1453       (set-buffer (get-buffer-create nnir-tmp-buffer))
1454       (erase-buffer)
1455       (let* ((cp-list
1456               `( ,nnir-namazu-program
1457                  nil                    ; input from /dev/null
1458                  t                      ; output
1459                  nil                    ; don't redisplay
1460                  "-q"                   ; don't be verbose
1461                  "-a"                   ; show all matches
1462                  "-s"                   ; use short format
1463                  ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server)
1464                  ,qstring               ; the query, in namazu format
1465                  ,(nnir-read-server-parm 'nnir-namazu-index-directory server) ; index directory
1466                  ))
1467              (exitstatus
1468               (progn
1469                 (message "%s args: %s" nnir-namazu-program
1470                          (mapconcat 'identity (cddddr cp-list) " "))
1471                 (apply 'call-process cp-list))))
1472         (unless (or (null exitstatus)
1473                     (zerop exitstatus))
1474           (nnheader-report 'nnir "Couldn't run namazu: %s" exitstatus)
1475           ;; Namazu failure reason is in this buffer, show it if
1476           ;; the user wants it.
1477           (when (> gnus-verbose 6)
1478             (display-buffer nnir-tmp-buffer))))
1479
1480       ;; Namazu output looks something like this:
1481       ;; 2. Re: Gnus agent expire broken (score: 55)
1482       ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1483
1484       (goto-char (point-min))
1485       (while (re-search-forward
1486               "^\\([0-9,]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1487               nil t)
1488         (setq score (match-string 3)
1489               group (file-name-directory (match-string 4))
1490               article (file-name-nondirectory (match-string 4)))
1491
1492         ;; make sure article and group is sane
1493         (when (and (string-match article-pattern article)
1494                    (not (null group)))
1495           (nnir-add-result group article score prefix server artlist)))
1496
1497       ;; sort artlist by score
1498       (apply 'vector
1499              (sort artlist
1500                    (function (lambda (x y)
1501                                (> (nnir-artitem-rsv x)
1502                                   (nnir-artitem-rsv y)))))))))
1503
1504 (defun nnir-run-notmuch (query server &optional group)
1505   "Run QUERY against notmuch.
1506 Returns a vector of (group name, file name) pairs (also vectors,
1507 actually)."
1508
1509   ;; (when group
1510   ;;   (error "The notmuch backend cannot search specific groups"))
1511
1512   (save-excursion
1513     (let ( (qstring (cdr (assq 'query query)))
1514            (groupspec (cdr (assq 'notmuch-group query)))
1515            (prefix (nnir-read-server-parm 'nnir-notmuch-remove-prefix server))
1516            artlist
1517            (article-pattern (if (string-match "\\`nnmaildir:"
1518                                               (gnus-group-server server))
1519                                ":[0-9]+"
1520                              "^[0-9]+$"))
1521            artno dirnam filenam)
1522
1523       (when (equal "" qstring)
1524         (error "notmuch: You didn't enter anything"))
1525
1526       (set-buffer (get-buffer-create nnir-tmp-buffer))
1527       (erase-buffer)
1528
1529       (if groupspec
1530           (message "Doing notmuch query %s on %s..." qstring groupspec)
1531         (message "Doing notmuch query %s..." qstring))
1532
1533       (let* ((cp-list `( ,nnir-notmuch-program
1534                          nil            ; input from /dev/null
1535                          t              ; output
1536                          nil            ; don't redisplay
1537                          "search"
1538                          "--format=text"
1539                          "--output=files"
1540                          ,@(nnir-read-server-parm 'nnir-notmuch-additional-switches server)
1541                          ,qstring       ; the query, in notmuch format
1542                          ))
1543              (exitstatus
1544               (progn
1545                 (message "%s args: %s" nnir-notmuch-program
1546                          (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1547                 (apply 'call-process cp-list))))
1548         (unless (or (null exitstatus)
1549                     (zerop exitstatus))
1550           (nnheader-report 'nnir "Couldn't run notmuch: %s" exitstatus)
1551           ;; notmuch failure reason is in this buffer, show it if
1552           ;; the user wants it.
1553           (when (> gnus-verbose 6)
1554             (display-buffer nnir-tmp-buffer))))
1555
1556       ;; The results are output in the format of:
1557       ;; absolute-path-name
1558       (goto-char (point-min))
1559       (while (not (eobp))
1560         (setq filenam (buffer-substring-no-properties (line-beginning-position)
1561                                                       (line-end-position))
1562               artno (file-name-nondirectory filenam)
1563               dirnam (file-name-directory filenam))
1564         (forward-line 1)
1565
1566         ;; don't match directories
1567         (when (string-match article-pattern artno)
1568           (when (not (null dirnam))
1569
1570             ;; maybe limit results to matching groups.
1571             (when (or (not groupspec)
1572                       (string-match groupspec dirnam))
1573               (nnir-add-result dirnam artno "" prefix server artlist)))))
1574
1575       (message "Massaging notmuch output...done")
1576
1577       artlist)))
1578
1579 (defun nnir-run-find-grep (query server &optional grouplist)
1580   "Run find and grep to obtain matching articles."
1581   (let* ((method (gnus-server-to-method server))
1582          (sym (intern
1583                (concat (symbol-name (car method)) "-directory")))
1584          (directory (cadr (assoc sym (cddr method))))
1585          (regexp (cdr (assoc 'query query)))
1586          (grep-options (cdr (assoc 'grep-options query)))
1587          (grouplist (or grouplist (nnir-get-active server))))
1588     (unless directory
1589       (error "No directory found in method specification of server %s"
1590              server))
1591     (apply
1592      'vconcat
1593      (mapcar (lambda (x)
1594                (let ((group x)
1595                      artlist)
1596                  (message "Searching %s using find-grep..."
1597                           (or group server))
1598                  (save-window-excursion
1599                    (set-buffer (get-buffer-create nnir-tmp-buffer))
1600                    (if (> gnus-verbose 6)
1601                        (pop-to-buffer (current-buffer)))
1602                    (cd directory) ; Using relative paths simplifies
1603                                         ; postprocessing.
1604                    (let ((group
1605                           (if (not group)
1606                               "."
1607                             ;; Try accessing the group literally as
1608                             ;; well as interpreting dots as directory
1609                             ;; separators so the engine works with
1610                             ;; plain nnml as well as the Gnus Cache.
1611                             (let ((group (gnus-group-real-name group)))
1612                               ;; Replace cl-func find-if.
1613                               (if (file-directory-p group)
1614                                   group
1615                                 (if (file-directory-p
1616                                      (setq group
1617                                            (replace-regexp-in-string
1618                                             "\\." "/"
1619                                             group nil t)))
1620                                     group))))))
1621                      (unless group
1622                        (error "Cannot locate directory for group"))
1623                      (save-excursion
1624                        (apply
1625                         'call-process "find" nil t
1626                         "find" group "-maxdepth" "1" "-type" "f"
1627                         "-name" "[0-9]*" "-exec"
1628                         "grep"
1629                         `("-l" ,@(and grep-options
1630                                       (split-string grep-options "\\s-" t))
1631                           "-e" ,regexp "{}" "+"))))
1632
1633                    ;; Translate relative paths to group names.
1634                    (while (not (eobp))
1635                      (let* ((path (split-string
1636                                    (buffer-substring
1637                                     (point)
1638                                     (line-end-position)) "/" t))
1639                             (art (string-to-number (car (last path)))))
1640                        (while (string= "." (car path))
1641                          (setq path (cdr path)))
1642                        (let ((group (mapconcat 'identity
1643                                                ;; Replace cl-func:
1644                                                ;; (subseq path 0 -1)
1645                                                (let ((end (1- (length path)))
1646                                                      res)
1647                                                  (while
1648                                                      (>= (setq end (1- end)) 0)
1649                                                    (push (pop path) res))
1650                                                  (nreverse res))
1651                                                ".")))
1652                          (push
1653                           (vector (gnus-group-full-name group server) art 0)
1654                           artlist))
1655                        (forward-line 1)))
1656                    (message "Searching %s using find-grep...done"
1657                             (or group server))
1658                    artlist)))
1659      grouplist))))
1660
1661 (declare-function mm-url-insert "mm-url" (url &optional follow-refresh))
1662 (declare-function mm-url-encode-www-form-urlencoded "mm-url" (pairs))
1663
1664 ;; gmane interface
1665 (defun nnir-run-gmane (query srv &optional groups)
1666   "Run a search against a gmane back-end server."
1667       (let* ((case-fold-search t)
1668              (qstring (cdr (assq 'query query)))
1669              (server (cadr (gnus-server-to-method srv)))
1670              (groupspec (mapconcat
1671                          (lambda (x)
1672                            (if (string-match-p "gmane" x)
1673                                (format "group:%s" (gnus-group-short-name x))
1674                              (error "Can't search non-gmane groups: %s" x)))
1675                            groups " "))
1676              (authorspec
1677               (if (assq 'gmane-author query)
1678                   (format "author:%s" (cdr (assq 'gmane-author query))) ""))
1679              (search (format "%s %s %s"
1680                              qstring groupspec authorspec))
1681              (gnus-inhibit-demon t)
1682              artlist)
1683         (require 'mm-url)
1684         (with-current-buffer (get-buffer-create nnir-tmp-buffer)
1685           (erase-buffer)
1686           (mm-url-insert
1687            (concat
1688             "http://search.gmane.org/nov.php"
1689             "?"
1690             (mm-url-encode-www-form-urlencoded
1691              `(("query" . ,search)
1692                ("HITSPERPAGE" . "999")))))
1693           (set-buffer-multibyte t)
1694           (decode-coding-region (point-min) (point-max) 'utf-8)
1695           (goto-char (point-min))
1696           (forward-line 1)
1697           (while (not (eobp))
1698             (unless (or (eolp) (looking-at "\x0d"))
1699               (let ((header (nnheader-parse-nov)))
1700                 (let ((xref (mail-header-xref header))
1701                       (xscore (string-to-number (cdr (assoc 'X-Score
1702                                (mail-header-extra header))))))
1703                   (when (string-match " \\([^:]+\\)[:/]\\([0-9]+\\)" xref)
1704                     (push
1705                      (vector
1706                       (gnus-group-prefixed-name (match-string 1 xref) srv)
1707                       (string-to-number (match-string 2 xref)) xscore)
1708                      artlist)))))
1709             (forward-line 1)))
1710         (apply 'vector (nreverse (delete-dups artlist)))))
1711
1712 ;;; Util Code:
1713
1714 (defun gnus-nnir-group-p (group)
1715   "Say whether GROUP is nnir or not."
1716   (if (gnus-group-prefixed-p group)
1717       (eq 'nnir (car (gnus-find-method-for-group group)))
1718     (and group (string-match "^nnir" group))))
1719
1720 (defun nnir-read-parms (nnir-search-engine)
1721   "Reads additional search parameters according to `nnir-engines'."
1722   (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines))))
1723     (mapcar 'nnir-read-parm parmspec)))
1724
1725 (defun nnir-read-parm (parmspec)
1726   "Reads a single search parameter.
1727 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1728   (let ((sym (car parmspec))
1729         (prompt (cdr parmspec)))
1730     (if (listp prompt)
1731         (let* ((result (apply 'gnus-completing-read prompt))
1732                (mapping (or (assoc result nnir-imap-search-arguments)
1733                             (cons nil nnir-imap-search-other))))
1734           (cons sym (format (cdr mapping) result)))
1735       (cons sym (read-string prompt)))))
1736
1737 (defun nnir-run-query (specs)
1738   "Invoke appropriate search engine function (see `nnir-engines')."
1739   (apply 'vconcat
1740          (mapcar
1741           (lambda (x)
1742             (let* ((server (car x))
1743                    (search-engine (nnir-server-to-search-engine server))
1744                    (search-func (cadr (assoc search-engine nnir-engines))))
1745               (and search-func
1746                    (funcall search-func (cdr (assq 'nnir-query-spec specs))
1747                             server (cadr x)))))
1748           (cdr (assq 'nnir-group-spec specs)))))
1749
1750 (defun nnir-server-to-search-engine (server)
1751   (or (nnir-read-server-parm 'nnir-search-engine server t)
1752       (cdr (assoc (car (gnus-server-to-method server))
1753                   nnir-method-default-engines))))
1754
1755 (defun nnir-read-server-parm (key server &optional not-global)
1756   "Returns the parameter value corresponding to `key' for
1757 `server'. If no server-specific value is found consult the global
1758 environment unless `not-global' is non-nil."
1759   (let ((method (gnus-server-to-method server)))
1760     (cond ((and method (assq key (cddr method)))
1761            (nth 1 (assq key (cddr method))))
1762           ((and (not not-global) (boundp key)) (symbol-value key))
1763           (t nil))))
1764
1765 (defun nnir-possibly-change-group (group &optional server)
1766   (or (not server) (nnir-server-opened server) (nnir-open-server server))
1767   (when (gnus-nnir-group-p group)
1768     (setq nnir-artlist (gnus-group-get-parameter
1769                         (gnus-group-prefixed-name
1770                          (gnus-group-short-name group) '(nnir "nnir"))
1771                         'nnir-artlist t))))
1772
1773 (defun nnir-server-opened (&optional server)
1774   (let ((backend (car (gnus-server-to-method server))))
1775     (nnoo-current-server-p (or backend 'nnir) server)))
1776
1777 (autoload 'nnimap-make-thread-query "nnimap")
1778 (declare-function gnus-registry-get-id-key "gnus-registry" (id key))
1779
1780 (defun nnir-search-thread (header)
1781   "Make an nnir group based on the thread containing the article
1782 header. The current server will be searched. If the registry is
1783 installed, the server that the registry reports the current
1784 article came from is also searched."
1785   (let* ((query
1786           (list (cons 'query (nnimap-make-thread-query header))
1787                 (cons 'criteria "")))
1788          (server
1789           (list (list (gnus-method-to-server
1790            (gnus-find-method-for-group gnus-newsgroup-name)))))
1791          (registry-group (and
1792                           (bound-and-true-p gnus-registry-enabled)
1793                           (car (gnus-registry-get-id-key
1794                                 (mail-header-id header) 'group))))
1795          (registry-server
1796           (and registry-group
1797                (gnus-method-to-server
1798                 (gnus-find-method-for-group registry-group)))))
1799     (when registry-server (add-to-list 'server (list registry-server)))
1800     (gnus-group-make-nnir-group nil (list
1801                                      (cons 'nnir-query-spec query)
1802                                      (cons 'nnir-group-spec server)))
1803     (gnus-summary-goto-subject (gnus-id-to-article (mail-header-id header)))))
1804
1805 (defun nnir-get-active (srv)
1806   (let ((method (gnus-server-to-method srv))
1807         groups)
1808     (gnus-request-list method)
1809     (with-current-buffer nntp-server-buffer
1810       (let ((cur (current-buffer))
1811             name)
1812         (goto-char (point-min))
1813         (unless (or (null nnir-ignored-newsgroups)
1814                     (string= nnir-ignored-newsgroups ""))
1815           (delete-matching-lines nnir-ignored-newsgroups))
1816         (if (eq (car method) 'nntp)
1817             (while (not (eobp))
1818               (ignore-errors
1819                 (push (string-as-unibyte
1820                        (gnus-group-full-name
1821                         (buffer-substring
1822                          (point)
1823                          (progn
1824                            (skip-chars-forward "^ \t")
1825                            (point)))
1826                         method))
1827                       groups))
1828               (forward-line))
1829           (while (not (eobp))
1830             (ignore-errors
1831               (push (string-as-unibyte
1832                      (if (eq (char-after) ?\")
1833                          (gnus-group-full-name (read cur) method)
1834                        (let ((p (point)) (name ""))
1835                          (skip-chars-forward "^ \t\\\\")
1836                          (setq name (buffer-substring p (point)))
1837                          (while (eq (char-after) ?\\)
1838                            (setq p (1+ (point)))
1839                            (forward-char 2)
1840                            (skip-chars-forward "^ \t\\\\")
1841                            (setq name (concat name (buffer-substring
1842                                                     p (point)))))
1843                          (gnus-group-full-name name method))))
1844                     groups))
1845             (forward-line)))))
1846     groups))
1847
1848 ;; Behind gnus-registry-enabled test.
1849 (declare-function gnus-registry-action "gnus-registry"
1850                   (action data-header from &optional to method))
1851
1852 (defun nnir-registry-action (action data-header from &optional to method)
1853   "Call `gnus-registry-action' with the original article group."
1854   (gnus-registry-action
1855    action
1856    data-header
1857    (nnir-article-group (mail-header-number data-header))
1858    to
1859    method))
1860
1861 (defun nnir-mode ()
1862   (when (eq (car (gnus-find-method-for-group gnus-newsgroup-name)) 'nnir)
1863     (setq gnus-summary-line-format
1864           (or nnir-summary-line-format gnus-summary-line-format))
1865     (when (bound-and-true-p gnus-registry-enabled)
1866       (remove-hook 'gnus-summary-article-delete-hook 'gnus-registry-action t)
1867       (remove-hook 'gnus-summary-article-move-hook 'gnus-registry-action t)
1868       (remove-hook 'gnus-summary-article-expire-hook 'gnus-registry-action t)
1869       (add-hook 'gnus-summary-article-delete-hook 'nnir-registry-action t t)
1870       (add-hook 'gnus-summary-article-move-hook 'nnir-registry-action t t)
1871       (add-hook 'gnus-summary-article-expire-hook 'nnir-registry-action t t))))
1872
1873
1874 (defun gnus-summary-create-nnir-group ()
1875   (interactive)
1876   (or (nnir-server-opened "") (nnir-open-server "nnir"))
1877   (let ((name (gnus-read-group "Group name: "))
1878         (method '(nnir ""))
1879         (pgroup
1880          (gnus-group-guess-full-name-from-command-method gnus-newsgroup-name)))
1881     (with-current-buffer gnus-group-buffer
1882       (gnus-group-make-group
1883        name method nil
1884        (gnus-group-find-parameter pgroup)))))
1885
1886
1887 (deffoo nnir-request-create-group (group &optional server args)
1888   (message "Creating nnir group %s" group)
1889   (let* ((group (gnus-group-prefixed-name  group '(nnir "nnir")))
1890          (specs (assq 'nnir-specs args))
1891          (query-spec
1892           (or (cdr (assq 'nnir-query-spec specs))
1893               (list (cons 'query
1894                           (read-string "Query: " nil 'nnir-search-history)))))
1895          (group-spec
1896           (or (cdr (assq 'nnir-group-spec specs))
1897               (list (list (read-string "Server: " nil nil)))))
1898          (nnir-specs (list (cons 'nnir-query-spec query-spec)
1899                            (cons 'nnir-group-spec group-spec))))
1900     (gnus-group-set-parameter group 'nnir-specs nnir-specs)
1901     (gnus-group-set-parameter
1902      group 'nnir-artlist
1903      (or (cdr (assq 'nnir-artlist args))
1904          (nnir-run-query nnir-specs)))
1905     (nnir-request-update-info group (gnus-get-info group)))
1906   t)
1907
1908 (deffoo nnir-request-delete-group (group &optional force server)
1909   t)
1910
1911 (deffoo nnir-request-list (&optional server)
1912   t)
1913
1914 (deffoo nnir-request-scan (group method)
1915   t)
1916
1917 (deffoo nnir-request-close ()
1918   t)
1919
1920 (nnoo-define-skeleton nnir)
1921
1922 ;; The end.
1923 (provide 'nnir)
1924
1925 ;;; nnir.el ends here