cd453ff5d0032cb6610c335db10ae89b7f490cd9
[gnus] / lisp / nnmail.el
1 ;;; nnmail.el --- mail support functions for the Gnus mail backends
2 ;; Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; Keywords: news, mail
6
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (eval-when-compile (require 'cl))
29
30 (require 'nnheader)
31 (require 'message)
32 (require 'custom)
33 (require 'gnus-util)
34 (require 'mail-source)
35 (require 'mm-util)
36
37 (eval-and-compile
38   (autoload 'gnus-error "gnus-util")
39   (autoload 'gnus-buffer-live-p "gnus-util"))
40
41 (defgroup nnmail nil
42   "Reading mail with Gnus."
43   :group 'gnus)
44
45 (defgroup nnmail-retrieve nil
46   "Retrieving new mail."
47   :group 'nnmail)
48
49 (defgroup nnmail-prepare nil
50   "Preparing (or mangling) new mail after retrival."
51   :group 'nnmail)
52
53 (defgroup nnmail-duplicate nil
54   "Handling of duplicate mail messages."
55   :group 'nnmail)
56
57 (defgroup nnmail-split nil
58   "Organizing the incomming mail in folders."
59   :group 'nnmail)
60
61 (defgroup nnmail-files nil
62   "Mail files."
63   :group 'gnus-files
64   :group 'nnmail)
65
66 (defgroup nnmail-expire nil
67   "Expiring old mail."
68   :group 'nnmail)
69
70 (defgroup nnmail-procmail nil
71   "Interfacing with procmail and other mail agents."
72   :group 'nnmail)
73
74 (defgroup nnmail-various nil
75   "Various mail options."
76   :group 'nnmail)
77
78 (defcustom nnmail-split-methods
79   '(("mail.misc" ""))
80   "*Incoming mail will be split according to this variable.
81
82 If you'd like, for instance, one mail group for mail from the
83 \"4ad-l\" mailing list, one group for junk mail and one for everything
84 else, you could do something like this:
85
86  (setq nnmail-split-methods
87        '((\"mail.4ad\" \"From:.*4ad\")
88          (\"mail.junk\" \"From:.*Lars\\\\|Subject:.*buy\")
89          (\"mail.misc\" \"\")))
90
91 As you can see, this variable is a list of lists, where the first
92 element in each \"rule\" is the name of the group (which, by the way,
93 does not have to be called anything beginning with \"mail\",
94 \"yonka.zow\" is a fine, fine name), and the second is a regexp that
95 nnmail will try to match on the header to find a fit.
96
97 The second element can also be a function.  In that case, it will be
98 called narrowed to the headers with the first element of the rule as
99 the argument.  It should return a non-nil value if it thinks that the
100 mail belongs in that group.
101
102 The last element should always have \"\" as the regexp.
103
104 This variable can also have a function as its value."
105   :group 'nnmail-split
106   :type '(choice (repeat :tag "Alist" (group (string :tag "Name") regexp))
107                  (function-item nnmail-split-fancy)
108                  (function :tag "Other")))
109
110 ;; Suggested by Erik Selberg <speed@cs.washington.edu>.
111 (defcustom nnmail-crosspost t
112   "If non-nil, do crossposting if several split methods match the mail.
113 If nil, the first match found will be used."
114   :group 'nnmail-split
115   :type 'boolean)
116
117 ;; Added by gord@enci.ucalgary.ca (Gordon Matzigkeit).
118 (defcustom nnmail-keep-last-article nil
119   "If non-nil, nnmail will never delete/move a group's last article.
120 It can be marked expirable, so it will be deleted when it is no longer last.
121
122 You may need to set this variable if other programs are putting
123 new mail into folder numbers that Gnus has marked as expired."
124   :group 'nnmail-procmail
125   :group 'nnmail-various
126   :type 'boolean)
127
128 (defcustom nnmail-use-long-file-names nil
129   "If non-nil the mail backends will use long file and directory names.
130 If nil, groups like \"mail.misc\" will end up in directories like
131 \"mail/misc/\"."
132   :group 'nnmail-files
133   :type 'boolean)
134
135 (defcustom nnmail-default-file-modes 384
136   "Set the mode bits of all new mail files to this integer."
137   :group 'nnmail-files
138   :type 'integer)
139
140 (defcustom nnmail-expiry-wait 7
141   "*Expirable articles that are older than this will be expired.
142 This variable can either be a number (which will be interpreted as a
143 number of days) -- this doesn't have to be an integer.  This variable
144 can also be `immediate' and `never'."
145   :group 'nnmail-expire
146   :type '(choice (const immediate)
147                  (integer :tag "days")
148                  (const never)))
149
150 (defcustom nnmail-expiry-wait-function nil
151   "Variable that holds function to specify how old articles should be before they are expired.
152   The function will be called with the name of the group that the
153 expiry is to be performed in, and it should return an integer that
154 says how many days an article can be stored before it is considered
155 \"old\".  It can also return the values `never' and `immediate'.
156
157 Eg.:
158
159 \(setq nnmail-expiry-wait-function
160       (lambda (newsgroup)
161         (cond ((string-match \"private\" newsgroup) 31)
162               ((string-match \"junk\" newsgroup) 1)
163               ((string-match \"important\" newsgroup) 'never)
164               (t 7))))"
165   :group 'nnmail-expire
166   :type '(choice (const :tag "nnmail-expiry-wait" nil)
167                  (function :format "%v" nnmail-)))
168
169 (defcustom nnmail-cache-accepted-message-ids nil
170   "If non-nil, put Message-IDs of Gcc'd articles into the duplicate cache."
171   :group 'nnmail
172   :type 'boolean)
173
174 (defcustom nnmail-spool-file '((file))
175   "*Where the mail backends will look for incoming mail.
176 This variable is a list of mail source specifiers.
177 This variable is obsolete; `mail-sources' should be used instead."
178   :group 'nnmail-files
179   :type 'sexp)
180
181 (defcustom nnmail-resplit-incoming nil
182   "*If non-nil, re-split incoming procmail sorted mail."
183   :group 'nnmail-procmail
184   :type 'boolean)
185
186 (defcustom nnmail-delete-file-function 'delete-file
187   "Function called to delete files in some mail backends."
188   :group 'nnmail-files
189   :type 'function)
190
191 (defcustom nnmail-crosspost-link-function
192   (if (string-match "windows-nt\\|emx" (symbol-name system-type))
193       'copy-file
194     'add-name-to-file)
195   "*Function called to create a copy of a file.
196 This is `add-name-to-file' by default, which means that crossposts
197 will use hard links.  If your file system doesn't allow hard
198 links, you could set this variable to `copy-file' instead."
199   :group 'nnmail-files
200   :type '(radio (function-item add-name-to-file)
201                 (function-item copy-file)
202                 (function :tag "Other")))
203
204 (defcustom nnmail-read-incoming-hook
205   (if (eq system-type 'windows-nt)
206       '(nnheader-ms-strip-cr)
207     nil)
208   "*Hook that will be run after the incoming mail has been transferred.
209 The incoming mail is moved from `nnmail-spool-file' (which normally is
210 something like \"/usr/spool/mail/$user\") to the user's home
211 directory.  This hook is called after the incoming mail box has been
212 emptied, and can be used to call any mail box programs you have
213 running (\"xwatch\", etc.)
214
215 Eg.
216
217 \(add-hook 'nnmail-read-incoming-hook
218            (lambda ()
219              (start-process \"mailsend\" nil
220                             \"/local/bin/mailsend\" \"read\" \"mbox\")))
221
222 If you have xwatch running, this will alert it that mail has been
223 read.
224
225 If you use `display-time', you could use something like this:
226
227 \(add-hook 'nnmail-read-incoming-hook
228           (lambda ()
229             ;; Update the displayed time, since that will clear out
230             ;; the flag that says you have mail.
231             (when (eq (process-status \"display-time\") 'run)
232               (display-time-filter display-time-process \"\"))))"
233   :group 'nnmail-prepare
234   :type 'hook)
235
236 (defcustom nnmail-prepare-incoming-hook nil
237   "Hook called before treating incoming mail.
238 The hook is run in a buffer with all the new, incoming mail."
239   :group 'nnmail-prepare
240   :type 'hook)
241
242 (defcustom nnmail-prepare-incoming-header-hook nil
243   "Hook called narrowed to the headers of each message.
244 This can be used to remove excessive spaces (and stuff like
245 that) from the headers before splitting and saving the messages."
246   :group 'nnmail-prepare
247   :type 'hook)
248
249 (defcustom nnmail-prepare-incoming-message-hook nil
250   "Hook called narrowed to each message."
251   :group 'nnmail-prepare
252   :type 'hook)
253
254 (defcustom nnmail-list-identifiers nil
255   "Regexp that matches list identifiers to be removed.
256 This can also be a list of regexps."
257   :group 'nnmail-prepare
258   :type '(choice (const :tag "none" nil)
259                  (regexp :value ".*")
260                  (repeat :value (".*") regexp)))
261
262 (defcustom nnmail-pre-get-new-mail-hook nil
263   "Hook called just before starting to handle new incoming mail."
264   :group 'nnmail-retrieve
265   :type 'hook)
266
267 (defcustom nnmail-post-get-new-mail-hook nil
268   "Hook called just after finishing handling new incoming mail."
269   :group 'nnmail-retrieve
270   :type 'hook)
271
272 (defcustom nnmail-split-hook nil
273   "Hook called before deciding where to split an article.
274 The functions in this hook are free to modify the buffer
275 contents in any way they choose -- the buffer contents are
276 discarded after running the split process."
277   :group 'nnmail-split
278   :type 'hook)
279
280 (defcustom nnmail-large-newsgroup 50
281   "*The number of the articles which indicates a large newsgroup.
282 If the number of the articles is greater than the value, verbose
283 messages will be shown to indicate the current status."
284   :group 'nnmail-various
285   :type 'integer)
286
287 (defcustom nnmail-split-fancy "mail.misc"
288   "Incoming mail can be split according to this fancy variable.
289 To enable this, set `nnmail-split-methods' to `nnmail-split-fancy'.
290
291 The format of this variable is SPLIT, where SPLIT can be one of
292 the following:
293
294 GROUP: Mail will be stored in GROUP (a string).
295
296 \(FIELD VALUE SPLIT): If the message field FIELD (a regexp) contains
297   VALUE (a regexp), store the messages as specified by SPLIT.
298
299 \(| SPLIT...): Process each SPLIT expression until one of them matches.
300   A SPLIT expression is said to match if it will cause the mail
301   message to be stored in one or more groups.
302
303 \(& SPLIT...): Process each SPLIT expression.
304
305 \(: FUNCTION optional args): Call FUNCTION with the optional args, in
306   the buffer containing the message headers.  The return value FUNCTION
307   should be a split, which is then recursively processed.
308
309 FIELD must match a complete field name.  VALUE must match a complete
310 word according to the `nnmail-split-fancy-syntax-table' syntax table.
311 You can use \".*\" in the regexps to match partial field names or words.
312
313 FIELD and VALUE can also be lisp symbols, in that case they are expanded
314 as specified in `nnmail-split-abbrev-alist'.
315
316 GROUP can contain \\& and \\N which will substitute from matching
317 \\(\\) patterns in the previous VALUE.
318
319 Example:
320
321 \(setq nnmail-split-methods 'nnmail-split-fancy
322       nnmail-split-fancy
323       ;; Messages from the mailer daemon are not crossposted to any of
324       ;; the ordinary groups.  Warnings are put in a separate group
325       ;; from real errors.
326       '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
327                           \"mail.misc\"))
328           ;; Non-error messages are crossposted to all relevant
329           ;; groups, but we don't crosspost between the group for the
330           ;; (ding) list and the group for other (ding) related mail.
331           (& (| (any \"ding@ifi\\\\.uio\\\\.no\" \"ding.list\")
332                 (\"subject\" \"ding\" \"ding.misc\"))
333              ;; Other mailing lists...
334              (any \"procmail@informatik\\\\.rwth-aachen\\\\.de\" \"procmail.list\")
335              (any \"SmartList@informatik\\\\.rwth-aachen\\\\.de\" \"SmartList.list\")
336              ;; People...
337              (any \"larsi@ifi\\\\.uio\\\\.no\" \"people.Lars Magne Ingebrigtsen\"))
338           ;; Unmatched mail goes to the catch all group.
339           \"misc.misc\"))"
340   :group 'nnmail-split
341   ;; Sigh!
342   :type 'sexp)
343
344 (defcustom nnmail-split-abbrev-alist
345   '((any . "from\\|to\\|cc\\|sender\\|apparently-to\\|resent-from\\|resent-to\\|resent-cc")
346     (mail . "mailer-daemon\\|postmaster\\|uucp")
347     (to . "to\\|cc\\|apparently-to\\|resent-to\\|resent-cc")
348     (from . "from\\|sender\\|resent-from")
349     (nato . "to\\|cc\\|resent-to\\|resent-cc")
350     (naany . "from\\|to\\|cc\\|sender\\|resent-from\\|resent-to\\|resent-cc"))
351   "*Alist of abbreviations allowed in `nnmail-split-fancy'."
352   :group 'nnmail-split
353   :type '(repeat (cons :format "%v" symbol regexp)))
354
355 (defcustom nnmail-message-id-cache-length 1000
356   "*The approximate number of Message-IDs nnmail will keep in its cache.
357 If this variable is nil, no checking on duplicate messages will be
358 performed."
359   :group 'nnmail-duplicate
360   :type '(choice (const :tag "disable" nil)
361                  (integer :format "%v")))
362
363 (defcustom nnmail-message-id-cache-file "~/.nnmail-cache"
364   "*The file name of the nnmail Message-ID cache."
365   :group 'nnmail-duplicate
366   :group 'nnmail-files
367   :type 'file)
368
369 (defcustom nnmail-treat-duplicates 'warn
370   "*If non-nil, nnmail keep a cache of Message-IDs to discover mail duplicates.
371 Three values are valid: nil, which means that nnmail is not to keep a
372 Message-ID cache; `warn', which means that nnmail should insert extra
373 headers to warn the user about the duplication (this is the default);
374 and `delete', which means that nnmail will delete duplicated mails.
375
376 This variable can also be a function.  It will be called from a buffer
377 narrowed to the article in question with the Message-ID as a
378 parameter.  It should return nil, `warn' or `delete'."
379   :group 'nnmail-duplicate
380   :type '(choice (const :tag "off" nil)
381                  (const warn)
382                  (const delete)))
383
384 (defcustom nnmail-extra-headers nil
385   "*Extra headers to parse."
386   :group 'nnmail
387   :type '(repeat symbol))
388
389 (defcustom nnmail-split-header-length-limit 512
390   "Header lines longer than this limit are excluded from the split function."
391   :group 'nnmail
392   :type 'integer)
393
394 ;;; Internal variables.
395
396 (defvar nnmail-split-history nil
397   "List of group/article elements that say where the previous split put messages.")
398
399 (defvar nnmail-split-fancy-syntax-table nil
400   "Syntax table used by `nnmail-split-fancy'.")
401 (unless (syntax-table-p nnmail-split-fancy-syntax-table)
402   (setq nnmail-split-fancy-syntax-table
403         (copy-syntax-table (standard-syntax-table)))
404   ;; support the %-hack
405   (modify-syntax-entry ?\% "." nnmail-split-fancy-syntax-table))
406
407 (defvar nnmail-prepare-save-mail-hook nil
408   "Hook called before saving mail.")
409
410 (defvar nnmail-split-tracing nil)
411 (defvar nnmail-split-trace nil)
412
413 \f
414
415 (defconst nnmail-version "nnmail 1.0"
416   "nnmail version.")
417
418 \f
419
420 (defun nnmail-request-post (&optional server)
421   (mail-send-and-exit nil))
422
423 (defvar nnmail-file-coding-system 'binary
424   "Coding system used in nnmail.")
425
426 (defvar nnmail-file-coding-system-1
427   (if (string-match "nt" system-configuration)
428       'raw-text-dos 'binary)
429   "Another coding system used in nnmail.")
430
431 (defvar nnmail-incoming-coding-system
432   mm-text-coding-system
433   "Coding system used in reading inbox")
434
435 (defun nnmail-find-file (file)
436   "Insert FILE in server buffer safely."
437   (set-buffer nntp-server-buffer)
438   (delete-region (point-min) (point-max))
439   (let ((format-alist nil)
440         (after-insert-file-functions nil))
441     (condition-case ()
442         (let ((coding-system-for-read nnmail-file-coding-system)
443               (auto-mode-alist (nnheader-auto-mode-alist))
444               (pathname-coding-system nnmail-file-coding-system))
445           (insert-file-contents file)
446           t)
447       (file-error nil))))
448
449 (defvar nnmail-pathname-coding-system 'binary
450   "*Coding system for pathname.")
451
452 (defun nnmail-group-pathname (group dir &optional file)
453   "Make pathname for GROUP."
454   (concat
455    (let ((dir (file-name-as-directory (expand-file-name dir))))
456      (setq group (nnheader-translate-file-chars group))
457      ;; If this directory exists, we use it directly.
458      (if (or nnmail-use-long-file-names
459              (file-directory-p (concat dir group)))
460          (concat dir group "/")
461        ;; If not, we translate dots into slashes.
462        (concat dir
463                (mm-encode-coding-string
464                 (nnheader-replace-chars-in-string group ?. ?/)
465                 nnmail-pathname-coding-system)
466                "/")))
467    (or file "")))
468
469 (defun nnmail-get-active ()
470   "Returns an assoc of group names and active ranges.
471 nn*-request-list should have been called before calling this function."
472   (let (group-assoc)
473     ;; Go through all groups from the active list.
474     (save-excursion
475       (set-buffer nntp-server-buffer)
476       (goto-char (point-min))
477       (while (re-search-forward
478               "^\\([^ \t]+\\)[ \t]+\\([0-9]+\\)[ \t]+\\([0-9]+\\)" nil t)
479         ;; We create an alist with `(GROUP (LOW . HIGH))' elements.
480         (push (list (match-string 1)
481                     (cons (string-to-int (match-string 3))
482                           (string-to-int (match-string 2))))
483               group-assoc)))
484     group-assoc))
485
486 (defvar nnmail-active-file-coding-system 'binary
487   "*Coding system for active file.")
488
489 (defun nnmail-save-active (group-assoc file-name)
490   "Save GROUP-ASSOC in ACTIVE-FILE."
491   (let ((coding-system-for-write nnmail-active-file-coding-system))
492     (when file-name
493       (with-temp-file file-name
494         (nnmail-generate-active group-assoc)))))
495
496 (defun nnmail-generate-active (alist)
497   "Generate an active file from group-alist ALIST."
498   (erase-buffer)
499   (let (group)
500     (while (setq group (pop alist))
501       (insert (format "%s %d %d y\n" (car group) (cdadr group)
502                       (caadr group))))))
503
504 (defun nnmail-get-split-group (file source)
505   "Find out whether this FILE is to be split into GROUP only.
506 If SOURCE is a directory spec, try to return the group name component."
507   (if (eq (car source) 'directory)
508       (let ((file (file-name-nondirectory file)))
509         (mail-source-bind (directory source)
510           (if (string-match (concat (regexp-quote suffix) "$") file)
511               (substring file 0 (match-beginning 0))
512             nil)))
513     nil))
514
515 (defun nnmail-process-babyl-mail-format (func artnum-func)
516   (let ((case-fold-search t)
517         start message-id content-length do-search end)
518     (while (not (eobp))
519       (goto-char (point-min))
520       (re-search-forward
521        "\f\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
522       (goto-char (match-end 0))
523       (delete-region (match-beginning 0) (match-end 0))
524       (narrow-to-region
525        (setq start (point))
526        (progn
527          ;; Skip all the headers in case there are more "From "s...
528          (or (search-forward "\n\n" nil t)
529              (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
530              (search-forward "\1f\f"))
531          (point)))
532       ;; Unquote the ">From " line, if any.
533       (goto-char (point-min))
534       (when (looking-at ">From ")
535         (replace-match "X-From-Line: ") )
536       (run-hooks 'nnmail-prepare-incoming-header-hook)
537       (goto-char (point-max))
538       ;; Find the Message-ID header.
539       (save-excursion
540         (if (re-search-backward
541              "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]*>\\)" nil t)
542             (setq message-id (buffer-substring (match-beginning 1)
543                                                (match-end 1)))
544           ;; There is no Message-ID here, so we create one.
545           (save-excursion
546             (when (re-search-backward "^Message-ID[ \t]*:" nil t)
547               (beginning-of-line)
548               (insert "Original-")))
549           (forward-line -1)
550           (insert "Message-ID: " (setq message-id (nnmail-message-id))
551                   "\n")))
552       ;; Look for a Content-Length header.
553       (if (not (save-excursion
554                  (and (re-search-backward
555                        "^Content-Length:[ \t]*\\([0-9]+\\)" start t)
556                       (setq content-length (string-to-int
557                                             (buffer-substring
558                                              (match-beginning 1)
559                                              (match-end 1))))
560                       ;; We destroy the header, since none of
561                       ;; the backends ever use it, and we do not
562                       ;; want to confuse other mailers by having
563                       ;; a (possibly) faulty header.
564                       (progn (insert "X-") t))))
565           (setq do-search t)
566         (widen)
567         (if (or (= (+ (point) content-length) (point-max))
568                 (save-excursion
569                   (goto-char (+ (point) content-length))
570                   (looking-at "\1f")))
571             (progn
572               (goto-char (+ (point) content-length))
573               (setq do-search nil))
574           (setq do-search t)))
575       (widen)
576       ;; Go to the beginning of the next article - or to the end
577       ;; of the buffer.
578       (when do-search
579         (if (re-search-forward "^\1f" nil t)
580             (goto-char (match-beginning 0))
581           (goto-char (1- (point-max)))))
582       (delete-char 1)                   ; delete ^_
583       (save-excursion
584         (save-restriction
585           (narrow-to-region start (point))
586           (goto-char (point-min))
587           (nnmail-check-duplication message-id func artnum-func)
588           (setq end (point-max))))
589       (goto-char end))))
590
591 (defsubst nnmail-search-unix-mail-delim ()
592   "Put point at the beginning of the next Unix mbox message."
593   ;; Algorithm used to find the the next article in the
594   ;; brain-dead Unix mbox format:
595   ;;
596   ;; 1) Search for "^From ".
597   ;; 2) If we find it, then see whether the previous
598   ;;    line is blank and the next line looks like a header.
599   ;; Then it's possible that this is a mail delim, and we use it.
600   (let ((case-fold-search nil)
601         found)
602     (while (not found)
603       (if (not (re-search-forward "^From " nil t))
604           (setq found 'no)
605         (save-excursion
606           (beginning-of-line)
607           (when (and (or (bobp)
608                          (save-excursion
609                            (forward-line -1)
610                            (eq (char-after) ?\n)))
611                      (save-excursion
612                        (forward-line 1)
613                        (while (looking-at ">From \\|From ")
614                          (forward-line 1))
615                        (looking-at "[^ \n\t:]+[ \n\t]*:")))
616             (setq found 'yes)))))
617     (beginning-of-line)
618     (eq found 'yes)))
619
620 (defun nnmail-search-unix-mail-delim-backward ()
621   "Put point at the beginning of the current Unix mbox message."
622   ;; Algorithm used to find the the next article in the
623   ;; brain-dead Unix mbox format:
624   ;;
625   ;; 1) Search for "^From ".
626   ;; 2) If we find it, then see whether the previous
627   ;;    line is blank and the next line looks like a header.
628   ;; Then it's possible that this is a mail delim, and we use it.
629   (let ((case-fold-search nil)
630         found)
631     (while (not found)
632       (if (not (re-search-backward "^From " nil t))
633           (setq found 'no)
634         (save-excursion
635           (beginning-of-line)
636           (when (and (or (bobp)
637                          (save-excursion
638                            (forward-line -1)
639                            (eq (char-after) ?\n)))
640                      (save-excursion
641                        (forward-line 1)
642                        (while (looking-at ">From \\|From ")
643                          (forward-line 1))
644                        (looking-at "[^ \n\t:]+[ \n\t]*:")))
645             (setq found 'yes)))))
646     (beginning-of-line)
647     (eq found 'yes)))
648
649 (defun nnmail-process-unix-mail-format (func artnum-func)
650   (let ((case-fold-search t)
651         start message-id content-length end skip head-end)
652     (goto-char (point-min))
653     (if (not (and (re-search-forward "^From " nil t)
654                   (goto-char (match-beginning 0))))
655         ;; Possibly wrong format?
656         (error "Error, unknown mail format! (Possibly corrupted.)")
657       ;; Carry on until the bitter end.
658       (while (not (eobp))
659         (setq start (point)
660               end nil)
661         ;; Find the end of the head.
662         (narrow-to-region
663          start
664          (if (search-forward "\n\n" nil t)
665              (1- (point))
666            ;; This will never happen, but just to be on the safe side --
667            ;; if there is no head-body delimiter, we search a bit manually.
668            (while (and (looking-at "From \\|[^ \t]+:")
669                        (not (eobp)))
670              (forward-line 1))
671            (point)))
672         ;; Find the Message-ID header.
673         (goto-char (point-min))
674         (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
675             (setq message-id (match-string 1))
676           (save-excursion
677             (when (re-search-forward "^Message-ID[ \t]*:" nil t)
678               (beginning-of-line)
679               (insert "Original-")))
680           ;; There is no Message-ID here, so we create one.
681           (forward-line 1)
682           (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
683         ;; Look for a Content-Length header.
684         (goto-char (point-min))
685         (if (not (re-search-forward
686                   "^Content-Length:[ \t]*\\([0-9]+\\)" nil t))
687             (setq content-length nil)
688           (setq content-length (string-to-int (match-string 1)))
689           ;; We destroy the header, since none of the backends ever
690           ;; use it, and we do not want to confuse other mailers by
691           ;; having a (possibly) faulty header.
692           (beginning-of-line)
693           (insert "X-"))
694         (run-hooks 'nnmail-prepare-incoming-header-hook)
695         ;; Find the end of this article.
696         (goto-char (point-max))
697         (widen)
698         (setq head-end (point))
699         ;; We try the Content-Length value.  The idea: skip over the header
700         ;; separator, then check what happens content-length bytes into the
701         ;; message body.  This should be either the end ot the buffer, the
702         ;; message separator or a blank line followed by the separator.
703         ;; The blank line should probably be deleted.  If neither of the
704         ;; three is met, the content-length header is probably invalid.
705         (when content-length
706           (forward-line 1)
707           (setq skip (+ (point) content-length))
708           (goto-char skip)
709           (cond ((or (= skip (point-max))
710                      (= (1+ skip) (point-max)))
711                  (setq end (point-max)))
712                 ((looking-at "From ")
713                  (setq end skip))
714                 ((looking-at "[ \t]*\n\\(From \\)")
715                  (setq end (match-beginning 1)))
716                 (t (setq end nil))))
717         (if end
718             (goto-char end)
719           ;; No Content-Length, so we find the beginning of the next
720           ;; article or the end of the buffer.
721           (goto-char head-end)
722           (or (nnmail-search-unix-mail-delim)
723               (goto-char (point-max))))
724         ;; Allow the backend to save the article.
725         (save-excursion
726           (save-restriction
727             (narrow-to-region start (point))
728             (goto-char (point-min))
729             (nnmail-check-duplication message-id func artnum-func)
730             (setq end (point-max))))
731         (goto-char end)))))
732
733 (defun nnmail-process-mmdf-mail-format (func artnum-func)
734   (let ((delim "^\^A\^A\^A\^A$")
735         (case-fold-search t)
736         start message-id end)
737     (goto-char (point-min))
738     (if (not (and (re-search-forward delim nil t)
739                   (forward-line 1)))
740         ;; Possibly wrong format?
741         (error "Error, unknown mail format! (Possibly corrupted.)")
742       ;; Carry on until the bitter end.
743       (while (not (eobp))
744         (setq start (point))
745         ;; Find the end of the head.
746         (narrow-to-region
747          start
748          (if (search-forward "\n\n" nil t)
749              (1- (point))
750            ;; This will never happen, but just to be on the safe side --
751            ;; if there is no head-body delimiter, we search a bit manually.
752            (while (and (looking-at "From \\|[^ \t]+:")
753                        (not (eobp)))
754              (forward-line 1))
755            (point)))
756         ;; Find the Message-ID header.
757         (goto-char (point-min))
758         (if (re-search-forward "^Message-ID[ \t]*:[ \n\t]*\\(<[^>]+>\\)" nil t)
759             (setq message-id (match-string 1))
760           ;; There is no Message-ID here, so we create one.
761           (save-excursion
762             (when (re-search-backward "^Message-ID[ \t]*:" nil t)
763               (beginning-of-line)
764               (insert "Original-")))
765           (forward-line 1)
766           (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
767         (run-hooks 'nnmail-prepare-incoming-header-hook)
768         ;; Find the end of this article.
769         (goto-char (point-max))
770         (widen)
771         (if (re-search-forward delim nil t)
772             (beginning-of-line)
773           (goto-char (point-max)))
774         ;; Allow the backend to save the article.
775         (save-excursion
776           (save-restriction
777             (narrow-to-region start (point))
778             (goto-char (point-min))
779             (nnmail-check-duplication message-id func artnum-func)
780             (setq end (point-max))))
781         (goto-char end)
782         (forward-line 2)))))
783
784 (defun nnmail-process-maildir-mail-format (func artnum-func)
785 ; In a maildir, every file contains exactly one mail
786   (let ((case-fold-search t)
787         message-id)
788     (goto-char (point-min))
789     ;; Find the end of the head.
790     (narrow-to-region
791      (point-min)
792      (if (search-forward "\n\n" nil t)
793          (1- (point))
794        ;; This will never happen, but just to be on the safe side --
795        ;; if there is no head-body delimiter, we search a bit manually.
796        (while (and (looking-at "From \\|[^ \t]+:")
797                    (not (eobp)))
798          (forward-line 1)
799          (point))))
800     ;; Find the Message-ID header.
801     (goto-char (point-min))
802     (if (re-search-forward "^Message-ID:[ \t]*\\(<[^>]+>\\)" nil t)
803         (setq message-id (match-string 1))
804       ;; There is no Message-ID here, so we create one.
805       (save-excursion
806             (when (re-search-backward "^Message-ID[ \t]*:" nil t)
807           (beginning-of-line)
808           (insert "Original-")))
809       (forward-line 1)
810       (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
811     (run-hooks 'nnmail-prepare-incoming-header-hook)
812     ;; Allow the backend to save the article.
813     (widen)
814     (save-excursion
815         (goto-char (point-min))
816         (nnmail-check-duplication message-id func artnum-func))))
817
818 (defun nnmail-split-incoming (incoming func &optional exit-func
819                                        group artnum-func)
820   "Go through the entire INCOMING file and pick out each individual mail.
821 FUNC will be called with the buffer narrowed to each mail."
822   (let (;; If this is a group-specific split, we bind the split
823         ;; methods to just this group.
824         (nnmail-split-methods (if (and group
825                                        (not nnmail-resplit-incoming))
826                                   (list (list group ""))
827                                 nnmail-split-methods)))
828     (save-excursion
829       ;; Insert the incoming file.
830       (set-buffer (get-buffer-create " *nnmail incoming*"))
831       (erase-buffer)
832       (let ((nnheader-file-coding-system nnmail-incoming-coding-system))
833         (nnheader-insert-file-contents incoming))
834       (unless (zerop (buffer-size))
835         (goto-char (point-min))
836         (save-excursion (run-hooks 'nnmail-prepare-incoming-hook))
837         ;; Handle both babyl, MMDF and unix mail formats, since movemail will
838         ;; use the former when fetching from a mailbox, the latter when
839         ;; fetching from a file.
840         (cond ((or (looking-at "\^L")
841                    (looking-at "BABYL OPTIONS:"))
842                (nnmail-process-babyl-mail-format func artnum-func))
843               ((looking-at "\^A\^A\^A\^A")
844                (nnmail-process-mmdf-mail-format func artnum-func))
845               ((looking-at "Return-Path:")
846                (nnmail-process-maildir-mail-format func artnum-func))
847               (t
848                (nnmail-process-unix-mail-format func artnum-func))))
849       (when exit-func
850         (funcall exit-func))
851       (kill-buffer (current-buffer)))))
852
853 (defun nnmail-article-group (func &optional trace)
854   "Look at the headers and return an alist of groups that match.
855 FUNC will be called with the group name to determine the article number."
856   (let ((methods nnmail-split-methods)
857         (obuf (current-buffer))
858         (beg (point-min))
859         end group-art method grp)
860     (if (and (sequencep methods)
861              (= (length methods) 1))
862         ;; If there is only just one group to put everything in, we
863         ;; just return a list with just this one method in.
864         (setq group-art
865               (list (cons (caar methods) (funcall func (caar methods)))))
866       ;; We do actual comparison.
867       (save-excursion
868         ;; Find headers.
869         (goto-char beg)
870         (setq end (if (search-forward "\n\n" nil t) (point) (point-max)))
871         (set-buffer nntp-server-buffer)
872         (erase-buffer)
873         ;; Copy the headers into the work buffer.
874         (insert-buffer-substring obuf beg end)
875         ;; Fold continuation lines.
876         (goto-char (point-min))
877         (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
878           (replace-match " " t t))
879         ;; Nuke pathologically long headers.  Since Gnus applies
880         ;; pathologically complex regexps to the buffer, lines
881         ;; that are looong will take longer than the Universe's
882         ;; existence to process.
883         (goto-char (point-min))
884         (while (not (eobp))
885           (unless (< (move-to-column nnmail-split-header-length-limit)
886                      nnmail-split-header-length-limit)
887             (delete-region (point) (progn (end-of-line) (point))))
888           (forward-line 1))
889         ;; Allow washing.
890         (goto-char (point-min))
891         (run-hooks 'nnmail-split-hook)
892         (when (setq nnmail-split-tracing trace)
893           (setq nnmail-split-trace nil))
894         (if (and (symbolp nnmail-split-methods)
895                  (fboundp nnmail-split-methods))
896             (let ((split
897                    (condition-case nil
898                        ;; `nnmail-split-methods' is a function, so we
899                        ;; just call this function here and use the
900                        ;; result.
901                        (or (funcall nnmail-split-methods)
902                            '("bogus"))
903                      (error
904                       (nnheader-message 5
905                        "Error in `nnmail-split-methods'; using `bogus' mail group")
906                       (sit-for 1)
907                       '("bogus")))))
908               (setq split (gnus-remove-duplicates split))
909               ;; The article may be "cross-posted" to `junk'.  What
910               ;; to do?  Just remove the `junk' spec.  Don't really
911               ;; see anything else to do...
912               (let (elem)
913                 (while (setq elem (car (memq 'junk split)))
914                   (setq split (delq elem split))))
915               (when split
916                 (setq group-art
917                       (mapcar
918                        (lambda (group) (cons group (funcall func group)))
919                        split))))
920           ;; Go through the split methods to find a match.
921           (while (and methods
922                       (or nnmail-crosspost
923                           (not group-art)))
924             (goto-char (point-max))
925             (setq method (pop methods)
926                   grp (car method))
927             (if (or methods
928                     (not (equal "" (nth 1 method))))
929                 (when (and
930                        (ignore-errors
931                          (if (stringp (nth 1 method))
932                              (let ((expand (string-match "\\\\[0-9&]" grp))
933                                    (pos (re-search-backward (cadr method)
934                                                             nil t)))
935                                (and expand
936                                     (setq grp (nnmail-expand-newtext grp)))
937                                pos)
938                            ;; Function to say whether this is a match.
939                            (funcall (nth 1 method) grp)))
940                        ;; Don't enter the article into the same
941                        ;; group twice.
942                        (not (assoc grp group-art)))
943                   (push (cons grp (funcall func grp))
944                         group-art))
945               ;; This is the final group, which is used as a
946               ;; catch-all.
947               (unless group-art
948                 (setq group-art
949                       (list (cons (car method)
950                                   (funcall func (car method)))))))))
951         ;; Produce a trace if non-empty.
952         (when (and trace nnmail-split-trace)
953           (let ((trace (nreverse nnmail-split-trace))
954                 (restore (current-buffer)))
955             (nnheader-set-temp-buffer "*Split Trace*")
956             (gnus-add-buffer)
957             (while trace
958               (insert (car trace) "\n")
959               (setq trace (cdr trace)))
960             (goto-char (point-min))
961             (gnus-configure-windows 'split-trace)
962             (set-buffer restore)))
963         ;; See whether the split methods returned `junk'.
964         (if (equal group-art '(junk))
965             nil
966           ;; The article may be "cross-posted" to `junk'.  What
967           ;; to do?  Just remove the `junk' spec.  Don't really
968           ;; see anything else to do...
969           (let (elem)
970             (while (setq elem (car (memq 'junk group-art)))
971               (setq group-art (delq elem group-art)))
972             (nreverse group-art)))))))
973
974 (defun nnmail-insert-lines ()
975   "Insert how many lines there are in the body of the mail.
976 Return the number of characters in the body."
977   (let (lines chars)
978     (save-excursion
979       (goto-char (point-min))
980       (when (search-forward "\n\n" nil t)
981         (setq chars (- (point-max) (point)))
982         (setq lines (count-lines (point) (point-max)))
983         (forward-char -1)
984         (save-excursion
985           (when (re-search-backward "^Lines: " nil t)
986             (delete-region (point) (progn (forward-line 1) (point)))))
987         (beginning-of-line)
988         (insert (format "Lines: %d\n" (max lines 0)))
989         chars))))
990
991 (defun nnmail-insert-xref (group-alist)
992   "Insert an Xref line based on the (group . article) alist."
993   (save-excursion
994     (goto-char (point-min))
995     (when (search-forward "\n\n" nil t)
996       (forward-char -1)
997       (when (re-search-backward "^Xref: " nil t)
998         (delete-region (match-beginning 0)
999                        (progn (forward-line 1) (point))))
1000       (insert (format "Xref: %s" (system-name)))
1001       (while group-alist
1002         (insert (format " %s:%d"
1003                         (mm-encode-coding-string
1004                          (caar group-alist)
1005                          nnmail-pathname-coding-system)
1006                         (cdar group-alist)))
1007         (setq group-alist (cdr group-alist)))
1008       (insert "\n"))))
1009
1010 ;;; Message washing functions
1011
1012 (defun nnmail-remove-leading-whitespace ()
1013   "Remove excessive whitespace from all headers."
1014   (goto-char (point-min))
1015   (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
1016     (replace-match "\\1" t)))
1017
1018 (defun nnmail-remove-list-identifiers ()
1019   "Remove list identifiers from Subject headers."
1020   (let ((regexp (if (stringp nnmail-list-identifiers) nnmail-list-identifiers
1021                   (mapconcat 'identity nnmail-list-identifiers "\\|"))))
1022     (when regexp
1023       (goto-char (point-min))
1024       (when (re-search-forward
1025              (concat "^Subject: +\\(Re: +\\)?\\(" regexp "\\) *")
1026              nil t)
1027         (delete-region (match-beginning 2) (match-end 0))))))
1028
1029 (defun nnmail-remove-tabs ()
1030   "Translate TAB characters into SPACE characters."
1031   (subst-char-in-region (point-min) (point-max) ?\t ?  t))
1032
1033 (defun nnmail-fix-eudora-headers ()
1034   "Eudora has a broken References line, but an OK In-Reply-To."
1035   (goto-char (point-min))
1036   (when (re-search-forward "^X-Mailer:.*Eudora" nil t)
1037     (goto-char (point-min))
1038     (when (re-search-forward "^References:" nil t)
1039       (beginning-of-line)
1040       (insert "X-Gnus-Broken-Eudora-"))))
1041
1042 (custom-add-option 'nnmail-prepare-incoming-header-hook
1043                    'nnmail-fix-eudora-headers)
1044
1045 ;;; Utility functions
1046
1047 (defun nnmail-split-fancy ()
1048   "Fancy splitting method.
1049 See the documentation for the variable `nnmail-split-fancy' for documentation."
1050   (let ((syntab (syntax-table)))
1051     (unwind-protect
1052         (progn
1053           (set-syntax-table nnmail-split-fancy-syntax-table)
1054           (nnmail-split-it nnmail-split-fancy))
1055       (set-syntax-table syntab))))
1056
1057 (defvar nnmail-split-cache nil)
1058 ;; Alist of split expressions their equivalent regexps.
1059
1060 (defun nnmail-split-it (split)
1061   ;; Return a list of groups matching SPLIT.
1062   (let (cached-pair)
1063     (cond
1064      ;; nil split
1065      ((null split)
1066       nil)
1067
1068      ;; A group name.  Do the \& and \N subs into the string.
1069      ((stringp split)
1070       (when nnmail-split-tracing
1071         (push (format "\"%s\"" split) nnmail-split-trace))
1072       (list (nnmail-expand-newtext split)))
1073
1074      ;; Junk the message.
1075      ((eq split 'junk)
1076       (when nnmail-split-tracing
1077         (push "junk" nnmail-split-trace))
1078       (list 'junk))
1079
1080      ;; Builtin & operation.
1081      ((eq (car split) '&)
1082       (apply 'nconc (mapcar 'nnmail-split-it (cdr split))))
1083
1084      ;; Builtin | operation.
1085      ((eq (car split) '|)
1086       (let (done)
1087         (while (and (not done) (cdr split))
1088           (setq split (cdr split)
1089                 done (nnmail-split-it (car split))))
1090         done))
1091
1092      ;; Builtin : operation.
1093      ((eq (car split) ':)
1094       (nnmail-split-it (save-excursion (eval (cdr split)))))
1095
1096      ;; Builtin ! operation.
1097      ((eq (car split) '!)
1098       (funcall (cadr split) (nnmail-split-it (caddr split))))
1099
1100      ;; Check the cache for the regexp for this split.
1101      ((setq cached-pair (assq split nnmail-split-cache))
1102       (goto-char (point-max))
1103       ;; FIX FIX FIX problem with re-search-backward is that if you have
1104       ;; a split: (from "foo-\\(bar\\|baz\\)@gnus.org "mail.foo.\\1")
1105       ;; and someone mails a message with 'To: foo-bar@gnus.org' and
1106       ;; 'CC: foo-baz@gnus.org', we'll pick 'mail.foo.baz' as the group
1107       ;; if the cc line is a later header, even though the other choice
1108       ;; is probably better.  Also, this routine won't do a crosspost
1109       ;; when there are two different matches.
1110       ;; I guess you could just make this more determined, and it could
1111       ;; look for still more matches prior to this one, and recurse
1112       ;; on each of the multiple matches hit.  Of course, then you'd
1113       ;; want to make sure that nnmail-article-group or nnmail-split-fancy
1114       ;; removed duplicates, since there might be more of those.
1115       ;; I guess we could also remove duplicates in the & split case, since
1116       ;; that's the only thing that can introduce them.
1117       (when (re-search-backward (cdr cached-pair) nil t)
1118         (when nnmail-split-tracing
1119           (push (cdr cached-pair) nnmail-split-trace))
1120         ;; Someone might want to do a \N sub on this match, so get the
1121         ;; correct match positions.
1122         (goto-char (match-end 0))
1123         (let ((value (nth 1 split)))
1124           (re-search-backward (if (symbolp value)
1125                                   (cdr (assq value nnmail-split-abbrev-alist))
1126                                 value)
1127                               (match-end 1)))
1128         (nnmail-split-it (nth 2 split))))
1129
1130      ;; Not in cache, compute a regexp for the field/value pair.
1131      (t
1132       (let* ((field (nth 0 split))
1133              (value (nth 1 split))
1134              (regexp (concat "^\\(\\("
1135                              (if (symbolp field)
1136                                  (cdr (assq field nnmail-split-abbrev-alist))
1137                                field)
1138                              "\\):.*\\)\\<\\("
1139                              (if (symbolp value)
1140                                  (cdr (assq value nnmail-split-abbrev-alist))
1141                                value)
1142                              "\\)\\>")))
1143         (push (cons split regexp) nnmail-split-cache)
1144         ;; Now that it's in the cache, just call nnmail-split-it again
1145         ;; on the same split, which will find it immediately in the cache.
1146         (nnmail-split-it split))))))
1147
1148 (defun nnmail-expand-newtext (newtext)
1149   (let ((len (length newtext))
1150         (pos 0)
1151         c expanded beg N did-expand)
1152     (while (< pos len)
1153       (setq beg pos)
1154       (while (and (< pos len)
1155                   (not (= (aref newtext pos) ?\\)))
1156         (setq pos (1+ pos)))
1157       (unless (= beg pos)
1158         (push (substring newtext beg pos) expanded))
1159       (when (< pos len)
1160         ;; We hit a \; expand it.
1161         (setq did-expand t
1162               pos (1+ pos)
1163               c (aref newtext pos))
1164         (if (not (or (= c ?\&)
1165                      (and (>= c ?1)
1166                           (<= c ?9))))
1167             ;; \ followed by some character we don't expand.
1168             (push (char-to-string c) expanded)
1169           ;; \& or \N
1170           (if (= c ?\&)
1171               (setq N 0)
1172             (setq N (- c ?0)))
1173           (when (match-beginning N)
1174             (push (buffer-substring (match-beginning N) (match-end N))
1175                   expanded))))
1176       (setq pos (1+ pos)))
1177     (if did-expand
1178         (apply 'concat (nreverse expanded))
1179       newtext)))
1180
1181 ;; Activate a backend only if it isn't already activated.
1182 ;; If FORCE, re-read the active file even if the backend is
1183 ;; already activated.
1184 (defun nnmail-activate (backend &optional force)
1185   (nnheader-init-server-buffer)
1186   (let (file timestamp file-time)
1187     (if (or (not (symbol-value (intern (format "%s-group-alist" backend))))
1188             force
1189             (and (setq file (ignore-errors
1190                               (symbol-value (intern (format "%s-active-file"
1191                                                             backend)))))
1192                  (setq file-time (nth 5 (file-attributes file)))
1193                  (or (not
1194                       (setq timestamp
1195                             (condition-case ()
1196                                 (symbol-value (intern
1197                                                (format "%s-active-timestamp"
1198                                                        backend)))
1199                               (error 'none))))
1200                      (not (consp timestamp))
1201                      (equal timestamp '(0 0))
1202                      (> (nth 0 file-time) (nth 0 timestamp))
1203                      (and (= (nth 0 file-time) (nth 0 timestamp))
1204                           (> (nth 1 file-time) (nth 1 timestamp))))))
1205         (save-excursion
1206           (or (eq timestamp 'none)
1207               (set (intern (format "%s-active-timestamp" backend))
1208                    file-time))
1209           (funcall (intern (format "%s-request-list" backend)))))
1210     t))
1211
1212 (defun nnmail-message-id ()
1213   (concat "<" (message-unique-id) "@totally-fudged-out-message-id>"))
1214
1215 ;;;
1216 ;;; nnmail duplicate handling
1217 ;;;
1218
1219 (defvar nnmail-cache-buffer nil)
1220
1221 (defun nnmail-cache-open ()
1222   (if (or (not nnmail-treat-duplicates)
1223           (and nnmail-cache-buffer
1224                (buffer-name nnmail-cache-buffer)))
1225       ()                                ; The buffer is open.
1226     (save-excursion
1227       (set-buffer
1228        (setq nnmail-cache-buffer
1229              (get-buffer-create " *nnmail message-id cache*")))
1230       (when (file-exists-p nnmail-message-id-cache-file)
1231         (nnheader-insert-file-contents nnmail-message-id-cache-file))
1232       (set-buffer-modified-p nil)
1233       (current-buffer))))
1234
1235 (defun nnmail-cache-close ()
1236   (when (and nnmail-cache-buffer
1237              nnmail-treat-duplicates
1238              (buffer-name nnmail-cache-buffer)
1239              (buffer-modified-p nnmail-cache-buffer))
1240     (save-excursion
1241       (set-buffer nnmail-cache-buffer)
1242       ;; Weed out the excess number of Message-IDs.
1243       (goto-char (point-max))
1244       (when (search-backward "\n" nil t nnmail-message-id-cache-length)
1245         (progn
1246           (beginning-of-line)
1247           (delete-region (point-min) (point))))
1248       ;; Save the buffer.
1249       (or (file-exists-p (file-name-directory nnmail-message-id-cache-file))
1250           (make-directory (file-name-directory nnmail-message-id-cache-file)
1251                           t))
1252       (nnmail-write-region (point-min) (point-max)
1253                            nnmail-message-id-cache-file nil 'silent)
1254       (set-buffer-modified-p nil)
1255       (setq nnmail-cache-buffer nil)
1256       (kill-buffer (current-buffer)))))
1257
1258 (defun nnmail-cache-insert (id)
1259   (when nnmail-treat-duplicates
1260     (unless (gnus-buffer-live-p nnmail-cache-buffer)
1261       (nnmail-cache-open))
1262     (save-excursion
1263       (set-buffer nnmail-cache-buffer)
1264       (goto-char (point-max))
1265       (insert id "\n"))))
1266
1267 (defun nnmail-cache-id-exists-p (id)
1268   (when nnmail-treat-duplicates
1269     (save-excursion
1270       (set-buffer nnmail-cache-buffer)
1271       (goto-char (point-max))
1272       (search-backward id nil t))))
1273
1274 (defun nnmail-fetch-field (header)
1275   (save-excursion
1276     (save-restriction
1277       (message-narrow-to-head)
1278       (message-fetch-field header))))
1279
1280 (defun nnmail-check-duplication (message-id func artnum-func)
1281   (run-hooks 'nnmail-prepare-incoming-message-hook)
1282   ;; If this is a duplicate message, then we do not save it.
1283   (let* ((duplication (nnmail-cache-id-exists-p message-id))
1284          (case-fold-search t)
1285          (action (when duplication
1286                    (cond
1287                     ((memq nnmail-treat-duplicates '(warn delete))
1288                      nnmail-treat-duplicates)
1289                     ((nnheader-functionp nnmail-treat-duplicates)
1290                      (funcall nnmail-treat-duplicates message-id))
1291                     (t
1292                      nnmail-treat-duplicates))))
1293          group-art)
1294     ;; We insert a line that says what the mail source is.
1295     (let ((case-fold-search t))
1296       (goto-char (point-min))
1297       (re-search-forward "^message-id[ \t]*:" nil t)
1298       (beginning-of-line)
1299       (insert (format "X-Gnus-Mail-Source: %s\n" mail-source-string)))
1300
1301     ;; Let the backend save the article (or not).
1302     (cond
1303      ((not duplication)
1304       (funcall func (setq group-art
1305                           (nreverse (nnmail-article-group artnum-func))))
1306       (nnmail-cache-insert message-id))
1307      ((eq action 'delete)
1308       (setq group-art nil))
1309      ((eq action 'warn)
1310       ;; We insert a warning.
1311       (let ((case-fold-search t))
1312         (goto-char (point-min))
1313         (re-search-forward "^message-id[ \t]*:" nil t)
1314         (beginning-of-line)
1315         (insert
1316          "Gnus-Warning: This is a duplicate of message " message-id "\n")
1317         (funcall func (setq group-art
1318                             (nreverse (nnmail-article-group artnum-func))))))
1319      (t
1320       (funcall func (setq group-art
1321                           (nreverse (nnmail-article-group artnum-func))))))
1322     ;; Add the group-art list to the history list.
1323     (if group-art
1324         (push group-art nnmail-split-history)
1325       (delete-region (point-min) (point-max)))))
1326
1327 ;;; Get new mail.
1328
1329 (defvar nnmail-fetched-sources nil)
1330
1331 (defun nnmail-get-value (&rest args)
1332   (let ((sym (intern (apply 'format args))))
1333     (when (boundp sym)
1334       (symbol-value sym))))
1335
1336 (defun nnmail-get-new-mail (method exit-func temp
1337                                    &optional group spool-func)
1338   "Read new incoming mail."
1339   (let* ((sources (or mail-sources
1340                       (if (listp nnmail-spool-file) nnmail-spool-file
1341                         (list nnmail-spool-file))))
1342          (group-in group)
1343          (i 0)
1344          (new 0)
1345          (total 0)
1346          incoming incomings source)
1347     (when (and (nnmail-get-value "%s-get-new-mail" method)
1348                nnmail-spool-file)
1349       ;; We first activate all the groups.
1350       (nnmail-activate method)
1351       ;; Allow the user to hook.
1352       (run-hooks 'nnmail-pre-get-new-mail-hook)
1353       ;; Open the message-id cache.
1354       (nnmail-cache-open)
1355       ;; The we go through all the existing mail source specification
1356       ;; and fetch the mail from each.
1357       (while (setq source (pop sources))
1358         ;; Be compatible with old values.
1359         (cond
1360          ((stringp source)
1361           (setq source
1362                 (cond
1363                  ((string-match "^po:" source)
1364                   (list 'pop :user (substring source (match-end 0))))
1365                  ((file-directory-p source)
1366                   (list 'directory :path source))
1367                  (t
1368                   (list 'file :path source)))))
1369          ((eq source 'procmail)
1370           (message "Invalid value for nnmail-spool-file: `procmail'")
1371           nil))
1372         ;; Hack to only fetch the contents of a single group's spool file.
1373         (when (and (eq (car source) 'directory)
1374                    group)
1375           (mail-source-bind (directory source)
1376             (setq source (append source
1377                                  (list
1378                                   :predicate
1379                                   `(lambda (file)
1380                                      (string-match
1381                                       ,(concat
1382                                         (regexp-quote (concat group suffix))
1383                                         "$")
1384                                       file)))))))
1385         (when nnmail-fetched-sources
1386           (if (member source nnmail-fetched-sources)
1387               (setq source nil)
1388             (push source nnmail-fetched-sources)))
1389         (when source
1390           (nnheader-message 4 "%s: Reading incoming mail from %s..."
1391                             method (car source))
1392           (when (setq new
1393                       (mail-source-fetch
1394                        source
1395                        `(lambda (file orig-file)
1396                           (nnmail-split-incoming
1397                            file ',(intern (format "%s-save-mail" method))
1398                            ',spool-func
1399                            (nnmail-get-split-group orig-file source)
1400                            ',(intern (format "%s-active-number" method))))))
1401             (incf total new)
1402             (incf i))))
1403       ;; If we did indeed read any incoming spools, we save all info.
1404       (unless (zerop new)
1405         (nnmail-save-active
1406          (nnmail-get-value "%s-group-alist" method)
1407          (nnmail-get-value "%s-active-file" method))
1408         (when exit-func
1409           (funcall exit-func))
1410         (run-hooks 'nnmail-read-incoming-hook)
1411         (nnheader-message 4 "%s: Reading incoming mail (%d new)...done" method
1412                           total))
1413       ;; Close the message-id cache.
1414       (nnmail-cache-close)
1415       ;; Allow the user to hook.
1416       (run-hooks 'nnmail-post-get-new-mail-hook))))
1417
1418 (defun nnmail-expired-article-p (group time force &optional inhibit)
1419   "Say whether an article that is TIME old in GROUP should be expired."
1420   (if force
1421       t
1422     (let ((days (or (and nnmail-expiry-wait-function
1423                          (funcall nnmail-expiry-wait-function group))
1424                     nnmail-expiry-wait)))
1425       (cond ((or (eq days 'never)
1426                  (and (not force)
1427                       inhibit))
1428              ;; This isn't an expirable group.
1429              nil)
1430             ((eq days 'immediate)
1431              ;; We expire all articles on sight.
1432              t)
1433             ((equal time '(0 0))
1434              ;; This is an ange-ftp group, and we don't have any dates.
1435              nil)
1436             ((numberp days)
1437              (setq days (days-to-time days))
1438              ;; Compare the time with the current time.
1439              (ignore-errors (time-less-p days (time-since time))))))))
1440
1441 (defun nnmail-check-syntax ()
1442   "Check (and modify) the syntax of the message in the current buffer."
1443   (save-restriction
1444     (message-narrow-to-head)
1445     (let ((case-fold-search t))
1446       (unless (re-search-forward "^Message-ID[ \t]*:" nil t)
1447         (insert "Message-ID: " (nnmail-message-id) "\n")))))
1448
1449 (defun nnmail-write-region (start end filename &optional append visit lockname)
1450   "Do a `write-region', and then set the file modes."
1451   (let ((coding-system-for-write nnmail-file-coding-system)
1452         (pathname-coding-system 'binary))
1453     (write-region start end filename append visit lockname)
1454     (set-file-modes filename nnmail-default-file-modes)))
1455
1456 ;;;
1457 ;;; Status functions
1458 ;;;
1459
1460 (defun nnmail-replace-status (name value)
1461   "Make status NAME and VALUE part of the current status line."
1462   (save-restriction
1463     (message-narrow-to-head)
1464     (let ((status (nnmail-decode-status)))
1465       (setq status (delq (member name status) status))
1466       (when value
1467         (push (cons name value) status))
1468       (message-remove-header "status")
1469       (goto-char (point-max))
1470       (insert "Status: " (nnmail-encode-status status) "\n"))))
1471
1472 (defun nnmail-decode-status ()
1473   "Return a status-value alist from STATUS."
1474   (goto-char (point-min))
1475   (when (re-search-forward "^Status: " nil t)
1476     (let (name value status)
1477       (save-restriction
1478         ;; Narrow to the status.
1479         (narrow-to-region
1480          (point)
1481          (if (re-search-forward "^[^ \t]" nil t)
1482              (1- (point))
1483            (point-max)))
1484         ;; Go through all elements and add them to the list.
1485         (goto-char (point-min))
1486         (while (re-search-forward "[^ \t=]+" nil t)
1487           (setq name (match-string 0))
1488           (if (not (eq (char-after) ?=))
1489               ;; Implied "yes".
1490               (setq value "yes")
1491             (forward-char 1)
1492             (if (not (eq (char-after) ?\"))
1493                 (if (not (looking-at "[^ \t]"))
1494                     ;; Implied "no".
1495                     (setq value "no")
1496                   ;; Unquoted value.
1497                   (setq value (match-string 0))
1498                   (goto-char (match-end 0)))
1499               ;; Quoted value.
1500               (setq value (read (current-buffer)))))
1501           (push (cons name value) status)))
1502       status)))
1503
1504 (defun nnmail-encode-status (status)
1505   "Return a status string from STATUS."
1506   (mapconcat
1507    (lambda (elem)
1508      (concat
1509       (car elem) "="
1510       (if (string-match "[ \t]" (cdr elem))
1511           (prin1-to-string (cdr elem))
1512         (cdr elem))))
1513    status " "))
1514
1515 (defun nnmail-split-history ()
1516   "Generate an overview of where the last mail split put articles."
1517   (interactive)
1518   (unless nnmail-split-history
1519     (error "No current split history"))
1520   (with-output-to-temp-buffer "*nnmail split history*"
1521     (let ((history nnmail-split-history)
1522           elem)
1523       (while (setq elem (pop history))
1524         (princ (mapconcat (lambda (ga)
1525                             (concat (car ga) ":" (int-to-string (cdr ga))))
1526                           elem
1527                           ", "))
1528         (princ "\n")))))
1529
1530 (defun nnmail-purge-split-history (group)
1531   "Remove all instances of GROUP from `nnmail-split-history'."
1532   (let ((history nnmail-split-history))
1533     (while history
1534       (setcar history (gnus-delete-if (lambda (e) (string= (car e) group))
1535                                       (car history)))
1536       (pop history))
1537     (setq nnmail-split-history (delq nil nnmail-split-history))))
1538
1539 (defun nnmail-new-mail-p (group)
1540   "Say whether GROUP has new mail."
1541   (let ((his nnmail-split-history)
1542         found)
1543     (while his
1544       (when (assoc group (pop his))
1545         (setq found t
1546               his nil)))
1547     found))
1548
1549 (defun nnmail-within-headers-p ()
1550   "Check to see if point is within the headers of a unix mail message.
1551 Doesn't change point."
1552   (let ((pos (point)))
1553     (save-excursion
1554       (and (nnmail-search-unix-mail-delim-backward)
1555            (not (search-forward "\n\n" pos t))))))
1556
1557 (run-hooks 'nnmail-load-hook)
1558
1559 (provide 'nnmail)
1560
1561 ;;; nnmail.el ends here