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