git.chise.org Git - elisp/gnus.git-/blob - lisp/nnheader.el

   1 ;;; nnheader.el --- header access macros for Semi-gnus and its backends
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
   4 ;;        1997, 1998, 2000, 2001, 2002, 2003, 2004
   5 ;;        Free Software Foundation, Inc.
   6
   7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   8 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   9 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
  10 ;;      Katsumi Yamaoka <yamaoka@jpl.org>
  11 ;; Keywords: mail, news, MIME
  12
  13 ;; This file is part of GNU Emacs.
  14
  15 ;; GNU Emacs is free software; you can redistribute it and/or modify
  16 ;; it under the terms of the GNU General Public License as published by
  17 ;; the Free Software Foundation; either version 2, or (at your option)
  18 ;; any later version.
  19
  20 ;; GNU Emacs is distributed in the hope that it will be useful,
  21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 ;; GNU General Public License for more details.
  24
  25 ;; You should have received a copy of the GNU General Public License
  26 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  28 ;; Boston, MA 02111-1307, USA.
  29
  30 ;;; Commentary:
  31
  32 ;;; Code:
  33
  34 (eval-when-compile (require 'cl))
  35 (eval-when-compile (require 'static))
  36
  37 ;; Requiring `gnus-util' at compile time creates a circular
  38 ;; dependency between nnheader.el and gnus-util.el.
  39 ;;(eval-when-compile (require 'gnus-util))
  40
  41 (require 'mail-utils)
  42 (require 'gnus-util)
  43
  44 ;; Reduce the required value of `recursive-load-depth-limit' for Emacs 21.
  45 (require 'pces)
  46 (require 'poem)
  47 (require 'std11)
  48
  49 (require 'mime)
  50 (eval-and-compile
  51   (autoload 'gnus-sorted-intersection "gnus-range")
  52   (autoload 'gnus-intersection "gnus-range")
  53   (autoload 'gnus-sorted-complement "gnus-range")
  54   (autoload 'gnus-sorted-difference "gnus-range"))
  55
  56 (defcustom gnus-verbose-backends 7
  57   "Integer that says how verbose the Gnus backends should be.
  58 The higher the number, the more messages the Gnus backends will flash
  59 to say what it's doing.  At zero, the Gnus backends will be totally
  60 mute; at five, they will display most important messages; and at ten,
  61 they will keep on jabbering all the time."
  62   :group 'gnus-start
  63   :type 'integer)
  64
  65 (defcustom gnus-nov-is-evil nil
  66   "If non-nil, Gnus backends will never output headers in the NOV format."
  67   :group 'gnus-server
  68   :type 'boolean)
  69
  70 (defvar nnheader-max-head-length 8192
  71   "*Max length of the head of articles.
  72
  73 Value is an integer, nil, or t.  nil means read in chunks of a file
  74 indefinitely until a complete head is found\; t means always read the
  75 entire file immediately, disregarding `nnheader-head-chop-length'.
  76
  77 Integer values will in effect be rounded up to the nearest multiple of
  78 `nnheader-head-chop-length'.")
  79
  80 (defvar nnheader-head-chop-length 2048
  81   "*Length of each read operation when trying to fetch HEAD headers.")
  82
  83 (defvar nnheader-read-timeout
  84   (if (string-match "windows-nt\\|os/2\\|emx\\|cygwin"
  85                     (symbol-name system-type))
  86       1.0                               ; why?
  87     0.1)
  88   "How long nntp should wait between checking for the end of output.
  89 Shorter values mean quicker response, but are more CPU intensive.")
  90
  91 (defvar nnheader-file-name-translation-alist
  92   (let ((case-fold-search t))
  93     (cond
  94      ((string-match "windows-nt\\|os/2\\|emx\\|cygwin"
  95                     (symbol-name system-type))
  96       (append (mapcar (lambda (c) (cons c ?_))
  97                       '(?: ?* ?\" ?< ?> ??))
  98               (if (string-match "windows-nt\\|cygwin"
  99                                 (symbol-name system-type))
 100                   nil
 101                 '((?+ . ?-)))))
 102      (t nil)))
 103   "*Alist that says how to translate characters in file names.
 104 For instance, if \":\" is invalid as a file character in file names
 105 on your system, you could say something like:
 106
 107 \(setq nnheader-file-name-translation-alist '((?: . ?_)))")
 108
 109 (defvar nnheader-text-coding-system
 110   (if (memq system-type '(windows-nt ms-dos ms-windows))
 111       'raw-text-dos
 112     'raw-text)
 113   "Text-safe coding system (For removing ^M).
 114 This variable is a substitute for `mm-text-coding-system'.")
 115
 116 (defvar nnheader-text-coding-system-for-write nil
 117   "Text coding system for write.
 118 This variable is a substitute for `mm-text-coding-system-for-write'.")
 119
 120 (defvar nnheader-auto-save-coding-system
 121   (cond
 122    ((not (fboundp 'find-coding-system)) nil)
 123    ((find-coding-system 'emacs-mule)
 124     (if (memq system-type '(windows-nt ms-dos ms-windows))
 125         'emacs-mule-dos 'emacs-mule))
 126    ((find-coding-system 'escape-quoted) 'escape-quoted)
 127    ((find-coding-system 'no-conversion) 'no-conversion)
 128    (t nil))
 129   "Coding system of auto save file.")
 130
 131 (defvar nnheader-directory-separator-character
 132   (string-to-char (substring (file-name-as-directory ".") -1))
 133   "*A character used to a directory separator.")
 134
 135 (eval-and-compile
 136   (autoload 'nnmail-message-id "nnmail")
 137   (autoload 'mail-position-on-field "sendmail")
 138   (autoload 'message-remove-header "message")
 139   (autoload 'gnus-buffer-live-p "gnus-util"))
 140
 141 ;; mm-util stuff.
 142 (unless (featurep 'mm-util)
 143   ;; Should keep track of `mm-image-load-path' in mm-util.el.
 144   (defun nnheader-image-load-path (&optional package)
 145     (let (dir result)
 146       (dolist (path load-path (nreverse result))
 147         (if (file-directory-p
 148              (setq dir (concat (file-name-directory
 149                                 (directory-file-name path))
 150                                "etc/" (or package "gnus/"))))
 151             (push dir result))
 152         (push path result))))
 153   (defalias 'mm-image-load-path 'nnheader-image-load-path)
 154
 155   ;; Should keep track of `mm-read-coding-system' in mm-util.el.
 156   (defalias 'mm-read-coding-system 'read-coding-system)
 157
 158   ;; Should keep track of `mm-%s' in mm-util.el.
 159   (defalias 'mm-multibyte-string-p
 160     (if (fboundp 'multibyte-string-p)
 161         'multibyte-string-p
 162       'ignore))
 163   (defalias 'mm-encode-coding-string 'encode-coding-string)
 164   (defalias 'mm-decode-coding-string 'decode-coding-string)
 165
 166   ;; Should keep track of `mm-detect-coding-region' in mm-util.el.
 167   (defun nnheader-detect-coding-region (start end)
 168     "Like 'detect-coding-region' except returning the best one."
 169     (let ((coding-systems (detect-coding-region (point) (point-max))))
 170       (or (car-safe coding-systems)
 171           coding-systems)))
 172   (defalias 'mm-detect-coding-region 'nnheader-detect-coding-region)
 173
 174   ;; Should keep track of `mm-detect-mime-charset-region' in mm-util.el.
 175   (defun nnheader-detect-mime-charset-region (start end)
 176     "Detect MIME charset of the text in the region between START and END."
 177     (coding-system-to-mime-charset
 178      (nnheader-detect-coding-region start end)))
 179   (defalias 'mm-detect-mime-charset-region
 180     'nnheader-detect-mime-charset-region)
 181
 182   ;; Should keep track of `mm-with-unibyte-buffer' in mm-util.el.
 183   (defmacro nnheader-with-unibyte-buffer (&rest forms)
 184   "Create a temporary buffer, and evaluate FORMS there like `progn'.
 185 Use unibyte mode for this."
 186   `(let (default-enable-multibyte-characters)
 187      (with-temp-buffer ,@forms)))
 188   (put 'nnheader-with-unibyte-buffer 'lisp-indent-function 0)
 189   (put 'nnheader-with-unibyte-buffer 'edebug-form-spec '(body))
 190   (put 'mm-with-unibyte-buffer 'lisp-indent-function 0)
 191   (put 'mm-with-unibyte-buffer 'edebug-form-spec '(body))
 192   (defalias 'mm-with-unibyte-buffer 'nnheader-with-unibyte-buffer)
 193
 194   ;; Should keep track of `mm-with-unibyte-current-buffer' in mm-util.el.
 195   (defmacro nnheader-with-unibyte-current-buffer (&rest forms)
 196     "Evaluate FORMS with current current buffer temporarily made unibyte.
 197 Also bind `default-enable-multibyte-characters' to nil.
 198 Equivalent to `progn' in XEmacs"
 199     (let ((multibyte (make-symbol "multibyte"))
 200           (buffer (make-symbol "buffer")))
 201       (cond ((featurep 'xemacs)
 202              `(let (default-enable-multibyte-characters)
 203                 ,@forms))
 204             (t
 205              `(let ((,multibyte enable-multibyte-characters)
 206                     (,buffer (current-buffer)))
 207                 (unwind-protect
 208                     (let (default-enable-multibyte-characters)
 209                       (set-buffer-multibyte nil)
 210                       ,@forms)
 211                   (set-buffer ,buffer)
 212                   (set-buffer-multibyte ,multibyte)))))))
 213   (put 'nnheader-with-unibyte-current-buffer 'lisp-indent-function 0)
 214   (put 'nnheader-with-unibyte-current-buffer 'edebug-form-spec '(body))
 215   (put 'mm-with-unibyte-current-buffer 'lisp-indent-function 0)
 216   (put 'mm-with-unibyte-current-buffer 'edebug-form-spec '(body))
 217   (defalias 'mm-with-unibyte-current-buffer
 218     'nnheader-with-unibyte-current-buffer)
 219
 220   ;; Should keep track of `mm-with-unibyte' in mm-util.el.
 221   (defmacro nnheader-with-unibyte (&rest forms)
 222     "Eval the FORMS with the default value of `enable-multibyte-characters'
 223 nil, ."
 224     `(let (default-enable-multibyte-characters)
 225        ,@forms))
 226   (put 'nnheader-with-unibyte 'lisp-indent-function 0)
 227   (put 'nnheader-with-unibyte 'edebug-form-spec '(body))
 228   (put 'mm-with-unibyte 'lisp-indent-function 0)
 229   (put 'mm-with-unibyte 'edebug-form-spec '(body))
 230   (defalias 'mm-with-unibyte 'nnheader-with-unibyte)
 231
 232   ;; Should keep track of `mm-guess-mime-charset' in mm-util.el.
 233   (defun nnheader-guess-mime-charset ()
 234   "Guess the default MIME charset from the language environment."
 235   (let ((language-info
 236          (and (boundp 'current-language-environment)
 237               (assoc current-language-environment
 238                      language-info-alist)))
 239         item)
 240     (cond
 241      ((null language-info)
 242       'iso-8859-1)
 243      ((setq item
 244             (cadr
 245              (or (assq 'coding-priority language-info)
 246                  (assq 'coding-system language-info))))
 247       (if (fboundp 'coding-system-get)
 248           (or (coding-system-get item 'mime-charset)
 249               item)
 250         item))
 251      ((setq item (car (last (assq 'charset language-info))))
 252       (if (eq item 'ascii)
 253           'iso-8859-1
 254          (charsets-to-mime-charset (list item))))
 255      (t
 256       'iso-8859-1))))
 257   (defalias 'mm-guess-mime-charset 'nnheader-guess-mime-charset)
 258
 259   (defalias 'mm-char-int 'char-int)
 260
 261   ;; Should keep track of the same alias in mm-util.el.
 262   (defalias 'mm-multibyte-p
 263     (static-cond ((and (featurep 'xemacs) (featurep 'mule))
 264                   (lambda nil t))
 265                  ((featurep 'xemacs)
 266                   (lambda nil nil))
 267                  (t
 268                   (lambda nil enable-multibyte-characters))))
 269
 270   ;; Should keep track of the same alias in mm-util.el.
 271   (defalias 'mm-make-temp-file
 272     (if (fboundp 'make-temp-file)
 273         'make-temp-file
 274       (lambda (prefix &optional dir-flag)
 275         (let ((file (expand-file-name
 276                      (make-temp-name prefix)
 277                      (if (fboundp 'temp-directory)
 278                          (temp-directory)
 279                        temporary-file-directory))))
 280           (if dir-flag
 281               (make-directory file))
 282           file))))
 283
 284   ;; Should keep track of `mm-coding-system-p' in mm-util.el.
 285   (defun nnheader-coding-system-p (sym)
 286     "Return non-nil if SYM is a coding system."
 287     (or (and (fboundp 'find-coding-system) (find-coding-system sym))
 288         (and (fboundp 'coding-system-p) (coding-system-p sym))))
 289   (defalias 'mm-coding-system-p 'nnheader-coding-system-p)
 290
 291   (defalias 'mm-disable-multibyte
 292     (static-if (featurep 'xemacs)
 293         'ignore
 294       (lambda nil (set-buffer-multibyte nil))))
 295   (defalias 'mm-enable-multibyte
 296     (static-if (featurep 'xemacs)
 297         'ignore
 298       ;; Why isn't it t but `to'?  See mm-util.el.
 299       (lambda nil (set-buffer-multibyte 'to))))
 300
 301   (defalias 'mm-encode-coding-region 'encode-coding-region)
 302
 303   (defalias 'mm-string-make-unibyte
 304     (if (fboundp 'string-make-unibyte)
 305         'string-make-unibyte
 306       'identity)))
 307
 308 ;; mail-parse stuff.
 309 (unless (featurep 'mail-parse)
 310   (unless (fboundp 'std11-narrow-to-field)
 311     (defalias 'std11-narrow-to-field
 312       ;; Should keep track of `rfc2047-narrow-to-field' in rfc2047.el.
 313       (lambda ()
 314         "Narrow the buffer to the header on the current line."
 315         (forward-line 0)
 316         (narrow-to-region (point)
 317                           (progn
 318                             (std11-field-end)
 319                             (when (eolp) (forward-line 1))
 320                             (point)))
 321         (goto-char (point-min)))))
 322   (defalias 'mail-header-narrow-to-field 'std11-narrow-to-field)
 323
 324   ;; Should keep track of `ietf-drums-narrow-to-header' in ietf-drums.el.
 325   (defun mail-narrow-to-head ()
 326     "Narrow to the header section in the current buffer."
 327     (narrow-to-region
 328      (goto-char (point-min))
 329      (if (re-search-forward "^\r?$" nil 1)
 330          (match-beginning 0)
 331        (point-max)))
 332     (goto-char (point-min)))
 333
 334   (unless (fboundp 'std11-fold-region)
 335     (defalias 'std11-fold-region
 336       ;; Should keep track of `rfc2047-fold-region' in rfc2047.el.
 337       (lambda (b e)
 338         "Fold long lines in region B to E."
 339         (save-restriction
 340           (narrow-to-region b e)
 341           (goto-char (point-min))
 342           (let ((break nil)
 343                 (qword-break nil)
 344                 (first t)
 345                 (bol (save-restriction
 346                        (widen)
 347                        (point-at-bol))))
 348             (while (not (eobp))
 349               (when (and (or break qword-break)
 350                          (> (- (point) bol) 76))
 351                 (goto-char (or break qword-break))
 352                 (setq break nil
 353                       qword-break nil)
 354                 (if (looking-at "[ \t]")
 355                     (insert "\n")
 356                   (insert "\n "))
 357                 (setq bol (1- (point)))
 358                 ;; Don't break before the first non-LWSP characters.
 359                 (skip-chars-forward " \t")
 360                 (unless (eobp)
 361                   (forward-char 1)))
 362               (cond
 363                ((eq (char-after) ?\n)
 364                 (forward-char 1)
 365                 (setq bol (point)
 366                       break nil
 367                       qword-break nil)
 368                 (skip-chars-forward " \t")
 369                 (unless (or (eobp) (eq (char-after) ?\n))
 370                   (forward-char 1)))
 371                ((eq (char-after) ?\r)
 372                 (forward-char 1))
 373                ((memq (char-after) '(?  ?\t))
 374                 (skip-chars-forward " \t")
 375                 (if first
 376                     ;; Don't break just after the header name.
 377                     (setq first nil)
 378                   (setq break (1- (point)))))
 379                ((not break)
 380                 (if (not (looking-at "=\\?[^=]"))
 381                     (if (eq (char-after) ?=)
 382                         (forward-char 1)
 383                       (skip-chars-forward "^ \t\n\r="))
 384                   (setq qword-break (point))
 385                   (skip-chars-forward "^ \t\n\r")))
 386                (t
 387                 (skip-chars-forward "^ \t\n\r"))))
 388             (when (and (or break qword-break)
 389                        (> (- (point) bol) 76))
 390               (goto-char (or break qword-break))
 391               (setq break nil
 392                     qword-break nil)
 393               (if (looking-at "[ \t]")
 394                   (insert "\n")
 395                 (insert "\n "))
 396               (setq bol (1- (point)))
 397               ;; Don't break before the first non-LWSP characters.
 398               (skip-chars-forward " \t")
 399               (unless (eobp)
 400                 (forward-char 1))))))))
 401
 402   (unless (fboundp 'std11-fold-field)
 403     (defalias 'std11-fold-field
 404       ;; Should keep track of `rfc2047-fold-field' in rfc2047.el.
 405       (lambda ()
 406         "Fold the current line."
 407         (save-excursion
 408           (save-restriction
 409             (std11-narrow-to-field)
 410             (std11-fold-region (point-min) (point-max)))))))
 411   (defalias 'mail-header-fold-field 'std11-fold-field)
 412
 413   (unless (fboundp 'std11-unfold-region)
 414     (defalias 'std11-unfold-region
 415       ;; Should keep track of `rfc2047-unfold-region' in rfc2047.el.
 416       (lambda (b e)
 417         "Unfold lines in region B to E."
 418         (save-restriction
 419           (narrow-to-region b e)
 420           (goto-char (point-min))
 421           (let ((bol (save-restriction
 422                        (widen)
 423                        (point-at-bol)))
 424                 (eol (point-at-eol)))
 425             (forward-line 1)
 426             (while (not (eobp))
 427               (if (and (looking-at "[ \t]")
 428                        (< (- (point-at-eol) bol) 76))
 429                   (delete-region eol (progn
 430                                        (goto-char eol)
 431                                        (skip-chars-forward "\r\n")
 432                                        (point)))
 433                 (setq bol (point-at-bol)))
 434               (setq eol (point-at-eol))
 435               (forward-line 1)))))))
 436
 437   (unless (fboundp 'std11-unfold-field)
 438     (defalias 'std11-unfold-field
 439       ;; Should keep track of `rfc2047-unfold-field' in rfc2047.el.
 440       (lambda ()
 441         "Fold the current line."
 442         (save-excursion
 443           (save-restriction
 444             (std11-narrow-to-field)
 445             (std11-unfold-region (point-min) (point-max)))))))
 446   (defalias 'mail-header-unfold-field 'std11-unfold-field)
 447
 448   (unless (fboundp 'std11-extract-addresses-components)
 449     (defalias 'std11-extract-addresses-components
 450       ;; This is the original function in T-gnus.
 451       (lambda (string)
 452         "Extract a list of full name and canonical address from STRING.  Each
 453 element looks like a list of the form (FULL-NAME CANONICAL-ADDRESS).
 454 If no name can be extracted, FULL-NAME will be nil."
 455         (when string
 456           (let (addresses)
 457             (dolist (structure (std11-parse-addresses-string
 458                                 (std11-unfold-string string))
 459                                addresses)
 460               (push (list (std11-full-name-string structure)
 461                           (std11-address-string structure))
 462                     addresses))
 463             (nreverse addresses))))))
 464
 465   ;; Should keep track of `ietf-drums-parse-addresses' in ietf-drums.el.
 466   (defun mail-header-parse-addresses (string)
 467     "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs."
 468     (mapcar (function
 469              (lambda (components)
 470                (cons (nth 1 components) (car components))))
 471             (std11-extract-addresses-components string)))
 472
 473   ;; Should keep track of `rfc2047-field-value' in rfc2047.el.
 474   (defun std11-field-value (&optional dont-include-last-newline)
 475     "Return the value of the field at point.  If the optional argument is
 476 given, the return value will not contain the last newline."
 477     (let ((begin (point))
 478           (inhibit-point-motion-hooks t)
 479           start value)
 480       (beginning-of-line)
 481       (unless (eobp)
 482         (while (and (memq (char-after) '(?\t ?\ ))
 483                     (zerop (forward-line -1))))
 484         (when (looking-at "[^\t\n ]+:[\t\n ]+")
 485           (goto-char (setq start (match-end 0)))
 486           (forward-line 1)
 487           (while (and (memq (char-after) '(?\t ?\ ))
 488                       (zerop (forward-line 1))))
 489           (when dont-include-last-newline
 490             (skip-chars-backward "\t\n " start))
 491           (setq value (buffer-substring start (point)))))
 492       (goto-char begin)
 493       value))
 494   (defalias 'mail-header-field-value 'std11-field-value))
 495
 496 ;; ietf-drums stuff.
 497 (unless (featurep 'ietf-drums)
 498   ;; Should keep track of `ietf-drums-unfold-fws' in ietf-drums.el.
 499   (defun nnheader-unfold-fws ()
 500     "Unfold folding white space in the current buffer."
 501     (goto-char (point-min))
 502     (while (re-search-forward "[ \t]*\n[ \t]+" nil t)
 503       (replace-match " " t t))
 504     (goto-char (point-min)))
 505
 506   (defalias 'ietf-drums-unfold-fws 'nnheader-unfold-fws))
 507
 508 ;;; Header access macros.
 509
 510 ;; These macros may look very much like the ones in GNUS 4.1.  They
 511 ;; are, in a way, but you should note that the indices they use have
 512 ;; been changed from the internal GNUS format to the NOV format.  The
 513 ;; makes it possible to read headers from XOVER much faster.
 514 ;;
 515 ;; The format of a header is now:
 516 ;; [number subject from date id references chars lines xref extra]
 517 ;;
 518 ;; (That next-to-last entry is defined as "misc" in the NOV format,
 519 ;; but Gnus uses it for xrefs.)
 520
 521 (require 'mmgnus)
 522
 523 (defmacro mail-header-number (header)
 524   "Return article number in HEADER."
 525   `(mime-entity-location-internal ,header))
 526
 527 (defmacro mail-header-set-number (header number)
 528   "Set article number of HEADER to NUMBER."
 529   `(mime-entity-set-location-internal ,header ,number))
 530
 531 (defalias 'mail-header-subject 'mime-gnus-entity-subject-internal)
 532 (defalias 'mail-header-set-subject 'mime-gnus-entity-set-subject-internal)
 533
 534 (defalias 'mail-header-from 'mime-gnus-entity-from-internal)
 535 (defalias 'mail-header-set-from 'mime-gnus-entity-set-from-internal)
 536
 537 (defalias 'mail-header-date 'mime-gnus-entity-date-internal)
 538 (defalias 'mail-header-set-date 'mime-gnus-entity-set-date-internal)
 539
 540 (defalias 'mail-header-message-id 'mime-gnus-entity-id-internal)
 541 (defalias 'mail-header-id 'mime-gnus-entity-id-internal)
 542 (defalias 'mail-header-set-message-id 'mime-gnus-entity-set-id-internal)
 543 (defalias 'mail-header-set-id 'mime-gnus-entity-set-id-internal)
 544
 545 (defalias 'mail-header-references 'mime-gnus-entity-references-internal)
 546 (defalias 'mail-header-set-references
 547   'mime-gnus-entity-set-references-internal)
 548
 549 (defalias 'mail-header-chars 'mime-gnus-entity-chars-internal)
 550 (defalias 'mail-header-set-chars 'mime-gnus-entity-set-chars-internal)
 551
 552 (defalias 'mail-header-lines 'mime-gnus-entity-lines-internal)
 553 (defalias 'mail-header-set-lines 'mime-gnus-entity-set-lines-internal)
 554
 555 (defalias 'mail-header-xref 'mime-gnus-entity-xref-internal)
 556 (defalias 'mail-header-set-xref 'mime-gnus-entity-set-xref-internal)
 557
 558 (defalias 'nnheader-decode-subject
 559   (mime-find-field-decoder 'Subject 'nov))
 560 (defalias 'nnheader-decode-from
 561   (mime-find-field-decoder 'From 'nov))
 562
 563 (defalias 'mail-header-extra 'mime-gnus-entity-extra-internal)
 564 (defalias 'mail-header-set-extra 'mime-gnus-entity-set-extra-internal)
 565
 566 (defun nnheader-decode-field-body (field-body field-name
 567                                               &optional mode max-column)
 568   (mime-decode-field-body field-body
 569                           (if (stringp field-name)
 570                               (intern (capitalize field-name))
 571                             field-name)
 572                           mode max-column))
 573
 574 (defsubst make-full-mail-header (&optional number subject from date id
 575                                            references chars lines xref
 576                                            extra)
 577   "Create a new mail header structure initialized with the parameters given."
 578   (luna-make-entity (mm-expand-class-name 'gnus)
 579                     :location number
 580                     :subject (if subject
 581                                  (nnheader-decode-subject subject))
 582                     :from (if from
 583                               (nnheader-decode-from from))
 584                     :date date
 585                     :id id
 586                     :references references
 587                     :chars chars
 588                     :lines lines
 589                     :xref xref
 590                     :original-header (list (cons 'Subject subject)
 591                                            (cons 'From from))
 592                     :extra extra))
 593
 594 (defsubst make-full-mail-header-from-decoded-header
 595   (&optional number subject from date id references chars lines xref extra)
 596   "Create a new mail header structure initialized with the parameters given."
 597   (luna-make-entity (mm-expand-class-name 'gnus)
 598                     :location number
 599                     :subject subject
 600                     :from from
 601                     :date date
 602                     :id id
 603                     :references references
 604                     :chars chars
 605                     :lines lines
 606                     :xref xref
 607                     :extra extra))
 608
 609 (defsubst make-mail-header (&optional init)
 610   "Create a new mail header structure initialized with INIT."
 611   (make-full-mail-header init init init init init
 612                          init init init init init))
 613
 614 ;; fake message-ids: generation and detection
 615
 616 (defvar nnheader-fake-message-id 1)
 617
 618 (defsubst nnheader-generate-fake-message-id (&optional number)
 619   (if (numberp number)
 620       (format "fake+none+%s+%d" gnus-newsgroup-name number)
 621     (format "fake+none+%s+%s"
 622             gnus-newsgroup-name
 623             (int-to-string (incf nnheader-fake-message-id)))))
 624
 625 (defsubst nnheader-fake-message-id-p (id)
 626   (save-match-data                      ; regular message-id's are <.*>
 627     (string-match "\\`fake\\+none\\+.*\\+[0-9]+\\'" id)))
 628
 629 ;; Parsing headers and NOV lines.
 630
 631 (defsubst nnheader-remove-cr-followed-by-lf ()
 632   (goto-char (point-max))
 633   (while (search-backward "\r\n" nil t)
 634     (delete-char 1)))
 635
 636 (defsubst nnheader-header-value ()
 637   (let ((pt (point)))
 638     (prog2
 639         (skip-chars-forward " \t")
 640         (buffer-substring (point) (std11-field-end))
 641       (goto-char pt))))
 642
 643 (defun nnheader-parse-naked-head (&optional number)
 644   ;; This function unfolds continuation lines in this buffer
 645   ;; destructively.  When this side effect is unwanted, use
 646   ;; `nnheader-parse-head' instead of this function.
 647   (let ((case-fold-search t)
 648         (buffer-read-only nil)
 649         (cur (current-buffer))
 650         (p (point-min))
 651         in-reply-to lines ref)
 652     (nnheader-remove-cr-followed-by-lf)
 653     (ietf-drums-unfold-fws)
 654     (subst-char-in-region (point-min) (point-max) ?\t ? )
 655     (goto-char p)
 656     (insert "\n")
 657     (prog1
 658         ;; This implementation of this function, with nine
 659         ;; search-forwards instead of the one re-search-forward and a
 660         ;; case (which basically was the old function) is actually
 661         ;; about twice as fast, even though it looks messier.  You
 662         ;; can't have everything, I guess.  Speed and elegance don't
 663         ;; always go hand in hand.
 664         (make-full-mail-header
 665          ;; Number.
 666          (or number 0)
 667          ;; Subject.
 668          (progn
 669            (goto-char p)
 670            (if (search-forward "\nsubject:" nil t)
 671                (nnheader-header-value) "(none)"))
 672          ;; From.
 673          (progn
 674            (goto-char p)
 675            (if (search-forward "\nfrom:" nil t)
 676                (nnheader-header-value) "(nobody)"))
 677          ;; Date.
 678          (progn
 679            (goto-char p)
 680            (if (search-forward "\ndate:" nil t)
 681                (nnheader-header-value) ""))
 682          ;; Message-ID.
 683          (progn
 684            (goto-char p)
 685            (if (search-forward "\nmessage-id:" nil t)
 686                (buffer-substring
 687                 (1- (or (search-forward "<" (point-at-eol) t)
 688                         (point)))
 689                 (or (search-forward ">" (point-at-eol) t) (point)))
 690              ;; If there was no message-id, we just fake one to make
 691              ;; subsequent routines simpler.
 692              (nnheader-generate-fake-message-id number)))
 693          ;; References.
 694          (progn
 695            (goto-char p)
 696            (if (search-forward "\nreferences:" nil t)
 697                (nnheader-header-value)
 698              ;; Get the references from the in-reply-to header if
 699              ;; there were no references and the in-reply-to header
 700              ;; looks promising.
 701              (if (and (search-forward "\nin-reply-to:" nil t)
 702                       (setq in-reply-to (nnheader-header-value))
 703                       (string-match "<[^\n>]+>" in-reply-to))
 704                  (let (ref2)
 705                    (setq ref (substring in-reply-to (match-beginning 0)
 706                                         (match-end 0)))
 707                    (while (string-match "<[^\n>]+>"
 708                                         in-reply-to (match-end 0))
 709                      (setq ref2 (substring in-reply-to (match-beginning 0)
 710                                            (match-end 0)))
 711                      (when (> (length ref2) (length ref))
 712                        (setq ref ref2)))
 713                    ref)
 714                nil)))
 715          ;; Chars.
 716          0
 717          ;; Lines.
 718          (progn
 719            (goto-char p)
 720            (if (search-forward "\nlines: " nil t)
 721                (if (numberp (setq lines (read cur)))
 722                    lines 0)
 723              0))
 724          ;; Xref.
 725          (progn
 726            (goto-char p)
 727            (and (search-forward "\nxref:" nil t)
 728                 (nnheader-header-value)))
 729          ;; Extra.
 730          (when nnmail-extra-headers
 731            (let ((extra nnmail-extra-headers)
 732                  out)
 733              (while extra
 734                (goto-char p)
 735                (when (search-forward
 736                       (concat "\n" (symbol-name (car extra)) ":") nil t)
 737                  (push (cons (car extra) (nnheader-header-value))
 738                        out))
 739                (pop extra))
 740              out)))
 741       (goto-char p)
 742       (delete-char 1))))
 743
 744 (defun nnheader-parse-head (&optional naked)
 745   (let ((cur (current-buffer)) num beg end)
 746     (when (if naked
 747               (setq num 0
 748                     beg (point-min)
 749                     end (point-max))
 750             (goto-char (point-min))
 751             ;; Search to the beginning of the next header.  Error
 752             ;; messages do not begin with 2 or 3.
 753             (when (re-search-forward "^[23][0-9]+ " nil t)
 754               (end-of-line)
 755               (setq num (read cur)
 756                     beg (point)
 757                     end (if (search-forward "\n.\n" nil t)
 758                             (- (point) 2)
 759                           (point)))))
 760       (with-temp-buffer
 761         (insert-buffer-substring cur beg end)
 762         (nnheader-parse-naked-head num)))))
 763
 764 (defmacro nnheader-nov-skip-field ()
 765   '(search-forward "\t" eol 'move))
 766
 767 (defmacro nnheader-nov-field ()
 768   '(buffer-substring (point) (if (nnheader-nov-skip-field) (1- (point)) eol)))
 769
 770 (defmacro nnheader-nov-read-integer ()
 771   '(prog1
 772        (if (eq (char-after) ?\t)
 773            0
 774          (let ((num (condition-case nil
 775                         (read (current-buffer))
 776                       (error nil))))
 777            (if (numberp num) num 0)))
 778      (unless (eobp)
 779        (search-forward "\t" eol 'move))))
 780
 781 (defmacro nnheader-nov-parse-extra ()
 782   '(let (out string)
 783      (while (not (memq (char-after) '(?\n nil)))
 784        (setq string (nnheader-nov-field))
 785        (when (string-match "^\\([^ :]+\\): " string)
 786          (push (cons (intern (match-string 1 string))
 787                      (substring string (match-end 0)))
 788                out)))
 789      out))
 790
 791 (defvar nnheader-uniquify-message-id nil)
 792
 793 (defmacro nnheader-nov-read-message-id (&optional number)
 794   `(let ((id (nnheader-nov-field)))
 795      (if (string-match "^<[^>]+>$" id)
 796          ,(if nnheader-uniquify-message-id
 797               `(if (string-match "__[^@]+@" id)
 798                    (concat (substring id 0 (match-beginning 0))
 799                            (substring id (1- (match-end 0))))
 800                  id)
 801             'id)
 802        (nnheader-generate-fake-message-id ,number))))
 803
 804 (defun nnheader-parse-nov ()
 805   (let* ((eol (point-at-eol))
 806          (number (nnheader-nov-read-integer)))
 807     (make-full-mail-header
 808      number                             ; number
 809      (nnheader-nov-field)               ; subject
 810      (nnheader-nov-field)               ; from
 811      (nnheader-nov-field)               ; date
 812      (nnheader-nov-read-message-id number) ; id
 813      (nnheader-nov-field)               ; refs
 814      (nnheader-nov-read-integer)        ; chars
 815      (nnheader-nov-read-integer)        ; lines
 816      (if (eq (char-after) ?\n)
 817          nil
 818        (if (looking-at "Xref: ")
 819            (goto-char (match-end 0)))
 820        (nnheader-nov-field))            ; Xref
 821      (nnheader-nov-parse-extra))))      ; extra
 822
 823 (defun nnheader-insert-nov (header)
 824   (princ (mail-header-number header) (current-buffer))
 825   (let ((p (point)))
 826     (insert
 827      "\t"
 828      (or (mime-entity-fetch-field header 'Subject) "(none)") "\t"
 829      (or (mime-entity-fetch-field header 'From) "(nobody)") "\t"
 830      (or (mail-header-date header) "") "\t"
 831      (or (mail-header-id header)
 832          (nnmail-message-id))
 833      "\t"
 834      (or (mail-header-references header) "") "\t")
 835     (princ (or (mail-header-chars header) 0) (current-buffer))
 836     (insert "\t")
 837     (princ (or (mail-header-lines header) 0) (current-buffer))
 838     (insert "\t")
 839     (when (mail-header-xref header)
 840       (insert "Xref: " (mail-header-xref header)))
 841     (when (or (mail-header-xref header)
 842               (mail-header-extra header))
 843       (insert "\t"))
 844     (when (mail-header-extra header)
 845       (let ((extra (mail-header-extra header)))
 846         (while extra
 847           (insert (symbol-name (caar extra))
 848                   ": " (cdar extra) "\t")
 849           (pop extra))))
 850     (insert "\n")
 851     (backward-char 1)
 852     (while (search-backward "\n" p t)
 853       (delete-char 1))
 854     (forward-line 1)))
 855
 856 (defun nnheader-parse-overview-file (file)
 857   "Parse FILE and return a list of headers."
 858   (mm-with-unibyte-buffer
 859     (nnheader-insert-file-contents file)
 860     (goto-char (point-min))
 861     (let (headers)
 862       (while (not (eobp))
 863         (push (nnheader-parse-nov) headers)
 864         (forward-line 1))
 865       (nreverse headers))))
 866
 867 (defun nnheader-write-overview-file (file headers)
 868   "Write HEADERS to FILE."
 869   (with-temp-file file
 870     (mapcar 'nnheader-insert-nov headers)))
 871
 872 (defun nnheader-insert-header (header)
 873   (insert
 874    "Subject: " (or (mail-header-subject header) "(none)") "\n"
 875    "From: " (or (mail-header-from header) "(nobody)") "\n"
 876    "Date: " (or (mail-header-date header) "") "\n"
 877    "Message-ID: " (or (mail-header-id header) (nnmail-message-id)) "\n"
 878    "References: " (or (mail-header-references header) "") "\n"
 879    "Lines: ")
 880   (princ (or (mail-header-lines header) 0) (current-buffer))
 881   (insert "\n\n"))
 882
 883 (defun nnheader-insert-article-line (article)
 884   (goto-char (point-min))
 885   (insert "220 ")
 886   (princ article (current-buffer))
 887   (insert " Article retrieved.\n")
 888   (search-forward "\n\n" nil 'move)
 889   (delete-region (point) (point-max))
 890   (forward-char -1)
 891   (insert "."))
 892
 893 (defun nnheader-nov-delete-outside-range (beg end)
 894   "Delete all NOV lines that lie outside the BEG to END range."
 895   ;; First we find the first wanted line.
 896   (nnheader-find-nov-line beg)
 897   (delete-region (point-min) (point))
 898   ;; Then we find the last wanted line.
 899   (when (nnheader-find-nov-line end)
 900     (forward-line 1))
 901   (delete-region (point) (point-max)))
 902
 903 (defun nnheader-find-nov-line (article)
 904   "Put point at the NOV line that start with ARTICLE.
 905 If ARTICLE doesn't exist, put point where that line
 906 would have been.  The function will return non-nil if
 907 the line could be found."
 908   ;; This function basically does a binary search.
 909   (let ((max (point-max))
 910         (min (goto-char (point-min)))
 911         (cur (current-buffer))
 912         (prev (point-min))
 913         num found)
 914     (while (not found)
 915       (goto-char (+ min (/ (- max min) 2)))
 916       (beginning-of-line)
 917       (if (or (= (point) prev)
 918               (eobp))
 919           (setq found t)
 920         (setq prev (point))
 921         (while (and (not (numberp (setq num (read cur))))
 922                     (not (eobp)))
 923           (gnus-delete-line))
 924         (cond ((> num article)
 925                (setq max (point)))
 926               ((< num article)
 927                (setq min (point)))
 928               (t
 929                (setq found 'yes)))))
 930     ;; We may be at the first line.
 931     (when (and (not num)
 932                (not (eobp)))
 933       (setq num (read cur)))
 934     ;; Now we may have found the article we're looking for, or we
 935     ;; may be somewhere near it.
 936     (when (and (not (eq found 'yes))
 937                (not (eq num article)))
 938       (setq found (point))
 939       (while (and (< (point) max)
 940                   (or (not (numberp num))
 941                       (< num article)))
 942         (forward-line 1)
 943         (setq found (point))
 944         (or (eobp)
 945             (= (setq num (read cur)) article)))
 946       (unless (eq num article)
 947         (goto-char found)))
 948     (beginning-of-line)
 949     (eq num article)))
 950
 951 (defun nnheader-retrieve-headers-from-directory* (articles
 952                                                   directory dependencies
 953                                                   &optional
 954                                                   fetch-old force-new large
 955                                                   backend)
 956   (with-temp-buffer
 957     (let* ((file nil)
 958            (number (length articles))
 959            (count 0)
 960            (file-name-coding-system 'binary)
 961            (case-fold-search t)
 962            (cur (current-buffer))
 963            article
 964            headers header id end ref in-reply-to lines chars ctype)
 965       ;; We don't support fetching by Message-ID.
 966       (if (stringp (car articles))
 967           'headers
 968         (while articles
 969           (when (and (file-exists-p
 970                       (setq file (expand-file-name
 971                                   (int-to-string
 972                                    (setq article (pop articles)))
 973                                   directory)))
 974                      (not (file-directory-p file)))
 975             (erase-buffer)
 976             (nnheader-insert-head file)
 977             (save-restriction
 978               (std11-narrow-to-header)
 979               (setq
 980                header
 981                (make-full-mail-header
 982                 ;; Number.
 983                 article
 984                 ;; Subject.
 985                 (or (std11-fetch-field "Subject")
 986                     "(none)")
 987                 ;; From.
 988                 (or (std11-fetch-field "From")
 989                     "(nobody)")
 990                 ;; Date.
 991                 (or (std11-fetch-field "Date")
 992                     "")
 993                 ;; Message-ID.
 994                 (progn
 995                   (goto-char (point-min))
 996                   (setq id (if (re-search-forward
 997                                 "^Message-ID: *\\(<[^\n\t> ]+>\\)" nil t)
 998                                ;; We do it this way to make sure the Message-ID
 999                                ;; is (somewhat) syntactically valid.
1000                                (buffer-substring (match-beginning 1)
1001                                                  (match-end 1))
1002                              ;; If there was no message-id, we just fake one
1003                              ;; to make subsequent routines simpler.
1004                              (nnheader-generate-fake-message-id))))
1005                 ;; References.
1006                 (progn
1007                   (goto-char (point-min))
1008                   (if (search-forward "\nReferences: " nil t)
1009                       (progn
1010                         (setq end (point))
1011                         (prog1
1012                             (buffer-substring (match-end 0) (std11-field-end))
1013                           (setq ref
1014                                 (buffer-substring
1015                                  (progn
1016                                    ;; (end-of-line)
1017                                    (search-backward ">" end t)
1018                                    (1+ (point)))
1019                                  (progn
1020                                    (search-backward "<" end t)
1021                                    (point))))))
1022                     ;; Get the references from the in-reply-to header if there
1023                     ;; were no references and the in-reply-to header looks
1024                     ;; promising.
1025                     (if (and (search-forward "\nIn-Reply-To: " nil t)
1026                              (setq in-reply-to
1027                                    (buffer-substring (match-end 0)
1028                                                      (std11-field-end)))
1029                              (string-match "<[^>]+>" in-reply-to))
1030                         (let (ref2)
1031                           (setq ref (substring in-reply-to (match-beginning 0)
1032                                                (match-end 0)))
1033                           (while (string-match "<[^>]+>"
1034                                                in-reply-to (match-end 0))
1035                             (setq ref2
1036                                   (substring in-reply-to (match-beginning 0)
1037                                              (match-end 0)))
1038                             (when (> (length ref2) (length ref))
1039                               (setq ref ref2)))
1040                           ref)
1041                       (setq ref nil))))
1042                 ;; Chars.
1043                 (progn
1044                   (goto-char (point-min))
1045                   (if (search-forward "\nChars: " nil t)
1046                       (if (numberp (setq chars (ignore-errors (read cur))))
1047                           chars 0)
1048                     0))
1049                 ;; Lines.
1050                 (progn
1051                   (goto-char (point-min))
1052                   (if (search-forward "\nLines: " nil t)
1053                       (if (numberp (setq lines (ignore-errors (read cur))))
1054                           lines 0)
1055                     0))
1056                 ;; Xref.
1057                 (std11-fetch-field "Xref")
1058                 ))
1059               (goto-char (point-min))
1060               (if (setq ctype (std11-fetch-field "Content-Type"))
1061                   (mime-entity-set-content-type-internal
1062                    header (mime-parse-Content-Type ctype)))
1063               )
1064             (when (setq header
1065                         (gnus-dependencies-add-header
1066                          header dependencies force-new))
1067               (push header headers))
1068             )
1069           (setq count (1+ count))
1070
1071           (and large
1072                (zerop (% count 20))
1073                (nnheader-message 5 "%s: Receiving headers... %d%%"
1074                                  backend
1075                                  (/ (* count 100) number))))
1076
1077         (when large
1078           (nnheader-message 5 "%s: Receiving headers...done" backend))
1079
1080         headers))))
1081
1082 (defun nnheader-retrieve-headers-from-directory (articles
1083                                                  directory dependencies
1084                                                  &optional
1085                                                  fetch-old force-new large
1086                                                  backend)
1087   (cons 'header
1088         (nreverse (nnheader-retrieve-headers-from-directory*
1089                    articles directory dependencies
1090                    fetch-old force-new large backend))))
1091
1092 (defun nnheader-get-newsgroup-headers-xover* (sequence
1093                                               &optional
1094                                               force-new dependencies
1095                                               group)
1096   "Parse the news overview data in the server buffer, and return a
1097 list of headers that match SEQUENCE (see `nntp-retrieve-headers')."
1098   ;; Get the Xref when the users reads the articles since most/some
1099   ;; NNTP servers do not include Xrefs when using XOVER.
1100   ;; (setq gnus-article-internal-prepare-hook '(gnus-article-get-xrefs))
1101   (let ((cur nntp-server-buffer)
1102         number headers header)
1103     (save-excursion
1104       (set-buffer nntp-server-buffer)
1105       ;; Allow the user to mangle the headers before parsing them.
1106       (gnus-run-hooks 'gnus-parse-headers-hook)
1107       (goto-char (point-min))
1108       (while (not (eobp))
1109         (condition-case ()
1110             (while (and sequence (not (eobp)))
1111               (setq number (read cur))
1112               (while (and sequence
1113                           (< (car sequence) number))
1114                 (setq sequence (cdr sequence)))
1115               (and sequence
1116                    (eq number (car sequence))
1117                    (progn
1118                      (setq sequence (cdr sequence))
1119                      (setq header (inline
1120                                     (gnus-nov-parse-line
1121                                      number dependencies force-new))))
1122                    (push header headers))
1123               (forward-line 1))
1124           (error
1125            (gnus-error 4 "Strange nov line (%d)"
1126                        (count-lines (point-min) (point)))))
1127         (forward-line 1))
1128       ;; A common bug in inn is that if you have posted an article and
1129       ;; then retrieves the active file, it will answer correctly --
1130       ;; the new article is included.  However, a NOV entry for the
1131       ;; article may not have been generated yet, so this may fail.
1132       ;; We work around this problem by retrieving the last few
1133       ;; headers using HEAD.
1134       headers)))
1135
1136 ;; Various cruft the backends and Gnus need to communicate.
1137
1138 (defvar nntp-server-buffer nil)
1139 (defvar nntp-process-response nil)
1140 (defvar news-reply-yank-from nil)
1141 (defvar news-reply-yank-message-id nil)
1142
1143 (defvar nnheader-callback-function nil)
1144
1145 (defun nnheader-init-server-buffer ()
1146   "Initialize the Gnus-backend communication buffer."
1147   (save-excursion
1148     (unless (gnus-buffer-live-p nntp-server-buffer)
1149       (setq nntp-server-buffer (get-buffer-create " *nntpd*")))
1150     (set-buffer nntp-server-buffer)
1151     (erase-buffer)
1152     (kill-all-local-variables)
1153     (setq case-fold-search t)           ;Should ignore case.
1154     (set (make-local-variable 'nntp-process-response) nil)
1155     t))
1156
1157 ;;; Various functions the backends use.
1158
1159 (defun nnheader-file-error (file)
1160   "Return a string that says what is wrong with FILE."
1161   (format
1162    (cond
1163     ((not (file-exists-p file))
1164      "%s does not exist")
1165     ((file-directory-p file)
1166      "%s is a directory")
1167     ((not (file-readable-p file))
1168      "%s is not readable"))
1169    file))
1170
1171 (defun nnheader-insert-head (file)
1172   "Insert the head of the article."
1173   (when (file-exists-p file)
1174     (if (eq nnheader-max-head-length t)
1175         ;; Just read the entire file.
1176         (nnheader-insert-file-contents file)
1177       ;; Read 1K blocks until we find a separator.
1178       (let ((beg 0)
1179             format-alist)
1180         (while (and (eq nnheader-head-chop-length
1181                         (nth 1 (nnheader-insert-file-contents
1182                                 file nil beg
1183                                 (incf beg nnheader-head-chop-length))))
1184                     (prog1 (not (search-forward "\n\n" nil t))
1185                       (goto-char (point-max)))
1186                     (or (null nnheader-max-head-length)
1187                         (< beg nnheader-max-head-length))))))
1188     t))
1189
1190 (defun nnheader-article-p ()
1191   "Say whether the current buffer looks like an article."
1192   (goto-char (point-min))
1193   (if (not (search-forward "\n\n" nil t))
1194       nil
1195     (narrow-to-region (point-min) (1- (point)))
1196     (goto-char (point-min))
1197     (while (looking-at "[a-zA-Z][^ \t]+:.*\n\\([ \t].*\n\\)*\\|From .*\n")
1198       (goto-char (match-end 0)))
1199     (prog1
1200         (eobp)
1201       (widen))))
1202
1203 (defun nnheader-insert-references (references message-id)
1204   "Insert a References header based on REFERENCES and MESSAGE-ID."
1205   (if (and (not references) (not message-id))
1206       ;; This is invalid, but not all articles have Message-IDs.
1207       ()
1208     (mail-position-on-field "References")
1209     (let ((begin (point-at-bol))
1210           (fill-column 78)
1211           (fill-prefix "\t"))
1212       (when references
1213         (insert references))
1214       (when (and references message-id)
1215         (insert " "))
1216       (when message-id
1217         (insert message-id))
1218       ;; Fold long References lines to conform to RFC1036 (sort of).
1219       ;; The region must end with a newline to fill the region
1220       ;; without inserting extra newline.
1221       (fill-region-as-paragraph begin (1+ (point))))))
1222
1223 (defun nnheader-replace-header (header new-value)
1224   "Remove HEADER and insert the NEW-VALUE."
1225   (save-excursion
1226     (save-restriction
1227       (nnheader-narrow-to-headers)
1228       (prog1
1229           (message-remove-header header)
1230         (goto-char (point-max))
1231         (insert header ": " new-value "\n")))))
1232
1233 (defun nnheader-narrow-to-headers ()
1234   "Narrow to the head of an article."
1235   (widen)
1236   (narrow-to-region
1237    (goto-char (point-min))
1238    (if (search-forward "\n\n" nil t)
1239        (1- (point))
1240      (point-max)))
1241   (goto-char (point-min)))
1242
1243 (defun nnheader-get-lines-and-char ()
1244   "Return the number of lines and chars in the article body."
1245   (goto-char (point-min))
1246   (if (not (re-search-forward "\n\r?\n" nil t))
1247       (list 0 0)
1248     (list (count-lines (point) (point-max))
1249           (- (point-max) (point)))))
1250
1251 (defun nnheader-remove-body ()
1252   "Remove the body from an article in this current buffer."
1253   (goto-char (point-min))
1254   (when (re-search-forward "\n\r?\n" nil t)
1255     (delete-region (point) (point-max))))
1256
1257 (defun nnheader-set-temp-buffer (name &optional noerase)
1258   "Set-buffer to an empty (possibly new) buffer called NAME with undo disabled."
1259   (set-buffer (get-buffer-create name))
1260   (buffer-disable-undo)
1261   (unless noerase
1262     (erase-buffer))
1263   (current-buffer))
1264
1265 (eval-when-compile (defvar jka-compr-compression-info-list))
1266 (defvar nnheader-numerical-files
1267   (if (boundp 'jka-compr-compression-info-list)
1268       (concat "\\([0-9]+\\)\\("
1269               (mapconcat (lambda (i) (aref i 0))
1270                          jka-compr-compression-info-list "\\|")
1271               "\\)?")
1272     "[0-9]+$")
1273   "Regexp that match numerical files.")
1274
1275 (defvar nnheader-numerical-short-files (concat "^" nnheader-numerical-files)
1276   "Regexp that matches numerical file names.")
1277
1278 (defvar nnheader-numerical-full-files (concat "/" nnheader-numerical-files)
1279   "Regexp that matches numerical full file names.")
1280
1281 (defsubst nnheader-file-to-number (file)
1282   "Take a FILE name and return the article number."
1283   (if (string= nnheader-numerical-short-files "^[0-9]+$")
1284       (string-to-int file)
1285     (string-match nnheader-numerical-short-files file)
1286     (string-to-int (match-string 0 file))))
1287
1288 (defvar nnheader-directory-files-is-safe
1289   (or (eq system-type 'windows-nt)
1290       (not (featurep 'xemacs)))
1291   "If non-nil, Gnus believes `directory-files' is safe.
1292 It has been reported numerous times that `directory-files' fails with
1293 an alarming frequency on NFS mounted file systems. If it is nil,
1294 `nnheader-directory-files-safe' is used.")
1295
1296 (defun nnheader-directory-files-safe (&rest args)
1297   "Execute `directory-files' twice and returns the longer result."
1298   (let ((first (apply 'directory-files args))
1299         (second (apply 'directory-files args)))
1300     (if (> (length first) (length second))
1301         first
1302       second)))
1303
1304 (defun nnheader-directory-articles (dir)
1305   "Return a list of all article files in directory DIR."
1306   (mapcar 'nnheader-file-to-number
1307           (if nnheader-directory-files-is-safe
1308               (directory-files
1309                dir nil nnheader-numerical-short-files t)
1310             (nnheader-directory-files-safe
1311              dir nil nnheader-numerical-short-files t))))
1312
1313 (defun nnheader-article-to-file-alist (dir)
1314   "Return an alist of article/file pairs in DIR."
1315   (mapcar (lambda (file) (cons (nnheader-file-to-number file) file))
1316           (if nnheader-directory-files-is-safe
1317               (directory-files
1318                dir nil nnheader-numerical-short-files t)
1319             (nnheader-directory-files-safe
1320              dir nil nnheader-numerical-short-files t))))
1321
1322 (defun nnheader-fold-continuation-lines ()
1323   "Fold continuation lines in the current buffer."
1324   (nnheader-replace-regexp "\\(\r?\n[ \t]+\\)+" " "))
1325
1326 (defun nnheader-translate-file-chars (file &optional full)
1327   "Translate FILE into something that can be a file name.
1328 If FULL, translate everything."
1329   (if (null nnheader-file-name-translation-alist)
1330       ;; No translation is necessary.
1331       file
1332     (let* ((i 0)
1333            trans leaf path len)
1334       (if full
1335           ;; Do complete translation.
1336           (setq leaf (copy-sequence file)
1337                 path ""
1338                 i (if (and (< 1 (length leaf)) (eq ?: (aref leaf 1)))
1339                       2 0))
1340         ;; We translate -- but only the file name.  We leave the directory
1341         ;; alone.
1342         (if (and (featurep 'xemacs)
1343                  (memq system-type '(cygwin32 win32 w32 mswindows windows-nt
1344                                               cygwin)))
1345             ;; This is needed on NT and stuff, because
1346             ;; file-name-nondirectory is not enough to split
1347             ;; file names, containing ':', e.g.
1348             ;; "d:\\Work\\News\\nntp+news.fido7.ru:fido7.ru.gnu.SCORE"
1349             ;;
1350             ;; we are trying to correctly split such names:
1351             ;; "d:file.name" -> "a:" "file.name"
1352             ;; "aaa:bbb.ccc" -> "" "aaa:bbb.ccc"
1353             ;; "d:aaa\\bbb:ccc"   -> "d:aaa\\" "bbb:ccc"
1354             ;; etc.
1355             ;; to translate then only the file name part.
1356             (progn
1357               (setq leaf file
1358                     path "")
1359               (if (string-match "\\(^\\w:\\|[/\\]\\)\\([^/\\]+\\)$" file)
1360                   (setq leaf (substring file (match-beginning 2))
1361                         path (substring file 0 (match-beginning 2)))))
1362           ;; Emacs DTRT, says andrewi.
1363           (setq leaf (file-name-nondirectory file)
1364                 path (file-name-directory file))))
1365       (setq len (length leaf))
1366       (while (< i len)
1367         (when (setq trans (cdr (assq (aref leaf i)
1368                                      nnheader-file-name-translation-alist)))
1369           (aset leaf i trans))
1370         (incf i))
1371       (concat path leaf))))
1372
1373 (defun nnheader-report (backend &rest args)
1374   "Report an error from the BACKEND.
1375 The first string in ARGS can be a format string."
1376   (set (intern (format "%s-status-string" backend))
1377        (if (< (length args) 2)
1378            (car args)
1379          (apply 'format args)))
1380   nil)
1381
1382 (defun nnheader-get-report (backend)
1383   "Get the most recent report from BACKEND."
1384   (condition-case ()
1385       (nnheader-message 5 "%s" (symbol-value (intern (format "%s-status-string"
1386                                                              backend))))
1387     (error (nnheader-message 5 ""))))
1388
1389 (defun nnheader-insert (format &rest args)
1390   "Clear the communication buffer and insert FORMAT and ARGS into the buffer.
1391 If FORMAT isn't a format string, it and all ARGS will be inserted
1392 without formatting."
1393   (save-excursion
1394     (set-buffer nntp-server-buffer)
1395     (erase-buffer)
1396     (if (string-match "%" format)
1397         (insert (apply 'format format args))
1398       (apply 'insert format args))
1399     t))
1400
1401 (static-if (fboundp 'subst-char-in-string)
1402     (defsubst nnheader-replace-chars-in-string (string from to)
1403       (subst-char-in-string from to string))
1404   (defun nnheader-replace-chars-in-string (string from to)
1405     "Replace characters in STRING from FROM to TO."
1406     (let ((string (substring string 0)) ;Copy string.
1407           (len (length string))
1408           (idx 0))
1409       ;; Replace all occurrences of FROM with TO.
1410       (while (< idx len)
1411         (when (= (aref string idx) from)
1412           (aset string idx to))
1413         (setq idx (1+ idx)))
1414       string)))
1415
1416 (defun nnheader-replace-duplicate-chars-in-string (string from to)
1417   "Replace characters in STRING from FROM to TO."
1418   (let ((string (substring string 0))   ;Copy string.
1419         (len (length string))
1420         (idx 0) prev i)
1421     ;; Replace all occurrences of FROM with TO.
1422     (while (< idx len)
1423       (setq i (aref string idx))
1424       (when (and (eq prev from) (= i from))
1425         (aset string (1- idx) to)
1426         (aset string idx to))
1427       (setq prev i)
1428       (setq idx (1+ idx)))
1429     string))
1430
1431 (defun nnheader-file-to-group (file &optional top)
1432   "Return a group name based on FILE and TOP."
1433   (nnheader-replace-chars-in-string
1434    (if (not top)
1435        file
1436      (condition-case ()
1437          (substring (expand-file-name file)
1438                     (length
1439                      (expand-file-name
1440                       (file-name-as-directory top))))
1441        (error "")))
1442    nnheader-directory-separator-character ?.))
1443
1444 (defun nnheader-message (level &rest args)
1445   "Message if the Gnus backends are talkative."
1446   (if (or (not (numberp gnus-verbose-backends))
1447           (<= level gnus-verbose-backends))
1448       (apply 'message args)
1449     (apply 'format args)))
1450
1451 (defun nnheader-be-verbose (level)
1452   "Return whether the backends should be verbose on LEVEL."
1453   (or (not (numberp gnus-verbose-backends))
1454       (<= level gnus-verbose-backends)))
1455
1456 (defvar nnheader-pathname-coding-system 'binary
1457   "*Coding system for file name.")
1458
1459 (defun nnheader-group-pathname (group dir &optional file)
1460   "Make file name for GROUP."
1461   (concat
1462    (let ((dir (file-name-as-directory (expand-file-name dir))))
1463      ;; If this directory exists, we use it directly.
1464      (file-name-as-directory
1465       (if (file-directory-p (concat dir group))
1466           (expand-file-name group dir)
1467         ;; If not, we translate dots into slashes.
1468         (expand-file-name (encode-coding-string
1469                            (nnheader-replace-chars-in-string group ?. ?/)
1470                            nnheader-pathname-coding-system)
1471                           dir))))
1472    (cond ((null file) "")
1473          ((numberp file) (int-to-string file))
1474          (t file))))
1475
1476 (defun nnheader-concat (dir &rest files)
1477   "Concat DIR as directory to FILES."
1478   (apply 'concat (file-name-as-directory dir) files))
1479
1480 (defun nnheader-ms-strip-cr ()
1481   "Strip ^M from the end of all lines."
1482   (save-excursion
1483     (nnheader-remove-cr-followed-by-lf)))
1484
1485 (defun nnheader-file-size (file)
1486   "Return the file size of FILE or 0."
1487   (or (nth 7 (file-attributes file)) 0))
1488
1489 (defun nnheader-find-etc-directory (package &optional file first)
1490   "Go through `load-path' and find the \"../etc/PACKAGE\" directory.
1491 This function will look in the parent directory of each `load-path'
1492 entry, and look for the \"etc\" directory there.
1493 If FILE, find the \".../etc/PACKAGE\" file instead.
1494 If FIRST is non-nil, return the directory or the file found at the
1495 first.  Otherwise, find the newest one, though it may take a time."
1496   (let ((path load-path)
1497         dir results)
1498     ;; We try to find the dir by looking at the load path,
1499     ;; stripping away the last component and adding "etc/".
1500     (while path
1501       (if (and (car path)
1502                (file-exists-p
1503                 (setq dir (concat
1504                            (file-name-directory
1505                             (directory-file-name (car path)))
1506                            "etc/" package
1507                            (if file "" "/"))))
1508                (or file (file-directory-p dir)))
1509           (progn
1510             (or (member dir results)
1511                 (push dir results))
1512             (setq path (if first nil (cdr path))))
1513         (setq path (cdr path))))
1514     (if (or first (not (cdr results)))
1515         (car results)
1516       (car (sort results 'file-newer-than-file-p)))))
1517
1518 (eval-when-compile
1519   (defvar ange-ftp-path-format)
1520   (defvar efs-path-regexp))
1521 (defun nnheader-re-read-dir (path)
1522   "Re-read directory PATH if PATH is on a remote system."
1523   (if (and (fboundp 'efs-re-read-dir) (boundp 'efs-path-regexp))
1524       (when (string-match efs-path-regexp path)
1525         (efs-re-read-dir path))
1526     (when (and (fboundp 'ange-ftp-re-read-dir) (boundp 'ange-ftp-path-format))
1527       (when (string-match (car ange-ftp-path-format) path)
1528         (ange-ftp-re-read-dir path)))))
1529
1530 (defvar nnheader-file-coding-system 'raw-text
1531   "Coding system used in file backends of Gnus.")
1532
1533 (defun nnheader-insert-file-contents (filename &optional visit beg end replace)
1534   "Like `insert-file-contents', q.v., but only reads in the file.
1535 A buffer may be modified in several ways after reading into the buffer due
1536 to advanced Emacs features, such as file-name-handlers, format decoding,
1537 find-file-hooks, etc.
1538   This function ensures that none of these modifications will take place."
1539   (let ((format-alist nil)
1540         (auto-mode-alist (nnheader-auto-mode-alist))
1541         (default-major-mode 'fundamental-mode)
1542         (enable-local-variables nil)
1543         (after-insert-file-functions nil)
1544         (enable-local-eval nil)
1545         (find-file-hooks nil))
1546     (insert-file-contents-as-coding-system
1547      nnheader-file-coding-system filename visit beg end replace)))
1548
1549 (defun nnheader-insert-nov-file (file first)
1550   (let ((size (nth 7 (file-attributes file)))
1551         (cutoff (* 32 1024)))
1552     (when size
1553       (if (< size cutoff)
1554           ;; If the file is small, we just load it.
1555           (nnheader-insert-file-contents file)
1556         ;; We start on the assumption that FIRST is pretty recent.  If
1557         ;; not, we just insert the rest of the file as well.
1558         (let (current)
1559           (nnheader-insert-file-contents file nil (- size cutoff) size)
1560           (goto-char (point-min))
1561           (delete-region (point) (or (search-forward "\n" nil 'move) (point)))
1562           (setq current (ignore-errors (read (current-buffer))))
1563           (if (and (numberp current)
1564                    (< current first))
1565               t
1566             (delete-region (point-min) (point-max))
1567             (nnheader-insert-file-contents file)))))))
1568
1569 (defun nnheader-find-file-noselect (&rest args)
1570   (let ((format-alist nil)
1571         (auto-mode-alist (nnheader-auto-mode-alist))
1572         (default-major-mode 'fundamental-mode)
1573         (enable-local-variables nil)
1574         (after-insert-file-functions nil)
1575         (enable-local-eval nil)
1576         (find-file-hooks nil))
1577     (apply 'find-file-noselect-as-coding-system
1578            nnheader-file-coding-system args)))
1579
1580 (defun nnheader-auto-mode-alist ()
1581   "Return an `auto-mode-alist' with only the .gz (etc) thingies."
1582   (let ((alist auto-mode-alist)
1583         out)
1584     (while alist
1585       (when (listp (cdar alist))
1586         (push (car alist) out))
1587       (pop alist))
1588     (nreverse out)))
1589
1590 (defun nnheader-directory-regular-files (dir)
1591   "Return a list of all regular files in DIR."
1592   (let ((files (directory-files dir t))
1593         out)
1594     (while files
1595       (when (file-regular-p (car files))
1596         (push (car files) out))
1597       (pop files))
1598     (nreverse out)))
1599
1600 (defun nnheader-directory-files (&rest args)
1601   "Same as `directory-files', but prune \".\" and \"..\"."
1602   (let ((files (apply 'directory-files args))
1603         out)
1604     (while files
1605       (unless (member (file-name-nondirectory (car files)) '("." ".."))
1606         (push (car files) out))
1607       (pop files))
1608     (nreverse out)))
1609
1610 (defmacro nnheader-skeleton-replace (from &optional to regexp)
1611   `(let ((new (generate-new-buffer " *nnheader replace*"))
1612          (cur (current-buffer))
1613          (start (point-min)))
1614      (set-buffer cur)
1615      (goto-char (point-min))
1616      (while (,(if regexp 're-search-forward 'search-forward)
1617              ,from nil t)
1618        (insert-buffer-substring
1619         cur start (prog1 (match-beginning 0) (set-buffer new)))
1620        (goto-char (point-max))
1621        ,(when to `(insert ,to))
1622        (set-buffer cur)
1623        (setq start (point)))
1624      (insert-buffer-substring
1625       cur start (prog1 (point-max) (set-buffer new)))
1626      (copy-to-buffer cur (point-min) (point-max))
1627      (kill-buffer (current-buffer))
1628      (set-buffer cur)))
1629
1630 (defun nnheader-replace-string (from to)
1631   "Do a fast replacement of FROM to TO from point to `point-max'."
1632   (nnheader-skeleton-replace from to))
1633
1634 (defun nnheader-replace-regexp (from to)
1635   "Do a fast regexp replacement of FROM to TO from point to `point-max'."
1636   (nnheader-skeleton-replace from to t))
1637
1638 (defun nnheader-strip-cr ()
1639   "Strip all \r's from the current buffer."
1640   (nnheader-skeleton-replace "\r"))
1641
1642 (defalias 'nnheader-cancel-timer 'cancel-timer)
1643 (defalias 'nnheader-cancel-function-timers 'cancel-function-timers)
1644 (defalias 'nnheader-string-as-multibyte 'string-as-multibyte)
1645
1646 (defun nnheader-Y-or-n-p (prompt)
1647   "Ask user a \"Y/n\" question. Return t if answer is neither \"n\", \"N\" nor \"C-g\"."
1648   (let ((cursor-in-echo-area t)
1649         (echo-keystrokes 0)
1650         (inhibit-quit t)
1651         ans)
1652     (let (message-log-max)
1653       (while (not (memq ans '(?\  ?N ?Y ?\C-g ?\e ?\n ?\r ?n ?y)))
1654         (message "%s(Y/n) " prompt)
1655         (setq ans (read-char-exclusive))))
1656     (if (memq ans '(?\C-g ?N ?n))
1657         (progn
1658           (message "%s(Y/n) No" prompt)
1659           nil)
1660       (message "%s(Y/n) Yes" prompt)
1661       t)))
1662
1663 (defun-maybe shell-command-to-string (command)
1664   "Execute shell command COMMAND and return its output as a string."
1665   (with-output-to-string
1666     (with-current-buffer
1667         standard-output
1668       (call-process shell-file-name nil t nil shell-command-switch command))))
1669
1670 (defun nnheader-accept-process-output (process)
1671   (accept-process-output
1672    process
1673    (truncate nnheader-read-timeout)
1674    (truncate (* (- nnheader-read-timeout
1675                    (truncate nnheader-read-timeout))
1676                 1000))))
1677
1678 (when (featurep 'xemacs)
1679   (require 'nnheaderxm))
1680
1681 (run-hooks 'nnheader-load-hook)
1682
1683 (provide 'nnheader)
1684
1685 ;;; nnheader.el ends here