nnheader.el 36.3 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; nnheader.el --- header access macros for Gnus and its backends
2

3 4
;; Copyright (C) 1987-1990, 1993-1998, 2000-2011
;;   Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
5 6

;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7
;;	Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
8 9 10 11
;; Keywords: news

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
24 25 26 27 28

;;; Commentary:

;;; Code:

29
;; For Emacs <22.2 and XEmacs.
30 31
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
32
(eval-when-compile (require 'cl))
33

34
(defvar nnmail-extra-headers)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
35 36 37
(defvar gnus-newsgroup-name)
(defvar nnheader-file-coding-system)
(defvar jka-compr-compression-info-list)
38

39 40
;; Requiring `gnus-util' at compile time creates a circular
;; dependency between nnheader.el and gnus-util.el.
41
;;(eval-when-compile (require 'gnus-util))
42

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
43
(require 'mail-utils)
44
(require 'mm-util)
45
(require 'gnus-util)
Glenn Morris's avatar
Glenn Morris committed
46 47
(autoload 'gnus-range-add "gnus-range")
(autoload 'gnus-remove-from-range "gnus-range")
48 49 50 51 52
;; FIXME none of these are used explicitly in this file.
(autoload 'gnus-sorted-intersection "gnus-range")
(autoload 'gnus-intersection "gnus-range")
(autoload 'gnus-sorted-complement "gnus-range")
(autoload 'gnus-sorted-difference "gnus-range")
53 54 55 56 57 58 59 60 61 62 63 64 65 66

(defcustom gnus-verbose-backends 7
  "Integer that says how verbose the Gnus backends should be.
The higher the number, the more messages the Gnus backends will flash
to say what it's doing.  At zero, the Gnus backends will be totally
mute; at five, they will display most important messages; and at ten,
they will keep on jabbering all the time."
  :group 'gnus-start
  :type 'integer)

(defcustom gnus-nov-is-evil nil
  "If non-nil, Gnus backends will never output headers in the NOV format."
  :group 'gnus-server
  :type 'boolean)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
67

68
(defvar nnheader-max-head-length 8192
69 70 71 72 73 74 75 76
  "*Max length of the head of articles.

Value is an integer, nil, or t.  nil means read in chunks of a file
indefinitely until a complete head is found\; t means always read the
entire file immediately, disregarding `nnheader-head-chop-length'.

Integer values will in effect be rounded up to the nearest multiple of
`nnheader-head-chop-length'.")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
77 78 79 80

(defvar nnheader-head-chop-length 2048
  "*Length of each read operation when trying to fetch HEAD headers.")

81
(defvar nnheader-read-timeout
82
  (if (string-match "windows-nt\\|os/2\\|cygwin"
83
		    (symbol-name system-type))
84 85 86 87 88 89 90 91 92
      ;; http://thread.gmane.org/v9655t3pjo.fsf@marauder.physik.uni-ulm.de
      ;;
      ;; IIRC, values lower than 1.0 didn't/don't work on Windows/DOS.
      ;;
      ;; There should probably be a runtime test to determine the timing
      ;; resolution, or a primitive to report it.  I don't know off-hand
      ;; what's possible.  Perhaps better, maybe the Windows/DOS primitive
      ;; could round up non-zero timeouts to a minimum of 1.0?
      1.0
Miles Bader's avatar
Miles Bader committed
93 94 95 96 97
    ;; 2008-05-19 change by Larsi:
    ;; Change the default timeout from 0.1 seconds to 0.01 seconds.  This will
    ;; make nntp and pop3 article retrieval faster in some cases, but might
    ;; make CPU usage larger.  If this has any bad side effects, we might
    ;; revert this change.
Miles Bader's avatar
Miles Bader committed
98
    0.01)
Miles Bader's avatar
Miles Bader committed
99 100
  ;; When changing this variable, consider changing `pop3-read-timeout' as
  ;; well.
101 102 103
  "How long nntp should wait between checking for the end of output.
Shorter values mean quicker response, but are more CPU intensive.")

Juanma Barranquero's avatar
Juanma Barranquero committed
104
(defvar nnheader-file-name-translation-alist
105 106
  (let ((case-fold-search t))
    (cond
107
     ((string-match "windows-nt\\|os/2\\|cygwin"
108 109 110
		    (symbol-name system-type))
      (append (mapcar (lambda (c) (cons c ?_))
		      '(?: ?* ?\" ?< ?> ??))
111
	      (if (string-match "windows-nt\\|cygwin"
112 113 114 115
				(symbol-name system-type))
		  nil
		'((?+ . ?-)))))
     (t nil)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
116
  "*Alist that says how to translate characters in file names.
117
For instance, if \":\" is invalid as a file character in file names
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
118 119 120 121
on your system, you could say something like:

\(setq nnheader-file-name-translation-alist '((?: . ?_)))")

122 123 124 125
(defvar nnheader-directory-separator-character
  (string-to-char (substring (file-name-as-directory ".") -1))
  "*A character used to a directory separator.")

126 127 128
(autoload 'nnmail-message-id "nnmail")
(autoload 'mail-position-on-field "sendmail")
(autoload 'gnus-buffer-live-p "gnus-util")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
129 130 131

;;; Header access macros.

132 133 134 135 136 137 138 139 140 141 142
;; These macros may look very much like the ones in GNUS 4.1.  They
;; are, in a way, but you should note that the indices they use have
;; been changed from the internal GNUS format to the NOV format.  The
;; makes it possible to read headers from XOVER much faster.
;;
;; The format of a header is now:
;; [number subject from date id references chars lines xref extra]
;;
;; (That next-to-last entry is defined as "misc" in the NOV format,
;; but Gnus uses it for xrefs.)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
(defmacro mail-header-number (header)
  "Return article number in HEADER."
  `(aref ,header 0))

(defmacro mail-header-set-number (header number)
  "Set article number of HEADER to NUMBER."
  `(aset ,header 0 ,number))

(defmacro mail-header-subject (header)
  "Return subject string in HEADER."
  `(aref ,header 1))

(defmacro mail-header-set-subject (header subject)
  "Set article subject of HEADER to SUBJECT."
  `(aset ,header 1 ,subject))

(defmacro mail-header-from (header)
  "Return author string in HEADER."
  `(aref ,header 2))

(defmacro mail-header-set-from (header from)
  "Set article author of HEADER to FROM."
  `(aset ,header 2 ,from))

(defmacro mail-header-date (header)
  "Return date in HEADER."
  `(aref ,header 3))

(defmacro mail-header-set-date (header date)
  "Set article date of HEADER to DATE."
  `(aset ,header 3 ,date))

(defalias 'mail-header-message-id 'mail-header-id)
(defmacro mail-header-id (header)
  "Return Id in HEADER."
  `(aref ,header 4))

(defalias 'mail-header-set-message-id 'mail-header-set-id)
(defmacro mail-header-set-id (header id)
  "Set article Id of HEADER to ID."
  `(aset ,header 4 ,id))

(defmacro mail-header-references (header)
  "Return references in HEADER."
  `(aref ,header 5))

(defmacro mail-header-set-references (header ref)
  "Set article references of HEADER to REF."
  `(aset ,header 5 ,ref))

(defmacro mail-header-chars (header)
  "Return number of chars of article in HEADER."
  `(aref ,header 6))

(defmacro mail-header-set-chars (header chars)
  "Set number of chars in article of HEADER to CHARS."
  `(aset ,header 6 ,chars))

(defmacro mail-header-lines (header)
  "Return lines in HEADER."
  `(aref ,header 7))

(defmacro mail-header-set-lines (header lines)
  "Set article lines of HEADER to LINES."
  `(aset ,header 7 ,lines))

(defmacro mail-header-xref (header)
  "Return xref string in HEADER."
  `(aref ,header 8))

(defmacro mail-header-set-xref (header xref)
214
  "Set article XREF of HEADER to xref."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
215 216
  `(aset ,header 8 ,xref))

217 218 219 220
(defmacro mail-header-extra (header)
  "Return the extra headers in HEADER."
  `(aref ,header 9))

221
(defun mail-header-set-extra (header extra)
222
  "Set the extra headers in HEADER to EXTRA."
223
  (aset header 9 extra))
224 225

(defsubst make-mail-header (&optional init)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
226
  "Create a new mail header structure initialized with INIT."
227
  (make-vector 10 init))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
228

229 230 231
(defsubst make-full-mail-header (&optional number subject from date id
					   references chars lines xref
					   extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
232
  "Create a new mail header structure initialized with the parameters given."
233
  (vector number subject from date id references chars lines xref extra))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
234 235 236 237 238

;; fake message-ids: generation and detection

(defvar nnheader-fake-message-id 1)

239 240 241 242 243 244
(defsubst nnheader-generate-fake-message-id (&optional number)
  (if (numberp number)
      (format "fake+none+%s+%d" gnus-newsgroup-name number)
    (format "fake+none+%s+%s"
	    gnus-newsgroup-name
	    (int-to-string (incf nnheader-fake-message-id)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
245 246

(defsubst nnheader-fake-message-id-p (id)
247
  (save-match-data		       ; regular message-id's are <.*>
248
    (string-match "\\`fake\\+none\\+.*\\+[0-9]+\\'" id)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
249 250 251

;; Parsing headers and NOV lines.

252 253 254 255 256
(defsubst nnheader-remove-cr-followed-by-lf ()
  (goto-char (point-max))
  (while (search-backward "\r\n" nil t)
    (delete-char 1)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
257
(defsubst nnheader-header-value ()
258
  (skip-chars-forward " \t")
259
  (buffer-substring (point) (point-at-eol)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
260

261 262
(autoload 'ietf-drums-unfold-fws "ietf-drums")

263 264 265 266
(defun nnheader-parse-naked-head (&optional number)
  ;; This function unfolds continuation lines in this buffer
  ;; destructively.  When this side effect is unwanted, use
  ;; `nnheader-parse-head' instead of this function.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
267 268
  (let ((case-fold-search t)
	(buffer-read-only nil)
269 270 271 272 273 274 275 276
	(cur (current-buffer))
	(p (point-min))
	in-reply-to lines ref)
    (nnheader-remove-cr-followed-by-lf)
    (ietf-drums-unfold-fws)
    (subst-char-in-region (point-min) (point-max) ?\t ? )
    (goto-char p)
    (insert "\n")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
277
    (prog1
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
	;; This implementation of this function, with nine
	;; search-forwards instead of the one re-search-forward and a
	;; case (which basically was the old function) is actually
	;; about twice as fast, even though it looks messier.  You
	;; can't have everything, I guess.  Speed and elegance don't
	;; always go hand in hand.
	(vector
	 ;; Number.
	 (or number 0)
	 ;; Subject.
	 (progn
	   (goto-char p)
	   (if (search-forward "\nsubject:" nil t)
	       (nnheader-header-value) "(none)"))
	 ;; From.
	 (progn
	   (goto-char p)
	   (if (search-forward "\nfrom:" nil t)
	       (nnheader-header-value) "(nobody)"))
	 ;; Date.
	 (progn
	   (goto-char p)
	   (if (search-forward "\ndate:" nil t)
	       (nnheader-header-value) ""))
	 ;; Message-ID.
	 (progn
	   (goto-char p)
	   (if (search-forward "\nmessage-id:" nil t)
	       (buffer-substring
307
		(1- (or (search-forward "<" (point-at-eol) t)
308
			(point)))
309
		(or (search-forward ">" (point-at-eol) t) (point)))
310 311
	     ;; If there was no message-id, we just fake one to make
	     ;; subsequent routines simpler.
312
	     (nnheader-generate-fake-message-id number)))
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
	 ;; References.
	 (progn
	   (goto-char p)
	   (if (search-forward "\nreferences:" nil t)
	       (nnheader-header-value)
	     ;; Get the references from the in-reply-to header if
	     ;; there were no references and the in-reply-to header
	     ;; looks promising.
	     (if (and (search-forward "\nin-reply-to:" nil t)
		      (setq in-reply-to (nnheader-header-value))
		      (string-match "<[^\n>]+>" in-reply-to))
		 (let (ref2)
		   (setq ref (substring in-reply-to (match-beginning 0)
					(match-end 0)))
		   (while (string-match "<[^\n>]+>"
					in-reply-to (match-end 0))
		     (setq ref2 (substring in-reply-to (match-beginning 0)
					   (match-end 0)))
		     (when (> (length ref2) (length ref))
		       (setq ref ref2)))
		   ref)
	       nil)))
	 ;; Chars.
	 0
	 ;; Lines.
	 (progn
	   (goto-char p)
	   (if (search-forward "\nlines: " nil t)
	       (if (numberp (setq lines (read cur)))
		   lines 0)
	     0))
	 ;; Xref.
	 (progn
	   (goto-char p)
	   (and (search-forward "\nxref:" nil t)
		(nnheader-header-value)))
	 ;; Extra.
	 (when nnmail-extra-headers
	   (let ((extra nnmail-extra-headers)
		 out)
	     (while extra
	       (goto-char p)
	       (when (search-forward
		      (concat "\n" (symbol-name (car extra)) ":") nil t)
		 (push (cons (car extra) (nnheader-header-value))
		       out))
	       (pop extra))
	     out)))
      (goto-char p)
      (delete-char 1))))

(defun nnheader-parse-head (&optional naked)
  (let ((cur (current-buffer)) num beg end)
    (when (if naked
	      (setq num 0
		    beg (point-min)
		    end (point-max))
	    ;; Search to the beginning of the next header.  Error
	    ;; messages do not begin with 2 or 3.
	    (when (re-search-forward "^[23][0-9]+ " nil t)
	      (setq num (read cur)
		    beg (point)
		    end (if (search-forward "\n.\n" nil t)
376
			    (goto-char  (- (point) 2))
377 378 379 380
			  (point)))))
      (with-temp-buffer
	(insert-buffer-substring cur beg end)
	(nnheader-parse-naked-head num)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
381 382 383 384 385 386 387 388 389

(defmacro nnheader-nov-skip-field ()
  '(search-forward "\t" eol 'move))

(defmacro nnheader-nov-field ()
  '(buffer-substring (point) (if (nnheader-nov-skip-field) (1- (point)) eol)))

(defmacro nnheader-nov-read-integer ()
  '(prog1
390
       (if (eq (char-after) ?\t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
391
	   0
392 393 394
	 (let ((num (condition-case nil
			(read (current-buffer))
		      (error nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
395 396 397
	   (if (numberp num) num 0)))
     (or (eobp) (forward-char 1))))

398 399 400 401 402 403 404 405 406 407
(defmacro nnheader-nov-parse-extra ()
  '(let (out string)
     (while (not (memq (char-after) '(?\n nil)))
       (setq string (nnheader-nov-field))
       (when (string-match "^\\([^ :]+\\): " string)
	 (push (cons (intern (match-string 1 string))
		     (substring string (match-end 0)))
	       out)))
     out))

408 409 410 411 412
(eval-and-compile
  (defvar nnheader-uniquify-message-id nil))

(defmacro nnheader-nov-read-message-id (&optional number)
  `(let ((id (nnheader-nov-field)))
413
     (if (string-match "^<[^>]+>$" id)
414 415 416 417 418 419 420
	 ,(if nnheader-uniquify-message-id
	      `(if (string-match "__[^@]+@" id)
		   (concat (substring id 0 (match-beginning 0))
			   (substring id (1- (match-end 0))))
		 id)
	    'id)
       (nnheader-generate-fake-message-id ,number))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
421 422

(defun nnheader-parse-nov ()
423 424
  (let ((eol (point-at-eol))
	(number (nnheader-nov-read-integer)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
425
    (vector
426
     number				; number
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
427 428 429
     (nnheader-nov-field)		; subject
     (nnheader-nov-field)		; from
     (nnheader-nov-field)		; date
430
     (nnheader-nov-read-message-id number) ; id
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
431 432 433
     (nnheader-nov-field)		; refs
     (nnheader-nov-read-integer)	; chars
     (nnheader-nov-read-integer)	; lines
434
     (if (eq (char-after) ?\n)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
435
	 nil
Dave Love's avatar
Dave Love committed
436 437 438
       (if (looking-at "Xref: ")
	   (goto-char (match-end 0)))
       (nnheader-nov-field))		; Xref
439
     (nnheader-nov-parse-extra))))	; extra
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
440 441 442

(defun nnheader-insert-nov (header)
  (princ (mail-header-number header) (current-buffer))
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  (let ((p (point)))
    (insert
     "\t"
     (or (mail-header-subject header) "(none)") "\t"
     (or (mail-header-from header) "(nobody)") "\t"
     (or (mail-header-date header) "") "\t"
     (or (mail-header-id header)
	 (nnmail-message-id))
     "\t"
     (or (mail-header-references header) "") "\t")
    (princ (or (mail-header-chars header) 0) (current-buffer))
    (insert "\t")
    (princ (or (mail-header-lines header) 0) (current-buffer))
    (insert "\t")
    (when (mail-header-xref header)
      (insert "Xref: " (mail-header-xref header)))
    (when (or (mail-header-xref header)
	      (mail-header-extra header))
      (insert "\t"))
    (when (mail-header-extra header)
      (let ((extra (mail-header-extra header)))
	(while extra
	  (insert (symbol-name (caar extra))
466
		  ": " (if (stringp (cdar extra)) (cdar extra) "") "\t")
467 468 469 470 471 472 473
	  (pop extra))))
    (insert "\n")
    (backward-char 1)
    (while (search-backward "\n" p t)
      (delete-char 1))
    (forward-line 1)))

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
(defun nnheader-parse-overview-file (file)
  "Parse FILE and return a list of headers."
  (mm-with-unibyte-buffer
    (nnheader-insert-file-contents file)
    (goto-char (point-min))
    (let (headers)
      (while (not (eobp))
	(push (nnheader-parse-nov) headers)
	(forward-line 1))
      (nreverse headers))))

(defun nnheader-write-overview-file (file headers)
  "Write HEADERS to FILE."
  (with-temp-file file
    (mapcar 'nnheader-insert-nov headers)))

490
(defun nnheader-insert-header (header)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
491
  (insert
492 493 494 495 496 497
   "Subject: " (or (mail-header-subject header) "(none)") "\n"
   "From: " (or (mail-header-from header) "(nobody)") "\n"
   "Date: " (or (mail-header-date header) "") "\n"
   "Message-ID: " (or (mail-header-id header) (nnmail-message-id)) "\n"
   "References: " (or (mail-header-references header) "") "\n"
   "Lines: ")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
498
  (princ (or (mail-header-lines header) 0) (current-buffer))
499
  (insert "\n\n"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532

(defun nnheader-insert-article-line (article)
  (goto-char (point-min))
  (insert "220 ")
  (princ article (current-buffer))
  (insert " Article retrieved.\n")
  (search-forward "\n\n" nil 'move)
  (delete-region (point) (point-max))
  (forward-char -1)
  (insert "."))

(defun nnheader-nov-delete-outside-range (beg end)
  "Delete all NOV lines that lie outside the BEG to END range."
  ;; First we find the first wanted line.
  (nnheader-find-nov-line beg)
  (delete-region (point-min) (point))
  ;; Then we find the last wanted line.
  (when (nnheader-find-nov-line end)
    (forward-line 1))
  (delete-region (point) (point-max)))

(defun nnheader-find-nov-line (article)
  "Put point at the NOV line that start with ARTICLE.
If ARTICLE doesn't exist, put point where that line
would have been.  The function will return non-nil if
the line could be found."
  ;; This function basically does a binary search.
  (let ((max (point-max))
	(min (goto-char (point-min)))
	(cur (current-buffer))
	(prev (point-min))
	num found)
    (while (not found)
533
      (goto-char (+ min (/ (- max min) 2)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
534 535 536 537 538
      (beginning-of-line)
      (if (or (= (point) prev)
	      (eobp))
	  (setq found t)
	(setq prev (point))
539 540 541 542
	(while (and (not (numberp (setq num (read cur))))
		    (not (eobp)))
	  (gnus-delete-line))
	(cond ((> num article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
	       (setq max (point)))
	      ((< num article)
	       (setq min (point)))
	      (t
	       (setq found 'yes)))))
    ;; We may be at the first line.
    (when (and (not num)
	       (not (eobp)))
      (setq num (read cur)))
    ;; Now we may have found the article we're looking for, or we
    ;; may be somewhere near it.
    (when (and (not (eq found 'yes))
	       (not (eq num article)))
      (setq found (point))
      (while (and (< (point) max)
		  (or (not (numberp num))
		      (< num article)))
	(forward-line 1)
	(setq found (point))
	(or (eobp)
	    (= (setq num (read cur)) article)))
      (unless (eq num article)
	(goto-char found)))
    (beginning-of-line)
    (eq num article)))

;; Various cruft the backends and Gnus need to communicate.

(defvar nntp-server-buffer nil)
572
(defvar nntp-process-response nil)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
573 574 575 576 577

(defvar nnheader-callback-function nil)

(defun nnheader-init-server-buffer ()
  "Initialize the Gnus-backend communication buffer."
578 579 580
  (unless (gnus-buffer-live-p nntp-server-buffer)
    (setq nntp-server-buffer (get-buffer-create " *nntpd*")))
  (with-current-buffer nntp-server-buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
581
    (erase-buffer)
582
    (mm-enable-multibyte)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
583 584
    (kill-all-local-variables)
    (setq case-fold-search t)		;Should ignore case.
585
    (set (make-local-variable 'nntp-process-response) nil)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
    t))

;;; Various functions the backends use.

(defun nnheader-file-error (file)
  "Return a string that says what is wrong with FILE."
  (format
   (cond
    ((not (file-exists-p file))
     "%s does not exist")
    ((file-directory-p file)
     "%s is a directory")
    ((not (file-readable-p file))
     "%s is not readable"))
   file))

(defun nnheader-insert-head (file)
  "Insert the head of the article."
  (when (file-exists-p file)
    (if (eq nnheader-max-head-length t)
	;; Just read the entire file.
	(nnheader-insert-file-contents file)
Miles Bader's avatar
Miles Bader committed
608 609
      ;; Read blocks of the size specified by `nnheader-head-chop-length'
      ;; until we find a separator.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
610
      (let ((beg 0)
Miles Bader's avatar
Miles Bader committed
611 612 613 614 615
	    (start (point))
	    ;; Use `binary' to prevent the contents from being decoded,
	    ;; or it will change the number of characters that
	    ;; `insert-file-contents' returns.
	    (coding-system-for-read 'binary))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
616
	(while (and (eq nnheader-head-chop-length
Miles Bader's avatar
Miles Bader committed
617
			(nth 1 (mm-insert-file-contents
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
618 619
				file nil beg
				(incf beg nnheader-head-chop-length))))
Miles Bader's avatar
Miles Bader committed
620
		    ;; CRLF or CR might be used for the line-break code.
Miles Bader's avatar
Miles Bader committed
621
		    (prog1 (not (re-search-forward "\n\r?\n\\|\r\r" nil t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
622 623
		      (goto-char (point-max)))
		    (or (null nnheader-max-head-length)
Miles Bader's avatar
Miles Bader committed
624 625 626 627 628
			(< beg nnheader-max-head-length))))
	;; Finally decode the contents.
	(when (mm-coding-system-p nnheader-file-coding-system)
	  (mm-decode-coding-region start (point-max)
				   nnheader-file-coding-system))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
629 630 631 632 633 634 635 636 637
    t))

(defun nnheader-article-p ()
  "Say whether the current buffer looks like an article."
  (goto-char (point-min))
  (if (not (search-forward "\n\n" nil t))
      nil
    (narrow-to-region (point-min) (1- (point)))
    (goto-char (point-min))
638
    (while (looking-at "[a-zA-Z][^ \t]+:.*\n\\([ \t].*\n\\)*\\|From .*\n")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
639 640 641 642 643 644 645 646
      (goto-char (match-end 0)))
    (prog1
	(eobp)
      (widen))))

(defun nnheader-insert-references (references message-id)
  "Insert a References header based on REFERENCES and MESSAGE-ID."
  (if (and (not references) (not message-id))
647 648
      ;; This is invalid, but not all articles have Message-IDs.
      ()
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
649
    (mail-position-on-field "References")
650
    (let ((begin (point-at-bol))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
651 652 653 654 655 656 657 658 659 660 661 662 663
	  (fill-column 78)
	  (fill-prefix "\t"))
      (when references
	(insert references))
      (when (and references message-id)
	(insert " "))
      (when message-id
	(insert message-id))
      ;; Fold long References lines to conform to RFC1036 (sort of).
      ;; The region must end with a newline to fill the region
      ;; without inserting extra newline.
      (fill-region-as-paragraph begin (1+ (point))))))

664 665 666
(declare-function message-remove-header "message"
		  (header &optional is-regexp first reverse))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
667 668
(defun nnheader-replace-header (header new-value)
  "Remove HEADER and insert the NEW-VALUE."
669
  (require 'message)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
  (save-excursion
    (save-restriction
      (nnheader-narrow-to-headers)
      (prog1
	  (message-remove-header header)
	(goto-char (point-max))
	(insert header ": " new-value "\n")))))

(defun nnheader-narrow-to-headers ()
  "Narrow to the head of an article."
  (widen)
  (narrow-to-region
   (goto-char (point-min))
   (if (search-forward "\n\n" nil t)
       (1- (point))
     (point-max)))
  (goto-char (point-min)))

688 689 690 691 692 693 694 695
(defun nnheader-get-lines-and-char ()
  "Return the number of lines and chars in the article body."
  (goto-char (point-min))
  (if (not (re-search-forward "\n\r?\n" nil t))
      (list 0 0)
    (list (count-lines (point) (point-max))
	  (- (point-max) (point)))))

696 697 698 699 700 701
(defun nnheader-remove-body ()
  "Remove the body from an article in this current buffer."
  (goto-char (point-min))
  (when (re-search-forward "\n\r?\n" nil t)
    (delete-region (point) (point-max))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
702 703 704
(defun nnheader-set-temp-buffer (name &optional noerase)
  "Set-buffer to an empty (possibly new) buffer called NAME with undo disabled."
  (set-buffer (get-buffer-create name))
705
  (buffer-disable-undo)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  (unless noerase
    (erase-buffer))
  (current-buffer))

(defvar nnheader-numerical-files
  (if (boundp 'jka-compr-compression-info-list)
      (concat "\\([0-9]+\\)\\("
	      (mapconcat (lambda (i) (aref i 0))
			 jka-compr-compression-info-list "\\|")
	      "\\)?")
    "[0-9]+$")
  "Regexp that match numerical files.")

(defvar nnheader-numerical-short-files (concat "^" nnheader-numerical-files)
  "Regexp that matches numerical file names.")

(defvar nnheader-numerical-full-files (concat "/" nnheader-numerical-files)
723
  "Regexp that matches numerical full file names.")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
724 725

(defsubst nnheader-file-to-number (file)
726
  "Take a FILE name and return the article number."
727
  (if (string= nnheader-numerical-short-files "^[0-9]+$")
728
      (string-to-number file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
729
    (string-match nnheader-numerical-short-files file)
730
    (string-to-number (match-string 0 file))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
731

732 733
(defvar nnheader-directory-files-is-safe
  (or (eq system-type 'windows-nt)
734
      (not (featurep 'xemacs)))
735 736 737 738 739
  "If non-nil, Gnus believes `directory-files' is safe.
It has been reported numerous times that `directory-files' fails with
an alarming frequency on NFS mounted file systems. If it is nil,
`nnheader-directory-files-safe' is used.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
740
(defun nnheader-directory-files-safe (&rest args)
741
  "Execute `directory-files' twice and returns the longer result."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
742 743 744 745 746 747 748
  (let ((first (apply 'directory-files args))
	(second (apply 'directory-files args)))
    (if (> (length first) (length second))
	first
      second)))

(defun nnheader-directory-articles (dir)
749
  "Return a list of all article files in directory DIR."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
750
  (mapcar 'nnheader-file-to-number
751 752 753 754 755
	  (if nnheader-directory-files-is-safe
	      (directory-files
	       dir nil nnheader-numerical-short-files t)
	    (nnheader-directory-files-safe
	     dir nil nnheader-numerical-short-files t))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
756 757 758 759

(defun nnheader-article-to-file-alist (dir)
  "Return an alist of article/file pairs in DIR."
  (mapcar (lambda (file) (cons (nnheader-file-to-number file) file))
760 761 762 763 764
	  (if nnheader-directory-files-is-safe
	      (directory-files
	       dir nil nnheader-numerical-short-files t)
	    (nnheader-directory-files-safe
	     dir nil nnheader-numerical-short-files t))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
765 766 767 768 769

(defun nnheader-fold-continuation-lines ()
  "Fold continuation lines in the current buffer."
  (nnheader-replace-regexp "\\(\r?\n[ \t]+\\)+" " "))

770 771 772
(defun nnheader-translate-file-chars (file &optional full)
  "Translate FILE into something that can be a file name.
If FULL, translate everything."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
773 774 775 776 777
  (if (null nnheader-file-name-translation-alist)
      ;; No translation is necessary.
      file
    (let* ((i 0)
	   trans leaf path len)
778 779 780
      (if full
	  ;; Do complete translation.
	  (setq leaf (copy-sequence file)
781 782 783
		path ""
		i (if (and (< 1 (length leaf)) (eq ?: (aref leaf 1)))
		      2 0))
784 785
	;; We translate -- but only the file name.  We leave the directory
	;; alone.
786
	(if (and (featurep 'xemacs)
787
		 (memq system-type '(windows-nt cygwin)))
788 789 790 791
	    ;; This is needed on NT and stuff, because
	    ;; file-name-nondirectory is not enough to split
	    ;; file names, containing ':', e.g.
	    ;; "d:\\Work\\News\\nntp+news.fido7.ru:fido7.ru.gnu.SCORE"
Juanma Barranquero's avatar
Juanma Barranquero committed
792
	    ;;
793 794 795 796 797 798 799 800 801 802 803 804 805
	    ;; we are trying to correctly split such names:
	    ;; "d:file.name" -> "a:" "file.name"
	    ;; "aaa:bbb.ccc" -> "" "aaa:bbb.ccc"
	    ;; "d:aaa\\bbb:ccc"   -> "d:aaa\\" "bbb:ccc"
	    ;; etc.
	    ;; to translate then only the file name part.
	    (progn
	      (setq leaf file
		    path "")
	      (if (string-match "\\(^\\w:\\|[/\\]\\)\\([^/\\]+\\)$" file)
		  (setq leaf (substring file (match-beginning 2))
			path (substring file 0 (match-beginning 2)))))
	  ;; Emacs DTRT, says andrewi.
806 807
	  (setq leaf (file-name-nondirectory file)
		path (file-name-directory file))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
      (setq len (length leaf))
      (while (< i len)
	(when (setq trans (cdr (assq (aref leaf i)
				     nnheader-file-name-translation-alist)))
	  (aset leaf i trans))
	(incf i))
      (concat path leaf))))

(defun nnheader-report (backend &rest args)
  "Report an error from the BACKEND.
The first string in ARGS can be a format string."
  (set (intern (format "%s-status-string" backend))
       (if (< (length args) 2)
	   (car args)
	 (apply 'format args)))
  nil)

825
(defun nnheader-get-report-string (backend)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
826 827
  "Get the most recent report from BACKEND."
  (condition-case ()
828 829 830 831 832 833 834
      (format "%s" (symbol-value (intern (format "%s-status-string"
						 backend))))
    (error "")))

(defun nnheader-get-report (backend)
  "Get the most recent report from BACKEND."
  (nnheader-message 5 (nnheader-get-report-string backend)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
835 836 837 838 839

(defun nnheader-insert (format &rest args)
  "Clear the communication buffer and insert FORMAT and ARGS into the buffer.
If FORMAT isn't a format string, it and all ARGS will be inserted
without formatting."
840
  (with-current-buffer nntp-server-buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842 843 844 845 846
    (erase-buffer)
    (if (string-match "%" format)
	(insert (apply 'format format args))
      (apply 'insert format args))
    t))

847 848
(defsubst nnheader-replace-chars-in-string (string from to)
  (mm-subst-char-in-string from to string))
849 850

(defun nnheader-replace-duplicate-chars-in-string (string from to)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
851 852 853
  "Replace characters in STRING from FROM to TO."
  (let ((string (substring string 0))	;Copy string.
	(len (length string))
854
	(idx 0) prev i)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
855 856
    ;; Replace all occurrences of FROM with TO.
    (while (< idx len)
857 858 859
      (setq i (aref string idx))
      (when (and (eq prev from) (= i from))
	(aset string (1- idx) to)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
860
	(aset string idx to))
861
      (setq prev i)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
862 863 864 865 866 867 868 869 870 871 872 873 874 875
      (setq idx (1+ idx)))
    string))

(defun nnheader-file-to-group (file &optional top)
  "Return a group name based on FILE and TOP."
  (nnheader-replace-chars-in-string
   (if (not top)
       file
     (condition-case ()
	 (substring (expand-file-name file)
		    (length
		     (expand-file-name
		      (file-name-as-directory top))))
       (error "")))
876
   nnheader-directory-separator-character ?.))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
877 878 879 880 881

(defun nnheader-message (level &rest args)
  "Message if the Gnus backends are talkative."
  (if (or (not (numberp gnus-verbose-backends))
	  (<= level gnus-verbose-backends))
882 883 884
      (if gnus-add-timestamp-to-message
	  (apply 'gnus-message-with-timestamp args)
	(apply 'message args))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
885 886 887 888 889 890 891
    (apply 'format args)))

(defun nnheader-be-verbose (level)
  "Return whether the backends should be verbose on LEVEL."
  (or (not (numberp gnus-verbose-backends))
      (<= level gnus-verbose-backends)))

892 893
(defvar nnheader-pathname-coding-system 'iso-8859-1
  "*Coding system for file name.")
894

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
895
(defun nnheader-group-pathname (group dir &optional file)
896
  "Make file name for GROUP."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
897 898 899
  (concat
   (let ((dir (file-name-as-directory (expand-file-name dir))))
     ;; If this directory exists, we use it directly.
900 901 902 903 904 905
     (file-name-as-directory
      (if (file-directory-p (concat dir group))
	  (expand-file-name group dir)
	;; If not, we translate dots into slashes.
	(expand-file-name (mm-encode-coding-string
			   (nnheader-replace-chars-in-string group ?. ?/)
906
			   nnheader-pathname-coding-system)
907
			  dir))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
908 909 910 911 912
   (cond ((null file) "")
	 ((numberp file) (int-to-string file))
	 (t file))))

(defun nnheader-concat (dir &rest files)
913
  "Concat DIR as directory to FILES."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
914 915 916 917 918
  (apply 'concat (file-name-as-directory dir) files))

(defun nnheader-ms-strip-cr ()
  "Strip ^M from the end of all lines."
  (save-excursion
919
    (nnheader-remove-cr-followed-by-lf)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
920 921 922 923 924

(defun nnheader-file-size (file)
  "Return the file size of FILE or 0."
  (or (nth 7 (file-attributes file)) 0))

925 926 927 928 929 930 931
(defun nnheader-find-etc-directory (package &optional file first)
  "Go through `load-path' and find the \"../etc/PACKAGE\" directory.
This function will look in the parent directory of each `load-path'
entry, and look for the \"etc\" directory there.
If FILE, find the \".../etc/PACKAGE\" file instead.
If FIRST is non-nil, return the directory or the file found at the
first.  Otherwise, find the newest one, though it may take a time."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
932
  (let ((path load-path)
933
	dir results)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
934 935 936 937 938 939 940 941 942 943 944
    ;; We try to find the dir by looking at the load path,
    ;; stripping away the last component and adding "etc/".
    (while path
      (if (and (car path)
	       (file-exists-p
		(setq dir (concat
			   (file-name-directory
			    (directory-file-name (car path)))
			   "etc/" package
			   (if file "" "/"))))
	       (or file (file-directory-p dir)))
945 946 947 948
	  (progn
	    (or (member dir results)
		(push dir results))
	    (setq path (if first nil (cdr path))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
949
	(setq path (cdr path))))
950 951 952
    (if (or first (not (cdr results)))
	(car results)
      (car (sort results 'file-newer-than-file-p)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
953

Dan Nicolaescu's avatar
Dan Nicolaescu committed
954 955
(defvar ange-ftp-path-format)
(defvar efs-path-regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
956 957 958 959 960 961 962 963 964
(defun nnheader-re-read-dir (path)
  "Re-read directory PATH if PATH is on a remote system."
  (if (and (fboundp 'efs-re-read-dir) (boundp 'efs-path-regexp))
      (when (string-match efs-path-regexp path)
	(efs-re-read-dir path))
    (when (and (fboundp 'ange-ftp-re-read-dir) (boundp 'ange-ftp-path-format))
      (when (string-match (car ange-ftp-path-format) path)
	(ange-ftp-re-read-dir path)))))

965 966 967
(defvar nnheader-file-coding-system 'raw-text
  "Coding system used in file backends of Gnus.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
968 969 970 971 972 973
(defun nnheader-insert-file-contents (filename &optional visit beg end replace)
  "Like `insert-file-contents', q.v., but only reads in the file.
A buffer may be modified in several ways after reading into the buffer due
to advanced Emacs features, such as file-name-handlers, format decoding,
find-file-hooks, etc.
  This function ensures that none of these modifications will take place."
974 975
  (let ((coding-system-for-read nnheader-file-coding-system))
    (mm-insert-file-contents filename visit beg end replace)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
976

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
(defun nnheader-insert-nov-file (file first)
  (let ((size (nth 7 (file-attributes file)))
	(cutoff (* 32 1024)))
    (when size
      (if (< size cutoff)
          ;; If the file is small, we just load it.
          (nnheader-insert-file-contents file)
        ;; We start on the assumption that FIRST is pretty recent.  If
        ;; not, we just insert the rest of the file as well.
        (let (current)
          (nnheader-insert-file-contents file nil (- size cutoff) size)
          (goto-char (point-min))
          (delete-region (point) (or (search-forward "\n" nil 'move) (point)))
          (setq current (ignore-errors (read (current-buffer))))
          (if (and (numberp current)
                   (< current first))
              t
            (delete-region (point-min) (point-max))
            (nnheader-insert-file-contents file)))))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
997
(defun nnheader-find-file-noselect (&rest args)
998 999
  "Open a file with some variables bound.
See `find-file-noselect' for the arguments."
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
  (letf* ((format-alist nil)
          (auto-mode-alist (mm-auto-mode-alist))
          ((default-value 'major-mode) 'fundamental-mode)
          (enable-local-variables nil)
          (after-insert-file-functions nil)
          (enable-local-eval nil)
          (coding-system-for-read nnheader-file-coding-system)
          (version-control 'never)
          (ffh (if (boundp 'find-file-hook)
                   'find-file-hook
                 'find-file-hooks))
          (val (symbol-value ffh)))
1012 1013 1014 1015
    (set ffh nil)
    (unwind-protect
	(apply 'find-file-noselect args)
      (set ffh val))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

(defun nnheader-directory-regular-files (dir)
  "Return a list of all regular files in DIR."
  (let ((files (directory-files dir t))
	out)
    (while files
      (when (file-regular-p (car files))
	(push (car files) out))
      (pop files))
    (nreverse out)))

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
(defun nnheader-directory-files (&rest args)
  "Same as `directory-files', but prune \".\" and \"..\"."
  (let ((files (apply 'directory-files args))
	out)
    (while files
      (unless (member (file-name-nondirectory (car files)) '("." ".."))
	(push (car files) out))
      (pop files))
    (nreverse out)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
(defmacro nnheader-skeleton-replace (from &optional to regexp)
  `(let ((new (generate-new-buffer " *nnheader replace*"))
	 (cur (current-buffer))
	 (start (point-min)))
     (set-buffer cur)
     (goto-char (point-min))
     (while (,(if regexp 're-search-forward 'search-forward)
	     ,from nil t)
       (insert-buffer-substring
	cur start (prog1 (match-beginning 0) (set-buffer new)))
       (goto-char (point-max))
       ,(when to `(insert ,to))
       (set-buffer cur)
       (setq start (point)))
     (insert-buffer-substring
      cur start (prog1 (point-max) (set-buffer new)))
     (copy-to-buffer cur (point-min) (point-max))
     (kill-buffer (current-buffer))
     (set-buffer cur)))

(defun nnheader-replace-string (from to)
1058
  "Do a fast replacement of FROM to TO from point to `point-max'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1059 1060 1061
  (nnheader-skeleton-replace from to))

(defun nnheader-replace-regexp (from to)
1062
  "Do a fast regexp replacement of FROM to TO from point to `point-max'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1063 1064 1065 1066 1067 1068
  (nnheader-skeleton-replace from to t))

(defun nnheader-strip-cr ()
  "Strip all \r's from the current buffer."
  (nnheader-skeleton-replace "\r"))

1069 1070
(defalias 'nnheader-cancel-timer 'cancel-timer)
(defalias 'nnheader-cancel-function-timers 'cancel-function-timers)
1071

Miles Bader's avatar
Miles Bader committed
1072 1073
;; When changing this function, consider changing `pop3-accept-process-output'
;; as well.
1074 1075 1076 1077 1078 1079 1080
(defun nnheader-accept-process-output (process)
  (accept-process-output
   process
   (truncate nnheader-read-timeout)
   (truncate (* (- nnheader-read-timeout
		   (truncate nnheader-read-timeout))
		1000))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1081

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
(defun nnheader-update-marks-actions (backend-marks actions)
  (dolist (action actions)
    (let ((range (nth 0 action))
	  (what  (nth 1 action))
	  (marks (nth 2 action)))
      (dolist (mark marks)
	(setq backend-marks
	      (gnus-update-alist-soft
	       mark
	       (cond
		((eq what 'add)
1093 1094 1095 1096 1097 1098
		 (gnus-range-add (cdr (assoc mark backend-marks)) range))
		((eq what 'del)
		 (gnus-remove-from-range
		  (cdr (assoc mark backend-marks)) range))
		((eq what 'set)
		 range))
1099 1100 1101
	       backend-marks)))))
  backend-marks)

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
(defmacro nnheader-insert-buffer-substring (buffer &optional start end)
  "Copy string from unibyte buffer to multibyte current buffer."
  (if (featurep 'xemacs)
      `(insert-buffer-substring ,buffer ,start ,end)
    `(if enable-multibyte-characters
	 (insert (with-current-buffer ,buffer
		   (mm-string-to-multibyte
		    ,(if (or start end)
			 `(buffer-substring (or ,start (point-min))
					    (or ,end (point-max)))
		       '(buffer-string)))))
       (insert-buffer-substring ,buffer ,start ,end))))

1115
(when (featurep 'xemacs)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1116 1117 1118 1119 1120 1121 1122
  (require 'nnheaderxm))

(run-hooks 'nnheader-load-hook)

(provide 'nnheader)

;;; nnheader.el ends here