1 ;;; gnus-art.el --- article mode commands for Gnus
2 ;; Copyright (C) 1996,97 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
35 (defgroup gnus-article nil
37 :link '(custom-manual "(gnus)The Article Buffer")
40 (defgroup gnus-article-hiding nil
41 "Hiding article parts."
42 :link '(custom-manual "(gnus)Article Hiding")
45 (defgroup gnus-article-highlight nil
46 "Article highlighting."
47 :link '(custom-manual "(gnus)Article Highlighting")
51 (defgroup gnus-article-signature nil
53 :link '(custom-manual "(gnus)Article Signature")
56 (defgroup gnus-article-headers nil
58 :link '(custom-manual "(gnus)Hiding Headers")
61 (defgroup gnus-article-washing nil
62 "Special commands on articles."
63 :link '(custom-manual "(gnus)Article Washing")
66 (defgroup gnus-article-emphasis nil
67 "Fontisizing articles."
68 :link '(custom-manual "(gnus)Article Fontisizing")
71 (defgroup gnus-article-saving nil
73 :link '(custom-manual "(gnus)Saving Articles")
76 (defgroup gnus-article-mime nil
77 "Worshiping the MIME wonder."
78 :link '(custom-manual "(gnus)Using MIME")
81 (defgroup gnus-article-buttons nil
82 "Pushable buttons in the article buffer."
83 :link '(custom-manual "(gnus)Article Buttons")
86 (defgroup gnus-article-various nil
87 "Other article options."
88 :link '(custom-manual "(gnus)Misc Article")
91 (defcustom gnus-ignored-headers
92 '("^Path:" "^Posting-Version:" "^Article-I.D.:" "^Expires:"
93 "^Date-Received:" "^References:" "^Control:" "^Xref:" "^Lines:"
94 "^Posted:" "^Relay-Version:" "^Message-ID:" "^Nf-ID:" "^Nf-From:"
95 "^Approved:" "^Sender:" "^Received:" "^Mail-from:")
96 "All headers that match this regexp will be hidden.
97 This variable can also be a list of regexps of headers to be ignored.
98 If `gnus-visible-headers' is non-nil, this variable will be ignored."
99 :type '(choice :custom-show nil
102 :group 'gnus-article-hiding)
104 (defcustom gnus-visible-headers
105 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From"
106 "All headers that do not match this regexp will be hidden.
107 This variable can also be a list of regexp of headers to remain visible.
108 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
109 :type '(repeat :value-to-internal (lambda (widget value)
110 (custom-split-regexp-maybe value))
111 :match (lambda (widget value)
113 (widget-editable-list-match widget value)))
115 :group 'gnus-article-hiding)
117 (defcustom gnus-sorted-header-list
118 '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:" "^To:"
119 "^Cc:" "^Date:" "^Organization:")
120 "This variable is a list of regular expressions.
121 If it is non-nil, headers that match the regular expressions will
122 be placed first in the article buffer in the sequence specified by
124 :type '(repeat regexp)
125 :group 'gnus-article-hiding)
127 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
128 "Headers that are only to be displayed if they have interesting data.
129 Possible values in this list are `empty', `newsgroups', `followup-to',
130 `reply-to', and `date'."
131 :type '(set (const :tag "Headers with no content." empty)
132 (const :tag "Newsgroups with only one group." newsgroups)
133 (const :tag "Followup-to identical to newsgroups." followup-to)
134 (const :tag "Reply-to identical to from." reply-to)
135 (const :tag "Date less than four days old." date))
136 :group 'gnus-article-hiding)
138 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
139 "Regexp matching signature separator.
140 This can also be a list of regexps. In that case, it will be checked
141 from head to tail looking for a separator. Searches will be done from
142 the end of the buffer."
143 :type '(repeat string)
144 :group 'gnus-article-signature)
146 (defcustom gnus-signature-limit nil
147 "Provide a limit to what is considered a signature.
148 If it is a number, no signature may not be longer (in characters) than
149 that number. If it is a floating point number, no signature may be
150 longer (in lines) than that number. If it is a function, the function
151 will be called without any parameters, and if it returns nil, there is
152 no signature in the buffer. If it is a string, it will be used as a
153 regexp. If it matches, the text in question is not a signature."
154 :type '(choice integer number function regexp)
155 :group 'gnus-article-signature)
157 (defcustom gnus-hidden-properties '(invisible t intangible t)
158 "Property list to use for hiding text."
160 :group 'gnus-article-hiding)
162 (defcustom gnus-article-x-face-command
163 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
164 "String or function to be executed to display an X-Face header.
165 If it is a string, the command will be executed in a sub-shell
166 asynchronously. The compressed face will be piped to this command."
167 :type 'string ;Leave function case to Lisp.
168 :group 'gnus-article-washing)
170 (defcustom gnus-article-x-face-too-ugly nil
171 "Regexp matching posters whose face shouldn't be shown automatically."
173 :group 'gnus-article-washing)
175 (defcustom gnus-emphasis-alist
177 "\\(\\s-\\|^\\|[-\"\(]\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-?!.,;:\"\)]\\)")
179 '(("_" "_" underline)
182 ("_/" "/_" underline-italic)
183 ("_\\*" "\\*_" underline-bold)
184 ("\\*/" "/\\*" bold-italic)
185 ("_\\*/" "/\\*_" underline-bold-italic))))
186 `(("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
187 2 3 gnus-emphasis-underline)
191 (format format (car spec) (cadr spec))
192 2 3 (intern (format "gnus-emphasis-%s" (caddr spec)))))
194 "Alist that says how to fontify certain phrases.
195 Each item looks like this:
197 (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
199 The first element is a regular expression to be matched. The second
200 is a number that says what regular expression grouping used to find
201 the entire emphasized word. The third is a number that says what
202 regexp grouping should be displayed and highlighted. The fourth
203 is the face used for highlighting."
204 :type '(repeat (list :value ("" 0 0 default)
206 (integer :tag "Match group")
207 (integer :tag "Emphasize group")
209 :group 'gnus-article-emphasis)
211 (defface gnus-emphasis-bold '((t (:bold t)))
212 "Face used for displaying strong emphasized text (*word*)."
213 :group 'gnus-article-emphasis)
215 (defface gnus-emphasis-italic '((t (:italic t)))
216 "Face used for displaying italic emphasized text (/word/)."
217 :group 'gnus-article-emphasis)
219 (defface gnus-emphasis-underline '((t (:underline t)))
220 "Face used for displaying underlined emphasized text (_word_)."
221 :group 'gnus-article-emphasis)
223 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
224 "Face used for displaying underlined bold emphasized text (_*word*_)."
225 :group 'gnus-article-emphasis)
227 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
228 "Face used for displaying underlined italic emphasized text (_*word*_)."
229 :group 'gnus-article-emphasis)
231 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
232 "Face used for displaying bold italic emphasized text (/*word*/)."
233 :group 'gnus-article-emphasis)
235 (defface gnus-emphasis-underline-bold-italic
236 '((t (:bold t :italic t :underline t)))
237 "Face used for displaying underlined bold italic emphasized text.
238 Esample: (_/*word*/_)."
239 :group 'gnus-article-emphasis)
241 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
242 "Format for display of Date headers in article bodies.
243 See `format-time-zone' for the possible values."
245 :link '(custom-manual "(gnus)Article Date")
246 :group 'gnus-article-washing)
249 (autoload 'hexl-hex-string-to-integer "hexl")
250 (autoload 'timezone-make-date-arpa-standard "timezone")
251 (autoload 'mail-extract-address-components "mail-extr"))
253 (defcustom gnus-article-save-directory gnus-directory
254 "*Name of the directory articles will be saved in (default \"~/News\")."
255 :group 'gnus-article-saving
258 (defcustom gnus-save-all-headers t
259 "*If non-nil, don't remove any headers before saving."
260 :group 'gnus-article-saving
263 (defcustom gnus-prompt-before-saving 'always
264 "*This variable says how much prompting is to be done when saving articles.
265 If it is nil, no prompting will be done, and the articles will be
266 saved to the default files. If this variable is `always', each and
267 every article that is saved will be preceded by a prompt, even when
268 saving large batches of articles. If this variable is neither nil not
269 `always', there the user will be prompted once for a file name for
270 each invocation of the saving commands."
271 :group 'gnus-article-saving
272 :type '(choice (item always)
273 (item :tag "never" nil)
274 (sexp :tag "once" :format "%t")))
276 (defcustom gnus-saved-headers gnus-visible-headers
277 "Headers to keep if `gnus-save-all-headers' is nil.
278 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
279 If that variable is nil, however, all headers that match this regexp
280 will be kept while the rest will be deleted before saving."
281 :group 'gnus-article-saving
282 :type '(repeat string))
284 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
285 "A function to save articles in your favourite format.
286 The function must be interactively callable (in other words, it must
287 be an Emacs command).
289 Gnus provides the following functions:
291 * gnus-summary-save-in-rmail (Rmail format)
292 * gnus-summary-save-in-mail (Unix mail format)
293 * gnus-summary-save-in-folder (MH folder)
294 * gnus-summary-save-in-file (article format)
295 * gnus-summary-save-in-vm (use VM's folder format)
296 * gnus-summary-write-to-file (article format -- overwrite)."
297 :group 'gnus-article-saving
298 :type '(radio (function-item gnus-summary-save-in-rmail)
299 (function-item gnus-summary-save-in-mail)
300 (function-item gnus-summary-save-in-folder)
301 (function-item gnus-summary-save-in-file)
302 (function-item gnus-summary-save-in-vm)
303 (function-item gnus-summary-write-to-file)))
305 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
306 "A function generating a file name to save articles in Rmail format.
307 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
308 :group 'gnus-article-saving
311 (defcustom gnus-mail-save-name 'gnus-plain-save-name
312 "A function generating a file name to save articles in Unix mail format.
313 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
314 :group 'gnus-article-saving
317 (defcustom gnus-folder-save-name 'gnus-folder-save-name
318 "A function generating a file name to save articles in MH folder.
319 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
320 :group 'gnus-article-saving
323 (defcustom gnus-file-save-name 'gnus-numeric-save-name
324 "A function generating a file name to save articles in article format.
325 The function is called with NEWSGROUP, HEADERS, and optional
327 :group 'gnus-article-saving
330 (defcustom gnus-split-methods
331 '((gnus-article-archive-name))
332 "Variable used to suggest where articles are to be saved.
333 For instance, if you would like to save articles related to Gnus in
334 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
335 you could set this variable to something like:
337 '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
338 (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
340 This variable is an alist where the where the key is the match and the
341 value is a list of possible files to save in if the match is non-nil.
343 If the match is a string, it is used as a regexp match on the
344 article. If the match is a symbol, that symbol will be funcalled
345 from the buffer of the article to be saved with the newsgroup as the
346 parameter. If it is a list, it will be evaled in the same buffer.
348 If this form or function returns a string, this string will be used as
349 a possible file name; and if it returns a non-nil list, that list will
350 be used as possible file names."
351 :group 'gnus-article-saving
352 :type '(repeat (choice (list function)
353 (cons regexp (repeat string))
356 (defcustom gnus-strict-mime t
357 "*If nil, MIME-decode even if there is no Mime-Version header."
358 :group 'gnus-article-mime
361 (defcustom gnus-show-mime-method 'metamail-buffer
362 "Function to process a MIME message.
363 The function is called from the article buffer."
364 :group 'gnus-article-mime
367 (defcustom gnus-decode-encoded-word-method 'gnus-article-de-quoted-unreadable
368 "*Function to decode MIME encoded words.
369 The function is called from the article buffer."
370 :group 'gnus-article-mime
373 (defcustom gnus-page-delimiter "^\^L"
374 "*Regexp describing what to use as article page delimiters.
375 The default value is \"^\^L\", which is a form linefeed at the
376 beginning of a line."
378 :group 'gnus-article-various)
380 (defcustom gnus-article-mode-line-format "Gnus: %%b %S"
381 "*The format specification for the article mode line.
382 See `gnus-summary-mode-line-format' for a closer description."
384 :group 'gnus-article-various)
386 (defcustom gnus-article-mode-hook nil
387 "*A hook for Gnus article mode."
389 :group 'gnus-article-various)
391 (defcustom gnus-article-menu-hook nil
392 "*Hook run after the creation of the article mode menu."
394 :group 'gnus-article-various)
396 (defcustom gnus-article-prepare-hook nil
397 "*A hook called after an article has been prepared in the article buffer.
398 If you want to run a special decoding program like nkf, use this hook."
400 :group 'gnus-article-various)
402 (defcustom gnus-article-button-face 'bold
403 "Face used for highlighting buttons in the article buffer.
405 An article button is a piece of text that you can activate by pressing
406 `RET' or `mouse-2' above it."
408 :group 'gnus-article-buttons)
410 (defcustom gnus-article-mouse-face 'highlight
411 "Face used for mouse highlighting in the article buffer.
413 Article buttons will be displayed in this face when the cursor is
416 :group 'gnus-article-buttons)
418 (defcustom gnus-signature-face 'italic
419 "Face used for highlighting a signature in the article buffer."
421 :group 'gnus-article-highlight
422 :group 'gnus-article-signature)
424 (defface gnus-header-from-face
427 (:foreground "light blue" :bold t :italic t))
430 (:foreground "MidnightBlue" :bold t :italic t))
432 (:bold t :italic t)))
433 "Face used for displaying from headers."
434 :group 'gnus-article-headers
435 :group 'gnus-article-highlight)
437 (defface gnus-header-subject-face
440 (:foreground "pink" :bold t :italic t))
443 (:foreground "firebrick" :bold t :italic t))
445 (:bold t :italic t)))
446 "Face used for displaying subject headers."
447 :group 'gnus-article-headers
448 :group 'gnus-article-highlight)
450 (defface gnus-header-newsgroups-face
453 (:foreground "yellow" :bold t :italic t))
456 (:foreground "indianred" :bold t :italic t))
458 (:bold t :italic t)))
459 "Face used for displaying newsgroups headers."
460 :group 'gnus-article-headers
461 :group 'gnus-article-highlight)
463 (defface gnus-header-name-face
466 (:foreground "cyan" :bold t))
469 (:foreground "DarkGreen" :bold t))
472 "Face used for displaying header names."
473 :group 'gnus-article-headers
474 :group 'gnus-article-highlight)
476 (defface gnus-header-content-face
479 (:foreground "forest green" :italic t))
482 (:foreground "DarkGreen" :italic t))
484 (:italic t))) "Face used for displaying header content."
485 :group 'gnus-article-headers
486 :group 'gnus-article-highlight)
488 (defcustom gnus-header-face-alist
489 '(("From" nil gnus-header-from-face)
490 ("Subject" nil gnus-header-subject-face)
491 ("Newsgroups:.*," nil gnus-header-newsgroups-face)
492 ("" gnus-header-name-face gnus-header-content-face))
493 "Controls highlighting of article header.
495 An alist of the form (HEADER NAME CONTENT).
497 HEADER is a regular expression which should match the name of an
498 header header and NAME and CONTENT are either face names or nil.
500 The name of each header field will be displayed using the face
501 specified by the first element in the list where HEADER match the
502 header name and NAME is non-nil. Similarly, the content will be
503 displayed by the first non-nil matching CONTENT face."
504 :group 'gnus-article-headers
505 :group 'gnus-article-highlight
506 :type '(repeat (list (regexp :tag "Header")
508 (item :tag "skip" nil)
509 (face :value default))
510 (choice :tag "Content"
511 (item :tag "skip" nil)
512 (face :value default)))))
514 ;;; Internal variables
516 (defvar gnus-article-mode-syntax-table
517 (let ((table (copy-syntax-table text-mode-syntax-table)))
518 ;;(modify-syntax-entry ?_ "w" table)
520 "Syntax table used in article mode buffers.
521 Initialized from `text-mode-syntax-table.")
523 (defvar gnus-save-article-buffer nil)
525 (defvar gnus-article-mode-line-format-alist
526 (nconc '((?w (gnus-article-wash-status) ?s))
527 gnus-summary-mode-line-format-alist))
529 (defvar gnus-number-of-articles-to-be-saved nil)
531 (defvar gnus-inhibit-hiding nil)
532 (defvar gnus-newsgroup-name)
534 (defsubst gnus-article-hide-text (b e props)
535 "Set text PROPS on the B to E region, extending `intangible' 1 past B."
536 (add-text-properties b e props)
537 (when (memq 'intangible props)
539 (max (1- b) (point-min))
540 b 'intangible (cddr (memq 'intangible props)))))
542 (defsubst gnus-article-unhide-text (b e)
543 "Remove hidden text properties from region between B and E."
544 (remove-text-properties b e gnus-hidden-properties)
545 (when (memq 'intangible gnus-hidden-properties)
546 (put-text-property (max (1- b) (point-min))
549 (defun gnus-article-hide-text-type (b e type)
550 "Hide text of TYPE between B and E."
551 (gnus-article-hide-text
552 b e (cons 'article-type (cons type gnus-hidden-properties))))
554 (defun gnus-article-unhide-text-type (b e type)
555 "Hide text of TYPE between B and E."
556 (remove-text-properties
557 b e (cons 'article-type (cons type gnus-hidden-properties)))
558 (when (memq 'intangible gnus-hidden-properties)
559 (put-text-property (max (1- b) (point-min))
562 (defun gnus-article-hide-text-of-type (type)
563 "Hide text of TYPE in the current buffer."
565 (let ((b (point-min))
567 (while (setq b (text-property-any b e 'article-type type))
568 (add-text-properties b (incf b) gnus-hidden-properties)))))
570 (defun gnus-article-delete-text-of-type (type)
571 "Delete text of TYPE in the current buffer."
573 (let ((b (point-min)))
574 (while (setq b (text-property-any b (point-max) 'article-type type))
575 (delete-region b (incf b))))))
577 (defun gnus-article-delete-invisible-text ()
578 "Delete all invisible text in the current buffer."
580 (let ((b (point-min)))
581 (while (setq b (text-property-any b (point-max) 'invisible t))
582 (delete-region b (incf b))))))
584 (defun gnus-article-text-type-exists-p (type)
585 "Say whether any text of type TYPE exists in the buffer."
586 (text-property-any (point-min) (point-max) 'article-type type))
588 (defsubst gnus-article-header-rank ()
589 "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
590 (let ((list gnus-sorted-header-list)
593 (when (looking-at (car list))
595 (setq list (cdr list))
599 (defun article-hide-headers (&optional arg delete)
600 "Toggle whether to hide unwanted headers and possibly sort them as well.
601 If given a negative prefix, always show; if given a positive prefix,
603 (interactive (gnus-article-hidden-arg))
604 (if (gnus-article-check-hidden-text 'headers arg)
605 ;; Show boring headers as well.
606 (gnus-article-show-hidden-text 'boring-headers)
607 ;; This function might be inhibited.
608 (unless gnus-inhibit-hiding
611 (let ((buffer-read-only nil)
612 (props (nconc (list 'article-type 'headers)
613 gnus-hidden-properties))
614 (max (1+ (length gnus-sorted-header-list)))
615 (ignored (when (not gnus-visible-headers)
616 (cond ((stringp gnus-ignored-headers)
617 gnus-ignored-headers)
618 ((listp gnus-ignored-headers)
619 (mapconcat 'identity gnus-ignored-headers
622 (cond ((stringp gnus-visible-headers)
623 gnus-visible-headers)
624 ((and gnus-visible-headers
625 (listp gnus-visible-headers))
626 (mapconcat 'identity gnus-visible-headers "\\|"))))
627 (inhibit-point-motion-hooks t)
629 ;; First we narrow to just the headers.
631 (goto-char (point-min))
632 ;; Hide any "From " lines at the beginning of (mail) articles.
633 (while (looking-at "From ")
637 (delete-region (point-min) (point))
638 (gnus-article-hide-text (point-min) (point) props)))
639 ;; Then treat the rest of the header lines.
642 (if (search-forward "\n\n" nil t) ; if there's a body
643 (progn (forward-line -1) (point))
645 ;; Then we use the two regular expressions
646 ;; `gnus-ignored-headers' and `gnus-visible-headers' to
647 ;; select which header lines is to remain visible in the
649 (goto-char (point-min))
650 (while (re-search-forward "^[^ \t]*:" nil t)
652 ;; Mark the rank of the header.
654 (point) (1+ (point)) 'message-rank
655 (if (or (and visible (looking-at visible))
657 (not (looking-at ignored))))
658 (gnus-article-header-rank)
661 (message-sort-headers-1)
662 (when (setq beg (text-property-any
663 (point-min) (point-max) 'message-rank (+ 2 max)))
664 ;; We make the unwanted headers invisible.
666 (delete-region beg (point-max))
667 ;; Suggested by Sudish Joseph <joseph@cis.ohio-state.edu>.
668 (gnus-article-hide-text-type beg (point-max) 'headers))
669 ;; Work around XEmacs lossage.
670 (put-text-property (point-min) beg 'invisible nil))))))))
672 (defun article-hide-boring-headers (&optional arg)
673 "Toggle hiding of headers that aren't very interesting.
674 If given a negative prefix, always show; if given a positive prefix,
676 (interactive (gnus-article-hidden-arg))
677 (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
678 (not gnus-show-all-headers))
681 (let ((buffer-read-only nil)
682 (list gnus-boring-article-headers)
683 (inhibit-point-motion-hooks t)
685 (nnheader-narrow-to-headers)
687 (setq elem (pop list))
688 (goto-char (point-min))
690 ;; Hide empty headers.
692 (while (re-search-forward "^[^:]+:[ \t]*\n[^ \t]" nil t)
694 (gnus-article-hide-text-type
695 (progn (beginning-of-line) (point))
698 (if (re-search-forward "^[^ \t]" nil t)
702 ;; Hide boring Newsgroups header.
703 ((eq elem 'newsgroups)
704 (when (equal (gnus-fetch-field "newsgroups")
705 (gnus-group-real-name
706 (if (boundp 'gnus-newsgroup-name)
709 (gnus-article-hide-header "newsgroups")))
710 ((eq elem 'followup-to)
711 (when (equal (message-fetch-field "followup-to")
712 (message-fetch-field "newsgroups"))
713 (gnus-article-hide-header "followup-to")))
715 (let ((from (message-fetch-field "from"))
716 (reply-to (message-fetch-field "reply-to")))
721 (nth 1 (mail-extract-address-components from))
722 (nth 1 (mail-extract-address-components reply-to)))))
723 (gnus-article-hide-header "reply-to"))))
725 (let ((date (message-fetch-field "date")))
727 (< (gnus-days-between (current-time-string) date)
729 (gnus-article-hide-header "date")))))))))))
731 (defun gnus-article-hide-header (header)
733 (goto-char (point-min))
734 (when (re-search-forward (concat "^" header ":") nil t)
735 (gnus-article-hide-text-type
736 (progn (beginning-of-line) (point))
739 (if (re-search-forward "^[^ \t]" nil t)
744 ;; Written by Per Abrahamsen <amanda@iesd.auc.dk>.
745 (defun article-treat-overstrike ()
746 "Translate overstrikes into bold text."
749 (let ((buffer-read-only nil))
750 (while (search-forward "\b" nil t)
751 (let ((next (following-char))
752 (previous (char-after (- (point) 2))))
753 ;; We do the boldification/underlining by hiding the
754 ;; overstrikes and putting the proper text property
758 (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
759 (put-text-property (point) (1+ (point)) 'face 'bold))
761 (gnus-article-hide-text-type (1- (point)) (1+ (point)) 'overstrike)
763 (- (point) 2) (1- (point)) 'face 'underline))
765 (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
767 (point) (1+ (point)) 'face 'underline))))))))
769 (defun article-fill ()
770 "Format too long lines."
773 (let ((buffer-read-only nil))
775 (goto-char (point-min))
776 (search-forward "\n\n" nil t)
778 (let ((paragraph-start "^[>|#:<;* ]*[ \t]*$")
779 (adaptive-fill-regexp "[ \t]*\\([|#:<;>*]+ *\\)?")
780 (adaptive-fill-mode t))
782 (and (>= (current-column) (min fill-column (window-width)))
783 (/= (preceding-char) ?:)
784 (fill-paragraph nil))
787 (defun article-remove-cr ()
788 "Remove carriage returns from an article."
791 (let ((buffer-read-only nil))
792 (goto-char (point-min))
793 (while (search-forward "\r" nil t)
794 (replace-match "" t t)))))
796 (defun article-remove-trailing-blank-lines ()
797 "Remove all trailing blank lines from the article."
800 (let ((buffer-read-only nil))
801 (goto-char (point-max))
805 (while (and (not (bobp))
806 (looking-at "^[ \t]*$"))
811 (defun article-display-x-face (&optional force)
812 "Look for an X-Face header and display it if present."
813 (interactive (list 'force))
815 ;; Delete the old process, if any.
816 (when (process-status "article-x-face")
817 (delete-process "article-x-face"))
818 (let ((inhibit-point-motion-hooks t)
819 (case-fold-search nil)
822 (nnheader-narrow-to-headers)
823 (setq from (message-fetch-field "from"))
824 (goto-char (point-min))
825 (when (and gnus-article-x-face-command
827 ;; Check whether this face is censored.
828 (not gnus-article-x-face-too-ugly)
829 (and gnus-article-x-face-too-ugly from
830 (not (string-match gnus-article-x-face-too-ugly
832 ;; Has to be present.
833 (re-search-forward "^X-Face: " nil t))
834 ;; We now have the area of the buffer where the X-Face is stored.
836 (end (1- (re-search-forward "^\\($\\|[^ \t]\\)" nil t))))
837 ;; We display the face.
838 (if (symbolp gnus-article-x-face-command)
839 ;; The command is a lisp function, so we call it.
840 (if (gnus-functionp gnus-article-x-face-command)
841 (funcall gnus-article-x-face-command beg end)
842 (error "%s is not a function" gnus-article-x-face-command))
843 ;; The command is a string, so we interpret the command
844 ;; as a, well, command, and fork it off.
845 (let ((process-connection-type nil))
846 (process-kill-without-query
848 "article-x-face" nil shell-file-name shell-command-switch
849 gnus-article-x-face-command))
850 (process-send-region "article-x-face" beg end)
851 (process-send-eof "article-x-face")))))))))
853 (defalias 'gnus-decode-rfc1522 'article-decode-rfc1522)
854 (defalias 'gnus-article-decode-rfc1522 'article-decode-rfc1522)
855 (defun article-decode-rfc1522 ()
856 "Hack to remove QP encoding from headers."
857 (let ((case-fold-search t)
858 (inhibit-point-motion-hooks t)
859 (buffer-read-only nil)
863 (goto-char (point-min))
864 (or (search-forward "\n\n" nil t) (point-max)))
865 (goto-char (point-min))
866 (while (re-search-forward
867 "=\\?iso-8859-1\\?q\\?\\([^?\t\n]*\\)\\?=" nil t)
868 (setq string (match-string 1))
870 (narrow-to-region (match-beginning 0) (match-end 0))
871 (delete-region (point-min) (point-max))
873 (article-mime-decode-quoted-printable
874 (goto-char (point-min)) (point-max))
875 (subst-char-in-region (point-min) (point-max) ?_ ? )
876 (goto-char (point-max)))
877 (goto-char (point-min))))))
879 (defun article-de-quoted-unreadable (&optional force)
880 "Do a naive translation of a quoted-printable-encoded article.
881 This is in no way, shape or form meant as a replacement for real MIME
882 processing, but is simply a stop-gap measure until MIME support is
884 If FORCE, decode the article whether it is marked as quoted-printable
886 (interactive (list 'force))
888 (let ((case-fold-search t)
889 (buffer-read-only nil)
890 (type (gnus-fetch-field "content-transfer-encoding")))
891 (gnus-article-decode-rfc1522)
893 (and type (string-match "quoted-printable" (downcase type))))
894 (goto-char (point-min))
895 (search-forward "\n\n" nil 'move)
896 (article-mime-decode-quoted-printable (point) (point-max))))))
898 (defun article-mime-decode-quoted-printable-buffer ()
899 "Decode Quoted-Printable in the current buffer."
900 (article-mime-decode-quoted-printable (point-min) (point-max)))
902 (defun article-mime-decode-quoted-printable (from to)
903 "Decode Quoted-Printable in the region between FROM and TO."
906 (while (search-forward "=" to t)
907 (cond ((eq (following-char) ?\n)
910 ((looking-at "[0-9A-F][0-9A-F]")
911 (subst-char-in-region
912 (1- (point)) (point) ?=
913 (hexl-hex-string-to-integer
914 (buffer-substring (point) (+ 2 (point)))))
918 ((gnus-message 3 "Malformed MIME quoted-printable message")))))
920 (defun article-hide-pgp (&optional arg)
921 "Toggle hiding of any PGP headers and signatures in the current article.
922 If given a negative prefix, always show; if given a positive prefix,
924 (interactive (gnus-article-hidden-arg))
925 (unless (gnus-article-check-hidden-text 'pgp arg)
927 (let ((inhibit-point-motion-hooks t)
928 buffer-read-only beg end)
930 (goto-char (point-min))
931 ;; Hide the "header".
932 (when (search-forward "\n-----BEGIN PGP SIGNED MESSAGE-----\n" nil t)
933 (gnus-article-hide-text-type (match-beginning 0) (match-end 0) 'pgp))
935 ;; Hide the actual signature.
936 (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
937 (setq end (1+ (match-beginning 0)))
938 (gnus-article-hide-text-type
940 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
942 ;; Perhaps we shouldn't hide to the end of the buffer
943 ;; if there is no end to the signature?
946 ;; Hide "- " PGP quotation markers.
948 (narrow-to-region beg end)
949 (goto-char (point-min))
950 (while (re-search-forward "^- " nil t)
951 (gnus-article-hide-text-type
952 (match-beginning 0) (match-end 0) 'pgp))
955 (defun article-hide-pem (&optional arg)
956 "Toggle hiding of any PEM headers and signatures in the current article.
957 If given a negative prefix, always show; if given a positive prefix,
959 (interactive (gnus-article-hidden-arg))
960 (unless (gnus-article-check-hidden-text 'pem arg)
962 (let (buffer-read-only end)
964 (goto-char (point-min))
965 ;; hide the horrendously ugly "header".
966 (and (search-forward "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
969 (setq end (1+ (match-beginning 0)))
970 (gnus-article-hide-text-type
972 (if (search-forward "\n\n" nil t)
976 ;; hide the trailer as well
977 (and (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
980 (gnus-article-hide-text-type
981 (match-beginning 0) (match-end 0) 'pem))))))
983 (defun article-hide-signature (&optional arg)
984 "Hide the signature in the current article.
985 If given a negative prefix, always show; if given a positive prefix,
987 (interactive (gnus-article-hidden-arg))
988 (unless (gnus-article-check-hidden-text 'signature arg)
991 (let ((buffer-read-only nil))
992 (when (gnus-article-narrow-to-signature)
993 (gnus-article-hide-text-type
994 (point-min) (point-max) 'signature)))))))
996 (defun article-strip-leading-blank-lines ()
997 "Remove all blank lines from the beginning of the article."
1000 (let ((inhibit-point-motion-hooks t)
1002 (goto-char (point-min))
1003 (when (search-forward "\n\n" nil t)
1004 (while (and (not (eobp))
1005 (looking-at "[ \t]*$"))
1006 (gnus-delete-line))))))
1008 (defun article-strip-multiple-blank-lines ()
1009 "Replace consecutive blank lines with one empty line."
1012 (let (buffer-read-only)
1013 ;; First make all blank lines empty.
1014 (goto-char (point-min))
1015 (while (re-search-forward "^[ \t]+$" nil t)
1016 (replace-match "" nil t))
1017 ;; Then replace multiple empty lines with a single empty line.
1018 (goto-char (point-min))
1019 (while (re-search-forward "\n\n\n+" nil t)
1020 (replace-match "\n\n" t t)))))
1022 (defun article-strip-blank-lines ()
1023 "Strip leading, trailing and multiple blank lines."
1025 (article-strip-leading-blank-lines)
1026 (article-remove-trailing-blank-lines)
1027 (article-strip-multiple-blank-lines))
1029 (defvar mime::preview/content-list)
1030 (defvar mime::preview-content-info/point-min)
1031 (defun gnus-article-narrow-to-signature ()
1032 "Narrow to the signature; return t if a signature is found, else nil."
1034 (when (and (boundp 'mime::preview/content-list)
1035 mime::preview/content-list)
1036 ;; We have a MIMEish article, so we use the MIME data to narrow.
1037 (let ((pcinfo (car (last mime::preview/content-list))))
1040 (funcall (intern "mime::preview-content-info/point-min") pcinfo)
1043 (when (gnus-article-search-signature)
1045 ;; Check whether we have some limits to what we consider
1046 ;; to be a signature.
1047 (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1048 (list gnus-signature-limit)))
1050 (while (setq limit (pop limits))
1051 (if (or (and (integerp limit)
1052 (< (- (point-max) (point)) limit))
1054 (< (count-lines (point) (point-max)) limit))
1055 (and (gnus-functionp limit)
1057 (and (stringp limit)
1058 (not (re-search-forward limit nil t))))
1059 () ; This limit did not succeed.
1063 (narrow-to-region (point) (point-max))
1066 (defun gnus-article-search-signature ()
1067 "Search the current buffer for the signature separator.
1068 Put point at the beginning of the signature separator."
1069 (let ((cur (point)))
1070 (goto-char (point-max))
1071 (if (if (stringp gnus-signature-separator)
1072 (re-search-backward gnus-signature-separator nil t)
1073 (let ((seps gnus-signature-separator))
1075 (not (re-search-backward (car seps) nil t)))
1082 (defun gnus-article-hidden-arg ()
1083 "Return the current prefix arg as a number, or 0 if no prefix."
1084 (list (if current-prefix-arg
1085 (prefix-numeric-value current-prefix-arg)
1088 (defun gnus-article-check-hidden-text (type arg)
1089 "Return nil if hiding is necessary.
1090 Arg can be nil or a number. Nil and positive means hide, negative
1091 means show, 0 means toggle."
1095 (let ((hide (gnus-article-hidden-text-p type)))
1101 (gnus-article-show-hidden-text type))
1103 (if (eq hide 'hidden)
1104 (gnus-article-show-hidden-text type)
1107 (defun gnus-article-hidden-text-p (type)
1108 "Say whether the current buffer contains hidden text of type TYPE."
1109 (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
1111 (if (get-text-property pos 'invisible)
1115 (defun gnus-article-show-hidden-text (type &optional hide)
1116 "Show all hidden text of type TYPE.
1117 If HIDE, hide the text instead."
1119 (let ((buffer-read-only nil)
1120 (inhibit-point-motion-hooks t)
1123 (while (setq beg (text-property-any end (point-max) 'article-type type))
1126 (text-property-not-all beg (point-max) 'article-type type)
1129 (gnus-article-hide-text beg end gnus-hidden-properties)
1130 (gnus-article-unhide-text beg end))
1134 (defconst article-time-units
1135 `((year . ,(* 365.25 24 60 60))
1136 (week . ,(* 7 24 60 60))
1137 (day . ,(* 24 60 60))
1141 "Mapping from time units to seconds.")
1143 (defun article-date-ut (&optional type highlight header)
1144 "Convert DATE date to universal time in the current article.
1145 If TYPE is `local', convert to local time; if it is `lapsed', output
1146 how much time has lapsed since DATE."
1147 (interactive (list 'ut t))
1148 (let* ((header (or header
1149 (mail-header-date gnus-current-headers)
1150 (message-fetch-field "date")
1152 (date (if (vectorp header) (mail-header-date header)
1154 (date-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
1155 (inhibit-point-motion-hooks t)
1157 (when (and date (not (string= date "")))
1160 (nnheader-narrow-to-headers)
1161 (let ((buffer-read-only nil))
1162 ;; Delete any old Date headers.
1163 (if (re-search-forward date-regexp nil t)
1165 (setq bface (get-text-property (gnus-point-at-bol) 'face)
1166 eface (get-text-property (1- (gnus-point-at-eol))
1168 (message-remove-header date-regexp t)
1169 (beginning-of-line))
1170 (goto-char (point-max)))
1171 (insert (article-make-date-line date type))
1174 (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
1175 (put-text-property (match-beginning 1) (match-end 1)
1177 (put-text-property (match-beginning 2) (match-end 2)
1180 (defun article-make-date-line (date type)
1181 "Return a DATE line of TYPE."
1183 ;; Convert to the local timezone. We have to slap a
1184 ;; `condition-case' round the calls to the timezone
1185 ;; functions since they aren't particularly resistant to
1188 (concat "Date: " (condition-case ()
1189 (timezone-make-date-arpa-standard date)
1192 ;; Convert to Universal Time.
1196 (timezone-make-date-arpa-standard date nil "UT")
1199 ;; Get the original date from the article.
1200 ((eq type 'original)
1201 (concat "Date: " date "\n"))
1202 ;; Let the user define the format.
1204 (format-time-string gnus-article-time-format
1207 (timezone-make-date-arpa-standard
1209 ;; Do an X-Sent lapsed format.
1211 ;; If the date is seriously mangled, the timezone functions are
1212 ;; liable to bug out, so we ignore all errors.
1213 (let* ((now (current-time))
1218 (timezone-make-date-arpa-standard
1219 (current-time-string now)
1220 (current-time-zone now) "UT"))
1222 (timezone-make-date-arpa-standard
1224 (real-sec (and real-time
1225 (+ (* (float (car real-time)) 65536)
1227 (sec (and real-time (abs real-sec)))
1231 "X-Sent: Unknown\n")
1237 ;; This is a bit convoluted, but basically we go
1238 ;; through the time units for years, weeks, etc,
1239 ;; and divide things to see whether that results
1240 ;; in positive answers.
1243 (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
1244 ;; The (remaining) seconds are too few to
1245 ;; be divided into this time unit.
1247 ;; It's big enough, so we output it.
1248 (setq sec (- sec (* num (cdr unit))))
1250 (concat (if prev ", " "") (int-to-string
1252 " " (symbol-name (car unit))
1253 (if (> num 1) "s" ""))
1255 article-time-units "")
1256 ;; If dates are odd, then it might appear like the
1257 ;; article was sent in the future.
1260 " in the future\n"))))))
1262 (error "Unknown conversion type: %s" type))))
1264 (defun article-date-local (&optional highlight)
1265 "Convert the current article date to the local timezone."
1266 (interactive (list t))
1267 (article-date-ut 'local highlight))
1269 (defun article-date-original (&optional highlight)
1270 "Convert the current article date to what it was originally.
1271 This is only useful if you have used some other date conversion
1272 function and want to see what the date was before converting."
1273 (interactive (list t))
1274 (article-date-ut 'original highlight))
1276 (defun article-date-lapsed (&optional highlight)
1277 "Convert the current article date to time lapsed since it was sent."
1278 (interactive (list t))
1279 (article-date-ut 'lapsed highlight))
1281 (defun article-date-user (&optional highlight)
1282 "Convert the current article date to the user-defined format."
1283 (interactive (list t))
1284 (article-date-ut 'user highlight))
1286 (defun article-show-all ()
1287 "Show all hidden text in the article buffer."
1290 (let ((buffer-read-only nil))
1291 (gnus-article-unhide-text (point-min) (point-max)))))
1293 (defun article-emphasize (&optional arg)
1294 "Emphasize text according to `gnus-emphasis-alist'."
1295 (interactive (gnus-article-hidden-arg))
1296 (unless (gnus-article-check-hidden-text 'emphasis arg)
1298 (let ((alist gnus-emphasis-alist)
1299 (buffer-read-only nil)
1300 (props (append '(article-type emphasis)
1301 gnus-hidden-properties))
1302 regexp elem beg invisible visible face)
1303 (goto-char (point-min))
1304 (search-forward "\n\n" nil t)
1306 (while (setq elem (pop alist))
1308 (setq regexp (car elem)
1309 invisible (nth 1 elem)
1310 visible (nth 2 elem)
1312 (while (re-search-forward regexp nil t)
1313 (when (and (match-beginning visible) (match-beginning invisible))
1314 (gnus-article-hide-text
1315 (match-beginning invisible) (match-end invisible) props)
1316 (gnus-article-unhide-text-type
1317 (match-beginning visible) (match-end visible) 'emphasis)
1318 (gnus-put-text-property-excluding-newlines
1319 (match-beginning visible) (match-end visible) 'face face)
1320 (goto-char (match-end invisible)))))))))
1322 (defvar gnus-summary-article-menu)
1323 (defvar gnus-summary-post-menu)
1325 ;;; Saving functions.
1327 (defun gnus-article-save (save-buffer file &optional num)
1328 "Save the currently selected article."
1329 (unless gnus-save-all-headers
1330 ;; Remove headers according to `gnus-saved-headers'.
1331 (let ((gnus-visible-headers
1332 (or gnus-saved-headers gnus-visible-headers))
1333 (gnus-article-buffer save-buffer))
1334 (gnus-article-hide-headers 1 t)))
1335 (save-window-excursion
1336 (if (not gnus-default-article-saver)
1337 (error "No default saver is defined.")
1338 ;; !!! Magic! The saving functions all save
1339 ;; `gnus-original-article-buffer' (or so they think), but we
1340 ;; bind that variable to our save-buffer.
1341 (set-buffer gnus-article-buffer)
1342 (let* ((gnus-save-article-buffer save-buffer)
1345 ((not gnus-prompt-before-saving) 'default)
1346 ((eq gnus-prompt-before-saving 'always) nil)
1348 (gnus-number-of-articles-to-be-saved
1349 (when (eq gnus-prompt-before-saving t)
1351 (set-buffer gnus-summary-buffer)
1352 (funcall gnus-default-article-saver filename)))))
1354 (defun gnus-read-save-file-name (prompt default-name &optional filename)
1356 ((eq filename 'default)
1360 (let* ((split-name (gnus-get-split-value gnus-split-methods))
1362 (format prompt (if (and gnus-number-of-articles-to-be-saved
1363 (> gnus-number-of-articles-to-be-saved 1))
1364 (format "these %d articles"
1365 gnus-number-of-articles-to-be-saved)
1368 ;; Let the split methods have their say.
1370 ;; No split name was found.
1373 (concat prompt " (default "
1374 (file-name-nondirectory default-name) ") ")
1375 (file-name-directory default-name)
1377 ;; A single split name was found
1378 ((= 1 (length split-name))
1379 (let* ((name (car split-name))
1380 (dir (cond ((file-directory-p name)
1381 (file-name-as-directory name))
1382 ((file-exists-p name) name)
1383 (t gnus-article-save-directory))))
1385 (concat prompt " (default " name ") ")
1387 ;; A list of splits was found.
1389 (setq split-name (nreverse split-name))
1391 (let ((file-name-history (nconc split-name file-name-history)))
1395 (concat prompt " (`M-p' for defaults) ")
1396 gnus-article-save-directory
1398 gnus-article-save-directory)))
1399 (car (push result file-name-history)))))))
1400 ;; Create the directory.
1401 (gnus-make-directory (file-name-directory file))
1402 ;; If we have read a directory, we append the default file name.
1403 (when (file-directory-p file)
1404 (setq file (concat (file-name-as-directory file)
1405 (file-name-nondirectory default-name))))
1406 ;; Possibly translate some characters.
1407 (nnheader-translate-file-chars file)))))
1409 (defun gnus-article-archive-name (group)
1410 "Return the first instance of an \"Archive-name\" in the current buffer."
1411 (let ((case-fold-search t))
1412 (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
1413 (nnheader-concat gnus-article-save-directory
1414 (match-string 1)))))
1416 (defun gnus-summary-save-in-rmail (&optional filename)
1417 "Append this article to Rmail file.
1418 Optional argument FILENAME specifies file name.
1419 Directory to save to is default to `gnus-article-save-directory'."
1421 (gnus-set-global-variables)
1423 (funcall gnus-rmail-save-name gnus-newsgroup-name
1424 gnus-current-headers gnus-newsgroup-last-rmail)))
1425 (setq filename (gnus-read-save-file-name
1426 "Save %s in rmail file:" default-name filename))
1427 (gnus-make-directory (file-name-directory filename))
1428 (gnus-eval-in-buffer-window gnus-save-article-buffer
1432 (gnus-output-to-rmail filename))))
1433 ;; Remember the directory name to save articles
1434 (setq gnus-newsgroup-last-rmail filename)))
1436 (defun gnus-summary-save-in-mail (&optional filename)
1437 "Append this article to Unix mail file.
1438 Optional argument FILENAME specifies file name.
1439 Directory to save to is default to `gnus-article-save-directory'."
1441 (gnus-set-global-variables)
1443 (funcall gnus-mail-save-name gnus-newsgroup-name
1444 gnus-current-headers gnus-newsgroup-last-mail)))
1445 (setq filename (gnus-read-save-file-name
1446 "Save %s in Unix mail file:" default-name filename))
1448 (expand-file-name filename
1450 (file-name-directory default-name))))
1451 (gnus-make-directory (file-name-directory filename))
1452 (gnus-eval-in-buffer-window gnus-save-article-buffer
1456 (if (and (file-readable-p filename) (mail-file-babyl-p filename))
1457 (gnus-output-to-rmail filename)
1458 (let ((mail-use-rfc822 t))
1459 (rmail-output filename 1 t t))))))
1460 ;; Remember the directory name to save articles.
1461 (setq gnus-newsgroup-last-mail filename)))
1463 (defun gnus-summary-save-in-file (&optional filename overwrite)
1464 "Append this article to file.
1465 Optional argument FILENAME specifies file name.
1466 Directory to save to is default to `gnus-article-save-directory'."
1468 (gnus-set-global-variables)
1470 (funcall gnus-file-save-name gnus-newsgroup-name
1471 gnus-current-headers gnus-newsgroup-last-file)))
1472 (setq filename (gnus-read-save-file-name
1473 "Save %s in file:" default-name filename))
1474 (gnus-make-directory (file-name-directory filename))
1475 (gnus-eval-in-buffer-window gnus-save-article-buffer
1479 (when (and overwrite
1480 (file-exists-p filename))
1481 (delete-file filename))
1482 (gnus-output-to-file filename))))
1483 ;; Remember the directory name to save articles.
1484 (setq gnus-newsgroup-last-file filename)))
1486 (defun gnus-summary-write-to-file (&optional filename)
1487 "Write this article to a file.
1488 Optional argument FILENAME specifies file name.
1489 The directory to save in defaults to `gnus-article-save-directory'."
1491 (gnus-summary-save-in-file nil t))
1493 (defun gnus-summary-save-body-in-file (&optional filename)
1494 "Append this article body to a file.
1495 Optional argument FILENAME specifies file name.
1496 The directory to save in defaults to `gnus-article-save-directory'."
1498 (gnus-set-global-variables)
1500 (funcall gnus-file-save-name gnus-newsgroup-name
1501 gnus-current-headers gnus-newsgroup-last-file)))
1502 (setq filename (gnus-read-save-file-name
1503 "Save %s body in file:" default-name filename))
1504 (gnus-make-directory (file-name-directory filename))
1505 (gnus-eval-in-buffer-window gnus-save-article-buffer
1509 (goto-char (point-min))
1510 (when (search-forward "\n\n" nil t)
1511 (narrow-to-region (point) (point-max)))
1512 (gnus-output-to-file filename))))
1513 ;; Remember the directory name to save articles.
1514 (setq gnus-newsgroup-last-file filename)))
1516 (defun gnus-summary-save-in-pipe (&optional command)
1517 "Pipe this article to subprocess."
1519 (gnus-set-global-variables)
1521 (cond ((eq command 'default)
1522 gnus-last-shell-command)
1526 "Shell command on %s: "
1527 (if (and gnus-number-of-articles-to-be-saved
1528 (> gnus-number-of-articles-to-be-saved 1))
1529 (format "these %d articles"
1530 gnus-number-of-articles-to-be-saved)
1532 gnus-last-shell-command))))
1533 (when (string-equal command "")
1534 (setq command gnus-last-shell-command))
1535 (gnus-eval-in-buffer-window gnus-article-buffer
1538 (shell-command-on-region (point-min) (point-max) command nil)))
1539 (setq gnus-last-shell-command command))
1541 ;;; Article file names when saving.
1543 (defun gnus-capitalize-newsgroup (newsgroup)
1544 "Capitalize NEWSGROUP name."
1545 (when (not (zerop (length newsgroup)))
1546 (concat (char-to-string (upcase (aref newsgroup 0)))
1547 (substring newsgroup 1))))
1549 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
1550 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1551 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
1552 Otherwise, it is like ~/News/news/group/num."
1555 (concat (if (gnus-use-long-file-name 'not-save)
1556 (gnus-capitalize-newsgroup newsgroup)
1557 (gnus-newsgroup-directory-form newsgroup))
1558 "/" (int-to-string (mail-header-number headers)))
1559 gnus-article-save-directory)))
1561 (string-equal (file-name-directory default)
1562 (file-name-directory last-file))
1563 (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1565 (or last-file default))))
1567 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
1568 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1569 If variable `gnus-use-long-file-name' is non-nil, it is
1570 ~/News/news.group/num. Otherwise, it is like ~/News/news/group/num."
1573 (concat (if (gnus-use-long-file-name 'not-save)
1575 (gnus-newsgroup-directory-form newsgroup))
1576 "/" (int-to-string (mail-header-number headers)))
1577 gnus-article-save-directory)))
1579 (string-equal (file-name-directory default)
1580 (file-name-directory last-file))
1581 (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1583 (or last-file default))))
1585 (defun gnus-Plain-save-name (newsgroup headers &optional last-file)
1586 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1587 If variable `gnus-use-long-file-name' is non-nil, it is
1588 ~/News/News.group. Otherwise, it is like ~/News/news/group/news."
1591 (if (gnus-use-long-file-name 'not-save)
1592 (gnus-capitalize-newsgroup newsgroup)
1593 (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1594 gnus-article-save-directory)))
1596 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
1597 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1598 If variable `gnus-use-long-file-name' is non-nil, it is
1599 ~/News/news.group. Otherwise, it is like ~/News/news/group/news."
1602 (if (gnus-use-long-file-name 'not-save)
1604 (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1605 gnus-article-save-directory)))
1612 (setq afunc (car func)
1615 gfunc (intern (format "gnus-%s" func))))
1617 (if (not (fboundp afunc))
1619 `(lambda (&optional interactive &rest args)
1620 ,(documentation afunc t)
1621 (interactive (list t))
1623 (set-buffer gnus-article-buffer)
1625 (call-interactively ',afunc)
1626 (apply ',afunc args))))))))
1627 '(article-hide-headers
1628 article-hide-boring-headers
1629 article-treat-overstrike
1630 (article-fill . gnus-article-word-wrap)
1632 article-display-x-face
1633 article-de-quoted-unreadable
1634 article-mime-decode-quoted-printable
1637 article-hide-signature
1638 article-remove-trailing-blank-lines
1639 article-strip-leading-blank-lines
1640 article-strip-multiple-blank-lines
1641 article-strip-blank-lines
1643 article-date-original
1648 (article-show-all . gnus-article-show-all-headers))))
1651 ;;; Gnus article mode
1654 (put 'gnus-article-mode 'mode-class 'special)
1657 (gnus-define-keys gnus-article-mode-map
1658 " " gnus-article-goto-next-page
1659 "\177" gnus-article-goto-prev-page
1660 [delete] gnus-article-goto-prev-page
1661 "\C-c^" gnus-article-refer-article
1662 "h" gnus-article-show-summary
1663 "s" gnus-article-show-summary
1664 "\C-c\C-m" gnus-article-mail
1665 "?" gnus-article-describe-briefly
1666 gnus-mouse-2 gnus-article-push-button
1667 "\r" gnus-article-press-button
1668 "\t" gnus-article-next-button
1669 "\M-\t" gnus-article-prev-button
1670 "e" gnus-article-edit
1671 "<" beginning-of-buffer
1673 "\C-c\C-i" gnus-info-find-node
1676 "\C-d" gnus-article-read-summary-keys
1677 "\M-*" gnus-article-read-summary-keys
1678 "\M-#" gnus-article-read-summary-keys
1679 "\M-g" gnus-article-read-summary-keys)
1681 (substitute-key-definition
1682 'undefined 'gnus-article-read-summary-keys gnus-article-mode-map))
1684 (defun gnus-article-make-menu-bar ()
1685 (gnus-turn-off-edit-menu 'article)
1686 (unless (boundp 'gnus-article-article-menu)
1688 gnus-article-article-menu gnus-article-mode-map ""
1690 ["Scroll forwards" gnus-article-goto-next-page t]
1691 ["Scroll backwards" gnus-article-goto-prev-page t]
1692 ["Show summary" gnus-article-show-summary t]
1693 ["Fetch Message-ID at point" gnus-article-refer-article t]
1694 ["Mail to address at point" gnus-article-mail t]))
1697 gnus-article-treatment-menu gnus-article-mode-map ""
1699 ["Hide headers" gnus-article-hide-headers t]
1700 ["Hide signature" gnus-article-hide-signature t]
1701 ["Hide citation" gnus-article-hide-citation t]
1702 ["Treat overstrike" gnus-article-treat-overstrike t]
1703 ["Remove carriage return" gnus-article-remove-cr t]
1704 ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]))
1706 (when (boundp 'gnus-summary-article-menu)
1707 (define-key gnus-article-mode-map [menu-bar commands]
1708 (cons "Commands" gnus-summary-article-menu)))
1710 (when (boundp 'gnus-summary-post-menu)
1711 (define-key gnus-article-mode-map [menu-bar post]
1712 (cons "Post" gnus-summary-post-menu)))
1714 (run-hooks 'gnus-article-menu-hook)))
1716 (defun gnus-article-mode ()
1717 "Major mode for displaying an article.
1719 All normal editing commands are switched off.
1721 The following commands are available in addition to all summary mode
1723 \\<gnus-article-mode-map>
1724 \\[gnus-article-next-page]\t Scroll the article one page forwards
1725 \\[gnus-article-prev-page]\t Scroll the article one page backwards
1726 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
1727 \\[gnus-article-show-summary]\t Display the summary buffer
1728 \\[gnus-article-mail]\t Send a reply to the address near point
1729 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
1730 \\[gnus-info-find-node]\t Go to the Gnus info node"
1732 (when (gnus-visual-p 'article-menu 'menu)
1733 (gnus-article-make-menu-bar))
1734 (kill-all-local-variables)
1735 (gnus-simplify-mode-line)
1736 (setq mode-name "Article")
1737 (setq major-mode 'gnus-article-mode)
1738 (make-local-variable 'minor-mode-alist)
1739 (unless (assq 'gnus-show-mime minor-mode-alist)
1740 (push (list 'gnus-show-mime " MIME") minor-mode-alist))
1741 (use-local-map gnus-article-mode-map)
1742 (gnus-update-format-specifications nil 'article-mode)
1743 (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
1744 (gnus-set-default-directory)
1745 (buffer-disable-undo (current-buffer))
1746 (setq buffer-read-only t)
1747 (set-syntax-table gnus-article-mode-syntax-table)
1748 (run-hooks 'gnus-article-mode-hook))
1750 (defun gnus-article-setup-buffer ()
1751 "Initialize the article buffer."
1752 (let* ((name (if gnus-single-article-buffer "*Article*"
1753 (concat "*Article " gnus-newsgroup-name "*")))
1755 (progn (string-match "\\*Article" name)
1756 (concat " *Original Article"
1757 (substring name (match-end 0))))))
1758 (setq gnus-article-buffer name)
1759 (setq gnus-original-article-buffer original)
1760 ;; This might be a variable local to the summary buffer.
1761 (unless gnus-single-article-buffer
1763 (set-buffer gnus-summary-buffer)
1764 (setq gnus-article-buffer name)
1765 (setq gnus-original-article-buffer original)
1766 (gnus-set-global-variables)))
1767 ;; Init original article buffer.
1769 (set-buffer (get-buffer-create gnus-original-article-buffer))
1770 (buffer-disable-undo (current-buffer))
1771 (setq major-mode 'gnus-original-article-mode)
1772 (gnus-add-current-to-buffer-list)
1773 (make-local-variable 'gnus-original-article))
1774 (if (get-buffer name)
1777 (buffer-disable-undo (current-buffer))
1778 (setq buffer-read-only t)
1779 (gnus-add-current-to-buffer-list)
1780 (unless (eq major-mode 'gnus-article-mode)
1781 (gnus-article-mode))
1784 (set-buffer (get-buffer-create name))
1785 (gnus-add-current-to-buffer-list)
1787 (make-local-variable 'gnus-summary-buffer)
1788 (current-buffer)))))
1790 ;; Set article window start at LINE, where LINE is the number of lines
1791 ;; from the head of the article.
1792 (defun gnus-article-set-window-start (&optional line)
1794 (get-buffer-window gnus-article-buffer t)
1796 (set-buffer gnus-article-buffer)
1797 (goto-char (point-min))
1800 (gnus-message 6 "Moved to bookmark")
1801 (search-forward "\n\n" nil t)
1805 (defun gnus-article-prepare (article &optional all-headers header)
1806 "Prepare ARTICLE in article mode buffer.
1807 ARTICLE should either be an article number or a Message-ID.
1808 If ARTICLE is an id, HEADER should be the article headers.
1809 If ALL-HEADERS is non-nil, no headers are hidden."
1811 ;; Make sure we start in a summary buffer.
1812 (unless (eq major-mode 'gnus-summary-mode)
1813 (set-buffer gnus-summary-buffer))
1814 (setq gnus-summary-buffer (current-buffer))
1815 ;; Make sure the connection to the server is alive.
1816 (unless (gnus-server-opened
1817 (gnus-find-method-for-group gnus-newsgroup-name))
1818 (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
1819 (gnus-request-group gnus-newsgroup-name t))
1820 (let* ((gnus-article (if header (mail-header-number header) article))
1821 (summary-buffer (current-buffer))
1822 (internal-hook gnus-article-internal-prepare-hook)
1823 (group gnus-newsgroup-name)
1826 (gnus-article-setup-buffer)
1827 (set-buffer gnus-article-buffer)
1828 ;; Deactivate active regions.
1829 (when (and (boundp 'transient-mark-mode)
1830 transient-mark-mode)
1831 (setq mark-active nil))
1832 (if (not (setq result (let ((buffer-read-only nil))
1833 (gnus-request-article-this-buffer
1835 ;; There is no such article.
1837 (when (and (numberp article)
1838 (not (memq article gnus-newsgroup-sparse)))
1839 (setq gnus-article-current
1840 (cons gnus-newsgroup-name article))
1841 (set-buffer gnus-summary-buffer)
1842 (setq gnus-current-article article)
1843 (gnus-summary-mark-article article gnus-canceled-mark))
1844 (unless (memq article gnus-newsgroup-sparse)
1846 1 "No such article (may have expired or been canceled)")))
1847 (if (or (eq result 'pseudo) (eq result 'nneething))
1850 (set-buffer summary-buffer)
1851 (setq gnus-last-article gnus-current-article
1852 gnus-newsgroup-history (cons gnus-current-article
1853 gnus-newsgroup-history)
1854 gnus-current-article 0
1855 gnus-current-headers nil
1856 gnus-article-current nil)
1857 (if (eq result 'nneething)
1858 (gnus-configure-windows 'summary)
1859 (gnus-configure-windows 'article))
1860 (gnus-set-global-variables))
1861 (gnus-set-mode-line 'article))
1862 ;; The result from the `request' was an actual article -
1863 ;; or at least some text that is now displayed in the
1865 (when (and (numberp article)
1866 (not (eq article gnus-current-article)))
1867 ;; Seems like a new article has been selected.
1868 ;; `gnus-current-article' must be an article number.
1870 (set-buffer summary-buffer)
1871 (setq gnus-last-article gnus-current-article
1872 gnus-newsgroup-history (cons gnus-current-article
1873 gnus-newsgroup-history)
1874 gnus-current-article article
1875 gnus-current-headers
1876 (gnus-summary-article-header gnus-current-article)
1877 gnus-article-current
1878 (cons gnus-newsgroup-name gnus-current-article))
1879 (unless (vectorp gnus-current-headers)
1880 (setq gnus-current-headers nil))
1881 (gnus-summary-show-thread)
1882 (run-hooks 'gnus-mark-article-hook)
1883 (gnus-set-mode-line 'summary)
1884 (when (gnus-visual-p 'article-highlight 'highlight)
1885 (run-hooks 'gnus-visual-mark-article-hook))
1886 ;; Set the global newsgroup variables here.
1887 ;; Suggested by Jim Sisolak
1888 ;; <sisolak@trans4.neep.wisc.edu>.
1889 (gnus-set-global-variables)
1890 (setq gnus-have-all-headers
1891 (or all-headers gnus-show-all-headers))
1893 (vectorp (gnus-summary-article-header article))
1894 (gnus-cache-possibly-enter-article
1896 (gnus-summary-article-header article)
1897 (memq article gnus-newsgroup-marked)
1898 (memq article gnus-newsgroup-dormant)
1899 (memq article gnus-newsgroup-unreads)))))
1900 (when (or (numberp article)
1902 ;; Hooks for getting information from the article.
1903 ;; This hook must be called before being narrowed.
1904 (let (buffer-read-only)
1905 (run-hooks 'internal-hook)
1906 (run-hooks 'gnus-article-prepare-hook)
1907 ;; Decode MIME message.
1908 (when gnus-show-mime
1909 (if (or (not gnus-strict-mime)
1910 (gnus-fetch-field "Mime-Version"))
1911 (funcall gnus-show-mime-method)
1912 (funcall gnus-decode-encoded-word-method)))
1913 ;; Perform the article display hooks.
1914 (run-hooks 'gnus-article-display-hook))
1916 (goto-char (point-min))
1917 (when gnus-break-pages
1918 (gnus-narrow-to-page)))
1919 (gnus-set-mode-line 'article)
1920 (gnus-configure-windows 'article)
1921 (goto-char (point-min))
1924 (defun gnus-article-wash-status ()
1925 "Return a string which display status of article washing."
1927 (set-buffer gnus-article-buffer)
1928 (let ((cite (gnus-article-hidden-text-p 'cite))
1929 (headers (gnus-article-hidden-text-p 'headers))
1930 (boring (gnus-article-hidden-text-p 'boring-headers))
1931 (pgp (gnus-article-hidden-text-p 'pgp))
1932 (pem (gnus-article-hidden-text-p 'pem))
1933 (signature (gnus-article-hidden-text-p 'signature))
1934 (overstrike (gnus-article-hidden-text-p 'overstrike))
1935 (emphasis (gnus-article-hidden-text-p 'emphasis))
1936 (mime gnus-show-mime))
1937 (format "%c%c%c%c%c%c%c"
1939 (if (or headers boring) ?h ? )
1940 (if (or pgp pem) ?p ? )
1941 (if signature ?s ? )
1942 (if overstrike ?o ? )
1944 (if emphasis ?e ? )))))
1946 (defun gnus-article-hide-headers-if-wanted ()
1947 "Hide unwanted headers if `gnus-have-all-headers' is nil.
1948 Provided for backwards compatibility."
1949 (or (save-excursion (set-buffer gnus-summary-buffer) gnus-have-all-headers)
1951 (gnus-article-hide-headers)))
1955 (defun gnus-output-to-rmail (file-name)
1956 "Append the current article to an Rmail file named FILE-NAME."
1958 ;; Most of these codes are borrowed from rmailout.el.
1959 (setq file-name (expand-file-name file-name))
1960 (setq rmail-default-rmail-file file-name)
1961 (let ((artbuf (current-buffer))
1962 (tmpbuf (get-buffer-create " *Gnus-output*")))
1964 (or (get-file-buffer file-name)
1965 (file-exists-p file-name)
1966 (if (gnus-yes-or-no-p
1967 (concat "\"" file-name "\" does not exist, create it? "))
1968 (let ((file-buffer (create-file-buffer file-name)))
1970 (set-buffer file-buffer)
1971 (rmail-insert-rmail-file-header)
1972 (let ((require-final-newline nil))
1973 (gnus-write-buffer file-name)))
1974 (kill-buffer file-buffer))
1975 (error "Output file does not exist")))
1977 (buffer-disable-undo (current-buffer))
1979 (insert-buffer-substring artbuf)
1980 (gnus-convert-article-to-rmail)
1981 ;; Decide whether to append to a file or to an Emacs buffer.
1982 (let ((outbuf (get-file-buffer file-name)))
1984 (append-to-file (point-min) (point-max) file-name)
1985 ;; File has been visited, in buffer OUTBUF.
1987 (let ((buffer-read-only nil)
1988 (msg (and (boundp 'rmail-current-message)
1989 (symbol-value 'rmail-current-message))))
1990 ;; If MSG is non-nil, buffer is in RMAIL mode.
1993 (narrow-to-region (point-max) (point-max)))
1994 (insert-buffer-substring tmpbuf)
1996 (goto-char (point-min))
1998 (search-backward "\^_")
1999 (narrow-to-region (point) (point-max))
2000 (goto-char (1+ (point-min)))
2001 (rmail-count-new-messages t)
2002 (rmail-show-message msg))))))
2003 (kill-buffer tmpbuf)))
2005 (defun gnus-output-to-file (file-name)
2006 "Append the current article to a file named FILE-NAME."
2007 (let ((artbuf (current-buffer)))
2008 (nnheader-temp-write nil
2009 (insert-buffer-substring artbuf)
2010 ;; Append newline at end of the buffer as separator, and then
2012 (goto-char (point-max))
2014 (append-to-file (point-min) (point-max) file-name))))
2016 (defun gnus-convert-article-to-rmail ()
2017 "Convert article in current buffer to Rmail message format."
2018 (let ((buffer-read-only nil))
2019 ;; Convert article directly into Babyl format.
2020 ;; Suggested by Rob Austein <sra@lcs.mit.edu>
2021 (goto-char (point-min))
2022 (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
2023 (while (search-forward "\n\^_" nil t) ;single char
2024 (replace-match "\n^_" t t)) ;2 chars: "^" and "_"
2025 (goto-char (point-max))
2028 (defun gnus-narrow-to-page (&optional arg)
2029 "Narrow the article buffer to a page.
2030 If given a numerical ARG, move forward ARG pages."
2032 (setq arg (if arg (prefix-numeric-value arg) 0))
2034 (set-buffer gnus-article-buffer)
2035 (goto-char (point-min))
2037 ;; Remove any old next/prev buttons.
2038 (when (gnus-visual-p 'page-marker)
2039 (let ((buffer-read-only nil))
2040 (gnus-remove-text-with-property 'gnus-prev)
2041 (gnus-remove-text-with-property 'gnus-next)))
2044 (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
2046 (re-search-forward page-delimiter nil 'move arg)))
2047 (goto-char (match-end 0)))
2050 (if (re-search-forward page-delimiter nil 'move)
2053 (when (and (gnus-visual-p 'page-marker)
2054 (not (= (point-min) 1)))
2056 (goto-char (point-min))
2057 (gnus-insert-prev-page-button)))
2058 (when (and (gnus-visual-p 'page-marker)
2059 (< (+ (point-max) 2) (buffer-size)))
2061 (goto-char (point-max))
2062 (gnus-insert-next-page-button)))))
2064 ;; Article mode commands
2066 (defun gnus-article-goto-next-page ()
2067 "Show the next page of the article."
2069 (when (gnus-article-next-page)
2070 (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
2072 (defun gnus-article-goto-prev-page ()
2073 "Show the next page of the article."
2075 (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
2076 (gnus-article-prev-page nil)))
2078 (defun gnus-article-next-page (&optional lines)
2079 "Show the next page of the current article.
2080 If end of article, return non-nil. Otherwise return nil.
2081 Argument LINES specifies lines to be scrolled up."
2083 (move-to-window-line -1)
2086 (and (pos-visible-in-window-p) ;Not continuation line.
2088 ;; Nothing in this page.
2089 (if (or (not gnus-break-pages)
2092 (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
2094 (gnus-narrow-to-page 1) ;Go to next page.
2096 ;; More in this page.
2097 (let ((scroll-in-place nil))
2101 ;; Long lines may cause an end-of-buffer error.
2102 (goto-char (point-max)))))
2103 (move-to-window-line 0)
2106 (defun gnus-article-prev-page (&optional lines)
2107 "Show previous page of current article.
2108 Argument LINES specifies lines to be scrolled down."
2110 (move-to-window-line 0)
2111 (if (and gnus-break-pages
2113 (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
2115 (gnus-narrow-to-page -1) ;Go to previous page.
2116 (goto-char (point-max))
2118 (let ((scroll-in-place nil))
2121 (scroll-down lines))
2122 (move-to-window-line 0)))))
2124 (defun gnus-article-refer-article ()
2125 "Read article specified by message-id around point."
2127 (let ((point (point)))
2128 (search-forward ">" nil t) ;Move point to end of "<....>".
2129 (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
2130 (let ((message-id (match-string 1)))
2132 (set-buffer gnus-summary-buffer)
2133 (gnus-summary-refer-article message-id))
2135 (error "No references around point"))))
2137 (defun gnus-article-show-summary ()
2138 "Reconfigure windows to show summary buffer."
2140 (gnus-configure-windows 'article)
2141 (gnus-summary-goto-subject gnus-current-article))
2143 (defun gnus-article-describe-briefly ()
2144 "Describe article mode commands briefly."
2147 (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page \\[gnus-article-goto-prev-page]:Prev page \\[gnus-article-show-summary]:Show summary \\[gnus-info-find-node]:Run Info \\[gnus-article-describe-briefly]:This help")))
2149 (defun gnus-article-summary-command ()
2150 "Execute the last keystroke in the summary buffer."
2152 (let ((obuf (current-buffer))
2153 (owin (current-window-configuration))
2155 (switch-to-buffer gnus-summary-buffer 'norecord)
2156 (setq func (lookup-key (current-local-map) (this-command-keys)))
2157 (call-interactively func)
2159 (set-window-configuration owin)
2160 (set-window-point (get-buffer-window (current-buffer)) (point))))
2162 (defun gnus-article-summary-command-nosave ()
2163 "Execute the last keystroke in the summary buffer."
2166 (pop-to-buffer gnus-summary-buffer 'norecord)
2167 (setq func (lookup-key (current-local-map) (this-command-keys)))
2168 (call-interactively func)))
2170 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
2171 "Read a summary buffer key sequence and execute it from the article buffer."
2174 '("q" "Q" "c" "r" "R" "\C-c\C-f" "m" "a" "f" "F"
2175 "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
2176 "=" "^" "\M-^" "|"))
2183 (set-buffer gnus-summary-buffer)
2184 (let (gnus-pick-mode)
2185 (push (or key last-command-event) unread-command-events)
2186 (setq keys (read-key-sequence nil))))
2189 (if (or (member keys nosaves)
2190 (member keys nosave-but-article)
2191 (member keys nosave-in-article))
2193 (save-window-excursion
2194 (pop-to-buffer gnus-summary-buffer 'norecord)
2195 ;; We disable the pick minor mode commands.
2196 (let (gnus-pick-mode)
2197 (setq func (lookup-key (current-local-map) keys))))
2200 (unless (member keys nosave-in-article)
2201 (set-buffer gnus-summary-buffer))
2202 (call-interactively func))
2203 (when (member keys nosave-but-article)
2204 (pop-to-buffer gnus-article-buffer 'norecord)))
2205 ;; These commands should restore window configuration.
2206 (let ((obuf (current-buffer))
2207 (owin (current-window-configuration))
2210 (if not-restore-window
2211 (pop-to-buffer gnus-summary-buffer 'norecord)
2212 (switch-to-buffer gnus-summary-buffer 'norecord))
2213 (setq in-buffer (current-buffer))
2214 ;; We disable the pick minor mode commands.
2215 (if (setq func (let (gnus-pick-mode)
2216 (lookup-key (current-local-map) keys)))
2217 (call-interactively func)
2219 (when (eq in-buffer (current-buffer))
2221 (unless not-restore-window
2222 (set-window-configuration owin))
2223 (set-window-point (get-buffer-window (current-buffer)) opoint))))))
2225 (defun gnus-article-hide (&optional arg force)
2226 "Hide all the gruft in the current article.
2227 This means that PGP stuff, signatures, cited text and (some)
2228 headers will be hidden.
2229 If given a prefix, show the hidden text instead."
2230 (interactive (list current-prefix-arg 'force))
2231 (gnus-article-hide-headers arg)
2232 (gnus-article-hide-pgp arg)
2233 (gnus-article-hide-citation-maybe arg force)
2234 (gnus-article-hide-signature arg))
2236 (defun gnus-article-maybe-highlight ()
2237 "Do some article highlighting if `article-visual' is non-nil."
2238 (when (gnus-visual-p 'article-highlight 'highlight)
2239 (gnus-article-highlight-some)))
2241 (defun gnus-request-article-this-buffer (article group)
2242 "Get an article and insert it into this buffer."
2243 (let (do-update-line)
2247 (gnus-kill-all-overlays)
2248 (setq group (or group gnus-newsgroup-name))
2250 ;; Open server if it has closed.
2251 (gnus-check-server (gnus-find-method-for-group group))
2253 ;; Using `gnus-request-article' directly will insert the article into
2254 ;; `nntp-server-buffer' - so we'll save some time by not having to
2255 ;; copy it from the server buffer into the article buffer.
2257 ;; We only request an article by message-id when we do not have the
2258 ;; headers for it, so we'll have to get those.
2259 (when (stringp article)
2260 (let ((gnus-override-method gnus-refer-article-method))
2261 (gnus-read-header article)))
2263 ;; If the article number is negative, that means that this article
2264 ;; doesn't belong in this newsgroup (possibly), so we find its
2265 ;; message-id and request it by id instead of number.
2266 (when (and (numberp article)
2268 (get-buffer gnus-summary-buffer)
2269 (buffer-name (get-buffer gnus-summary-buffer)))
2271 (set-buffer gnus-summary-buffer)
2272 (let ((header (gnus-summary-article-header article)))
2275 ((memq article gnus-newsgroup-sparse)
2276 ;; This is a sparse gap article.
2277 (setq do-update-line article)
2278 (setq article (mail-header-id header))
2279 (let ((gnus-override-method gnus-refer-article-method))
2280 (gnus-read-header article))
2281 (setq gnus-newsgroup-sparse
2282 (delq article gnus-newsgroup-sparse)))
2284 ;; It's a real article.
2285 (setq article (mail-header-id header)))
2287 ;; It is an extracted pseudo-article.
2288 (setq article 'pseudo)
2289 (gnus-request-pseudo-article header))))
2291 (let ((method (gnus-find-method-for-group
2292 gnus-newsgroup-name)))
2293 (if (not (eq (car method) 'nneething))
2295 (let ((dir (concat (file-name-as-directory (nth 1 method))
2296 (mail-header-subject header))))
2297 (when (file-directory-p dir)
2298 (setq article 'nneething)
2299 (gnus-group-enter-directory dir))))))))
2302 ;; Refuse to select canceled articles.
2303 ((and (numberp article)
2305 (get-buffer gnus-summary-buffer)
2306 (buffer-name (get-buffer gnus-summary-buffer))
2307 (eq (cdr (save-excursion
2308 (set-buffer gnus-summary-buffer)
2309 (assq article gnus-newsgroup-reads)))
2310 gnus-canceled-mark))
2312 ;; We first check `gnus-original-article-buffer'.
2313 ((and (get-buffer gnus-original-article-buffer)
2316 (set-buffer gnus-original-article-buffer)
2317 (and (equal (car gnus-original-article) group)
2318 (eq (cdr gnus-original-article) article))))
2319 (insert-buffer-substring gnus-original-article-buffer)
2321 ;; Check the backlog.
2322 ((and gnus-keep-backlog
2323 (gnus-backlog-request-article group article (current-buffer)))
2325 ;; Check asynchronous pre-fetch.
2326 ((gnus-async-request-fetched-article group article (current-buffer))
2327 (gnus-async-prefetch-next group article gnus-summary-buffer)
2330 ((and gnus-use-cache
2332 (gnus-cache-request-article article group))
2334 ;; Get the article and put into the article buffer.
2335 ((or (stringp article) (numberp article))
2336 (let ((gnus-override-method
2337 (and (stringp article) gnus-refer-article-method))
2338 (buffer-read-only nil))
2340 (gnus-kill-all-overlays)
2341 (when (gnus-request-article article group (current-buffer))
2342 (when (numberp article)
2343 (gnus-async-prefetch-next group article gnus-summary-buffer)
2344 (when gnus-keep-backlog
2345 (gnus-backlog-enter-article
2346 group article (current-buffer))))
2351 ;; Take the article from the original article buffer
2352 ;; and place it in the buffer it's supposed to be in.
2353 (when (and (get-buffer gnus-article-buffer)
2355 (equal (buffer-name (current-buffer))
2356 (buffer-name (get-buffer gnus-article-buffer))))
2358 (if (get-buffer gnus-original-article-buffer)
2359 (set-buffer (get-buffer gnus-original-article-buffer))
2360 (set-buffer (get-buffer-create gnus-original-article-buffer))
2361 (buffer-disable-undo (current-buffer))
2362 (setq major-mode 'gnus-original-article-mode)
2363 (setq buffer-read-only t)
2364 (gnus-add-current-to-buffer-list))
2365 (let (buffer-read-only)
2367 (insert-buffer-substring gnus-article-buffer))
2368 (setq gnus-original-article (cons group article))))
2370 ;; Update sparse articles.
2371 (when (and do-update-line
2372 (or (numberp article)
2374 (let ((buf (current-buffer)))
2375 (set-buffer gnus-summary-buffer)
2376 (gnus-summary-update-article do-update-line)
2377 (gnus-summary-goto-subject do-update-line nil t)
2378 (set-window-point (get-buffer-window (current-buffer) t)
2380 (set-buffer buf))))))
2386 (defcustom gnus-article-edit-mode-hook nil
2387 "Hook run in article edit mode buffers."
2388 :group 'gnus-article-various
2391 (defvar gnus-article-edit-done-function nil)
2393 (defvar gnus-article-edit-mode-map nil)
2395 (unless gnus-article-edit-mode-map
2396 (setq gnus-article-edit-mode-map (copy-keymap text-mode-map))
2398 (gnus-define-keys gnus-article-edit-mode-map
2399 "\C-c\C-c" gnus-article-edit-done
2400 "\C-c\C-k" gnus-article-edit-exit)
2402 (gnus-define-keys (gnus-article-edit-wash-map
2403 "\C-c\C-w" gnus-article-edit-mode-map)
2404 "f" gnus-article-edit-full-stops))
2406 (defun gnus-article-edit-mode ()
2407 "Major mode for editing articles.
2408 This is an extended text-mode.
2410 \\{gnus-article-edit-mode-map}"
2412 (kill-all-local-variables)
2413 (setq major-mode 'gnus-article-edit-mode)
2414 (setq mode-name "Article Edit")
2415 (use-local-map gnus-article-edit-mode-map)
2416 (make-local-variable 'gnus-article-edit-done-function)
2417 (make-local-variable 'gnus-prev-winconf)
2418 (setq buffer-read-only nil)
2419 (buffer-enable-undo)
2421 (run-hooks 'text-mode 'gnus-article-edit-mode-hook))
2423 (defun gnus-article-edit (&optional force)
2424 "Edit the current article.
2425 This will have permanent effect only in mail groups.
2426 If FORCE is non-nil, allow editing of articles even in read-only
2429 (when (and (not force)
2430 (gnus-group-read-only-p))
2431 (error "The current newsgroup does not support article editing."))
2432 (gnus-article-edit-article
2434 (gnus-summary-edit-article-done
2435 ,(or (mail-header-references gnus-current-headers) "")
2436 ,(gnus-group-read-only-p) ,gnus-summary-buffer))))
2438 (defun gnus-article-edit-article (exit-func)
2439 "Start editing the contents of the current article buffer."
2440 (let ((winconf (current-window-configuration)))
2441 (set-buffer gnus-article-buffer)
2442 (gnus-article-edit-mode)
2443 (set-text-properties (point-min) (point-max) nil)
2444 (gnus-configure-windows 'edit-article)
2445 (setq gnus-article-edit-done-function exit-func)
2446 (setq gnus-prev-winconf winconf)
2447 (gnus-message 6 "C-c C-c to end edits")))
2449 (defun gnus-article-edit-done ()
2450 "Update the article edits and exit."
2452 (let ((func gnus-article-edit-done-function)
2453 (buf (current-buffer))
2454 (start (window-start)))
2455 (gnus-article-edit-exit)
2458 (let ((buffer-read-only nil))
2461 (set-window-start (get-buffer-window buf) start)
2462 (set-window-point (get-buffer-window buf) (point))))
2464 (defun gnus-article-edit-exit ()
2465 "Exit the article editing without updating."
2467 ;; We remove all text props from the article buffer.
2468 (let ((buf (format "%s" (buffer-string)))
2469 (curbuf (current-buffer))
2471 (window-start (window-start)))
2474 (let ((winconf gnus-prev-winconf))
2476 ;; The cache and backlog have to be flushed somewhat.
2477 (when gnus-use-cache
2478 (gnus-cache-update-article
2479 (car gnus-article-current) (cdr gnus-article-current)))
2480 (when gnus-keep-backlog
2481 (gnus-backlog-remove-article
2482 (car gnus-article-current) (cdr gnus-article-current)))
2483 ;; Flush original article as well.
2485 (when (get-buffer gnus-original-article-buffer)
2486 (set-buffer gnus-original-article-buffer)
2487 (setq gnus-original-article nil)))
2488 (set-window-configuration winconf)
2489 ;; Tippy-toe some to make sure that point remains where it was.
2490 (let ((buf (current-buffer)))
2492 (set-window-start (get-buffer-window (current-buffer)) window-start)
2494 (set-buffer buf)))))
2496 (defun gnus-article-edit-full-stops ()
2497 "Interactively repair spacing at end of sentences."
2500 (goto-char (point-min))
2501 (search-forward-regexp "^$" nil t)
2502 (let ((case-fold-search nil))
2503 (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
2506 ;;; Article highlights
2509 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
2511 ;;; Internal Variables:
2513 (defcustom gnus-button-url-regexp "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?\\([-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,]\\|\\w\\)+\\([-a-zA-Z0-9_=#$@~`%&*+|\\/]\\|\\w\\)"
2514 "Regular expression that matches URLs."
2515 :group 'gnus-article-buttons
2518 (defcustom gnus-button-alist
2519 `(("\\(\\b<?\\(url: ?\\)?news:\\([^>\n\t ]*\\)>?\\)" 1 t
2520 gnus-button-message-id 3)
2521 ("\\(\\b<?\\(url: ?\\)?news:\\(//\\)?\\([^>\n\t ]*\\)>?\\)" 1 t
2522 gnus-button-fetch-group 4)
2523 ("\\bin\\( +article\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
2524 t gnus-button-message-id 3)
2525 ("\\(<URL: *\\)?mailto: *\\([^> \n\t]+\\)>?" 0 t gnus-url-mailto 2)
2526 ;; This is how URLs _should_ be embedded in text...
2527 ("<URL: *\\([^>]*\\)>" 0 t gnus-button-embedded-url 1)
2529 (,gnus-button-url-regexp 0 t gnus-button-url 0))
2530 "Alist of regexps matching buttons in article bodies.
2532 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
2533 REGEXP: is the string matching text around the button,
2534 BUTTON: is the number of the regexp grouping actually matching the button,
2535 FORM: is a lisp expression which must eval to true for the button to
2537 CALLBACK: is the function to call when the user push this button, and each
2538 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
2540 CALLBACK can also be a variable, in that case the value of that
2541 variable it the real callback function."
2542 :group 'gnus-article-buttons
2543 :type '(repeat (list regexp
2544 (integer :tag "Button")
2546 (function :tag "Callback")
2549 (integer :tag "Regexp group")))))
2551 (defcustom gnus-header-button-alist
2552 `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
2553 0 t gnus-button-message-id 0)
2554 ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
2555 ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
2556 0 t gnus-button-mailto 0)
2557 ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2558 ("^[^:]+:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2559 ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
2560 gnus-button-message-id 3))
2561 "Alist of headers and regexps to match buttons in article heads.
2563 This alist is very similar to `gnus-button-alist', except that each
2564 alist has an additional HEADER element first in each entry:
2566 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
2568 HEADER is a regexp to match a header. For a fuller explanation, see
2569 `gnus-button-alist'."
2570 :group 'gnus-article-buttons
2571 :group 'gnus-article-headers
2572 :type '(repeat (list (regexp :tag "Header")
2574 (integer :tag "Button")
2576 (function :tag "Callback")
2579 (integer :tag "Regexp group")))))
2581 (defvar gnus-button-regexp nil)
2582 (defvar gnus-button-marker-list nil)
2583 ;; Regexp matching any of the regexps from `gnus-button-alist'.
2585 (defvar gnus-button-last nil)
2586 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
2590 (defun gnus-article-push-button (event)
2591 "Check text under the mouse pointer for a callback function.
2592 If the text under the mouse pointer has a `gnus-callback' property,
2593 call it with the value of the `gnus-data' text property."
2595 (set-buffer (window-buffer (posn-window (event-start event))))
2596 (let* ((pos (posn-point (event-start event)))
2597 (data (get-text-property pos 'gnus-data))
2598 (fun (get-text-property pos 'gnus-callback)))
2600 (funcall fun data))))
2602 (defun gnus-article-press-button ()
2603 "Check text at point for a callback function.
2604 If the text at point has a `gnus-callback' property,
2605 call it with the value of the `gnus-data' text property."
2607 (let* ((data (get-text-property (point) 'gnus-data))
2608 (fun (get-text-property (point) 'gnus-callback)))
2610 (funcall fun data))))
2612 (defun gnus-article-prev-button (n)
2613 "Move point to N buttons backward.
2614 If N is negative, move forward instead."
2616 (gnus-article-next-button (- n)))
2618 (defun gnus-article-next-button (n)
2619 "Move point to N buttons forward.
2620 If N is negative, move backward instead."
2622 (let ((function (if (< n 0) 'previous-single-property-change
2623 'next-single-property-change))
2624 (inhibit-point-motion-hooks t)
2626 (limit (if (< n 0) (point-min) (point-max))))
2628 (while (and (not (= limit (point)))
2630 ;; Skip past the current button.
2631 (when (get-text-property (point) 'gnus-callback)
2632 (goto-char (funcall function (point) 'gnus-callback nil limit)))
2633 ;; Go to the next (or previous) button.
2634 (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
2635 ;; Put point at the start of the button.
2636 (when (and backward (not (get-text-property (point) 'gnus-callback)))
2637 (goto-char (funcall function (point) 'gnus-callback nil limit)))
2638 ;; Skip past intangible buttons.
2639 (when (get-text-property (point) 'intangible)
2643 (gnus-message 5 "No more buttons"))
2646 (defun gnus-article-highlight (&optional force)
2647 "Highlight current article.
2648 This function calls `gnus-article-highlight-headers',
2649 `gnus-article-highlight-citation',
2650 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2651 do the highlighting. See the documentation for those functions."
2652 (interactive (list 'force))
2653 (gnus-article-highlight-headers)
2654 (gnus-article-highlight-citation force)
2655 (gnus-article-highlight-signature)
2656 (gnus-article-add-buttons force)
2657 (gnus-article-add-buttons-to-head))
2659 (defun gnus-article-highlight-some (&optional force)
2660 "Highlight current article.
2661 This function calls `gnus-article-highlight-headers',
2662 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2663 do the highlighting. See the documentation for those functions."
2664 (interactive (list 'force))
2665 (gnus-article-highlight-headers)
2666 (gnus-article-highlight-signature)
2667 (gnus-article-add-buttons))
2669 (defun gnus-article-highlight-headers ()
2670 "Highlight article headers as specified by `gnus-header-face-alist'."
2673 (set-buffer gnus-article-buffer)
2675 (let ((alist gnus-header-face-alist)
2676 (buffer-read-only nil)
2677 (case-fold-search t)
2678 (inhibit-point-motion-hooks t)
2679 entry regexp header-face field-face from hpoints fpoints)
2680 (goto-char (point-min))
2681 (when (search-forward "\n\n" nil t)
2682 (narrow-to-region (1- (point)) (point-min))
2683 (while (setq entry (pop alist))
2684 (goto-char (point-min))
2685 (setq regexp (concat "^\\("
2686 (if (string-equal "" (nth 0 entry))
2690 header-face (nth 1 entry)
2691 field-face (nth 2 entry))
2692 (while (and (re-search-forward regexp nil t)
2696 (unless (search-forward ":" nil t)
2698 (when (and header-face
2699 (not (memq (point) hpoints)))
2700 (push (point) hpoints)
2701 (gnus-put-text-property from (point) 'face header-face))
2702 (when (and field-face
2703 (not (memq (setq from (point)) fpoints)))
2705 (if (re-search-forward "^[^ \t]" nil t)
2707 (goto-char (point-max)))
2708 (gnus-put-text-property from (point) 'face field-face)))))))))
2710 (defun gnus-article-highlight-signature ()
2711 "Highlight the signature in an article.
2712 It does this by highlighting everything after
2713 `gnus-signature-separator' using `gnus-signature-face'."
2716 (set-buffer gnus-article-buffer)
2717 (let ((buffer-read-only nil)
2718 (inhibit-point-motion-hooks t))
2720 (when (and gnus-signature-face
2721 (gnus-article-narrow-to-signature))
2722 (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
2723 'face gnus-signature-face)
2725 (gnus-article-search-signature)
2726 (let ((start (match-beginning 0))
2727 (end (set-marker (make-marker) (1+ (match-end 0)))))
2728 (gnus-article-add-button start (1- end) 'gnus-signature-toggle
2731 (defun gnus-article-add-buttons (&optional force)
2732 "Find external references in the article and make buttons of them.
2733 \"External references\" are things like Message-IDs and URLs, as
2734 specified by `gnus-button-alist'."
2735 (interactive (list 'force))
2737 (set-buffer gnus-article-buffer)
2738 ;; Remove all old markers.
2739 (while gnus-button-marker-list
2740 (set-marker (pop gnus-button-marker-list) nil))
2741 (let ((buffer-read-only nil)
2742 (inhibit-point-motion-hooks t)
2743 (case-fold-search t)
2744 (alist gnus-button-alist)
2746 (goto-char (point-min))
2747 ;; We skip the headers.
2748 (unless (search-forward "\n\n" nil t)
2749 (goto-char (point-max)))
2751 (while (setq entry (pop alist))
2752 (setq regexp (car entry))
2754 (while (re-search-forward regexp nil t)
2755 (let* ((start (and entry (match-beginning (nth 1 entry))))
2756 (end (and entry (match-end (nth 1 entry))))
2757 (from (match-beginning 0)))
2758 (when (and (or (eq t (nth 1 entry))
2759 (eval (nth 1 entry)))
2760 (not (get-text-property (point) 'gnus-callback)))
2761 ;; That optional form returned non-nil, so we add the
2763 (gnus-article-add-button
2764 start end 'gnus-button-push
2765 (car (push (set-marker (make-marker) from)
2766 gnus-button-marker-list))))))))))
2768 ;; Add buttons to the head of an article.
2769 (defun gnus-article-add-buttons-to-head ()
2770 "Add buttons to the head of the article."
2773 (set-buffer gnus-article-buffer)
2774 (let ((buffer-read-only nil)
2775 (inhibit-point-motion-hooks t)
2776 (case-fold-search t)
2777 (alist gnus-header-button-alist)
2779 (nnheader-narrow-to-headers)
2781 ;; Each alist entry.
2782 (setq entry (car alist)
2784 (goto-char (point-min))
2785 (while (re-search-forward (car entry) nil t)
2786 ;; Each header matching the entry.
2787 (setq beg (match-beginning 0))
2788 (setq end (or (and (re-search-forward "^[^ \t]" nil t)
2789 (match-beginning 0))
2792 (while (re-search-forward (nth 1 entry) end t)
2793 ;; Each match within a header.
2794 (let* ((entry (cdr entry))
2795 (start (match-beginning (nth 1 entry)))
2796 (end (match-end (nth 1 entry)))
2797 (form (nth 2 entry)))
2798 (goto-char (match-end 0))
2800 (gnus-article-add-button
2801 start end (nth 3 entry)
2802 (buffer-substring (match-beginning (nth 4 entry))
2803 (match-end (nth 4 entry)))))))
2807 ;;; External functions:
2809 (defun gnus-article-add-button (from to fun &optional data)
2810 "Create a button between FROM and TO with callback FUN and data DATA."
2811 (when gnus-article-button-face
2812 (gnus-overlay-put (gnus-make-overlay from to)
2813 'face gnus-article-button-face))
2814 (gnus-add-text-properties
2816 (nconc (and gnus-article-mouse-face
2817 (list gnus-mouse-face-prop gnus-article-mouse-face))
2818 (list 'gnus-callback fun)
2819 (and data (list 'gnus-data data)))))
2821 ;;; Internal functions:
2823 (defun gnus-signature-toggle (end)
2825 (set-buffer gnus-article-buffer)
2826 (let ((buffer-read-only nil)
2827 (inhibit-point-motion-hooks t))
2828 (if (get-text-property end 'invisible)
2829 (gnus-article-unhide-text end (point-max))
2830 (gnus-article-hide-text end (point-max) gnus-hidden-properties)))))
2832 (defun gnus-button-entry ()
2833 ;; Return the first entry in `gnus-button-alist' matching this place.
2834 (let ((alist gnus-button-alist)
2837 (setq entry (pop alist))
2838 (if (looking-at (car entry))
2843 (defun gnus-button-push (marker)
2844 ;; Push button starting at MARKER.
2846 (set-buffer gnus-article-buffer)
2848 (let* ((entry (gnus-button-entry))
2849 (inhibit-point-motion-hooks t)
2851 (args (mapcar (lambda (group)
2852 (let ((string (match-string group)))
2853 (gnus-set-text-properties
2854 0 (length string) nil string)
2861 (fboundp (symbol-value fun)))
2862 (apply (symbol-value fun) args))
2864 (gnus-message 1 "You must define `%S' to use this button"
2865 (cons fun args)))))))
2867 (defun gnus-button-message-id (message-id)
2870 (set-buffer gnus-summary-buffer)
2871 (gnus-summary-refer-article message-id)))
2873 (defun gnus-button-fetch-group (address)
2874 "Fetch GROUP specified by ADDRESS."
2875 (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\(.*\\)$" address))
2876 (error "Can't parse %s" address)
2877 (gnus-group-read-ephemeral-group
2878 (match-string 4 address)
2879 `(nntp ,(match-string 1 address) (nntp-address ,(match-string 1 address))
2880 (nntp-port-number ,(if (match-end 3)
2881 (match-string 3 address)
2884 (defun gnus-split-string (string pattern)
2885 "Return a list of substrings of STRING which are separated by PATTERN."
2886 (let (parts (start 0))
2887 (while (string-match pattern string start)
2888 (setq parts (cons (substring string start (match-beginning 0)) parts)
2889 start (match-end 0)))
2890 (nreverse (cons (substring string start) parts))))
2892 (defun gnus-url-parse-query-string (query &optional downcase)
2893 (let (retval pairs cur key val)
2894 (setq pairs (gnus-split-string query "&"))
2896 (setq cur (car pairs)
2898 (if (not (string-match "=" cur))
2900 (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
2901 val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
2903 (setq key (downcase key)))
2904 (setq cur (assoc key retval))
2906 (setcdr cur (cons val (cdr cur)))
2907 (setq retval (cons (list key val) retval)))))
2910 (defun gnus-url-unhex (x)
2917 (defun gnus-url-unhex-string (str &optional allow-newlines)
2918 "Remove %XXX embedded spaces, etc in a url.
2919 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
2920 decoding of carriage returns and line feeds in the string, which is normally
2921 forbidden in URL encoding."
2922 (setq str (or str ""))
2924 (case-fold-search t))
2925 (while (string-match "%[0-9a-f][0-9a-f]" str)
2926 (let* ((start (match-beginning 0))
2927 (ch1 (gnus-url-unhex (elt str (+ start 1))))
2929 (gnus-url-unhex (elt str (+ start 2))))))
2931 tmp (substring str 0 start)
2934 (char-to-string code))
2935 ((or (= code ?\n) (= code ?\r))
2937 (t (char-to-string code))))
2938 str (substring str (match-end 0)))))
2939 (setq tmp (concat tmp str))
2942 (defun gnus-url-mailto (url)
2943 ;; Send mail to someone
2944 (when (string-match "mailto:/*\\(.*\\)" url)
2945 (setq url (substring url (match-beginning 1) nil)))
2946 (let (to args source-url subject func)
2947 (if (string-match (regexp-quote "?") url)
2948 (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
2949 args (gnus-url-parse-query-string
2950 (substring url (match-end 0) nil) t))
2951 (setq to (gnus-url-unhex-string url)))
2952 (setq args (cons (list "to" to) args)
2953 subject (cdr-safe (assoc "subject" args)))
2956 (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
2959 (message-position-on-field (caar args)))
2960 (insert (mapconcat 'identity (cdar args) ", "))
2961 (setq args (cdr args)))
2964 (message-goto-subject))))
2966 (defun gnus-button-mailto (address)
2968 (set-buffer (gnus-copy-article-buffer))
2969 (message-reply address))
2971 (defun gnus-button-reply (address)
2972 ;; Reply to ADDRESS.
2973 (message-reply address))
2975 (defun gnus-button-url (address)
2977 (funcall browse-url-browser-function address))
2979 (defun gnus-button-embedded-url (address)
2981 (funcall browse-url-browser-function (gnus-strip-whitespace address)))
2983 ;;; Next/prev buttons in the article buffer.
2985 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
2986 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
2988 (defvar gnus-prev-page-map nil)
2989 (unless gnus-prev-page-map
2990 (setq gnus-prev-page-map (make-sparse-keymap))
2991 (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
2992 (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
2994 (defun gnus-insert-prev-page-button ()
2995 (let ((buffer-read-only nil))
2997 gnus-prev-page-line-format nil
2998 `(gnus-prev t local-map ,gnus-prev-page-map
2999 gnus-callback gnus-article-button-prev-page))))
3001 (defvar gnus-next-page-map nil)
3002 (unless gnus-next-page-map
3003 (setq gnus-next-page-map (make-keymap))
3004 (suppress-keymap gnus-prev-page-map)
3005 (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
3006 (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
3008 (defun gnus-button-next-page ()
3009 "Go to the next page."
3011 (let ((win (selected-window)))
3012 (select-window (get-buffer-window gnus-article-buffer t))
3013 (gnus-article-next-page)
3014 (select-window win)))
3016 (defun gnus-button-prev-page ()
3017 "Go to the prev page."
3019 (let ((win (selected-window)))
3020 (select-window (get-buffer-window gnus-article-buffer t))
3021 (gnus-article-prev-page)
3022 (select-window win)))
3024 (defun gnus-insert-next-page-button ()
3025 (let ((buffer-read-only nil))
3026 (gnus-eval-format gnus-next-page-line-format nil
3027 `(gnus-next t local-map ,gnus-next-page-map
3029 gnus-article-button-next-page))))
3031 (defun gnus-article-button-next-page (arg)
3032 "Go to the next page."
3034 (let ((win (selected-window)))
3035 (select-window (get-buffer-window gnus-article-buffer t))
3036 (gnus-article-next-page)
3037 (select-window win)))
3039 (defun gnus-article-button-prev-page (arg)
3040 "Go to the prev page."
3042 (let ((win (selected-window)))
3043 (select-window (get-buffer-window gnus-article-buffer t))
3044 (gnus-article-prev-page)
3045 (select-window win)))
3051 (run-hooks 'gnus-art-load-hook)
3053 ;;; gnus-art.el ends here