Sync.
[elisp/gnus.git-] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Semi-gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;;      Katsumi Yamaoka <yamaoka@jpl.org>
7 ;; Keywords: mail, news, MIME
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval-when-compile (require 'cl))
31 (eval-when-compile (require 'static))
32
33 (require 'path-util)
34 (require 'gnus)
35 (require 'gnus-sum)
36 (require 'gnus-spec)
37 (require 'gnus-int)
38 (require 'alist)
39 (require 'mime-view)
40
41 ;; Avoid byte-compile warnings.
42 (eval-when-compile
43   (require 'mm-bodies)
44   (require 'mail-parse)
45   (require 'mm-decode)
46   (require 'mm-view)
47   (require 'wid-edit)
48   (require 'mm-uu)
49   )
50
51 (defgroup gnus-article nil
52   "Article display."
53   :link '(custom-manual "(gnus)The Article Buffer")
54   :group 'gnus)
55
56 (defgroup gnus-article-treat nil
57   "Treating article parts."
58   :link '(custom-manual "(gnus)Article Hiding")
59   :group 'gnus-article)
60
61 (defgroup gnus-article-hiding nil
62   "Hiding article parts."
63   :link '(custom-manual "(gnus)Article Hiding")
64   :group 'gnus-article)
65
66 (defgroup gnus-article-highlight nil
67   "Article highlighting."
68   :link '(custom-manual "(gnus)Article Highlighting")
69   :group 'gnus-article
70   :group 'gnus-visual)
71
72 (defgroup gnus-article-signature nil
73   "Article signatures."
74   :link '(custom-manual "(gnus)Article Signature")
75   :group 'gnus-article)
76
77 (defgroup gnus-article-headers nil
78   "Article headers."
79   :link '(custom-manual "(gnus)Hiding Headers")
80   :group 'gnus-article)
81
82 (defgroup gnus-article-washing nil
83   "Special commands on articles."
84   :link '(custom-manual "(gnus)Article Washing")
85   :group 'gnus-article)
86
87 (defgroup gnus-article-emphasis nil
88   "Fontisizing articles."
89   :link '(custom-manual "(gnus)Article Fontisizing")
90   :group 'gnus-article)
91
92 (defgroup gnus-article-saving nil
93   "Saving articles."
94   :link '(custom-manual "(gnus)Saving Articles")
95   :group 'gnus-article)
96
97 (defgroup gnus-article-mime nil
98   "Worshiping the MIME wonder."
99   :link '(custom-manual "(gnus)Using MIME")
100   :group 'gnus-article)
101
102 (defgroup gnus-article-buttons nil
103   "Pushable buttons in the article buffer."
104   :link '(custom-manual "(gnus)Article Buttons")
105   :group 'gnus-article)
106
107 (defgroup gnus-article-various nil
108   "Other article options."
109   :link '(custom-manual "(gnus)Misc Article")
110   :group 'gnus-article)
111
112 (defcustom gnus-ignored-headers
113   '("^Path:" "^Expires:" "^Date-Received:" "^References:" "^Xref:" "^Lines:"
114     "^Relay-Version:" "^Message-ID:" "^Approved:" "^Sender:" "^Received:"
115     "^X-UIDL:" "^MIME-Version:" "^Return-Path:" "^In-Reply-To:"
116     "^Content-Type:" "^Content-Transfer-Encoding:" "^X-WebTV-Signature:"
117     "^X-MimeOLE:" "^X-MSMail-Priority:" "^X-Priority:" "^X-Loop:"
118     "^X-Authentication-Warning:" "^X-MIME-Autoconverted:" "^X-Face:"
119     "^X-Attribution:" "^X-Originating-IP:" "^Delivered-To:"
120     "^NNTP-[-A-Za-z]+:" "^Distribution:" "^X-no-archive:" "^X-Trace:"
121     "^X-Complaints-To:" "^X-NNTP-Posting-Host:" "^X-Orig.*:"
122     "^Abuse-Reports-To:" "^Cache-Post-Path:" "^X-Article-Creation-Date:"
123     "^X-Poster:" "^X-Mail2News-Path:" "^X-Server-Date:" "^X-Cache:"
124     "^Originator:" "^X-Problems-To:" "^X-Auth-User:" "^X-Post-Time:"
125     "^X-Admin:" "^X-UID:" "^Resent-[-A-Za-z]+:" "^X-Mailing-List:"
126     "^Precedence:" "^Original-[-A-Za-z]+:" "^X-filename:" "^X-Orcpt:"
127     "^Old-Received:" "^X-Pgp" "^X-Auth:" "^X-From-Line:"
128     "^X-Gnus-Article-Number:" "^X-Majordomo:" "^X-Url:" "^X-Sender:"
129     "^MBOX-Line" "^Priority:" "^X-Pgp" "^X400-[-A-Za-z]+:"
130     "^Status:" "^X-Gnus-Mail-Source:" "^Cancel-Lock:"
131     "^X-FTN" "^X-EXP32-SerialNo:" "^Encoding:" "^Importance:"
132     "^Autoforwarded:" "^Original-Encoded-Information-Types:" "^X-Ya-Pop3:"
133     "^X-Face-Version:" "^X-Vms-To:" "^X-ML-NAME:" "^X-ML-COUNT:"
134     "^Mailing-List:" "^X-finfo:" "^X-md5sum:" "^X-md5sum-Origin:"
135     "^X-Sun-Charset:" "^X-Accept-Language:" "^X-Envelope-Sender:"
136     "^List-[A-Za-z]+:" "^X-Listprocessor-Version:"
137     "^X-Received:" "^X-Distribute:" "^X-Sequence:" "^X-Juno-Line-Breaks:"
138     "^X-Notes-Item:" "^X-MS-TNEF-Correlator:" "^x-uunet-gateway:"
139     "^X-Received:" "^Content-length:" "X-precedence:")
140   "*All headers that start with this regexp will be hidden.
141 This variable can also be a list of regexps of headers to be ignored.
142 If `gnus-visible-headers' is non-nil, this variable will be ignored."
143   :type '(choice :custom-show nil
144                  regexp
145                  (repeat regexp))
146   :group 'gnus-article-hiding)
147
148 (defcustom gnus-visible-headers
149   "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
150   "*All headers that do not match this regexp will be hidden.
151 This variable can also be a list of regexp of headers to remain visible.
152 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
153   :type '(repeat :value-to-internal (lambda (widget value)
154                                       (custom-split-regexp-maybe value))
155                  :match (lambda (widget value)
156                           (or (stringp value)
157                               (widget-editable-list-match widget value)))
158                  regexp)
159   :group 'gnus-article-hiding)
160
161 (defcustom gnus-sorted-header-list
162   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
163     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
164   "*This variable is a list of regular expressions.
165 If it is non-nil, headers that match the regular expressions will
166 be placed first in the article buffer in the sequence specified by
167 this list."
168   :type '(repeat regexp)
169   :group 'gnus-article-hiding)
170
171 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
172   "Headers that are only to be displayed if they have interesting data.
173 Possible values in this list are `empty', `newsgroups', `followup-to',
174 `reply-to', `date', `long-to', and `many-to'."
175   :type '(set (const :tag "Headers with no content." empty)
176               (const :tag "Newsgroups with only one group." newsgroups)
177               (const :tag "Followup-to identical to newsgroups." followup-to)
178               (const :tag "Reply-to identical to from." reply-to)
179               (const :tag "Date less than four days old." date)
180               (const :tag "Very long To and/or Cc header." long-to)
181               (const :tag "Multiple To and/or Cc headers." many-to))
182   :group 'gnus-article-hiding)
183
184 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
185   "Regexp matching signature separator.
186 This can also be a list of regexps.  In that case, it will be checked
187 from head to tail looking for a separator.  Searches will be done from
188 the end of the buffer."
189   :type '(repeat string)
190   :group 'gnus-article-signature)
191
192 (defcustom gnus-signature-limit nil
193   "Provide a limit to what is considered a signature.
194 If it is a number, no signature may not be longer (in characters) than
195 that number.  If it is a floating point number, no signature may be
196 longer (in lines) than that number.  If it is a function, the function
197 will be called without any parameters, and if it returns nil, there is
198 no signature in the buffer.  If it is a string, it will be used as a
199 regexp.  If it matches, the text in question is not a signature."
200   :type '(choice (integer :value 200)
201                  (number :value 4.0)
202                  (function :value fun)
203                  (regexp :value ".*"))
204   :group 'gnus-article-signature)
205
206 (defcustom gnus-hidden-properties '(invisible t intangible t)
207   "Property list to use for hiding text."
208   :type 'sexp
209   :group 'gnus-article-hiding)
210
211 (defcustom gnus-article-x-face-command
212   (cond
213    ;; Fixme: This isn't the right thing for mixed graphical and and
214    ;; non-graphical frames in a session.
215    ((and (fboundp 'image-type-available-p)
216          (image-type-available-p 'xbm))
217     'gnus-article-display-xface)
218    ((and (not gnus-xemacs)
219          window-system
220          (module-installed-p 'x-face-mule))
221     'x-face-mule-gnus-article-display-x-face)
222    (t
223     "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | display -"))
224   "*String or function to be executed to display an X-Face header.
225 If it is a string, the command will be executed in a sub-shell
226 asynchronously.  The compressed face will be piped to this command."
227   :type '(choice string
228                  (function-item gnus-article-display-xface)
229                  (function-item x-face-mule-gnus-article-display-x-face)
230                  function)
231   :group 'gnus-article-washing)
232
233 (defcustom gnus-article-x-face-too-ugly nil
234   "Regexp matching posters whose face shouldn't be shown automatically."
235   :type '(choice regexp (const nil))
236   :group 'gnus-article-washing)
237
238 (defcustom gnus-emphasis-alist
239   (let ((format
240          "\\(\\s-\\|^\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-,;:\"]\\s-\\|[?!.]+\\s-\\|\\s)\\)")
241         (types
242          '(("_" "_" underline)
243            ("/" "/" italic)
244            ("\\*" "\\*" bold)
245            ("_/" "/_" underline-italic)
246            ("_\\*" "\\*_" underline-bold)
247            ("\\*/" "/\\*" bold-italic)
248            ("_\\*/" "/\\*_" underline-bold-italic))))
249     `(("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
250        2 3 gnus-emphasis-underline)
251       ,@(mapcar
252          (lambda (spec)
253            (list
254             (format format (car spec) (car (cdr spec)))
255             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
256          types)))
257   "*Alist that says how to fontify certain phrases.
258 Each item looks like this:
259
260   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
261
262 The first element is a regular expression to be matched.  The second
263 is a number that says what regular expression grouping used to find
264 the entire emphasized word.  The third is a number that says what
265 regexp grouping should be displayed and highlighted.  The fourth
266 is the face used for highlighting."
267   :type '(repeat (list :value ("" 0 0 default)
268                        regexp
269                        (integer :tag "Match group")
270                        (integer :tag "Emphasize group")
271                        face))
272   :group 'gnus-article-emphasis)
273
274 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
275   "A regexp to describe whitespace which should not be emphasized.
276 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
277 The former avoids underlining of leading and trailing whitespace,
278 and the latter avoids underlining any whitespace at all."
279   :group 'gnus-article-emphasis
280   :type 'regexp)
281
282 (defface gnus-emphasis-bold '((t (:bold t)))
283   "Face used for displaying strong emphasized text (*word*)."
284   :group 'gnus-article-emphasis)
285
286 (defface gnus-emphasis-italic '((t (:italic t)))
287   "Face used for displaying italic emphasized text (/word/)."
288   :group 'gnus-article-emphasis)
289
290 (defface gnus-emphasis-underline '((t (:underline t)))
291   "Face used for displaying underlined emphasized text (_word_)."
292   :group 'gnus-article-emphasis)
293
294 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
295   "Face used for displaying underlined bold emphasized text (_*word*_)."
296   :group 'gnus-article-emphasis)
297
298 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
299   "Face used for displaying underlined italic emphasized text (_/word/_)."
300   :group 'gnus-article-emphasis)
301
302 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
303   "Face used for displaying bold italic emphasized text (/*word*/)."
304   :group 'gnus-article-emphasis)
305
306 (defface gnus-emphasis-underline-bold-italic
307   '((t (:bold t :italic t :underline t)))
308   "Face used for displaying underlined bold italic emphasized text.
309 Esample: (_/*word*/_)."
310   :group 'gnus-article-emphasis)
311
312 (defface gnus-emphasis-highlight-words
313   '((t (:background "black" :foreground "yellow")))
314   "Face used for displaying highlighted words."
315   :group 'gnus-article-emphasis)
316
317 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
318   "Format for display of Date headers in article bodies.
319 See `format-time-string' for the possible values.
320
321 The variable can also be function, which should return a complete Date
322 header.  The function is called with one argument, the time, which can
323 be fed to `format-time-string'."
324   :type '(choice string symbol)
325   :link '(custom-manual "(gnus)Article Date")
326   :group 'gnus-article-washing)
327
328 (eval-and-compile
329   (autoload 'mail-extract-address-components "mail-extr"))
330
331 (defcustom gnus-save-all-headers t
332   "*If non-nil, don't remove any headers before saving."
333   :group 'gnus-article-saving
334   :type 'boolean)
335
336 (defcustom gnus-prompt-before-saving 'always
337   "*This variable says how much prompting is to be done when saving articles.
338 If it is nil, no prompting will be done, and the articles will be
339 saved to the default files.  If this variable is `always', each and
340 every article that is saved will be preceded by a prompt, even when
341 saving large batches of articles.  If this variable is neither nil not
342 `always', there the user will be prompted once for a file name for
343 each invocation of the saving commands."
344   :group 'gnus-article-saving
345   :type '(choice (item always)
346                  (item :tag "never" nil)
347                  (sexp :tag "once" :format "%t\n" :value t)))
348
349 (defcustom gnus-saved-headers gnus-visible-headers
350   "Headers to keep if `gnus-save-all-headers' is nil.
351 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
352 If that variable is nil, however, all headers that match this regexp
353 will be kept while the rest will be deleted before saving."
354   :group 'gnus-article-saving
355   :type 'regexp)
356
357 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
358   "A function to save articles in your favourite format.
359 The function must be interactively callable (in other words, it must
360 be an Emacs command).
361
362 Gnus provides the following functions:
363
364 * gnus-summary-save-in-rmail (Rmail format)
365 * gnus-summary-save-in-mail (Unix mail format)
366 * gnus-summary-save-in-folder (MH folder)
367 * gnus-summary-save-in-file (article format)
368 * gnus-summary-save-in-vm (use VM's folder format)
369 * gnus-summary-write-to-file (article format -- overwrite)."
370   :group 'gnus-article-saving
371   :type '(radio (function-item gnus-summary-save-in-rmail)
372                 (function-item gnus-summary-save-in-mail)
373                 (function-item gnus-summary-save-in-folder)
374                 (function-item gnus-summary-save-in-file)
375                 (function-item gnus-summary-save-in-vm)
376                 (function-item gnus-summary-write-to-file)))
377
378 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
379   "A function generating a file name to save articles in Rmail format.
380 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
381   :group 'gnus-article-saving
382   :type 'function)
383
384 (defcustom gnus-mail-save-name 'gnus-plain-save-name
385   "A function generating a file name to save articles in Unix mail format.
386 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
387   :group 'gnus-article-saving
388   :type 'function)
389
390 (defcustom gnus-folder-save-name 'gnus-folder-save-name
391   "A function generating a file name to save articles in MH folder.
392 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
393   :group 'gnus-article-saving
394   :type 'function)
395
396 (defcustom gnus-file-save-name 'gnus-numeric-save-name
397   "A function generating a file name to save articles in article format.
398 The function is called with NEWSGROUP, HEADERS, and optional
399 LAST-FILE."
400   :group 'gnus-article-saving
401   :type 'function)
402
403 (defcustom gnus-split-methods
404   '((gnus-article-archive-name)
405     (gnus-article-nndoc-name))
406   "*Variable used to suggest where articles are to be saved.
407 For instance, if you would like to save articles related to Gnus in
408 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
409 you could set this variable to something like:
410
411  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
412    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
413
414 This variable is an alist where the where the key is the match and the
415 value is a list of possible files to save in if the match is non-nil.
416
417 If the match is a string, it is used as a regexp match on the
418 article.  If the match is a symbol, that symbol will be funcalled
419 from the buffer of the article to be saved with the newsgroup as the
420 parameter.  If it is a list, it will be evaled in the same buffer.
421
422 If this form or function returns a string, this string will be used as
423 a possible file name; and if it returns a non-nil list, that list will
424 be used as possible file names."
425   :group 'gnus-article-saving
426   :type '(repeat (choice (list :value (fun) function)
427                          (cons :value ("" "") regexp (repeat string))
428                          (sexp :value nil))))
429
430 (defcustom gnus-article-display-method-for-mime
431   'gnus-article-display-mime-message
432   "Function to display a MIME message.
433 The function is called from the article buffer."
434   :group 'gnus-article-mime
435   :type 'function)
436
437 (defcustom gnus-article-display-method-for-traditional
438   'gnus-article-display-traditional-message
439   "*Function to display a traditional message.
440 The function is called from the article buffer."
441   :group 'gnus-article-mime
442   :type 'function)
443
444 (defcustom gnus-page-delimiter "^\^L"
445   "*Regexp describing what to use as article page delimiters.
446 The default value is \"^\^L\", which is a form linefeed at the
447 beginning of a line."
448   :type 'regexp
449   :group 'gnus-article-various)
450
451 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
452   "*The format specification for the article mode line.
453 See `gnus-summary-mode-line-format' for a closer description.
454
455 The following additional specs are available:
456
457 %w  The article washing status.
458 %m  The number of MIME parts in the article."
459   :type 'string
460   :group 'gnus-article-various)
461
462 (defcustom gnus-article-mode-hook nil
463   "*A hook for Gnus article mode."
464   :type 'hook
465   :group 'gnus-article-various)
466
467 (defcustom gnus-article-menu-hook nil
468   "*Hook run after the creation of the article mode menu."
469   :type 'hook
470   :group 'gnus-article-various)
471
472 (defcustom gnus-article-prepare-hook nil
473   "*A hook called after an article has been prepared in the article buffer."
474   :type 'hook
475   :group 'gnus-article-various)
476
477 (defcustom gnus-article-hide-pgp-hook nil
478   "*A hook called after successfully hiding a PGP signature."
479   :type 'hook
480   :group 'gnus-article-various)
481
482 (defcustom gnus-article-button-face 'bold
483   "Face used for highlighting buttons in the article buffer.
484
485 An article button is a piece of text that you can activate by pressing
486 `RET' or `mouse-2' above it."
487   :type 'face
488   :group 'gnus-article-buttons)
489
490 (defcustom gnus-article-mouse-face 'highlight
491   "Face used for mouse highlighting in the article buffer.
492
493 Article buttons will be displayed in this face when the cursor is
494 above them."
495   :type 'face
496   :group 'gnus-article-buttons)
497
498 (defcustom gnus-signature-face 'gnus-signature-face
499   "Face used for highlighting a signature in the article buffer.
500 Obsolete; use the face `gnus-signature-face' for customizations instead."
501   :type 'face
502   :group 'gnus-article-highlight
503   :group 'gnus-article-signature)
504
505 (defface gnus-signature-face
506   '((t (:italic t)))
507   "Face used for highlighting a signature in the article buffer."
508   :group 'gnus-article-highlight
509   :group 'gnus-article-signature)
510
511 (defface gnus-header-from-face
512   '((((class color)
513       (background dark))
514      (:foreground "spring green"))
515     (((class color)
516       (background light))
517      (:foreground "red3"))
518     (t
519      (:italic t)))
520   "Face used for displaying from headers."
521   :group 'gnus-article-headers
522   :group 'gnus-article-highlight)
523
524 (defface gnus-header-subject-face
525   '((((class color)
526       (background dark))
527      (:foreground "SeaGreen3"))
528     (((class color)
529       (background light))
530      (:foreground "red4"))
531     (t
532      (:bold t :italic t)))
533   "Face used for displaying subject headers."
534   :group 'gnus-article-headers
535   :group 'gnus-article-highlight)
536
537 (defface gnus-header-newsgroups-face
538   '((((class color)
539       (background dark))
540      (:foreground "yellow" :italic t))
541     (((class color)
542       (background light))
543      (:foreground "MidnightBlue" :italic t))
544     (t
545      (:italic t)))
546   "Face used for displaying newsgroups headers."
547   :group 'gnus-article-headers
548   :group 'gnus-article-highlight)
549
550 (defface gnus-header-name-face
551   '((((class color)
552       (background dark))
553      (:foreground "SeaGreen"))
554     (((class color)
555       (background light))
556      (:foreground "maroon"))
557     (t
558      (:bold t)))
559   "Face used for displaying header names."
560   :group 'gnus-article-headers
561   :group 'gnus-article-highlight)
562
563 (defface gnus-header-content-face
564   '((((class color)
565       (background dark))
566      (:foreground "forest green" :italic t))
567     (((class color)
568       (background light))
569      (:foreground "indianred4" :italic t))
570     (t
571      (:italic t)))  "Face used for displaying header content."
572   :group 'gnus-article-headers
573   :group 'gnus-article-highlight)
574
575 (defcustom gnus-header-face-alist
576   '(("From" nil gnus-header-from-face)
577     ("Subject" nil gnus-header-subject-face)
578     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
579     ("" gnus-header-name-face gnus-header-content-face))
580   "*Controls highlighting of article header.
581
582 An alist of the form (HEADER NAME CONTENT).
583
584 HEADER is a regular expression which should match the name of an
585 header header and NAME and CONTENT are either face names or nil.
586
587 The name of each header field will be displayed using the face
588 specified by the first element in the list where HEADER match the
589 header name and NAME is non-nil.  Similarly, the content will be
590 displayed by the first non-nil matching CONTENT face."
591   :group 'gnus-article-headers
592   :group 'gnus-article-highlight
593   :type '(repeat (list (regexp :tag "Header")
594                        (choice :tag "Name"
595                                (item :tag "skip" nil)
596                                (face :value default))
597                        (choice :tag "Content"
598                                (item :tag "skip" nil)
599                                (face :value default)))))
600
601 (defcustom gnus-article-decode-hook nil
602   "*Hook run to decode charsets in articles."
603   :group 'gnus-article-headers
604   :type 'hook)
605
606 (defcustom gnus-display-mime-function 'gnus-display-mime
607   "Function to display MIME articles."
608   :group 'gnus-article-mime
609   :type 'function)
610
611 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
612   "Function used to decode headers.")
613
614 (defvar gnus-article-dumbquotes-map
615   '(("\202" ",")
616     ("\203" "f")
617     ("\204" ",,")
618     ("\205" "...")
619     ("\213" "<")
620     ("\214" "OE")
621     ("\221" "`")
622     ("\222" "'")
623     ("\223" "``")
624     ("\224" "\"")
625     ("\225" "*")
626     ("\226" "---")
627     ("\227" "-")
628     ("\231" "(TM)")
629     ("\233" ">")
630     ("\234" "oe")
631     ("\264" "'"))
632   "Table for MS-to-Latin1 translation.")
633
634 (defcustom gnus-ignored-mime-types nil
635   "List of MIME types that should be ignored by Gnus."
636   :group 'gnus-article-mime
637   :type '(repeat regexp))
638
639 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
640   "List of MIME types that should not be given buttons when rendered inline."
641   :group 'gnus-article-mime
642   :type '(repeat regexp))
643
644 (defcustom gnus-article-mime-part-function nil
645   "Function called with a MIME handle as the argument.
646 This is meant for people who want to do something automatic based
647 on parts -- for instance, adding Vcard info to a database."
648   :group 'gnus-article-mime
649   :type 'function)
650
651 (defcustom gnus-mime-multipart-functions nil
652   "An alist of MIME types to functions to display them.")
653
654 (defcustom gnus-article-date-lapsed-new-header nil
655   "Whether the X-Sent and Date headers can coexist.
656 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
657 either replace the old \"Date:\" header (if this variable is nil), or
658 be added below it (otherwise)."
659   :group 'gnus-article-headers
660   :type 'boolean)
661
662 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
663   "Function called with a MIME handle as the argument.
664 This is meant for people who want to view first matched part.
665 For `undisplayed-alternative' (default), the first undisplayed 
666 part or alternative part is used.  For `undisplayed', the first 
667 undisplayed part is used.  For a function, the first part which 
668 the function return `t' is used.  For `nil', the first part is
669 used."
670   :group 'gnus-article-mime
671   :type '(choice 
672           (item :tag "first" :value nil)
673           (item :tag "undisplayed" :value undisplayed)
674           (item :tag "undisplayed or alternative" 
675                 :value undisplayed-alternative)
676           (function)))
677
678 ;;;
679 ;;; The treatment variables
680 ;;;
681
682 (defvar gnus-part-display-hook nil
683   "Hook called on parts that are to receive treatment.")
684
685 (defvar gnus-article-treat-custom
686   '(choice (const :tag "Off" nil)
687            (const :tag "On" t)
688            (const :tag "Header" head)
689            (const :tag "Last" last)
690            (const :tag "Mime" mime)
691            (integer :tag "Less")
692            (repeat :tag "Groups" regexp)
693            (sexp :tag "Predicate")))
694
695 (defvar gnus-article-treat-head-custom
696   '(choice (const :tag "Off" nil)
697            (const :tag "Header" head)))
698
699 (defvar gnus-article-treat-types '("text/plain")
700   "Parts to treat.")
701
702 (defvar gnus-inhibit-treatment nil
703   "Whether to inhibit treatment.")
704
705 (defcustom gnus-treat-highlight-signature '(or last (typep "text/x-vcard"))
706   "Highlight the signature.
707 Valid values are nil, t, `head', `last', an integer or a predicate.
708 See the manual for details."
709   :group 'gnus-article-treat
710   :type gnus-article-treat-custom)
711 (put 'gnus-treat-highlight-signature 'highlight t)
712
713 (defcustom gnus-treat-buttonize 100000
714   "Add buttons.
715 Valid values are nil, t, `head', `last', an integer or a predicate.
716 See the manual for details."
717   :group 'gnus-article-treat
718   :type gnus-article-treat-custom)
719 (put 'gnus-treat-buttonize 'highlight t)
720
721 (defcustom gnus-treat-buttonize-head 'head
722   "Add buttons to the head.
723 Valid values are nil, t, `head', `last', an integer or a predicate.
724 See the manual for details."
725   :group 'gnus-article-treat
726   :type gnus-article-treat-head-custom)
727 (put 'gnus-treat-buttonize-head 'highlight t)
728
729 (defcustom gnus-treat-emphasize nil
730   "Emphasize text.
731 Valid values are nil, t, `head', `last', an integer or a predicate.
732 See the manual for details."
733   :group 'gnus-article-treat
734   :type gnus-article-treat-custom)
735 (put 'gnus-treat-emphasize 'highlight t)
736
737 (defcustom gnus-treat-strip-cr nil
738   "Remove carriage returns.
739 Valid values are nil, t, `head', `last', an integer or a predicate.
740 See the manual for details."
741   :group 'gnus-article-treat
742   :type gnus-article-treat-custom)
743
744 (defcustom gnus-treat-hide-headers 'head
745   "Hide headers.
746 Valid values are nil, t, `head', `last', an integer or a predicate.
747 See the manual for details."
748   :group 'gnus-article-treat
749   :type gnus-article-treat-head-custom)
750
751 (defcustom gnus-treat-hide-boring-headers nil
752   "Hide boring headers.
753 Valid values are nil, t, `head', `last', an integer or a predicate.
754 See the manual for details."
755   :group 'gnus-article-treat
756   :type gnus-article-treat-head-custom)
757
758 (defcustom gnus-treat-hide-signature nil
759   "Hide the signature.
760 Valid values are nil, t, `head', `last', an integer or a predicate.
761 See the manual for details."
762   :group 'gnus-article-treat
763   :type gnus-article-treat-custom)
764
765 (defcustom gnus-treat-fill-article nil
766   "Fill the article.
767 Valid values are nil, t, `head', `last', an integer or a predicate.
768 See the manual for details."
769   :group 'gnus-article-treat
770   :type gnus-article-treat-custom)
771
772 (defcustom gnus-treat-hide-citation nil
773   "Hide cited text.
774 Valid values are nil, t, `head', `last', an integer or a predicate.
775 See the manual for details."
776   :group 'gnus-article-treat
777   :type gnus-article-treat-custom)
778
779 (defcustom gnus-treat-strip-list-identifiers 'head
780   "Strip list identifiers from `gnus-list-identifiers`.
781 Valid values are nil, t, `head', `last', an integer or a predicate.
782 See the manual for details."
783   :group 'gnus-article-treat
784   :type gnus-article-treat-custom)
785
786 (defcustom gnus-treat-strip-pgp t
787   "Strip PGP signatures.
788 Valid values are nil, t, `head', `last', an integer or a predicate.
789 See the manual for details."
790   :group 'gnus-article-treat
791   :type gnus-article-treat-custom)
792
793 (defcustom gnus-treat-strip-pem nil
794   "Strip PEM signatures.
795 Valid values are nil, t, `head', `last', an integer or a predicate.
796 See the manual for details."
797   :group 'gnus-article-treat
798   :type gnus-article-treat-custom)
799
800 (defcustom gnus-treat-strip-banner t
801   "Strip banners from articles.
802 The banner to be stripped is specified in the `banner' group parameter.
803 Valid values are nil, t, `head', `last', an integer or a predicate.
804 See the manual for details."
805   :group 'gnus-article-treat
806   :type gnus-article-treat-custom)
807
808 (defcustom gnus-treat-highlight-headers 'head
809   "Highlight the headers.
810 Valid values are nil, t, `head', `last', an integer or a predicate.
811 See the manual for details."
812   :group 'gnus-article-treat
813   :type gnus-article-treat-head-custom)
814 (put 'gnus-treat-highlight-headers 'highlight t)
815
816 (defcustom gnus-treat-highlight-citation t
817   "Highlight cited text.
818 Valid values are nil, t, `head', `last', an integer or a predicate.
819 See the manual for details."
820   :group 'gnus-article-treat
821   :type gnus-article-treat-custom)
822 (put 'gnus-treat-highlight-citation 'highlight t)
823
824 (defcustom gnus-treat-date-ut nil
825   "Display the Date in UT (GMT).
826 Valid values are nil, t, `head', `last', an integer or a predicate.
827 See the manual for details."
828   :group 'gnus-article-treat
829   :type gnus-article-treat-head-custom)
830
831 (defcustom gnus-treat-date-local nil
832   "Display the Date in the local timezone.
833 Valid values are nil, t, `head', `last', an integer or a predicate.
834 See the manual for details."
835   :group 'gnus-article-treat
836   :type gnus-article-treat-head-custom)
837
838 (defcustom gnus-treat-date-lapsed nil
839   "Display the Date header in a way that says how much time has elapsed.
840 Valid values are nil, t, `head', `last', an integer or a predicate.
841 See the manual for details."
842   :group 'gnus-article-treat
843   :type gnus-article-treat-head-custom)
844
845 (defcustom gnus-treat-date-original nil
846   "Display the date in the original timezone.
847 Valid values are nil, t, `head', `last', an integer or a predicate.
848 See the manual for details."
849   :group 'gnus-article-treat
850   :type gnus-article-treat-head-custom)
851
852 (defcustom gnus-treat-date-iso8601 nil
853   "Display the date in the ISO8601 format.
854 Valid values are nil, t, `head', `last', an integer or a predicate.
855 See the manual for details."
856   :group 'gnus-article-treat
857   :type gnus-article-treat-head-custom)
858
859 (defcustom gnus-treat-date-user-defined nil
860   "Display the date in a user-defined format.
861 The format is defined by the `gnus-article-time-format' variable.
862 Valid values are nil, t, `head', `last', an integer or a predicate.
863 See the manual for details."
864   :group 'gnus-article-treat
865   :type gnus-article-treat-head-custom)
866
867 (defcustom gnus-treat-strip-headers-in-body t
868   "Strip the X-No-Archive header line from the beginning of the body.
869 Valid values are nil, t, `head', `last', an integer or a predicate.
870 See the manual for details."
871   :group 'gnus-article-treat
872   :type gnus-article-treat-custom)
873
874 (defcustom gnus-treat-strip-trailing-blank-lines nil
875   "Strip trailing blank lines.
876 Valid values are nil, t, `head', `last', an integer or a predicate.
877 See the manual for details."
878   :group 'gnus-article-treat
879   :type gnus-article-treat-custom)
880
881 (defcustom gnus-treat-strip-leading-blank-lines nil
882   "Strip leading blank lines.
883 Valid values are nil, t, `head', `last', an integer or a predicate.
884 See the manual for details."
885   :group 'gnus-article-treat
886   :type gnus-article-treat-custom)
887
888 (defcustom gnus-treat-strip-multiple-blank-lines nil
889   "Strip multiple blank lines.
890 Valid values are nil, t, `head', `last', an integer or a predicate.
891 See the manual for details."
892   :group 'gnus-article-treat
893   :type gnus-article-treat-custom)
894
895 (defcustom gnus-treat-overstrike t
896   "Treat overstrike highlighting.
897 Valid values are nil, t, `head', `last', an integer or a predicate.
898 See the manual for details."
899   :group 'gnus-article-treat
900   :type gnus-article-treat-custom)
901 (put 'gnus-treat-overstrike 'highlight t)
902
903 (defcustom gnus-treat-display-xface
904   (if (or (and gnus-xemacs (featurep 'xface))
905           (eq 'x-face-mule-gnus-article-display-x-face
906               gnus-article-x-face-command))
907       'head
908     nil)
909   "Display X-Face headers.
910 Valid values are nil, t, `head', `last', an integer or a predicate.
911 See the manual for details."
912   :group 'gnus-article-treat
913   :type gnus-article-treat-head-custom)
914 (put 'gnus-treat-display-xface 'highlight t)
915
916 (defcustom gnus-treat-display-smileys
917   (if (or (and gnus-xemacs (featurep 'xpm))
918           (and (not gnus-xemacs)
919                window-system
920                (module-installed-p 'gnus-bitmap)))
921       t
922     nil)
923   "Display smileys.
924 Valid values are nil, t, `head', `last', an integer or a predicate.
925 See the manual for details."
926   :group 'gnus-article-treat
927   :type gnus-article-treat-custom)
928 (put 'gnus-treat-display-smileys 'highlight t)
929
930 (defcustom gnus-treat-display-picons (if gnus-xemacs 'head nil)
931   "Display picons.
932 Valid values are nil, t, `head', `last', an integer or a predicate.
933 See the manual for details."
934   :group 'gnus-article-treat
935   :type gnus-article-treat-head-custom)
936 (put 'gnus-treat-display-picons 'highlight t)
937
938 (defcustom gnus-treat-capitalize-sentences nil
939   "Capitalize sentence-starting words.
940 Valid values are nil, t, `head', `last', an integer or a predicate.
941 See the manual for details."
942   :group 'gnus-article-treat
943   :type gnus-article-treat-custom)
944
945 (defcustom gnus-treat-fill-long-lines nil
946   "Fill long lines.
947 Valid values are nil, t, `head', `last', an integer or a predicate.
948 See the manual for details."
949   :group 'gnus-article-treat
950   :type gnus-article-treat-custom)
951
952 (defcustom gnus-treat-play-sounds nil
953   "Play sounds.
954 Valid values are nil, t, `head', `last', an integer or a predicate.
955 See the manual for details."
956   :group 'gnus-article-treat
957   :type gnus-article-treat-custom)
958
959 (defcustom gnus-treat-decode-article-as-default-mime-charset nil
960   "Decode an article as `default-mime-charset'.  For instance, if you want to
961 attempt to decode an article even if the value of `gnus-show-mime' is nil,
962 you could set this variable to something like: nil for don't decode, t for
963 decode the body, '(or header t) for the whole article, etc."
964   :group 'gnus-article-treat
965   :type '(radio (const :tag "Off" nil)
966                 (const :tag "Decode body" t)
967                 (const :tag "Decode all" (or head t))))
968
969 (defcustom gnus-treat-translate nil
970   "Translate articles from one language to another.
971 Valid values are nil, t, `head', `last', an integer or a predicate.
972 See the manual for details."
973   :group 'gnus-article-treat
974   :type gnus-article-treat-custom)
975
976 ;;; Internal variables
977
978 (defvar article-goto-body-goes-to-point-min-p nil)
979 (defvar gnus-article-wash-types nil)
980 (defvar gnus-article-emphasis-alist nil)
981
982 (defvar gnus-article-mime-handle-alist-1 nil)
983 (defvar gnus-treatment-function-alist
984   '((gnus-treat-decode-article-as-default-mime-charset
985      gnus-article-decode-article-as-default-mime-charset)
986     (gnus-treat-strip-banner gnus-article-strip-banner)
987     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
988     (gnus-treat-buttonize gnus-article-add-buttons)
989     (gnus-treat-fill-article gnus-article-fill-cited-article)
990     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
991     (gnus-treat-strip-cr gnus-article-remove-cr)
992     (gnus-treat-display-xface gnus-article-display-x-face)
993     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
994     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
995     (gnus-treat-hide-signature gnus-article-hide-signature)
996     (gnus-treat-hide-citation gnus-article-hide-citation)
997     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
998     (gnus-treat-strip-pgp gnus-article-hide-pgp)
999     (gnus-treat-strip-pem gnus-article-hide-pem)
1000     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1001     (gnus-treat-emphasize gnus-article-emphasize)
1002     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1003     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1004     (gnus-treat-date-ut gnus-article-date-ut)
1005     (gnus-treat-date-local gnus-article-date-local)
1006     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1007     (gnus-treat-date-original gnus-article-date-original)
1008     (gnus-treat-date-user-defined gnus-article-date-user)
1009     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1010     (gnus-treat-strip-trailing-blank-lines
1011      gnus-article-remove-trailing-blank-lines)
1012     (gnus-treat-strip-leading-blank-lines
1013      gnus-article-strip-leading-blank-lines)
1014     (gnus-treat-strip-multiple-blank-lines
1015      gnus-article-strip-multiple-blank-lines)
1016     (gnus-treat-overstrike gnus-article-treat-overstrike)
1017     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1018     (gnus-treat-display-smileys gnus-article-smiley-display)
1019     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1020     (gnus-treat-display-picons gnus-article-display-picons)
1021     (gnus-treat-play-sounds gnus-earcon-display)))
1022
1023 (defvar gnus-article-mime-handle-alist nil)
1024 (defvar article-lapsed-timer nil)
1025 (defvar gnus-article-current-summary nil)
1026
1027 (defvar gnus-article-mode-syntax-table
1028   (let ((table (copy-syntax-table text-mode-syntax-table)))
1029     (modify-syntax-entry ?- "w" table)
1030     (modify-syntax-entry ?> ")" table)
1031     (modify-syntax-entry ?< "(" table)
1032     table)
1033   "Syntax table used in article mode buffers.
1034 Initialized from `text-mode-syntax-table.")
1035
1036 (defvar gnus-save-article-buffer nil)
1037
1038 (defvar gnus-article-mode-line-format-alist
1039   (nconc '((?w (gnus-article-wash-status) ?s)
1040            (?m (gnus-article-mime-part-status) ?s))
1041          gnus-summary-mode-line-format-alist))
1042
1043 (defvar gnus-number-of-articles-to-be-saved nil)
1044
1045 (defvar gnus-inhibit-hiding nil)
1046
1047 (defsubst gnus-article-hide-text (b e props)
1048   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1049   (add-text-properties b e props)
1050   (when (memq 'intangible props)
1051     (put-text-property
1052      (max (1- b) (point-min))
1053      b 'intangible (cddr (memq 'intangible props)))))
1054 (defsubst gnus-article-unhide-text (b e)
1055   "Remove hidden text properties from region between B and E."
1056   (remove-text-properties b e gnus-hidden-properties)
1057   (when (memq 'intangible gnus-hidden-properties)
1058     (put-text-property (max (1- b) (point-min))
1059                        b 'intangible nil)))
1060
1061 (defun gnus-article-hide-text-type (b e type)
1062   "Hide text of TYPE between B and E."
1063   (push type gnus-article-wash-types)
1064   (gnus-article-hide-text
1065    b e (cons 'article-type (cons type gnus-hidden-properties))))
1066
1067 (defun gnus-article-unhide-text-type (b e type)
1068   "Unhide text of TYPE between B and E."
1069   (setq gnus-article-wash-types
1070         (delq type gnus-article-wash-types))
1071   (remove-text-properties
1072    b e (cons 'article-type (cons type gnus-hidden-properties)))
1073   (when (memq 'intangible gnus-hidden-properties)
1074     (put-text-property (max (1- b) (point-min))
1075                        b 'intangible nil)))
1076
1077 (defun gnus-article-hide-text-of-type (type)
1078   "Hide text of TYPE in the current buffer."
1079   (save-excursion
1080     (let ((b (point-min))
1081           (e (point-max)))
1082       (while (setq b (text-property-any b e 'article-type type))
1083         (add-text-properties b (incf b) gnus-hidden-properties)))))
1084
1085 (defun gnus-article-delete-text-of-type (type)
1086   "Delete text of TYPE in the current buffer."
1087   (save-excursion
1088     (let ((b (point-min)))
1089       (while (setq b (text-property-any b (point-max) 'article-type type))
1090         (delete-region
1091          b (or (text-property-not-all b (point-max) 'article-type type)
1092                (point-max)))))))
1093
1094 (defun gnus-article-delete-invisible-text ()
1095   "Delete all invisible text in the current buffer."
1096   (save-excursion
1097     (let ((b (point-min)))
1098       (while (setq b (text-property-any b (point-max) 'invisible t))
1099         (delete-region
1100          b (or (text-property-not-all b (point-max) 'invisible t)
1101                (point-max)))))))
1102
1103 (defun gnus-article-text-type-exists-p (type)
1104   "Say whether any text of type TYPE exists in the buffer."
1105   (text-property-any (point-min) (point-max) 'article-type type))
1106
1107 (defsubst gnus-article-header-rank ()
1108   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1109   (let ((list gnus-sorted-header-list)
1110         (i 0))
1111     (while list
1112       (when (looking-at (car list))
1113         (setq list nil))
1114       (setq list (cdr list))
1115       (incf i))
1116     i))
1117
1118 (defun article-hide-headers (&optional arg delete)
1119   "Hide unwanted headers and possibly sort them as well."
1120   (interactive (gnus-article-hidden-arg))
1121   ;; Lars said that this function might be inhibited.
1122   (if (gnus-article-check-hidden-text 'headers arg)
1123       (progn
1124         ;; Show boring headers as well.
1125         (gnus-article-show-hidden-text 'boring-headers)
1126         (when (eq 1 (point-min))
1127           (set-window-start (get-buffer-window (current-buffer)) 1)))
1128   (unless gnus-inhibit-hiding
1129     (save-excursion
1130       (save-restriction
1131         (let ((buffer-read-only nil)
1132               (inhibit-read-only t)
1133               (case-fold-search t)
1134               (max (1+ (length gnus-sorted-header-list)))
1135               (ignored (when (not gnus-visible-headers)
1136                          (cond ((stringp gnus-ignored-headers)
1137                                 gnus-ignored-headers)
1138                                ((listp gnus-ignored-headers)
1139                                 (mapconcat 'identity gnus-ignored-headers
1140                                            "\\|")))))
1141               (visible
1142                (cond ((stringp gnus-visible-headers)
1143                       gnus-visible-headers)
1144                      ((and gnus-visible-headers
1145                            (listp gnus-visible-headers))
1146                       (mapconcat 'identity gnus-visible-headers "\\|"))))
1147               (inhibit-point-motion-hooks t)
1148               beg)
1149           ;; First we narrow to just the headers.
1150           (article-narrow-to-head)
1151           ;; Hide any "From " lines at the beginning of (mail) articles.
1152           (while (looking-at "From ")
1153             (forward-line 1))
1154           (unless (bobp)
1155             (if delete
1156                 (delete-region (point-min) (point))
1157               (gnus-article-hide-text (point-min) (point)
1158                                       (nconc (list 'article-type 'headers)
1159                                              gnus-hidden-properties))))
1160           ;; Then treat the rest of the header lines.
1161           ;; Then we use the two regular expressions
1162           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1163           ;; select which header lines is to remain visible in the
1164           ;; article buffer.
1165           (while (re-search-forward "^[^ \t]*:" nil t)
1166             (beginning-of-line)
1167             ;; Mark the rank of the header.
1168             (put-text-property
1169              (point) (1+ (point)) 'message-rank
1170              (if (or (and visible (looking-at visible))
1171                      (and ignored
1172                           (not (looking-at ignored))))
1173                  (gnus-article-header-rank)
1174                (+ 2 max)))
1175             (forward-line 1))
1176           (message-sort-headers-1)
1177           (when (setq beg (text-property-any
1178                            (point-min) (point-max) 'message-rank (+ 2 max)))
1179             ;; We delete or make invisible the unwanted headers.
1180             (push 'headers gnus-article-wash-types)
1181             (if delete
1182                 (progn
1183                   (add-text-properties
1184                    (point-min) (+ 5 (point-min))
1185                    '(article-type headers dummy-invisible t))
1186                   (delete-region beg (point-max)))
1187               (gnus-article-hide-text-type beg (point-max) 'headers))))))))
1188   )
1189
1190 (defun article-hide-boring-headers (&optional arg)
1191   "Toggle hiding of headers that aren't very interesting.
1192 If given a negative prefix, always show; if given a positive prefix,
1193 always hide."
1194   (interactive (gnus-article-hidden-arg))
1195   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1196              (not gnus-show-all-headers))
1197     (save-excursion
1198       (save-restriction
1199         (let ((buffer-read-only nil)
1200               (list gnus-boring-article-headers)
1201               (inhibit-point-motion-hooks t)
1202               elem)
1203           (article-narrow-to-head)
1204           (while list
1205             (setq elem (pop list))
1206             (goto-char (point-min))
1207             (cond
1208              ;; Hide empty headers.
1209              ((eq elem 'empty)
1210               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1211                 (forward-line -1)
1212                 (gnus-article-hide-text-type
1213                  (progn (beginning-of-line) (point))
1214                  (progn
1215                    (end-of-line)
1216                    (if (re-search-forward "^[^ \t]" nil t)
1217                        (match-beginning 0)
1218                      (point-max)))
1219                  'boring-headers)))
1220              ;; Hide boring Newsgroups header.
1221              ((eq elem 'newsgroups)
1222               (when (equal (gnus-fetch-field "newsgroups")
1223                            (gnus-group-real-name
1224                             (if (boundp 'gnus-newsgroup-name)
1225                                 gnus-newsgroup-name
1226                               "")))
1227                 (gnus-article-hide-header "newsgroups")))
1228              ((eq elem 'followup-to)
1229               (when (equal (message-fetch-field "followup-to")
1230                            (message-fetch-field "newsgroups"))
1231                 (gnus-article-hide-header "followup-to")))
1232              ((eq elem 'reply-to)
1233               (let ((from (message-fetch-field "from"))
1234                     (reply-to (message-fetch-field "reply-to")))
1235                 (when (and
1236                        from reply-to
1237                        (ignore-errors
1238                          (equal
1239                           (nth 1 (funcall gnus-extract-address-components from))
1240                           (nth 1 (funcall gnus-extract-address-components reply-to)))))
1241                   (gnus-article-hide-header "reply-to"))))
1242              ((eq elem 'date)
1243               (let ((date (message-fetch-field "date")))
1244                 (when (and date
1245                            (< (days-between (current-time-string) date)
1246                               4))
1247                   (gnus-article-hide-header "date"))))
1248              ((eq elem 'long-to)
1249               (let ((to (message-fetch-field "to"))
1250                     (cc (message-fetch-field "cc")))
1251                 (when (> (length to) 1024)
1252                   (gnus-article-hide-header "to"))
1253                 (when (> (length cc) 1024)
1254                   (gnus-article-hide-header "cc"))))
1255              ((eq elem 'many-to)
1256               (let ((to-count 0)
1257                     (cc-count 0))
1258                 (goto-char (point-min))
1259                 (while (re-search-forward "^to:" nil t)
1260                   (setq to-count (1+ to-count)))
1261                 (when (> to-count 1)
1262                   (while (> to-count 0)
1263                     (goto-char (point-min))
1264                     (save-restriction
1265                       (re-search-forward "^to:" nil nil to-count)
1266                       (forward-line -1)
1267                       (narrow-to-region (point) (point-max))
1268                       (gnus-article-hide-header "to"))
1269                     (setq to-count (1- to-count))))
1270                 (goto-char (point-min))
1271                 (while (re-search-forward "^cc:" nil t)
1272                   (setq cc-count (1+ cc-count)))
1273                 (when (> cc-count 1)
1274                   (while (> cc-count 0)
1275                     (goto-char (point-min))
1276                     (save-restriction
1277                       (re-search-forward "^cc:" nil nil cc-count)
1278                       (forward-line -1)
1279                       (narrow-to-region (point) (point-max))
1280                       (gnus-article-hide-header "cc"))
1281                     (setq cc-count (1- cc-count)))))))))))))
1282
1283 (defun gnus-article-hide-header (header)
1284   (save-excursion
1285     (goto-char (point-min))
1286     (when (re-search-forward (concat "^" header ":") nil t)
1287       (gnus-article-hide-text-type
1288        (progn (beginning-of-line) (point))
1289        (progn
1290          (end-of-line)
1291          (if (re-search-forward "^[^ \t]" nil t)
1292              (match-beginning 0)
1293            (point-max)))
1294        'boring-headers))))
1295
1296 (defun article-toggle-headers (&optional arg)
1297   "Toggle hiding of headers.  If given a negative prefix, always show;
1298 if given a positive prefix, always hide."
1299   (interactive (gnus-article-hidden-arg))
1300   (let ((force (when (numberp arg)
1301                  (cond ((> arg 0) 'always-hide)
1302                        ((< arg 0) 'always-show))))
1303         (window (get-buffer-window gnus-article-buffer))
1304         (header-end (point-min))
1305         header-start field-end field-start
1306         (inhibit-point-motion-hooks t)
1307         (inhibit-read-only t)
1308         buffer-read-only)
1309     (save-restriction
1310       (widen)
1311       (while (and (setq header-start
1312                         (text-property-any header-end (point-max)
1313                                            'article-treated-header t))
1314                   (setq header-end
1315                         (text-property-not-all header-start (point-max)
1316                                                'article-treated-header t)))
1317         (setq field-end header-start)
1318         (cond
1319          (;; Hide exposed invisible fields.
1320           (and (not (eq 'always-show force))
1321                (setq field-start
1322                      (text-property-any field-end header-end
1323                                         'exposed-invisible-field t)))
1324           (while (and field-start
1325                       (setq field-end (text-property-not-all
1326                                        field-start header-end
1327                                        'exposed-invisible-field t)))
1328             (add-text-properties field-start field-end gnus-hidden-properties)
1329             (setq field-start (text-property-any field-end header-end
1330                                                  'exposed-invisible-field t)))
1331           (put-text-property header-start header-end
1332                              'exposed-invisible-field nil))
1333          (;; Expose invisible fields.
1334           (and (not (eq 'always-hide force))
1335                (setq field-start
1336                      (text-property-any field-end header-end 'invisible t)))
1337           (while (and field-start
1338                       (setq field-end (text-property-not-all
1339                                        field-start header-end
1340                                        'invisible t)))
1341             ;; If the invisible text is not terminated with newline, we
1342             ;; won't expose it.  Because it may be created by x-face-mule.
1343             ;; BTW, XEmacs sometimes fail in putting a invisible text
1344             ;; property with `gnus-article-hide-text' (really?).  In that
1345             ;; case, the invisible text might be started from the middle of
1346             ;; a line so we will expose the sort of thing.
1347             (when (or (not (or (eq header-start field-start)
1348                                (eq ?\n (char-before field-start))))
1349                       (eq ?\n (char-before field-end)))
1350               (remove-text-properties field-start field-end
1351                                       gnus-hidden-properties)
1352               (put-text-property field-start field-end
1353                                  'exposed-invisible-field t))
1354             (setq field-start (text-property-any field-end header-end
1355                                                  'invisible t))))
1356          (;; Hide fields.
1357           (not (eq 'always-show force))
1358           (narrow-to-region header-start header-end)
1359           (article-hide-headers)
1360           ;; Re-display X-Face image under XEmacs.
1361           (when (and gnus-xemacs
1362                      (gnus-functionp gnus-article-x-face-command))
1363             (let ((func (cadr (assq 'gnus-treat-display-xface
1364                                     gnus-treatment-function-alist)))
1365                   (condition 'head))
1366               (when (and (not gnus-inhibit-treatment)
1367                          func
1368                          (gnus-treat-predicate gnus-treat-display-xface))
1369                 (funcall func)
1370                 (put-text-property header-start header-end 'read-only nil))))
1371           (widen))
1372          ))
1373       (goto-char (point-min))
1374       (when window
1375         (set-window-start window (point-min))))))
1376
1377 (defvar gnus-article-normalized-header-length 40
1378   "Length of normalized headers.")
1379
1380 (defun article-normalize-headers ()
1381   "Make all header lines 40 characters long."
1382   (interactive)
1383   (let ((buffer-read-only nil)
1384         column)
1385     (save-excursion
1386       (save-restriction
1387         (article-narrow-to-head)
1388         (while (not (eobp))
1389           (cond
1390            ((< (setq column (- (gnus-point-at-eol) (point)))
1391                gnus-article-normalized-header-length)
1392             (end-of-line)
1393             (insert (make-string
1394                      (- gnus-article-normalized-header-length column)
1395                      ? )))
1396            ((> column gnus-article-normalized-header-length)
1397             (gnus-put-text-property
1398              (progn
1399                (forward-char gnus-article-normalized-header-length)
1400                (point))
1401              (gnus-point-at-eol)
1402              'invisible t))
1403            (t
1404             ;; Do nothing.
1405             ))
1406           (forward-line 1))))))
1407
1408 (defun article-treat-dumbquotes ()
1409   "Translate M******** sm*rtq**t*s into proper text.
1410 Note that this function guesses whether a character is a sm*rtq**t* or
1411 not, so it should only be used interactively."
1412   (interactive)
1413   (article-translate-strings gnus-article-dumbquotes-map))
1414
1415 (defun article-translate-characters (from to)
1416   "Translate all characters in the body of the article according to FROM and TO.
1417 FROM is a string of characters to translate from; to is a string of
1418 characters to translate to."
1419   (save-excursion
1420     (when (article-goto-body)
1421       (let ((buffer-read-only nil)
1422             (x (make-string 225 ?x))
1423             (i -1))
1424         (while (< (incf i) (length x))
1425           (aset x i i))
1426         (setq i 0)
1427         (while (< i (length from))
1428           (aset x (aref from i) (aref to i))
1429           (incf i))
1430         (translate-region (point) (point-max) x)))))
1431
1432 (defun article-translate-strings (map)
1433   "Translate all string in the body of the article according to MAP.
1434 MAP is an alist where the elements are on the form (\"from\" \"to\")."
1435   (save-excursion
1436     (when (article-goto-body)
1437       (let ((buffer-read-only nil)
1438             elem)
1439         (while (setq elem (pop map))
1440           (save-excursion
1441             (while (search-forward (car elem) nil t)
1442               (replace-match (cadr elem)))))))))
1443
1444 (defun article-treat-overstrike ()
1445   "Translate overstrikes into bold text."
1446   (interactive)
1447   (save-excursion
1448     (when (article-goto-body)
1449       (let ((buffer-read-only nil))
1450         (while (search-forward "\b" nil t)
1451           (let ((next (char-after))
1452                 start end previous)
1453             (backward-char 2)
1454             (setq start (point)
1455                   previous (char-after))
1456             (forward-char 3)
1457             (setq end (point))
1458             (backward-char)
1459             ;; We do the boldification/underlining by hiding the
1460             ;; overstrikes and putting the proper text property
1461             ;; on the letters.
1462             (cond
1463              ((eq next previous)
1464               (gnus-article-hide-text-type start (point) 'overstrike)
1465               (put-text-property (point) end 'face 'bold))
1466              ((eq next ?_)
1467               (gnus-article-hide-text-type
1468                (1- (point)) (1+ (point)) 'overstrike)
1469               (put-text-property
1470                start (1- (point)) 'face 'underline))
1471              ((eq previous ?_)
1472               (gnus-article-hide-text-type start (point) 'overstrike)
1473               (put-text-property
1474                (point) end 'face 'underline)))))))))
1475
1476 (defun article-fill-long-lines ()
1477   "Fill lines that are wider than the window width."
1478   (interactive)
1479   (save-excursion
1480     (let ((buffer-read-only nil)
1481           (width (window-width (get-buffer-window (current-buffer)))))
1482       (save-restriction
1483         (article-goto-body)
1484         (let ((adaptive-fill-mode nil))
1485           (while (not (eobp))
1486             (end-of-line)
1487             (when (>= (current-column) (min fill-column width))
1488               (narrow-to-region (point) (gnus-point-at-bol))
1489               (fill-paragraph nil)
1490               (goto-char (point-max))
1491               (widen))
1492             (forward-line 1)))))))
1493
1494 (defun article-capitalize-sentences ()
1495   "Capitalize the first word in each sentence."
1496   (interactive)
1497   (save-excursion
1498     (let ((buffer-read-only nil)
1499           (paragraph-start "^[\n\^L]"))
1500       (article-goto-body)
1501       (while (not (eobp))
1502         (capitalize-word 1)
1503         (forward-sentence)))))
1504
1505 (defun article-remove-cr ()
1506   "Remove trailing CRs and then translate remaining CRs into LFs."
1507   (interactive)
1508   (save-excursion
1509     (let ((buffer-read-only nil))
1510       (goto-char (point-min))
1511       (while (re-search-forward "\r+$" nil t)
1512         (replace-match "" t t))
1513       (goto-char (point-min))
1514       (while (search-forward "\r" nil t)
1515         (replace-match "\n" t t)))))
1516
1517 (defun article-remove-trailing-blank-lines ()
1518   "Remove all trailing blank lines from the article."
1519   (interactive)
1520   (save-excursion
1521     (let ((buffer-read-only nil))
1522       (goto-char (point-max))
1523       (delete-region
1524        (point)
1525        (progn
1526          (while (and (not (bobp))
1527                      (looking-at "^[ \t]*$")
1528                      (not (gnus-annotation-in-region-p
1529                            (point) (gnus-point-at-eol))))
1530            (forward-line -1))
1531          (forward-line 1)
1532          (point))))))
1533
1534 (defun article-display-x-face (&optional force)
1535   "Look for an X-Face header and display it if present."
1536   (interactive (list 'force))
1537   (save-excursion
1538     ;; Delete the old process, if any.
1539     (when (process-status "article-x-face")
1540       (delete-process "article-x-face"))
1541     (let ((inhibit-point-motion-hooks t)
1542           (case-fold-search t)
1543           from last)
1544       (save-restriction
1545         (article-narrow-to-head)
1546         (goto-char (point-min))
1547         (setq from (message-fetch-field "from"))
1548         (goto-char (point-min))
1549         (while (and gnus-article-x-face-command
1550                     (not last)
1551                     (or force
1552                         ;; Check whether this face is censored.
1553                         (not gnus-article-x-face-too-ugly)
1554                         (and gnus-article-x-face-too-ugly from
1555                              (not (string-match gnus-article-x-face-too-ugly
1556                                                 from))))
1557                     ;; Has to be present.
1558                     (re-search-forward "^X-Face:[ \t]*" nil t))
1559           ;; This used to try to do multiple faces (`while' instead of
1560           ;; `when' above), but (a) sending multiple EOFs to xv doesn't
1561           ;; work (b) it can crash some versions of Emacs (c) are
1562           ;; multiple faces really something to encourage?
1563           (when (stringp gnus-article-x-face-command)
1564             (setq last t))
1565           ;; We now have the area of the buffer where the X-Face is stored.
1566           (save-excursion
1567             (let ((beg (point))
1568                   (end (1- (re-search-forward "^\\($\\|[^ \t]\\)" nil t))))
1569               ;; We display the face.
1570               (if (symbolp gnus-article-x-face-command)
1571                   ;; The command is a lisp function, so we call it.
1572                   (if (gnus-functionp gnus-article-x-face-command)
1573                       (funcall gnus-article-x-face-command beg end)
1574                     (error "%s is not a function" gnus-article-x-face-command))
1575                 ;; The command is a string, so we interpret the command
1576                 ;; as a, well, command, and fork it off.
1577                 (let ((process-connection-type nil))
1578                   (process-kill-without-query
1579                    (start-process
1580                     "article-x-face" nil shell-file-name shell-command-switch
1581                     gnus-article-x-face-command))
1582                   (process-send-region "article-x-face" beg end)
1583                   (process-send-eof "article-x-face"))))))))))
1584
1585 (defun article-decode-mime-words ()
1586   "Decode all MIME-encoded words in the article."
1587   (interactive)
1588   (save-excursion
1589     (set-buffer gnus-article-buffer)
1590     (let ((inhibit-point-motion-hooks t)
1591           buffer-read-only
1592           (mail-parse-charset gnus-newsgroup-charset)
1593           (mail-parse-ignored-charsets 
1594            (save-excursion (set-buffer gnus-summary-buffer)
1595                            gnus-newsgroup-ignored-charsets)))
1596       (mail-decode-encoded-word-region (point-min) (point-max)))))
1597
1598 (defun article-decode-charset (&optional prompt)
1599   "Decode charset-encoded text in the article.
1600 If PROMPT (the prefix), prompt for a coding system to use."
1601   (interactive "P")
1602   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
1603         buffer-read-only
1604         (mail-parse-charset gnus-newsgroup-charset)
1605         (mail-parse-ignored-charsets 
1606          (save-excursion (condition-case nil
1607                              (set-buffer gnus-summary-buffer)
1608                            (error))
1609                          gnus-newsgroup-ignored-charsets))
1610         ct cte ctl charset format)
1611   (save-excursion
1612     (save-restriction
1613       (article-narrow-to-head)
1614       (setq ct (message-fetch-field "Content-Type" t)
1615             cte (message-fetch-field "Content-Transfer-Encoding" t)
1616             ctl (and ct (ignore-errors
1617                           (mail-header-parse-content-type ct)))
1618             charset (cond
1619                      (prompt
1620                       (mm-read-coding-system "Charset to decode: "))
1621                      (ctl
1622                       (mail-content-type-get ctl 'charset)))
1623             format (and ctl (mail-content-type-get ctl 'format)))
1624       (when cte
1625         (setq cte (mail-header-strip cte)))
1626       (if (and ctl (not (string-match "/" (car ctl)))) 
1627           (setq ctl nil))
1628       (goto-char (point-max)))
1629     (forward-line 1)
1630     (save-restriction
1631       (narrow-to-region (point) (point-max))
1632       (when (and (eq mail-parse-charset 'gnus-decoded)
1633                  (eq (mm-body-7-or-8) '8bit))
1634         ;; The text code could have been decoded.
1635         (setq charset mail-parse-charset))
1636       (when (and (or (not ctl)
1637                      (equal (car ctl) "text/plain"))
1638                  (not format)) ;; article with format will decode later.
1639         (mm-decode-body
1640          charset (and cte (intern (downcase
1641                                    (gnus-strip-whitespace cte))))
1642          (car ctl)))))))
1643
1644 (defun article-decode-encoded-words ()
1645   "Remove encoded-word encoding from headers."
1646   (let (buffer-read-only)
1647     (let ((charset (save-excursion
1648                      (set-buffer gnus-summary-buffer)
1649                      default-mime-charset)))
1650       (mime-decode-header-in-buffer charset)
1651       )))
1652
1653 (defun article-de-quoted-unreadable (&optional force)
1654   "Translate a quoted-printable-encoded article.
1655 If FORCE, decode the article whether it is marked as quoted-printable
1656 or not."
1657   (interactive (list 'force))
1658   (save-excursion
1659     (let ((buffer-read-only nil)
1660           (type (gnus-fetch-field "content-transfer-encoding"))
1661           (charset gnus-newsgroup-charset))
1662       (when (or force
1663                 (and type (string-match "quoted-printable" (downcase type))))
1664         (article-goto-body)
1665         (quoted-printable-decode-region (point) (point-max) charset)))))
1666
1667 (defun article-de-base64-unreadable (&optional force)
1668   "Translate a base64 article.
1669 If FORCE, decode the article whether it is marked as base64 not."
1670   (interactive (list 'force))
1671   (save-excursion
1672     (let ((buffer-read-only nil)
1673           (type (gnus-fetch-field "content-transfer-encoding"))
1674           (charset gnus-newsgroup-charset))
1675       (when (or force
1676                 (and type (string-match "base64" (downcase type))))
1677         (article-goto-body)
1678         (save-restriction
1679           (narrow-to-region (point) (point-max))
1680           (base64-decode-region (point-min) (point-max))
1681           (if (mm-coding-system-p charset)
1682               (mm-decode-coding-region (point-min) (point-max) charset)))))))
1683
1684 (eval-when-compile
1685   (require 'rfc1843))
1686
1687 (defun article-decode-HZ ()
1688   "Translate a HZ-encoded article."
1689   (interactive)
1690   (require 'rfc1843)
1691   (save-excursion
1692     (let ((buffer-read-only nil))
1693       (rfc1843-decode-region (point-min) (point-max)))))
1694
1695 (defun article-wash-html ()
1696   "Format an html article."
1697   (interactive)
1698   (save-excursion
1699     (let ((buffer-read-only nil)
1700           (charset gnus-newsgroup-charset))
1701       (article-goto-body)
1702       (save-window-excursion
1703         (save-restriction
1704           (narrow-to-region (point) (point-max))
1705           (mm-setup-w3)
1706           (let ((w3-strict-width (window-width))
1707                 (url-standalone-mode t))
1708             (condition-case var
1709                 (w3-region (point-min) (point-max))
1710               (error))))))))
1711
1712 (defun article-hide-list-identifiers ()
1713   "Remove list identifies from the Subject header.
1714 The `gnus-list-identifiers' variable specifies what to do."
1715   (interactive)
1716   (save-excursion
1717     (save-restriction
1718       (let ((inhibit-point-motion-hooks t)
1719             buffer-read-only)
1720         (article-narrow-to-head)
1721         (let ((regexp (if (stringp gnus-list-identifiers) gnus-list-identifiers
1722                         (mapconcat 'identity gnus-list-identifiers " *\\|"))))
1723           (when regexp
1724             (goto-char (point-min))
1725             (when (re-search-forward
1726                    (concat "^Subject: +\\(\\(\\(Re: +\\)?\\(" regexp 
1727                            " *\\)\\)+\\(Re: +\\)?\\)")
1728                    nil t)
1729               (let ((s (or (match-string 3) (match-string 5))))
1730                 (delete-region (match-beginning 1) (match-end 1))
1731                 (when s
1732                   (goto-char (match-beginning 1))
1733                   (insert s))))))))))
1734
1735 (defun article-hide-pgp ()
1736   "Remove any PGP headers and signatures in the current article."
1737   (interactive)
1738   (save-excursion
1739     (save-restriction
1740       (let ((inhibit-point-motion-hooks t)
1741             buffer-read-only beg end)
1742         (article-goto-body)
1743         ;; Hide the "header".
1744         (when (re-search-forward "^-----BEGIN PGP SIGNED MESSAGE-----\n" nil t)
1745           (push 'pgp gnus-article-wash-types)
1746           (delete-region (match-beginning 0) (match-end 0))
1747           ;; Remove armor headers (rfc2440 6.2)
1748           (delete-region (point) (or (re-search-forward "^[ \t]*\n" nil t)
1749                                      (point)))
1750           (setq beg (point))
1751           ;; Hide the actual signature.
1752           (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
1753                (setq end (1+ (match-beginning 0)))
1754                (delete-region
1755                 end
1756                 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
1757                     (match-end 0)
1758                   ;; Perhaps we shouldn't hide to the end of the buffer
1759                   ;; if there is no end to the signature?
1760                   (point-max))))
1761           ;; Hide "- " PGP quotation markers.
1762           (when (and beg end)
1763             (narrow-to-region beg end)
1764             (goto-char (point-min))
1765             (while (re-search-forward "^- " nil t)
1766               (delete-region
1767                (match-beginning 0) (match-end 0)))
1768             (widen))
1769           (gnus-run-hooks 'gnus-article-hide-pgp-hook))))))
1770
1771 (defun article-hide-pem (&optional arg)
1772   "Toggle hiding of any PEM headers and signatures in the current article.
1773 If given a negative prefix, always show; if given a positive prefix,
1774 always hide."
1775   (interactive (gnus-article-hidden-arg))
1776   (unless (gnus-article-check-hidden-text 'pem arg)
1777     (save-excursion
1778       (let (buffer-read-only end)
1779         (goto-char (point-min))
1780         ;; Hide the horrendously ugly "header".
1781         (when (and (search-forward
1782                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
1783                     nil t)
1784                    (setq end (1+ (match-beginning 0))))
1785           (push 'pem gnus-article-wash-types)
1786           (gnus-article-hide-text-type
1787            end
1788            (if (search-forward "\n\n" nil t)
1789                (match-end 0)
1790              (point-max))
1791            'pem)
1792           ;; Hide the trailer as well
1793           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
1794                                 nil t)
1795             (gnus-article-hide-text-type
1796              (match-beginning 0) (match-end 0) 'pem)))))))
1797
1798 (defun article-strip-banner ()
1799   "Strip the banner specified by the `banner' group parameter."
1800   (interactive)
1801   (save-excursion
1802     (save-restriction
1803       (let ((inhibit-point-motion-hooks t)
1804             (banner (gnus-group-get-parameter gnus-newsgroup-name 'banner))
1805             (gnus-signature-limit nil)
1806             buffer-read-only beg end)
1807         (when banner
1808           (article-goto-body)
1809           (cond
1810            ((eq banner 'signature)
1811             (when (gnus-article-narrow-to-signature)
1812               (widen)
1813               (forward-line -1)
1814               (delete-region (point) (point-max))))
1815            ((stringp banner)
1816             (while (re-search-forward banner nil t)
1817               (delete-region (match-beginning 0) (match-end 0))))))))))
1818
1819 (defun article-babel ()
1820   "Translate article using an online translation service."
1821   (interactive)
1822   (require 'babel)
1823   (save-excursion
1824     (set-buffer gnus-article-buffer)
1825     (when (article-goto-body)
1826       (let* ((buffer-read-only nil)
1827              (start (point))
1828              (end (point-max))
1829              (orig (buffer-substring start end))
1830              (trans (babel-as-string orig)))
1831         (save-restriction
1832           (narrow-to-region start end)
1833           (delete-region start end)
1834           (insert trans))))))
1835
1836 (defun article-hide-signature (&optional arg)
1837   "Hide the signature in the current article.
1838 If given a negative prefix, always show; if given a positive prefix,
1839 always hide."
1840   (interactive (gnus-article-hidden-arg))
1841   (save-excursion
1842     (save-restriction
1843       (if (interactive-p)
1844           (progn
1845             (widen)
1846             (article-goto-body))
1847         (goto-char (point-min)))
1848       (unless (gnus-article-check-hidden-text 'signature arg)
1849         (let ((buffer-read-only nil)
1850               (button (point)))
1851           (while (setq button (text-property-any button (point-max)
1852                                                  'gnus-callback
1853                                                  'gnus-signature-toggle))
1854             (setq button (text-property-not-all button (point-max)
1855                                                 'gnus-callback
1856                                                 'gnus-signature-toggle))
1857             (when (and button (not (eobp)))
1858               (gnus-article-hide-text-type
1859                (1+ button)
1860                (next-single-property-change (1+ button) 'mime-view-entity
1861                                             nil (point-max))
1862                'signature))))))))
1863
1864 (defun article-strip-headers-in-body ()
1865   "Strip offensive headers from bodies."
1866   (interactive)
1867   (save-excursion
1868     (article-goto-body)
1869     (let ((case-fold-search t))
1870       (when (looking-at "x-no-archive:")
1871         (gnus-delete-line)))))
1872
1873 (defun article-strip-leading-blank-lines ()
1874   "Remove all blank lines from the beginning of the article."
1875   (interactive)
1876   (save-excursion
1877     (let ((inhibit-point-motion-hooks t)
1878           buffer-read-only)
1879       (when (article-goto-body)
1880         (while (and (not (eobp))
1881                     (looking-at "[ \t]*$"))
1882           (gnus-delete-line))))))
1883
1884 (defun article-narrow-to-head ()
1885   "Narrow the buffer to the head of the message.
1886 Point is left at the beginning of the narrowed-to region."
1887   (narrow-to-region
1888    (goto-char (point-min))
1889    (if (search-forward "\n\n" nil 1)
1890        (1- (point))
1891      (point-max)))
1892   (goto-char (point-min)))
1893
1894 (defun article-goto-body ()
1895   "Place point at the start of the body."
1896   (goto-char (point-min))
1897   (cond
1898    ;; This variable is only bound when dealing with separate
1899    ;; MIME body parts.
1900    (article-goto-body-goes-to-point-min-p
1901     t)
1902    ((search-forward "\n\n" nil t)
1903     t)
1904    (t
1905     (goto-char (point-max))
1906     nil)))
1907
1908 (defun article-strip-multiple-blank-lines ()
1909   "Replace consecutive blank lines with one empty line."
1910   (interactive)
1911   (save-excursion
1912     (let ((inhibit-point-motion-hooks t)
1913           buffer-read-only)
1914       ;; First make all blank lines empty.
1915       (article-goto-body)
1916       (while (re-search-forward "^[ \t]+$" nil t)
1917         (unless (gnus-annotation-in-region-p
1918                  (match-beginning 0) (match-end 0))
1919           (replace-match "" nil t)))
1920       ;; Then replace multiple empty lines with a single empty line.
1921       (article-goto-body)
1922       (while (re-search-forward "\n\n\n+" nil t)
1923         (unless (gnus-annotation-in-region-p
1924                  (match-beginning 0) (match-end 0))
1925           (replace-match "\n\n" t t))))))
1926
1927 (defun article-strip-leading-space ()
1928   "Remove all white space from the beginning of the lines in the article."
1929   (interactive)
1930   (save-excursion
1931     (let ((inhibit-point-motion-hooks t)
1932           buffer-read-only)
1933       (article-goto-body)
1934       (while (re-search-forward "^[ \t]+" nil t)
1935         (replace-match "" t t)))))
1936
1937 (defun article-strip-trailing-space ()
1938   "Remove all white space from the end of the lines in the article."
1939   (interactive)
1940   (save-excursion
1941     (let ((inhibit-point-motion-hooks t)
1942           buffer-read-only)
1943       (article-goto-body)
1944       (while (re-search-forward "[ \t]+$" nil t)
1945         (replace-match "" t t)))))
1946
1947 (defun article-strip-blank-lines ()
1948   "Strip leading, trailing and multiple blank lines."
1949   (interactive)
1950   (article-strip-leading-blank-lines)
1951   (article-remove-trailing-blank-lines)
1952   (article-strip-multiple-blank-lines))
1953
1954 (defun article-strip-all-blank-lines ()
1955   "Strip all blank lines."
1956   (interactive)
1957   (save-excursion
1958     (let ((inhibit-point-motion-hooks t)
1959           buffer-read-only)
1960       (article-goto-body)
1961       (while (re-search-forward "^[ \t]*\n" nil t)
1962         (replace-match "" t t)))))
1963
1964 (defun gnus-article-narrow-to-signature ()
1965   "Narrow to the signature; return t if a signature is found, else nil."
1966   (let ((inhibit-point-motion-hooks t))
1967     (when (gnus-article-search-signature)
1968       (forward-line 1)
1969       ;; Check whether we have some limits to what we consider
1970       ;; to be a signature.
1971       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1972                       (list gnus-signature-limit)))
1973             limit limited)
1974         (while (setq limit (pop limits))
1975           (if (or (and (integerp limit)
1976                        (< (- (point-max) (point)) limit))
1977                   (and (floatp limit)
1978                        (< (count-lines (point) (point-max)) limit))
1979                   (and (gnus-functionp limit)
1980                        (funcall limit))
1981                   (and (stringp limit)
1982                        (not (re-search-forward limit nil t))))
1983               ()                        ; This limit did not succeed.
1984             (setq limited t
1985                   limits nil)))
1986         (unless limited
1987           (narrow-to-region (point) (point-max))
1988           t)))))
1989
1990 (defun gnus-article-search-signature ()
1991   "Search the current buffer for the signature separator.
1992 Put point at the beginning of the signature separator."
1993   (let ((cur (point)))
1994     (goto-char (point-max))
1995     (if (if (stringp gnus-signature-separator)
1996             (re-search-backward gnus-signature-separator nil t)
1997           (let ((seps gnus-signature-separator))
1998             (while (and seps
1999                         (not (re-search-backward (car seps) nil t)))
2000               (pop seps))
2001             seps))
2002         t
2003       (goto-char cur)
2004       nil)))
2005
2006 (defun gnus-article-hidden-arg ()
2007   "Return the current prefix arg as a number, or 0 if no prefix."
2008   (list (if current-prefix-arg
2009             (prefix-numeric-value current-prefix-arg)
2010           0)))
2011
2012 (defun gnus-article-check-hidden-text (type arg)
2013   "Return nil if hiding is necessary.
2014 Arg can be nil or a number.  Nil and positive means hide, negative
2015 means show, 0 means toggle."
2016   (save-excursion
2017     (save-restriction
2018       (let ((hide (gnus-article-hidden-text-p type)))
2019         (cond
2020          ((or (null arg)
2021               (> arg 0))
2022           nil)
2023          ((< arg 0)
2024           (gnus-article-show-hidden-text type))
2025          (t
2026           (if (eq hide 'hidden)
2027               (gnus-article-show-hidden-text type)
2028             nil)))))))
2029
2030 (defun gnus-article-hidden-text-p (type)
2031   "Say whether the current buffer contains hidden text of type TYPE."
2032   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
2033     (while (and pos
2034                 (not (get-text-property pos 'invisible))
2035                 (not (get-text-property pos 'dummy-invisible)))
2036       (setq pos
2037             (text-property-any (1+ pos) (point-max) 'article-type type)))
2038     (if pos
2039         'hidden
2040       nil)))
2041
2042 (defun gnus-article-show-hidden-text (type &optional hide)
2043   "Show all hidden text of type TYPE.
2044 If HIDE, hide the text instead."
2045   (save-excursion
2046     (let ((buffer-read-only nil)
2047           (inhibit-point-motion-hooks t)
2048           (end (point-min))
2049           beg)
2050       (while (setq beg (text-property-any end (point-max) 'article-type type))
2051         (goto-char beg)
2052         (setq end (or
2053                    (text-property-not-all beg (point-max) 'article-type type)
2054                    (point-max)))
2055         (if hide
2056             (gnus-article-hide-text beg end gnus-hidden-properties)
2057           (gnus-article-unhide-text beg end))
2058         (goto-char end))
2059       t)))
2060
2061 (defconst article-time-units
2062   `((year . ,(* 365.25 24 60 60))
2063     (week . ,(* 7 24 60 60))
2064     (day . ,(* 24 60 60))
2065     (hour . ,(* 60 60))
2066     (minute . 60)
2067     (second . 1))
2068   "Mapping from time units to seconds.")
2069
2070 (defun article-date-ut (&optional type highlight header)
2071   "Convert DATE date to universal time in the current article.
2072 If TYPE is `local', convert to local time; if it is `lapsed', output
2073 how much time has lapsed since DATE.  For `lapsed', the value of
2074 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
2075 should replace the \"Date:\" one, or should be added below it."
2076   (interactive (list 'ut t))
2077   (let* ((header (or header
2078                      (and (eq 1 (point-min))
2079                           (mail-header-date (save-excursion
2080                                               (set-buffer gnus-summary-buffer)
2081                                               gnus-current-headers)))
2082                      (message-fetch-field "date")
2083                      ""))
2084          (date (if (vectorp header) (mail-header-date header)
2085                  header))
2086          (inhibit-point-motion-hooks t)
2087          bface eface date-pos)
2088     (when (and date (not (string= date "")))
2089       (save-excursion
2090         (save-restriction
2091           (article-narrow-to-head)
2092           (when (or (and (eq type 'lapsed)
2093                          gnus-article-date-lapsed-new-header
2094                          ;; Attempt to get the face of X-Sent first.
2095                          (re-search-forward "^X-Sent:[ \t]" nil t))
2096                     (re-search-forward "^Date:[ \t]" nil t)
2097                     ;; If Date is missing, try again for X-Sent.
2098                     (re-search-forward "^X-Sent:[ \t]" nil t))
2099             (setq bface (get-text-property (gnus-point-at-bol) 'face)
2100                   date (or (get-text-property (gnus-point-at-bol)
2101                                                 'original-date)
2102                              date)
2103                   eface (get-text-property (1- (gnus-point-at-eol))
2104                                            'face)))
2105           (let ((buffer-read-only nil))
2106             ;; Delete any old X-Sent headers.
2107             (when (setq date-pos
2108                         (text-property-any (point-min) (point-max)
2109                                            'article-date-lapsed t))
2110               (goto-char (setq date-pos (set-marker (make-marker) date-pos)))
2111               (delete-region (match-beginning 0)
2112                              (progn (forward-line 1) (point))))
2113             (goto-char (point-min))
2114             ;; Delete any old Date headers.
2115             (while (re-search-forward "^Date:[ \t]" nil t)
2116               (unless date-pos
2117                 (setq date-pos (match-beginning 0)))
2118               (unless (and (eq type 'lapsed)
2119                            gnus-article-date-lapsed-new-header)
2120                 (delete-region (match-beginning 0)
2121                                (progn (message-next-header) (point)))))
2122             (if date-pos
2123                 (progn
2124                   (goto-char date-pos)
2125                   (unless (bolp)
2126                     ;; Possibly, Date has been deleted.
2127                     (insert "\n"))
2128                   (when (and (eq type 'lapsed)
2129                              gnus-article-date-lapsed-new-header
2130                              (looking-at "Date:"))
2131                     (forward-line 1)))
2132               (goto-char (point-min)))
2133             (insert (article-make-date-line date type))
2134             (when (eq type 'lapsed)
2135               (put-text-property (gnus-point-at-bol) (point)
2136                                  'article-date-lapsed t))
2137             (insert "\n")
2138             (forward-line -1)
2139             ;; Do highlighting.
2140             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
2141               (put-text-property (match-beginning 1) (1+ (match-end 1))
2142                                  'original-date date)
2143               (put-text-property (match-beginning 1) (1+ (match-end 1))
2144                                  'face bface)
2145               (put-text-property (match-beginning 2) (match-end 2)
2146                                  'face eface))))))))
2147
2148 (defun article-make-date-line (date type)
2149   "Return a DATE line of TYPE."
2150   (let ((time (condition-case ()
2151                   (date-to-time date)
2152                 (error '(0 0)))))
2153     (cond
2154      ;; Convert to the local timezone.  We have to slap a
2155      ;; `condition-case' round the calls to the timezone
2156      ;; functions since they aren't particularly resistant to
2157      ;; buggy dates.
2158      ((eq type 'local)
2159       (let ((tz (car (current-time-zone time))))
2160         (format "Date: %s %s%02d%02d" (current-time-string time)
2161                 (if (> tz 0) "+" "-") (/ (abs tz) 3600) 
2162                 (/ (% (abs tz) 3600) 60))))
2163      ;; Convert to Universal Time.
2164      ((eq type 'ut)
2165       (concat "Date: "
2166               (current-time-string
2167                (let* ((e (parse-time-string date))
2168                       (tm (apply 'encode-time e))
2169                       (ms (car tm))
2170                       (ls (- (cadr tm) (car (current-time-zone time)))))
2171                  (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
2172                        ((> ls 65535) (list (1+ ms) (- ls 65536)))
2173                        (t (list ms ls)))))
2174               " UT"))
2175      ;; Get the original date from the article.
2176      ((eq type 'original)
2177       (concat "Date: " (if (string-match "\n+$" date)
2178                            (substring date 0 (match-beginning 0))
2179                          date)))
2180      ;; Let the user define the format.
2181      ((eq type 'user)
2182       (if (gnus-functionp gnus-article-time-format)
2183           (funcall gnus-article-time-format time)
2184         (concat
2185          "Date: "
2186          (format-time-string gnus-article-time-format time))))
2187      ;; ISO 8601.
2188      ((eq type 'iso8601)
2189       (let ((tz (car (current-time-zone time))))
2190         (concat
2191          "Date: "
2192          (format-time-string "%Y%m%dT%H%M%S" time)
2193          (format "%s%02d%02d"
2194                  (if (> tz 0) "+" "-") (/ (abs tz) 3600) 
2195                  (/ (% (abs tz) 3600) 60)))))
2196      ;; Do an X-Sent lapsed format.
2197      ((eq type 'lapsed)
2198       ;; If the date is seriously mangled, the timezone functions are
2199       ;; liable to bug out, so we ignore all errors.
2200       (let* ((now (current-time))
2201              (real-time (subtract-time now time))
2202              (real-sec (and real-time
2203                             (+ (* (float (car real-time)) 65536)
2204                                (cadr real-time))))
2205              (sec (and real-time (abs real-sec)))
2206              num prev)
2207         (cond
2208          ((null real-time)
2209           "X-Sent: Unknown")
2210          ((zerop sec)
2211           "X-Sent: Now")
2212          (t
2213           (concat
2214            "X-Sent: "
2215            ;; This is a bit convoluted, but basically we go
2216            ;; through the time units for years, weeks, etc,
2217            ;; and divide things to see whether that results
2218            ;; in positive answers.
2219            (mapconcat
2220             (lambda (unit)
2221               (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
2222                   ;; The (remaining) seconds are too few to
2223                   ;; be divided into this time unit.
2224                   ""
2225                 ;; It's big enough, so we output it.
2226                 (setq sec (- sec (* num (cdr unit))))
2227                 (prog1
2228                     (concat (if prev ", " "") (int-to-string
2229                                                (floor num))
2230                             " " (symbol-name (car unit))
2231                             (if (> num 1) "s" ""))
2232                   (setq prev t))))
2233             article-time-units "")
2234            ;; If dates are odd, then it might appear like the
2235            ;; article was sent in the future.
2236            (if (> real-sec 0)
2237                " ago"
2238              " in the future"))))))
2239      (t
2240       (error "Unknown conversion type: %s" type)))))
2241
2242 (defun article-date-local (&optional highlight)
2243   "Convert the current article date to the local timezone."
2244   (interactive (list t))
2245   (article-date-ut 'local highlight))
2246
2247 (defun article-date-original (&optional highlight)
2248   "Convert the current article date to what it was originally.
2249 This is only useful if you have used some other date conversion
2250 function and want to see what the date was before converting."
2251   (interactive (list t))
2252   (article-date-ut 'original highlight))
2253
2254 (defun article-date-lapsed (&optional highlight)
2255   "Convert the current article date to time lapsed since it was sent."
2256   (interactive (list t))
2257   (article-date-ut 'lapsed highlight))
2258
2259 (defun article-update-date-lapsed ()
2260   "Function to be run from a timer to update the lapsed time line."
2261   (let (deactivate-mark)
2262     (save-excursion
2263       (ignore-errors
2264         (walk-windows
2265          (lambda (w)
2266            (set-buffer (window-buffer w))
2267            (when (eq major-mode 'gnus-article-mode)
2268              (goto-char (point-min))
2269              (when (re-search-forward "^X-Sent:" nil t)
2270                (article-date-lapsed t))))
2271          nil 'visible)))))
2272
2273 (defun gnus-start-date-timer (&optional n)
2274   "Start a timer to update the X-Sent header in the article buffers.
2275 The numerical prefix says how frequently (in seconds) the function
2276 is to run."
2277   (interactive "p")
2278   (unless n
2279     (setq n 1))
2280   (gnus-stop-date-timer)
2281   (setq article-lapsed-timer
2282         (nnheader-run-at-time 1 n 'article-update-date-lapsed)))
2283
2284 (defun gnus-stop-date-timer ()
2285   "Stop the X-Sent timer."
2286   (interactive)
2287   (when article-lapsed-timer
2288     (nnheader-cancel-timer article-lapsed-timer)
2289     (setq article-lapsed-timer nil)))
2290
2291 (defun article-date-user (&optional highlight)
2292   "Convert the current article date to the user-defined format.
2293 This format is defined by the `gnus-article-time-format' variable."
2294   (interactive (list t))
2295   (article-date-ut 'user highlight))
2296
2297 (defun article-date-iso8601 (&optional highlight)
2298   "Convert the current article date to ISO8601."
2299   (interactive (list t))
2300   (article-date-ut 'iso8601 highlight))
2301
2302 (defun article-show-all ()
2303   "Show all hidden text in the article buffer."
2304   (interactive)
2305   (save-excursion
2306     (widen)
2307     (let ((buffer-read-only nil))
2308       (gnus-article-unhide-text (point-min) (point-max))
2309       (gnus-remove-text-with-property 'gnus-prev)
2310       (gnus-remove-text-with-property 'gnus-next))))
2311
2312 (defun article-show-all-headers ()
2313   "Show all hidden headers in the article buffer."
2314   (interactive)
2315   (save-excursion
2316     (save-restriction
2317       (widen)
2318       (article-narrow-to-head)
2319       (let ((buffer-read-only nil))
2320         (gnus-article-unhide-text (point-min) (point-max))))))
2321
2322 (defun article-emphasize (&optional arg)
2323   "Emphasize text according to `gnus-emphasis-alist'."
2324   (interactive (gnus-article-hidden-arg))
2325   (unless (gnus-article-check-hidden-text 'emphasis arg)
2326     (save-excursion
2327       (let ((alist (or 
2328                     (condition-case nil
2329                         (with-current-buffer gnus-summary-buffer 
2330                           gnus-article-emphasis-alist) 
2331                       (error))
2332                     gnus-emphasis-alist))
2333             (buffer-read-only nil)
2334             (props (append '(article-type emphasis)
2335                            gnus-hidden-properties))
2336             regexp elem beg invisible visible face)
2337         (article-goto-body)
2338         (setq beg (point))
2339         (while (setq elem (pop alist))
2340           (goto-char beg)
2341           (setq regexp (car elem)
2342                 invisible (nth 1 elem)
2343                 visible (nth 2 elem)
2344                 face (nth 3 elem))
2345           (while (re-search-forward regexp nil t)
2346             (when (and (match-beginning visible) (match-beginning invisible))
2347               (push 'emphasis gnus-article-wash-types)
2348               (gnus-article-hide-text
2349                (match-beginning invisible) (match-end invisible) props)
2350               (gnus-article-unhide-text-type
2351                (match-beginning visible) (match-end visible) 'emphasis)
2352               (gnus-put-text-property-excluding-newlines
2353                (match-beginning visible) (match-end visible) 'face face)
2354               (goto-char (match-end invisible)))))))))
2355
2356 (defun gnus-article-setup-highlight-words (&optional highlight-words)
2357   "Setup newsgroup emphasis alist."
2358   (unless gnus-article-emphasis-alist
2359     (let ((name (and gnus-newsgroup-name
2360                      (gnus-group-real-name gnus-newsgroup-name))))
2361       (make-local-variable 'gnus-article-emphasis-alist)
2362       (setq gnus-article-emphasis-alist
2363             (nconc
2364              (let ((alist gnus-group-highlight-words-alist) elem highlight)
2365                (while (setq elem (pop alist))
2366                  (when (and name (string-match (car elem) name))
2367                    (setq alist nil
2368                          highlight (copy-sequence (cdr elem)))))
2369                highlight)
2370              (copy-sequence highlight-words)
2371              (if gnus-newsgroup-name
2372                  (copy-sequence (gnus-group-find-parameter
2373                                  gnus-newsgroup-name 'highlight-words t)))
2374              gnus-emphasis-alist)))))
2375
2376 (defvar gnus-summary-article-menu)
2377 (defvar gnus-summary-post-menu)
2378
2379 ;;; Saving functions.
2380
2381 (defun gnus-article-save (save-buffer file &optional num)
2382   "Save the currently selected article."
2383   (unless gnus-save-all-headers
2384     ;; Remove headers according to `gnus-saved-headers'.
2385     (let ((gnus-visible-headers
2386            (or gnus-saved-headers gnus-visible-headers))
2387           (gnus-article-buffer save-buffer))
2388       (save-excursion
2389         (set-buffer save-buffer)
2390         (article-hide-headers 1 t))))
2391   (save-window-excursion
2392     (if (not gnus-default-article-saver)
2393         (error "No default saver is defined")
2394       ;; !!! Magic!  The saving functions all save
2395       ;; `gnus-save-article-buffer' (or so they think), but we
2396       ;; bind that variable to our save-buffer.
2397       (set-buffer gnus-article-buffer)
2398       (let* ((gnus-save-article-buffer save-buffer)
2399              (filename
2400               (cond
2401                ((not gnus-prompt-before-saving) 'default)
2402                ((eq gnus-prompt-before-saving 'always) nil)
2403                (t file)))
2404              (gnus-number-of-articles-to-be-saved
2405               (when (eq gnus-prompt-before-saving t)
2406                 num)))                  ; Magic
2407         (set-buffer gnus-article-current-summary)
2408         (funcall gnus-default-article-saver filename)))))
2409
2410 (defun gnus-read-save-file-name (prompt &optional filename
2411                                         function group headers variable)
2412   (let ((default-name
2413           (funcall function group headers (symbol-value variable)))
2414         result)
2415     (setq
2416      result
2417      (cond
2418       ((eq filename 'default)
2419        default-name)
2420       ((eq filename t)
2421        default-name)
2422       (filename filename)
2423       (t
2424        (let* ((split-name (gnus-get-split-value gnus-split-methods))
2425               (prompt
2426                (format prompt
2427                        (if (and gnus-number-of-articles-to-be-saved
2428                                 (> gnus-number-of-articles-to-be-saved 1))
2429                            (format "these %d articles"
2430                                    gnus-number-of-articles-to-be-saved)
2431                          "this article")))
2432               (file
2433                ;; Let the split methods have their say.
2434                (cond
2435                 ;; No split name was found.
2436                 ((null split-name)
2437                  (read-file-name
2438                   (concat prompt " (default "
2439                           (file-name-nondirectory default-name) ") ")
2440                   (file-name-directory default-name)
2441                   default-name))
2442                 ;; A single group name is returned.
2443                 ((stringp split-name)
2444                  (setq default-name
2445                        (funcall function split-name headers
2446                                 (symbol-value variable)))
2447                  (read-file-name
2448                   (concat prompt " (default "
2449                           (file-name-nondirectory default-name) ") ")
2450                   (file-name-directory default-name)
2451                   default-name))
2452                 ;; A single split name was found
2453                 ((= 1 (length split-name))
2454                  (let* ((name (expand-file-name
2455                                (car split-name) gnus-article-save-directory))
2456                         (dir (cond ((file-directory-p name)
2457                                     (file-name-as-directory name))
2458                                    ((file-exists-p name) name)
2459                                    (t gnus-article-save-directory))))
2460                    (read-file-name
2461                     (concat prompt " (default " name ") ")
2462                     dir name)))
2463                 ;; A list of splits was found.
2464                 (t
2465                  (setq split-name (nreverse split-name))
2466                  (let (result)
2467                    (let ((file-name-history
2468                           (nconc split-name file-name-history)))
2469                      (setq result
2470                            (expand-file-name
2471                             (read-file-name
2472                              (concat prompt " (`M-p' for defaults) ")
2473                              gnus-article-save-directory
2474                              (car split-name))
2475                             gnus-article-save-directory)))
2476                    (car (push result file-name-history)))))))
2477          ;; Create the directory.
2478          (gnus-make-directory (file-name-directory file))
2479          ;; If we have read a directory, we append the default file name.
2480          (when (file-directory-p file)
2481            (setq file (concat (file-name-as-directory file)
2482                               (file-name-nondirectory default-name))))
2483          ;; Possibly translate some characters.
2484          (nnheader-translate-file-chars file)))))
2485     (gnus-make-directory (file-name-directory result))
2486     (set variable result)))
2487
2488 (defun gnus-article-archive-name (group)
2489   "Return the first instance of an \"Archive-name\" in the current buffer."
2490   (let ((case-fold-search t))
2491     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
2492       (nnheader-concat gnus-article-save-directory
2493                        (match-string 1)))))
2494
2495 (defun gnus-article-nndoc-name (group)
2496   "If GROUP is an nndoc group, return the name of the parent group."
2497   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
2498     (gnus-group-get-parameter group 'save-article-group)))
2499
2500 (defun gnus-summary-save-in-rmail (&optional filename)
2501   "Append this article to Rmail file.
2502 Optional argument FILENAME specifies file name.
2503 Directory to save to is default to `gnus-article-save-directory'."
2504   (setq filename (gnus-read-save-file-name
2505                   "Save %s in rmail file:" filename
2506                   gnus-rmail-save-name gnus-newsgroup-name
2507                   gnus-current-headers 'gnus-newsgroup-last-rmail))
2508   (gnus-eval-in-buffer-window gnus-save-article-buffer
2509     (save-excursion
2510       (save-restriction
2511         (widen)
2512         (gnus-output-to-rmail filename))))
2513   filename)
2514
2515 (defun gnus-summary-save-in-mail (&optional filename)
2516   "Append this article to Unix mail file.
2517 Optional argument FILENAME specifies file name.
2518 Directory to save to is default to `gnus-article-save-directory'."
2519   (setq filename (gnus-read-save-file-name
2520                   "Save %s in Unix mail file:" filename
2521                   gnus-mail-save-name gnus-newsgroup-name
2522                   gnus-current-headers 'gnus-newsgroup-last-mail))
2523   (gnus-eval-in-buffer-window gnus-save-article-buffer
2524     (save-excursion
2525       (save-restriction
2526         (widen)
2527         (if (and (file-readable-p filename)
2528                  (mail-file-babyl-p filename))
2529             (rmail-output-to-rmail-file filename t)
2530           (gnus-output-to-mail filename)))))
2531   filename)
2532
2533 (defun gnus-summary-save-in-file (&optional filename overwrite)
2534   "Append this article to file.
2535 Optional argument FILENAME specifies file name.
2536 Directory to save to is default to `gnus-article-save-directory'."
2537   (setq filename (gnus-read-save-file-name
2538                   "Save %s in file:" filename
2539                   gnus-file-save-name gnus-newsgroup-name
2540                   gnus-current-headers 'gnus-newsgroup-last-file))
2541   (gnus-eval-in-buffer-window gnus-save-article-buffer
2542     (save-excursion
2543       (save-restriction
2544         (widen)
2545         (when (and overwrite
2546                    (file-exists-p filename))
2547           (delete-file filename))
2548         (gnus-output-to-file filename))))
2549   filename)
2550
2551 (defun gnus-summary-write-to-file (&optional filename)
2552   "Write this article to a file.
2553 Optional argument FILENAME specifies file name.
2554 The directory to save in defaults to `gnus-article-save-directory'."
2555   (gnus-summary-save-in-file nil t))
2556
2557 (defun gnus-summary-save-body-in-file (&optional filename)
2558   "Append this article body to a file.
2559 Optional argument FILENAME specifies file name.
2560 The directory to save in defaults to `gnus-article-save-directory'."
2561   (setq filename (gnus-read-save-file-name
2562                   "Save %s body in file:" filename
2563                   gnus-file-save-name gnus-newsgroup-name
2564                   gnus-current-headers 'gnus-newsgroup-last-file))
2565   (gnus-eval-in-buffer-window gnus-save-article-buffer
2566     (save-excursion
2567       (save-restriction
2568         (widen)
2569         (when (article-goto-body)
2570           (narrow-to-region (point) (point-max)))
2571         (gnus-output-to-file filename))))
2572   filename)
2573
2574 (defun gnus-summary-save-in-pipe (&optional command)
2575   "Pipe this article to subprocess."
2576   (setq command
2577         (cond ((and (eq command 'default)
2578                     gnus-last-shell-command)
2579                gnus-last-shell-command)
2580               (command command)
2581               (t (read-string
2582                   (format
2583                    "Shell command on %s: "
2584                    (if (and gnus-number-of-articles-to-be-saved
2585                             (> gnus-number-of-articles-to-be-saved 1))
2586                        (format "these %d articles"
2587                                gnus-number-of-articles-to-be-saved)
2588                      "this article"))
2589                   gnus-last-shell-command))))
2590   (when (string-equal command "")
2591     (setq command gnus-last-shell-command))
2592   (gnus-eval-in-buffer-window gnus-article-buffer
2593     (save-restriction
2594       (widen)
2595       (shell-command-on-region (point-min) (point-max) command nil)))
2596   (setq gnus-last-shell-command command))
2597
2598 ;;; Article file names when saving.
2599
2600 (defun gnus-capitalize-newsgroup (newsgroup)
2601   "Capitalize NEWSGROUP name."
2602   (when (not (zerop (length newsgroup)))
2603     (concat (char-to-string (upcase (aref newsgroup 0)))
2604             (substring newsgroup 1))))
2605
2606 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
2607   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2608 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
2609 Otherwise, it is like ~/News/news/group/num."
2610   (let ((default
2611           (expand-file-name
2612            (concat (if (gnus-use-long-file-name 'not-save)
2613                        (gnus-capitalize-newsgroup newsgroup)
2614                      (gnus-newsgroup-directory-form newsgroup))
2615                    "/" (int-to-string (mail-header-number headers)))
2616            gnus-article-save-directory)))
2617     (if (and last-file
2618              (string-equal (file-name-directory default)
2619                            (file-name-directory last-file))
2620              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
2621         default
2622       (or last-file default))))
2623
2624 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
2625   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2626 If variable `gnus-use-long-file-name' is non-nil, it is
2627 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
2628   (let ((default
2629           (expand-file-name
2630            (concat (if (gnus-use-long-file-name 'not-save)
2631                        newsgroup
2632                      (gnus-newsgroup-directory-form newsgroup))
2633                    "/" (int-to-string (mail-header-number headers)))
2634            gnus-article-save-directory)))
2635     (if (and last-file
2636              (string-equal (file-name-directory default)
2637                            (file-name-directory last-file))
2638              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
2639         default
2640       (or last-file default))))
2641
2642 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
2643   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2644 If variable `gnus-use-long-file-name' is non-nil, it is
2645 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
2646   (or last-file
2647       (expand-file-name
2648        (if (gnus-use-long-file-name 'not-save)
2649            newsgroup
2650          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
2651        gnus-article-save-directory)))
2652
2653 (eval-and-compile
2654   (mapcar
2655    (lambda (func)
2656      (let (afunc gfunc)
2657        (if (consp func)
2658            (setq afunc (car func)
2659                  gfunc (cdr func))
2660          (setq afunc func
2661                gfunc (intern (format "gnus-%s" func))))
2662        (defalias gfunc
2663          (if (fboundp afunc)
2664            `(lambda (&optional interactive &rest args)
2665               ,(documentation afunc t)
2666               (interactive (list t))
2667               (save-excursion
2668                 (set-buffer gnus-article-buffer)
2669                 (if interactive
2670                     (call-interactively ',afunc)
2671                   (apply ',afunc args))))))))
2672    '(article-hide-headers
2673      article-hide-boring-headers
2674      article-toggle-headers
2675      article-treat-overstrike
2676      article-fill-long-lines
2677      article-capitalize-sentences
2678      article-remove-cr
2679      article-display-x-face
2680      article-de-quoted-unreadable
2681      article-de-base64-unreadable
2682      article-decode-HZ
2683      article-wash-html
2684      article-hide-list-identifiers
2685      article-hide-pgp
2686      article-strip-banner
2687      article-babel
2688      article-hide-pem
2689      article-hide-signature
2690      article-strip-headers-in-body
2691      article-remove-trailing-blank-lines
2692      article-strip-leading-blank-lines
2693      article-strip-multiple-blank-lines
2694      article-strip-leading-space
2695      article-strip-trailing-space
2696      article-strip-blank-lines
2697      article-strip-all-blank-lines
2698      article-date-local
2699      article-date-iso8601
2700      article-date-original
2701      article-date-ut
2702      article-decode-mime-words
2703      article-decode-charset
2704      article-decode-encoded-words
2705      article-date-user
2706      article-date-lapsed
2707      article-emphasize
2708      article-treat-dumbquotes
2709      article-normalize-headers
2710      (article-show-all-headers . gnus-article-show-all-headers)
2711      (article-show-all . gnus-article-show-all))))
2712 \f
2713 ;;;
2714 ;;; Gnus article mode
2715 ;;;
2716
2717 (put 'gnus-article-mode 'mode-class 'special)
2718
2719 (gnus-define-keys gnus-article-mode-map
2720   " " gnus-article-goto-next-page
2721   "\177" gnus-article-goto-prev-page
2722   [delete] gnus-article-goto-prev-page
2723   [backspace] gnus-article-goto-prev-page
2724   "\C-c^" gnus-article-refer-article
2725   "h" gnus-article-show-summary
2726   "s" gnus-article-show-summary
2727   "\C-c\C-m" gnus-article-mail
2728   "?" gnus-article-describe-briefly
2729   "e" gnus-summary-edit-article
2730   "<" beginning-of-buffer
2731   ">" end-of-buffer
2732   "\C-c\C-i" gnus-info-find-node
2733   "\C-c\C-b" gnus-bug
2734
2735   "\C-d" gnus-article-read-summary-keys
2736   "\M-*" gnus-article-read-summary-keys
2737   "\M-#" gnus-article-read-summary-keys
2738   "\M-^" gnus-article-read-summary-keys
2739   "\M-g" gnus-article-read-summary-keys)
2740
2741 ;; Define almost undefined keys to `gnus-article-read-summary-keys'.
2742 (mapcar
2743  (lambda (key)
2744    (unless (lookup-key gnus-article-mode-map key)
2745      (define-key gnus-article-mode-map key
2746        'gnus-article-read-summary-keys)))
2747  (delq nil
2748        (append
2749         (mapcar
2750          (lambda (elt)
2751            (let ((key (car elt)))
2752              (and (> (length key) 0)
2753                   (not (eq 'menu-bar (aref key 0)))
2754                   (symbolp (lookup-key gnus-summary-mode-map key))
2755                   key)))
2756          (accessible-keymaps gnus-summary-mode-map))
2757         (let ((c 127)
2758               keys)
2759           (while (>= c 32)
2760             (push (char-to-string c) keys)
2761             (decf c))
2762           keys))))
2763
2764 (defun gnus-article-make-menu-bar ()
2765   (gnus-turn-off-edit-menu 'article)
2766   (unless (boundp 'gnus-article-article-menu)
2767     (easy-menu-define
2768      gnus-article-article-menu gnus-article-mode-map ""
2769      '("Article"
2770        ["Scroll forwards" gnus-article-goto-next-page t]
2771        ["Scroll backwards" gnus-article-goto-prev-page t]
2772        ["Show summary" gnus-article-show-summary t]
2773        ["Fetch Message-ID at point" gnus-article-refer-article t]
2774        ["Mail to address at point" gnus-article-mail t]
2775        ["Send a bug report" gnus-bug t]))
2776
2777     (easy-menu-define
2778      gnus-article-treatment-menu gnus-article-mode-map ""
2779      '("Treatment"
2780        ["Hide headers" gnus-article-toggle-headers t]
2781        ["Hide signature" gnus-article-hide-signature t]
2782        ["Hide citation" gnus-article-hide-citation t]
2783        ["Treat overstrike" gnus-article-treat-overstrike t]
2784        ["Remove carriage return" gnus-article-remove-cr t]
2785        ["Decode HZ" gnus-article-decode-HZ t]))
2786
2787     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
2788
2789     (when (boundp 'gnus-summary-post-menu)
2790       (define-key gnus-article-mode-map [menu-bar post]
2791         (cons "Post" gnus-summary-post-menu)))
2792
2793     (gnus-run-hooks 'gnus-article-menu-hook)))
2794
2795 (defun gnus-article-mode ()
2796   "Major mode for displaying an article.
2797
2798 All normal editing commands are switched off.
2799
2800 The following commands are available in addition to all summary mode
2801 commands:
2802 \\<gnus-article-mode-map>
2803 \\[gnus-article-next-page]\t Scroll the article one page forwards
2804 \\[gnus-article-prev-page]\t Scroll the article one page backwards
2805 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
2806 \\[gnus-article-show-summary]\t Display the summary buffer
2807 \\[gnus-article-mail]\t Send a reply to the address near point
2808 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
2809 \\[gnus-info-find-node]\t Go to the Gnus info node"
2810   (interactive)
2811   (when (gnus-visual-p 'article-menu 'menu)
2812     (gnus-article-make-menu-bar))
2813   (gnus-simplify-mode-line)
2814   (setq mode-name "Article")
2815   (setq major-mode 'gnus-article-mode)
2816   (make-local-variable 'minor-mode-alist)
2817   (unless (assq 'gnus-show-mime minor-mode-alist)
2818     (push (list 'gnus-show-mime " MIME") minor-mode-alist))
2819   (use-local-map gnus-article-mode-map)
2820   (gnus-update-format-specifications nil 'article-mode)
2821   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
2822   (make-local-variable 'gnus-page-broken)
2823   (make-local-variable 'gnus-button-marker-list)
2824   (make-local-variable 'gnus-article-current-summary)
2825   (make-local-variable 'gnus-article-mime-handles)
2826   (make-local-variable 'gnus-article-decoded-p)
2827   (make-local-variable 'gnus-article-mime-handle-alist)
2828   (make-local-variable 'gnus-article-wash-types)
2829   (gnus-set-default-directory)
2830   (buffer-disable-undo)
2831   (setq buffer-read-only t)
2832   (set-syntax-table gnus-article-mode-syntax-table)
2833   (gnus-run-hooks 'gnus-article-mode-hook))
2834
2835 (defun gnus-article-setup-buffer ()
2836   "Initialize the article buffer."
2837   (let* ((name (if gnus-single-article-buffer "*Article*"
2838                  (concat "*Article " gnus-newsgroup-name "*")))
2839          (original
2840           (progn (string-match "\\*Article" name)
2841                  (concat " *Original Article"
2842                          (substring name (match-end 0))))))
2843     (setq gnus-article-buffer name)
2844     (setq gnus-original-article-buffer original)
2845     (setq gnus-article-mime-handle-alist nil)
2846     ;; This might be a variable local to the summary buffer.
2847     (unless gnus-single-article-buffer
2848       (save-excursion
2849         (set-buffer gnus-summary-buffer)
2850         (setq gnus-article-buffer name)
2851         (setq gnus-original-article-buffer original)
2852         (gnus-set-global-variables)))
2853     (gnus-article-setup-highlight-words)
2854     ;; Init original article buffer.
2855     (save-excursion
2856       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
2857       (setq major-mode 'gnus-original-article-mode)
2858       (make-local-variable 'gnus-original-article))
2859     (if (get-buffer name)
2860         (save-excursion
2861           (set-buffer name)
2862           (buffer-disable-undo)
2863           (setq buffer-read-only t)
2864           (unless (eq major-mode 'gnus-article-mode)
2865             (gnus-article-mode))
2866           (current-buffer))
2867       (save-excursion
2868         (set-buffer (gnus-get-buffer-create name))
2869         (gnus-article-mode)
2870         (make-local-variable 'gnus-summary-buffer)
2871         (gnus-summary-set-local-parameters gnus-newsgroup-name)
2872         (current-buffer)))))
2873
2874 ;; Set article window start at LINE, where LINE is the number of lines
2875 ;; from the head of the article.
2876 (defun gnus-article-set-window-start (&optional line)
2877   (set-window-start
2878    (get-buffer-window gnus-article-buffer t)
2879    (save-excursion
2880      (set-buffer gnus-article-buffer)
2881      (goto-char (point-min))
2882      (if (not line)
2883          (point-min)
2884        (gnus-message 6 "Moved to bookmark")
2885        (search-forward "\n\n" nil t)
2886        (forward-line line)
2887        (point)))))
2888
2889 ;;; @@ article filters
2890 ;;;
2891
2892 (defun gnus-article-display-mime-message ()
2893   "Article display method for MIME message."
2894   ;; called from `gnus-original-article-buffer'.
2895   (let (charset all-headers)
2896     (with-current-buffer gnus-summary-buffer
2897       (setq charset default-mime-charset
2898             all-headers gnus-have-all-headers))
2899     (make-local-variable 'default-mime-charset)
2900     (setq default-mime-charset charset)
2901     (with-current-buffer (get-buffer-create gnus-article-buffer)
2902       (make-local-variable 'default-mime-charset)
2903       (setq default-mime-charset charset))
2904     (mime-display-message mime-message-structure
2905                           gnus-article-buffer nil gnus-article-mode-map)
2906     (when all-headers
2907       (gnus-article-hide-headers nil -1))
2908     )
2909   ;; `mime-display-message' changes current buffer to `gnus-article-buffer'.
2910   (make-local-variable 'mime-button-mother-dispatcher)
2911   (setq mime-button-mother-dispatcher
2912         (function gnus-article-push-button))
2913   (run-hooks 'gnus-mime-article-prepare-hook))
2914
2915 (defun gnus-article-display-traditional-message ()
2916   "Article display method for traditional message."
2917   (set-buffer gnus-article-buffer)
2918   (let (buffer-read-only)
2919     (erase-buffer)
2920     (insert-buffer-substring gnus-original-article-buffer)))
2921
2922 (defun gnus-article-make-full-mail-header (&optional number charset)
2923   "Create a new mail header structure in a raw article buffer."
2924   (unless (and number charset)
2925     (save-current-buffer
2926       (set-buffer gnus-summary-buffer)
2927       (unless number
2928         (setq number (or (cdr gnus-article-current) 0)))
2929       (unless charset
2930         (setq charset (or default-mime-charset 'x-ctext)))))
2931   (goto-char (point-min))
2932   (let ((header-end (if (search-forward "\n\n" nil t)
2933                         (1- (point))
2934                       (goto-char (point-max))))
2935         (chars (- (point-max) (point)))
2936         (lines (count-lines (point) (point-max)))
2937         (default-mime-charset charset)
2938         xref)
2939     (narrow-to-region (point-min) header-end)
2940     (setq xref (std11-fetch-field "xref"))
2941     (prog1
2942         (make-full-mail-header
2943          number
2944          (std11-fetch-field "subject")
2945          (std11-fetch-field "from")
2946          (std11-fetch-field "date")
2947          (std11-fetch-field "message-id")
2948          (std11-fetch-field "references")
2949          chars
2950          lines
2951          (when xref (concat "Xref: " xref)))
2952       (widen))))
2953
2954 (defun gnus-article-prepare (article &optional all-headers header)
2955   "Prepare ARTICLE in article mode buffer.
2956 ARTICLE should either be an article number or a Message-ID.
2957 If ARTICLE is an id, HEADER should be the article headers.
2958 If ALL-HEADERS is non-nil, no headers are hidden."
2959   (save-excursion
2960     ;; Make sure we start in a summary buffer.
2961     (unless (eq major-mode 'gnus-summary-mode)
2962       (set-buffer gnus-summary-buffer))
2963     (setq gnus-summary-buffer (current-buffer))
2964     (let* ((gnus-article (if header (mail-header-number header) article))
2965            (summary-buffer (current-buffer))
2966            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
2967            (group gnus-newsgroup-name)
2968            result)
2969       (save-excursion
2970         (gnus-article-setup-buffer)
2971         (set-buffer gnus-original-article-buffer)
2972         ;; Deactivate active regions.
2973         (when (and (boundp 'transient-mark-mode)
2974                    transient-mark-mode)
2975           (setq mark-active nil))
2976         (if (not (setq result (let ((buffer-read-only nil))
2977                                 (gnus-request-article-this-buffer
2978                                  article group))))
2979             ;; There is no such article.
2980             (save-excursion
2981               (when (and (numberp article)
2982                          (not (memq article gnus-newsgroup-sparse)))
2983                 (setq gnus-article-current
2984                       (cons gnus-newsgroup-name article))
2985                 (set-buffer gnus-summary-buffer)
2986                 (setq gnus-current-article article)
2987                 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2988                     (progn
2989                       (gnus-summary-set-agent-mark article)
2990                       (message "Message marked for downloading"))
2991                   (gnus-summary-mark-article article gnus-canceled-mark)
2992                   (unless (memq article gnus-newsgroup-sparse)
2993                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
2994           (if (or (eq result 'pseudo)
2995                   (eq result 'nneething))
2996               (progn
2997                 (save-excursion
2998                   (set-buffer summary-buffer)
2999                   (push article gnus-newsgroup-history)
3000                   (setq gnus-last-article gnus-current-article
3001                         gnus-current-article 0
3002                         gnus-current-headers nil
3003                         gnus-article-current nil)
3004                   (if (eq result 'nneething)
3005                       (gnus-configure-windows 'summary)
3006                     (gnus-configure-windows 'article))
3007                   (gnus-set-global-variables))
3008                 (let ((gnus-article-mime-handle-alist-1
3009                        gnus-article-mime-handle-alist))
3010                   (gnus-set-mode-line 'article)))
3011             ;; The result from the `request' was an actual article -
3012             ;; or at least some text that is now displayed in the
3013             ;; article buffer.
3014             (when (and (numberp article)
3015                        (not (eq article gnus-current-article)))
3016               ;; Seems like a new article has been selected.
3017               ;; `gnus-current-article' must be an article number.
3018               (save-excursion
3019                 (set-buffer summary-buffer)
3020                 (push article gnus-newsgroup-history)
3021                 (setq gnus-last-article gnus-current-article
3022                       gnus-current-article article
3023                       gnus-current-headers
3024                       (gnus-summary-article-header gnus-current-article)
3025                       gnus-article-current
3026                       (cons gnus-newsgroup-name gnus-current-article))
3027                 (unless (vectorp gnus-current-headers)
3028                   (setq gnus-current-headers nil))
3029                 (gnus-summary-goto-subject gnus-current-article)
3030                 (when (gnus-summary-show-thread)
3031                   ;; If the summary buffer really was folded, the
3032                   ;; previous goto may not actually have gone to
3033                   ;; the right article, but the thread root instead.
3034                   ;; So we go again.
3035                   (gnus-summary-goto-subject gnus-current-article))
3036                 (gnus-run-hooks 'gnus-mark-article-hook)
3037                 (gnus-set-mode-line 'summary)
3038                 (when (gnus-visual-p 'article-highlight 'highlight)
3039                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
3040                 ;; Set the global newsgroup variables here.
3041                 (gnus-set-global-variables)
3042                 (setq gnus-have-all-headers
3043                       (or all-headers gnus-show-all-headers))))
3044             (when (or (numberp article)
3045                       (stringp article))
3046               (gnus-article-prepare-display)
3047               ;; Do page break.
3048               (goto-char (point-min))
3049               (setq gnus-page-broken
3050                     (when gnus-break-pages
3051                       (gnus-narrow-to-page)
3052                       t)))
3053             (let ((gnus-article-mime-handle-alist-1
3054                    gnus-article-mime-handle-alist))
3055               (gnus-set-mode-line 'article))
3056             (article-goto-body)
3057             (set-window-point (get-buffer-window (current-buffer)) (point))
3058             (gnus-configure-windows 'article)
3059             t))))))
3060
3061 (defun gnus-article-prepare-mime-display (&optional number)
3062   (goto-char (point-min))
3063   (when (re-search-forward "^[^\t ]+:" nil t)
3064     (goto-char (match-beginning 0)))
3065   (let ((entity (if (eq 1 (point-min))
3066                     (get-text-property 1 'mime-view-entity)
3067                   (get-text-property (point) 'mime-view-entity)))
3068         last-entity child-entity next type)
3069     (setq child-entity (mime-entity-children entity))
3070     (if child-entity
3071         (setq last-entity (nth (1- (length child-entity))
3072                                child-entity))
3073       (setq last-entity entity))
3074     (save-restriction
3075       (narrow-to-region (point)
3076                         (if (search-forward "\n\n" nil t)
3077                             (point)
3078                           (point-max)))
3079       (gnus-treat-article 'head)
3080       (put-text-property (point-min) (point-max) 'article-treated-header t)
3081       (goto-char (point-max)))
3082     (while (and (not (eobp)) entity)
3083       (setq next (set-marker
3084                   (make-marker)
3085                   (next-single-property-change (point) 'mime-view-entity
3086                                                nil (point-max))))
3087       (let ((types (mime-entity-content-type entity)))
3088         (while (eq 'multipart (mime-content-type-primary-type types))
3089           (setq entity (car (mime-entity-children entity))
3090                 types (mime-entity-content-type entity)))
3091         (when types
3092           (setq type (format "%s/%s"
3093                              (mime-content-type-primary-type types)
3094                              (mime-content-type-subtype types)))))
3095       (if (string-equal type "message/rfc822")
3096           (progn
3097             (setq next (point))
3098             (let ((children (mime-entity-children entity))
3099                   last-children)
3100               (when children
3101                 (setq last-children (nth (1- (length children)) children))
3102                 (while
3103                     (and
3104                      (not (eq last-children
3105                               (get-text-property next 'mime-view-entity)))
3106                      (setq next
3107                            (next-single-property-change next
3108                                                         'mime-view-entity
3109                                                         nil (point-max)))))))
3110             (setq next (next-single-property-change next 'mime-view-entity
3111                                                     nil (point-max)))
3112             (save-restriction
3113               (narrow-to-region (point) next)
3114               (gnus-article-prepare-mime-display)
3115               (goto-char (point-max)))
3116             (setq entity (get-text-property (point) 'mime-view-entity)))
3117         (save-restriction
3118           (narrow-to-region (point) next)
3119           ;; Kludge. We have to count true number, but for now,
3120           ;; part number is here only to achieve `last'.
3121           (gnus-treat-article nil 1
3122                               (if (eq entity last-entity)
3123                                   1 2)
3124                               type)
3125           (goto-char (point-max)))
3126         (setq entity (get-text-property next 'mime-view-entity))))))
3127
3128 ;;;###autoload
3129 (defun gnus-article-prepare-display ()
3130   "Make the current buffer look like a nice article."
3131   (setq gnus-article-wash-types nil)
3132   (gnus-run-hooks 'gnus-tmp-internal-hook)
3133   (gnus-run-hooks 'gnus-article-prepare-hook)
3134   ;; Display message.
3135   (let (mime-display-header-hook mime-display-text/plain-hook)
3136     (funcall (if gnus-show-mime
3137                  (progn
3138                    (setq mime-message-structure gnus-current-headers)
3139                    (mime-buffer-entity-set-buffer-internal
3140                     mime-message-structure
3141                     gnus-original-article-buffer)
3142                    (mime-entity-set-representation-type-internal
3143                     mime-message-structure 'mime-buffer-entity)
3144                    (luna-send mime-message-structure
3145                               'initialize-instance
3146                               mime-message-structure)
3147                    gnus-article-display-method-for-mime)
3148                gnus-article-display-method-for-traditional)))
3149   ;; Associate this article with the current summary buffer.
3150   (setq gnus-article-current-summary gnus-summary-buffer)
3151   ;; Call the treatment functions.
3152   (let ((inhibit-read-only t)
3153         buffer-read-only)
3154     (save-restriction
3155       (widen)
3156       (if gnus-show-mime
3157           (gnus-article-prepare-mime-display)
3158         (narrow-to-region (goto-char (point-min))
3159                           (if (search-forward "\n\n" nil t)
3160                               (point)
3161                             (point-max)))
3162         (gnus-treat-article 'head)
3163         (put-text-property (point-min) (point-max) 'article-treated-header t)
3164         (goto-char (point-max))
3165         (widen)
3166         (narrow-to-region (point) (point-max))
3167         (gnus-treat-article nil))
3168       (put-text-property (point-min) (point-max) 'read-only nil)))
3169   ;; Perform the article display hooks.  Incidentally, this hook is
3170   ;; an obsolete variable by now.
3171   (gnus-run-hooks 'gnus-article-display-hook))
3172
3173 (defun gnus-article-decode-article-as-default-mime-charset ()
3174   "Decode an article as `default-mime-charset'.  It won't work if the
3175 value of the variable `gnus-show-mime' is non-nil."
3176   (unless gnus-show-mime
3177     (decode-mime-charset-region (point-min) (point-max)
3178                                 (with-current-buffer gnus-summary-buffer
3179                                   default-mime-charset))))
3180
3181 ;;;
3182 ;;; Gnus MIME viewing functions
3183 ;;;
3184
3185 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
3186   "The following specs can be used:
3187 %t  The MIME type
3188 %T  MIME type, along with additional info
3189 %n  The `name' parameter
3190 %d  The description, if any
3191 %l  The length of the encoded part
3192 %p  The part identifier number
3193 %e  Dots if the part isn't displayed")
3194
3195 (defvar gnus-mime-button-line-format-alist
3196   '((?t gnus-tmp-type ?s)
3197     (?T gnus-tmp-type-long ?s)
3198     (?n gnus-tmp-name ?s)
3199     (?d gnus-tmp-description ?s)
3200     (?p gnus-tmp-id ?s)
3201     (?l gnus-tmp-length ?d)
3202     (?e gnus-tmp-dots ?s)))
3203
3204 (defvar gnus-mime-button-commands
3205   '((gnus-article-press-button "\r" "Toggle Display")
3206     (gnus-mime-view-part "v" "View Interactively...")
3207     (gnus-mime-view-part-as-type "t" "View As Type...")
3208     (gnus-mime-save-part "o" "Save...")
3209     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
3210     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
3211     (gnus-mime-internalize-part "E" "View Internally")
3212     (gnus-mime-externalize-part "e" "View Externally")
3213     (gnus-mime-pipe-part "|" "Pipe To Command...")))
3214
3215 (defun gnus-article-mime-part-status ()
3216   (with-current-buffer gnus-article-buffer
3217     (let ((entity (get-text-property (point-min) 'mime-view-entity)))
3218       (if (and entity (mime-entity-children entity))
3219           (format " (%d parts)" (length (mime-entity-children entity)))
3220         ""))))
3221
3222 (defvar gnus-mime-button-map nil)
3223 (unless gnus-mime-button-map
3224   (setq gnus-mime-button-map (make-sparse-keymap))
3225   (set-keymap-parent gnus-mime-button-map gnus-article-mode-map)
3226   (define-key gnus-mime-button-map gnus-mouse-2 'gnus-article-push-button)
3227   (define-key gnus-mime-button-map gnus-down-mouse-3 'gnus-mime-button-menu)
3228   (mapcar (lambda (c)
3229             (define-key gnus-mime-button-map (cadr c) (car c)))
3230           gnus-mime-button-commands))
3231
3232 (defun gnus-mime-button-menu (event)
3233   "Construct a context-sensitive menu of MIME commands."
3234   (interactive "e")
3235   (save-excursion
3236     (let ((pos (event-start event)))
3237       (set-buffer (window-buffer (posn-window pos)))
3238       (goto-char (posn-point pos))
3239       (gnus-article-check-buffer)
3240       (let ((response (x-popup-menu
3241                        t `("MIME Part"
3242                            ("" ,@(mapcar (lambda (c)
3243                                            (cons (caddr c) (car c)))
3244                                          gnus-mime-button-commands))))))
3245         (if response
3246             (call-interactively response))))))
3247
3248 (defun gnus-mime-view-all-parts (&optional handles)
3249   "View all the MIME parts."
3250   (interactive)
3251   (save-current-buffer
3252     (set-buffer gnus-article-buffer)
3253     (let ((handles (or handles gnus-article-mime-handles))
3254           (mail-parse-charset gnus-newsgroup-charset)
3255           (mail-parse-ignored-charsets 
3256            (save-excursion (set-buffer gnus-summary-buffer)
3257                            gnus-newsgroup-ignored-charsets)))
3258       (if (stringp (car handles))
3259           (gnus-mime-view-all-parts (cdr handles))
3260         (mapcar 'mm-display-part handles)))))
3261
3262 (defun gnus-mime-save-part ()
3263   "Save the MIME part under point."
3264   (interactive)
3265   (gnus-article-check-buffer)
3266   (let ((data (get-text-property (point) 'gnus-data)))
3267     (mm-save-part data)))
3268
3269 (defun gnus-mime-pipe-part ()
3270   "Pipe the MIME part under point to a process."
3271   (interactive)
3272   (gnus-article-check-buffer)
3273   (let ((data (get-text-property (point) 'gnus-data)))
3274     (mm-pipe-part data)))
3275
3276 (defun gnus-mime-view-part ()
3277   "Interactively choose a viewing method for the MIME part under point."
3278   (interactive)
3279   (gnus-article-check-buffer)
3280   (let ((data (get-text-property (point) 'gnus-data)))
3281     (mm-interactively-view-part data)))
3282
3283 (defun gnus-mime-view-part-as-type-internal ()
3284   (gnus-article-check-buffer)
3285   (let* ((name (mail-content-type-get
3286                 (mm-handle-type (get-text-property (point) 'gnus-data))
3287                 'name))
3288          (def-type (and name (mm-default-file-encoding name))))
3289     (and def-type (cons def-type 0))))
3290
3291 (defun gnus-mime-view-part-as-type (mime-type)
3292   "Choose a MIME media type, and view the part as such."
3293   (interactive
3294    (list (completing-read
3295           "View as MIME type: "
3296           (mapcar (lambda (i) (list i i)) (mailcap-mime-types))
3297           nil nil
3298           (gnus-mime-view-part-as-type-internal))))
3299   (gnus-article-check-buffer)
3300   (let ((handle (get-text-property (point) 'gnus-data)))
3301     (gnus-mm-display-part
3302      (mm-make-handle (mm-handle-buffer handle)
3303                      (cons mime-type (cdr (mm-handle-type handle)))
3304                      (mm-handle-encoding handle)
3305                      (mm-handle-undisplayer handle)
3306                      (mm-handle-disposition handle)
3307                      (mm-handle-description handle)
3308                      (mm-handle-cache handle)
3309                      (mm-handle-id handle)))))
3310
3311 (defun gnus-mime-copy-part (&optional handle)
3312   "Put the the MIME part under point into a new buffer."
3313   (interactive)
3314   (gnus-article-check-buffer)
3315   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3316          (contents (mm-get-part handle))|
3317          (base (file-name-nondirectory
3318                 (or
3319                  (mail-content-type-get (mm-handle-type handle) 'name)
3320                  (mail-content-type-get (mm-handle-type handle)
3321                                         'filename)
3322                  "*decoded*")))
3323          (buffer (generate-new-buffer base)))
3324     (switch-to-buffer buffer)
3325     (insert contents)
3326     ;; We do it this way to make `normal-mode' set the appropriate mode.
3327     (unwind-protect
3328         (progn
3329           (setq buffer-file-name (expand-file-name base))
3330           (normal-mode))
3331       (setq buffer-file-name nil))
3332     (goto-char (point-min))))
3333
3334 (defun gnus-mime-inline-part (&optional handle)
3335   "Insert the MIME part under point into the current buffer."
3336   (interactive)
3337   (gnus-article-check-buffer)
3338   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3339          contents
3340          (b (point))
3341          buffer-read-only)
3342     (if (mm-handle-undisplayer handle)
3343         (mm-remove-part handle)
3344       (setq contents (mm-get-part handle))
3345       (forward-line 2)
3346       (mm-insert-inline handle contents)
3347       (goto-char b))))
3348
3349 (defun gnus-mime-externalize-part (&optional handle)
3350   "View the MIME part under point with an external viewer."
3351   (interactive)
3352   (gnus-article-check-buffer)
3353   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3354          (mm-user-display-methods nil)
3355          (mm-inlined-types nil)
3356          (mail-parse-charset gnus-newsgroup-charset)
3357          (mail-parse-ignored-charsets 
3358           (save-excursion (set-buffer gnus-summary-buffer)
3359                           gnus-newsgroup-ignored-charsets)))
3360     (if (mm-handle-undisplayer handle)
3361         (mm-remove-part handle)
3362       (mm-display-part handle))))
3363
3364 (defun gnus-mime-internalize-part (&optional handle)
3365   "View the MIME part under point with an internal viewer.
3366 In no internal viewer is available, use an external viewer."
3367   (interactive)
3368   (gnus-article-check-buffer)
3369   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3370          (mm-inlined-types '(".*"))
3371          (mm-inline-large-images t)
3372          (mail-parse-charset gnus-newsgroup-charset)
3373          (mail-parse-ignored-charsets 
3374           (save-excursion (set-buffer gnus-summary-buffer)
3375                           gnus-newsgroup-ignored-charsets)))
3376     (if (mm-handle-undisplayer handle)
3377         (mm-remove-part handle)
3378       (mm-display-part handle))))
3379
3380 (defun gnus-article-part-wrapper (n function)
3381   (save-current-buffer
3382     (set-buffer gnus-article-buffer)
3383     (when (> n (length gnus-article-mime-handle-alist))
3384       (error "No such part"))
3385     (gnus-article-goto-part n)
3386     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3387       (funcall function handle))))
3388
3389 (defun gnus-article-pipe-part (n)
3390   "Pipe MIME part N, which is the numerical prefix."
3391   (interactive "p")
3392   (gnus-article-part-wrapper n 'mm-pipe-part))
3393
3394 (defun gnus-article-save-part (n)
3395   "Save MIME part N, which is the numerical prefix."
3396   (interactive "p")
3397   (gnus-article-part-wrapper n 'mm-save-part))
3398
3399 (defun gnus-article-interactively-view-part (n)
3400   "View MIME part N interactively, which is the numerical prefix."
3401   (interactive "p")
3402   (gnus-article-part-wrapper n 'mm-interactively-view-part))
3403
3404 (defun gnus-article-copy-part (n)
3405   "Copy MIME part N, which is the numerical prefix."
3406   (interactive "p")
3407   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
3408
3409 (defun gnus-article-externalize-part (n)
3410   "View MIME part N externally, which is the numerical prefix."
3411   (interactive "p")
3412   (gnus-article-part-wrapper n 'gnus-mime-externalize-part))
3413
3414 (defun gnus-article-inline-part (n)
3415   "Inline MIME part N, which is the numerical prefix."
3416   (interactive "p")
3417   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
3418
3419 (defun gnus-article-mime-match-handle-first (condition)
3420   (if condition
3421       (let ((alist gnus-article-mime-handle-alist) ihandle n)
3422         (while (setq ihandle (pop alist))
3423           (if (and (cond 
3424                     ((functionp condition)
3425                      (funcall condition (cdr ihandle)))
3426                     ((eq condition 'undisplayed) 
3427                      (not (or (mm-handle-undisplayer (cdr ihandle))
3428                               (equal (mm-handle-media-type (cdr ihandle))
3429                                      "multipart/alternative"))))
3430                     ((eq condition 'undisplayed-alternative)
3431                      (not (mm-handle-undisplayer (cdr ihandle))))
3432                     (t t))
3433                    (gnus-article-goto-part (car ihandle))
3434                    (or (not n) (< (car ihandle) n)))
3435               (setq n (car ihandle))))
3436         (or n 1))
3437     1))
3438
3439 (defun gnus-article-view-part (&optional n)
3440   "View MIME part N, which is the numerical prefix."
3441   (interactive "P")
3442   (save-current-buffer
3443     (set-buffer gnus-article-buffer)
3444     (or (numberp n) (setq n (gnus-article-mime-match-handle-first 
3445                              gnus-article-mime-match-handle-function)))
3446     (when (> n (length gnus-article-mime-handle-alist))
3447       (error "No such part"))
3448     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3449       (when (gnus-article-goto-part n)
3450         (if (equal (car handle) "multipart/alternative")
3451             (gnus-article-press-button)
3452           (when (eq (gnus-mm-display-part handle) 'internal)
3453             (gnus-set-window-start)))))))
3454
3455 (defun gnus-mm-display-part (handle)
3456   "Display HANDLE and fix MIME button."
3457   (let ((id (get-text-property (point) 'gnus-part))
3458         (point (point))
3459         buffer-read-only)
3460     (forward-line 1)
3461     (prog1
3462         (let ((window (selected-window))
3463               (mail-parse-charset gnus-newsgroup-charset)
3464               (mail-parse-ignored-charsets 
3465                (save-excursion (set-buffer gnus-summary-buffer)
3466                                gnus-newsgroup-ignored-charsets)))
3467           (save-excursion
3468             (unwind-protect
3469                 (let ((win (get-buffer-window (current-buffer) t))
3470                       (beg (point)))
3471                   (when win
3472                     (select-window win))
3473                   (goto-char point)
3474                   (forward-line)
3475                   (if (mm-handle-displayed-p handle)
3476                       ;; This will remove the part.
3477                       (mm-display-part handle)
3478                     (save-restriction
3479                       (narrow-to-region (point) (1+ (point)))
3480                       (mm-display-part handle)
3481                       ;; We narrow to the part itself and
3482                       ;; then call the treatment functions.
3483                       (goto-char (point-min))
3484                       (forward-line 1)
3485                       (narrow-to-region (point) (point-max))
3486                       (gnus-treat-article
3487                        nil id
3488                        (1- (length gnus-article-mime-handles))
3489                        (mm-handle-media-type handle)))))
3490               (select-window window))))
3491       (goto-char point)
3492       (delete-region (gnus-point-at-bol) (progn (forward-line 1) (point)))
3493       (gnus-insert-mime-button
3494        handle id (list (mm-handle-displayed-p handle)))
3495       (goto-char point))))
3496
3497 (defun gnus-article-goto-part (n)
3498   "Go to MIME part N."
3499   (let ((point (text-property-any (point-min) (point-max) 'gnus-part n)))
3500     (when point
3501       (goto-char point))))
3502
3503 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
3504   (let ((gnus-tmp-name
3505          (or (mail-content-type-get (mm-handle-type handle)
3506                                     'name)
3507              (mail-content-type-get (mm-handle-disposition handle)
3508                                     'filename)
3509              ""))
3510         (gnus-tmp-type (mm-handle-media-type handle))
3511         (gnus-tmp-description
3512          (mail-decode-encoded-word-string (or (mm-handle-description handle)
3513                                               "")))
3514         (gnus-tmp-dots
3515          (if (if displayed (car displayed)
3516                (mm-handle-displayed-p handle))
3517              "" "..."))
3518         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
3519                            (buffer-size)))
3520         gnus-tmp-type-long b e)
3521     (when (string-match ".*/" gnus-tmp-name)
3522       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
3523     (setq gnus-tmp-type-long (concat gnus-tmp-type
3524                                      (and (not (equal gnus-tmp-name ""))
3525                                           (concat "; " gnus-tmp-name))))
3526     (or (equal gnus-tmp-description "")
3527         (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
3528     (unless (bolp)
3529       (insert "\n"))
3530     (setq b (point))
3531     (gnus-eval-format
3532      gnus-mime-button-line-format gnus-mime-button-line-format-alist
3533      `(local-map ,gnus-mime-button-map
3534                  keymap ,gnus-mime-button-map
3535                  gnus-callback gnus-mm-display-part
3536                  gnus-part ,gnus-tmp-id
3537                  article-type annotation
3538                  gnus-data ,handle))
3539     (setq e (point))
3540     (widget-convert-button 'link b e
3541                            :mime-handle handle
3542                            :action 'gnus-widget-press-button
3543                            :button-keymap gnus-mime-button-map
3544                            :help-echo
3545                            (lambda (widget)
3546                              ;; Needed to properly clear the message
3547                              ;; due to a bug in wid-edit
3548                              (setq help-echo-owns-message t)
3549                              (format
3550                               "Click to %s the MIME part; %s for more options"
3551                               (if (mm-handle-displayed-p
3552                                    (widget-get widget :mime-handle))
3553                                   "hide" "show")
3554                               (if gnus-xemacs "button3" "mouse-3"))))))
3555
3556 (defun gnus-widget-press-button (elems el)
3557   (goto-char (widget-get elems :from))
3558   (gnus-article-press-button))
3559
3560 (defvar gnus-displaying-mime nil)
3561
3562 (defun gnus-display-mime (&optional ihandles)
3563   "Display the MIME parts."
3564   (save-excursion
3565     (save-selected-window
3566       (let ((window (get-buffer-window gnus-article-buffer))
3567             (point (point)))
3568         (when window
3569           (select-window window)
3570           ;; We have to do this since selecting the window
3571           ;; may change the point.  So we set the window point.
3572           (set-window-point window point)))
3573       (let* ((handles (or ihandles (mm-dissect-buffer) (mm-uu-dissect)))
3574              buffer-read-only handle name type b e display)
3575         (when (and (not ihandles)
3576                    (not gnus-displaying-mime))
3577           ;; Top-level call; we clean up.
3578           (when gnus-article-mime-handles
3579             (mm-destroy-parts gnus-article-mime-handles)
3580             (setq gnus-article-mime-handle-alist nil));; A trick.
3581           (setq gnus-article-mime-handles handles)
3582           ;; We allow users to glean info from the handles.
3583           (when gnus-article-mime-part-function
3584             (gnus-mime-part-function handles)))
3585         (if (and handles
3586                  (or (not (stringp (car handles)))
3587                      (cdr handles)))
3588             (progn
3589               (when (and (not ihandles)
3590                          (not gnus-displaying-mime))
3591                 ;; Clean up for mime parts.
3592                 (article-goto-body)
3593                 (delete-region (point) (point-max)))
3594               (let ((gnus-displaying-mime t))
3595                 (gnus-mime-display-part handles)))
3596           (save-restriction
3597             (article-goto-body)
3598             (narrow-to-region (point) (point-max))
3599             (gnus-treat-article nil 1 1)
3600             (widen)))
3601         (unless ihandles
3602           ;; Highlight the headers.
3603           (save-excursion
3604             (save-restriction
3605               (article-goto-body)
3606               (narrow-to-region (point-min) (point))
3607               (gnus-treat-article 'head))))))))
3608
3609 (defvar gnus-mime-display-multipart-as-mixed nil)
3610
3611 (defun gnus-mime-display-part (handle)
3612   (cond
3613    ;; Single part.
3614    ((not (stringp (car handle)))
3615     (gnus-mime-display-single handle))
3616    ;; User-defined multipart
3617    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
3618     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
3619              handle))
3620    ;; multipart/alternative
3621    ((and (equal (car handle) "multipart/alternative")
3622          (not gnus-mime-display-multipart-as-mixed))
3623     (let ((id (1+ (length gnus-article-mime-handle-alist))))
3624       (push (cons id handle) gnus-article-mime-handle-alist)
3625       (gnus-mime-display-alternative (cdr handle) nil nil id)))
3626    ;; multipart/related
3627    ((and (equal (car handle) "multipart/related")
3628          (not gnus-mime-display-multipart-as-mixed))
3629     ;;;!!!We should find the start part, but we just default
3630     ;;;!!!to the first part.
3631     (gnus-mime-display-part (cadr handle)))
3632    ;; Other multiparts are handled like multipart/mixed.
3633    (t
3634     (gnus-mime-display-mixed (cdr handle)))))
3635
3636 (defun gnus-mime-part-function (handles)
3637   (if (stringp (car handles))
3638       (mapcar 'gnus-mime-part-function (cdr handles))
3639     (funcall gnus-article-mime-part-function handles)))
3640
3641 (defun gnus-mime-display-mixed (handles)
3642   (mapcar 'gnus-mime-display-part handles))
3643
3644 (defun gnus-mime-display-single (handle)
3645   (let ((type (mm-handle-media-type handle))
3646         (ignored gnus-ignored-mime-types)
3647         (not-attachment t)
3648         (move nil)
3649         display text)
3650     (catch 'ignored
3651       (progn
3652         (while ignored
3653           (when (string-match (pop ignored) type)
3654             (throw 'ignored nil)))
3655         (if (and (setq not-attachment
3656                        (and (not (mm-inline-override-p handle))
3657                             (or (not (mm-handle-disposition handle))
3658                                 (equal (car (mm-handle-disposition handle))
3659                                        "inline")
3660                                 (mm-attachment-override-p handle))))
3661                  (mm-automatic-display-p handle)
3662                  (or (mm-inlined-p handle)
3663                      (mm-automatic-external-display-p type)))
3664             (setq display t)
3665           (when (equal (mm-handle-media-supertype handle) "text")
3666             (setq text t)))
3667         (let ((id (1+ (length gnus-article-mime-handle-alist))))
3668           (push (cons id handle) gnus-article-mime-handle-alist)
3669           (when (or (not display)
3670                     (not (gnus-unbuttonized-mime-type-p type)))
3671             ;(gnus-article-insert-newline)
3672             (gnus-insert-mime-button
3673              handle id (list (or display (and not-attachment text))))
3674             (gnus-article-insert-newline)
3675             ;(gnus-article-insert-newline)
3676             (setq move t)))
3677         (let ((beg (point)))
3678           (cond
3679            (display
3680             (when move
3681               (forward-line -2)
3682               (setq beg (point)))
3683             (let ((mail-parse-charset gnus-newsgroup-charset)
3684                   (mail-parse-ignored-charsets 
3685                    (save-excursion (condition-case ()
3686                                        (set-buffer gnus-summary-buffer)
3687                                      (error))
3688                                    gnus-newsgroup-ignored-charsets)))
3689               (mm-display-part handle t))
3690             (goto-char (point-max)))
3691            ((and text not-attachment)
3692             (when move
3693               (forward-line -2)
3694               (setq beg (point)))
3695             (gnus-article-insert-newline)
3696             (mm-insert-inline handle (mm-get-part handle))
3697             (goto-char (point-max))))
3698           ;; Do highlighting.
3699           (save-excursion
3700             (save-restriction
3701               (narrow-to-region beg (point))
3702               (gnus-treat-article
3703                nil (length gnus-article-mime-handle-alist)
3704                (1- (length gnus-article-mime-handles))
3705                (mm-handle-media-type handle)))))))))
3706
3707 (defun gnus-unbuttonized-mime-type-p (type)
3708   "Say whether TYPE is to be unbuttonized."
3709   (unless gnus-inhibit-mime-unbuttonizing
3710     (catch 'found
3711       (let ((types gnus-unbuttonized-mime-types))
3712         (while types
3713           (when (string-match (pop types) type)
3714             (throw 'found t)))))))
3715
3716 (defun gnus-article-insert-newline ()
3717   "Insert a newline, but mark it as undeletable."
3718   (gnus-put-text-property
3719    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
3720
3721 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
3722   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
3723          (ihandles handles)
3724          (point (point))
3725          handle buffer-read-only from props begend not-pref)
3726     (save-window-excursion
3727       (save-restriction
3728         (when ibegend
3729           (narrow-to-region (car ibegend)
3730                             (or (cdr ibegend)
3731                                 (progn
3732                                   (goto-char (car ibegend))
3733                                   (forward-line 2)
3734                                   (point))))
3735           (delete-region (point-min) (point-max))
3736           (mm-remove-parts handles))
3737         (setq begend (list (point-marker)))
3738         ;; Do the toggle.
3739         (unless (setq not-pref (cadr (member preferred ihandles)))
3740           (setq not-pref (car ihandles)))
3741         (when (or ibegend
3742                   (not (gnus-unbuttonized-mime-type-p
3743                         "multipart/alternative")))
3744           (gnus-add-text-properties
3745            (setq from (point))
3746            (progn
3747              (insert (format "%d.  " id))
3748              (point))
3749            `(gnus-callback
3750              (lambda (handles)
3751                (unless ,(not ibegend)
3752                  (setq gnus-article-mime-handle-alist
3753                        ',gnus-article-mime-handle-alist))
3754                (gnus-mime-display-alternative
3755                 ',ihandles ',not-pref ',begend ,id))
3756              local-map ,gnus-mime-button-map
3757              ,gnus-mouse-face-prop ,gnus-article-mouse-face
3758              face ,gnus-article-button-face
3759              keymap ,gnus-mime-button-map
3760              gnus-part ,id
3761              gnus-data ,handle))
3762           (widget-convert-button 'link from (point)
3763                                  :action 'gnus-widget-press-button
3764                                  :button-keymap gnus-widget-button-keymap)
3765           ;; Do the handles
3766           (while (setq handle (pop handles))
3767             (gnus-add-text-properties
3768              (setq from (point))
3769              (progn
3770                (insert (format "(%c) %-18s"
3771                                (if (equal handle preferred) ?* ? )
3772                                (mm-handle-media-type handle)))
3773                (point))
3774              `(gnus-callback
3775                (lambda (handles)
3776                  (unless ,(not ibegend)
3777                    (setq gnus-article-mime-handle-alist
3778                          ',gnus-article-mime-handle-alist))
3779                  (gnus-mime-display-alternative
3780                   ',ihandles ',handle ',begend ,id))
3781                local-map ,gnus-mime-button-map
3782                ,gnus-mouse-face-prop ,gnus-article-mouse-face
3783                face ,gnus-article-button-face
3784                keymap ,gnus-mime-button-map
3785                gnus-part ,id
3786                gnus-data ,handle))
3787             (widget-convert-button 'link from (point)
3788                                    :action 'gnus-widget-press-button
3789                                    :button-keymap gnus-widget-button-keymap)
3790             (insert "  "))
3791           (insert "\n\n"))
3792         (when preferred
3793           (if (stringp (car preferred))
3794               (gnus-display-mime preferred)
3795             (let ((mail-parse-charset gnus-newsgroup-charset)
3796                   (mail-parse-ignored-charsets 
3797                    (save-excursion (set-buffer gnus-summary-buffer)
3798                                    gnus-newsgroup-ignored-charsets)))
3799               (mm-display-part preferred)
3800               ;; Do highlighting.
3801               (save-excursion
3802                 (save-restriction
3803                   (narrow-to-region (car begend) (point-max))
3804                   (gnus-treat-article
3805                    nil (length gnus-article-mime-handle-alist)
3806                    (1- (length gnus-article-mime-handles))
3807                    (mm-handle-media-type handle))))))
3808           (goto-char (point-max))
3809           (setcdr begend (point-marker)))))
3810     (when ibegend
3811       (goto-char point))))
3812
3813 (defun gnus-article-wash-status ()
3814   "Return a string which display status of article washing."
3815   (save-excursion
3816     (set-buffer gnus-article-buffer)
3817     (let ((cite (memq 'cite gnus-article-wash-types))
3818           (headers (memq 'headers gnus-article-wash-types))
3819           (boring (memq 'boring-headers gnus-article-wash-types))
3820           (pgp (memq 'pgp gnus-article-wash-types))
3821           (pem (memq 'pem gnus-article-wash-types))
3822           (signature (memq 'signature gnus-article-wash-types))
3823           (overstrike (memq 'overstrike gnus-article-wash-types))
3824           (emphasis (memq 'emphasis gnus-article-wash-types)))
3825       (format "%c%c%c%c%c%c%c"
3826               (if cite ?c ? )
3827               (if (or headers boring) ?h ? )
3828               (if (or pgp pem) ?p ? )
3829               (if signature ?s ? )
3830               (if overstrike ?o ? )
3831               (if gnus-show-mime ?m ? )
3832               (if emphasis ?e ? )))))
3833
3834 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
3835
3836 (defun gnus-article-maybe-hide-headers ()
3837   "Hide unwanted headers if `gnus-have-all-headers' is nil.
3838 Provided for backwards compatibility."
3839   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
3840                  (not (save-excursion (set-buffer gnus-summary-buffer)
3841                                       gnus-have-all-headers)))
3842              (not gnus-inhibit-hiding))
3843     (gnus-article-hide-headers)))
3844
3845 ;;; Article savers.
3846
3847 (defun gnus-output-to-file (file-name)
3848   "Append the current article to a file named FILE-NAME."
3849   (let ((artbuf (current-buffer)))
3850     (with-temp-buffer
3851       (insert-buffer-substring artbuf)
3852       ;; Append newline at end of the buffer as separator, and then
3853       ;; save it to file.
3854       (goto-char (point-max))
3855       (insert "\n")
3856       (write-region-as-binary (point-min) (point-max) file-name 'append)
3857       t)))
3858
3859 (defun gnus-narrow-to-page (&optional arg)
3860   "Narrow the article buffer to a page.
3861 If given a numerical ARG, move forward ARG pages."
3862   (interactive "P")
3863   (setq arg (if arg (prefix-numeric-value arg) 0))
3864   (save-excursion
3865     (set-buffer gnus-article-buffer)
3866     (goto-char (point-min))
3867     (widen)
3868     ;; Remove any old next/prev buttons.
3869     (when (gnus-visual-p 'page-marker)
3870       (let ((buffer-read-only nil))
3871         (gnus-remove-text-with-property 'gnus-prev)
3872         (gnus-remove-text-with-property 'gnus-next)))
3873     (when
3874         (cond ((< arg 0)
3875                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
3876               ((> arg 0)
3877                (re-search-forward page-delimiter nil 'move arg)))
3878       (goto-char (match-end 0)))
3879     (narrow-to-region
3880      (point)
3881      (if (re-search-forward page-delimiter nil 'move)
3882          (match-beginning 0)
3883        (point)))
3884     (when (and (gnus-visual-p 'page-marker)
3885                (not (= (point-min) 1)))
3886       (save-excursion
3887         (goto-char (point-min))
3888         (gnus-insert-prev-page-button)))
3889     (when (and (gnus-visual-p 'page-marker)
3890                (< (+ (point-max) 2) (buffer-size)))
3891       (save-excursion
3892         (goto-char (point-max))
3893         (gnus-insert-next-page-button)))))
3894
3895 ;; Article mode commands
3896
3897 (defun gnus-article-goto-next-page ()
3898   "Show the next page of the article."
3899   (interactive)
3900   (when (gnus-article-next-page)
3901     (goto-char (point-min))
3902     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
3903
3904 (defun gnus-article-goto-prev-page ()
3905   "Show the next page of the article."
3906   (interactive)
3907   (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
3908     (gnus-article-prev-page nil)))
3909
3910 (defun gnus-article-next-page (&optional lines)
3911   "Show the next page of the current article.
3912 If end of article, return non-nil.  Otherwise return nil.
3913 Argument LINES specifies lines to be scrolled up."
3914   (interactive "p")
3915   (let ((start (window-start))
3916         end-of-buffer end-of-page)
3917     (save-excursion
3918       (move-to-window-line -1)
3919       (if (<= (point) start)
3920           (progn
3921             (forward-line 2)
3922             (setq start (point)))
3923         (forward-line 1)
3924         (setq start nil))
3925       (unless (or (cond ((eq (1+ (buffer-size)) (point))
3926                          (and (pos-visible-in-window-p)
3927                               (setq end-of-buffer t)))
3928                         ((eobp)
3929                          (setq end-of-page t)))
3930                   (not lines))
3931         (move-to-window-line lines)
3932         (unless (search-backward "\n\n" nil t)
3933           (setq start (point)))))
3934     (cond (end-of-buffer t)
3935           (end-of-page
3936            (gnus-narrow-to-page 1)
3937            nil)
3938           (t
3939            (if start
3940                (set-window-start (selected-window) start)
3941              (let (window-pixel-scroll-increment)
3942                (scroll-up lines)))
3943            nil))))
3944
3945 (defun gnus-article-prev-page (&optional lines)
3946   "Show previous page of current article.
3947 Argument LINES specifies lines to be scrolled down."
3948   (interactive "p")
3949   (let (beginning-of-buffer beginning-of-page)
3950     (save-excursion
3951       (move-to-window-line 0)
3952       (cond ((eq 1 (point))
3953              (setq beginning-of-buffer t))
3954             ((bobp)
3955              (setq beginning-of-page t))))
3956     (cond (beginning-of-buffer)
3957           (beginning-of-page
3958            (gnus-narrow-to-page -1))
3959           (t
3960            (condition-case nil
3961                (let (window-pixel-scroll-increment)
3962                  (scroll-down lines))
3963              (beginning-of-buffer
3964               (goto-char (point-min))))))))
3965
3966 (defun gnus-article-refer-article ()
3967   "Read article specified by message-id around point."
3968   (interactive)
3969   (let ((point (point)))
3970     (search-forward ">" nil t)          ;Move point to end of "<....>".
3971     (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
3972         (let ((message-id (match-string 1)))
3973           (goto-char point)
3974           (set-buffer gnus-summary-buffer)
3975           (gnus-summary-refer-article message-id))
3976       (goto-char (point))
3977       (error "No references around point"))))
3978
3979 (defun gnus-article-show-summary ()
3980   "Reconfigure windows to show summary buffer."
3981   (interactive)
3982   (if (not (gnus-buffer-live-p gnus-summary-buffer))
3983       (error "There is no summary buffer for this article buffer")
3984     (gnus-article-set-globals)
3985     (gnus-configure-windows 'article)
3986     (gnus-summary-goto-subject gnus-current-article)
3987     (gnus-summary-position-point)))
3988
3989 (defun gnus-article-describe-briefly ()
3990   "Describe article mode commands briefly."
3991   (interactive)
3992   (gnus-message 6 (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")))
3993
3994 (defun gnus-article-summary-command ()
3995   "Execute the last keystroke in the summary buffer."
3996   (interactive)
3997   (let ((obuf (current-buffer))
3998         (owin (current-window-configuration))
3999         func)
4000     (switch-to-buffer gnus-article-current-summary 'norecord)
4001     (setq func (lookup-key (current-local-map) (this-command-keys)))
4002     (call-interactively func)
4003     (set-buffer obuf)
4004     (set-window-configuration owin)
4005     (set-window-point (get-buffer-window (current-buffer)) (point))))
4006
4007 (defun gnus-article-summary-command-nosave ()
4008   "Execute the last keystroke in the summary buffer."
4009   (interactive)
4010   (let (func)
4011     (pop-to-buffer gnus-article-current-summary 'norecord)
4012     (setq func (lookup-key (current-local-map) (this-command-keys)))
4013     (call-interactively func)))
4014
4015 (defun gnus-article-check-buffer ()
4016   "Beep if not in an article buffer."
4017   (unless (eq (get-buffer gnus-article-buffer) (current-buffer))
4018     (error "Command invoked outside of a Gnus article buffer")))
4019
4020 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
4021   "Read a summary buffer key sequence and execute it from the article buffer."
4022   (interactive "P")
4023   (gnus-article-check-buffer)
4024   (let ((nosaves
4025          '("q" "Q"  "c" "r" "R" "\C-c\C-f" "m"  "a" "f" "F"
4026            "Zc" "ZC" "ZE" "ZJ" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
4027            "=" "^" "\M-^" "|"))
4028         (nosave-but-article
4029          '("A\r"))
4030         (nosave-in-article
4031          '("\C-d"))
4032         (up-to-top
4033          '("n" "Gn" "p" "Gp"))
4034         keys new-sum-point)
4035     (save-excursion
4036       (set-buffer gnus-article-current-summary)
4037       (let (gnus-pick-mode)
4038         (push (or key last-command-event) unread-command-events)
4039         (setq keys (static-if (featurep 'xemacs)
4040                        (events-to-keys (read-key-sequence nil))
4041                      (read-key-sequence nil)))))
4042     (message "")
4043
4044     (if (or (member keys nosaves)
4045             (member keys nosave-but-article)
4046             (member keys nosave-in-article))
4047         (let (func)
4048           (save-window-excursion
4049             (pop-to-buffer gnus-article-current-summary 'norecord)
4050             ;; We disable the pick minor mode commands.
4051             (let (gnus-pick-mode)
4052               (setq func (lookup-key (current-local-map) keys))))
4053           (if (or (not func)
4054                   (numberp func))
4055               (ding)
4056             (unless (member keys nosave-in-article)
4057               (set-buffer gnus-article-current-summary))
4058             (call-interactively func)
4059             (setq new-sum-point (point)))
4060           (when (member keys nosave-but-article)
4061             (pop-to-buffer gnus-article-buffer 'norecord)))
4062       ;; These commands should restore window configuration.
4063       (let ((obuf (current-buffer))
4064             (owin (current-window-configuration))
4065             (opoint (point))
4066             (summary gnus-article-current-summary)
4067             func in-buffer selected)
4068         (if not-restore-window
4069             (pop-to-buffer summary 'norecord)
4070           (switch-to-buffer summary 'norecord))
4071         (setq in-buffer (current-buffer))
4072         ;; We disable the pick minor mode commands.
4073         (if (setq func (let (gnus-pick-mode)
4074                          (lookup-key (current-local-map) keys)))
4075             (progn
4076               (call-interactively func)
4077               (setq new-sum-point (point)))
4078           (ding))
4079         (when (eq in-buffer (current-buffer))
4080           (setq selected (gnus-summary-select-article))
4081           (set-buffer obuf)
4082           (unless not-restore-window
4083             (set-window-configuration owin))
4084           (when (eq selected 'old)
4085             (article-goto-body)
4086             (set-window-start (get-buffer-window (current-buffer))
4087                               1)
4088             (set-window-point (get-buffer-window (current-buffer))
4089                               (point)))
4090           (let ((win (get-buffer-window gnus-article-current-summary)))
4091             (when win
4092               (set-window-point win new-sum-point))))))))
4093
4094 (defun gnus-article-hide (&optional arg force)
4095   "Hide all the gruft in the current article.
4096 This means that PGP stuff, signatures, cited text and (some)
4097 headers will be hidden.
4098 If given a prefix, show the hidden text instead."
4099   (interactive (append (gnus-article-hidden-arg) (list 'force)))
4100   (gnus-article-hide-headers arg)
4101   (gnus-article-hide-list-identifiers arg)
4102   (gnus-article-hide-pgp arg)
4103   (gnus-article-hide-citation-maybe arg force)
4104   (gnus-article-hide-signature arg))
4105
4106 (defun gnus-article-maybe-highlight ()
4107   "Do some article highlighting if article highlighting is requested."
4108   (when (gnus-visual-p 'article-highlight 'highlight)
4109     (gnus-article-highlight-some)))
4110
4111 (defun gnus-check-group-server ()
4112   ;; Make sure the connection to the server is alive.
4113   (unless (gnus-server-opened
4114            (gnus-find-method-for-group gnus-newsgroup-name))
4115     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
4116     (gnus-request-group gnus-newsgroup-name t)))
4117
4118 (defun gnus-request-article-this-buffer (article group)
4119   "Get an article and insert it into this buffer."
4120   (let (do-update-line sparse-header)
4121     (prog1
4122         (save-excursion
4123           (erase-buffer)
4124           (gnus-kill-all-overlays)
4125           (setq group (or group gnus-newsgroup-name))
4126
4127           ;; Using `gnus-request-article' directly will insert the article into
4128           ;; `nntp-server-buffer' - so we'll save some time by not having to
4129           ;; copy it from the server buffer into the article buffer.
4130
4131           ;; We only request an article by message-id when we do not have the
4132           ;; headers for it, so we'll have to get those.
4133           (when (stringp article)
4134             (gnus-read-header article))
4135
4136           ;; If the article number is negative, that means that this article
4137           ;; doesn't belong in this newsgroup (possibly), so we find its
4138           ;; message-id and request it by id instead of number.
4139           (when (and (numberp article)
4140                      gnus-summary-buffer
4141                      (get-buffer gnus-summary-buffer)
4142                      (gnus-buffer-exists-p gnus-summary-buffer))
4143             (save-excursion
4144               (set-buffer gnus-summary-buffer)
4145               (let ((header (gnus-summary-article-header article)))
4146                 (when (< article 0)
4147                   (cond
4148                    ((memq article gnus-newsgroup-sparse)
4149                     ;; This is a sparse gap article.
4150                     (setq do-update-line article)
4151                     (setq article (mail-header-id header))
4152                     (setq sparse-header (gnus-read-header article))
4153                     (setq gnus-newsgroup-sparse
4154                           (delq article gnus-newsgroup-sparse)))
4155                    ((vectorp header)
4156                     ;; It's a real article.
4157                     (setq article (mail-header-id header)))
4158                    (t
4159                     ;; It is an extracted pseudo-article.
4160                     (setq article 'pseudo)
4161                     (gnus-request-pseudo-article header))))
4162
4163                 (let ((method (gnus-find-method-for-group
4164                                gnus-newsgroup-name)))
4165                   (when (and (eq (car method) 'nneething)
4166                              (vectorp header))
4167                     (let ((dir (concat
4168                                 (file-name-as-directory
4169                                  (or (cadr (assq 'nneething-address method))
4170                                      (nth 1 method)))
4171                                 (mail-header-subject header))))
4172                       (when (file-directory-p dir)
4173                         (setq article 'nneething)
4174                         (gnus-group-enter-directory dir))))))))
4175
4176           (cond
4177            ;; Refuse to select canceled articles.
4178            ((and (numberp article)
4179                  gnus-summary-buffer
4180                  (get-buffer gnus-summary-buffer)
4181                  (gnus-buffer-exists-p gnus-summary-buffer)
4182                  (eq (cdr (save-excursion
4183                             (set-buffer gnus-summary-buffer)
4184                             (assq article gnus-newsgroup-reads)))
4185                      gnus-canceled-mark))
4186             nil)
4187            ;; Check the backlog.
4188            ((and gnus-keep-backlog
4189                  (gnus-backlog-request-article group article (current-buffer)))
4190             'article)
4191            ;; Check asynchronous pre-fetch.
4192            ((gnus-async-request-fetched-article group article (current-buffer))
4193             (gnus-async-prefetch-next group article gnus-summary-buffer)
4194             (when (and (numberp article) gnus-keep-backlog)
4195               (gnus-backlog-enter-article group article (current-buffer)))
4196             'article)
4197            ;; Check the cache.
4198            ((and gnus-use-cache
4199                  (numberp article)
4200                  (gnus-cache-request-article article group))
4201             'article)
4202            ;; Get the article and put into the article buffer.
4203            ((or (stringp article)
4204                 (numberp article))
4205             (let ((gnus-override-method gnus-override-method)
4206                   (methods (and (stringp article) 
4207                                 gnus-refer-article-method))
4208                   result
4209                   (buffer-read-only nil))
4210               (setq methods
4211                     (if (listp methods)
4212                         methods
4213                       (list methods)))
4214               (when (and (null gnus-override-method)
4215                          methods)
4216                 (setq gnus-override-method (pop methods)))
4217               (while (not result)
4218                 (when (eq gnus-override-method 'current)
4219                   (setq gnus-override-method gnus-current-select-method))
4220                 (erase-buffer)
4221                 (gnus-kill-all-overlays)
4222                 (let ((gnus-newsgroup-name group))
4223                   (gnus-check-group-server))
4224                 (when (gnus-request-article article group (current-buffer))
4225                   (when (numberp article)
4226                     (gnus-async-prefetch-next group article 
4227                                               gnus-summary-buffer)
4228                     (when gnus-keep-backlog
4229                       (gnus-backlog-enter-article
4230                        group article (current-buffer))))
4231                   (setq result 'article))
4232                 (if (not result)
4233                     (if methods
4234                         (setq gnus-override-method (pop methods))
4235                       (setq result 'done))))
4236               (and (eq result 'article) 'article)))
4237            ;; It was a pseudo.
4238            (t article)))
4239
4240       ;; Associate this article with the current summary buffer.
4241       (setq gnus-article-current-summary gnus-summary-buffer)
4242
4243       ;; Take the article from the original article buffer
4244       ;; and place it in the buffer it's supposed to be in.
4245       (when (and (get-buffer gnus-article-buffer)
4246                  (equal (buffer-name (current-buffer))
4247                         (buffer-name (get-buffer gnus-article-buffer))))
4248         (save-excursion
4249           (if (get-buffer gnus-original-article-buffer)
4250               (set-buffer gnus-original-article-buffer)
4251             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4252             (buffer-disable-undo)
4253             (setq major-mode 'gnus-original-article-mode)
4254             (setq buffer-read-only t))
4255           (let (buffer-read-only)
4256             (erase-buffer)
4257             (insert-buffer-substring gnus-article-buffer))
4258           (setq gnus-original-article (cons group article)))
4259
4260         ;; Decode charsets.
4261         (run-hooks 'gnus-article-decode-hook)
4262         ;; Mark article as decoded or not.
4263         (setq gnus-article-decoded-p gnus-article-decode-hook))
4264
4265       ;; Update sparse articles.
4266       (when (and do-update-line
4267                  (or (numberp article)
4268                      (stringp article)))
4269         (let ((buf (current-buffer)))
4270           (set-buffer gnus-summary-buffer)
4271           (gnus-summary-update-article do-update-line sparse-header)
4272           (gnus-summary-goto-subject do-update-line nil t)
4273           (set-window-point (get-buffer-window (current-buffer) t)
4274                             (point))
4275           (set-buffer buf))))))
4276
4277 ;;;
4278 ;;; Article editing
4279 ;;;
4280
4281 (defcustom gnus-article-edit-mode-hook nil
4282   "Hook run in article edit mode buffers."
4283   :group 'gnus-article-various
4284   :type 'hook)
4285
4286 (defcustom gnus-article-edit-article-setup-function
4287   'gnus-article-mime-edit-article-setup
4288   "Function called to setup an editing article buffer."
4289   :group 'gnus-article-various
4290   :type 'function)
4291
4292 (defvar gnus-article-edit-done-function nil)
4293
4294 (defvar gnus-article-edit-mode-map nil)
4295
4296 ;; Should we be using derived.el for this?
4297 (unless gnus-article-edit-mode-map
4298   (setq gnus-article-edit-mode-map (make-sparse-keymap))
4299   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
4300
4301   (gnus-define-keys gnus-article-edit-mode-map
4302     "\C-c\C-c" gnus-article-edit-done
4303     "\C-c\C-k" gnus-article-edit-exit)
4304
4305   (gnus-define-keys (gnus-article-edit-wash-map
4306                      "\C-c\C-w" gnus-article-edit-mode-map)
4307     "f" gnus-article-edit-full-stops))
4308
4309 (defun gnus-article-edit-mode ()
4310   "Major mode for editing articles.
4311 This is an extended text-mode.
4312
4313 \\{gnus-article-edit-mode-map}"
4314   (interactive)
4315   (setq major-mode 'gnus-article-edit-mode)
4316   (setq mode-name "Article Edit")
4317   (use-local-map gnus-article-edit-mode-map)
4318   (make-local-variable 'gnus-article-edit-done-function)
4319   (make-local-variable 'gnus-prev-winconf)
4320   (setq buffer-read-only nil)
4321   (buffer-enable-undo)
4322   (widen)
4323   (gnus-run-hooks 'text-mode-hook 'gnus-article-edit-mode-hook))
4324
4325 (defun gnus-article-edit (&optional force)
4326   "Edit the current article.
4327 This will have permanent effect only in mail groups.
4328 If FORCE is non-nil, allow editing of articles even in read-only
4329 groups."
4330   (interactive "P")
4331   (when (and (not force)
4332              (gnus-group-read-only-p))
4333     (error "The current newsgroup does not support article editing"))
4334   (gnus-article-date-original)
4335   (gnus-article-edit-article
4336    'ignore
4337    `(lambda (no-highlight)
4338       'ignore
4339       (gnus-summary-edit-article-done
4340        ,(or (mail-header-references gnus-current-headers) "")
4341        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
4342
4343 (defun gnus-article-edit-article (start-func exit-func)
4344   "Start editing the contents of the current article buffer."
4345   (let ((winconf (current-window-configuration)))
4346     (set-buffer gnus-article-buffer)
4347     (gnus-article-edit-mode)
4348     (funcall start-func)
4349     (gnus-configure-windows 'edit-article)
4350     (setq gnus-article-edit-done-function exit-func)
4351     (setq gnus-prev-winconf winconf)
4352     (when gnus-article-edit-article-setup-function
4353       (funcall gnus-article-edit-article-setup-function))
4354     (gnus-message 6 "C-c C-c to end edits")))
4355
4356 (defun gnus-article-edit-done (&optional arg)
4357   "Update the article edits and exit."
4358   (interactive "P")
4359   (save-excursion
4360     (save-restriction
4361       (widen)
4362       (when (article-goto-body)
4363         (let ((lines (count-lines (point) (point-max)))
4364               (length (- (point-max) (point)))
4365               (case-fold-search t)
4366               (body (copy-marker (point))))
4367           (goto-char (point-min))
4368           (when (re-search-forward "^content-length:[ \t]\\([0-9]+\\)" body t)
4369             (delete-region (match-beginning 1) (match-end 1))
4370             (insert (number-to-string length)))
4371           (goto-char (point-min))
4372           (when (re-search-forward
4373                  "^x-content-length:[ \t]\\([0-9]+\\)" body t)
4374             (delete-region (match-beginning 1) (match-end 1))
4375             (insert (number-to-string length)))
4376           (goto-char (point-min))
4377           (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
4378             (delete-region (match-beginning 1) (match-end 1))
4379             (insert (number-to-string lines)))))))
4380   (let ((func gnus-article-edit-done-function)
4381         (buf (current-buffer))
4382         (start (window-start)))
4383     (remove-hook 'gnus-article-mode-hook
4384                  'gnus-article-mime-edit-article-unwind)
4385     (gnus-article-edit-exit)
4386     (save-excursion
4387       (set-buffer buf)
4388       (let ((buffer-read-only nil))
4389         (funcall func arg))
4390       ;; The cache and backlog have to be flushed somewhat.
4391       (when gnus-keep-backlog
4392         (gnus-backlog-remove-article
4393          (car gnus-article-current) (cdr gnus-article-current)))
4394       ;; Flush original article as well.
4395       (save-excursion
4396         (when (get-buffer gnus-original-article-buffer)
4397           (set-buffer gnus-original-article-buffer)
4398           (setq gnus-original-article nil)))
4399       (when gnus-use-cache
4400         (gnus-cache-update-article
4401          (car gnus-article-current) (cdr gnus-article-current))))
4402     (set-buffer buf)
4403     (set-window-start (get-buffer-window buf) start)
4404     (set-window-point (get-buffer-window buf) (point))))
4405
4406 (defun gnus-article-edit-exit ()
4407   "Exit the article editing without updating."
4408   (interactive)
4409   ;; We remove all text props from the article buffer.
4410   (let ((buf (buffer-substring-no-properties (point-min) (point-max)))
4411         (curbuf (current-buffer))
4412         (p (point))
4413         (window-start (window-start)))
4414     (erase-buffer)
4415     (insert buf)
4416     (let ((winconf gnus-prev-winconf))
4417       (gnus-article-mode)
4418       (set-window-configuration winconf)
4419       ;; Tippy-toe some to make sure that point remains where it was.
4420       (save-current-buffer
4421         (set-buffer curbuf)
4422         (set-window-start (get-buffer-window (current-buffer)) window-start)
4423         (goto-char p)))))
4424
4425 (defun gnus-article-edit-full-stops ()
4426   "Interactively repair spacing at end of sentences."
4427   (interactive)
4428   (save-excursion
4429     (goto-char (point-min))
4430     (search-forward-regexp "^$" nil t)
4431     (let ((case-fold-search nil))
4432       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
4433
4434 ;;;
4435 ;;; Article editing with MIME-Edit
4436 ;;;
4437
4438 (defcustom gnus-article-mime-edit-article-setup-hook nil
4439   "Hook run after setting up a MIME editing article buffer."
4440   :group 'gnus-article-various
4441   :type 'hook)
4442
4443 (defun gnus-article-mime-edit-article-unwind ()
4444   "Unwind `gnus-article-buffer' if article editing was given up."
4445   (remove-hook 'gnus-article-mode-hook 'gnus-article-mime-edit-article-unwind)
4446   (when mime-edit-mode-flag
4447     (mime-edit-exit 'nomime 'no-error)
4448     (message ""))
4449   (when (featurep 'font-lock)
4450     (setq font-lock-defaults nil)
4451     (font-lock-mode 0)))
4452
4453 (defun gnus-article-mime-edit-article-setup ()
4454   "Convert current buffer to MIME-Edit buffer and turn on MIME-Edit mode
4455 after replacing with the original article."
4456   (setq gnus-show-mime t)
4457   (setq gnus-article-edit-done-function
4458         `(lambda (&rest args)
4459            (when mime-edit-mode-flag
4460              (mime-edit-exit)
4461              (message ""))
4462            (goto-char (point-min))
4463            (let (case-fold-search)
4464              (when (re-search-forward
4465                     (format "^%s$" (regexp-quote mail-header-separator))
4466                     nil t)
4467                (replace-match "")))
4468            (when (featurep 'font-lock)
4469              (setq font-lock-defaults nil)
4470              (font-lock-mode 0))
4471            (apply ,gnus-article-edit-done-function args)
4472            (set-buffer gnus-original-article-buffer)
4473            (erase-buffer)
4474            (insert-buffer gnus-article-buffer)
4475            (setq gnus-current-headers (gnus-article-make-full-mail-header))
4476            (gnus-article-prepare-display)))
4477   (substitute-key-definition
4478    'gnus-article-edit-exit 'gnus-article-mime-edit-exit
4479    gnus-article-edit-mode-map)
4480   (erase-buffer)
4481   (insert-buffer gnus-original-article-buffer)
4482   (mime-edit-again)
4483   (when (featurep 'font-lock)
4484     (set (make-local-variable 'font-lock-defaults)
4485          '(message-font-lock-keywords t))
4486     (font-lock-set-defaults)
4487     (turn-on-font-lock))
4488   (add-hook 'gnus-article-mode-hook 'gnus-article-mime-edit-article-unwind)
4489   (gnus-run-hooks 'gnus-article-mime-edit-article-setup-hook))
4490
4491 (defun gnus-article-mime-edit-exit ()
4492   "Exit the article MIME editing without updating."
4493   (interactive)
4494   (let ((winconf gnus-prev-winconf)
4495         buf)
4496     (when mime-edit-mode-flag
4497       (mime-edit-exit)
4498       (message ""))
4499     (goto-char (point-min))
4500     (let (case-fold-search)
4501       (when (re-search-forward
4502              (format "^%s$" (regexp-quote mail-header-separator)) nil t)
4503         (replace-match "")))
4504     (when (featurep 'font-lock)
4505       (setq font-lock-defaults nil)
4506       (font-lock-mode 0))
4507     ;; We remove all text props from the article buffer.
4508     (setq buf (format "%s" (buffer-string)))
4509     (set-buffer (get-buffer-create gnus-original-article-buffer))
4510     (erase-buffer)
4511     (insert buf)
4512     (setq gnus-current-headers (gnus-article-make-full-mail-header))
4513     (gnus-article-prepare-display)
4514     (set-window-configuration winconf)))
4515
4516 ;;;
4517 ;;; Article highlights
4518 ;;;
4519
4520 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
4521
4522 ;;; Internal Variables:
4523
4524 (defcustom gnus-button-url-regexp "\\b\\(\\(www\\.\\|\\(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\\)\\)"
4525   "Regular expression that matches URLs."
4526   :group 'gnus-article-buttons
4527   :type 'regexp)
4528
4529 (defcustom gnus-button-alist
4530   `(("<\\(url:[>\n\t ]*?\\)?news:[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
4531      0 t gnus-button-message-id 2)
4532     ("\\bnews:\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t gnus-button-message-id 1)
4533     ("\\(\\b<\\(url:[>\n\t ]*\\)?news:[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
4534      1 t
4535      gnus-button-fetch-group 4)
4536     ("\\bnews:\\(//\\)?\\([^'\">\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
4537     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
4538      t gnus-button-message-id 3)
4539     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 2)
4540     ("mailto:\\([-a-zA-Z.@_+0-9%]+\\)" 0 t gnus-url-mailto 1)
4541     ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 1)
4542     ;; This is how URLs _should_ be embedded in text...
4543     ("<URL: *\\([^<>]*\\)>" 0 t gnus-button-embedded-url 1)
4544     ;; Raw URLs.
4545     (,gnus-button-url-regexp 0 t browse-url 0))
4546   "*Alist of regexps matching buttons in article bodies.
4547
4548 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
4549 REGEXP: is the string matching text around the button,
4550 BUTTON: is the number of the regexp grouping actually matching the button,
4551 FORM: is a lisp expression which must eval to true for the button to
4552 be added,
4553 CALLBACK: is the function to call when the user push this button, and each
4554 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
4555
4556 CALLBACK can also be a variable, in that case the value of that
4557 variable it the real callback function."
4558   :group 'gnus-article-buttons
4559   :type '(repeat (list regexp
4560                        (integer :tag "Button")
4561                        (sexp :tag "Form")
4562                        (function :tag "Callback")
4563                        (repeat :tag "Par"
4564                                :inline t
4565                                (integer :tag "Regexp group")))))
4566
4567 (defcustom gnus-header-button-alist
4568   `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
4569      0 t gnus-button-message-id 0)
4570     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
4571     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
4572      0 t gnus-button-mailto 0)
4573     ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t browse-url 0)
4574     ("^Subject:" ,gnus-button-url-regexp 0 t browse-url 0)
4575     ("^[^:]+:" ,gnus-button-url-regexp 0 t browse-url 0)
4576     ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
4577      gnus-button-message-id 3))
4578   "*Alist of headers and regexps to match buttons in article heads.
4579
4580 This alist is very similar to `gnus-button-alist', except that each
4581 alist has an additional HEADER element first in each entry:
4582
4583 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
4584
4585 HEADER is a regexp to match a header.  For a fuller explanation, see
4586 `gnus-button-alist'."
4587   :group 'gnus-article-buttons
4588   :group 'gnus-article-headers
4589   :type '(repeat (list (regexp :tag "Header")
4590                        regexp
4591                        (integer :tag "Button")
4592                        (sexp :tag "Form")
4593                        (function :tag "Callback")
4594                        (repeat :tag "Par"
4595                                :inline t
4596                                (integer :tag "Regexp group")))))
4597
4598 (defvar gnus-button-regexp nil)
4599 (defvar gnus-button-marker-list nil)
4600 ;; Regexp matching any of the regexps from `gnus-button-alist'.
4601
4602 (defvar gnus-button-last nil)
4603 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
4604
4605 ;;; Commands:
4606
4607 (defun gnus-article-push-button (event)
4608   "Check text under the mouse pointer for a callback function.
4609 If the text under the mouse pointer has a `gnus-callback' property,
4610 call it with the value of the `gnus-data' text property."
4611   (interactive "e")
4612   (set-buffer (window-buffer (posn-window (event-start event))))
4613   (let* ((pos (posn-point (event-start event)))
4614          (data (get-text-property pos 'gnus-data))
4615          (fun (get-text-property pos 'gnus-callback)))
4616     (goto-char pos)
4617     (when fun
4618       (funcall fun data))))
4619
4620 (defun gnus-article-press-button ()
4621   "Check text at point for a callback function.
4622 If the text at point has a `gnus-callback' property,
4623 call it with the value of the `gnus-data' text property."
4624   (interactive)
4625   (let* ((data (get-text-property (point) 'gnus-data))
4626          (fun (get-text-property (point) 'gnus-callback)))
4627     (when fun
4628       (funcall fun data))))
4629
4630 (defun gnus-article-prev-button (n)
4631   "Move point to N buttons backward.
4632 If N is negative, move forward instead."
4633   (interactive "p")
4634   (gnus-article-next-button (- n)))
4635
4636 (defun gnus-article-next-button (n)
4637   "Move point to N buttons forward.
4638 If N is negative, move backward instead."
4639   (interactive "p")
4640   (let ((function (if (< n 0) 'previous-single-property-change
4641                     'next-single-property-change))
4642         (inhibit-point-motion-hooks t)
4643         (backward (< n 0))
4644         (limit (if (< n 0) (point-min) (point-max))))
4645     (setq n (abs n))
4646     (while (and (not (= limit (point)))
4647                 (> n 0))
4648       ;; Skip past the current button.
4649       (when (get-text-property (point) 'gnus-callback)
4650         (goto-char (funcall function (point) 'gnus-callback nil limit)))
4651       ;; Go to the next (or previous) button.
4652       (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
4653       ;; Put point at the start of the button.
4654       (when (and backward (not (get-text-property (point) 'gnus-callback)))
4655         (goto-char (funcall function (point) 'gnus-callback nil limit)))
4656       ;; Skip past intangible buttons.
4657       (when (get-text-property (point) 'intangible)
4658         (incf n))
4659       (decf n))
4660     (unless (zerop n)
4661       (gnus-message 5 "No more buttons"))
4662     n))
4663
4664 (defun gnus-article-highlight (&optional force)
4665   "Highlight current article.
4666 This function calls `gnus-article-highlight-headers',
4667 `gnus-article-highlight-citation',
4668 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4669 do the highlighting.  See the documentation for those functions."
4670   (interactive (list 'force))
4671   (gnus-article-highlight-headers)
4672   (gnus-article-highlight-citation force)
4673   (gnus-article-highlight-signature)
4674   (gnus-article-add-buttons force)
4675   (gnus-article-add-buttons-to-head))
4676
4677 (defun gnus-article-highlight-some (&optional force)
4678   "Highlight current article.
4679 This function calls `gnus-article-highlight-headers',
4680 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4681 do the highlighting.  See the documentation for those functions."
4682   (interactive (list 'force))
4683   (gnus-article-highlight-headers)
4684   (gnus-article-highlight-signature)
4685   (gnus-article-add-buttons))
4686
4687 (defun gnus-article-highlight-headers ()
4688   "Highlight article headers as specified by `gnus-header-face-alist'."
4689   (interactive)
4690   (save-excursion
4691     (set-buffer gnus-article-buffer)
4692     (save-restriction
4693       (let ((alist gnus-header-face-alist)
4694             (buffer-read-only nil)
4695             (case-fold-search t)
4696             (inhibit-point-motion-hooks t)
4697             entry regexp header-face field-face from hpoints fpoints)
4698         (article-narrow-to-head)
4699         (while (setq entry (pop alist))
4700           (goto-char (point-min))
4701           (setq regexp (concat "^\\("
4702                                (if (string-equal "" (nth 0 entry))
4703                                    "[^\t ]"
4704                                  (nth 0 entry))
4705                                "\\)")
4706                 header-face (nth 1 entry)
4707                 field-face (nth 2 entry))
4708           (while (and (re-search-forward regexp nil t)
4709                       (not (eobp)))
4710             (beginning-of-line)
4711             (setq from (point))
4712             (unless (search-forward ":" nil t)
4713               (forward-char 1))
4714             (when (and header-face
4715                        (not (memq (point) hpoints)))
4716               (push (point) hpoints)
4717               (gnus-put-text-property from (point) 'face header-face))
4718             (when (and field-face
4719                        (not (memq (setq from (point)) fpoints)))
4720               (push from fpoints)
4721               (if (re-search-forward "^[^ \t]" nil t)
4722                   (forward-char -2)
4723                 (goto-char (point-max)))
4724               (gnus-put-text-property from (point) 'face field-face))))))))
4725
4726 (defun gnus-article-highlight-signature ()
4727   "Highlight the signature in an article.
4728 It does this by highlighting everything after
4729 `gnus-signature-separator' using `gnus-signature-face'."
4730   (interactive)
4731   (when gnus-signature-face
4732     (save-excursion
4733       (set-buffer gnus-article-buffer)
4734       (let ((buffer-read-only nil)
4735             (inhibit-point-motion-hooks t))
4736         (save-restriction
4737           (when (gnus-article-narrow-to-signature)
4738             (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
4739                               'face gnus-signature-face)))))))
4740
4741 (defun gnus-article-buttonize-signature ()
4742   "Add button to the signature."
4743   (interactive)
4744   (save-excursion
4745     (set-buffer gnus-article-buffer)
4746     (let ((buffer-read-only nil)
4747           (inhibit-point-motion-hooks t))
4748       (when (gnus-article-search-signature)
4749         (gnus-article-add-button (match-beginning 0) (match-end 0)
4750                                  'gnus-signature-toggle
4751                                  (set-marker (make-marker)
4752                                              (1+ (match-end 0))))))))
4753
4754 (defun gnus-button-in-region-p (b e prop)
4755   "Say whether PROP exists in the region."
4756   (text-property-not-all b e prop nil))
4757
4758 (defun gnus-article-add-buttons (&optional force)
4759   "Find external references in the article and make buttons of them.
4760 \"External references\" are things like Message-IDs and URLs, as
4761 specified by `gnus-button-alist'."
4762   (interactive (list 'force))
4763   (save-excursion
4764     (set-buffer gnus-article-buffer)
4765     (let ((buffer-read-only nil)
4766           (inhibit-point-motion-hooks t)
4767           (case-fold-search t)
4768           (alist gnus-button-alist)
4769           beg entry regexp)
4770       ;; Remove all old markers.
4771       (let (marker entry new-list)
4772         (while (setq marker (pop gnus-button-marker-list))
4773           (if (or (< marker (point-min)) (>= marker (point-max)))
4774               (push marker new-list)
4775             (goto-char marker)
4776             (when (setq entry (gnus-button-entry))
4777               (put-text-property (match-beginning (nth 1 entry))
4778                                  (match-end (nth 1 entry))
4779                                  'gnus-callback nil))
4780             (set-marker marker nil)))
4781         (setq gnus-button-marker-list new-list))
4782       ;; We skip the headers.
4783       (article-goto-body)
4784       (setq beg (point))
4785       (while (setq entry (pop alist))
4786         (setq regexp (car entry))
4787         (goto-char beg)
4788         (while (re-search-forward regexp nil t)
4789           (let* ((start (and entry (match-beginning (nth 1 entry))))
4790                  (end (and entry (match-end (nth 1 entry))))
4791                  (from (match-beginning 0)))
4792             (when (and (or (eq t (nth 2 entry))
4793                            (eval (nth 2 entry)))
4794                        (not (gnus-button-in-region-p
4795                              start end 'gnus-callback)))
4796               ;; That optional form returned non-nil, so we add the
4797               ;; button.
4798               (gnus-article-add-button
4799                start end 'gnus-button-push
4800                (car (push (set-marker (make-marker) from)
4801                           gnus-button-marker-list))))))))))
4802
4803 ;; Add buttons to the head of an article.
4804 (defun gnus-article-add-buttons-to-head ()
4805   "Add buttons to the head of the article."
4806   (interactive)
4807   (save-excursion
4808     (set-buffer gnus-article-buffer)
4809     (save-restriction
4810       (let ((buffer-read-only nil)
4811             (inhibit-point-motion-hooks t)
4812             (case-fold-search t)
4813             (alist gnus-header-button-alist)
4814             entry beg end)
4815         (article-narrow-to-head)
4816         (while alist
4817           ;; Each alist entry.
4818           (setq entry (car alist)
4819                 alist (cdr alist))
4820           (goto-char (point-min))
4821           (while (re-search-forward (car entry) nil t)
4822             ;; Each header matching the entry.
4823             (setq beg (match-beginning 0))
4824             (setq end (or (and (re-search-forward "^[^ \t]" nil t)
4825                                (match-beginning 0))
4826                           (point-max)))
4827             (goto-char beg)
4828             (while (re-search-forward (nth 1 entry) end t)
4829               ;; Each match within a header.
4830               (let* ((entry (cdr entry))
4831                      (start (match-beginning (nth 1 entry)))
4832                      (end (match-end (nth 1 entry)))
4833                      (form (nth 2 entry)))
4834                 (goto-char (match-end 0))
4835                 (when (eval form)
4836                   (gnus-article-add-button
4837                    start end (nth 3 entry)
4838                    (buffer-substring (match-beginning (nth 4 entry))
4839                                      (match-end (nth 4 entry)))))))
4840             (goto-char end)))))))
4841
4842 ;;; External functions:
4843
4844 (defun gnus-article-add-button (from to fun &optional data)
4845   "Create a button between FROM and TO with callback FUN and data DATA."
4846   (when gnus-article-button-face
4847     (gnus-overlay-put (gnus-make-overlay from to)
4848                       'face gnus-article-button-face))
4849   (gnus-add-text-properties
4850    from to
4851    (nconc (and gnus-article-mouse-face
4852                (list gnus-mouse-face-prop gnus-article-mouse-face))
4853           (list 'gnus-callback fun)
4854           (and data (list 'gnus-data data)))))
4855
4856 ;;; Internal functions:
4857
4858 (defun gnus-article-set-globals ()
4859   (save-excursion
4860     (set-buffer gnus-summary-buffer)
4861     (gnus-set-global-variables)))
4862
4863 (defun gnus-signature-toggle (end)
4864   (save-excursion
4865     (set-buffer gnus-article-buffer)
4866     (let ((buffer-read-only nil)
4867           (inhibit-point-motion-hooks t)
4868           (limit (next-single-property-change end 'mime-view-entity
4869                                               nil (point-max))))
4870       (if (get-text-property end 'invisible)
4871           (gnus-article-unhide-text end limit)
4872         (gnus-article-hide-text end limit gnus-hidden-properties)))))
4873
4874 (defun gnus-button-entry ()
4875   ;; Return the first entry in `gnus-button-alist' matching this place.
4876   (let ((alist gnus-button-alist)
4877         (entry nil))
4878     (while alist
4879       (setq entry (pop alist))
4880       (if (looking-at (car entry))
4881           (setq alist nil)
4882         (setq entry nil)))
4883     entry))
4884
4885 (defun gnus-button-push (marker)
4886   ;; Push button starting at MARKER.
4887   (save-excursion
4888     (goto-char marker)
4889     (let* ((entry (gnus-button-entry))
4890            (inhibit-point-motion-hooks t)
4891            (fun (nth 3 entry))
4892            (args (mapcar (lambda (group)
4893                            (let ((string (match-string group)))
4894                              (gnus-set-text-properties
4895                               0 (length string) nil string)
4896                              string))
4897                          (nthcdr 4 entry))))
4898       (cond
4899        ((fboundp fun)
4900         (apply fun args))
4901        ((and (boundp fun)
4902              (fboundp (symbol-value fun)))
4903         (apply (symbol-value fun) args))
4904        (t
4905         (gnus-message 1 "You must define `%S' to use this button"
4906                       (cons fun args)))))))
4907
4908 (defun gnus-button-message-id (message-id)
4909   "Fetch MESSAGE-ID."
4910   (save-excursion
4911     (set-buffer gnus-summary-buffer)
4912     (gnus-summary-refer-article message-id)))
4913
4914 (defun gnus-button-fetch-group (address)
4915   "Fetch GROUP specified by ADDRESS."
4916   (if (not (string-match "[:/]" address))
4917       ;; This is just a simple group url.
4918       (gnus-group-read-ephemeral-group address gnus-select-method)
4919     (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)/\\)?\\(.*\\)$"
4920                            address))
4921         (error "Can't parse %s" address)
4922       (gnus-group-read-ephemeral-group
4923        (match-string 4 address)
4924        `(nntp ,(match-string 1 address)
4925               (nntp-address ,(match-string 1 address))
4926               (nntp-port-number ,(if (match-end 3)
4927                                      (match-string 3 address)
4928                                    "nntp")))))))
4929
4930 (defun gnus-url-parse-query-string (query &optional downcase)
4931   (let (retval pairs cur key val)
4932     (setq pairs (split-string query "&"))
4933     (while pairs
4934       (setq cur (car pairs)
4935             pairs (cdr pairs))
4936       (if (not (string-match "=" cur))
4937           nil                           ; Grace
4938         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
4939               val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
4940         (if downcase
4941             (setq key (downcase key)))
4942         (setq cur (assoc key retval))
4943         (if cur
4944             (setcdr cur (cons val (cdr cur)))
4945           (setq retval (cons (list key val) retval)))))
4946     retval))
4947
4948 (defun gnus-url-unhex (x)
4949   (if (> x ?9)
4950       (if (>= x ?a)
4951           (+ 10 (- x ?a))
4952         (+ 10 (- x ?A)))
4953     (- x ?0)))
4954
4955 (defun gnus-url-unhex-string (str &optional allow-newlines)
4956   "Remove %XXX embedded spaces, etc in a url.
4957 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
4958 decoding of carriage returns and line feeds in the string, which is normally
4959 forbidden in URL encoding."
4960   (setq str (or str ""))
4961   (let ((tmp "")
4962         (case-fold-search t))
4963     (while (string-match "%[0-9a-f][0-9a-f]" str)
4964       (let* ((start (match-beginning 0))
4965              (ch1 (gnus-url-unhex (elt str (+ start 1))))
4966              (code (+ (* 16 ch1)
4967                       (gnus-url-unhex (elt str (+ start 2))))))
4968         (setq tmp (concat
4969                    tmp (substring str 0 start)
4970                    (cond
4971                     (allow-newlines
4972                      (char-to-string code))
4973                     ((or (= code ?\n) (= code ?\r))
4974                      " ")
4975                     (t (char-to-string code))))
4976               str (substring str (match-end 0)))))
4977     (setq tmp (concat tmp str))
4978     tmp))
4979
4980 (defun gnus-url-mailto (url)
4981   ;; Send mail to someone
4982   (when (string-match "mailto:/*\\(.*\\)" url)
4983     (setq url (substring url (match-beginning 1) nil)))
4984   (let (to args subject func)
4985     (if (string-match (regexp-quote "?") url)
4986         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
4987               args (gnus-url-parse-query-string
4988                     (substring url (match-end 0) nil) t))
4989       (setq to (gnus-url-unhex-string url)))
4990     (setq args (cons (list "to" to) args)
4991           subject (cdr-safe (assoc "subject" args)))
4992     (gnus-setup-message 'reply
4993       (message-mail)
4994       (while args
4995         (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
4996         (if (fboundp func)
4997             (funcall func)
4998           (message-position-on-field (caar args)))
4999         (insert (mapconcat 'identity (cdar args) ", "))
5000         (setq args (cdr args)))
5001       (if subject
5002           (message-goto-body)
5003         (message-goto-subject)))))
5004
5005 (defun gnus-button-mailto (address)
5006   ;; Mail to ADDRESS.
5007   (set-buffer (gnus-copy-article-buffer))
5008   (gnus-setup-message 'reply
5009     (message-reply address)))
5010
5011 (defun gnus-button-reply (address)
5012   ;; Reply to ADDRESS.
5013   (gnus-setup-message 'reply
5014     (message-reply address)))
5015
5016 (defun gnus-button-embedded-url (address)
5017   "Browse ADDRESS."
5018   (browse-url (gnus-strip-whitespace address)))
5019
5020 (defun gnus-article-smiley-display ()
5021   "Display \"smileys\" as small graphical icons."
5022   (smiley-toggle-buffer 1 (current-buffer) (point-min) (point-max)))
5023
5024 ;;; Next/prev buttons in the article buffer.
5025
5026 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
5027 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
5028
5029 (defvar gnus-prev-page-map nil)
5030 (unless gnus-prev-page-map
5031   (setq gnus-prev-page-map (make-sparse-keymap))
5032   (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
5033   (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
5034
5035 (static-if (featurep 'xemacs)
5036     (defun gnus-insert-prev-page-button ()
5037       (let ((buffer-read-only nil))
5038         (gnus-eval-format
5039          gnus-prev-page-line-format nil
5040          `(gnus-prev t local-map ,gnus-prev-page-map
5041                      gnus-callback gnus-article-button-prev-page
5042                      article-type annotation))))
5043   (defun gnus-insert-prev-page-button ()
5044     (let ((buffer-read-only nil)
5045           (situation (get-text-property (point-min) 'mime-view-situation)))
5046       (set-keymap-parent gnus-prev-page-map (current-local-map))
5047       (gnus-eval-format
5048        gnus-prev-page-line-format nil
5049        `(gnus-prev t local-map ,gnus-prev-page-map
5050                    gnus-callback gnus-article-button-prev-page
5051                    article-type annotation
5052                    mime-view-situation ,situation))))
5053   )
5054
5055 (defvar gnus-next-page-map nil)
5056 (unless gnus-next-page-map
5057   (setq gnus-next-page-map (make-sparse-keymap))
5058   (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
5059   (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
5060
5061 (defun gnus-button-next-page ()
5062   "Go to the next page."
5063   (interactive)
5064   (let ((win (selected-window)))
5065     (select-window (get-buffer-window gnus-article-buffer t))
5066     (gnus-article-next-page)
5067     (select-window win)))
5068
5069 (defun gnus-button-prev-page ()
5070   "Go to the prev page."
5071   (interactive)
5072   (let ((win (selected-window)))
5073     (select-window (get-buffer-window gnus-article-buffer t))
5074     (gnus-article-prev-page)
5075     (select-window win)))
5076
5077 (static-if (featurep 'xemacs)
5078     (defun gnus-insert-next-page-button ()
5079       (let ((buffer-read-only nil))
5080         (gnus-eval-format gnus-next-page-line-format nil
5081                           `(gnus-next
5082                             t local-map ,gnus-next-page-map
5083                             gnus-callback gnus-article-button-next-page
5084                             article-type annotation))))
5085   (defun gnus-insert-next-page-button ()
5086     (let ((buffer-read-only nil)
5087           (situation (get-text-property (point-min) 'mime-view-situation)))
5088       (set-keymap-parent gnus-next-page-map (current-local-map))
5089       (gnus-eval-format gnus-next-page-line-format nil
5090                         `(gnus-next
5091                           t local-map ,gnus-next-page-map
5092                           gnus-callback gnus-article-button-next-page
5093                           article-type annotation
5094                           mime-view-situation ,situation))))
5095   )
5096
5097 (defun gnus-article-button-next-page (arg)
5098   "Go to the next page."
5099   (interactive "P")
5100   (let ((win (selected-window)))
5101     (select-window (get-buffer-window gnus-article-buffer t))
5102     (gnus-article-next-page)
5103     (select-window win)))
5104
5105 (defun gnus-article-button-prev-page (arg)
5106   "Go to the prev page."
5107   (interactive "P")
5108   (let ((win (selected-window)))
5109     (select-window (get-buffer-window gnus-article-buffer t))
5110     (gnus-article-prev-page)
5111     (select-window win)))
5112
5113 (defvar gnus-decode-header-methods
5114   '(mail-decode-encoded-word-region)
5115   "List of methods used to decode headers.
5116
5117 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
5118 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
5119 (REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
5120 whose names match REGEXP.
5121
5122 For example:
5123 ((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
5124  mail-decode-encoded-word-region
5125  (\"chinese\" . rfc1843-decode-region))
5126 ")
5127
5128 (defvar gnus-decode-header-methods-cache nil)
5129
5130 (defun gnus-multi-decode-header (start end)
5131   "Apply the functions from `gnus-encoded-word-methods' that match."
5132   (unless (and gnus-decode-header-methods-cache
5133                (eq gnus-newsgroup-name
5134                    (car gnus-decode-header-methods-cache)))
5135     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
5136     (mapcar (lambda (x)
5137               (if (symbolp x)
5138                   (nconc gnus-decode-header-methods-cache (list x))
5139                 (if (and gnus-newsgroup-name
5140                          (string-match (car x) gnus-newsgroup-name))
5141                     (nconc gnus-decode-header-methods-cache
5142                            (list (cdr x))))))
5143           gnus-decode-header-methods))
5144   (let ((xlist gnus-decode-header-methods-cache))
5145     (pop xlist)
5146     (save-restriction
5147       (narrow-to-region start end)
5148       (while xlist
5149         (funcall (pop xlist) (point-min) (point-max))))))
5150
5151 ;;;
5152 ;;; Treatment top-level handling.
5153 ;;;
5154
5155 (defun gnus-treat-article (condition &optional part-number total-parts type)
5156   (let ((length (- (point-max) (point-min)))
5157         (alist gnus-treatment-function-alist)
5158         (article-goto-body-goes-to-point-min-p t)
5159         (treated-type
5160          (or (not type)
5161              (catch 'found
5162                (let ((list gnus-article-treat-types))
5163                  (while list
5164                    (when (string-match (pop list) type)
5165                      (throw 'found t)))))))
5166         (highlightp (gnus-visual-p 'article-highlight 'highlight))
5167         (entity (static-unless (featurep 'xemacs)
5168                   (when (eq 'head condition)
5169                     (get-text-property (point-min) 'mime-view-entity))))
5170         val elem buttonized)
5171     (gnus-run-hooks 'gnus-part-display-hook)
5172     (unless gnus-inhibit-treatment
5173       (while (setq elem (pop alist))
5174         (setq val
5175               (save-excursion
5176                 (if (gnus-buffer-live-p gnus-summary-buffer)
5177                     (set-buffer gnus-summary-buffer))
5178                 (symbol-value (car elem))))
5179         (when (and (or (consp val)
5180                        treated-type)
5181                    (gnus-treat-predicate val)
5182                    (or (not (get (car elem) 'highlight))
5183                        highlightp))
5184           (when (and (not buttonized)
5185                      (memq (car elem)
5186                            '(gnus-treat-hide-signature
5187                              gnus-treat-highlight-signature)))
5188             (gnus-article-buttonize-signature)
5189             (setq buttonized t))
5190           (save-restriction
5191             (funcall (cadr elem)))))
5192       ;; FSF Emacsen does not inherit the existing text properties
5193       ;; in the new text, so we should do it for `mime-view-entity'.
5194       (static-unless (featurep 'xemacs)
5195         (when entity
5196           (put-text-property (point-min) (point-max)
5197                              'mime-view-entity entity))))))
5198
5199 ;; Dynamic variables.
5200 (defvar part-number)
5201 (defvar total-parts)
5202 (defvar type)
5203 (defvar condition)
5204 (defvar length)
5205 (defun gnus-treat-predicate (val)
5206   (cond
5207    ((null val)
5208     nil)
5209    ((and (listp val)
5210          (stringp (car val)))
5211     (apply 'gnus-or (mapcar `(lambda (s)
5212                                (string-match s ,(or gnus-newsgroup-name "")))
5213                             val)))
5214    ((listp val)
5215     (let ((pred (pop val)))
5216       (cond
5217        ((eq pred 'or)
5218         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
5219        ((eq pred 'and)
5220         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
5221        ((eq pred 'not)
5222         (not (gnus-treat-predicate (car val))))
5223        ((eq pred 'typep)
5224         (equal (car val) type))
5225        (t
5226         (error "%S is not a valid predicate" pred)))))
5227    ((eq val 'mime)
5228     gnus-show-mime)
5229    (condition
5230     (eq condition val))
5231    ((eq val t)
5232     t)
5233    ((eq val 'head)
5234     nil)
5235    ((eq val 'last)
5236     (eq part-number total-parts))
5237    ((numberp val)
5238     (< length val))
5239    (t
5240     (error "%S is not a valid value" val))))
5241
5242
5243 ;;; @ for mime-view
5244 ;;;
5245
5246 (defun gnus-article-header-presentation-method (entity situation)
5247   (mime-insert-header entity)
5248   )
5249
5250 (set-alist 'mime-header-presentation-method-alist
5251            'gnus-original-article-mode
5252            #'gnus-article-header-presentation-method)
5253
5254 (defun gnus-mime-preview-quitting-method ()
5255   (mime-preview-kill-buffer)
5256   (delete-other-windows)
5257   (gnus-article-show-summary)
5258   (gnus-summary-select-article gnus-show-all-headers t))
5259
5260 (set-alist 'mime-preview-quitting-method-alist
5261            'gnus-original-article-mode #'gnus-mime-preview-quitting-method)
5262
5263 (set-alist 'mime-preview-following-method-alist
5264            'gnus-original-article-mode #'gnus-following-method)
5265
5266 (set-alist 'mime-preview-over-to-previous-method-alist
5267            'gnus-original-article-mode
5268            (lambda ()
5269              (if (> (point-min) 1)
5270                  (gnus-article-prev-page)
5271                (gnus-article-read-summary-keys
5272                 nil (gnus-character-to-event ?P)))))
5273
5274 (set-alist 'mime-preview-over-to-next-method-alist
5275            'gnus-original-article-mode'
5276            (lambda ()
5277              (if (< (point-max) (buffer-size))
5278                  (gnus-article-next-page)
5279                (gnus-article-read-summary-keys
5280                 nil (gnus-character-to-event ?N)))))
5281
5282
5283 ;;; @ end
5284 ;;;
5285
5286 (gnus-ems-redefine)
5287
5288 (provide 'gnus-art)
5289
5290 (run-hooks 'gnus-art-load-hook)
5291
5292 ;;; gnus-art.el ends here