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 (rassq 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-request-expire-articles (articles group &optional server force)
 691   (let ((articles-by-group (nnir-categorize
 692                             articles nnir-article-group nnir-article-ids))
 693         not-deleted)
 694     (while (not (null articles-by-group))
 695       (let* ((group-articles (pop articles-by-group))
 696              (artgroup (car group-articles))
 697              (articleids (cadr group-articles))
 698              (artlist (sort (mapcar 'cdr articleids) '<)))
 699         (unless (gnus-check-backend-function 'request-expire-articles
 700                                              artgroup)
 701           (error "The group %s does not support article deletion" artgroup))
 702         (unless (gnus-check-server (gnus-find-method-for-group artgroup))
 703           (error "Couldn't open server for group %s" artgroup))
 704         (push (gnus-request-expire-articles
 705                artlist artgroup force)
 706               not-deleted)))
 707     (sort (delq nil not-deleted) '<)))
 708
 709 (deffoo nnir-warp-to-article ()
 710   (let* ((cur (if (> (gnus-summary-article-number) 0)
 711                   (gnus-summary-article-number)
 712                 (error "This is not a real article.")))
 713          (gnus-newsgroup-name (nnir-article-group cur))
 714          (backend-number (nnir-article-number cur)))
 715     (gnus-summary-read-group-1 gnus-newsgroup-name t t gnus-summary-buffer
 716                                nil (list backend-number))))
 717
 718 (nnoo-define-skeleton nnir)
 719
 720
 721 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
 722   "Ask `nnir-compose-result' to construct a result vector,
 723 and if it is non-nil, add it to artlist."
 724   `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
 725      (when (not (null result))
 726        (push result ,artlist))))
 727
 728 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
 729
 730 ;; Helper function currently used by the Swish++ and Namazu backends;
 731 ;; perhaps useful for other backends as well
 732 (defun nnir-compose-result (dirnam article score prefix server)
 733   "Extract the group from dirnam, and create a result vector
 734 ready to be added to the list of search results."
 735
 736   ;; remove nnir-*-remove-prefix from beginning of dirnam filename
 737   (when (string-match (concat "^" prefix) dirnam)
 738     (setq dirnam (replace-match "" t t dirnam)))
 739
 740   (when (file-readable-p (concat prefix dirnam article))
 741     ;; remove trailing slash and, for nnmaildir, cur/new/tmp
 742     (setq dirnam
 743           (substring dirnam 0
 744                      (if (string= (gnus-group-server server) "nnmaildir")
 745                          -5 -1)))
 746
 747     ;; Set group to dirnam without any leading dots or slashes,
 748     ;; and with all subsequent slashes replaced by dots
 749     (let ((group (gnus-replace-in-string
 750                  (gnus-replace-in-string dirnam "^[./\\]" "" t)
 751                  "[/\\]" "." t)))
 752
 753     (vector (gnus-group-full-name group server)
 754             (if (string= (gnus-group-server server) "nnmaildir")
 755                 (nnmaildir-base-name-to-article-number
 756                  (substring article 0 (string-match ":" article))
 757                  group nil)
 758               (string-to-number article))
 759             (string-to-number score)))))
 760
 761 ;;; Search Engine Interfaces:
 762
 763 ;; imap interface
 764 (defun nnir-run-imap (query srv &optional groups)
 765   "Run a search against an IMAP back-end server.
 766 This uses a custom query language parser; see `nnir-imap-make-query' for
 767 details on the language and supported extensions"
 768   (save-excursion
 769     (let ((qstring (cdr (assq 'query query)))
 770           (server (cadr (gnus-server-to-method srv)))
 771           (defs (caddr (gnus-server-to-method srv)))
 772           (criteria (or (cdr (assq 'criteria query))
 773                         (cdr (assoc nnir-imap-default-search-key
 774                                     nnir-imap-search-arguments))))
 775           (gnus-inhibit-demon t)
 776           (groups (or groups (nnir-get-active srv))))
 777       (message "Opening server %s" server)
 778       (apply
 779        'vconcat
 780        (mapcar
 781         (lambda (group)
 782           (let (artlist)
 783             (condition-case ()
 784                 (when (nnimap-possibly-change-group
 785                        (gnus-group-short-name group) server)
 786                   (with-current-buffer (nnimap-buffer)
 787                     (message "Searching %s..." group)
 788                     (let ((arts 0)
 789                           (result (nnimap-command "UID SEARCH %s"
 790                                                   (if (string= criteria "")
 791                                                       qstring
 792                                                     (nnir-imap-make-query
 793                                                      criteria qstring)))))
 794                       (mapc
 795                        (lambda (artnum) (push (vector group artnum 100) artlist)
 796                          (setq arts (1+ arts)))
 797                        (and (car result)
 798                             (delete 0 (mapcar #'string-to-number
 799                                               (cdr (assoc "SEARCH"
 800                                                           (cdr result)))))))
 801                       (message "Searching %s... %d matches" group arts)))
 802                   (message "Searching %s...done" group))
 803               (quit nil))
 804             artlist))
 805         groups)))))
 806
 807 (defun nnir-imap-make-query (criteria qstring)
 808   "Parse the query string and criteria into an appropriate IMAP search
 809 expression, returning the string query to make.
 810
 811 This implements a little language designed to return the expected results
 812 to an arbitrary query string to the end user.
 813
 814 The search is always case-insensitive, as defined by RFC2060, and supports
 815 the following features (inspired by the Google search input language):
 816
 817 Automatic \"and\" queries
 818     If you specify multiple words then they will be treated as an \"and\"
 819     expression intended to match all components.
 820
 821 Phrase searches
 822     If you wrap your query in double-quotes then it will be treated as a
 823     literal string.
 824
 825 Negative terms
 826     If you precede a term with \"-\" then it will negate that.
 827
 828 \"OR\" queries
 829     If you include an upper-case \"OR\" in your search it will cause the
 830     term before it and the term after it to be treated as alternatives.
 831
 832 In future the following will be added to the language:
 833  * support for date matches
 834  * support for location of text matching within the query
 835  * from/to/etc headers
 836  * additional search terms
 837  * flag based searching
 838  * anything else that the RFC supports, basically."
 839   ;; Walk through the query and turn it into an IMAP query string.
 840   (nnir-imap-query-to-imap criteria (nnir-imap-parse-query qstring)))
 841
 842
 843 (defun nnir-imap-query-to-imap (criteria query)
 844   "Turn a s-expression format query into IMAP."
 845   (mapconcat
 846    ;; Turn the expressions into IMAP text
 847    (lambda (item)
 848      (nnir-imap-expr-to-imap criteria item))
 849    ;; The query, already in s-expr format.
 850    query
 851    ;; Append a space between each expression
 852    " "))
 853
 854
 855 (defun nnir-imap-expr-to-imap (criteria expr)
 856   "Convert EXPR into an IMAP search expression on CRITERIA"
 857   ;; What sort of expression is this, eh?
 858   (cond
 859    ;; Simple string term
 860    ((stringp expr)
 861     (format "%s %S" criteria expr))
 862    ;; Trivial term: and
 863    ((eq expr 'and) nil)
 864    ;; Composite term: or expression
 865    ((eq (car-safe expr) 'or)
 866     (format "OR %s %s"
 867             (nnir-imap-expr-to-imap criteria (second expr))
 868             (nnir-imap-expr-to-imap criteria (third expr))))
 869    ;; Composite term: just the fax, mam
 870    ((eq (car-safe expr) 'not)
 871     (format "NOT (%s)" (nnir-imap-query-to-imap criteria (rest expr))))
 872    ;; Composite term: just expand it all.
 873    ((and (not (null expr)) (listp expr))
 874     (format "(%s)" (nnir-imap-query-to-imap criteria expr)))
 875    ;; Complex value, give up for now.
 876    (t (error "Unhandled input: %S" expr))))
 877
 878
 879 (defun nnir-imap-parse-query (string)
 880   "Turn STRING into an s-expression based query based on the IMAP
 881 query language as defined in `nnir-imap-make-query'.
 882
 883 This involves turning individual tokens into higher level terms
 884 that the search language can then understand and use."
 885   (with-temp-buffer
 886     ;; Set up the parsing environment.
 887     (insert string)
 888     (goto-char (point-min))
 889     ;; Now, collect the output terms and return them.
 890     (let (out)
 891       (while (not (nnir-imap-end-of-input))
 892         (push (nnir-imap-next-expr) out))
 893       (reverse out))))
 894
 895
 896 (defun nnir-imap-next-expr (&optional count)
 897   "Return the next expression from the current buffer."
 898   (let ((term (nnir-imap-next-term count))
 899         (next (nnir-imap-peek-symbol)))
 900     ;; Are we looking at an 'or' expression?
 901     (cond
 902      ;; Handle 'expr or expr'
 903      ((eq next 'or)
 904       (list 'or term (nnir-imap-next-expr 2)))
 905      ;; Anything else
 906      (t term))))
 907
 908
 909 (defun nnir-imap-next-term (&optional count)
 910   "Return the next TERM from the current buffer."
 911   (let ((term (nnir-imap-next-symbol count)))
 912     ;; What sort of term is this?
 913     (cond
 914      ;; and -- just ignore it
 915      ((eq term 'and) 'and)
 916      ;; negated term
 917      ((eq term 'not) (list 'not (nnir-imap-next-expr)))
 918      ;; generic term
 919      (t term))))
 920
 921
 922 (defun nnir-imap-peek-symbol ()
 923   "Return the next symbol from the current buffer, but don't consume it."
 924   (save-excursion
 925     (nnir-imap-next-symbol)))
 926
 927 (defun nnir-imap-next-symbol (&optional count)
 928   "Return the next symbol from the current buffer, or nil if we are
 929 at the end of the buffer.  If supplied COUNT skips some symbols before
 930 returning the one at the supplied position."
 931   (when (and (numberp count) (> count 1))
 932     (nnir-imap-next-symbol (1- count)))
 933   (let ((case-fold-search t))
 934     ;; end of input stream?
 935     (unless (nnir-imap-end-of-input)
 936       ;; No, return the next symbol from the stream.
 937       (cond
 938        ;; negated expression -- return it and advance one char.
 939        ((looking-at "-") (forward-char 1) 'not)
 940        ;; quoted string
 941        ((looking-at "\"") (nnir-imap-delimited-string "\""))
 942        ;; list expression -- we parse the content and return this as a list.
 943        ((looking-at "(")
 944         (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
 945        ;; keyword input -- return a symbol version
 946        ((looking-at "\\band\\b") (forward-char 3) 'and)
 947        ((looking-at "\\bor\\b")  (forward-char 2) 'or)
 948        ((looking-at "\\bnot\\b") (forward-char 3) 'not)
 949        ;; Simple, boring keyword
 950        (t (let ((start (point))
 951                 (end (if (search-forward-regexp "[[:blank:]]" nil t)
 952                          (prog1
 953                              (match-beginning 0)
 954                            ;; unskip if we hit a non-blank terminal character.
 955                            (when (string-match "[^[:blank:]]" (match-string 0))
 956                              (backward-char 1)))
 957                        (goto-char (point-max)))))
 958             (buffer-substring start end)))))))
 959
 960 (defun nnir-imap-delimited-string (delimiter)
 961   "Return a delimited string from the current buffer."
 962   (let ((start (point)) end)
 963     (forward-char 1)                    ; skip the first delimiter.
 964     (while (not end)
 965       (unless (search-forward delimiter nil t)
 966         (error "Unmatched delimited input with %s in query" delimiter))
 967       (let ((here (point)))
 968         (unless (equal (buffer-substring (- here 2) (- here 1)) "\\")
 969           (setq end (point)))))
 970     (buffer-substring (1+ start) (1- end))))
 971
 972 (defun nnir-imap-end-of-input ()
 973   "Are we at the end of input?"
 974   (skip-chars-forward "[[:blank:]]")
 975   (looking-at "$"))
 976
 977
 978 ;; Swish++ interface.
 979 ;; -cc- Todo
 980 ;; Search by
 981 ;; - group
 982 ;; Sort by
 983 ;; - rank (default)
 984 ;; - article number
 985 ;; - file size
 986 ;; - group
 987 (defun nnir-run-swish++ (query server &optional group)
 988   "Run QUERY against swish++.
 989 Returns a vector of (group name, file name) pairs (also vectors,
 990 actually).
 991
 992 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
 993 Windows NT 4.0."
 994
 995   ;; (when group
 996   ;;   (error "The swish++ backend cannot search specific groups"))
 997
 998   (save-excursion
 999     (let ( (qstring (cdr (assq 'query query)))
1000            (groupspec (cdr (assq 'group query)))
1001            (prefix (nnir-read-server-parm 'nnir-swish++-remove-prefix server))
1002            artlist
1003            ;; nnml-use-compressed-files might be any string, but probably this
1004            ;; is sufficient.  Note that we can't only use the value of
1005            ;; nnml-use-compressed-files because old articles might have been
1006            ;; saved with a different value.
1007            (article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1008                                 ":[0-9]+"
1009                               "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
1010            score artno dirnam filenam)
1011
1012       (when (equal "" qstring)
1013         (error "swish++: You didn't enter anything"))
1014
1015       (set-buffer (get-buffer-create nnir-tmp-buffer))
1016       (erase-buffer)
1017
1018       (if groupspec
1019           (message "Doing swish++ query %s on %s..." qstring groupspec)
1020         (message "Doing swish++ query %s..." qstring))
1021
1022       (let* ((cp-list `( ,nnir-swish++-program
1023                          nil            ; input from /dev/null
1024                          t              ; output
1025                          nil            ; don't redisplay
1026                          "--config-file" ,(nnir-read-server-parm 'nnir-swish++-configuration-file server)
1027                          ,@(nnir-read-server-parm 'nnir-swish++-additional-switches server)
1028                          ,qstring       ; the query, in swish++ format
1029                          ))
1030              (exitstatus
1031               (progn
1032                 (message "%s args: %s" nnir-swish++-program
1033                          (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1034                 (apply 'call-process cp-list))))
1035         (unless (or (null exitstatus)
1036                     (zerop exitstatus))
1037           (nnheader-report 'nnir "Couldn't run swish++: %s" exitstatus)
1038           ;; swish++ failure reason is in this buffer, show it if
1039           ;; the user wants it.
1040           (when (> gnus-verbose 6)
1041             (display-buffer nnir-tmp-buffer))))
1042
1043       ;; The results are output in the format of:
1044       ;; V 4.7 Linux
1045       ;; rank relative-path-name file-size file-title
1046       ;; V 5.0b2:
1047       ;; rank relative-path-name file-size topic??
1048       ;; where rank is an integer from 1 to 100.
1049       (goto-char (point-min))
1050       (while (re-search-forward
1051               "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t)
1052         (setq score (match-string 1)
1053               filenam (match-string 2)
1054               artno (file-name-nondirectory filenam)
1055               dirnam (file-name-directory filenam))
1056
1057         ;; don't match directories
1058         (when (string-match article-pattern artno)
1059           (when (not (null dirnam))
1060
1061             ;; maybe limit results to matching groups.
1062             (when (or (not groupspec)
1063                       (string-match groupspec dirnam))
1064               (nnir-add-result dirnam artno score prefix server artlist)))))
1065
1066       (message "Massaging swish++ output...done")
1067
1068       ;; Sort by score
1069       (apply 'vector
1070              (sort artlist
1071                    (function (lambda (x y)
1072                                (> (nnir-artitem-rsv x)
1073                                   (nnir-artitem-rsv y)))))))))
1074
1075 ;; Swish-E interface.
1076 (defun nnir-run-swish-e (query server &optional group)
1077   "Run given query against swish-e.
1078 Returns a vector of (group name, file name) pairs (also vectors,
1079 actually).
1080
1081 Tested with swish-e-2.0.1 on Windows NT 4.0."
1082
1083   ;; swish-e crashes with empty parameter to "-w" on commandline...
1084   ;; (when group
1085   ;;   (error "The swish-e backend cannot search specific groups"))
1086
1087   (save-excursion
1088     (let ((qstring (cdr (assq 'query query)))
1089           (prefix
1090            (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server)
1091                (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1092           artlist score artno dirnam group )
1093
1094       (when (equal "" qstring)
1095         (error "swish-e: You didn't enter anything"))
1096
1097       (set-buffer (get-buffer-create nnir-tmp-buffer))
1098       (erase-buffer)
1099
1100       (message "Doing swish-e query %s..." query)
1101       (let* ((index-files
1102               (or (nnir-read-server-parm
1103                    'nnir-swish-e-index-files server)
1104                   (error "Missing parameter `nnir-swish-e-index-files'")))
1105              (additional-switches
1106               (nnir-read-server-parm
1107                'nnir-swish-e-additional-switches server))
1108              (cp-list `(,nnir-swish-e-program
1109                         nil             ; input from /dev/null
1110                         t               ; output
1111                         nil             ; don't redisplay
1112                         "-f" ,@index-files
1113                         ,@additional-switches
1114                         "-w"
1115                         ,qstring        ; the query, in swish-e format
1116                         ))
1117              (exitstatus
1118               (progn
1119                 (message "%s args: %s" nnir-swish-e-program
1120                          (mapconcat 'identity (cddddr cp-list) " "))
1121                 (apply 'call-process cp-list))))
1122         (unless (or (null exitstatus)
1123                     (zerop exitstatus))
1124           (nnheader-report 'nnir "Couldn't run swish-e: %s" exitstatus)
1125           ;; swish-e failure reason is in this buffer, show it if
1126           ;; the user wants it.
1127           (when (> gnus-verbose 6)
1128             (display-buffer nnir-tmp-buffer))))
1129
1130       ;; The results are output in the format of:
1131       ;; rank path-name file-title file-size
1132       (goto-char (point-min))
1133       (while (re-search-forward
1134               "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t)
1135         (setq score (match-string 1)
1136               artno (match-string 3)
1137               dirnam (file-name-directory (match-string 2)))
1138
1139         ;; don't match directories
1140         (when (string-match "^[0-9]+$" artno)
1141           (when (not (null dirnam))
1142
1143             ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1144             (when (string-match (concat "^" prefix) dirnam)
1145               (setq dirnam (replace-match "" t t dirnam)))
1146
1147             (setq dirnam (substring dirnam 0 -1))
1148             ;; eliminate all ".", "/", "\" from beginning. Always matches.
1149             (string-match "^[./\\]*\\(.*\\)$" dirnam)
1150             ;; "/" -> "."
1151             (setq group (gnus-replace-in-string (match-string 1 dirnam) "/" "."))
1152             ;; Windows "\\" -> "."
1153             (setq group (gnus-replace-in-string group "\\\\" "."))
1154
1155             (push (vector (gnus-group-full-name group server)
1156                           (string-to-number artno)
1157                           (string-to-number score))
1158                   artlist))))
1159
1160       (message "Massaging swish-e output...done")
1161
1162       ;; Sort by score
1163       (apply 'vector
1164              (sort artlist
1165                    (function (lambda (x y)
1166                                (> (nnir-artitem-rsv x)
1167                                   (nnir-artitem-rsv y)))))))))
1168
1169 ;; HyREX interface
1170 (defun nnir-run-hyrex (query server &optional group)
1171   (save-excursion
1172     (let ((artlist nil)
1173           (groupspec (cdr (assq 'group query)))
1174           (qstring (cdr (assq 'query query)))
1175           (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server))
1176           score artno dirnam)
1177       (when (and (not groupspec) group)
1178         (setq groupspec
1179               (regexp-opt
1180                (mapcar (lambda (x) (gnus-group-real-name x)) group))))
1181       (set-buffer (get-buffer-create nnir-tmp-buffer))
1182       (erase-buffer)
1183       (message "Doing hyrex-search query %s..." query)
1184       (let* ((cp-list
1185               `( ,nnir-hyrex-program
1186                  nil                    ; input from /dev/null
1187                  t                      ; output
1188                  nil                    ; don't redisplay
1189                  "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server) ; index directory
1190                  ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server)
1191                  ,qstring          ; the query, in hyrex-search format
1192                  ))
1193              (exitstatus
1194               (progn
1195                 (message "%s args: %s" nnir-hyrex-program
1196                          (mapconcat 'identity (cddddr cp-list) " "))
1197                 (apply 'call-process cp-list))))
1198         (unless (or (null exitstatus)
1199                     (zerop exitstatus))
1200           (nnheader-report 'nnir "Couldn't run hyrex-search: %s" exitstatus)
1201           ;; nnir-search failure reason is in this buffer, show it if
1202           ;; the user wants it.
1203           (when (> gnus-verbose 6)
1204             (display-buffer nnir-tmp-buffer)))) ;; FIXME: Dont clear buffer !
1205       (message "Doing hyrex-search query \"%s\"...done" qstring)
1206       (sit-for 0)
1207       ;; nnir-search returns:
1208       ;;   for nnml/nnfolder: "filename mailid weigth"
1209       ;;   for nnimap:        "group mailid weigth"
1210       (goto-char (point-min))
1211       (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1212       ;; HyREX doesn't search directly in groups -- so filter out here.
1213       (when groupspec
1214         (keep-lines groupspec))
1215       ;; extract data from result lines
1216       (goto-char (point-min))
1217       (while (re-search-forward
1218               "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t)
1219         (setq dirnam (match-string 1)
1220               artno (match-string 2)
1221               score (match-string 3))
1222         (when (string-match prefix dirnam)
1223           (setq dirnam (replace-match "" t t dirnam)))
1224         (push (vector (gnus-group-full-name
1225                        (gnus-replace-in-string dirnam "/" ".") server)
1226                       (string-to-number artno)
1227                       (string-to-number score))
1228               artlist))
1229       (message "Massaging hyrex-search output...done.")
1230       (apply 'vector
1231              (sort artlist
1232                    (function (lambda (x y)
1233                                (if (string-lessp (nnir-artitem-group x)
1234                                                  (nnir-artitem-group y))
1235                                    t
1236                                  (< (nnir-artitem-number x)
1237                                     (nnir-artitem-number y)))))))
1238       )))
1239
1240 ;; Namazu interface
1241 (defun nnir-run-namazu (query server &optional group)
1242   "Run given query against Namazu.  Returns a vector of (group name, file name)
1243 pairs (also vectors, actually).
1244
1245 Tested with Namazu 2.0.6 on a GNU/Linux system."
1246   ;; (when group
1247   ;;   (error "The Namazu backend cannot search specific groups"))
1248   (save-excursion
1249     (let ((article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1250                                ":[0-9]+"
1251                              "^[0-9]+$"))
1252           artlist
1253           (qstring (cdr (assq 'query query)))
1254           (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server))
1255           score group article
1256           (process-environment (copy-sequence process-environment)))
1257       (setenv "LC_MESSAGES" "C")
1258       (set-buffer (get-buffer-create nnir-tmp-buffer))
1259       (erase-buffer)
1260       (let* ((cp-list
1261               `( ,nnir-namazu-program
1262                  nil                    ; input from /dev/null
1263                  t                      ; output
1264                  nil                    ; don't redisplay
1265                  "-q"                   ; don't be verbose
1266                  "-a"                   ; show all matches
1267                  "-s"                   ; use short format
1268                  ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server)
1269                  ,qstring               ; the query, in namazu format
1270                  ,(nnir-read-server-parm 'nnir-namazu-index-directory server) ; index directory
1271                  ))
1272              (exitstatus
1273               (progn
1274                 (message "%s args: %s" nnir-namazu-program
1275                          (mapconcat 'identity (cddddr cp-list) " "))
1276                 (apply 'call-process cp-list))))
1277         (unless (or (null exitstatus)
1278                     (zerop exitstatus))
1279           (nnheader-report 'nnir "Couldn't run namazu: %s" exitstatus)
1280           ;; Namazu failure reason is in this buffer, show it if
1281           ;; the user wants it.
1282           (when (> gnus-verbose 6)
1283             (display-buffer nnir-tmp-buffer))))
1284
1285       ;; Namazu output looks something like this:
1286       ;; 2. Re: Gnus agent expire broken (score: 55)
1287       ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1288
1289       (goto-char (point-min))
1290       (while (re-search-forward
1291               "^\\([0-9]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1292               nil t)
1293         (setq score (match-string 3)
1294               group (file-name-directory (match-string 4))
1295               article (file-name-nondirectory (match-string 4)))
1296
1297         ;; make sure article and group is sane
1298         (when (and (string-match article-pattern article)
1299                    (not (null group)))
1300           (nnir-add-result group article score prefix server artlist)))
1301
1302       ;; sort artlist by score
1303       (apply 'vector
1304              (sort artlist
1305                    (function (lambda (x y)
1306                                (> (nnir-artitem-rsv x)
1307                                   (nnir-artitem-rsv y)))))))))
1308
1309 (defun nnir-run-find-grep (query server &optional grouplist)
1310   "Run find and grep to obtain matching articles."
1311   (let* ((method (gnus-server-to-method server))
1312          (sym (intern
1313                (concat (symbol-name (car method)) "-directory")))
1314          (directory (cadr (assoc sym (cddr method))))
1315          (regexp (cdr (assoc 'query query)))
1316          (grep-options (cdr (assoc 'grep-options query)))
1317          (grouplist (or grouplist (nnir-get-active server)))
1318          artlist)
1319     (unless directory
1320       (error "No directory found in method specification of server %s"
1321              server))
1322     (apply
1323      'vconcat
1324      (mapcar (lambda (x)
1325                (let ((group x))
1326                  (message "Searching %s using find-grep..."
1327                           (or group server))
1328                  (save-window-excursion
1329                    (set-buffer (get-buffer-create nnir-tmp-buffer))
1330                    (erase-buffer)
1331                    (if (> gnus-verbose 6)
1332                        (pop-to-buffer (current-buffer)))
1333                    (cd directory) ; Using relative paths simplifies
1334                                   ; postprocessing.
1335                    (let ((group
1336                           (if (not group)
1337                               "."
1338                             ;; Try accessing the group literally as
1339                             ;; well as interpreting dots as directory
1340                             ;; separators so the engine works with
1341                             ;; plain nnml as well as the Gnus Cache.
1342                             (let ((group (gnus-group-real-name group)))
1343                               ;; Replace cl-func find-if.
1344                               (if (file-directory-p group)
1345                                   group
1346                                 (if (file-directory-p
1347                                      (setq group
1348                                            (gnus-replace-in-string
1349                                             group
1350                                             "\\." "/" t)))
1351                                     group))))))
1352                      (unless group
1353                        (error "Cannot locate directory for group"))
1354                      (save-excursion
1355                        (apply
1356                         'call-process "find" nil t
1357                         "find" group "-type" "f" "-name" "[0-9]*" "-exec"
1358                         "grep"
1359                         `("-l" ,@(and grep-options
1360                                       (split-string grep-options "\\s-" t))
1361                           "-e" ,regexp "{}" "+"))))
1362
1363                    ;; Translate relative paths to group names.
1364                    (while (not (eobp))
1365                      (let* ((path (split-string
1366                                    (buffer-substring
1367                                     (point)
1368                                     (line-end-position)) "/" t))
1369                             (art (string-to-number (car (last path)))))
1370                        (while (string= "." (car path))
1371                          (setq path (cdr path)))
1372                        (let ((group (mapconcat 'identity
1373                                                ;; Replace cl-func:
1374                                                ;; (subseq path 0 -1)
1375                                                (let ((end (1- (length path)))
1376                                                      res)
1377                                                  (while
1378                                                      (>= (setq end (1- end)) 0)
1379                                                    (push (pop path) res))
1380                                                  (nreverse res))
1381                                                ".")))
1382                          (push
1383                           (vector (gnus-group-full-name group server) art 0)
1384                           artlist))
1385                        (forward-line 1)))
1386                    (message "Searching %s using find-grep...done"
1387                             (or group server))
1388                    artlist)))
1389      grouplist))))
1390
1391 (declare-function mm-url-insert "mm-url" (url &optional follow-refresh))
1392 (declare-function mm-url-encode-www-form-urlencoded "mm-url" (pairs))
1393
1394 ;; gmane interface
1395 (defun nnir-run-gmane (query srv &optional groups)
1396   "Run a search against a gmane back-end server."
1397   (if (gnus-string-match-p  "gmane" srv)
1398       (let* ((case-fold-search t)
1399              (qstring (cdr (assq 'query query)))
1400              (server (cadr (gnus-server-to-method srv)))
1401              (groupspec (mapconcat
1402                          (lambda (x)
1403                            (format "group:%s" (gnus-group-short-name x)))
1404                          groups " "))
1405              (authorspec
1406               (if (assq 'author query)
1407                   (format "author:%s" (cdr (assq 'author query))) ""))
1408              (search (format "%s %s %s"
1409                              qstring groupspec authorspec))
1410              (gnus-inhibit-demon t)
1411              artlist)
1412         (require 'mm-url)
1413         (with-current-buffer (get-buffer-create nnir-tmp-buffer)
1414           (erase-buffer)
1415           (mm-url-insert
1416            (concat
1417             "http://search.gmane.org/nov.php"
1418             "?"
1419             (mm-url-encode-www-form-urlencoded
1420              `(("query" . ,search)
1421                ("HITSPERPAGE" . "999")))))
1422           (unless (featurep 'xemacs) (set-buffer-multibyte t))
1423           (mm-decode-coding-region (point-min) (point-max) 'utf-8)
1424           (goto-char (point-min))
1425           (forward-line 1)
1426           (while (not (eobp))
1427             (unless (or (eolp) (looking-at "\x0d"))
1428               (let ((header (nnheader-parse-nov)))
1429                 (let ((xref (mail-header-xref header))
1430                       (xscore (string-to-number (cdr (assoc 'X-Score
1431                                (mail-header-extra header))))))
1432                   (when (string-match " \\([^:]+\\)[:/]\\([0-9]+\\)" xref)
1433                     (push
1434                      (vector
1435                       (gnus-group-prefixed-name (match-string 1 xref) srv)
1436                       (string-to-number (match-string 2 xref)) xscore)
1437                      artlist)))))
1438             (forward-line 1)))
1439         (apply 'vector (nreverse (mm-delete-duplicates artlist))))
1440     (message "Can't search non-gmane nntp groups")
1441     nil))
1442
1443 ;;; Util Code:
1444
1445 (defun nnir-read-parms (query nnir-search-engine)
1446   "Reads additional search parameters according to `nnir-engines'."
1447   (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines))))
1448     (append query
1449            (mapcar 'nnir-read-parm parmspec))))
1450
1451 (defun nnir-read-parm (parmspec)
1452   "Reads a single search parameter.
1453 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1454   (let ((sym (car parmspec))
1455         (prompt (cdr parmspec)))
1456     (if (listp prompt)
1457         (let* ((result (apply 'gnus-completing-read prompt))
1458                (mapping (or (assoc result nnir-imap-search-arguments)
1459                             (cons nil nnir-imap-search-other))))
1460           (cons sym (format (cdr mapping) result)))
1461       (cons sym (read-string prompt)))))
1462
1463 (autoload 'gnus-group-topic-name "gnus-topic")
1464
1465 (defun nnir-run-query (query nserver)
1466   "Invoke appropriate search engine function (see `nnir-engines').
1467   If some groups were process-marked, run the query for each of the groups
1468   and concat the results."
1469   (let ((q (car (read-from-string query)))
1470         (groups (if (string= "all-ephemeral" nserver)
1471                     (with-current-buffer gnus-server-buffer
1472                       (list (list (gnus-server-server-name))))
1473                   (nnir-categorize
1474                    (or gnus-group-marked
1475                        (if (gnus-group-group-name)
1476                            (list (gnus-group-group-name))
1477                          (cdr (assoc (gnus-group-topic-name)
1478                                      gnus-topic-alist))))
1479                    gnus-group-server))))
1480     (apply 'vconcat
1481            (mapcar
1482             (lambda (x)
1483               (let* ((server (car x))
1484                      (nnir-search-engine
1485                       (or (nnir-read-server-parm 'nnir-search-engine
1486                                                  server)
1487                           (cdr (assoc (car
1488                                        (gnus-server-to-method server))
1489                                       nnir-method-default-engines))))
1490                      search-func)
1491                 (setq search-func (cadr (assoc nnir-search-engine
1492                                                nnir-engines)))
1493                 (if search-func
1494                     (funcall search-func
1495                              (if nnir-extra-parms
1496                                  (nnir-read-parms q nnir-search-engine)
1497                                q)
1498                              server (cadr x))
1499                   nil)))
1500             groups))))
1501
1502 (defun nnir-read-server-parm (key server)
1503   "Returns the parameter value of key for the given server, where
1504 server is of form 'backend:name'."
1505   (let ((method (gnus-server-to-method server)))
1506     (cond ((and method (assq key (cddr method)))
1507            (nth 1 (assq key (cddr method))))
1508           (t nil))))
1509
1510 (defun nnir-possibly-change-server (server)
1511   (unless (and server (nnir-server-opened server))
1512     (nnir-open-server server)))
1513
1514
1515
1516 ;; unused?
1517 (defun nnir-artlist-groups (artlist)
1518   "Returns a list of all groups in the given ARTLIST."
1519   (let ((res nil)
1520         (with-dups nil))
1521     ;; from each artitem, extract group component
1522     (setq with-dups (mapcar 'nnir-artitem-group artlist))
1523     ;; remove duplicates from above
1524     (mapc (function (lambda (x) (add-to-list 'res x)))
1525             with-dups)
1526     res))
1527
1528 (defun nnir-get-active (srv)
1529   (let ((method (gnus-server-to-method srv))
1530         groups)
1531     (gnus-request-list method)
1532     (with-current-buffer nntp-server-buffer
1533       (let ((cur (current-buffer))
1534             name)
1535         (goto-char (point-min))
1536         (unless (string= nnir-ignored-newsgroups "")
1537           (delete-matching-lines nnir-ignored-newsgroups))
1538         (if (eq (car method) 'nntp)
1539             (while (not (eobp))
1540               (ignore-errors
1541                 (push (mm-string-as-unibyte
1542                        (gnus-group-full-name
1543                         (buffer-substring
1544                          (point)
1545                          (progn
1546                            (skip-chars-forward "^ \t")
1547                            (point))) method))
1548                       groups))
1549               (forward-line))
1550           (while (not (eobp))
1551             (ignore-errors
1552               (push (mm-string-as-unibyte
1553                      (if (eq (char-after) ?\")
1554                          (gnus-group-full-name (read cur) method)
1555                        (let ((p (point)) (name ""))
1556                          (skip-chars-forward "^ \t\\\\")
1557                          (setq name (buffer-substring p (point)))
1558                          (while (eq (char-after) ?\\)
1559                            (setq p (1+ (point)))
1560                            (forward-char 2)
1561                            (skip-chars-forward "^ \t\\\\")
1562                            (setq name (concat name (buffer-substring
1563                                                     p (point)))))
1564                          (gnus-group-full-name name method))))
1565                     groups))
1566             (forward-line)))))
1567     groups))
1568
1569 (defun nnir-registry-action (action data-header from &optional to method)
1570   "Call `gnus-registry-action' with the original article group."
1571   (gnus-registry-action
1572    action
1573    data-header
1574    (nnir-article-group (mail-header-number data-header))
1575    to
1576    method))
1577
1578 (defun nnir-mode ()
1579   (when (eq (car (gnus-find-method-for-group gnus-newsgroup-name)) 'nnir)
1580     (setq gnus-summary-line-format
1581           (or nnir-summary-line-format gnus-summary-line-format))
1582     (remove-hook 'gnus-summary-article-delete-hook 'gnus-registry-action t)
1583     (remove-hook 'gnus-summary-article-move-hook 'gnus-registry-action t)
1584     (add-hook 'gnus-summary-article-delete-hook 'nnir-registry-action t t)
1585     (add-hook 'gnus-summary-article-move-hook 'nnir-registry-action t t)))
1586
1587
1588
1589 ;; The end.
1590 (provide 'nnir)
1591
1592 ;;; nnir.el ends here