1 ;;; nnir.el --- search mail with various search engines -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
4 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
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
16 ;; This file is part of GNU Emacs.
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.
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.
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/>.
33 ;; TODO: Documentation in the Gnus manual
36 ;; Subject: Re: Including nnir.el
37 ;; Newsgroups: gmane.emacs.gnus.general
38 ;; Message-ID: <v9d5dnp6aq.fsf@marauder.physik.uni-ulm.de>
39 ;; Date: 2006-06-05 22:49:01 GMT
41 ;; On Sun, Jun 04 2006, Sascha Wilde wrote:
43 ;; > The one thing most hackers like to forget: Documentation. By now the
44 ;; > documentation is only in the comments at the head of the source, I
45 ;; > would use it as basis to cook up some minimal texinfo docs.
47 ;; > Where in the existing gnus manual would this fit best?
49 ;; Maybe (info "(gnus)Combined Groups") for a general description.
50 ;; `gnus-group-make-nnir-group' might be described in (info
51 ;; "(gnus)Foreign Groups") as well.
54 ;; The most recent version of this can always be fetched from the Gnus
55 ;; repository. See http://www.gnus.org/ for more information.
57 ;; This code is still in the development stage but I'd like other
58 ;; people to have a look at it. Please do not hesitate to contact me
61 ;; What does it do? Well, it allows you to index your mail using some
62 ;; search engine (freeWAIS-sf, swish-e and others -- see later),
63 ;; then type `G G' in the Group buffer and issue a query to the search
64 ;; engine. You will then get a buffer which shows all articles
65 ;; matching the query, sorted by Retrieval Status Value (score).
67 ;; When looking at the retrieval result (in the Summary buffer) you
68 ;; can type `G T' (aka M-x gnus-summary-nnir-goto-thread RET) on an
69 ;; article. You will be teleported into the group this article came
70 ;; from, showing the thread this article is part of. (See below for
73 ;; The Lisp installation is simple: just put this file on your
74 ;; load-path, byte-compile it, and load it from ~/.gnus or something.
75 ;; This will install a new command `G G' in your Group buffer for
76 ;; searching your mail. Note that you also need to configure a number
77 ;; of variables, as described below.
81 ;; * If you don't use HyREX as your search engine, this expects that
82 ;; you use nnml or another one-file-per-message backend, because the
83 ;; others doesn't support nnfolder.
84 ;; * It can only search the mail backend's which are supported by one
85 ;; search engine, because of different query languages.
86 ;; * There are restrictions to the Wais setup.
87 ;; * There are restrictions to the imap setup.
88 ;; * gnus-summary-nnir-goto-thread: Fetches whole group first, before
89 ;; limiting to the right articles. This is much too slow, of
90 ;; course. May issue a query for number of articles to fetch; you
91 ;; must accept the default of all articles at this point or things
94 ;; The Lisp setup involves setting a few variables and setting up the
95 ;; search engine. You can define the variables in the server definition
97 ;; (setq gnus-secondary-select-methods '(
98 ;; (nnimap "" (nnimap-address "localhost")
99 ;; (nnir-search-engine hyrex)
100 ;; (nnir-hyrex-additional-switches ("-d" "ddl-nnimap.xml"))
102 ;; Or you can define the global ones. The variables set in the mailer-
103 ;; definition will be used first.
104 ;; The variable to set is `nnir-search-engine'. Choose one of the engines
105 ;; listed in `nnir-engines'. (Actually `nnir-engines' is an alist,
106 ;; type `C-h v nnir-engines RET' for more information; this includes
107 ;; examples for setting `nnir-search-engine', too.)
109 ;; The variable nnir-mail-backend isn't used anymore.
112 ;; You must also set up a search engine. I'll tell you about the two
113 ;; search engines currently supported:
117 ;; As always with freeWAIS-sf, you need a so-called `format file'. I
118 ;; use the following file:
121 ;; | # Kai's format file for freeWAIS-sf for indexing mails.
122 ;; | # Each mail is in a file, much like the MH format.
124 ;; | # Document separator should never match -- each file is a document.
125 ;; | record-sep: /^@this regex should never match@$/
127 ;; | # Searchable fields specification.
129 ;; | region: /^[sS]ubject:/ /^[sS]ubject: */
130 ;; | subject "Subject header" stemming TEXT BOTH
133 ;; | region: /^([tT][oO]|[cC][cC]):/ /^([tT][oO]|[cC][cC]): */
134 ;; | to "To and Cc headers" SOUNDEX BOTH
137 ;; | region: /^[fF][rR][oO][mM]:/ /^[fF][rR][oO][mM]: */
138 ;; | from "From header" SOUNDEX BOTH
142 ;; | stemming TEXT GLOBAL
143 ;; | end: /^@this regex should never match@$/
146 ;; 1998-07-22: waisindex would dump core on me for large articles with
147 ;; the above settings. I used /^$/ as the end regex for the global
148 ;; field. That seemed to work okay.
150 ;; There is a Perl module called `WAIS.pm' which is available from
151 ;; CPAN as well as ls6-ftp.cs.uni-dortmund.de:/pub/wais/Perl. This
152 ;; module comes with a nifty tool called `makedb', which I use for
153 ;; indexing. Here's my `makedb.conf':
156 ;; | # Config file for makedb
158 ;; | # Global options
159 ;; | waisindex = /usr/local/bin/waisindex
160 ;; | wais_opt = -stem -t fields
161 ;; | # `-stem' option necessary when `stemming' is specified for the
162 ;; | # global field in the *.fmt file
165 ;; | homedir = /home/kai
167 ;; | # The mail database.
169 ;; | files = `find $homedir/Mail -name \*[0-9] -print`
170 ;; | dbdir = $homedir/.wais
174 ;; The Lisp setup involves the `nnir-wais-*' variables. The most
175 ;; difficult to understand variable is probably
176 ;; `nnir-wais-remove-prefix'. Here's what it does: the output of
177 ;; `waissearch' basically contains the file name and the (full)
178 ;; directory name. As Gnus works with group names rather than
179 ;; directory names, the directory name is transformed into a group
180 ;; name as follows: first, a prefix is removed from the (full)
181 ;; directory name, then all `/' are replaced with `.'. The variable
182 ;; `nnir-wais-remove-prefix' should contain a regex matching exactly
183 ;; this prefix. It defaults to `$HOME/Mail/' (note the trailing
188 ;; The Namazu backend requires you to have one directory containing all
189 ;; index files, this is controlled by the `nnir-namazu-index-directory'
190 ;; variable. To function the `nnir-namazu-remove-prefix' variable must
191 ;; also be correct, see the documentation for `nnir-wais-remove-prefix'
194 ;; It is particularly important not to pass any any switches to namazu
195 ;; that will change the output format. Good switches to use include
196 ;; `--sort', `--ascending', `--early' and `--late'. Refer to the Namazu
197 ;; documentation for further information on valid switches.
199 ;; To index my mail with the `mknmz' program I use the following
200 ;; configuration file:
203 ;; | package conf; # Don't remove this line!
205 ;; | # Paths which will not be indexed. Don't use `^' or `$' anchors.
206 ;; | $EXCLUDE_PATH = "spam|sent";
208 ;; | # Header fields which should be searchable. case-insensitive
209 ;; | $REMAIN_HEADER = "from|date|message-id|subject";
211 ;; | # Searchable fields. case-insensitive
212 ;; | $SEARCH_FIELD = "from|date|message-id|subject";
214 ;; | # The max length of a word.
215 ;; | $WORD_LENG_MAX = 128;
217 ;; | # The max length of a field.
218 ;; | $MAX_FIELD_LENGTH = 256;
221 ;; My mail is stored in the directories ~/Mail/mail/, ~/Mail/lists/ and
222 ;; ~/Mail/archive/, so to index them I go to the directory set in
223 ;; `nnir-namazu-index-directory' and issue the following command.
225 ;; mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
227 ;; For maximum searching efficiency I have a cron job set to run this
228 ;; command every four hours.
232 ;; The HyREX backend requires you to have one directory from where all
233 ;; your relative paths are to, if you use them. This directory must be
234 ;; set in the `nnir-hyrex-index-directory' variable, which defaults to
235 ;; your home directory. You must also pass the base, class and
236 ;; directory options or simply your dll to the `nnir-hyrex-programm' by
237 ;; setting the `nnir-hyrex-additional-switches' variable accordently.
238 ;; To function the `nnir-hyrex-remove-prefix' variable must also be
239 ;; correct, see the documentation for `nnir-wais-remove-prefix' above.
243 ;; The find-grep engine simply runs find(1) to locate eligible
244 ;; articles and searches them with grep(1). This, of course, is much
245 ;; slower than using a proper search engine but OTOH doesn't require
246 ;; maintenance of an index and is still faster than using any built-in
247 ;; means for searching. The method specification of the server to
248 ;; search must include a directory for this engine to work (E.g.,
249 ;; `nnml-directory'). The tools must be POSIX compliant. GNU Find
250 ;; prior to version 4.2.12 (4.2.26 on Linux due to incorrect ARG_MAX
251 ;; handling) does not work.
253 ;; | ;; find-grep configuration for searching the Gnus Cache
256 ;; | (nnml-get-new-mail nil)
257 ;; | (nnir-search-engine find-grep)
258 ;; | (nnml-directory "~/News/cache/")
259 ;; | (nnml-active-file "~/News/cache/active"))
262 ;; Developer information:
264 ;; I have tried to make the code expandable. Basically, it is divided
265 ;; into two layers. The upper layer is somewhat like the `nnvirtual'
266 ;; backend: given a specification of what articles to show from
267 ;; another backend, it creates a group containing exactly those
268 ;; articles. The lower layer issues a query to a search engine and
269 ;; produces such a specification of what articles to show from the
272 ;; The interface between the two layers consists of the single
273 ;; function `nnir-run-query', which just selects the appropriate
274 ;; function for the search engine one is using. The input to
275 ;; `nnir-run-query' is a string, representing the query as input by
276 ;; the user. The output of `nnir-run-query' is supposed to be a
277 ;; vector, each element of which should in turn be a three-element
278 ;; vector. The first element should be full group name of the article,
279 ;; the second element should be the article number, and the third
280 ;; element should be the Retrieval Status Value (RSV) as returned from
281 ;; the search engine. An RSV is the score assigned to the document by
282 ;; the search engine. For Boolean search engines, the
283 ;; RSV is always 1000 (or 1 or 100, or whatever you like).
285 ;; The sorting order of the articles in the summary buffer created by
286 ;; nnir is based on the order of the articles in the above mentioned
287 ;; vector, so that's where you can do the sorting you'd like. Maybe
288 ;; it would be nice to have a way of displaying the search result
289 ;; sorted differently?
291 ;; So what do you need to do when you want to add another search
292 ;; engine? You write a function that executes the query. Temporary
293 ;; data from the search engine can be put in `nnir-tmp-buffer'. This
294 ;; function should return the list of articles as a vector, as
295 ;; described above. Then, you need to register this backend in
296 ;; `nnir-engines'. Then, users can choose the backend by setting
297 ;; `nnir-search-engine'.
299 ;; Todo, or future ideas:
301 ;; * It should be possible to restrict search to certain groups.
303 ;; * There is currently no error checking.
305 ;; * The summary buffer display is currently really ugly, with all the
306 ;; added information in the subjects. How could I make this
309 ;; * A function which can be called from an nnir summary buffer which
310 ;; teleports you into the group the current article came from and
311 ;; shows you the whole thread this article is part of.
312 ;; Implementation suggestions?
313 ;; (1998-07-24: There is now a preliminary implementation, but
314 ;; it is much too slow and quite fragile.)
316 ;; * Support other mail backends. In particular, probably quite a few
317 ;; people use nnfolder. How would one go about searching nnfolders
318 ;; and producing the right data needed? The group name and the RSV
319 ;; are simple, but what about the article number?
320 ;; - The article number is encoded in the `X-Gnus-Article-Number'
321 ;; header of each mail.
322 ;; - The HyREX engine supports nnfolder.
324 ;; * Support compressed mail files. Probably, just stripping off the
325 ;; `.gz' or `.Z' file name extension is sufficient.
327 ;; * At least for imap, the query is performed twice.
330 ;; Have you got other ideas?
335 (require 'gnus-group)
343 (nnoo-define-basics nnir)
345 (gnus-declare-backend "nnir" 'mail)
347 (defvar nnir-imap-search-field "TEXT"
348 "The IMAP search item when doing an nnir search. To use raw
349 imap queries by default set this to \"\"")
351 (defvar nnir-imap-search-arguments
352 '(("Whole message" . "TEXT")
353 ("Subject" . "SUBJECT")
356 ("Head" . "HEADER \"%s\"")
358 "Mapping from user readable strings to IMAP search items for use in nnir")
360 (defvar nnir-imap-search-argument-history ()
361 "The history for querying search options in nnir")
363 (defvar nnir-get-article-nov-override-function nil
364 "If non-nil, a function that will be passed each search result. This
365 should return a message's headers in NOV format.
367 If this variable is nil, or if the provided function returns nil for a search
368 result, `gnus-retrieve-headers' will be called instead.")
371 ;;; Developer Extension Variable:
374 `((wais nnir-run-waissearch
378 "Search in: " ; Prompt
379 ,nnir-imap-search-arguments ; alist for completing
381 nil ; allow any user input
383 nnir-imap-search-argument-history ; the history to use
384 ,nnir-imap-search-field ; default
386 (swish++ nnir-run-swish++
387 ((group . "Group spec: ")))
388 (swish-e nnir-run-swish-e
389 ((group . "Group spec: ")))
390 (namazu nnir-run-namazu
392 (hyrex nnir-run-hyrex
393 ((group . "Group spec: ")))
394 (find-grep nnir-run-find-grep
395 ((grep-options . "Grep options: "))))
396 "Alist of supported search engines.
397 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
398 ENGINE is a symbol designating the searching engine. FUNCTION is also
399 a symbol, giving the function that does the search. The third element
400 ARGS is a list of cons pairs (PARAM . PROMPT). When issuing a query,
401 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
403 The value of `nnir-search-engine' must be one of the ENGINE symbols.
404 For example, use the following line for searching using freeWAIS-sf:
405 (setq nnir-search-engine 'wais)
406 Use the following line if you read your mail via IMAP and your IMAP
407 server supports searching:
408 (setq nnir-search-engine 'imap)
409 Note that you have to set additional variables for most backends. For
410 example, the `wais' backend needs the variables `nnir-wais-program',
411 `nnir-wais-database' and `nnir-wais-remove-prefix'.
413 Add an entry here when adding a new search engine.")
415 ;;; User Customizable Variables:
418 "Search nnmh and nnml groups in Gnus with swish-e, freeWAIS-sf, or EWS."
424 ;; If `nil', use server parameters to find out which server to search. CCC
426 (defcustom nnir-mail-backend '(nnml "")
427 "*Specifies which backend should be searched.
428 More precisely, this is used to determine from which backend to fetch the
431 This must be equal to an existing server, so maybe it is best to use
432 something like the following:
433 (setq nnir-mail-backend (nth 0 gnus-secondary-select-methods))
434 The above line works fine if the mail backend you want to search is
435 the first element of gnus-secondary-select-methods (`nth' starts counting
440 ;; Search engine to use.
442 (defcustom nnir-search-engine 'wais
443 "*The search engine to use. Must be a symbol.
444 See `nnir-engines' for a list of supported engines, and for example
445 settings of `nnir-search-engine'."
451 (defcustom nnir-wais-program "waissearch"
452 "*Name of waissearch executable."
456 (defcustom nnir-wais-database (expand-file-name "~/.wais/mail")
457 "*Name of Wais database containing the mail.
459 Note that this should be a file name without extension. For example,
460 if you have a file /home/john/.wais/mail.fmt, use this:
461 (setq nnir-wais-database \"/home/john/.wais/mail\")
462 The string given here is passed to `waissearch -d' as-is."
466 (defcustom nnir-wais-remove-prefix (concat (getenv "HOME") "/Mail/")
467 "*The prefix to remove from each directory name returned by waissearch
468 in order to get a group name (albeit with / instead of .). This is a
471 For example, suppose that Wais returns file names such as
472 \"/home/john/Mail/mail/misc/42\". For this example, use the following
473 setting: (setq nnir-wais-remove-prefix \"/home/john/Mail/\")
474 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
475 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
476 arrive at the correct group name, \"mail.misc\"."
480 (defcustom nnir-swish++-configuration-file
481 (expand-file-name "~/Mail/swish++.conf")
482 "*Configuration file for swish++."
486 (defcustom nnir-swish++-program "search"
487 "*Name of swish++ search executable."
491 (defcustom nnir-swish++-additional-switches '()
492 "*A list of strings, to be given as additional arguments to swish++.
494 Note that this should be a list. Ie, do NOT use the following:
495 (setq nnir-swish++-additional-switches \"-i -w\") ; wrong
497 (setq nnir-swish++-additional-switches '(\"-i\" \"-w\"))"
498 :type '(repeat (string))
501 (defcustom nnir-swish++-remove-prefix (concat (getenv "HOME") "/Mail/")
502 "*The prefix to remove from each file name returned by swish++
503 in order to get a group name (albeit with / instead of .). This is a
506 This variable is very similar to `nnir-wais-remove-prefix', except
507 that it is for swish++, not Wais."
512 ;; URL: http://sunsite.berkeley.edu/SWISH-E/
513 ;; New version: http://www.boe.es/swish-e
514 ;; Variables `nnir-swish-e-index-file', `nnir-swish-e-program' and
515 ;; `nnir-swish-e-additional-switches'
517 (make-obsolete-variable 'nnir-swish-e-index-file
518 'nnir-swish-e-index-files "Emacs 23.1")
519 (defcustom nnir-swish-e-index-file
520 (expand-file-name "~/Mail/index.swish-e")
521 "*Index file for swish-e.
522 This could be a server parameter.
523 It is never consulted once `nnir-swish-e-index-files', which should be
524 used instead, has been customized."
528 (defcustom nnir-swish-e-index-files
529 (list nnir-swish-e-index-file)
530 "*List of index files for swish-e.
531 This could be a server parameter."
532 :type '(repeat (file))
535 (defcustom nnir-swish-e-program "swish-e"
536 "*Name of swish-e search executable.
537 This cannot be a server parameter."
541 (defcustom nnir-swish-e-additional-switches '()
542 "*A list of strings, to be given as additional arguments to swish-e.
544 Note that this should be a list. Ie, do NOT use the following:
545 (setq nnir-swish-e-additional-switches \"-i -w\") ; wrong
547 (setq nnir-swish-e-additional-switches '(\"-i\" \"-w\"))
549 This could be a server parameter."
550 :type '(repeat (string))
553 (defcustom nnir-swish-e-remove-prefix (concat (getenv "HOME") "/Mail/")
554 "*The prefix to remove from each file name returned by swish-e
555 in order to get a group name (albeit with / instead of .). This is a
558 This variable is very similar to `nnir-wais-remove-prefix', except
559 that it is for swish-e, not Wais.
561 This could be a server parameter."
565 ;; HyREX engine, see <URL:http://ls6-www.cs.uni-dortmund.de/>
567 (defcustom nnir-hyrex-program "nnir-search"
568 "*Name of the nnir-search executable."
572 (defcustom nnir-hyrex-additional-switches '()
573 "*A list of strings, to be given as additional arguments for nnir-search.
574 Note that this should be a list. Ie, do NOT use the following:
575 (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
577 (setq nnir-hyrex-additional-switches '(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
578 :type '(repeat (string))
581 (defcustom nnir-hyrex-index-directory (getenv "HOME")
582 "*Index directory for HyREX."
586 (defcustom nnir-hyrex-remove-prefix (concat (getenv "HOME") "/Mail/")
587 "*The prefix to remove from each file name returned by HyREX
588 in order to get a group name (albeit with / instead of .).
590 For example, suppose that HyREX returns file names such as
591 \"/home/john/Mail/mail/misc/42\". For this example, use the following
592 setting: (setq nnir-hyrex-remove-prefix \"/home/john/Mail/\")
593 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
594 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
595 arrive at the correct group name, \"mail.misc\"."
599 ;; Namazu engine, see <URL:http://ww.namazu.org/>
601 (defcustom nnir-namazu-program "namazu"
602 "*Name of Namazu search executable."
606 (defcustom nnir-namazu-index-directory (expand-file-name "~/Mail/namazu/")
607 "*Index directory for Namazu."
611 (defcustom nnir-namazu-additional-switches '()
612 "*A list of strings, to be given as additional arguments to namazu.
613 The switches `-q', `-a', and `-s' are always used, very few other switches
614 make any sense in this context.
616 Note that this should be a list. Ie, do NOT use the following:
617 (setq nnir-namazu-additional-switches \"-i -w\") ; wrong
619 (setq nnir-namazu-additional-switches '(\"-i\" \"-w\"))"
620 :type '(repeat (string))
623 (defcustom nnir-namazu-remove-prefix (concat (getenv "HOME") "/Mail/")
624 "*The prefix to remove from each file name returned by Namazu
625 in order to get a group name (albeit with / instead of .).
627 This variable is very similar to `nnir-wais-remove-prefix', except
628 that it is for Namazu, not Wais."
632 ;;; Internal Variables:
634 (defvar nnir-current-query nil
635 "Internal: stores current query (= group name).")
637 (defvar nnir-current-server nil
638 "Internal: stores current server (does it ever change?).")
640 (defvar nnir-current-group-marked nil
641 "Internal: stores current list of process-marked groups.")
643 (defvar nnir-artlist nil
644 "Internal: stores search result.")
646 (defvar nnir-tmp-buffer " *nnir*"
647 "Internal: temporary buffer.")
653 (defun gnus-group-make-nnir-group (extra-parms query)
654 "Create an nnir group. Asks for query."
655 (interactive "P\nsQuery: ")
656 (setq nnir-current-query nil
657 nnir-current-server nil
658 nnir-current-group-marked nil
662 (setq parms (nnir-read-parms query))
663 (setq parms (list (cons 'query query))))
664 (add-to-list 'parms (cons 'unique-id (message-unique-id)) t)
665 (gnus-group-read-ephemeral-group
666 (concat "nnir:" (prin1-to-string parms)) '(nnir "") t
667 (cons (current-buffer)
668 gnus-current-window-configuration)
672 (when (featurep 'xemacs)
673 ;; The `kbd' macro requires that the `read-kbd-macro' macro is available.
676 (defun nnir-group-mode-hook ()
677 (define-key gnus-group-mode-map (kbd "G G")
678 'gnus-group-make-nnir-group))
679 (add-hook 'gnus-group-mode-hook 'nnir-group-mode-hook)
681 ;; Why is this needed? Is this for compatibility with old/new gnusae? Using
682 ;; gnus-group-server instead works for me. -- Justus Piater
683 (defmacro nnir-group-server (group)
684 "Return the server for a newsgroup GROUP.
685 The returned format is as `gnus-server-to-method' needs it. See
686 `gnus-group-real-prefix' and `gnus-group-real-name'."
687 `(let ((gname ,group))
688 (if (string-match "^\\([^:]+\\):" gname)
690 (setq gname (match-string 1 gname))
691 (if (string-match "^\\([^+]+\\)\\+\\(.+\\)$" gname)
692 (format "%s:%s" (match-string 1 gname) (match-string 2 gname))
694 (format "%s:%s" (car gnus-select-method) (cadr gnus-select-method)))))
696 ;; Summary mode commands.
698 (defun gnus-summary-nnir-goto-thread ()
699 "Only applies to nnir groups. Go to group this article came from
700 and show thread that contains this article."
702 (unless (eq 'nnir (car (gnus-find-method-for-group gnus-newsgroup-name)))
703 (error "Can't execute this command unless in nnir group"))
704 (let* ((cur (gnus-summary-article-number))
705 (group (nnir-artlist-artitem-group nnir-artlist cur))
706 (backend-number (nnir-artlist-artitem-number nnir-artlist cur))
707 server backend-group)
708 (setq server (nnir-group-server group))
709 (setq backend-group (gnus-group-real-name group))
710 (gnus-group-read-ephemeral-group
712 (gnus-server-to-method server)
714 (cons (current-buffer)
715 'summary) ; window config
717 (list backend-number))
718 (gnus-summary-limit (list backend-number))
719 (gnus-summary-refer-thread)))
721 (if (fboundp 'eval-after-load)
722 (eval-after-load "gnus-sum"
723 '(define-key gnus-summary-goto-map
724 "T" 'gnus-summary-nnir-goto-thread))
725 (add-hook 'gnus-summary-mode-hook
727 (define-key gnus-summary-goto-map
728 "T" 'gnus-summary-nnir-goto-thread)))))
732 ;; Gnus backend interface functions.
734 (deffoo nnir-open-server (server &optional definitions)
735 ;; Just set the server variables appropriately.
736 (nnoo-change-server 'nnir server definitions))
738 (deffoo nnir-request-group (group &optional server fast info)
739 "GROUP is the query string."
740 (nnir-possibly-change-server server)
741 ;; Check for cache and return that if appropriate.
742 (if (and (equal group nnir-current-query)
743 (equal gnus-group-marked nnir-current-group-marked)
745 (equal server nnir-current-server)))
748 (setq nnir-artlist (nnir-run-query group)))
749 (with-current-buffer nntp-server-buffer
750 (if (zerop (length nnir-artlist))
752 (setq nnir-current-query nil
753 nnir-current-server nil
754 nnir-current-group-marked nil
756 (nnheader-report 'nnir "Search produced empty results."))
757 ;; Remember data for cache.
758 (setq nnir-current-query group)
759 (when server (setq nnir-current-server server))
760 (setq nnir-current-group-marked gnus-group-marked)
761 (nnheader-insert "211 %d %d %d %s\n"
762 (nnir-artlist-length nnir-artlist) ; total #
764 (nnir-artlist-length nnir-artlist) ; last #
765 group)))) ; group name
767 (deffoo nnir-retrieve-headers (articles &optional group server fetch-old)
769 (let ((artlist (copy-sequence articles))
770 art artitem artgroup artno artrsv artfullgroup
771 novitem novdata foo server)
772 (while (not (null artlist))
773 (setq art (car artlist))
777 "nnir-retrieve-headers doesn't grok message ids: %s"
779 (setq artitem (nnir-artlist-article nnir-artlist art))
780 (setq artrsv (nnir-artitem-rsv artitem))
781 (setq artfullgroup (nnir-artitem-group artitem))
782 (setq artno (nnir-artitem-number artitem))
783 (setq artgroup (gnus-group-real-name artfullgroup))
784 (setq server (nnir-group-server artfullgroup))
785 ;; retrieve NOV or HEAD data for this article, transform into
786 ;; NOV data and prepend to `novdata'
787 (set-buffer nntp-server-buffer)
788 (nnir-possibly-change-server server)
789 (let ((gnus-override-method
790 (gnus-server-to-method server)))
791 ;; if nnir-get-article-nov-override-function is set, use it
792 (if nnir-get-article-nov-override-function
793 (setq novitem (funcall nnir-get-article-nov-override-function
795 ;; else, set novitem through nnheader-parse-nov/nnheader-parse-head
796 (case (setq foo (gnus-retrieve-headers (list artno)
799 (goto-char (point-min))
800 (setq novitem (nnheader-parse-nov))
802 (pop-to-buffer nntp-server-buffer)
804 "nnheader-parse-nov returned nil for article %s in group %s"
805 artno artfullgroup)))
807 (goto-char (point-min))
808 (setq novitem (nnheader-parse-head))
810 (pop-to-buffer nntp-server-buffer)
812 "nnheader-parse-head returned nil for article %s in group %s"
813 artno artfullgroup)))
814 (t (error "Unknown header type %s while requesting article %s of group %s"
815 foo artno artfullgroup)))))
816 ;; replace article number in original group with article number
818 (mail-header-set-number novitem art)
819 (mail-header-set-from novitem
820 (mail-header-from novitem))
821 (mail-header-set-subject
823 (format "[%d: %s/%d] %s"
824 artrsv artgroup artno
825 (mail-header-subject novitem)))
826 ;;-(mail-header-set-extra novitem nil)
827 (push novitem novdata)
828 (setq artlist (cdr artlist)))
829 (setq novdata (nreverse novdata))
830 (set-buffer nntp-server-buffer) (erase-buffer)
831 (mapc 'nnheader-insert-nov novdata)
834 (deffoo nnir-request-article (article
835 &optional group server to-buffer)
836 (if (stringp article)
839 "nnir-retrieve-headers doesn't grok message ids: %s"
842 (let* ((artitem (nnir-artlist-article nnir-artlist
844 (artfullgroup (nnir-artitem-group artitem))
845 (artno (nnir-artitem-number artitem))
847 ;; Why must we bind nntp-server-buffer here? It won't
848 ;; work if `buf' is used, say. (Of course, the set-buffer
849 ;; line below must then be updated, too.)
850 (nntp-server-buffer (or to-buffer nntp-server-buffer)))
851 (set-buffer nntp-server-buffer)
853 (message "Requesting article %d from group %s"
855 (gnus-request-article artno artfullgroup nntp-server-buffer)
856 (cons artfullgroup artno)))))
859 (nnoo-define-skeleton nnir)
862 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
863 "Ask `nnir-compose-result' to construct a result vector,
864 and if it is non-nil, add it to artlist."
865 `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
866 (when (not (null result))
867 (push result ,artlist))))
869 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
871 ;; Helper function currently used by the Swish++ and Namazu backends;
872 ;; perhaps useful for other backends as well
873 (defun nnir-compose-result (dirnam article score prefix server)
874 "Extract the group from dirnam, and create a result vector
875 ready to be added to the list of search results."
877 ;; remove nnir-*-remove-prefix from beginning of dirnam filename
878 (when (string-match (concat "^" prefix) dirnam)
879 (setq dirnam (replace-match "" t t dirnam)))
881 (when (file-readable-p (concat prefix dirnam article))
882 ;; remove trailing slash and, for nnmaildir, cur/new/tmp
885 (if (string= (gnus-group-server server) "nnmaildir")
888 ;; Set group to dirnam without any leading dots or slashes,
889 ;; and with all subsequent slashes replaced by dots
890 (let ((group (gnus-replace-in-string
891 (gnus-replace-in-string dirnam "^[./\\]" "" t)
894 (vector (nnir-group-full-name group server)
895 (if (string= (gnus-group-server server) "nnmaildir")
896 (nnmaildir-base-name-to-article-number
897 (substring article 0 (string-match ":" article))
899 (string-to-number article))
900 (string-to-number score)))))
902 ;;; Search Engine Interfaces:
904 ;; freeWAIS-sf interface.
905 (defun nnir-run-waissearch (query server &optional group)
906 "Run given query agains waissearch. Returns vector of (group name, file name)
907 pairs (also vectors, actually)."
909 (error "The freeWAIS-sf backend cannot search specific groups"))
911 (let ((qstring (cdr (assq 'query query)))
912 (prefix (nnir-read-server-parm 'nnir-wais-remove-prefix server))
913 artlist score artno dirnam)
914 (set-buffer (get-buffer-create nnir-tmp-buffer))
916 (message "Doing WAIS query %s..." query)
917 (call-process nnir-wais-program
918 nil ; input from /dev/null
919 t ; output to current buffer
920 nil ; don't redisplay
921 "-d" (nnir-read-server-parm 'nnir-wais-database server) ; database to search
923 (message "Massaging waissearch output...")
924 ;; remove superfluous lines
925 (keep-lines "Score:")
926 ;; extract data from result lines
927 (goto-char (point-min))
928 (while (re-search-forward
929 "Score: +\\([0-9]+\\).*'\\([0-9]+\\) +\\([^']+\\)/'" nil t)
930 (setq score (match-string 1)
931 artno (match-string 2)
932 dirnam (match-string 3))
933 (unless (string-match prefix dirnam)
934 (nnheader-report 'nnir "Dir name %s doesn't contain prefix %s"
936 (setq group (gnus-replace-in-string
937 (replace-match "" t t dirnam) "/" "."))
938 (push (vector (nnir-group-full-name group server)
939 (string-to-number artno)
940 (string-to-number score))
942 (message "Massaging waissearch output...done")
945 (function (lambda (x y)
946 (> (nnir-artitem-rsv x)
947 (nnir-artitem-rsv y)))))))))
951 ;; nnir invokes this two (2) times???!
952 ;; we should not use nnimap at all but open our own server connection
953 ;; we should not LIST * but use nnimap-list-pattern from defs
954 ;; send queries as literals
957 (autoload 'nnimap-open-server "nnimap")
958 (defvar nnimap-server-buffer) ;; nnimap.el
959 (autoload 'imap-mailbox-select "imap")
960 (autoload 'imap-search "imap")
961 (autoload 'imap-quote-specials "imap")
964 (autoload 'nnimap-buffer "nnimap")
965 (autoload 'nnimap-command "nnimap")
966 (autoload 'nnimap-possibly-change-group "nnimap"))
968 (defun nnir-run-imap (query srv &optional group-option)
969 "Run a search against an IMAP back-end server.
970 This uses a custom query language parser; see `nnir-imap-make-query' for
971 details on the language and supported extensions"
973 (let ((qstring (cdr (assq 'query query)))
974 (server (cadr (gnus-server-to-method srv)))
975 (group (or group-option (gnus-group-group-name)))
976 (defs (caddr (gnus-server-to-method srv)))
977 (criteria (or (cdr (assq 'criteria query))
978 nnir-imap-search-field))
979 (gnus-inhibit-demon t)
981 (message "Opening server %s" server)
983 (when (nnimap-possibly-change-group (gnus-group-short-name group) server)
984 (with-current-buffer (nnimap-buffer)
985 (message "Searching %s..." group)
988 (nnimap-command "UID SEARCH %s"
989 (if (string= criteria "")
991 (nnir-imap-make-query criteria qstring)
995 (push (vector group artnum 1) artlist)
996 (setq arts (1+ arts)))
998 (delete 0 (mapcar #'string-to-number
999 (cdr (assoc "SEARCH" (cdr result)))))))
1000 (message "Searching %s... %d matches" group arts)))
1001 (message "Searching %s...done" group))
1003 (reverse artlist))))
1005 (defun nnir-imap-make-query (criteria qstring)
1006 "Parse the query string and criteria into an appropriate IMAP search
1007 expression, returning the string query to make.
1009 This implements a little language designed to return the expected results
1010 to an arbitrary query string to the end user.
1012 The search is always case-insensitive, as defined by RFC2060, and supports
1013 the following features (inspired by the Google search input language):
1015 Automatic \"and\" queries
1016 If you specify multiple words then they will be treated as an \"and\"
1017 expression intended to match all components.
1020 If you wrap your query in double-quotes then it will be treated as a
1024 If you precede a term with \"-\" then it will negate that.
1027 If you include an upper-case \"OR\" in your search it will cause the
1028 term before it and the term after it to be treated as alternatives.
1030 In future the following will be added to the language:
1031 * support for date matches
1032 * support for location of text matching within the query
1033 * from/to/etc headers
1034 * additional search terms
1035 * flag based searching
1036 * anything else that the RFC supports, basically."
1037 ;; Walk through the query and turn it into an IMAP query string.
1038 (nnir-imap-query-to-imap criteria (nnir-imap-parse-query qstring)))
1041 (defun nnir-imap-query-to-imap (criteria query)
1042 "Turn a s-expression format query into IMAP."
1044 ;; Turn the expressions into IMAP text
1046 (nnir-imap-expr-to-imap criteria item))
1047 ;; The query, already in s-expr format.
1049 ;; Append a space between each expression
1053 (defun nnir-imap-expr-to-imap (criteria expr)
1054 "Convert EXPR into an IMAP search expression on CRITERIA"
1055 ;; What sort of expression is this, eh?
1057 ;; Simple string term
1059 (format "%s \"%s\"" criteria (imap-quote-specials expr)))
1060 ;; Trivial term: and
1061 ((eq expr 'and) nil)
1062 ;; Composite term: or expression
1063 ((eq (car-safe expr) 'or)
1065 (nnir-imap-expr-to-imap criteria (second expr))
1066 (nnir-imap-expr-to-imap criteria (third expr))))
1067 ;; Composite term: just the fax, mam
1068 ((eq (car-safe expr) 'not)
1069 (format "NOT (%s)" (nnir-imap-query-to-imap criteria (rest expr))))
1070 ;; Composite term: just expand it all.
1071 ((and (not (null expr)) (listp expr))
1072 (format "(%s)" (nnir-imap-query-to-imap criteria expr)))
1073 ;; Complex value, give up for now.
1074 (t (error "Unhandled input: %S" expr))))
1077 (defun nnir-imap-parse-query (string)
1078 "Turn STRING into an s-expression based query based on the IMAP
1079 query language as defined in `nnir-imap-make-query'.
1081 This involves turning individual tokens into higher level terms
1082 that the search language can then understand and use."
1084 ;; Set up the parsing environment.
1086 (goto-char (point-min))
1087 ;; Now, collect the output terms and return them.
1089 (while (not (nnir-imap-end-of-input))
1090 (push (nnir-imap-next-expr) out))
1094 (defun nnir-imap-next-expr (&optional count)
1095 "Return the next expression from the current buffer."
1096 (let ((term (nnir-imap-next-term count))
1097 (next (nnir-imap-peek-symbol)))
1098 ;; Are we looking at an 'or' expression?
1100 ;; Handle 'expr or expr'
1102 (list 'or term (nnir-imap-next-expr 2)))
1107 (defun nnir-imap-next-term (&optional count)
1108 "Return the next TERM from the current buffer."
1109 (let ((term (nnir-imap-next-symbol count)))
1110 ;; What sort of term is this?
1112 ;; and -- just ignore it
1113 ((eq term 'and) 'and)
1115 ((eq term 'not) (list 'not (nnir-imap-next-expr)))
1120 (defun nnir-imap-peek-symbol ()
1121 "Return the next symbol from the current buffer, but don't consume it."
1123 (nnir-imap-next-symbol)))
1125 (defun nnir-imap-next-symbol (&optional count)
1126 "Return the next symbol from the current buffer, or nil if we are
1127 at the end of the buffer. If supplied COUNT skips some symbols before
1128 returning the one at the supplied position."
1129 (when (and (numberp count) (> count 1))
1130 (nnir-imap-next-symbol (1- count)))
1131 (let ((case-fold-search t))
1132 ;; end of input stream?
1133 (unless (nnir-imap-end-of-input)
1134 ;; No, return the next symbol from the stream.
1136 ;; negated expression -- return it and advance one char.
1137 ((looking-at "-") (forward-char 1) 'not)
1139 ((looking-at "\"") (nnir-imap-delimited-string "\""))
1140 ;; list expression -- we parse the content and return this as a list.
1142 (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
1143 ;; keyword input -- return a symbol version
1144 ((looking-at "\\band\\b") (forward-char 3) 'and)
1145 ((looking-at "\\bor\\b") (forward-char 2) 'or)
1146 ((looking-at "\\bnot\\b") (forward-char 3) 'not)
1147 ;; Simple, boring keyword
1148 (t (let ((start (point))
1149 (end (if (search-forward-regexp "[[:blank:]]" nil t)
1152 ;; unskip if we hit a non-blank terminal character.
1153 (when (string-match "[^[:blank:]]" (match-string 0))
1155 (goto-char (point-max)))))
1156 (buffer-substring start end)))))))
1158 (defun nnir-imap-delimited-string (delimiter)
1159 "Return a delimited string from the current buffer."
1160 (let ((start (point)) end)
1161 (forward-char 1) ; skip the first delimiter.
1163 (unless (search-forward delimiter nil t)
1164 (error "Unmatched delimited input with %s in query" delimiter))
1165 (let ((here (point)))
1166 (unless (equal (buffer-substring (- here 2) (- here 1)) "\\")
1167 (setq end (point)))))
1168 (buffer-substring (1+ start) (1- end))))
1170 (defun nnir-imap-end-of-input ()
1171 "Are we at the end of input?"
1172 (skip-chars-forward "[[:blank:]]")
1176 ;; Swish++ interface.
1185 (defun nnir-run-swish++ (query server &optional group)
1186 "Run QUERY against swish++.
1187 Returns a vector of (group name, file name) pairs (also vectors,
1190 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
1194 (error "The swish++ backend cannot search specific groups"))
1197 (let ( (qstring (cdr (assq 'query query)))
1198 (groupspec (cdr (assq 'group query)))
1199 (prefix (nnir-read-server-parm 'nnir-swish++-remove-prefix server))
1201 ;; nnml-use-compressed-files might be any string, but probably this
1202 ;; is sufficient. Note that we can't only use the value of
1203 ;; nnml-use-compressed-files because old articles might have been
1204 ;; saved with a different value.
1205 (article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1207 "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
1208 score artno dirnam filenam)
1210 (when (equal "" qstring)
1211 (error "swish++: You didn't enter anything"))
1213 (set-buffer (get-buffer-create nnir-tmp-buffer))
1217 (message "Doing swish++ query %s on %s..." qstring groupspec)
1218 (message "Doing swish++ query %s..." qstring))
1220 (let* ((cp-list `( ,nnir-swish++-program
1221 nil ; input from /dev/null
1223 nil ; don't redisplay
1224 "--config-file" ,(nnir-read-server-parm 'nnir-swish++-configuration-file server)
1225 ,@(nnir-read-server-parm 'nnir-swish++-additional-switches server)
1226 ,qstring ; the query, in swish++ format
1230 (message "%s args: %s" nnir-swish++-program
1231 (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1232 (apply 'call-process cp-list))))
1233 (unless (or (null exitstatus)
1235 (nnheader-report 'nnir "Couldn't run swish++: %s" exitstatus)
1236 ;; swish++ failure reason is in this buffer, show it if
1237 ;; the user wants it.
1238 (when (> gnus-verbose 6)
1239 (display-buffer nnir-tmp-buffer))))
1241 ;; The results are output in the format of:
1243 ;; rank relative-path-name file-size file-title
1245 ;; rank relative-path-name file-size topic??
1246 ;; where rank is an integer from 1 to 100.
1247 (goto-char (point-min))
1248 (while (re-search-forward
1249 "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t)
1250 (setq score (match-string 1)
1251 filenam (match-string 2)
1252 artno (file-name-nondirectory filenam)
1253 dirnam (file-name-directory filenam))
1255 ;; don't match directories
1256 (when (string-match article-pattern artno)
1257 (when (not (null dirnam))
1259 ;; maybe limit results to matching groups.
1260 (when (or (not groupspec)
1261 (string-match groupspec dirnam))
1262 (nnir-add-result dirnam artno score prefix server artlist)))))
1264 (message "Massaging swish++ output...done")
1269 (function (lambda (x y)
1270 (> (nnir-artitem-rsv x)
1271 (nnir-artitem-rsv y)))))))))
1273 ;; Swish-E interface.
1274 (defun nnir-run-swish-e (query server &optional group)
1275 "Run given query against swish-e.
1276 Returns a vector of (group name, file name) pairs (also vectors,
1279 Tested with swish-e-2.0.1 on Windows NT 4.0."
1281 ;; swish-e crashes with empty parameter to "-w" on commandline...
1283 (error "The swish-e backend cannot search specific groups"))
1286 (let ((qstring (cdr (assq 'query query)))
1288 (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server)
1289 (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1290 artlist score artno dirnam group )
1292 (when (equal "" qstring)
1293 (error "swish-e: You didn't enter anything"))
1295 (set-buffer (get-buffer-create nnir-tmp-buffer))
1298 (message "Doing swish-e query %s..." query)
1300 (or (nnir-read-server-parm
1301 'nnir-swish-e-index-files server)
1302 (error "Missing parameter `nnir-swish-e-index-files'")))
1303 (additional-switches
1304 (nnir-read-server-parm
1305 'nnir-swish-e-additional-switches server))
1306 (cp-list `(,nnir-swish-e-program
1307 nil ; input from /dev/null
1309 nil ; don't redisplay
1311 ,@additional-switches
1313 ,qstring ; the query, in swish-e format
1317 (message "%s args: %s" nnir-swish-e-program
1318 (mapconcat 'identity (cddddr cp-list) " "))
1319 (apply 'call-process cp-list))))
1320 (unless (or (null exitstatus)
1322 (nnheader-report 'nnir "Couldn't run swish-e: %s" exitstatus)
1323 ;; swish-e failure reason is in this buffer, show it if
1324 ;; the user wants it.
1325 (when (> gnus-verbose 6)
1326 (display-buffer nnir-tmp-buffer))))
1328 ;; The results are output in the format of:
1329 ;; rank path-name file-title file-size
1330 (goto-char (point-min))
1331 (while (re-search-forward
1332 "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t)
1333 (setq score (match-string 1)
1334 artno (match-string 3)
1335 dirnam (file-name-directory (match-string 2)))
1337 ;; don't match directories
1338 (when (string-match "^[0-9]+$" artno)
1339 (when (not (null dirnam))
1341 ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1342 (when (string-match (concat "^" prefix) dirnam)
1343 (setq dirnam (replace-match "" t t dirnam)))
1345 (setq dirnam (substring dirnam 0 -1))
1346 ;; eliminate all ".", "/", "\" from beginning. Always matches.
1347 (string-match "^[./\\]*\\(.*\\)$" dirnam)
1349 (setq group (gnus-replace-in-string (match-string 1 dirnam) "/" "."))
1350 ;; Windows "\\" -> "."
1351 (setq group (gnus-replace-in-string group "\\\\" "."))
1353 (push (vector (nnir-group-full-name group server)
1354 (string-to-number artno)
1355 (string-to-number score))
1358 (message "Massaging swish-e output...done")
1363 (function (lambda (x y)
1364 (> (nnir-artitem-rsv x)
1365 (nnir-artitem-rsv y)))))))))
1368 (defun nnir-run-hyrex (query server &optional group)
1371 (groupspec (cdr (assq 'group query)))
1372 (qstring (cdr (assq 'query query)))
1373 (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server))
1375 (when (and group groupspec)
1376 (error (concat "It does not make sense to use a group spec"
1377 " with process-marked groups.")))
1379 (setq groupspec (gnus-group-real-name group)))
1380 (when (and group (not (equal group (nnir-group-full-name groupspec server))))
1381 (message "%s vs. %s" group (nnir-group-full-name groupspec server))
1382 (error "Server with groupspec doesn't match group !"))
1383 (set-buffer (get-buffer-create nnir-tmp-buffer))
1386 (message "Doing hyrex-search query %s on %s..." query groupspec)
1387 (message "Doing hyrex-search query %s..." query))
1389 `( ,nnir-hyrex-program
1390 nil ; input from /dev/null
1392 nil ; don't redisplay
1393 "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server) ; index directory
1394 ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server)
1395 ,qstring ; the query, in hyrex-search format
1399 (message "%s args: %s" nnir-hyrex-program
1400 (mapconcat 'identity (cddddr cp-list) " "))
1401 (apply 'call-process cp-list))))
1402 (unless (or (null exitstatus)
1404 (nnheader-report 'nnir "Couldn't run hyrex-search: %s" exitstatus)
1405 ;; nnir-search failure reason is in this buffer, show it if
1406 ;; the user wants it.
1407 (when (> gnus-verbose 6)
1408 (display-buffer nnir-tmp-buffer)))) ;; FIXME: Dont clear buffer !
1410 (message "Doing hyrex-search query \"%s\" on %s...done" qstring groupspec)
1411 (message "Doing hyrex-search query \"%s\"...done" qstring))
1413 ;; nnir-search returns:
1414 ;; for nnml/nnfolder: "filename mailid weigth"
1415 ;; for nnimap: "group mailid weigth"
1416 (goto-char (point-min))
1417 (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1418 ;; HyREX couldn't search directly in groups -- so filter out here.
1420 (keep-lines groupspec))
1421 ;; extract data from result lines
1422 (goto-char (point-min))
1423 (while (re-search-forward
1424 "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t)
1425 (setq dirnam (match-string 1)
1426 artno (match-string 2)
1427 score (match-string 3))
1428 (when (string-match prefix dirnam)
1429 (setq dirnam (replace-match "" t t dirnam)))
1430 (push (vector (nnir-group-full-name
1431 (gnus-replace-in-string dirnam "/" ".") server)
1432 (string-to-number artno)
1433 (string-to-number score))
1435 (message "Massaging hyrex-search output...done.")
1438 (function (lambda (x y)
1439 (if (string-lessp (nnir-artitem-group x)
1440 (nnir-artitem-group y))
1442 (< (nnir-artitem-number x)
1443 (nnir-artitem-number y)))))))
1447 (defun nnir-run-namazu (query server &optional group)
1448 "Run given query against Namazu. Returns a vector of (group name, file name)
1449 pairs (also vectors, actually).
1451 Tested with Namazu 2.0.6 on a GNU/Linux system."
1453 (error "The Namazu backend cannot search specific groups"))
1455 (let ((article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1459 (qstring (cdr (assq 'query query)))
1460 (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server))
1462 (process-environment (copy-sequence process-environment)))
1463 (setenv "LC_MESSAGES" "C")
1464 (set-buffer (get-buffer-create nnir-tmp-buffer))
1467 `( ,nnir-namazu-program
1468 nil ; input from /dev/null
1470 nil ; don't redisplay
1471 "-q" ; don't be verbose
1472 "-a" ; show all matches
1473 "-s" ; use short format
1474 ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server)
1475 ,qstring ; the query, in namazu format
1476 ,(nnir-read-server-parm 'nnir-namazu-index-directory server) ; index directory
1480 (message "%s args: %s" nnir-namazu-program
1481 (mapconcat 'identity (cddddr cp-list) " "))
1482 (apply 'call-process cp-list))))
1483 (unless (or (null exitstatus)
1485 (nnheader-report 'nnir "Couldn't run namazu: %s" exitstatus)
1486 ;; Namazu failure reason is in this buffer, show it if
1487 ;; the user wants it.
1488 (when (> gnus-verbose 6)
1489 (display-buffer nnir-tmp-buffer))))
1491 ;; Namazu output looks something like this:
1492 ;; 2. Re: Gnus agent expire broken (score: 55)
1493 ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1495 (goto-char (point-min))
1496 (while (re-search-forward
1497 "^\\([0-9]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1499 (setq score (match-string 3)
1500 group (file-name-directory (match-string 4))
1501 article (file-name-nondirectory (match-string 4)))
1503 ;; make sure article and group is sane
1504 (when (and (string-match article-pattern article)
1506 (nnir-add-result group article score prefix server artlist)))
1508 ;; sort artlist by score
1511 (function (lambda (x y)
1512 (> (nnir-artitem-rsv x)
1513 (nnir-artitem-rsv y)))))))))
1515 (defun nnir-run-find-grep (query server &optional group)
1516 "Run find and grep to obtain matching articles."
1517 (let* ((method (gnus-server-to-method server))
1519 (concat (symbol-name (car method)) "-directory")))
1520 (directory (cadr (assoc sym (cddr method))))
1521 (regexp (cdr (assoc 'query query)))
1522 (grep-options (cdr (assoc 'grep-options query)))
1525 (error "No directory found in method specification of server %s"
1527 (message "Searching %s using find-grep..." (or group server))
1528 (save-window-excursion
1529 (set-buffer (get-buffer-create nnir-tmp-buffer))
1531 (if (> gnus-verbose 6)
1532 (pop-to-buffer (current-buffer)))
1533 (cd directory) ; Using relative paths simplifies postprocessing.
1537 ;; Try accessing the group literally as well as
1538 ;; interpreting dots as directory separators so the
1539 ;; engine works with plain nnml as well as the Gnus Cache.
1540 (let ((group (gnus-group-real-name group)))
1541 ;; Replace cl-func find-if.
1542 (if (file-directory-p group)
1544 (if (file-directory-p
1545 (setq group (gnus-replace-in-string group "\\." "/" t)))
1548 (error "Cannot locate directory for group"))
1551 'call-process "find" nil t
1552 "find" group "-type" "f" "-name" "[0-9]*" "-exec"
1554 `("-l" ,@(and grep-options
1555 (split-string grep-options "\\s-" t))
1556 "-e" ,regexp "{}" "+"))))
1558 ;; Translate relative paths to group names.
1560 (let* ((path (split-string
1561 (buffer-substring (point) (line-end-position)) "/" t))
1562 (art (string-to-number (car (last path)))))
1563 (while (string= "." (car path))
1564 (setq path (cdr path)))
1565 (let ((group (mapconcat 'identity
1566 ;; Replace cl-func: (subseq path 0 -1)
1567 (let ((end (1- (length path)))
1569 (while (>= (setq end (1- end)) 0)
1570 (push (pop path) res))
1573 (push (vector (nnir-group-full-name group server) art 0)
1576 (message "Searching %s using find-grep...done" (or group server))
1581 (defun nnir-read-parms (query)
1582 "Reads additional search parameters according to `nnir-engines'."
1583 (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines))))
1584 (cons (cons 'query query)
1585 (mapcar 'nnir-read-parm parmspec))))
1587 (defun nnir-read-parm (parmspec)
1588 "Reads a single search parameter.
1589 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1590 (let ((sym (car parmspec))
1591 (prompt (cdr parmspec)))
1593 (let* ((result (gnus-completing-read prompt nil))
1594 (mapping (or (assoc result nnir-imap-search-arguments)
1595 (assoc nil nnir-imap-search-arguments))))
1596 (cons sym (format (cdr mapping) result)))
1597 (cons sym (read-string prompt)))))
1599 (defun nnir-run-query (query)
1600 "Invoke appropriate search engine function (see `nnir-engines').
1601 If some groups were process-marked, run the query for each of the groups
1602 and concat the results."
1603 (let ((q (car (read-from-string query))))
1604 (if gnus-group-marked
1607 (let ((server (nnir-group-server x))
1609 (setq search-func (cadr
1611 (nnir-read-server-parm 'nnir-search-engine server) nnir-engines)))
1613 (funcall search-func q server x)
1619 (if (and (equal (cadr x) 'ok) (not (equal (cadar x) "-ephemeral")))
1620 (let ((server (format "%s:%s" (caar x) (cadar x)))
1622 (setq search-func (cadr
1624 (nnir-read-server-parm 'nnir-search-engine server) nnir-engines)))
1626 (funcall search-func q server nil)
1629 gnus-opened-servers)
1633 (defun nnir-read-server-parm (key server)
1634 "Returns the parameter value of for the given server, where server is of
1635 form 'backend:name'."
1636 (let ((method (gnus-server-to-method server)))
1637 (cond ((and method (assq key (cddr method)))
1638 (nth 1 (assq key (cddr method))))
1639 ((and nnir-mail-backend
1640 (gnus-server-equal method nnir-mail-backend))
1644 ;; (if (assq key (cddr method))
1645 ;; (nth 1 (assq key (cddr method)))
1646 ;; (symbol-value key))
1647 ;; (symbol-value key))
1650 (defun nnir-group-full-name (shortname server)
1651 "For the given group name, return a full Gnus group name.
1652 The Gnus backend/server information is added."
1653 (gnus-group-prefixed-name shortname (gnus-server-to-method server)))
1655 (defun nnir-possibly-change-server (server)
1656 (unless (and server (nnir-server-opened server))
1657 (nnir-open-server server)))
1660 ;; Data type article list.
1662 (defun nnir-artlist-length (artlist)
1663 "Returns number of articles in artlist."
1666 (defun nnir-artlist-article (artlist n)
1667 "Returns from ARTLIST the Nth artitem (counting starting at 1)."
1668 (elt artlist (1- n)))
1670 (defun nnir-artitem-group (artitem)
1671 "Returns the group from the ARTITEM."
1674 (defun nnir-artlist-artitem-group (artlist n)
1675 "Returns from ARTLIST the group of the Nth artitem (counting from 1)."
1676 (nnir-artitem-group (nnir-artlist-article artlist n)))
1678 (defun nnir-artitem-number (artitem)
1679 "Returns the number from the ARTITEM."
1682 (defun nnir-artlist-artitem-number (artlist n)
1683 "Returns from ARTLIST the number of the Nth artitem (counting from 1)."
1684 (nnir-artitem-number (nnir-artlist-article artlist n)))
1686 (defun nnir-artitem-rsv (artitem)
1687 "Returns the Retrieval Status Value (RSV, score) from the ARTITEM."
1690 (defun nnir-artlist-artitem-rsv (artlist n)
1691 "Returns from ARTLIST the Retrieval Status Value of the Nth artitem
1692 \(counting from 1)."
1693 (nnir-artitem-rsv (nnir-artlist-article artlist n)))
1696 (defun nnir-artlist-groups (artlist)
1697 "Returns a list of all groups in the given ARTLIST."
1700 ;; from each artitem, extract group component
1701 (setq with-dups (mapcar 'nnir-artitem-group artlist))
1702 ;; remove duplicates from above
1703 (mapc (function (lambda (x) (add-to-list 'res x)))
1711 ;;; nnir.el ends here