;;; gnus-namazu.el --- Search mail with Namazu.
-;; Copyright (C) 2000,2001 Tsuchiya Masatoshi <tsuchiya@namazu.org>
+;; Copyright (C) 2000,2001,2002 Tsuchiya Masatoshi <tsuchiya@namazu.org>
;; Author: Tsuchiya Masatoshi <tsuchiya@namazu.org>
;; Keywords: mail searching namazu
-;;; Copyright:
-
;; This file is a part of Semi-Gnus.
;; This program is free software; you can redistribute it and/or modify
;;; Commentary:
-;; This file defines the command to search mails with Namazu and
-;; browse its results with Gnus. This module requires the external
-;; command Namazu. Visit the following page for more information.
+;; This file defines the command to search mails and persistent
+;; articles with Namazu and browse its results with Gnus. This module
+;; requires the external command, Namazu. Visit the following page
+;; for more information.
;;
;; http://namazu.org/
;; Make index of articles with Namzu before using this module.
;;
;; % mkdir ~/News/namazu
-;; % mknmz -a -h -O ~/News/namazu ~/Mail
+;; % mknmz -a -h -O ~/News/namazu ~/Mail ~/News/cache
+;;
+;; The first command makes the directory for index files, and the
+;; second command generates index files of mails and persistent
+;; articles.
;;
;; When you put index files of Namazu into the directory other than
;; the default one (~/News/namazu), it is necessary to put this
:type 'boolean
:group 'gnus-namazu)
+(defcustom gnus-namazu-query-highlight t
+ "Non-nil means that queried words is highlighted."
+ :type 'boolean
+ :group 'gnus-namazu)
+
+(defface gnus-namazu-query-highlight-face
+ '((((type tty pc) (class color))
+ (:background "magenta4" :foreground "cyan1"))
+ (((class color) (background light))
+ (:background "magenta4" :foreground "lightskyblue1"))
+ (((class color) (background dark))
+ (:background "palevioletred2" :foreground "brown4"))
+ (t (:inverse-video t)))
+ "Face used for namazu query matching words."
+ :group 'gnus-namazu)
;;; Internal Variable:
(defvar gnus-namazu/group-alist nil
(or (cdr (assoc (downcase name) gnus-namazu/group-alist))
name))))
+(defun gnus-namazu/check-cache-group (str)
+ "Get the news group from the partial path STR of the cached article."
+ (if (gnus-use-long-file-name 'not-cache)
+ str
+ (catch 'found-group
+ (dolist (group (gnus-namazu/cache-group-candidates
+ (nnheader-replace-chars-in-string str ?/ ?.)))
+ (when (gnus-gethash group gnus-newsrc-hashtb)
+ (throw 'found-group group))))))
+
+(defun gnus-namazu/cache-group-candidates (str)
+ "Regard the string STR as the partial path of the cached article and
+generate possible group names from it."
+ (if (string-match "_\\(_\\(_\\)?\\)?" str)
+ (let ((prefix (substring str 0 (match-beginning 0)))
+ (suffix (substring str (match-end 0))))
+ (cond
+ ((match-beginning 2) ;; The number of discoverd underscores = 3
+ (nconc
+ (gnus-namazu/cache-group-candidates (concat prefix "/__" suffix))
+ (gnus-namazu/cache-group-candidates (concat prefix ".._" suffix))))
+ ((match-beginning 1) ;; The number of discoverd underscores = 2
+ (nconc
+ (gnus-namazu/cache-group-candidates (concat prefix "//" suffix))
+ (gnus-namazu/cache-group-candidates (concat prefix ".." suffix))))
+ (t ;; The number of discoverd underscores = 1
+ (gnus-namazu/cache-group-candidates (concat prefix "/" suffix)))))
+ (if (string-match "\\." str)
+ ;; Handle the first occurence of period.
+ (list (concat (substring str 0 (match-beginning 0))
+ ":"
+ (substring str (match-end 0)))
+ str)
+ (list str))))
+
(defun gnus-namazu/search (groups query)
(with-temp-buffer
(let ((exit-status (gnus-namazu/call-namazu query)))
(when (setq dir (gnus-namazu/server-directory s))
(cons (file-name-as-directory dir) s)))
(gnus-namazu/indexed-servers)))))
- (topdir-regexp (regexp-opt (mapcar 'car server-alist))))
+ (topdir-regexp (regexp-opt (mapcar 'car server-alist)))
+ (cache-regexp (concat
+ (regexp-quote
+ (file-name-as-directory
+ (expand-file-name gnus-cache-directory)))
+ "\\(.*\\)/\\([0-9]+\\)$")))
(gnus-namazu/normalize-results)
(goto-char (point-min))
(while (not (eobp))
(let (server group file)
- (and (looking-at topdir-regexp)
- ;; Check a discovered file is managed by Gnus servers.
- (setq file (buffer-substring-no-properties
- (match-end 0) (gnus-point-at-eol))
- server (cdr (assoc (match-string-no-properties 0)
- server-alist)))
- ;; Check validity of the file name.
- (string-match "/\\([0-9]+\\)\\'" file)
- (progn
- (setq group (substring file 0 (match-beginning 0))
- file (match-string 1 file))
- (setq group
- (gnus-namazu/group-prefixed-name
- (nnheader-replace-chars-in-string group ?/ ?.)
- server))
- (when (or (not groups)
- (member group groups))
- (push (gnus-namazu/make-article
- group (string-to-number file))
- articles)))))
+ (and (or
+ ;; Check the discoverd file is the persistent article.
+ (and (looking-at cache-regexp)
+ (setq file (match-string-no-properties 2)
+ group (gnus-namazu/check-cache-group
+ (match-string-no-properties 1))))
+ ;; Check the discovered file is managed by Gnus servers.
+ (and (looking-at topdir-regexp)
+ (setq file (buffer-substring-no-properties
+ (match-end 0) (gnus-point-at-eol))
+ server (cdr (assoc (match-string-no-properties 0)
+ server-alist)))
+ ;; Check validity of the file name.
+ (string-match "/\\([0-9]+\\)\\'" file)
+ (progn
+ (setq group (substring file 0 (match-beginning 0))
+ file (match-string 1 file))
+ (setq group
+ (gnus-namazu/group-prefixed-name
+ (nnheader-replace-chars-in-string group ?/ ?.)
+ server)))))
+ (or (not groups)
+ (member group groups))
+ (push (gnus-namazu/make-article group (string-to-number file))
+ articles)))
(forward-line 1))
(nreverse articles)))))
;; In Summary buffer.
(if current-prefix-arg
(list (gnus-read-group "Group: "))
- (if (and (gnus-ephemeral-group-p gnus-newsgroup-name)
- (string-match gnus-namazu/group-name-regexp gnus-newsgroup-name))
+ (if (and
+ (gnus-ephemeral-group-p gnus-newsgroup-name)
+ (string-match gnus-namazu/group-name-regexp gnus-newsgroup-name))
(cadr (assq 'gnus-namazu-target-groups
(gnus-info-method (gnus-get-info gnus-newsgroup-name))))
(list gnus-newsgroup-name))))))
(read-from-minibuffer prompt initial gnus-namazu/read-query-map nil
'gnus-namazu/read-query-history)))
+(defun gnus-namazu/highlight-words (query)
+ (let ((strings)
+ (start 0))
+ (while (string-match
+ "[ \t\r\f\n]*\\(\\(and\\|or\\|\\(not\\)\\)[ \t\r\f\n]+\\)?\
+\\(\\+[^ \t\r\f\n]+:\\)?\\(/\\([^/]+\\)/\\|\\(\"\\([^\"]+\\)\"\\|\
+{\\([^{}]+\\)}\\)\\|[^ \t\r\f\n]+\\)" query start)
+ (setq start (match-end 0))
+ (or (match-beginning 3) ; NOT search
+ (match-beginning 4) ; Field search
+ (match-beginning 6) ; Regular expression search
+ (if (match-beginning 7) ; Phrase search
+ (dolist (str (split-string
+ (if (match-beginning 8)
+ (match-string 8 query)
+ (match-string 9 query))))
+ (when (> (length str) 0)
+ (push str strings)))
+ (push (match-string 5 query) strings))))
+ (and strings
+ (list
+ (list
+ (regexp-opt (mapcar
+ (lambda (str)
+ (if (string-match "\\`\\*?\\([^\\*]*\\)\\*?\\'" str)
+ (match-string 1 str) str))
+ strings))
+ 0 0 'gnus-namazu-query-highlight-face)))))
+
(defun gnus-namazu/truncate-article-list (articles)
(let ((hit (length articles)))
(when (> hit gnus-large-newsgroup)
(gnus-namazu-target-groups ,groups)
(gnus-namazu-current-query ,query))
t (cons (current-buffer) (current-window-configuration)) t))
+ (when gnus-namazu-query-highlight
+ (gnus-group-set-parameter vgroup 'highlight-words
+ (gnus-namazu/highlight-words query)))
;; Generate new summary buffer which contains search results.
(gnus-group-read-group
t t vgroup
@menu
* Virtual Groups:: \e$B$?$/$5$s$N%0%k!<%W$N5-;v$r7k9g$9$k\e(B
* Kibozed Groups:: \e$B%K%e!<%9%9%W!<%k$NCf$+$i$N5-;v$r8!:w$9$k\e(B
+* Namazu Groups:: Namazu \e$B$r;H$C$F%a!<%k$N;3$+$i5-;v$r<h$j=P$9\e(B
@end menu
@node Virtual Groups
@code{nnkiboze} \e$B%0%k!<%WFb$N4{FI$H$J$C$?5-;v$O!"$=$N5-;v$N\e(B @sc{nov} \e$B9T\e(B
\e$B$,\e(B @sc{nov} \e$B%U%!%$%k$+$i:o=|$5$l$^$9!#\e(B
+@node Namazu Groups
+@subsection Namazu \e$B$r;H$C$F%a!<%k$N;3$+$i5-;v$r<h$j=P$9\e(B
+@cindex namazu
+
+\e$B%a!<%k$OF|!9Cy$^$C$F$$$/$P$+$j$G$9!#N.NL$NB?$$%a!<%j%s%0%j%9%H$r9XFI$7\e(B
+\e$B$F$$$k>l9g$K$O!"FC$K!#$G$b!"BgDq$N>l9g!"2ACM$"$k5-;v$O$4$/>/?t$G!"$=$N\e(B
+\e$B5-;v$rBgNL$N5-;v$N;3$+$i8+$D$1=P$9$N$O!"$H$F$b:$Fq$J$3$H$G$9!#\e(B
+
+\e$B$3$&$$$C$?$3$H$3$=!"%3%s%T%e!<%?$,$7$F$/$l$k$Y$-;E;v$G$9$h$M!#\e(BGnus \e$B$O!"\e(B
+Namazu \e$B$r;H$C$F!"%a!<%k$N;3$+$i$"$J$?$N9%$-$J%-!<%o!<%I$r4^$`5-;v$r8+\e(B
+\e$B$D$1=P$9J}K!$rDs6!$7$^$9!#\e(B
+
+\e$B:G=i$KHa$7$$$*CN$i$;$,$R$H$D!#\e(B@file{gnus-namazu.el} \e$B$O!"8=;~E@$G$O!"\e(B
+@code{nnml} \e$B%P%C%/%(%s%I$"$k$$$O\e(B @code{nnmh} \e$B%P%C%/%(%s%I$K$h$C$FJ]B8\e(B
+\e$B$5$l$F$$$k5-;v$H!"\e(B@code{gnus-cache-enter-article} \e$B$K$h$C$F1JB32=$5$l$?\e(B
+\e$B5-;v$7$+!"<h$j07$&$3$H$,$G$-$^$;$s!#\e(B@code{nnimap} \e$B%P%C%/%(%s%I$d\e(B
+@code{nnmbox} \e$B%P%C%/%(%s%I$r;H$C$F$$$k?M$O!"$4$a$s$J$5$$!#\e(B
+
+\e$B$=$l$G$O5$$r<h$jD>$7$F!"$^$:!"\e(BNamazu \e$B$r;H$($k$h$&$K$7$^$7$g$&!#>\$7$$\e(B
+\e$B$3$H$O!"<!$N%Z!<%8$GCN$k$3$H$,$G$-$^$9!#\e(B
+
+@example
+ @uref{http://namazu.org/}
+@end example
+
+\e$B<!$K!"$"$J$?$NHkB"$N%a!<%k$H1JB35-;v$N;3$N:w0z$r:n$j$^$9!#$=$N$?$a$K$O!"\e(B
+\e$B0J2<$N\e(B2\e$B$D$N%3%^%s%I$r<B9T$9$kI,MW$,$"$k$G$7$g$&!#\e(B
+
+@example
+ % mkdir ~/News/namazu
+ % mknmz -a -h -O ~/News/namazu ~/Mail ~/News/cache
+@end example
+
+\e$B$3$N%3%^%s%I$O!"\e(B(1) @file{~/News/namazu/} \e$B$H$$$&%G%#%l%/%H%j$r:n@.$9$k!"\e(B
+(2) \e$B$=$N%G%#%l%/%H%j$K\e(B @file{~/Mail/} \e$B0J2<$KJ]B8$5$l$F$$$k%a!<%k$H\e(B
+@file{~/News/cache/} \e$B0J2<$KJ]B8$5$l$F$$$k1JB35-;v$N:w0z$r:n@.$9$k!"$H\e(B
+\e$B$$$&0UL#$G$9!#\e(B
+
+\e$B$5$"!"$3$l$G=`Hw$,$G$-$^$7$?!#\e(B
+
+@kindex C-c C-n (\e$B%0%k!<%W\e(B)
+@kindex C-c C-n (\e$B35N,\e(B)
+@findex gnus-namazu-search
+\e$B%0%k!<%W%P%C%U%!$G\e(B@kbd{C-c C-n}\e$B$HF~NO$9$k$H!"8!:w<0$r?R$M$i$l$^$9$+$i!"\e(B
+\e$BE,Ev$JC18l$rF~NO$7$F$/$@$5$$!#Nc$($P\e(B:
+
+@example
+ @kbd{C-c C-n gnus namazu RET}
+@end example
+
+\e$B$3$&$9$k$H!"\e(Bgnus \e$B$H\e(B namazu \e$B$NAPJ}$N%-!<%o!<%I$rF1;~$K4^$`%a!<%k$rA4$F\e(B
+\e$BC5$7=P$7!"$=$l$i$N%a!<%k$+$i$J$k2>A[%0%k!<%W$r:n@.$7$^$9\e(B(@xref{Virtual
+Groups})\e$B!#\e(B
+
+@kbd{C-c C-n}\e$B$K$h$C$F8F$S=P$5$l$kL?Na\e(B @code{gnus-namazu-search} \e$B$O!"\e(B
+gnus \e$B$NDL>o$N?t;z@\F,<-$d!"%W%m%;%9@\F,<-$rM}2r$7$^$9!#$G$9$+$i!"$"$J\e(B
+\e$B$?$,!"$"$k%0%k!<%W$@$1$rBP>]$H$7$F8!:w$r<B9T$7$?$$$J$i$P!"$=$N%0%k!<%W\e(B
+\e$B$N9T$K0\F0$7$F!"<!$N$h$&$K8!:w$9$k$3$H$,$G$-$^$9!#\e(B
+
+@example
+ @kbd{M-1 C-c C-n namazu RET}
+@end example
+
+\e$B$^$?!"35N,%P%C%U%!$+$i!"$$$-$J$j8!:w$9$k$3$H$b$G$-$^$9!#$3$N>l9g!"8!:w\e(B
+\e$BBP>]$O!"<+F0E*$K$=$N%0%k!<%W$K8BDj$5$l$^$9!#Nc$($P!"$"$J$?$,$"$k%0%k!<\e(B
+\e$B%W$r1\MwCf$K!"$=$N%0%k!<%W$K$*$1$k<+J,$N2a5n$r?6$jJV$j$?$/$J$C$?$i!"<!\e(B
+\e$B$N$h$&$K$9$l$PNI$$$N$G$9!#\e(B
+
+@example
+ @kbd{C-c C-n +from:"Your E-Mail Address" RET}
+@end example
+
+\e$B:G8e$K!"\e(BNamazu \e$B$r$h$/J,$+$C$F$$$k?M$K$O!"ITMW$JCm0U$r0l$D!#\e(BNamazu \e$B$O!"\e(B
+\e$B;vA0$K:n@.$5$l$?:w0z$rMQ$$$F8!:w$r9T$$!":w0z$K$N$C$F$$$J$$%U%!%$%k$K$O\e(B
+\e$BL\$b$/$l$^$;$s!#$@$+$i!"Dj4|E*$K\e(B @code{mknmz} \e$B$r8F$S=P$7$F!"?7$?$J%a!<\e(B
+\e$B%k$N:w0z$rDI2C$7$J$$$H!"?7$7$$%a!<%k$O$$$D$^$G$?$C$F$b8!:w$5$l$J$$$3$H\e(B
+\e$B$K$J$j$^$9$+$i!"$"$7$+$i$:!#\e(B
+
@node Gnus Unplugged
@section Gnus \e$B$N@Z$jN%$7\e(B
@cindex offline