1 ;;; gnus-namazu.el --- Search mail with Namazu -*- coding: iso-2022-7bit; -*-
3 ;; Copyright (C) 2000,2001,2002 TSUCHIYA Masatoshi <tsuchiya@namazu.org>
5 ;; Author: TSUCHIYA Masatoshi <tsuchiya@namazu.org>
6 ;; Keywords: mail searching namazu
8 ;; This file is a part of Semi-Gnus.
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; This program is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program; if not, you can either send email to this
22 ;; program's maintainer or write to: The Free Software Foundation,
23 ;; Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA.
28 ;; This file defines the command to search mails and persistent
29 ;; articles with Namazu and to browse its results with Gnus.
31 ;; Namazu is a full-text search engine intended for easy use. For
32 ;; more detail about Namazu, visit the following page:
39 ;; If this module has already been installed, only 3 steps are
40 ;; required to search articles with this module.
42 ;; (1) Install Namazu.
43 ;; (2) Start Gnus and type M-x gnus-namazu-create-index RET to make
45 ;; (3) In group buffer or in summary buffer, type C-c C-n query RET.
50 ;; Before installing this module, you must install Namazu.
52 ;; This file is a part of T-gnus but is not *YET* a part of Gnus.
53 ;; When you would like to use this module in Gnus (not T-gnus), put
54 ;; this file into the lisp/ directory in the Gnus source tree and run
55 ;; `make install'. And then, put the following expression into your
58 ;; (require 'gnus-namazu)
59 ;; (gnus-namazu-insinuate)
61 ;; In order to make index of articles with Namazu before using this
62 ;; module, type M-x gnus-namazu-create-index RET. Otherwise, you can
63 ;; create index by yourself with the following commands:
65 ;; % mkdir ~/News/namazu
66 ;; % mknmz -a -h -O ~/News/namazu ~/Mail ~/News/cache
68 ;; The first command makes the directory for index files, and the
69 ;; second command generates index files of mails and persistent
72 ;; In order to update indices for incoming articles, this module
73 ;; automatically runs mknmz, the indexer of Namazu, at an interval of
74 ;; 3 days; this period is set to `gnus-namazu-index-update-interval'.
76 ;; Indices will be updated when `gnus-namazu-search' is called. If
77 ;; you want to update indices everywhen Gnus is started, you can put
78 ;; the following expression to your ~/.gnus.
80 ;; (add-hook 'gnus-startup-hook 'gnus-namazu-update-all-indices)
82 ;; In order to control mknmz closely, disable the automatic updating
83 ;; feature and run mknmz by yourself. In this case, set nil to the
86 ;; (setq gnus-namazu-index-update-interval nil)
88 ;; When your index is put into the directory other than the default
89 ;; one (~/News/namazu), it is necessary to set its place to
90 ;; `gnus-namazu-index-directories' as follows:
92 ;; (setq gnus-namazu-index-directories
93 ;; (list (expand-file-name "~/namazu")))
98 (eval-when-compile (require 'cl))
104 ;; It is required for Mule 2.3. See the file Mule23@1934.en.
106 (autoload 'regexp-opt "regexp-opt"))
108 ;; To suppress byte-compile warning.
110 (defvar nnml-directory)
111 (defvar nnmh-directory))
114 (defgroup gnus-namazu nil
115 "Search nnmh and nnml groups in Gnus with Namazu."
118 :prefix "gnus-namazu-")
120 (defconst gnus-namazu-default-index-directory
121 (expand-file-name "namazu" gnus-directory)
122 "Default place of Namazu index files.")
124 (defcustom gnus-namazu-index-directories
126 (or (and (boundp 'gnus-namazu-index-directory)
127 (symbol-value 'gnus-namazu-index-directory))
128 (and (boundp 'nnir-namazu-index-directory)
129 (symbol-value 'nnir-namazu-index-directory))
130 (and (boundp 'gnus-namazu-index-directory)
131 (symbol-value 'gnus-namazu-index-directory))
132 gnus-namazu-default-index-directory))
133 "*Places of Namazu index files."
134 :type '(repeat directory)
137 (defcustom gnus-namazu-command
138 (or (and (boundp 'namazu-command)
139 (symbol-value 'namazu-command))
140 (and (boundp 'nnir-namazu-program)
141 (symbol-value 'nnir-namazu-program))
143 "*Name of the executable file of Namazu."
147 (defcustom gnus-namazu-additional-arguments nil
148 "*Additional arguments of Namazu.
149 The options `-q', `-a', and `-l' are always used, very few other
150 options make any sense in this context."
151 :type '(repeat string)
154 (defcustom gnus-namazu-index-update-interval
155 259200 ; 3 days == 259200 seconds.
156 "*Number of seconds between running the indexer of Namazu."
157 :type '(choice (const :tag "Never run the indexer" nil)
158 (integer :tag "Number of seconds"))
161 (defcustom gnus-namazu-make-index-command "mknmz"
162 "*Name of the executable file of the indexer of Namazu."
166 (defcustom gnus-namazu-make-index-arguments
168 (list "--all" "--mailnews" "--deny=^.*[^0-9].*$")
169 (when (or (and (boundp 'current-language-environment)
171 (symbol-value 'current-language-environment)))
173 (list "--indexing-lang=ja")))
174 "*Arguments of the indexer of Namazu."
175 :type '(repeat string)
178 (defcustom gnus-namazu-field-keywords
179 '("date" "from" "newsgroups" "size" "subject" "summary" "to" "uri")
180 "*List of keywords to do field-search."
181 :type '(repeat string)
184 (defcustom gnus-namazu-coding-system
185 (if (memq system-type '(windows-nt OS/2 emx))
186 (if (boundp 'MULE) '*sjis* 'shift_jis)
187 (if (boundp 'MULE) '*euc-japan* 'euc-japan))
188 "*Coding system for Namazu process."
192 (defcustom gnus-namazu-need-path-normalization
193 (eq system-type 'windows-nt)
194 "*Non-nil means that outputs of namazu may contain a not normalized path."
198 (defcustom gnus-namazu-case-sensitive-filesystem
199 (not (eq system-type 'windows-nt))
200 "*Non-nil means that the using file system distinguishes cases of characters."
204 (defcustom gnus-namazu-query-highlight t
205 "Non-nil means that queried words is highlighted."
209 (defface gnus-namazu-query-highlight-face
210 '((((type tty pc) (class color))
211 (:background "magenta4" :foreground "cyan1"))
212 (((class color) (background light))
213 (:background "magenta4" :foreground "lightskyblue1"))
214 (((class color) (background dark))
215 (:background "palevioletred2" :foreground "brown4"))
216 (t (:inverse-video t)))
217 "Face used for namazu query matching words."
220 ;;; Internal Variable:
221 (defconst gnus-namazu/group-name-regexp "\\`nnvirtual:namazu-search\\?")
223 ;; Multibyte group name:
225 (fboundp 'gnus-group-decoded-name)
226 (let ((gnus-group-name-charset-group-alist
227 (list (cons gnus-namazu/group-name-regexp gnus-namazu-coding-system)))
228 (query (decode-coding-string
229 (string 27 36 66 52 65 59 122 27 40 66)
230 (if (boundp 'MULE) '*iso-2022-jp* 'iso-2022-7bit))))
231 (not (string-match query
232 (gnus-summary-buffer-name
233 (encode-coding-string
234 (concat "nnvirtual:namazu-search?query=" query)
235 gnus-namazu-coding-system)))))
236 (let (current-load-list)
237 (defadvice gnus-summary-buffer-name
238 (before gnus-namazu-summary-buffer-name activate compile)
239 "Advised by `gnus-namazu' to handle encoded group names."
240 (ad-set-arg 0 (gnus-group-decoded-name (ad-get-arg 0))))))
242 (defmacro gnus-namazu/make-article (group number)
243 `(cons ,group ,number))
244 (defmacro gnus-namazu/article-group (x) `(car ,x))
245 (defmacro gnus-namazu/article-number (x) `(cdr ,x))
247 (defsubst gnus-namazu/indexed-servers ()
248 "Choice appropriate servers from opened ones, and return thier list."
250 (gnus-servers-using-backend 'nnml)
251 (gnus-servers-using-backend 'nnmh)))
253 (defsubst gnus-namazu/default-index-directory ()
254 (if (member gnus-namazu-default-index-directory
255 gnus-namazu-index-directories)
256 gnus-namazu-default-index-directory
257 (car gnus-namazu-index-directories)))
259 (defun gnus-namazu/setup ()
260 (and (boundp 'gnus-group-name-charset-group-alist)
261 (not (member (cons gnus-namazu/group-name-regexp
262 gnus-namazu-coding-system)
263 gnus-group-name-charset-group-alist))
264 (let ((pair (assoc gnus-namazu/group-name-regexp
265 gnus-group-name-charset-group-alist)))
267 (setcdr pair gnus-namazu-coding-system)
268 (push (cons gnus-namazu/group-name-regexp
269 gnus-namazu-coding-system)
270 gnus-group-name-charset-group-alist))))
271 (gnus-namazu-update-all-indices))
273 (defun gnus-namazu/server-directory (server)
274 "Return the top directory of the server SERVER."
275 (and (memq (car server) '(nnml nnmh))
276 (nnoo-change-server (car server) (nth 1 server) (nthcdr 2 server))
277 (file-name-as-directory
278 (expand-file-name (if (eq 'nnml (car server))
282 ;;; Functions to call Namazu.
283 (defsubst gnus-namazu/normalize-results ()
284 "Normalize file names returned by Namazu in this current buffer."
285 (goto-char (point-min))
287 (when (if gnus-namazu-need-path-normalization
288 (or (not (looking-at "/\\(.\\)|/"))
289 (replace-match "\\1:/"))
290 (eq ?~ (char-after (point))))
291 (insert (expand-file-name
292 (buffer-substring (gnus-point-at-bol) (gnus-point-at-eol))))
293 (delete-region (point) (gnus-point-at-eol)))
296 (defsubst gnus-namazu/call-namazu (query)
297 (let ((coding-system-for-read gnus-namazu-coding-system)
298 (coding-system-for-write gnus-namazu-coding-system)
299 (input-coding-system gnus-namazu-coding-system)
300 (output-coding-system gnus-namazu-coding-system)
301 (default-process-coding-system
302 (cons gnus-namazu-coding-system gnus-namazu-coding-system))
303 program-coding-system-alist
304 (file-name-coding-system gnus-namazu-coding-system)
305 (pathname-coding-system gnus-namazu-coding-system))
307 `(,gnus-namazu-command
308 nil ; input from /dev/null
310 nil ; don't redisplay
311 "-q" ; don't be verbose
312 "-a" ; show all matches
313 "-l" ; use list format
314 ,@gnus-namazu-additional-arguments
316 ,@gnus-namazu-index-directories))))
318 (defsubst gnus-namazu/group-prefixed-name (group method)
319 "Return the whole name from GROUP and METHOD."
320 (if gnus-namazu-case-sensitive-filesystem
321 (gnus-group-prefixed-name group method)
322 (let* ((orig (gnus-group-prefixed-name group method))
323 (name (downcase orig)))
325 (mapatoms (lambda (sym)
326 (when (string= name (downcase (symbol-name sym)))
327 (throw 'found-group (symbol-name sym))))
331 (defun gnus-namazu/real-group-name (cond str)
332 "Generate the real group name from the partial path, STR."
336 (dolist (group (gnus-namazu/possible-real-groups
337 (nnheader-replace-chars-in-string str ?/ ?.)))
338 (when (gnus-gethash group gnus-newsrc-hashtb)
339 (throw 'found-group group))))))
341 (defun gnus-namazu/possible-real-groups (str)
342 "Regard the string STR as the partial path of the cached article and
343 generate possible group names from it."
344 (if (string-match "_\\(_\\(_\\)?\\)?" str)
345 (let ((prefix (substring str 0 (match-beginning 0)))
346 (suffix (substring str (match-end 0))))
348 ((match-beginning 2) ;; The number of discoverd underscores = 3
350 (gnus-namazu/possible-real-groups (concat prefix "/__" suffix))
351 (gnus-namazu/possible-real-groups (concat prefix ".._" suffix))))
352 ((match-beginning 1) ;; The number of discoverd underscores = 2
354 (gnus-namazu/possible-real-groups (concat prefix "//" suffix))
355 (gnus-namazu/possible-real-groups (concat prefix ".." suffix))))
356 (t ;; The number of discoverd underscores = 1
357 (gnus-namazu/possible-real-groups (concat prefix "/" suffix)))))
358 (if (string-match "\\." str)
359 ;; Handle the first occurence of period.
360 (list (concat (substring str 0 (match-beginning 0))
362 (substring str (match-end 0)))
366 (defun gnus-namazu/search (groups query)
368 (let ((exit-status (gnus-namazu/call-namazu query)))
369 (unless (zerop exit-status)
370 (error "Namazu finished abnormally: %d" exit-status))
377 (when (setq dir (gnus-namazu/server-directory s))
378 (cons (file-name-as-directory dir) s)))
379 (gnus-namazu/indexed-servers)))))
380 (topdir-regexp (regexp-opt (mapcar 'car server-alist)))
381 (cache-regexp (concat
383 (file-name-as-directory
384 (expand-file-name gnus-cache-directory)))
385 "\\(.*\\)/\\([0-9]+\\)$"))
386 (agent-regexp (concat
388 (file-name-as-directory
389 (expand-file-name gnus-agent-directory)))
390 "\\(.*\\)/\\([0-9]+\\)$")))
391 (gnus-namazu/normalize-results)
392 (goto-char (point-min))
394 (let (server group file)
396 ;; Check the discoverd file is the persistent article.
397 (and (looking-at cache-regexp)
398 (setq file (match-string-no-properties 2)
399 group (gnus-namazu/real-group-name
400 (gnus-use-long-file-name 'not-cache)
401 (match-string-no-properties 1))))
402 ;; Check the discoverd file is covered by the agent.
403 (and (looking-at agent-regexp)
404 (setq file (match-string-no-properties 2)
405 group (gnus-namazu/real-group-name
406 nnmail-use-long-file-names
407 (match-string-no-properties 1))))
408 ;; Check the discovered file is managed by Gnus servers.
409 (and (looking-at topdir-regexp)
410 (setq file (buffer-substring-no-properties
411 (match-end 0) (gnus-point-at-eol))
412 server (cdr (assoc (match-string-no-properties 0)
414 ;; Check validity of the file name.
415 (string-match "/\\([0-9]+\\)\\'" file)
417 (setq group (substring file 0 (match-beginning 0))
418 file (match-string 1 file))
420 (gnus-namazu/group-prefixed-name
421 (if nnmail-use-long-file-names
423 (nnheader-replace-chars-in-string group
427 (member group groups))
428 (push (gnus-namazu/make-article group (string-to-number file))
431 (nreverse articles)))))
435 (defun gnus-namazu/get-target-groups ()
437 ((eq major-mode 'gnus-group-mode)
441 (gnus-group-process-prefix current-prefix-arg))
443 (prog1 gnus-group-marked (gnus-group-unmark-all-groups)))))
444 ((eq major-mode 'gnus-summary-mode)
445 ;; In Summary buffer.
446 (if current-prefix-arg
447 (list (gnus-read-group "Group: "))
449 (gnus-ephemeral-group-p gnus-newsgroup-name)
450 (string-match gnus-namazu/group-name-regexp gnus-newsgroup-name))
451 (cadr (assq 'gnus-namazu-target-groups
452 (gnus-info-method (gnus-get-info gnus-newsgroup-name))))
453 (list gnus-newsgroup-name))))))
455 (defun gnus-namazu/get-current-query ()
456 (and (eq major-mode 'gnus-summary-mode)
457 (gnus-ephemeral-group-p gnus-newsgroup-name)
458 (string-match gnus-namazu/group-name-regexp gnus-newsgroup-name)
459 (cadr (assq 'gnus-namazu-current-query
460 (gnus-info-method (gnus-get-info gnus-newsgroup-name))))))
462 (defvar gnus-namazu/read-query-original-buffer nil)
463 (defvar gnus-namazu/read-query-prompt nil)
464 (defvar gnus-namazu/read-query-history nil)
466 (defun gnus-namazu/get-current-subject ()
467 (and gnus-namazu/read-query-original-buffer
468 (bufferp gnus-namazu/read-query-original-buffer)
469 (with-current-buffer gnus-namazu/read-query-original-buffer
470 (when (eq major-mode 'gnus-summary-mode)
471 (let ((s (gnus-summary-article-subject)))
472 ;; Remove typically prefixes of mailing lists.
474 "^\\(\\[[^]]*[0-9]+\\]\\|([^)]*[0-9]+)\\)\\s-*" s)
475 (setq s (substring s (match-end 0))))
477 "^\\(Re\\(\\^?\\([0-9]+\\|\\[[0-9]+\\]\\)\\)?:\\s-*\\)+" s)
478 (setq s (substring s (match-end 0))))
479 (when (string-match "\\s-*(\\(re\\|was\\)\\b" s)
480 (setq s (substring s 0 (match-beginning 0))))
483 (defun gnus-namazu/get-current-from ()
484 (and gnus-namazu/read-query-original-buffer
485 (bufferp gnus-namazu/read-query-original-buffer)
486 (with-current-buffer gnus-namazu/read-query-original-buffer
487 (when (eq major-mode 'gnus-summary-mode)
488 (cadr (mail-extract-address-components
490 (gnus-summary-article-header))))))))
492 (defun gnus-namazu/get-current-to ()
493 (and gnus-namazu/read-query-original-buffer
494 (bufferp gnus-namazu/read-query-original-buffer)
495 (with-current-buffer gnus-namazu/read-query-original-buffer
496 (when (eq major-mode 'gnus-summary-mode)
497 (cadr (mail-extract-address-components
498 (cdr (assq 'To (mail-header-extra
499 (gnus-summary-article-header))))))))))
501 (defmacro gnus-namazu/minibuffer-prompt-end ()
502 (if (fboundp 'minibuffer-prompt-end)
503 '(minibuffer-prompt-end)
506 (defun gnus-namazu/message (string &rest arguments)
508 gnus-namazu/read-query-prompt
509 (buffer-substring (gnus-namazu/minibuffer-prompt-end)
511 (s2 (apply (function format) string arguments))
516 (message (if (>= w 0)
517 (concat s1 (make-string w ?\ ) s2)
519 (if (sit-for 0.3) (message s1))
522 (defun gnus-namazu/complete-query ()
526 ((and (re-search-backward "\\+\\([-a-z]*\\)" nil t)
527 (= pos (match-end 0)))
528 (let* ((partial (match-string 1))
532 (mapcar 'list gnus-namazu-field-keywords))))
535 (gnus-namazu/message "No completions of %s" partial))
536 ((= 1 (length completions))
537 (goto-char (match-beginning 1))
538 (delete-region (match-beginning 1) (match-end 1))
539 (insert (car completions) ":")
541 (gnus-namazu/message "Completed"))
543 (let ((x (try-completion partial (mapcar 'list completions))))
544 (if (string= x partial)
545 (if (and (eq last-command
546 'gnus-namazu/field-keyword-completion)
547 completion-auto-help)
548 (with-output-to-temp-buffer "*Completions*"
549 (display-completion-list completions))
550 (gnus-namazu/message "Sole completion"))
551 (goto-char (match-beginning 1))
552 (delete-region (match-beginning 1) (match-end 1))
554 (setq pos (point))))))))
555 ((and (looking-at "\\+subject:")
556 (= pos (match-end 0)))
557 (let ((s (gnus-namazu/get-current-subject)))
561 (setq pos (point)))))
562 ((and (looking-at "\\+from:")
563 (= pos (match-end 0)))
564 (let ((f (gnus-namazu/get-current-from)))
568 (setq pos (point)))))
569 ((and (looking-at "\\+to:")
570 (= pos (match-end 0)))
571 (let ((to (gnus-namazu/get-current-to)))
574 (insert "\"" to "\"")
575 (setq pos (point))))))
578 (defvar gnus-namazu/read-query-map
579 (let ((keymap (copy-keymap minibuffer-local-map)))
580 (define-key keymap "\t" 'gnus-namazu/complete-query)
583 (defun gnus-namazu/read-query (prompt &optional initial)
584 (let ((gnus-namazu/read-query-original-buffer (current-buffer))
585 (gnus-namazu/read-query-prompt prompt))
587 (when (setq initial (gnus-namazu/get-current-query))
588 (setq initial (cons initial 0))))
589 (read-from-minibuffer prompt initial gnus-namazu/read-query-map nil
590 'gnus-namazu/read-query-history)))
592 (defun gnus-namazu/highlight-words (query)
595 ;; Remove tokens for NOT search
596 (goto-char (point-min))
597 (while (re-search-forward "[
\e$B!!
\e(B \t\r\f\n]+not[
\e$B!!
\e(B \t\r\f\n]+\
598 \\([^
\e$B!!
\e(B \t\r\f\n\"{(/]+\\|\"[^\"]+\"\\|{[^}]+}\\|([^)]+)\\|/[^/]+/\\)+" nil t)
599 (delete-region (match-beginning 0) (match-end 0)))
600 ;; Remove tokens for Field search
601 (goto-char (point-min))
602 (while (re-search-forward "[
\e$B!!
\e(B \t\r\f\n]+\\+[^
\e$B!!
\e(B \t\r\f\n:]+:\
603 \\([^
\e$B!!
\e(B \t\r\f\n\"{(/]+\\|\"[^\"]+\"\\|{[^}]+}\\|([^)]+)\\|/[^/]+/\\)+" nil t)
604 (delete-region (match-beginning 0) (match-end 0)))
605 ;; Remove tokens for Regexp search
606 (goto-char (point-min))
607 (while (re-search-forward "/[^/]+/" nil t)
608 (delete-region (match-beginning 0) (match-end 0)))
609 ;; Remove brackets, double quote, asterisk and operators
610 (goto-char (point-min))
611 (while (re-search-forward "\\([(){}\"*]\\|\\b\\(and\\|or\\)\\b\\)" nil t)
612 (delete-region (match-beginning 0) (match-end 0)))
613 ;; Collect all keywords
615 (goto-char (point-min))
616 (while (re-search-forward "[^
\e$B!!
\e(B \t\r\f\n]+" nil t)
617 (push (match-string 0) query))
619 (list (list (regexp-opt query)
620 0 0 'gnus-namazu-query-highlight-face)))))
622 (defun gnus-namazu/truncate-article-list (articles)
623 (let ((hit (length articles)))
624 (when (and gnus-large-newsgroup
625 (> hit gnus-large-newsgroup))
626 (let* ((cursor-in-echo-area nil)
627 (input (read-from-minibuffer
629 Too many articles were retrieved. How many articles (max %d): "
631 (cons (number-to-string gnus-large-newsgroup) 0))))
632 (unless (string-match "\\`[ \t]*\\'" input)
633 (setcdr (nthcdr (min (1- (string-to-number input)) hit) articles)
638 (defun gnus-namazu-search (groups query)
639 "Search QUERY through GROUPS with Namazu,
640 and make a virtual group contains its results."
643 (gnus-namazu/get-target-groups)
644 (gnus-namazu/read-query "Enter query: ")))
646 (let ((articles (gnus-namazu/search groups query)))
648 (let ((real-groups groups)
650 (apply (function format)
651 "nnvirtual:namazu-search?query=%s&groups=%s&id=%d%d%d"
653 (if groups (mapconcat 'identity groups ",") "ALL")
655 (gnus-namazu/truncate-article-list articles)
658 (add-to-list 'real-groups (gnus-namazu/article-group a))))
659 ;; Generate virtual group which includes all results.
660 (when (fboundp 'gnus-group-decoded-name)
662 (encode-coding-string vgroup gnus-namazu-coding-system)))
664 (gnus-group-read-ephemeral-group
667 (nnvirtual-component-groups ,real-groups)
668 (gnus-namazu-target-groups ,groups)
669 (gnus-namazu-current-query ,query))
670 t (cons (current-buffer) (current-window-configuration)) t))
671 (when gnus-namazu-query-highlight
672 (gnus-group-set-parameter vgroup 'highlight-words
673 (gnus-namazu/highlight-words query)))
674 ;; Generate new summary buffer which contains search results.
675 (gnus-group-read-group
677 (sort (delq nil ;; Ad-hoc fix, to avoid wrong-type-argument error.
680 (nnvirtual-reverse-map-article
681 (gnus-namazu/article-group a)
682 (gnus-namazu/article-number a)))
685 (message "No entry."))))
687 (defmacro gnus-namazu/lock-file-name (&optional directory)
688 `(expand-file-name "NMZ.lock2" ,directory))
690 (defmacro gnus-namazu/status-file-name (&optional directory)
691 `(expand-file-name "NMZ.status" ,directory))
693 (defmacro gnus-namazu/index-file-name (&optional directory)
694 `(expand-file-name "NMZ.i" ,directory))
696 (defun gnus-namazu/mknmz-cleanup (directory)
697 (let ((lockfile (gnus-namazu/lock-file-name directory)))
698 (when (file-exists-p lockfile)
699 (delete-file lockfile)
700 (dolist (tmpfile (directory-files directory t "\\`NMZ\\..*\\.tmp\\'" t))
701 (delete-file tmpfile)))))
704 (defun gnus-namazu-create-index (directory &optional target-directories force)
705 "Create index under DIRECTORY."
708 (if (and current-prefix-arg (> (length gnus-namazu-index-directories) 1))
709 (completing-read "Directory: "
710 (mapcar 'list gnus-namazu-index-directories) nil t)
711 (gnus-namazu/default-index-directory))
713 (setq directory (file-name-as-directory (expand-file-name directory)))
714 (unless target-directories
715 (setq target-directories
717 (mapcar (lambda (dir)
718 (when (file-directory-p dir) dir))
720 (mapcar 'gnus-namazu/server-directory
721 (gnus-namazu/indexed-servers))
723 (expand-file-name gnus-cache-directory)
724 (expand-file-name gnus-agent-directory)))))))
725 (if (file-exists-p (gnus-namazu/lock-file-name directory))
727 (error "Found lock file: %s" (gnus-namazu/lock-file-name directory)))
729 (get-buffer-create (concat " *mknmz*" directory))
731 (unless (file-directory-p directory)
732 (make-directory directory t))
733 (setq default-directory directory)
734 (let ((args (append gnus-namazu-make-index-arguments
735 target-directories)))
736 (insert "% " gnus-namazu-make-index-command " "
737 (mapconcat 'identity args " ") "\n")
738 (goto-char (point-max))
740 (pop-to-buffer (current-buffer)))
741 (message "Make index at %s..." directory)
743 (apply 'call-process gnus-namazu-make-index-command nil t t args)
744 (gnus-namazu/mknmz-cleanup directory))
745 (message "Make index at %s...done" directory)
747 (kill-buffer (current-buffer)))))))
749 (defun gnus-namazu/lapse-seconds (start end)
750 "Return lapse seconds from START to END.
751 START and END are lists which represent time in Emacs-style."
752 (+ (* (- (car end) (car start)) 65536)
756 (defun gnus-namazu/index-old-p (directory)
757 "Return non-nil value when the index under the DIRECTORY is older
758 than the period that is set to `gnus-namazu-index-update-interval'"
759 (let ((file (gnus-namazu/index-file-name directory)))
760 (or (not (file-exists-p file))
761 (and (integerp gnus-namazu-index-update-interval)
762 (>= (gnus-namazu/lapse-seconds
763 (nth 5 (file-attributes file))
765 gnus-namazu-index-update-interval)))))
767 (defvar gnus-namazu/update-directories nil)
768 (defvar gnus-namazu/update-process nil)
770 (defun gnus-namazu/update-p (directory &optional force)
771 "Return the DIRECTORY when the index undef the DIRECTORY should be updated."
772 (setq directory (file-name-as-directory (expand-file-name directory)))
773 (labels ((error-message (format &rest args)
774 (apply (if force 'error 'message) format args)
776 (if gnus-namazu/update-process
777 (error-message "%s" "Can not run two update processes simultaneously")
779 (gnus-namazu/index-old-p directory))
780 (let ((status-file (gnus-namazu/status-file-name directory)))
781 (or (file-exists-p status-file)
782 (error-message "Can not find status file: %s" status-file)))
783 (let ((lock-file (gnus-namazu/lock-file-name directory)))
784 (or (not (file-exists-p lock-file))
785 (error-message "Found lock file: %s" lock-file)))
789 (defun gnus-namazu-update-index (directory &optional force)
790 "Update the index under the DIRECTORY."
793 (if (and current-prefix-arg (> (length gnus-namazu-index-directories) 1))
794 (completing-read "Directory: "
795 (mapcar 'list gnus-namazu-index-directories) nil t)
796 (gnus-namazu/default-index-directory))
798 (when (setq directory (gnus-namazu/update-p directory force))
799 (with-current-buffer (get-buffer-create (concat " *mknmz*" directory))
801 (unless (file-directory-p directory)
802 (make-directory directory t))
803 (setq default-directory directory)
804 (let ((proc (start-process gnus-namazu-make-index-command
806 gnus-namazu-make-index-command
807 (format "--update=%s" directory))))
809 (prog1 (setq gnus-namazu/update-process proc)
810 (process-kill-without-query proc)
811 (set-process-sentinel proc 'gnus-namazu/update-sentinel)
812 (add-hook 'kill-emacs-hook 'gnus-namazu-stop-update)
813 (message "Update index at %s..." directory))
814 (kill-buffer (current-buffer))
816 (error "Can not start %s"
817 gnus-namazu-make-index-command)))))))
820 (defun gnus-namazu-update-all-indices (&optional directories force)
821 "Update all indices which is set to `gnus-namazu-index-directories'."
822 (interactive (list nil t))
823 (when (setq directories
825 (lambda (d) (gnus-namazu/update-p d force))
826 (or directories gnus-namazu-index-directories))))
827 (setq gnus-namazu/update-directories (cdr directories))
828 (gnus-namazu-update-index (car directories))))
830 (defun gnus-namazu/update-sentinel (process event)
831 (let ((buffer (process-buffer process)))
832 (when (buffer-name buffer)
833 (with-current-buffer buffer
834 (gnus-namazu/mknmz-cleanup default-directory)
835 (when (and (eq 'exit (process-status process))
836 (zerop (process-exit-status process)))
837 (message "Update index at %s...done" default-directory)))
838 (unless (or debug-on-error debug-on-quit)
839 (kill-buffer buffer))))
840 (setq gnus-namazu/update-process nil)
841 (when gnus-namazu/update-directories
842 (gnus-namazu-update-all-indices gnus-namazu/update-directories)))
845 (defun gnus-namazu-stop-update ()
846 "Stop the running indexer of Namazu."
848 (setq gnus-namazu/update-directories nil)
849 (and gnus-namazu/update-process
850 (processp gnus-namazu/update-process)
851 (kill-process gnus-namazu/update-process)))
853 (let (current-load-list)
854 (defadvice gnus-offer-save-summaries
855 (before gnus-namazu-kill-summary-buffers activate compile)
856 "Advised by `gnus-namazu'.
857 In order to avoid annoying questions, kill summary buffers which
858 generated by `gnus-namazu' itself before `gnus-offer-save-summaries'
860 (let ((buffers (buffer-list)))
862 (when (with-current-buffer (car buffers)
863 (and (eq major-mode 'gnus-summary-mode)
864 (gnus-ephemeral-group-p gnus-newsgroup-name)
865 (string-match gnus-namazu/group-name-regexp
866 gnus-newsgroup-name)))
867 (kill-buffer (car buffers)))
868 (setq buffers (cdr buffers))))))
871 (defun gnus-namazu-insinuate ()
873 'gnus-group-mode-hook
875 (define-key gnus-group-mode-map "\C-c\C-n" 'gnus-namazu-search)))
877 'gnus-summary-mode-hook
879 (define-key gnus-summary-mode-map "\C-c\C-n" 'gnus-namazu-search))))
881 (provide 'gnus-namazu)
883 ;; gnus-namazu.el ends here.