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 ;; or `nnkiboze' backends: given a specification of what articles to
267 ;; show from another backend, it creates a group containing exactly
268 ;; those articles. The lower layer issues a query to a search engine
269 ;; and 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")
350 (defvar nnir-imap-search-arguments
351 '(("Whole message" . "TEXT")
352 ("Subject" . "SUBJECT")
355 (nil . "HEADER \"%s\""))
356 "Mapping from user readable strings to IMAP search items for use in nnir")
358 (defvar nnir-imap-search-argument-history ()
359 "The history for querying search options in nnir")
361 (defvar nnir-get-article-nov-override-function nil
362 "If non-nil, a function that will be passed each search result. This
363 should return a message's headers in NOV format.
365 If this variable is nil, or if the provided function returns nil for a search
366 result, `gnus-retrieve-headers' will be called instead.")
369 ;;; Developer Extension Variable:
372 `((wais nnir-run-waissearch
376 "Search in: " ; Prompt
377 ,nnir-imap-search-arguments ; alist for completing
379 nil ; allow any user input
381 nnir-imap-search-argument-history ; the history to use
382 ,nnir-imap-search-field ; default
384 (swish++ nnir-run-swish++
385 ((group . "Group spec: ")))
386 (swish-e nnir-run-swish-e
387 ((group . "Group spec: ")))
388 (namazu nnir-run-namazu
390 (hyrex nnir-run-hyrex
391 ((group . "Group spec: ")))
392 (find-grep nnir-run-find-grep
393 ((grep-options . "Grep options: "))))
394 "Alist of supported search engines.
395 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
396 ENGINE is a symbol designating the searching engine. FUNCTION is also
397 a symbol, giving the function that does the search. The third element
398 ARGS is a list of cons pairs (PARAM . PROMPT). When issuing a query,
399 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
401 The value of `nnir-search-engine' must be one of the ENGINE symbols.
402 For example, use the following line for searching using freeWAIS-sf:
403 (setq nnir-search-engine 'wais)
404 Use the following line if you read your mail via IMAP and your IMAP
405 server supports searching:
406 (setq nnir-search-engine 'imap)
407 Note that you have to set additional variables for most backends. For
408 example, the `wais' backend needs the variables `nnir-wais-program',
409 `nnir-wais-database' and `nnir-wais-remove-prefix'.
411 Add an entry here when adding a new search engine.")
413 ;;; User Customizable Variables:
416 "Search nnmh and nnml groups in Gnus with swish-e, freeWAIS-sf, or EWS."
422 ;; If `nil', use server parameters to find out which server to search. CCC
424 (defcustom nnir-mail-backend '(nnml "")
425 "*Specifies which backend should be searched.
426 More precisely, this is used to determine from which backend to fetch the
429 This must be equal to an existing server, so maybe it is best to use
430 something like the following:
431 (setq nnir-mail-backend (nth 0 gnus-secondary-select-methods))
432 The above line works fine if the mail backend you want to search is
433 the first element of gnus-secondary-select-methods (`nth' starts counting
438 ;; Search engine to use.
440 (defcustom nnir-search-engine 'wais
441 "*The search engine to use. Must be a symbol.
442 See `nnir-engines' for a list of supported engines, and for example
443 settings of `nnir-search-engine'."
449 (defcustom nnir-wais-program "waissearch"
450 "*Name of waissearch executable."
454 (defcustom nnir-wais-database (expand-file-name "~/.wais/mail")
455 "*Name of Wais database containing the mail.
457 Note that this should be a file name without extension. For example,
458 if you have a file /home/john/.wais/mail.fmt, use this:
459 (setq nnir-wais-database \"/home/john/.wais/mail\")
460 The string given here is passed to `waissearch -d' as-is."
464 (defcustom nnir-wais-remove-prefix (concat (getenv "HOME") "/Mail/")
465 "*The prefix to remove from each directory name returned by waissearch
466 in order to get a group name (albeit with / instead of .). This is a
469 For example, suppose that Wais returns file names such as
470 \"/home/john/Mail/mail/misc/42\". For this example, use the following
471 setting: (setq nnir-wais-remove-prefix \"/home/john/Mail/\")
472 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
473 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
474 arrive at the correct group name, \"mail.misc\"."
478 (defcustom nnir-swish++-configuration-file
479 (expand-file-name "~/Mail/swish++.conf")
480 "*Configuration file for swish++."
484 (defcustom nnir-swish++-program "search"
485 "*Name of swish++ search executable."
489 (defcustom nnir-swish++-additional-switches '()
490 "*A list of strings, to be given as additional arguments to swish++.
492 Note that this should be a list. Ie, do NOT use the following:
493 (setq nnir-swish++-additional-switches \"-i -w\") ; wrong
495 (setq nnir-swish++-additional-switches '(\"-i\" \"-w\"))"
496 :type '(repeat (string))
499 (defcustom nnir-swish++-remove-prefix (concat (getenv "HOME") "/Mail/")
500 "*The prefix to remove from each file name returned by swish++
501 in order to get a group name (albeit with / instead of .). This is a
504 This variable is very similar to `nnir-wais-remove-prefix', except
505 that it is for swish++, not Wais."
510 ;; URL: http://sunsite.berkeley.edu/SWISH-E/
511 ;; New version: http://www.boe.es/swish-e
512 ;; Variables `nnir-swish-e-index-file', `nnir-swish-e-program' and
513 ;; `nnir-swish-e-additional-switches'
515 (make-obsolete-variable 'nnir-swish-e-index-file
516 'nnir-swish-e-index-files "Emacs 23.1")
517 (defcustom nnir-swish-e-index-file
518 (expand-file-name "~/Mail/index.swish-e")
519 "*Index file for swish-e.
520 This could be a server parameter.
521 It is never consulted once `nnir-swish-e-index-files', which should be
522 used instead, has been customized."
526 (defcustom nnir-swish-e-index-files
527 (list nnir-swish-e-index-file)
528 "*List of index files for swish-e.
529 This could be a server parameter."
530 :type '(repeat (file))
533 (defcustom nnir-swish-e-program "swish-e"
534 "*Name of swish-e search executable.
535 This cannot be a server parameter."
539 (defcustom nnir-swish-e-additional-switches '()
540 "*A list of strings, to be given as additional arguments to swish-e.
542 Note that this should be a list. Ie, do NOT use the following:
543 (setq nnir-swish-e-additional-switches \"-i -w\") ; wrong
545 (setq nnir-swish-e-additional-switches '(\"-i\" \"-w\"))
547 This could be a server parameter."
548 :type '(repeat (string))
551 (defcustom nnir-swish-e-remove-prefix (concat (getenv "HOME") "/Mail/")
552 "*The prefix to remove from each file name returned by swish-e
553 in order to get a group name (albeit with / instead of .). This is a
556 This variable is very similar to `nnir-wais-remove-prefix', except
557 that it is for swish-e, not Wais.
559 This could be a server parameter."
563 ;; HyREX engine, see <URL:http://ls6-www.cs.uni-dortmund.de/>
565 (defcustom nnir-hyrex-program "nnir-search"
566 "*Name of the nnir-search executable."
570 (defcustom nnir-hyrex-additional-switches '()
571 "*A list of strings, to be given as additional arguments for nnir-search.
572 Note that this should be a list. Ie, do NOT use the following:
573 (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
575 (setq nnir-hyrex-additional-switches '(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
576 :type '(repeat (string))
579 (defcustom nnir-hyrex-index-directory (getenv "HOME")
580 "*Index directory for HyREX."
584 (defcustom nnir-hyrex-remove-prefix (concat (getenv "HOME") "/Mail/")
585 "*The prefix to remove from each file name returned by HyREX
586 in order to get a group name (albeit with / instead of .).
588 For example, suppose that HyREX returns file names such as
589 \"/home/john/Mail/mail/misc/42\". For this example, use the following
590 setting: (setq nnir-hyrex-remove-prefix \"/home/john/Mail/\")
591 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
592 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
593 arrive at the correct group name, \"mail.misc\"."
597 ;; Namazu engine, see <URL:http://ww.namazu.org/>
599 (defcustom nnir-namazu-program "namazu"
600 "*Name of Namazu search executable."
604 (defcustom nnir-namazu-index-directory (expand-file-name "~/Mail/namazu/")
605 "*Index directory for Namazu."
609 (defcustom nnir-namazu-additional-switches '()
610 "*A list of strings, to be given as additional arguments to namazu.
611 The switches `-q', `-a', and `-s' are always used, very few other switches
612 make any sense in this context.
614 Note that this should be a list. Ie, do NOT use the following:
615 (setq nnir-namazu-additional-switches \"-i -w\") ; wrong
617 (setq nnir-namazu-additional-switches '(\"-i\" \"-w\"))"
618 :type '(repeat (string))
621 (defcustom nnir-namazu-remove-prefix (concat (getenv "HOME") "/Mail/")
622 "*The prefix to remove from each file name returned by Namazu
623 in order to get a group name (albeit with / instead of .).
625 This variable is very similar to `nnir-wais-remove-prefix', except
626 that it is for Namazu, not Wais."
630 ;;; Internal Variables:
632 (defvar nnir-current-query nil
633 "Internal: stores current query (= group name).")
635 (defvar nnir-current-server nil
636 "Internal: stores current server (does it ever change?).")
638 (defvar nnir-current-group-marked nil
639 "Internal: stores current list of process-marked groups.")
641 (defvar nnir-artlist nil
642 "Internal: stores search result.")
644 (defvar nnir-tmp-buffer " *nnir*"
645 "Internal: temporary buffer.")
651 (defun gnus-group-make-nnir-group (extra-parms query)
652 "Create an nnir group. Asks for query."
653 (interactive "P\nsQuery: ")
654 (setq nnir-current-query nil
655 nnir-current-server nil
656 nnir-current-group-marked nil
660 (setq parms (nnir-read-parms query))
661 (setq parms (list (cons 'query query))))
662 (add-to-list 'parms (cons 'unique-id (message-unique-id)) t)
663 (gnus-group-read-ephemeral-group
664 (concat "nnir:" (prin1-to-string parms)) '(nnir "") t
665 (cons (current-buffer)
666 gnus-current-window-configuration)
670 (when (featurep 'xemacs)
671 ;; The `kbd' macro requires that the `read-kbd-macro' macro is available.
674 (defun nnir-group-mode-hook ()
675 (define-key gnus-group-mode-map (kbd "G G")
676 'gnus-group-make-nnir-group))
677 (add-hook 'gnus-group-mode-hook 'nnir-group-mode-hook)
679 ;; Why is this needed? Is this for compatibility with old/new gnusae? Using
680 ;; gnus-group-server instead works for me. -- Justus Piater
681 (defmacro nnir-group-server (group)
682 "Return the server for a newsgroup GROUP.
683 The returned format is as `gnus-server-to-method' needs it. See
684 `gnus-group-real-prefix' and `gnus-group-real-name'."
685 `(let ((gname ,group))
686 (if (string-match "^\\([^:]+\\):" gname)
688 (setq gname (match-string 1 gname))
689 (if (string-match "^\\([^+]+\\)\\+\\(.+\\)$" gname)
690 (format "%s:%s" (match-string 1 gname) (match-string 2 gname))
692 (format "%s:%s" (car gnus-select-method) (cadr gnus-select-method)))))
694 ;; Summary mode commands.
696 (defun gnus-summary-nnir-goto-thread ()
697 "Only applies to nnir groups. Go to group this article came from
698 and show thread that contains this article."
700 (unless (eq 'nnir (car (gnus-find-method-for-group gnus-newsgroup-name)))
701 (error "Can't execute this command unless in nnir group"))
702 (let* ((cur (gnus-summary-article-number))
703 (group (nnir-artlist-artitem-group nnir-artlist cur))
704 (backend-number (nnir-artlist-artitem-number nnir-artlist cur))
705 server backend-group)
706 (setq server (nnir-group-server group))
707 (setq backend-group (gnus-group-real-name group))
708 (gnus-group-read-ephemeral-group
710 (gnus-server-to-method server)
712 (cons (current-buffer)
713 'summary) ; window config
715 (list backend-number))
716 (gnus-summary-limit (list backend-number))
717 (gnus-summary-refer-thread)))
719 (if (fboundp 'eval-after-load)
720 (eval-after-load "gnus-sum"
721 '(define-key gnus-summary-goto-map
722 "T" 'gnus-summary-nnir-goto-thread))
723 (add-hook 'gnus-summary-mode-hook
725 (define-key gnus-summary-goto-map
726 "T" 'gnus-summary-nnir-goto-thread)))))
730 ;; Gnus backend interface functions.
732 (deffoo nnir-open-server (server &optional definitions)
733 ;; Just set the server variables appropriately.
734 (nnoo-change-server 'nnir server definitions))
736 (deffoo nnir-request-group (group &optional server fast)
737 "GROUP is the query string."
738 (nnir-possibly-change-server server)
739 ;; Check for cache and return that if appropriate.
740 (if (and (equal group nnir-current-query)
741 (equal gnus-group-marked nnir-current-group-marked)
743 (equal server nnir-current-server)))
746 (setq nnir-artlist (nnir-run-query group)))
748 (set-buffer nntp-server-buffer)
749 (if (zerop (length nnir-artlist))
751 (setq nnir-current-query nil
752 nnir-current-server nil
753 nnir-current-group-marked nil
755 (nnheader-report 'nnir "Search produced empty results."))
756 ;; Remember data for cache.
757 (setq nnir-current-query group)
758 (when server (setq nnir-current-server server))
759 (setq nnir-current-group-marked gnus-group-marked)
760 (nnheader-insert "211 %d %d %d %s\n"
761 (nnir-artlist-length nnir-artlist) ; total #
763 (nnir-artlist-length nnir-artlist) ; last #
764 group)))) ; group name
766 (deffoo nnir-retrieve-headers (articles &optional group server fetch-old)
768 (let ((artlist (copy-sequence articles))
769 art artitem artgroup artno artrsv artfullgroup
770 novitem novdata foo server)
771 (while (not (null artlist))
772 (setq art (car artlist))
776 "nnir-retrieve-headers doesn't grok message ids: %s"
778 (setq artitem (nnir-artlist-article nnir-artlist art))
779 (setq artrsv (nnir-artitem-rsv artitem))
780 (setq artfullgroup (nnir-artitem-group artitem))
781 (setq artno (nnir-artitem-number artitem))
782 (setq artgroup (gnus-group-real-name artfullgroup))
783 (setq server (nnir-group-server artfullgroup))
784 ;; retrieve NOV or HEAD data for this article, transform into
785 ;; NOV data and prepend to `novdata'
786 (set-buffer nntp-server-buffer)
787 (nnir-possibly-change-server server)
788 (let ((gnus-override-method
789 (gnus-server-to-method server)))
790 ;; if nnir-get-article-nov-override-function is set, use it
791 (if nnir-get-article-nov-override-function
792 (setq novitem (funcall nnir-get-article-nov-override-function
794 ;; else, set novitem through nnheader-parse-nov/nnheader-parse-head
795 (case (setq foo (gnus-retrieve-headers (list artno)
798 (goto-char (point-min))
799 (setq novitem (nnheader-parse-nov))
801 (pop-to-buffer nntp-server-buffer)
803 "nnheader-parse-nov returned nil for article %s in group %s"
804 artno artfullgroup)))
806 (goto-char (point-min))
807 (setq novitem (nnheader-parse-head))
809 (pop-to-buffer nntp-server-buffer)
811 "nnheader-parse-head returned nil for article %s in group %s"
812 artno artfullgroup)))
813 (t (error "Unknown header type %s while requesting article %s of group %s"
814 foo artno artfullgroup)))))
815 ;; replace article number in original group with article number
817 (mail-header-set-number novitem art)
818 (mail-header-set-from novitem
819 (mail-header-from novitem))
820 (mail-header-set-subject
822 (format "[%d: %s/%d] %s"
823 artrsv artgroup artno
824 (mail-header-subject novitem)))
825 ;;-(mail-header-set-extra novitem nil)
826 (push novitem novdata)
827 (setq artlist (cdr artlist)))
828 (setq novdata (nreverse novdata))
829 (set-buffer nntp-server-buffer) (erase-buffer)
830 (mapc 'nnheader-insert-nov novdata)
833 (deffoo nnir-request-article (article
834 &optional group server to-buffer)
835 (if (stringp article)
838 "nnir-retrieve-headers doesn't grok message ids: %s"
841 (let* ((artitem (nnir-artlist-article nnir-artlist
843 (artfullgroup (nnir-artitem-group artitem))
844 (artno (nnir-artitem-number artitem))
846 ;; Why must we bind nntp-server-buffer here? It won't
847 ;; work if `buf' is used, say. (Of course, the set-buffer
848 ;; line below must then be updated, too.)
849 (nntp-server-buffer (or to-buffer nntp-server-buffer)))
850 (set-buffer nntp-server-buffer)
852 (message "Requesting article %d from group %s"
854 (gnus-request-article artno artfullgroup nntp-server-buffer)
855 (cons artfullgroup artno)))))
858 (nnoo-define-skeleton nnir)
861 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
862 "Ask `nnir-compose-result' to construct a result vector,
863 and if it is non-nil, add it to artlist."
864 `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
865 (when (not (null result))
866 (push result ,artlist))))
868 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
870 ;; Helper function currently used by the Swish++ and Namazu backends;
871 ;; perhaps useful for other backends as well
872 (defun nnir-compose-result (dirnam article score prefix server)
873 "Extract the group from dirnam, and create a result vector
874 ready to be added to the list of search results."
876 ;; remove nnir-*-remove-prefix from beginning of dirnam filename
877 (when (string-match (concat "^" prefix) dirnam)
878 (setq dirnam (replace-match "" t t dirnam)))
880 (when (file-readable-p (concat prefix dirnam article))
881 ;; remove trailing slash and, for nnmaildir, cur/new/tmp
883 (substring dirnam 0 (if (string= server "nnmaildir:") -5 -1)))
885 ;; Set group to dirnam without any leading dots or slashes,
886 ;; and with all subsequent slashes replaced by dots
887 (let ((group (gnus-replace-in-string
888 (gnus-replace-in-string dirnam "^[./\\]" "" t)
891 (vector (nnir-group-full-name group server)
892 (if (string= server "nnmaildir:")
893 (nnmaildir-base-name-to-article-number
894 (substring article 0 (string-match ":" article))
896 (string-to-number article))
897 (string-to-number score)))))
899 ;;; Search Engine Interfaces:
901 ;; freeWAIS-sf interface.
902 (defun nnir-run-waissearch (query server &optional group)
903 "Run given query agains waissearch. Returns vector of (group name, file name)
904 pairs (also vectors, actually)."
906 (error "The freeWAIS-sf backend cannot search specific groups"))
908 (let ((qstring (cdr (assq 'query query)))
909 (prefix (nnir-read-server-parm 'nnir-wais-remove-prefix server))
910 artlist score artno dirnam)
911 (set-buffer (get-buffer-create nnir-tmp-buffer))