*** empty log message ***
[gnus] / lisp / nnbabyl.el
1 ;;; nnbabyl.el --- rmail mbox access for Gnus
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
5 ;;      Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Keywords: news, mail
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs 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)
13 ;; any later version.
14
15 ;; GNU Emacs 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.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; For an overview of what the interface functions do, please see the
28 ;; Gnus sources.  
29
30 ;;; Code:
31
32 (require 'nnheader)
33 (require 'rmail)
34 (require 'nnmail)
35
36 (defvar nnbabyl-mbox-file (expand-file-name "~/RMAIL")
37   "The name of the rmail box file in the users home directory.")
38
39 (defvar nnbabyl-active-file (expand-file-name "~/.rmail-active")
40   "The name of the active file for the rmail box.")
41
42 (defvar nnbabyl-get-new-mail t
43   "If non-nil, nnbabyl will check the incoming mail file and split the mail.")
44
45 (defvar nnbabyl-prepare-save-mail-hook nil
46   "Hook run narrowed to an article before saving.")
47
48 \f
49
50 (defvar nnbabyl-mail-delimiter "\^_")
51
52 (defconst nnbabyl-version "nnbabyl 1.0"
53   "nnbabyl version.")
54
55 (defvar nnbabyl-mbox-buffer nil)
56 (defvar nnbabyl-current-group nil)
57 (defvar nnbabyl-status-string "")
58 (defvar nnbabyl-group-alist nil)
59 (defvar nnbabyl-active-timestamp nil)
60
61 (defvar nnbabyl-previous-buffer-mode nil)
62
63 \f
64
65 (defvar nnbabyl-current-server nil)
66 (defvar nnbabyl-server-alist nil)
67 (defvar nnbabyl-server-variables 
68   (list
69    (list 'nnbabyl-mbox-file nnbabyl-mbox-file)
70    (list 'nnbabyl-active-file nnbabyl-active-file)
71    (list 'nnbabyl-get-new-mail nnbabyl-get-new-mail)
72    '(nnbabyl-current-group nil)
73    '(nnbabyl-status-string "")
74    '(nnbabyl-previous-buffer-mode nil)
75    '(nnbabyl-group-alist nil)))
76
77 \f
78
79 ;;; Interface functions
80
81 (defun nnbabyl-retrieve-headers (sequence &optional newsgroup server fetch-old)
82   (save-excursion
83     (set-buffer nntp-server-buffer)
84     (erase-buffer)
85     (let ((number (length sequence))
86           (count 0)
87           article art-string start stop)
88       (nnbabyl-possibly-change-newsgroup newsgroup)
89       (while sequence
90         (setq article (car sequence))
91         (setq art-string (nnbabyl-article-string article))
92         (set-buffer nnbabyl-mbox-buffer)
93         (if (or (search-forward art-string nil t)
94                 (search-backward art-string nil t))
95             (progn
96               (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
97               (while (and (not (looking-at ".+:"))
98                           (zerop (forward-line 1))))
99               (setq start (point))
100               (search-forward "\n\n" nil t)
101               (setq stop (1- (point)))
102               (set-buffer nntp-server-buffer)
103               (insert "221 " (int-to-string article) " Article retrieved.\n")
104               (insert-buffer-substring nnbabyl-mbox-buffer start stop)
105               (goto-char (point-max))
106               (insert ".\n")))
107         (setq sequence (cdr sequence))
108         (setq count (1+ count))
109         (and (numberp nnmail-large-newsgroup)
110              (> number nnmail-large-newsgroup)
111              (zerop (% count 20))
112              (nnheader-message 5 "nnbabyl: Receiving headers... %d%%"
113                                (/ (* count 100) number))))
114
115       (and (numberp nnmail-large-newsgroup)
116            (> number nnmail-large-newsgroup)
117            (nnheader-message 5 "nnbabyl: Receiving headers...done"))
118
119       (set-buffer nntp-server-buffer)
120       (nnheader-fold-continuation-lines)
121       'headers)))
122
123 (defun nnbabyl-open-server (server &optional defs)
124   (nnheader-init-server-buffer)
125   (if (equal server nnbabyl-current-server)
126       t
127     (if nnbabyl-current-server
128         (setq nnbabyl-server-alist 
129               (cons (list nnbabyl-current-server
130                           (nnheader-save-variables nnbabyl-server-variables))
131                     nnbabyl-server-alist)))
132     (let ((state (assoc server nnbabyl-server-alist)))
133       (if state 
134           (progn
135             (nnheader-restore-variables (nth 1 state))
136             (setq nnbabyl-server-alist (delq state nnbabyl-server-alist)))
137         (nnheader-set-init-variables nnbabyl-server-variables defs)))
138     (setq nnbabyl-current-server server)))
139
140 (defun nnbabyl-close-server (&optional server)
141   ;; Restore buffer mode.
142   (when (and (nnbabyl-server-opened)
143              nnbabyl-previous-buffer-mode)
144     (save-excursion
145       (set-buffer nnbabyl-mbox-buffer)
146       (narrow-to-region
147        (car (car nnbabyl-previous-buffer-mode))
148        (cdr (car nnbabyl-previous-buffer-mode)))
149       (funcall (cdr nnbabyl-previous-buffer-mode))))
150   (setq nnbabyl-current-server nil
151         nnbabyl-mbox-buffer nil)
152   t)
153
154 (defun nnbabyl-server-opened (&optional server)
155   (and (equal server nnbabyl-current-server)
156        nnbabyl-mbox-buffer
157        (buffer-name nnbabyl-mbox-buffer)
158        nntp-server-buffer
159        (buffer-name nntp-server-buffer)))
160
161 (defun nnbabyl-status-message (&optional server)
162   nnbabyl-status-string)
163
164 (defun nnbabyl-request-article (article &optional newsgroup server buffer)
165   (nnbabyl-possibly-change-newsgroup newsgroup)
166   (save-excursion
167     (set-buffer nnbabyl-mbox-buffer)
168     (goto-char (point-min))
169     (if (search-forward (nnbabyl-article-string article) nil t)
170         (let (start stop summary-line)
171           (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
172           (while (and (not (looking-at ".+:"))
173                       (zerop (forward-line 1))))
174           (setq start (point))
175           (or (and (re-search-forward 
176                     (concat "^" nnbabyl-mail-delimiter) nil t)
177                    (forward-line -1))
178               (goto-char (point-max)))
179           (setq stop (point))
180           (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
181             (set-buffer nntp-server-buffer)
182             (erase-buffer)
183             (insert-buffer-substring nnbabyl-mbox-buffer start stop)
184             (goto-char (point-min))
185             ;; If there is an EOOH header, then we have to remove some
186             ;; duplicated headers. 
187             (setq summary-line (looking-at "Summary-line:"))
188             (when (search-forward "\n*** EOOH ***" nil t)
189               (if summary-line
190                   ;; The headers to be deleted are located before the
191                   ;; EOOH line...
192                   (delete-region (point-min) (progn (forward-line 1)
193                   (point)))
194                 ;; ...or after.
195                 (delete-region (progn (beginning-of-line) (point))
196                                (or (search-forward "\n\n" nil t)
197                                    (point)))))
198             (if (numberp article) 
199                 (cons nnbabyl-current-group article)
200               (nnbabyl-article-group-number)))))))
201
202 (defun nnbabyl-request-group (group &optional server dont-check)
203   (let ((active (cadr (assoc group nnbabyl-group-alist))))
204     (save-excursion
205       (cond 
206        ((null active)
207         (nnheader-report 'nnbabyl "No such group: %s" group))
208        ((null (nnbabyl-possibly-change-newsgroup group))
209         (nnheader-report 'nnbabyl "No such group: %s" group))
210        (dont-check
211         (nnheader-report 'nnbabyl "Selected group %s" group)
212         t)
213        (t
214         (nnheader-report 'nnbabyl "Selected group %s" group)
215         (nnheader-insert "211 %d %d %d %s\n" 
216                          (1+ (- (cdr active) (car active)))
217                          (car active) (cdr active) group)
218         t)))))
219
220 (defun nnbabyl-request-scan (&optional group server)
221   (nnbabyl-read-mbox)
222   (nnmail-get-new-mail 
223    'nnbabyl 
224    (lambda ()
225      (save-excursion
226        (set-buffer nnbabyl-mbox-buffer)
227        (save-buffer)))
228    nnbabyl-mbox-file group
229    (lambda ()
230      (save-excursion
231        (let ((in-buf (current-buffer)))
232          (goto-char (point-min))
233          (while (search-forward "\n\^_\n" nil t)
234            (delete-char -1))
235          (set-buffer nnbabyl-mbox-buffer)
236          (goto-char (point-max))
237          (search-backward "\n\^_" nil t)
238          (goto-char (match-end 0))
239          (insert-buffer-substring in-buf))))))
240
241 (defun nnbabyl-close-group (group &optional server)
242   t)
243
244 (defun nnbabyl-request-create-group (group &optional server) 
245   (nnmail-activate 'nnbabyl)
246   (or (assoc group nnbabyl-group-alist)
247       (let (active)
248         (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 0)))
249                                         nnbabyl-group-alist))
250         (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))
251   t)
252
253 (defun nnbabyl-request-list (&optional server)
254   (save-excursion
255     (or (nnmail-find-file nnbabyl-active-file)
256         (progn
257           (setq nnbabyl-group-alist (nnmail-get-active))
258           (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
259           (nnmail-find-file nnbabyl-active-file)))))
260
261 (defun nnbabyl-request-newgroups (date &optional server)
262   (nnbabyl-request-list server))
263
264 (defun nnbabyl-request-list-newsgroups (&optional server)
265   (setq nnbabyl-status-string "nnbabyl: LIST NEWSGROUPS is not implemented.")
266   nil)
267
268 (defun nnbabyl-request-post (&optional server)
269   (mail-send-and-exit nil))
270
271 (defun nnbabyl-request-expire-articles
272   (articles newsgroup &optional server force)
273   (nnbabyl-possibly-change-newsgroup newsgroup)
274   (let* ((is-old t)
275          rest)
276     (nnmail-activate 'nnbabyl)
277
278     (save-excursion 
279       (set-buffer nnbabyl-mbox-buffer)
280       (set-text-properties (point-min) (point-max) nil)
281       (while (and articles is-old)
282         (goto-char (point-min))
283         (if (search-forward (nnbabyl-article-string (car articles)) nil t)
284             (if (setq is-old
285                       (nnmail-expired-article-p
286                        newsgroup
287                        (buffer-substring 
288                         (point) (progn (end-of-line) (point))) force))
289                 (progn
290                   (nnheader-message 5 "Deleting article %d in %s..." 
291                                     (car articles) newsgroup)
292                   (nnbabyl-delete-mail))
293               (setq rest (cons (car articles) rest))))
294         (setq articles (cdr articles)))
295       (save-buffer)
296       ;; Find the lowest active article in this group.
297       (let ((active (nth 1 (assoc newsgroup nnbabyl-group-alist))))
298         (goto-char (point-min))
299         (while (and (not (search-forward
300                           (nnbabyl-article-string (car active)) nil t))
301                     (<= (car active) (cdr active)))
302           (setcar active (1+ (car active)))
303           (goto-char (point-min))))
304       (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
305       (nconc rest articles))))
306
307 (defun nnbabyl-request-move-article 
308   (article group server accept-form &optional last)
309   (nnbabyl-possibly-change-newsgroup group)
310   (let ((buf (get-buffer-create " *nnbabyl move*"))
311         result)
312     (and 
313      (nnbabyl-request-article article group server)
314      (save-excursion
315        (set-buffer buf)
316        (insert-buffer-substring nntp-server-buffer)
317        (goto-char (point-min))
318        (if (re-search-forward 
319             "^X-Gnus-Newsgroup:" 
320             (save-excursion (search-forward "\n\n" nil t) (point)) t)
321            (delete-region (progn (beginning-of-line) (point))
322                           (progn (forward-line 1) (point))))
323        (setq result (eval accept-form))
324        (kill-buffer (current-buffer))
325        result)
326      (save-excursion
327        (set-buffer nnbabyl-mbox-buffer)
328        (goto-char (point-min))
329        (if (search-forward (nnbabyl-article-string article) nil t)
330            (nnbabyl-delete-mail))
331        (and last (save-buffer))))
332     result))
333
334 (defun nnbabyl-request-accept-article (group &optional last)
335   (let ((buf (current-buffer))
336         result beg)
337     (and 
338      (nnmail-activate 'nnbabyl)
339      (save-excursion
340        (goto-char (point-min))
341        (search-forward "\n\n" nil t)
342        (forward-line -1)
343        (save-excursion
344          (while (re-search-backward "^X-Gnus-Newsgroup: " beg t)
345            (delete-region (point) (progn (forward-line 1) (point)))))
346        (let ((nnmail-split-methods
347               (if (stringp group) (list (list group "")) 
348                 nnmail-split-methods)))
349          (setq result (car (nnbabyl-save-mail))))
350        (set-buffer nnbabyl-mbox-buffer)
351        (goto-char (point-max))
352        (search-backward "\n\^_")
353        (goto-char (match-end 0))
354        (insert-buffer-substring buf)
355        (and last (progn 
356                    (save-buffer)
357                    (nnmail-save-active
358                     nnbabyl-group-alist nnbabyl-active-file)))
359        result))))
360
361 (defun nnbabyl-request-replace-article (article group buffer)
362   (nnbabyl-possibly-change-newsgroup group)
363   (save-excursion
364     (set-buffer nnbabyl-mbox-buffer)
365     (goto-char (point-min))
366     (if (not (search-forward (nnbabyl-article-string article) nil t))
367         nil
368       (nnbabyl-delete-mail t t)
369       (insert-buffer-substring buffer)
370       (save-buffer)
371       t)))
372
373 (defun nnbabyl-request-delete-group (group &optional force server)
374   (nnbabyl-possibly-change-newsgroup group)
375   ;; Delete all articles in GROUP.
376   (if (not force)
377       ()                                ; Don't delete the articles.
378     (save-excursion
379       (set-buffer nnbabyl-mbox-buffer)
380       (goto-char (point-min))
381       ;; Delete all articles in this group.
382       (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
383             found)
384         (while (search-forward ident nil t)
385           (setq found t)
386           (nnbabyl-delete-mail))
387         (and found (save-buffer)))))
388   ;; Remove the group from all structures.
389   (setq nnbabyl-group-alist 
390         (delq (assoc group nnbabyl-group-alist) nnbabyl-group-alist)
391         nnbabyl-current-group nil)
392   ;; Save the active file.
393   (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
394   t)
395
396 (defun nnbabyl-request-rename-group (group new-name &optional server)
397   (nnbabyl-possibly-change-newsgroup group)
398   (save-excursion
399     (set-buffer nnbabyl-mbox-buffer)
400     (goto-char (point-min))
401     (let ((ident (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":"))
402           (new-ident (concat "\nX-Gnus-Newsgroup: " new-name ":"))
403           found)
404       (while (search-forward ident nil t)
405         (replace-match new-ident t t)
406         (setq found t))
407       (and found (save-buffer))))
408   (let ((entry (assoc group nnbabyl-group-alist)))
409     (and entry (setcar entry new-name))
410     (setq nnbabyl-current-group nil)
411     ;; Save the new group alist.
412     (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)
413     t))
414
415 \f
416 ;;; Internal functions.
417
418 ;; If FORCE, delete article no matter how many X-Gnus-Newsgroup
419 ;; headers there are. If LEAVE-DELIM, don't delete the Unix mbox
420 ;; delimiter line.
421 (defun nnbabyl-delete-mail (&optional force leave-delim)
422   ;; Delete the current X-Gnus-Newsgroup line.
423   (or force
424       (delete-region
425        (progn (beginning-of-line) (point))
426        (progn (forward-line 1) (point))))
427   ;; Beginning of the article.
428   (save-excursion
429     (save-restriction
430       (widen)
431       (narrow-to-region
432        (save-excursion
433          (re-search-backward (concat "^" nnbabyl-mail-delimiter) nil t)
434          (if leave-delim (progn (forward-line 1) (point))
435            (match-beginning 0)))
436        (progn
437          (forward-line 1)
438          (or (and (re-search-forward (concat "^" nnbabyl-mail-delimiter) 
439                                      nil t)
440                   (if (and (not (bobp)) leave-delim)
441                       (progn (forward-line -2) (point))
442                     (match-beginning 0)))
443              (point-max))))
444       (goto-char (point-min))
445       ;; Only delete the article if no other groups owns it as well.
446       (if (or force (not (re-search-forward "^X-Gnus-Newsgroup: " nil t)))
447           (delete-region (point-min) (point-max))))))
448
449 (defun nnbabyl-possibly-change-newsgroup (newsgroup)
450   (if (or (not nnbabyl-mbox-buffer)
451           (not (buffer-name nnbabyl-mbox-buffer)))
452       (save-excursion (nnbabyl-read-mbox)))
453   (or nnbabyl-group-alist
454       (nnmail-activate 'nnbabyl))
455   (if newsgroup
456       (if (assoc newsgroup nnbabyl-group-alist)
457           (setq nnbabyl-current-group newsgroup)
458         (setq nnbabyl-status-string "No such group in file")
459         nil)
460     t))
461
462 (defun nnbabyl-article-string (article)
463   (if (numberp article)
464       (concat "\nX-Gnus-Newsgroup: " nnbabyl-current-group ":" 
465               (int-to-string article) " ")
466     (concat "\nMessage-ID: " article)))
467
468 (defun nnbabyl-article-group-number ()
469   (save-excursion
470     (goto-char (point-min))
471     (and (re-search-forward "^X-Gnus-Newsgroup: +\\([^:]+\\):\\([0-9]+\\) "
472                             nil t)
473          (cons (buffer-substring (match-beginning 1) (match-end 1))
474                (string-to-int
475                 (buffer-substring (match-beginning 2) (match-end 2)))))))
476
477 (defun nnbabyl-insert-lines ()
478   "Insert how many lines and chars there are in the body of the mail."
479   (let (lines chars)
480     (save-excursion
481       (goto-char (point-min))
482       (if (search-forward "\n\n" nil t) 
483           (progn
484             ;; There may be an EOOH line here...
485             (if (looking-at "\\*\\*\\* EOOH \\*\\*\\*")
486                 (search-forward "\n\n" nil t))
487             (setq chars (- (point-max) (point)))
488             (setq lines (- (count-lines (point) (point-max)) 1))
489             ;; Move back to the end of the headers. 
490             (goto-char (point-min))
491             (search-forward "\n\n" nil t)
492             (forward-char -1)
493             (save-excursion
494               (if (re-search-backward "^Lines: " nil t)
495                   (delete-region (point) (progn (forward-line 1) (point)))))
496             (insert (format "Lines: %d\n" lines))
497             chars)))))
498
499 (defun nnbabyl-save-mail ()
500   ;; Called narrowed to an article.
501   (let ((group-art (nreverse (nnmail-article-group 'nnbabyl-active-number))))
502     (nnbabyl-insert-lines)
503     (nnmail-insert-xref group-art)
504     (nnbabyl-insert-newsgroup-line group-art)
505     (run-hooks 'nnbabyl-prepare-save-mail-hook)
506     group-art))
507
508 (defun nnbabyl-insert-newsgroup-line (group-art)
509   (save-excursion
510     (goto-char (point-min))
511     (while (looking-at "From ")
512       (replace-match "Mail-from: From " t t)
513       (forward-line 1))
514     ;; If there is a C-l at the beginning of the narrowed region, this
515     ;; isn't really a "save", but rather a "scan".
516     (goto-char (point-min))
517     (or (looking-at "\^L")
518         (save-excursion
519           (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
520           (goto-char (point-max))
521           (insert "\^_\n")))
522     (if (search-forward "\n\n" nil t)
523         (progn
524           (forward-char -1)
525           (while group-art
526             (insert (format "X-Gnus-Newsgroup: %s:%d   %s\n" 
527                             (car (car group-art)) (cdr (car group-art))
528                             (current-time-string)))
529             (setq group-art (cdr group-art)))))
530     t))
531
532 (defun nnbabyl-active-number (group)
533   ;; Find the next article number in GROUP.
534   (let ((active (car (cdr (assoc group nnbabyl-group-alist)))))
535     (if active
536         (setcdr active (1+ (cdr active)))
537       ;; This group is new, so we create a new entry for it.
538       ;; This might be a bit naughty... creating groups on the drop of
539       ;; a hat, but I don't know...
540       (setq nnbabyl-group-alist (cons (list group (setq active (cons 1 1)))
541                                       nnbabyl-group-alist)))
542     (cdr active)))
543
544 (defun nnbabyl-read-mbox ()
545   (nnmail-activate 'nnbabyl)
546   (or (file-exists-p nnbabyl-mbox-file)
547       (save-excursion
548         (set-buffer (setq nnbabyl-mbox-buffer
549                           (create-file-buffer nnbabyl-mbox-file)))
550         (setq buffer-file-name nnbabyl-mbox-file)
551         (insert "BABYL OPTIONS:\n\n\^_")
552         (write-region (point-min) (point-max) nnbabyl-mbox-file t 'nomesg)))
553
554   (if (and nnbabyl-mbox-buffer
555            (buffer-name nnbabyl-mbox-buffer)
556            (save-excursion
557              (set-buffer nnbabyl-mbox-buffer)
558              (= (buffer-size) (nth 7 (file-attributes nnbabyl-mbox-file)))))
559       ()
560     (save-excursion
561       (let ((delim (concat "^" nnbabyl-mail-delimiter))
562             start end)
563         (set-buffer (setq nnbabyl-mbox-buffer 
564                           (nnheader-find-file-noselect 
565                            nnbabyl-mbox-file nil 'raw)))
566         ;; Save buffer mode.
567         (setq nnbabyl-previous-buffer-mode 
568               (cons (cons (point-min) (point-max))
569                     major-mode))
570
571         (buffer-disable-undo (current-buffer))
572         (widen)
573         (setq buffer-read-only nil)
574         (fundamental-mode)
575         
576         (goto-char (point-min))
577         (re-search-forward delim nil t)
578         (setq start (match-end 0))
579         (while (re-search-forward delim nil t)
580           (setq end (match-end 0))
581           (or (search-backward "\nX-Gnus-Newsgroup: " start t)
582               (progn
583                 (goto-char end)
584                 (save-excursion
585                   (save-restriction
586                     (goto-char start)
587                     (narrow-to-region start end)
588                     (nnbabyl-save-mail)
589                     (setq end (point-max))))))
590           (goto-char (setq start end)))
591         (and (buffer-modified-p (current-buffer)) (save-buffer))
592         (nnmail-save-active nnbabyl-group-alist nnbabyl-active-file)))))
593
594 (defun nnbabyl-remove-incoming-delims ()
595   (goto-char (point-min))
596   (while (search-forward "\^_" nil t)
597     (replace-match "?" t t)))
598
599 (provide 'nnbabyl)
600
601 ;;; nnbabyl.el ends here