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