1 ;;; nnir.el --- search mail with various search engines -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1998-2011 Free Software Foundation, Inc.
5 ;; Author: Kai Großjohann <grossjohann@ls6.cs.uni-dortmund.de>
6 ;; Swish-e and Swish++ backends by:
7 ;; Christoph Conrad <christoph.conrad@gmx.de>.
8 ;; IMAP backend by: Simon Josefsson <jas@pdc.kth.se>.
9 ;; IMAP search by: Torsten Hilbrich <torsten.hilbrich <at> gmx.net>
10 ;; IMAP search improved by Daniel Pittman <daniel@rimspace.net>.
11 ;; nnmaildir support for Swish++ and Namazu backends by:
12 ;; Justus Piater <Justus <at> Piater.name>
13 ;; Keywords: news mail searching ir
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software: you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation, either version 3 of the License, or
20 ;; (at your option) any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;; TODO: Documentation in the Gnus manual
34 ;; Where in the existing gnus manual would this fit best?
36 ;; What does it do? Well, it allows you to search your mail using
37 ;; some search engine (imap, namazu, swish-e, gmane and others -- see
38 ;; later) by typing `G G' in the Group buffer. You will then get a
39 ;; buffer which shows all articles matching the query, sorted by
40 ;; Retrieval Status Value (score).
42 ;; When looking at the retrieval result (in the Summary buffer) you
43 ;; can type `A W' (aka M-x gnus-warp-to-article RET) on an article. You
44 ;; will be warped into the group this article came from. Typing `A T'
45 ;; (aka M-x gnus-summary-refer-thread RET) will warp to the group and
46 ;; also show the thread this article is part of.
48 ;; The Lisp setup may involve setting a few variables and setting up the
49 ;; search engine. You can define the variables in the server definition
51 ;; (setq gnus-secondary-select-methods '(
52 ;; (nnimap "" (nnimap-address "localhost")
53 ;; (nnir-search-engine namazu)
55 ;; The main variable to set is `nnir-search-engine'. Choose one of
56 ;; the engines listed in `nnir-engines'. (Actually `nnir-engines' is
57 ;; an alist, type `C-h v nnir-engines RET' for more information; this
58 ;; includes examples for setting `nnir-search-engine', too.)
60 ;; If you use one of the local indices (namazu, find-grep, swish) you
61 ;; must also set up a search engine backend.
65 ;; The Namazu backend requires you to have one directory containing all
66 ;; index files, this is controlled by the `nnir-namazu-index-directory'
67 ;; variable. To function the `nnir-namazu-remove-prefix' variable must
68 ;; also be correct, see the documentation for `nnir-namazu-remove-prefix'
71 ;; It is particularly important not to pass any any switches to namazu
72 ;; that will change the output format. Good switches to use include
73 ;; `--sort', `--ascending', `--early' and `--late'. Refer to the Namazu
74 ;; documentation for further information on valid switches.
76 ;; To index my mail with the `mknmz' program I use the following
77 ;; configuration file:
80 ;; | package conf; # Don't remove this line!
82 ;; | # Paths which will not be indexed. Don't use `^' or `$' anchors.
83 ;; | $EXCLUDE_PATH = "spam|sent";
85 ;; | # Header fields which should be searchable. case-insensitive
86 ;; | $REMAIN_HEADER = "from|date|message-id|subject";
88 ;; | # Searchable fields. case-insensitive
89 ;; | $SEARCH_FIELD = "from|date|message-id|subject";
91 ;; | # The max length of a word.
92 ;; | $WORD_LENG_MAX = 128;
94 ;; | # The max length of a field.
95 ;; | $MAX_FIELD_LENGTH = 256;
98 ;; My mail is stored in the directories ~/Mail/mail/, ~/Mail/lists/ and
99 ;; ~/Mail/archive/, so to index them I go to the directory set in
100 ;; `nnir-namazu-index-directory' and issue the following command.
102 ;; mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
104 ;; For maximum searching efficiency I have a cron job set to run this
105 ;; command every four hours.
109 ;; The find-grep engine simply runs find(1) to locate eligible
110 ;; articles and searches them with grep(1). This, of course, is much
111 ;; slower than using a proper search engine but OTOH doesn't require
112 ;; maintenance of an index and is still faster than using any built-in
113 ;; means for searching. The method specification of the server to
114 ;; search must include a directory for this engine to work (E.g.,
115 ;; `nnml-directory'). The tools must be POSIX compliant. GNU Find
116 ;; prior to version 4.2.12 (4.2.26 on Linux due to incorrect ARG_MAX
117 ;; handling) does not work.
119 ;; | ;; find-grep configuration for searching the Gnus Cache
122 ;; | (nnml-get-new-mail nil)
123 ;; | (nnir-search-engine find-grep)
124 ;; | (nnml-directory "~/News/cache/")
125 ;; | (nnml-active-file "~/News/cache/active"))
128 ;; Developer information:
130 ;; I have tried to make the code expandable. Basically, it is divided
131 ;; into two layers. The upper layer is somewhat like the `nnvirtual'
132 ;; backend: given a specification of what articles to show from
133 ;; another backend, it creates a group containing exactly those
134 ;; articles. The lower layer issues a query to a search engine and
135 ;; produces such a specification of what articles to show from the
138 ;; The interface between the two layers consists of the single
139 ;; function `nnir-run-query', which just selects the appropriate
140 ;; function for the search engine one is using. The input to
141 ;; `nnir-run-query' is a string, representing the query as input by
142 ;; the user. The output of `nnir-run-query' is supposed to be a
143 ;; vector, each element of which should in turn be a three-element
144 ;; vector. The first element should be full group name of the article,
145 ;; the second element should be the article number, and the third
146 ;; element should be the Retrieval Status Value (RSV) as returned from
147 ;; the search engine. An RSV is the score assigned to the document by
148 ;; the search engine. For Boolean search engines, the
149 ;; RSV is always 1000 (or 1 or 100, or whatever you like).
151 ;; The sorting order of the articles in the summary buffer created by
152 ;; nnir is based on the order of the articles in the above mentioned
153 ;; vector, so that's where you can do the sorting you'd like. Maybe
154 ;; it would be nice to have a way of displaying the search result
155 ;; sorted differently?
157 ;; So what do you need to do when you want to add another search
158 ;; engine? You write a function that executes the query. Temporary
159 ;; data from the search engine can be put in `nnir-tmp-buffer'. This
160 ;; function should return the list of articles as a vector, as
161 ;; described above. Then, you need to register this backend in
162 ;; `nnir-engines'. Then, users can choose the backend by setting
163 ;; `nnir-search-engine' as a server variable.
169 ;; For Emacs <22.2 and XEmacs.
171 (unless (fboundp 'declare-function
) (defmacro declare-function
(&rest r
))))
174 (require 'gnus-group
)
180 ;;; Internal Variables:
182 (defvar nnir-current-query nil
183 "Internal: stores current query (= group name).")
185 (defvar nnir-current-server nil
186 "Internal: stores current server (does it ever change?).")
188 (defvar nnir-current-group-marked nil
189 "Internal: stores current list of process-marked groups.")
191 (defvar nnir-artlist nil
192 "Internal: stores search result.")
194 (defvar nnir-tmp-buffer
" *nnir*"
195 "Internal: temporary buffer.")
197 (defvar nnir-search-history
()
198 "Internal: the history for querying search options in nnir")
200 (defvar nnir-extra-parms nil
201 "Internal: stores request for extra search parms")
205 (defvar nnir-imap-search-arguments
206 '(("whole message" .
"TEXT")
207 ("subject" .
"SUBJECT")
212 "Mapping from user readable keys to IMAP search items for use in nnir")
214 (defvar nnir-imap-search-other
"HEADER %S"
215 "The IMAP search item to use for anything other than
216 `nnir-imap-search-arguments'. By default this is the name of an
219 (defvar nnir-imap-search-argument-history
()
220 "The history for querying search options in nnir")
224 ;; Data type article list.
226 (defmacro nnir-artlist-length
(artlist)
227 "Returns number of articles in artlist."
230 (defmacro nnir-artlist-article
(artlist n
)
231 "Returns from ARTLIST the Nth artitem (counting starting at 1)."
233 (elt ,artlist
(1- ,n
))))
235 (defmacro nnir-artitem-group
(artitem)
236 "Returns the group from the ARTITEM."
239 (defmacro nnir-artitem-number
(artitem)
240 "Returns the number from the ARTITEM."
243 (defmacro nnir-artitem-rsv
(artitem)
244 "Returns the Retrieval Status Value (RSV, score) from the ARTITEM."
247 (defmacro nnir-article-group
(article)
248 "Returns the group for ARTICLE"
249 `(nnir-artitem-group (nnir-artlist-article nnir-artlist
,article
)))
251 (defmacro nnir-article-number
(article)
252 "Returns the number for ARTICLE"
253 `(nnir-artitem-number (nnir-artlist-article nnir-artlist
,article
)))
255 (defmacro nnir-article-rsv
(article)
256 "Returns the rsv for ARTICLE"
257 `(nnir-artitem-rsv (nnir-artlist-article nnir-artlist
,article
)))
259 (defsubst nnir-article-ids
(article)
260 "Returns the pair `(nnir id . real id)' of ARTICLE"
261 (cons article
(nnir-article-number article
)))
263 (defmacro nnir-categorize
(sequence keyfunc
&optional valuefunc
)
264 "Sorts a sequence into categories and returns a list of the form
265 `((key1 (element11 element12)) (key2 (element21 element22))'.
266 The category key for a member of the sequence is obtained
267 as `(keyfunc member)' and the corresponding element is just
268 `member'. If `valuefunc' is non-nil, the element of the list
269 is `(valuefunc member)'."
270 `(unless (null ,sequence
)
274 (let ((y (,keyfunc member
))
279 (push x
(cadr (assoc y value
)))
280 (push (list y
(list x
)) value
))))
289 (autoload 'nnimap-buffer
"nnimap")
290 (autoload 'nnimap-command
"nnimap")
291 (autoload 'nnimap-possibly-change-group
"nnimap")
292 (autoload 'gnus-registry-action
"gnus-registry")
293 (defvar gnus-registry-install
))
297 (nnoo-define-basics nnir
)
299 (gnus-declare-backend "nnir" 'mail
)
302 ;;; User Customizable Variables:
305 "Search groups in Gnus with assorted seach engines."
308 (defcustom nnir-ignored-newsgroups
""
309 "*A regexp to match newsgroups in the active file that should
310 be skipped when searching."
314 (defcustom nnir-summary-line-format nil
315 "*The format specification of the lines in an nnir summary buffer.
317 All the items from `gnus-summary-line-format' are available, along
318 with three items unique to nnir summary buffers:
320 %Z Search retrieval score value (integer)
321 %G Article original full group name (string)
322 %g Article original short group name (string)
324 If nil this will use `gnus-summary-line-format'."
328 (defcustom nnir-retrieve-headers-override-function nil
329 "*If non-nil, a function that accepts an article list and group
330 and populates the `nntp-server-buffer' with the retrieved
331 headers. Must return either 'nov or 'headers indicating the
332 retrieved header format.
334 If this variable is nil, or if the provided function returns nil for a search
335 result, `gnus-retrieve-headers' will be called instead."
339 (defcustom nnir-imap-default-search-key
"whole message"
340 "*The default IMAP search key for an nnir search. Must be one of
341 the keys in `nnir-imap-search-arguments'. To use raw imap queries
342 by default set this to \"Imap\"."
343 :type
`(choice ,@(mapcar (lambda (elem) (list 'const
(car elem
)))
344 nnir-imap-search-arguments
))
347 (defcustom nnir-swish
++-configuration-file
348 (expand-file-name "~/Mail/swish++.conf")
349 "*Configuration file for swish++."
353 (defcustom nnir-swish
++-program
"search"
354 "*Name of swish++ search executable."
358 (defcustom nnir-swish
++-additional-switches
'()
359 "*A list of strings, to be given as additional arguments to swish++.
361 Note that this should be a list. Ie, do NOT use the following:
362 (setq nnir-swish++-additional-switches \"-i -w\") ; wrong
364 (setq nnir-swish++-additional-switches '(\"-i\" \"-w\"))"
365 :type
'(repeat (string))
368 (defcustom nnir-swish
++-remove-prefix
(concat (getenv "HOME") "/Mail/")
369 "*The prefix to remove from each file name returned by swish++
370 in order to get a group name (albeit with / instead of .). This is a
373 This variable is very similar to `nnir-namazu-remove-prefix', except
374 that it is for swish++, not Namazu."
379 ;; URL: http://swish-e.org/
380 ;; Variables `nnir-swish-e-index-file', `nnir-swish-e-program' and
381 ;; `nnir-swish-e-additional-switches'
383 (make-obsolete-variable 'nnir-swish-e-index-file
384 'nnir-swish-e-index-files
"Emacs 23.1")
385 (defcustom nnir-swish-e-index-file
386 (expand-file-name "~/Mail/index.swish-e")
387 "*Index file for swish-e.
388 This could be a server parameter.
389 It is never consulted once `nnir-swish-e-index-files', which should be
390 used instead, has been customized."
394 (defcustom nnir-swish-e-index-files
395 (list nnir-swish-e-index-file
)
396 "*List of index files for swish-e.
397 This could be a server parameter."
398 :type
'(repeat (file))
401 (defcustom nnir-swish-e-program
"swish-e"
402 "*Name of swish-e search executable.
403 This cannot be a server parameter."
407 (defcustom nnir-swish-e-additional-switches
'()
408 "*A list of strings, to be given as additional arguments to swish-e.
410 Note that this should be a list. Ie, do NOT use the following:
411 (setq nnir-swish-e-additional-switches \"-i -w\") ; wrong
413 (setq nnir-swish-e-additional-switches '(\"-i\" \"-w\"))
415 This could be a server parameter."
416 :type
'(repeat (string))
419 (defcustom nnir-swish-e-remove-prefix
(concat (getenv "HOME") "/Mail/")
420 "*The prefix to remove from each file name returned by swish-e
421 in order to get a group name (albeit with / instead of .). This is a
424 This variable is very similar to `nnir-namazu-remove-prefix', except
425 that it is for swish-e, not Namazu.
427 This could be a server parameter."
431 ;; HyREX engine, see <URL:http://ls6-www.cs.uni-dortmund.de/>
433 (defcustom nnir-hyrex-program
"nnir-search"
434 "*Name of the nnir-search executable."
438 (defcustom nnir-hyrex-additional-switches
'()
439 "*A list of strings, to be given as additional arguments for nnir-search.
440 Note that this should be a list. Ie, do NOT use the following:
441 (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
443 (setq nnir-hyrex-additional-switches '(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
444 :type
'(repeat (string))
447 (defcustom nnir-hyrex-index-directory
(getenv "HOME")
448 "*Index directory for HyREX."
452 (defcustom nnir-hyrex-remove-prefix
(concat (getenv "HOME") "/Mail/")
453 "*The prefix to remove from each file name returned by HyREX
454 in order to get a group name (albeit with / instead of .).
456 For example, suppose that HyREX returns file names such as
457 \"/home/john/Mail/mail/misc/42\". For this example, use the following
458 setting: (setq nnir-hyrex-remove-prefix \"/home/john/Mail/\")
459 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
460 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
461 arrive at the correct group name, \"mail.misc\"."
465 ;; Namazu engine, see <URL:http://www.namazu.org/>
467 (defcustom nnir-namazu-program
"namazu"
468 "*Name of Namazu search executable."
472 (defcustom nnir-namazu-index-directory
(expand-file-name "~/Mail/namazu/")
473 "*Index directory for Namazu."
477 (defcustom nnir-namazu-additional-switches
'()
478 "*A list of strings, to be given as additional arguments to namazu.
479 The switches `-q', `-a', and `-s' are always used, very few other switches
480 make any sense in this context.
482 Note that this should be a list. Ie, do NOT use the following:
483 (setq nnir-namazu-additional-switches \"-i -w\") ; wrong
485 (setq nnir-namazu-additional-switches '(\"-i\" \"-w\"))"
486 :type
'(repeat (string))
489 (defcustom nnir-namazu-remove-prefix
(concat (getenv "HOME") "/Mail/")
490 "*The prefix to remove from each file name returned by Namazu
491 in order to get a group name (albeit with / instead of .).
493 For example, suppose that Namazu returns file names such as
494 \"/home/john/Mail/mail/misc/42\". For this example, use the following
495 setting: (setq nnir-namazu-remove-prefix \"/home/john/Mail/\")
496 Note the trailing slash. Removing this prefix gives \"mail/misc/42\".
497 `nnir' knows to remove the \"/42\" and to replace \"/\" with \".\" to
498 arrive at the correct group name, \"mail.misc\"."
502 ;;; Developer Extension Variable:
505 `((imap nnir-run-imap
507 "Imap Search in" ; Prompt
508 ,(mapcar 'car nnir-imap-search-arguments
) ; alist for completing
509 nil
; allow any user input
511 nnir-imap-search-argument-history
; the history to use
512 ,nnir-imap-default-search-key
; default
514 (gmane nnir-run-gmane
515 ((author .
"Gmane Author: ")))
516 (swish++ nnir-run-swish
++
517 ((group .
"Swish++ Group spec: ")))
518 (swish-e nnir-run-swish-e
519 ((group .
"Swish-e Group spec: ")))
520 (namazu nnir-run-namazu
522 (hyrex nnir-run-hyrex
523 ((group .
"Hyrex Group spec: ")))
524 (find-grep nnir-run-find-grep
525 ((grep-options .
"Grep options: "))))
526 "Alist of supported search engines.
527 Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
528 ENGINE is a symbol designating the searching engine. FUNCTION is also
529 a symbol, giving the function that does the search. The third element
530 ARGS is a list of cons pairs (PARAM . PROMPT). When issuing a query,
531 the FUNCTION will issue a query for each of the PARAMs, using PROMPT.
533 The value of `nnir-search-engine' must be one of the ENGINE symbols.
534 For example, for searching a server using namazu include
535 (nnir-search-engine namazu)
536 in the server definition. Note that you have to set additional
537 variables for most backends. For example, the `namazu' backend
538 needs the variables `nnir-namazu-program',
539 `nnir-namazu-index-directory' and `nnir-namazu-remove-prefix'.
541 Add an entry here when adding a new search engine.")
543 (defcustom nnir-method-default-engines
546 "*Alist of default search engines keyed by server method."
547 :type
`(repeat (cons (choice (const nnimap
) (const nttp
) (const nnspool
)
548 (const nneething
) (const nndir
) (const nnmbox
)
549 (const nnml
) (const nnmh
) (const nndraft
)
550 (const nnfolder
) (const nnmaildir
))
552 ,@(mapcar (lambda (elem) (list 'const
(car elem
)))
558 (defun gnus-group-make-nnir-group (nnir-extra-parms)
559 "Create an nnir group. Asks for query."
561 (setq nnir-current-query nil
562 nnir-current-server nil
563 nnir-current-group-marked nil
565 (let* ((query (read-string "Query: " nil
'nnir-search-history
))
566 (parms (list (cons 'query query
)))
567 (srv (if (gnus-server-server-name)
569 (add-to-list 'parms
(cons 'unique-id
(message-unique-id)) t
)
570 (gnus-group-read-ephemeral-group
571 (concat "nnir:" (prin1-to-string parms
)) (list 'nnir srv
) t
572 (cons (current-buffer) gnus-current-window-configuration
)
576 ;; Gnus backend interface functions.
578 (deffoo nnir-open-server
(server &optional definitions
)
579 ;; Just set the server variables appropriately.
580 (add-hook 'gnus-summary-mode-hook
'nnir-mode
)
581 (nnoo-change-server 'nnir server definitions
))
583 (deffoo nnir-request-group
(group &optional server fast info
)
584 "GROUP is the query string."
585 (nnir-possibly-change-server server
)
586 ;; Check for cache and return that if appropriate.
587 (if (and (equal group nnir-current-query
)
588 (equal gnus-group-marked nnir-current-group-marked
)
590 (equal server nnir-current-server
)))
593 (setq nnir-artlist
(nnir-run-query group server
)))
594 (with-current-buffer nntp-server-buffer
595 (setq nnir-current-query group
)
596 (when server
(setq nnir-current-server server
))
597 (setq nnir-current-group-marked gnus-group-marked
)
598 (if (zerop (length nnir-artlist
))
599 (nnheader-report 'nnir
"Search produced empty results.")
600 ;; Remember data for cache.
601 (nnheader-insert "211 %d %d %d %s\n"
602 (nnir-artlist-length nnir-artlist
) ; total #
604 (nnir-artlist-length nnir-artlist
) ; last #
605 group
)))) ; group name
607 (deffoo nnir-retrieve-headers
(articles &optional group server fetch-old
)
608 (with-current-buffer nntp-server-buffer
609 (let ((gnus-inhibit-demon t
)
610 (articles-by-group (nnir-categorize
611 articles nnir-article-group nnir-article-ids
))
613 (while (not (null articles-by-group
))
614 (let* ((group-articles (pop articles-by-group
))
615 (artgroup (car group-articles
))
616 (articleids (cadr group-articles
))
617 (artlist (sort (mapcar 'cdr articleids
) '<))
618 (server (gnus-group-server artgroup
))
619 (gnus-override-method (gnus-server-to-method server
))
624 ;; "nnir-retrieve-headers doesn't grok message ids: %s"
626 (nnir-possibly-change-server server
)
629 (case (setq gnus-headers-retrieved-by
632 nnir-retrieve-headers-override-function
633 (funcall nnir-retrieve-headers-override-function
635 (gnus-retrieve-headers artlist artgroup nil
)))
637 (setq parsefunc
'nnheader-parse-nov
))
639 (setq parsefunc
'nnheader-parse-head
))
640 (t (error "Unknown header type %s while requesting articles \
641 of group %s" gnus-headers-retrieved-by artgroup
)))
642 (goto-char (point-min))
644 (let* ((novitem (funcall parsefunc
))
645 (artno (mail-header-number novitem
))
646 (art (car (rassq artno articleids
))))
648 (mail-header-set-number novitem art
)
649 (push novitem headers
))
654 (< (mail-header-number x
) (mail-header-number y
)))))
656 (mapc 'nnheader-insert-nov headers
)
659 (deffoo nnir-request-article
(article &optional group server to-buffer
)
660 (if (stringp article
)
663 "nnir-retrieve-headers doesn't grok message ids: %s"
666 (let ((artfullgroup (nnir-article-group article
))
667 (artno (nnir-article-number article
)))
668 (message "Requesting article %d from group %s"
671 (with-current-buffer to-buffer
672 (let ((gnus-article-decode-hook nil
))
673 (gnus-request-article-this-buffer artno artfullgroup
)))
674 (gnus-request-article artno artfullgroup
))
675 (cons artfullgroup artno
)))))
677 (deffoo nnir-request-move-article
(article group server accept-form
678 &optional last internal-move-group
)
679 (let* ((artfullgroup (nnir-article-group article
))
680 (artno (nnir-article-number article
))
681 (to-newsgroup (nth 1 accept-form
))
682 (to-method (gnus-find-method-for-group to-newsgroup
))
683 (from-method (gnus-find-method-for-group artfullgroup
))
684 (move-is-internal (gnus-server-equal from-method to-method
)))
685 (unless (gnus-check-backend-function
686 'request-move-article artfullgroup
)
687 (error "The group %s does not support article moving" artfullgroup
))
688 (gnus-request-move-article
694 (and move-is-internal
695 to-newsgroup
; Not respooling
696 (gnus-group-real-name to-newsgroup
)))))
698 (deffoo nnir-request-expire-articles
(articles group
&optional server force
)
700 (let ((articles-by-group (nnir-categorize
701 articles nnir-article-group nnir-article-ids
))
703 (while (not (null articles-by-group
))
704 (let* ((group-articles (pop articles-by-group
))
705 (artgroup (car group-articles
))
706 (articleids (cadr group-articles
))
707 (artlist (sort (mapcar 'cdr articleids
) '<)))
708 (unless (gnus-check-backend-function 'request-expire-articles
710 (error "The group %s does not support article deletion" artgroup
))
711 (unless (gnus-check-server (gnus-find-method-for-group artgroup
))
712 (error "Couldn't open server for group %s" artgroup
))
713 (push (gnus-request-expire-articles
714 artlist artgroup force
)
716 (sort (delq nil not-deleted
) '<))
719 (deffoo nnir-warp-to-article
()
720 (let* ((cur (if (> (gnus-summary-article-number) 0)
721 (gnus-summary-article-number)
722 (error "This is not a real article.")))
723 (gnus-newsgroup-name (nnir-article-group cur
))
724 (backend-number (nnir-article-number cur
)))
725 (gnus-summary-read-group-1 gnus-newsgroup-name t t gnus-summary-buffer
726 nil
(list backend-number
))))
728 (nnoo-define-skeleton nnir
)
731 (defmacro nnir-add-result
(dirnam artno score prefix server artlist
)
732 "Ask `nnir-compose-result' to construct a result vector,
733 and if it is non-nil, add it to artlist."
734 `(let ((result (nnir-compose-result ,dirnam
,artno
,score
,prefix
,server
)))
735 (when (not (null result
))
736 (push result
,artlist
))))
738 (autoload 'nnmaildir-base-name-to-article-number
"nnmaildir")
740 ;; Helper function currently used by the Swish++ and Namazu backends;
741 ;; perhaps useful for other backends as well
742 (defun nnir-compose-result (dirnam article score prefix server
)
743 "Extract the group from dirnam, and create a result vector
744 ready to be added to the list of search results."
746 ;; remove nnir-*-remove-prefix from beginning of dirnam filename
747 (when (string-match (concat "^" prefix
) dirnam
)
748 (setq dirnam
(replace-match "" t t dirnam
)))
750 (when (file-readable-p (concat prefix dirnam article
))
751 ;; remove trailing slash and, for nnmaildir, cur/new/tmp
754 (if (string= (gnus-group-server server
) "nnmaildir")
757 ;; Set group to dirnam without any leading dots or slashes,
758 ;; and with all subsequent slashes replaced by dots
759 (let ((group (gnus-replace-in-string
760 (gnus-replace-in-string dirnam
"^[./\\]" "" t
)
763 (vector (gnus-group-full-name group server
)
764 (if (string= (gnus-group-server server
) "nnmaildir")
765 (nnmaildir-base-name-to-article-number
766 (substring article
0 (string-match ":" article
))
768 (string-to-number article
))
769 (string-to-number score
)))))
771 ;;; Search Engine Interfaces:
774 (defun nnir-run-imap (query srv
&optional groups
)
775 "Run a search against an IMAP back-end server.
776 This uses a custom query language parser; see `nnir-imap-make-query' for
777 details on the language and supported extensions"
779 (let ((qstring (cdr (assq 'query query
)))
780 (server (cadr (gnus-server-to-method srv
)))
781 (defs (caddr (gnus-server-to-method srv
)))
782 (criteria (or (cdr (assq 'criteria query
))
783 (cdr (assoc nnir-imap-default-search-key
784 nnir-imap-search-arguments
))))
785 (gnus-inhibit-demon t
)
786 (groups (or groups
(nnir-get-active srv
))))
787 (message "Opening server %s" server
)
794 (when (nnimap-possibly-change-group
795 (gnus-group-short-name group
) server
)
796 (with-current-buffer (nnimap-buffer)
797 (message "Searching %s..." group
)
799 (result (nnimap-command "UID SEARCH %s"
800 (if (string= criteria
"")
802 (nnir-imap-make-query
803 criteria qstring
)))))
806 (let ((artn (string-to-number artnum
)))
808 (push (vector group artn
100)
810 (setq arts
(1+ arts
)))))
811 (and (car result
) (cdr (assoc "SEARCH" (cdr result
)))))
812 (message "Searching %s... %d matches" group arts
)))
813 (message "Searching %s...done" group
))
818 (defun nnir-imap-make-query (criteria qstring
)
819 "Parse the query string and criteria into an appropriate IMAP search
820 expression, returning the string query to make.
822 This implements a little language designed to return the expected results
823 to an arbitrary query string to the end user.
825 The search is always case-insensitive, as defined by RFC2060, and supports
826 the following features (inspired by the Google search input language):
828 Automatic \"and\" queries
829 If you specify multiple words then they will be treated as an \"and\"
830 expression intended to match all components.
833 If you wrap your query in double-quotes then it will be treated as a
837 If you precede a term with \"-\" then it will negate that.
840 If you include an upper-case \"OR\" in your search it will cause the
841 term before it and the term after it to be treated as alternatives.
843 In future the following will be added to the language:
844 * support for date matches
845 * support for location of text matching within the query
846 * from/to/etc headers
847 * additional search terms
848 * flag based searching
849 * anything else that the RFC supports, basically."
850 ;; Walk through the query and turn it into an IMAP query string.
851 (nnir-imap-query-to-imap criteria
(nnir-imap-parse-query qstring
)))
854 (defun nnir-imap-query-to-imap (criteria query
)
855 "Turn a s-expression format query into IMAP."
857 ;; Turn the expressions into IMAP text
859 (nnir-imap-expr-to-imap criteria item
))
860 ;; The query, already in s-expr format.
862 ;; Append a space between each expression
866 (defun nnir-imap-expr-to-imap (criteria expr
)
867 "Convert EXPR into an IMAP search expression on CRITERIA"
868 ;; What sort of expression is this, eh?
870 ;; Simple string term
872 (format "%s %S" criteria expr
))
875 ;; Composite term: or expression
876 ((eq (car-safe expr
) 'or
)
878 (nnir-imap-expr-to-imap criteria
(second expr
))
879 (nnir-imap-expr-to-imap criteria
(third expr
))))
880 ;; Composite term: just the fax, mam
881 ((eq (car-safe expr
) 'not
)
882 (format "NOT (%s)" (nnir-imap-query-to-imap criteria
(rest expr
))))
883 ;; Composite term: just expand it all.
884 ((and (not (null expr
)) (listp expr
))
885 (format "(%s)" (nnir-imap-query-to-imap criteria expr
)))
886 ;; Complex value, give up for now.
887 (t (error "Unhandled input: %S" expr
))))
890 (defun nnir-imap-parse-query (string)
891 "Turn STRING into an s-expression based query based on the IMAP
892 query language as defined in `nnir-imap-make-query'.
894 This involves turning individual tokens into higher level terms
895 that the search language can then understand and use."
897 ;; Set up the parsing environment.
899 (goto-char (point-min))
900 ;; Now, collect the output terms and return them.
902 (while (not (nnir-imap-end-of-input))
903 (push (nnir-imap-next-expr) out
))
907 (defun nnir-imap-next-expr (&optional count
)
908 "Return the next expression from the current buffer."
909 (let ((term (nnir-imap-next-term count
))
910 (next (nnir-imap-peek-symbol)))
911 ;; Are we looking at an 'or' expression?
913 ;; Handle 'expr or expr'
915 (list 'or term
(nnir-imap-next-expr 2)))
920 (defun nnir-imap-next-term (&optional count
)
921 "Return the next TERM from the current buffer."
922 (let ((term (nnir-imap-next-symbol count
)))
923 ;; What sort of term is this?
925 ;; and -- just ignore it
926 ((eq term
'and
) 'and
)
928 ((eq term
'not
) (list 'not
(nnir-imap-next-expr)))
933 (defun nnir-imap-peek-symbol ()
934 "Return the next symbol from the current buffer, but don't consume it."
936 (nnir-imap-next-symbol)))
938 (defun nnir-imap-next-symbol (&optional count
)
939 "Return the next symbol from the current buffer, or nil if we are
940 at the end of the buffer. If supplied COUNT skips some symbols before
941 returning the one at the supplied position."
942 (when (and (numberp count
) (> count
1))
943 (nnir-imap-next-symbol (1- count
)))
944 (let ((case-fold-search t
))
945 ;; end of input stream?
946 (unless (nnir-imap-end-of-input)
947 ;; No, return the next symbol from the stream.
949 ;; negated expression -- return it and advance one char.
950 ((looking-at "-") (forward-char 1) 'not
)
952 ((looking-at "\"") (nnir-imap-delimited-string "\""))
953 ;; list expression -- we parse the content and return this as a list.
955 (nnir-imap-parse-query (nnir-imap-delimited-string ")")))
956 ;; keyword input -- return a symbol version
957 ((looking-at "\\band\\b") (forward-char 3) 'and
)
958 ((looking-at "\\bor\\b") (forward-char 2) 'or
)
959 ((looking-at "\\bnot\\b") (forward-char 3) 'not
)
960 ;; Simple, boring keyword
961 (t (let ((start (point))
962 (end (if (search-forward-regexp "[[:blank:]]" nil t
)
965 ;; unskip if we hit a non-blank terminal character.
966 (when (string-match "[^[:blank:]]" (match-string 0))
968 (goto-char (point-max)))))
969 (buffer-substring start end
)))))))
971 (defun nnir-imap-delimited-string (delimiter)
972 "Return a delimited string from the current buffer."
973 (let ((start (point)) end
)
974 (forward-char 1) ; skip the first delimiter.
976 (unless (search-forward delimiter nil t
)
977 (error "Unmatched delimited input with %s in query" delimiter
))
978 (let ((here (point)))
979 (unless (equal (buffer-substring (- here
2) (- here
1)) "\\")
980 (setq end
(point)))))
981 (buffer-substring (1+ start
) (1- end
))))
983 (defun nnir-imap-end-of-input ()
984 "Are we at the end of input?"
985 (skip-chars-forward "[[:blank:]]")
989 ;; Swish++ interface.
998 (defun nnir-run-swish++ (query server
&optional group
)
999 "Run QUERY against swish++.
1000 Returns a vector of (group name, file name) pairs (also vectors,
1003 Tested with swish++ 4.7 on GNU/Linux and with swish++ 5.0b2 on
1007 ;; (error "The swish++ backend cannot search specific groups"))
1010 (let ( (qstring (cdr (assq 'query query
)))
1011 (groupspec (cdr (assq 'group query
)))
1012 (prefix (nnir-read-server-parm 'nnir-swish
++-remove-prefix server
))
1014 ;; nnml-use-compressed-files might be any string, but probably this
1015 ;; is sufficient. Note that we can't only use the value of
1016 ;; nnml-use-compressed-files because old articles might have been
1017 ;; saved with a different value.
1018 (article-pattern (if (string= (gnus-group-server server
) "nnmaildir")
1020 "^[0-9]+\\(\\.[a-z0-9]+\\)?$"))
1021 score artno dirnam filenam
)
1023 (when (equal "" qstring
)
1024 (error "swish++: You didn't enter anything"))
1026 (set-buffer (get-buffer-create nnir-tmp-buffer
))
1030 (message "Doing swish++ query %s on %s..." qstring groupspec
)
1031 (message "Doing swish++ query %s..." qstring
))
1033 (let* ((cp-list `( ,nnir-swish
++-program
1034 nil
; input from /dev/null
1036 nil
; don't redisplay
1037 "--config-file" ,(nnir-read-server-parm 'nnir-swish
++-configuration-file server
)
1038 ,@(nnir-read-server-parm 'nnir-swish
++-additional-switches server
)
1039 ,qstring
; the query, in swish++ format
1043 (message "%s args: %s" nnir-swish
++-program
1044 (mapconcat 'identity
(cddddr cp-list
) " ")) ;; ???
1045 (apply 'call-process cp-list
))))
1046 (unless (or (null exitstatus
)
1048 (nnheader-report 'nnir
"Couldn't run swish++: %s" exitstatus
)
1049 ;; swish++ failure reason is in this buffer, show it if
1050 ;; the user wants it.
1051 (when (> gnus-verbose
6)
1052 (display-buffer nnir-tmp-buffer
))))
1054 ;; The results are output in the format of:
1056 ;; rank relative-path-name file-size file-title
1058 ;; rank relative-path-name file-size topic??
1059 ;; where rank is an integer from 1 to 100.
1060 (goto-char (point-min))
1061 (while (re-search-forward
1062 "\\(^[0-9]+\\) \\([^ ]+\\) [0-9]+ \\(.*\\)$" nil t
)
1063 (setq score
(match-string 1)
1064 filenam
(match-string 2)
1065 artno
(file-name-nondirectory filenam
)
1066 dirnam
(file-name-directory filenam
))
1068 ;; don't match directories
1069 (when (string-match article-pattern artno
)
1070 (when (not (null dirnam
))
1072 ;; maybe limit results to matching groups.
1073 (when (or (not groupspec
)
1074 (string-match groupspec dirnam
))
1075 (nnir-add-result dirnam artno score prefix server artlist
)))))
1077 (message "Massaging swish++ output...done")
1082 (function (lambda (x y
)
1083 (> (nnir-artitem-rsv x
)
1084 (nnir-artitem-rsv y
)))))))))
1086 ;; Swish-E interface.
1087 (defun nnir-run-swish-e (query server
&optional group
)
1088 "Run given query against swish-e.
1089 Returns a vector of (group name, file name) pairs (also vectors,
1092 Tested with swish-e-2.0.1 on Windows NT 4.0."
1094 ;; swish-e crashes with empty parameter to "-w" on commandline...
1096 ;; (error "The swish-e backend cannot search specific groups"))
1099 (let ((qstring (cdr (assq 'query query
)))
1101 (or (nnir-read-server-parm 'nnir-swish-e-remove-prefix server
)
1102 (error "Missing parameter `nnir-swish-e-remove-prefix'")))
1103 artlist score artno dirnam group
)
1105 (when (equal "" qstring
)
1106 (error "swish-e: You didn't enter anything"))
1108 (set-buffer (get-buffer-create nnir-tmp-buffer
))
1111 (message "Doing swish-e query %s..." query
)
1113 (or (nnir-read-server-parm
1114 'nnir-swish-e-index-files server
)
1115 (error "Missing parameter `nnir-swish-e-index-files'")))
1116 (additional-switches
1117 (nnir-read-server-parm
1118 'nnir-swish-e-additional-switches server
))
1119 (cp-list `(,nnir-swish-e-program
1120 nil
; input from /dev/null
1122 nil
; don't redisplay
1124 ,@additional-switches
1126 ,qstring
; the query, in swish-e format
1130 (message "%s args: %s" nnir-swish-e-program
1131 (mapconcat 'identity
(cddddr cp-list
) " "))
1132 (apply 'call-process cp-list
))))
1133 (unless (or (null exitstatus
)
1135 (nnheader-report 'nnir
"Couldn't run swish-e: %s" exitstatus
)
1136 ;; swish-e failure reason is in this buffer, show it if
1137 ;; the user wants it.
1138 (when (> gnus-verbose
6)
1139 (display-buffer nnir-tmp-buffer
))))
1141 ;; The results are output in the format of:
1142 ;; rank path-name file-title file-size
1143 (goto-char (point-min))
1144 (while (re-search-forward
1145 "\\(^[0-9]+\\) \\([^ ]+\\) \"\\([^\"]+\\)\" [0-9]+$" nil t
)
1146 (setq score
(match-string 1)
1147 artno
(match-string 3)
1148 dirnam
(file-name-directory (match-string 2)))
1150 ;; don't match directories
1151 (when (string-match "^[0-9]+$" artno
)
1152 (when (not (null dirnam
))
1154 ;; remove nnir-swish-e-remove-prefix from beginning of dirname
1155 (when (string-match (concat "^" prefix
) dirnam
)
1156 (setq dirnam
(replace-match "" t t dirnam
)))
1158 (setq dirnam
(substring dirnam
0 -
1))
1159 ;; eliminate all ".", "/", "\" from beginning. Always matches.
1160 (string-match "^[./\\]*\\(.*\\)$" dirnam
)
1162 (setq group
(gnus-replace-in-string (match-string 1 dirnam
) "/" "."))
1163 ;; Windows "\\" -> "."
1164 (setq group
(gnus-replace-in-string group
"\\\\" "."))
1166 (push (vector (gnus-group-full-name group server
)
1167 (string-to-number artno
)
1168 (string-to-number score
))
1171 (message "Massaging swish-e output...done")
1176 (function (lambda (x y
)
1177 (> (nnir-artitem-rsv x
)
1178 (nnir-artitem-rsv y
)))))))))
1181 (defun nnir-run-hyrex (query server
&optional group
)
1184 (groupspec (cdr (assq 'group query
)))
1185 (qstring (cdr (assq 'query query
)))
1186 (prefix (nnir-read-server-parm 'nnir-hyrex-remove-prefix server
))
1188 (when (and (not groupspec
) group
)
1191 (mapcar (lambda (x) (gnus-group-real-name x
)) group
))))
1192 (set-buffer (get-buffer-create nnir-tmp-buffer
))
1194 (message "Doing hyrex-search query %s..." query
)
1196 `( ,nnir-hyrex-program
1197 nil
; input from /dev/null
1199 nil
; don't redisplay
1200 "-i",(nnir-read-server-parm 'nnir-hyrex-index-directory server
) ; index directory
1201 ,@(nnir-read-server-parm 'nnir-hyrex-additional-switches server
)
1202 ,qstring
; the query, in hyrex-search format
1206 (message "%s args: %s" nnir-hyrex-program
1207 (mapconcat 'identity
(cddddr cp-list
) " "))
1208 (apply 'call-process cp-list
))))
1209 (unless (or (null exitstatus
)
1211 (nnheader-report 'nnir
"Couldn't run hyrex-search: %s" exitstatus
)
1212 ;; nnir-search failure reason is in this buffer, show it if
1213 ;; the user wants it.
1214 (when (> gnus-verbose
6)
1215 (display-buffer nnir-tmp-buffer
)))) ;; FIXME: Dont clear buffer !
1216 (message "Doing hyrex-search query \"%s\"...done" qstring
)
1218 ;; nnir-search returns:
1219 ;; for nnml/nnfolder: "filename mailid weigth"
1220 ;; for nnimap: "group mailid weigth"
1221 (goto-char (point-min))
1222 (delete-non-matching-lines "^\\S + [0-9]+ [0-9]+$")
1223 ;; HyREX doesn't search directly in groups -- so filter out here.
1225 (keep-lines groupspec
))
1226 ;; extract data from result lines
1227 (goto-char (point-min))
1228 (while (re-search-forward
1229 "\\(\\S +\\) \\([0-9]+\\) \\([0-9]+\\)" nil t
)
1230 (setq dirnam
(match-string 1)
1231 artno
(match-string 2)
1232 score
(match-string 3))
1233 (when (string-match prefix dirnam
)
1234 (setq dirnam
(replace-match "" t t dirnam
)))
1235 (push (vector (gnus-group-full-name
1236 (gnus-replace-in-string dirnam
"/" ".") server
)
1237 (string-to-number artno
)
1238 (string-to-number score
))
1240 (message "Massaging hyrex-search output...done.")
1243 (function (lambda (x y
)
1244 (if (string-lessp (nnir-artitem-group x
)
1245 (nnir-artitem-group y
))
1247 (< (nnir-artitem-number x
)
1248 (nnir-artitem-number y
)))))))
1252 (defun nnir-run-namazu (query server
&optional group
)
1253 "Run given query against Namazu. Returns a vector of (group name, file name)
1254 pairs (also vectors, actually).
1256 Tested with Namazu 2.0.6 on a GNU/Linux system."
1258 ;; (error "The Namazu backend cannot search specific groups"))
1260 (let ((article-pattern (if (string= (gnus-group-server server
) "nnmaildir")
1264 (qstring (cdr (assq 'query query
)))
1265 (prefix (nnir-read-server-parm 'nnir-namazu-remove-prefix server
))
1267 (process-environment (copy-sequence process-environment
)))
1268 (setenv "LC_MESSAGES" "C")
1269 (set-buffer (get-buffer-create nnir-tmp-buffer
))
1272 `( ,nnir-namazu-program
1273 nil
; input from /dev/null
1275 nil
; don't redisplay
1276 "-q" ; don't be verbose
1277 "-a" ; show all matches
1278 "-s" ; use short format
1279 ,@(nnir-read-server-parm 'nnir-namazu-additional-switches server
)
1280 ,qstring
; the query, in namazu format
1281 ,(nnir-read-server-parm 'nnir-namazu-index-directory server
) ; index directory
1285 (message "%s args: %s" nnir-namazu-program
1286 (mapconcat 'identity
(cddddr cp-list
) " "))
1287 (apply 'call-process cp-list
))))
1288 (unless (or (null exitstatus
)
1290 (nnheader-report 'nnir
"Couldn't run namazu: %s" exitstatus
)
1291 ;; Namazu failure reason is in this buffer, show it if
1292 ;; the user wants it.
1293 (when (> gnus-verbose
6)
1294 (display-buffer nnir-tmp-buffer
))))
1296 ;; Namazu output looks something like this:
1297 ;; 2. Re: Gnus agent expire broken (score: 55)
1298 ;; /home/henrik/Mail/mail/sent/1310 (4,138 bytes)
1300 (goto-char (point-min))
1301 (while (re-search-forward
1302 "^\\([0-9]+\\.\\).*\\((score: \\([0-9]+\\)\\))\n\\([^ ]+\\)"
1304 (setq score
(match-string 3)
1305 group
(file-name-directory (match-string 4))
1306 article
(file-name-nondirectory (match-string 4)))
1308 ;; make sure article and group is sane
1309 (when (and (string-match article-pattern article
)
1311 (nnir-add-result group article score prefix server artlist
)))
1313 ;; sort artlist by score
1316 (function (lambda (x y
)
1317 (> (nnir-artitem-rsv x
)
1318 (nnir-artitem-rsv y
)))))))))
1320 (defun nnir-run-find-grep (query server
&optional grouplist
)
1321 "Run find and grep to obtain matching articles."
1322 (let* ((method (gnus-server-to-method server
))
1324 (concat (symbol-name (car method
)) "-directory")))
1325 (directory (cadr (assoc sym
(cddr method
))))
1326 (regexp (cdr (assoc 'query query
)))
1327 (grep-options (cdr (assoc 'grep-options query
)))
1328 (grouplist (or grouplist
(nnir-get-active server
)))
1331 (error "No directory found in method specification of server %s"
1337 (message "Searching %s using find-grep..."
1339 (save-window-excursion
1340 (set-buffer (get-buffer-create nnir-tmp-buffer
))
1342 (if (> gnus-verbose
6)
1343 (pop-to-buffer (current-buffer)))
1344 (cd directory
) ; Using relative paths simplifies
1349 ;; Try accessing the group literally as
1350 ;; well as interpreting dots as directory
1351 ;; separators so the engine works with
1352 ;; plain nnml as well as the Gnus Cache.
1353 (let ((group (gnus-group-real-name group
)))
1354 ;; Replace cl-func find-if.
1355 (if (file-directory-p group
)
1357 (if (file-directory-p
1359 (gnus-replace-in-string
1364 (error "Cannot locate directory for group"))
1367 'call-process
"find" nil t
1368 "find" group
"-type" "f" "-name" "[0-9]*" "-exec"
1370 `("-l" ,@(and grep-options
1371 (split-string grep-options
"\\s-" t
))
1372 "-e" ,regexp
"{}" "+"))))
1374 ;; Translate relative paths to group names.
1376 (let* ((path (split-string
1379 (line-end-position)) "/" t
))
1380 (art (string-to-number (car (last path
)))))
1381 (while (string= "." (car path
))
1382 (setq path
(cdr path
)))
1383 (let ((group (mapconcat 'identity
1385 ;; (subseq path 0 -1)
1386 (let ((end (1- (length path
)))
1389 (>= (setq end
(1- end
)) 0)
1390 (push (pop path
) res
))
1394 (vector (gnus-group-full-name group server
) art
0)
1397 (message "Searching %s using find-grep...done"
1402 (declare-function mm-url-insert
"mm-url" (url &optional follow-refresh
))
1403 (declare-function mm-url-encode-www-form-urlencoded
"mm-url" (pairs))
1406 (defun nnir-run-gmane (query srv
&optional groups
)
1407 "Run a search against a gmane back-end server."
1408 (let* ((case-fold-search t
)
1409 (qstring (cdr (assq 'query query
)))
1410 (server (cadr (gnus-server-to-method srv
)))
1411 (groupspec (mapconcat
1413 (if (gnus-string-match-p "gmane" x
)
1414 (format "group:%s" (gnus-group-short-name x
))
1415 (error "Can't search non-gmane groups: %s" x
)))
1418 (if (assq 'author query
)
1419 (format "author:%s" (cdr (assq 'author query
))) ""))
1420 (search (format "%s %s %s"
1421 qstring groupspec authorspec
))
1422 (gnus-inhibit-demon t
)
1425 (with-current-buffer (get-buffer-create nnir-tmp-buffer
)
1429 "http://search.gmane.org/nov.php"
1431 (mm-url-encode-www-form-urlencoded
1432 `(("query" .
,search
)
1433 ("HITSPERPAGE" .
"999")))))
1434 (unless (featurep 'xemacs
) (set-buffer-multibyte t
))
1435 (mm-decode-coding-region (point-min) (point-max) 'utf-8
)
1436 (goto-char (point-min))
1439 (unless (or (eolp) (looking-at "\x0d"))
1440 (let ((header (nnheader-parse-nov)))
1441 (let ((xref (mail-header-xref header
))
1442 (xscore (string-to-number (cdr (assoc 'X-Score
1443 (mail-header-extra header
))))))
1444 (when (string-match " \\([^:]+\\)[:/]\\([0-9]+\\)" xref
)
1447 (gnus-group-prefixed-name (match-string 1 xref
) srv
)
1448 (string-to-number (match-string 2 xref
)) xscore
)
1451 (apply 'vector
(nreverse (mm-delete-duplicates artlist
)))))
1455 (defun nnir-read-parms (query nnir-search-engine
)
1456 "Reads additional search parameters according to `nnir-engines'."
1457 (let ((parmspec (caddr (assoc nnir-search-engine nnir-engines
))))
1459 (mapcar 'nnir-read-parm parmspec
))))
1461 (defun nnir-read-parm (parmspec)
1462 "Reads a single search parameter.
1463 `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
1464 (let ((sym (car parmspec
))
1465 (prompt (cdr parmspec
)))
1467 (let* ((result (apply 'gnus-completing-read prompt
))
1468 (mapping (or (assoc result nnir-imap-search-arguments
)
1469 (cons nil nnir-imap-search-other
))))
1470 (cons sym
(format (cdr mapping
) result
)))
1471 (cons sym
(read-string prompt
)))))
1473 (autoload 'gnus-group-topic-name
"gnus-topic")
1475 (defun nnir-run-query (query nserver
)
1476 "Invoke appropriate search engine function (see `nnir-engines').
1477 If some groups were process-marked, run the query for each of the groups
1478 and concat the results."
1479 (let ((q (car (read-from-string query
)))
1480 (groups (if (string= "all-ephemeral" nserver
)
1481 (with-current-buffer gnus-server-buffer
1482 (list (list (gnus-server-server-name))))
1484 (or gnus-group-marked
1485 (if (gnus-group-group-name)
1486 (list (gnus-group-group-name))
1487 (cdr (assoc (gnus-group-topic-name)
1488 gnus-topic-alist
))))
1489 gnus-group-server
))))
1493 (let* ((server (car x
))
1495 (or (nnir-read-server-parm 'nnir-search-engine
1498 (gnus-server-to-method server
))
1499 nnir-method-default-engines
))))
1501 (setq search-func
(cadr (assoc nnir-search-engine
1506 (if nnir-extra-parms
1507 (or (and (eq nnir-search-engine
'imap
)
1508 (assq 'criteria q
) q
)
1509 (setq q
(nnir-read-parms q nnir-search-engine
)))
1515 (defun nnir-read-server-parm (key server
)
1516 "Returns the parameter value of key for the given server, where
1517 server is of form 'backend:name'."
1518 (let ((method (gnus-server-to-method server
)))
1519 (cond ((and method
(assq key
(cddr method
)))
1520 (nth 1 (assq key
(cddr method
))))
1523 (defun nnir-possibly-change-server (server)
1524 (unless (and server
(nnir-server-opened server
))
1525 (nnir-open-server server
)))
1530 (defun nnir-artlist-groups (artlist)
1531 "Returns a list of all groups in the given ARTLIST."
1534 ;; from each artitem, extract group component
1535 (setq with-dups
(mapcar 'nnir-artitem-group artlist
))
1536 ;; remove duplicates from above
1537 (mapc (function (lambda (x) (add-to-list 'res x
)))
1541 (defun nnir-get-active (srv)
1542 (let ((method (gnus-server-to-method srv
))
1544 (gnus-request-list method
)
1545 (with-current-buffer nntp-server-buffer
1546 (let ((cur (current-buffer))
1548 (goto-char (point-min))
1549 (unless (or (null nnir-ignored-newsgroups
)
1550 (string= nnir-ignored-newsgroups
""))
1551 (delete-matching-lines nnir-ignored-newsgroups
))
1552 (if (eq (car method
) 'nntp
)
1555 (push (mm-string-as-unibyte
1556 (gnus-group-full-name
1560 (skip-chars-forward "^ \t")
1566 (push (mm-string-as-unibyte
1567 (if (eq (char-after) ?
\")
1568 (gnus-group-full-name (read cur
) method
)
1569 (let ((p (point)) (name ""))
1570 (skip-chars-forward "^ \t\\\\")
1571 (setq name
(buffer-substring p
(point)))
1572 (while (eq (char-after) ?
\\)
1573 (setq p
(1+ (point)))
1575 (skip-chars-forward "^ \t\\\\")
1576 (setq name
(concat name
(buffer-substring
1578 (gnus-group-full-name name method
))))
1583 (defun nnir-registry-action (action data-header from
&optional to method
)
1584 "Call `gnus-registry-action' with the original article group."
1585 (gnus-registry-action
1588 (nnir-article-group (mail-header-number data-header
))
1593 (when (eq (car (gnus-find-method-for-group gnus-newsgroup-name
)) 'nnir
)
1594 (setq gnus-summary-line-format
1595 (or nnir-summary-line-format gnus-summary-line-format
))
1596 (when (and (boundp 'gnus-registry-install
)
1597 (eq gnus-registry-install t
))
1598 (remove-hook 'gnus-summary-article-delete-hook
'gnus-registry-action t
)
1599 (remove-hook 'gnus-summary-article-move-hook
'gnus-registry-action t
)
1600 (remove-hook 'gnus-summary-article-expire-hook
'gnus-registry-action t
)
1601 (add-hook 'gnus-summary-article-delete-hook
'nnir-registry-action t t
)
1602 (add-hook 'gnus-summary-article-move-hook
'nnir-registry-action t t
)
1603 (add-hook 'gnus-summary-article-expire-hook
'nnir-registry-action t t
))))
1610 ;;; nnir.el ends here