cgit.sxemacs.org Git - gnus/blob - lisp/nnheader.el

   1 ;;; nnheader.el --- header access macros for Gnus and its backends
   2 ;; Copyright (C) 1987,88,89,90,93,94,95 Free Software Foundation, Inc.
   3
   4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   5 ;;      Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 ;;; Commentary:
  25
  26 ;; These macros may look very much like the ones in GNUS 4.1. They
  27 ;; are, in a way, but you should note that the indices they use have
  28 ;; been changed from the internal GNUS format to the NOV format. Makes
  29 ;; it possible to read headers from XOVER much faster.
  30 ;;
  31 ;; The format of a header is now:
  32 ;; [number subject from date id references chars lines xref]
  33 ;;
  34 ;; (That last entry is defined as "misc" in the NOV format, but Gnus
  35 ;; uses it for xrefs.)
  36
  37 ;;; Code:
  38
  39 (require 'mail-utils)
  40
  41 (defvar nnheader-max-head-length 4096
  42   "*Max length of the head of articles.")
  43
  44 (defalias 'nntp-header-number 'mail-header-number)
  45 (defmacro mail-header-number (header)
  46   "Return article number in HEADER."
  47   (` (aref (, header) 0)))
  48
  49 (defalias 'nntp-set-header-number 'mail-header-set-number)
  50 (defmacro mail-header-set-number (header number)
  51   "Set article number of HEADER to NUMBER."
  52   (` (aset (, header) 0 (, number))))
  53
  54 (defalias 'nntp-header-subject 'mail-header-subject)
  55 (defmacro mail-header-subject (header)
  56   "Return subject string in HEADER."
  57   (` (aref (, header) 1)))
  58
  59 (defalias 'nntp-set-header-subject 'mail-header-set-subject)
  60 (defmacro mail-header-set-subject (header subject)
  61   "Set article subject of HEADER to SUBJECT."
  62   (` (aset (, header) 1 (, subject))))
  63
  64 (defalias 'nntp-header-from 'mail-header-from)
  65 (defmacro mail-header-from (header)
  66   "Return author string in HEADER."
  67   (` (aref (, header) 2)))
  68
  69 (defalias 'nntp-set-header-from 'mail-header-set-from)
  70 (defmacro mail-header-set-from (header from)
  71   "Set article author of HEADER to FROM."
  72   (` (aset (, header) 2 (, from))))
  73
  74 (defalias 'nntp-header-date 'mail-header-date)
  75 (defmacro mail-header-date (header)
  76   "Return date in HEADER."
  77   (` (aref (, header) 3)))
  78
  79 (defalias 'nntp-set-header-date 'mail-header-set-date)
  80 (defmacro mail-header-set-date (header date)
  81   "Set article date of HEADER to DATE."
  82   (` (aset (, header) 3 (, date))))
  83
  84 (defalias 'nntp-header-id 'mail-header-id)
  85 (defmacro mail-header-id (header)
  86   "Return Id in HEADER."
  87   (` (aref (, header) 4)))
  88
  89 (defalias 'nntp-set-header-id 'mail-header-set-id)
  90 (defmacro mail-header-set-id (header id)
  91   "Set article Id of HEADER to ID."
  92   (` (aset (, header) 4 (, id))))
  93
  94 (defalias 'nntp-header-references 'mail-header-references)
  95 (defmacro mail-header-references (header)
  96   "Return references in HEADER."
  97   (` (aref (, header) 5)))
  98
  99 (defalias 'nntp-set-header-references 'mail-header-set-references)
 100 (defmacro mail-header-set-references (header ref)
 101   "Set article references of HEADER to REF."
 102   (` (aset (, header) 5 (, ref))))
 103
 104 (defalias 'nntp-header-chars 'mail-header-chars)
 105 (defmacro mail-header-chars (header)
 106   "Return number of chars of article in HEADER."
 107   (` (aref (, header) 6)))
 108
 109 (defalias 'nntp-set-header-chars 'mail-header-set-chars)
 110 (defmacro mail-header-set-chars (header chars)
 111   "Set number of chars in article of HEADER to CHARS."
 112   (` (aset (, header) 6 (, chars))))
 113
 114 (defalias 'nntp-header-lines 'mail-header-lines)
 115 (defmacro mail-header-lines (header)
 116   "Return lines in HEADER."
 117   (` (aref (, header) 7)))
 118
 119 (defalias 'nntp-set-header-lines 'mail-header-set-lines)
 120 (defmacro mail-header-set-lines (header lines)
 121   "Set article lines of HEADER to LINES."
 122   (` (aset (, header) 7 (, lines))))
 123
 124 (defalias 'nntp-header-xref 'mail-header-xref)
 125 (defmacro mail-header-xref (header)
 126   "Return xref string in HEADER."
 127   (` (aref (, header) 8)))
 128
 129 (defalias 'nntp-set-header-xref 'mail-header-set-xref)
 130 (defmacro mail-header-set-xref (header xref)
 131   "Set article xref of HEADER to xref."
 132   (` (aset (, header) 8 (, xref))))
 133
 134
 135 ;; Various cruft the backends and Gnus need to communicate.
 136
 137 (defvar nntp-server-buffer nil)
 138 (defvar gnus-verbose-backends t
 139   "*If non-nil, Gnus backends will generate lots of comments.")
 140 (defvar gnus-nov-is-evil nil
 141   "If non-nil, Gnus backends will never output headers in the NOV format.")
 142 (defvar news-reply-yank-from nil)
 143 (defvar news-reply-yank-message-id nil)
 144
 145 ;; All backends use this function, so I moved it to this file.
 146
 147 (defun nnheader-init-server-buffer ()
 148   (save-excursion
 149     (setq nntp-server-buffer (get-buffer-create " *nntpd*"))
 150     (set-buffer nntp-server-buffer)
 151     (buffer-disable-undo (current-buffer))
 152     (erase-buffer)
 153     (kill-all-local-variables)
 154     (setq case-fold-search t)           ;Should ignore case.
 155     t))
 156
 157 (defun nnheader-set-init-variables (server defs)
 158   (let ((s server)
 159         val)
 160     ;; First we set the server variables in the sequence required.  We
 161     ;; use the definitions from the `defs' list where that is
 162     ;; possible.
 163     (while s
 164       (set (car (car s))
 165            (if (setq val (assq (car (car s)) defs))
 166                (nth 1 val)
 167              (nth 1 (car s))))
 168       (setq s (cdr s)))
 169     ;; The we go through the defs list and set any variables that were
 170     ;; not set in the first sweep.
 171     (while defs
 172       (if (not (assq (car (car defs)) server))
 173           (set (car (car defs))
 174                (if (and (symbolp (nth 1 (car defs)))
 175                         (not (boundp (nth 1 (car defs)))))
 176                    (nth 1 (car defs))
 177                  (eval (nth 1 (car defs))))))
 178       (setq defs (cdr defs)))))
 179
 180 (defun nnheader-save-variables (server)
 181   (let (out)
 182     (while server
 183       (setq out (cons (list (car (car server))
 184                             (symbol-value (car (car server))))
 185                       out))
 186       (setq server (cdr server)))
 187     (nreverse out)))
 188
 189 (defun nnheader-restore-variables (state)
 190   (while state
 191     (set (car (car state)) (nth 1 (car state)))
 192     (setq state (cdr state))))
 193
 194 ;; Read the head of an article.
 195 (defun nnheader-insert-head (file)
 196   (if (eq nnheader-max-head-length t)
 197       ;; Just read the entire file.
 198       (nnheader-insert-file-contents-literally file)
 199     (let ((beg 0)
 200           (chop 1024))
 201       ;; Read 1K blocks until we find a separator.
 202       (while (and (eq chop (nth 1 (nnheader-insert-file-contents-literally
 203                                    file nil beg (setq beg (+ chop beg)))))
 204                   (prog1 (not (search-backward "\n\n" nil t))
 205                     (goto-char (point-max)))
 206                   (or (null nnheader-max-head-length)
 207                       (< beg nnheader-max-head-length)))))))
 208
 209 (defun nnheader-article-p ()
 210   (goto-char (point-min))
 211   (if (not (search-forward "\n\n" nil t))
 212       nil
 213     (narrow-to-region (point-min) (1- (point)))
 214     (goto-char (point-min))
 215     (while (looking-at "[A-Z][^ \t]+:.*\n\\([ \t].*\n\\)*\\|From .*\n")
 216       (goto-char (match-end 0)))
 217     (prog1
 218         (eobp)
 219       (widen))))
 220
 221 ;; Written by Erik Naggum <erik@naggum.no>.
 222 (defun nnheader-insert-file-contents-literally (filename &optional visit beg end replace)
 223   "Like `insert-file-contents', q.v., but only reads in the file.
 224 A buffer may be modified in several ways after reading into the buffer due
 225 to advanced Emacs features, such as file-name-handlers, format decoding,
 226 find-file-hooks, etc.
 227   This function ensures that none of these modifications will take place."
 228   (let (                                ; (file-name-handler-alist nil)
 229         (format-alist nil)
 230         (after-insert-file-functions nil)
 231         (find-buffer-file-type-function
 232          (if (fboundp 'find-buffer-file-type)
 233              (symbol-function 'find-buffer-file-type)
 234            nil)))
 235     (unwind-protect
 236         (progn
 237           (fset 'find-buffer-file-type (lambda (filename) t))
 238           (insert-file-contents filename visit beg end replace))
 239       (if find-buffer-file-type-function
 240           (fset 'find-buffer-file-type find-buffer-file-type-function)
 241         (fmakunbound 'find-buffer-file-type)))))
 242
 243 (defun nnheader-find-file-noselect (filename &optional nowarn rawfile)
 244   "Read file FILENAME into a buffer and return the buffer.
 245 If a buffer exists visiting FILENAME, return that one, but
 246 verify that the file has not changed since visited or saved.
 247 The buffer is not selected, just returned to the caller."
 248   (setq filename
 249         (abbreviate-file-name
 250          (expand-file-name filename)))
 251   (if (file-directory-p filename)
 252       (if find-file-run-dired
 253           (dired-noselect filename)
 254         (error "%s is a directory." filename))
 255     (let* ((buf (get-file-buffer filename))
 256            (truename (abbreviate-file-name (file-truename filename)))
 257            (number (nthcdr 10 (file-attributes truename)))
 258            ;; Find any buffer for a file which has same truename.
 259            (other (and (not buf)
 260                        (if (fboundp 'find-buffer-visiting)
 261                            (find-buffer-visiting filename)
 262                          (get-file-buffer filename))))
 263            error)
 264       ;; Let user know if there is a buffer with the same truename.
 265       (if other
 266           (progn
 267             (or nowarn
 268                 (string-equal filename (buffer-file-name other))
 269                 (message "%s and %s are the same file"
 270                          filename (buffer-file-name other)))
 271             ;; Optionally also find that buffer.
 272             (if (or (and (boundp 'find-file-existing-other-name)
 273                          find-file-existing-other-name)
 274                     find-file-visit-truename)
 275                 (setq buf other))))
 276       (if buf
 277           (or nowarn
 278               (verify-visited-file-modtime buf)
 279               (cond ((not (file-exists-p filename))
 280                      (error "File %s no longer exists!" filename))
 281                     ((yes-or-no-p
 282                       (if (string= (file-name-nondirectory filename)
 283                                    (buffer-name buf))
 284                           (format
 285                            (if (buffer-modified-p buf)
 286                                "File %s changed on disk.  Discard your edits? "
 287                              "File %s changed on disk.  Reread from disk? ")
 288                            (file-name-nondirectory filename))
 289                         (format
 290                          (if (buffer-modified-p buf)
 291                              "File %s changed on disk.  Discard your edits in %s? "
 292                            "File %s changed on disk.  Reread from disk into %s? ")
 293                          (file-name-nondirectory filename)
 294                          (buffer-name buf))))
 295                      (save-excursion
 296                        (set-buffer buf)
 297                        (revert-buffer t t)))))
 298         (save-excursion
 299 ;;; The truename stuff makes this obsolete.
 300 ;;;       (let* ((link-name (car (file-attributes filename)))
 301 ;;;              (linked-buf (and (stringp link-name)
 302 ;;;                               (get-file-buffer link-name))))
 303 ;;;         (if (bufferp linked-buf)
 304 ;;;             (message "Symbolic link to file in buffer %s"
 305 ;;;                      (buffer-name linked-buf))))
 306           (setq buf (create-file-buffer filename))
 307           ;;      (set-buffer-major-mode buf)
 308           (set-buffer buf)
 309           (erase-buffer)
 310           (if rawfile
 311               (condition-case ()
 312                   (nnheader-insert-file-contents-literally filename t)
 313                 (file-error
 314                  ;; Unconditionally set error
 315                  (setq error t)))
 316             (condition-case ()
 317                 (insert-file-contents filename t)
 318               (file-error
 319                ;; Run find-file-not-found-hooks until one returns non-nil.
 320                (or t                    ; (run-hook-with-args-until-success 'find-file-not-found-hooks)
 321                    ;; If they fail too, set error.
 322                    (setq error t)))))
 323           ;; Find the file's truename, and maybe use that as visited name.
 324           (setq buffer-file-truename truename)
 325           (setq buffer-file-number number)
 326           ;; On VMS, we may want to remember which directory in a search list
 327           ;; the file was found in.
 328           (and (eq system-type 'vax-vms)
 329                (let (logical)
 330                  (if (string-match ":" (file-name-directory filename))
 331                      (setq logical (substring (file-name-directory filename)
 332                                               0 (match-beginning 0))))
 333                  (not (member logical find-file-not-true-dirname-list)))
 334                (setq buffer-file-name buffer-file-truename))
 335           (if find-file-visit-truename
 336               (setq buffer-file-name
 337                     (setq filename
 338                           (expand-file-name buffer-file-truename))))
 339           ;; Set buffer's default directory to that of the file.
 340           (setq default-directory (file-name-directory filename))
 341           ;; Turn off backup files for certain file names.  Since
 342           ;; this is a permanent local, the major mode won't eliminate it.
 343           (and (not (funcall backup-enable-predicate buffer-file-name))
 344                (progn
 345                  (make-local-variable 'backup-inhibited)
 346                  (setq backup-inhibited t)))
 347           (if rawfile
 348               nil
 349             (after-find-file error (not nowarn)))))
 350       buf)))
 351
 352 (defun nnheader-insert-references (references message-id)
 353   ;; Fold long references line to follow RFC1036.
 354   (mail-position-on-field "References")
 355   (let ((begin (save-excursion (beginning-of-line) (point)))
 356         (fill-column 78)
 357         (fill-prefix "\t"))
 358     (if references (insert references))
 359     (if (and references message-id) (insert " "))
 360     (if message-id (insert message-id))
 361     ;; The region must end with a newline to fill the region
 362     ;; without inserting extra newline.
 363     (fill-region-as-paragraph begin (1+ (point)))))
 364
 365 (defun nnheader-remove-header (header &optional is-regexp)
 366   (goto-char (point-min))
 367   (let ((regexp (if is-regexp header (concat "^" header ":")))
 368         (case-fold-search t))
 369     (while (re-search-forward regexp nil t)
 370       (delete-region
 371        (match-beginning 0)
 372        ;; There might be a continuation header, so we have to search
 373        ;; until we find a new non-continuation line.
 374        (if (re-search-forward "^[^ \t]" nil t)
 375            (match-beginning 0)
 376          (point-max))))))
 377
 378 (defun nnheader-set-temp-buffer (name)
 379   (set-buffer (get-buffer-create name))
 380   (buffer-disable-undo (current-buffer))
 381   (erase-buffer))
 382
 383 (provide 'nnheader)
 384
 385 ;;; nnheader.el ends here