cgit.sxemacs.org Git - gnus/blob - lisp/nnir.el

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