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 (1+ (match-beginning 0))
936 ;; Hide the actual signature.
937 (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
938 (setq end (1+ (match-beginning 0)))
939 (gnus-article-hide-text-type
941 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
943 ;; Perhaps we shouldn't hide to the end of the buffer
944 ;; if there is no end to the signature?
947 ;; Hide "- " PGP quotation markers.
949 (narrow-to-region beg end)
950 (goto-char (point-min))
951 (while (re-search-forward "^- " nil t)
952 (gnus-article-hide-text-type
953 (match-beginning 0) (match-end 0) 'pgp))
956 (defun article-hide-pem (&optional arg)
957 "Toggle hiding of any PEM headers and signatures in the current article.
958 If given a negative prefix, always show; if given a positive prefix,
960 (interactive (gnus-article-hidden-arg))
961 (unless (gnus-article-check-hidden-text 'pem arg)
963 (let (buffer-read-only end)
965 (goto-char (point-min))
966 ;; hide the horrendously ugly "header".
967 (and (search-forward "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
970 (setq end (1+ (match-beginning 0)))
971 (gnus-article-hide-text-type
973 (if (search-forward "\n\n" nil t)
977 ;; hide the trailer as well
978 (and (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
981 (gnus-article-hide-text-type
982 (match-beginning 0) (match-end 0) 'pem))))))
984 (defun article-hide-signature (&optional arg)
985 "Hide the signature in the current article.
986 If given a negative prefix, always show; if given a positive prefix,
988 (interactive (gnus-article-hidden-arg))
989 (unless (gnus-article-check-hidden-text 'signature arg)
992 (let ((buffer-read-only nil))
993 (when (gnus-article-narrow-to-signature)
994 (gnus-article-hide-text-type
995 (point-min) (point-max) 'signature)))))))
997 (defun article-strip-leading-blank-lines ()
998 "Remove all blank lines from the beginning of the article."
1001 (let ((inhibit-point-motion-hooks t)
1003 (goto-char (point-min))
1004 (when (search-forward "\n\n" nil t)
1005 (while (and (not (eobp))
1006 (looking-at "[ \t]*$"))
1007 (gnus-delete-line))))))
1009 (defun article-strip-multiple-blank-lines ()
1010 "Replace consecutive blank lines with one empty line."
1013 (let ((inhibit-point-motion-hooks t)
1015 ;; First make all blank lines empty.
1016 (goto-char (point-min))
1017 (search-forward "\n\n" nil t)
1018 (while (re-search-forward "^[ \t]+$" nil t)
1019 (replace-match "" nil t))
1020 ;; Then replace multiple empty lines with a single empty line.
1021 (goto-char (point-min))
1022 (search-forward "\n\n" nil t)
1023 (while (re-search-forward "\n\n\n+" nil t)
1024 (replace-match "\n\n" t t)))))
1026 (defun article-strip-blank-lines ()
1027 "Strip leading, trailing and multiple blank lines."
1029 (article-strip-leading-blank-lines)
1030 (article-remove-trailing-blank-lines)
1031 (article-strip-multiple-blank-lines))
1033 (defvar mime::preview/content-list)
1034 (defvar mime::preview-content-info/point-min)
1035 (defun gnus-article-narrow-to-signature ()
1036 "Narrow to the signature; return t if a signature is found, else nil."
1038 (when (and (boundp 'mime::preview/content-list)
1039 mime::preview/content-list)
1040 ;; We have a MIMEish article, so we use the MIME data to narrow.
1041 (let ((pcinfo (car (last mime::preview/content-list))))
1044 (funcall (intern "mime::preview-content-info/point-min") pcinfo)
1047 (when (gnus-article-search-signature)
1049 ;; Check whether we have some limits to what we consider
1050 ;; to be a signature.
1051 (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1052 (list gnus-signature-limit)))
1054 (while (setq limit (pop limits))
1055 (if (or (and (integerp limit)
1056 (< (- (point-max) (point)) limit))
1058 (< (count-lines (point) (point-max)) limit))
1059 (and (gnus-functionp limit)
1061 (and (stringp limit)
1062 (not (re-search-forward limit nil t))))
1063 () ; This limit did not succeed.
1067 (narrow-to-region (point) (point-max))
1070 (defun gnus-article-search-signature ()
1071 "Search the current buffer for the signature separator.
1072 Put point at the beginning of the signature separator."
1073 (let ((cur (point)))
1074 (goto-char (point-max))
1075 (if (if (stringp gnus-signature-separator)
1076 (re-search-backward gnus-signature-separator nil t)
1077 (let ((seps gnus-signature-separator))
1079 (not (re-search-backward (car seps) nil t)))
1087 (autoload 'w3-parse-buffer "w3-parse"))
1089 (defun gnus-article-treat-html ()
1092 (let ((cbuf (current-buffer)))
1093 (set-buffer gnus-article-buffer)
1094 (let (buf buffer-read-only b e)
1095 (goto-char (point-min))
1097 (if (search-forward "\n\n" nil t)
1100 (setq e (point-max)))
1101 (nnheader-temp-write nil
1102 (insert-buffer-substring gnus-article-buffer b e)
1103 (save-window-excursion
1104 (setq buf (car (w3-parse-buffer (current-buffer))))))
1106 (delete-region (point-min) (point-max))
1107 (insert-buffer-substring buf)
1110 (goto-char (point-min))
1111 (set-window-start (get-buffer-window (current-buffer)) (point-min))
1112 (set-buffer cbuf))))
1114 (defun gnus-article-hidden-arg ()
1115 "Return the current prefix arg as a number, or 0 if no prefix."
1116 (list (if current-prefix-arg
1117 (prefix-numeric-value current-prefix-arg)
1120 (defun gnus-article-check-hidden-text (type arg)
1121 "Return nil if hiding is necessary.
1122 Arg can be nil or a number. Nil and positive means hide, negative
1123 means show, 0 means toggle."
1127 (let ((hide (gnus-article-hidden-text-p type)))
1133 (gnus-article-show-hidden-text type))
1135 (if (eq hide 'hidden)
1136 (gnus-article-show-hidden-text type)
1139 (defun gnus-article-hidden-text-p (type)
1140 "Say whether the current buffer contains hidden text of type TYPE."
1141 (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
1143 (if (get-text-property pos 'invisible)
1147 (defun gnus-article-show-hidden-text (type &optional hide)
1148 "Show all hidden text of type TYPE.
1149 If HIDE, hide the text instead."
1151 (let ((buffer-read-only nil)
1152 (inhibit-point-motion-hooks t)
1155 (while (setq beg (text-property-any end (point-max) 'article-type type))
1158 (text-property-not-all beg (point-max) 'article-type type)
1161 (gnus-article-hide-text beg end gnus-hidden-properties)
1162 (gnus-article-unhide-text beg end))
1166 (defconst article-time-units
1167 `((year . ,(* 365.25 24 60 60))
1168 (week . ,(* 7 24 60 60))
1169 (day . ,(* 24 60 60))
1173 "Mapping from time units to seconds.")
1175 (defun article-date-ut (&optional type highlight header)
1176 "Convert DATE date to universal time in the current article.
1177 If TYPE is `local', convert to local time; if it is `lapsed', output
1178 how much time has lapsed since DATE."
1179 (interactive (list 'ut t))
1180 (let* ((header (or header
1181 (mail-header-date gnus-current-headers)
1182 (message-fetch-field "date")
1184 (date (if (vectorp header) (mail-header-date header)
1186 (date-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
1187 (inhibit-point-motion-hooks t)
1189 (when (and date (not (string= date "")))
1192 (nnheader-narrow-to-headers)
1193 (let ((buffer-read-only nil))
1194 ;; Delete any old Date headers.
1195 (if (re-search-forward date-regexp nil t)
1197 (setq bface (get-text-property (gnus-point-at-bol) 'face)
1198 eface (get-text-property (1- (gnus-point-at-eol))
1200 (message-remove-header date-regexp t)
1201 (beginning-of-line))
1202 (goto-char (point-max)))
1203 (insert (article-make-date-line date type))
1206 (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
1207 (put-text-property (match-beginning 1) (match-end 1)
1209 (put-text-property (match-beginning 2) (match-end 2)
1212 (defun article-make-date-line (date type)
1213 "Return a DATE line of TYPE."
1215 ;; Convert to the local timezone. We have to slap a
1216 ;; `condition-case' round the calls to the timezone
1217 ;; functions since they aren't particularly resistant to
1220 (concat "Date: " (condition-case ()
1221 (timezone-make-date-arpa-standard date)
1224 ;; Convert to Universal Time.
1228 (timezone-make-date-arpa-standard date nil "UT")
1231 ;; Get the original date from the article.
1232 ((eq type 'original)
1233 (concat "Date: " date "\n"))
1234 ;; Let the user define the format.
1238 (format-time-string gnus-article-time-format
1241 (timezone-make-date-arpa-standard
1244 ;; Do an X-Sent lapsed format.
1246 ;; If the date is seriously mangled, the timezone functions are
1247 ;; liable to bug out, so we ignore all errors.
1248 (let* ((now (current-time))
1253 (timezone-make-date-arpa-standard
1254 (current-time-string now)
1255 (current-time-zone now) "UT"))
1257 (timezone-make-date-arpa-standard
1259 (real-sec (and real-time
1260 (+ (* (float (car real-time)) 65536)
1262 (sec (and real-time (abs real-sec)))
1266 "X-Sent: Unknown\n")
1272 ;; This is a bit convoluted, but basically we go
1273 ;; through the time units for years, weeks, etc,
1274 ;; and divide things to see whether that results
1275 ;; in positive answers.
1278 (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
1279 ;; The (remaining) seconds are too few to
1280 ;; be divided into this time unit.
1282 ;; It's big enough, so we output it.
1283 (setq sec (- sec (* num (cdr unit))))
1285 (concat (if prev ", " "") (int-to-string
1287 " " (symbol-name (car unit))
1288 (if (> num 1) "s" ""))
1290 article-time-units "")
1291 ;; If dates are odd, then it might appear like the
1292 ;; article was sent in the future.
1295 " in the future\n"))))))
1297 (error "Unknown conversion type: %s" type))))
1299 (defun article-date-local (&optional highlight)
1300 "Convert the current article date to the local timezone."
1301 (interactive (list t))
1302 (article-date-ut 'local highlight))
1304 (defun article-date-original (&optional highlight)
1305 "Convert the current article date to what it was originally.
1306 This is only useful if you have used some other date conversion
1307 function and want to see what the date was before converting."
1308 (interactive (list t))
1309 (article-date-ut 'original highlight))
1311 (defun article-date-lapsed (&optional highlight)
1312 "Convert the current article date to time lapsed since it was sent."
1313 (interactive (list t))
1314 (article-date-ut 'lapsed highlight))
1316 (defun article-date-user (&optional highlight)
1317 "Convert the current article date to the user-defined format.
1318 This format is defined by the `gnus-article-time-format' variable."
1319 (interactive (list t))
1320 (article-date-ut 'user highlight))
1322 (defun article-show-all ()
1323 "Show all hidden text in the article buffer."
1326 (let ((buffer-read-only nil))
1327 (gnus-article-unhide-text (point-min) (point-max)))))
1329 (defun article-emphasize (&optional arg)
1330 "Emphasize text according to `gnus-emphasis-alist'."
1331 (interactive (gnus-article-hidden-arg))
1332 (unless (gnus-article-check-hidden-text 'emphasis arg)
1334 (let ((alist gnus-emphasis-alist)
1335 (buffer-read-only nil)
1336 (props (append '(article-type emphasis)
1337 gnus-hidden-properties))
1338 regexp elem beg invisible visible face)
1339 (goto-char (point-min))
1340 (search-forward "\n\n" nil t)
1342 (while (setq elem (pop alist))
1344 (setq regexp (car elem)
1345 invisible (nth 1 elem)
1346 visible (nth 2 elem)
1348 (while (re-search-forward regexp nil t)
1349 (when (and (match-beginning visible) (match-beginning invisible))
1350 (gnus-article-hide-text
1351 (match-beginning invisible) (match-end invisible) props)
1352 (gnus-article-unhide-text-type
1353 (match-beginning visible) (match-end visible) 'emphasis)
1354 (gnus-put-text-property-excluding-newlines
1355 (match-beginning visible) (match-end visible) 'face face)
1356 (goto-char (match-end invisible)))))))))
1358 (defvar gnus-summary-article-menu)
1359 (defvar gnus-summary-post-menu)
1361 ;;; Saving functions.
1363 (defun gnus-article-save (save-buffer file &optional num)
1364 "Save the currently selected article."
1365 (unless gnus-save-all-headers
1366 ;; Remove headers according to `gnus-saved-headers'.
1367 (let ((gnus-visible-headers
1368 (or gnus-saved-headers gnus-visible-headers))
1369 (gnus-article-buffer save-buffer))
1370 (gnus-article-hide-headers 1 t)))
1371 (save-window-excursion
1372 (if (not gnus-default-article-saver)
1373 (error "No default saver is defined.")
1374 ;; !!! Magic! The saving functions all save
1375 ;; `gnus-original-article-buffer' (or so they think), but we
1376 ;; bind that variable to our save-buffer.
1377 (set-buffer gnus-article-buffer)
1378 (let* ((gnus-save-article-buffer save-buffer)
1381 ((not gnus-prompt-before-saving) 'default)
1382 ((eq gnus-prompt-before-saving 'always) nil)
1384 (gnus-number-of-articles-to-be-saved
1385 (when (eq gnus-prompt-before-saving t)
1387 (set-buffer gnus-summary-buffer)
1388 (funcall gnus-default-article-saver filename)))))
1390 (defun gnus-read-save-file-name (prompt default-name &optional filename)
1392 ((eq filename 'default)
1396 (let* ((split-name (gnus-get-split-value gnus-split-methods))
1398 (format prompt (if (and gnus-number-of-articles-to-be-saved
1399 (> gnus-number-of-articles-to-be-saved 1))
1400 (format "these %d articles"
1401 gnus-number-of-articles-to-be-saved)
1404 ;; Let the split methods have their say.
1406 ;; No split name was found.
1409 (concat prompt " (default "
1410 (file-name-nondirectory default-name) ") ")
1411 (file-name-directory default-name)
1413 ;; A single split name was found
1414 ((= 1 (length split-name))
1415 (let* ((name (car split-name))
1416 (dir (cond ((file-directory-p name)
1417 (file-name-as-directory name))
1418 ((file-exists-p name) name)
1419 (t gnus-article-save-directory))))
1421 (concat prompt " (default " name ") ")
1423 ;; A list of splits was found.
1425 (setq split-name (nreverse split-name))
1427 (let ((file-name-history (nconc split-name file-name-history)))
1431 (concat prompt " (`M-p' for defaults) ")
1432 gnus-article-save-directory
1434 gnus-article-save-directory)))
1435 (car (push result file-name-history)))))))
1436 ;; Create the directory.
1437 (gnus-make-directory (file-name-directory file))
1438 ;; If we have read a directory, we append the default file name.
1439 (when (file-directory-p file)
1440 (setq file (concat (file-name-as-directory file)
1441 (file-name-nondirectory default-name))))
1442 ;; Possibly translate some characters.
1443 (nnheader-translate-file-chars file)))))
1445 (defun gnus-article-archive-name (group)
1446 "Return the first instance of an \"Archive-name\" in the current buffer."
1447 (let ((case-fold-search t))
1448 (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
1449 (nnheader-concat gnus-article-save-directory
1450 (match-string 1)))))
1452 (defun gnus-summary-save-in-rmail (&optional filename)
1453 "Append this article to Rmail file.
1454 Optional argument FILENAME specifies file name.
1455 Directory to save to is default to `gnus-article-save-directory'."
1457 (gnus-set-global-variables)
1459 (funcall gnus-rmail-save-name gnus-newsgroup-name
1460 gnus-current-headers gnus-newsgroup-last-rmail)))
1461 (setq filename (gnus-read-save-file-name
1462 "Save %s in rmail file:" default-name filename))
1463 (gnus-make-directory (file-name-directory filename))
1464 (gnus-eval-in-buffer-window gnus-save-article-buffer
1468 (gnus-output-to-rmail filename))))
1469 ;; Remember the directory name to save articles
1470 (setq gnus-newsgroup-last-rmail filename)))
1472 (defun gnus-summary-save-in-mail (&optional filename)
1473 "Append this article to Unix mail file.
1474 Optional argument FILENAME specifies file name.
1475 Directory to save to is default to `gnus-article-save-directory'."
1477 (gnus-set-global-variables)
1479 (funcall gnus-mail-save-name gnus-newsgroup-name
1480 gnus-current-headers gnus-newsgroup-last-mail)))
1481 (setq filename (gnus-read-save-file-name
1482 "Save %s in Unix mail file:" default-name filename))
1484 (expand-file-name filename
1486 (file-name-directory default-name))))
1487 (gnus-make-directory (file-name-directory filename))
1488 (gnus-eval-in-buffer-window gnus-save-article-buffer
1492 (if (and (file-readable-p filename)
1493 (mail-file-babyl-p filename))
1494 (gnus-output-to-rmail filename t)
1495 (gnus-output-to-mail filename)))))
1496 ;; Remember the directory name to save articles.
1497 (setq gnus-newsgroup-last-mail filename)))
1499 (defun gnus-summary-save-in-file (&optional filename overwrite)
1500 "Append this article to file.
1501 Optional argument FILENAME specifies file name.
1502 Directory to save to is default to `gnus-article-save-directory'."
1504 (gnus-set-global-variables)
1506 (funcall gnus-file-save-name gnus-newsgroup-name
1507 gnus-current-headers gnus-newsgroup-last-file)))
1508 (setq filename (gnus-read-save-file-name
1509 "Save %s in file:" default-name filename))
1510 (gnus-make-directory (file-name-directory filename))
1511 (gnus-eval-in-buffer-window gnus-save-article-buffer
1515 (when (and overwrite
1516 (file-exists-p filename))
1517 (delete-file filename))
1518 (gnus-output-to-file filename))))
1519 ;; Remember the directory name to save articles.
1520 (setq gnus-newsgroup-last-file filename)))
1522 (defun gnus-summary-write-to-file (&optional filename)
1523 "Write this article to a file.
1524 Optional argument FILENAME specifies file name.
1525 The directory to save in defaults to `gnus-article-save-directory'."
1527 (gnus-summary-save-in-file nil t))
1529 (defun gnus-summary-save-body-in-file (&optional filename)
1530 "Append this article body to a file.
1531 Optional argument FILENAME specifies file name.
1532 The directory to save in defaults to `gnus-article-save-directory'."
1534 (gnus-set-global-variables)
1536 (funcall gnus-file-save-name gnus-newsgroup-name
1537 gnus-current-headers gnus-newsgroup-last-file)))
1538 (setq filename (gnus-read-save-file-name
1539 "Save %s body in file:" default-name filename))
1540 (gnus-make-directory (file-name-directory filename))
1541 (gnus-eval-in-buffer-window gnus-save-article-buffer
1545 (goto-char (point-min))
1546 (when (search-forward "\n\n" nil t)
1547 (narrow-to-region (point) (point-max)))
1548 (gnus-output-to-file filename))))
1549 ;; Remember the directory name to save articles.
1550 (setq gnus-newsgroup-last-file filename)))
1552 (defun gnus-summary-save-in-pipe (&optional command)
1553 "Pipe this article to subprocess."
1555 (gnus-set-global-variables)
1557 (cond ((eq command 'default)
1558 gnus-last-shell-command)
1562 "Shell command on %s: "
1563 (if (and gnus-number-of-articles-to-be-saved
1564 (> gnus-number-of-articles-to-be-saved 1))
1565 (format "these %d articles"
1566 gnus-number-of-articles-to-be-saved)
1568 gnus-last-shell-command))))
1569 (when (string-equal command "")
1570 (setq command gnus-last-shell-command))
1571 (gnus-eval-in-buffer-window gnus-article-buffer
1574 (shell-command-on-region (point-min) (point-max) command nil)))
1575 (setq gnus-last-shell-command command))
1577 ;;; Article file names when saving.
1579 (defun gnus-capitalize-newsgroup (newsgroup)
1580 "Capitalize NEWSGROUP name."
1581 (when (not (zerop (length newsgroup)))
1582 (concat (char-to-string (upcase (aref newsgroup 0)))
1583 (substring newsgroup 1))))
1585 (defun gnus-Numeric-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 ~/News/News.group/num.
1588 Otherwise, it is like ~/News/news/group/num."
1591 (concat (if (gnus-use-long-file-name 'not-save)
1592 (gnus-capitalize-newsgroup newsgroup)
1593 (gnus-newsgroup-directory-form newsgroup))
1594 "/" (int-to-string (mail-header-number headers)))
1595 gnus-article-save-directory)))
1597 (string-equal (file-name-directory default)
1598 (file-name-directory last-file))
1599 (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1601 (or last-file default))))
1603 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
1604 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1605 If variable `gnus-use-long-file-name' is non-nil, it is
1606 ~/News/news.group/num. Otherwise, it is like ~/News/news/group/num."
1609 (concat (if (gnus-use-long-file-name 'not-save)
1611 (gnus-newsgroup-directory-form newsgroup))
1612 "/" (int-to-string (mail-header-number headers)))
1613 gnus-article-save-directory)))
1615 (string-equal (file-name-directory default)
1616 (file-name-directory last-file))
1617 (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1619 (or last-file default))))
1621 (defun gnus-Plain-save-name (newsgroup headers &optional last-file)
1622 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1623 If variable `gnus-use-long-file-name' is non-nil, it is
1624 ~/News/News.group. Otherwise, it is like ~/News/news/group/news."
1627 (if (gnus-use-long-file-name 'not-save)
1628 (gnus-capitalize-newsgroup newsgroup)
1629 (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1630 gnus-article-save-directory)))
1632 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
1633 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1634 If variable `gnus-use-long-file-name' is non-nil, it is
1635 ~/News/news.group. Otherwise, it is like ~/News/news/group/news."
1638 (if (gnus-use-long-file-name 'not-save)
1640 (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1641 gnus-article-save-directory)))
1648 (setq afunc (car func)
1651 gfunc (intern (format "gnus-%s" func))))
1653 (if (not (fboundp afunc))
1655 `(lambda (&optional interactive &rest args)
1656 ,(documentation afunc t)
1657 (interactive (list t))
1659 (set-buffer gnus-article-buffer)
1661 (call-interactively ',afunc)
1662 (apply ',afunc args))))))))
1663 '(article-hide-headers
1664 article-hide-boring-headers
1665 article-treat-overstrike
1666 (article-fill . gnus-article-word-wrap)
1668 article-display-x-face
1669 article-de-quoted-unreadable
1670 article-mime-decode-quoted-printable
1673 article-hide-signature
1674 article-remove-trailing-blank-lines
1675 article-strip-leading-blank-lines
1676 article-strip-multiple-blank-lines
1677 article-strip-blank-lines
1679 article-date-original
1684 (article-show-all . gnus-article-show-all-headers))))
1687 ;;; Gnus article mode
1690 (put 'gnus-article-mode 'mode-class 'special)
1693 (gnus-define-keys gnus-article-mode-map
1694 " " gnus-article-goto-next-page
1695 "\177" gnus-article-goto-prev-page
1696 [delete] gnus-article-goto-prev-page
1697 "\C-c^" gnus-article-refer-article
1698 "h" gnus-article-show-summary
1699 "s" gnus-article-show-summary
1700 "\C-c\C-m" gnus-article-mail
1701 "?" gnus-article-describe-briefly
1702 gnus-mouse-2 gnus-article-push-button
1703 "\r" gnus-article-press-button
1704 "\t" gnus-article-next-button
1705 "\M-\t" gnus-article-prev-button
1706 "e" gnus-article-edit
1707 "<" beginning-of-buffer
1709 "\C-c\C-i" gnus-info-find-node
1712 "\C-d" gnus-article-read-summary-keys
1713 "\M-*" gnus-article-read-summary-keys
1714 "\M-#" gnus-article-read-summary-keys
1715 "\M-^" gnus-article-read-summary-keys
1716 "\M-g" gnus-article-read-summary-keys)
1718 (substitute-key-definition
1719 'undefined 'gnus-article-read-summary-keys gnus-article-mode-map))
1721 (defun gnus-article-make-menu-bar ()
1722 (gnus-turn-off-edit-menu 'article)
1723 (unless (boundp 'gnus-article-article-menu)
1725 gnus-article-article-menu gnus-article-mode-map ""
1727 ["Scroll forwards" gnus-article-goto-next-page t]
1728 ["Scroll backwards" gnus-article-goto-prev-page t]
1729 ["Show summary" gnus-article-show-summary t]
1730 ["Fetch Message-ID at point" gnus-article-refer-article t]
1731 ["Mail to address at point" gnus-article-mail t]))
1734 gnus-article-treatment-menu gnus-article-mode-map ""
1736 ["Hide headers" gnus-article-hide-headers t]
1737 ["Hide signature" gnus-article-hide-signature t]
1738 ["Hide citation" gnus-article-hide-citation t]
1739 ["Treat overstrike" gnus-article-treat-overstrike t]
1740 ["Remove carriage return" gnus-article-remove-cr t]
1741 ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]))
1744 (when (boundp 'gnus-summary-article-menu)
1745 (define-key gnus-article-mode-map [menu-bar commands]
1746 (cons "Commands" gnus-summary-article-menu))))
1748 (when (boundp 'gnus-summary-post-menu)
1749 (define-key gnus-article-mode-map [menu-bar post]
1750 (cons "Post" gnus-summary-post-menu)))
1752 (run-hooks 'gnus-article-menu-hook)))
1754 (defun gnus-article-mode ()
1755 "Major mode for displaying an article.
1757 All normal editing commands are switched off.
1759 The following commands are available in addition to all summary mode
1761 \\<gnus-article-mode-map>
1762 \\[gnus-article-next-page]\t Scroll the article one page forwards
1763 \\[gnus-article-prev-page]\t Scroll the article one page backwards
1764 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
1765 \\[gnus-article-show-summary]\t Display the summary buffer
1766 \\[gnus-article-mail]\t Send a reply to the address near point
1767 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
1768 \\[gnus-info-find-node]\t Go to the Gnus info node"
1770 (when (gnus-visual-p 'article-menu 'menu)
1771 (gnus-article-make-menu-bar))
1772 (kill-all-local-variables)
1773 (gnus-simplify-mode-line)
1774 (setq mode-name "Article")
1775 (setq major-mode 'gnus-article-mode)
1776 (make-local-variable 'minor-mode-alist)
1777 (unless (assq 'gnus-show-mime minor-mode-alist)
1778 (push (list 'gnus-show-mime " MIME") minor-mode-alist))
1779 (use-local-map gnus-article-mode-map)
1780 (gnus-update-format-specifications nil 'article-mode)
1781 (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
1782 (set (make-local-variable 'gnus-button-marker-list) nil)
1783 (gnus-set-default-directory)
1784 (buffer-disable-undo (current-buffer))
1785 (setq buffer-read-only t)
1786 (set-syntax-table gnus-article-mode-syntax-table)
1787 (run-hooks 'gnus-article-mode-hook))
1789 (defun gnus-article-setup-buffer ()
1790 "Initialize the article buffer."
1791 (let* ((name (if gnus-single-article-buffer "*Article*"
1792 (concat "*Article " gnus-newsgroup-name "*")))
1794 (progn (string-match "\\*Article" name)
1795 (concat " *Original Article"
1796 (substring name (match-end 0))))))
1797 (setq gnus-article-buffer name)
1798 (setq gnus-original-article-buffer original)
1799 ;; This might be a variable local to the summary buffer.
1800 (unless gnus-single-article-buffer
1802 (set-buffer gnus-summary-buffer)
1803 (setq gnus-article-buffer name)
1804 (setq gnus-original-article-buffer original)
1805 (gnus-set-global-variables)))
1806 ;; Init original article buffer.
1808 (set-buffer (get-buffer-create gnus-original-article-buffer))
1809 (buffer-disable-undo (current-buffer))
1810 (setq major-mode 'gnus-original-article-mode)
1811 (gnus-add-current-to-buffer-list)
1812 (make-local-variable 'gnus-original-article))
1813 (if (get-buffer name)
1816 (buffer-disable-undo (current-buffer))
1817 (setq buffer-read-only t)
1818 (gnus-add-current-to-buffer-list)
1819 (unless (eq major-mode 'gnus-article-mode)
1820 (gnus-article-mode))
1823 (set-buffer (get-buffer-create name))
1824 (gnus-add-current-to-buffer-list)
1826 (make-local-variable 'gnus-summary-buffer)
1827 (current-buffer)))))
1829 ;; Set article window start at LINE, where LINE is the number of lines
1830 ;; from the head of the article.
1831 (defun gnus-article-set-window-start (&optional line)
1833 (get-buffer-window gnus-article-buffer t)
1835 (set-buffer gnus-article-buffer)
1836 (goto-char (point-min))
1839 (gnus-message 6 "Moved to bookmark")
1840 (search-forward "\n\n" nil t)
1844 (defun gnus-article-prepare (article &optional all-headers header)
1845 "Prepare ARTICLE in article mode buffer.
1846 ARTICLE should either be an article number or a Message-ID.
1847 If ARTICLE is an id, HEADER should be the article headers.
1848 If ALL-HEADERS is non-nil, no headers are hidden."
1850 ;; Make sure we start in a summary buffer.
1851 (unless (eq major-mode 'gnus-summary-mode)
1852 (set-buffer gnus-summary-buffer))
1853 (setq gnus-summary-buffer (current-buffer))
1854 ;; Make sure the connection to the server is alive.
1855 (unless (gnus-server-opened
1856 (gnus-find-method-for-group gnus-newsgroup-name))
1857 (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
1858 (gnus-request-group gnus-newsgroup-name t))
1859 (let* ((gnus-article (if header (mail-header-number header) article))
1860 (summary-buffer (current-buffer))
1861 (internal-hook gnus-article-internal-prepare-hook)
1862 (group gnus-newsgroup-name)
1865 (gnus-article-setup-buffer)
1866 (set-buffer gnus-article-buffer)
1867 ;; Deactivate active regions.
1868 (when (and (boundp 'transient-mark-mode)
1869 transient-mark-mode)
1870 (setq mark-active nil))
1871 (if (not (setq result (let ((buffer-read-only nil))
1872 (gnus-request-article-this-buffer
1874 ;; There is no such article.
1876 (when (and (numberp article)
1877 (not (memq article gnus-newsgroup-sparse)))
1878 (setq gnus-article-current
1879 (cons gnus-newsgroup-name article))
1880 (set-buffer gnus-summary-buffer)
1881 (setq gnus-current-article article)
1882 (gnus-summary-mark-article article gnus-canceled-mark))
1883 (unless (memq article gnus-newsgroup-sparse)
1885 1 "No such article (may have expired or been canceled)")))
1886 (if (or (eq result 'pseudo) (eq result 'nneething))
1889 (set-buffer summary-buffer)
1890 (setq gnus-last-article gnus-current-article
1891 gnus-newsgroup-history (cons gnus-current-article
1892 gnus-newsgroup-history)
1893 gnus-current-article 0
1894 gnus-current-headers nil
1895 gnus-article-current nil)
1896 (if (eq result 'nneething)
1897 (gnus-configure-windows 'summary)
1898 (gnus-configure-windows 'article))
1899 (gnus-set-global-variables))
1900 (gnus-set-mode-line 'article))
1901 ;; The result from the `request' was an actual article -
1902 ;; or at least some text that is now displayed in the
1904 (when (and (numberp article)
1905 (not (eq article gnus-current-article)))
1906 ;; Seems like a new article has been selected.
1907 ;; `gnus-current-article' must be an article number.
1909 (set-buffer summary-buffer)
1910 (setq gnus-last-article gnus-current-article
1911 gnus-newsgroup-history (cons gnus-current-article
1912 gnus-newsgroup-history)
1913 gnus-current-article article
1914 gnus-current-headers
1915 (gnus-summary-article-header gnus-current-article)
1916 gnus-article-current
1917 (cons gnus-newsgroup-name gnus-current-article))
1918 (unless (vectorp gnus-current-headers)
1919 (setq gnus-current-headers nil))
1920 (gnus-summary-show-thread)
1921 (run-hooks 'gnus-mark-article-hook)
1922 (gnus-set-mode-line 'summary)
1923 (when (gnus-visual-p 'article-highlight 'highlight)
1924 (run-hooks 'gnus-visual-mark-article-hook))
1925 ;; Set the global newsgroup variables here.
1926 ;; Suggested by Jim Sisolak
1927 ;; <sisolak@trans4.neep.wisc.edu>.
1928 (gnus-set-global-variables)
1929 (setq gnus-have-all-headers
1930 (or all-headers gnus-show-all-headers))
1932 (vectorp (gnus-summary-article-header article))
1933 (gnus-cache-possibly-enter-article
1935 (gnus-summary-article-header article)
1936 (memq article gnus-newsgroup-marked)
1937 (memq article gnus-newsgroup-dormant)
1938 (memq article gnus-newsgroup-unreads)))))
1939 (when (or (numberp article)
1941 ;; Hooks for getting information from the article.
1942 ;; This hook must be called before being narrowed.
1943 (let (buffer-read-only)
1944 (run-hooks 'internal-hook)
1945 (run-hooks 'gnus-article-prepare-hook)
1946 ;; Decode MIME message.
1947 (when gnus-show-mime
1948 (if (or (not gnus-strict-mime)
1949 (gnus-fetch-field "Mime-Version"))
1950 (funcall gnus-show-mime-method)
1951 (funcall gnus-decode-encoded-word-method)))
1952 ;; Perform the article display hooks.
1953 (run-hooks 'gnus-article-display-hook))
1955 (goto-char (point-min))
1956 (when gnus-break-pages
1957 (gnus-narrow-to-page)))
1958 (gnus-set-mode-line 'article)
1959 (gnus-configure-windows 'article)
1960 (goto-char (point-min))
1963 (defun gnus-article-wash-status ()
1964 "Return a string which display status of article washing."
1966 (set-buffer gnus-article-buffer)
1967 (let ((cite (gnus-article-hidden-text-p 'cite))
1968 (headers (gnus-article-hidden-text-p 'headers))
1969 (boring (gnus-article-hidden-text-p 'boring-headers))
1970 (pgp (gnus-article-hidden-text-p 'pgp))
1971 (pem (gnus-article-hidden-text-p 'pem))
1972 (signature (gnus-article-hidden-text-p 'signature))
1973 (overstrike (gnus-article-hidden-text-p 'overstrike))
1974 (emphasis (gnus-article-hidden-text-p 'emphasis))
1975 (mime gnus-show-mime))
1976 (format "%c%c%c%c%c%c%c"
1978 (if (or headers boring) ?h ? )
1979 (if (or pgp pem) ?p ? )
1980 (if signature ?s ? )
1981 (if overstrike ?o ? )
1983 (if emphasis ?e ? )))))
1985 (defun gnus-article-hide-headers-if-wanted ()
1986 "Hide unwanted headers if `gnus-have-all-headers' is nil.
1987 Provided for backwards compatibility."
1988 (or (save-excursion (set-buffer gnus-summary-buffer) gnus-have-all-headers)
1990 (gnus-article-hide-headers)))
1994 (defun gnus-output-to-file (file-name)
1995 "Append the current article to a file named FILE-NAME."
1996 (let ((artbuf (current-buffer)))
1997 (nnheader-temp-write nil
1998 (insert-buffer-substring artbuf)
1999 ;; Append newline at end of the buffer as separator, and then
2001 (goto-char (point-max))
2003 (append-to-file (point-min) (point-max) file-name))))
2005 (defun gnus-narrow-to-page (&optional arg)
2006 "Narrow the article buffer to a page.
2007 If given a numerical ARG, move forward ARG pages."
2009 (setq arg (if arg (prefix-numeric-value arg) 0))
2011 (set-buffer gnus-article-buffer)
2012 (goto-char (point-min))
2014 ;; Remove any old next/prev buttons.
2015 (when (gnus-visual-p 'page-marker)
2016 (let ((buffer-read-only nil))
2017 (gnus-remove-text-with-property 'gnus-prev)
2018 (gnus-remove-text-with-property 'gnus-next)))
2021 (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
2023 (re-search-forward page-delimiter nil 'move arg)))
2024 (goto-char (match-end 0)))
2027 (if (re-search-forward page-delimiter nil 'move)
2030 (when (and (gnus-visual-p 'page-marker)
2031 (not (= (point-min) 1)))
2033 (goto-char (point-min))
2034 (gnus-insert-prev-page-button)))
2035 (when (and (gnus-visual-p 'page-marker)
2036 (< (+ (point-max) 2) (buffer-size)))
2038 (goto-char (point-max))
2039 (gnus-insert-next-page-button)))))
2041 ;; Article mode commands
2043 (defun gnus-article-goto-next-page ()
2044 "Show the next page of the article."
2046 (when (gnus-article-next-page)
2047 (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
2049 (defun gnus-article-goto-prev-page ()
2050 "Show the next page of the article."
2052 (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
2053 (gnus-article-prev-page nil)))
2055 (defun gnus-article-next-page (&optional lines)
2056 "Show the next page of the current article.
2057 If end of article, return non-nil. Otherwise return nil.
2058 Argument LINES specifies lines to be scrolled up."
2060 (move-to-window-line -1)
2063 (and (pos-visible-in-window-p) ;Not continuation line.
2065 ;; Nothing in this page.
2066 (if (or (not gnus-break-pages)
2069 (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
2071 (gnus-narrow-to-page 1) ;Go to next page.
2073 ;; More in this page.
2074 (let ((scroll-in-place nil))
2078 ;; Long lines may cause an end-of-buffer error.
2079 (goto-char (point-max)))))
2080 (move-to-window-line 0)
2083 (defun gnus-article-prev-page (&optional lines)
2084 "Show previous page of current article.
2085 Argument LINES specifies lines to be scrolled down."
2087 (move-to-window-line 0)
2088 (if (and gnus-break-pages
2090 (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
2092 (gnus-narrow-to-page -1) ;Go to previous page.
2093 (goto-char (point-max))
2095 (let ((scroll-in-place nil))
2098 (scroll-down lines))
2099 (move-to-window-line 0)))))
2101 (defun gnus-article-refer-article ()
2102 "Read article specified by message-id around point."
2104 (let ((point (point)))
2105 (search-forward ">" nil t) ;Move point to end of "<....>".
2106 (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
2107 (let ((message-id (match-string 1)))
2109 (set-buffer gnus-summary-buffer)
2110 (gnus-summary-refer-article message-id))
2112 (error "No references around point"))))
2114 (defun gnus-article-show-summary ()
2115 "Reconfigure windows to show summary buffer."
2117 (gnus-configure-windows 'article)
2118 (gnus-summary-goto-subject gnus-current-article))
2120 (defun gnus-article-describe-briefly ()
2121 "Describe article mode commands briefly."
2124 (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")))
2126 (defun gnus-article-summary-command ()
2127 "Execute the last keystroke in the summary buffer."
2129 (let ((obuf (current-buffer))
2130 (owin (current-window-configuration))
2132 (switch-to-buffer gnus-summary-buffer 'norecord)
2133 (setq func (lookup-key (current-local-map) (this-command-keys)))
2134 (call-interactively func)
2136 (set-window-configuration owin)
2137 (set-window-point (get-buffer-window (current-buffer)) (point))))
2139 (defun gnus-article-summary-command-nosave ()
2140 "Execute the last keystroke in the summary buffer."
2143 (pop-to-buffer gnus-summary-buffer 'norecord)
2144 (setq func (lookup-key (current-local-map) (this-command-keys)))
2145 (call-interactively func)))
2147 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
2148 "Read a summary buffer key sequence and execute it from the article buffer."
2151 '("q" "Q" "c" "r" "R" "\C-c\C-f" "m" "a" "f" "F"
2152 "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
2153 "=" "^" "\M-^" "|"))
2160 (set-buffer gnus-summary-buffer)
2161 (let (gnus-pick-mode)
2162 (push (or key last-command-event) unread-command-events)
2163 (setq keys (read-key-sequence nil))))
2166 (if (or (member keys nosaves)
2167 (member keys nosave-but-article)
2168 (member keys nosave-in-article))
2170 (save-window-excursion
2171 (pop-to-buffer gnus-summary-buffer 'norecord)
2172 ;; We disable the pick minor mode commands.
2173 (let (gnus-pick-mode)
2174 (setq func (lookup-key (current-local-map) keys))))
2177 (unless (member keys nosave-in-article)
2178 (set-buffer gnus-summary-buffer))
2179 (call-interactively func))
2180 (when (member keys nosave-but-article)
2181 (pop-to-buffer gnus-article-buffer 'norecord)))
2182 ;; These commands should restore window configuration.
2183 (let ((obuf (current-buffer))
2184 (owin (current-window-configuration))
2187 (if not-restore-window
2188 (pop-to-buffer gnus-summary-buffer 'norecord)
2189 (switch-to-buffer gnus-summary-buffer 'norecord))
2190 (setq in-buffer (current-buffer))
2191 ;; We disable the pick minor mode commands.
2192 (if (setq func (let (gnus-pick-mode)
2193 (lookup-key (current-local-map) keys)))
2194 (call-interactively func)
2196 (when (eq in-buffer (current-buffer))
2198 (unless not-restore-window
2199 (set-window-configuration owin))
2200 (set-window-point (get-buffer-window (current-buffer)) opoint))))))
2202 (defun gnus-article-hide (&optional arg force)
2203 "Hide all the gruft in the current article.
2204 This means that PGP stuff, signatures, cited text and (some)
2205 headers will be hidden.
2206 If given a prefix, show the hidden text instead."
2207 (interactive (list current-prefix-arg 'force))
2208 (gnus-article-hide-headers arg)
2209 (gnus-article-hide-pgp arg)
2210 (gnus-article-hide-citation-maybe arg force)
2211 (gnus-article-hide-signature arg))
2213 (defun gnus-article-maybe-highlight ()
2214 "Do some article highlighting if `article-visual' is non-nil."
2215 (when (gnus-visual-p 'article-highlight 'highlight)
2216 (gnus-article-highlight-some)))
2218 (defun gnus-request-article-this-buffer (article group)
2219 "Get an article and insert it into this buffer."
2220 (let (do-update-line)
2224 (gnus-kill-all-overlays)
2225 (setq group (or group gnus-newsgroup-name))
2227 ;; Open server if it has closed.
2228 (gnus-check-server (gnus-find-method-for-group group))
2230 ;; Using `gnus-request-article' directly will insert the article into
2231 ;; `nntp-server-buffer' - so we'll save some time by not having to
2232 ;; copy it from the server buffer into the article buffer.
2234 ;; We only request an article by message-id when we do not have the
2235 ;; headers for it, so we'll have to get those.
2236 (when (stringp article)
2237 (let ((gnus-override-method gnus-refer-article-method))
2238 (gnus-read-header article)))
2240 ;; If the article number is negative, that means that this article
2241 ;; doesn't belong in this newsgroup (possibly), so we find its
2242 ;; message-id and request it by id instead of number.
2243 (when (and (numberp article)
2245 (get-buffer gnus-summary-buffer)
2246 (buffer-name (get-buffer gnus-summary-buffer)))
2248 (set-buffer gnus-summary-buffer)
2249 (let ((header (gnus-summary-article-header article)))
2252 ((memq article gnus-newsgroup-sparse)
2253 ;; This is a sparse gap article.
2254 (setq do-update-line article)
2255 (setq article (mail-header-id header))
2256 (let ((gnus-override-method gnus-refer-article-method))
2257 (gnus-read-header article))
2258 (setq gnus-newsgroup-sparse
2259 (delq article gnus-newsgroup-sparse)))
2261 ;; It's a real article.
2262 (setq article (mail-header-id header)))
2264 ;; It is an extracted pseudo-article.
2265 (setq article 'pseudo)
2266 (gnus-request-pseudo-article header))))
2268 (let ((method (gnus-find-method-for-group
2269 gnus-newsgroup-name)))
2270 (if (not (eq (car method) 'nneething))
2272 (let ((dir (concat (file-name-as-directory (nth 1 method))
2273 (mail-header-subject header))))
2274 (when (file-directory-p dir)
2275 (setq article 'nneething)
2276 (gnus-group-enter-directory dir))))))))
2279 ;; Refuse to select canceled articles.
2280 ((and (numberp article)
2282 (get-buffer gnus-summary-buffer)
2283 (buffer-name (get-buffer gnus-summary-buffer))
2284 (eq (cdr (save-excursion
2285 (set-buffer gnus-summary-buffer)
2286 (assq article gnus-newsgroup-reads)))
2287 gnus-canceled-mark))
2289 ;; We first check `gnus-original-article-buffer'.
2290 ((and (get-buffer gnus-original-article-buffer)
2293 (set-buffer gnus-original-article-buffer)
2294 (and (equal (car gnus-original-article) group)
2295 (eq (cdr gnus-original-article) article))))
2296 (insert-buffer-substring gnus-original-article-buffer)
2298 ;; Check the backlog.
2299 ((and gnus-keep-backlog
2300 (gnus-backlog-request-article group article (current-buffer)))
2302 ;; Check asynchronous pre-fetch.
2303 ((gnus-async-request-fetched-article group article (current-buffer))
2304 (gnus-async-prefetch-next group article gnus-summary-buffer)
2307 ((and gnus-use-cache
2309 (gnus-cache-request-article article group))
2311 ;; Get the article and put into the article buffer.
2312 ((or (stringp article) (numberp article))
2313 (let ((gnus-override-method
2314 (and (stringp article) gnus-refer-article-method))
2315 (buffer-read-only nil))
2317 (gnus-kill-all-overlays)
2318 (when (gnus-request-article article group (current-buffer))
2319 (when (numberp article)
2320 (gnus-async-prefetch-next group article gnus-summary-buffer)
2321 (when gnus-keep-backlog
2322 (gnus-backlog-enter-article
2323 group article (current-buffer))))
2328 ;; Take the article from the original article buffer
2329 ;; and place it in the buffer it's supposed to be in.
2330 (when (and (get-buffer gnus-article-buffer)
2332 (equal (buffer-name (current-buffer))
2333 (buffer-name (get-buffer gnus-article-buffer))))
2335 (if (get-buffer gnus-original-article-buffer)
2336 (set-buffer (get-buffer gnus-original-article-buffer))
2337 (set-buffer (get-buffer-create gnus-original-article-buffer))
2338 (buffer-disable-undo (current-buffer))
2339 (setq major-mode 'gnus-original-article-mode)
2340 (setq buffer-read-only t)
2341 (gnus-add-current-to-buffer-list))
2342 (let (buffer-read-only)
2344 (insert-buffer-substring gnus-article-buffer))
2345 (setq gnus-original-article (cons group article))))
2347 ;; Update sparse articles.
2348 (when (and do-update-line
2349 (or (numberp article)
2351 (let ((buf (current-buffer)))
2352 (set-buffer gnus-summary-buffer)
2353 (gnus-summary-update-article do-update-line)
2354 (gnus-summary-goto-subject do-update-line nil t)
2355 (set-window-point (get-buffer-window (current-buffer) t)
2357 (set-buffer buf))))))
2363 (defcustom gnus-article-edit-mode-hook nil
2364 "Hook run in article edit mode buffers."
2365 :group 'gnus-article-various
2368 (defvar gnus-article-edit-done-function nil)
2370 (defvar gnus-article-edit-mode-map nil)
2372 (unless gnus-article-edit-mode-map
2373 (setq gnus-article-edit-mode-map (copy-keymap text-mode-map))
2375 (gnus-define-keys gnus-article-edit-mode-map
2376 "\C-c\C-c" gnus-article-edit-done
2377 "\C-c\C-k" gnus-article-edit-exit)
2379 (gnus-define-keys (gnus-article-edit-wash-map
2380 "\C-c\C-w" gnus-article-edit-mode-map)
2381 "f" gnus-article-edit-full-stops))
2383 (defun gnus-article-edit-mode ()
2384 "Major mode for editing articles.
2385 This is an extended text-mode.
2387 \\{gnus-article-edit-mode-map}"
2389 (kill-all-local-variables)
2390 (setq major-mode 'gnus-article-edit-mode)
2391 (setq mode-name "Article Edit")
2392 (use-local-map gnus-article-edit-mode-map)
2393 (make-local-variable 'gnus-article-edit-done-function)
2394 (make-local-variable 'gnus-prev-winconf)
2395 (setq buffer-read-only nil)
2396 (buffer-enable-undo)
2398 (run-hooks 'text-mode 'gnus-article-edit-mode-hook))
2400 (defun gnus-article-edit (&optional force)
2401 "Edit the current article.
2402 This will have permanent effect only in mail groups.
2403 If FORCE is non-nil, allow editing of articles even in read-only
2406 (when (and (not force)
2407 (gnus-group-read-only-p))
2408 (error "The current newsgroup does not support article editing."))
2409 (gnus-article-edit-article
2411 (gnus-summary-edit-article-done
2412 ,(or (mail-header-references gnus-current-headers) "")
2413 ,(gnus-group-read-only-p) ,gnus-summary-buffer))))
2415 (defun gnus-article-edit-article (exit-func)
2416 "Start editing the contents of the current article buffer."
2417 (let ((winconf (current-window-configuration)))
2418 (set-buffer gnus-article-buffer)
2419 (gnus-article-edit-mode)
2420 (set-text-properties (point-min) (point-max) nil)
2421 (gnus-configure-windows 'edit-article)
2422 (setq gnus-article-edit-done-function exit-func)
2423 (setq gnus-prev-winconf winconf)
2424 (gnus-message 6 "C-c C-c to end edits")))
2426 (defun gnus-article-edit-done ()
2427 "Update the article edits and exit."
2429 (let ((func gnus-article-edit-done-function)
2430 (buf (current-buffer))
2431 (start (window-start)))
2432 (gnus-article-edit-exit)
2435 (let ((buffer-read-only nil))
2438 (set-window-start (get-buffer-window buf) start)
2439 (set-window-point (get-buffer-window buf) (point))))
2441 (defun gnus-article-edit-exit ()
2442 "Exit the article editing without updating."
2444 ;; We remove all text props from the article buffer.
2445 (let ((buf (format "%s" (buffer-string)))
2446 (curbuf (current-buffer))
2448 (window-start (window-start)))
2451 (let ((winconf gnus-prev-winconf))
2453 ;; The cache and backlog have to be flushed somewhat.
2454 (when gnus-use-cache
2455 (gnus-cache-update-article
2456 (car gnus-article-current) (cdr gnus-article-current)))
2457 (when gnus-keep-backlog
2458 (gnus-backlog-remove-article
2459 (car gnus-article-current) (cdr gnus-article-current)))
2460 ;; Flush original article as well.
2462 (when (get-buffer gnus-original-article-buffer)
2463 (set-buffer gnus-original-article-buffer)
2464 (setq gnus-original-article nil)))
2465 (set-window-configuration winconf)
2466 ;; Tippy-toe some to make sure that point remains where it was.
2467 (let ((buf (current-buffer)))
2469 (set-window-start (get-buffer-window (current-buffer)) window-start)
2471 (set-buffer buf)))))
2473 (defun gnus-article-edit-full-stops ()
2474 "Interactively repair spacing at end of sentences."
2477 (goto-char (point-min))
2478 (search-forward-regexp "^$" nil t)
2479 (let ((case-fold-search nil))
2480 (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
2483 ;;; Article highlights
2486 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
2488 ;;; Internal Variables:
2490 (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\\)"
2491 "Regular expression that matches URLs."
2492 :group 'gnus-article-buttons
2495 (defcustom gnus-button-alist
2496 `(("<\\(url: ?\\)?news:\\([^>\n\t ]*@[^>\n\t ]*\\)>" 0 t
2497 gnus-button-message-id 2)
2498 ("\\bnews:\\([^>\n\t ]*@[^>\n\t ]*+\\)" 0 t gnus-button-message-id 1)
2499 ("\\(\\b<\\(url: ?\\)?news:\\(//\\)?\\([^>\n\t ]*\\)>\\)" 1 t
2500 gnus-button-fetch-group 4)
2501 ("\\bnews:\\(//\\)?\\([^>\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
2502 ("\\bin\\( +article\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
2503 t gnus-button-message-id 3)
2504 ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 1)
2505 ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 2)
2506 ;; This is how URLs _should_ be embedded in text...
2507 ("<URL: *\\([^>]*\\)>" 0 t gnus-button-embedded-url 1)
2509 (,gnus-button-url-regexp 0 t gnus-button-url 0))
2510 "Alist of regexps matching buttons in article bodies.
2512 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
2513 REGEXP: is the string matching text around the button,
2514 BUTTON: is the number of the regexp grouping actually matching the button,
2515 FORM: is a lisp expression which must eval to true for the button to
2517 CALLBACK: is the function to call when the user push this button, and each
2518 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
2520 CALLBACK can also be a variable, in that case the value of that
2521 variable it the real callback function."
2522 :group 'gnus-article-buttons
2523 :type '(repeat (list regexp
2524 (integer :tag "Button")
2526 (function :tag "Callback")
2529 (integer :tag "Regexp group")))))
2531 (defcustom gnus-header-button-alist
2532 `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
2533 0 t gnus-button-message-id 0)
2534 ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
2535 ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
2536 0 t gnus-button-mailto 0)
2537 ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2538 ("^[^:]+:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2539 ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
2540 gnus-button-message-id 3))
2541 "Alist of headers and regexps to match buttons in article heads.
2543 This alist is very similar to `gnus-button-alist', except that each
2544 alist has an additional HEADER element first in each entry:
2546 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
2548 HEADER is a regexp to match a header. For a fuller explanation, see
2549 `gnus-button-alist'."
2550 :group 'gnus-article-buttons
2551 :group 'gnus-article-headers
2552 :type '(repeat (list (regexp :tag "Header")
2554 (integer :tag "Button")
2556 (function :tag "Callback")
2559 (integer :tag "Regexp group")))))
2561 (defvar gnus-button-regexp nil)
2562 (defvar gnus-button-marker-list nil)
2563 ;; Regexp matching any of the regexps from `gnus-button-alist'.
2565 (defvar gnus-button-last nil)
2566 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
2570 (defun gnus-article-push-button (event)
2571 "Check text under the mouse pointer for a callback function.
2572 If the text under the mouse pointer has a `gnus-callback' property,
2573 call it with the value of the `gnus-data' text property."
2575 (set-buffer (window-buffer (posn-window (event-start event))))
2576 (let* ((pos (posn-point (event-start event)))
2577 (data (get-text-property pos 'gnus-data))
2578 (fun (get-text-property pos 'gnus-callback)))
2580 (funcall fun data))))
2582 (defun gnus-article-press-button ()
2583 "Check text at point for a callback function.
2584 If the text at point has a `gnus-callback' property,
2585 call it with the value of the `gnus-data' text property."
2587 (let* ((data (get-text-property (point) 'gnus-data))
2588 (fun (get-text-property (point) 'gnus-callback)))
2590 (funcall fun data))))
2592 (defun gnus-article-prev-button (n)
2593 "Move point to N buttons backward.
2594 If N is negative, move forward instead."
2596 (gnus-article-next-button (- n)))
2598 (defun gnus-article-next-button (n)
2599 "Move point to N buttons forward.
2600 If N is negative, move backward instead."
2602 (let ((function (if (< n 0) 'previous-single-property-change
2603 'next-single-property-change))
2604 (inhibit-point-motion-hooks t)
2606 (limit (if (< n 0) (point-min) (point-max))))
2608 (while (and (not (= limit (point)))
2610 ;; Skip past the current button.
2611 (when (get-text-property (point) 'gnus-callback)
2612 (goto-char (funcall function (point) 'gnus-callback nil limit)))
2613 ;; Go to the next (or previous) button.
2614 (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
2615 ;; Put point at the start of the button.
2616 (when (and backward (not (get-text-property (point) 'gnus-callback)))
2617 (goto-char (funcall function (point) 'gnus-callback nil limit)))
2618 ;; Skip past intangible buttons.
2619 (when (get-text-property (point) 'intangible)
2623 (gnus-message 5 "No more buttons"))
2626 (defun gnus-article-highlight (&optional force)
2627 "Highlight current article.
2628 This function calls `gnus-article-highlight-headers',
2629 `gnus-article-highlight-citation',
2630 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2631 do the highlighting. See the documentation for those functions."
2632 (interactive (list 'force))
2633 (gnus-article-highlight-headers)
2634 (gnus-article-highlight-citation force)
2635 (gnus-article-highlight-signature)
2636 (gnus-article-add-buttons force)
2637 (gnus-article-add-buttons-to-head))
2639 (defun gnus-article-highlight-some (&optional force)
2640 "Highlight current article.
2641 This function calls `gnus-article-highlight-headers',
2642 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2643 do the highlighting. See the documentation for those functions."
2644 (interactive (list 'force))
2645 (gnus-article-highlight-headers)
2646 (gnus-article-highlight-signature)
2647 (gnus-article-add-buttons))
2649 (defun gnus-article-highlight-headers ()
2650 "Highlight article headers as specified by `gnus-header-face-alist'."
2653 (set-buffer gnus-article-buffer)
2655 (let ((alist gnus-header-face-alist)
2656 (buffer-read-only nil)
2657 (case-fold-search t)
2658 (inhibit-point-motion-hooks t)
2659 entry regexp header-face field-face from hpoints fpoints)
2660 (goto-char (point-min))
2661 (when (search-forward "\n\n" nil t)
2662 (narrow-to-region (1- (point)) (point-min))
2663 (while (setq entry (pop alist))
2664 (goto-char (point-min))
2665 (setq regexp (concat "^\\("
2666 (if (string-equal "" (nth 0 entry))
2670 header-face (nth 1 entry)
2671 field-face (nth 2 entry))
2672 (while (and (re-search-forward regexp nil t)
2676 (unless (search-forward ":" nil t)
2678 (when (and header-face
2679 (not (memq (point) hpoints)))
2680 (push (point) hpoints)
2681 (gnus-put-text-property from (point) 'face header-face))
2682 (when (and field-face
2683 (not (memq (setq from (point)) fpoints)))
2685 (if (re-search-forward "^[^ \t]" nil t)
2687 (goto-char (point-max)))
2688 (gnus-put-text-property from (point) 'face field-face)))))))))
2690 (defun gnus-article-highlight-signature ()
2691 "Highlight the signature in an article.
2692 It does this by highlighting everything after
2693 `gnus-signature-separator' using `gnus-signature-face'."
2696 (set-buffer gnus-article-buffer)
2697 (let ((buffer-read-only nil)
2698 (inhibit-point-motion-hooks t))
2700 (when (and gnus-signature-face
2701 (gnus-article-narrow-to-signature))
2702 (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
2703 'face gnus-signature-face)
2705 (gnus-article-search-signature)
2706 (let ((start (match-beginning 0))
2707 (end (set-marker (make-marker) (1+ (match-end 0)))))
2708 (gnus-article-add-button start (1- end) 'gnus-signature-toggle
2711 (defun gnus-button-in-region-p (b e prop)
2712 "Say whether PROP exists in the region."
2713 (text-property-not-all b e prop nil))
2715 (defun gnus-article-add-buttons (&optional force)
2716 "Find external references in the article and make buttons of them.
2717 \"External references\" are things like Message-IDs and URLs, as
2718 specified by `gnus-button-alist'."
2719 (interactive (list 'force))
2721 (set-buffer gnus-article-buffer)
2722 ;; Remove all old markers.
2724 (while (setq marker (pop gnus-button-marker-list))
2726 (when (setq entry (gnus-button-entry))
2727 (put-text-property (match-beginning (nth 1 entry))
2728 (match-end (nth 1 entry))
2729 'gnus-callback nil))
2730 (set-marker marker nil)))
2731 (let ((buffer-read-only nil)
2732 (inhibit-point-motion-hooks t)
2733 (case-fold-search t)
2734 (alist gnus-button-alist)
2736 (goto-char (point-min))
2737 ;; We skip the headers.
2738 (unless (search-forward "\n\n" nil t)
2739 (goto-char (point-max)))
2741 (while (setq entry (pop alist))
2742 (setq regexp (car entry))
2744 (while (re-search-forward regexp nil t)
2745 (let* ((start (and entry (match-beginning (nth 1 entry))))
2746 (end (and entry (match-end (nth 1 entry))))
2747 (from (match-beginning 0)))
2748 (when (and (or (eq t (nth 1 entry))
2749 (eval (nth 1 entry)))
2750 (not (gnus-button-in-region-p
2751 start end 'gnus-callback)))
2752 ;; That optional form returned non-nil, so we add the
2754 (gnus-article-add-button
2755 start end 'gnus-button-push
2756 (car (push (set-marker (make-marker) from)
2757 gnus-button-marker-list))))))))))
2759 ;; Add buttons to the head of an article.
2760 (defun gnus-article-add-buttons-to-head ()
2761 "Add buttons to the head of the article."
2764 (set-buffer gnus-article-buffer)
2765 (let ((buffer-read-only nil)
2766 (inhibit-point-motion-hooks t)
2767 (case-fold-search t)
2768 (alist gnus-header-button-alist)
2770 (nnheader-narrow-to-headers)
2772 ;; Each alist entry.
2773 (setq entry (car alist)
2775 (goto-char (point-min))
2776 (while (re-search-forward (car entry) nil t)
2777 ;; Each header matching the entry.
2778 (setq beg (match-beginning 0))
2779 (setq end (or (and (re-search-forward "^[^ \t]" nil t)
2780 (match-beginning 0))
2783 (while (re-search-forward (nth 1 entry) end t)
2784 ;; Each match within a header.
2785 (let* ((entry (cdr entry))
2786 (start (match-beginning (nth 1 entry)))
2787 (end (match-end (nth 1 entry)))
2788 (form (nth 2 entry)))
2789 (goto-char (match-end 0))
2791 (gnus-article-add-button
2792 start end (nth 3 entry)
2793 (buffer-substring (match-beginning (nth 4 entry))
2794 (match-end (nth 4 entry)))))))
2798 ;;; External functions:
2800 (defun gnus-article-add-button (from to fun &optional data)
2801 "Create a button between FROM and TO with callback FUN and data DATA."
2802 (when gnus-article-button-face
2803 (gnus-overlay-put (gnus-make-overlay from to)
2804 'face gnus-article-button-face))
2805 (gnus-add-text-properties
2807 (nconc (and gnus-article-mouse-face
2808 (list gnus-mouse-face-prop gnus-article-mouse-face))
2809 (list 'gnus-callback fun)
2810 (and data (list 'gnus-data data)))))
2812 ;;; Internal functions:
2814 (defun gnus-signature-toggle (end)
2816 (set-buffer gnus-article-buffer)
2817 (let ((buffer-read-only nil)
2818 (inhibit-point-motion-hooks t))
2819 (if (get-text-property end 'invisible)
2820 (gnus-article-unhide-text end (point-max))
2821 (gnus-article-hide-text end (point-max) gnus-hidden-properties)))))
2823 (defun gnus-button-entry ()
2824 ;; Return the first entry in `gnus-button-alist' matching this place.
2825 (let ((alist gnus-button-alist)
2828 (setq entry (pop alist))
2829 (if (looking-at (car entry))
2834 (defun gnus-button-push (marker)
2835 ;; Push button starting at MARKER.
2837 (set-buffer gnus-article-buffer)
2839 (let* ((entry (gnus-button-entry))
2840 (inhibit-point-motion-hooks t)
2842 (args (mapcar (lambda (group)
2843 (let ((string (match-string group)))
2844 (gnus-set-text-properties
2845 0 (length string) nil string)
2852 (fboundp (symbol-value fun)))
2853 (apply (symbol-value fun) args))
2855 (gnus-message 1 "You must define `%S' to use this button"
2856 (cons fun args)))))))
2858 (defun gnus-button-message-id (message-id)
2861 (set-buffer gnus-summary-buffer)
2862 (gnus-summary-refer-article message-id)))
2864 (defun gnus-button-fetch-group (address)
2865 "Fetch GROUP specified by ADDRESS."
2866 (if (not (string-match "[:/]" address))
2867 ;; This is just a simple group url.
2868 (gnus-group-read-ephemeral-group address gnus-select-method)
2869 (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)/\\)?\\(.*\\)$"
2871 (error "Can't parse %s" address)
2872 (gnus-group-read-ephemeral-group
2873 (match-string 4 address)
2874 `(nntp ,(match-string 1 address)
2875 (nntp-address ,(match-string 1 address))
2876 (nntp-port-number ,(if (match-end 3)
2877 (match-string 3 address)
2880 (defun gnus-split-string (string pattern)
2881 "Return a list of substrings of STRING which are separated by PATTERN."
2882 (let (parts (start 0))
2883 (while (string-match pattern string start)
2884 (setq parts (cons (substring string start (match-beginning 0)) parts)
2885 start (match-end 0)))
2886 (nreverse (cons (substring string start) parts))))
2888 (defun gnus-url-parse-query-string (query &optional downcase)
2889 (let (retval pairs cur key val)
2890 (setq pairs (gnus-split-string query "&"))
2892 (setq cur (car pairs)
2894 (if (not (string-match "=" cur))
2896 (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
2897 val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
2899 (setq key (downcase key)))
2900 (setq cur (assoc key retval))
2902 (setcdr cur (cons val (cdr cur)))
2903 (setq retval (cons (list key val) retval)))))
2906 (defun gnus-url-unhex (x)
2913 (defun gnus-url-unhex-string (str &optional allow-newlines)
2914 "Remove %XXX embedded spaces, etc in a url.
2915 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
2916 decoding of carriage returns and line feeds in the string, which is normally
2917 forbidden in URL encoding."
2918 (setq str (or str ""))
2920 (case-fold-search t))
2921 (while (string-match "%[0-9a-f][0-9a-f]" str)
2922 (let* ((start (match-beginning 0))
2923 (ch1 (gnus-url-unhex (elt str (+ start 1))))
2925 (gnus-url-unhex (elt str (+ start 2))))))
2927 tmp (substring str 0 start)
2930 (char-to-string code))
2931 ((or (= code ?\n) (= code ?\r))
2933 (t (char-to-string code))))
2934 str (substring str (match-end 0)))))
2935 (setq tmp (concat tmp str))
2938 (defun gnus-url-mailto (url)
2939 ;; Send mail to someone
2940 (when (string-match "mailto:/*\\(.*\\)" url)
2941 (setq url (substring url (match-beginning 1) nil)))
2942 (let (to args source-url subject func)
2943 (if (string-match (regexp-quote "?") url)
2944 (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
2945 args (gnus-url-parse-query-string
2946 (substring url (match-end 0) nil) t))
2947 (setq to (gnus-url-unhex-string url)))
2948 (setq args (cons (list "to" to) args)
2949 subject (cdr-safe (assoc "subject" args)))
2952 (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
2955 (message-position-on-field (caar args)))
2956 (insert (mapconcat 'identity (cdar args) ", "))
2957 (setq args (cdr args)))
2960 (message-goto-subject))))
2962 (defun gnus-button-mailto (address)
2964 (set-buffer (gnus-copy-article-buffer))
2965 (message-reply address))
2967 (defun gnus-button-reply (address)
2968 ;; Reply to ADDRESS.
2969 (message-reply address))
2971 (defun gnus-button-url (address)
2973 (funcall browse-url-browser-function address))
2975 (defun gnus-button-embedded-url (address)
2977 (funcall browse-url-browser-function (gnus-strip-whitespace address)))
2979 ;;; Next/prev buttons in the article buffer.
2981 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
2982 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
2984 (defvar gnus-prev-page-map nil)
2985 (unless gnus-prev-page-map
2986 (setq gnus-prev-page-map (make-sparse-keymap))
2987 (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
2988 (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
2990 (defun gnus-insert-prev-page-button ()
2991 (let ((buffer-read-only nil))
2993 gnus-prev-page-line-format nil
2994 `(gnus-prev t local-map ,gnus-prev-page-map
2995 gnus-callback gnus-article-button-prev-page))))
2997 (defvar gnus-next-page-map nil)
2998 (unless gnus-next-page-map
2999 (setq gnus-next-page-map (make-keymap))
3000 (suppress-keymap gnus-prev-page-map)
3001 (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
3002 (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
3004 (defun gnus-button-next-page ()
3005 "Go to the next page."
3007 (let ((win (selected-window)))
3008 (select-window (get-buffer-window gnus-article-buffer t))
3009 (gnus-article-next-page)
3010 (select-window win)))
3012 (defun gnus-button-prev-page ()
3013 "Go to the prev page."
3015 (let ((win (selected-window)))
3016 (select-window (get-buffer-window gnus-article-buffer t))
3017 (gnus-article-prev-page)
3018 (select-window win)))
3020 (defun gnus-insert-next-page-button ()
3021 (let ((buffer-read-only nil))
3022 (gnus-eval-format gnus-next-page-line-format nil
3023 `(gnus-next t local-map ,gnus-next-page-map
3025 gnus-article-button-next-page))))
3027 (defun gnus-article-button-next-page (arg)
3028 "Go to the next page."
3030 (let ((win (selected-window)))
3031 (select-window (get-buffer-window gnus-article-buffer t))
3032 (gnus-article-next-page)
3033 (select-window win)))
3035 (defun gnus-article-button-prev-page (arg)
3036 "Go to the prev page."
3038 (let ((win (selected-window)))
3039 (select-window (get-buffer-window gnus-article-buffer t))
3040 (gnus-article-prev-page)
3041 (select-window win)))
3047 (run-hooks 'gnus-art-load-hook)
3049 ;;; gnus-art.el ends here