New directory
[bpt/emacs.git] / lisp / gnus / nnfolder.el
CommitLineData
eec82323 1;;; nnfolder.el --- mail folder access for Gnus
2c902422 2;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001
16409b0b 3;; Free Software Foundation, Inc.
eec82323
LMI
4
5;; Author: Scott Byer <byer@mv.us.adobe.com>
6748645f 6;; Lars Magne Ingebrigtsen <larsi@gnus.org>
eec82323
LMI
7;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8;; Keywords: mail
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
26
27;;; Commentary:
28
29;;; Code:
30
31(require 'nnheader)
32(require 'message)
33(require 'nnmail)
34(require 'nnoo)
6748645f 35(eval-when-compile (require 'cl))
eec82323 36(require 'gnus-util)
0d972486 37(require 'gnus-range)
eec82323
LMI
38
39(nnoo-declare nnfolder)
40
41(defvoo nnfolder-directory (expand-file-name message-directory)
42 "The name of the nnfolder directory.")
43
44(defvoo nnfolder-active-file
16409b0b 45 (nnheader-concat nnfolder-directory "active")
eec82323
LMI
46 "The name of the active file.")
47
48;; I renamed this variable to something more in keeping with the general GNU
49;; style. -SLB
50
51(defvoo nnfolder-ignore-active-file nil
dcf4ae73 52 "If non-nil, the active file is ignored.
16409b0b
GM
53This causes nnfolder to do some extra work in order to determine the
54true active ranges of an mbox file. Note that the active file is
dcf4ae73 55still saved, but its values are not used. This costs some extra time
16409b0b 56when scanning an mbox when opening it.")
eec82323
LMI
57
58(defvoo nnfolder-distrust-mbox nil
16409b0b
GM
59 "If non-nil, the folder will be distrusted.
60This means that nnfolder will not trust the user with respect to
61inserting unaccounted for mail in the middle of an mbox file. This
62can greatly slow down scans, which now must scan the entire file for
63unmarked messages. When nil, scans occur forward from the last marked
64message, a huge time saver for large mailboxes.")
eec82323
LMI
65
66(defvoo nnfolder-newsgroups-file
16409b0b 67 (concat (file-name-as-directory nnfolder-directory) "newsgroups")
eec82323
LMI
68 "Mail newsgroups description file.")
69
70(defvoo nnfolder-get-new-mail t
71 "If non-nil, nnfolder will check the incoming mail file and split the mail.")
72
73(defvoo nnfolder-prepare-save-mail-hook nil
74 "Hook run narrowed to an article before saving.")
75
76(defvoo nnfolder-save-buffer-hook nil
77 "Hook run before saving the nnfolder mbox buffer.")
78
79(defvoo nnfolder-inhibit-expiry nil
80 "If non-nil, inhibit expiry.")
81
82\f
83
84(defconst nnfolder-version "nnfolder 1.0"
85 "nnfolder version.")
86
87(defconst nnfolder-article-marker "X-Gnus-Article-Number: "
88 "String used to demarcate what the article number for a message is.")
89
90(defvoo nnfolder-current-group nil)
91(defvoo nnfolder-current-buffer nil)
92(defvoo nnfolder-status-string "")
93(defvoo nnfolder-group-alist nil)
94(defvoo nnfolder-buffer-alist nil)
95(defvoo nnfolder-scantime-alist nil)
96(defvoo nnfolder-active-timestamp nil)
16409b0b 97(defvoo nnfolder-active-file-coding-system mm-text-coding-system)
a1506d29 98(defvoo nnfolder-active-file-coding-system-for-write
16409b0b
GM
99 nnmail-active-file-coding-system)
100(defvoo nnfolder-file-coding-system mm-text-coding-system)
101(defvoo nnfolder-file-coding-system-for-write nnheader-file-coding-system
102 "Coding system for save nnfolder file.
f0529b5b 103If nil, `nnfolder-file-coding-system' is used.")
eec82323
LMI
104
105\f
106
107;;; Interface functions
108
109(nnoo-define-basics nnfolder)
110
111(deffoo nnfolder-retrieve-headers (articles &optional group server fetch-old)
112 (save-excursion
113 (set-buffer nntp-server-buffer)
114 (erase-buffer)
6748645f 115 (let (article start stop)
eec82323
LMI
116 (nnfolder-possibly-change-group group server)
117 (when nnfolder-current-buffer
118 (set-buffer nnfolder-current-buffer)
119 (goto-char (point-min))
120 (if (stringp (car articles))
121 'headers
6748645f 122 (while (setq article (pop articles))
eec82323 123 (set-buffer nnfolder-current-buffer)
6748645f 124 (when (nnfolder-goto-article article)
eec82323 125 (setq start (point))
16409b0b
GM
126 (setq stop (if (search-forward "\n\n" nil t)
127 (1- (point))
128 (point-max)))
eec82323
LMI
129 (set-buffer nntp-server-buffer)
130 (insert (format "221 %d Article retrieved.\n" article))
131 (insert-buffer-substring nnfolder-current-buffer start stop)
132 (goto-char (point-max))
6748645f 133 (insert ".\n")))
eec82323
LMI
134
135 (set-buffer nntp-server-buffer)
136 (nnheader-fold-continuation-lines)
137 'headers)))))
138
139(deffoo nnfolder-open-server (server &optional defs)
140 (nnoo-change-server 'nnfolder server defs)
141 (nnmail-activate 'nnfolder t)
142 (gnus-make-directory nnfolder-directory)
143 (cond
144 ((not (file-exists-p nnfolder-directory))
145 (nnfolder-close-server)
146 (nnheader-report 'nnfolder "Couldn't create directory: %s"
147 nnfolder-directory))
148 ((not (file-directory-p (file-truename nnfolder-directory)))
149 (nnfolder-close-server)
150 (nnheader-report 'nnfolder "Not a directory: %s" nnfolder-directory))
151 (t
152 (nnmail-activate 'nnfolder)
153 (nnheader-report 'nnfolder "Opened server %s using directory %s"
154 server nnfolder-directory)
155 t)))
156
157(deffoo nnfolder-request-close ()
158 (let ((alist nnfolder-buffer-alist))
159 (while alist
160 (nnfolder-close-group (caar alist) nil t)
161 (setq alist (cdr alist))))
162 (nnoo-close-server 'nnfolder)
163 (setq nnfolder-buffer-alist nil
164 nnfolder-group-alist nil))
165
166(deffoo nnfolder-request-article (article &optional group server buffer)
167 (nnfolder-possibly-change-group group server)
168 (save-excursion
169 (set-buffer nnfolder-current-buffer)
170 (goto-char (point-min))
6748645f 171 (when (nnfolder-goto-article article)
eec82323 172 (let (start stop)
eec82323
LMI
173 (setq start (point))
174 (forward-line 1)
175 (unless (and (nnmail-search-unix-mail-delim)
176 (forward-line -1))
177 (goto-char (point-max)))
178 (setq stop (point))
179 (let ((nntp-server-buffer (or buffer nntp-server-buffer)))
180 (set-buffer nntp-server-buffer)
181 (erase-buffer)
182 (insert-buffer-substring nnfolder-current-buffer start stop)
183 (goto-char (point-min))
184 (while (looking-at "From ")
185 (delete-char 5)
186 (insert "X-From-Line: ")
187 (forward-line 1))
188 (if (numberp article)
189 (cons nnfolder-current-group article)
190 (goto-char (point-min))
eec82323 191 (cons nnfolder-current-group
a1506d29 192 (if (search-forward (concat "\n" nnfolder-article-marker)
16409b0b
GM
193 nil t)
194 (string-to-int
195 (buffer-substring
196 (point) (progn (end-of-line) (point))))
197 -1))))))))
eec82323
LMI
198
199(deffoo nnfolder-request-group (group &optional server dont-check)
200 (nnfolder-possibly-change-group group server t)
201 (save-excursion
202 (if (not (assoc group nnfolder-group-alist))
203 (nnheader-report 'nnfolder "No such group: %s" group)
204 (if dont-check
205 (progn
206 (nnheader-report 'nnfolder "Selected group %s" group)
207 t)
208 (let* ((active (assoc group nnfolder-group-alist))
209 (group (car active))
210 (range (cadr active)))
211 (cond
212 ((null active)
213 (nnheader-report 'nnfolder "No such group: %s" group))
214 ((null nnfolder-current-group)
215 (nnheader-report 'nnfolder "Empty group: %s" group))
216 (t
217 (nnheader-report 'nnfolder "Selected group %s" group)
218 (nnheader-insert "211 %d %d %d %s\n"
219 (1+ (- (cdr range) (car range)))
220 (car range) (cdr range) group))))))))
221
222(deffoo nnfolder-request-scan (&optional group server)
223 (nnfolder-possibly-change-group nil server)
224 (when nnfolder-get-new-mail
225 (nnfolder-possibly-change-group group server)
226 (nnmail-get-new-mail
227 'nnfolder
228 (lambda ()
229 (let ((bufs nnfolder-buffer-alist))
230 (save-excursion
231 (while bufs
232 (if (not (gnus-buffer-live-p (nth 1 (car bufs))))
233 (setq nnfolder-buffer-alist
234 (delq (car bufs) nnfolder-buffer-alist))
235 (set-buffer (nth 1 (car bufs)))
236 (nnfolder-save-buffer)
237 (kill-buffer (current-buffer)))
238 (setq bufs (cdr bufs))))))
239 nnfolder-directory
240 group)))
241
242;; Don't close the buffer if we're not shutting down the server. This way,
243;; we can keep the buffer in the group buffer cache, and not have to grovel
244;; over the buffer again unless we add new mail to it or modify it in some
245;; way.
246
247(deffoo nnfolder-close-group (group &optional server force)
248 ;; Make sure we _had_ the group open.
249 (when (or (assoc group nnfolder-buffer-alist)
250 (equal group nnfolder-current-group))
251 (let ((inf (assoc group nnfolder-buffer-alist)))
252 (when inf
253 (when (and nnfolder-current-group
254 nnfolder-current-buffer)
255 (push (list nnfolder-current-group nnfolder-current-buffer)
256 nnfolder-buffer-alist))
257 (setq nnfolder-buffer-alist
258 (delq inf nnfolder-buffer-alist))
259 (setq nnfolder-current-buffer (cadr inf)
260 nnfolder-current-group (car inf))))
261 (when (and nnfolder-current-buffer
262 (buffer-name nnfolder-current-buffer))
263 (save-excursion
264 (set-buffer nnfolder-current-buffer)
265 ;; If the buffer was modified, write the file out now.
266 (nnfolder-save-buffer)
267 ;; If we're shutting the server down, we need to kill the
268 ;; buffer and remove it from the open buffer list. Or, of
269 ;; course, if we're trying to minimize our space impact.
270 (kill-buffer (current-buffer))
271 (setq nnfolder-buffer-alist (delq (assoc group nnfolder-buffer-alist)
272 nnfolder-buffer-alist)))))
273 (setq nnfolder-current-group nil
274 nnfolder-current-buffer nil)
275 t)
276
277(deffoo nnfolder-request-create-group (group &optional server args)
278 (nnfolder-possibly-change-group nil server)
279 (nnmail-activate 'nnfolder)
280 (when group
281 (unless (assoc group nnfolder-group-alist)
282 (push (list group (cons 1 0)) nnfolder-group-alist)
16409b0b 283 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
a8151ef7 284 (nnfolder-read-folder group)))
eec82323
LMI
285 t)
286
287(deffoo nnfolder-request-list (&optional server)
288 (nnfolder-possibly-change-group nil server)
289 (save-excursion
16409b0b 290 (let ((nnmail-file-coding-system nnfolder-active-file-coding-system))
58724016
KH
291 (nnmail-find-file nnfolder-active-file)
292 (setq nnfolder-group-alist (nnmail-get-active)))
eec82323
LMI
293 t))
294
295(deffoo nnfolder-request-newgroups (date &optional server)
296 (nnfolder-possibly-change-group nil server)
297 (nnfolder-request-list server))
298
299(deffoo nnfolder-request-list-newsgroups (&optional server)
300 (nnfolder-possibly-change-group nil server)
301 (save-excursion
16409b0b
GM
302 (let ((nnmail-file-coding-system nnfolder-file-coding-system))
303 (nnmail-find-file nnfolder-newsgroups-file))))
304
305;; Return a list consisting of all article numbers existing in the
306;; current folder.
307
308(defun nnfolder-existing-articles ()
309 (save-excursion
310 (when nnfolder-current-buffer
311 (set-buffer nnfolder-current-buffer)
312 (goto-char (point-min))
313 (let ((marker (concat "\n" nnfolder-article-marker))
314 (number "[0-9]+")
315 numbers)
a1506d29 316
16409b0b
GM
317 (while (and (search-forward marker nil t)
318 (re-search-forward number nil t))
319 (let ((newnum (string-to-number (match-string 0))))
320 (if (nnmail-within-headers-p)
321 (push newnum numbers))))
322 numbers))))
eec82323
LMI
323
324(deffoo nnfolder-request-expire-articles
16409b0b 325 (articles newsgroup &optional server force)
eec82323
LMI
326 (nnfolder-possibly-change-group newsgroup server)
327 (let* ((is-old t)
16409b0b
GM
328 ;; The articles we have deleted so far.
329 (deleted-articles nil)
330 ;; The articles that really exist and will
331 ;; be expired if they are old enough.
332 (maybe-expirable
333 (gnus-intersection articles (nnfolder-existing-articles))))
eec82323
LMI
334 (nnmail-activate 'nnfolder)
335
336 (save-excursion
337 (set-buffer nnfolder-current-buffer)
16409b0b
GM
338 ;; Since messages are sorted in arrival order and expired in the
339 ;; same order, we can stop as soon as we find a message that is
340 ;; too old.
341 (while (and maybe-expirable is-old)
eec82323 342 (goto-char (point-min))
16409b0b
GM
343 (when (and (nnfolder-goto-article (car maybe-expirable))
344 (search-forward (concat "\n" nnfolder-article-marker)
345 nil t))
346 (forward-sexp)
347 (when (setq is-old
348 (nnmail-expired-article-p
349 newsgroup
350 (buffer-substring
351 (point) (progn (end-of-line) (point)))
352 force nnfolder-inhibit-expiry))
0d972486
SZ
353 (unless (eq nnmail-expiry-target 'delete)
354 (with-temp-buffer
a1506d29 355 (nnfolder-request-article (car maybe-expirable)
0d972486
SZ
356 newsgroup server (current-buffer))
357 (let ((nnml-current-directory nil))
358 (nnmail-expiry-target-group
359 nnmail-expiry-target newsgroup))))
360 (nnheader-message 5 "Deleting article %d in %s..."
16409b0b
GM
361 (car maybe-expirable) newsgroup)
362 (nnfolder-delete-mail)
363 ;; Must remember which articles were actually deleted
364 (push (car maybe-expirable) deleted-articles)))
365 (setq maybe-expirable (cdr maybe-expirable)))
eec82323
LMI
366 (unless nnfolder-inhibit-expiry
367 (nnheader-message 5 "Deleting articles...done"))
368 (nnfolder-save-buffer)
369 (nnfolder-adjust-min-active newsgroup)
16409b0b
GM
370 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
371 (gnus-sorted-complement articles (nreverse deleted-articles)))))
eec82323 372
6748645f
LMI
373(deffoo nnfolder-request-move-article (article group server
374 accept-form &optional last)
375 (save-excursion
376 (let ((buf (get-buffer-create " *nnfolder move*"))
377 result)
378 (and
379 (nnfolder-request-article article group server)
380 (save-excursion
381 (set-buffer buf)
6748645f
LMI
382 (erase-buffer)
383 (insert-buffer-substring nntp-server-buffer)
384 (goto-char (point-min))
385 (while (re-search-forward
386 (concat "^" nnfolder-article-marker)
a1506d29 387 (save-excursion (and (search-forward "\n\n" nil t) (point)))
16409b0b 388 t)
6748645f
LMI
389 (delete-region (progn (beginning-of-line) (point))
390 (progn (forward-line 1) (point))))
391 (setq result (eval accept-form))
392 (kill-buffer buf)
393 result)
394 (save-excursion
395 (nnfolder-possibly-change-group group server)
396 (set-buffer nnfolder-current-buffer)
397 (goto-char (point-min))
398 (when (nnfolder-goto-article article)
399 (nnfolder-delete-mail))
400 (when last
401 (nnfolder-save-buffer)
402 (nnfolder-adjust-min-active group)
16409b0b 403 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file))))
6748645f 404 result)))
eec82323
LMI
405
406(deffoo nnfolder-request-accept-article (group &optional server last)
6748645f
LMI
407 (save-excursion
408 (nnfolder-possibly-change-group group server)
409 (nnmail-check-syntax)
410 (let ((buf (current-buffer))
411 result art-group)
412 (goto-char (point-min))
413 (when (looking-at "X-From-Line: ")
f9936da6
SZ
414 (replace-match "From ")
415 (while (progn (forward-line) (looking-at "[ \t]"))
416 (delete-char -1)))
6748645f
LMI
417 (and
418 (nnfolder-request-list)
eec82323 419 (save-excursion
6748645f
LMI
420 (set-buffer buf)
421 (goto-char (point-min))
16409b0b
GM
422 (if (search-forward "\n\n" nil t)
423 (forward-line -1)
424 (goto-char (point-max)))
6748645f
LMI
425 (while (re-search-backward (concat "^" nnfolder-article-marker) nil t)
426 (delete-region (point) (progn (forward-line 1) (point))))
eec82323 427 (when nnmail-cache-accepted-message-ids
6748645f
LMI
428 (nnmail-cache-insert (nnmail-fetch-field "message-id")))
429 (setq result (if (stringp group)
430 (list (cons group (nnfolder-active-number group)))
431 (setq art-group
432 (nnmail-article-group 'nnfolder-active-number))))
433 (if (and (null result)
434 (yes-or-no-p "Moved to `junk' group; delete article? "))
435 (setq result 'junk)
436 (setq result
437 (car (nnfolder-save-mail result)))))
438 (when last
439 (save-excursion
440 (nnfolder-possibly-change-folder (or (caar art-group) group))
441 (nnfolder-save-buffer)
442 (when nnmail-cache-accepted-message-ids
443 (nnmail-cache-close)))))
16409b0b 444 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
6748645f
LMI
445 (unless result
446 (nnheader-report 'nnfolder "Couldn't store article"))
447 result)))
eec82323
LMI
448
449(deffoo nnfolder-request-replace-article (article group buffer)
450 (nnfolder-possibly-change-group group)
451 (save-excursion
6748645f
LMI
452 (set-buffer buffer)
453 (goto-char (point-min))
454 (let (xfrom)
455 (while (re-search-forward "^X-From-Line: \\(.*\\)$" nil t)
456 (setq xfrom (match-string 1))
457 (gnus-delete-line))
458 (goto-char (point-min))
459 (if xfrom
460 (insert "From " xfrom "\n")
16409b0b 461 (unless (looking-at "From ")
6748645f
LMI
462 (insert "From nobody " (current-time-string) "\n"))))
463 (nnfolder-normalize-buffer)
eec82323
LMI
464 (set-buffer nnfolder-current-buffer)
465 (goto-char (point-min))
6748645f 466 (if (not (nnfolder-goto-article article))
eec82323 467 nil
6748645f 468 (nnfolder-delete-mail)
eec82323
LMI
469 (insert-buffer-substring buffer)
470 (nnfolder-save-buffer)
471 t)))
472
473(deffoo nnfolder-request-delete-group (group &optional force server)
474 (nnfolder-close-group group server t)
475 ;; Delete all articles in GROUP.
476 (if (not force)
477 () ; Don't delete the articles.
478 ;; Delete the file that holds the group.
479 (ignore-errors
480 (delete-file (nnfolder-group-pathname group))))
481 ;; Remove the group from all structures.
482 (setq nnfolder-group-alist
483 (delq (assoc group nnfolder-group-alist) nnfolder-group-alist)
484 nnfolder-current-group nil
485 nnfolder-current-buffer nil)
486 ;; Save the active file.
16409b0b 487 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
eec82323
LMI
488 t)
489
490(deffoo nnfolder-request-rename-group (group new-name &optional server)
491 (nnfolder-possibly-change-group group server)
492 (save-excursion
493 (set-buffer nnfolder-current-buffer)
494 (and (file-writable-p buffer-file-name)
495 (ignore-errors
496 (rename-file
497 buffer-file-name
16409b0b
GM
498 (let ((new-file (nnfolder-group-pathname new-name)))
499 (gnus-make-directory (file-name-directory new-file))
500 new-file))
eec82323
LMI
501 t)
502 ;; That went ok, so we change the internal structures.
503 (let ((entry (assoc group nnfolder-group-alist)))
504 (and entry (setcar entry new-name))
505 (setq nnfolder-current-buffer nil
506 nnfolder-current-group nil)
507 ;; Save the new group alist.
16409b0b 508 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
eec82323
LMI
509 ;; We kill the buffer instead of renaming it and stuff.
510 (kill-buffer (current-buffer))
511 t))))
512
a8151ef7
LMI
513(defun nnfolder-request-regenerate (server)
514 (nnfolder-possibly-change-group nil server)
515 (nnfolder-generate-active-file)
516 t)
517
eec82323
LMI
518\f
519;;; Internal functions.
520
521(defun nnfolder-adjust-min-active (group)
522 ;; Find the lowest active article in this group.
523 (let* ((active (cadr (assoc group nnfolder-group-alist)))
524 (marker (concat "\n" nnfolder-article-marker))
525 (number "[0-9]+")
526 (activemin (cdr active)))
527 (save-excursion
528 (set-buffer nnfolder-current-buffer)
529 (goto-char (point-min))
530 (while (and (search-forward marker nil t)
531 (re-search-forward number nil t))
6748645f
LMI
532 (let ((newnum (string-to-number (match-string 0))))
533 (if (nnmail-within-headers-p)
534 (setq activemin (min activemin newnum)))))
eec82323
LMI
535 (setcar active activemin))))
536
537(defun nnfolder-article-string (article)
538 (if (numberp article)
539 (concat "\n" nnfolder-article-marker (int-to-string article) " ")
540 (concat "\nMessage-ID: " article)))
541
6748645f
LMI
542(defun nnfolder-goto-article (article)
543 "Place point at the start of the headers of ARTICLE.
544ARTICLE can be an article number or a Message-ID.
545Returns t if successful, nil otherwise."
546 (let ((art-string (nnfolder-article-string article))
547 start found)
548 ;; It is likely that we are at or before the delimiter line.
549 ;; We therefore go to the end of the previous line, and start
550 ;; searching from there.
551 (beginning-of-line)
552 (unless (bobp)
553 (forward-char -1))
554 (setq start (point))
555 ;; First search forward.
556 (while (and (setq found (search-forward art-string nil t))
557 (not (nnmail-within-headers-p))))
558 ;; If unsuccessful, search backward from where we started,
559 (unless found
560 (goto-char start)
561 (while (and (setq found (search-backward art-string nil t))
562 (not (nnmail-within-headers-p)))))
563 (when found
564 (nnmail-search-unix-mail-delim-backward))))
565
566(defun nnfolder-delete-mail (&optional leave-delim)
567 "Delete the message that point is in.
568If optional argument LEAVE-DELIM is t, then mailbox delimiter is not
569deleted. Point is left where the deleted region was."
16409b0b
GM
570 (save-restriction
571 (narrow-to-region
572 (save-excursion
573 ;; In case point is at the beginning of the message already.
574 (forward-line 1)
575 (nnmail-search-unix-mail-delim-backward)
576 (if leave-delim (progn (forward-line 1) (point))
577 (point)))
578 (progn
579 (forward-line 1)
580 (if (nnmail-search-unix-mail-delim)
581 (point)
582 (point-max))))
583 (run-hooks 'nnfolder-delete-mail-hook)
584 (delete-region (point-min) (point-max))))
eec82323
LMI
585
586(defun nnfolder-possibly-change-group (group &optional server dont-check)
587 ;; Change servers.
588 (when (and server
589 (not (nnfolder-server-opened server)))
590 (nnfolder-open-server server))
591 (unless (gnus-buffer-live-p nnfolder-current-buffer)
592 (setq nnfolder-current-buffer nil
593 nnfolder-current-group nil))
594 ;; Change group.
595 (when (and group
596 (not (equal group nnfolder-current-group)))
16409b0b 597 (let ((file-name-coding-system nnmail-pathname-coding-system))
58724016
KH
598 (nnmail-activate 'nnfolder)
599 (when (and (not (assoc group nnfolder-group-alist))
600 (not (file-exists-p
601 (nnfolder-group-pathname group))))
602 ;; The group doesn't exist, so we create a new entry for it.
603 (push (list group (cons 1 0)) nnfolder-group-alist)
16409b0b 604 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file))
a8151ef7 605
58724016 606 (if dont-check
a8151ef7
LMI
607 (setq nnfolder-current-group group
608 nnfolder-current-buffer nil)
58724016
KH
609 (let (inf file)
610 ;; If we have to change groups, see if we don't already have the
611 ;; folder in memory. If we do, verify the modtime and destroy
612 ;; the folder if needed so we can rescan it.
a8151ef7
LMI
613 (setq nnfolder-current-buffer
614 (nth 1 (assoc group nnfolder-buffer-alist)))
615
58724016
KH
616 ;; If the buffer is not live, make sure it isn't in the alist. If it
617 ;; is live, verify that nobody else has touched the file since last
618 ;; time.
619 (when (and nnfolder-current-buffer
620 (not (gnus-buffer-live-p nnfolder-current-buffer)))
621 (setq nnfolder-buffer-alist (delq inf nnfolder-buffer-alist)
622 nnfolder-current-buffer nil))
a8151ef7 623
58724016 624 (setq nnfolder-current-group group)
a8151ef7 625
58724016 626 (when (or (not nnfolder-current-buffer)
6748645f
LMI
627 (not (verify-visited-file-modtime
628 nnfolder-current-buffer)))
58724016
KH
629 (save-excursion
630 (setq file (nnfolder-group-pathname group))
631 ;; See whether we need to create the new file.
632 (unless (file-exists-p file)
633 (gnus-make-directory (file-name-directory file))
a1506d29 634 (let ((nnmail-file-coding-system
16409b0b
GM
635 (or nnfolder-file-coding-system-for-write
636 nnfolder-file-coding-system-for-write)))
be1ad767
SM
637 (nnmail-write-region (point-min) (point-min)
638 file t 'nomesg)))
58724016
KH
639 (when (setq nnfolder-current-buffer (nnfolder-read-folder group))
640 (set-buffer nnfolder-current-buffer)
641 (push (list group nnfolder-current-buffer)
642 nnfolder-buffer-alist)))))))))
eec82323
LMI
643
644(defun nnfolder-save-mail (group-art-list)
645 "Called narrowed to an article."
646 (let* (save-list group-art)
647 (goto-char (point-min))
648 ;; The From line may have been quoted by movemail.
16409b0b 649 (when (looking-at ">From")
eec82323
LMI
650 (delete-char 1))
651 ;; This might come from somewhere else.
16409b0b 652 (unless (looking-at "From ")
eec82323
LMI
653 (insert "From nobody " (current-time-string) "\n")
654 (goto-char (point-min)))
6748645f 655 ;; Quote all "From " lines in the article.
16409b0b 656 (forward-line 1)
eec82323
LMI
657 (let (case-fold-search)
658 (while (re-search-forward "^From " nil t)
659 (beginning-of-line)
660 (insert "> ")))
661 (setq save-list group-art-list)
662 (nnmail-insert-lines)
663 (nnmail-insert-xref group-art-list)
664 (run-hooks 'nnmail-prepare-save-mail-hook)
665 (run-hooks 'nnfolder-prepare-save-mail-hook)
666
667 ;; Insert the mail into each of the destination groups.
668 (while (setq group-art (pop group-art-list))
669 ;; Kill any previous newsgroup markers.
670 (goto-char (point-min))
16409b0b
GM
671 (if (search-forward "\n\n" nil t)
672 (forward-line -1)
673 (goto-char (point-max)))
eec82323
LMI
674 (while (search-backward (concat "\n" nnfolder-article-marker) nil t)
675 (delete-region (1+ (point)) (progn (forward-line 2) (point))))
676
677 ;; Insert the new newsgroup marker.
678 (nnfolder-insert-newsgroup-line group-art)
679
680 (save-excursion
681 (let ((beg (point-min))
682 (end (point-max))
683 (obuf (current-buffer)))
684 (nnfolder-possibly-change-folder (car group-art))
685 (let ((buffer-read-only nil))
6748645f 686 (nnfolder-normalize-buffer)
eec82323
LMI
687 (insert-buffer-substring obuf beg end)))))
688
689 ;; Did we save it anywhere?
690 save-list))
691
6748645f
LMI
692(defun nnfolder-normalize-buffer ()
693 "Make sure there are two newlines at the end of the buffer."
694 (goto-char (point-max))
695 (skip-chars-backward "\n")
696 (delete-region (point) (point-max))
697 (insert "\n\n"))
698
eec82323
LMI
699(defun nnfolder-insert-newsgroup-line (group-art)
700 (save-excursion
701 (goto-char (point-min))
16409b0b
GM
702 (unless (search-forward "\n\n" nil t)
703 (goto-char (point-max))
704 (insert "\n"))
705 (forward-char -1)
706 (insert (format (concat nnfolder-article-marker "%d %s\n")
707 (cdr group-art) (current-time-string)))))
eec82323
LMI
708
709(defun nnfolder-active-number (group)
710 ;; Find the next article number in GROUP.
711 (let ((active (cadr (assoc group nnfolder-group-alist))))
712 (if active
713 (setcdr active (1+ (cdr active)))
714 ;; This group is new, so we create a new entry for it.
715 ;; This might be a bit naughty... creating groups on the drop of
716 ;; a hat, but I don't know...
717 (push (list group (setq active (cons 1 1)))
718 nnfolder-group-alist))
719 (cdr active)))
720
721(defun nnfolder-possibly-change-folder (group)
722 (let ((inf (assoc group nnfolder-buffer-alist)))
723 (if (and inf
724 (gnus-buffer-live-p (cadr inf)))
725 (set-buffer (cadr inf))
726 (when inf
727 (setq nnfolder-buffer-alist (delq inf nnfolder-buffer-alist)))
728 (when nnfolder-group-alist
16409b0b 729 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file))
eec82323
LMI
730 (push (list group (nnfolder-read-folder group))
731 nnfolder-buffer-alist))))
732
733;; This method has a problem if you've accidentally let the active list get
734;; out of sync with the files. This could happen, say, if you've
735;; accidentally gotten new mail with something other than Gnus (but why
736;; would _that_ ever happen? :-). In that case, we will be in the middle of
737;; processing the file, ready to add new X-Gnus article number markers, and
738;; we'll run across a message with no ID yet - the active list _may_not_ be
739;; ready for us yet.
740
741;; To handle this, I'm modifying this routine to maintain the maximum ID seen
742;; so far, and when we hit a message with no ID, we will _manually_ scan the
743;; rest of the message looking for any more, possibly higher IDs. We'll
744;; assume the maximum that we find is the highest active. Note that this
745;; shouldn't cost us much extra time at all, but will be a lot less
746;; vulnerable to glitches between the mbox and the active file.
747
748(defun nnfolder-read-folder (group)
749 (let* ((file (nnfolder-group-pathname group))
16409b0b 750 (buffer (set-buffer
a1506d29 751 (let ((nnheader-file-coding-system
16409b0b
GM
752 nnfolder-file-coding-system))
753 (nnheader-find-file-noselect file)))))
2c902422 754 (mm-enable-multibyte) ;; Use multibyte buffer for future copying.
eec82323
LMI
755 (if (equal (cadr (assoc group nnfolder-scantime-alist))
756 (nth 5 (file-attributes file)))
757 ;; This looks up-to-date, so we don't do any scanning.
6748645f
LMI
758 (if (file-exists-p file)
759 buffer
760 (push (list group buffer) nnfolder-buffer-alist)
761 (set-buffer-modified-p t)
16409b0b 762 (nnfolder-save-buffer))
eec82323
LMI
763 ;; Parse the damn thing.
764 (save-excursion
16409b0b
GM
765 (goto-char (point-min))
766 ;; Remove any blank lines at the start.
767 (while (eq (following-char) ?\n)
768 (delete-char 1))
eec82323
LMI
769 (nnmail-activate 'nnfolder)
770 ;; Read in the file.
16409b0b 771 (let ((delim "^From ")
eec82323
LMI
772 (marker (concat "\n" nnfolder-article-marker))
773 (number "[0-9]+")
774 (active (or (cadr (assoc group nnfolder-group-alist))
775 (cons 1 0)))
776 (scantime (assoc group nnfolder-scantime-alist))
777 (minid (lsh -1 -1))
778 maxid start end newscantime
779 buffer-read-only)
16409b0b 780 (buffer-disable-undo)
eec82323
LMI
781 (setq maxid (cdr active))
782 (goto-char (point-min))
783
784 ;; Anytime the active number is 1 or 0, it is suspect. In that
785 ;; case, search the file manually to find the active number. Or,
786 ;; of course, if we're being paranoid. (This would also be the
787 ;; place to build other lists from the header markers, such as
788 ;; expunge lists, etc., if we ever desired to abandon the active
789 ;; file entirely for mboxes.)
790 (when (or nnfolder-ignore-active-file
791 (< maxid 2))
792 (while (and (search-forward marker nil t)
793 (re-search-forward number nil t))
794 (let ((newnum (string-to-number (match-string 0))))
6748645f
LMI
795 (if (nnmail-within-headers-p)
796 (setq maxid (max maxid newnum)
797 minid (min minid newnum)))))
eec82323
LMI
798 (setcar active (max 1 (min minid maxid)))
799 (setcdr active (max maxid (cdr active)))
800 (goto-char (point-min)))
801
802 ;; As long as we trust that the user will only insert unmarked mail
803 ;; at the end, go to the end and search backwards for the last
804 ;; marker. Find the start of that message, and begin to search for
805 ;; unmarked messages from there.
806 (when (not (or nnfolder-distrust-mbox
807 (< maxid 2)))
808 (goto-char (point-max))
809 (unless (re-search-backward marker nil t)
810 (goto-char (point-min)))
811 (when (nnmail-search-unix-mail-delim)
812 (goto-char (point-min))))
813
814 ;; Keep track of the active number on our own, and insert it back
815 ;; into the active list when we're done. Also, prime the pump to
816 ;; cut down on the number of searches we do.
817 (unless (nnmail-search-unix-mail-delim)
818 (goto-char (point-max)))
819 (setq end (point-marker))
820 (while (not (= end (point-max)))
821 (setq start (marker-position end))
822 (goto-char end)
823 ;; There may be more than one "From " line, so we skip past
824 ;; them.
825 (while (looking-at delim)
826 (forward-line 1))
827 (set-marker end (if (nnmail-search-unix-mail-delim)
828 (point)
829 (point-max)))
830 (goto-char start)
831 (when (not (search-forward marker end t))
832 (narrow-to-region start end)
833 (nnmail-insert-lines)
834 (nnfolder-insert-newsgroup-line
835 (cons nil (nnfolder-active-number nnfolder-current-group)))
836 (widen)))
837
838 (set-marker end nil)
839 ;; Make absolutely sure that the active list reflects reality!
16409b0b 840 (nnfolder-save-active nnfolder-group-alist nnfolder-active-file)
eec82323
LMI
841 ;; Set the scantime for this group.
842 (setq newscantime (visited-file-modtime))
843 (if scantime
844 (setcdr scantime (list newscantime))
845 (push (list nnfolder-current-group newscantime)
846 nnfolder-scantime-alist))
847 (current-buffer))))))
848
849;;;###autoload
850(defun nnfolder-generate-active-file ()
16409b0b
GM
851 "Look for mbox folders in the nnfolder directory and make them into groups.
852This command does not work if you use short group names."
eec82323
LMI
853 (interactive)
854 (nnmail-activate 'nnfolder)
855 (let ((files (directory-files nnfolder-directory))
856 file)
857 (while (setq file (pop files))
858 (when (and (not (backup-file-name-p file))
859 (message-mail-file-mbox-p
860 (nnheader-concat nnfolder-directory file)))
861 (let ((oldgroup (assoc file nnfolder-group-alist)))
862 (if oldgroup
863 (nnheader-message 5 "Refreshing group %s..." file)
864 (nnheader-message 5 "Adding group %s..." file))
03378294
RS
865 (if oldgroup
866 (setq nnfolder-group-alist
867 (delq oldgroup (copy-sequence nnfolder-group-alist))))
eec82323
LMI
868 (push (list file (cons 1 0)) nnfolder-group-alist)
869 (nnfolder-possibly-change-folder file)
870 (nnfolder-possibly-change-group file)
871 (nnfolder-close-group file))))
6748645f 872 (nnheader-message 5 "")))
eec82323
LMI
873
874(defun nnfolder-group-pathname (group)
35ef97a5 875 "Make file name for GROUP."
16409b0b
GM
876 (setq group
877 (mm-encode-coding-string group nnmail-pathname-coding-system))
eec82323
LMI
878 (let ((dir (file-name-as-directory (expand-file-name nnfolder-directory))))
879 ;; If this file exists, we use it directly.
880 (if (or nnmail-use-long-file-names
881 (file-exists-p (concat dir group)))
882 (concat dir group)
883 ;; If not, we translate dots into slashes.
884 (concat dir (nnheader-replace-chars-in-string group ?. ?/)))))
885
886(defun nnfolder-save-buffer ()
887 "Save the buffer."
888 (when (buffer-modified-p)
889 (run-hooks 'nnfolder-save-buffer-hook)
a8151ef7 890 (gnus-make-directory (file-name-directory (buffer-file-name)))
a1506d29 891 (let ((coding-system-for-write
16409b0b
GM
892 (or nnfolder-file-coding-system-for-write
893 nnfolder-file-coding-system)))
894 (save-buffer))))
895
896(defun nnfolder-save-active (group-alist active-file)
897 (let ((nnmail-active-file-coding-system
898 (or nnfolder-active-file-coding-system-for-write
899 nnfolder-active-file-coding-system)))
900 (nnmail-save-active group-alist active-file)))
eec82323
LMI
901
902(provide 'nnfolder)
903
904;;; nnfolder.el ends here