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
35 ;; Where in the existing gnus manual would this fit best?
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).
43 ;; When looking at the retrieval result (in the Summary buffer) you
44 ;; can type `A W' (aka M-x gnus-warp-to-article RET) on an article. You
45 ;; will be warped into the group this article came from. Typing `A T'
46 ;; (aka M-x gnus-summary-refer-thread RET) will warp to the group and
47 ;; also show the thread this article is part of.
49 ;; The Lisp setup may involve setting a few variables and setting up the
50 ;; search engine. You can define the variables in the server definition
52 ;; (setq gnus-secondary-select-methods '(
53 ;; (nnimap "" (nnimap-address "localhost")
54 ;; (nnir-search-engine namazu)
56 ;; The main variable to set is `nnir-search-engine'. Choose one of
57 ;; the engines listed in `nnir-engines'. (Actually `nnir-engines' is
58 ;; an alist, type `C-h v nnir-engines RET' for more information; this
59 ;; includes examples for setting `nnir-search-engine', too.)
61 ;; If you use one of the local indices (namazu, find-grep, swish) you
62 ;; must also set up a search engine backend.
66 ;; The Namazu backend requires you to have one directory containing all
67 ;; index files, this is controlled by the `nnir-namazu-index-directory'
68 ;; variable. To function the `nnir-namazu-remove-prefix' variable must
69 ;; also be correct, see the documentation for `nnir-namazu-remove-prefix'
72 ;; It is particularly important not to pass any any switches to namazu
73 ;; that will change the output format. Good switches to use include
74 ;; `--sort', `--ascending', `--early' and `--late'. Refer to the Namazu
75 ;; documentation for further information on valid switches.
77 ;; To index my mail with the `mknmz' program I use the following
78 ;; configuration file:
81 ;; | package conf; # Don't remove this line!
83 ;; | # Paths which will not be indexed. Don't use `^' or `$' anchors.
84 ;; | $EXCLUDE_PATH = "spam|sent";
86 ;; | # Header fields which should be searchable. case-insensitive
87 ;; | $REMAIN_HEADER = "from|date|message-id|subject";
89 ;; | # Searchable fields. case-insensitive
90 ;; | $SEARCH_FIELD = "from|date|message-id|subject";
92 ;; | # The max length of a word.
93 ;; | $WORD_LENG_MAX = 128;
95 ;; | # The max length of a field.
96 ;; | $MAX_FIELD_LENGTH = 256;
99 ;; My mail is stored in the directories ~/Mail/mail/, ~/Mail/lists/ and
100 ;; ~/Mail/archive/, so to index them I go to the directory set in
101 ;; `nnir-namazu-index-directory' and issue the following command.
103 ;; mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
105 ;; For maximum searching efficiency I have a cron job set to run this
106 ;; command every four hours.
110 ;; The find-grep engine simply runs find(1) to locate eligible
111 ;; articles and searches them with grep(1). This, of course, is much
112 ;; slower than using a proper search engine but OTOH doesn't require
113 ;; maintenance of an index and is still faster than using any built-in
114 ;; means for searching. The method specification of the server to
115 ;; search must include a directory for this engine to work (E.g.,
116 ;; `nnml-directory'). The tools must be POSIX compliant. GNU Find
117 ;; prior to version 4.2.12 (4.2.26 on Linux due to incorrect ARG_MAX
118 ;; handling) does not work.
120 ;; | ;; find-grep configuration for searching the Gnus Cache
123 ;; | (nnml-get-new-mail nil)
124 ;; | (nnir-search-engine find-grep)
125 ;; | (nnml-directory "~/News/cache/")
126 ;; | (nnml-active-file "~/News/cache/active"))
129 ;; Developer information:
131 ;; I have tried to make the code expandable. Basically, it is divided
132 ;; into two layers. The upper layer is somewhat like the `nnvirtual'
133 ;; backend: given a specification of what articles to show from
134 ;; another backend, it creates a group containing exactly those
135 ;; articles. The lower layer issues a query to a search engine and
136 ;; produces such a specification of what articles to show from the
139 ;; The interface between the two layers consists of the single
140 ;; function `nnir-run-query', which just selects the appropriate
141 ;; function for the search engine one is using. The input to
142 ;; `nnir-run-query' is a string, representing the query as input by
143 ;; the user. The output of `nnir-run-query' is supposed to be a
144 ;; vector, each element of which should in turn be a three-element
145 ;; vector. The first element should be full group name of the article,
146 ;; the second element should be the article number, and the third
147 ;; element should be the Retrieval Status Value (RSV) as returned from
148 ;; the search engine. An RSV is the score assigned to the document by
149 ;; the search engine. For Boolean search engines, the
150 ;; RSV is always 1000 (or 1 or 100, or whatever you like).
152 ;; The sorting order of the articles in the summary buffer created by
153 ;; nnir is based on the order of the articles in the above mentioned
154 ;; vector, so that's where you can do the sorting you'd like. Maybe
155 ;; it would be nice to have a way of displaying the search result
156 ;; sorted differently?
158 ;; So what do you need to do when you want to add another search
159 ;; engine? You write a function that executes the query. Temporary
160 ;; data from the search engine can be put in `nnir-tmp-buffer'. This
161 ;; function should return the list of articles as a vector, as
162 ;; described above. Then, you need to register this backend in
163 ;; `nnir-engines'. Then, users can choose the backend by setting
164 ;; `nnir-search-engine' as a server variable.
168 ;; For Emacs <22.2 and XEmacs.
170 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
173 (require 'gnus-group)
182 (autoload 'nnimap-buffer "nnimap")
183 (autoload 'nnimap-command "nnimap")
184 (autoload 'nnimap-possibly-change-group "nnimap")
185 (autoload 'gnus-registry-action "gnus-registry"))
188 (nnoo-define-basics nnir)
190 (gnus-declare-backend "nnir" 'mail)
193 ;;; User Customizable Variables:
196 "Search groups in Gnus with assorted seach engines."
199 (defcustom nnir-method-default-engines
202 "*Alist of default search engines keyed by server method."
206 (defcustom nnir-ignored-newsgroups ""
207 "*A regexp to match newsgroups in the active file that should
208 be skipped when searching."
212 (defcustom nnir-summary-line-format nil
213 "*The format specification of the lines in an nnir summary buffer.
215 All the items from `gnus-summary-line-format' are available, along
216 with three items unique to nnir summary buffers:
218 %Z Search retrieval score value (integer)
219 %G Article original full group name (string)
220 %g Article original short group name (string)
222 If nil this will use `gnus-summary-line-format'."
226 (defcustom nnir-imap-default-search-key "Whole message"
227 "*The default IMAP search key for an nnir search. Must be one of
228 the keys in `nnir-imap-search-arguments'. To use raw imap queries
229 by default set this to \"Imap\"."
233 (defcustom nnir-swish++-configuration-file
234 (expand-file-name "~/Mail/swish++.conf")
235 "*Configuration file for swish++."
239 (defcustom nnir-swish++-program "search"
240 "*Name of swish++ search executable."
244 (defcustom nnir-swish++-additional-switches '()
245 "*A list of strings, to be given as additional arguments to swish++.
247 Note that this should be a list. Ie, do NOT use the following:
248 (setq nnir-swish++-additional-switches \"-i -w\") ; wrong
250 (setq nnir-swish++-additional-switches '(\"-i\" \"-w\"))"
251 :type '(repeat (string))
254 (defcustom nnir-swish++-remove-prefix (concat (getenv "HOME") "/Mail/")
255 "*The prefix to remove from each file name returned by swish++
256 in order to get a group name (albeit with / instead of .). This is a
259 This variable is very similar to `nnir-namazu-remove-prefix', except
260 that it is for swish++, not Namazu."
265 ;; URL: http://swish-e.org/
266 ;; Variables `nnir-swish-e-index-file', `nnir-swish-e-program' and
267 ;; `nnir-swish-e-additional-switches'
269 (make-obsolete-variable 'nnir-swish-e-index-file
270 'nnir-swish-e-index-files "Emacs 23.1")
271 (defcustom nnir-swish-e-index-file
272 (expand-file-name "~/Mail/index.swish-e")
273 "*Index file for swish-e.
274 This could be a server parameter.
275 It is never consulted once `nnir-swish-e-index-files', which should be
276 used instead, has been customized."
280 (defcustom nnir-swish-e-index-files
281 (list nnir-swish-e-index-file)
282 "*List of index files for swish-e.
283 This could be a server parameter."
284 :type '(repeat (file))
287 (defcustom nnir-swish-e-program "swish-e"
288 "*Name of swish-e search executable.
289 This cannot be a server parameter."
293 (defcustom nnir-swish-e-additional-switches '()
294 "*A list of strings, to be given as additional arguments to swish-e.
296 Note that this should be a list. Ie, do NOT use the following:
297 (setq nnir-swish-e-additional-switches \"-i -w\") ; wrong
299 (setq nnir-swish-e-additional-switches '(\"-i\" \"-w\"))
301 This could be a server parameter."
302 :type '(repeat (string))
305 (defcustom nnir-swish-e-remove-prefix (concat (getenv "HOME") "/Mail/")
306 "*The prefix to remove from each file name returned by swish-e
307 in order to get a group name (albeit with / instead of .). This is a
310 This variable is very similar to `nnir-namazu-remove-prefix', except
311 that it is for swish-e, not Namazu.
313 This could be a server parameter."
317 ;; HyREX engine, see <URL:http://ls6-www.cs.uni-dortmund.de/>
319 (defcustom nnir-hyrex-program "nnir-search"
320 "*Name of the nnir-search executable."
324 (defcustom nnir-hyrex-additional-switches '()
325 "*A list of strings, to be given as additional arguments for nnir-search.
326 Note that this should be a list. Ie, do NOT use the following:
327 (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
329 (setq nnir-hyrex-additional-switches '(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
330 :type '(repeat (string))
333 (defcustom nnir-hyrex-index-directory (getenv "HOME")
334 "*Index directory for HyREX."
338 (defcustom nnir-hyrex-remove-prefix (concat (getenv "HOME") "/Mail/")
339 "*The prefix to remove from each file name returned by HyREX
340 in order to get a group name (albeit with / instead of .).
342 For example, suppose that HyREX returns file names such as
343 \"/home/john/Mail/mail/misc/42\". For this example, use the following
344 setting: (setq nnir-hyrex-remove-prefix \"/home/john/Mail/\")
345 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
346 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
347 arrive at the correct group name, \"mail.misc\"."
351 ;; Namazu engine, see <URL:http://www.namazu.org/>
353 (defcustom nnir-namazu-program "namazu"
354 "*Name of Namazu search executable."
358 (defcustom nnir-namazu-index-directory (expand-file-name "~/Mail/namazu/")
359 "*Index directory for Namazu."
363 (defcustom nnir-namazu-additional-switches '()
364 "*A list of strings, to be given as additional arguments to namazu.
365 The switches `-q', `-a', and `-s' are always used, very few other switches
366 make any sense in this context.
368 Note that this should be a list. Ie, do NOT use the following:
369 (setq nnir-namazu-additional-switches \"-i -w\") ; wrong
371 (setq nnir-namazu-additional-switches '(\"-i\" \"-w\"))"
372 :type '(repeat (string))
375 (defcustom nnir-namazu-remove-prefix (concat (getenv "HOME") "/Mail/")
376 "*The prefix to remove from each file name returned by Namazu
377 in order to get a group name (albeit with / instead of .).
379 For example, suppose that Namazu returns file names such as
380 \"/home/john/Mail/mail/misc/42\". For this example, use the following
381 setting: (setq nnir-namazu-remove-prefix \"/home/john/Mail/\")
382 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
383 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
384 arrive at the correct group name, \"mail.misc\"."
390 (defvar nnir-imap-search-arguments
391 '(("Whole message" . "TEXT")
392 ("Subject" . "SUBJECT")
396 "Mapping from user readable keys to IMAP search items for use in nnir")
398 (defvar nnir-imap-search-other "HEADER %S"
399 "The IMAP search item to use for anything other than
400 `nnir-imap-search-arguments'. By default this is the name of an
403 (defvar nnir-imap-search-argument-history ()
404 "The history for querying search options in nnir")
406 ;;; Developer Extension Variable:
409 `((imap nnir-run-imap
411 "Imap Search in" ; Prompt
412 ,(mapcar 'car nnir-imap-search-arguments) ; alist for completing
413 nil ; allow any user input
415 nnir-imap-search-argument-history ; the history to use
416 ,nnir-imap-default-search-key ; default
418 (gmane nnir-run-gmane
419 ((author . "Gmane Author: ")))
420 (swish++ nnir-run-swish++
421 ((group . "Swish++ Group spec: ")))
422 (swish-e nnir-run-swish-e
423 ((group . "Swish-e Group spec: ")))
424 (namazu nnir-run-namazu
426 (hyrex nnir-run-hyrex
427 ((group . "Hyrex Group spec: ")))
428 (find-grep nnir-run-find-grep
429 ((grep-options . "Grep options: "))))
430 "Alist of supported search engines.
431 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
432 ENGINE is a symbol designating the searching engine. FUNCTION is also
433 a symbol, giving the function that does the search. The third element
434 ARGS is a list of cons pairs (PARAM . PROMPT). When issuing a query,
435 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
437 The value of `nnir-search-engine' must be one of the ENGINE symbols.
438 For example, for searching a server using namazu include
439 (nnir-search-engine namazu)
440 in the server definition. Note that you have to set additional
441 variables for most backends. For example, the `namazu' backend
442 needs the variables `nnir-namazu-program',
443 `nnir-namazu-index-directory' and `nnir-namazu-remove-prefix'.
445 Add an entry here when adding a new search engine.")
447 (defvar nnir-retrieve-headers-override-function nil
448 "If non-nil, a function that accepts an article list and group
449 and populates the `nntp-server-buffer' with the retrieved
450 headers. Must return either 'nov or 'headers indicating the
451 retrieved header format.
453 If this variable is nil, or if the provided function returns nil for a search
454 result, `gnus-retrieve-headers' will be called instead.")
456 ;;; Internal Variables:
458 (defvar nnir-current-query nil
459 "Internal: stores current query (= group name).")
461 (defvar nnir-current-server nil
462 "Internal: stores current server (does it ever change?).")
464 (defvar nnir-current-group-marked nil
465 "Internal: stores current list of process-marked groups.")
467 (defvar nnir-artlist nil
468 "Internal: stores search result.")
470 (defvar nnir-tmp-buffer " *nnir*"
471 "Internal: temporary buffer.")
473 (defvar nnir-search-history ()
474 "Internal: the history for querying search options in nnir")
476 (defvar nnir-extra-parms nil
477 "Internal: stores request for extra search parms")
483 ;; Data type article list.
485 (defmacro nnir-artlist-length (artlist)
486 "Returns number of articles in artlist."
489 (defmacro nnir-artlist-article (artlist n)
490 "Returns from ARTLIST the Nth artitem (counting starting at 1)."
492 (elt ,artlist (1- ,n))))
494 (defmacro nnir-artitem-group (artitem)
495 "Returns the group from the ARTITEM."
498 (defmacro nnir-artitem-number (artitem)
499 "Returns the number from the ARTITEM."
502 (defmacro nnir-artitem-rsv (artitem)
503 "Returns the Retrieval Status Value (RSV, score) from the ARTITEM."
506 (defmacro nnir-article-group (article)
507 "Returns the group for ARTICLE"
508 `(nnir-artitem-group (nnir-artlist-article nnir-artlist ,article)))
510 (defmacro nnir-article-number (article)
511 "Returns the number for ARTICLE"
512 `(nnir-artitem-number (nnir-artlist-article nnir-artlist ,article)))
514 (defmacro nnir-article-rsv (article)
515 "Returns the rsv for ARTICLE"
516 `(nnir-artitem-rsv (nnir-artlist-article nnir-artlist ,article)))
518 (defsubst nnir-article-ids (article)
519 "Returns the pair `(nnir id . real id)' of ARTICLE"
520 (cons article (nnir-article-number article)))
522 (defmacro nnir-categorize (sequence keyfunc &optional valuefunc)
523 "Sorts a sequence into categories and returns a list of the form
524 `((key1 (element11 element12)) (key2 (element21 element22))'.
525 The category key for a member of the sequence is obtained
526 as `(keyfunc member)' and the corresponding element is just
527 `member'. If `valuefunc' is non-nil, the element of the list
528 is `(valuefunc member)'."
529 `(unless (null ,sequence)
533 (let ((y (,keyfunc member))
538 (push x (cadr (assoc y value)))
539 (push (list y (list x)) value))))
545 (defun gnus-group-make-nnir-group (nnir-extra-parms)
546 "Create an nnir group. Asks for query."
548 (setq nnir-current-query nil
549 nnir-current-server nil
550 nnir-current-group-marked nil
552 (let* ((query (read-string "Query: " nil 'nnir-search-history))
553 (parms (list (cons 'query query)))
554 (srv (if (gnus-server-server-name)
556 (add-to-list 'parms (cons 'unique-id (message-unique-id)) t)
557 (gnus-group-read-ephemeral-group
558 (concat "nnir:" (prin1-to-string parms)) (list 'nnir srv) t
559 (cons (current-buffer) gnus-current-window-configuration)
563 ;; Gnus backend interface functions.
565 (deffoo nnir-open-server (server &optional definitions)
566 ;; Just set the server variables appropriately.
567 (add-hook 'gnus-summary-mode-hook 'nnir-mode)
568 (nnoo-change-server 'nnir server definitions))
570 (deffoo nnir-request-group (group &optional server fast info)
571 "GROUP is the query string."
572 (nnir-possibly-change-server server)
573 ;; Check for cache and return that if appropriate.
574 (if (and (equal group nnir-current-query)
575 (equal gnus-group-marked nnir-current-group-marked)
577 (equal server nnir-current-server)))
580 (setq nnir-artlist (nnir-run-query group server)))
581 (with-current-buffer nntp-server-buffer
582 (setq nnir-current-query group)
583 (when server (setq nnir-current-server server))
584 (setq nnir-current-group-marked gnus-group-marked)
585 (if (zerop (length nnir-artlist))
586 (nnheader-report 'nnir "Search produced empty results.")
587 ;; Remember data for cache.
588 (nnheader-insert "211 %d %d %d %s\n"
589 (nnir-artlist-length nnir-artlist) ; total #
591 (nnir-artlist-length nnir-artlist) ; last #
592 group)))) ; group name
594 (deffoo nnir-retrieve-headers (articles &optional group server fetch-old)
595 (with-current-buffer nntp-server-buffer
596 (let ((gnus-inhibit-demon t)
597 (articles-by-group (nnir-categorize
598 articles nnir-article-group nnir-article-ids))
600 (while (not (null articles-by-group))
601 (let* ((group-articles (pop articles-by-group))
602 (artgroup (car group-articles))
603 (articleids (cadr group-articles))
604 (artlist (sort (mapcar 'cdr articleids) '<))
605 (server (gnus-group-server artgroup))
606 (gnus-override-method (gnus-server-to-method server))
611 ;; "nnir-retrieve-headers doesn't grok message ids: %s"
613 (nnir-possibly-change-server server)
616 (case (setq gnus-headers-retrieved-by
619 nnir-retrieve-headers-override-function
620 (funcall nnir-retrieve-headers-override-function
622 (gnus-retrieve-headers artlist artgroup nil)))
624 (setq parsefunc 'nnheader-parse-nov))
626 (setq parsefunc 'nnheader-parse-head))
627 (t (error "Unknown header type %s while requesting articles \
628 of group %s" gnus-headers-retrieved-by artgroup)))
629 (goto-char (point-min))
631 (let* ((novitem (funcall parsefunc))
632 (artno (mail-header-number novitem))
633 (art (car (rassoc artno articleids))))
635 (mail-header-set-number novitem art)
636 ;; (mail-header-set-subject
638 ;; (format "[%d: %s/%d] %s"
639 ;; (nnir-article-rsv art) artgroup artno
640 ;; (mail-header-subject novitem)))
641 (push novitem headers))
646 (< (mail-header-number x) (mail-header-number y)))))
648 (mapc 'nnheader-insert-nov headers)
651 (deffoo nnir-request-article (article &optional group server to-buffer)
652 (if (stringp article)
655 "nnir-retrieve-headers doesn't grok message ids: %s"
658 (let ((artfullgroup (nnir-article-group article))
659 (artno (nnir-article-number article))
661 ;; Why must we bind nntp-server-buffer here? It won't
662 ;; work if `buf' is used, say. (Of course, the set-buffer
663 ;; line below must then be updated, too.)
664 (nntp-server-buffer (or to-buffer nntp-server-buffer)))
665 (set-buffer nntp-server-buffer)
667 (message "Requesting article %d from group %s"
669 (gnus-request-article artno artfullgroup nntp-server-buffer)
670 (cons artfullgroup artno)))))
672 (deffoo nnir-request-move-article (article group server accept-form
673 &optional last internal-move-group)
674 (let* ((artfullgroup (nnir-article-group article))
675 (artno (nnir-article-number article))
676 (to-newsgroup (nth 1 accept-form))
677 (to-method (gnus-find-method-for-group to-newsgroup))
678 (from-method (gnus-find-method-for-group artfullgroup))
679 (move-is-internal (gnus-server-equal from-method to-method))
680 (artsubject (mail-header-subject
682 (assoc article (gnus-data-list nil))))))
683 (unless (gnus-check-backend-function
684 'request-move-article artfullgroup)
685 (error "The group %s does not support article moving" artfullgroup))
686 (gnus-request-move-article
692 (and move-is-internal
693 to-newsgroup ; Not respooling
694 (gnus-group-real-name to-newsgroup)))))
696 (deffoo nnir-warp-to-article ()
697 (let* ((cur (if (> (gnus-summary-article-number) 0)
698 (gnus-summary-article-number)
699 (error "This is not a real article.")))
700 (gnus-newsgroup-name (nnir-article-group cur))
701 (backend-number (nnir-article-number cur)))
702 (gnus-summary-read-group-1 gnus-newsgroup-name t t gnus-summary-buffer
703 nil (list backend-number))))
705 (nnoo-define-skeleton nnir)
708 (defmacro nnir-add-result (dirnam artno score prefix server artlist)
709 "Ask `nnir-compose-result' to construct a result vector,
710 and if it is non-nil, add it to artlist."
711 `(let ((result (nnir-compose-result ,dirnam ,artno ,score ,prefix ,server)))
712 (when (not (null result))
713 (push result ,artlist))))
715 (autoload 'nnmaildir-base-name-to-article-number "nnmaildir")
717 ;; Helper function currently used by the Swish++ and Namazu backends;
718 ;; perhaps useful for other backends as well
719 (defun nnir-compose-result (dirnam article score prefix server)
720 "Extract the group from dirnam, and create a result vector
721 ready to be added to the list of search results."
723 ;; remove nnir-*-remove-prefix from beginning of dirnam filename
724 (when (string-match (concat "^" prefix) dirnam)
725 (setq dirnam (replace-match "" t t dirnam)))
727 (when (file-readable-p (concat prefix dirnam article))
728 ;; remove trailing slash and, for nnmaildir, cur/new/tmp
731 (if (string= (gnus-group-server server) "nnmaildir")
734 ;; Set group to dirnam without any leading dots or slashes,
735 ;; and with all subsequent slashes replaced by dots
736 (let ((group (gnus-replace-in-string
737 (gnus-replace-in-string dirnam "^[./\\]" "" t)
740 (vector (gnus-group-full-name group server)
741 (if (string= (gnus-group-server server) "nnmaildir")
742 (nnmaildir-base-name-to-article-number
743 (substring article 0 (string-match ":" article))
745 (string-to-number article))
746 (string-to-number score)))))
748 ;;; Search Engine Interfaces:
751 (defun nnir-run-imap (query srv &optional groups)
752 "Run a search against an IMAP back-end server.
753 This uses a custom query language parser; see `nnir-imap-make-query' for
754 details on the language and supported extensions"
756 (let ((qstring (cdr (assq 'query query)))
757 (server (cadr (gnus-server-to-method srv)))
758 (defs (caddr (gnus-server-to-method srv)))
759 (criteria (or (cdr (assq 'criteria query))
760 (cdr (assoc nnir-imap-default-search-key
761 nnir-imap-search-arguments))))
762 (gnus-inhibit-demon t)
763 (groups (or groups (nnir-get-active srv))))
764 (message "Opening server %s" server)
771 (when (nnimap-possibly-change-group
772 (gnus-group-short-name group) server)
773 (with-current-buffer (nnimap-buffer)
774 (message "Searching %s..." group)
776 (result (nnimap-command "UID SEARCH %s"
777 (if (string= criteria "")
779 (nnir-imap-make-query
780 criteria qstring)))))
782 (lambda (artnum) (push (vector group artnum 100) artlist)
783 (setq arts (1+ arts)))
785 (delete 0 (mapcar #'string-to-number
788 (message "Searching %s... %d matches" group arts)))
789 (message "Searching %s...done" group))
794 (defun nnir-imap-make-query (criteria qstring)
795 "Parse the query string and criteria into an appropriate IMAP search
796 expression, returning the string query to make.
798 This implements a little language designed to return the expected results
799 to an arbitrary query string to the end user.
801 The search is always case-insensitive, as defined by RFC2060, and supports
802 the following features (inspired by the Google search input language):
804 Automatic \"and\" queries
805 If you specify multiple words then they will be treated as an \"and\"
806 expression intended to match all components.
809 If you wrap your query in double-quotes then it will be treated as a
813 If you precede a term with \"-\" then it will negate that.
816 If you include an upper-case \"OR\" in your search it will cause the
817 term before it and the term after it to be treated as alternatives.
819 In future the following will be added to the language:
820 * support for date matches
821 * support for location of text matching within the query
822 * from/to/etc headers
823 * additional search terms
824 * flag based searching
825 * anything else that the RFC supports, basically."
826 ;; Walk through the query and turn it into an IMAP query string.
827 (nnir-imap-query-to-imap criteria (nnir-imap-parse-query qstring)))
830 (defun nnir-imap-query-to-imap (criteria query)
831 "Turn a s-expression format query into IMAP."
833 ;; Turn the expressions into IMAP text
835 (nnir-imap-expr-to-imap criteria item))
836 ;; The query, already in s-expr format.
838 ;; Append a space between each expression
842 (defun nnir-imap-expr-to-imap (criteria expr)
843 "Convert EXPR into an IMAP search expression on CRITERIA"
844 ;; What sort of expression is this, eh?
846 ;; Simple string term
848 (format "%s %S" criteria expr))
851 ;; Composite term: or expression
852 ((eq (car-safe expr) 'or)
854 (nnir-imap-expr-to-imap criteria (second expr))
855 (nnir-imap-expr-to-imap criteria (third expr))))
856 ;; Composite term: just the fax, mam
857 ((eq (car-safe expr) 'not)
858 (format "NOT (%s)" (nnir-imap-query-to-imap criteria (rest expr))))
859 ;; Composite term: just expand it all.
860 ((and (not (null expr)) (listp expr))
861 (format "(%s)" (nnir-imap-query-to-imap criteria expr)))
862 ;; Complex value, give up for now.
863 (t (error "Unhandled input: %S" expr))))
866 (defun nnir-imap-parse-query (string)
867 "Turn STRING into an s-expression based query based on the IMAP
868 query language as defined in `nnir-imap-make-query'.
870 This involves turning individual tokens into higher level terms
871 that the search language can then understand and use."
873 ;; Set up the parsing environment.
875 (goto-char (point-min))
876 ;; Now, collect the output terms and return them.
878 (while (not (nnir-imap-end-of-input))
879 (push (nnir-imap-next-expr) out))
883 (defun nnir-imap-next-expr (&optional count)
884 "Return the next expression from the current buffer."
885 (let ((term (nnir-imap-next-term count))
886 (next (nnir-imap-peek-symbol)))
887 ;; Are we looking at an 'or' expression?
889 ;; Handle 'expr or expr'
891 (list 'or term (nnir-imap-next-expr 2)))
896 (defun nnir-imap-next-term (&optional count)
897 "Return the next TERM from the current buffer."
898 (let ((term (nnir-imap-next-symbol count)))
899 ;; What sort of term is this?
901 ;; and -- just ignore it
902 ((eq term 'and) 'and)
904 ((eq term 'not) (list 'not (nnir-imap-next-expr)))
909 (defun nnir-imap-peek-symbol ()
910 "Return the next symbol from the current buffer, but don't consume it."
912 (nnir-imap-next-symbol)))
914 (defun nnir-imap-next-symbol (&optional count)
915 "Return the next symbol from the current buffer, or nil if we are
916 at the end of the buffer. If supplied COUNT skips some symbols before
917 returning the one at the supplied position."
918 (when (and (numberp count) (> count 1))
919 (nnir-imap-next-symbol (1- count)))
920 (let ((case-fold-search t))
921 ;; end of input stream?
922 (unless (nnir-imap-end-of-input)
923 ;; No, return the next symbol from the stream.
925 ;; negated expression -- return it and advance one char.
926 ((looking-at "-") (forward-char 1) 'not)
928 ((looking-at "\"") (nnir-imap-delimited-string "\""))
929 ;; list expression -- we parse the content and return this as a list.
931 (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
932 ;; keyword input -- return a symbol version
933 ((looking-at "\\band\\b") (forward-char 3) 'and)
934 ((looking-at "\\bor\\b") (forward-char 2) 'or)
935 ((looking-at "\\bnot\\b") (forward-char 3) 'not)
936 ;; Simple, boring keyword
937 (t (let ((start (point))
938 (end (if (search-forward-regexp "[[:blank:]]" nil t)
941 ;; unskip if we hit a non-blank terminal character.
942 (when (string-match "[^[:blank:]]" (match-string 0))
944 (goto-char (point-max)))))
945 (buffer-substring start end)))))))
947 (defun nnir-imap-delimited-string (delimiter)
948 "Return a delimited string from the current buffer."
949 (let ((start (point)) end)
950 (forward-char 1) ; skip the first delimiter.
952 (unless (search-forward delimiter nil t)
953 (error "Unmatched delimited input with %s in query" delimiter))
954 (let ((here (point)))
955 (unless (equal (buffer-substring (- here 2) (- here 1)) "\\")
956 (setq end (point)))))
957 (buffer-substring (1+ start) (1- end))))
959 (defun nnir-imap-end-of-input ()
960 "Are we at the end of input?"
961 (skip-chars-forward "[[:blank:]]")
965 ;; Swish++ interface.
974 (defun nnir-run-swish++ (query server &optional group)
975 "Run QUERY against swish++.
976 Returns a vector of (group name, file name) pairs (also vectors,
979 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
983 ;; (error "The swish++ backend cannot search specific groups"))
986 (let ( (qstring (cdr (assq 'query query)))
987 (groupspec (cdr (assq 'group query)))
988 (prefix (nnir-read-server-parm 'nnir-swish++-remove-prefix server))
990 ;; nnml-use-compressed-files might be any string, but probably this
991 ;; is sufficient. Note that we can't only use the value of
992 ;; nnml-use-compressed-files because old articles might have been
993 ;; saved with a different value.
994 (article-pattern (if (string= (gnus-group-server server) "nnmaildir")
996 "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
997 score artno dirnam filenam)
999 (when (equal "" qstring)
1000 (error "swish++: You didn't enter anything"))
1002 (set-buffer (get-buffer-create nnir-tmp-buffer))
1006 (message "Doing swish++ query %s on %s..." qstring groupspec)
1007 (message "Doing swish++ query %s..." qstring))
1009 (let* ((cp-list `( ,nnir-swish++-program
1010 nil ; input from /dev/null
1012 nil ; don't redisplay
1013 "--config-file" ,(nnir-read-server-parm 'nnir-swish++-configuration-file server)
1014 ,@(nnir-read-server-parm 'nnir-swish++-additional-switches server)
1015 ,qstring ; the query, in swish++ format
1019 (message "%s args: %s" nnir-swish++-program
1020 (mapconcat 'identity (cddddr cp-list) " ")) ;; ???
1021 (apply 'call-process cp-list))))
1022 (unless (or (null exitstatus)
1024 (nnheader-report 'nnir "Couldn't run swish++: %s" exitstatus)
1025 ;; swish++ failure reason is in this buffer, show it if
1026 ;; the user wants it.
1027 (when (> gnus-verbose 6)
1028 (display-buffer nnir-tmp-buffer))))
1030 ;; The results are output in the format of:
1032 ;; rank relative-path-name file-size file-title
1034 ;; rank relative-path-name file-size topic??
1035 ;; where rank is an integer from 1 to 100.
1036 (goto-char (point-min))
1037 (while (re-search-forward
1038 "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t)
1039 (setq score (match-string 1)
1040 filenam (match-string 2)
1041 artno (file-name-nondirectory filenam)
1042 dirnam (file-name-directory filenam))
1044 ;; don't match directories
1045 (when (string-match article-pattern artno)
1046 (when (not (null dirnam))
1048 ;; maybe limit results to matching groups.
1049 (when (or (not groupspec)
1050 (string-match groupspec dirnam))
1051 (nnir-add-result dirnam artno score prefix server artlist)))))
1053 (message "Massaging swish++ output...done")
1058 (function (lambda (x y)
1059 (> (nnir-artitem-rsv x)
1060 (nnir-artitem-rsv y)))))))))
1062 ;; Swish-E interface.
1063 (defun nnir-run-swish-e (query server &optional group)
1064 "Run given query against swish-e.
1065 Returns a vector of (group name, file name) pairs (also vectors,
1068 Tested with swish-e-2.0.1 on Windows NT 4.0."
1070 ;; swish-e crashes with empty parameter to "-w" on commandline...
1072 ;; (error "The swish-e backend cannot search specific groups"))
1075 (let ((qstring (cdr (assq 'query query)))
1077 (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server)
1078 (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1079 artlist score artno dirnam group )
1081 (when (equal "" qstring)
1082 (error "swish-e: You didn't enter anything"))
1084 (set-buffer (get-buffer-create nnir-tmp-buffer))
1087 (message "Doing swish-e query %s..." query)
1089 (or (nnir-read-server-parm
1090 'nnir-swish-e-index-files server)
1091 (error "Missing parameter `nnir-swish-e-index-files'")))
1092 (additional-switches
1093 (nnir-read-server-parm
1094 'nnir-swish-e-additional-switches server))
1095 (cp-list `(,nnir-swish-e-program
1096 nil ; input from /dev/null
1098 nil ; don't redisplay
1100 ,@additional-switches
1102 ,qstring ; the query, in swish-e format
1106 (message "%s args: %s" nnir-swish-e-program
1107 (mapconcat 'identity (cddddr cp-list) " "))
1108 (apply 'call-process cp-list))))
1109 (unless (or (null exitstatus)
1111 (nnheader-report 'nnir "Couldn't run swish-e: %s" exitstatus)
1112 ;; swish-e failure reason is in this buffer, show it if
1113 ;; the user wants it.
1114 (when (> gnus-verbose 6)
1115 (display-buffer nnir-tmp-buffer))))
1117 ;; The results are output in the format of:
1118 ;; rank path-name file-title file-size
1119 (goto-char (point-min))
1120 (while (re-search-forward
1121 "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t)
1122 (setq score (match-string 1)
1123 artno (match-string 3)
1124 dirnam (file-name-directory (match-string 2)))
1126 ;; don't match directories
1127 (when (string-match "^[0-9]+$" artno)
1128 (when (not (null dirnam))
1130 ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1131 (when (string-match (concat "^" prefix) dirnam)
1132 (setq dirnam (replace-match "" t t dirnam)))
1134 (setq dirnam (substring dirnam 0 -1))
1135 ;; eliminate all ".", "/", "\" from beginning. Always matches.
1136 (string-match "^[./\\]*\\(.*\\)$" dirnam)
1138 (setq group (gnus-replace-in-string (match-string 1 dirnam) "/" "."))
1139 ;; Windows "\\" -> "."
1140 (setq group (gnus-replace-in-string group "\\\\" "."))
1142 (push (vector (gnus-group-full-name group server)
1143 (string-to-number artno)
1144 (string-to-number score))
1147 (message "Massaging swish-e output...done")
1152 (function (lambda (x y)
1153 (> (nnir-artitem-rsv x)
1154 (nnir-artitem-rsv y)))))))))
1157 (defun nnir-run-hyrex (query server &optional group)
1160 (groupspec (cdr (assq 'group query)))
1161 (qstring (cdr (assq 'query query)))
1162 (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server))
1164 (when (and (not groupspec) group)
1167 (mapcar (lambda (x) (gnus-group-real-name x)) group))))
1168 (set-buffer (get-buffer-create nnir-tmp-buffer))
1170 (message "Doing hyrex-search query %s..." query)
1172 `( ,nnir-hyrex-program
1173 nil ; input from /dev/null
1175 nil ; don't redisplay
1176 "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server) ; index directory
1177 ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server)
1178 ,qstring ; the query, in hyrex-search format
1182 (message "%s args: %s" nnir-hyrex-program
1183 (mapconcat 'identity (cddddr cp-list) " "))
1184 (apply 'call-process cp-list))))
1185 (unless (or (null exitstatus)
1187 (nnheader-report 'nnir "Couldn't run hyrex-search: %s" exitstatus)
1188 ;; nnir-search failure reason is in this buffer, show it if
1189 ;; the user wants it.
1190 (when (> gnus-verbose 6)
1191 (display-buffer nnir-tmp-buffer)))) ;; FIXME: Dont clear buffer !
1192 (message "Doing hyrex-search query \"%s\"...done" qstring)
1194 ;; nnir-search returns:
1195 ;; for nnml/nnfolder: "filename mailid weigth"
1196 ;; for nnimap: "group mailid weigth"
1197 (goto-char (point-min))
1198 (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1199 ;; HyREX doesn't search directly in groups -- so filter out here.
1201 (keep-lines groupspec))
1202 ;; extract data from result lines
1203 (goto-char (point-min))
1204 (while (re-search-forward
1205 "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t)
1206 (setq dirnam (match-string 1)
1207 artno (match-string 2)
1208 score (match-string 3))
1209 (when (string-match prefix dirnam)
1210 (setq dirnam (replace-match "" t t dirnam)))
1211 (push (vector (gnus-group-full-name
1212 (gnus-replace-in-string dirnam "/" ".") server)
1213 (string-to-number artno)
1214 (string-to-number score))
1216 (message "Massaging hyrex-search output...done.")
1219 (function (lambda (x y)
1220 (if (string-lessp (nnir-artitem-group x)
1221 (nnir-artitem-group y))
1223 (< (nnir-artitem-number x)
1224 (nnir-artitem-number y)))))))
1228 (defun nnir-run-namazu (query server &optional group)
1229 "Run given query against Namazu. Returns a vector of (group name, file name)
1230 pairs (also vectors, actually).
1232 Tested with Namazu 2.0.6 on a GNU/Linux system."
1234 ;; (error "The Namazu backend cannot search specific groups"))
1236 (let ((article-pattern (if (string= (gnus-group-server server) "nnmaildir")
1240 (qstring (cdr (assq 'query query)))
1241 (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server))
1243 (process-environment (copy-sequence process-environment)))
1244 (setenv "LC_MESSAGES" "C")
1245 (set-buffer (get-buffer-create nnir-tmp-buffer))
1248 `( ,nnir-namazu-program
1249 nil ; input from /dev/null
1251 nil ; don't redisplay
1252 "-q" ; don't be verbose
1253 "-a" ; show all matches
1254 "-s" ; use short format
1255 ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server)
1256 ,qstring ; the query, in namazu format
1257 ,(nnir-read-server-parm 'nnir-namazu-index-directory server) ; index directory
1261 (message "%s args: %s" nnir-namazu-program
1262 (mapconcat 'identity (cddddr cp-list) " "))
1263 (apply 'call-process cp-list))))
1264 (unless (or (null exitstatus)
1266 (nnheader-report 'nnir "Couldn't run namazu: %s" exitstatus)
1267 ;; Namazu failure reason is in this buffer, show it if
1268 ;; the user wants it.
1269 (when (> gnus-verbose 6)
1270 (display-buffer nnir-tmp-buffer))))
1272 ;; Namazu output looks something like this:
1273 ;; 2. Re: Gnus agent expire broken (score: 55)
1274 ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1276 (goto-char (point-min))
1277 (while (re-search-forward
1278 "^\\([0-9]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1280 (setq score (match-string 3)
1281 group (file-name-directory (match-string 4))
1282 article (file-name-nondirectory (match-string 4)))
1284 ;; make sure article and group is sane
1285 (when (and (string-match article-pattern article)
1287 (nnir-add-result group article score prefix server artlist)))
1289 ;; sort artlist by score
1292 (function (lambda (x y)
1293 (> (nnir-artitem-rsv x)
1294 (nnir-artitem-rsv y)))))))))
1296 (defun nnir-run-find-grep (query server &optional grouplist)
1297 "Run find and grep to obtain matching articles."
1298 (let* ((method (gnus-server-to-method server))
1300 (concat (symbol-name (car method)) "-directory")))
1301 (directory (cadr (assoc sym (cddr method))))
1302 (regexp (cdr (assoc 'query query)))
1303 (grep-options (cdr (assoc 'grep-options query)))
1304 (grouplist (or grouplist (nnir-get-active server)))
1307 (error "No directory found in method specification of server %s"
1313 (message "Searching %s using find-grep..."
1315 (save-window-excursion
1316 (set-buffer (get-buffer-create nnir-tmp-buffer))
1318 (if (> gnus-verbose 6)
1319 (pop-to-buffer (current-buffer)))
1320 (cd directory) ; Using relative paths simplifies
1325 ;; Try accessing the group literally as
1326 ;; well as interpreting dots as directory
1327 ;; separators so the engine works with
1328 ;; plain nnml as well as the Gnus Cache.
1329 (let ((group (gnus-group-real-name group)))
1330 ;; Replace cl-func find-if.
1331 (if (file-directory-p group)
1333 (if (file-directory-p
1335 (gnus-replace-in-string
1340 (error "Cannot locate directory for group"))
1343 'call-process "find" nil t
1344 "find" group "-type" "f" "-name" "[0-9]*" "-exec"
1346 `("-l" ,@(and grep-options
1347 (split-string grep-options "\\s-" t))
1348 "-e" ,regexp "{}" "+"))))
1350 ;; Translate relative paths to group names.
1352 (let* ((path (split-string
1355 (line-end-position)) "/" t))
1356 (art (string-to-number (car (last path)))))
1357 (while (string= "." (car path))
1358 (setq path (cdr path)))
1359 (let ((group (mapconcat 'identity
1361 ;; (subseq path 0 -1)
1362 (let ((end (1- (length path)))
1365 (>= (setq end (1- end)) 0)
1366 (push (pop path) res))
1370 (vector (gnus-group-full-name group server) art 0)
1373 (message "Searching %s using find-grep...done"
1378 (declare-function mm-url-insert "mm-url" (url &optional follow-refresh))
1379 (declare-function mm-url-encode-www-form-urlencoded "mm-url" (pairs))
1382 (defun nnir-run-gmane (query srv &optional groups)
1383 "Run a search against a gmane back-end server."
1384 (if (gnus-string-match-p "gmane.org$" srv)
1385 (let* ((case-fold-search t)
1386 (qstring (cdr (assq 'query query)))
1387 (server (cadr (gnus-server-to-method srv)))
1388 (groupspec (if groups
1391 (format "group:%s" (gnus-group-short-name x)))
1394 (if (assq 'author query)
1395 (format "author:%s" (cdr (assq 'author query))) ""))
1396 (search (format "%s %s %s"
1397 qstring groupspec authorspec))
1398 (gnus-inhibit-demon t)
1401 (with-current-buffer (get-buffer-create nnir-tmp-buffer)
1405 "http://search.gmane.org/nov.php"
1407 (mm-url-encode-www-form-urlencoded
1408 `(("query" . ,search)
1409 ("HITSPERPAGE" . "999")))))
1410 (unless (featurep 'xemacs) (set-buffer-multibyte t))
1411 (mm-decode-coding-region (point-min) (point-max) 'utf-8)
1412 (goto-char (point-min))
1415 (unless (or (eolp) (looking-at "\x0d"))
1416 (let ((header (nnheader-parse-nov)))
1417 (let ((xref (mail-header-xref header))
1418 (xscore (string-to-number (cdr (assoc 'X-Score
1419 (mail-header-extra header))))))
1420 (when (string-match " \\([^:]+\\)[:/]\\([0-9]+\\)" xref)
1423 (gnus-group-prefixed-name (match-string 1 xref) srv)
1424 (string-to-number (match-string 2 xref)) xscore)
1427 (apply 'vector (nreverse (mm-delete-duplicates artlist))))
1428 (message "Can't search non-gmane nntp groups")
1433 (defun nnir-read-parms (query nnir-search-engine)
1434 "Reads additional search parameters according to `nnir-engines'."
1435 (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines))))
1437 (mapcar 'nnir-read-parm parmspec))))
1439 (defun nnir-read-parm (parmspec)
1440 "Reads a single search parameter.
1441 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1442 (let ((sym (car parmspec))
1443 (prompt (cdr parmspec)))
1445 (let* ((result (apply 'gnus-completing-read prompt))
1446 (mapping (or (assoc result nnir-imap-search-arguments)
1447 (cons nil nnir-imap-search-other))))
1448 (cons sym (format (cdr mapping) result)))
1449 (cons sym (read-string prompt)))))
1451 (autoload 'gnus-group-topic-name "gnus-topic")
1453 (defun nnir-run-query (query nserver)
1454 "Invoke appropriate search engine function (see `nnir-engines').
1455 If some groups were process-marked, run the query for each of the groups
1456 and concat the results."
1457 (let ((q (car (read-from-string query)))
1458 (groups (if (string= "all-ephemeral" nserver)
1459 (with-current-buffer gnus-server-buffer
1460 (list (list (gnus-server-server-name))))
1462 (or gnus-group-marked
1463 (if (gnus-group-group-name)
1464 (list (gnus-group-group-name))
1465 (cdr (assoc (gnus-group-topic-name)
1466 gnus-topic-alist))))
1467 gnus-group-server))))
1471 (let* ((server (car x))
1473 (or (nnir-read-server-parm 'nnir-search-engine
1476 (gnus-server-to-method server))
1477 nnir-method-default-engines))))
1479 (setq search-func (cadr (assoc nnir-search-engine
1482 (funcall search-func
1483 (if nnir-extra-parms
1484 (nnir-read-parms q nnir-search-engine)
1490 (defun nnir-read-server-parm (key server)
1491 "Returns the parameter value of key for the given server, where
1492 server is of form 'backend:name'."
1493 (let ((method (gnus-server-to-method server)))
1494 (cond ((and method (assq key (cddr method)))
1495 (nth 1 (assq key (cddr method))))
1498 (defun nnir-possibly-change-server (server)
1499 (unless (and server (nnir-server-opened server))
1500 (nnir-open-server server)))
1505 (defun nnir-artlist-groups (artlist)
1506 "Returns a list of all groups in the given ARTLIST."
1509 ;; from each artitem, extract group component
1510 (setq with-dups (mapcar 'nnir-artitem-group artlist))
1511 ;; remove duplicates from above
1512 (mapc (function (lambda (x) (add-to-list 'res x)))
1516 (defun nnir-get-active (srv)
1517 (let ((method (gnus-server-to-method srv))
1519 (gnus-request-list method)
1520 (with-current-buffer nntp-server-buffer
1521 (let ((cur (current-buffer))
1523 (goto-char (point-min))
1524 (unless (string= nnir-ignored-newsgroups "")
1525 (delete-matching-lines nnir-ignored-newsgroups))
1526 (if (eq (car method) 'nntp)
1529 (push (mm-string-as-unibyte
1530 (gnus-group-full-name
1534 (skip-chars-forward "^ \t")
1540 (push (mm-string-as-unibyte
1541 (if (eq (char-after) ?\")
1542 (gnus-group-full-name (read cur) method)
1543 (let ((p (point)) (name ""))
1544 (skip-chars-forward "^ \t\\\\")
1545 (setq name (buffer-substring p (point)))
1546 (while (eq (char-after) ?\\)
1547 (setq p (1+ (point)))
1549 (skip-chars-forward "^ \t\\\\")
1550 (setq name (concat name (buffer-substring
1552 (gnus-group-full-name name method))))
1557 (defun nnir-registry-action (action data-header from &optional to method)
1558 "Call `gnus-registry-action' with the original article group."
1559 (gnus-registry-action
1562 (nnir-article-group (mail-header-number data-header))
1567 (when (eq (car (gnus-find-method-for-group gnus-newsgroup-name)) 'nnir)
1568 (setq gnus-summary-line-format
1569 (or nnir-summary-line-format gnus-summary-line-format))
1570 (remove-hook 'gnus-summary-article-delete-hook 'gnus-registry-action t)
1571 (remove-hook 'gnus-summary-article-move-hook 'gnus-registry-action t)
1572 (add-hook 'gnus-summary-article-delete-hook 'nnir-registry-action t t)
1573 (add-hook 'gnus-summary-article-move-hook 'nnir-registry-action t t)))
1580 ;;; nnir.el ends here