gnus-util.el 59.4 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-util.el --- utility functions for Gnus
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1996-2019 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4

5
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
6 7 8 9
;; Keywords: news

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; 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
14 15 16

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
18 19 20
;; GNU General Public License for more details.

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

;;; Commentary:

;; Nothing in this file depends on any other parts of Gnus -- all
;; functions and macros in this file are utility functions that are
;; used by Gnus and may be used by any other package without loading
;; Gnus first.

30
;; [Unfortunately, it does depend on other parts of Gnus, e.g. the
31
;; autoloads and defvars below...]
32

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
33 34
;;; Code:

Glenn Morris's avatar
Glenn Morris committed
35
(eval-when-compile (require 'cl-lib))
36

37
(require 'seq)
38
(require 'time-date)
39
(require 'text-property-search)
40

41
(defcustom gnus-completing-read-function 'gnus-emacs-completing-read
42
  "Function use to do completing read."
43
  :version "24.1"
44
  :group 'gnus-meta
45
  :type '(radio (function-item
46 47
                 :doc "Use Emacs standard `completing-read' function."
                 gnus-emacs-completing-read)
Lars Ingebrigtsen's avatar
Lars Ingebrigtsen committed
48 49 50 51 52 53
		(function-item
		 :doc "Use `ido-completing-read' function."
		 gnus-ido-completing-read)
		(function-item
		 :doc "Use iswitchb based completing-read function."
		 gnus-iswitchb-completing-read)))
54 55

(defcustom gnus-completion-styles
56 57 58 59
  (append (when (and (assq 'substring completion-styles-alist)
		     (not (memq 'substring completion-styles)))
	    (list 'substring))
	  completion-styles)
60 61 62
  "Value of `completion-styles' to use when completing."
  :version "24.1"
  :group 'gnus-meta
63
  :type '(repeat symbol))
64

Dan Nicolaescu's avatar
Dan Nicolaescu committed
65 66 67 68 69 70 71 72 73
;; Fixme: this should be a gnus variable, not nnmail-.
(defvar nnmail-pathname-coding-system)
(defvar nnmail-active-file-coding-system)

;; Inappropriate references to other parts of Gnus.
(defvar gnus-emphasize-whitespace-regexp)
(defvar gnus-original-article-buffer)
(defvar gnus-user-agent)

Glenn Morris's avatar
Glenn Morris committed
74 75 76
(autoload 'gnus-get-buffer-window "gnus-win")
(autoload 'nnheader-narrow-to-headers "nnheader")
(autoload 'nnheader-replace-chars-in-string "nnheader")
77
(autoload 'mail-header-remove-comments "mail-parse")
78

79 80
(defun gnus-replace-in-string  (string regexp newtext &optional literal)
  "Replace all matches for REGEXP with NEWTEXT in STRING.
81 82 83 84
If LITERAL is non-nil, insert NEWTEXT literally.  Return a new
string containing the replacements.

This is a compatibility function for different Emacsen."
85
  (declare (obsolete replace-regexp-in-string "26.1"))
86
  (replace-regexp-in-string regexp newtext string nil literal))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
87 88 89 90

(defmacro gnus-eval-in-buffer-window (buffer &rest forms)
  "Pop to BUFFER, evaluate FORMS, and then return to the original window."
  (let ((tempvar (make-symbol "GnusStartBufferWindow"))
91 92
	(w (make-symbol "w"))
	(buf (make-symbol "buf")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
93
    `(let* ((,tempvar (selected-window))
94 95
	    (,buf ,buffer)
	    (,w (gnus-get-buffer-window ,buf 'visible)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
96
       (unwind-protect
97 98 99 100 101 102 103 104
	   (progn
	     (if ,w
		 (progn
		   (select-window ,w)
		   (set-buffer (window-buffer ,w)))
	       (pop-to-buffer ,buf))
	     ,@forms)
	 (select-window ,tempvar)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
105

106 107 108
(put 'gnus-eval-in-buffer-window 'lisp-indent-function 1)
(put 'gnus-eval-in-buffer-window 'edebug-form-spec '(form body))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
(defsubst gnus-goto-char (point)
  (and point (goto-char point)))

(defun gnus-delete-first (elt list)
  "Delete by side effect the first occurrence of ELT as a member of LIST."
  (if (equal (car list) elt)
      (cdr list)
    (let ((total list))
      (while (and (cdr list)
		  (not (equal (cadr list) elt)))
	(setq list (cdr list)))
      (when (cdr list)
	(setcdr list (cddr list)))
      total)))

;; Delete the current line (and the next N lines).
(defmacro gnus-delete-line (&optional n)
126
  `(delete-region (point-at-bol)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
127 128 129
		  (progn (forward-line ,(or n 1)) (point))))

(defun gnus-extract-address-components (from)
130
  "Extract address components from a From header.
131
Given an RFC-822 (or later) address FROM, extract name and address.
132
Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  Much more simple
133
solution than `mail-header-parse-address', which works much better, but
134
is slower."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
135 136 137 138
  (let (name address)
    ;; First find the address - the thing with the @ in it.  This may
    ;; not be accurate in mail addresses, but does the trick most of
    ;; the time in news messages.
Miles Bader's avatar
Miles Bader committed
139 140 141 142 143 144 145
    (cond (;; Check ``<foo@bar>'' first in order to handle the quite common
	   ;; form ``"abc@xyz" <foo@bar>'' (i.e. ``@'' as part of a comment)
	   ;; correctly.
	   (string-match "<\\([^@ \t<>]+[!@][^@ \t<>]+\\)>" from)
	   (setq address (substring from (match-beginning 1) (match-end 1))))
	  ((string-match "\\b[^@ \t<>]+[!@][^@ \t<>]+\\b" from)
	   (setq address (substring from (match-beginning 0) (match-end 0)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
146 147 148 149 150 151
    ;; Then we check whether the "name <address>" format is used.
    (and address
	 ;; Linear white space is not required.
	 (string-match (concat "[ \t]*<" (regexp-quote address) ">") from)
	 (and (setq name (substring from 0 (match-beginning 0)))
	      ;; Strip any quotes from the name.
152
	      (string-match "^\".*\"$" name)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
153 154 155 156 157 158 159 160 161 162 163 164
	      (setq name (substring name 1 (1- (match-end 0))))))
    ;; If not, then "address (name)" is used.
    (or name
	(and (string-match "(.+)" from)
	     (setq name (substring from (1+ (match-beginning 0))
				   (1- (match-end 0)))))
	(and (string-match "()" from)
	     (setq name address))
	;; XOVER might not support folded From headers.
	(and (string-match "(.*" from)
	     (setq name (substring from (1+ (match-beginning 0))
				   (match-end 0)))))
165 166
    (list (if (string= name "") nil name) (or address from))))

167 168
(declare-function message-fetch-field "message" (header &optional not-all))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
169 170
(defun gnus-fetch-field (field)
  "Return the value of the header FIELD of current article."
171
  (require 'message)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
172 173
  (save-excursion
    (save-restriction
174
      (let ((inhibit-point-motion-hooks t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
175 176 177
	(nnheader-narrow-to-headers)
	(message-fetch-field field)))))

178 179 180 181 182 183
(defun gnus-fetch-original-field (field)
  "Fetch FIELD from the original version of the current article."
  (with-current-buffer gnus-original-article-buffer
    (gnus-fetch-field field)))


Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
184
(defun gnus-goto-colon ()
185
  (move-beginning-of-line 1)
186
  (let ((eol (point-at-eol)))
187 188 189 190
    (goto-char (or (text-property-any (point) eol 'gnus-position t)
		   (search-forward ":" eol t)
		   (point)))))

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
(defun gnus-text-property-search (prop value &optional forward-only goto end)
  "Search current buffer for text property PROP with VALUE.
Behaves like a combination of `text-property-any' and
`text-property-search-forward'.  Searches for the beginning of a
text property `equal' to VALUE.  Returns the value of point at
the beginning of the matching text property span.

If FORWARD-ONLY is non-nil, only search forward from point.

If GOTO is non-nil, move point to the beginning of that span
instead.

If END is non-nil, use the end of the span instead."
  (let* ((start (point))
	 (found (progn
		  (unless forward-only
		    (goto-char (point-min)))
		  (text-property-search-forward
		   prop value #'equal)))
	 (target (when found
		   (if end
		       (prop-match-end found)
		     (prop-match-beginning found)))))
    (when target
      (if goto
	  (goto-char target)
	(prog1
	    target
	  (goto-char start))))))

221
(declare-function gnus-find-method-for-group "gnus" (group &optional info))
222
(declare-function gnus-group-name-decode "gnus-group" (string charset))
223 224 225 226 227
(declare-function gnus-group-name-charset "gnus-group" (method group))
;; gnus-group requires gnus-int which requires message.
(declare-function message-tokenize-header "message"
                  (header &optional separator))

228
(defun gnus-decode-newsgroups (newsgroups group &optional method)
229
  (require 'gnus-group)
230 231 232 233 234 235
  (let ((method (or method (gnus-find-method-for-group group))))
    (mapconcat (lambda (group)
		 (gnus-group-name-decode group (gnus-group-name-charset
						method group)))
	       (message-tokenize-header newsgroups)
	       ",")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
236 237 238

(defun gnus-remove-text-with-property (prop)
  "Delete all text in the current buffer with text property PROP."
239 240 241 242 243 244 245 246 247
  (let ((start (point-min))
	end)
    (unless (get-text-property start prop)
      (setq start (next-single-property-change start prop)))
    (while start
      (setq end (text-property-any start (point-max) prop nil))
      (delete-region start (or end (point-max)))
      (setq start (when end
		    (next-single-property-change start prop))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
248

249 250 251 252 253 254 255 256 257 258 259
(defun gnus-find-text-property-region (start end prop)
  "Return a list of text property regions that has property PROP."
  (let (regions value)
    (unless (get-text-property start prop)
      (setq start (next-single-property-change start prop)))
    (while start
      (setq value (get-text-property start prop)
	    end (text-property-not-all start (point-max) prop value))
      (if (not end)
	  (setq start nil)
	(when value
260 261 262 263
	  (push (list (set-marker (make-marker) start)
		      (set-marker (make-marker) end)
		      value)
		regions))
264 265 266
	(setq start (next-single-property-change start prop))))
    (nreverse regions)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
267 268
(defun gnus-newsgroup-directory-form (newsgroup)
  "Make hierarchical directory name from NEWSGROUP name."
269 270 271 272 273 274 275 276
  (let* ((newsgroup (gnus-newsgroup-savable-name newsgroup))
	 (idx (string-match ":" newsgroup)))
    (concat
     (if idx (substring newsgroup 0 idx))
     (if idx "/")
     (nnheader-replace-chars-in-string
      (if idx (substring newsgroup (1+ idx)) newsgroup)
      ?. ?/))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
277 278 279 280 281 282 283 284 285 286

(defun gnus-newsgroup-savable-name (group)
  ;; Replace any slashes in a group name (eg. an ange-ftp nndoc group)
  ;; with dots.
  (nnheader-replace-chars-in-string group ?/ ?.))

(defun gnus-string> (s1 s2)
  (not (or (string< s1 s2)
	   (string= s1 s2))))

Miles Bader's avatar
Miles Bader committed
287 288 289 290 291 292 293 294 295
(defun gnus-string< (s1 s2)
  "Return t if first arg string is less than second in lexicographic order.
Case is significant if and only if `case-fold-search' is nil.
Symbols are also allowed; their print names are used instead."
  (if case-fold-search
      (string-lessp (downcase (if (symbolp s1) (symbol-name s1) s1))
		    (downcase (if (symbolp s2) (symbol-name s2) s2)))
    (string-lessp s1 s2)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
296 297 298
;;; Time functions.

(defun gnus-file-newer-than (file date)
Paul Eggert's avatar
Paul Eggert committed
299
  (time-less-p date (file-attribute-modification-time (file-attributes file))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314

;;; Keymap macros.

(defmacro gnus-local-set-keys (&rest plist)
  "Set the keys in PLIST in the current keymap."
  `(gnus-define-keys-1 (current-local-map) ',plist))

(defmacro gnus-define-keys (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP."
  `(gnus-define-keys-1 (quote ,keymap) (quote ,plist)))

(defmacro gnus-define-keys-safe (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP without overwriting previous definitions."
  `(gnus-define-keys-1 (quote ,keymap) (quote ,plist) t))

315 316 317 318
(put 'gnus-define-keys 'lisp-indent-function 1)
(put 'gnus-define-keys-safe 'lisp-indent-function 1)
(put 'gnus-local-set-keys 'lisp-indent-function 1)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
319 320 321 322
(defmacro gnus-define-keymap (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP."
  `(gnus-define-keys-1 ,keymap (quote ,plist)))

323 324
(put 'gnus-define-keymap 'lisp-indent-function 1)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
(defun gnus-define-keys-1 (keymap plist &optional safe)
  (when (null keymap)
    (error "Can't set keys in a null keymap"))
  (cond ((symbolp keymap)
	 (setq keymap (symbol-value keymap)))
	((keymapp keymap))
	((listp keymap)
	 (set (car keymap) nil)
	 (define-prefix-command (car keymap))
	 (define-key (symbol-value (caddr keymap)) (cadr keymap) (car keymap))
	 (setq keymap (symbol-value (car keymap)))))
  (let (key)
    (while plist
      (when (symbolp (setq key (pop plist)))
	(setq key (symbol-value key)))
      (if (or (not safe)
	      (eq (lookup-key keymap key) 'undefined))
	  (define-key keymap key (pop plist))
	(pop plist)))))

345 346 347 348 349 350 351 352
(defun gnus-y-or-n-p (prompt)
  (prog1
      (y-or-n-p prompt)
    (message "")))
(defun gnus-yes-or-no-p (prompt)
  (prog1
      (yes-or-no-p prompt)
    (message "")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
353

354 355 356 357 358 359
;; By Frank Schmitt <ich@Frank-Schmitt.net>. Allows to have
;; age-depending date representations. (e.g. just the time if it's
;; from today, the day of the week if it's within the last 7 days and
;; the full date if it's older)

(defun gnus-seconds-today ()
Paul Eggert's avatar
Paul Eggert committed
360 361
  "Return the integer number of seconds passed today."
  (let ((now (decode-time nil nil 'integer)))
362 363 364
    (+ (decoded-time-second now)
       (* (decoded-time-minute now) 60)
       (* (decoded-time-hour now) 3600))))
365 366

(defun gnus-seconds-month ()
Paul Eggert's avatar
Paul Eggert committed
367 368
  "Return the integer number of seconds passed this month."
  (let ((now (decode-time nil nil 'integer)))
369 370 371 372
    (+ (decoded-time-second now)
       (* (decoded-time-minute now) 60)
       (* (decoded-time-hour now) 3600)
       (* (- (decoded-time-day now) 1) 3600 24))))
373 374

(defun gnus-seconds-year ()
Paul Eggert's avatar
Paul Eggert committed
375
  "Return the integer number of seconds passed this year."
376
  (let* ((current (current-time))
Paul Eggert's avatar
Paul Eggert committed
377
	 (now (decode-time current nil 'integer))
378
	 (days (format-time-string "%j" current)))
379 380 381
    (+ (decoded-time-second now)
       (* (decoded-time-minute now) 60)
       (* (decoded-time-hour now) 3600)
382 383
       (* (- (string-to-number days) 1) 3600 24))))

Romain Francoise's avatar
Romain Francoise committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397
(defmacro gnus-date-get-time (date)
  "Convert DATE string to Emacs time.
Cache the result as a text property stored in DATE."
  ;; Either return the cached value...
  `(let ((d ,date))
     (if (equal "" d)
	 '(0 0)
       (or (get-text-property 0 'gnus-time d)
	   ;; or compute the value...
	   (let ((time (safe-date-to-time d)))
	     ;; and store it back in the string.
	     (put-text-property 0 1 'gnus-time time d)
	     time)))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
398
(defun gnus-dd-mmm (messy-date)
399
  "Return a string like DD-MMM from a big messy string."
400
  (condition-case ()
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
401
      (format-time-string "%d-%b" (gnus-date-get-time messy-date))
402
    (error "  -   ")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
403 404

(defsubst gnus-time-iso8601 (time)
Dave Love's avatar
Dave Love committed
405
  "Return a string of TIME in YYYYMMDDTHHMMSS format."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
406 407
  (format-time-string "%Y%m%dT%H%M%S" time))

408
(defun gnus-date-iso8601 (date)
Dave Love's avatar
Dave Love committed
409
  "Convert the DATE to YYYYMMDDTHHMMSS."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
410
  (condition-case ()
411
      (gnus-time-iso8601 (gnus-date-get-time date))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
412 413 414 415
    (error "")))

(defun gnus-mode-string-quote (string)
  "Quote all \"%\"'s in STRING."
416
  (replace-regexp-in-string "%" "%%" string))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
417

418 419 420
(defsubst gnus-make-hashtable (&optional size)
  "Make a hash table of SIZE, testing on `equal'."
  (make-hash-table :size (or size 300) :test #'equal))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
421

422
(defcustom gnus-verbose 6
423
  "Integer that says how verbose Gnus should be.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
424 425 426 427
The higher the number, the more messages Gnus will flash to say what
it's doing.  At zero, Gnus will be totally mute; at five, Gnus will
display most important messages; and at ten, Gnus will keep on
jabbering all the time."
428
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
429 430 431
  :group 'gnus-start
  :type 'integer)

432 433
(defcustom gnus-add-timestamp-to-message nil
  "Non-nil means add timestamps to messages that Gnus issues.
434 435 436 437
If it is `log', add timestamps to only the messages that go into
the \"*Messages*\" buffer.  If it is neither nil nor `log', add
timestamps not only to log messages but also to the ones
displayed in the echo area."
438
  :version "23.1" ;; No Gnus
439 440 441 442 443 444 445 446 447 448
  :group  'gnus-various
  :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
		 (const :tag "Logged messages only" log)
		 (sexp :tag "All messages"
		       :match (lambda (widget value) value)
		       :value t)
		 (const :tag "No timestamp" nil)))

(eval-when-compile
  (defmacro gnus-message-with-timestamp-1 (format-string args)
449
    (let ((timestamp '(format-time-string "%Y%m%dT%H%M%S.%3N> " time)))
450 451 452
      `(let (str time)
	 (cond ((eq gnus-add-timestamp-to-message 'log)
		(setq str (let (message-log-max)
453
			    (apply 'message ,format-string ,args)))
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
		(when (and message-log-max
			   (> message-log-max 0)
			   (/= (length str) 0))
		  (setq time (current-time))
		  (with-current-buffer (if (fboundp 'messages-buffer)
					   (messages-buffer)
					 (get-buffer-create "*Messages*"))
		    (goto-char (point-max))
		    (let ((inhibit-read-only t))
		      (insert ,timestamp str "\n")
		      (forward-line (- message-log-max))
		      (delete-region (point-min) (point)))
		    (goto-char (point-max))))
		str)
	       (gnus-add-timestamp-to-message
		(if (or (and (null ,format-string) (null ,args))
			(progn
471 472
			  (setq str (apply #'format-message ,format-string
					   ,args))
473 474 475 476 477 478 479 480
			  (zerop (length str))))
		    (prog1
			(and ,format-string str)
		      (message nil))
		  (setq time (current-time))
		  (message "%s" (concat ,timestamp str))
		  str))
	       (t
481
		(apply 'message ,format-string ,args)))))))
482

483 484
(defvar gnus-action-message-log nil)

485 486 487 488 489 490
(defun gnus-message-with-timestamp (format-string &rest args)
  "Display message with timestamp.  Arguments are the same as `message'.
The `gnus-add-timestamp-to-message' variable controls how to add
timestamp to message."
  (gnus-message-with-timestamp-1 format-string args))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
491
(defun gnus-message (level &rest args)
492 493 494 495 496 497
  "If LEVEL is lower than `gnus-verbose' print ARGS using `message'.

Guideline for numbers:
1 - error messages, 3 - non-serious error messages, 5 - messages for things
that take a long time, 7 - not very important messages on stuff, 9 - messages
inside loops."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
498
  (if (<= level gnus-verbose)
499
      (let ((message
500 501 502
	     (if gnus-add-timestamp-to-message
		 (apply 'gnus-message-with-timestamp args)
	       (apply 'message args))))
503 504 505 506
	(when (and (consp gnus-action-message-log)
		   (<= level 3))
	  (push message gnus-action-message-log))
	message)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
507 508 509
    ;; We have to do this format thingy here even if the result isn't
    ;; shown - the return value has to be the same as the return value
    ;; from `message'.
510
    (apply #'format-message args)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
511

512 513 514 515 516 517 518
(defun gnus-final-warning ()
  (when (and (consp gnus-action-message-log)
	     (setq gnus-action-message-log
		   (delete nil gnus-action-message-log)))
    (message "Warning: %s"
	     (mapconcat #'identity gnus-action-message-log "; "))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
519
(defun gnus-error (level &rest args)
520 521
  "Beep an error if LEVEL is equal to or less than `gnus-verbose'.
ARGS are passed to `message'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
522
  (when (<= (floor level) gnus-verbose)
523
    (apply 'message args)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
524 525 526 527 528 529 530 531 532 533
    (ding)
    (let (duration)
      (when (and (floatp level)
		 (not (zerop (setq duration (* 10 (- level (floor level)))))))
	(sit-for duration))))
  nil)

(defun gnus-split-references (references)
  "Return a list of Message-IDs in REFERENCES."
  (let ((beg 0)
534
	(references (mail-header-remove-comments (or references "")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
535
	ids)
536
    (while (string-match "<[^<]+[^< \t]" references beg)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
537 538 539 540
      (push (substring references (match-beginning 0) (setq beg (match-end 0)))
	    ids))
    (nreverse ids)))

541 542 543 544 545 546 547 548 549 550
(defun gnus-extract-references (references)
  "Return a list of Message-IDs in REFERENCES (in In-Reply-To
  format), trimmed to only contain the Message-IDs."
  (let ((ids (gnus-split-references references))
	refs)
    (dolist (id ids)
      (when (string-match "<[^<>]+>" id)
	(push (match-string 0 id) refs)))
    refs))

551
(defsubst gnus-parent-id (references &optional n)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
552 553
  "Return the last Message-ID in REFERENCES.
If N, return the Nth ancestor instead."
554 555 556 557 558 559 560
  (when (and references
	     (not (zerop (length references))))
    (if n
	(let ((ids (inline (gnus-split-references references))))
	  (while (nthcdr n ids)
	    (setq ids (cdr ids)))
	  (car ids))
561 562 563
      (let ((references (mail-header-remove-comments references)))
	(when (string-match "\\(<[^<]+>\\)[ \t]*\\'" references)
	  (match-string 1 references))))))
564

565
(defsubst gnus-buffer-live-p (buffer)
566 567 568 569 570 571
  "If BUFFER names a live buffer, return its object; else nil."
  (and buffer (buffer-live-p (setq buffer (get-buffer buffer)))
       buffer))

(define-obsolete-function-alias 'gnus-buffer-exists-p
  'gnus-buffer-live-p "27.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
572 573 574 575

(defun gnus-horizontal-recenter ()
  "Recenter the current buffer horizontally."
  (if (< (current-column) (/ (window-width) 2))
576
      (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
577
    (let* ((orig (point))
578
	   (end (window-end (gnus-get-buffer-window (current-buffer) t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
579
	   (max 0))
580 581 582 583 584 585 586 587 588 589 590 591
      (when end
	;; Find the longest line currently displayed in the window.
	(goto-char (window-start))
	(while (and (not (eobp))
		    (< (point) end))
	  (end-of-line)
	  (setq max (max max (current-column)))
	  (forward-line 1))
	(goto-char orig)
	;; Scroll horizontally to center (sort of) the point.
	(if (> max (window-width))
	    (set-window-hscroll
592
	     (gnus-get-buffer-window (current-buffer) t)
593 594
	     (min (- (current-column) (/ (window-width) 3))
		  (+ 2 (- max (window-width)))))
595
	  (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0))
596
	max))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
597

598
(defun gnus-read-event-char (&optional prompt)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
599
  "Get the next event."
600
  (let ((event (read-event prompt)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
601 602 603 604 605 606 607 608 609 610 611 612 613
    (cons (and (numberp event) event) event)))

(defun gnus-copy-file (file &optional to)
  "Copy FILE to TO."
  (interactive
   (list (read-file-name "Copy file: " default-directory)
	 (read-file-name "Copy file to: " default-directory)))
  (unless to
    (setq to (read-file-name "Copy file to: " default-directory)))
  (copy-file file to))

(defvar gnus-work-buffer " *gnus work*")

614 615 616 617
(declare-function gnus-get-buffer-create "gnus" (name))
;; gnus.el requires mm-util.
(declare-function mm-enable-multibyte "mm-util")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
618 619 620 621 622 623
(defun gnus-set-work-buffer ()
  "Put point in the empty Gnus work buffer."
  (if (get-buffer gnus-work-buffer)
      (progn
	(set-buffer gnus-work-buffer)
	(erase-buffer))
624
    (set-buffer (gnus-get-buffer-create gnus-work-buffer))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
625
    (kill-all-local-variables)
626
    (mm-enable-multibyte)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
627 628 629 630 631 632 633 634

(defmacro gnus-group-real-name (group)
  "Find the real name of a foreign newsgroup."
  `(let ((gname ,group))
     (if (string-match "^[^:]+:" gname)
	 (substring gname (match-end 0))
       gname)))

Miles Bader's avatar
Miles Bader committed
635 636 637 638 639 640 641 642 643 644 645
(defmacro gnus-group-server (group)
  "Find the server name of a foreign newsgroup.
For example, (gnus-group-server \"nnimap+yxa:INBOX.foo\") would
yield \"nnimap:yxa\"."
  `(let ((gname ,group))
     (if (string-match "^\\([^:+]+\\)\\(?:\\+\\([^:]*\\)\\)?:" gname)
	 (format "%s:%s" (match-string 1 gname) (or
						 (match-string 2 gname)
						 ""))
       (format "%s:%s" (car gnus-select-method) (cadr gnus-select-method)))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
646
(defun gnus-make-sort-function (funs)
647
  "Return a composite sort condition based on the functions in FUNS."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
648
  (cond
649
   ;; Just a simple function.
650
   ((functionp funs) funs)
651
   ;; No functions at all.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
652
   ((null funs) funs)
653 654 655
   ;; A list of functions.
   ((or (cdr funs)
	(listp (car funs)))
656 657 658
    (gnus-byte-compile
     `(lambda (t1 t2)
	,(gnus-make-sort-function-1 (reverse funs)))))
659
   ;; A list containing just one function.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
660 661 662 663
   (t
    (car funs))))

(defun gnus-make-sort-function-1 (funs)
664
  "Return a composite sort condition based on the functions in FUNS."
665 666 667 668 669 670 671 672 673 674
  (let ((function (car funs))
	(first 't1)
	(last 't2))
    (when (consp function)
      (cond
       ;; Reversed spec.
       ((eq (car function) 'not)
	(setq function (cadr function)
	      first 't2
	      last 't1))
675
       ((functionp function)
676 677 678 679 680 681 682 683 684
	;; Do nothing.
	)
       (t
	(error "Invalid sort spec: %s" function))))
    (if (cdr funs)
	`(or (,function ,first ,last)
	     (and (not (,function ,last ,first))
		  ,(gnus-make-sort-function-1 (cdr funs))))
      `(,function ,first ,last))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
685 686 687 688 689 690

(defun gnus-turn-off-edit-menu (type)
  "Turn off edit menu in `gnus-TYPE-mode-map'."
  (define-key (symbol-value (intern (format "gnus-%s-mode-map" type)))
    [menu-bar edit] 'undefined))

691 692 693 694 695 696 697
(defmacro gnus-bind-print-variables (&rest forms)
  "Bind print-* variables and evaluate FORMS.
This macro is used with `prin1', `pp', etc. in order to ensure printed
Lisp objects are loadable.  Bind `print-quoted' and `print-readably'
to t, and `print-escape-multibyte', `print-escape-newlines',
`print-escape-nonascii', `print-length', `print-level' and
`print-string-length' to nil."
698 699 700 701 702 703 704 705 706 707 708 709
  `(let ((print-quoted t)
	 (print-readably t)
	 ;;print-circle
	 ;;print-continuous-numbering
	 print-escape-multibyte
	 print-escape-newlines
	 print-escape-nonascii
	 ;;print-gensym
	 print-length
	 print-level
	 print-string-length)
     ,@forms))
710

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
711 712
(defun gnus-prin1 (form)
  "Use `prin1' on FORM in the current buffer.
713 714 715
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (prin1 form (current-buffer))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
716 717

(defun gnus-prin1-to-string (form)
718 719 720 721 722
  "The same as `prin1'.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (prin1-to-string form)))

723
(defun gnus-pp (form &optional stream)
724 725 726
  "Use `pp' on FORM in the current buffer.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
727
  (gnus-bind-print-variables (pp form (or stream (current-buffer)))))
728 729 730 731 732 733

(defun gnus-pp-to-string (form)
  "The same as `pp-to-string'.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (pp-to-string form)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
734 735 736

(defun gnus-make-directory (directory)
  "Make DIRECTORY (and all its parents) if it doesn't exist."
737
  (require 'nnmail)
738 739 740 741
  (let ((file-name-coding-system nnmail-pathname-coding-system))
    (when (and directory
	       (not (file-exists-p directory)))
      (make-directory directory t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
742 743 744 745
  t)

(defun gnus-write-buffer (file)
  "Write the current buffer's contents to FILE."
746
  (require 'nnmail)
747
  (let ((file-name-coding-system nnmail-pathname-coding-system))
748 749
    ;; Make sure the directory exists.
    (gnus-make-directory (file-name-directory file))
750 751
    ;; Write the buffer.
    (write-region (point-min) (point-max) file nil 'quietly)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
752 753 754 755 756 757

(defun gnus-delete-file (file)
  "Delete FILE if it exists."
  (when (file-exists-p file)
    (delete-file file)))

758 759 760 761 762 763 764 765 766
(defun gnus-delete-duplicates (list)
  "Remove duplicate entries from LIST."
  (let ((result nil))
    (while list
      (unless (member (car list) result)
	(push (car list) result))
      (pop list))
    (nreverse result)))

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
(defun gnus-delete-directory (directory)
  "Delete files in DIRECTORY.  Subdirectories remain.
If there's no subdirectory, delete DIRECTORY as well."
  (when (file-directory-p directory)
    (let ((files (directory-files
		  directory t "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
	  file dir)
      (while files
	(setq file (pop files))
	(if (eq t (car (file-attributes file)))
	    ;; `file' is a subdirectory.
	    (setq dir t)
	  ;; `file' is a file or a symlink.
	  (delete-file file)))
      (unless dir
	(delete-directory directory)))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
784 785 786 787 788 789
(defun gnus-strip-whitespace (string)
  "Return STRING stripped of all whitespace."
  (while (string-match "[\r\n\t ]+" string)
    (setq string (replace-match "" t t string)))
  string)

790
(defsubst gnus-put-text-property-excluding-newlines (beg end prop val)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
791 792 793 794 795
  "The same as `put-text-property', but don't put this prop on any newlines in the region."
  (save-match-data
    (save-excursion
      (save-restriction
	(goto-char beg)
796
	(while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
797
	  (put-text-property beg (match-beginning 0) prop val)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
798
	  (setq beg (point)))
799
	(put-text-property beg (point) prop val)))))
800

801 802 803 804 805 806 807
(defsubst gnus-put-overlay-excluding-newlines (beg end prop val)
  "The same as `put-text-property', but don't put this prop on any newlines in the region."
  (save-match-data
    (save-excursion
      (save-restriction
	(goto-char beg)
	(while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
808
	  (overlay-put (make-overlay beg (match-beginning 0)) prop val)
809
	  (setq beg (point)))
810
	(overlay-put (make-overlay beg (point)) prop val)))))
811

812 813 814 815 816 817 818 819 820
(defun gnus-put-text-property-excluding-characters-with-faces (beg end prop val)
  "The same as `put-text-property', except where `gnus-face' is set.
If so, and PROP is `face', set the second element of its value to VAL.
Otherwise, do nothing."
  (while (< beg end)
    ;; Property values are compared with `eq'.
    (let ((stop (next-single-property-change beg 'face nil end)))
      (if (get-text-property beg 'gnus-face)
	  (when (eq prop 'face)
821
	    (setcar (cdr (get-text-property beg 'face)) (or val 'default)))
822
	(inline
823
	  (put-text-property beg stop prop val)))
824 825 826 827 828 829 830 831 832 833 834
      (setq beg stop))))

(defun gnus-get-text-property-excluding-characters-with-faces (pos prop)
  "The same as `get-text-property', except where `gnus-face' is set.
If so, and PROP is `face', return the second element of its value.
Otherwise, return the value."
  (let ((val (get-text-property pos prop)))
    (if (and (get-text-property pos 'gnus-face)
	     (eq prop 'face))
	(cadr val)
      (get-text-property pos prop))))
835

836 837
(defmacro gnus-faces-at (position)
  "Return a list of faces at POSITION."
838 839 840 841 842 843
  `(let ((pos ,position))
     (delq nil (cons (get-text-property pos 'face)
		     (mapcar
		      (lambda (overlay)
			(overlay-get overlay 'face))
		      (overlays-at pos))))))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
844

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
845
;;; Protected and atomic operations.  dmoore@ucsd.edu 21.11.1996
Paul Eggert's avatar
Paul Eggert committed
846
;; The primary idea here is to try to protect internal data structures
847 848 849
;; from becoming corrupted when the user hits C-g, or if a hook or
;; similar blows up.  Often in Gnus multiple tables/lists need to be
;; updated at the same time, or information can be lost.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

(defvar gnus-atomic-be-safe t
  "If t, certain operations will be protected from interruption by C-g.")

(defmacro gnus-atomic-progn (&rest forms)
  "Evaluate FORMS atomically, which means to protect the evaluation
from being interrupted by the user.  An error from the forms themselves
will return without finishing the operation.  Since interrupts from
the user are disabled, it is recommended that only the most minimal
operations are performed by FORMS.  If you wish to assign many
complicated values atomically, compute the results into temporary
variables and then do only the assignment atomically."
  `(let ((inhibit-quit gnus-atomic-be-safe))
     ,@forms))

865 866
(put 'gnus-atomic-progn 'lisp-indent-function 0)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
867
(defmacro gnus-atomic-progn-assign (protect &rest forms)
868
  "Evaluate FORMS, but ensure that the variables listed in PROTECT
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
869 870 871 872 873
are not changed if anything in FORMS signals an error or otherwise
non-locally exits.  The variables listed in PROTECT are updated atomically.
It is safe to use gnus-atomic-progn-assign with long computations.

Note that if any of the symbols in PROTECT were unbound, they will be
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
874
set to nil on a successful assignment.  In case of an error or other
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
875 876 877 878 879 880 881 882 883 884 885 886 887
non-local exit, it will still be unbound."
  (let* ((temp-sym-map (mapcar (lambda (x) (list (make-symbol
						  (concat (symbol-name x)
							  "-tmp"))
						 x))
			       protect))
	 (sym-temp-map (mapcar (lambda (x) (list (cadr x) (car x)))
			       temp-sym-map))
	 (temp-sym-let (mapcar (lambda (x) (list (car x)
						 `(and (boundp ',(cadr x))
						       ,(cadr x))))
			       temp-sym-map))
	 (sym-temp-let sym-temp-map)
888 889
	 (temp-sym-assign (apply 'append temp-sym-map))
	 (sym-temp-assign (apply 'append sym-temp-map))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
890 891 892 893 894 895 896 897 898 899
	 (result (make-symbol "result-tmp")))
    `(let (,@temp-sym-let
	   ,result)
       (let ,sym-temp-let
	 (setq ,result (progn ,@forms))
	 (setq ,@temp-sym-assign))
       (let ((inhibit-quit gnus-atomic-be-safe))
	 (setq ,@sym-temp-assign))
       ,result)))

900 901 902
(put 'gnus-atomic-progn-assign 'lisp-indent-function 1)
;(put 'gnus-atomic-progn-assign 'edebug-form-spec '(sexp body))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
(defmacro gnus-atomic-setq (&rest pairs)
  "Similar to setq, except that the real symbols are only assigned when
there are no errors.  And when the real symbols are assigned, they are
done so atomically.  If other variables might be changed via side-effect,
see gnus-atomic-progn-assign.  It is safe to use gnus-atomic-setq
with potentially long computations."
  (let ((tpairs pairs)
	syms)
    (while tpairs
      (push (car tpairs) syms)
      (setq tpairs (cddr tpairs)))
    `(gnus-atomic-progn-assign ,syms
       (setq ,@pairs))))

;(put 'gnus-atomic-setq 'edebug-form-spec '(body))


;;; Functions for saving to babyl/mail files.

922 923
(require 'rmail)
(autoload 'rmail-update-summary "rmailsum")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
924 925

(defvar mm-text-coding-system)
926

927 928
(declare-function mm-append-to-file "mm-util"
                  (start end filename &optional codesys inhibit))
Glenn Morris's avatar
Glenn Morris committed
929 930 931 932 933 934 935 936 937
(declare-function rmail-swap-buffers-maybe "rmail" ())
(declare-function rmail-maybe-set-message-counters "rmail" ())
(declare-function rmail-count-new-messages "rmail" (&optional nomsg))
(declare-function rmail-summary-exists "rmail" ())
(declare-function rmail-show-message "rmail" (&optional n no-summary))
;; Macroexpansion of rmail-select-summary:
(declare-function rmail-summary-displayed "rmail" ())
(declare-function rmail-pop-to-buffer "rmail" (&rest args))
(declare-function rmail-maybe-display-summary "rmail" ())
938

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
939
(defun gnus-output-to-rmail (filename &optional ask)
940 941 942
  "Append the current article to an Rmail file named FILENAME.
In Emacs 22 this writes Babyl format; in Emacs 23 it writes mbox unless
FILENAME exists and is Babyl format."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
943
  (require 'rmail)
944
  (require 'mm-util)
945
  (require 'nnmail)
946
  ;; Some of this codes is borrowed from rmailout.el.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
947
  (setq filename (expand-file-name filename))
948 949 950 951 952
  ;; FIXME should we really be messing with this defcustom?
  ;; It is not needed for the operation of this function.
  (if (boundp 'rmail-default-rmail-file)
      (setq rmail-default-rmail-file filename) ; 22
    (setq rmail-default-file filename))        ; 23
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
953
  (let ((artbuf (current-buffer))
954 955 956
	(tmpbuf (get-buffer-create " *Gnus-output*"))
        ;; Babyl rmail.el defines this, mbox does not.
        (babyl (fboundp 'rmail-insert-rmail-file-header)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
957
    (save-excursion
958 959 960 961 962 963 964 965
      ;; Note that we ignore the possibility of visiting a Babyl
      ;; format buffer in Emacs 23, since Rmail no longer supports that.
     (or (get-file-buffer filename)
         (progn
           ;; In case someone wants to write to a Babyl file from Emacs 23.
           (when (file-exists-p filename)
             (setq babyl (mail-file-babyl-p filename))
             t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
966 967 968 969
	  (if (or (not ask)
		  (gnus-yes-or-no-p
		   (concat "\"" filename "\" does not exist, create it? ")))
	      (let ((file-buffer (create-file-buffer filename)))
970
		(with-current-buffer file-buffer
971 972
                  (if (fboundp 'rmail-insert-rmail-file-header)
                      (rmail-insert-rmail-file-header))
973 974
		  (let ((require-final-newline nil)
			(coding-system-for-write mm-text-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
975 976 977 978 979 980
		    (gnus-write-buffer filename)))
		(kill-buffer file-buffer))
	    (error "Output file does not exist")))
      (set-buffer tmpbuf)
      (erase-buffer)
      (insert-buffer-substring artbuf)
981 982 983 984 985 986 987 988 989 990 991
      (if babyl
          (gnus-convert-article-to-rmail)
        ;; Non-Babyl case copied from gnus-output-to-mail.
        (goto-char (point-min))
        (if (looking-at "From ")
            (forward-line 1)
          (insert "From nobody " (current-time-string) "\n"))
        (let (case-fold-search)
          (while (re-search-forward "^From " nil t)
            (beginning-of-line)
            (insert ">"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
992 993 994
      ;; Decide whether to append to a file or to an Emacs buffer.
      (let ((outbuf (get-file-buffer filename)))
	(if (not outbuf)
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
            (progn
              (unless babyl             ; from gnus-output-to-mail
                (let ((buffer-read-only nil))
                  (goto-char (point-max))
                  (forward-char -2)
                  (unless (looking-at "\n\n")
                    (goto-char (point-max))
                    (unless (bolp)
                      (insert "\n"))
                    (insert "\n"))))
              (let ((file-name-coding-system nnmail-pathname-coding-system))
                (mm-append-to-file (point-min) (point-max) filename)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1007 1008 1009 1010 1011 1012
	  ;; File has been visited, in buffer OUTBUF.
	  (set-buffer outbuf)
	  (let ((buffer-read-only nil)
		(msg (and (boundp 'rmail-current-message)
			  (symbol-value 'rmail-current-message))))
	    ;; If MSG is non-nil, buffer is in RMAIL mode.
1013
            ;; Compare this with rmail-output-to-rmail-buffer in Emacs 23.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1014
	    (when msg
1015 1016 1017 1018 1019
              (unless babyl
                (rmail-swap-buffers-maybe)
                (rmail-maybe-set-message-counters))
              (widen)
              (narrow-to-region (point-max) (point-max)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1020 1021
	    (insert-buffer-substring tmpbuf)
	    (when msg
1022 1023 1024 1025 1026
              (when babyl
                (goto-char (point-min))
                (widen)
                (search-backward "\n\^_")
                (narrow-to-region (point) (point-max)))
1027 1028
	      (rmail-count-new-messages t)
	      (when (rmail-summary-exists)
1029 1030 1031 1032
		(rmail-select-summary
		 (rmail-update-summary)))
	      (rmail-show-message msg))
	    (save-buffer)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1033 1034 1035 1036
    (kill-buffer tmpbuf)))

(defun gnus-output-to-mail (filename &optional ask)
  "Append the current article to a mail file named FILENAME."
1037
  (require 'nnmail)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
  (setq filename (expand-file-name filename))
  (let ((artbuf (current-buffer))
	(tmpbuf (get-buffer-create " *Gnus-output*")))
    (save-excursion
      ;; Create the file, if it doesn't exist.
      (when (and (not (get-file-buffer filename))
		 (not (file-exists-p filename)))
	(if (or (not ask)
		(gnus-y-or-n-p
		 (concat "\"" filename "\" does not exist, create it? ")))
	    (let ((file-buffer (create-file-buffer filename)))
1049
	      (with-current-buffer file-buffer
1050 1051
		(let ((require-final-newline nil)
		      (coding-system-for-write mm-text-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
		  (gnus-write-buffer filename)))
	      (kill-buffer file-buffer))
	  (error "Output file does not exist")))
      (set-buffer tmpbuf)
      (erase-buffer)
      (insert-buffer-substring artbuf)
      (goto-char (point-min))
      (if (looking-at "From ")
	  (forward-line 1)
	(insert "From nobody " (current-time-string) "\n"))
      (let (case-fold-search)
	(while (re-search-forward "^From " nil t)
	  (beginning-of-line)
	  (insert ">")))
      ;; Decide whether to append to a file or to an Emacs buffer.
      (let ((outbuf (get-file-buffer filename)))
	(if (not outbuf)
	    (let ((buffer-read-only nil))
	      (save-excursion
		(goto-char (point-max))
		(forward-char -2)
		(unless (looking-at "\n\n")
		  (goto-char (point-max))
		  (unless (bolp)
		    (insert "\n"))
		  (insert "\n"))
		(goto-char (point-max))
1079 1080
		(let ((file-name-coding-system nnmail-pathname-coding-system))
		  (mm-append-to-file (point-min) (point-max) filename))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
	  ;; File has been visited, in buffer OUTBUF.
	  (set-buffer outbuf)
	  (let ((buffer-read-only nil))
	    (goto-char (point-max))
	    (unless (eobp)
	      (insert "\n"))
	    (insert "\n")
	    (insert-buffer-substring tmpbuf)))))
    (kill-buffer tmpbuf)))

(defun gnus-convert-article-to-rmail ()
  "Convert article in current buffer to Rmail message format."
  (let ((buffer-read-only nil))
    ;; Convert article directly into Babyl format.
    (goto-char (point-min))
    (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
    (while (search-forward "\n\^_" nil t) ;single char
      (replace-match "\n^_" t t))	;2 chars: "^" and "_"
    (goto-char (point-max))
    (insert "\^_")))

1102
(defun gnus-map-function (funs arg)
1103
  "Apply the result of the first function in FUNS to the second, and so on.
1104
ARG is passed to the first function."
1105 1106 1107
  (while funs
    (setq arg (funcall (pop funs) arg)))
  arg)
1108 1109

(defun gnus-run-hooks (&rest funcs)
1110 1111
  "Does the same as `run-hooks', but saves the current buffer."
  (save-current-buffer
1112
    (apply 'run-hooks funcs)))
1113

1114 1115 1116
(defun gnus-run-hook-with-args (hook &rest args)
  "Does the same as `run-hook-with-args', but saves the current buffer."
  (save-current-buffer
1117
    (apply 'run-hook-with-args hook args)))
1118

1119
(defun gnus-run-mode-hooks (&rest funcs)
1120
  "Run `run-mode-hooks', saving the current buffer."
1121
  (save-current-buffer (apply 'run-mode-hooks funcs)))
1122

1123 1124
;;; Various

1125
(defvar gnus-group-buffer)		; Compiler directive
1126 1127 1128 1129
(defun gnus-alive-p ()
  "Say whether Gnus is running or not."
  (and (boundp 'gnus-group-buffer)
       (get-buffer gnus-group-buffer)
1130
       (with-current-buffer gnus-group-buffer
1131 1132
	 (eq major-mode 'gnus-group-mode))))

1133 1134 1135
(define-obsolete-function-alias 'gnus-remove-if 'seq-remove "27.1")

(define-obsolete-function-alias 'gnus-remove-if-not 'seq-filter "27.1")
1136

1137 1138 1139 1140 1141 1142 1143 1144
(defun gnus-grep-in-list (word list)
  "Find if a WORD matches any regular expression in the given LIST."
  (when (and word list)
    (catch 'found
      (dolist (r list)
	(when (string-match r word)
	  (throw 'found r))))))

1145
(defmacro gnus-alist-pull (key alist &optional assoc-p)
1146 1147 1148
  "Modify ALIST to be without KEY."
  (unless (symbolp alist)
    (error "Not a symbol: %s" alist))
1149 1150
  (let ((fun (if assoc-p 'assoc 'assq)))
    `(setq ,alist (delq (,fun ,key ,alist) ,alist))))
1151 1152

(defun gnus-globalify-regexp (re)
1153
  "Return a regexp that matches a whole line, if RE matches a part of it."
1154 1155 1156 1157
  (concat (unless (string-match "^\\^" re) "^.*")
	  re
	  (unless (string-match "\\$$" re) ".*$")))

1158 1159
(defun gnus-set-window-start (&optional point)
  "Set the window start to POINT, or (point) if nil."
<