Merge gnus-6_7.
[elisp/gnus.git-] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Semi-gnus
2 ;; Copyright (C) 1996,97,98 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;;         MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Keywords: mail, news, MIME
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'custom)
32 (require 'gnus)
33 (require 'gnus-sum)
34 (require 'gnus-spec)
35 (require 'gnus-int)
36 (require 'browse-url)
37 (require 'alist)
38 (require 'mime-view)
39
40 (defgroup gnus-article nil
41   "Article display."
42   :link '(custom-manual "(gnus)The Article Buffer")
43   :group 'gnus)
44
45 (defgroup gnus-article-hiding nil
46   "Hiding article parts."
47   :link '(custom-manual "(gnus)Article Hiding")
48   :group 'gnus-article)
49
50 (defgroup gnus-article-highlight nil
51   "Article highlighting."
52   :link '(custom-manual "(gnus)Article Highlighting")
53   :group 'gnus-article
54   :group 'gnus-visual)
55
56 (defgroup gnus-article-signature nil
57   "Article signatures."
58   :link '(custom-manual "(gnus)Article Signature")
59   :group 'gnus-article)
60
61 (defgroup gnus-article-headers nil
62   "Article headers."
63   :link '(custom-manual "(gnus)Hiding Headers")
64   :group 'gnus-article)
65
66 (defgroup gnus-article-washing nil
67   "Special commands on articles."
68   :link '(custom-manual "(gnus)Article Washing")
69   :group 'gnus-article)
70
71 (defgroup gnus-article-emphasis nil
72   "Fontisizing articles."
73   :link '(custom-manual "(gnus)Article Fontisizing")
74   :group 'gnus-article)
75
76 (defgroup gnus-article-saving nil
77   "Saving articles."
78   :link '(custom-manual "(gnus)Saving Articles")
79   :group 'gnus-article)
80
81 (defgroup gnus-article-mime nil
82   "Worshiping the MIME wonder."
83   :link '(custom-manual "(gnus)Using MIME")
84   :group 'gnus-article)
85
86 (defgroup gnus-article-buttons nil
87   "Pushable buttons in the article buffer."
88   :link '(custom-manual "(gnus)Article Buttons")
89   :group 'gnus-article)
90
91 (defgroup gnus-article-various nil
92   "Other article options."
93   :link '(custom-manual "(gnus)Misc Article")
94   :group 'gnus-article)
95
96 (defcustom gnus-ignored-headers
97   '("^Path:" "^Posting-Version:" "^Article-I.D.:" "^Expires:"
98     "^Date-Received:" "^References:" "^Control:" "^Xref:" "^Lines:"
99     "^Posted:" "^Relay-Version:" "^Message-ID:" "^Nf-ID:" "^Nf-From:"
100     "^Approved:" "^Sender:" "^Received:" "^Mail-from:")
101   "*All headers that start with this regexp will be hidden.
102 This variable can also be a list of regexps of headers to be ignored.
103 If `gnus-visible-headers' is non-nil, this variable will be ignored."
104   :type '(choice :custom-show nil
105                  regexp
106                  (repeat regexp))
107   :group 'gnus-article-hiding)
108
109 (defcustom gnus-visible-headers
110   "From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|X-Sent:"
111   "*All headers that do not match this regexp will be hidden.
112 This variable can also be a list of regexp of headers to remain visible.
113 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
114   :type '(repeat :value-to-internal (lambda (widget value)
115                                       (custom-split-regexp-maybe value))
116                  :match (lambda (widget value)
117                           (or (stringp value)
118                               (widget-editable-list-match widget value)))
119                  regexp)
120   :group 'gnus-article-hiding)
121
122 (defcustom gnus-sorted-header-list
123   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
124     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
125   "*This variable is a list of regular expressions.
126 If it is non-nil, headers that match the regular expressions will
127 be placed first in the article buffer in the sequence specified by
128 this list."
129   :type '(repeat regexp)
130   :group 'gnus-article-hiding)
131
132 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
133   "Headers that are only to be displayed if they have interesting data.
134 Possible values in this list are `empty', `newsgroups', `followup-to',
135 `reply-to', `date', `long-to', and `many-to'."
136   :type '(set (const :tag "Headers with no content." empty)
137               (const :tag "Newsgroups with only one group." newsgroups)
138               (const :tag "Followup-to identical to newsgroups." followup-to)
139               (const :tag "Reply-to identical to from." reply-to)
140               (const :tag "Date less than four days old." date)
141               (const :tag "Very long To header." long-to)
142               (const :tag "Multiple To headers." many-to))
143   :group 'gnus-article-hiding)
144
145 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
146   "Regexp matching signature separator.
147 This can also be a list of regexps.  In that case, it will be checked
148 from head to tail looking for a separator.  Searches will be done from
149 the end of the buffer."
150   :type '(repeat string)
151   :group 'gnus-article-signature)
152
153 (defcustom gnus-signature-limit nil
154    "Provide a limit to what is considered a signature.
155 If it is a number, no signature may not be longer (in characters) than
156 that number.  If it is a floating point number, no signature may be
157 longer (in lines) than that number.  If it is a function, the function
158 will be called without any parameters, and if it returns nil, there is
159 no signature in the buffer.  If it is a string, it will be used as a
160 regexp.  If it matches, the text in question is not a signature."
161   :type '(choice (integer :value 200)
162                  (number :value 4.0)
163                  (function :value fun)
164                  (regexp :value ".*"))
165   :group 'gnus-article-signature)
166
167 (defcustom gnus-hidden-properties '(invisible t intangible t)
168   "Property list to use for hiding text."
169   :type 'sexp
170   :group 'gnus-article-hiding)
171
172 (defcustom gnus-article-x-face-command
173   "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
174   "*String or function to be executed to display an X-Face header.
175 If it is a string, the command will be executed in a sub-shell
176 asynchronously.  The compressed face will be piped to this command."
177   :type 'string                         ;Leave function case to Lisp.
178   :group 'gnus-article-washing)
179
180 (defcustom gnus-article-x-face-too-ugly nil
181   "Regexp matching posters whose face shouldn't be shown automatically."
182   :type '(choice regexp (const nil))
183   :group 'gnus-article-washing)
184
185 (defcustom gnus-emphasis-alist
186   (let ((format
187          "\\(\\s-\\|^\\|[-\"]\\|\\s(\\|\\s)\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-?!.,;:\"]\\|\\s(\\|\\s)\\)")
188         (types
189          '(("_" "_" underline)
190            ("/" "/" italic)
191            ("\\*" "\\*" bold)
192            ("_/" "/_" underline-italic)
193            ("_\\*" "\\*_" underline-bold)
194            ("\\*/" "/\\*" bold-italic)
195            ("_\\*/" "/\\*_" underline-bold-italic))))
196     `(("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
197        2 3 gnus-emphasis-underline)
198       ,@(mapcar
199          (lambda (spec)
200            (list
201             (format format (car spec) (cadr spec))
202             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
203          types)))
204   "*Alist that says how to fontify certain phrases.
205 Each item looks like this:
206
207   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
208
209 The first element is a regular expression to be matched.  The second
210 is a number that says what regular expression grouping used to find
211 the entire emphasized word.  The third is a number that says what
212 regexp grouping should be displayed and highlighted.  The fourth
213 is the face used for highlighting."
214   :type '(repeat (list :value ("" 0 0 default)
215                        regexp
216                        (integer :tag "Match group")
217                        (integer :tag "Emphasize group")
218                        face))
219   :group 'gnus-article-emphasis)
220
221 (defface gnus-emphasis-bold '((t (:bold t)))
222   "Face used for displaying strong emphasized text (*word*)."
223   :group 'gnus-article-emphasis)
224
225 (defface gnus-emphasis-italic '((t (:italic t)))
226   "Face used for displaying italic emphasized text (/word/)."
227   :group 'gnus-article-emphasis)
228
229 (defface gnus-emphasis-underline '((t (:underline t)))
230   "Face used for displaying underlined emphasized text (_word_)."
231   :group 'gnus-article-emphasis)
232
233 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
234   "Face used for displaying underlined bold emphasized text (_*word*_)."
235   :group 'gnus-article-emphasis)
236
237 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
238   "Face used for displaying underlined italic emphasized text (_*word*_)."
239   :group 'gnus-article-emphasis)
240
241 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
242   "Face used for displaying bold italic emphasized text (/*word*/)."
243   :group 'gnus-article-emphasis)
244
245 (defface gnus-emphasis-underline-bold-italic
246   '((t (:bold t :italic t :underline t)))
247   "Face used for displaying underlined bold italic emphasized text.
248 Esample: (_/*word*/_)."
249   :group 'gnus-article-emphasis)
250
251 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
252   "Format for display of Date headers in article bodies.
253 See `format-time-string' for the possible values.
254
255 The variable can also be function, which should return a complete Date
256 header.  The function is called with one argument, the time, which can
257 be fed to `format-time-string'."
258   :type '(choice string symbol)
259   :link '(custom-manual "(gnus)Article Date")
260   :group 'gnus-article-washing)
261
262 (eval-and-compile
263   (autoload 'hexl-hex-string-to-integer "hexl")
264   (autoload 'timezone-make-date-arpa-standard "timezone")
265   (autoload 'mail-extract-address-components "mail-extr"))
266
267 (defcustom gnus-save-all-headers t
268   "*If non-nil, don't remove any headers before saving."
269   :group 'gnus-article-saving
270   :type 'boolean)
271
272 (defcustom gnus-prompt-before-saving 'always
273   "*This variable says how much prompting is to be done when saving articles.
274 If it is nil, no prompting will be done, and the articles will be
275 saved to the default files.  If this variable is `always', each and
276 every article that is saved will be preceded by a prompt, even when
277 saving large batches of articles.  If this variable is neither nil not
278 `always', there the user will be prompted once for a file name for
279 each invocation of the saving commands."
280   :group 'gnus-article-saving
281   :type '(choice (item always)
282                  (item :tag "never" nil)
283                  (sexp :tag "once" :format "%t\n" :value t)))
284
285 (defcustom gnus-saved-headers gnus-visible-headers
286   "Headers to keep if `gnus-save-all-headers' is nil.
287 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
288 If that variable is nil, however, all headers that match this regexp
289 will be kept while the rest will be deleted before saving."
290   :group 'gnus-article-saving
291   :type 'regexp)
292
293 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
294   "A function to save articles in your favourite format.
295 The function must be interactively callable (in other words, it must
296 be an Emacs command).
297
298 Gnus provides the following functions:
299
300 * gnus-summary-save-in-rmail (Rmail format)
301 * gnus-summary-save-in-mail (Unix mail format)
302 * gnus-summary-save-in-folder (MH folder)
303 * gnus-summary-save-in-file (article format)
304 * gnus-summary-save-in-vm (use VM's folder format)
305 * gnus-summary-write-to-file (article format -- overwrite)."
306   :group 'gnus-article-saving
307   :type '(radio (function-item gnus-summary-save-in-rmail)
308                 (function-item gnus-summary-save-in-mail)
309                 (function-item gnus-summary-save-in-folder)
310                 (function-item gnus-summary-save-in-file)
311                 (function-item gnus-summary-save-in-vm)
312                 (function-item gnus-summary-write-to-file)))
313
314 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
315   "A function generating a file name to save articles in Rmail format.
316 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
317   :group 'gnus-article-saving
318   :type 'function)
319
320 (defcustom gnus-mail-save-name 'gnus-plain-save-name
321   "A function generating a file name to save articles in Unix mail format.
322 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
323   :group 'gnus-article-saving
324   :type 'function)
325
326 (defcustom gnus-folder-save-name 'gnus-folder-save-name
327   "A function generating a file name to save articles in MH folder.
328 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
329   :group 'gnus-article-saving
330   :type 'function)
331
332 (defcustom gnus-file-save-name 'gnus-numeric-save-name
333   "A function generating a file name to save articles in article format.
334 The function is called with NEWSGROUP, HEADERS, and optional
335 LAST-FILE."
336   :group 'gnus-article-saving
337   :type 'function)
338
339 (defcustom gnus-split-methods
340   '((gnus-article-archive-name)
341     (gnus-article-nndoc-name))
342   "*Variable used to suggest where articles are to be saved.
343 For instance, if you would like to save articles related to Gnus in
344 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
345 you could set this variable to something like:
346
347  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
348    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
349
350 This variable is an alist where the where the key is the match and the
351 value is a list of possible files to save in if the match is non-nil.
352
353 If the match is a string, it is used as a regexp match on the
354 article.  If the match is a symbol, that symbol will be funcalled
355 from the buffer of the article to be saved with the newsgroup as the
356 parameter.  If it is a list, it will be evaled in the same buffer.
357
358 If this form or function returns a string, this string will be used as
359 a possible file name; and if it returns a non-nil list, that list will
360 be used as possible file names."
361   :group 'gnus-article-saving
362   :type '(repeat (choice (list :value (fun) function)
363                          (cons :value ("" "") regexp (repeat string))
364                          (sexp :value nil))))
365
366 (defcustom gnus-strict-mime t
367   "*If nil, MIME-decode even if there is no Mime-Version header."
368   :group 'gnus-article-mime
369   :type 'boolean)
370
371 (defcustom gnus-article-display-method-for-mime
372   'gnus-article-display-mime-message
373   "Function to display a MIME message.
374 The function is called from the article buffer."
375   :group 'gnus-article-mime
376   :type 'function)
377
378 (defcustom gnus-article-display-method-for-encoded-word
379   'gnus-article-display-message-with-encoded-word
380   "*Function to display a message with MIME encoded-words.
381 The function is called from the article buffer."
382   :group 'gnus-article-mime
383   :type 'function)
384
385 (defcustom gnus-article-display-method-for-traditional
386   'gnus-article-display-traditional-message
387   "*Function to display a traditional message.
388 The function is called from the article buffer."
389   :group 'gnus-article-mime
390   :type 'function)
391
392 (defcustom gnus-page-delimiter "^\^L"
393   "*Regexp describing what to use as article page delimiters.
394 The default value is \"^\^L\", which is a form linefeed at the
395 beginning of a line."
396   :type 'regexp
397   :group 'gnus-article-various)
398
399 (defcustom gnus-article-mode-line-format "Gnus: %%b %S"
400   "*The format specification for the article mode line.
401 See `gnus-summary-mode-line-format' for a closer description."
402   :type 'string
403   :group 'gnus-article-various)
404
405 (defcustom gnus-article-mode-hook nil
406   "*A hook for Gnus article mode."
407   :type 'hook
408   :group 'gnus-article-various)
409
410 (defcustom gnus-article-menu-hook nil
411   "*Hook run after the creation of the article mode menu."
412   :type 'hook
413   :group 'gnus-article-various)
414
415 (defcustom gnus-article-prepare-hook nil
416   "*A hook called after an article has been prepared in the article buffer.
417 If you want to run a special decoding program like nkf, use this hook."
418   :type 'hook
419   :group 'gnus-article-various)
420
421 (defcustom gnus-article-hide-pgp-hook nil
422   "*A hook called after successfully hiding a PGP signature."
423   :type 'hook
424   :group 'gnus-article-various)
425
426 (defcustom gnus-article-button-face 'bold
427   "Face used for highlighting buttons in the article buffer.
428
429 An article button is a piece of text that you can activate by pressing
430 `RET' or `mouse-2' above it."
431   :type 'face
432   :group 'gnus-article-buttons)
433
434 (defcustom gnus-article-mouse-face 'highlight
435   "Face used for mouse highlighting in the article buffer.
436
437 Article buttons will be displayed in this face when the cursor is
438 above them."
439   :type 'face
440   :group 'gnus-article-buttons)
441
442 (defcustom gnus-signature-face 'gnus-signature-face
443   "Face used for highlighting a signature in the article buffer.
444 Obsolete; use the face `gnus-signature-face' for customizations instead."
445   :type 'face
446   :group 'gnus-article-highlight
447   :group 'gnus-article-signature)
448
449 (defface gnus-signature-face
450   '((((type x))
451      (:italic t)))
452   "Face used for highlighting a signature in the article buffer."
453   :group 'gnus-article-highlight
454   :group 'gnus-article-signature)
455
456 (defface gnus-header-from-face
457   '((((class color)
458       (background dark))
459      (:foreground "spring green" :bold t))
460     (((class color)
461       (background light))
462      (:foreground "red3" :bold t))
463     (t
464      (:bold t :italic t)))
465   "Face used for displaying from headers."
466   :group 'gnus-article-headers
467   :group 'gnus-article-highlight)
468
469 (defface gnus-header-subject-face
470   '((((class color)
471       (background dark))
472      (:foreground "SeaGreen3" :bold t))
473     (((class color)
474       (background light))
475      (:foreground "red4" :bold t))
476     (t
477      (:bold t :italic t)))
478   "Face used for displaying subject headers."
479   :group 'gnus-article-headers
480   :group 'gnus-article-highlight)
481
482 (defface gnus-header-newsgroups-face
483   '((((class color)
484       (background dark))
485      (:foreground "yellow" :bold t :italic t))
486     (((class color)
487       (background light))
488      (:foreground "MidnightBlue" :bold t :italic t))
489     (t
490      (:bold t :italic t)))
491   "Face used for displaying newsgroups headers."
492   :group 'gnus-article-headers
493   :group 'gnus-article-highlight)
494
495 (defface gnus-header-name-face
496   '((((class color)
497       (background dark))
498      (:foreground "SeaGreen"))
499     (((class color)
500       (background light))
501      (:foreground "maroon"))
502     (t
503      (:bold t)))
504   "Face used for displaying header names."
505   :group 'gnus-article-headers
506   :group 'gnus-article-highlight)
507
508 (defface gnus-header-content-face
509   '((((class color)
510       (background dark))
511      (:foreground "forest green" :italic t))
512     (((class color)
513       (background light))
514      (:foreground "indianred4" :italic t))
515     (t
516      (:italic t)))  "Face used for displaying header content."
517   :group 'gnus-article-headers
518   :group 'gnus-article-highlight)
519
520 (defcustom gnus-header-face-alist
521   '(("From" nil gnus-header-from-face)
522     ("Subject" nil gnus-header-subject-face)
523     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
524     ("" gnus-header-name-face gnus-header-content-face))
525   "*Controls highlighting of article header.
526
527 An alist of the form (HEADER NAME CONTENT).
528
529 HEADER is a regular expression which should match the name of an
530 header header and NAME and CONTENT are either face names or nil.
531
532 The name of each header field will be displayed using the face
533 specified by the first element in the list where HEADER match the
534 header name and NAME is non-nil.  Similarly, the content will be
535 displayed by the first non-nil matching CONTENT face."
536   :group 'gnus-article-headers
537   :group 'gnus-article-highlight
538   :type '(repeat (list (regexp :tag "Header")
539                        (choice :tag "Name"
540                                (item :tag "skip" nil)
541                                (face :value default))
542                        (choice :tag "Content"
543                                (item :tag "skip" nil)
544                                (face :value default)))))
545
546 ;;; Internal variables
547
548 (defvar article-lapsed-timer nil)
549 (defvar gnus-article-current-summary nil)
550
551 (defvar gnus-article-mode-syntax-table
552   (let ((table (copy-syntax-table text-mode-syntax-table)))
553     (modify-syntax-entry ?- "w" table)
554     (modify-syntax-entry ?> ")" table)
555     (modify-syntax-entry ?< "(" table)
556     table)
557   "Syntax table used in article mode buffers.
558 Initialized from `text-mode-syntax-table.")
559
560 (defvar gnus-save-article-buffer nil)
561
562 (defvar gnus-article-mode-line-format-alist
563   (nconc '((?w (gnus-article-wash-status) ?s))
564          gnus-summary-mode-line-format-alist))
565
566 (defvar gnus-number-of-articles-to-be-saved nil)
567
568 (defvar gnus-inhibit-hiding nil)
569
570 (defsubst gnus-article-hide-text (b e props)
571   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
572   (add-text-properties b e props)
573   (when (memq 'intangible props)
574     (put-text-property
575      (max (1- b) (point-min))
576      b 'intangible (cddr (memq 'intangible props)))))
577
578 (defsubst gnus-article-unhide-text (b e)
579   "Remove hidden text properties from region between B and E."
580   (remove-text-properties b e gnus-hidden-properties)
581   (when (memq 'intangible gnus-hidden-properties)
582     (put-text-property (max (1- b) (point-min))
583                        b 'intangible nil)))
584
585 (defun gnus-article-hide-text-type (b e type)
586   "Hide text of TYPE between B and E."
587   (gnus-article-hide-text
588    b e (cons 'article-type (cons type gnus-hidden-properties))))
589
590 (defun gnus-article-unhide-text-type (b e type)
591   "Hide text of TYPE between B and E."
592   (remove-text-properties
593    b e (cons 'article-type (cons type gnus-hidden-properties)))
594   (when (memq 'intangible gnus-hidden-properties)
595     (put-text-property (max (1- b) (point-min))
596                        b 'intangible nil)))
597
598 (defun gnus-article-hide-text-of-type (type)
599   "Hide text of TYPE in the current buffer."
600   (save-excursion
601     (let ((b (point-min))
602           (e (point-max)))
603       (while (setq b (text-property-any b e 'article-type type))
604         (add-text-properties b (incf b) gnus-hidden-properties)))))
605
606 (defun gnus-article-delete-text-of-type (type)
607   "Delete text of TYPE in the current buffer."
608   (save-excursion
609     (let ((b (point-min)))
610       (while (setq b (text-property-any b (point-max) 'article-type type))
611         (delete-region
612          b (or (text-property-not-all b (point-max) 'article-type type)
613                (point-max)))))))
614
615 (defun gnus-article-delete-invisible-text ()
616   "Delete all invisible text in the current buffer."
617   (save-excursion
618     (let ((b (point-min)))
619       (while (setq b (text-property-any b (point-max) 'invisible t))
620         (delete-region
621          b (or (text-property-not-all b (point-max) 'invisible t)
622                (point-max)))))))
623
624 (defun gnus-article-text-type-exists-p (type)
625   "Say whether any text of type TYPE exists in the buffer."
626   (text-property-any (point-min) (point-max) 'article-type type))
627
628 (defsubst gnus-article-header-rank ()
629   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
630   (let ((list gnus-sorted-header-list)
631         (i 0))
632     (while list
633       (when (looking-at (car list))
634         (setq list nil))
635       (setq list (cdr list))
636       (incf i))
637     i))
638
639 (defun article-hide-headers (&optional arg delete)
640   "Toggle whether to hide unwanted headers and possibly sort them as well.
641 If given a negative prefix, always show; if given a positive prefix,
642 always hide."
643   (interactive (gnus-article-hidden-arg))
644   (current-buffer)
645   (if (gnus-article-check-hidden-text 'headers arg)
646       ;; Show boring headers as well.
647       (gnus-article-show-hidden-text 'boring-headers)
648     ;; This function might be inhibited.
649     (unless gnus-inhibit-hiding
650       (save-excursion
651         (save-restriction
652           (let ((buffer-read-only nil)
653                 (case-fold-search t)
654                 (props (nconc (list 'article-type 'headers)
655                               gnus-hidden-properties))
656                 (max (1+ (length gnus-sorted-header-list)))
657                 (ignored (when (not gnus-visible-headers)
658                            (cond ((stringp gnus-ignored-headers)
659                                   gnus-ignored-headers)
660                                  ((listp gnus-ignored-headers)
661                                   (mapconcat 'identity gnus-ignored-headers
662                                              "\\|")))))
663                 (visible
664                  (cond ((stringp gnus-visible-headers)
665                         gnus-visible-headers)
666                        ((and gnus-visible-headers
667                              (listp gnus-visible-headers))
668                         (mapconcat 'identity gnus-visible-headers "\\|"))))
669                 (inhibit-point-motion-hooks t)
670                 want-list beg)
671             ;; First we narrow to just the headers.
672             (widen)
673             (goto-char (point-min))
674             ;; Hide any "From " lines at the beginning of (mail) articles.
675             (while (looking-at "From ")
676               (forward-line 1))
677             (unless (bobp)
678               (if delete
679                   (delete-region (point-min) (point))
680                 (gnus-article-hide-text (point-min) (point) props)))
681             ;; Then treat the rest of the header lines.
682             (narrow-to-region
683              (point)
684              (if (search-forward "\n\n" nil t) ; if there's a body
685                  (progn (forward-line -1) (point))
686                (point-max)))
687             ;; Then we use the two regular expressions
688             ;; `gnus-ignored-headers' and `gnus-visible-headers' to
689             ;; select which header lines is to remain visible in the
690             ;; article buffer.
691             (goto-char (point-min))
692             (while (re-search-forward "^[^ \t]*:" nil t)
693               (beginning-of-line)
694               ;; Mark the rank of the header.
695               (put-text-property
696                (point) (1+ (point)) 'message-rank
697                (if (or (and visible (looking-at visible))
698                        (and ignored
699                             (not (looking-at ignored))))
700                    (gnus-article-header-rank)
701                  (+ 2 max)))
702               (forward-line 1))
703             (message-sort-headers-1)
704             (when (setq beg (text-property-any
705                              (point-min) (point-max) 'message-rank (+ 2 max)))
706               ;; We make the unwanted headers invisible.
707               (if delete
708                   (delete-region beg (point-max))
709                 ;; Suggested by Sudish Joseph <joseph@cis.ohio-state.edu>.
710                 (gnus-article-hide-text-type beg (point-max) 'headers))
711               ;; Work around XEmacs lossage.
712               (put-text-property (point-min) beg 'invisible nil))))))))
713
714 (defun article-hide-boring-headers (&optional arg)
715   "Toggle hiding of headers that aren't very interesting.
716 If given a negative prefix, always show; if given a positive prefix,
717 always hide."
718   (interactive (gnus-article-hidden-arg))
719   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
720              (not gnus-show-all-headers))
721     (save-excursion
722       (save-restriction
723         (let ((buffer-read-only nil)
724               (list gnus-boring-article-headers)
725               (inhibit-point-motion-hooks t)
726               elem)
727           (nnheader-narrow-to-headers)
728           (while list
729             (setq elem (pop list))
730             (goto-char (point-min))
731             (cond
732              ;; Hide empty headers.
733              ((eq elem 'empty)
734               (while (re-search-forward "^[^:]+:[ \t]*\n[^ \t]" nil t)
735                 (forward-line -1)
736                 (gnus-article-hide-text-type
737                  (progn (beginning-of-line) (point))
738                  (progn
739                    (end-of-line)
740                    (if (re-search-forward "^[^ \t]" nil t)
741                        (match-beginning 0)
742                      (point-max)))
743                  'boring-headers)))
744              ;; Hide boring Newsgroups header.
745              ((eq elem 'newsgroups)
746               (when (equal (gnus-fetch-field "newsgroups")
747                            (gnus-group-real-name
748                             (if (boundp 'gnus-newsgroup-name)
749                                 gnus-newsgroup-name
750                               "")))
751                 (gnus-article-hide-header "newsgroups")))
752              ((eq elem 'followup-to)
753               (when (equal (message-fetch-field "followup-to")
754                            (message-fetch-field "newsgroups"))
755                 (gnus-article-hide-header "followup-to")))
756              ((eq elem 'reply-to)
757               (let ((from (message-fetch-field "from"))
758                     (reply-to (message-fetch-field "reply-to")))
759                 (when (and
760                        from reply-to
761                        (ignore-errors
762                          (equal
763                           (nth 1 (mail-extract-address-components from))
764                           (nth 1 (mail-extract-address-components reply-to)))))
765                   (gnus-article-hide-header "reply-to"))))
766              ((eq elem 'date)
767               (let ((date (message-fetch-field "date")))
768                 (when (and date
769                            (< (gnus-days-between (current-time-string) date)
770                               4))
771                   (gnus-article-hide-header "date"))))
772              ((eq elem 'long-to)
773               (let ((to (message-fetch-field "to")))
774                 (when (> (length to) 1024)
775                   (gnus-article-hide-header "to"))))
776              ((eq elem 'many-to)
777               (let ((to-count 0))
778                 (goto-char (point-min))
779                 (while (re-search-forward "^to:" nil t)
780                   (setq to-count (1+ to-count)))
781                 (when (> to-count 1)
782                   (while (> to-count 0)
783                     (goto-char (point-min))
784                     (save-restriction
785                       (re-search-forward "^to:" nil nil to-count)
786                       (forward-line -1)
787                       (narrow-to-region (point) (point-max))
788                       (gnus-article-hide-header "to"))
789                     (setq to-count (1- to-count)))))))))))))
790
791 (defun gnus-article-hide-header (header)
792   (save-excursion
793     (goto-char (point-min))
794     (when (re-search-forward (concat "^" header ":") nil t)
795       (gnus-article-hide-text-type
796        (progn (beginning-of-line) (point))
797        (progn
798          (end-of-line)
799          (if (re-search-forward "^[^ \t]" nil t)
800              (match-beginning 0)
801            (point-max)))
802        'boring-headers))))
803
804 (defun article-treat-dumbquotes ()
805   "Translate M******** sm*rtq**t*s into proper text."
806   (interactive)
807   (article-translate-characters "\221\222\223\223" "`'\"\""))
808
809 (defun article-translate-characters (from to)
810   "Translate all characters in the body of the article according to FROM and TO.
811 FROM is a string of characters to translate from; to is a string of
812 characters to translate to."
813   (save-excursion
814     (goto-char (point-min))
815     (when (search-forward "\n\n" nil t)
816       (let ((buffer-read-only nil)
817             (x (make-string 225 ?x))
818             (i -1))
819         (while (< (incf i) (length x))
820           (aset x i i))
821         (setq i 0)
822         (while (< i (length from))
823           (aset x (aref from i) (aref to i))
824           (incf i))
825         (translate-region (point) (point-max) x)))))
826
827 (defun article-treat-overstrike ()
828   "Translate overstrikes into bold text."
829   (interactive)
830   (save-excursion
831     (goto-char (point-min))
832     (when (search-forward "\n\n" nil t)
833       (let ((buffer-read-only nil))
834         (while (search-forward "\b" nil t)
835           (let ((next (following-char))
836                 (previous (char-after (- (point) 2))))
837             ;; We do the boldification/underlining by hiding the
838             ;; overstrikes and putting the proper text property
839             ;; on the letters.
840             (cond
841              ((eq next previous)
842               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
843               (put-text-property (point) (1+ (point)) 'face 'bold))
844              ((eq next ?_)
845               (gnus-article-hide-text-type
846                (1- (point)) (1+ (point)) 'overstrike)
847               (put-text-property
848                (- (point) 2) (1- (point)) 'face 'underline))
849              ((eq previous ?_)
850               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
851               (put-text-property
852                (point) (1+ (point)) 'face 'underline)))))))))
853
854 (defun article-fill ()
855   "Format too long lines."
856   (interactive)
857   (save-excursion
858     (let ((buffer-read-only nil))
859       (widen)
860       (goto-char (point-min))
861       (search-forward "\n\n" nil t)
862       (end-of-line 1)
863       (let ((paragraph-start "^[>|#:<;* ]*[ \t]*$")
864             (adaptive-fill-regexp "[ \t]*\\([|#:<;>*]+ *\\)?")
865             (adaptive-fill-mode t))
866         (while (not (eobp))
867           (and (>= (current-column) (min fill-column (window-width)))
868                (/= (preceding-char) ?:)
869                (fill-paragraph nil))
870           (end-of-line 2))))))
871
872 (defun article-remove-cr ()
873   "Remove carriage returns from an article."
874   (interactive)
875   (save-excursion
876     (let ((buffer-read-only nil))
877       (goto-char (point-min))
878       (while (search-forward "\r" nil t)
879         (replace-match "" t t)))))
880
881 (defun article-remove-trailing-blank-lines ()
882   "Remove all trailing blank lines from the article."
883   (interactive)
884   (save-excursion
885     (let ((buffer-read-only nil))
886       (goto-char (point-max))
887       (delete-region
888        (point)
889        (progn
890          (while (and (not (bobp))
891                      (looking-at "^[ \t]*$"))
892            (forward-line -1))
893          (forward-line 1)
894          (point))))))
895
896 (defun article-display-x-face (&optional force)
897   "Look for an X-Face header and display it if present."
898   (interactive (list 'force))
899   (save-excursion
900     ;; Delete the old process, if any.
901     (when (process-status "article-x-face")
902       (delete-process "article-x-face"))
903     (let ((inhibit-point-motion-hooks t)
904           (case-fold-search t)
905           from)
906       (save-restriction
907         (nnheader-narrow-to-headers)
908         (setq from (message-fetch-field "from"))
909         (goto-char (point-min))
910         (while (and gnus-article-x-face-command
911                     (or force
912                         ;; Check whether this face is censored.
913                         (not gnus-article-x-face-too-ugly)
914                         (and gnus-article-x-face-too-ugly from
915                              (not (string-match gnus-article-x-face-too-ugly
916                                                 from))))
917                     ;; Has to be present.
918                     (re-search-forward "^X-Face: " nil t))
919           ;; We now have the area of the buffer where the X-Face is stored.
920           (save-excursion
921             (let ((beg (point))
922                   (end (1- (re-search-forward "^\\($\\|[^ \t]\\)" nil t))))
923               ;; We display the face.
924               (if (symbolp gnus-article-x-face-command)
925                   ;; The command is a lisp function, so we call it.
926                   (if (gnus-functionp gnus-article-x-face-command)
927                       (funcall gnus-article-x-face-command beg end)
928                     (error "%s is not a function" gnus-article-x-face-command))
929                 ;; The command is a string, so we interpret the command
930                 ;; as a, well, command, and fork it off.
931                 (let ((process-connection-type nil))
932                   (process-kill-without-query
933                    (start-process
934                     "article-x-face" nil shell-file-name shell-command-switch
935                     gnus-article-x-face-command))
936                   (process-send-region "article-x-face" beg end)
937                   (process-send-eof "article-x-face"))))))))))
938
939 (defun gnus-article-decode-rfc1522 ()
940   "Decode MIME encoded-words in header fields."
941   (let (buffer-read-only)
942     (let ((charset (save-excursion
943                      (set-buffer gnus-summary-buffer)
944                      default-mime-charset)))
945       (eword-decode-header charset)
946       )))
947
948 (defun article-hide-pgp (&optional arg)
949   "Toggle hiding of any PGP headers and signatures in the current article.
950 If given a negative prefix, always show; if given a positive prefix,
951 always hide."
952   (interactive (gnus-article-hidden-arg))
953   (unless (gnus-article-check-hidden-text 'pgp arg)
954     (save-excursion
955       (let ((inhibit-point-motion-hooks t)
956             buffer-read-only beg end)
957         (widen)
958         (goto-char (point-min))
959         ;; Hide the "header".
960         (when (search-forward "\n-----BEGIN PGP SIGNED MESSAGE-----\n" nil t)
961           (gnus-article-hide-text-type (1+ (match-beginning 0))
962                                        (match-end 0) 'pgp)
963           (setq beg (point))
964           ;; Hide the actual signature.
965           (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
966                (setq end (1+ (match-beginning 0)))
967                (gnus-article-hide-text-type
968                 end
969                 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
970                     (match-end 0)
971                   ;; Perhaps we shouldn't hide to the end of the buffer
972                   ;; if there is no end to the signature?
973                   (point-max))
974                 'pgp))
975           ;; Hide "- " PGP quotation markers.
976           (when (and beg end)
977             (narrow-to-region beg end)
978             (goto-char (point-min))
979             (while (re-search-forward "^- " nil t)
980               (gnus-article-hide-text-type
981                (match-beginning 0) (match-end 0) 'pgp))
982             (widen))
983           (gnus-run-hooks 'gnus-article-hide-pgp-hook))))))
984
985 (defun article-hide-pem (&optional arg)
986   "Toggle hiding of any PEM headers and signatures in the current article.
987 If given a negative prefix, always show; if given a positive prefix,
988 always hide."
989   (interactive (gnus-article-hidden-arg))
990   (unless (gnus-article-check-hidden-text 'pem arg)
991     (save-excursion
992       (let (buffer-read-only end)
993         (widen)
994         (goto-char (point-min))
995         ;; hide the horrendously ugly "header".
996         (and (search-forward "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
997                              nil
998                              t)
999              (setq end (1+ (match-beginning 0)))
1000              (gnus-article-hide-text-type
1001               end
1002               (if (search-forward "\n\n" nil t)
1003                   (match-end 0)
1004                 (point-max))
1005               'pem))
1006         ;; hide the trailer as well
1007         (and (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
1008                              nil
1009                              t)
1010              (gnus-article-hide-text-type
1011               (match-beginning 0) (match-end 0) 'pem))))))
1012
1013 (defun article-hide-signature (&optional arg)
1014   "Hide the signature in the current article.
1015 If given a negative prefix, always show; if given a positive prefix,
1016 always hide."
1017   (interactive (gnus-article-hidden-arg))
1018   (unless (gnus-article-check-hidden-text 'signature arg)
1019     (save-excursion
1020       (save-restriction
1021         (let ((buffer-read-only nil))
1022           (when (gnus-article-narrow-to-signature)
1023             (gnus-article-hide-text-type
1024              (point-min) (point-max) 'signature)))))))
1025
1026 (defun article-strip-leading-blank-lines ()
1027   "Remove all blank lines from the beginning of the article."
1028   (interactive)
1029   (save-excursion
1030     (let ((inhibit-point-motion-hooks t)
1031           buffer-read-only)
1032       (goto-char (point-min))
1033       (when (search-forward "\n\n" nil t)
1034         (while (and (not (eobp))
1035                     (looking-at "[ \t]*$"))
1036           (gnus-delete-line))))))
1037
1038 (defun article-strip-multiple-blank-lines ()
1039   "Replace consecutive blank lines with one empty line."
1040   (interactive)
1041   (save-excursion
1042     (let ((inhibit-point-motion-hooks t)
1043           buffer-read-only)
1044       ;; First make all blank lines empty.
1045       (goto-char (point-min))
1046       (search-forward "\n\n" nil t)
1047       (while (re-search-forward "^[ \t]+$" nil t)
1048         (replace-match "" nil t))
1049       ;; Then replace multiple empty lines with a single empty line.
1050       (goto-char (point-min))
1051       (search-forward "\n\n" nil t)
1052       (while (re-search-forward "\n\n\n+" nil t)
1053         (replace-match "\n\n" t t)))))
1054
1055 (defun article-strip-leading-space ()
1056   "Remove all white space from the beginning of the lines in the article."
1057   (interactive)
1058   (save-excursion
1059     (let ((inhibit-point-motion-hooks t)
1060           buffer-read-only)
1061       (goto-char (point-min))
1062       (search-forward "\n\n" nil t)
1063       (while (re-search-forward "^[ \t]+" nil t)
1064         (replace-match "" t t)))))
1065
1066 (defun article-strip-blank-lines ()
1067   "Strip leading, trailing and multiple blank lines."
1068   (interactive)
1069   (article-strip-leading-blank-lines)
1070   (article-remove-trailing-blank-lines)
1071   (article-strip-multiple-blank-lines))
1072
1073 (defun article-strip-all-blank-lines ()
1074   "Strip all blank lines."
1075   (interactive)
1076   (save-excursion
1077     (let ((inhibit-point-motion-hooks t)
1078           buffer-read-only)
1079       (goto-char (point-min))
1080       (search-forward "\n\n" nil t)
1081       (while (re-search-forward "^[ \t]*\n" nil t)
1082         (replace-match "" t t)))))
1083
1084 (defvar mime::preview/content-list)
1085 (defvar mime::preview-content-info/point-min)
1086 (defun gnus-article-narrow-to-signature ()
1087   "Narrow to the signature; return t if a signature is found, else nil."
1088   (widen)
1089   (when (and (boundp 'mime::preview/content-list)
1090              mime::preview/content-list)
1091     ;; We have a MIMEish article, so we use the MIME data to narrow.
1092     (let ((pcinfo (car (last mime::preview/content-list))))
1093       (ignore-errors
1094         (narrow-to-region
1095          (funcall (intern "mime::preview-content-info/point-min") pcinfo)
1096          (point-max)))))
1097
1098   (when (gnus-article-search-signature)
1099     (forward-line 1)
1100     ;; Check whether we have some limits to what we consider
1101     ;; to be a signature.
1102     (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1103                     (list gnus-signature-limit)))
1104           limit limited)
1105       (while (setq limit (pop limits))
1106         (if (or (and (integerp limit)
1107                      (< (- (point-max) (point)) limit))
1108                 (and (floatp limit)
1109                      (< (count-lines (point) (point-max)) limit))
1110                 (and (gnus-functionp limit)
1111                      (funcall limit))
1112                 (and (stringp limit)
1113                      (not (re-search-forward limit nil t))))
1114             ()                          ; This limit did not succeed.
1115           (setq limited t
1116                 limits nil)))
1117       (unless limited
1118         (narrow-to-region (point) (point-max))
1119         t))))
1120
1121 (defun gnus-article-search-signature ()
1122   "Search the current buffer for the signature separator.
1123 Put point at the beginning of the signature separator."
1124   (let ((cur (point)))
1125     (goto-char (point-max))
1126     (if (if (stringp gnus-signature-separator)
1127             (re-search-backward gnus-signature-separator nil t)
1128           (let ((seps gnus-signature-separator))
1129             (while (and seps
1130                         (not (re-search-backward (car seps) nil t)))
1131               (pop seps))
1132             seps))
1133         t
1134       (goto-char cur)
1135       nil)))
1136
1137 (eval-and-compile
1138   (autoload 'w3-display "w3-parse")
1139   (autoload 'w3-do-setup "w3" "" t)
1140   (autoload 'w3-region "w3-display" "" t))
1141
1142 (defun gnus-article-treat-html ()
1143   "Render HTML."
1144   (interactive)
1145   (let ((cbuf (current-buffer)))
1146     (set-buffer gnus-article-buffer)
1147     (let (buf buffer-read-only b e)
1148       (w3-do-setup)
1149       (goto-char (point-min))
1150       (narrow-to-region
1151        (if (search-forward "\n\n" nil t)
1152            (setq b (point))
1153          (point-max))
1154        (setq e (point-max)))
1155       (nnheader-temp-write nil
1156         (insert-buffer-substring gnus-article-buffer b e)
1157         (require 'url)
1158         (save-window-excursion
1159           (w3-region (point-min) (point-max))
1160           (setq buf (buffer-substring-no-properties (point-min) (point-max)))))
1161       (when buf
1162         (delete-region (point-min) (point-max))
1163         (insert buf))
1164       (widen)
1165       (goto-char (point-min))
1166       (set-window-start (get-buffer-window (current-buffer)) (point-min))
1167       (set-buffer cbuf))))
1168
1169 (defun gnus-article-hidden-arg ()
1170   "Return the current prefix arg as a number, or 0 if no prefix."
1171   (list (if current-prefix-arg
1172             (prefix-numeric-value current-prefix-arg)
1173           0)))
1174
1175 (defun gnus-article-check-hidden-text (type arg)
1176   "Return nil if hiding is necessary.
1177 Arg can be nil or a number.  Nil and positive means hide, negative
1178 means show, 0 means toggle."
1179   (save-excursion
1180     (save-restriction
1181       (widen)
1182       (let ((hide (gnus-article-hidden-text-p type)))
1183         (cond
1184          ((or (null arg)
1185               (> arg 0))
1186           nil)
1187          ((< arg 0)
1188           (gnus-article-show-hidden-text type))
1189          (t
1190           (if (eq hide 'hidden)
1191               (gnus-article-show-hidden-text type)
1192             nil)))))))
1193
1194 (defun gnus-article-hidden-text-p (type)
1195   "Say whether the current buffer contains hidden text of type TYPE."
1196   (let ((start (point-min))
1197         (pos (text-property-any (point-min) (point-max) 'article-type type)))
1198     (while (and pos
1199                 (not (get-text-property pos 'invisible)))
1200       (setq pos
1201             (text-property-any (1+ pos) (point-max) 'article-type type)))
1202     (if pos
1203         'hidden
1204       'shown)))
1205
1206 (defun gnus-article-show-hidden-text (type &optional hide)
1207   "Show all hidden text of type TYPE.
1208 If HIDE, hide the text instead."
1209   (save-excursion
1210     (let ((buffer-read-only nil)
1211           (inhibit-point-motion-hooks t)
1212           (end (point-min))
1213           beg)
1214       (while (setq beg (text-property-any end (point-max) 'article-type type))
1215         (goto-char beg)
1216         (setq end (or
1217                    (text-property-not-all beg (point-max) 'article-type type)
1218                    (point-max)))
1219         (if hide
1220             (gnus-article-hide-text beg end gnus-hidden-properties)
1221           (gnus-article-unhide-text beg end))
1222         (goto-char end))
1223       t)))
1224
1225 (defconst article-time-units
1226   `((year . ,(* 365.25 24 60 60))
1227     (week . ,(* 7 24 60 60))
1228     (day . ,(* 24 60 60))
1229     (hour . ,(* 60 60))
1230     (minute . 60)
1231     (second . 1))
1232   "Mapping from time units to seconds.")
1233
1234 (defun article-date-ut (&optional type highlight header)
1235   "Convert DATE date to universal time in the current article.
1236 If TYPE is `local', convert to local time; if it is `lapsed', output
1237 how much time has lapsed since DATE."
1238   (interactive (list 'ut t))
1239   (let* ((header (or header
1240                      (mail-header-date gnus-current-headers)
1241                      (message-fetch-field "date")
1242                      ""))
1243          (date (if (vectorp header) (mail-header-date header)
1244                  header))
1245          (date-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
1246          (inhibit-point-motion-hooks t)
1247          bface eface newline)
1248     (when (and date (not (string= date "")))
1249       (save-excursion
1250         (save-restriction
1251           (nnheader-narrow-to-headers)
1252           (let ((buffer-read-only nil))
1253             ;; Delete any old Date headers.
1254             (if (re-search-forward date-regexp nil t)
1255                 (progn
1256                   (setq bface (get-text-property (gnus-point-at-bol) 'face)
1257                         eface (get-text-property (1- (gnus-point-at-eol))
1258                                                  'face))
1259                   (delete-region (progn (beginning-of-line) (point))
1260                                  (progn (end-of-line) (point)))
1261                   (beginning-of-line))
1262               (goto-char (point-max))
1263               (setq newline t))
1264             (insert (article-make-date-line date type))
1265             ;; Do highlighting.
1266             (beginning-of-line)
1267             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
1268               (put-text-property (match-beginning 1) (1+ (match-end 1))
1269                                  'face bface)
1270               (put-text-property (match-beginning 2) (match-end 2)
1271                                  'face eface))
1272             (when newline
1273               (end-of-line)
1274               (insert "\n"))))))))
1275
1276 (defun article-make-date-line (date type)
1277   "Return a DATE line of TYPE."
1278   (cond
1279    ;; Convert to the local timezone.  We have to slap a
1280    ;; `condition-case' round the calls to the timezone
1281    ;; functions since they aren't particularly resistant to
1282    ;; buggy dates.
1283    ((eq type 'local)
1284     (concat "Date: " (condition-case ()
1285                          (timezone-make-date-arpa-standard date)
1286                        (error date))))
1287    ;; Convert to Universal Time.
1288    ((eq type 'ut)
1289     (concat "Date: "
1290             (condition-case ()
1291                 (timezone-make-date-arpa-standard date nil "UT")
1292               (error date))))
1293    ;; Get the original date from the article.
1294    ((eq type 'original)
1295     (concat "Date: " date))
1296    ;; Let the user define the format.
1297    ((eq type 'user)
1298     (if (gnus-functionp gnus-article-time-format)
1299         (funcall
1300          gnus-article-time-format
1301          (ignore-errors
1302            (gnus-encode-date
1303             (timezone-make-date-arpa-standard
1304              date nil "UT"))))
1305       (concat
1306        "Date: "
1307        (format-time-string gnus-article-time-format
1308                            (ignore-errors
1309                              (gnus-encode-date
1310                               (timezone-make-date-arpa-standard
1311                                date nil "UT")))))))
1312    ;; ISO 8601.
1313    ((eq type 'iso8601)
1314     (concat
1315      "Date: "
1316      (format-time-string "%Y%M%DT%h%m%s"
1317                          (ignore-errors
1318                            (gnus-encode-date
1319                             (timezone-make-date-arpa-standard
1320                              date nil "UT"))))))
1321    ;; Do an X-Sent lapsed format.
1322    ((eq type 'lapsed)
1323     ;; If the date is seriously mangled, the timezone functions are
1324     ;; liable to bug out, so we ignore all errors.
1325     (let* ((now (current-time))
1326            (real-time
1327             (ignore-errors
1328               (gnus-time-minus
1329                (gnus-encode-date
1330                 (timezone-make-date-arpa-standard
1331                  (current-time-string now)
1332                  (current-time-zone now) "UT"))
1333                (gnus-encode-date
1334                 (timezone-make-date-arpa-standard
1335                  date nil "UT")))))
1336            (real-sec (and real-time
1337                           (+ (* (float (car real-time)) 65536)
1338                              (cadr real-time))))
1339            (sec (and real-time (abs real-sec)))
1340            num prev)
1341       (cond
1342        ((null real-time)
1343         "X-Sent: Unknown")
1344        ((zerop sec)
1345         "X-Sent: Now")
1346        (t
1347         (concat
1348          "X-Sent: "
1349          ;; This is a bit convoluted, but basically we go
1350          ;; through the time units for years, weeks, etc,
1351          ;; and divide things to see whether that results
1352          ;; in positive answers.
1353          (mapconcat
1354           (lambda (unit)
1355             (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
1356                 ;; The (remaining) seconds are too few to
1357                 ;; be divided into this time unit.
1358                 ""
1359               ;; It's big enough, so we output it.
1360               (setq sec (- sec (* num (cdr unit))))
1361               (prog1
1362                   (concat (if prev ", " "") (int-to-string
1363                                              (floor num))
1364                           " " (symbol-name (car unit))
1365                           (if (> num 1) "s" ""))
1366                 (setq prev t))))
1367           article-time-units "")
1368          ;; If dates are odd, then it might appear like the
1369          ;; article was sent in the future.
1370          (if (> real-sec 0)
1371              " ago"
1372            " in the future"))))))
1373    (t
1374     (error "Unknown conversion type: %s" type))))
1375
1376 (defun article-date-local (&optional highlight)
1377   "Convert the current article date to the local timezone."
1378   (interactive (list t))
1379   (article-date-ut 'local highlight))
1380
1381 (defun article-date-original (&optional highlight)
1382   "Convert the current article date to what it was originally.
1383 This is only useful if you have used some other date conversion
1384 function and want to see what the date was before converting."
1385   (interactive (list t))
1386   (article-date-ut 'original highlight))
1387
1388 (defun article-date-lapsed (&optional highlight)
1389   "Convert the current article date to time lapsed since it was sent."
1390   (interactive (list t))
1391   (article-date-ut 'lapsed highlight))
1392
1393 (defun article-update-date-lapsed ()
1394   "Function to be run from a timer to update the lapsed time line."
1395   (let (deactivate-mark)
1396     (save-excursion
1397       (ignore-errors
1398         (when (gnus-buffer-live-p gnus-article-buffer)
1399           (set-buffer gnus-article-buffer)
1400           (goto-char (point-min))
1401           (when (re-search-forward "^X-Sent:" nil t)
1402             (article-date-lapsed t)))))))
1403
1404 (defun gnus-start-date-timer (&optional n)
1405   "Start a timer to update the X-Sent header in the article buffers.
1406 The numerical prefix says how frequently (in seconds) the function
1407 is to run."
1408   (interactive "p")
1409   (unless n
1410     (setq n 1))
1411   (gnus-stop-date-timer)
1412   (setq article-lapsed-timer 
1413         (nnheader-run-at-time 1 n 'article-update-date-lapsed)))
1414
1415 (defun gnus-stop-date-timer ()
1416   "Stop the X-Sent timer."
1417   (interactive)
1418   (when article-lapsed-timer
1419     (nnheader-cancel-timer article-lapsed-timer)
1420     (setq article-lapsed-timer nil)))
1421
1422 (defun article-date-user (&optional highlight)
1423   "Convert the current article date to the user-defined format.
1424 This format is defined by the `gnus-article-time-format' variable."
1425   (interactive (list t))
1426   (article-date-ut 'user highlight))
1427
1428 (defun article-date-iso8601 (&optional highlight)
1429   "Convert the current article date to ISO8601."
1430   (interactive (list t))
1431   (article-date-ut 'iso8601 highlight))
1432
1433 (defun article-show-all ()
1434   "Show all hidden text in the article buffer."
1435   (interactive)
1436   (save-excursion
1437     (let ((buffer-read-only nil))
1438       (gnus-article-unhide-text (point-min) (point-max)))))
1439
1440 (defun article-emphasize (&optional arg)
1441   "Emphasize text according to `gnus-emphasis-alist'."
1442   (interactive (gnus-article-hidden-arg))
1443   (unless (gnus-article-check-hidden-text 'emphasis arg)
1444     (save-excursion
1445       (let ((alist gnus-emphasis-alist)
1446             (buffer-read-only nil)
1447             (props (append '(article-type emphasis)
1448                            gnus-hidden-properties))
1449             regexp elem beg invisible visible face)
1450         (goto-char (point-min))
1451         (search-forward "\n\n" nil t)
1452         (setq beg (point))
1453         (while (setq elem (pop alist))
1454           (goto-char beg)
1455           (setq regexp (car elem)
1456                 invisible (nth 1 elem)
1457                 visible (nth 2 elem)
1458                 face (nth 3 elem))
1459           (while (re-search-forward regexp nil t)
1460             (when (and (match-beginning visible) (match-beginning invisible))
1461               (gnus-article-hide-text
1462                (match-beginning invisible) (match-end invisible) props)
1463               (gnus-article-unhide-text-type
1464                (match-beginning visible) (match-end visible) 'emphasis)
1465               (gnus-put-text-property-excluding-newlines
1466                (match-beginning visible) (match-end visible) 'face face)
1467               (goto-char (match-end invisible)))))))))
1468
1469 (defvar gnus-summary-article-menu)
1470 (defvar gnus-summary-post-menu)
1471
1472 ;;; Saving functions.
1473
1474 (defun gnus-article-save (save-buffer file &optional num)
1475   "Save the currently selected article."
1476   (unless gnus-save-all-headers
1477     ;; Remove headers according to `gnus-saved-headers'.
1478     (let ((gnus-visible-headers
1479            (or gnus-saved-headers gnus-visible-headers))
1480           (gnus-article-buffer save-buffer))
1481       (save-excursion
1482         (set-buffer save-buffer)
1483         (article-hide-headers 1 t))))
1484   (save-window-excursion
1485     (if (not gnus-default-article-saver)
1486         (error "No default saver is defined")
1487       ;; !!! Magic!  The saving functions all save
1488       ;; `gnus-original-article-buffer' (or so they think), but we
1489       ;; bind that variable to our save-buffer.
1490       (set-buffer gnus-article-buffer)
1491       (let* ((gnus-save-article-buffer save-buffer)
1492              (filename
1493               (cond
1494                ((not gnus-prompt-before-saving) 'default)
1495                ((eq gnus-prompt-before-saving 'always) nil)
1496                (t file)))
1497              (gnus-number-of-articles-to-be-saved
1498               (when (eq gnus-prompt-before-saving t)
1499                 num)))                  ; Magic
1500         (set-buffer gnus-article-current-summary)
1501         (funcall gnus-default-article-saver filename)))))
1502
1503 (defun gnus-read-save-file-name (prompt &optional filename
1504                                         function group headers variable)
1505   (let ((default-name
1506           (funcall function group headers (symbol-value variable)))
1507         result)
1508     (setq
1509      result
1510      (cond
1511       ((eq filename 'default)
1512        default-name)
1513       ((eq filename t)
1514        default-name)
1515       (filename filename)
1516       (t
1517        (let* ((split-name (gnus-get-split-value gnus-split-methods))
1518               (prompt
1519                (format prompt
1520                        (if (and gnus-number-of-articles-to-be-saved
1521                                 (> gnus-number-of-articles-to-be-saved 1))
1522                            (format "these %d articles"
1523                                    gnus-number-of-articles-to-be-saved)
1524                          "this article")))
1525               (file
1526                ;; Let the split methods have their say.
1527                (cond
1528                 ;; No split name was found.
1529                 ((null split-name)
1530                  (read-file-name
1531                   (concat prompt " (default "
1532                           (file-name-nondirectory default-name) ") ")
1533                   (file-name-directory default-name)
1534                   default-name))
1535                 ;; A single group name is returned.
1536                 ((stringp split-name)
1537                  (setq default-name
1538                        (funcall function split-name headers
1539                                 (symbol-value variable)))
1540                  (read-file-name
1541                   (concat prompt " (default "
1542                           (file-name-nondirectory default-name) ") ")
1543                   (file-name-directory default-name)
1544                   default-name))
1545                 ;; A single split name was found
1546                 ((= 1 (length split-name))
1547                  (let* ((name (expand-file-name
1548                                (car split-name) gnus-article-save-directory))
1549                         (dir (cond ((file-directory-p name)
1550                                     (file-name-as-directory name))
1551                                    ((file-exists-p name) name)
1552                                    (t gnus-article-save-directory))))
1553                    (read-file-name
1554                     (concat prompt " (default " name ") ")
1555                     dir name)))
1556                 ;; A list of splits was found.
1557                 (t
1558                  (setq split-name (nreverse split-name))
1559                  (let (result)
1560                    (let ((file-name-history
1561                           (nconc split-name file-name-history)))
1562                      (setq result
1563                            (expand-file-name
1564                             (read-file-name
1565                              (concat prompt " (`M-p' for defaults) ")
1566                              gnus-article-save-directory
1567                              (car split-name))
1568                             gnus-article-save-directory)))
1569                    (car (push result file-name-history)))))))
1570          ;; Create the directory.
1571          (gnus-make-directory (file-name-directory file))
1572          ;; If we have read a directory, we append the default file name.
1573          (when (file-directory-p file)
1574            (setq file (concat (file-name-as-directory file)
1575                               (file-name-nondirectory default-name))))
1576          ;; Possibly translate some characters.
1577          (nnheader-translate-file-chars file)))))
1578     (gnus-make-directory (file-name-directory result))
1579     (set variable result)))
1580
1581 (defun gnus-article-archive-name (group)
1582   "Return the first instance of an \"Archive-name\" in the current buffer."
1583   (let ((case-fold-search t))
1584     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
1585       (nnheader-concat gnus-article-save-directory
1586                        (match-string 1)))))
1587
1588 (defun gnus-article-nndoc-name (group)
1589   "If GROUP is an nndoc group, return the name of the parent group."
1590   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
1591     (gnus-group-get-parameter group 'save-article-group)))
1592
1593 (defun gnus-summary-save-in-rmail (&optional filename)
1594   "Append this article to Rmail file.
1595 Optional argument FILENAME specifies file name.
1596 Directory to save to is default to `gnus-article-save-directory'."
1597   (setq filename (gnus-read-save-file-name
1598                   "Save %s in rmail file:" filename
1599                   gnus-rmail-save-name gnus-newsgroup-name
1600                   gnus-current-headers 'gnus-newsgroup-last-rmail))
1601   (gnus-eval-in-buffer-window gnus-save-article-buffer
1602     (save-excursion
1603       (save-restriction
1604         (widen)
1605         (gnus-output-to-rmail filename))))
1606   filename)
1607
1608 (defun gnus-summary-save-in-mail (&optional filename)
1609   "Append this article to Unix mail file.
1610 Optional argument FILENAME specifies file name.
1611 Directory to save to is default to `gnus-article-save-directory'."
1612   (setq filename (gnus-read-save-file-name
1613                   "Save %s in Unix mail file:" filename
1614                   gnus-mail-save-name gnus-newsgroup-name
1615                   gnus-current-headers 'gnus-newsgroup-last-mail))
1616   (gnus-eval-in-buffer-window gnus-save-article-buffer
1617     (save-excursion
1618       (save-restriction
1619         (widen)
1620         (if (and (file-readable-p filename)
1621                  (mail-file-babyl-p filename))
1622             (gnus-output-to-rmail filename t)
1623           (gnus-output-to-mail filename)))))
1624   filename)
1625
1626 (defun gnus-summary-save-in-file (&optional filename overwrite)
1627   "Append this article to file.
1628 Optional argument FILENAME specifies file name.
1629 Directory to save to is default to `gnus-article-save-directory'."
1630   (setq filename (gnus-read-save-file-name
1631                   "Save %s in file:" filename
1632                   gnus-file-save-name gnus-newsgroup-name
1633                   gnus-current-headers 'gnus-newsgroup-last-file))
1634   (gnus-eval-in-buffer-window gnus-save-article-buffer
1635     (save-excursion
1636       (save-restriction
1637         (widen)
1638         (when (and overwrite
1639                    (file-exists-p filename))
1640           (delete-file filename))
1641         (gnus-output-to-file filename))))
1642   filename)
1643
1644 (defun gnus-summary-write-to-file (&optional filename)
1645   "Write this article to a file.
1646 Optional argument FILENAME specifies file name.
1647 The directory to save in defaults to `gnus-article-save-directory'."
1648   (gnus-summary-save-in-file nil t))
1649
1650 (defun gnus-summary-save-body-in-file (&optional filename)
1651   "Append this article body to a file.
1652 Optional argument FILENAME specifies file name.
1653 The directory to save in defaults to `gnus-article-save-directory'."
1654   (setq filename (gnus-read-save-file-name
1655                   "Save %s body in file:" filename
1656                   gnus-file-save-name gnus-newsgroup-name
1657                   gnus-current-headers 'gnus-newsgroup-last-file))
1658   (gnus-eval-in-buffer-window gnus-save-article-buffer
1659     (save-excursion
1660       (save-restriction
1661         (widen)
1662         (goto-char (point-min))
1663         (when (search-forward "\n\n" nil t)
1664           (narrow-to-region (point) (point-max)))
1665         (gnus-output-to-file filename))))
1666   filename)
1667
1668 (defun gnus-summary-save-in-pipe (&optional command)
1669   "Pipe this article to subprocess."
1670   (setq command
1671         (cond ((eq command 'default)
1672                gnus-last-shell-command)
1673               (command command)
1674               (t (read-string
1675                   (format
1676                    "Shell command on %s: "
1677                    (if (and gnus-number-of-articles-to-be-saved
1678                             (> gnus-number-of-articles-to-be-saved 1))
1679                        (format "these %d articles"
1680                                gnus-number-of-articles-to-be-saved)
1681                      "this article"))
1682                   gnus-last-shell-command))))
1683   (when (string-equal command "")
1684     (setq command gnus-last-shell-command))
1685   (gnus-eval-in-buffer-window gnus-article-buffer
1686     (save-restriction
1687       (widen)
1688       (shell-command-on-region (point-min) (point-max) command nil)))
1689   (setq gnus-last-shell-command command))
1690
1691 ;;; Article file names when saving.
1692
1693 (defun gnus-capitalize-newsgroup (newsgroup)
1694   "Capitalize NEWSGROUP name."
1695   (when (not (zerop (length newsgroup)))
1696     (concat (char-to-string (upcase (aref newsgroup 0)))
1697             (substring newsgroup 1))))
1698
1699 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
1700   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1701 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
1702 Otherwise, it is like ~/News/news/group/num."
1703   (let ((default
1704           (expand-file-name
1705            (concat (if (gnus-use-long-file-name 'not-save)
1706                        (gnus-capitalize-newsgroup newsgroup)
1707                      (gnus-newsgroup-directory-form newsgroup))
1708                    "/" (int-to-string (mail-header-number headers)))
1709            gnus-article-save-directory)))
1710     (if (and last-file
1711              (string-equal (file-name-directory default)
1712                            (file-name-directory last-file))
1713              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1714         default
1715       (or last-file default))))
1716
1717 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
1718   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1719 If variable `gnus-use-long-file-name' is non-nil, it is
1720 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
1721   (let ((default
1722           (expand-file-name
1723            (concat (if (gnus-use-long-file-name 'not-save)
1724                        newsgroup
1725                      (gnus-newsgroup-directory-form newsgroup))
1726                    "/" (int-to-string (mail-header-number headers)))
1727            gnus-article-save-directory)))
1728     (if (and last-file
1729              (string-equal (file-name-directory default)
1730                            (file-name-directory last-file))
1731              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1732         default
1733       (or last-file default))))
1734
1735 (defun gnus-Plain-save-name (newsgroup headers &optional last-file)
1736   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1737 If variable `gnus-use-long-file-name' is non-nil, it is
1738 ~/News/News.group.  Otherwise, it is like ~/News/news/group/news."
1739   (or last-file
1740       (expand-file-name
1741        (if (gnus-use-long-file-name 'not-save)
1742            (gnus-capitalize-newsgroup newsgroup)
1743          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1744        gnus-article-save-directory)))
1745
1746 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
1747   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1748 If variable `gnus-use-long-file-name' is non-nil, it is
1749 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
1750   (or last-file
1751       (expand-file-name
1752        (if (gnus-use-long-file-name 'not-save)
1753            newsgroup
1754          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1755        gnus-article-save-directory)))
1756
1757 (eval-and-compile
1758   (mapcar
1759    (lambda (func)
1760      (let (afunc gfunc)
1761        (if (consp func)
1762            (setq afunc (car func)
1763                  gfunc (cdr func))
1764          (setq afunc func
1765                gfunc (intern (format "gnus-%s" func))))
1766        (fset gfunc
1767              (if (not (fboundp afunc))
1768                  nil
1769                `(lambda (&optional interactive &rest args)
1770                   ,(documentation afunc t)
1771                   (interactive (list t))
1772                   (save-excursion
1773                     (set-buffer gnus-article-buffer)
1774                     (if interactive
1775                         (call-interactively ',afunc)
1776                       (apply ',afunc args))))))))
1777    '(article-hide-headers
1778      article-hide-boring-headers
1779      article-treat-overstrike
1780      (article-fill . gnus-article-word-wrap)
1781      article-remove-cr
1782      article-display-x-face
1783      article-hide-pgp
1784      article-hide-pem
1785      article-hide-signature
1786      article-remove-trailing-blank-lines
1787      article-strip-leading-blank-lines
1788      article-strip-multiple-blank-lines
1789      article-strip-leading-space
1790      article-strip-blank-lines
1791      article-strip-all-blank-lines
1792      article-date-local
1793      article-date-iso8601
1794      article-date-original
1795      article-date-ut
1796      article-date-user
1797      article-date-lapsed
1798      article-emphasize
1799      article-treat-dumbquotes
1800      (article-show-all . gnus-article-show-all-headers))))
1801 \f
1802 ;;;
1803 ;;; Gnus article mode
1804 ;;;
1805
1806 (put 'gnus-article-mode 'mode-class 'special)
1807
1808 (gnus-define-keys gnus-article-mode-map
1809   " " gnus-article-goto-next-page
1810   "\177" gnus-article-goto-prev-page
1811   [delete] gnus-article-goto-prev-page
1812   "\C-c^" gnus-article-refer-article
1813   "h" gnus-article-show-summary
1814   "s" gnus-article-show-summary
1815   "\C-c\C-m" gnus-article-mail
1816   "?" gnus-article-describe-briefly
1817   gnus-mouse-2 gnus-article-push-button
1818   "\r" gnus-article-press-button
1819   "\t" gnus-article-next-button
1820   "\M-\t" gnus-article-prev-button
1821   "e" gnus-article-edit
1822   "<" beginning-of-buffer
1823   ">" end-of-buffer
1824   "\C-c\C-i" gnus-info-find-node
1825   "\C-c\C-b" gnus-bug
1826
1827   "\C-d" gnus-article-read-summary-keys
1828   "\M-*" gnus-article-read-summary-keys
1829   "\M-#" gnus-article-read-summary-keys
1830   "\M-^" gnus-article-read-summary-keys
1831   "\M-g" gnus-article-read-summary-keys)
1832
1833 (substitute-key-definition
1834  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
1835
1836 (defun gnus-article-make-menu-bar ()
1837   (gnus-turn-off-edit-menu 'article)
1838   (unless (boundp 'gnus-article-article-menu)
1839     (easy-menu-define
1840      gnus-article-article-menu gnus-article-mode-map ""
1841      '("Article"
1842        ["Scroll forwards" gnus-article-goto-next-page t]
1843        ["Scroll backwards" gnus-article-goto-prev-page t]
1844        ["Show summary" gnus-article-show-summary t]
1845        ["Fetch Message-ID at point" gnus-article-refer-article t]
1846        ["Mail to address at point" gnus-article-mail t]))
1847
1848     (easy-menu-define
1849      gnus-article-treatment-menu gnus-article-mode-map ""
1850      '("Treatment"
1851        ["Hide headers" gnus-article-hide-headers t]
1852        ["Hide signature" gnus-article-hide-signature t]
1853        ["Hide citation" gnus-article-hide-citation t]
1854        ["Treat overstrike" gnus-article-treat-overstrike t]
1855        ["Remove carriage return" gnus-article-remove-cr t]
1856        ))
1857
1858     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
1859
1860     (when (boundp 'gnus-summary-post-menu)
1861       (define-key gnus-article-mode-map [menu-bar post]
1862         (cons "Post" gnus-summary-post-menu)))
1863
1864     (gnus-run-hooks 'gnus-article-menu-hook)))
1865
1866 (defun gnus-article-mode ()
1867   "Major mode for displaying an article.
1868
1869 All normal editing commands are switched off.
1870
1871 The following commands are available in addition to all summary mode
1872 commands:
1873 \\<gnus-article-mode-map>
1874 \\[gnus-article-next-page]\t Scroll the article one page forwards
1875 \\[gnus-article-prev-page]\t Scroll the article one page backwards
1876 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
1877 \\[gnus-article-show-summary]\t Display the summary buffer
1878 \\[gnus-article-mail]\t Send a reply to the address near point
1879 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
1880 \\[gnus-info-find-node]\t Go to the Gnus info node"
1881   (interactive)
1882   (when (gnus-visual-p 'article-menu 'menu)
1883     (gnus-article-make-menu-bar))
1884   (gnus-simplify-mode-line)
1885   (setq mode-name "Article")
1886   (setq major-mode 'gnus-article-mode)
1887   (make-local-variable 'minor-mode-alist)
1888   (unless (assq 'gnus-show-mime minor-mode-alist)
1889     (push (list 'gnus-show-mime " MIME") minor-mode-alist))
1890   (use-local-map gnus-article-mode-map)
1891   (gnus-update-format-specifications nil 'article-mode)
1892   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
1893   (make-local-variable 'gnus-page-broken) 
1894   (make-local-variable 'gnus-button-marker-list) 
1895   (make-local-variable 'gnus-article-current-summary) 
1896   (gnus-set-default-directory)
1897   (buffer-disable-undo (current-buffer))
1898   (setq buffer-read-only t)
1899   (set-syntax-table gnus-article-mode-syntax-table)
1900   (gnus-run-hooks 'gnus-article-mode-hook))
1901
1902 (defun gnus-article-setup-buffer ()
1903   "Initialize the article buffer."
1904   (let* ((name (if gnus-single-article-buffer "*Article*"
1905                  (concat "*Article " gnus-newsgroup-name "*")))
1906          (original
1907           (progn (string-match "\\*Article" name)
1908                  (concat " *Original Article"
1909                          (substring name (match-end 0))))))
1910     (setq gnus-article-buffer name)
1911     (setq gnus-original-article-buffer original)
1912     ;; This might be a variable local to the summary buffer.
1913     (unless gnus-single-article-buffer
1914       (save-excursion
1915         (set-buffer gnus-summary-buffer)
1916         (setq gnus-article-buffer name)
1917         (setq gnus-original-article-buffer original)
1918         (gnus-set-global-variables)))
1919     ;; Init original article buffer.
1920     (save-excursion
1921       (set-buffer (get-buffer-create gnus-original-article-buffer))
1922       (buffer-disable-undo (current-buffer))
1923       (setq major-mode 'gnus-original-article-mode)
1924       (gnus-add-current-to-buffer-list)
1925       (make-local-variable 'gnus-original-article))
1926     (if (get-buffer name)
1927         (save-excursion
1928           (set-buffer name)
1929           (buffer-disable-undo (current-buffer))
1930           (setq buffer-read-only t)
1931           (gnus-add-current-to-buffer-list)
1932           (unless (eq major-mode 'gnus-article-mode)
1933             (gnus-article-mode))
1934           (current-buffer))
1935       (save-excursion
1936         (set-buffer (get-buffer-create name))
1937         (gnus-add-current-to-buffer-list)
1938         (gnus-article-mode)
1939         (make-local-variable 'gnus-summary-buffer)
1940         (current-buffer)))))
1941
1942 ;; Set article window start at LINE, where LINE is the number of lines
1943 ;; from the head of the article.
1944 (defun gnus-article-set-window-start (&optional line)
1945   (set-window-start
1946    (get-buffer-window gnus-article-buffer t)
1947    (save-excursion
1948      (set-buffer gnus-article-buffer)
1949      (goto-char (point-min))
1950      (if (not line)
1951          (point-min)
1952        (gnus-message 6 "Moved to bookmark")
1953        (search-forward "\n\n" nil t)
1954        (forward-line line)
1955        (point)))))
1956
1957 ;;; @@ article filters
1958 ;;;
1959
1960 (defun gnus-article-display-mime-message ()
1961   "Article display method for MIME message."
1962   (make-local-variable 'mime-button-mother-dispatcher)
1963   (setq mime-button-mother-dispatcher
1964         (function gnus-article-push-button))
1965   (let ((default-mime-charset
1966           (save-excursion
1967             (set-buffer gnus-summary-buffer)
1968             default-mime-charset))
1969         )
1970     (mime-display-message mime-message-structure
1971                           gnus-article-buffer nil gnus-article-mode-map)
1972     )
1973   (run-hooks 'gnus-mime-article-prepare-hook)
1974   )
1975
1976 (defun gnus-article-display-traditional-message ()
1977   "Article display method for traditional message."
1978   (set-buffer gnus-article-buffer)
1979   (let (buffer-read-only)
1980     (erase-buffer)
1981     (insert-buffer-substring gnus-original-article-buffer)
1982     ))
1983
1984 (defun gnus-article-display-message-with-encoded-word ()
1985   "Article display method for message with encoded-words."
1986   (let ((charset (save-excursion
1987                    (set-buffer gnus-summary-buffer)
1988                    default-mime-charset)))
1989     (gnus-article-display-traditional-message)
1990     (let (buffer-read-only)
1991       (eword-decode-header charset)
1992       (goto-char (point-min))
1993       (if (search-forward "\n\n" nil t)
1994           (decode-mime-charset-region (match-end 0) (point-max) charset))
1995       )
1996     (mime-maybe-hide-echo-buffer)
1997     )
1998   (gnus-run-hooks 'gnus-mime-article-prepare-hook)
1999   )
2000
2001 (defun gnus-article-prepare (article &optional all-headers header)
2002   "Prepare ARTICLE in article mode buffer.
2003 ARTICLE should either be an article number or a Message-ID.
2004 If ARTICLE is an id, HEADER should be the article headers.
2005 If ALL-HEADERS is non-nil, no headers are hidden."
2006   (save-excursion
2007     ;; Make sure we start in a summary buffer.
2008     (unless (eq major-mode 'gnus-summary-mode)
2009       (set-buffer gnus-summary-buffer))
2010     (setq gnus-summary-buffer (current-buffer))
2011     (let* ((gnus-article (if header (mail-header-number header) article))
2012            (summary-buffer (current-buffer))
2013            (internal-hook gnus-article-internal-prepare-hook)
2014            (group gnus-newsgroup-name)
2015            result)
2016       (save-excursion
2017         (gnus-article-setup-buffer)
2018         (set-buffer gnus-original-article-buffer)
2019         ;; Deactivate active regions.
2020         (when (and (boundp 'transient-mark-mode)
2021                    transient-mark-mode)
2022           (setq mark-active nil))
2023         (if (not (setq result (let ((buffer-read-only nil))
2024                                 (gnus-request-article-this-buffer
2025                                  article group))))
2026             ;; There is no such article.
2027             (save-excursion
2028               (when (and (numberp article)
2029                          (not (memq article gnus-newsgroup-sparse)))
2030                 (setq gnus-article-current
2031                       (cons gnus-newsgroup-name article))
2032                 (set-buffer gnus-summary-buffer)
2033                 (setq gnus-current-article article)
2034                 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2035                     (progn
2036                       (gnus-summary-set-agent-mark article)
2037                       (message "Message marked for downloading"))
2038                   (gnus-summary-mark-article article gnus-canceled-mark)
2039                   (unless (memq article gnus-newsgroup-sparse)
2040                     (gnus-error 1 
2041                      "No such article (may have expired or been canceled)")))))
2042           (if (or (eq result 'pseudo) (eq result 'nneething))
2043               (progn
2044                 (save-excursion
2045                   (set-buffer summary-buffer)
2046                   (push article gnus-newsgroup-history)
2047                   (setq gnus-last-article gnus-current-article
2048                         gnus-current-article 0
2049                         gnus-current-headers nil
2050                         gnus-article-current nil)
2051                   (if (eq result 'nneething)
2052                       (gnus-configure-windows 'summary)
2053                     (gnus-configure-windows 'article))
2054                   (gnus-set-global-variables))
2055                 (gnus-set-mode-line 'article))
2056             ;; The result from the `request' was an actual article -
2057             ;; or at least some text that is now displayed in the
2058             ;; article buffer.
2059             (when (and (numberp article)
2060                        (not (eq article gnus-current-article)))
2061               ;; Seems like a new article has been selected.
2062               ;; `gnus-current-article' must be an article number.
2063               (save-excursion
2064                 (set-buffer summary-buffer)
2065                 (push article gnus-newsgroup-history)
2066                 (setq gnus-last-article gnus-current-article
2067                       gnus-current-article article
2068                       gnus-current-headers
2069                       (gnus-summary-article-header gnus-current-article)
2070                       gnus-article-current
2071                       (cons gnus-newsgroup-name gnus-current-article))
2072                 (unless (vectorp gnus-current-headers)
2073                   (setq gnus-current-headers nil))
2074                 (gnus-summary-goto-subject gnus-current-article)
2075                 (gnus-summary-show-thread)
2076                 (gnus-run-hooks 'gnus-mark-article-hook)
2077                 (gnus-set-mode-line 'summary)
2078                 (when (gnus-visual-p 'article-highlight 'highlight)
2079                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
2080                 ;; Set the global newsgroup variables here.
2081                 ;; Suggested by Jim Sisolak
2082                 ;; <sisolak@trans4.neep.wisc.edu>.
2083                 (gnus-set-global-variables)
2084                 (setq gnus-have-all-headers
2085                       (or all-headers gnus-show-all-headers))))
2086             (when (or (numberp article)
2087                       (stringp article))
2088               (let ((method
2089                      (if gnus-show-mime
2090                          (progn
2091                            (mime-parse-buffer)
2092                            (if (or (not gnus-strict-mime)
2093                                    (mime-fetch-field "MIME-Version"))
2094                                gnus-article-display-method-for-mime
2095                              gnus-article-display-method-for-encoded-word))
2096                        gnus-article-display-method-for-traditional)))
2097                 ;; Hooks for getting information from the article.
2098                 ;; This hook must be called before being narrowed.
2099                 (gnus-run-hooks 'internal-hook)
2100                 (gnus-run-hooks 'gnus-article-prepare-hook)
2101                 ;; Display message.
2102                 (funcall method)
2103                 ;; Associate this article with the current summary buffer.
2104                 (setq gnus-article-current-summary summary-buffer)
2105                 ;; Perform the article display hooks.
2106                 (gnus-run-hooks 'gnus-article-display-hook))
2107               ;; Do page break.
2108               (goto-char (point-min))
2109               (setq gnus-page-broken
2110                     (when gnus-break-pages
2111                       (gnus-narrow-to-page)
2112                       t)))
2113             (gnus-set-mode-line 'article)
2114             (gnus-configure-windows 'article)
2115             (goto-char (point-min))
2116             t))))))
2117
2118 (defun gnus-article-wash-status ()
2119   "Return a string which display status of article washing."
2120   (save-excursion
2121     (set-buffer gnus-article-buffer)
2122     (let ((cite (gnus-article-hidden-text-p 'cite))
2123           (headers (gnus-article-hidden-text-p 'headers))
2124           (boring (gnus-article-hidden-text-p 'boring-headers))
2125           (pgp (gnus-article-hidden-text-p 'pgp))
2126           (pem (gnus-article-hidden-text-p 'pem))
2127           (signature (gnus-article-hidden-text-p 'signature))
2128           (overstrike (gnus-article-hidden-text-p 'overstrike))
2129           (emphasis (gnus-article-hidden-text-p 'emphasis))
2130           (mime gnus-show-mime))
2131       (format "%c%c%c%c%c%c%c"
2132               (if cite ?c ? )
2133               (if (or headers boring) ?h ? )
2134               (if (or pgp pem) ?p ? )
2135               (if signature ?s ? )
2136               (if overstrike ?o ? )
2137               (if mime ?m ? )
2138               (if emphasis ?e ? )))))
2139
2140 (defun gnus-article-hide-headers-if-wanted ()
2141   "Hide unwanted headers if `gnus-have-all-headers' is nil.
2142 Provided for backwards compatibility."
2143   (or (save-excursion (set-buffer gnus-summary-buffer) gnus-have-all-headers)
2144       gnus-inhibit-hiding
2145       (gnus-article-hide-headers)))
2146
2147 ;;; Article savers.
2148
2149 (defun gnus-output-to-file (file-name)
2150   "Append the current article to a file named FILE-NAME."
2151   (let ((artbuf (current-buffer)))
2152     (nnheader-temp-write nil
2153       (insert-buffer-substring artbuf)
2154       ;; Append newline at end of the buffer as separator, and then
2155       ;; save it to file.
2156       (goto-char (point-max))
2157       (insert "\n")
2158       (append-to-file (point-min) (point-max) file-name)
2159       t)))
2160
2161 (defun gnus-narrow-to-page (&optional arg)
2162   "Narrow the article buffer to a page.
2163 If given a numerical ARG, move forward ARG pages."
2164   (interactive "P")
2165   (setq arg (if arg (prefix-numeric-value arg) 0))
2166   (save-excursion
2167     (set-buffer gnus-article-buffer)
2168     (goto-char (point-min))
2169     (widen)
2170     ;; Remove any old next/prev buttons.
2171     (when (gnus-visual-p 'page-marker)
2172       (let ((buffer-read-only nil))
2173         (gnus-remove-text-with-property 'gnus-prev)
2174         (gnus-remove-text-with-property 'gnus-next)))
2175     (when
2176         (cond ((< arg 0)
2177                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
2178               ((> arg 0)
2179                (re-search-forward page-delimiter nil 'move arg)))
2180       (goto-char (match-end 0)))
2181     (narrow-to-region
2182      (point)
2183      (if (re-search-forward page-delimiter nil 'move)
2184          (match-beginning 0)
2185        (point)))
2186     (when (and (gnus-visual-p 'page-marker)
2187                (not (= (point-min) 1)))
2188       (save-excursion
2189         (goto-char (point-min))
2190         (gnus-insert-prev-page-button)))
2191     (when (and (gnus-visual-p 'page-marker)
2192                (< (+ (point-max) 2) (buffer-size)))
2193       (save-excursion
2194         (goto-char (point-max))
2195         (gnus-insert-next-page-button)))))
2196
2197 ;; Article mode commands
2198
2199 (defun gnus-article-goto-next-page ()
2200   "Show the next page of the article."
2201   (interactive)
2202   (when (gnus-article-next-page)
2203     (goto-char (point-min))
2204     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
2205
2206 (defun gnus-article-goto-prev-page ()
2207   "Show the next page of the article."
2208   (interactive)
2209   (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
2210     (gnus-article-prev-page nil)))
2211
2212 (defun gnus-article-next-page (&optional lines)
2213   "Show the next page of the current article.
2214 If end of article, return non-nil.  Otherwise return nil.
2215 Argument LINES specifies lines to be scrolled up."
2216   (interactive "p")
2217   (move-to-window-line -1)
2218   (if (save-excursion
2219         (end-of-line)
2220         (and (pos-visible-in-window-p)  ;Not continuation line.
2221              (eobp)))
2222       ;; Nothing in this page.
2223       (if (or (not gnus-page-broken)
2224               (save-excursion
2225                 (save-restriction
2226                   (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
2227           t                             ;Nothing more.
2228         (gnus-narrow-to-page 1)         ;Go to next page.
2229         nil)
2230     ;; More in this page.
2231     (let ((scroll-in-place nil))
2232       (condition-case ()
2233           (scroll-up lines)
2234         (end-of-buffer
2235          ;; Long lines may cause an end-of-buffer error.
2236          (goto-char (point-max)))))
2237     (move-to-window-line 0)
2238     nil))
2239
2240 (defun gnus-article-prev-page (&optional lines)
2241   "Show previous page of current article.
2242 Argument LINES specifies lines to be scrolled down."
2243   (interactive "p")
2244   (move-to-window-line 0)
2245   (if (and gnus-page-broken
2246            (bobp)
2247            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
2248       (progn
2249         (gnus-narrow-to-page -1)        ;Go to previous page.
2250         (goto-char (point-max))
2251         (recenter -1))
2252     (let ((scroll-in-place nil))
2253       (prog1
2254           (condition-case ()
2255               (scroll-down lines)
2256             (beginning-of-buffer
2257              (goto-char (point-min))))
2258         (move-to-window-line 0)))))
2259
2260 (defun gnus-article-refer-article ()
2261   "Read article specified by message-id around point."
2262   (interactive)
2263   (let ((point (point)))
2264     (search-forward ">" nil t)          ;Move point to end of "<....>".
2265     (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
2266         (let ((message-id (match-string 1)))
2267           (goto-char point)
2268           (set-buffer gnus-summary-buffer)
2269           (gnus-summary-refer-article message-id))
2270       (goto-char (point))
2271       (error "No references around point"))))
2272
2273 (defun gnus-article-show-summary ()
2274   "Reconfigure windows to show summary buffer."
2275   (interactive)
2276   (if (not (gnus-buffer-live-p gnus-summary-buffer))
2277       (error "There is no summary buffer for this article buffer")
2278     (gnus-article-set-globals)
2279     (gnus-configure-windows 'article)
2280     (gnus-summary-goto-subject gnus-current-article)
2281     (gnus-summary-position-point)))
2282
2283 (defun gnus-article-describe-briefly ()
2284   "Describe article mode commands briefly."
2285   (interactive)
2286   (gnus-message 6
2287                 (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")))
2288
2289 (defun gnus-article-summary-command ()
2290   "Execute the last keystroke in the summary buffer."
2291   (interactive)
2292   (let ((obuf (current-buffer))
2293         (owin (current-window-configuration))
2294         func)
2295     (switch-to-buffer gnus-article-current-summary 'norecord)
2296     (setq func (lookup-key (current-local-map) (this-command-keys)))
2297     (call-interactively func)
2298     (set-buffer obuf)
2299     (set-window-configuration owin)
2300     (set-window-point (get-buffer-window (current-buffer)) (point))))
2301
2302 (defun gnus-article-summary-command-nosave ()
2303   "Execute the last keystroke in the summary buffer."
2304   (interactive)
2305   (let (func)
2306     (pop-to-buffer gnus-article-current-summary 'norecord)
2307     (setq func (lookup-key (current-local-map) (this-command-keys)))
2308     (call-interactively func)))
2309
2310 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
2311   "Read a summary buffer key sequence and execute it from the article buffer."
2312   (interactive "P")
2313   (let ((nosaves
2314          '("q" "Q"  "c" "r" "R" "\C-c\C-f" "m"  "a" "f" "F"
2315            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
2316            "=" "^" "\M-^" "|"))
2317         (nosave-but-article
2318          '("A\r"))
2319         (nosave-in-article
2320          '("\C-d"))
2321         (up-to-top
2322          '("n" "Gn" "p" "Gp"))
2323         keys new-sum-point)
2324     (save-excursion
2325       (set-buffer gnus-article-current-summary)
2326       (let (gnus-pick-mode)
2327         (push (or key last-command-event) unread-command-events)
2328         (setq keys (read-key-sequence nil))))
2329     (message "")
2330
2331     (if (or (member keys nosaves)
2332             (member keys nosave-but-article)
2333             (member keys nosave-in-article))
2334         (let (func)
2335           (save-window-excursion
2336             (pop-to-buffer gnus-article-current-summary 'norecord)
2337             ;; We disable the pick minor mode commands.
2338             (let (gnus-pick-mode)
2339               (setq func (lookup-key (current-local-map) keys))))
2340           (if (not func)
2341               (ding)
2342             (unless (member keys nosave-in-article)
2343               (set-buffer gnus-article-current-summary))
2344             (call-interactively func)
2345             (setq new-sum-point (point)))
2346           (when (member keys nosave-but-article)
2347             (pop-to-buffer gnus-article-buffer 'norecord)))
2348       ;; These commands should restore window configuration.
2349       (let ((obuf (current-buffer))
2350             (owin (current-window-configuration))
2351             (opoint (point))
2352             (summary gnus-article-current-summary)
2353             func in-buffer selected)
2354         (if not-restore-window
2355             (pop-to-buffer summary 'norecord)
2356           (switch-to-buffer summary 'norecord))
2357         (setq in-buffer (current-buffer))
2358         ;; We disable the pick minor mode commands.
2359         (if (setq func (let (gnus-pick-mode)
2360                          (lookup-key (current-local-map) keys)))
2361             (progn
2362               (call-interactively func)
2363               (setq new-sum-point (point)))
2364           (ding))
2365         (when (eq in-buffer (current-buffer))
2366           (setq selected (gnus-summary-select-article))
2367           (set-buffer obuf)
2368           (unless not-restore-window
2369             (set-window-configuration owin))
2370           (unless (or (not (eq selected 'old)) (member keys up-to-top))
2371             (set-window-point (get-buffer-window (current-buffer))
2372                               opoint))
2373           (let ((win (get-buffer-window gnus-article-current-summary)))
2374             (when win
2375               (set-window-point win new-sum-point))))))))
2376
2377 (defun gnus-article-hide (&optional arg force)
2378   "Hide all the gruft in the current article.
2379 This means that PGP stuff, signatures, cited text and (some)
2380 headers will be hidden.
2381 If given a prefix, show the hidden text instead."
2382   (interactive (append (gnus-article-hidden-arg) (list 'force)))
2383   (gnus-article-hide-headers arg)
2384   (gnus-article-hide-pgp arg)
2385   (gnus-article-hide-citation-maybe arg force)
2386   (gnus-article-hide-signature arg))
2387
2388 (defun gnus-article-maybe-highlight ()
2389   "Do some article highlighting if `article-visual' is non-nil."
2390   (when (gnus-visual-p 'article-highlight 'highlight)
2391     (gnus-article-highlight-some)))
2392
2393 (defun gnus-check-group-server ()
2394   ;; Make sure the connection to the server is alive.
2395   (unless (gnus-server-opened
2396            (gnus-find-method-for-group gnus-newsgroup-name))
2397     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
2398     (gnus-request-group gnus-newsgroup-name t)))
2399
2400 (defun gnus-request-article-this-buffer (article group)
2401   "Get an article and insert it into this buffer."
2402   (let (do-update-line)
2403     (prog1
2404         (save-excursion
2405           (erase-buffer)
2406           (gnus-kill-all-overlays)
2407           (setq group (or group gnus-newsgroup-name))
2408
2409           ;; Using `gnus-request-article' directly will insert the article into
2410           ;; `nntp-server-buffer' - so we'll save some time by not having to
2411           ;; copy it from the server buffer into the article buffer.
2412
2413           ;; We only request an article by message-id when we do not have the
2414           ;; headers for it, so we'll have to get those.
2415           (when (stringp article)
2416             (let ((gnus-override-method gnus-refer-article-method))
2417               (gnus-read-header article)))
2418
2419           ;; If the article number is negative, that means that this article
2420           ;; doesn't belong in this newsgroup (possibly), so we find its
2421           ;; message-id and request it by id instead of number.
2422           (when (and (numberp article)
2423                      gnus-summary-buffer
2424                      (get-buffer gnus-summary-buffer)
2425                      (gnus-buffer-exists-p gnus-summary-buffer))
2426             (save-excursion
2427               (set-buffer gnus-summary-buffer)
2428               (let ((header (gnus-summary-article-header article)))
2429                 (when (< article 0)
2430                   (cond
2431                    ((memq article gnus-newsgroup-sparse)
2432                     ;; This is a sparse gap article.
2433                     (setq do-update-line article)
2434                     (setq article (mail-header-id header))
2435                     (let ((gnus-override-method gnus-refer-article-method))
2436                       (gnus-read-header article))
2437                     (setq gnus-newsgroup-sparse
2438                           (delq article gnus-newsgroup-sparse)))
2439                    ((vectorp header)
2440                     ;; It's a real article.
2441                     (setq article (mail-header-id header)))
2442                    (t
2443                     ;; It is an extracted pseudo-article.
2444                     (setq article 'pseudo)
2445                     (gnus-request-pseudo-article header))))
2446
2447                 (let ((method (gnus-find-method-for-group
2448                                gnus-newsgroup-name)))
2449                   (when (and (eq (car method) 'nneething)
2450                              (vectorp header))
2451                     (let ((dir (concat (file-name-as-directory (nth 1 method))
2452                                        (mail-header-subject header))))
2453                       (when (file-directory-p dir)
2454                         (setq article 'nneething)
2455                         (gnus-group-enter-directory dir))))))))
2456
2457           (cond
2458            ;; Refuse to select canceled articles.
2459            ((and (numberp article)
2460                  gnus-summary-buffer
2461                  (get-buffer gnus-summary-buffer)
2462                  (gnus-buffer-exists-p gnus-summary-buffer)
2463                  (eq (cdr (save-excursion
2464                             (set-buffer gnus-summary-buffer)
2465                             (assq article gnus-newsgroup-reads)))
2466                      gnus-canceled-mark))
2467             nil)
2468            ;; Check the backlog.
2469            ((and gnus-keep-backlog
2470                  (gnus-backlog-request-article group article (current-buffer)))
2471             'article)
2472            ;; Check asynchronous pre-fetch.
2473            ((gnus-async-request-fetched-article group article (current-buffer))
2474             (gnus-async-prefetch-next group article gnus-summary-buffer)
2475             (when (and (numberp article) gnus-keep-backlog)
2476               (gnus-backlog-enter-article group article (current-buffer)))
2477             'article)
2478            ;; Check the cache.
2479            ((and gnus-use-cache
2480                  (numberp article)
2481                  (gnus-cache-request-article article group))
2482             'article)
2483            ;; Get the article and put into the article buffer.
2484            ((or (stringp article) (numberp article))
2485             (let ((gnus-override-method
2486                    (and (stringp article) gnus-refer-article-method))
2487                   (buffer-read-only nil))
2488               (erase-buffer)
2489               (gnus-kill-all-overlays)
2490               (gnus-check-group-server)
2491               (when (gnus-request-article article group (current-buffer))
2492                 (when (numberp article)
2493                   (gnus-async-prefetch-next group article gnus-summary-buffer)
2494                   (when gnus-keep-backlog
2495                     (gnus-backlog-enter-article
2496                      group article (current-buffer))))
2497                 'article)))
2498            ;; It was a pseudo.
2499            (t article)))
2500
2501       ;; Update sparse articles.
2502       (when (and do-update-line
2503                  (or (numberp article)
2504                      (stringp article)))
2505         (let ((buf (current-buffer)))
2506           (set-buffer gnus-summary-buffer)
2507           (gnus-summary-update-article do-update-line)
2508           (gnus-summary-goto-subject do-update-line nil t)
2509           (set-window-point (get-buffer-window (current-buffer) t)
2510                             (point))
2511           (set-buffer buf))))))
2512
2513 ;;;
2514 ;;; Article editing
2515 ;;;
2516
2517 (defcustom gnus-article-edit-mode-hook nil
2518   "Hook run in article edit mode buffers."
2519   :group 'gnus-article-various
2520   :type 'hook)
2521
2522 (defvar gnus-article-edit-done-function nil)
2523
2524 (defvar gnus-article-edit-mode-map nil)
2525
2526 (unless gnus-article-edit-mode-map
2527   (setq gnus-article-edit-mode-map (copy-keymap text-mode-map))
2528
2529   (gnus-define-keys gnus-article-edit-mode-map
2530     "\C-c\C-c" gnus-article-edit-done
2531     "\C-c\C-k" gnus-article-edit-exit)
2532
2533   (gnus-define-keys (gnus-article-edit-wash-map
2534                      "\C-c\C-w" gnus-article-edit-mode-map)
2535     "f" gnus-article-edit-full-stops))
2536
2537 (defun gnus-article-edit-mode ()
2538   "Major mode for editing articles.
2539 This is an extended text-mode.
2540
2541 \\{gnus-article-edit-mode-map}"
2542   (interactive)
2543   (setq major-mode 'gnus-article-edit-mode)
2544   (setq mode-name "Article Edit")
2545   (use-local-map gnus-article-edit-mode-map)
2546   (make-local-variable 'gnus-article-edit-done-function)
2547   (make-local-variable 'gnus-prev-winconf)
2548   (setq buffer-read-only nil)
2549   (buffer-enable-undo)
2550   (widen)
2551   (gnus-run-hooks 'text-mode-hook 'gnus-article-edit-mode-hook))
2552
2553 (defun gnus-article-edit (&optional force)
2554   "Edit the current article.
2555 This will have permanent effect only in mail groups.
2556 If FORCE is non-nil, allow editing of articles even in read-only
2557 groups."
2558   (interactive "P")
2559   (when (and (not force)
2560              (gnus-group-read-only-p))
2561     (error "The current newsgroup does not support article editing"))
2562   (gnus-article-date-original)
2563   (gnus-article-edit-article
2564    `(lambda (no-highlight)
2565       (gnus-summary-edit-article-done
2566        ,(or (mail-header-references gnus-current-headers) "")
2567        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
2568
2569 (defun gnus-article-edit-article (exit-func)
2570   "Start editing the contents of the current article buffer."
2571   (let ((winconf (current-window-configuration)))
2572     (set-buffer gnus-article-buffer)
2573     (gnus-article-edit-mode)
2574     (gnus-set-text-properties (point-min) (point-max) nil)
2575     (gnus-configure-windows 'edit-article)
2576     (setq gnus-article-edit-done-function exit-func)
2577     (setq gnus-prev-winconf winconf)
2578     (gnus-message 6 "C-c C-c to end edits")))
2579
2580 (defun gnus-article-edit-done (&optional arg)
2581   "Update the article edits and exit."
2582   (interactive "P")
2583   (save-excursion
2584     (save-restriction
2585       (widen)
2586       (goto-char (point-min))
2587       (when (search-forward "\n\n" nil 1)
2588         (let ((lines (count-lines (point) (point-max)))
2589               (length (- (point-max) (point)))
2590               (case-fold-search t)
2591               (body (copy-marker (point))))
2592           (goto-char (point-min))
2593           (when (re-search-forward "^content-length:[ \t]\\([0-9]+\\)" body t)
2594             (delete-region (match-beginning 1) (match-end 1))
2595             (insert (number-to-string length)))
2596           (goto-char (point-min))
2597           (when (re-search-forward
2598                  "^x-content-length:[ \t]\\([0-9]+\\)" body t)
2599             (delete-region (match-beginning 1) (match-end 1))
2600             (insert (number-to-string length)))
2601           (goto-char (point-min))
2602           (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
2603             (delete-region (match-beginning 1) (match-end 1))
2604             (insert (number-to-string lines)))))))
2605   (let ((func gnus-article-edit-done-function)
2606         (buf (current-buffer))
2607         (start (window-start)))
2608     (gnus-article-edit-exit)
2609     (save-excursion
2610       (set-buffer buf)
2611       (let ((buffer-read-only nil))
2612         (funcall func arg)))
2613     (set-buffer buf)
2614     (set-window-start (get-buffer-window buf) start)
2615     (set-window-point (get-buffer-window buf) (point))))
2616
2617 (defun gnus-article-edit-exit ()
2618   "Exit the article editing without updating."
2619   (interactive)
2620   ;; We remove all text props from the article buffer.
2621   (let ((buf (format "%s" (buffer-string)))
2622         (curbuf (current-buffer))
2623         (p (point))
2624         (window-start (window-start)))
2625     (erase-buffer)
2626     (insert buf)
2627     (let ((winconf gnus-prev-winconf))
2628       (gnus-article-mode)
2629       ;; The cache and backlog have to be flushed somewhat.
2630       (when gnus-use-cache
2631         (gnus-cache-update-article
2632          (car gnus-article-current) (cdr gnus-article-current)))
2633       (when gnus-keep-backlog
2634         (gnus-backlog-remove-article
2635          (car gnus-article-current) (cdr gnus-article-current)))
2636       ;; Flush original article as well.
2637       (save-excursion
2638         (when (get-buffer gnus-original-article-buffer)
2639           (set-buffer gnus-original-article-buffer)
2640           (setq gnus-original-article nil)))
2641       (set-window-configuration winconf)
2642       ;; Tippy-toe some to make sure that point remains where it was.
2643       (let ((buf (current-buffer)))
2644         (set-buffer curbuf)
2645         (set-window-start (get-buffer-window (current-buffer)) window-start)
2646         (goto-char p)
2647         (set-buffer buf)))))
2648
2649 (defun gnus-article-edit-full-stops ()
2650   "Interactively repair spacing at end of sentences."
2651   (interactive)
2652   (save-excursion
2653     (goto-char (point-min))
2654     (search-forward-regexp "^$" nil t)
2655     (let ((case-fold-search nil))
2656       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
2657
2658 ;;;
2659 ;;; Article highlights
2660 ;;;
2661
2662 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
2663
2664 ;;; Internal Variables:
2665
2666 (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\\)"
2667   "Regular expression that matches URLs."
2668   :group 'gnus-article-buttons
2669   :type 'regexp)
2670
2671 (defcustom gnus-button-alist
2672   `(("<\\(url:[>\n\t ]*?\\)?news:[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>" 0 t
2673      gnus-button-message-id 2)
2674     ("\\bnews:\\([^>\n\t ]*@[^>\n\t ]*\\)" 0 t gnus-button-message-id 1)
2675     ("\\(\\b<\\(url:[>\n\t ]*\\)?news:[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
2676      1 t
2677      gnus-button-fetch-group 4)
2678     ("\\bnews:\\(//\\)?\\([^'\">\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
2679     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
2680      t gnus-button-message-id 3)
2681     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 2)
2682     ("mailto:\\([a-zA-Z.-@_+0-9%]+\\)" 0 t gnus-url-mailto 1)
2683     ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 1)
2684     ;; This is how URLs _should_ be embedded in text...
2685     ("<URL: *\\([^>]*\\)>" 0 t gnus-button-embedded-url 1)
2686     ;; Raw URLs.
2687     (,gnus-button-url-regexp 0 t gnus-button-url 0))
2688   "*Alist of regexps matching buttons in article bodies.
2689
2690 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
2691 REGEXP: is the string matching text around the button,
2692 BUTTON: is the number of the regexp grouping actually matching the button,
2693 FORM: is a lisp expression which must eval to true for the button to
2694 be added,
2695 CALLBACK: is the function to call when the user push this button, and each
2696 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
2697
2698 CALLBACK can also be a variable, in that case the value of that
2699 variable it the real callback function."
2700   :group 'gnus-article-buttons
2701   :type '(repeat (list regexp
2702                        (integer :tag "Button")
2703                        (sexp :tag "Form")
2704                        (function :tag "Callback")
2705                        (repeat :tag "Par"
2706                                :inline t
2707                                (integer :tag "Regexp group")))))
2708
2709 (defcustom gnus-header-button-alist
2710   `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
2711      0 t gnus-button-message-id 0)
2712     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
2713     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
2714      0 t gnus-button-mailto 0)
2715     ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2716     ("^Subject:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2717     ("^[^:]+:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2718     ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
2719      gnus-button-message-id 3))
2720   "*Alist of headers and regexps to match buttons in article heads.
2721
2722 This alist is very similar to `gnus-button-alist', except that each
2723 alist has an additional HEADER element first in each entry:
2724
2725 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
2726
2727 HEADER is a regexp to match a header.  For a fuller explanation, see
2728 `gnus-button-alist'."
2729   :group 'gnus-article-buttons
2730   :group 'gnus-article-headers
2731   :type '(repeat (list (regexp :tag "Header")
2732                        regexp
2733                        (integer :tag "Button")
2734                        (sexp :tag "Form")
2735                        (function :tag "Callback")
2736                        (repeat :tag "Par"
2737                                :inline t
2738                                (integer :tag "Regexp group")))))
2739
2740 (defvar gnus-button-regexp nil)
2741 (defvar gnus-button-marker-list nil)
2742 ;; Regexp matching any of the regexps from `gnus-button-alist'.
2743
2744 (defvar gnus-button-last nil)
2745 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
2746
2747 ;;; Commands:
2748
2749 (defun gnus-article-push-button (event)
2750   "Check text under the mouse pointer for a callback function.
2751 If the text under the mouse pointer has a `gnus-callback' property,
2752 call it with the value of the `gnus-data' text property."
2753   (interactive "e")
2754   (set-buffer (window-buffer (posn-window (event-start event))))
2755   (let* ((pos (posn-point (event-start event)))
2756          (data (get-text-property pos 'gnus-data))
2757          (fun (get-text-property pos 'gnus-callback)))
2758     (when fun
2759       (funcall fun data))))
2760
2761 (defun gnus-article-press-button ()
2762   "Check text at point for a callback function.
2763 If the text at point has a `gnus-callback' property,
2764 call it with the value of the `gnus-data' text property."
2765   (interactive)
2766   (let* ((data (get-text-property (point) 'gnus-data))
2767          (fun (get-text-property (point) 'gnus-callback)))
2768     (when fun
2769       (funcall fun data))))
2770
2771 (defun gnus-article-prev-button (n)
2772   "Move point to N buttons backward.
2773 If N is negative, move forward instead."
2774   (interactive "p")
2775   (gnus-article-next-button (- n)))
2776
2777 (defun gnus-article-next-button (n)
2778   "Move point to N buttons forward.
2779 If N is negative, move backward instead."
2780   (interactive "p")
2781   (let ((function (if (< n 0) 'previous-single-property-change
2782                     'next-single-property-change))
2783         (inhibit-point-motion-hooks t)
2784         (backward (< n 0))
2785         (limit (if (< n 0) (point-min) (point-max))))
2786     (setq n (abs n))
2787     (while (and (not (= limit (point)))
2788                 (> n 0))
2789       ;; Skip past the current button.
2790       (when (get-text-property (point) 'gnus-callback)
2791         (goto-char (funcall function (point) 'gnus-callback nil limit)))
2792       ;; Go to the next (or previous) button.
2793       (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
2794       ;; Put point at the start of the button.
2795       (when (and backward (not (get-text-property (point) 'gnus-callback)))
2796         (goto-char (funcall function (point) 'gnus-callback nil limit)))
2797       ;; Skip past intangible buttons.
2798       (when (get-text-property (point) 'intangible)
2799         (incf n))
2800       (decf n))
2801     (unless (zerop n)
2802       (gnus-message 5 "No more buttons"))
2803     n))
2804
2805 (defun gnus-article-highlight (&optional force)
2806   "Highlight current article.
2807 This function calls `gnus-article-highlight-headers',
2808 `gnus-article-highlight-citation',
2809 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2810 do the highlighting.  See the documentation for those functions."
2811   (interactive (list 'force))
2812   (gnus-article-highlight-headers)
2813   (gnus-article-highlight-citation force)
2814   (gnus-article-highlight-signature)
2815   (gnus-article-add-buttons force)
2816   (gnus-article-add-buttons-to-head))
2817
2818 (defun gnus-article-highlight-some (&optional force)
2819   "Highlight current article.
2820 This function calls `gnus-article-highlight-headers',
2821 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2822 do the highlighting.  See the documentation for those functions."
2823   (interactive (list 'force))
2824   (gnus-article-highlight-headers)
2825   (gnus-article-highlight-signature)
2826   (gnus-article-add-buttons))
2827
2828 (defun gnus-article-highlight-headers ()
2829   "Highlight article headers as specified by `gnus-header-face-alist'."
2830   (interactive)
2831   (save-excursion
2832     (set-buffer gnus-article-buffer)
2833     (save-restriction
2834       (let ((alist gnus-header-face-alist)
2835             (buffer-read-only nil)
2836             (case-fold-search t)
2837             (inhibit-point-motion-hooks t)
2838             entry regexp header-face field-face from hpoints fpoints)
2839         (message-narrow-to-head)
2840         (while (setq entry (pop alist))
2841           (goto-char (point-min))
2842           (setq regexp (concat "^\\("
2843                                (if (string-equal "" (nth 0 entry))
2844                                    "[^\t ]"
2845                                  (nth 0 entry))
2846                                "\\)")
2847                 header-face (nth 1 entry)
2848                 field-face (nth 2 entry))
2849           (while (and (re-search-forward regexp nil t)
2850                       (not (eobp)))
2851             (beginning-of-line)
2852             (setq from (point))
2853             (unless (search-forward ":" nil t)
2854               (forward-char 1))
2855             (when (and header-face
2856                        (not (memq (point) hpoints)))
2857               (push (point) hpoints)
2858               (gnus-put-text-property from (point) 'face header-face))
2859             (when (and field-face
2860                        (not (memq (setq from (point)) fpoints)))
2861               (push from fpoints)
2862               (if (re-search-forward "^[^ \t]" nil t)
2863                   (forward-char -2)
2864                 (goto-char (point-max)))
2865               (gnus-put-text-property from (point) 'face field-face))))))))
2866
2867 (defun gnus-article-highlight-signature ()
2868   "Highlight the signature in an article.
2869 It does this by highlighting everything after
2870 `gnus-signature-separator' using `gnus-signature-face'."
2871   (interactive)
2872   (save-excursion
2873     (set-buffer gnus-article-buffer)
2874     (let ((buffer-read-only nil)
2875           (inhibit-point-motion-hooks t))
2876       (save-restriction
2877         (when (and gnus-signature-face
2878                    (gnus-article-narrow-to-signature))
2879           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
2880                             'face gnus-signature-face)
2881           (widen)
2882           (gnus-article-search-signature)
2883           (let ((start (match-beginning 0))
2884                 (end (set-marker (make-marker) (1+ (match-end 0)))))
2885             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
2886                                      end)))))))
2887
2888 (defun gnus-button-in-region-p (b e prop)
2889   "Say whether PROP exists in the region."
2890   (text-property-not-all b e prop nil))
2891
2892 (defun gnus-article-add-buttons (&optional force)
2893   "Find external references in the article and make buttons of them.
2894 \"External references\" are things like Message-IDs and URLs, as
2895 specified by `gnus-button-alist'."
2896   (interactive (list 'force))
2897   (save-excursion
2898     (set-buffer gnus-article-buffer)
2899     (let ((buffer-read-only nil)
2900           (inhibit-point-motion-hooks t)
2901           (case-fold-search t)
2902           (alist gnus-button-alist)
2903           beg entry regexp)
2904       ;; Remove all old markers.
2905       (let (marker entry)
2906         (while (setq marker (pop gnus-button-marker-list))
2907           (goto-char marker)
2908           (when (setq entry (gnus-button-entry))
2909             (put-text-property (match-beginning (nth 1 entry))
2910                                (match-end (nth 1 entry))
2911                                'gnus-callback nil))
2912           (set-marker marker nil)))
2913       ;; We skip the headers.
2914       (goto-char (point-min))
2915       (unless (search-forward "\n\n" nil t)
2916         (goto-char (point-max)))
2917       (setq beg (point))
2918       (while (setq entry (pop alist))
2919         (setq regexp (car entry))
2920         (goto-char beg)
2921         (while (re-search-forward regexp nil t)
2922           (let* ((start (and entry (match-beginning (nth 1 entry))))
2923                  (end (and entry (match-end (nth 1 entry))))
2924                  (from (match-beginning 0)))
2925             (when (and (or (eq t (nth 2 entry))
2926                            (eval (nth 2 entry)))
2927                        (not (gnus-button-in-region-p
2928                              start end 'gnus-callback)))
2929               ;; That optional form returned non-nil, so we add the
2930               ;; button.
2931               (gnus-article-add-button
2932                start end 'gnus-button-push
2933                (car (push (set-marker (make-marker) from)
2934                           gnus-button-marker-list))))))))))
2935
2936 ;; Add buttons to the head of an article.
2937 (defun gnus-article-add-buttons-to-head ()
2938   "Add buttons to the head of the article."
2939   (interactive)
2940   (save-excursion
2941     (set-buffer gnus-article-buffer)
2942     (let ((buffer-read-only nil)
2943           (inhibit-point-motion-hooks t)
2944           (case-fold-search t)
2945           (alist gnus-header-button-alist)
2946           entry beg end)
2947       (nnheader-narrow-to-headers)
2948       (while alist
2949         ;; Each alist entry.
2950         (setq entry (car alist)
2951               alist (cdr alist))
2952         (goto-char (point-min))
2953         (while (re-search-forward (car entry) nil t)
2954           ;; Each header matching the entry.
2955           (setq beg (match-beginning 0))
2956           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
2957                              (match-beginning 0))
2958                         (point-max)))
2959           (goto-char beg)
2960           (while (re-search-forward (nth 1 entry) end t)
2961             ;; Each match within a header.
2962             (let* ((entry (cdr entry))
2963                    (start (match-beginning (nth 1 entry)))
2964                    (end (match-end (nth 1 entry)))
2965                    (form (nth 2 entry)))
2966               (goto-char (match-end 0))
2967               (when (eval form)
2968                 (gnus-article-add-button
2969                  start end (nth 3 entry)
2970                  (buffer-substring (match-beginning (nth 4 entry))
2971                                    (match-end (nth 4 entry)))))))
2972           (goto-char end))))
2973     (widen)))
2974
2975 ;;; External functions:
2976
2977 (defun gnus-article-add-button (from to fun &optional data)
2978   "Create a button between FROM and TO with callback FUN and data DATA."
2979   (when gnus-article-button-face
2980     (gnus-overlay-put (gnus-make-overlay from to)
2981                       'face gnus-article-button-face))
2982   (gnus-add-text-properties
2983    from to
2984    (nconc (and gnus-article-mouse-face
2985                (list gnus-mouse-face-prop gnus-article-mouse-face))
2986           (list 'gnus-callback fun)
2987           (and data (list 'gnus-data data)))))
2988
2989 ;;; Internal functions:
2990
2991 (defun gnus-article-set-globals ()
2992   (save-excursion
2993     (set-buffer gnus-summary-buffer)
2994     (gnus-set-global-variables)))
2995
2996 (defun gnus-signature-toggle (end)
2997   (save-excursion
2998     (set-buffer gnus-article-buffer)
2999     (let ((buffer-read-only nil)
3000           (inhibit-point-motion-hooks t))
3001       (if (get-text-property end 'invisible)
3002           (gnus-article-unhide-text end (point-max))
3003         (gnus-article-hide-text end (point-max) gnus-hidden-properties)))))
3004
3005 (defun gnus-button-entry ()
3006   ;; Return the first entry in `gnus-button-alist' matching this place.
3007   (let ((alist gnus-button-alist)
3008         (entry nil))
3009     (while alist
3010       (setq entry (pop alist))
3011       (if (looking-at (car entry))
3012           (setq alist nil)
3013         (setq entry nil)))
3014     entry))
3015
3016 (defun gnus-button-push (marker)
3017   ;; Push button starting at MARKER.
3018   (save-excursion
3019     (set-buffer gnus-article-buffer)
3020     (goto-char marker)
3021     (let* ((entry (gnus-button-entry))
3022            (inhibit-point-motion-hooks t)
3023            (fun (nth 3 entry))
3024            (args (mapcar (lambda (group)
3025                            (let ((string (match-string group)))
3026                              (gnus-set-text-properties
3027                               0 (length string) nil string)
3028                              string))
3029                          (nthcdr 4 entry))))
3030       (cond
3031        ((fboundp fun)
3032         (apply fun args))
3033        ((and (boundp fun)
3034              (fboundp (symbol-value fun)))
3035         (apply (symbol-value fun) args))
3036        (t
3037         (gnus-message 1 "You must define `%S' to use this button"
3038                       (cons fun args)))))))
3039
3040 (defun gnus-button-message-id (message-id)
3041   "Fetch MESSAGE-ID."
3042   (save-excursion
3043     (set-buffer gnus-summary-buffer)
3044     (gnus-summary-refer-article message-id)))
3045
3046 (defun gnus-button-fetch-group (address)
3047   "Fetch GROUP specified by ADDRESS."
3048   (if (not (string-match "[:/]" address))
3049       ;; This is just a simple group url.
3050       (gnus-group-read-ephemeral-group address gnus-select-method)
3051     (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)/\\)?\\(.*\\)$"
3052                            address))
3053         (error "Can't parse %s" address)
3054       (gnus-group-read-ephemeral-group
3055        (match-string 4 address)
3056        `(nntp ,(match-string 1 address)
3057               (nntp-address ,(match-string 1 address))
3058               (nntp-port-number ,(if (match-end 3)
3059                                      (match-string 3 address)
3060                                    "nntp")))))))
3061
3062 (defun gnus-url-parse-query-string (query &optional downcase)
3063   (let (retval pairs cur key val)
3064     (setq pairs (gnus-split-string query "&"))
3065     (while pairs
3066       (setq cur (car pairs)
3067             pairs (cdr pairs))
3068       (if (not (string-match "=" cur))
3069           nil                           ; Grace
3070         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
3071               val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
3072         (if downcase
3073             (setq key (downcase key)))
3074         (setq cur (assoc key retval))
3075         (if cur
3076             (setcdr cur (cons val (cdr cur)))
3077           (setq retval (cons (list key val) retval)))))
3078     retval))
3079
3080 (defun gnus-url-unhex (x)
3081   (if (> x ?9)
3082       (if (>= x ?a)
3083           (+ 10 (- x ?a))
3084         (+ 10 (- x ?A)))
3085     (- x ?0)))
3086
3087 (defun gnus-url-unhex-string (str &optional allow-newlines)
3088   "Remove %XXX embedded spaces, etc in a url.
3089 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
3090 decoding of carriage returns and line feeds in the string, which is normally
3091 forbidden in URL encoding."
3092   (setq str (or str ""))
3093   (let ((tmp "")
3094         (case-fold-search t))
3095     (while (string-match "%[0-9a-f][0-9a-f]" str)
3096       (let* ((start (match-beginning 0))
3097              (ch1 (gnus-url-unhex (elt str (+ start 1))))
3098              (code (+ (* 16 ch1)
3099                       (gnus-url-unhex (elt str (+ start 2))))))
3100         (setq tmp (concat
3101                    tmp (substring str 0 start)
3102                    (cond
3103                     (allow-newlines
3104                      (char-to-string code))
3105                     ((or (= code ?\n) (= code ?\r))
3106                      " ")
3107                     (t (char-to-string code))))
3108               str (substring str (match-end 0)))))
3109     (setq tmp (concat tmp str))
3110     tmp))
3111
3112 (defun gnus-url-mailto (url)
3113   ;; Send mail to someone
3114   (when (string-match "mailto:/*\\(.*\\)" url)
3115     (setq url (substring url (match-beginning 1) nil)))
3116   (let (to args source-url subject func)
3117     (if (string-match (regexp-quote "?") url)
3118         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
3119               args (gnus-url-parse-query-string
3120                     (substring url (match-end 0) nil) t))
3121       (setq to (gnus-url-unhex-string url)))
3122     (setq args (cons (list "to" to) args)
3123           subject (cdr-safe (assoc "subject" args)))
3124     (message-mail)
3125     (while args
3126       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
3127       (if (fboundp func)
3128           (funcall func)
3129         (message-position-on-field (caar args)))
3130       (insert (mapconcat 'identity (cdar args) ", "))
3131       (setq args (cdr args)))
3132     (if subject
3133         (message-goto-body)
3134       (message-goto-subject))))
3135
3136 (defun gnus-button-mailto (address)
3137   ;; Mail to ADDRESS.
3138   (set-buffer (gnus-copy-article-buffer))
3139   (message-reply address))
3140
3141 (defun gnus-button-reply (address)
3142   ;; Reply to ADDRESS.
3143   (message-reply address))
3144
3145 (defun gnus-button-url (address)
3146   "Browse ADDRESS."
3147   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
3148   (if (listp browse-url-browser-function)
3149       (browse-url address)
3150     (funcall browse-url-browser-function address)))
3151
3152 (defun gnus-button-embedded-url (address)
3153   "Browse ADDRESS."
3154   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
3155   (if (listp browse-url-browser-function)
3156       (browse-url (gnus-strip-whitespace address))
3157     (funcall browse-url-browser-function (gnus-strip-whitespace address))))
3158
3159 ;;; Next/prev buttons in the article buffer.
3160
3161 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
3162 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
3163
3164 (defvar gnus-prev-page-map nil)
3165 (unless gnus-prev-page-map
3166   (setq gnus-prev-page-map (make-sparse-keymap))
3167   (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
3168   (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
3169
3170 (defun gnus-insert-prev-page-button ()
3171   (let ((buffer-read-only nil))
3172     (gnus-eval-format
3173      gnus-prev-page-line-format nil
3174      `(gnus-prev t local-map ,gnus-prev-page-map
3175                  gnus-callback gnus-article-button-prev-page))))
3176
3177 (defvar gnus-next-page-map nil)
3178 (unless gnus-next-page-map
3179   (setq gnus-next-page-map (make-keymap))
3180   (suppress-keymap gnus-prev-page-map)
3181   (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
3182   (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
3183
3184 (defun gnus-button-next-page ()
3185   "Go to the next page."
3186   (interactive)
3187   (let ((win (selected-window)))
3188     (select-window (get-buffer-window gnus-article-buffer t))
3189     (gnus-article-next-page)
3190     (select-window win)))
3191
3192 (defun gnus-button-prev-page ()
3193   "Go to the prev page."
3194   (interactive)
3195   (let ((win (selected-window)))
3196     (select-window (get-buffer-window gnus-article-buffer t))
3197     (gnus-article-prev-page)
3198     (select-window win)))
3199
3200 (defun gnus-insert-next-page-button ()
3201   (let ((buffer-read-only nil))
3202     (gnus-eval-format gnus-next-page-line-format nil
3203                       `(gnus-next t local-map ,gnus-next-page-map
3204                                   gnus-callback
3205                                   gnus-article-button-next-page))))
3206
3207 (defun gnus-article-button-next-page (arg)
3208   "Go to the next page."
3209   (interactive "P")
3210   (let ((win (selected-window)))
3211     (select-window (get-buffer-window gnus-article-buffer t))
3212     (gnus-article-next-page)
3213     (select-window win)))
3214
3215 (defun gnus-article-button-prev-page (arg)
3216   "Go to the prev page."
3217   (interactive "P")
3218   (let ((win (selected-window)))
3219     (select-window (get-buffer-window gnus-article-buffer t))
3220     (gnus-article-prev-page)
3221     (select-window win)))
3222
3223
3224 ;;; @ for mime-view
3225 ;;;
3226
3227 (defun gnus-article-header-presentation-method (entity situation)
3228   (mime-insert-decoded-header entity nil nil default-mime-charset)
3229   )
3230
3231 (set-alist 'mime-header-presentation-method-alist
3232            'gnus-original-article-mode
3233            #'gnus-article-header-presentation-method)
3234
3235 (defun gnus-mime-preview-quitting-method ()
3236   (if gnus-show-mime
3237       (gnus-article-show-summary)
3238     (mime-preview-kill-buffer)
3239     (delete-other-windows)
3240     (gnus-article-show-summary)
3241     (gnus-summary-select-article nil t)
3242     ))
3243
3244 (set-alist 'mime-raw-representation-type-alist
3245            'gnus-original-article-mode 'binary)
3246
3247 (set-alist 'mime-preview-quitting-method-alist
3248            'gnus-original-article-mode #'gnus-mime-preview-quitting-method)
3249
3250 (defun gnus-following-method (buf)
3251   (set-buffer buf)
3252   (message-followup)
3253   (message-yank-original)
3254   (kill-buffer buf)
3255   (goto-char (point-min))
3256   )
3257
3258 (set-alist 'mime-preview-following-method-alist
3259            'gnus-original-article-mode #'gnus-following-method)
3260
3261
3262 ;;; @ end
3263 ;;;
3264
3265 (gnus-ems-redefine)
3266
3267 (provide 'gnus-art)
3268
3269 (run-hooks 'gnus-art-load-hook)
3270
3271 ;;; gnus-art.el ends here