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