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, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   4 ;;   2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Kai Großjohann <grossjohann@ls6.cs.uni-dortmund.de>
   7 ;; Swish-e and Swish++ backends by:
   8 ;;   Christoph Conrad <christoph.conrad@gmx.de>.
   9 ;; IMAP backend by: Simon Josefsson <jas@pdc.kth.se>.
  10 ;; IMAP search by: Torsten Hilbrich <torsten.hilbrich <at> gmx.net>
  11 ;; IMAP search improved by Daniel Pittman  <daniel@rimspace.net>.
  12 ;; nnmaildir support for Swish++ and Namazu backends by:
  13 ;;   Justus Piater <Justus <at> Piater.name>
  14 ;; Keywords: news mail searching ir
  15
  16 ;; This file is part of GNU Emacs.
  17
  18 ;; GNU Emacs is free software: you can redistribute it and/or modify
  19 ;; it under the terms of the GNU General Public License as published by
  20 ;; the Free Software Foundation, either version 3 of the License, or
  21 ;; (at your option) any later version.
  22
  23 ;; GNU Emacs is distributed in the hope that it will be useful,
  24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26 ;; GNU General Public License for more details.
  27
  28 ;; You should have received a copy of the GNU General Public License
  29 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  30
  31 ;;; Commentary:
  32
  33 ;; TODO: Documentation in the Gnus manual
  34
  35 ;; Where in the existing gnus manual would this fit best?
  36
  37 ;; What does it do?  Well, it allows you to search your mail using
  38 ;; some search engine (imap, namazu, swish-e, gmane and others -- see
  39 ;; later) by typing `G G' in the Group buffer.  You will then get a
  40 ;; buffer which shows all articles matching the query, sorted by
  41 ;; Retrieval Status Value (score).
  42
  43 ;; When looking at the retrieval result (in the Summary buffer) you
  44 ;; can type `A W' (aka M-x gnus-warp-to-article RET) on an article.  You
  45 ;; will be warped into the group this article came from. Typing `A T'
  46 ;; (aka M-x gnus-summary-refer-thread RET) will warp to the group and
  47 ;; also show the thread this article is part of.
  48
  49 ;; The Lisp setup may involve setting a few variables and setting up the
  50 ;; search engine. You can define the variables in the server definition
  51 ;; like this :
  52 ;;   (setq gnus-secondary-select-methods '(
  53 ;;       (nnimap "" (nnimap-address "localhost")
  54 ;;                  (nnir-search-engine namazu)
  55 ;;       )))
  56 ;; The main variable to set is `nnir-search-engine'.  Choose one of
  57 ;; the engines listed in `nnir-engines'.  (Actually `nnir-engines' is
  58 ;; an alist, type `C-h v nnir-engines RET' for more information; this
  59 ;; includes examples for setting `nnir-search-engine', too.)
  60
  61 ;; If you use one of the local indices (namazu, find-grep, swish) you
  62 ;; must also set up a search engine backend.
  63
  64 ;; 1. Namazu
  65 ;;
  66 ;; The Namazu backend requires you to have one directory containing all
  67 ;; index files, this is controlled by the `nnir-namazu-index-directory'
  68 ;; variable.  To function the `nnir-namazu-remove-prefix' variable must
  69 ;; also be correct, see the documentation for `nnir-namazu-remove-prefix'
  70 ;; above.
  71 ;;
  72 ;; It is particularly important not to pass any any switches to namazu
  73 ;; that will change the output format.  Good switches to use include
  74 ;; `--sort', `--ascending', `--early' and `--late'.  Refer to the Namazu
  75 ;; documentation for further information on valid switches.
  76 ;;
  77 ;; To index my mail with the `mknmz' program I use the following
  78 ;; configuration file:
  79 ;;
  80 ;; ,----
  81 ;; | package conf;  # Don't remove this line!
  82 ;; |
  83 ;; | # Paths which will not be indexed. Don't use `^' or `$' anchors.
  84 ;; | $EXCLUDE_PATH = "spam|sent";
  85 ;; |
  86 ;; | # Header fields which should be searchable. case-insensitive
  87 ;; | $REMAIN_HEADER = "from|date|message-id|subject";
  88 ;; |
  89 ;; | # Searchable fields. case-insensitive
  90 ;; | $SEARCH_FIELD = "from|date|message-id|subject";
  91 ;; |
  92 ;; | # The max length of a word.
  93 ;; | $WORD_LENG_MAX = 128;
  94 ;; |
  95 ;; | # The max length of a field.
  96 ;; | $MAX_FIELD_LENGTH = 256;
  97 ;; `----
  98 ;;
  99 ;; My mail is stored in the directories ~/Mail/mail/, ~/Mail/lists/ and
 100 ;; ~/Mail/archive/, so to index them I go to the directory set in
 101 ;; `nnir-namazu-index-directory' and issue the following command.
 102 ;;
 103 ;;      mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
 104 ;;
 105 ;; For maximum searching efficiency I have a cron job set to run this
 106 ;; command every four hours.
 107
 108 ;; 2. find-grep
 109 ;;
 110 ;; The find-grep engine simply runs find(1) to locate eligible
 111 ;; articles and searches them with grep(1).  This, of course, is much
 112 ;; slower than using a proper search engine but OTOH doesn't require
 113 ;; maintenance of an index and is still faster than using any built-in
 114 ;; means for searching.  The method specification of the server to
 115 ;; search must include a directory for this engine to work (E.g.,
 116 ;; `nnml-directory').  The tools must be POSIX compliant.  GNU Find
 117 ;; prior to version 4.2.12 (4.2.26 on Linux due to incorrect ARG_MAX
 118 ;; handling) does not work.
 119 ;; ,----
 120 ;; |    ;; find-grep configuration for searching the Gnus Cache
 121 ;; |
 122 ;; |    (nnml "cache"
 123 ;; |          (nnml-get-new-mail nil)
 124 ;; |          (nnir-search-engine find-grep)
 125 ;; |          (nnml-directory "~/News/cache/")
 126 ;; |          (nnml-active-file "~/News/cache/active"))
 127 ;; `----
 128
 129 ;; Developer information:
 130
 131 ;; I have tried to make the code expandable.  Basically, it is divided
 132 ;; into two layers.  The upper layer is somewhat like the `nnvirtual'
 133 ;; backend: given a specification of what articles to show from
 134 ;; another backend, it creates a group containing exactly those
 135 ;; articles.  The lower layer issues a query to a search engine and
 136 ;; produces such a specification of what articles to show from the
 137 ;; other backend.
 138
 139 ;; The interface between the two layers consists of the single
 140 ;; function `nnir-run-query', which just selects the appropriate
 141 ;; function for the search engine one is using.  The input to
 142 ;; `nnir-run-query' is a string, representing the query as input by
 143 ;; the user.  The output of `nnir-run-query' is supposed to be a
 144 ;; vector, each element of which should in turn be a three-element
 145 ;; vector.  The first element should be full group name of the article,
 146 ;; the second element should be the article number, and the third
 147 ;; element should be the Retrieval Status Value (RSV) as returned from
 148 ;; the search engine.  An RSV is the score assigned to the document by
 149 ;; the search engine.  For Boolean search engines, the
 150 ;; RSV is always 1000 (or 1 or 100, or whatever you like).
 151
 152 ;; The sorting order of the articles in the summary buffer created by
 153 ;; nnir is based on the order of the articles in the above mentioned
 154 ;; vector, so that's where you can do the sorting you'd like.  Maybe
 155 ;; it would be nice to have a way of displaying the search result
 156 ;; sorted differently?
 157
 158 ;; So what do you need to do when you want to add another search
 159 ;; engine?  You write a function that executes the query.  Temporary
 160 ;; data from the search engine can be put in `nnir-tmp-buffer'.  This
 161 ;; function should return the list of articles as a vector, as
 162 ;; described above.  Then, you need to register this backend in
 163 ;; `nnir-engines'.  Then, users can choose the backend by setting
 164 ;; `nnir-search-engine' as a server variable.
 165
 166 ;;; Code:
 167
 168 ;;; Setup:
 169
 170 ;; For Emacs <22.2 and XEmacs.
 171 (eval-and-compile
 172   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
 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-current-query nil
 184   "Internal: stores current query (= group name).")
 185
 186 (defvar nnir-current-server nil
 187   "Internal: stores current server (does it ever change?).")
 188
 189 (defvar nnir-current-group-marked nil
 190   "Internal: stores current list of process-marked groups.")
 191
 192 (defvar nnir-artlist nil
 193   "Internal: stores search result.")
 194
 195 (defvar nnir-tmp-buffer " *nnir*"
 196   "Internal: temporary buffer.")
 197
 198 (defvar nnir-search-history ()
 199   "Internal: the history for querying search options in nnir")
 200
 201 (defvar nnir-extra-parms nil
 202   "Internal: stores request for extra search parms")
 203
 204 ;; Imap variables
 205
 206 (defvar nnir-imap-search-arguments
 207   '(("Whole message" . "TEXT")
 208     ("Subject" . "SUBJECT")
 209     ("To" . "TO")
 210     ("From" . "FROM")
 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 'gnus-registry-action "gnus-registry"))
 293
 294 (nnoo-declare nnir)
 295 (nnoo-define-basics nnir)
 296
 297 (gnus-declare-backend "nnir" 'mail)
 298
 299
 300 ;;; User Customizable Variables:
 301
 302 (defgroup nnir nil
 303   "Search groups in Gnus with assorted seach engines."
 304   :group 'gnus)
 305
 306 (defcustom nnir-method-default-engines
 307   '((nnimap . imap)
 308     (nntp . gmane))
 309   "*Alist of default search engines keyed by server method."
 310   :type '(alist)
 311   :group 'nnir)
 312
 313 (defcustom nnir-ignored-newsgroups ""
 314   "*A regexp to match newsgroups in the active file that should
 315   be skipped when searching."
 316   :type '(regexp)
 317   :group 'nnir)
 318
 319 (defcustom nnir-summary-line-format nil
 320   "*The format specification of the lines in an nnir summary buffer.
 321
 322 All the items from `gnus-summary-line-format' are available, along
 323 with three items unique to nnir summary buffers:
 324
 325 %Z    Search retrieval score value (integer)
 326 %G    Article original full group name (string)
 327 %g    Article original short group name (string)
 328
 329 If nil this will use `gnus-summary-line-format'."
 330   :type '(regexp)
 331   :group 'nnir)
 332
 333 (defcustom nnir-retrieve-headers-override-function nil
 334   "*If non-nil, a function that accepts an article list and group
 335 and populates the `nntp-server-buffer' with the retrieved
 336 headers. Must return either 'nov or 'headers indicating the
 337 retrieved header format.
 338
 339 If this variable is nil, or if the provided function returns nil for a search
 340 result, `gnus-retrieve-headers' will be called instead."
 341   :type '(function)
 342   :group 'nnir)
 343
 344 (defcustom nnir-imap-default-search-key "Whole message"
 345   "*The default IMAP search key for an nnir search. Must be one of
 346   the keys in `nnir-imap-search-arguments'. To use raw imap queries
 347   by default set this to \"Imap\"."
 348   :type '(string)
 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 ;;; Developer Extension Variable:
 507
 508 (defvar nnir-engines
 509   `((imap    nnir-run-imap
 510              ((criteria
 511                "Imap Search in"                   ; Prompt
 512                ,(mapcar 'car nnir-imap-search-arguments) ; alist for completing
 513                nil                                ; allow any user input
 514                nil                                ; initial value
 515                nnir-imap-search-argument-history  ; the history to use
 516                ,nnir-imap-default-search-key      ; default
 517                )))
 518     (gmane   nnir-run-gmane
 519              ((author . "Gmane Author: ")))
 520     (swish++ nnir-run-swish++
 521              ((group . "Swish++ Group spec: ")))
 522     (swish-e nnir-run-swish-e
 523              ((group . "Swish-e Group spec: ")))
 524     (namazu  nnir-run-namazu
 525              ())
 526     (hyrex   nnir-run-hyrex
 527              ((group . "Hyrex Group spec: ")))
 528     (find-grep nnir-run-find-grep
 529                ((grep-options . "Grep options: "))))
 530   "Alist of supported search engines.
 531 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
 532 ENGINE is a symbol designating the searching engine.  FUNCTION is also
 533 a symbol, giving the function that does the search.  The third element
 534 ARGS is a list of cons pairs (PARAM . PROMPT).  When issuing a query,
 535 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
 536
 537 The value of `nnir-search-engine' must be one of the ENGINE symbols.
 538 For example, for searching a server using namazu include
 539     (nnir-search-engine namazu)
 540 in the server definition.  Note that you have to set additional
 541 variables for most backends.  For example, the `namazu' backend
 542 needs the variables `nnir-namazu-program',
 543 `nnir-namazu-index-directory' and `nnir-namazu-remove-prefix'.
 544
 545 Add an entry here when adding a new search engine.")
 546
 547
 548 ;; Gnus glue.
 549
 550 (defun gnus-group-make-nnir-group (nnir-extra-parms)
 551   "Create an nnir group.  Asks for query."
 552   (interactive "P")
 553   (setq nnir-current-query nil
 554         nnir-current-server nil
 555         nnir-current-group-marked nil
 556         nnir-artlist nil)
 557   (let* ((query (read-string "Query: " nil 'nnir-search-history))
 558          (parms (list (cons 'query query)))
 559          (srv (if (gnus-server-server-name)
 560                   "all" "")))
 561     (add-to-list 'parms (cons 'unique-id (message-unique-id)) t)
 562     (gnus-group-read-ephemeral-group
 563      (concat "nnir:" (prin1-to-string parms)) (list 'nnir srv) t
 564      (cons (current-buffer) gnus-current-window-configuration)
 565      nil)))
 566
 567
 568 ;; Gnus backend interface functions.
 569
 570 (deffoo nnir-open-server (server &optional definitions)
 571   ;; Just set the server variables appropriately.
 572   (add-hook 'gnus-summary-mode-hook 'nnir-mode)
 573   (nnoo-change-server 'nnir server definitions))
 574
 575 (deffoo nnir-request-group (group &optional server fast info)
 576   "GROUP is the query string."
 577   (nnir-possibly-change-server server)
 578   ;; Check for cache and return that if appropriate.
 579   (if (and (equal group nnir-current-query)
 580            (equal gnus-group-marked nnir-current-group-marked)
 581            (or (null server)
 582                (equal server nnir-current-server)))
 583       nnir-artlist
 584     ;; Cache miss.
 585     (setq nnir-artlist (nnir-run-query group server)))
 586   (with-current-buffer nntp-server-buffer
 587     (setq nnir-current-query group)
 588     (when server (setq nnir-current-server server))
 589     (setq nnir-current-group-marked gnus-group-marked)
 590     (if (zerop (length nnir-artlist))
 591         (nnheader-report 'nnir "Search produced empty results.")
 592       ;; Remember data for cache.
 593       (nnheader-insert "211 %d %d %d %s\n"
 594                        (nnir-artlist-length nnir-artlist) ; total #
 595                        1              ; first #
 596                        (nnir-artlist-length nnir-artlist) ; last #
 597                        group))))      ; group name
 598
 599 (deffoo nnir-retrieve-headers (articles &optional group server fetch-old)
 600   (with-current-buffer nntp-server-buffer
 601     (let ((gnus-inhibit-demon t)
 602           (articles-by-group (nnir-categorize
 603                               articles nnir-article-group nnir-article-ids))
 604           headers)
 605       (while (not (null articles-by-group))
 606         (let* ((group-articles (pop articles-by-group))
 607                (artgroup (car group-articles))
 608                (articleids (cadr group-articles))
 609                (artlist (sort (mapcar 'cdr articleids) '<))
 610                (server (gnus-group-server artgroup))
 611                (gnus-override-method (gnus-server-to-method server))
 612                parsefunc)
 613           ;; (or (numberp art)
 614           ;;     (nnheader-report
 615           ;;      'nnir
 616           ;;      "nnir-retrieve-headers doesn't grok message ids: %s"
 617           ;;      art))
 618           (nnir-possibly-change-server server)
 619           ;; is this needed?
 620           (erase-buffer)
 621           (case (setq gnus-headers-retrieved-by
 622                       (or
 623                        (and
 624                         nnir-retrieve-headers-override-function
 625                         (funcall nnir-retrieve-headers-override-function
 626                                  artlist artgroup))
 627                        (gnus-retrieve-headers artlist artgroup nil)))
 628             (nov
 629              (setq parsefunc 'nnheader-parse-nov))
 630             (headers
 631              (setq parsefunc 'nnheader-parse-head))
 632             (t (error "Unknown header type %s while requesting articles \
 633                     of group %s" gnus-headers-retrieved-by artgroup)))
 634           (goto-char (point-min))
 635           (while (not (eobp))
 636             (let* ((novitem (funcall parsefunc))
 637                    (artno (mail-header-number novitem))
 638                    (art (car (rassoc artno articleids))))
 639               (when art
 640                 (mail-header-set-number novitem art)
 641                 (push novitem headers))
 642               (forward-line 1)))))
 643       (setq headers
 644             (sort headers
 645                   (lambda (x y)
 646                     (< (mail-header-number x) (mail-header-number y)))))
 647       (erase-buffer)
 648       (mapc 'nnheader-insert-nov headers)
 649       'nov)))
 650
 651 (deffoo nnir-request-article (article &optional group server to-buffer)
 652   (if (stringp article)
 653       (nnheader-report
 654        'nnir
 655        "nnir-retrieve-headers doesn't grok message ids: %s"
 656        article)
 657     (save-excursion
 658       (let ((artfullgroup (nnir-article-group article))
 659             (artno (nnir-article-number article)))
 660         (message "Requesting article %d from group %s"
 661                  artno artfullgroup)
 662         (if to-buffer
 663             (with-current-buffer to-buffer
 664               (let ((gnus-article-decode-hook nil))
 665                 (gnus-request-article-this-buffer artno artfullgroup)))
 666           (gnus-request-article artno artfullgroup))
 667         (cons artfullgroup artno)))))
 668
 669 (deffoo nnir-request-move-article (article group server accept-form
 670                                            &optional last internal-move-group)
 671   (let* ((artfullgroup (nnir-article-group article))
 672          (artno (nnir-article-number article))
 673          (to-newsgroup (nth 1 accept-form))
 674          (to-method (gnus-find-method-for-group to-newsgroup))
 675          (from-method (gnus-find-method-for-group artfullgroup))
 676          (move-is-internal (gnus-server-equal from-method to-method)))
 677     (unless (gnus-check-backend-function
 678              'request-move-article artfullgroup)
 679       (error "The group %s does not support article moving" artfullgroup))
 680     (gnus-request-move-article
 681      artno
 682      artfullgroup
 683      (nth 1 from-method)
 684      accept-form
 685      last
 686      (and move-is-internal
 687           to-newsgroup          ; Not respooling
 688           (gnus-group-real-name to-newsgroup)))))
 689
 690 (deffoo nnir-warp-to-article ()
 691   (let* ((cur (if (> (gnus-summary-article-number) 0)
 692                   (gnus-summary-article-number)
 693                 (error "This is not a real article.")))
 694          (gnus-newsgroup-name (nnir-article-group cur))
 695          (backend-number (nnir-article-number cur)))
 696     (gnus-summary-read-group-1 gnus-newsgroup-name t t gnus-summary-buffer
 697                                nil (list backend-number))))
 698
 699 (nnoo-define-skeleton nnir)
 700
 701
 702 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
 703   "Ask `nnir-compose-result' to construct a result vector,
 704 and if it is non-nil, add it to artlist."
 705   `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
 706      (when (not (null result))
 707        (push result ,artlist))))
 708
 709 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
 710
 711 ;; Helper function currently used by the Swish++ and Namazu backends;
 712 ;; perhaps useful for other backends as well
 713 (defun nnir-compose-result (dirnam article score prefix server)
 714   "Extract the group from dirnam, and create a result vector
 715 ready to be added to the list of search results."
 716
 717   ;; remove nnir-*-remove-prefix from beginning of dirnam filename
 718   (when (string-match (concat "^" prefix) dirnam)
 719     (setq dirnam (replace-match "" t t dirnam)))
 720
 721   (when (file-readable-p (concat prefix dirnam article))
 722     ;; remove trailing slash and, for nnmaildir, cur/new/tmp
 723     (setq dirnam
 724           (substring dirnam 0
 725                      (if (string= (gnus-group-server server) "nnmaildir")
 726                          -5 -1)))
 727
 728     ;; Set group to dirnam without any leading dots or slashes,
 729     ;; and with all subsequent slashes replaced by dots
 730     (let ((group (gnus-replace-in-string
 731                  (gnus-replace-in-string dirnam "^[./\\]" "" t)
 732                  "[/\\]" "." t)))
 733
 734     (vector (gnus-group-full-name group server)
 735             (if (string= (gnus-group-server server) "nnmaildir")
 736                 (nnmaildir-base-name-to-article-number
 737                  (substring article 0 (string-match ":" article))
 738                  group nil)
 739               (string-to-number article))
 740             (string-to-number score)))))
 741
 742 ;;; Search Engine Interfaces:
 743
 744 ;; imap interface
 745 (defun nnir-run-imap (query srv &optional groups)
 746   "Run a search against an IMAP back-end server.
 747 This uses a custom query language parser; see `nnir-imap-make-query' for
 748 details on the language and supported extensions"
 749   (save-excursion
 750     (let ((qstring (cdr (assq 'query query)))
 751           (server (cadr (gnus-server-to-method srv)))
 752           (defs (caddr (gnus-server-to-method srv)))
 753           (criteria (or (cdr (assq 'criteria query))
 754                         (cdr (assoc nnir-imap-default-search-key
 755                                     nnir-imap-search-arguments))))
 756           (gnus-inhibit-demon t)
 757           (groups (or groups (nnir-get-active srv))))
 758       (message "Opening server %s" server)
 759       (apply
 760        'vconcat
 761        (mapcar
 762         (lambda (group)
 763           (let (artlist)
 764             (condition-case ()
 765                 (when (nnimap-possibly-change-group
 766                        (gnus-group-short-name group) server)
 767                   (with-current-buffer (nnimap-buffer)
 768                     (message "Searching %s..." group)
 769                     (let ((arts 0)
 770                           (result (nnimap-command "UID SEARCH %s"
 771                                                   (if (string= criteria "")
 772                                                       qstring
 773                                                     (nnir-imap-make-query
 774                                                      criteria qstring)))))
 775                       (mapc
 776                        (lambda (artnum) (push (vector group artnum 100) artlist)
 777                          (setq arts (1+ arts)))
 778                        (and (car result)
 779                             (delete 0 (mapcar #'string-to-number
 780                                               (cdr (assoc "SEARCH"
 781                                                           (cdr result)))))))
 782                       (message "Searching %s... %d matches" group arts)))
 783                   (message "Searching %s...done" group))
 784               (quit nil))
 785             artlist))
 786         groups)))))
 787
 788 (defun nnir-imap-make-query (criteria qstring)
 789   "Parse the query string and criteria into an appropriate IMAP search
 790 expression, returning the string query to make.
 791
 792 This implements a little language designed to return the expected results
 793 to an arbitrary query string to the end user.
 794
 795 The search is always case-insensitive, as defined by RFC2060, and supports
 796 the following features (inspired by the Google search input language):
 797
 798 Automatic \"and\" queries
 799     If you specify multiple words then they will be treated as an \"and\"
 800     expression intended to match all components.
 801
 802 Phrase searches
 803     If you wrap your query in double-quotes then it will be treated as a
 804     literal string.
 805
 806 Negative terms
 807     If you precede a term with \"-\" then it will negate that.
 808
 809 \"OR\" queries
 810     If you include an upper-case \"OR\" in your search it will cause the
 811     term before it and the term after it to be treated as alternatives.
 812
 813 In future the following will be added to the language:
 814  * support for date matches
 815  * support for location of text matching within the query
 816  * from/to/etc headers
 817  * additional search terms
 818  * flag based searching
 819  * anything else that the RFC supports, basically."
 820   ;; Walk through the query and turn it into an IMAP query string.
 821   (nnir-imap-query-to-imap criteria (nnir-imap-parse-query qstring)))
 822
 823
 824 (defun nnir-imap-query-to-imap (criteria query)
 825   "Turn a s-expression format query into IMAP."
 826   (mapconcat
 827    ;; Turn the expressions into IMAP text
 828    (lambda (item)
 829      (nnir-imap-expr-to-imap criteria item))
 830    ;; The query, already in s-expr format.
 831    query
 832    ;; Append a space between each expression
 833    " "))
 834
 835
 836 (defun nnir-imap-expr-to-imap (criteria expr)
 837   "Convert EXPR into an IMAP search expression on CRITERIA"
 838   ;; What sort of expression is this, eh?
 839   (cond
 840    ;; Simple string term
 841    ((stringp expr)
 842     (format "%s %S" criteria expr))
 843    ;; Trivial term: and
 844    ((eq expr 'and) nil)
 845    ;; Composite term: or expression
 846    ((eq (car-safe expr) 'or)
 847     (format "OR %s %s"
 848             (nnir-imap-expr-to-imap criteria (second expr))
 849             (nnir-imap-expr-to-imap criteria (third expr))))
 850    ;; Composite term: just the fax, mam
 851    ((eq (car-safe expr) 'not)
 852     (format "NOT (%s)" (nnir-imap-query-to-imap criteria (rest expr))))
 853    ;; Composite term: just expand it all.
 854    ((and (not (null expr)) (listp expr))
 855     (format "(%s)" (nnir-imap-query-to-imap criteria expr)))
 856    ;; Complex value, give up for now.
 857    (t (error "Unhandled input: %S" expr))))
 858
 859
 860 (defun nnir-imap-parse-query (string)
 861   "Turn STRING into an s-expression based query based on the IMAP
 862 query language as defined in `nnir-imap-make-query'.
 863
 864 This involves turning individual tokens into higher level terms
 865 that the search language can then understand and use."
 866   (with-temp-buffer
 867     ;; Set up the parsing environment.
 868     (insert string)
 869     (goto-char (point-min))
 870     ;; Now, collect the output terms and return them.
 871     (let (out)
 872       (while (not (nnir-imap-end-of-input))
 873         (push (nnir-imap-next-expr) out))
 874       (reverse out))))
 875
 876
 877 (defun nnir-imap-next-expr (&optional count)
 878   "Return the next expression from the current buffer."
 879   (let ((term (nnir-imap-next-term count))
 880         (next (nnir-imap-peek-symbol)))
 881     ;; Are we looking at an 'or' expression?
 882     (cond
 883      ;; Handle 'expr or expr'
 884      ((eq next 'or)
 885       (list 'or term (nnir-imap-next-expr 2)))
 886      ;; Anything else
 887      (t term))))
 888
 889
 890 (defun nnir-imap-next-term (&optional count)
 891   "Return the next TERM from the current buffer."
 892   (let ((term (nnir-imap-next-symbol count)))
 893     ;; What sort of term is this?
 894     (cond
 895      ;; and -- just ignore it
 896      ((eq term 'and) 'and)
 897      ;; negated term
 898      ((eq term 'not) (list 'not (nnir-imap-next-expr)))
 899      ;; generic term
 900      (t term))))
 901
 902
 903 (defun nnir-imap-peek-symbol ()
 904   "Return the next symbol from the current buffer, but don't consume it."
 905   (save-excursion
 906     (nnir-imap-next-symbol)))
 907
 908 (defun nnir-imap-next-symbol (&optional count)
 909   "Return the next symbol from the current buffer, or nil if we are
 910 at the end of the buffer.  If supplied COUNT skips some symbols before
 911 returning the one at the supplied position."
 912   (when (and (numberp count) (> count 1))
 913     (nnir-imap-next-symbol (1- count)))
 914   (let ((case-fold-search t))
 915     ;; end of input stream?
 916     (unless (nnir-imap-end-of-input)
 917       ;; No, return the next symbol from the stream.
 918       (cond
 919        ;; negated expression -- return it and advance one char.
 920        ((looking-at "-") (forward-char 1) 'not)
 921        ;; quoted string
 922        ((looking-at "\"") (nnir-imap-delimited-string "\""))
 923        ;; list expression -- we parse the content and return this as a list.
 924        ((looking-at "(")
 925         (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
 926        ;; keyword input -- return a symbol version
 927        ((looking-at "\\band\\b") (forward-char 3) 'and)
 928        ((looking-at "\\bor\\b")  (forward-char 2) 'or)
 929        ((looking-at "\\bnot\\b") (forward-char 3) 'not)
 930        ;; Simple, boring keyword
 931        (t (let ((start (point))
 932                 (end (if (search-forward-regexp "[[:blank:]]" nil t)
 933                          (prog1
 934                              (match-beginning 0)
 935                            ;; unskip if we hit a non-blank terminal character.
 936                            (when (string-match "[^[:blank:]]" (match-string 0))
 937                              (backward-char 1)))
 938                        (goto-char (point-max)))))
 939             (buffer-substring start end)))))))
 940
 941 (defun nnir-imap-delimited-string (delimiter)
 942   "Return a delimited string from the current buffer."
 943   (let ((start (point)) end)
 944     (forward-char 1)                    ; skip the first delimiter.
 945     (while (not end)
 946       (unless (search-forward delimiter nil t)
 947         (error "Unmatched delimited input with %s in query" delimiter))
 948       (let ((here (point)))
 949         (unless (equal (buffer-substring (- here 2) (- here 1)) "\\")
 950           (setq end (point)))))
 951     (buffer-substring (1+ start) (1- end))))
 952
 953 (defun nnir-imap-end-of-input ()
 954   "Are we at the end of input?"
 955   (skip-chars-forward "[[:blank:]]")
 956   (looking-at "$"))
 957
 958
 959 ;; Swish++ interface.
 960 ;; -cc- Todo
 961 ;; Search by
 962 ;; - group
 963 ;; Sort by
 964 ;; - rank (default)
 965 ;; - article number
 966 ;; - file size
 967 ;; - group
 968 (defun nnir-run-swish++ (query server &optional group)
 969   "Run QUERY against swish++.
 970 Returns a vector of (group name, file name) pairs (also vectors,
 971 actually).
 972
 973 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
 974 Windows NT 4.0."
 975
 976   ;; (when group
 977   ;;   (error "The swish++ backend cannot search specific groups"))
 978
 979   (save-excursion
 980     (let ( (qstring (cdr (assq 'query query)))
 981            (groupspec (cdr (assq 'group query)))
 982            (prefix (nnir-read-server-parm 'nnir-swish++-remove-prefix server))
 983            artlist
 984            ;; nnml-use-compressed-files might be any string, but probably this
 985            ;; is sufficient.  Note that we can't only use the value of
 986            ;; nnml-use-compressed-files because old articles might have been
 987            ;; saved with a different value.
 988            (article-pattern (if (string= (gnus-group-server server) "nnmaildir")
 989                                 ":[0-9]+"
 990                               "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
 991            score artno dirnam filenam)
 992
 993       (when (equal "" qstring)
 994         (error "swish++: You didn't enter anything"))
 995
 996       (set-buffer (get-buffer-create nnir-tmp-buffer))
 997       (erase-buffer)
 998
 999       (if groupspec
1000           (message "Doing swish++ query %s on %s..." qstring groupspec)
1001         (message "Doing swish++ query %s..." qstring))
1002
1003       (let* ((cp-list `( ,nnir-swish++-program
1004                          nil            ; input from /dev/null
1005                          t              ; output
1006                          nil            ; don't redisplay
1007                          "--config-file" ,(nnir-read-server-parm 'nnir-swish++-configuration-file server)
1008                          ,@(nnir-read-server-parm 'nnir-swish++-additional-switches server)
1009                          ,qstring       ; the query, in swish++ format
1010                          ))
1011              (exitstatus
1012               (progn
1013                 (message "%s args: %s" nnir-swish++-program
1014                          (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1015                 (apply 'call-process cp-list))))
1016         (unless (or (null exitstatus)
1017                     (zerop exitstatus))
1018           (nnheader-report 'nnir "Couldn't run swish++: %s" exitstatus)
1019           ;; swish++ failure reason is in this buffer, show it if
1020           ;; the user wants it.
1021           (when (> gnus-verbose 6)
1022             (display-buffer nnir-tmp-buffer))))
1023
1024       ;; The results are output in the format of:
1025       ;; V 4.7 Linux
1026       ;; rank relative-path-name file-size file-title
1027       ;; V 5.0b2:
1028       ;; rank relative-path-name file-size topic??
1029       ;; where rank is an integer from 1 to 100.
1030       (goto-char (point-min))
1031       (while (re-search-forward
1032               "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t)
1033         (setq score (match-string 1)
1034               filenam (match-string 2)
1035               artno (file-name-nondirectory filenam)
1036               dirnam (file-name-directory filenam))
1037
1038         ;; don't match directories
1039         (when (string-match article-pattern artno)
1040           (when (not (null dirnam))
1041
1042             ;; maybe limit results to matching groups.
1043             (when (or (not groupspec)
1044                       (string-match groupspec dirnam))
1045               (nnir-add-result dirnam artno score prefix server artlist)))))
1046
1047       (message "Massaging swish++ output...done")
1048
1049       ;; Sort by score
1050       (apply 'vector
1051              (sort artlist
1052                    (function (lambda (x y)
1053                                (> (nnir-artitem-rsv x)
1054                                   (nnir-artitem-rsv y)))))))))
1055
1056 ;; Swish-E interface.
1057 (defun nnir-run-swish-e (query server &optional group)
1058   "Run given query against swish-e.
1059 Returns a vector of (group name, file name) pairs (also vectors,
1060 actually).
1061
1062 Tested with swish-e-2.0.1 on Windows NT 4.0."
1063
1064   ;; swish-e crashes with empty parameter to "-w" on commandline...
1065   ;; (when group
1066   ;;   (error "The swish-e backend cannot search specific groups"))
1067
1068   (save-excursion
1069     (let ((qstring (cdr (assq 'query query)))
1070           (prefix
1071            (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server)
1072                (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1073           artlist score artno dirnam group )
1074
1075       (when (equal "" qstring)
1076         (error "swish-e: You didn't enter anything"))
1077
1078       (set-buffer (get-buffer-create nnir-tmp-buffer))
1079       (erase-buffer)
1080
1081       (message "Doing swish-e query %s..." query)
1082       (let* ((index-files
1083               (or (nnir-read-server-parm
1084                    'nnir-swish-e-index-files server)
1085                   (error "Missing parameter `nnir-swish-e-index-files'")))
1086              (additional-switches
1087               (nnir-read-server-parm
1088                'nnir-swish-e-additional-switches server))
1089              (cp-list `(,nnir-swish-e-program
1090                         nil             ; input from /dev/null
1091                         t               ; output
1092                         nil             ; don't redisplay
1093                         "-f" ,@index-files
1094                         ,@additional-switches
1095                         "-w"
1096                         ,qstring        ; the query, in swish-e format
1097                         ))
1098              (exitstatus
1099               (progn
1100                 (message "%s args: %s" nnir-swish-e-program
1101                          (mapconcat 'identity (cddddr cp-list) " "))
1102                 (apply 'call-process cp-list))))
1103         (unless (or (null exitstatus)
1104                     (zerop exitstatus))
1105           (nnheader-report 'nnir "Couldn't run swish-e: %s" exitstatus)
1106           ;; swish-e failure reason is in this buffer, show it if
1107           ;; the user wants it.
1108           (when (> gnus-verbose 6)
1109             (display-buffer nnir-tmp-buffer))))
1110
1111       ;; The results are output in the format of:
1112       ;; rank path-name file-title file-size
1113       (goto-char (point-min))
1114       (while (re-search-forward
1115               "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t)
1116         (setq score (match-string 1)
1117               artno (match-string 3)
1118               dirnam (file-name-directory (match-string 2)))
1119
1120         ;; don't match directories
1121         (when (string-match "^[0-9]+$" artno)
1122           (when (not (null dirnam))
1123
1124             ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1125             (when (string-match (concat "^" prefix) dirnam)
1126               (setq dirnam (replace-match "" t t dirnam)))
1127
1128             (setq dirnam (substring dirnam 0 -1))
1129             ;; eliminate all ".", "/", "\" from beginning. Always matches.
1130             (string-match "^[./\\]*\\(.*\\)$" dirnam)
1131             ;; "/" -> "."
1132             (setq group (gnus-replace-in-string (match-string 1 dirnam) "/" "."))
1133             ;; Windows "\\" -> "."
1134             (setq group (gnus-replace-in-string group "\\\\" "."))
1135
1136             (push (vector (gnus-group-full-name group server)
1137                           (string-to-number artno)
1138                           (string-to-number score))
1139                   artlist))))
1140
1141       (message "Massaging swish-e output...done")
1142
1143       ;; Sort by score
1144       (apply 'vector
1145              (sort artlist
1146                    (function (lambda (x y)
1147                                (> (nnir-artitem-rsv x)
1148                                   (nnir-artitem-rsv y)))))))))
1149
1150 ;; HyREX interface
1151 (defun nnir-run-hyrex (query server &optional group)
1152   (save-excursion
1153     (let ((artlist nil)
1154           (groupspec (cdr (assq 'group query)))
1155           (qstring (cdr (assq 'query query)))
1156           (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server))
1157           score artno dirnam)
1158       (when (and (not groupspec) group)
1159         (setq groupspec
1160               (regexp-opt
1161                (mapcar (lambda (x) (gnus-group-real-name x)) group))))
1162       (set-buffer (get-buffer-create nnir-tmp-buffer))
1163       (erase-buffer)
1164       (message "Doing hyrex-search query %s..." query)
1165       (let* ((cp-list
1166               `( ,nnir-hyrex-program
1167                  nil                    ; input from /dev/null
1168                  t                      ; output
1169                  nil                    ; don't redisplay
1170                  "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server) ; index directory
1171                  ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server)
1172                  ,qstring          ; the query, in hyrex-search format
1173                  ))
1174              (exitstatus
1175               (progn
1176                 (message "%s args: %s" nnir-hyrex-program
1177                          (mapconcat 'identity (cddddr cp-list) " "))
1178                 (apply 'call-process cp-list))))
1179         (unless (or (null exitstatus)
1180                     (zerop exitstatus))
1181           (nnheader-report 'nnir "Couldn't run hyrex-search: %s" exitstatus)
1182           ;; nnir-search failure reason is in this buffer, show it if
1183           ;; the user wants it.
1184           (when (> gnus-verbose 6)
1185             (display-buffer nnir-tmp-buffer)))) ;; FIXME: Dont clear buffer !
1186       (message "Doing hyrex-search query \"%s\"...done" qstring)
1187       (sit-for 0)
1188       ;; nnir-search returns:
1189       ;;   for nnml/nnfolder: "filename mailid weigth"
1190       ;;   for nnimap:        "group mailid weigth"
1191       (goto-char (point-min))
1192       (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1193       ;; HyREX doesn't search directly in groups -- so filter out here.
1194       (when groupspec
1195         (keep-lines groupspec))
1196       ;; extract data from result lines
1197       (goto-char (point-min))
1198       (while (re-search-forward
1199               "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t)
1200         (setq dirnam (match-string 1)
1201               artno (match-string 2)
1202               score (match-string 3))
1203         (when (string-match prefix dirnam)
1204           (setq dirnam (replace-match "" t t dirnam)))
1205         (push (vector (gnus-group-full-name
1206                        (gnus-replace-in-string dirnam "/" ".") server)
1207                       (string-to-number artno)
1208                       (string-to-number score))
1209               artlist))
1210       (message "Massaging hyrex-search output...done.")
1211       (apply 'vector
1212              (sort artlist
1213                    (function (lambda (x y)
1214                                (if (string-lessp (nnir-artitem-group x)
1215                                                  (nnir-artitem-group y))
1216                                    t
1217                                  (< (nnir-artitem-number x)
1218                                     (nnir-artitem-number y)))))))
1219       )))
1220
1221 ;; Namazu interface
1222 (defun nnir-run-namazu (query server &optional group)
1223   "Run given query against Namazu.  Returns a vector of (group name, file name)
1224 pairs (also vectors, actually).
1225
1226 Tested with Namazu 2.0.6 on a GNU/Linux system."
1227   ;; (when group
1228   ;;   (error "The Namazu backend cannot search specific groups"))
1229   (save-excursion
1230     (let ((article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1231                                ":[0-9]+"
1232                              "^[0-9]+$"))
1233           artlist
1234           (qstring (cdr (assq 'query query)))
1235           (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server))
1236           score group article
1237           (process-environment (copy-sequence process-environment)))
1238       (setenv "LC_MESSAGES" "C")
1239       (set-buffer (get-buffer-create nnir-tmp-buffer))
1240       (erase-buffer)
1241       (let* ((cp-list
1242               `( ,nnir-namazu-program
1243                  nil                    ; input from /dev/null
1244                  t                      ; output
1245                  nil                    ; don't redisplay
1246                  "-q"                   ; don't be verbose
1247                  "-a"                   ; show all matches
1248                  "-s"                   ; use short format
1249                  ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server)
1250                  ,qstring               ; the query, in namazu format
1251                  ,(nnir-read-server-parm 'nnir-namazu-index-directory server) ; index directory
1252                  ))
1253              (exitstatus
1254               (progn
1255                 (message "%s args: %s" nnir-namazu-program
1256                          (mapconcat 'identity (cddddr cp-list) " "))
1257                 (apply 'call-process cp-list))))
1258         (unless (or (null exitstatus)
1259                     (zerop exitstatus))
1260           (nnheader-report 'nnir "Couldn't run namazu: %s" exitstatus)
1261           ;; Namazu failure reason is in this buffer, show it if
1262           ;; the user wants it.
1263           (when (> gnus-verbose 6)
1264             (display-buffer nnir-tmp-buffer))))
1265
1266       ;; Namazu output looks something like this:
1267       ;; 2. Re: Gnus agent expire broken (score: 55)
1268       ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1269
1270       (goto-char (point-min))
1271       (while (re-search-forward
1272               "^\\([0-9]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1273               nil t)
1274         (setq score (match-string 3)
1275               group (file-name-directory (match-string 4))
1276               article (file-name-nondirectory (match-string 4)))
1277
1278         ;; make sure article and group is sane
1279         (when (and (string-match article-pattern article)
1280                    (not (null group)))
1281           (nnir-add-result group article score prefix server artlist)))
1282
1283       ;; sort artlist by score
1284       (apply 'vector
1285              (sort artlist
1286                    (function (lambda (x y)
1287                                (> (nnir-artitem-rsv x)
1288                                   (nnir-artitem-rsv y)))))))))
1289
1290 (defun nnir-run-find-grep (query server &optional grouplist)
1291   "Run find and grep to obtain matching articles."
1292   (let* ((method (gnus-server-to-method server))
1293          (sym (intern
1294                (concat (symbol-name (car method)) "-directory")))
1295          (directory (cadr (assoc sym (cddr method))))
1296          (regexp (cdr (assoc 'query query)))
1297          (grep-options (cdr (assoc 'grep-options query)))
1298          (grouplist (or grouplist (nnir-get-active server)))
1299          artlist)
1300     (unless directory
1301       (error "No directory found in method specification of server %s"
1302              server))
1303     (apply
1304      'vconcat
1305      (mapcar (lambda (x)
1306                (let ((group x))
1307                  (message "Searching %s using find-grep..."
1308                           (or group server))
1309                  (save-window-excursion
1310                    (set-buffer (get-buffer-create nnir-tmp-buffer))
1311                    (erase-buffer)
1312                    (if (> gnus-verbose 6)
1313                        (pop-to-buffer (current-buffer)))
1314                    (cd directory) ; Using relative paths simplifies
1315                                   ; postprocessing.
1316                    (let ((group
1317                           (if (not group)
1318                               "."
1319                             ;; Try accessing the group literally as
1320                             ;; well as interpreting dots as directory
1321                             ;; separators so the engine works with
1322                             ;; plain nnml as well as the Gnus Cache.
1323                             (let ((group (gnus-group-real-name group)))
1324                               ;; Replace cl-func find-if.
1325                               (if (file-directory-p group)
1326                                   group
1327                                 (if (file-directory-p
1328                                      (setq group
1329                                            (gnus-replace-in-string
1330                                             group
1331                                             "\\." "/" t)))
1332                                     group))))))
1333                      (unless group
1334                        (error "Cannot locate directory for group"))
1335                      (save-excursion
1336                        (apply
1337                         'call-process "find" nil t
1338                         "find" group "-type" "f" "-name" "[0-9]*" "-exec"
1339                         "grep"
1340                         `("-l" ,@(and grep-options
1341                                       (split-string grep-options "\\s-" t))
1342                           "-e" ,regexp "{}" "+"))))
1343
1344                    ;; Translate relative paths to group names.
1345                    (while (not (eobp))
1346                      (let* ((path (split-string
1347                                    (buffer-substring
1348                                     (point)
1349                                     (line-end-position)) "/" t))
1350                             (art (string-to-number (car (last path)))))
1351                        (while (string= "." (car path))
1352                          (setq path (cdr path)))
1353                        (let ((group (mapconcat 'identity
1354                                                ;; Replace cl-func:
1355                                                ;; (subseq path 0 -1)
1356                                                (let ((end (1- (length path)))
1357                                                      res)
1358                                                  (while
1359                                                      (>= (setq end (1- end)) 0)
1360                                                    (push (pop path) res))
1361                                                  (nreverse res))
1362                                                ".")))
1363                          (push
1364                           (vector (gnus-group-full-name group server) art 0)
1365                           artlist))
1366                        (forward-line 1)))
1367                    (message "Searching %s using find-grep...done"
1368                             (or group server))
1369                    artlist)))
1370      grouplist))))
1371
1372 (declare-function mm-url-insert "mm-url" (url &optional follow-refresh))
1373 (declare-function mm-url-encode-www-form-urlencoded "mm-url" (pairs))
1374
1375 ;; gmane interface
1376 (defun nnir-run-gmane (query srv &optional groups)
1377   "Run a search against a gmane back-end server."
1378   (if (gnus-string-match-p  "gmane" srv)
1379       (let* ((case-fold-search t)
1380              (qstring (cdr (assq 'query query)))
1381              (server (cadr (gnus-server-to-method srv)))
1382              (groupspec (if groups
1383                             (mapconcat
1384                              (lambda (x)
1385                                (format "group:%s" (gnus-group-short-name x)))
1386                              groups " ") ""))
1387              (authorspec
1388               (if (assq 'author query)
1389                   (format "author:%s" (cdr (assq 'author query))) ""))
1390              (search (format "%s %s %s"
1391                              qstring groupspec authorspec))
1392              (gnus-inhibit-demon t)
1393              artlist)
1394         (require 'mm-url)
1395         (with-current-buffer (get-buffer-create nnir-tmp-buffer)
1396           (erase-buffer)
1397           (mm-url-insert
1398            (concat
1399             "http://search.gmane.org/nov.php"
1400             "?"
1401             (mm-url-encode-www-form-urlencoded
1402              `(("query" . ,search)
1403                ("HITSPERPAGE" . "999")))))
1404           (unless (featurep 'xemacs) (set-buffer-multibyte t))
1405           (mm-decode-coding-region (point-min) (point-max) 'utf-8)
1406           (goto-char (point-min))
1407           (forward-line 1)
1408           (while (not (eobp))
1409             (unless (or (eolp) (looking-at "\x0d"))
1410               (let ((header (nnheader-parse-nov)))
1411                 (let ((xref (mail-header-xref header))
1412                       (xscore (string-to-number (cdr (assoc 'X-Score
1413                                (mail-header-extra header))))))
1414                   (when (string-match " \\([^:]+\\)[:/]\\([0-9]+\\)" xref)
1415                     (push
1416                      (vector
1417                       (gnus-group-prefixed-name (match-string 1 xref) srv)
1418                       (string-to-number (match-string 2 xref)) xscore)
1419                      artlist)))))
1420             (forward-line 1)))
1421         (apply 'vector (nreverse (mm-delete-duplicates artlist))))
1422     (message "Can't search non-gmane nntp groups")
1423     nil))
1424
1425 ;;; Util Code:
1426
1427 (defun nnir-read-parms (query nnir-search-engine)
1428   "Reads additional search parameters according to `nnir-engines'."
1429   (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines))))
1430     (append query
1431            (mapcar 'nnir-read-parm parmspec))))
1432
1433 (defun nnir-read-parm (parmspec)
1434   "Reads a single search parameter.
1435 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1436   (let ((sym (car parmspec))
1437         (prompt (cdr parmspec)))
1438     (if (listp prompt)
1439         (let* ((result (apply 'gnus-completing-read prompt))
1440                (mapping (or (assoc result nnir-imap-search-arguments)
1441                             (cons nil nnir-imap-search-other))))
1442           (cons sym (format (cdr mapping) result)))
1443       (cons sym (read-string prompt)))))
1444
1445 (autoload 'gnus-group-topic-name "gnus-topic")
1446
1447 (defun nnir-run-query (query nserver)
1448   "Invoke appropriate search engine function (see `nnir-engines').
1449   If some groups were process-marked, run the query for each of the groups
1450   and concat the results."
1451   (let ((q (car (read-from-string query)))
1452         (groups (if (string= "all-ephemeral" nserver)
1453                     (with-current-buffer gnus-server-buffer
1454                       (list (list (gnus-server-server-name))))
1455                   (nnir-categorize
1456                    (or gnus-group-marked
1457                        (if (gnus-group-group-name)
1458                            (list (gnus-group-group-name))
1459                          (cdr (assoc (gnus-group-topic-name)
1460                                      gnus-topic-alist))))
1461                    gnus-group-server))))
1462     (apply 'vconcat
1463            (mapcar
1464             (lambda (x)
1465               (let* ((server (car x))
1466                      (nnir-search-engine
1467                       (or (nnir-read-server-parm 'nnir-search-engine
1468                                                  server)
1469                           (cdr (assoc (car
1470                                        (gnus-server-to-method server))
1471                                       nnir-method-default-engines))))
1472                      search-func)
1473                 (setq search-func (cadr (assoc nnir-search-engine
1474                                                nnir-engines)))
1475                 (if search-func
1476                     (funcall search-func
1477                              (if nnir-extra-parms
1478                                  (nnir-read-parms q nnir-search-engine)
1479                                q)
1480                              server (cadr x))
1481                   nil)))
1482             groups))))
1483
1484 (defun nnir-read-server-parm (key server)
1485   "Returns the parameter value of key for the given server, where
1486 server is of form 'backend:name'."
1487   (let ((method (gnus-server-to-method server)))
1488     (cond ((and method (assq key (cddr method)))
1489            (nth 1 (assq key (cddr method))))
1490           (t nil))))
1491
1492 (defun nnir-possibly-change-server (server)
1493   (unless (and server (nnir-server-opened server))
1494     (nnir-open-server server)))
1495
1496
1497
1498 ;; unused?
1499 (defun nnir-artlist-groups (artlist)
1500   "Returns a list of all groups in the given ARTLIST."
1501   (let ((res nil)
1502         (with-dups nil))
1503     ;; from each artitem, extract group component
1504     (setq with-dups (mapcar 'nnir-artitem-group artlist))
1505     ;; remove duplicates from above
1506     (mapc (function (lambda (x) (add-to-list 'res x)))
1507             with-dups)
1508     res))
1509
1510 (defun nnir-get-active (srv)
1511   (let ((method (gnus-server-to-method srv))
1512         groups)
1513     (gnus-request-list method)
1514     (with-current-buffer nntp-server-buffer
1515       (let ((cur (current-buffer))
1516             name)
1517         (goto-char (point-min))
1518         (unless (string= nnir-ignored-newsgroups "")
1519           (delete-matching-lines nnir-ignored-newsgroups))
1520         (if (eq (car method) 'nntp)
1521             (while (not (eobp))
1522               (ignore-errors
1523                 (push (mm-string-as-unibyte
1524                        (gnus-group-full-name
1525                         (buffer-substring
1526                          (point)
1527                          (progn
1528                            (skip-chars-forward "^ \t")
1529                            (point))) method))
1530                       groups))
1531               (forward-line))
1532           (while (not (eobp))
1533             (ignore-errors
1534               (push (mm-string-as-unibyte
1535                      (if (eq (char-after) ?\")
1536                          (gnus-group-full-name (read cur) method)
1537                        (let ((p (point)) (name ""))
1538                          (skip-chars-forward "^ \t\\\\")
1539                          (setq name (buffer-substring p (point)))
1540                          (while (eq (char-after) ?\\)
1541                            (setq p (1+ (point)))
1542                            (forward-char 2)
1543                            (skip-chars-forward "^ \t\\\\")
1544                            (setq name (concat name (buffer-substring
1545                                                     p (point)))))
1546                          (gnus-group-full-name name method))))
1547                     groups))
1548             (forward-line)))))
1549     groups))
1550
1551 (defun nnir-registry-action (action data-header from &optional to method)
1552   "Call `gnus-registry-action' with the original article group."
1553   (gnus-registry-action
1554    action
1555    data-header
1556    (nnir-article-group (mail-header-number data-header))
1557    to
1558    method))
1559
1560 (defun nnir-mode ()
1561   (when (eq (car (gnus-find-method-for-group gnus-newsgroup-name)) 'nnir)
1562     (setq gnus-summary-line-format
1563           (or nnir-summary-line-format gnus-summary-line-format))
1564     (remove-hook 'gnus-summary-article-delete-hook 'gnus-registry-action t)
1565     (remove-hook 'gnus-summary-article-move-hook 'gnus-registry-action t)
1566     (add-hook 'gnus-summary-article-delete-hook 'nnir-registry-action t t)
1567     (add-hook 'gnus-summary-article-move-hook 'nnir-registry-action t t)))
1568
1569
1570
1571 ;; The end.
1572 (provide 'nnir)
1573
1574 ;;; nnir.el ends here