(article-strip-banner): Use original from fields instead of
[gnus] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile
30   (require 'cl)
31   (defvar tool-bar-map))
32
33 (require 'gnus)
34 (require 'gnus-sum)
35 (require 'gnus-spec)
36 (require 'gnus-int)
37 (require 'gnus-win)
38 (require 'mm-bodies)
39 (require 'mail-parse)
40 (require 'mm-decode)
41 (require 'mm-view)
42 (require 'wid-edit)
43 (require 'mm-uu)
44 (require 'message)
45
46 (autoload 'gnus-msg-mail "gnus-msg" nil t)
47 (autoload 'gnus-button-mailto "gnus-msg")
48 (autoload 'gnus-button-reply "gnus-msg" nil t)
49 (autoload 'ansi-color-apply-on-region "ansi-color")
50
51 (defgroup gnus-article nil
52   "Article display."
53   :link '(custom-manual "(gnus)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   (mapcar
114    (lambda (header)
115      (concat "^" header ":"))
116    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
117      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
118      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
119      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
120      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
121      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
122      "X-Attribution" "X-Originating-IP" "Delivered-To"
123      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
124      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
125      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
126      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
127      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
128      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
129      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
130      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
131      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
132      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
133      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
134      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
135      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
136      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
137      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
138      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
139      "List-[A-Za-z]+" "X-Listprocessor-Version"
140      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
141      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
142      "X-Received" "Content-length" "X-precedence"
143      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
144      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
145      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
146      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
147      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
148      "X-Content-length" "X-Posting-Agent" "Original-Received"
149      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
150      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
151      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
152      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
153      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"))
154   "*All headers that start with this regexp will be hidden.
155 This variable can also be a list of regexps of headers to be ignored.
156 If `gnus-visible-headers' is non-nil, this variable will be ignored."
157   :type '(choice :custom-show nil
158                  regexp
159                  (repeat regexp))
160   :group 'gnus-article-hiding)
161
162 (defcustom gnus-visible-headers
163   "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Mail-Followup-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
164   "*All headers that do not match this regexp will be hidden.
165 This variable can also be a list of regexp of headers to remain visible.
166 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
167   :type '(repeat :value-to-internal (lambda (widget value)
168                                       (custom-split-regexp-maybe value))
169                  :match (lambda (widget value)
170                           (or (stringp value)
171                               (widget-editable-list-match widget value)))
172                  regexp)
173   :group 'gnus-article-hiding)
174
175 (defcustom gnus-sorted-header-list
176   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
177     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
178   "*This variable is a list of regular expressions.
179 If it is non-nil, headers that match the regular expressions will
180 be placed first in the article buffer in the sequence specified by
181 this list."
182   :type '(repeat regexp)
183   :group 'gnus-article-hiding)
184
185 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
186   "Headers that are only to be displayed if they have interesting data.
187 Possible values in this list are:
188
189   'empty       Headers with no content.
190   'newsgroups  Newsgroup identical to Gnus group.
191   'to-address  To identical to To-address.
192   'to-list     To identical to To-list.
193   'cc-list     CC identical to To-list.
194   'followup-to Followup-to identical to Newsgroups.
195   'reply-to    Reply-to identical to From.
196   'date        Date less than four days old.
197   'long-to     To and/or Cc longer than 1024 characters.
198   'many-to     Multiple To and/or Cc."
199   :type '(set (const :tag "Headers with no content." empty)
200               (const :tag "Newsgroups identical to Gnus group." newsgroups)
201               (const :tag "To identical to To-address." to-address)
202               (const :tag "To identical to To-list." to-list)
203               (const :tag "CC identical to To-list." cc-list)
204               (const :tag "Followup-to identical to Newsgroups." followup-to)
205               (const :tag "Reply-to identical to From." reply-to)
206               (const :tag "Date less than four days old." date)
207               (const :tag "To and/or Cc longer than 1024 characters." long-to)
208               (const :tag "Multiple To and/or Cc headers." many-to))
209   :group 'gnus-article-hiding)
210
211 (defcustom gnus-article-skip-boring nil
212   "Skip over text that is not worth reading.
213 By default, if you set this t, then Gnus will display citations and
214 signatures, but will never scroll down to show you a page consisting
215 only of boring text.  Boring text is controlled by
216 `gnus-article-boring-faces'."
217   :type 'boolean
218   :group 'gnus-article-hiding)
219
220 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
221   "Regexp matching signature separator.
222 This can also be a list of regexps.  In that case, it will be checked
223 from head to tail looking for a separator.  Searches will be done from
224 the end of the buffer."
225   :type '(repeat string)
226   :group 'gnus-article-signature)
227
228 (defcustom gnus-signature-limit nil
229   "Provide a limit to what is considered a signature.
230 If it is a number, no signature may not be longer (in characters) than
231 that number.  If it is a floating point number, no signature may be
232 longer (in lines) than that number.  If it is a function, the function
233 will be called without any parameters, and if it returns nil, there is
234 no signature in the buffer.  If it is a string, it will be used as a
235 regexp.  If it matches, the text in question is not a signature."
236   :type '(choice (integer :value 200)
237                  (number :value 4.0)
238                  (function :value fun)
239                  (regexp :value ".*"))
240   :group 'gnus-article-signature)
241
242 (defcustom gnus-hidden-properties '(invisible t intangible t)
243   "Property list to use for hiding text."
244   :type 'sexp
245   :group 'gnus-article-hiding)
246
247 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
248 ;; frames in a session.
249 (defcustom gnus-article-x-face-command
250   (if (featurep 'xemacs)
251       (if (or (gnus-image-type-available-p 'xface)
252               (gnus-image-type-available-p 'pbm))
253           'gnus-display-x-face-in-from
254         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
255     (if (gnus-image-type-available-p 'pbm)
256         'gnus-display-x-face-in-from
257       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
258 display -"))
259   "*String or function to be executed to display an X-Face header.
260 If it is a string, the command will be executed in a sub-shell
261 asynchronously.  The compressed face will be piped to this command."
262   :type `(choice string
263                  (function-item gnus-display-x-face-in-from)
264                  function)
265   :version "21.1"
266   :group 'gnus-picon
267   :group 'gnus-article-washing)
268
269 (defcustom gnus-article-x-face-too-ugly nil
270   "Regexp matching posters whose face shouldn't be shown automatically."
271   :type '(choice regexp (const nil))
272   :group 'gnus-article-washing)
273
274 (defcustom gnus-article-banner-alist nil
275   "Banner alist for stripping.
276 For example,
277      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
278   :version "21.1"
279   :type '(repeat (cons symbol regexp))
280   :group 'gnus-article-washing)
281
282 (gnus-define-group-parameter
283  banner
284  :variable-document
285  "Alist of regexps (to match group names) and banner."
286  :variable-group gnus-article-washing
287  :parameter-type
288  '(choice :tag "Banner"
289           :value nil
290           (const :tag "Remove signature" signature)
291           (symbol :tag "Item in `gnus-article-banner-alist'" none)
292           regexp
293           (const :tag "None" nil))
294  :parameter-document
295  "If non-nil, specify how to remove `banners' from articles.
296
297 Symbol `signature' means to remove signatures delimited by
298 `gnus-signature-separator'.  Any other symbol is used to look up a
299 regular expression to match the banner in `gnus-article-banner-alist'.
300 A string is used as a regular expression to match the banner
301 directly.")
302
303 (defcustom gnus-article-address-banner-alist nil
304   "Alist of mail addresses and banners.
305 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
306 to match a mail address in the From: header, BANNER is one of a symbol
307 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
308 If ADDRESS matches author's mail address, it will remove things like
309 advertisements.  For example:
310
311 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
312 "
313   :type '(repeat
314           (cons
315            (regexp :tag "Address")
316            (choice :tag "Banner" :value nil
317                    (const :tag "Remove signature" signature)
318                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
319                    regexp
320                    (const :tag "None" nil))))
321   :group 'gnus-article-washing)
322
323 (defcustom gnus-emphasis-alist
324   (let ((format
325          "\\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)")
326         (types
327          '(("\\*" "\\*" bold)
328            ("_" "_" underline)
329            ("/" "/" italic)
330            ("_/" "/_" underline-italic)
331            ("_\\*" "\\*_" underline-bold)
332            ("\\*/" "/\\*" bold-italic)
333            ("_\\*/" "/\\*_" underline-bold-italic))))
334     `(,@(mapcar
335          (lambda (spec)
336            (list
337             (format format (car spec) (cadr spec))
338             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
339          types)
340         ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
341          2 3 gnus-emphasis-strikethru)
342         ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
343          2 3 gnus-emphasis-underline)))
344   "*Alist that says how to fontify certain phrases.
345 Each item looks like this:
346
347   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
348
349 The first element is a regular expression to be matched.  The second
350 is a number that says what regular expression grouping used to find
351 the entire emphasized word.  The third is a number that says what
352 regexp grouping should be displayed and highlighted.  The fourth
353 is the face used for highlighting."
354   :type '(repeat (list :value ("" 0 0 default)
355                        regexp
356                        (integer :tag "Match group")
357                        (integer :tag "Emphasize group")
358                        face))
359   :group 'gnus-article-emphasis)
360
361 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
362   "A regexp to describe whitespace which should not be emphasized.
363 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
364 The former avoids underlining of leading and trailing whitespace,
365 and the latter avoids underlining any whitespace at all."
366   :version "21.1"
367   :group 'gnus-article-emphasis
368   :type 'regexp)
369
370 (defface gnus-emphasis-bold '((t (:bold t)))
371   "Face used for displaying strong emphasized text (*word*)."
372   :group 'gnus-article-emphasis)
373
374 (defface gnus-emphasis-italic '((t (:italic t)))
375   "Face used for displaying italic emphasized text (/word/)."
376   :group 'gnus-article-emphasis)
377
378 (defface gnus-emphasis-underline '((t (:underline t)))
379   "Face used for displaying underlined emphasized text (_word_)."
380   :group 'gnus-article-emphasis)
381
382 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
383   "Face used for displaying underlined bold emphasized text (_*word*_)."
384   :group 'gnus-article-emphasis)
385
386 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
387   "Face used for displaying underlined italic emphasized text (_/word/_)."
388   :group 'gnus-article-emphasis)
389
390 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
391   "Face used for displaying bold italic emphasized text (/*word*/)."
392   :group 'gnus-article-emphasis)
393
394 (defface gnus-emphasis-underline-bold-italic
395   '((t (:bold t :italic t :underline t)))
396   "Face used for displaying underlined bold italic emphasized text.
397 Example: (_/*word*/_)."
398   :group 'gnus-article-emphasis)
399
400 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
401                                       '((t (:strikethru t)))
402                                     '((t (:strike-through t))))
403   "Face used for displaying strike-through text (-word-)."
404   :group 'gnus-article-emphasis)
405
406 (defface gnus-emphasis-highlight-words
407   '((t (:background "black" :foreground "yellow")))
408   "Face used for displaying highlighted words."
409   :group 'gnus-article-emphasis)
410
411 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
412   "Format for display of Date headers in article bodies.
413 See `format-time-string' for the possible values.
414
415 The variable can also be function, which should return a complete Date
416 header.  The function is called with one argument, the time, which can
417 be fed to `format-time-string'."
418   :type '(choice string symbol)
419   :link '(custom-manual "(gnus)Article Date")
420   :group 'gnus-article-washing)
421
422 (eval-and-compile
423   (autoload 'mail-extract-address-components "mail-extr"))
424
425 (defcustom gnus-save-all-headers t
426   "*If non-nil, don't remove any headers before saving."
427   :group 'gnus-article-saving
428   :type 'boolean)
429
430 (defcustom gnus-prompt-before-saving 'always
431   "*This variable says how much prompting is to be done when saving articles.
432 If it is nil, no prompting will be done, and the articles will be
433 saved to the default files.  If this variable is `always', each and
434 every article that is saved will be preceded by a prompt, even when
435 saving large batches of articles.  If this variable is neither nil not
436 `always', there the user will be prompted once for a file name for
437 each invocation of the saving commands."
438   :group 'gnus-article-saving
439   :type '(choice (item always)
440                  (item :tag "never" nil)
441                  (sexp :tag "once" :format "%t\n" :value t)))
442
443 (defcustom gnus-saved-headers gnus-visible-headers
444   "Headers to keep if `gnus-save-all-headers' is nil.
445 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
446 If that variable is nil, however, all headers that match this regexp
447 will be kept while the rest will be deleted before saving."
448   :group 'gnus-article-saving
449   :type 'regexp)
450
451 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
452   "A function to save articles in your favourite format.
453 The function must be interactively callable (in other words, it must
454 be an Emacs command).
455
456 Gnus provides the following functions:
457
458 * gnus-summary-save-in-rmail (Rmail format)
459 * gnus-summary-save-in-mail (Unix mail format)
460 * gnus-summary-save-in-folder (MH folder)
461 * gnus-summary-save-in-file (article format)
462 * gnus-summary-save-body-in-file (article body)
463 * gnus-summary-save-in-vm (use VM's folder format)
464 * gnus-summary-write-to-file (article format -- overwrite)."
465   :group 'gnus-article-saving
466   :type '(radio (function-item gnus-summary-save-in-rmail)
467                 (function-item gnus-summary-save-in-mail)
468                 (function-item gnus-summary-save-in-folder)
469                 (function-item gnus-summary-save-in-file)
470                 (function-item gnus-summary-save-body-in-file)
471                 (function-item gnus-summary-save-in-vm)
472                 (function-item gnus-summary-write-to-file)))
473
474 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
475   "A function generating a file name to save articles in Rmail format.
476 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
477   :group 'gnus-article-saving
478   :type 'function)
479
480 (defcustom gnus-mail-save-name 'gnus-plain-save-name
481   "A function generating a file name to save articles in Unix mail format.
482 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
483   :group 'gnus-article-saving
484   :type 'function)
485
486 (defcustom gnus-folder-save-name 'gnus-folder-save-name
487   "A function generating a file name to save articles in MH folder.
488 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
489   :group 'gnus-article-saving
490   :type 'function)
491
492 (defcustom gnus-file-save-name 'gnus-numeric-save-name
493   "A function generating a file name to save articles in article format.
494 The function is called with NEWSGROUP, HEADERS, and optional
495 LAST-FILE."
496   :group 'gnus-article-saving
497   :type 'function)
498
499 (defcustom gnus-split-methods
500   '((gnus-article-archive-name)
501     (gnus-article-nndoc-name))
502   "*Variable used to suggest where articles are to be saved.
503 For instance, if you would like to save articles related to Gnus in
504 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
505 you could set this variable to something like:
506
507  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
508    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
509
510 This variable is an alist where the where the key is the match and the
511 value is a list of possible files to save in if the match is non-nil.
512
513 If the match is a string, it is used as a regexp match on the
514 article.  If the match is a symbol, that symbol will be funcalled
515 from the buffer of the article to be saved with the newsgroup as the
516 parameter.  If it is a list, it will be evaled in the same buffer.
517
518 If this form or function returns a string, this string will be used as
519 a possible file name; and if it returns a non-nil list, that list will
520 be used as possible file names."
521   :group 'gnus-article-saving
522   :type '(repeat (choice (list :value (fun) function)
523                          (cons :value ("" "") regexp (repeat string))
524                          (sexp :value nil))))
525
526 (defcustom gnus-page-delimiter "^\^L"
527   "*Regexp describing what to use as article page delimiters.
528 The default value is \"^\^L\", which is a form linefeed at the
529 beginning of a line."
530   :type 'regexp
531   :group 'gnus-article-various)
532
533 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
534   "*The format specification for the article mode line.
535 See `gnus-summary-mode-line-format' for a closer description.
536
537 The following additional specs are available:
538
539 %w  The article washing status.
540 %m  The number of MIME parts in the article."
541   :type 'string
542   :group 'gnus-article-various)
543
544 (defcustom gnus-article-mode-hook nil
545   "*A hook for Gnus article mode."
546   :type 'hook
547   :group 'gnus-article-various)
548
549 (when (featurep 'xemacs)
550   ;; Extracted from gnus-xmas-define in order to preserve user settings
551   (when (fboundp 'turn-off-scroll-in-place)
552     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
553   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
554   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
555
556 (defcustom gnus-article-menu-hook nil
557   "*Hook run after the creation of the article mode menu."
558   :type 'hook
559   :group 'gnus-article-various)
560
561 (defcustom gnus-article-prepare-hook nil
562   "*A hook called after an article has been prepared in the article buffer."
563   :type 'hook
564   :group 'gnus-article-various)
565
566 (make-obsolete-variable 'gnus-article-hide-pgp-hook
567                         "This variable is obsolete in Gnus 5.10.")
568
569 (defcustom gnus-article-button-face 'bold
570   "Face used for highlighting buttons in the article buffer.
571
572 An article button is a piece of text that you can activate by pressing
573 `RET' or `mouse-2' above it."
574   :type 'face
575   :group 'gnus-article-buttons)
576
577 (defcustom gnus-article-mouse-face 'highlight
578   "Face used for mouse highlighting in the article buffer.
579
580 Article buttons will be displayed in this face when the cursor is
581 above them."
582   :type 'face
583   :group 'gnus-article-buttons)
584
585 (defcustom gnus-signature-face 'gnus-signature-face
586   "Face used for highlighting a signature in the article buffer.
587 Obsolete; use the face `gnus-signature-face' for customizations instead."
588   :type 'face
589   :group 'gnus-article-highlight
590   :group 'gnus-article-signature)
591
592 (defface gnus-signature-face
593   '((t
594      (:italic t)))
595   "Face used for highlighting a signature in the article buffer."
596   :group 'gnus-article-highlight
597   :group 'gnus-article-signature)
598
599 (defface gnus-header-from-face
600   '((((class color)
601       (background dark))
602      (:foreground "spring green"))
603     (((class color)
604       (background light))
605      (:foreground "red3"))
606     (t
607      (:italic t)))
608   "Face used for displaying from headers."
609   :group 'gnus-article-headers
610   :group 'gnus-article-highlight)
611
612 (defface gnus-header-subject-face
613   '((((class color)
614       (background dark))
615      (:foreground "SeaGreen3"))
616     (((class color)
617       (background light))
618      (:foreground "red4"))
619     (t
620      (:bold t :italic t)))
621   "Face used for displaying subject headers."
622   :group 'gnus-article-headers
623   :group 'gnus-article-highlight)
624
625 (defface gnus-header-newsgroups-face
626   '((((class color)
627       (background dark))
628      (:foreground "yellow" :italic t))
629     (((class color)
630       (background light))
631      (:foreground "MidnightBlue" :italic t))
632     (t
633      (:italic t)))
634   "Face used for displaying newsgroups headers.
635 In the default setup this face is only used for crossposted
636 articles."
637   :group 'gnus-article-headers
638   :group 'gnus-article-highlight)
639
640 (defface gnus-header-name-face
641   '((((class color)
642       (background dark))
643      (:foreground "SeaGreen"))
644     (((class color)
645       (background light))
646      (:foreground "maroon"))
647     (t
648      (:bold t)))
649   "Face used for displaying header names."
650   :group 'gnus-article-headers
651   :group 'gnus-article-highlight)
652
653 (defface gnus-header-content-face
654   '((((class color)
655       (background dark))
656      (:foreground "forest green" :italic t))
657     (((class color)
658       (background light))
659      (:foreground "indianred4" :italic t))
660     (t
661      (:italic t)))  "Face used for displaying header content."
662   :group 'gnus-article-headers
663   :group 'gnus-article-highlight)
664
665 (defcustom gnus-header-face-alist
666   '(("From" nil gnus-header-from-face)
667     ("Subject" nil gnus-header-subject-face)
668     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
669     ("" gnus-header-name-face gnus-header-content-face))
670   "*Controls highlighting of article headers.
671
672 An alist of the form (HEADER NAME CONTENT).
673
674 HEADER is a regular expression which should match the name of a
675 header and NAME and CONTENT are either face names or nil.
676
677 The name of each header field will be displayed using the face
678 specified by the first element in the list where HEADER matches
679 the header name and NAME is non-nil.  Similarly, the content will
680 be displayed by the first non-nil matching CONTENT face."
681   :group 'gnus-article-headers
682   :group 'gnus-article-highlight
683   :type '(repeat (list (regexp :tag "Header")
684                        (choice :tag "Name"
685                                (item :tag "skip" nil)
686                                (face :value default))
687                        (choice :tag "Content"
688                                (item :tag "skip" nil)
689                                (face :value default)))))
690
691 (defcustom gnus-article-decode-hook
692   '(article-decode-charset article-decode-encoded-words
693                            article-decode-group-name article-decode-idna-rhs)
694   "*Hook run to decode charsets in articles."
695   :group 'gnus-article-headers
696   :type 'hook)
697
698 (defcustom gnus-display-mime-function 'gnus-display-mime
699   "Function to display MIME articles."
700   :group 'gnus-article-mime
701   :type 'function)
702
703 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
704   "Function used to decode headers.")
705
706 (defvar gnus-article-dumbquotes-map
707   '(("\200" "EUR")
708     ("\202" ",")
709     ("\203" "f")
710     ("\204" ",,")
711     ("\205" "...")
712     ("\213" "<")
713     ("\214" "OE")
714     ("\221" "`")
715     ("\222" "'")
716     ("\223" "``")
717     ("\224" "\"")
718     ("\225" "*")
719     ("\226" "-")
720     ("\227" "--")
721     ("\230" "~")
722     ("\231" "(TM)")
723     ("\233" ">")
724     ("\234" "oe")
725     ("\264" "'"))
726   "Table for MS-to-Latin1 translation.")
727
728 (defcustom gnus-ignored-mime-types nil
729   "List of MIME types that should be ignored by Gnus."
730   :version "21.1"
731   :group 'gnus-article-mime
732   :type '(repeat regexp))
733
734 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
735   "List of MIME types that should not be given buttons when rendered inline.
736 See also `gnus-buttonized-mime-types' which may override this variable.
737 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
738   :version "21.1"
739   :group 'gnus-article-mime
740   :type '(repeat regexp))
741
742 (defcustom gnus-buttonized-mime-types nil
743   "List of MIME types that should be given buttons when rendered inline.
744 If set, this variable overrides `gnus-unbuttonized-mime-types'.
745 To see e.g. security buttons you could set this to
746 `(\"multipart/signed\")'.
747 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
748   :version "21.1"
749   :group 'gnus-article-mime
750   :type '(repeat regexp))
751
752 (defcustom gnus-inhibit-mime-unbuttonizing nil
753   "If non-nil, all MIME parts get buttons.
754 When nil (the default value), then some MIME parts do not get buttons,
755 as described by the variables `gnus-buttonized-mime-types' and
756 `gnus-unbuttonized-mime-types'."
757   :version "21.3"
758   :group 'gnus-article-mime
759   :type 'boolean)
760
761 (defcustom gnus-body-boundary-delimiter "_"
762   "String used to delimit header and body.
763 This variable is used by `gnus-article-treat-body-boundary' which can
764 be controlled by `gnus-treat-body-boundary'."
765   :group 'gnus-article-various
766   :type '(choice (item :tag "None" :value nil)
767                  string))
768
769 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces")
770   "Defines the location of the faces database.
771 For information on obtaining this database of pretty pictures, please
772 see http://www.cs.indiana.edu/picons/ftp/index.html"
773   :type '(repeat directory)
774   :link '(url-link :tag "download"
775                    "http://www.cs.indiana.edu/picons/ftp/index.html")
776   :link '(custom-manual "(gnus)Picons")
777   :group 'gnus-picon)
778
779 (defun gnus-picons-installed-p ()
780   "Say whether picons are installed on your machine."
781   (let ((installed nil))
782     (dolist (database gnus-picon-databases)
783       (when (file-exists-p database)
784         (setq installed t)))
785     installed))
786
787 (defcustom gnus-article-mime-part-function nil
788   "Function called with a MIME handle as the argument.
789 This is meant for people who want to do something automatic based
790 on parts -- for instance, adding Vcard info to a database."
791   :group 'gnus-article-mime
792   :type 'function)
793
794 (defcustom gnus-mime-multipart-functions nil
795   "An alist of MIME types to functions to display them."
796   :version "21.1"
797   :group 'gnus-article-mime
798   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
799
800 (defcustom gnus-article-date-lapsed-new-header nil
801   "Whether the X-Sent and Date headers can coexist.
802 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
803 either replace the old \"Date:\" header (if this variable is nil), or
804 be added below it (otherwise)."
805   :version "21.1"
806   :group 'gnus-article-headers
807   :type 'boolean)
808
809 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
810   "Function called with a MIME handle as the argument.
811 This is meant for people who want to view first matched part.
812 For `undisplayed-alternative' (default), the first undisplayed
813 part or alternative part is used.  For `undisplayed', the first
814 undisplayed part is used.  For a function, the first part which
815 the function return t is used.  For nil, the first part is
816 used."
817   :version "21.1"
818   :group 'gnus-article-mime
819   :type '(choice
820           (item :tag "first" :value nil)
821           (item :tag "undisplayed" :value undisplayed)
822           (item :tag "undisplayed or alternative"
823                 :value undisplayed-alternative)
824           (function)))
825
826 (defcustom gnus-mime-action-alist
827   '(("save to file" . gnus-mime-save-part)
828     ("save and strip" . gnus-mime-save-part-and-strip)
829     ("delete part" . gnus-mime-delete-part)
830     ("display as text" . gnus-mime-inline-part)
831     ("view the part" . gnus-mime-view-part)
832     ("pipe to command" . gnus-mime-pipe-part)
833     ("toggle display" . gnus-article-press-button)
834     ("toggle display" . gnus-article-view-part-as-charset)
835     ("view as type" . gnus-mime-view-part-as-type)
836     ("view internally" . gnus-mime-view-part-internally)
837     ("view externally" . gnus-mime-view-part-externally))
838   "An alist of actions that run on the MIME attachment."
839   :group 'gnus-article-mime
840   :type '(repeat (cons (string :tag "name")
841                        (function))))
842
843 ;;;
844 ;;; The treatment variables
845 ;;;
846
847 (defvar gnus-part-display-hook nil
848   "Hook called on parts that are to receive treatment.")
849
850 (defvar gnus-article-treat-custom
851   '(choice (const :tag "Off" nil)
852            (const :tag "On" t)
853            (const :tag "Header" head)
854            (const :tag "Last" last)
855            (integer :tag "Less")
856            (repeat :tag "Groups" regexp)
857            (sexp :tag "Predicate")))
858
859 (defvar gnus-article-treat-head-custom
860   '(choice (const :tag "Off" nil)
861            (const :tag "Header" head)))
862
863 (defvar gnus-article-treat-types '("text/plain")
864   "Parts to treat.")
865
866 (defvar gnus-inhibit-treatment nil
867   "Whether to inhibit treatment.")
868
869 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
870   "Highlight the signature.
871 Valid values are nil, t, `head', `last', an integer or a predicate.
872 See Info node `(gnus)Customizing Articles'."
873   :group 'gnus-article-treat
874   :link '(custom-manual "(gnus)Customizing Articles")
875   :type gnus-article-treat-custom)
876 (put 'gnus-treat-highlight-signature 'highlight t)
877
878 (defcustom gnus-treat-buttonize 100000
879   "Add buttons.
880 Valid values are nil, t, `head', `last', an integer or a predicate.
881 See Info node `(gnus)Customizing Articles'."
882   :group 'gnus-article-treat
883   :link '(custom-manual "(gnus)Customizing Articles")
884   :type gnus-article-treat-custom)
885 (put 'gnus-treat-buttonize 'highlight t)
886
887 (defcustom gnus-treat-buttonize-head 'head
888   "Add buttons to the head.
889 Valid values are nil, t, `head', `last', an integer or a predicate.
890 See Info node `(gnus)Customizing Articles' for details."
891   :group 'gnus-article-treat
892   :link '(custom-manual "(gnus)Customizing Articles")
893   :type gnus-article-treat-head-custom)
894 (put 'gnus-treat-buttonize-head 'highlight t)
895
896 (defcustom gnus-treat-emphasize
897   (and (or window-system
898            (featurep 'xemacs))
899        50000)
900   "Emphasize text.
901 Valid values are nil, t, `head', `last', an integer or a predicate.
902 See Info node `(gnus)Customizing Articles' for details."
903   :group 'gnus-article-treat
904   :link '(custom-manual "(gnus)Customizing Articles")
905   :type gnus-article-treat-custom)
906 (put 'gnus-treat-emphasize 'highlight t)
907
908 (defcustom gnus-treat-strip-cr nil
909   "Remove carriage returns.
910 Valid values are nil, t, `head', `last', an integer or a predicate.
911 See Info node `(gnus)Customizing Articles' for details."
912   :group 'gnus-article-treat
913   :link '(custom-manual "(gnus)Customizing Articles")
914   :type gnus-article-treat-custom)
915
916 (defcustom gnus-treat-unsplit-urls nil
917   "Remove newlines from within URLs.
918 Valid values are nil, t, `head', `last', an integer or a predicate.
919 See Info node `(gnus)Customizing Articles' for details."
920   :group 'gnus-article-treat
921   :link '(custom-manual "(gnus)Customizing Articles")
922   :type gnus-article-treat-custom)
923
924 (defcustom gnus-treat-leading-whitespace nil
925   "Remove leading whitespace in headers.
926 Valid values are nil, t, `head', `last', an integer or a predicate.
927 See Info node `(gnus)Customizing Articles' for details."
928   :group 'gnus-article-treat
929   :link '(custom-manual "(gnus)Customizing Articles")
930   :type gnus-article-treat-custom)
931
932 (defcustom gnus-treat-hide-headers 'head
933   "Hide headers.
934 Valid values are nil, t, `head', `last', an integer or a predicate.
935 See Info node `(gnus)Customizing Articles' for details."
936   :group 'gnus-article-treat
937   :link '(custom-manual "(gnus)Customizing Articles")
938   :type gnus-article-treat-head-custom)
939
940 (defcustom gnus-treat-hide-boring-headers nil
941   "Hide boring headers.
942 Valid values are nil, t, `head', `last', an integer or a predicate.
943 See Info node `(gnus)Customizing Articles' for details."
944   :group 'gnus-article-treat
945   :link '(custom-manual "(gnus)Customizing Articles")
946   :type gnus-article-treat-head-custom)
947
948 (defcustom gnus-treat-hide-signature nil
949   "Hide the signature.
950 Valid values are nil, t, `head', `last', an integer or a predicate.
951 See Info node `(gnus)Customizing Articles' for details."
952   :group 'gnus-article-treat
953   :link '(custom-manual "(gnus)Customizing Articles")
954   :type gnus-article-treat-custom)
955
956 (defcustom gnus-treat-fill-article nil
957   "Fill the article.
958 Valid values are nil, t, `head', `last', an integer or a predicate.
959 See Info node `(gnus)Customizing Articles' for details."
960   :group 'gnus-article-treat
961   :link '(custom-manual "(gnus)Customizing Articles")
962   :type gnus-article-treat-custom)
963
964 (defcustom gnus-treat-hide-citation nil
965   "Hide cited text.
966 Valid values are nil, t, `head', `last', an integer or a predicate.
967 See Info node `(gnus)Customizing Articles' for details."
968   :group 'gnus-article-treat
969   :link '(custom-manual "(gnus)Customizing Articles")
970   :type gnus-article-treat-custom)
971
972 (defcustom gnus-treat-hide-citation-maybe nil
973   "Hide cited text.
974 Valid values are nil, t, `head', `last', an integer or a predicate.
975 See Info node `(gnus)Customizing Articles' for details."
976   :group 'gnus-article-treat
977   :link '(custom-manual "(gnus)Customizing Articles")
978   :type gnus-article-treat-custom)
979
980 (defcustom gnus-treat-strip-list-identifiers 'head
981   "Strip list identifiers from `gnus-list-identifiers`.
982 Valid values are nil, t, `head', `last', an integer or a predicate.
983 See Info node `(gnus)Customizing Articles' for details."
984   :version "21.1"
985   :group 'gnus-article-treat
986   :link '(custom-manual "(gnus)Customizing Articles")
987   :type gnus-article-treat-custom)
988
989 (make-obsolete-variable 'gnus-treat-strip-pgp
990                         "This option is obsolete in Gnus 5.10.")
991
992 (defcustom gnus-treat-strip-pem nil
993   "Strip PEM signatures.
994 Valid values are nil, t, `head', `last', an integer or a predicate.
995 See Info node `(gnus)Customizing Articles' for details."
996   :group 'gnus-article-treat
997   :link '(custom-manual "(gnus)Customizing Articles")
998   :type gnus-article-treat-custom)
999
1000 (defcustom gnus-treat-strip-banner t
1001   "Strip banners from articles.
1002 The banner to be stripped is specified in the `banner' group parameter.
1003 Valid values are nil, t, `head', `last', an integer or a predicate.
1004 See Info node `(gnus)Customizing Articles' for details."
1005   :group 'gnus-article-treat
1006   :link '(custom-manual "(gnus)Customizing Articles")
1007   :type gnus-article-treat-custom)
1008
1009 (defcustom gnus-treat-highlight-headers 'head
1010   "Highlight the headers.
1011 Valid values are nil, t, `head', `last', an integer or a predicate.
1012 See Info node `(gnus)Customizing Articles' for details."
1013   :group 'gnus-article-treat
1014   :link '(custom-manual "(gnus)Customizing Articles")
1015   :type gnus-article-treat-head-custom)
1016 (put 'gnus-treat-highlight-headers 'highlight t)
1017
1018 (defcustom gnus-treat-highlight-citation t
1019   "Highlight cited text.
1020 Valid values are nil, t, `head', `last', an integer or a predicate.
1021 See Info node `(gnus)Customizing Articles' for details."
1022   :group 'gnus-article-treat
1023   :link '(custom-manual "(gnus)Customizing Articles")
1024   :type gnus-article-treat-custom)
1025 (put 'gnus-treat-highlight-citation 'highlight t)
1026
1027 (defcustom gnus-treat-date-ut nil
1028   "Display the Date in UT (GMT).
1029 Valid values are nil, t, `head', `last', an integer or a predicate.
1030 See Info node `(gnus)Customizing Articles' for details."
1031   :group 'gnus-article-treat
1032   :link '(custom-manual "(gnus)Customizing Articles")
1033   :type gnus-article-treat-head-custom)
1034
1035 (defcustom gnus-treat-date-local nil
1036   "Display the Date in the local timezone.
1037 Valid values are nil, t, `head', `last', an integer or a predicate.
1038 See Info node `(gnus)Customizing Articles' for details."
1039   :group 'gnus-article-treat
1040   :link '(custom-manual "(gnus)Customizing Articles")
1041   :type gnus-article-treat-head-custom)
1042
1043 (defcustom gnus-treat-date-english nil
1044   "Display the Date in a format that can be read aloud in English.
1045 Valid values are nil, t, `head', `last', an integer or a predicate.
1046 See Info node `(gnus)Customizing Articles' for details."
1047   :group 'gnus-article-treat
1048   :link '(custom-manual "(gnus)Customizing Articles")
1049   :type gnus-article-treat-head-custom)
1050
1051 (defcustom gnus-treat-date-lapsed nil
1052   "Display the Date header in a way that says how much time has elapsed.
1053 Valid values are nil, t, `head', `last', an integer or a predicate.
1054 See Info node `(gnus)Customizing Articles' for details."
1055   :group 'gnus-article-treat
1056   :link '(custom-manual "(gnus)Customizing Articles")
1057   :type gnus-article-treat-head-custom)
1058
1059 (defcustom gnus-treat-date-original nil
1060   "Display the date in the original timezone.
1061 Valid values are nil, t, `head', `last', an integer or a predicate.
1062 See Info node `(gnus)Customizing Articles' for details."
1063   :group 'gnus-article-treat
1064   :link '(custom-manual "(gnus)Customizing Articles")
1065   :type gnus-article-treat-head-custom)
1066
1067 (defcustom gnus-treat-date-iso8601 nil
1068   "Display the date in the ISO8601 format.
1069 Valid values are nil, t, `head', `last', an integer or a predicate.
1070 See Info node `(gnus)Customizing Articles' for details."
1071   :version "21.1"
1072   :group 'gnus-article-treat
1073   :link '(custom-manual "(gnus)Customizing Articles")
1074   :type gnus-article-treat-head-custom)
1075
1076 (defcustom gnus-treat-date-user-defined nil
1077   "Display the date in a user-defined format.
1078 The format is defined by the `gnus-article-time-format' variable.
1079 Valid values are nil, t, `head', `last', an integer or a predicate.
1080 See Info node `(gnus)Customizing Articles' for details."
1081   :group 'gnus-article-treat
1082   :link '(custom-manual "(gnus)Customizing Articles")
1083   :type gnus-article-treat-head-custom)
1084
1085 (defcustom gnus-treat-strip-headers-in-body t
1086   "Strip the X-No-Archive header line from the beginning of the body.
1087 Valid values are nil, t, `head', `last', an integer or a predicate.
1088 See Info node `(gnus)Customizing Articles' for details."
1089   :version "21.1"
1090   :group 'gnus-article-treat
1091   :link '(custom-manual "(gnus)Customizing Articles")
1092   :type gnus-article-treat-custom)
1093
1094 (defcustom gnus-treat-strip-trailing-blank-lines nil
1095   "Strip trailing blank lines.
1096 Valid values are nil, t, `head', `last', an integer or a predicate.
1097 See Info node `(gnus)Customizing Articles' for details."
1098   :group 'gnus-article-treat
1099   :link '(custom-manual "(gnus)Customizing Articles")
1100   :type gnus-article-treat-custom)
1101
1102 (defcustom gnus-treat-strip-leading-blank-lines nil
1103   "Strip leading blank lines.
1104 Valid values are nil, t, `head', `last', an integer or a predicate.
1105 See Info node `(gnus)Customizing Articles' for details."
1106   :group 'gnus-article-treat
1107   :link '(custom-manual "(gnus)Customizing Articles")
1108   :type gnus-article-treat-custom)
1109
1110 (defcustom gnus-treat-strip-multiple-blank-lines nil
1111   "Strip multiple blank lines.
1112 Valid values are nil, t, `head', `last', an integer or a predicate.
1113 See Info node `(gnus)Customizing Articles' for details."
1114   :group 'gnus-article-treat
1115   :link '(custom-manual "(gnus)Customizing Articles")
1116   :type gnus-article-treat-custom)
1117
1118 (defcustom gnus-treat-unfold-headers 'head
1119   "Unfold folded header lines.
1120 Valid values are nil, t, `head', `last', an integer or a predicate.
1121 See Info node `(gnus)Customizing Articles' for details."
1122   :group 'gnus-article-treat
1123   :link '(custom-manual "(gnus)Customizing Articles")
1124   :type gnus-article-treat-custom)
1125
1126 (defcustom gnus-treat-fold-headers nil
1127   "Fold headers.
1128 Valid values are nil, t, `head', `last', an integer or a predicate.
1129 See Info node `(gnus)Customizing Articles' for details."
1130   :group 'gnus-article-treat
1131   :link '(custom-manual "(gnus)Customizing Articles")
1132   :type gnus-article-treat-custom)
1133
1134 (defcustom gnus-treat-fold-newsgroups 'head
1135   "Fold the Newsgroups and Followup-To headers.
1136 Valid values are nil, t, `head', `last', an integer or a predicate.
1137 See Info node `(gnus)Customizing Articles' for details."
1138   :group 'gnus-article-treat
1139   :link '(custom-manual "(gnus)Customizing Articles")
1140   :type gnus-article-treat-custom)
1141
1142 (defcustom gnus-treat-overstrike t
1143   "Treat overstrike highlighting.
1144 Valid values are nil, t, `head', `last', an integer or a predicate.
1145 See Info node `(gnus)Customizing Articles' for details."
1146   :group 'gnus-article-treat
1147   :link '(custom-manual "(gnus)Customizing Articles")
1148   :type gnus-article-treat-custom)
1149 (put 'gnus-treat-overstrike 'highlight t)
1150
1151 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1152   "Treat ANSI SGR control sequences.
1153 Valid values are nil, t, `head', `last', an integer or a predicate.
1154 See Info node `(gnus)Customizing Articles' for details."
1155   :group 'gnus-article-treat
1156   :link '(custom-manual "(gnus)Customizing Articles")
1157   :type gnus-article-treat-custom)
1158
1159 (make-obsolete-variable 'gnus-treat-display-xface
1160                         'gnus-treat-display-x-face)
1161
1162 (defcustom gnus-treat-display-x-face
1163   (and (not noninteractive)
1164        (or (and (fboundp 'image-type-available-p)
1165                 (image-type-available-p 'xbm)
1166                 (string-match "^0x" (shell-command-to-string "uncompface"))
1167                 (executable-find "icontopbm"))
1168            (and (featurep 'xemacs)
1169                 (featurep 'xface)))
1170        'head)
1171   "Display X-Face headers.
1172 Valid values are nil, t, `head', `last', an integer or a predicate.
1173 See Info node `(gnus)Customizing Articles' and Info node
1174 `(gnus)X-Face' for details."
1175   :group 'gnus-article-treat
1176   :version "21.1"
1177   :link '(custom-manual "(gnus)Customizing Articles")
1178   :link '(custom-manual "(gnus)X-Face")
1179   :type gnus-article-treat-head-custom
1180   :set (lambda (symbol value)
1181          (set-default
1182           symbol
1183           (cond ((or (boundp symbol) (get symbol 'saved-value))
1184                  value)
1185                 ((boundp 'gnus-treat-display-xface)
1186                  (message "\
1187 ** gnus-treat-display-xface is an obsolete variable;\
1188  use gnus-treat-display-x-face instead")
1189                  (default-value 'gnus-treat-display-xface))
1190                 ((get 'gnus-treat-display-xface 'saved-value)
1191                  (message "\
1192 ** gnus-treat-display-xface is an obsolete variable;\
1193  use gnus-treat-display-x-face instead")
1194                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1195                 (t
1196                  value)))))
1197 (put 'gnus-treat-display-x-face 'highlight t)
1198
1199 (defcustom gnus-treat-display-face
1200   (and (not noninteractive)
1201        (or (and (fboundp 'image-type-available-p)
1202                 (image-type-available-p 'png))
1203            (and (featurep 'xemacs)
1204                 (featurep 'png)))
1205        'head)
1206   "Display Face headers.
1207 Valid values are nil, t, `head', `last', an integer or a predicate.
1208 See Info node `(gnus)Customizing Articles' and Info node
1209 `(gnus)X-Face' for details."
1210   :group 'gnus-article-treat
1211   :version "21.1"
1212   :link '(custom-manual "(gnus)Customizing Articles")
1213   :link '(custom-manual "(gnus)X-Face")
1214   :type gnus-article-treat-head-custom)
1215 (put 'gnus-treat-display-face 'highlight t)
1216
1217 (defcustom gnus-treat-display-smileys
1218   (if (or (and (featurep 'xemacs)
1219                (featurep 'xpm))
1220           (and (fboundp 'image-type-available-p)
1221                (image-type-available-p 'pbm)))
1222       t nil)
1223   "Display smileys.
1224 Valid values are nil, t, `head', `last', an integer or a predicate.
1225 See Info node `(gnus)Customizing Articles' and Info node
1226 `(gnus)Smileys' for details."
1227   :group 'gnus-article-treat
1228   :version "21.1"
1229   :link '(custom-manual "(gnus)Customizing Articles")
1230   :link '(custom-manual "(gnus)Smileys")
1231   :type gnus-article-treat-custom)
1232 (put 'gnus-treat-display-smileys 'highlight t)
1233
1234 (defcustom gnus-treat-from-picon
1235   (if (and (gnus-image-type-available-p 'xpm)
1236            (gnus-picons-installed-p))
1237       'head nil)
1238   "Display picons in the From header.
1239 Valid values are nil, t, `head', `last', an integer or a predicate.
1240 See Info node `(gnus)Customizing Articles' and Info node
1241 `(gnus)Picons' for details."
1242   :group 'gnus-article-treat
1243   :group 'gnus-picon
1244   :link '(custom-manual "(gnus)Customizing Articles")
1245   :link '(custom-manual "(gnus)Picons")
1246   :type gnus-article-treat-head-custom)
1247 (put 'gnus-treat-from-picon 'highlight t)
1248
1249 (defcustom gnus-treat-mail-picon
1250   (if (and (gnus-image-type-available-p 'xpm)
1251            (gnus-picons-installed-p))
1252       'head nil)
1253   "Display picons in To and Cc headers.
1254 Valid values are nil, t, `head', `last', an integer or a predicate.
1255 See Info node `(gnus)Customizing Articles' and Info node
1256 `(gnus)Picons' for details."
1257   :group 'gnus-article-treat
1258   :group 'gnus-picon
1259   :link '(custom-manual "(gnus)Customizing Articles")
1260   :link '(custom-manual "(gnus)Picons")
1261   :type gnus-article-treat-head-custom)
1262 (put 'gnus-treat-mail-picon 'highlight t)
1263
1264 (defcustom gnus-treat-newsgroups-picon
1265   (if (and (gnus-image-type-available-p 'xpm)
1266            (gnus-picons-installed-p))
1267       'head nil)
1268   "Display picons in the Newsgroups and Followup-To headers.
1269 Valid values are nil, t, `head', `last', an integer or a predicate.
1270 See Info node `(gnus)Customizing Articles' and Info node
1271 `(gnus)Picons' for details."
1272   :group 'gnus-article-treat
1273   :group 'gnus-picon
1274   :link '(custom-manual "(gnus)Customizing Articles")
1275   :link '(custom-manual "(gnus)Picons")
1276   :type gnus-article-treat-head-custom)
1277 (put 'gnus-treat-newsgroups-picon 'highlight t)
1278
1279 (defcustom gnus-treat-body-boundary
1280   (if (or gnus-treat-newsgroups-picon
1281           gnus-treat-mail-picon
1282           gnus-treat-from-picon)
1283       'head nil)
1284   "Draw a boundary at the end of the headers.
1285 Valid values are nil and `head'.
1286 See Info node `(gnus)Customizing Articles' for details."
1287   :version "21.1"
1288   :group 'gnus-article-treat
1289   :link '(custom-manual "(gnus)Customizing Articles")
1290   :type gnus-article-treat-head-custom)
1291
1292 (defcustom gnus-treat-capitalize-sentences nil
1293   "Capitalize sentence-starting words.
1294 Valid values are nil, t, `head', `last', an integer or a predicate.
1295 See Info node `(gnus)Customizing Articles' for details."
1296   :version "21.1"
1297   :group 'gnus-article-treat
1298   :link '(custom-manual "(gnus)Customizing Articles")
1299   :type gnus-article-treat-custom)
1300
1301 (defcustom gnus-treat-wash-html nil
1302   "Format as HTML.
1303 Valid values are nil, t, `head', `last', an integer or a predicate.
1304 See Info node `(gnus)Customizing Articles' for details."
1305   :group 'gnus-article-treat
1306   :link '(custom-manual "(gnus)Customizing Articles")
1307   :type gnus-article-treat-custom)
1308
1309 (defcustom gnus-treat-fill-long-lines nil
1310   "Fill long lines.
1311 Valid values are nil, t, `head', `last', an integer or a predicate.
1312 See Info node `(gnus)Customizing Articles' for details."
1313   :group 'gnus-article-treat
1314   :link '(custom-manual "(gnus)Customizing Articles")
1315   :type gnus-article-treat-custom)
1316
1317 (defcustom gnus-treat-play-sounds nil
1318   "Play sounds.
1319 Valid values are nil, t, `head', `last', an integer or a predicate.
1320 See Info node `(gnus)Customizing Articles' for details."
1321   :version "21.1"
1322   :group 'gnus-article-treat
1323   :link '(custom-manual "(gnus)Customizing Articles")
1324   :type gnus-article-treat-custom)
1325
1326 (defcustom gnus-treat-translate nil
1327   "Translate articles from one language to another.
1328 Valid values are nil, t, `head', `last', an integer or a predicate.
1329 See Info node `(gnus)Customizing Articles' for details."
1330   :version "21.1"
1331   :group 'gnus-article-treat
1332   :link '(custom-manual "(gnus)Customizing Articles")
1333   :type gnus-article-treat-custom)
1334
1335 (defcustom gnus-treat-x-pgp-sig nil
1336   "Verify X-PGP-Sig.
1337 To automatically treat X-PGP-Sig, set it to head.
1338 Valid values are nil, t, `head', `last', an integer or a predicate.
1339 See Info node `(gnus)Customizing Articles' for details."
1340   :group 'gnus-article-treat
1341   :group 'mime-security
1342   :link '(custom-manual "(gnus)Customizing Articles")
1343   :type gnus-article-treat-custom)
1344
1345 (defvar gnus-article-encrypt-protocol-alist
1346   '(("PGP" . mml2015-self-encrypt)))
1347
1348 ;; Set to nil if more than one protocol added to
1349 ;; gnus-article-encrypt-protocol-alist.
1350 (defcustom gnus-article-encrypt-protocol "PGP"
1351   "The protocol used for encrypt articles.
1352 It is a string, such as \"PGP\". If nil, ask user."
1353   :type 'string
1354   :group 'mime-security)
1355
1356 (defvar gnus-article-wash-function nil
1357   "Function used for converting HTML into text.")
1358
1359 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1360                               (mm-coding-system-p 'utf-8)
1361                               (executable-find idna-program))
1362   "Whether IDNA decoding of headers is used when viewing messages.
1363 This requires GNU Libidn, and by default only enabled if it is found."
1364   :group 'gnus-article-headers
1365   :type 'boolean)
1366
1367 (defcustom gnus-article-over-scroll nil
1368   "If non-nil, allow scrolling the article buffer even when there no more text."
1369   :group 'gnus-article
1370   :type 'boolean)
1371
1372 ;;; Internal variables
1373
1374 (defvar gnus-english-month-names
1375   '("January" "February" "March" "April" "May" "June" "July" "August"
1376     "September" "October" "November" "December"))
1377
1378 (defvar gnus-button-regexp nil)
1379 (defvar gnus-button-marker-list nil)
1380 ;; Regexp matching any of the regexps from `gnus-button-alist'.
1381
1382 (defvar gnus-button-last nil)
1383 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
1384
1385 (defvar article-goto-body-goes-to-point-min-p nil)
1386 (defvar gnus-article-wash-types nil)
1387 (defvar gnus-article-emphasis-alist nil)
1388 (defvar gnus-article-image-alist nil)
1389
1390 (defvar gnus-article-mime-handle-alist-1 nil)
1391 (defvar gnus-treatment-function-alist
1392   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1393     (gnus-treat-strip-banner gnus-article-strip-banner)
1394     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1395     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1396     (gnus-treat-buttonize gnus-article-add-buttons)
1397     (gnus-treat-fill-article gnus-article-fill-cited-article)
1398     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1399     (gnus-treat-strip-cr gnus-article-remove-cr)
1400     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1401     (gnus-treat-date-ut gnus-article-date-ut)
1402     (gnus-treat-date-local gnus-article-date-local)
1403     (gnus-treat-date-english gnus-article-date-english)
1404     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1405     (gnus-treat-date-original gnus-article-date-original)
1406     (gnus-treat-date-user-defined gnus-article-date-user)
1407     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1408     (gnus-treat-display-x-face gnus-article-display-x-face)
1409     (gnus-treat-display-face gnus-article-display-face)
1410     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1411     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1412     (gnus-treat-hide-signature gnus-article-hide-signature)
1413     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1414     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1415     (gnus-treat-strip-pem gnus-article-hide-pem)
1416     (gnus-treat-from-picon gnus-treat-from-picon)
1417     (gnus-treat-mail-picon gnus-treat-mail-picon)
1418     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1419     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1420     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1421     (gnus-treat-strip-trailing-blank-lines
1422      gnus-article-remove-trailing-blank-lines)
1423     (gnus-treat-strip-leading-blank-lines
1424      gnus-article-strip-leading-blank-lines)
1425     (gnus-treat-strip-multiple-blank-lines
1426      gnus-article-strip-multiple-blank-lines)
1427     (gnus-treat-overstrike gnus-article-treat-overstrike)
1428     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1429     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1430     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1431     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1432     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1433     (gnus-treat-display-smileys gnus-treat-smiley)
1434     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1435     (gnus-treat-wash-html gnus-article-wash-html)
1436     (gnus-treat-emphasize gnus-article-emphasize)
1437     (gnus-treat-hide-citation gnus-article-hide-citation)
1438     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1439     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1440     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1441     (gnus-treat-play-sounds gnus-earcon-display)))
1442
1443 (defvar gnus-article-mime-handle-alist nil)
1444 (defvar article-lapsed-timer nil)
1445 (defvar gnus-article-current-summary nil)
1446
1447 (defvar gnus-article-mode-syntax-table
1448   (let ((table (copy-syntax-table text-mode-syntax-table)))
1449     ;; This causes the citation match run O(2^n).
1450     ;; (modify-syntax-entry ?- "w" table)
1451     (modify-syntax-entry ?> ")<" table)
1452     (modify-syntax-entry ?< "(>" table)
1453     ;; make M-. in article buffers work for `foo' strings
1454     (modify-syntax-entry ?' " " table)
1455     (modify-syntax-entry ?` " " table)
1456     table)
1457   "Syntax table used in article mode buffers.
1458 Initialized from `text-mode-syntax-table.")
1459
1460 (defvar gnus-save-article-buffer nil)
1461
1462 (defvar gnus-article-mode-line-format-alist
1463   (nconc '((?w (gnus-article-wash-status) ?s)
1464            (?m (gnus-article-mime-part-status) ?s))
1465          gnus-summary-mode-line-format-alist))
1466
1467 (defvar gnus-number-of-articles-to-be-saved nil)
1468
1469 (defvar gnus-inhibit-hiding nil)
1470
1471 (defvar gnus-article-edit-mode nil)
1472
1473 ;;; Macros for dealing with the article buffer.
1474
1475 (defmacro gnus-with-article-headers (&rest forms)
1476   `(save-excursion
1477      (set-buffer gnus-article-buffer)
1478      (save-restriction
1479        (let ((buffer-read-only nil)
1480              (inhibit-point-motion-hooks t)
1481              (case-fold-search t))
1482          (article-narrow-to-head)
1483          ,@forms))))
1484
1485 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1486 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1487
1488 (defmacro gnus-with-article-buffer (&rest forms)
1489   `(save-excursion
1490      (set-buffer gnus-article-buffer)
1491      (let ((buffer-read-only nil))
1492        ,@forms)))
1493
1494 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1495 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1496
1497 (defun gnus-article-goto-header (header)
1498   "Go to HEADER, which is a regular expression."
1499   (re-search-forward (concat "^\\(" header "\\):") nil t))
1500
1501 (defsubst gnus-article-hide-text (b e props)
1502   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1503   (gnus-add-text-properties-when 'article-type nil b e props)
1504   (when (memq 'intangible props)
1505     (put-text-property
1506      (max (1- b) (point-min))
1507      b 'intangible (cddr (memq 'intangible props)))))
1508
1509 (defsubst gnus-article-unhide-text (b e)
1510   "Remove hidden text properties from region between B and E."
1511   (remove-text-properties b e gnus-hidden-properties)
1512   (when (memq 'intangible gnus-hidden-properties)
1513     (put-text-property (max (1- b) (point-min))
1514                        b 'intangible nil)))
1515
1516 (defun gnus-article-hide-text-type (b e type)
1517   "Hide text of TYPE between B and E."
1518   (gnus-add-wash-type type)
1519   (gnus-article-hide-text
1520    b e (cons 'article-type (cons type gnus-hidden-properties))))
1521
1522 (defun gnus-article-unhide-text-type (b e type)
1523   "Unhide text of TYPE between B and E."
1524   (gnus-delete-wash-type type)
1525   (remove-text-properties
1526    b e (cons 'article-type (cons type gnus-hidden-properties)))
1527   (when (memq 'intangible gnus-hidden-properties)
1528     (put-text-property (max (1- b) (point-min))
1529                        b 'intangible nil)))
1530
1531 (defun gnus-article-hide-text-of-type (type)
1532   "Hide text of TYPE in the current buffer."
1533   (save-excursion
1534     (let ((b (point-min))
1535           (e (point-max)))
1536       (while (setq b (text-property-any b e 'article-type type))
1537         (add-text-properties b (incf b) gnus-hidden-properties)))))
1538
1539 (defun gnus-article-delete-text-of-type (type)
1540   "Delete text of TYPE in the current buffer."
1541   (save-excursion
1542     (let ((b (point-min)))
1543       (while (setq b (text-property-any b (point-max) 'article-type type))
1544         (delete-region
1545          b (or (text-property-not-all b (point-max) 'article-type type)
1546                (point-max)))))))
1547
1548 (defun gnus-article-delete-invisible-text ()
1549   "Delete all invisible text in the current buffer."
1550   (save-excursion
1551     (let ((b (point-min)))
1552       (while (setq b (text-property-any b (point-max) 'invisible t))
1553         (delete-region
1554          b (or (text-property-not-all b (point-max) 'invisible t)
1555                (point-max)))))))
1556
1557 (defun gnus-article-text-type-exists-p (type)
1558   "Say whether any text of type TYPE exists in the buffer."
1559   (text-property-any (point-min) (point-max) 'article-type type))
1560
1561 (defsubst gnus-article-header-rank ()
1562   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1563   (let ((list gnus-sorted-header-list)
1564         (i 1))
1565     (while list
1566       (if (looking-at (car list))
1567           (setq list nil)
1568         (setq list (cdr list))
1569         (incf i)))
1570       i))
1571
1572 (defun article-hide-headers (&optional arg delete)
1573   "Hide unwanted headers and possibly sort them as well."
1574   (interactive)
1575   ;; This function might be inhibited.
1576   (unless gnus-inhibit-hiding
1577     (save-excursion
1578       (save-restriction
1579         (let ((buffer-read-only nil)
1580               (case-fold-search t)
1581               (max (1+ (length gnus-sorted-header-list)))
1582               (ignored (when (not gnus-visible-headers)
1583                          (cond ((stringp gnus-ignored-headers)
1584                                 gnus-ignored-headers)
1585                                ((listp gnus-ignored-headers)
1586                                 (mapconcat 'identity gnus-ignored-headers
1587                                            "\\|")))))
1588               (visible
1589                (cond ((stringp gnus-visible-headers)
1590                       gnus-visible-headers)
1591                      ((and gnus-visible-headers
1592                            (listp gnus-visible-headers))
1593                       (mapconcat 'identity gnus-visible-headers "\\|"))))
1594               (inhibit-point-motion-hooks t)
1595               beg)
1596           ;; First we narrow to just the headers.
1597           (article-narrow-to-head)
1598           ;; Hide any "From " lines at the beginning of (mail) articles.
1599           (while (looking-at "From ")
1600             (forward-line 1))
1601           (unless (bobp)
1602             (delete-region (point-min) (point)))
1603           ;; Then treat the rest of the header lines.
1604           ;; Then we use the two regular expressions
1605           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1606           ;; select which header lines is to remain visible in the
1607           ;; article buffer.
1608           (while (re-search-forward "^[^ \t:]*:" nil t)
1609             (beginning-of-line)
1610             ;; Mark the rank of the header.
1611             (put-text-property
1612              (point) (1+ (point)) 'message-rank
1613              (if (or (and visible (looking-at visible))
1614                      (and ignored
1615                           (not (looking-at ignored))))
1616                  (gnus-article-header-rank)
1617                (+ 2 max)))
1618             (forward-line 1))
1619           (message-sort-headers-1)
1620           (when (setq beg (text-property-any
1621                            (point-min) (point-max) 'message-rank (+ 2 max)))
1622             ;; We delete the unwanted headers.
1623             (gnus-add-wash-type 'headers)
1624             (add-text-properties (point-min) (+ 5 (point-min))
1625                                  '(article-type headers dummy-invisible t))
1626             (delete-region beg (point-max))))))))
1627
1628 (defun article-hide-boring-headers (&optional arg)
1629   "Toggle hiding of headers that aren't very interesting.
1630 If given a negative prefix, always show; if given a positive prefix,
1631 always hide."
1632   (interactive (gnus-article-hidden-arg))
1633   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1634              (not gnus-show-all-headers))
1635     (save-excursion
1636       (save-restriction
1637         (let ((buffer-read-only nil)
1638               (list gnus-boring-article-headers)
1639               (inhibit-point-motion-hooks t)
1640               elem)
1641           (article-narrow-to-head)
1642           (while list
1643             (setq elem (pop list))
1644             (goto-char (point-min))
1645             (cond
1646              ;; Hide empty headers.
1647              ((eq elem 'empty)
1648               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1649                 (forward-line -1)
1650                 (gnus-article-hide-text-type
1651                  (point-at-bol)
1652                  (progn
1653                    (end-of-line)
1654                    (if (re-search-forward "^[^ \t]" nil t)
1655                        (match-beginning 0)
1656                      (point-max)))
1657                  'boring-headers)))
1658              ;; Hide boring Newsgroups header.
1659              ((eq elem 'newsgroups)
1660               (when (gnus-string-equal
1661                      (gnus-fetch-field "newsgroups")
1662                      (gnus-group-real-name
1663                       (if (boundp 'gnus-newsgroup-name)
1664                           gnus-newsgroup-name
1665                         "")))
1666                 (gnus-article-hide-header "newsgroups")))
1667              ((eq elem 'to-address)
1668               (let ((to (message-fetch-field "to"))
1669                     (to-address
1670                      (gnus-parameter-to-address
1671                       (if (boundp 'gnus-newsgroup-name)
1672                           gnus-newsgroup-name ""))))
1673                 (when (and to to-address
1674                            (ignore-errors
1675                              (gnus-string-equal
1676                               ;; only one address in To
1677                               (nth 1 (mail-extract-address-components to))
1678                               to-address)))
1679                   (gnus-article-hide-header "to"))))
1680              ((eq elem 'to-list)
1681               (let ((to (message-fetch-field "to"))
1682                     (to-list
1683                      (gnus-parameter-to-list
1684                       (if (boundp 'gnus-newsgroup-name)
1685                           gnus-newsgroup-name ""))))
1686                 (when (and to to-list
1687                            (ignore-errors
1688                              (gnus-string-equal
1689                               ;; only one address in To
1690                               (nth 1 (mail-extract-address-components to))
1691                               to-list)))
1692                   (gnus-article-hide-header "to"))))
1693              ((eq elem 'cc-list)
1694               (let ((cc (message-fetch-field "cc"))
1695                     (to-list
1696                      (gnus-parameter-to-list
1697                       (if (boundp 'gnus-newsgroup-name)
1698                           gnus-newsgroup-name ""))))
1699                 (when (and cc to-list
1700                            (ignore-errors
1701                              (gnus-string-equal
1702                               ;; only one address in CC
1703                               (nth 1 (mail-extract-address-components cc))
1704                               to-list)))
1705                   (gnus-article-hide-header "cc"))))
1706              ((eq elem 'followup-to)
1707               (when (gnus-string-equal
1708                      (message-fetch-field "followup-to")
1709                      (message-fetch-field "newsgroups"))
1710                 (gnus-article-hide-header "followup-to")))
1711              ((eq elem 'reply-to)
1712               (if (gnus-group-find-parameter
1713                    gnus-newsgroup-name 'broken-reply-to)
1714                   (gnus-article-hide-header "reply-to")
1715                 (let ((from (message-fetch-field "from"))
1716                       (reply-to (message-fetch-field "reply-to")))
1717                   (when
1718                       (and
1719                        from reply-to
1720                        (ignore-errors
1721                          (equal
1722                           (sort (mapcar
1723                                  (lambda (x) (downcase (cadr x)))
1724                                  (mail-extract-address-components from t))
1725                                 'string<)
1726                           (sort (mapcar
1727                                  (lambda (x) (downcase (cadr x)))
1728                                  (mail-extract-address-components reply-to t))
1729                                 'string<))))
1730                     (gnus-article-hide-header "reply-to")))))
1731              ((eq elem 'date)
1732               (let ((date (message-fetch-field "date")))
1733                 (when (and date
1734                            (< (days-between (current-time-string) date)
1735                               4))
1736                   (gnus-article-hide-header "date"))))
1737              ((eq elem 'long-to)
1738               (let ((to (message-fetch-field "to"))
1739                     (cc (message-fetch-field "cc")))
1740                 (when (> (length to) 1024)
1741                   (gnus-article-hide-header "to"))
1742                 (when (> (length cc) 1024)
1743                   (gnus-article-hide-header "cc"))))
1744              ((eq elem 'many-to)
1745               (let ((to-count 0)
1746                     (cc-count 0))
1747                 (goto-char (point-min))
1748                 (while (re-search-forward "^to:" nil t)
1749                   (setq to-count (1+ to-count)))
1750                 (when (> to-count 1)
1751                   (while (> to-count 0)
1752                     (goto-char (point-min))
1753                     (save-restriction
1754                       (re-search-forward "^to:" nil nil to-count)
1755                       (forward-line -1)
1756                       (narrow-to-region (point) (point-max))
1757                       (gnus-article-hide-header "to"))
1758                     (setq to-count (1- to-count))))
1759                 (goto-char (point-min))
1760                 (while (re-search-forward "^cc:" nil t)
1761                   (setq cc-count (1+ cc-count)))
1762                 (when (> cc-count 1)
1763                   (while (> cc-count 0)
1764                     (goto-char (point-min))
1765                     (save-restriction
1766                       (re-search-forward "^cc:" nil nil cc-count)
1767                       (forward-line -1)
1768                       (narrow-to-region (point) (point-max))
1769                       (gnus-article-hide-header "cc"))
1770                     (setq cc-count (1- cc-count)))))))))))))
1771
1772 (defun gnus-article-hide-header (header)
1773   (save-excursion
1774     (goto-char (point-min))
1775     (when (re-search-forward (concat "^" header ":") nil t)
1776       (gnus-article-hide-text-type
1777        (point-at-bol)
1778        (progn
1779          (end-of-line)
1780          (if (re-search-forward "^[^ \t]" nil t)
1781              (match-beginning 0)
1782            (point-max)))
1783        'boring-headers))))
1784
1785 (defvar gnus-article-normalized-header-length 40
1786   "Length of normalized headers.")
1787
1788 (defun article-normalize-headers ()
1789   "Make all header lines 40 characters long."
1790   (interactive)
1791   (let ((buffer-read-only nil)
1792         column)
1793     (save-excursion
1794       (save-restriction
1795         (article-narrow-to-head)
1796         (while (not (eobp))
1797           (cond
1798            ((< (setq column (- (point-at-eol) (point)))
1799                gnus-article-normalized-header-length)
1800             (end-of-line)
1801             (insert (make-string
1802                      (- gnus-article-normalized-header-length column)
1803                      ? )))
1804            ((> column gnus-article-normalized-header-length)
1805             (gnus-put-text-property
1806              (progn
1807                (forward-char gnus-article-normalized-header-length)
1808                (point))
1809              (point-at-eol)
1810              'invisible t))
1811            (t
1812             ;; Do nothing.
1813             ))
1814           (forward-line 1))))))
1815
1816 (defun article-treat-dumbquotes ()
1817   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
1818 Note that this function guesses whether a character is a sm*rtq**t* or
1819 not, so it should only be used interactively.
1820
1821 Sm*rtq**t*s are M****s***'s unilateral extension to the
1822 iso-8859-1 character map in an attempt to provide more quoting
1823 characters.  If you see something like \\222 or \\264 where
1824 you're expecting some kind of apostrophe or quotation mark, then
1825 try this wash."
1826   (interactive)
1827   (article-translate-strings gnus-article-dumbquotes-map))
1828
1829 (defun article-translate-characters (from to)
1830   "Translate all characters in the body of the article according to FROM and TO.
1831 FROM is a string of characters to translate from; to is a string of
1832 characters to translate to."
1833   (save-excursion
1834     (when (article-goto-body)
1835       (let ((buffer-read-only nil)
1836             (x (make-string 225 ?x))
1837             (i -1))
1838         (while (< (incf i) (length x))
1839           (aset x i i))
1840         (setq i 0)
1841         (while (< i (length from))
1842           (aset x (aref from i) (aref to i))
1843           (incf i))
1844         (translate-region (point) (point-max) x)))))
1845
1846 (defun article-translate-strings (map)
1847   "Translate all string in the body of the article according to MAP.
1848 MAP is an alist where the elements are on the form (\"from\" \"to\")."
1849   (save-excursion
1850     (when (article-goto-body)
1851       (let ((buffer-read-only nil)
1852             elem)
1853         (while (setq elem (pop map))
1854           (save-excursion
1855             (while (search-forward (car elem) nil t)
1856               (replace-match (cadr elem)))))))))
1857
1858 (defun article-treat-overstrike ()
1859   "Translate overstrikes into bold text."
1860   (interactive)
1861   (save-excursion
1862     (when (article-goto-body)
1863       (let ((buffer-read-only nil))
1864         (while (search-forward "\b" nil t)
1865           (let ((next (char-after))
1866                 (previous (char-after (- (point) 2))))
1867             ;; We do the boldification/underlining by hiding the
1868             ;; overstrikes and putting the proper text property
1869             ;; on the letters.
1870             (cond
1871              ((eq next previous)
1872               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1873               (put-text-property (point) (1+ (point)) 'face 'bold))
1874              ((eq next ?_)
1875               (gnus-article-hide-text-type
1876                (1- (point)) (1+ (point)) 'overstrike)
1877               (put-text-property
1878                (- (point) 2) (1- (point)) 'face 'underline))
1879              ((eq previous ?_)
1880               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
1881               (put-text-property
1882                (point) (1+ (point)) 'face 'underline)))))))))
1883
1884 (defun article-treat-ansi-sequences ()
1885   "Translate ANSI SGR control sequences into overlays or extents."
1886   (interactive)
1887   (save-excursion
1888     (when (article-goto-body)
1889       (let ((buffer-read-only nil))
1890         (ansi-color-apply-on-region (point) (point-max))))))
1891
1892 (defun gnus-article-treat-unfold-headers ()
1893   "Unfold folded message headers.
1894 Only the headers that fit into the current window width will be
1895 unfolded."
1896   (interactive)
1897   (gnus-with-article-headers
1898     (let (length)
1899       (while (not (eobp))
1900         (save-restriction
1901           (mail-header-narrow-to-field)
1902           (let ((header (buffer-string)))
1903             (with-temp-buffer
1904               (insert header)
1905               (goto-char (point-min))
1906               (while (re-search-forward "\n[\t ]" nil t)
1907                 (replace-match " " t t)))
1908             (setq length (- (point-max) (point-min) 1)))
1909           (when (< length (window-width))
1910             (while (re-search-forward "\n[\t ]" nil t)
1911               (replace-match " " t t)))
1912           (goto-char (point-max)))))))
1913
1914 (defun gnus-article-treat-fold-headers ()
1915   "Fold message headers."
1916   (interactive)
1917   (gnus-with-article-headers
1918     (while (not (eobp))
1919       (save-restriction
1920         (mail-header-narrow-to-field)
1921         (mail-header-fold-field)
1922         (goto-char (point-max))))))
1923
1924 (defun gnus-treat-smiley ()
1925   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
1926   (interactive)
1927   (gnus-with-article-buffer
1928     (if (memq 'smiley gnus-article-wash-types)
1929         (gnus-delete-images 'smiley)
1930       (article-goto-body)
1931       (let ((images (smiley-region (point) (point-max))))
1932         (when images
1933           (gnus-add-wash-type 'smiley)
1934           (dolist (image images)
1935             (gnus-add-image 'smiley image)))))))
1936
1937 (defun gnus-article-remove-images ()
1938   "Remove all images from the article buffer."
1939   (interactive)
1940   (gnus-with-article-buffer
1941     (dolist (elem gnus-article-image-alist)
1942       (gnus-delete-images (car elem)))))
1943
1944 (defun gnus-article-treat-fold-newsgroups ()
1945   "Unfold folded message headers.
1946 Only the headers that fit into the current window width will be
1947 unfolded."
1948   (interactive)
1949   (gnus-with-article-headers
1950     (while (gnus-article-goto-header "newsgroups\\|followup-to")
1951       (save-restriction
1952         (mail-header-narrow-to-field)
1953         (while (re-search-forward ", *" nil t)
1954           (replace-match ", " t t))
1955         (mail-header-fold-field)
1956         (goto-char (point-max))))))
1957
1958 (defun gnus-article-treat-body-boundary ()
1959   "Place a boundary line at the end of the headers."
1960   (interactive)
1961   (when (and gnus-body-boundary-delimiter
1962              (> (length gnus-body-boundary-delimiter) 0))
1963     (gnus-with-article-headers
1964       (goto-char (point-max))
1965       (let ((start (point)))
1966         (insert "X-Boundary: ")
1967         (gnus-add-text-properties start (point) '(invisible t intangible t))
1968         (insert (let (str)
1969                   (while (>= (1- (window-width)) (length str))
1970                     (setq str (concat str gnus-body-boundary-delimiter)))
1971                   (substring str 0 (1- (window-width))))
1972                 "\n")
1973         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
1974
1975 (defun article-fill-long-lines ()
1976   "Fill lines that are wider than the window width."
1977   (interactive)
1978   (save-excursion
1979     (let ((buffer-read-only nil)
1980           (width (window-width (get-buffer-window (current-buffer)))))
1981       (save-restriction
1982         (article-goto-body)
1983         (let ((adaptive-fill-mode nil)) ;Why?  -sm
1984           (while (not (eobp))
1985             (end-of-line)
1986             (when (>= (current-column) (min fill-column width))
1987               (narrow-to-region (min (1+ (point)) (point-max))
1988                                 (point-at-bol))
1989               (let ((goback (point-marker)))
1990                 (fill-paragraph nil)
1991                 (goto-char (marker-position goback)))
1992               (widen))
1993             (forward-line 1)))))))
1994
1995 (defun article-capitalize-sentences ()
1996   "Capitalize the first word in each sentence."
1997   (interactive)
1998   (save-excursion
1999     (let ((buffer-read-only nil)
2000           (paragraph-start "^[\n\^L]"))
2001       (article-goto-body)
2002       (while (not (eobp))
2003         (capitalize-word 1)
2004         (forward-sentence)))))
2005
2006 (defun article-remove-cr ()
2007   "Remove trailing CRs and then translate remaining CRs into LFs."
2008   (interactive)
2009   (save-excursion
2010     (let ((buffer-read-only nil))
2011       (goto-char (point-min))
2012       (while (re-search-forward "\r+$" nil t)
2013         (replace-match "" t t))
2014       (goto-char (point-min))
2015       (while (search-forward "\r" nil t)
2016         (replace-match "\n" t t)))))
2017
2018 (defun article-remove-trailing-blank-lines ()
2019   "Remove all trailing blank lines from the article."
2020   (interactive)
2021   (save-excursion
2022     (let ((buffer-read-only nil))
2023       (goto-char (point-max))
2024       (delete-region
2025        (point)
2026        (progn
2027          (while (and (not (bobp))
2028                      (looking-at "^[ \t]*$")
2029                      (not (gnus-annotation-in-region-p
2030                            (point) (point-at-eol))))
2031            (forward-line -1))
2032          (forward-line 1)
2033          (point))))))
2034
2035 (eval-when-compile
2036   (defvar gnus-face-properties-alist))
2037
2038 (defun article-display-face ()
2039   "Display any Face headers in the header."
2040   (interactive)
2041   (let ((wash-face-p buffer-read-only))
2042     (gnus-with-article-headers
2043       ;; When displaying parts, this function can be called several times on
2044       ;; the same article, without any intended toggle semantic (as typing `W
2045       ;; D d' would have). So face deletion must occur only when we come from
2046       ;; an interactive command, that is when the *Article* buffer is
2047       ;; read-only.
2048       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2049           (gnus-delete-images 'face)
2050         (let (face faces)
2051           (save-excursion
2052             (when (and wash-face-p
2053                        (progn
2054                          (goto-char (point-min))
2055                          (not (re-search-forward "^Face:[\t ]*" nil t)))
2056                        (gnus-buffer-live-p gnus-original-article-buffer))
2057               (set-buffer gnus-original-article-buffer))
2058             (save-restriction
2059               (mail-narrow-to-head)
2060               (while (gnus-article-goto-header "Face")
2061                 (setq faces (nconc faces (list (mail-header-field-value)))))))
2062           (while (setq face (pop faces))
2063             (let ((png (gnus-convert-face-to-png face))
2064                   image)
2065               (when png
2066                 (setq image
2067                       (apply 'gnus-create-image png 'png t
2068                              (cdr (assq 'png gnus-face-properties-alist))))
2069                 (gnus-article-goto-header "from")
2070                 (when (bobp)
2071                   (insert "From: [no `from' set]\n")
2072                   (forward-char -17))
2073                 (gnus-add-wash-type 'face)
2074                 (gnus-add-image 'face image)
2075                 (gnus-put-image image nil 'face))))))
2076       )))
2077
2078 (defun article-display-x-face (&optional force)
2079   "Look for an X-Face header and display it if present."
2080   (interactive (list 'force))
2081   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2082     (gnus-with-article-headers
2083       ;; Delete the old process, if any.
2084       (when (process-status "article-x-face")
2085         (delete-process "article-x-face"))
2086       ;; See the comment in `article-display-face'.
2087       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2088           ;; We have already displayed X-Faces, so we remove them
2089           ;; instead.
2090           (gnus-delete-images 'xface)
2091         ;; Display X-Faces.
2092         (let (x-faces from face)
2093           (save-excursion
2094             (when (and wash-face-p
2095                        (progn
2096                          (goto-char (point-min))
2097                          (not (re-search-forward
2098                                "^X-Face\\(-[0-9]+\\)?:[\t ]*" nil t)))
2099                        (gnus-buffer-live-p gnus-original-article-buffer))
2100               ;; If type `W f', use gnus-original-article-buffer,
2101               ;; otherwise use the current buffer because displaying
2102               ;; RFC822 parts calls this function too.
2103               (set-buffer gnus-original-article-buffer))
2104             (save-restriction
2105               (mail-narrow-to-head)
2106               (while (gnus-article-goto-header "X-Face")
2107                 (push (mail-header-field-value) x-faces))
2108               (setq from (message-fetch-field "from"))))
2109           ;; Sending multiple EOFs to xv doesn't work, so we only do a
2110           ;; single external face.
2111           (when (stringp gnus-article-x-face-command)
2112             (setq x-faces (list (car x-faces))))
2113           (while (and (setq face (pop x-faces))
2114                       gnus-article-x-face-command
2115                       (or force
2116                           ;; Check whether this face is censored.
2117                           (not gnus-article-x-face-too-ugly)
2118                           (and gnus-article-x-face-too-ugly from
2119                                (not (string-match gnus-article-x-face-too-ugly
2120                                                   from)))))
2121             ;; We display the face.
2122             (cond ((stringp gnus-article-x-face-command)
2123                    ;; The command is a string, so we interpret the command
2124                    ;; as a, well, command, and fork it off.
2125                    (let ((process-connection-type nil))
2126                      (process-kill-without-query
2127                       (start-process
2128                        "article-x-face" nil shell-file-name
2129                        shell-command-switch gnus-article-x-face-command))
2130                      (with-temp-buffer
2131                        (insert face)
2132                        (process-send-region "article-x-face"
2133                                             (point-min) (point-max)))
2134                      (process-send-eof "article-x-face")))
2135                   ((functionp gnus-article-x-face-command)
2136                    ;; The command is a lisp function, so we call it.
2137                    (funcall gnus-article-x-face-command face))
2138                   (t
2139                    (error "%s is not a function"
2140                           gnus-article-x-face-command)))))))))
2141
2142 (defun article-decode-mime-words ()
2143   "Decode all MIME-encoded words in the article."
2144   (interactive)
2145   (gnus-with-article-buffer
2146     (let ((inhibit-point-motion-hooks t)
2147           (mail-parse-charset gnus-newsgroup-charset)
2148           (mail-parse-ignored-charsets
2149            (with-current-buffer gnus-summary-buffer
2150              gnus-newsgroup-ignored-charsets)))
2151       (mail-decode-encoded-word-region (point-min) (point-max)))))
2152
2153 (defun article-decode-charset (&optional prompt)
2154   "Decode charset-encoded text in the article.
2155 If PROMPT (the prefix), prompt for a coding system to use."
2156   (interactive "P")
2157   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2158         buffer-read-only
2159         (mail-parse-charset gnus-newsgroup-charset)
2160         (mail-parse-ignored-charsets
2161          (save-excursion (condition-case nil
2162                              (set-buffer gnus-summary-buffer)
2163                            (error))
2164                          gnus-newsgroup-ignored-charsets))
2165         ct cte ctl charset format)
2166   (save-excursion
2167     (save-restriction
2168       (article-narrow-to-head)
2169       (setq ct (message-fetch-field "Content-Type" t)
2170             cte (message-fetch-field "Content-Transfer-Encoding" t)
2171             ctl (and ct (ignore-errors
2172                           (mail-header-parse-content-type ct)))
2173             charset (cond
2174                      (prompt
2175                       (mm-read-coding-system "Charset to decode: "))
2176                      (ctl
2177                       (mail-content-type-get ctl 'charset)))
2178             format (and ctl (mail-content-type-get ctl 'format)))
2179       (when cte
2180         (setq cte (mail-header-strip cte)))
2181       (if (and ctl (not (string-match "/" (car ctl))))
2182           (setq ctl nil))
2183       (goto-char (point-max)))
2184     (forward-line 1)
2185     (save-restriction
2186       (narrow-to-region (point) (point-max))
2187       (when (and (eq mail-parse-charset 'gnus-decoded)
2188                  (eq (mm-body-7-or-8) '8bit))
2189         ;; The text code could have been decoded.
2190         (setq charset mail-parse-charset))
2191       (when (and (or (not ctl)
2192                      (equal (car ctl) "text/plain"))
2193                  (not format)) ;; article with format will decode later.
2194         (mm-decode-body
2195          charset (and cte (intern (downcase
2196                                    (gnus-strip-whitespace cte))))
2197          (car ctl)))))))
2198
2199 (defun article-decode-encoded-words ()
2200   "Remove encoded-word encoding from headers."
2201   (let ((inhibit-point-motion-hooks t)
2202         (mail-parse-charset gnus-newsgroup-charset)
2203         (mail-parse-ignored-charsets
2204          (save-excursion (condition-case nil
2205                              (set-buffer gnus-summary-buffer)
2206                            (error))
2207                          gnus-newsgroup-ignored-charsets))
2208         buffer-read-only)
2209     (save-restriction
2210       (article-narrow-to-head)
2211       (funcall gnus-decode-header-function (point-min) (point-max)))))
2212
2213 (defun article-decode-group-name ()
2214   "Decode group names in `Newsgroups:'."
2215   (let ((inhibit-point-motion-hooks t)
2216         buffer-read-only
2217         (method (gnus-find-method-for-group gnus-newsgroup-name)))
2218     (when (and (or gnus-group-name-charset-method-alist
2219                    gnus-group-name-charset-group-alist)
2220                (gnus-buffer-live-p gnus-original-article-buffer))
2221       (save-restriction
2222         (article-narrow-to-head)
2223         (with-current-buffer gnus-original-article-buffer
2224           (goto-char (point-min)))
2225         (while (re-search-forward
2226                 "^Newsgroups:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]" nil t)
2227           (replace-match (save-match-data
2228                            (gnus-decode-newsgroups
2229                             ;; XXX how to use data in article buffer?
2230                             (with-current-buffer gnus-original-article-buffer
2231                               (re-search-forward
2232                                "^Newsgroups:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]"
2233                                nil t)
2234                               (match-string 1))
2235                             gnus-newsgroup-name method))
2236                          t t nil 1))
2237         (goto-char (point-min))
2238         (with-current-buffer gnus-original-article-buffer
2239           (goto-char (point-min)))
2240         (while (re-search-forward
2241                 "^Followup-To:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]" nil t)
2242           (replace-match (save-match-data
2243                            (gnus-decode-newsgroups
2244                             ;; XXX how to use data in article buffer?
2245                             (with-current-buffer gnus-original-article-buffer
2246                               (re-search-forward
2247                                "^Followup-To:\\(\\(.\\|\n[\t ]\\)*\\)\n[^\t ]"
2248                                nil t)
2249                               (match-string 1))
2250                             gnus-newsgroup-name method))
2251                          t t nil 1))))))
2252
2253 (autoload 'idna-to-unicode "idna")
2254
2255 (defun article-decode-idna-rhs ()
2256   "Decode IDNA strings in RHS in From:, To: and Cc: headers in current buffer."
2257   (when gnus-use-idna
2258     (save-restriction
2259       (let ((inhibit-point-motion-hooks t)
2260             buffer-read-only)
2261         (article-narrow-to-head)
2262         (goto-char (point-min))
2263         (while (re-search-forward "\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2264           (let (ace unicode)
2265             (when (save-match-data
2266                     (and (setq ace (match-string 1))
2267                          (save-excursion
2268                            (and (re-search-backward "^[^ \t]" nil t)
2269                                 (looking-at "From\\|To\\|Cc")))
2270                          (save-excursion (backward-char)
2271                                          (message-idna-inside-rhs-p))
2272                          (setq unicode (idna-to-unicode ace))))
2273               (unless (string= ace unicode)
2274                 (replace-match unicode nil nil nil 1)))))))))
2275
2276 (defun article-de-quoted-unreadable (&optional force read-charset)
2277   "Translate a quoted-printable-encoded article.
2278 If FORCE, decode the article whether it is marked as quoted-printable
2279 or not.
2280 If READ-CHARSET, ask for a coding system."
2281   (interactive (list 'force current-prefix-arg))
2282   (save-excursion
2283     (let ((buffer-read-only nil) type charset)
2284       (if (gnus-buffer-live-p gnus-original-article-buffer)
2285           (with-current-buffer gnus-original-article-buffer
2286             (setq type
2287                   (gnus-fetch-field "content-transfer-encoding"))
2288             (let* ((ct (gnus-fetch-field "content-type"))
2289                    (ctl (and ct
2290                              (ignore-errors
2291                                (mail-header-parse-content-type ct)))))
2292               (setq charset (and ctl
2293                                  (mail-content-type-get ctl 'charset)))
2294               (if (stringp charset)
2295                   (setq charset (intern (downcase charset)))))))
2296       (if read-charset
2297           (setq charset (mm-read-coding-system "Charset: " charset)))
2298       (unless charset
2299         (setq charset gnus-newsgroup-charset))
2300       (when (or force
2301                 (and type (let ((case-fold-search t))
2302                             (string-match "quoted-printable" type))))
2303         (article-goto-body)
2304         (quoted-printable-decode-region
2305          (point) (point-max) (mm-charset-to-coding-system charset))))))
2306
2307 (defun article-de-base64-unreadable (&optional force read-charset)
2308   "Translate a base64 article.
2309 If FORCE, decode the article whether it is marked as base64 not.
2310 If READ-CHARSET, ask for a coding system."
2311   (interactive (list 'force current-prefix-arg))
2312   (save-excursion
2313     (let ((buffer-read-only nil) type charset)
2314       (if (gnus-buffer-live-p gnus-original-article-buffer)
2315           (with-current-buffer gnus-original-article-buffer
2316             (setq type
2317                   (gnus-fetch-field "content-transfer-encoding"))
2318             (let* ((ct (gnus-fetch-field "content-type"))
2319                    (ctl (and ct
2320                              (ignore-errors
2321                                (mail-header-parse-content-type ct)))))
2322               (setq charset (and ctl
2323                                  (mail-content-type-get ctl 'charset)))
2324               (if (stringp charset)
2325                   (setq charset (intern (downcase charset)))))))
2326       (if read-charset
2327           (setq charset (mm-read-coding-system "Charset: " charset)))
2328       (unless charset
2329         (setq charset gnus-newsgroup-charset))
2330       (when (or force
2331                 (and type (let ((case-fold-search t))
2332                             (string-match "base64" type))))
2333         (article-goto-body)
2334         (save-restriction
2335           (narrow-to-region (point) (point-max))
2336           (base64-decode-region (point-min) (point-max))
2337           (mm-decode-coding-region
2338            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2339
2340 (eval-when-compile
2341   (require 'rfc1843))
2342
2343 (defun article-decode-HZ ()
2344   "Translate a HZ-encoded article."
2345   (interactive)
2346   (require 'rfc1843)
2347   (save-excursion
2348     (let ((buffer-read-only nil))
2349       (rfc1843-decode-region (point-min) (point-max)))))
2350
2351 (defun article-unsplit-urls ()
2352   "Remove the newlines that some other mailers insert into URLs."
2353   (interactive)
2354   (save-excursion
2355     (let ((buffer-read-only nil))
2356       (goto-char (point-min))
2357       (while (re-search-forward
2358               "^\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2359         (replace-match "\\1\\3" t)))
2360     (when (interactive-p)
2361       (gnus-treat-article nil))))
2362
2363
2364 (defun article-wash-html (&optional read-charset)
2365   "Format an HTML article.
2366 If READ-CHARSET, ask for a coding system."
2367   (interactive "P")
2368   (save-excursion
2369     (let ((buffer-read-only nil)
2370           charset)
2371       (when (gnus-buffer-live-p gnus-original-article-buffer)
2372         (with-current-buffer gnus-original-article-buffer
2373           (let* ((ct (gnus-fetch-field "content-type"))
2374                  (ctl (and ct
2375                            (ignore-errors
2376                              (mail-header-parse-content-type ct)))))
2377             (setq charset (and ctl
2378                                (mail-content-type-get ctl 'charset)))
2379             (when (stringp charset)
2380               (setq charset (intern (downcase charset)))))))
2381       (when read-charset
2382         (setq charset (mm-read-coding-system "Charset: " charset)))
2383       (unless charset
2384         (setq charset gnus-newsgroup-charset))
2385       (article-goto-body)
2386       (save-window-excursion
2387         (save-restriction
2388           (narrow-to-region (point) (point-max))
2389           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2390                  (entry (assq func mm-text-html-washer-alist)))
2391             (when entry
2392               (setq func (cdr entry)))
2393             (cond
2394              ((functionp func)
2395               (funcall func))
2396              (t
2397               (apply (car func) (cdr func))))))))))
2398
2399 (defun gnus-article-wash-html-with-w3 ()
2400   "Wash the current buffer with w3."
2401   (mm-setup-w3)
2402   (let ((w3-strict-width (window-width))
2403         (url-standalone-mode t)
2404         (url-gateway-unplugged t)
2405         (w3-honor-stylesheets nil))
2406     (condition-case ()
2407         (w3-region (point-min) (point-max))
2408       (error))))
2409
2410 (defun gnus-article-wash-html-with-w3m ()
2411   "Wash the current buffer with emacs-w3m."
2412   (mm-setup-w3m)
2413   (save-restriction
2414     (narrow-to-region (point) (point-max))
2415     (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2416           w3m-force-redisplay)
2417       (w3m-region (point-min) (point-max)))
2418     (when (and mm-inline-text-html-with-w3m-keymap
2419                (boundp 'w3m-minor-mode-map)
2420                w3m-minor-mode-map)
2421       (add-text-properties
2422        (point-min) (point-max)
2423        (list 'keymap w3m-minor-mode-map
2424              ;; Put the mark meaning this part was rendered by emacs-w3m.
2425              'mm-inline-text-html-with-w3m t)))))
2426
2427 (defun article-hide-list-identifiers ()
2428   "Remove list identifies from the Subject header.
2429 The `gnus-list-identifiers' variable specifies what to do."
2430   (interactive)
2431   (let ((inhibit-point-motion-hooks t)
2432         (regexp (if (consp gnus-list-identifiers)
2433                     (mapconcat 'identity gnus-list-identifiers " *\\|")
2434                   gnus-list-identifiers))
2435         buffer-read-only)
2436     (when regexp
2437       (save-excursion
2438         (save-restriction
2439           (article-narrow-to-head)
2440           (goto-char (point-min))
2441           (while (re-search-forward
2442                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
2443                   nil t)
2444             (delete-region (match-beginning 2) (match-end 0))
2445             (beginning-of-line))
2446           (when (re-search-forward
2447                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
2448             (delete-region (match-beginning 1) (match-end 1))))))))
2449
2450 (defun article-hide-pem (&optional arg)
2451   "Toggle hiding of any PEM headers and signatures in the current article.
2452 If given a negative prefix, always show; if given a positive prefix,
2453 always hide."
2454   (interactive (gnus-article-hidden-arg))
2455   (unless (gnus-article-check-hidden-text 'pem arg)
2456     (save-excursion
2457       (let (buffer-read-only end)
2458         (goto-char (point-min))
2459         ;; Hide the horrendously ugly "header".
2460         (when (and (search-forward
2461                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
2462                     nil t)
2463                    (setq end (1+ (match-beginning 0))))
2464           (gnus-add-wash-type 'pem)
2465           (gnus-article-hide-text-type
2466            end
2467            (if (search-forward "\n\n" nil t)
2468                (match-end 0)
2469              (point-max))
2470            'pem)
2471           ;; Hide the trailer as well
2472           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
2473                                 nil t)
2474             (gnus-article-hide-text-type
2475              (match-beginning 0) (match-end 0) 'pem)))))))
2476
2477 (defun article-strip-banner ()
2478   "Strip the banners specified by the `banner' group parameter and by
2479 `gnus-article-address-banner-alist'."
2480   (interactive)
2481   (save-excursion
2482     (save-restriction
2483       (let ((inhibit-point-motion-hooks t))
2484         (when (gnus-parameter-banner gnus-newsgroup-name)
2485           (article-really-strip-banner
2486            (gnus-parameter-banner gnus-newsgroup-name)))
2487         (when gnus-article-address-banner-alist
2488           (let ((from (caar (mail-header-parse-addresses
2489                              (gnus-fetch-original-field "from")))))
2490             (when from
2491               (catch 'found
2492                 (dolist (pair gnus-article-address-banner-alist)
2493                   (when (string-match (car pair) from)
2494                     (throw 'found
2495                            (article-really-strip-banner (cdr pair)))))))))))))
2496
2497 (defun article-really-strip-banner (banner)
2498   "Strip the banner specified by the argument."
2499   (save-excursion
2500     (save-restriction
2501       (let ((inhibit-point-motion-hooks t)
2502             (gnus-signature-limit nil)
2503             buffer-read-only)
2504         (article-goto-body)
2505         (cond
2506          ((eq banner 'signature)
2507           (when (gnus-article-narrow-to-signature)
2508             (widen)
2509             (forward-line -1)
2510             (delete-region (point) (point-max))))
2511          ((symbolp banner)
2512           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
2513               (while (re-search-forward banner nil t)
2514                 (delete-region (match-beginning 0) (match-end 0)))))
2515          ((stringp banner)
2516           (while (re-search-forward banner nil t)
2517             (delete-region (match-beginning 0) (match-end 0)))))))))
2518
2519 (defun article-babel ()
2520   "Translate article using an online translation service."
2521   (interactive)
2522   (require 'babel)
2523   (gnus-with-article-buffer
2524     (when (article-goto-body)
2525       (let* ((start (point))
2526              (end (point-max))
2527              (orig (buffer-substring start end))
2528              (trans (babel-as-string orig)))
2529         (save-restriction
2530           (narrow-to-region start end)
2531           (delete-region start end)
2532           (insert trans))))))
2533
2534 (defun article-hide-signature (&optional arg)
2535   "Hide the signature in the current article.
2536 If given a negative prefix, always show; if given a positive prefix,
2537 always hide."
2538   (interactive (gnus-article-hidden-arg))
2539   (unless (gnus-article-check-hidden-text 'signature arg)
2540     (save-excursion
2541       (save-restriction
2542         (let ((buffer-read-only nil))
2543           (when (gnus-article-narrow-to-signature)
2544             (gnus-article-hide-text-type
2545              (point-min) (point-max) 'signature))))))
2546   (gnus-set-mode-line 'article))
2547
2548 (defun article-strip-headers-in-body ()
2549   "Strip offensive headers from bodies."
2550   (interactive)
2551   (save-excursion
2552     (article-goto-body)
2553     (let ((case-fold-search t))
2554       (when (looking-at "x-no-archive:")
2555         (gnus-delete-line)))))
2556
2557 (defun article-strip-leading-blank-lines ()
2558   "Remove all blank lines from the beginning of the article."
2559   (interactive)
2560   (save-excursion
2561     (let ((inhibit-point-motion-hooks t)
2562           buffer-read-only)
2563       (when (article-goto-body)
2564         (while (and (not (eobp))
2565                     (looking-at "[ \t]*$"))
2566           (gnus-delete-line))))))
2567
2568 (defun article-narrow-to-head ()
2569   "Narrow the buffer to the head of the message.
2570 Point is left at the beginning of the narrowed-to region."
2571   (narrow-to-region
2572    (goto-char (point-min))
2573    (if (search-forward "\n\n" nil 1)
2574        (1- (point))
2575      (point-max)))
2576   (goto-char (point-min)))
2577
2578 (defun article-goto-body ()
2579   "Place point at the start of the body."
2580   (goto-char (point-min))
2581   (cond
2582    ;; This variable is only bound when dealing with separate
2583    ;; MIME body parts.
2584    (article-goto-body-goes-to-point-min-p
2585     t)
2586    ((search-forward "\n\n" nil t)
2587     t)
2588    (t
2589     (goto-char (point-max))
2590     nil)))
2591
2592 (defun article-strip-multiple-blank-lines ()
2593   "Replace consecutive blank lines with one empty line."
2594   (interactive)
2595   (save-excursion
2596     (let ((inhibit-point-motion-hooks t)
2597           buffer-read-only)
2598       ;; First make all blank lines empty.
2599       (article-goto-body)
2600       (while (re-search-forward "^[ \t]+$" nil t)
2601         (unless (gnus-annotation-in-region-p
2602                  (match-beginning 0) (match-end 0))
2603           (replace-match "" nil t)))
2604       ;; Then replace multiple empty lines with a single empty line.
2605       (article-goto-body)
2606       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
2607         (unless (gnus-annotation-in-region-p
2608                  (match-beginning 0) (match-end 0))
2609           (delete-region (match-beginning 1) (match-end 1)))))))
2610
2611 (defun article-strip-leading-space ()
2612   "Remove all white space from the beginning of the lines in the article."
2613   (interactive)
2614   (save-excursion
2615     (let ((inhibit-point-motion-hooks t)
2616           buffer-read-only)
2617       (article-goto-body)
2618       (while (re-search-forward "^[ \t]+" nil t)
2619         (replace-match "" t t)))))
2620
2621 (defun article-strip-trailing-space ()
2622   "Remove all white space from the end of the lines in the article."
2623   (interactive)
2624   (save-excursion
2625     (let ((inhibit-point-motion-hooks t)
2626           buffer-read-only)
2627       (article-goto-body)
2628       (while (re-search-forward "[ \t]+$" nil t)
2629         (replace-match "" t t)))))
2630
2631 (defun article-strip-blank-lines ()
2632   "Strip leading, trailing and multiple blank lines."
2633   (interactive)
2634   (article-strip-leading-blank-lines)
2635   (article-remove-trailing-blank-lines)
2636   (article-strip-multiple-blank-lines))
2637
2638 (defun article-strip-all-blank-lines ()
2639   "Strip all blank lines."
2640   (interactive)
2641   (save-excursion
2642     (let ((inhibit-point-motion-hooks t)
2643           buffer-read-only)
2644       (article-goto-body)
2645       (while (re-search-forward "^[ \t]*\n" nil t)
2646         (replace-match "" t t)))))
2647
2648 (defun gnus-article-narrow-to-signature ()
2649   "Narrow to the signature; return t if a signature is found, else nil."
2650   (let ((inhibit-point-motion-hooks t))
2651     (when (gnus-article-search-signature)
2652       (forward-line 1)
2653       ;; Check whether we have some limits to what we consider
2654       ;; to be a signature.
2655       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
2656                       (list gnus-signature-limit)))
2657             limit limited)
2658         (while (setq limit (pop limits))
2659           (if (or (and (integerp limit)
2660                        (< (- (point-max) (point)) limit))
2661                   (and (floatp limit)
2662                        (< (count-lines (point) (point-max)) limit))
2663                   (and (functionp limit)
2664                        (funcall limit))
2665                   (and (stringp limit)
2666                        (not (re-search-forward limit nil t))))
2667               ()                        ; This limit did not succeed.
2668             (setq limited t
2669                   limits nil)))
2670         (unless limited
2671           (narrow-to-region (point) (point-max))
2672           t)))))
2673
2674 (defun gnus-article-search-signature ()
2675   "Search the current buffer for the signature separator.
2676 Put point at the beginning of the signature separator."
2677   (let ((cur (point)))
2678     (goto-char (point-max))
2679     (if (if (stringp gnus-signature-separator)
2680             (re-search-backward gnus-signature-separator nil t)
2681           (let ((seps gnus-signature-separator))
2682             (while (and seps
2683                         (not (re-search-backward (car seps) nil t)))
2684               (pop seps))
2685             seps))
2686         t
2687       (goto-char cur)
2688       nil)))
2689
2690 (defun gnus-article-hidden-arg ()
2691   "Return the current prefix arg as a number, or 0 if no prefix."
2692   (list (if current-prefix-arg
2693             (prefix-numeric-value current-prefix-arg)
2694           0)))
2695
2696 (defun gnus-article-check-hidden-text (type arg)
2697   "Return nil if hiding is necessary.
2698 Arg can be nil or a number.  nil and positive means hide, negative
2699 means show, 0 means toggle."
2700   (save-excursion
2701     (save-restriction
2702       (let ((hide (gnus-article-hidden-text-p type)))
2703         (cond
2704          ((or (null arg)
2705               (> arg 0))
2706           nil)
2707          ((< arg 0)
2708           (gnus-article-show-hidden-text type)
2709           t)
2710          (t
2711           (if (eq hide 'hidden)
2712               (progn
2713                 (gnus-article-show-hidden-text type)
2714                 t)
2715             nil)))))))
2716
2717 (defun gnus-article-hidden-text-p (type)
2718   "Say whether the current buffer contains hidden text of type TYPE."
2719   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
2720     (while (and pos
2721                 (not (get-text-property pos 'invisible))
2722                 (not (get-text-property pos 'dummy-invisible)))
2723       (setq pos
2724             (text-property-any (1+ pos) (point-max) 'article-type type)))
2725     (if pos
2726         'hidden
2727       nil)))
2728
2729 (defun gnus-article-show-hidden-text (type &optional dummy)
2730   "Show all hidden text of type TYPE.
2731 Originally it is hide instead of DUMMY."
2732   (let ((buffer-read-only nil)
2733         (inhibit-point-motion-hooks t))
2734     (gnus-remove-text-properties-when
2735      'article-type type
2736      (point-min) (point-max)
2737      (cons 'article-type (cons type
2738                                gnus-hidden-properties)))
2739     (gnus-delete-wash-type type)))
2740
2741 (defconst article-time-units
2742   `((year . ,(* 365.25 24 60 60))
2743     (week . ,(* 7 24 60 60))
2744     (day . ,(* 24 60 60))
2745     (hour . ,(* 60 60))
2746     (minute . 60)
2747     (second . 1))
2748   "Mapping from time units to seconds.")
2749
2750 (defun gnus-article-forward-header ()
2751   "Move point to the start of the next header.
2752 If the current header is a continuation header, this can be several
2753 lines forward."
2754   (let ((ended nil))
2755     (while (not ended)
2756       (forward-line 1)
2757       (if (looking-at "[ \t]+[^ \t]")
2758           (forward-line 1)
2759         (setq ended t)))))
2760
2761 (defun article-date-ut (&optional type highlight header)
2762   "Convert DATE date to universal time in the current article.
2763 If TYPE is `local', convert to local time; if it is `lapsed', output
2764 how much time has lapsed since DATE.  For `lapsed', the value of
2765 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
2766 should replace the \"Date:\" one, or should be added below it."
2767   (interactive (list 'ut t))
2768   (let* ((header (or header
2769                      (message-fetch-field "date")
2770                      ""))
2771          (tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
2772          (date-regexp
2773           (cond
2774            ((not gnus-article-date-lapsed-new-header)
2775             tdate-regexp)
2776            ((eq type 'lapsed)
2777             "^X-Sent:[ \t]")
2778            (t
2779             "^Date:[ \t]")))
2780          (date (if (vectorp header) (mail-header-date header)
2781                  header))
2782          (inhibit-point-motion-hooks t)
2783          pos
2784          bface eface)
2785     (save-excursion
2786       (save-restriction
2787         (article-narrow-to-head)
2788         (when (re-search-forward tdate-regexp nil t)
2789           (setq bface (get-text-property (point-at-bol) 'face)
2790                 date (or (get-text-property (point-at-bol)
2791                                             'original-date)
2792                          date)
2793                 eface (get-text-property (1- (point-at-eol)) 'face))
2794           (forward-line 1))
2795         (when (and date (not (string= date "")))
2796           (goto-char (point-min))
2797           (let ((buffer-read-only nil))
2798             ;; Delete any old Date headers.
2799             (while (re-search-forward date-regexp nil t)
2800               (if pos
2801                   (delete-region (point-at-bol)
2802                                  (progn (gnus-article-forward-header)
2803                                         (point)))
2804                 (delete-region (point-at-bol)
2805                                (progn (gnus-article-forward-header)
2806                                       (forward-char -1)
2807                                       (point)))
2808                 (setq pos (point))))
2809             (when (and (not pos)
2810                        (re-search-forward tdate-regexp nil t))
2811               (forward-line 1))
2812             (gnus-goto-char pos)
2813             (insert (article-make-date-line date (or type 'ut)))
2814             (unless pos
2815               (insert "\n")
2816               (forward-line -1))
2817             ;; Do highlighting.
2818             (beginning-of-line)
2819             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
2820               (put-text-property (match-beginning 1) (1+ (match-end 1))
2821                                  'original-date date)
2822               (put-text-property (match-beginning 1) (1+ (match-end 1))
2823                                  'face bface)
2824               (put-text-property (match-beginning 2) (match-end 2)
2825                                  'face eface))))))))
2826
2827 (defun article-make-date-line (date type)
2828   "Return a DATE line of TYPE."
2829   (unless (memq type '(local ut original user iso8601 lapsed english))
2830     (error "Unknown conversion type: %s" type))
2831   (condition-case ()
2832       (let ((time (date-to-time date)))
2833         (cond
2834          ;; Convert to the local timezone.
2835          ((eq type 'local)
2836           (let ((tz (car (current-time-zone time))))
2837             (format "Date: %s %s%02d%02d" (current-time-string time)
2838                     (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2839                     (/ (% (abs tz) 3600) 60))))
2840          ;; Convert to Universal Time.
2841          ((eq type 'ut)
2842           (concat "Date: "
2843                   (current-time-string
2844                    (let* ((e (parse-time-string date))
2845                           (tm (apply 'encode-time e))
2846                           (ms (car tm))
2847                           (ls (- (cadr tm) (car (current-time-zone time)))))
2848                      (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
2849                            ((> ls 65535) (list (1+ ms) (- ls 65536)))
2850                            (t (list ms ls)))))
2851                   " UT"))
2852          ;; Get the original date from the article.
2853          ((eq type 'original)
2854           (concat "Date: " (if (string-match "\n+$" date)
2855                                (substring date 0 (match-beginning 0))
2856                              date)))
2857          ;; Let the user define the format.
2858          ((eq type 'user)
2859           (let ((format (or (condition-case nil
2860                                 (with-current-buffer gnus-summary-buffer
2861                                   gnus-article-time-format)
2862                               (error nil))
2863                             gnus-article-time-format)))
2864             (if (functionp format)
2865                 (funcall format time)
2866               (concat "Date: " (format-time-string format time)))))
2867          ;; ISO 8601.
2868          ((eq type 'iso8601)
2869           (let ((tz (car (current-time-zone time))))
2870             (concat
2871              "Date: "
2872              (format-time-string "%Y%m%dT%H%M%S" time)
2873              (format "%s%02d%02d"
2874                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2875                      (/ (% (abs tz) 3600) 60)))))
2876          ;; Do an X-Sent lapsed format.
2877          ((eq type 'lapsed)
2878           ;; If the date is seriously mangled, the timezone functions are
2879           ;; liable to bug out, so we ignore all errors.
2880           (let* ((now (current-time))
2881                  (real-time (subtract-time now time))
2882                  (real-sec (and real-time
2883                                 (+ (* (float (car real-time)) 65536)
2884                                    (cadr real-time))))
2885                  (sec (and real-time (abs real-sec)))
2886                  num prev)
2887             (cond
2888              ((null real-time)
2889               "X-Sent: Unknown")
2890              ((zerop sec)
2891               "X-Sent: Now")
2892              (t
2893               (concat
2894                "X-Sent: "
2895                ;; This is a bit convoluted, but basically we go
2896                ;; through the time units for years, weeks, etc,
2897                ;; and divide things to see whether that results
2898                ;; in positive answers.
2899                (mapconcat
2900                 (lambda (unit)
2901                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
2902                       ;; The (remaining) seconds are too few to
2903                       ;; be divided into this time unit.
2904                       ""
2905                     ;; It's big enough, so we output it.
2906                     (setq sec (- sec (* num (cdr unit))))
2907                     (prog1
2908                         (concat (if prev ", " "") (int-to-string
2909                                                    (floor num))
2910                                 " " (symbol-name (car unit))
2911                                 (if (> num 1) "s" ""))
2912                       (setq prev t))))
2913                 article-time-units "")
2914                ;; If dates are odd, then it might appear like the
2915                ;; article was sent in the future.
2916                (if (> real-sec 0)
2917                    " ago"
2918                  " in the future"))))))
2919          ;; Display the date in proper English
2920          ((eq type 'english)
2921           (let ((dtime (decode-time time)))
2922             (concat
2923              "Date: the "
2924              (number-to-string (nth 3 dtime))
2925              (let ((digit (% (nth 3 dtime) 10)))
2926                (cond
2927                 ((memq (nth 3 dtime) '(11 12 13)) "th")
2928                 ((= digit 1) "st")
2929                 ((= digit 2) "nd")
2930                 ((= digit 3) "rd")
2931                 (t "th")))
2932              " of "
2933              (nth (1- (nth 4 dtime)) gnus-english-month-names)
2934              " "
2935              (number-to-string (nth 5 dtime))
2936              " at "
2937              (format "%02d" (nth 2 dtime))
2938              ":"
2939              (format "%02d" (nth 1 dtime)))))))
2940     (error
2941      (format "Date: %s (from Gnus)" date))))
2942
2943 (defun article-date-local (&optional highlight)
2944   "Convert the current article date to the local timezone."
2945   (interactive (list t))
2946   (article-date-ut 'local highlight))
2947
2948 (defun article-date-english (&optional highlight)
2949   "Convert the current article date to something that is proper English."
2950   (interactive (list t))
2951   (article-date-ut 'english highlight))
2952
2953 (defun article-date-original (&optional highlight)
2954   "Convert the current article date to what it was originally.
2955 This is only useful if you have used some other date conversion
2956 function and want to see what the date was before converting."
2957   (interactive (list t))
2958   (article-date-ut 'original highlight))
2959
2960 (defun article-date-lapsed (&optional highlight)
2961   "Convert the current article date to time lapsed since it was sent."
2962   (interactive (list t))
2963   (article-date-ut 'lapsed highlight))
2964
2965 (defun article-update-date-lapsed ()
2966   "Function to be run from a timer to update the lapsed time line."
2967   (let (deactivate-mark)
2968     (save-excursion
2969       (ignore-errors
2970         (walk-windows
2971          (lambda (w)
2972            (set-buffer (window-buffer w))
2973            (when (eq major-mode 'gnus-article-mode)
2974              (let ((mark (point-marker)))
2975                (goto-char (point-min))
2976                (when (re-search-forward "^X-Sent:" nil t)
2977                  (article-date-lapsed t))
2978                (goto-char (marker-position mark))
2979                (move-marker mark nil))))
2980          nil 'visible)))))
2981
2982 (defun gnus-start-date-timer (&optional n)
2983   "Start a timer to update the X-Sent header in the article buffers.
2984 The numerical prefix says how frequently (in seconds) the function
2985 is to run."
2986   (interactive "p")
2987   (unless n
2988     (setq n 1))
2989   (gnus-stop-date-timer)
2990   (setq article-lapsed-timer
2991         (run-at-time 1 n 'article-update-date-lapsed)))
2992
2993 (defun gnus-stop-date-timer ()
2994   "Stop the X-Sent timer."
2995   (interactive)
2996   (when article-lapsed-timer
2997     (nnheader-cancel-timer article-lapsed-timer)
2998     (setq article-lapsed-timer nil)))
2999
3000 (defun article-date-user (&optional highlight)
3001   "Convert the current article date to the user-defined format.
3002 This format is defined by the `gnus-article-time-format' variable."
3003   (interactive (list t))
3004   (article-date-ut 'user highlight))
3005
3006 (defun article-date-iso8601 (&optional highlight)
3007   "Convert the current article date to ISO8601."
3008   (interactive (list t))
3009   (article-date-ut 'iso8601 highlight))
3010
3011 ;; (defun article-show-all ()
3012 ;;   "Show all hidden text in the article buffer."
3013 ;;   (interactive)
3014 ;;   (save-excursion
3015 ;;     (let ((buffer-read-only nil))
3016 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3017
3018 (defun article-remove-leading-whitespace ()
3019   "Remove excessive whitespace from all headers."
3020   (interactive)
3021   (save-excursion
3022     (save-restriction
3023       (let ((buffer-read-only nil))
3024         (article-narrow-to-head)
3025         (goto-char (point-min))
3026         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3027           (delete-region (match-beginning 1) (match-end 1)))))))
3028
3029 (defun article-emphasize (&optional arg)
3030   "Emphasize text according to `gnus-emphasis-alist'."
3031   (interactive (gnus-article-hidden-arg))
3032   (unless (gnus-article-check-hidden-text 'emphasis arg)
3033     (save-excursion
3034       (let ((alist (or
3035                     (condition-case nil
3036                         (with-current-buffer gnus-summary-buffer
3037                           gnus-article-emphasis-alist)
3038                       (error))
3039                     gnus-emphasis-alist))
3040             (buffer-read-only nil)
3041             (props (append '(article-type emphasis)
3042                            gnus-hidden-properties))
3043             regexp elem beg invisible visible face)
3044         (article-goto-body)
3045         (setq beg (point))
3046         (while (setq elem (pop alist))
3047           (goto-char beg)
3048           (setq regexp (car elem)
3049                 invisible (nth 1 elem)
3050                 visible (nth 2 elem)
3051                 face (nth 3 elem))
3052           (while (re-search-forward regexp nil t)
3053             (when (and (match-beginning visible) (match-beginning invisible))
3054               (gnus-article-hide-text
3055                (match-beginning invisible) (match-end invisible) props)
3056               (gnus-article-unhide-text-type
3057                (match-beginning visible) (match-end visible) 'emphasis)
3058               (gnus-put-overlay-excluding-newlines
3059                (match-beginning visible) (match-end visible) 'face face)
3060               (gnus-add-wash-type 'emphasis)
3061               (goto-char (match-end invisible)))))))))
3062
3063 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3064   "Setup newsgroup emphasis alist."
3065   (unless gnus-article-emphasis-alist
3066     (let ((name (and gnus-newsgroup-name
3067                      (gnus-group-real-name gnus-newsgroup-name))))
3068       (make-local-variable 'gnus-article-emphasis-alist)
3069       (setq gnus-article-emphasis-alist
3070             (nconc
3071              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3072                (while (setq elem (pop alist))
3073                  (when (and name (string-match (car elem) name))
3074                    (setq alist nil
3075                          highlight (copy-sequence (cdr elem)))))
3076                highlight)
3077              (copy-sequence highlight-words)
3078              (if gnus-newsgroup-name
3079                  (copy-sequence (gnus-group-find-parameter
3080                                  gnus-newsgroup-name 'highlight-words t)))
3081              gnus-emphasis-alist)))))
3082
3083 (eval-when-compile
3084   (defvar gnus-summary-article-menu)
3085   (defvar gnus-summary-post-menu))
3086
3087 ;;; Saving functions.
3088
3089 (defun gnus-article-save (save-buffer file &optional num)
3090   "Save the currently selected article."
3091   (unless gnus-save-all-headers
3092     ;; Remove headers according to `gnus-saved-headers'.
3093     (let ((gnus-visible-headers
3094            (or gnus-saved-headers gnus-visible-headers))
3095           (gnus-article-buffer save-buffer))
3096       (save-excursion
3097         (set-buffer save-buffer)
3098         (article-hide-headers 1 t))))
3099   (save-window-excursion
3100     (if (not gnus-default-article-saver)
3101         (error "No default saver is defined")
3102       ;; !!! Magic!  The saving functions all save
3103       ;; `gnus-save-article-buffer' (or so they think), but we
3104       ;; bind that variable to our save-buffer.
3105       (set-buffer gnus-article-buffer)
3106       (let* ((gnus-save-article-buffer save-buffer)
3107              (filename
3108               (cond
3109                ((not gnus-prompt-before-saving) 'default)
3110                ((eq gnus-prompt-before-saving 'always) nil)
3111                (t file)))
3112              (gnus-number-of-articles-to-be-saved
3113               (when (eq gnus-prompt-before-saving t)
3114                 num)))                  ; Magic
3115         (set-buffer gnus-article-current-summary)
3116         (funcall gnus-default-article-saver filename)))))
3117
3118 (defun gnus-read-save-file-name (prompt &optional filename
3119                                         function group headers variable)
3120   (let ((default-name
3121           (funcall function group headers (symbol-value variable)))
3122         result)
3123     (setq result
3124           (expand-file-name
3125            (cond
3126             ((eq filename 'default)
3127              default-name)
3128             ((eq filename t)
3129              default-name)
3130             (filename filename)
3131             (t
3132              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3133                     (prompt
3134                      (format prompt
3135                              (if (and gnus-number-of-articles-to-be-saved
3136                                       (> gnus-number-of-articles-to-be-saved 1))
3137                                  (format "these %d articles"
3138                                          gnus-number-of-articles-to-be-saved)
3139                                "this article")))
3140                     (file
3141                      ;; Let the split methods have their say.
3142                      (cond
3143                       ;; No split name was found.
3144                       ((null split-name)
3145                        (read-file-name
3146                         (concat prompt " (default "
3147                                 (file-name-nondirectory default-name) ") ")
3148                         (file-name-directory default-name)
3149                         default-name))
3150                       ;; A single group name is returned.
3151                       ((stringp split-name)
3152                        (setq default-name
3153                              (funcall function split-name headers
3154                                       (symbol-value variable)))
3155                        (read-file-name
3156                         (concat prompt " (default "
3157                                 (file-name-nondirectory default-name) ") ")
3158                         (file-name-directory default-name)
3159                         default-name))
3160                       ;; A single split name was found
3161                       ((= 1 (length split-name))
3162                        (let* ((name (expand-file-name
3163                                      (car split-name)
3164                                      gnus-article-save-directory))
3165                               (dir (cond ((file-directory-p name)
3166                                           (file-name-as-directory name))
3167                                          ((file-exists-p name) name)
3168                                          (t gnus-article-save-directory))))
3169                          (read-file-name
3170                           (concat prompt " (default " name ") ")
3171                           dir name)))
3172                       ;; A list of splits was found.
3173                       (t
3174                        (setq split-name (nreverse split-name))
3175                        (let (result)
3176                          (let ((file-name-history
3177                                 (nconc split-name file-name-history)))
3178                            (setq result
3179                                  (expand-file-name
3180                                   (read-file-name
3181                                    (concat prompt " (`M-p' for defaults) ")
3182                                    gnus-article-save-directory
3183                                    (car split-name))
3184                                   gnus-article-save-directory)))
3185                          (car (push result file-name-history)))))))
3186                ;; Create the directory.
3187                (gnus-make-directory (file-name-directory file))
3188                ;; If we have read a directory, we append the default file name.
3189                (when (file-directory-p file)
3190                  (setq file (expand-file-name (file-name-nondirectory
3191                                                default-name)
3192                                               (file-name-as-directory file))))
3193                ;; Possibly translate some characters.
3194                (nnheader-translate-file-chars file))))))
3195     (gnus-make-directory (file-name-directory result))
3196     (set variable result)))
3197
3198 (defun gnus-article-archive-name (group)
3199   "Return the first instance of an \"Archive-name\" in the current buffer."
3200   (let ((case-fold-search t))
3201     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3202       (nnheader-concat gnus-article-save-directory
3203                        (match-string 1)))))
3204
3205 (defun gnus-article-nndoc-name (group)
3206   "If GROUP is an nndoc group, return the name of the parent group."
3207   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3208     (gnus-group-get-parameter group 'save-article-group)))
3209
3210 (defun gnus-summary-save-in-rmail (&optional filename)
3211   "Append this article to Rmail file.
3212 Optional argument FILENAME specifies file name.
3213 Directory to save to is default to `gnus-article-save-directory'."
3214   (setq filename (gnus-read-save-file-name
3215                   "Save %s in rmail file:" filename
3216                   gnus-rmail-save-name gnus-newsgroup-name
3217                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3218   (gnus-eval-in-buffer-window gnus-save-article-buffer
3219     (save-excursion
3220       (save-restriction
3221         (widen)
3222         (gnus-output-to-rmail filename))))
3223   filename)
3224
3225 (defun gnus-summary-save-in-mail (&optional filename)
3226   "Append this article to Unix mail file.
3227 Optional argument FILENAME specifies file name.
3228 Directory to save to is default to `gnus-article-save-directory'."
3229   (setq filename (gnus-read-save-file-name
3230                   "Save %s in Unix mail file:" filename
3231                   gnus-mail-save-name gnus-newsgroup-name
3232                   gnus-current-headers 'gnus-newsgroup-last-mail))
3233   (gnus-eval-in-buffer-window gnus-save-article-buffer
3234     (save-excursion
3235       (save-restriction
3236         (widen)
3237         (if (and (file-readable-p filename)
3238                  (file-regular-p filename)
3239                  (mail-file-babyl-p filename))
3240             (rmail-output-to-rmail-file filename t)
3241           (gnus-output-to-mail filename)))))
3242   filename)
3243
3244 (defun gnus-summary-save-in-file (&optional filename overwrite)
3245   "Append this article to file.
3246 Optional argument FILENAME specifies file name.
3247 Directory to save to is default to `gnus-article-save-directory'."
3248   (setq filename (gnus-read-save-file-name
3249                   "Save %s in file:" filename
3250                   gnus-file-save-name gnus-newsgroup-name
3251                   gnus-current-headers 'gnus-newsgroup-last-file))
3252   (gnus-eval-in-buffer-window gnus-save-article-buffer
3253     (save-excursion
3254       (save-restriction
3255         (widen)
3256         (when (and overwrite
3257                    (file-exists-p filename))
3258           (delete-file filename))
3259         (gnus-output-to-file filename))))
3260   filename)
3261
3262 (defun gnus-summary-write-to-file (&optional filename)
3263   "Write this article to a file, overwriting it if the file exists.
3264 Optional argument FILENAME specifies file name.
3265 The directory to save in defaults to `gnus-article-save-directory'."
3266   (gnus-summary-save-in-file nil t))
3267
3268 (defun gnus-summary-save-body-in-file (&optional filename)
3269   "Append this article body to a file.
3270 Optional argument FILENAME specifies file name.
3271 The directory to save in defaults to `gnus-article-save-directory'."
3272   (setq filename (gnus-read-save-file-name
3273                   "Save %s body in file:" filename
3274                   gnus-file-save-name gnus-newsgroup-name
3275                   gnus-current-headers 'gnus-newsgroup-last-file))
3276   (gnus-eval-in-buffer-window gnus-save-article-buffer
3277     (save-excursion
3278       (save-restriction
3279         (widen)
3280         (when (article-goto-body)
3281           (narrow-to-region (point) (point-max)))
3282         (gnus-output-to-file filename))))
3283   filename)
3284
3285 (defun gnus-summary-save-in-pipe (&optional command)
3286   "Pipe this article to subprocess."
3287   (setq command
3288         (cond ((and (eq command 'default)
3289                     gnus-last-shell-command)
3290                gnus-last-shell-command)
3291               ((stringp command)
3292                command)
3293               (t (read-string
3294                   (format
3295                    "Shell command on %s: "
3296                    (if (and gnus-number-of-articles-to-be-saved
3297                             (> gnus-number-of-articles-to-be-saved 1))
3298                        (format "these %d articles"
3299                                gnus-number-of-articles-to-be-saved)
3300                      "this article"))
3301                   gnus-last-shell-command))))
3302   (when (string-equal command "")
3303     (if gnus-last-shell-command
3304         (setq command gnus-last-shell-command)
3305       (error "A command is required")))
3306   (gnus-eval-in-buffer-window gnus-article-buffer
3307     (save-restriction
3308       (widen)
3309       (shell-command-on-region (point-min) (point-max) command nil)))
3310   (setq gnus-last-shell-command command))
3311
3312 (defun gnus-summary-pipe-to-muttprint (&optional command)
3313   "Pipe this article to muttprint."
3314   (setq command (read-string
3315                  "Print using command: " gnus-summary-muttprint-program
3316                  nil gnus-summary-muttprint-program))
3317   (gnus-summary-save-in-pipe command))
3318
3319 ;;; Article file names when saving.
3320
3321 (defun gnus-capitalize-newsgroup (newsgroup)
3322   "Capitalize NEWSGROUP name."
3323   (when (not (zerop (length newsgroup)))
3324     (concat (char-to-string (upcase (aref newsgroup 0)))
3325             (substring newsgroup 1))))
3326
3327 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3328   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3329 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3330 Otherwise, it is like ~/News/news/group/num."
3331   (let ((default
3332           (expand-file-name
3333            (concat (if (gnus-use-long-file-name 'not-save)
3334                        (gnus-capitalize-newsgroup newsgroup)
3335                      (gnus-newsgroup-directory-form newsgroup))
3336                    "/" (int-to-string (mail-header-number headers)))
3337            gnus-article-save-directory)))
3338     (if (and last-file
3339              (string-equal (file-name-directory default)
3340                            (file-name-directory last-file))
3341              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3342         default
3343       (or last-file default))))
3344
3345 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
3346   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3347 If variable `gnus-use-long-file-name' is non-nil, it is
3348 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
3349   (let ((default
3350           (expand-file-name
3351            (concat (if (gnus-use-long-file-name 'not-save)
3352                        newsgroup
3353                      (gnus-newsgroup-directory-form newsgroup))
3354                    "/" (int-to-string (mail-header-number headers)))
3355            gnus-article-save-directory)))
3356     (if (and last-file
3357              (string-equal (file-name-directory default)
3358                            (file-name-directory last-file))
3359              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3360         default
3361       (or last-file default))))
3362
3363 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
3364   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3365 If variable `gnus-use-long-file-name' is non-nil, it is
3366 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
3367   (or last-file
3368       (expand-file-name
3369        (if (gnus-use-long-file-name 'not-save)
3370            newsgroup
3371          (file-relative-name
3372           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
3373           default-directory))
3374        gnus-article-save-directory)))
3375
3376 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
3377   "Generate file name from sender."
3378   (let ((from (mail-header-from headers)))
3379     (expand-file-name
3380      (if (and from (string-match "\\([^ <]+\\)@" from))
3381          (match-string 1 from)
3382        "nobody")
3383      gnus-article-save-directory)))
3384
3385 (defun article-verify-x-pgp-sig ()
3386   "Verify X-PGP-Sig."
3387   (interactive)
3388   (if (gnus-buffer-live-p gnus-original-article-buffer)
3389       (let ((sig (with-current-buffer gnus-original-article-buffer
3390                    (gnus-fetch-field "X-PGP-Sig")))
3391             items info headers)
3392         (when (and sig
3393                    mml2015-use
3394                    (mml2015-clear-verify-function))
3395           (with-temp-buffer
3396             (insert-buffer-substring gnus-original-article-buffer)
3397             (setq items (split-string sig))
3398             (message-narrow-to-head)
3399             (let ((inhibit-point-motion-hooks t)
3400                   (case-fold-search t))
3401               ;; Don't verify multiple headers.
3402               (setq headers (mapconcat (lambda (header)
3403                                          (concat header ": "
3404                                                  (mail-fetch-field header)
3405                                                  "\n"))
3406                                        (split-string (nth 1 items) ",") "")))
3407             (delete-region (point-min) (point-max))
3408             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
3409             (insert "X-Signed-Headers: " (nth 1 items) "\n")
3410             (insert headers)
3411             (widen)
3412             (forward-line)
3413             (while (not (eobp))
3414               (if (looking-at "^-")
3415                   (insert "- "))
3416               (forward-line))
3417             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
3418             (insert "Version: " (car items) "\n\n")
3419             (insert (mapconcat 'identity (cddr items) "\n"))
3420             (insert "\n-----END PGP SIGNATURE-----\n")
3421             (let ((mm-security-handle (list (format "multipart/signed"))))
3422               (mml2015-clean-buffer)
3423               (let ((coding-system-for-write (or gnus-newsgroup-charset
3424                                                  'iso-8859-1)))
3425                 (funcall (mml2015-clear-verify-function)))
3426               (setq info
3427                     (or (mm-handle-multipart-ctl-parameter
3428                          mm-security-handle 'gnus-details)
3429                         (mm-handle-multipart-ctl-parameter
3430                          mm-security-handle 'gnus-info)))))
3431           (when info
3432             (let (buffer-read-only bface eface)
3433               (save-restriction
3434                 (message-narrow-to-head)
3435                 (goto-char (point-max))
3436                 (forward-line -1)
3437                 (setq bface (get-text-property (point-at-bol) 'face)
3438                       eface (get-text-property (1- (point-at-eol)) 'face))
3439                 (message-remove-header "X-Gnus-PGP-Verify")
3440                 (if (re-search-forward "^X-PGP-Sig:" nil t)
3441                     (forward-line)
3442                   (goto-char (point-max)))
3443                 (narrow-to-region (point) (point))
3444                 (insert "X-Gnus-PGP-Verify: " info "\n")
3445                 (goto-char (point-min))
3446                 (forward-line)
3447                 (while (not (eobp))
3448                   (if (not (looking-at "^[ \t]"))
3449                       (insert " "))
3450                   (forward-line))
3451                 ;; Do highlighting.
3452                 (goto-char (point-min))
3453                 (when (looking-at "\\([^:]+\\): *")
3454                   (put-text-property (match-beginning 1) (1+ (match-end 1))
3455                                      'face bface)
3456                   (put-text-property (match-end 0) (point-max)
3457                                      'face eface)))))))))
3458
3459 (defun article-verify-cancel-lock ()
3460   "Verify Cancel-Lock header."
3461   (interactive)
3462   (if (gnus-buffer-live-p gnus-original-article-buffer)
3463       (canlock-verify gnus-original-article-buffer)))
3464
3465 (eval-and-compile
3466   (mapcar
3467    (lambda (func)
3468      (let (afunc gfunc)
3469        (if (consp func)
3470            (setq afunc (car func)
3471                  gfunc (cdr func))
3472          (setq afunc func
3473                gfunc (intern (format "gnus-%s" func))))
3474        (defalias gfunc
3475          (when (fboundp afunc)
3476            `(lambda (&optional interactive &rest args)
3477               ,(documentation afunc t)
3478               (interactive (list t))
3479               (save-excursion
3480                 (set-buffer gnus-article-buffer)
3481                 (if interactive
3482                     (call-interactively ',afunc)
3483                   (apply ',afunc args))))))))
3484    '(article-hide-headers
3485      article-verify-x-pgp-sig
3486      article-verify-cancel-lock
3487      article-hide-boring-headers
3488      article-treat-overstrike
3489      article-treat-ansi-sequences
3490      article-fill-long-lines
3491      article-capitalize-sentences
3492      article-remove-cr
3493      article-remove-leading-whitespace
3494      article-display-x-face
3495      article-display-face
3496      article-de-quoted-unreadable
3497      article-de-base64-unreadable
3498      article-decode-HZ
3499      article-wash-html
3500      article-unsplit-urls
3501      article-hide-list-identifiers
3502      article-strip-banner
3503      article-babel
3504      article-hide-pem
3505      article-hide-signature
3506      article-strip-headers-in-body
3507      article-remove-trailing-blank-lines
3508      article-strip-leading-blank-lines
3509      article-strip-multiple-blank-lines
3510      article-strip-leading-space
3511      article-strip-trailing-space
3512      article-strip-blank-lines
3513      article-strip-all-blank-lines
3514      article-date-local
3515      article-date-english
3516      article-date-iso8601
3517      article-date-original
3518      article-date-ut
3519      article-decode-mime-words
3520      article-decode-charset
3521      article-decode-encoded-words
3522      article-date-user
3523      article-date-lapsed
3524      article-emphasize
3525      article-treat-dumbquotes
3526      article-normalize-headers
3527 ;;     (article-show-all . gnus-article-show-all-headers)
3528      )))
3529 \f
3530 ;;;
3531 ;;; Gnus article mode
3532 ;;;
3533
3534 (put 'gnus-article-mode 'mode-class 'special)
3535
3536 (set-keymap-parent gnus-article-mode-map widget-keymap)
3537
3538 (gnus-define-keys gnus-article-mode-map
3539   " " gnus-article-goto-next-page
3540   "\177" gnus-article-goto-prev-page
3541   [delete] gnus-article-goto-prev-page
3542   [backspace] gnus-article-goto-prev-page
3543   "\C-c^" gnus-article-refer-article
3544   "h" gnus-article-show-summary
3545   "s" gnus-article-show-summary
3546   "\C-c\C-m" gnus-article-mail
3547   "?" gnus-article-describe-briefly
3548   "e" gnus-summary-edit-article
3549   "<" beginning-of-buffer
3550   ">" end-of-buffer
3551   "\C-c\C-i" gnus-info-find-node
3552   "\C-c\C-b" gnus-bug
3553   "R" gnus-article-reply-with-original
3554   "F" gnus-article-followup-with-original
3555   "\C-hk" gnus-article-describe-key
3556   "\C-hc" gnus-article-describe-key-briefly
3557
3558   "\C-d" gnus-article-read-summary-keys
3559   "\M-*" gnus-article-read-summary-keys
3560   "\M-#" gnus-article-read-summary-keys
3561   "\M-^" gnus-article-read-summary-keys
3562   "\M-g" gnus-article-read-summary-keys)
3563
3564 (substitute-key-definition
3565  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
3566
3567 (defun gnus-article-make-menu-bar ()
3568   (unless (boundp 'gnus-article-commands-menu)
3569     (gnus-summary-make-menu-bar))
3570   (gnus-turn-off-edit-menu 'article)
3571   (unless (boundp 'gnus-article-article-menu)
3572     (easy-menu-define
3573      gnus-article-article-menu gnus-article-mode-map ""
3574      '("Article"
3575        ["Scroll forwards" gnus-article-goto-next-page t]
3576        ["Scroll backwards" gnus-article-goto-prev-page t]
3577        ["Show summary" gnus-article-show-summary t]
3578        ["Fetch Message-ID at point" gnus-article-refer-article t]
3579        ["Mail to address at point" gnus-article-mail t]
3580        ["Send a bug report" gnus-bug t]))
3581
3582     (easy-menu-define
3583      gnus-article-treatment-menu gnus-article-mode-map ""
3584      ;; Fixme: this should use :active (and maybe :visible).
3585      '("Treatment"
3586        ["Hide headers" gnus-article-hide-headers t]
3587        ["Hide signature" gnus-article-hide-signature t]
3588        ["Hide citation" gnus-article-hide-citation t]
3589        ["Treat overstrike" gnus-article-treat-overstrike t]
3590        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
3591        ["Remove carriage return" gnus-article-remove-cr t]
3592        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
3593        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
3594        ["Remove base64" gnus-article-de-base64-unreadable t]
3595        ["Treat html" gnus-article-wash-html t]
3596        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
3597        ["Decode HZ" gnus-article-decode-HZ t]))
3598
3599     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
3600
3601     ;; Note "Post" menu is defined in gnus-sum.el for consistency
3602
3603     (gnus-run-hooks 'gnus-article-menu-hook)))
3604
3605 (defun gnus-article-mode ()
3606   "Major mode for displaying an article.
3607
3608 All normal editing commands are switched off.
3609
3610 The following commands are available in addition to all summary mode
3611 commands:
3612 \\<gnus-article-mode-map>
3613 \\[gnus-article-next-page]\t Scroll the article one page forwards
3614 \\[gnus-article-prev-page]\t Scroll the article one page backwards
3615 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
3616 \\[gnus-article-show-summary]\t Display the summary buffer
3617 \\[gnus-article-mail]\t Send a reply to the address near point
3618 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
3619 \\[gnus-info-find-node]\t Go to the Gnus info node"
3620   (interactive)
3621   (gnus-simplify-mode-line)
3622   (setq mode-name "Article")
3623   (setq major-mode 'gnus-article-mode)
3624   (make-local-variable 'minor-mode-alist)
3625   (use-local-map gnus-article-mode-map)
3626   (when (gnus-visual-p 'article-menu 'menu)
3627     (gnus-article-make-menu-bar)
3628     (when gnus-summary-tool-bar-map
3629       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
3630   (gnus-update-format-specifications nil 'article-mode)
3631   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
3632   (set (make-local-variable 'gnus-page-broken) nil)
3633   (make-local-variable 'gnus-button-marker-list)
3634   (make-local-variable 'gnus-article-current-summary)
3635   (make-local-variable 'gnus-article-mime-handles)
3636   (make-local-variable 'gnus-article-decoded-p)
3637   (make-local-variable 'gnus-article-mime-handle-alist)
3638   (make-local-variable 'gnus-article-wash-types)
3639   (make-local-variable 'gnus-article-image-alist)
3640   (make-local-variable 'gnus-article-charset)
3641   (make-local-variable 'gnus-article-ignored-charsets)
3642   (gnus-set-default-directory)
3643   (buffer-disable-undo)
3644   (setq buffer-read-only t)
3645   (set-syntax-table gnus-article-mode-syntax-table)
3646   (mm-enable-multibyte)
3647   (gnus-run-hooks 'gnus-article-mode-hook))
3648
3649 (defun gnus-article-setup-buffer ()
3650   "Initialize the article buffer."
3651   (let* ((name (if gnus-single-article-buffer "*Article*"
3652                  (concat "*Article " gnus-newsgroup-name "*")))
3653          (original
3654           (progn (string-match "\\*Article" name)
3655                  (concat " *Original Article"
3656                          (substring name (match-end 0))))))
3657     (setq gnus-article-buffer name)
3658     (setq gnus-original-article-buffer original)
3659     (setq gnus-article-mime-handle-alist nil)
3660     ;; This might be a variable local to the summary buffer.
3661     (unless gnus-single-article-buffer
3662       (save-excursion
3663         (set-buffer gnus-summary-buffer)
3664         (setq gnus-article-buffer name)
3665         (setq gnus-original-article-buffer original)
3666         (gnus-set-global-variables)))
3667     (gnus-article-setup-highlight-words)
3668     ;; Init original article buffer.
3669     (save-excursion
3670       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
3671       (mm-enable-multibyte)
3672       (setq major-mode 'gnus-original-article-mode)
3673       (make-local-variable 'gnus-original-article))
3674     (if (get-buffer name)
3675         (save-excursion
3676           (set-buffer name)
3677           (when (and gnus-article-edit-mode
3678                      (buffer-modified-p)
3679                      (not
3680                       (y-or-n-p "Article mode edit in progress; discard? ")))
3681             (error "Action aborted"))
3682           (set (make-local-variable 'gnus-article-edit-mode) nil)
3683           (when gnus-article-mime-handles
3684             (mm-destroy-parts gnus-article-mime-handles)
3685             (setq gnus-article-mime-handles nil))
3686           ;; Set it to nil in article-buffer!
3687           (setq gnus-article-mime-handle-alist nil)
3688           (buffer-disable-undo)
3689           (setq buffer-read-only t)
3690           ;; This list just keeps growing if we don't reset it.
3691           (setq gnus-button-marker-list nil)
3692           (unless (eq major-mode 'gnus-article-mode)
3693             (gnus-article-mode))
3694           (current-buffer))
3695       (save-excursion
3696         (set-buffer (gnus-get-buffer-create name))
3697         (gnus-article-mode)
3698         (make-local-variable 'gnus-summary-buffer)
3699         (gnus-summary-set-local-parameters gnus-newsgroup-name)
3700         (current-buffer)))))
3701
3702 ;; Set article window start at LINE, where LINE is the number of lines
3703 ;; from the head of the article.
3704 (defun gnus-article-set-window-start (&optional line)
3705   (set-window-start
3706    (gnus-get-buffer-window gnus-article-buffer t)
3707    (save-excursion
3708      (set-buffer gnus-article-buffer)
3709      (goto-char (point-min))
3710      (if (not line)
3711          (point-min)
3712        (gnus-message 6 "Moved to bookmark")
3713        (search-forward "\n\n" nil t)
3714        (forward-line line)
3715        (point)))))
3716
3717 (defun gnus-article-prepare (article &optional all-headers header)
3718   "Prepare ARTICLE in article mode buffer.
3719 ARTICLE should either be an article number or a Message-ID.
3720 If ARTICLE is an id, HEADER should be the article headers.
3721 If ALL-HEADERS is non-nil, no headers are hidden."
3722   (save-excursion
3723     ;; Make sure we start in a summary buffer.
3724     (unless (eq major-mode 'gnus-summary-mode)
3725       (set-buffer gnus-summary-buffer))
3726     (setq gnus-summary-buffer (current-buffer))
3727     (let* ((gnus-article (if header (mail-header-number header) article))
3728            (summary-buffer (current-buffer))
3729            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
3730            (group gnus-newsgroup-name)
3731            result)
3732       (save-excursion
3733         (gnus-article-setup-buffer)
3734         (set-buffer gnus-article-buffer)
3735         ;; Deactivate active regions.
3736         (when (and (boundp 'transient-mark-mode)
3737                    transient-mark-mode)
3738           (setq mark-active nil))
3739         (if (not (setq result (let ((buffer-read-only nil))
3740                                 (gnus-request-article-this-buffer
3741                                  article group))))
3742             ;; There is no such article.
3743             (save-excursion
3744               (when (and (numberp article)
3745                          (not (memq article gnus-newsgroup-sparse)))
3746                 (setq gnus-article-current
3747                       (cons gnus-newsgroup-name article))
3748                 (set-buffer gnus-summary-buffer)
3749                 (setq gnus-current-article article)
3750                 (if (and (memq article gnus-newsgroup-undownloaded)
3751                          (not (gnus-online (gnus-find-method-for-group
3752                                             gnus-newsgroup-name))))
3753                     (progn
3754                       (gnus-summary-set-agent-mark article)
3755                       (message "Message marked for downloading"))
3756                   (gnus-summary-mark-article article gnus-canceled-mark)
3757                   (unless (memq article gnus-newsgroup-sparse)
3758                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
3759           (if (or (eq result 'pseudo)
3760                   (eq result 'nneething))
3761               (progn
3762                 (save-excursion
3763                   (set-buffer summary-buffer)
3764                   (push article gnus-newsgroup-history)
3765                   (setq gnus-last-article gnus-current-article
3766                         gnus-current-article 0
3767                         gnus-current-headers nil
3768                         gnus-article-current nil)
3769                   (if (eq result 'nneething)
3770                       (gnus-configure-windows 'summary)
3771                     (gnus-configure-windows 'article))
3772                   (gnus-set-global-variables))
3773                 (let ((gnus-article-mime-handle-alist-1
3774                        gnus-article-mime-handle-alist))
3775                   (gnus-set-mode-line 'article)))
3776             ;; The result from the `request' was an actual article -
3777             ;; or at least some text that is now displayed in the
3778             ;; article buffer.
3779             (when (and (numberp article)
3780                        (not (eq article gnus-current-article)))
3781               ;; Seems like a new article has been selected.
3782               ;; `gnus-current-article' must be an article number.
3783               (save-excursion
3784                 (set-buffer summary-buffer)
3785                 (push article gnus-newsgroup-history)
3786                 (setq gnus-last-article gnus-current-article
3787                       gnus-current-article article
3788                       gnus-current-headers
3789                       (gnus-summary-article-header gnus-current-article)
3790                       gnus-article-current
3791                       (cons gnus-newsgroup-name gnus-current-article))
3792                 (unless (vectorp gnus-current-headers)
3793                   (setq gnus-current-headers nil))
3794                 (gnus-summary-goto-subject gnus-current-article)
3795                 (when (gnus-summary-show-thread)
3796                   ;; If the summary buffer really was folded, the
3797                   ;; previous goto may not actually have gone to
3798                   ;; the right article, but the thread root instead.
3799                   ;; So we go again.
3800                   (gnus-summary-goto-subject gnus-current-article))
3801                 (gnus-run-hooks 'gnus-mark-article-hook)
3802                 (gnus-set-mode-line 'summary)
3803                 (when (gnus-visual-p 'article-highlight 'highlight)
3804                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
3805                 ;; Set the global newsgroup variables here.
3806                 (gnus-set-global-variables)
3807                 (setq gnus-have-all-headers
3808                       (or all-headers gnus-show-all-headers))))
3809             (save-excursion
3810               (gnus-configure-windows 'article))
3811             (when (or (numberp article)
3812                       (stringp article))
3813               (gnus-article-prepare-display)
3814               ;; Do page break.
3815               (goto-char (point-min))
3816               (when gnus-break-pages
3817                 (gnus-narrow-to-page)))
3818             (let ((gnus-article-mime-handle-alist-1
3819                    gnus-article-mime-handle-alist))
3820               (gnus-set-mode-line 'article))
3821             (article-goto-body)
3822             (unless (bobp)
3823               (forward-line -1))
3824             (set-window-point (get-buffer-window (current-buffer)) (point))
3825             (gnus-configure-windows 'article)
3826             t))))))
3827
3828 ;;;###autoload
3829 (defun gnus-article-prepare-display ()
3830   "Make the current buffer look like a nice article."
3831   ;; Hooks for getting information from the article.
3832   ;; This hook must be called before being narrowed.
3833   (let ((gnus-article-buffer (current-buffer))
3834         buffer-read-only)
3835     (unless (eq major-mode 'gnus-article-mode)
3836       (gnus-article-mode))
3837     (setq buffer-read-only nil
3838           gnus-article-wash-types nil
3839           gnus-article-image-alist nil)
3840     (gnus-run-hooks 'gnus-tmp-internal-hook)
3841     (when gnus-display-mime-function
3842       (funcall gnus-display-mime-function))
3843     (gnus-run-hooks 'gnus-article-prepare-hook)))
3844
3845 ;;;
3846 ;;; Gnus MIME viewing functions
3847 ;;;
3848
3849 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
3850   "Format of the MIME buttons.
3851
3852 Valid specifiers include:
3853 %t  The MIME type
3854 %T  MIME type, along with additional info
3855 %n  The `name' parameter
3856 %d  The description, if any
3857 %l  The length of the encoded part
3858 %p  The part identifier number
3859 %e  Dots if the part isn't displayed
3860
3861 General format specifiers can also be used.  See Info node
3862 `(gnus)Formatting Variables'.")
3863
3864 (defvar gnus-mime-button-line-format-alist
3865   '((?t gnus-tmp-type ?s)
3866     (?T gnus-tmp-type-long ?s)
3867     (?n gnus-tmp-name ?s)
3868     (?d gnus-tmp-description ?s)
3869     (?p gnus-tmp-id ?s)
3870     (?l gnus-tmp-length ?d)
3871     (?e gnus-tmp-dots ?s)))
3872
3873 (defvar gnus-mime-button-commands
3874   '((gnus-article-press-button "\r" "Toggle Display")
3875     (gnus-mime-view-part "v" "View Interactively...")
3876     (gnus-mime-view-part-as-type "t" "View As Type...")
3877     (gnus-mime-view-part-as-charset "C" "View As charset...")
3878     (gnus-mime-save-part "o" "Save...")
3879     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
3880     (gnus-mime-delete-part "d" "Delete part")
3881     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
3882     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
3883     (gnus-mime-view-part-internally "E" "View Internally")
3884     (gnus-mime-view-part-externally "e" "View Externally")
3885     (gnus-mime-print-part "p" "Print")
3886     (gnus-mime-pipe-part "|" "Pipe To Command...")
3887     (gnus-mime-action-on-part "." "Take action on the part...")))
3888
3889 (defun gnus-article-mime-part-status ()
3890   (if gnus-article-mime-handle-alist-1
3891       (if (eq 1 (length gnus-article-mime-handle-alist-1))
3892           " (1 part)"
3893         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
3894     ""))
3895
3896 (defvar gnus-mime-button-map
3897   (let ((map (make-sparse-keymap)))
3898     (define-key map gnus-mouse-2 'gnus-article-push-button)
3899     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
3900     (dolist (c gnus-mime-button-commands)
3901       (define-key map (cadr c) (car c)))
3902     map))
3903
3904 (easy-menu-define
3905   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
3906   `("MIME Part"
3907     ,@(mapcar (lambda (c)
3908                 (vector (caddr c) (car c) :enable t))
3909               gnus-mime-button-commands)))
3910
3911 (defun gnus-mime-button-menu (event prefix)
3912  "Construct a context-sensitive menu of MIME commands."
3913  (interactive "e\nP")
3914  (save-window-excursion
3915    (let ((pos (event-start event)))
3916      (select-window (posn-window pos))
3917      (goto-char (posn-point pos))
3918      (gnus-article-check-buffer)
3919      (popup-menu gnus-mime-button-menu nil prefix))))
3920
3921 (defun gnus-mime-view-all-parts (&optional handles)
3922   "View all the MIME parts."
3923   (interactive)
3924   (with-current-buffer gnus-article-buffer
3925     (let ((handles (or handles gnus-article-mime-handles))
3926           (mail-parse-charset gnus-newsgroup-charset)
3927           (mail-parse-ignored-charsets
3928            (with-current-buffer gnus-summary-buffer
3929              gnus-newsgroup-ignored-charsets)))
3930       (when handles
3931         (mm-remove-parts handles)
3932         (goto-char (point-min))
3933         (or (search-forward "\n\n") (goto-char (point-max)))
3934         (let (buffer-read-only)
3935           (delete-region (point) (point-max))
3936           (mm-display-parts handles))))))
3937
3938 (eval-when-compile
3939   (defsubst gnus-article-edit-part (handles)
3940     "Edit an article in order to delete a mime part.
3941 This function is exclusively used by `gnus-mime-save-part-and-strip'
3942 and `gnus-mime-delete-part', and not provided at run-time normally."
3943     (gnus-article-edit-article
3944      `(lambda ()
3945         (erase-buffer)
3946         (let ((mail-parse-charset (or gnus-article-charset
3947                                       ',gnus-newsgroup-charset))
3948               (mail-parse-ignored-charsets
3949                (or gnus-article-ignored-charsets
3950                    ',gnus-newsgroup-ignored-charsets))
3951               (mbl mml-buffer-list))
3952           (setq mml-buffer-list nil)
3953           (insert-buffer gnus-original-article-buffer)
3954           (mime-to-mml ',handles)
3955           (setq gnus-article-mime-handles nil)
3956           (let ((mbl1 mml-buffer-list))
3957             (setq mml-buffer-list mbl)
3958             (set (make-local-variable 'mml-buffer-list) mbl1))
3959           (gnus-make-local-hook 'kill-buffer-hook)
3960           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
3961      `(lambda (no-highlight)
3962         (let ((mail-parse-charset (or gnus-article-charset
3963                                       ',gnus-newsgroup-charset))
3964               (message-options message-options)
3965               (message-options-set-recipient)
3966               (mail-parse-ignored-charsets
3967                (or gnus-article-ignored-charsets
3968                    ',gnus-newsgroup-ignored-charsets)))
3969           (mml-to-mime)
3970           (mml-destroy-buffers)
3971           (remove-hook 'kill-buffer-hook
3972                        'mml-destroy-buffers t)
3973           (kill-local-variable 'mml-buffer-list))
3974         (gnus-summary-edit-article-done
3975          ,(or (mail-header-references gnus-current-headers) "")
3976          ,(gnus-group-read-only-p)
3977          ,gnus-summary-buffer no-highlight)))
3978     (gnus-article-edit-done)
3979     (gnus-summary-expand-window)
3980     (gnus-summary-show-article)))
3981
3982 (defun gnus-mime-save-part-and-strip ()
3983   "Save the MIME part under point then replace it with an external body."
3984   (interactive)
3985   (gnus-article-check-buffer)
3986   (when (gnus-group-read-only-p)
3987     (error "The current group does not support deleting of parts"))
3988   (when (mm-complicated-handles gnus-article-mime-handles)
3989     (error "\
3990 The current article has a complicated MIME structure, giving up..."))
3991   (when (gnus-yes-or-no-p "\
3992 Deleting parts may malfunction or destroy the article; continue? ")
3993     (let* ((data (get-text-property (point) 'gnus-data))
3994            file param
3995            (handles gnus-article-mime-handles))
3996       (setq file (and data (mm-save-part data)))
3997       (when file
3998         (with-current-buffer (mm-handle-buffer data)
3999           (erase-buffer)
4000           (insert "Content-Type: " (mm-handle-media-type data))
4001           (mml-insert-parameter-string (cdr (mm-handle-type data))
4002                                        '(charset))
4003           (insert "\n")
4004           (insert "Content-ID: " (message-make-message-id) "\n")
4005           (insert "Content-Transfer-Encoding: binary\n")
4006           (insert "\n"))
4007         (setcdr data
4008                 (cdr (mm-make-handle nil
4009                                      `("message/external-body"
4010                                        (access-type . "LOCAL-FILE")
4011                                        (name . ,file)))))
4012         (set-buffer gnus-summary-buffer)
4013         (gnus-article-edit-part handles)))))
4014
4015 (defun gnus-mime-delete-part ()
4016   "Delete the MIME part under point.
4017 Replace it with some information about the removed part."
4018   (interactive)
4019   (gnus-article-check-buffer)
4020   (when (gnus-group-read-only-p)
4021     (error "The current group does not support deleting of parts"))
4022   (when (mm-complicated-handles gnus-article-mime-handles)
4023     (error "\
4024 The current article has a complicated MIME structure, giving up..."))
4025   (when (gnus-yes-or-no-p "\
4026 Deleting parts may malfunction or destroy the article; continue? ")
4027     (let* ((data (get-text-property (point) 'gnus-data))
4028            (handles gnus-article-mime-handles)
4029            (none "(none)")
4030            (description
4031             (or
4032              (mail-decode-encoded-word-string (or (mm-handle-description data)
4033                                                   none))))
4034            (filename
4035             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4036                 none))
4037            (type (mm-handle-media-type data)))
4038       (with-current-buffer (mm-handle-buffer data)
4039         (let ((bsize (format "%s" (buffer-size))))
4040           (erase-buffer)
4041           (insert
4042            (concat
4043             ",----\n"
4044             "| The following attachment has been deleted:\n"
4045             "|\n"
4046             "| Type:           " type "\n"
4047             "| Filename:       " filename "\n"
4048             "| Size (encoded): " bsize " Byte\n"
4049             "| Description:    " description "\n"
4050             "`----\n"))
4051           (setcdr data
4052                   (cdr (mm-make-handle
4053                         nil `("text/plain") nil nil
4054                         (list "attachment")
4055                         (format "Deleted attachment (%s bytes)" bsize))))))
4056       (set-buffer gnus-summary-buffer)
4057       (gnus-article-edit-part handles))))
4058
4059 (defun gnus-mime-save-part ()
4060   "Save the MIME part under point."
4061   (interactive)
4062   (gnus-article-check-buffer)
4063   (let ((data (get-text-property (point) 'gnus-data)))
4064     (when data
4065       (mm-save-part data))))
4066
4067 (defun gnus-mime-pipe-part ()
4068   "Pipe the MIME part under point to a process."
4069   (interactive)
4070   (gnus-article-check-buffer)
4071   (let ((data (get-text-property (point) 'gnus-data)))
4072     (when data
4073       (mm-pipe-part data))))
4074
4075 (defun gnus-mime-view-part ()
4076   "Interactively choose a viewing method for the MIME part under point."
4077   (interactive)
4078   (gnus-article-check-buffer)
4079   (let ((data (get-text-property (point) 'gnus-data)))
4080     (when data
4081       (setq gnus-article-mime-handles
4082             (mm-merge-handles
4083              gnus-article-mime-handles (setq data (copy-sequence data))))
4084       (mm-interactively-view-part data))))
4085
4086 (defun gnus-mime-view-part-as-type-internal ()
4087   (gnus-article-check-buffer)
4088   (let* ((name (mail-content-type-get
4089                 (mm-handle-type (get-text-property (point) 'gnus-data))
4090                 'name))
4091          (def-type (and name (mm-default-file-encoding name))))
4092     (and def-type (cons def-type 0))))
4093
4094 (defun gnus-mime-view-part-as-type (&optional mime-type)
4095   "Choose a MIME media type, and view the part as such."
4096   (interactive)
4097   (unless mime-type
4098     (setq mime-type (completing-read
4099                      "View as MIME type: "
4100                      (mapcar #'list (mailcap-mime-types))
4101                      nil nil
4102                      (gnus-mime-view-part-as-type-internal))))
4103   (gnus-article-check-buffer)
4104   (let ((handle (get-text-property (point) 'gnus-data)))
4105     (when handle
4106       (setq handle
4107             (mm-make-handle (mm-handle-buffer handle)
4108                             (cons mime-type (cdr (mm-handle-type handle)))
4109                             (mm-handle-encoding handle)
4110                             (mm-handle-undisplayer handle)
4111                             (mm-handle-disposition handle)
4112                             (mm-handle-description handle)
4113                             nil
4114                             (mm-handle-id handle)))
4115       (setq gnus-article-mime-handles
4116             (mm-merge-handles gnus-article-mime-handles handle))
4117       (gnus-mm-display-part handle))))
4118
4119 (eval-when-compile
4120   (require 'jka-compr))
4121
4122 ;; jka-compr.el uses a "sh -c" to direct stderr to err-file, but these days
4123 ;; emacs can do that itself.
4124 ;;
4125 (defun gnus-mime-jka-compr-maybe-uncompress ()
4126   "Uncompress the current buffer if `auto-compression-mode' is enabled.
4127 The uncompress method used is derived from `buffer-file-name'."
4128   (when (and (fboundp 'jka-compr-installed-p)
4129              (jka-compr-installed-p))
4130     (let ((info (jka-compr-get-compression-info buffer-file-name)))
4131       (when info
4132         (let ((basename (file-name-nondirectory buffer-file-name))
4133               (args     (jka-compr-info-uncompress-args    info))
4134               (prog     (jka-compr-info-uncompress-program info))
4135               (message  (jka-compr-info-uncompress-message info))
4136               (err-file (jka-compr-make-temp-name)))
4137           (if message
4138               (message "%s %s..." message basename))
4139           (unwind-protect
4140               (unless (memq (apply 'call-process-region
4141                                    (point-min) (point-max)
4142                                    prog
4143                                    t (list t err-file) nil
4144                                    args)
4145                             jka-compr-acceptable-retval-list)
4146                 (jka-compr-error prog args basename message err-file))
4147             (jka-compr-delete-temp-file err-file)))))))
4148
4149 (defun gnus-mime-copy-part (&optional handle)
4150   "Put the MIME part under point into a new buffer.
4151 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4152 are decompressed."
4153   (interactive)
4154   (gnus-article-check-buffer)
4155   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4156          (contents (and handle (mm-get-part handle)))
4157          (base (and handle
4158                     (file-name-nondirectory
4159                      (or
4160                       (mail-content-type-get (mm-handle-type handle) 'name)
4161                       (mail-content-type-get (mm-handle-disposition handle)
4162                                              'filename)
4163                       "*decoded*"))))
4164          (buffer (and base (generate-new-buffer base))))
4165     (when contents
4166       (switch-to-buffer buffer)
4167       (insert contents)
4168       ;; We do it this way to make `normal-mode' set the appropriate mode.
4169       (unwind-protect
4170           (progn
4171             (setq buffer-file-name (expand-file-name base))
4172             (gnus-mime-jka-compr-maybe-uncompress)
4173             (normal-mode))
4174         (setq buffer-file-name nil))
4175       (goto-char (point-min)))))
4176
4177 (defun gnus-mime-print-part (&optional handle filename)
4178   "Print the MIME part under point."
4179   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4180   (gnus-article-check-buffer)
4181   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4182          (contents (and handle (mm-get-part handle)))
4183          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4184          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4185     (when contents
4186         (if printer
4187             (unwind-protect
4188                 (progn
4189                   (mm-save-part-to-file handle file)
4190                   (call-process shell-file-name nil
4191                                 (generate-new-buffer " *mm*")
4192                                 nil
4193                                 shell-command-switch
4194                                 (mm-mailcap-command
4195                                  printer file (mm-handle-type handle))))
4196               (delete-file file))
4197           (with-temp-buffer
4198             (insert contents)
4199             (gnus-print-buffer))
4200           (ps-despool filename)))))
4201
4202 (defun gnus-mime-inline-part (&optional handle arg)
4203   "Insert the MIME part under point into the current buffer."
4204   (interactive (list nil current-prefix-arg))
4205   (gnus-article-check-buffer)
4206   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4207          contents charset
4208          (b (point))
4209          buffer-read-only)
4210     (when handle
4211       (if (and (not arg) (mm-handle-undisplayer handle))
4212           (mm-remove-part handle)
4213         (setq contents (mm-get-part handle))
4214         (cond
4215          ((not arg)
4216           (setq charset (or (mail-content-type-get
4217                              (mm-handle-type handle) 'charset)
4218                             gnus-newsgroup-charset)))
4219          ((numberp arg)
4220           (if (mm-handle-undisplayer handle)
4221               (mm-remove-part handle))
4222           (setq charset
4223                 (or (cdr (assq arg
4224                                gnus-summary-show-article-charset-alist))
4225                     (mm-read-coding-system "Charset: ")))))
4226         (forward-line 2)
4227         (mm-insert-inline handle
4228                           (if (and charset
4229                                    (setq charset (mm-charset-to-coding-system
4230                                                   charset))
4231                                    (not (eq charset 'ascii)))
4232                               (mm-decode-coding-string contents charset)
4233                             contents))
4234         (goto-char b)))))
4235
4236 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4237   "Insert the MIME part under point into the current buffer using the
4238 specified charset."
4239   (interactive (list nil current-prefix-arg))
4240   (gnus-article-check-buffer)
4241   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4242          contents charset
4243          (b (point))
4244          buffer-read-only)
4245     (when handle
4246       (if (mm-handle-undisplayer handle)
4247           (mm-remove-part handle))
4248       (let ((gnus-newsgroup-charset
4249              (or (cdr (assq arg
4250                             gnus-summary-show-article-charset-alist))
4251                  (mm-read-coding-system "Charset: ")))
4252           (gnus-newsgroup-ignored-charsets 'gnus-all))
4253         (gnus-article-press-button)))))
4254
4255 (defun gnus-mime-view-part-externally (&optional handle)
4256   "View the MIME part under point with an external viewer."
4257   (interactive)
4258   (gnus-article-check-buffer)
4259   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4260          (mm-user-display-methods nil)
4261          (mm-inlined-types nil)
4262          (mail-parse-charset gnus-newsgroup-charset)
4263          (mail-parse-ignored-charsets
4264           (with-current-buffer gnus-summary-buffer
4265             gnus-newsgroup-ignored-charsets)))
4266     (when handle
4267       (if (mm-handle-undisplayer handle)
4268           (mm-remove-part handle)
4269         (mm-display-part handle)))))
4270
4271 (defun gnus-mime-view-part-internally (&optional handle)
4272   "View the MIME part under point with an internal viewer.
4273 If no internal viewer is available, use an external viewer."
4274   (interactive)
4275   (gnus-article-check-buffer)
4276   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4277          (mm-inlined-types '(".*"))
4278          (mm-inline-large-images t)
4279          (mail-parse-charset gnus-newsgroup-charset)
4280          (mail-parse-ignored-charsets
4281           (with-current-buffer gnus-summary-buffer
4282             gnus-newsgroup-ignored-charsets))
4283          buffer-read-only)
4284     (when handle
4285       (if (mm-handle-undisplayer handle)
4286           (mm-remove-part handle)
4287         (mm-display-part handle)))))
4288
4289 (defun gnus-mime-action-on-part (&optional action)
4290   "Do something with the MIME attachment at \(point\)."
4291   (interactive
4292    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
4293   (gnus-article-check-buffer)
4294   (let ((action-pair (assoc action gnus-mime-action-alist)))
4295     (if action-pair
4296         (funcall (cdr action-pair)))))
4297
4298 (defun gnus-article-part-wrapper (n function)
4299   (with-current-buffer gnus-article-buffer
4300     (when (> n (length gnus-article-mime-handle-alist))
4301       (error "No such part"))
4302     (gnus-article-goto-part n)
4303     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4304       (funcall function handle))))
4305
4306 (defun gnus-article-pipe-part (n)
4307   "Pipe MIME part N, which is the numerical prefix."
4308   (interactive "p")
4309   (gnus-article-part-wrapper n 'mm-pipe-part))
4310
4311 (defun gnus-article-save-part (n)
4312   "Save MIME part N, which is the numerical prefix."
4313   (interactive "p")
4314   (gnus-article-part-wrapper n 'mm-save-part))
4315
4316 (defun gnus-article-interactively-view-part (n)
4317   "View MIME part N interactively, which is the numerical prefix."
4318   (interactive "p")
4319   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4320
4321 (defun gnus-article-copy-part (n)
4322   "Copy MIME part N, which is the numerical prefix."
4323   (interactive "p")
4324   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4325
4326 (defun gnus-article-view-part-as-charset (n)
4327   "View MIME part N using a specified charset.
4328 N is the numerical prefix."
4329   (interactive "p")
4330   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4331
4332 (defun gnus-article-view-part-externally (n)
4333   "View MIME part N externally, which is the numerical prefix."
4334   (interactive "p")
4335   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4336
4337 (defun gnus-article-inline-part (n)
4338   "Inline MIME part N, which is the numerical prefix."
4339   (interactive "p")
4340   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4341
4342 (defun gnus-article-mime-match-handle-first (condition)
4343   (if condition
4344       (let ((alist gnus-article-mime-handle-alist) ihandle n)
4345         (while (setq ihandle (pop alist))
4346           (if (and (cond
4347                     ((functionp condition)
4348                      (funcall condition (cdr ihandle)))
4349                     ((eq condition 'undisplayed)
4350                      (not (or (mm-handle-undisplayer (cdr ihandle))
4351                               (equal (mm-handle-media-type (cdr ihandle))
4352                                      "multipart/alternative"))))
4353                     ((eq condition 'undisplayed-alternative)
4354                      (not (mm-handle-undisplayer (cdr ihandle))))
4355                     (t t))
4356                    (gnus-article-goto-part (car ihandle))
4357                    (or (not n) (< (car ihandle) n)))
4358               (setq n (car ihandle))))
4359         (or n 1))
4360     1))
4361
4362 (defun gnus-article-view-part (&optional n)
4363   "View MIME part N, which is the numerical prefix."
4364   (interactive "P")
4365   (with-current-buffer gnus-article-buffer
4366     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4367                              gnus-article-mime-match-handle-function)))
4368     (when (> n (length gnus-article-mime-handle-alist))
4369       (error "No such part"))
4370     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4371       (when (gnus-article-goto-part n)
4372         (if (equal (car handle) "multipart/alternative")
4373             (gnus-article-press-button)
4374           (when (eq (gnus-mm-display-part handle) 'internal)
4375             (gnus-set-window-start)))))))
4376
4377 (defsubst gnus-article-mime-total-parts ()
4378   (if (bufferp (car gnus-article-mime-handles))
4379       1 ;; single part
4380     (1- (length gnus-article-mime-handles))))
4381
4382 (defun gnus-mm-display-part (handle)
4383   "Display HANDLE and fix MIME button."
4384   (let ((id (get-text-property (point) 'gnus-part))
4385         (point (point))
4386         buffer-read-only)
4387     (forward-line 1)
4388     (prog1
4389         (let ((window (selected-window))
4390               (mail-parse-charset gnus-newsgroup-charset)
4391               (mail-parse-ignored-charsets
4392                (if (gnus-buffer-live-p gnus-summary-buffer)
4393                    (with-current-buffer gnus-summary-buffer
4394                      gnus-newsgroup-ignored-charsets)
4395                  nil)))
4396           (save-excursion
4397             (unwind-protect
4398                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4399                       (beg (point)))
4400                   (when win
4401                     (select-window win))
4402                   (goto-char point)
4403                   (forward-line)
4404                   (if (mm-handle-displayed-p handle)
4405                       ;; This will remove the part.
4406                       (mm-display-part handle)
4407                     (save-restriction
4408                       (narrow-to-region (point)
4409                                         (if (eobp) (point) (1+ (point))))
4410                       (mm-display-part handle)
4411                       ;; We narrow to the part itself and
4412                       ;; then call the treatment functions.
4413                       (goto-char (point-min))
4414                       (forward-line 1)
4415                       (narrow-to-region (point) (point-max))
4416                       (gnus-treat-article
4417                        nil id
4418                        (gnus-article-mime-total-parts)
4419                        (mm-handle-media-type handle)))))
4420               (if (window-live-p window)
4421                   (select-window window)))))
4422       (goto-char point)
4423       (gnus-delete-line)
4424       (gnus-insert-mime-button
4425        handle id (list (mm-handle-displayed-p handle)))
4426       (goto-char point))))
4427
4428 (defun gnus-article-goto-part (n)
4429   "Go to MIME part N."
4430   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
4431
4432 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4433   (let ((gnus-tmp-name
4434          (or (mail-content-type-get (mm-handle-type handle) 'name)
4435              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4436              (mail-content-type-get (mm-handle-type handle) 'url)
4437              ""))
4438         (gnus-tmp-type (mm-handle-media-type handle))
4439         (gnus-tmp-description
4440          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4441                                               "")))
4442         (gnus-tmp-dots
4443          (if (if displayed (car displayed)
4444                (mm-handle-displayed-p handle))
4445              "" "..."))
4446         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4447                            (buffer-size)))
4448         gnus-tmp-type-long b e)
4449     (when (string-match ".*/" gnus-tmp-name)
4450       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4451     (setq gnus-tmp-type-long (concat gnus-tmp-type
4452                                      (and (not (equal gnus-tmp-name ""))
4453                                           (concat "; " gnus-tmp-name))))
4454     (unless (equal gnus-tmp-description "")
4455       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4456     (unless (bolp)
4457       (insert "\n"))
4458     (setq b (point))
4459     (gnus-eval-format
4460      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4461      `(keymap ,gnus-mime-button-map
4462               gnus-callback gnus-mm-display-part
4463               gnus-part ,gnus-tmp-id
4464               article-type annotation
4465               gnus-data ,handle))
4466     (setq e (if (bolp)
4467                 ;; Exclude a newline.
4468                 (1- (point))
4469               (point)))
4470     (widget-convert-button
4471      'link b e
4472      :mime-handle handle
4473      :action 'gnus-widget-press-button
4474      :button-keymap gnus-mime-button-map
4475      :help-echo
4476      (lambda (widget/window &optional overlay pos)
4477        ;; Needed to properly clear the message due to a bug in
4478        ;; wid-edit (XEmacs only).
4479        (if (boundp 'help-echo-owns-message)
4480            (setq help-echo-owns-message t))
4481        (format
4482         "%S: %s the MIME part; %S: more options"
4483         (aref gnus-mouse-2 0)
4484         ;; XEmacs will get a single widget arg; Emacs 21 will get
4485         ;; window, overlay, position.
4486         (if (mm-handle-displayed-p
4487              (if overlay
4488                  (with-current-buffer (gnus-overlay-buffer overlay)
4489                    (widget-get (widget-at (gnus-overlay-start overlay))
4490                                :mime-handle))
4491                (widget-get widget/window :mime-handle)))
4492             "hide" "show")
4493         (aref gnus-down-mouse-3 0))))))
4494
4495 (defun gnus-widget-press-button (elems el)
4496   (goto-char (widget-get elems :from))
4497   (gnus-article-press-button))
4498
4499 (defvar gnus-displaying-mime nil)
4500
4501 (defun gnus-display-mime (&optional ihandles)
4502   "Display the MIME parts."
4503   (save-excursion
4504     (save-selected-window
4505       (let ((window (get-buffer-window gnus-article-buffer))
4506             (point (point)))
4507         (when window
4508           (select-window window)
4509           ;; We have to do this since selecting the window
4510           ;; may change the point.  So we set the window point.
4511           (set-window-point window point)))
4512       (let* ((handles (or ihandles
4513                           (mm-dissect-buffer nil gnus-article-loose-mime)
4514                           (and gnus-article-emulate-mime
4515                                (mm-uu-dissect))))
4516              buffer-read-only handle name type b e display)
4517         (when (and (not ihandles)
4518                    (not gnus-displaying-mime))
4519           ;; Top-level call; we clean up.
4520           (when gnus-article-mime-handles
4521             (mm-destroy-parts gnus-article-mime-handles)
4522             (setq gnus-article-mime-handle-alist nil));; A trick.
4523           (setq gnus-article-mime-handles handles)
4524           ;; We allow users to glean info from the handles.
4525           (when gnus-article-mime-part-function
4526             (gnus-mime-part-function handles)))
4527         (if (and handles
4528                  (or (not (stringp (car handles)))
4529                      (cdr handles)))
4530             (progn
4531               (when (and (not ihandles)
4532                          (not gnus-displaying-mime))
4533                 ;; Clean up for mime parts.
4534                 (article-goto-body)
4535                 (delete-region (point) (point-max)))
4536               (let ((gnus-displaying-mime t))
4537                 (gnus-mime-display-part handles)))
4538           (save-restriction
4539             (article-goto-body)
4540             (narrow-to-region (point) (point-max))
4541             (gnus-treat-article nil 1 1)
4542             (widen)))
4543         (unless ihandles
4544           ;; Highlight the headers.
4545           (save-excursion
4546             (save-restriction
4547               (article-goto-body)
4548               (narrow-to-region (point-min) (point))
4549               (gnus-treat-article 'head))))))))
4550
4551 (defcustom gnus-mime-display-multipart-as-mixed nil
4552   "Display \"multipart\" parts as  \"multipart/mixed\".
4553
4554 If t, it overrides nil values of
4555 `gnus-mime-display-multipart-alternative-as-mixed' and
4556 `gnus-mime-display-multipart-related-as-mixed'."
4557   :group 'gnus-article-mime
4558   :type 'boolean)
4559
4560 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
4561   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
4562   :group 'gnus-article-mime
4563   :type 'boolean)
4564
4565 (defcustom gnus-mime-display-multipart-related-as-mixed nil
4566   "Display \"multipart/related\" parts as  \"multipart/mixed\".
4567
4568 If displaying \"text/html\" is discouraged \(see
4569 `mm-discouraged-alternatives'\) images or other material inside a
4570 \"multipart/related\" part might be overlooked when this variable is nil."
4571   :group 'gnus-article-mime
4572   :type 'boolean)
4573
4574 (defun gnus-mime-display-part (handle)
4575   (cond
4576    ;; Single part.
4577    ((not (stringp (car handle)))
4578     (gnus-mime-display-single handle))
4579    ;; User-defined multipart
4580    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
4581     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
4582              handle))
4583    ;; multipart/alternative
4584    ((and (equal (car handle) "multipart/alternative")
4585          (not (or gnus-mime-display-multipart-as-mixed
4586                   gnus-mime-display-multipart-alternative-as-mixed)))
4587     (let ((id (1+ (length gnus-article-mime-handle-alist))))
4588       (push (cons id handle) gnus-article-mime-handle-alist)
4589       (gnus-mime-display-alternative (cdr handle) nil nil id)))
4590    ;; multipart/related
4591    ((and (equal (car handle) "multipart/related")
4592          (not (or gnus-mime-display-multipart-as-mixed
4593                   gnus-mime-display-multipart-related-as-mixed)))
4594     ;;;!!!We should find the start part, but we just default
4595     ;;;!!!to the first part.
4596     ;;(gnus-mime-display-part (cadr handle))
4597     ;;;!!! Most multipart/related is an HTML message plus images.
4598     ;;;!!! Unfortunately we are unable to let W3 display those
4599     ;;;!!! included images, so we just display it as a mixed multipart.
4600     ;;(gnus-mime-display-mixed (cdr handle))
4601     ;;;!!! No, w3 can display everything just fine.
4602     (gnus-mime-display-part (cadr handle)))
4603    ((equal (car handle) "multipart/signed")
4604     (gnus-add-wash-type 'signed)
4605     (gnus-mime-display-security handle))
4606    ((equal (car handle) "multipart/encrypted")
4607     (gnus-add-wash-type 'encrypted)
4608     (gnus-mime-display-security handle))
4609    ;; Other multiparts are handled like multipart/mixed.
4610    (t
4611     (gnus-mime-display-mixed (cdr handle)))))
4612
4613 (defun gnus-mime-part-function (handles)
4614   (if (stringp (car handles))
4615       (mapcar 'gnus-mime-part-function (cdr handles))
4616     (funcall gnus-article-mime-part-function handles)))
4617
4618 (defun gnus-mime-display-mixed (handles)
4619   (mapcar 'gnus-mime-display-part handles))
4620
4621 (defun gnus-mime-display-single (handle)
4622   (let ((type (mm-handle-media-type handle))
4623         (ignored gnus-ignored-mime-types)
4624         (not-attachment t)
4625         (move nil)
4626         display text)
4627     (catch 'ignored
4628       (progn
4629         (while ignored
4630           (when (string-match (pop ignored) type)
4631             (throw 'ignored nil)))
4632         (if (and (setq not-attachment
4633                        (and (not (mm-inline-override-p handle))
4634                             (or (not (mm-handle-disposition handle))
4635                                 (equal (car (mm-handle-disposition handle))
4636                                        "inline")
4637                                 (mm-attachment-override-p handle))))
4638                  (mm-automatic-display-p handle)
4639                  (or (and
4640                       (mm-inlinable-p handle)
4641                       (mm-inlined-p handle))
4642                      (mm-automatic-external-display-p type)))
4643             (setq display t)
4644           (when (equal (mm-handle-media-supertype handle) "text")
4645             (setq text t)))
4646         (let ((id (1+ (length gnus-article-mime-handle-alist)))
4647               beg)
4648           (push (cons id handle) gnus-article-mime-handle-alist)
4649           (when (or (not display)
4650                     (not (gnus-unbuttonized-mime-type-p type)))
4651             (gnus-insert-mime-button
4652              handle id (list (or display (and not-attachment text))))
4653             (gnus-article-insert-newline)
4654             ;; Remember modify the number of forward lines.
4655             (setq move t))
4656           (setq beg (point))
4657           (cond
4658            (display
4659             (when move
4660               (forward-line -1)
4661               (setq beg (point)))
4662             (let ((mail-parse-charset gnus-newsgroup-charset)
4663                   (mail-parse-ignored-charsets
4664                    (save-excursion (condition-case ()
4665                                        (set-buffer gnus-summary-buffer)
4666                                      (error))
4667                                    gnus-newsgroup-ignored-charsets)))
4668               (mm-display-part handle t))
4669             (goto-char (point-max)))
4670            ((and text not-attachment)
4671             (when move
4672               (forward-line -1)
4673               (setq beg (point)))
4674             (gnus-article-insert-newline)
4675             (mm-insert-inline handle (mm-get-part handle))
4676             (goto-char (point-max))))
4677           ;; Do highlighting.
4678           (save-excursion
4679             (save-restriction
4680               (narrow-to-region beg (point))
4681               (gnus-treat-article
4682                nil id
4683                (gnus-article-mime-total-parts)
4684                (mm-handle-media-type handle)))))))))
4685
4686 (defun gnus-unbuttonized-mime-type-p (type)
4687   "Say whether TYPE is to be unbuttonized."
4688   (unless gnus-inhibit-mime-unbuttonizing
4689     (when (catch 'found
4690             (let ((types gnus-unbuttonized-mime-types))
4691               (while types
4692                 (when (string-match (pop types) type)
4693                   (throw 'found t)))))
4694       (not (catch 'found
4695              (let ((types gnus-buttonized-mime-types))
4696                (while types
4697                  (when (string-match (pop types) type)
4698                    (throw 'found t)))))))))
4699
4700 (defun gnus-article-insert-newline ()
4701   "Insert a newline, but mark it as undeletable."
4702   (gnus-put-text-property
4703    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
4704
4705 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
4706   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
4707          (ihandles handles)
4708          (point (point))
4709          handle buffer-read-only from props begend not-pref)
4710     (save-window-excursion
4711       (save-restriction
4712         (when ibegend
4713           (narrow-to-region (car ibegend)
4714                             (or (cdr ibegend)
4715                                 (progn
4716                                   (goto-char (car ibegend))
4717                                   (forward-line 2)
4718                                   (point))))
4719           (delete-region (point-min) (point-max))
4720           (mm-remove-parts handles))
4721         (setq begend (list (point-marker)))
4722         ;; Do the toggle.
4723         (unless (setq not-pref (cadr (member preferred ihandles)))
4724           (setq not-pref (car ihandles)))
4725         (when (or ibegend
4726                   (not preferred)
4727                   (not (gnus-unbuttonized-mime-type-p
4728                         "multipart/alternative")))
4729           (gnus-add-text-properties
4730            (setq from (point))
4731            (progn
4732              (insert (format "%d.  " id))
4733              (point))
4734            `(gnus-callback
4735              (lambda (handles)
4736                (unless ,(not ibegend)
4737                  (setq gnus-article-mime-handle-alist
4738                        ',gnus-article-mime-handle-alist))
4739                (gnus-mime-display-alternative
4740                 ',ihandles ',not-pref ',begend ,id))
4741              keymap ,gnus-mime-button-map
4742              ,gnus-mouse-face-prop ,gnus-article-mouse-face
4743              face ,gnus-article-button-face
4744              gnus-part ,id
4745              gnus-data ,handle))
4746           (widget-convert-button 'link from (point)
4747                                  :action 'gnus-widget-press-button
4748                                  :button-keymap gnus-widget-button-keymap)
4749           ;; Do the handles
4750           (while (setq handle (pop handles))
4751             (gnus-add-text-properties
4752              (setq from (point))
4753              (progn
4754                (insert (format "(%c) %-18s"
4755                                (if (equal handle preferred) ?* ? )
4756                                (mm-handle-media-type handle)))
4757                (point))
4758              `(gnus-callback
4759                (lambda (handles)
4760                  (unless ,(not ibegend)
4761                    (setq gnus-article-mime-handle-alist
4762                          ',gnus-article-mime-handle-alist))
4763                  (gnus-mime-display-alternative
4764                   ',ihandles ',handle ',begend ,id))
4765                keymap ,gnus-mime-button-map
4766                ,gnus-mouse-face-prop ,gnus-article-mouse-face
4767                face ,gnus-article-button-face
4768                gnus-part ,id
4769                gnus-data ,handle))
4770             (widget-convert-button 'link from (point)
4771                                    :action 'gnus-widget-press-button
4772                                    :button-keymap gnus-widget-button-keymap)
4773             (insert "  "))
4774           (insert "\n\n"))
4775         (when preferred
4776           (if (stringp (car preferred))
4777               (gnus-display-mime preferred)
4778             (let ((mail-parse-charset gnus-newsgroup-charset)
4779                   (mail-parse-ignored-charsets
4780                    (with-current-buffer gnus-summary-buffer
4781                      gnus-newsgroup-ignored-charsets)))
4782               (mm-display-part preferred)
4783               ;; Do highlighting.
4784               (save-excursion
4785                 (save-restriction
4786                   (narrow-to-region (car begend) (point-max))
4787                   (gnus-treat-article
4788                    nil (length gnus-article-mime-handle-alist)
4789                    (gnus-article-mime-total-parts)
4790                    (mm-handle-media-type handle))))))
4791           (goto-char (point-max))
4792           (setcdr begend (point-marker)))))
4793     (when ibegend
4794       (goto-char point))))
4795
4796 (defconst gnus-article-wash-status-strings
4797   (let ((alist '((cite "c" "Possible hidden citation text"
4798                        " " "All citation text visible")
4799                  (headers "h" "Hidden headers"
4800                           " " "All headers visible.")
4801                  (pgp "p" "Encrypted or signed message status hidden"
4802                       " " "No hidden encryption nor digital signature status")
4803                  (signature "s" "Signature has been hidden"
4804                             " " "Signature is visible")
4805                  (overstrike "o" "Overstrike (^H) characters applied"
4806                              " " "No overstrike characters applied")
4807                  (emphasis "e" "/*_Emphasis_*/ characters applied"
4808                            " " "No /*_emphasis_*/ characters applied")))
4809         result)
4810     (dolist (entry alist result)
4811       (let ((key (nth 0 entry))
4812             (on (copy-sequence (nth 1 entry)))
4813             (on-help (nth 2 entry))
4814             (off (copy-sequence (nth 3 entry)))
4815             (off-help (nth 4 entry)))
4816         (put-text-property 0 1 'help-echo on-help on)
4817         (put-text-property 0 1 'help-echo off-help off)
4818         (push (list key on off) result))))
4819   "Alist of strings describing wash status in the mode line.
4820 Each entry has the form (KEY ON OF), where the KEY is a symbol
4821 representing the particular washing function, ON is the string to use
4822 in the article mode line when the washing function is active, and OFF
4823 is the string to use when it is inactive.")
4824
4825 (defun gnus-article-wash-status-entry (key value)
4826   (let ((entry (assoc key gnus-article-wash-status-strings)))
4827     (if value (nth 1 entry) (nth 2 entry))))
4828
4829 (defun gnus-article-wash-status ()
4830   "Return a string which display status of article washing."
4831   (with-current-buffer gnus-article-buffer
4832     (let ((cite (memq 'cite gnus-article-wash-types))
4833           (headers (memq 'headers gnus-article-wash-types))
4834           (boring (memq 'boring-headers gnus-article-wash-types))
4835           (pgp (memq 'pgp gnus-article-wash-types))
4836           (pem (memq 'pem gnus-article-wash-types))
4837           (signed (memq 'signed gnus-article-wash-types))
4838           (encrypted (memq 'encrypted gnus-article-wash-types))
4839           (signature (memq 'signature gnus-article-wash-types))
4840           (overstrike (memq 'overstrike gnus-article-wash-types))
4841           (emphasis (memq 'emphasis gnus-article-wash-types)))
4842       (concat
4843        (gnus-article-wash-status-entry 'cite cite)
4844        (gnus-article-wash-status-entry 'headers (or headers boring))
4845        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
4846        (gnus-article-wash-status-entry 'signature signature)
4847        (gnus-article-wash-status-entry 'overstrike overstrike)
4848        (gnus-article-wash-status-entry 'emphasis emphasis)))))
4849
4850 (defun gnus-add-wash-type (type)
4851   "Add a washing of TYPE to the current status."
4852   (add-to-list 'gnus-article-wash-types type))
4853
4854 (defun gnus-delete-wash-type (type)
4855   "Add a washing of TYPE to the current status."
4856   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
4857
4858 (defun gnus-add-image (category image)
4859   "Add IMAGE of CATEGORY to the list of displayed images."
4860   (let ((entry (assq category gnus-article-image-alist)))
4861     (unless entry
4862       (setq entry (list category))
4863       (push entry gnus-article-image-alist))
4864     (nconc entry (list image))))
4865
4866 (defun gnus-delete-images (category)
4867   "Delete all images in CATEGORY."
4868   (let ((entry (assq category gnus-article-image-alist)))
4869     (dolist (image (cdr entry))
4870       (gnus-remove-image image category))
4871     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
4872     (gnus-delete-wash-type category)))
4873
4874 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
4875
4876 (defun gnus-article-maybe-hide-headers ()
4877   "Hide unwanted headers if `gnus-have-all-headers' is nil.
4878 Provided for backwards compatibility."
4879   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
4880                  (not (with-current-buffer gnus-summary-buffer
4881                         gnus-have-all-headers)))
4882              (not gnus-inhibit-hiding))
4883     (gnus-article-hide-headers)))
4884
4885 ;;; Article savers.
4886
4887 (defun gnus-output-to-file (file-name)
4888   "Append the current article to a file named FILE-NAME."
4889   (let ((artbuf (current-buffer)))
4890     (with-temp-buffer
4891       (insert-buffer-substring artbuf)
4892       ;; Append newline at end of the buffer as separator, and then
4893       ;; save it to file.
4894       (goto-char (point-max))
4895       (insert "\n")
4896       (let ((file-name-coding-system nnmail-pathname-coding-system))
4897         (mm-append-to-file (point-min) (point-max) file-name))
4898       t)))
4899
4900 (defun gnus-narrow-to-page (&optional arg)
4901   "Narrow the article buffer to a page.
4902 If given a numerical ARG, move forward ARG pages."
4903   (interactive "P")
4904   (setq arg (if arg (prefix-numeric-value arg) 0))
4905   (save-excursion
4906     (set-buffer gnus-article-buffer)
4907     (goto-char (point-min))
4908     (widen)
4909     ;; Remove any old next/prev buttons.
4910     (when (gnus-visual-p 'page-marker)
4911       (let ((buffer-read-only nil))
4912         (gnus-remove-text-with-property 'gnus-prev)
4913         (gnus-remove-text-with-property 'gnus-next)))
4914     (if
4915         (cond ((< arg 0)
4916                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
4917               ((> arg 0)
4918                (re-search-forward page-delimiter nil 'move arg)))
4919         (goto-char (match-end 0))
4920       (save-excursion
4921         (goto-char (point-min))
4922         (setq gnus-page-broken
4923               (and (re-search-forward page-delimiter nil t) t))))
4924     (when gnus-page-broken
4925       (narrow-to-region
4926        (point)
4927        (if (re-search-forward page-delimiter nil 'move)
4928            (match-beginning 0)
4929          (point)))
4930       (when (and (gnus-visual-p 'page-marker)
4931                  (not (= (point-min) 1)))
4932         (save-excursion
4933           (goto-char (point-min))
4934           (gnus-insert-prev-page-button)))
4935       (when (and (gnus-visual-p 'page-marker)
4936                  (< (+ (point-max) 2) (buffer-size)))
4937         (save-excursion
4938           (goto-char (point-max))
4939           (gnus-insert-next-page-button))))))
4940
4941 ;; Article mode commands
4942
4943 (defun gnus-article-goto-next-page ()
4944   "Show the next page of the article."
4945   (interactive)
4946   (when (gnus-article-next-page)
4947     (goto-char (point-min))
4948     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
4949
4950
4951 (defun gnus-article-goto-prev-page ()
4952   "Show the previous page of the article."
4953   (interactive)
4954   (if (bobp)
4955       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
4956     (gnus-article-prev-page nil)))
4957
4958 ;; This is cleaner but currently breaks `gnus-pick-mode':
4959 ;;
4960 ;; (defun gnus-article-goto-next-page ()
4961 ;;   "Show the next page of the article."
4962 ;;   (interactive)
4963 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4964 ;;     (gnus-summary-next-page)))
4965 ;;
4966 ;; (defun gnus-article-goto-prev-page ()
4967 ;;   "Show the next page of the article."
4968 ;;   (interactive)
4969 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4970 ;;     (gnus-summary-prev-page)))
4971
4972 (defun gnus-article-next-page (&optional lines)
4973   "Show the next page of the current article.
4974 If end of article, return non-nil.  Otherwise return nil.
4975 Argument LINES specifies lines to be scrolled up."
4976   (interactive "p")
4977   (move-to-window-line -1)
4978   (if (save-excursion
4979         (end-of-line)
4980         (and (pos-visible-in-window-p)  ;Not continuation line.
4981              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
4982       ;; Nothing in this page.
4983       (if (or (not gnus-page-broken)
4984               (save-excursion
4985                 (save-restriction
4986                   (widen)
4987                   (eobp)))) ;Real end-of-buffer?
4988           (progn
4989             (when gnus-article-over-scroll
4990               (gnus-article-next-page-1 lines))
4991             t)                  ;Nothing more.
4992         (gnus-narrow-to-page 1)         ;Go to next page.
4993         nil)
4994     ;; More in this page.
4995     (gnus-article-next-page-1 lines)
4996     nil))
4997
4998 (defun gnus-article-next-page-1 (lines)
4999   (let ((scroll-in-place nil))
5000     (condition-case ()
5001         (scroll-up lines)
5002       (end-of-buffer
5003        ;; Long lines may cause an end-of-buffer error.
5004        (goto-char (point-max)))))
5005   (move-to-window-line 0))
5006
5007 (defun gnus-article-prev-page (&optional lines)
5008   "Show previous page of current article.
5009 Argument LINES specifies lines to be scrolled down."
5010   (interactive "p")
5011   (move-to-window-line 0)
5012   (if (and gnus-page-broken
5013            (bobp)
5014            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
5015       (progn
5016         (gnus-narrow-to-page -1)        ;Go to previous page.
5017         (goto-char (point-max))
5018         (recenter -1))
5019     (let ((scroll-in-place nil))
5020       (prog1
5021           (condition-case ()
5022               (scroll-down lines)
5023             (beginning-of-buffer
5024              (goto-char (point-min))))
5025         (move-to-window-line 0)))))
5026
5027 (defun gnus-article-only-boring-p ()
5028   "Decide whether there is only boring text remaining in the article.
5029 Something \"interesting\" is a word of at least two letters that does
5030 not have a face in `gnus-article-boring-faces'."
5031   (when (and gnus-article-skip-boring
5032              (boundp 'gnus-article-boring-faces)
5033              (symbol-value 'gnus-article-boring-faces))
5034     (save-excursion
5035       (catch 'only-boring
5036         (while (re-search-forward "\\b\\w\\w" nil t)
5037           (forward-char -1)
5038           (when (not (gnus-intersection
5039                       (gnus-faces-at (point))
5040                       (symbol-value 'gnus-article-boring-faces)))
5041             (throw 'only-boring nil)))
5042         (throw 'only-boring t)))))
5043
5044 (defun gnus-article-refer-article ()
5045   "Read article specified by message-id around point."
5046   (interactive)
5047   (save-excursion
5048     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
5049     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
5050     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
5051         (let ((msg-id (concat "<" (match-string 0) ">")))
5052           (set-buffer gnus-summary-buffer)
5053           (gnus-summary-refer-article msg-id))
5054       (error "No references around point"))))
5055
5056 (defun gnus-article-show-summary ()
5057   "Reconfigure windows to show summary buffer."
5058   (interactive)
5059   (if (not (gnus-buffer-live-p gnus-summary-buffer))
5060       (error "There is no summary buffer for this article buffer")
5061     (gnus-article-set-globals)
5062     (gnus-configure-windows 'article)
5063     (gnus-summary-goto-subject gnus-current-article)
5064     (gnus-summary-position-point)))
5065
5066 (defun gnus-article-describe-briefly ()
5067   "Describe article mode commands briefly."
5068   (interactive)
5069   (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")))
5070
5071 (defun gnus-article-summary-command ()
5072   "Execute the last keystroke in the summary buffer."
5073   (interactive)
5074   (let ((obuf (current-buffer))
5075         (owin (current-window-configuration))
5076         func)
5077     (switch-to-buffer gnus-article-current-summary 'norecord)
5078     (setq func (lookup-key (current-local-map) (this-command-keys)))
5079     (call-interactively func)
5080     (set-buffer obuf)
5081     (set-window-configuration owin)
5082     (set-window-point (get-buffer-window (current-buffer)) (point))))
5083
5084 (defun gnus-article-summary-command-nosave ()
5085   "Execute the last keystroke in the summary buffer."
5086   (interactive)
5087   (let (func)
5088     (pop-to-buffer gnus-article-current-summary 'norecord)
5089     (setq func (lookup-key (current-local-map) (this-command-keys)))
5090     (call-interactively func)))
5091
5092 (defun gnus-article-check-buffer ()
5093   "Beep if not in an article buffer."
5094   (unless (equal major-mode 'gnus-article-mode)
5095     (error "Command invoked outside of a Gnus article buffer")))
5096
5097 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
5098   "Read a summary buffer key sequence and execute it from the article buffer."
5099   (interactive "P")
5100   (gnus-article-check-buffer)
5101   (let ((nosaves
5102          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
5103            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
5104            "=" "^" "\M-^" "|"))
5105         (nosave-but-article
5106          '("A\r"))
5107         (nosave-in-article
5108          '("\C-d"))
5109         (up-to-top
5110          '("n" "Gn" "p" "Gp"))
5111         keys new-sum-point)
5112     (save-excursion
5113       (set-buffer gnus-article-current-summary)
5114       (let (gnus-pick-mode)
5115         (push (or key last-command-event) unread-command-events)
5116         (setq keys (if (featurep 'xemacs)
5117                        (events-to-keys (read-key-sequence nil))
5118                      (read-key-sequence nil)))))
5119
5120     (message "")
5121
5122     (if (or (member keys nosaves)
5123             (member keys nosave-but-article)
5124             (member keys nosave-in-article))
5125         (let (func)
5126           (save-window-excursion
5127             (pop-to-buffer gnus-article-current-summary 'norecord)
5128             ;; We disable the pick minor mode commands.
5129             (let (gnus-pick-mode)
5130               (setq func (lookup-key (current-local-map) keys))))
5131           (if (or (not func)
5132                   (numberp func))
5133               (ding)
5134             (unless (member keys nosave-in-article)
5135               (set-buffer gnus-article-current-summary))
5136             (call-interactively func)
5137             (setq new-sum-point (point)))
5138           (when (member keys nosave-but-article)
5139             (pop-to-buffer gnus-article-buffer 'norecord)))
5140       ;; These commands should restore window configuration.
5141       (let ((obuf (current-buffer))
5142             (owin (current-window-configuration))
5143             (opoint (point))
5144             win func in-buffer selected new-sum-start new-sum-hscroll)
5145         (cond (not-restore-window
5146                (pop-to-buffer gnus-article-current-summary 'norecord))
5147               ((setq win (get-buffer-window gnus-article-current-summary))
5148                (select-window win))
5149               (t
5150                (switch-to-buffer gnus-article-current-summary 'norecord)))
5151         (setq in-buffer (current-buffer))
5152         ;; We disable the pick minor mode commands.
5153         (if (and (setq func (let (gnus-pick-mode)
5154                               (lookup-key (current-local-map) keys)))
5155                  (functionp func))
5156             (progn
5157               (call-interactively func)
5158               (when (eq win (selected-window))
5159                 (setq new-sum-point (point)
5160                       new-sum-start (window-start win)
5161                       new-sum-hscroll (window-hscroll win))
5162               (when (eq in-buffer (current-buffer))
5163                 (setq selected (gnus-summary-select-article))
5164                 (set-buffer obuf)
5165                 (unless not-restore-window
5166                   (set-window-configuration owin))
5167                 (when (eq selected 'old)
5168                   (article-goto-body)
5169                   (set-window-start (get-buffer-window (current-buffer))
5170                                     1)
5171                   (set-window-point (get-buffer-window (current-buffer))
5172                                     (point)))
5173                 (when (and (not not-restore-window)
5174                            new-sum-point)
5175                   (set-window-point win new-sum-point)
5176                   (set-window-start win new-sum-start)
5177                   (set-window-hscroll win new-sum-hscroll)))))
5178           (set-window-configuration owin)
5179           (ding))))))
5180
5181 (defun gnus-article-describe-key (key)
5182   "Display documentation of the function invoked by KEY.  KEY is a string."
5183   (interactive "kDescribe key: ")
5184   (gnus-article-check-buffer)
5185   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5186       (save-excursion
5187         (set-buffer gnus-article-current-summary)
5188         (let (gnus-pick-mode)
5189           (if (featurep 'xemacs)
5190               (progn
5191                 (push (elt key 0) unread-command-events)
5192                 (setq key (events-to-keys
5193                            (read-key-sequence "Describe key: "))))
5194             (setq unread-command-events
5195                   (mapcar
5196                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5197                    (string-to-list key)))
5198             (setq key (read-key-sequence "Describe key: "))))
5199         (describe-key key))
5200     (describe-key key)))
5201
5202 (defun gnus-article-describe-key-briefly (key &optional insert)
5203   "Display documentation of the function invoked by KEY.  KEY is a string."
5204   (interactive "kDescribe key: \nP")
5205   (gnus-article-check-buffer)
5206   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5207       (save-excursion
5208         (set-buffer gnus-article-current-summary)
5209         (let (gnus-pick-mode)
5210           (if (featurep 'xemacs)
5211               (progn
5212                 (push (elt key 0) unread-command-events)
5213                 (setq key (events-to-keys
5214                            (read-key-sequence "Describe key: "))))
5215             (setq unread-command-events
5216                   (mapcar
5217                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5218                    (string-to-list key)))
5219             (setq key (read-key-sequence "Describe key: "))))
5220         (describe-key-briefly key insert))
5221     (describe-key-briefly key insert)))
5222
5223 (defun gnus-article-reply-with-original (&optional wide)
5224   "Start composing a reply mail to the current message.
5225 The text in the region will be yanked.  If the region isn't active,
5226 the entire article will be yanked."
5227   (interactive "P")
5228   (let ((article (cdr gnus-article-current))
5229         contents)
5230     (if (not (gnus-mark-active-p))
5231         (with-current-buffer gnus-summary-buffer
5232           (gnus-summary-reply (list (list article)) wide))
5233       (setq contents (buffer-substring (point) (mark t)))
5234       ;; Deactivate active regions.
5235       (when (and (boundp 'transient-mark-mode)
5236                  transient-mark-mode)
5237         (setq mark-active nil))
5238       (with-current-buffer gnus-summary-buffer
5239         (gnus-summary-reply
5240          (list (list article contents)) wide)))))
5241
5242 (defun gnus-article-followup-with-original ()
5243   "Compose a followup to the current article.
5244 The text in the region will be yanked.  If the region isn't active,
5245 the entire article will be yanked."
5246   (interactive)
5247   (let ((article (cdr gnus-article-current))
5248         contents)
5249       (if (not (gnus-mark-active-p))
5250           (with-current-buffer gnus-summary-buffer
5251             (gnus-summary-followup (list (list article))))
5252         (setq contents (buffer-substring (point) (mark t)))
5253         ;; Deactivate active regions.
5254         (when (and (boundp 'transient-mark-mode)
5255                    transient-mark-mode)
5256           (setq mark-active nil))
5257         (with-current-buffer gnus-summary-buffer
5258           (gnus-summary-followup
5259            (list (list article contents)))))))
5260
5261 (defun gnus-article-hide (&optional arg force)
5262   "Hide all the gruft in the current article.
5263 This means that signatures, cited text and (some) headers will be
5264 hidden.
5265 If given a prefix, show the hidden text instead."
5266   (interactive (append (gnus-article-hidden-arg) (list 'force)))
5267   (gnus-article-hide-headers arg)
5268   (gnus-article-hide-list-identifiers arg)
5269   (gnus-article-hide-citation-maybe arg force)
5270   (gnus-article-hide-signature arg))
5271
5272 (defun gnus-article-maybe-highlight ()
5273   "Do some article highlighting if article highlighting is requested."
5274   (when (gnus-visual-p 'article-highlight 'highlight)
5275     (gnus-article-highlight-some)))
5276
5277 (defun gnus-check-group-server ()
5278   ;; Make sure the connection to the server is alive.
5279   (unless (gnus-server-opened
5280            (gnus-find-method-for-group gnus-newsgroup-name))
5281     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5282     (gnus-request-group gnus-newsgroup-name t)))
5283
5284 (eval-when-compile
5285   (autoload 'nneething-get-file-name "nneething"))
5286
5287 (defun gnus-request-article-this-buffer (article group)
5288   "Get an article and insert it into this buffer."
5289   (let (do-update-line sparse-header)
5290     (prog1
5291         (save-excursion
5292           (erase-buffer)
5293           (gnus-kill-all-overlays)
5294           (setq group (or group gnus-newsgroup-name))
5295
5296           ;; Using `gnus-request-article' directly will insert the article into
5297           ;; `nntp-server-buffer' - so we'll save some time by not having to
5298           ;; copy it from the server buffer into the article buffer.
5299
5300           ;; We only request an article by message-id when we do not have the
5301           ;; headers for it, so we'll have to get those.
5302           (when (stringp article)
5303             (gnus-read-header article))
5304
5305           ;; If the article number is negative, that means that this article
5306           ;; doesn't belong in this newsgroup (possibly), so we find its
5307           ;; message-id and request it by id instead of number.
5308           (when (and (numberp article)
5309                      gnus-summary-buffer
5310                      (get-buffer gnus-summary-buffer)
5311                      (gnus-buffer-exists-p gnus-summary-buffer))
5312             (save-excursion
5313               (set-buffer gnus-summary-buffer)
5314               (let ((header (gnus-summary-article-header article)))
5315                 (when (< article 0)
5316                   (cond
5317                    ((memq article gnus-newsgroup-sparse)
5318                     ;; This is a sparse gap article.
5319                     (setq do-update-line article)
5320                     (setq article (mail-header-id header))
5321                     (setq sparse-header (gnus-read-header article))
5322                     (setq gnus-newsgroup-sparse
5323                           (delq article gnus-newsgroup-sparse)))
5324                    ((vectorp header)
5325                     ;; It's a real article.
5326                     (setq article (mail-header-id header)))
5327                    (t
5328                     ;; It is an extracted pseudo-article.
5329                     (setq article 'pseudo)
5330                     (gnus-request-pseudo-article header))))
5331
5332                 (let ((method (gnus-find-method-for-group
5333                                gnus-newsgroup-name)))
5334                   (when (and (eq (car method) 'nneething)
5335                              (vectorp header))
5336                     (let ((dir (nneething-get-file-name
5337                                 (mail-header-id header))))
5338                       (when (and (stringp dir)
5339                                  (file-directory-p dir))
5340                         (setq article 'nneething)
5341                         (gnus-group-enter-directory dir))))))))
5342
5343           (cond
5344            ;; Refuse to select canceled articles.
5345            ((and (numberp article)
5346                  gnus-summary-buffer
5347                  (get-buffer gnus-summary-buffer)
5348                  (gnus-buffer-exists-p gnus-summary-buffer)
5349                  (eq (cdr (with-current-buffer gnus-summary-buffer
5350                             (assq article gnus-newsgroup-reads)))
5351                      gnus-canceled-mark))
5352             nil)
5353            ;; We first check `gnus-original-article-buffer'.
5354            ((and (get-buffer gnus-original-article-buffer)
5355                  (numberp article)
5356                  (with-current-buffer gnus-original-article-buffer
5357                    (and (equal (car gnus-original-article) group)
5358                         (eq (cdr gnus-original-article) article))))
5359             (insert-buffer-substring gnus-original-article-buffer)
5360             'article)
5361            ;; Check the backlog.
5362            ((and gnus-keep-backlog
5363                  (gnus-backlog-request-article group article (current-buffer)))
5364             'article)
5365            ;; Check asynchronous pre-fetch.
5366            ((gnus-async-request-fetched-article group article (current-buffer))
5367             (gnus-async-prefetch-next group article gnus-summary-buffer)
5368             (when (and (numberp article) gnus-keep-backlog)
5369               (gnus-backlog-enter-article group article (current-buffer)))
5370             'article)
5371            ;; Check the cache.
5372            ((and gnus-use-cache
5373                  (numberp article)
5374                  (gnus-cache-request-article article group))
5375             'article)
5376            ;; Check the agent cache.
5377            ((gnus-agent-request-article article group)
5378             'article)
5379            ;; Get the article and put into the article buffer.
5380            ((or (stringp article)
5381                 (numberp article))
5382             (let ((gnus-override-method gnus-override-method)
5383                   (methods (and (stringp article)
5384                                 gnus-refer-article-method))
5385                   (backend (car (gnus-find-method-for-group
5386                                  gnus-newsgroup-name)))
5387                   result
5388                   (buffer-read-only nil))
5389               (if (or (not (listp methods))
5390                       (and (symbolp (car methods))
5391                            (assq (car methods) nnoo-definition-alist)))
5392                   (setq methods (list methods)))
5393               (when (and (null gnus-override-method)
5394                          methods)
5395                 (setq gnus-override-method (pop methods)))
5396               (while (not result)
5397                 (when (eq gnus-override-method 'current)
5398                   (setq gnus-override-method
5399                         (with-current-buffer gnus-summary-buffer
5400                           gnus-current-select-method)))
5401                 (erase-buffer)
5402                 (gnus-kill-all-overlays)
5403                 (let ((gnus-newsgroup-name group))
5404                   (gnus-check-group-server))
5405                 (cond
5406                  ((gnus-request-article article group (current-buffer))
5407                   (when (numberp article)
5408                     (gnus-async-prefetch-next group article
5409                                               gnus-summary-buffer)
5410                     (when gnus-keep-backlog
5411                       (gnus-backlog-enter-article
5412                        group article (current-buffer))))
5413                   (setq result 'article))
5414                  (methods
5415                   (setq gnus-override-method (pop methods)))
5416                  ((not (string-match "^400 "
5417                                      (nnheader-get-report backend)))
5418                   ;; If we get 400 server disconnect, reconnect and
5419                   ;; retry; otherwise, assume the article has expired.
5420                   (setq result 'done))))
5421               (and (eq result 'article) 'article)))
5422            ;; It was a pseudo.
5423            (t article)))
5424
5425       ;; Associate this article with the current summary buffer.
5426       (setq gnus-article-current-summary gnus-summary-buffer)
5427
5428       ;; Take the article from the original article buffer
5429       ;; and place it in the buffer it's supposed to be in.
5430       (when (and (get-buffer gnus-article-buffer)
5431                  (equal (buffer-name (current-buffer))
5432                         (buffer-name (get-buffer gnus-article-buffer))))
5433         (save-excursion
5434           (if (get-buffer gnus-original-article-buffer)
5435               (set-buffer gnus-original-article-buffer)
5436             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
5437             (buffer-disable-undo)
5438             (setq major-mode 'gnus-original-article-mode)
5439             (setq buffer-read-only t))
5440           (let (buffer-read-only)
5441             (erase-buffer)
5442             (insert-buffer-substring gnus-article-buffer))
5443           (setq gnus-original-article (cons group article)))
5444
5445         ;; Decode charsets.
5446         (run-hooks 'gnus-article-decode-hook)
5447         ;; Mark article as decoded or not.
5448         (setq gnus-article-decoded-p gnus-article-decode-hook))
5449
5450       ;; Update sparse articles.
5451       (when (and do-update-line
5452                  (or (numberp article)
5453                      (stringp article)))
5454         (let ((buf (current-buffer)))
5455           (set-buffer gnus-summary-buffer)
5456           (gnus-summary-update-article do-update-line sparse-header)
5457           (gnus-summary-goto-subject do-update-line nil t)
5458           (set-window-point (gnus-get-buffer-window (current-buffer) t)
5459                             (point))
5460           (set-buffer buf))))))
5461
5462 ;;;
5463 ;;; Article editing
5464 ;;;
5465
5466 (defcustom gnus-article-edit-mode-hook nil
5467   "Hook run in article edit mode buffers."
5468   :group 'gnus-article-various
5469   :type 'hook)
5470
5471 (defvar gnus-article-edit-done-function nil)
5472
5473 (defvar gnus-article-edit-mode-map nil)
5474
5475 ;; Should we be using derived.el for this?
5476 (unless gnus-article-edit-mode-map
5477   (setq gnus-article-edit-mode-map (make-keymap))
5478   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
5479
5480   (gnus-define-keys gnus-article-edit-mode-map
5481     "\C-c?"    describe-mode
5482     "\C-c\C-c" gnus-article-edit-done
5483     "\C-c\C-k" gnus-article-edit-exit
5484     "\C-c\C-f\C-t" message-goto-to
5485     "\C-c\C-f\C-o" message-goto-from
5486     "\C-c\C-f\C-b" message-goto-bcc
5487     ;;"\C-c\C-f\C-w" message-goto-fcc
5488     "\C-c\C-f\C-c" message-goto-cc
5489     "\C-c\C-f\C-s" message-goto-subject
5490     "\C-c\C-f\C-r" message-goto-reply-to
5491     "\C-c\C-f\C-n" message-goto-newsgroups
5492     "\C-c\C-f\C-d" message-goto-distribution
5493     "\C-c\C-f\C-f" message-goto-followup-to
5494     "\C-c\C-f\C-m" message-goto-mail-followup-to
5495     "\C-c\C-f\C-k" message-goto-keywords
5496     "\C-c\C-f\C-u" message-goto-summary
5497     "\C-c\C-f\C-i" message-insert-or-toggle-importance
5498     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
5499     "\C-c\C-b" message-goto-body
5500     "\C-c\C-i" message-goto-signature
5501
5502     "\C-c\C-t" message-insert-to
5503     "\C-c\C-n" message-insert-newsgroups
5504     "\C-c\C-o" message-sort-headers
5505     "\C-c\C-e" message-elide-region
5506     "\C-c\C-v" message-delete-not-region
5507     "\C-c\C-z" message-kill-to-signature
5508     "\M-\r" message-newline-and-reformat
5509     "\C-c\C-a" mml-attach-file
5510     "\C-a" message-beginning-of-line
5511     "\t" message-tab
5512     "\M-;" comment-region)
5513
5514   (gnus-define-keys (gnus-article-edit-wash-map
5515                      "\C-c\C-w" gnus-article-edit-mode-map)
5516     "f" gnus-article-edit-full-stops))
5517
5518 (easy-menu-define
5519   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
5520   '("Field"
5521     ["Fetch To" message-insert-to t]
5522     ["Fetch Newsgroups" message-insert-newsgroups t]
5523     "----"
5524     ["To" message-goto-to t]
5525     ["From" message-goto-from t]
5526     ["Subject" message-goto-subject t]
5527     ["Cc" message-goto-cc t]
5528     ["Reply-To" message-goto-reply-to t]
5529     ["Summary" message-goto-summary t]
5530     ["Keywords" message-goto-keywords t]
5531     ["Newsgroups" message-goto-newsgroups t]
5532     ["Followup-To" message-goto-followup-to t]
5533     ["Mail-Followup-To" message-goto-mail-followup-to t]
5534     ["Distribution" message-goto-distribution t]
5535     ["Body" message-goto-body t]
5536     ["Signature" message-goto-signature t]))
5537
5538 (define-derived-mode gnus-article-edit-mode text-mode "Article Edit"
5539   "Major mode for editing articles.
5540 This is an extended text-mode.
5541
5542 \\{gnus-article-edit-mode-map}"
5543   (make-local-variable 'gnus-article-edit-done-function)
5544   (make-local-variable 'gnus-prev-winconf)
5545   (set (make-local-variable 'font-lock-defaults)
5546        '(message-font-lock-keywords t))
5547   (set (make-local-variable 'mail-header-separator) "")
5548   (set (make-local-variable 'gnus-article-edit-mode) t)
5549   (easy-menu-add message-mode-field-menu message-mode-map)
5550   (mml-mode)
5551   (setq buffer-read-only nil)
5552   (buffer-enable-undo)
5553   (widen))
5554
5555 (defun gnus-article-edit (&optional force)
5556   "Edit the current article.
5557 This will have permanent effect only in mail groups.
5558 If FORCE is non-nil, allow editing of articles even in read-only
5559 groups."
5560   (interactive "P")
5561   (when (and (not force)
5562              (gnus-group-read-only-p))
5563     (error "The current newsgroup does not support article editing"))
5564   (gnus-article-date-original)
5565   (gnus-article-edit-article
5566    'ignore
5567    `(lambda (no-highlight)
5568       'ignore
5569       (gnus-summary-edit-article-done
5570        ,(or (mail-header-references gnus-current-headers) "")
5571        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
5572
5573 (defun gnus-article-edit-article (start-func exit-func)
5574   "Start editing the contents of the current article buffer."
5575   (let ((winconf (current-window-configuration)))
5576     (set-buffer gnus-article-buffer)
5577     (gnus-article-edit-mode)
5578     (funcall start-func)
5579     (set-buffer-modified-p nil)
5580     (gnus-configure-windows 'edit-article)
5581     (setq gnus-article-edit-done-function exit-func)
5582     (setq gnus-prev-winconf winconf)
5583     (gnus-message 6 "C-c C-c to end edits")))
5584
5585 (defun gnus-article-edit-done (&optional arg)
5586   "Update the article edits and exit."
5587   (interactive "P")
5588   (let ((func gnus-article-edit-done-function)
5589         (buf (current-buffer))
5590         (start (window-start))
5591         (p (point))
5592         (winconf gnus-prev-winconf))
5593     (widen) ;; Widen it in case that users narrowed the buffer.
5594     (funcall func arg)
5595     (set-buffer buf)
5596     ;; The cache and backlog have to be flushed somewhat.
5597     (when gnus-keep-backlog
5598       (gnus-backlog-remove-article
5599        (car gnus-article-current) (cdr gnus-article-current)))
5600     ;; Flush original article as well.
5601     (save-excursion
5602       (when (get-buffer gnus-original-article-buffer)
5603         (set-buffer gnus-original-article-buffer)
5604         (setq gnus-original-article nil)))
5605     (when gnus-use-cache
5606       (gnus-cache-update-article
5607        (car gnus-article-current) (cdr gnus-article-current)))
5608     ;; We remove all text props from the article buffer.
5609     (kill-all-local-variables)
5610     (set-text-properties (point-min) (point-max) nil)
5611     (gnus-article-mode)
5612     (set-window-configuration winconf)
5613     (set-buffer buf)
5614     (set-window-start (get-buffer-window buf) start)
5615     (set-window-point (get-buffer-window buf) (point)))
5616   (gnus-summary-show-article))
5617
5618 (defun gnus-article-edit-exit ()
5619   "Exit the article editing without updating."
5620   (interactive)
5621   (when (or (not (buffer-modified-p))
5622             (yes-or-no-p "Article modified; kill anyway? "))
5623     (let ((curbuf (current-buffer))
5624           (p (point))
5625           (window-start (window-start)))
5626       (erase-buffer)
5627       (if (gnus-buffer-live-p gnus-original-article-buffer)
5628           (insert-buffer gnus-original-article-buffer))
5629       (let ((winconf gnus-prev-winconf))
5630         (kill-all-local-variables)
5631         (gnus-article-mode)
5632         (set-window-configuration winconf)
5633         ;; Tippy-toe some to make sure that point remains where it was.
5634         (save-current-buffer
5635           (set-buffer curbuf)
5636           (set-window-start (get-buffer-window (current-buffer)) window-start)
5637           (goto-char p))))
5638     (gnus-summary-show-article)))
5639
5640 (defun gnus-article-edit-full-stops ()
5641   "Interactively repair spacing at end of sentences."
5642   (interactive)
5643   (save-excursion
5644     (goto-char (point-min))
5645     (search-forward-regexp "^$" nil t)
5646     (let ((case-fold-search nil))
5647       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
5648
5649 ;;;
5650 ;;; Article highlights
5651 ;;;
5652
5653 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
5654
5655 ;;; Internal Variables:
5656
5657 (defcustom gnus-button-url-regexp
5658   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
5659       "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-z0-9_.]+:[0-9]*\\)?[-a-z0-9_=!?#$@~%&*+\\/:;.,[:word:]]+[-a-z0-9_=#$@~%&*+\\/[:word:]]\\)"
5660     "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-z0-9_.]+:[0-9]*\\)?\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)\\)")
5661   "Regular expression that matches URLs."
5662   :group 'gnus-article-buttons
5663   :type 'regexp)
5664
5665 (defcustom gnus-button-valid-fqdn-regexp
5666   message-valid-fqdn-regexp
5667   "Regular expression that matches a valid FQDN."
5668   :group 'gnus-article-buttons
5669   :type 'regexp)
5670
5671 (defcustom gnus-button-man-handler 'manual-entry
5672   "Function to use for displaying man pages.
5673 The function must take at least one argument with a string naming the
5674 man page."
5675   :type '(choice (function-item :tag "Man" manual-entry)
5676                  (function-item :tag "Woman" woman)
5677                  (function :tag "Other"))
5678   :group 'gnus-article-buttons)
5679
5680 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
5681   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
5682 If the default site is too slow, try to find a CTAN mirror, see
5683 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
5684 the variable `gnus-button-handle-ctan'."
5685   :group 'gnus-article-buttons
5686   :link '(custom-manual "(gnus)Group Parameters")
5687   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
5688                  (const "http://tug.ctan.org/tex-archive/")
5689                  (const "http://www.dante.de/CTAN/")
5690                  (string :tag "Other")))
5691
5692 (defcustom gnus-button-ctan-handler 'browse-url
5693   "Function to use for displaying CTAN links.
5694 The function must take one argument, the string naming the URL."
5695   :type '(choice (function-item :tag "Browse Url" browse-url)
5696                  (function :tag "Other"))
5697   :group 'gnus-article-buttons)
5698
5699 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
5700   "Bogus strings removed from CTAN URLs."
5701   :group 'gnus-article-buttons
5702   :type '(choice (const "^/?tex-archive/\\|/")
5703                  (regexp :tag "Other")))
5704
5705 (defcustom gnus-button-ctan-directory-regexp
5706   (concat
5707    "\\(?:"
5708    "biblio\\|digests\\|dviware\\|fonts\\|graphics\\|help\\|"
5709    "indexing\\|info\\|language\\|macros\\|support\\|systems\\|"
5710    "tds\\|tools\\|usergrps\\|web\\|nonfree\\|obsolete"
5711    "\\)")
5712   "Regular expression for ctan directories.
5713 It should match all directories in the top level of `gnus-ctan-url'."
5714   :group 'gnus-article-buttons
5715   :type 'regexp)
5716
5717 (defcustom gnus-button-mid-or-mail-regexp
5718   (concat "\\b\\(<?[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t ]*@"
5719           ;; Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
5720           gnus-button-valid-fqdn-regexp
5721           ">?\\)\\b")
5722   "Regular expression that matches a message ID or a mail address."
5723   :group 'gnus-article-buttons
5724   :type 'regexp)
5725
5726 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
5727   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
5728 Strings like this can be either a message ID or a mail address.  If it is one
5729 of the symbols `mid' or `mail', Gnus will always assume that the string is a
5730 message ID or a mail address, respectively.  If this variable is set to the
5731 symbol `ask', always query the user what do do.  If it is a function, this
5732 function will be called with the string as it's only argument.  The function
5733 must return `mid', `mail', `invalid' or `ask'."
5734   :group 'gnus-article-buttons
5735   :type '(choice (function-item :tag "Heuristic function"
5736                                 gnus-button-mid-or-mail-heuristic)
5737                  (const ask)
5738                  (const mid)
5739                  (const mail)))
5740
5741 (defcustom gnus-button-mid-or-mail-heuristic-alist
5742   '((-10.0 . ".+\\$.+@")
5743     (-10.0 . "#")
5744     (-10.0 . "\\*")
5745     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
5746     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
5747     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
5748     (-1.0  . "^[^a-z]+@")
5749     ;;
5750     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
5751     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
5752     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
5753     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
5754     ;;
5755     (-2.0  . "^[0-9]")
5756     (-1.0  . "^[0-9][0-9]")
5757     ;;
5758     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
5759     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5760     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
5761     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5762     ;;
5763     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
5764     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
5765     ;;       "[0-9]{8,}.*\@"
5766     (-3.0
5767      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
5768     ;; "[0-9]{12,}.*\@"
5769     ;; compensation for TDMA dated mail addresses:
5770     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
5771     ;;
5772     (-20.0 . "\\.fsf@") ;; Gnus
5773     (-20.0 . "^slrn")
5774     (-20.0 . "^Pine")
5775     (-20.0 . "_-_") ;; Subject change in thread
5776     ;;
5777     (-20.0 . "\\.ln@") ;; leafnode
5778     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
5779     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
5780     ;;
5781     ;; (5.0 . "") ;; $local_part_len <= 7
5782     (10.0  . "^[^0-9]+@")
5783     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
5784     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
5785     (3.0   . "\@stud")
5786     ;;
5787     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
5788     ;;
5789     (0.5   . "^[A-Z][a-z]")
5790     (0.5   . "^[A-Z][a-z][a-z]")
5791     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
5792     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
5793   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
5794
5795 A negative RATE indicates a message IDs, whereas a positive indicates a mail
5796 address.  The REGEXP is processed with `case-fold-search' set to nil."
5797   :group 'gnus-article-buttons
5798   :type '(repeat (cons (number :tag "Rate")
5799                        (regexp :tag "Regexp"))))
5800
5801 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
5802   "Guess whether MID-OR-MAIL is a message ID or a mail address.
5803 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
5804 address, `ask' if unsure and `invalid' if the string is invalid."
5805   (let ((case-fold-search nil)
5806         (list gnus-button-mid-or-mail-heuristic-alist)
5807         (result 0) rate regexp lpartlen elem)
5808     (setq lpartlen
5809           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
5810     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
5811     ;; Certain special cases...
5812     (when (string-match
5813            (concat
5814             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
5815             "^[0-9]+\\.[0-9]+@compuserve\\|"
5816             "@public\\.gmane\\.org")
5817            mid-or-mail)
5818       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
5819       (setq result 'mail))
5820     (when (string-match "@.*@\\| " mid-or-mail)
5821       (gnus-message 8 "`%s' is invalid." mid-or-mail)
5822       (setq result 'invalid))
5823     ;; Nothing more to do, if result is not a number here...
5824     (when (numberp result)
5825       (while list
5826         (setq elem (car list)
5827               rate (car elem)
5828               regexp (cdr elem)
5829               list (cdr list))
5830         (when (string-match regexp mid-or-mail)
5831           (setq result (+ result rate))
5832           (gnus-message
5833            9 "`%s' matched `%s', rate `%s', result `%s'."
5834            mid-or-mail regexp rate result)))
5835       (when (<= lpartlen 7)
5836         (setq result (+ result 5.0))
5837         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
5838                       mid-or-mail result))
5839       (when (>= lpartlen 12)
5840         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
5841         (cond
5842          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
5843           ;; Long local part should contain realname if e-mail address,
5844           ;; too many digits: message-id.
5845           ;; $score -= 5.0 + 0.1 * $local_part_len;
5846           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
5847           (setq result (+ result rate))
5848           (gnus-message
5849            9 "Many digits in `%s', rate `%s', result `%s'."
5850            mid-or-mail rate result))
5851          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
5852                         mid-or-mail)
5853           ;; Too few vowels [^aeiouy]{4,}.*\@
5854           (setq result (+ result -5.0))
5855           (gnus-message
5856            9 "Few vowels in `%s', rate `%s', result `%s'."
5857            mid-or-mail -5.0 result))
5858          (t
5859           (setq result (+ result 5.0))
5860           (gnus-message
5861            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
5862     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
5863     ;; Maybe we should make this a customizable alist: (condition . 'result)
5864     (cond
5865      ((symbolp result) result)
5866      ;; Now convert number into proper results:
5867      ((< result -10.0) 'mid)
5868      ((> result  10.0) 'mail)
5869      (t 'ask))))
5870
5871 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
5872   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
5873          (url-mid (concat "news" ":" mid-or-mail))
5874          (url-mailto (concat "mailto" ":" mid-or-mail)))
5875     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
5876     (when (fboundp pref)
5877       (setq guessed
5878             ;; get rid of surrounding angles...
5879             (funcall pref
5880                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
5881       (if (or (eq 'mid guessed) (eq 'mail guessed))
5882           (setq pref guessed)
5883         (setq pref 'ask)))
5884     (if (eq pref 'ask)
5885         (save-window-excursion
5886           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
5887               (setq pref 'mail)
5888             (setq pref 'mid))))
5889     (cond ((eq pref 'mid)
5890            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
5891            (gnus-button-handle-news url-mid))
5892           ((eq pref 'mail)
5893            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
5894            (gnus-url-mailto url-mailto))
5895           (t (gnus-message 3 "Invalid string.")))))
5896
5897 (defun gnus-button-handle-custom (url)
5898   "Follow a Custom URL."
5899   (customize-apropos (gnus-url-unhex-string url)))
5900
5901 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
5902
5903 ;; FIXME: Maybe we should merge some of the functions that do quite similar
5904 ;; stuff?
5905
5906 (defun gnus-button-handle-describe-function (url)
5907   "Call `describe-function' when pushing the corresponding URL button."
5908   (describe-function
5909    (intern
5910     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5911
5912 (defun gnus-button-handle-describe-variable (url)
5913   "Call `describe-variable' when pushing the corresponding URL button."
5914   (describe-variable
5915    (intern
5916     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5917
5918 (defun gnus-button-handle-symbol (url)
5919 "Display help on variable or function.
5920 Calls `describe-variable' or `describe-function'."
5921   (let ((sym (intern url)))
5922     (cond
5923      ((fboundp sym) (describe-function sym))
5924      ((boundp sym) (describe-variable sym))
5925      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
5926
5927 (defun gnus-button-handle-describe-key (url)
5928   "Call `describe-key' when pushing the corresponding URL button."
5929   (let* ((key-string
5930           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
5931          (keys (ignore-errors (eval `(kbd ,key-string)))))
5932     (if keys
5933         (describe-key keys)
5934       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
5935
5936 (defun gnus-button-handle-apropos (url)
5937   "Call `apropos' when pushing the corresponding URL button."
5938   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5939
5940 (defun gnus-button-handle-apropos-command (url)
5941   "Call `apropos' when pushing the corresponding URL button."
5942   (apropos-command
5943    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5944
5945 (defun gnus-button-handle-apropos-variable (url)
5946   "Call `apropos' when pushing the corresponding URL button."
5947   (funcall
5948    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
5949    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5950
5951 (defun gnus-button-handle-apropos-documentation (url)
5952   "Call `apropos' when pushing the corresponding URL button."
5953   (funcall
5954    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
5955    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5956
5957 (defun gnus-button-handle-library (url)
5958   "Call `locate-library' when pushing the corresponding URL button."
5959   (gnus-message 9 "url=`%s'" url)
5960   (let* ((lib (locate-library url))
5961          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
5962     (if (not lib)
5963         (gnus-message 1 "Cannot locale library `%s'." url)
5964       (find-file-read-only file))))
5965
5966 (defun gnus-button-handle-ctan (url)
5967   "Call `browse-url' when pushing a CTAN URL button."
5968   (funcall
5969    gnus-button-ctan-handler
5970    (concat
5971     gnus-ctan-url
5972     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
5973
5974 (defcustom gnus-button-tex-level 5
5975   "*Integer that says how many TeX-related buttons Gnus will show.
5976 The higher the number, the more buttons will appear and the more false
5977 positives are possible.  Note that you can set this variable local to
5978 specific groups.  Setting it higher in TeX groups is probably a good idea.
5979 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5980 how to set variables in specific groups."
5981   :group 'gnus-article-buttons
5982   :link '(custom-manual "(gnus)Group Parameters")
5983   :type 'integer)
5984
5985 (defcustom gnus-button-man-level 5
5986   "*Integer that says how many man-related buttons Gnus will show.
5987 The higher the number, the more buttons will appear and the more false
5988 positives are possible.  Note that you can set this variable local to
5989 specific groups.  Setting it higher in Unix groups is probably a good idea.
5990 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5991 how to set variables in specific groups."
5992   :group 'gnus-article-buttons
5993   :link '(custom-manual "(gnus)Group Parameters")
5994   :type 'integer)
5995
5996 (defcustom gnus-button-emacs-level 5
5997   "*Integer that says how many emacs-related buttons Gnus will show.
5998 The higher the number, the more buttons will appear and the more false
5999 positives are possible.  Note that you can set this variable local to
6000 specific groups.  Setting it higher in Emacs or Gnus related groups is
6001 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
6002 `gnus-parameters' on how to set variables in specific groups."
6003   :group 'gnus-article-buttons
6004   :link '(custom-manual "(gnus)Group Parameters")
6005   :type 'integer)
6006
6007 (defcustom gnus-button-message-level 5
6008   "*Integer that says how many buttons for news or mail messages will appear.
6009 The higher the number, the more buttons will appear and the more false
6010 positives are possible."
6011   ;; mail addresses, MIDs, URLs for news, ...
6012   :group 'gnus-article-buttons
6013   :type 'integer)
6014
6015 (defcustom gnus-button-browse-level 5
6016   "*Integer that says how many buttons for browsing will appear.
6017 The higher the number, the more buttons will appear and the more false
6018 positives are possible."
6019   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
6020   :group 'gnus-article-buttons
6021   :type 'integer)
6022
6023 (defcustom gnus-button-alist
6024   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
6025      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
6026     ("\\b\\(nntp\\|news\\):\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t
6027      gnus-button-handle-news 2)
6028     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
6029      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
6030     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
6031      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
6032     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
6033     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
6034      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
6035     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
6036      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
6037     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
6038      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
6039     ;; RFC 2368 (The mailto URL scheme)
6040     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6041      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6042     ("\\bmailto:\\([^ \n\t]+\\)"
6043      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6044     ;; CTAN
6045     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
6046              gnus-button-ctan-directory-regexp
6047              "[^][>)!;:,'\n\t ]+\\)")
6048      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
6049     ((concat "\\btex-archive/\\("
6050              gnus-button-ctan-directory-regexp
6051              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
6052      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
6053     ((concat
6054       "\\b\\("
6055       gnus-button-ctan-directory-regexp
6056       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
6057      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
6058     ;; This is info (home-grown style) <info://foo/bar+baz>
6059     ("\\binfo://\\([^'\">\n\t ]+\\)"
6060      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
6061     ;; Info GNOME style <info:foo#bar_baz>
6062     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
6063      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
6064     ;; Info KDE style <info:(foo)bar baz>
6065     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
6066      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
6067     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
6068      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6069     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
6070      ;; Info links like `C-h i d m CC Mode RET'
6071      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
6072     ;; This is custom
6073     ("\\bcustom:\\(//\\)?\\([^'\">\n\t ]+\\)"
6074      0 (>= gnus-button-emacs-level 5) gnus-button-handle-custom 2)
6075     ("M-x[ \t\n]customize-[^ ]+[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
6076      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1)
6077     ;; Emacs help commands
6078     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6079      ;; regexp doesn't match arguments containing ` '.
6080      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
6081     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6082      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
6083     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6084      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
6085     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6086      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
6087     ;; The following entries may lead to many false positives so don't enable
6088     ;; them by default (use a high button level):
6089     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>"
6090      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6091     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
6092      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6093     ("`\\([a-z][a-z0-9]+-[a-z]+-[-a-z]+\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
6094      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
6095     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
6096      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
6097     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
6098      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
6099     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6100      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
6101     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6102      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
6103     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6104      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
6105     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
6106      ;; Unlike the other regexps we really have to require quoting
6107      ;; here to determine where it ends.
6108      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
6109     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
6110     ("<URL: *\\([^<>]*\\)>"
6111      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6112     ;; RFC 2396 (2.4.3., delims) ...
6113     ("\"URL: *\\([^\"]*\\)\""
6114      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6115     ;; RFC 2396 (2.4.3., delims) ...
6116     ("\"URL: *\\([^\"]*\\)\""
6117      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6118     ;; Raw URLs.
6119     (gnus-button-url-regexp
6120      0 (>= gnus-button-browse-level 0) browse-url 0)
6121     ;; man pages
6122     ("\\b\\([a-z][a-z]+\\)([1-9])\\W"
6123      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
6124      gnus-button-handle-man 1)
6125     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
6126     ("\\b\\([a-z][-_.a-z0-9]+\\)([1-9])\\W"
6127      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
6128      gnus-button-handle-man 1)
6129     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
6130     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
6131     ("\\b\\([a-z][-+_.:a-z0-9]+\\)([1-9][X1a-z]*)\\W\\|\\b\\(X\\)([1-9])\\W"
6132      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
6133     ;; MID or mail: To avoid too many false positives we don't try to catch
6134     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
6135     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
6136     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
6137     ;; so that non-ambiguous entries (see above) match first.
6138     (gnus-button-mid-or-mail-regexp
6139      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
6140   "*Alist of regexps matching buttons in article bodies.
6141
6142 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
6143 REGEXP: is the string (case insensitive) matching text around the button (can
6144 also be Lisp expression evaluating to a string),
6145 BUTTON: is the number of the regexp grouping actually matching the button,
6146 FORM: is a Lisp expression which must eval to true for the button to
6147 be added,
6148 CALLBACK: is the function to call when the user push this button, and each
6149 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
6150
6151 CALLBACK can also be a variable, in that case the value of that
6152 variable it the real callback function."
6153   :group 'gnus-article-buttons
6154   :type '(repeat (list (choice regexp variable sexp)
6155                        (integer :tag "Button")
6156                        (sexp :tag "Form")
6157                        (function :tag "Callback")
6158                        (repeat :tag "Par"
6159                                :inline t
6160                                (integer :tag "Regexp group")))))
6161
6162 (defcustom gnus-header-button-alist
6163   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
6164      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
6165     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
6166      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
6167     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
6168      0 (>= gnus-button-message-level 0) gnus-button-mailto 0)
6169     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
6170      0 (>= gnus-button-browse-level 0) browse-url 0)
6171     ("^Subject:" gnus-button-url-regexp
6172      0 (>= gnus-button-browse-level 0) browse-url 0)
6173     ("^[^:]+:" gnus-button-url-regexp
6174      0 (>= gnus-button-browse-level 0) browse-url 0)
6175     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6176      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6177     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
6178      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
6179   "*Alist of headers and regexps to match buttons in article heads.
6180
6181 This alist is very similar to `gnus-button-alist', except that each
6182 alist has an additional HEADER element first in each entry:
6183
6184 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
6185
6186 HEADER is a regexp to match a header.  For a fuller explanation, see
6187 `gnus-button-alist'."
6188   :group 'gnus-article-buttons
6189   :group 'gnus-article-headers
6190   :type '(repeat (list (regexp :tag "Header")
6191                        (choice regexp variable)
6192                        (integer :tag "Button")
6193                        (sexp :tag "Form")
6194                        (function :tag "Callback")
6195                        (repeat :tag "Par"
6196                                :inline t
6197                                (integer :tag "Regexp group")))))
6198
6199 ;;; Commands:
6200
6201 (defun gnus-article-push-button (event)
6202   "Check text under the mouse pointer for a callback function.
6203 If the text under the mouse pointer has a `gnus-callback' property,
6204 call it with the value of the `gnus-data' text property."
6205   (interactive "e")
6206   (set-buffer (window-buffer (posn-window (event-start event))))
6207   (let* ((pos (posn-point (event-start event)))
6208          (data (get-text-property pos 'gnus-data))
6209          (fun (get-text-property pos 'gnus-callback)))
6210     (goto-char pos)
6211     (when fun
6212       (funcall fun data))))
6213
6214 (defun gnus-article-press-button ()
6215   "Check text at point for a callback function.
6216 If the text at point has a `gnus-callback' property,
6217 call it with the value of the `gnus-data' text property."
6218   (interactive)
6219   (let ((data (get-text-property (point) 'gnus-data))
6220         (fun (get-text-property (point) 'gnus-callback)))
6221     (when fun
6222       (funcall fun data))))
6223
6224 (defun gnus-article-highlight (&optional force)
6225   "Highlight current article.
6226 This function calls `gnus-article-highlight-headers',
6227 `gnus-article-highlight-citation',
6228 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6229 do the highlighting.  See the documentation for those functions."
6230   (interactive (list 'force))
6231   (gnus-article-highlight-headers)
6232   (gnus-article-highlight-citation force)
6233   (gnus-article-highlight-signature)
6234   (gnus-article-add-buttons force)
6235   (gnus-article-add-buttons-to-head))
6236
6237 (defun gnus-article-highlight-some (&optional force)
6238   "Highlight current article.
6239 This function calls `gnus-article-highlight-headers',
6240 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6241 do the highlighting.  See the documentation for those functions."
6242   (interactive (list 'force))
6243   (gnus-article-highlight-headers)
6244   (gnus-article-highlight-signature)
6245   (gnus-article-add-buttons))
6246
6247 (defun gnus-article-highlight-headers ()
6248   "Highlight article headers as specified by `gnus-header-face-alist'."
6249   (interactive)
6250   (gnus-with-article-headers
6251     (let ((alist gnus-header-face-alist)
6252           entry regexp header-face field-face from hpoints fpoints)
6253       (while (setq entry (pop alist))
6254         (goto-char (point-min))
6255         (setq regexp (concat "^\\("
6256                              (if (string-equal "" (nth 0 entry))
6257                                  "[^\t ]"
6258                                (nth 0 entry))
6259                              "\\)")
6260               header-face (nth 1 entry)
6261               field-face (nth 2 entry))
6262         (while (and (re-search-forward regexp nil t)
6263                     (not (eobp)))
6264           (beginning-of-line)
6265           (setq from (point))
6266           (unless (search-forward ":" nil t)
6267             (forward-char 1))
6268           (when (and header-face
6269                      (not (memq (point) hpoints)))
6270             (push (point) hpoints)
6271             (gnus-put-text-property from (point) 'face header-face))
6272           (when (and field-face
6273                      (not (memq (setq from (point)) fpoints)))
6274             (push from fpoints)
6275             (if (re-search-forward "^[^ \t]" nil t)
6276                 (forward-char -2)
6277               (goto-char (point-max)))
6278             (gnus-put-text-property from (point) 'face field-face)))))))
6279
6280 (defun gnus-article-highlight-signature ()
6281   "Highlight the signature in an article.
6282 It does this by highlighting everything after
6283 `gnus-signature-separator' using `gnus-signature-face'."
6284   (interactive)
6285   (gnus-with-article-buffer
6286     (let ((inhibit-point-motion-hooks t))
6287       (save-restriction
6288         (when (and gnus-signature-face
6289                    (gnus-article-narrow-to-signature))
6290           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
6291                             'face gnus-signature-face)
6292           (widen)
6293           (gnus-article-search-signature)
6294           (let ((start (match-beginning 0))
6295                 (end (set-marker (make-marker) (1+ (match-end 0)))))
6296             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
6297                                      end)))))))
6298
6299 (defun gnus-button-in-region-p (b e prop)
6300   "Say whether PROP exists in the region."
6301   (text-property-not-all b e prop nil))
6302
6303 (defun gnus-article-add-buttons (&optional force)
6304   "Find external references in the article and make buttons of them.
6305 \"External references\" are things like Message-IDs and URLs, as
6306 specified by `gnus-button-alist'."
6307   (interactive (list 'force))
6308   (gnus-with-article-buffer
6309     (let ((inhibit-point-motion-hooks t)
6310           (case-fold-search t)
6311           (alist gnus-button-alist)
6312           beg entry regexp)
6313       ;; Remove all old markers.
6314       (let (marker entry new-list)
6315         (while (setq marker (pop gnus-button-marker-list))
6316           (if (or (< marker (point-min)) (>= marker (point-max)))
6317               (push marker new-list)
6318             (goto-char marker)
6319             (when (setq entry (gnus-button-entry))
6320               (put-text-property (match-beginning (nth 1 entry))
6321                                  (match-end (nth 1 entry))
6322                                  'gnus-callback nil))
6323             (set-marker marker nil)))
6324         (setq gnus-button-marker-list new-list))
6325       ;; We skip the headers.
6326       (article-goto-body)
6327       (setq beg (point))
6328       (while (setq entry (pop alist))
6329         (setq regexp (eval (car entry)))
6330         (goto-char beg)
6331         (while (re-search-forward regexp nil t)
6332           (let* ((start (and entry (match-beginning (nth 1 entry))))
6333                  (end (and entry (match-end (nth 1 entry))))
6334                  (from (match-beginning 0)))
6335             (when (and (or (eq t (nth 2 entry))
6336                            (eval (nth 2 entry)))
6337                        (not (gnus-button-in-region-p
6338                              start end 'gnus-callback)))
6339               ;; That optional form returned non-nil, so we add the
6340               ;; button.
6341               (gnus-article-add-button
6342                start end 'gnus-button-push
6343                (car (push (set-marker (make-marker) from)
6344                           gnus-button-marker-list))))))))))
6345
6346 ;; Add buttons to the head of an article.
6347 (defun gnus-article-add-buttons-to-head ()
6348   "Add buttons to the head of the article."
6349   (interactive)
6350   (gnus-with-article-headers
6351     (let ((alist gnus-header-button-alist)
6352           entry beg end)
6353       (while alist
6354         ;; Each alist entry.
6355         (setq entry (pop alist))
6356         (goto-char (point-min))
6357         (while (re-search-forward (car entry) nil t)
6358           ;; Each header matching the entry.
6359           (setq beg (match-beginning 0))
6360           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
6361                              (match-beginning 0))
6362                         (point-max)))
6363           (goto-char beg)
6364           (while (re-search-forward (eval (nth 1 entry)) end t)
6365             ;; Each match within a header.
6366             (let* ((entry (cdr entry))
6367                    (start (match-beginning (nth 1 entry)))
6368                    (end (match-end (nth 1 entry)))
6369                    (form (nth 2 entry)))
6370               (goto-char (match-end 0))
6371               (when (eval form)
6372                 (gnus-article-add-button
6373                  start end (nth 3 entry)
6374                  (buffer-substring (match-beginning (nth 4 entry))
6375                                    (match-end (nth 4 entry)))))))
6376           (goto-char end))))))
6377
6378 ;;; External functions:
6379
6380 (defun gnus-article-add-button (from to fun &optional data)
6381   "Create a button between FROM and TO with callback FUN and data DATA."
6382   (when gnus-article-button-face
6383     (gnus-overlay-put (gnus-make-overlay from to)
6384                       'face gnus-article-button-face))
6385   (gnus-add-text-properties
6386    from to
6387    (nconc (and gnus-article-mouse-face
6388                (list gnus-mouse-face-prop gnus-article-mouse-face))
6389           (list 'gnus-callback fun)
6390           (and data (list 'gnus-data data))))
6391   (widget-convert-button 'link from to :action 'gnus-widget-press-button
6392                          :button-keymap gnus-widget-button-keymap))
6393
6394 ;;; Internal functions:
6395
6396 (defun gnus-article-set-globals ()
6397   (with-current-buffer gnus-summary-buffer
6398     (gnus-set-global-variables)))
6399
6400 (defun gnus-signature-toggle (end)
6401   (gnus-with-article-buffer
6402     (let ((inhibit-point-motion-hooks t))
6403       (if (text-property-any end (point-max) 'article-type 'signature)
6404           (progn
6405             (gnus-delete-wash-type 'signature)
6406             (gnus-remove-text-properties-when
6407              'article-type 'signature end (point-max)
6408              (cons 'article-type (cons 'signature
6409                                        gnus-hidden-properties))))
6410         (gnus-add-wash-type 'signature)
6411         (gnus-add-text-properties-when
6412          'article-type nil end (point-max)
6413          (cons 'article-type (cons 'signature
6414                                    gnus-hidden-properties)))))
6415     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
6416       (gnus-set-mode-line 'article))))
6417
6418 (defun gnus-button-entry ()
6419   ;; Return the first entry in `gnus-button-alist' matching this place.
6420   (let ((alist gnus-button-alist)
6421         (entry nil))
6422     (while alist
6423       (setq entry (pop alist))
6424       (if (looking-at (eval (car entry)))
6425           (setq alist nil)
6426         (setq entry nil)))
6427     entry))
6428
6429 (defun gnus-button-push (marker)
6430   ;; Push button starting at MARKER.
6431   (save-excursion
6432     (goto-char marker)
6433     (let* ((entry (gnus-button-entry))
6434            (inhibit-point-motion-hooks t)
6435            (fun (nth 3 entry))
6436            (args (mapcar (lambda (group)
6437                            (let ((string (match-string group)))
6438                              (set-text-properties
6439                               0 (length string) nil string)
6440                              string))
6441                          (nthcdr 4 entry))))
6442       (cond
6443        ((fboundp fun)
6444         (apply fun args))
6445        ((and (boundp fun)
6446              (fboundp (symbol-value fun)))
6447         (apply (symbol-value fun) args))
6448        (t
6449         (gnus-message 1 "You must define `%S' to use this button"
6450                       (cons fun args)))))))
6451
6452 (defun gnus-parse-news-url (url)
6453   (let (scheme server group message-id articles)
6454     (with-temp-buffer
6455       (insert url)
6456       (goto-char (point-min))
6457       (when (looking-at "\\([A-Za-z]+\\):")
6458         (setq scheme (match-string 1))
6459         (goto-char (match-end 0)))
6460       (when (looking-at "//\\([^/]+\\)/")
6461         (setq server (match-string 1))
6462         (goto-char (match-end 0)))
6463
6464       (cond
6465        ((looking-at "\\(.*@.*\\)")
6466         (setq message-id (match-string 1)))
6467        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
6468         (setq group (match-string 1)
6469               articles (split-string (match-string 2) "-")))
6470        ((looking-at "\\([^/]+\\)/?")
6471         (setq group (match-string 1)))
6472        (t
6473         (error "Unknown news URL syntax"))))
6474     (list scheme server group message-id articles)))
6475
6476 (defun gnus-button-handle-news (url)
6477   "Fetch a news URL."
6478   (destructuring-bind (scheme server group message-id articles)
6479       (gnus-parse-news-url url)
6480     (cond
6481      (message-id
6482       (save-excursion
6483         (set-buffer gnus-summary-buffer)
6484         (if server
6485             (let ((gnus-refer-article-method (list (list 'nntp server))))
6486               (gnus-summary-refer-article message-id))
6487           (gnus-summary-refer-article message-id))))
6488      (group
6489       (gnus-button-fetch-group url)))))
6490
6491 (defun gnus-button-handle-man (url)
6492   "Fetch a man page."
6493   (funcall gnus-button-man-handler url))
6494
6495 (defun gnus-button-handle-info-url (url)
6496   "Fetch an info URL."
6497   (setq url (mm-subst-char-in-string ?+ ?\  url))
6498   (cond
6499    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
6500     (gnus-info-find-node
6501      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
6502                      "Gnus")
6503              ")" (gnus-url-unhex-string (match-string 2 url)))))
6504    ((string-match "([^)\"]+)[^\"]+" url)
6505     (setq url
6506           (gnus-replace-in-string
6507            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
6508     (gnus-info-find-node url))
6509    (t (error "Can't parse %s" url))))
6510
6511 (defun gnus-button-handle-info-url-gnome (url)
6512   "Fetch GNOME style info URL."
6513   (setq url (mm-subst-char-in-string ?_ ?\  url))
6514   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
6515       (gnus-info-find-node
6516        (concat "("
6517                (gnus-url-unhex-string 
6518                  (match-string 1 url))
6519                ")"
6520                (or (gnus-url-unhex-string 
6521                     (match-string 2 url))
6522                    "Top")))
6523     (error "Can't parse %s" url)))
6524
6525 (defun gnus-button-handle-info-url-kde (url)
6526   "Fetch KDE style info URL."
6527   (gnus-info-find-node (gnus-url-unhex-string url)))
6528
6529 (defun gnus-button-handle-info-keystrokes (url)
6530   "Call `info' when pushing the corresponding URL button."
6531   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
6532   (info)
6533   (Info-directory)
6534   (Info-menu url))
6535
6536 (defun gnus-button-message-id (message-id)
6537   "Fetch MESSAGE-ID."
6538   (with-current-buffer gnus-summary-buffer
6539     (gnus-summary-refer-article message-id)))
6540
6541 (defun gnus-button-fetch-group (address)
6542   "Fetch GROUP specified by ADDRESS."
6543   (if (not (string-match "[:/]" address))
6544       ;; This is just a simple group url.
6545       (gnus-group-read-ephemeral-group address gnus-select-method)
6546     (if (not
6547          (string-match
6548           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
6549           address))
6550         (error "Can't parse %s" address)
6551       (gnus-group-read-ephemeral-group
6552        (match-string 4 address)
6553        `(nntp ,(match-string 1 address)
6554               (nntp-address ,(match-string 1 address))
6555               (nntp-port-number ,(if (match-end 3)
6556                                      (match-string 3 address)
6557                                    "nntp")))
6558        nil nil nil
6559        (and (match-end 6) (list (string-to-int (match-string 6 address))))))))
6560
6561 (defun gnus-url-parse-query-string (query &optional downcase)
6562   (let (retval pairs cur key val)
6563     (setq pairs (split-string query "&"))
6564     (while pairs
6565       (setq cur (car pairs)
6566             pairs (cdr pairs))
6567       (if (not (string-match "=" cur))
6568           nil                           ; Grace
6569         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
6570               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
6571         (if downcase
6572             (setq key (downcase key)))
6573         (setq cur (assoc key retval))
6574         (if cur
6575             (setcdr cur (cons val (cdr cur)))
6576           (setq retval (cons (list key val) retval)))))
6577     retval))
6578
6579 (defun gnus-url-mailto (url)
6580   ;; Send mail to someone
6581   (when (string-match "mailto:/*\\(.*\\)" url)
6582     (setq url (substring url (match-beginning 1) nil)))
6583   (let (to args subject func)
6584     (setq args (gnus-url-parse-query-string
6585                 (if (string-match "^\\?" url)
6586                     (substring url 1)
6587                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
6588                       (concat "to=" (match-string 1 url) "&"
6589                               (match-string 2 url))
6590                     (concat "to=" url)))
6591                 t)
6592           subject (cdr-safe (assoc "subject" args)))
6593     (gnus-msg-mail)
6594     (while args
6595       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
6596       (if (fboundp func)
6597           (funcall func)
6598         (message-position-on-field (caar args)))
6599       (insert (gnus-replace-in-string
6600                (mapconcat 'identity (reverse (cdar args)) ", ")
6601                "\r\n" "\n" t))
6602       (setq args (cdr args)))
6603     (if subject
6604         (message-goto-body)
6605       (message-goto-subject))))
6606
6607 (defun gnus-button-embedded-url (address)
6608   "Activate ADDRESS with `browse-url'."
6609   (browse-url (gnus-strip-whitespace address)))
6610
6611 ;;; Next/prev buttons in the article buffer.
6612
6613 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
6614 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
6615
6616 (defvar gnus-prev-page-map
6617   (let ((map (make-sparse-keymap)))
6618     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6619     (define-key map "\r" 'gnus-button-prev-page)
6620     map))
6621
6622 (defvar gnus-next-page-map
6623   (let ((map (make-sparse-keymap)))
6624     (define-key map gnus-mouse-2 'gnus-button-next-page)
6625     (define-key map "\r" 'gnus-button-next-page)
6626     map))
6627
6628 (defun gnus-insert-prev-page-button ()
6629   (let ((b (point))
6630         (buffer-read-only nil))
6631     (gnus-eval-format
6632      gnus-prev-page-line-format nil
6633      `(keymap ,gnus-prev-page-map
6634          gnus-prev t
6635          gnus-callback gnus-article-button-prev-page
6636          article-type annotation))
6637     (widget-convert-button
6638      'link b (if (bolp)
6639                  ;; Exclude a newline.
6640                  (1- (point))
6641                (point))
6642      :action 'gnus-button-prev-page
6643      :button-keymap gnus-prev-page-map)))
6644
6645 (defun gnus-button-next-page (&optional args more-args)
6646   "Go to the next page."
6647   (interactive)
6648   (let ((win (selected-window)))
6649     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6650     (gnus-article-next-page)
6651     (select-window win)))
6652
6653 (defun gnus-button-prev-page (&optional args more-args)
6654   "Go to the prev page."
6655   (interactive)
6656   (let ((win (selected-window)))
6657     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6658     (gnus-article-prev-page)
6659     (select-window win)))
6660
6661 (defun gnus-insert-next-page-button ()
6662   (let ((b (point))
6663         (buffer-read-only nil))
6664     (gnus-eval-format gnus-next-page-line-format nil
6665                       `(keymap ,gnus-next-page-map
6666                           gnus-next t
6667                           gnus-callback gnus-article-button-next-page
6668                           article-type annotation))
6669     (widget-convert-button
6670      'link b (if (bolp)
6671                  ;; Exclude a newline.
6672                  (1- (point))
6673                (point))
6674      :action 'gnus-button-next-page
6675      :button-keymap gnus-next-page-map)))
6676
6677 (defun gnus-article-button-next-page (arg)
6678   "Go to the next page."
6679   (interactive "P")
6680   (let ((win (selected-window)))
6681     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6682     (gnus-article-next-page)
6683     (select-window win)))
6684
6685 (defun gnus-article-button-prev-page (arg)
6686   "Go to the prev page."
6687   (interactive "P")
6688   (let ((win (selected-window)))
6689     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6690     (gnus-article-prev-page)
6691     (select-window win)))
6692
6693 (defvar gnus-decode-header-methods
6694   '(mail-decode-encoded-word-region)
6695   "List of methods used to decode headers.
6696
6697 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
6698 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
6699 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
6700 whose names match REGEXP.
6701
6702 For example:
6703 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
6704  mail-decode-encoded-word-region
6705  (\"chinese\" . rfc1843-decode-region))
6706 ")
6707
6708 (defvar gnus-decode-header-methods-cache nil)
6709
6710 (defun gnus-multi-decode-header (start end)
6711   "Apply the functions from `gnus-encoded-word-methods' that match."
6712   (unless (and gnus-decode-header-methods-cache
6713                (eq gnus-newsgroup-name
6714                    (car gnus-decode-header-methods-cache)))
6715     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
6716     (mapcar (lambda (x)
6717               (if (symbolp x)
6718                   (nconc gnus-decode-header-methods-cache (list x))
6719                 (if (and gnus-newsgroup-name
6720                          (string-match (car x) gnus-newsgroup-name))
6721                     (nconc gnus-decode-header-methods-cache
6722                            (list (cdr x))))))
6723           gnus-decode-header-methods))
6724   (let ((xlist gnus-decode-header-methods-cache))
6725     (pop xlist)
6726     (save-restriction
6727       (narrow-to-region start end)
6728       (while xlist
6729         (funcall (pop xlist) (point-min) (point-max))))))
6730
6731 ;;;
6732 ;;; Treatment top-level handling.
6733 ;;;
6734
6735 (defun gnus-treat-article (condition &optional part-number total-parts type)
6736   (let ((length (- (point-max) (point-min)))
6737         (alist gnus-treatment-function-alist)
6738         (article-goto-body-goes-to-point-min-p t)
6739         (treated-type
6740          (or (not type)
6741              (catch 'found
6742                (let ((list gnus-article-treat-types))
6743                  (while list
6744                    (when (string-match (pop list) type)
6745                      (throw 'found t)))))))
6746         (highlightp (gnus-visual-p 'article-highlight 'highlight))
6747         val elem)
6748     (gnus-run-hooks 'gnus-part-display-hook)
6749     (dolist (elem alist)
6750       (setq val
6751             (save-excursion
6752               (when (gnus-buffer-live-p gnus-summary-buffer)
6753                 (set-buffer gnus-summary-buffer))
6754               (symbol-value (car elem))))
6755       (when (and (or (consp val)
6756                      treated-type)
6757                  (gnus-treat-predicate val)
6758                  (or (not (get (car elem) 'highlight))
6759                      highlightp))
6760         (save-restriction
6761           (funcall (cadr elem)))))))
6762
6763 ;; Dynamic variables.
6764 (eval-when-compile
6765   (defvar part-number)
6766   (defvar total-parts)
6767   (defvar type)
6768   (defvar condition)
6769   (defvar length))
6770
6771 (defun gnus-treat-predicate (val)
6772   (cond
6773    ((null val)
6774     nil)
6775    (condition
6776     (eq condition val))
6777    ((and (listp val)
6778          (stringp (car val)))
6779     (apply 'gnus-or (mapcar `(lambda (s)
6780                                (string-match s ,(or gnus-newsgroup-name "")))
6781                             val)))
6782    ((listp val)
6783     (let ((pred (pop val)))
6784       (cond
6785        ((eq pred 'or)
6786         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
6787        ((eq pred 'and)
6788         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
6789        ((eq pred 'not)
6790         (not (gnus-treat-predicate (car val))))
6791        ((eq pred 'typep)
6792         (equal (car val) type))
6793        (t
6794         (error "%S is not a valid predicate" pred)))))
6795    ((eq val t)
6796     t)
6797    ((eq val 'head)
6798     nil)
6799    ((eq val 'last)
6800     (eq part-number total-parts))
6801    ((numberp val)
6802     (< length val))
6803    (t
6804     (error "%S is not a valid value" val))))
6805
6806 (defun gnus-article-encrypt-body (protocol &optional n)
6807   "Encrypt the article body."
6808   (interactive
6809    (list
6810     (or gnus-article-encrypt-protocol
6811         (completing-read "Encrypt protocol: "
6812                          gnus-article-encrypt-protocol-alist
6813                          nil t))
6814     current-prefix-arg))
6815   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
6816     (unless func
6817       (error (format "Can't find the encrypt protocol %s" protocol)))
6818     (if (member gnus-newsgroup-name '("nndraft:delayed"
6819                                       "nndraft:drafts"
6820                                       "nndraft:queue"))
6821         (error "Can't encrypt the article in group %s"
6822                gnus-newsgroup-name))
6823     (gnus-summary-iterate n
6824       (save-excursion
6825         (set-buffer gnus-summary-buffer)
6826         (let ((mail-parse-charset gnus-newsgroup-charset)
6827               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6828               (summary-buffer gnus-summary-buffer)
6829               references point)
6830           (gnus-set-global-variables)
6831           (when (gnus-group-read-only-p)
6832             (error "The current newsgroup does not support article encrypt"))
6833           (gnus-summary-show-article t)
6834           (setq references
6835               (or (mail-header-references gnus-current-headers) ""))
6836           (set-buffer gnus-article-buffer)
6837           (let* ((buffer-read-only nil)
6838                  (headers
6839                   (mapcar (lambda (field)
6840                             (and (save-restriction
6841                                    (message-narrow-to-head)
6842                                    (goto-char (point-min))
6843                                    (search-forward field nil t))
6844                                  (prog2
6845                                      (message-narrow-to-field)
6846                                      (buffer-string)
6847                                    (delete-region (point-min) (point-max))
6848                                    (widen))))
6849                           '("Content-Type:" "Content-Transfer-Encoding:"
6850                             "Content-Disposition:"))))
6851             (message-narrow-to-head)
6852             (message-remove-header "MIME-Version")
6853             (goto-char (point-max))
6854             (setq point (point))
6855             (insert (apply 'concat headers))
6856             (widen)
6857             (narrow-to-region point (point-max))
6858             (let ((message-options message-options))
6859               (message-options-set 'message-sender user-mail-address)
6860               (message-options-set 'message-recipients user-mail-address)
6861               (message-options-set 'message-sign-encrypt 'not)
6862               (funcall func))
6863             (goto-char (point-min))
6864             (insert "MIME-Version: 1.0\n")
6865             (widen)
6866             (gnus-summary-edit-article-done
6867              references nil summary-buffer t))
6868           (when gnus-keep-backlog
6869             (gnus-backlog-remove-article
6870              (car gnus-article-current) (cdr gnus-article-current)))
6871           (save-excursion
6872             (when (get-buffer gnus-original-article-buffer)
6873               (set-buffer gnus-original-article-buffer)
6874               (setq gnus-original-article nil)))
6875           (when gnus-use-cache
6876             (gnus-cache-update-article
6877              (car gnus-article-current) (cdr gnus-article-current))))))))
6878
6879 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
6880   "The following specs can be used:
6881 %t  The security MIME type
6882 %i  Additional info
6883 %d  Details
6884 %D  Details if button is pressed")
6885
6886 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
6887   "The following specs can be used:
6888 %t  The security MIME type
6889 %i  Additional info
6890 %d  Details
6891 %D  Details if button is pressed")
6892
6893 (defvar gnus-mime-security-button-line-format-alist
6894   '((?t gnus-tmp-type ?s)
6895     (?i gnus-tmp-info ?s)
6896     (?d gnus-tmp-details ?s)
6897     (?D gnus-tmp-pressed-details ?s)))
6898
6899 (defvar gnus-mime-security-button-map
6900   (let ((map (make-sparse-keymap)))
6901     (define-key map gnus-mouse-2 'gnus-article-push-button)
6902     (define-key map "\r" 'gnus-article-press-button)
6903     map))
6904
6905 (defvar gnus-mime-security-details-buffer nil)
6906
6907 (defvar gnus-mime-security-button-pressed nil)
6908
6909 (defvar gnus-mime-security-show-details-inline t
6910   "If non-nil, show details in the article buffer.")
6911
6912 (defun gnus-mime-security-verify-or-decrypt (handle)
6913   (mm-remove-parts (cdr handle))
6914   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
6915         point buffer-read-only)
6916     (if region
6917         (goto-char (car region)))
6918     (save-restriction
6919       (narrow-to-region (point) (point))
6920       (with-current-buffer (mm-handle-multipart-original-buffer handle)
6921         (let* ((mm-verify-option 'known)
6922                (mm-decrypt-option 'known)
6923                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
6924           (unless (eq nparts (cdr handle))
6925             (mm-destroy-parts (cdr handle))
6926             (setcdr handle nparts))))
6927       (setq point (point))
6928       (gnus-mime-display-security handle)
6929       (goto-char (point-max)))
6930     (when region
6931       (delete-region (point) (cdr region))
6932       (set-marker (car region) nil)
6933       (set-marker (cdr region) nil))
6934     (goto-char point)))
6935
6936 (defun gnus-mime-security-show-details (handle)
6937   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
6938     (if (not details)
6939         (gnus-message 5 "No details.")
6940       (if gnus-mime-security-show-details-inline
6941           (let ((gnus-mime-security-button-pressed
6942                  (not (get-text-property (point) 'gnus-mime-details)))
6943                 (gnus-mime-security-button-line-format
6944                  (get-text-property (point) 'gnus-line-format))
6945                 buffer-read-only)
6946             (forward-char -1)
6947             (while (eq (get-text-property (point) 'gnus-line-format)
6948                        gnus-mime-security-button-line-format)
6949               (forward-char -1))
6950             (forward-char)
6951             (save-restriction
6952               (narrow-to-region (point) (point))
6953               (gnus-insert-mime-security-button handle))
6954             (delete-region (point)
6955                            (or (text-property-not-all
6956                                 (point) (point-max)
6957                                 'gnus-line-format
6958                                 gnus-mime-security-button-line-format)
6959                                (point-max))))
6960         ;; Not inlined.
6961         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
6962             (with-current-buffer gnus-mime-security-details-buffer
6963               (erase-buffer)
6964               t)
6965           (setq gnus-mime-security-details-buffer
6966                 (gnus-get-buffer-create "*MIME Security Details*")))
6967         (with-current-buffer gnus-mime-security-details-buffer
6968           (insert details)
6969           (goto-char (point-min)))
6970         (pop-to-buffer gnus-mime-security-details-buffer)))))
6971
6972 (defun gnus-mime-security-press-button (handle)
6973   (save-excursion
6974     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6975         (gnus-mime-security-show-details handle)
6976       (gnus-mime-security-verify-or-decrypt handle))))
6977
6978 (defun gnus-insert-mime-security-button (handle &optional displayed)
6979   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
6980          (gnus-tmp-type
6981           (concat
6982            (or (nth 2 (assoc protocol mm-verify-function-alist))
6983                (nth 2 (assoc protocol mm-decrypt-function-alist))
6984                "Unknown")
6985            (if (equal (car handle) "multipart/signed")
6986                " Signed" " Encrypted")
6987            " Part"))
6988          (gnus-tmp-info
6989           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6990               "Undecided"))
6991          (gnus-tmp-details
6992           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
6993          gnus-tmp-pressed-details
6994          b e)
6995     (setq gnus-tmp-details
6996           (if gnus-tmp-details
6997               (concat "\n" gnus-tmp-details)
6998             ""))
6999     (setq gnus-tmp-pressed-details
7000           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
7001     (unless (bolp)
7002       (insert "\n"))
7003     (setq b (point))
7004     (gnus-eval-format
7005      gnus-mime-security-button-line-format
7006      gnus-mime-security-button-line-format-alist
7007      `(keymap ,gnus-mime-security-button-map
7008          gnus-callback gnus-mime-security-press-button
7009          gnus-line-format ,gnus-mime-security-button-line-format
7010          gnus-mime-details ,gnus-mime-security-button-pressed
7011          article-type annotation
7012          gnus-data ,handle))
7013     (setq e (if (bolp)
7014                 ;; Exclude a newline.
7015                 (1- (point))
7016               (point)))
7017     (widget-convert-button
7018      'link b e
7019      :mime-handle handle
7020      :action 'gnus-widget-press-button
7021      :button-keymap gnus-mime-security-button-map
7022      :help-echo
7023      (lambda (widget/window &optional overlay pos)
7024        ;; Needed to properly clear the message due to a bug in
7025        ;; wid-edit (XEmacs only).
7026        (when (boundp 'help-echo-owns-message)
7027          (setq help-echo-owns-message t))
7028        (format
7029         "%S: show detail"
7030         (aref gnus-mouse-2 0))))))
7031
7032 (defun gnus-mime-display-security (handle)
7033   (save-restriction
7034     (narrow-to-region (point) (point))
7035     (unless (gnus-unbuttonized-mime-type-p (car handle))
7036       (gnus-insert-mime-security-button handle))
7037     (gnus-mime-display-mixed (cdr handle))
7038     (unless (bolp)
7039       (insert "\n"))
7040     (unless (gnus-unbuttonized-mime-type-p (car handle))
7041       (let ((gnus-mime-security-button-line-format
7042              gnus-mime-security-button-end-line-format))
7043         (gnus-insert-mime-security-button handle)))
7044     (mm-set-handle-multipart-parameter
7045      handle 'gnus-region
7046      (cons (set-marker (make-marker) (point-min))
7047            (set-marker (make-marker) (point-max))))))
7048
7049 (gnus-ems-redefine)
7050
7051 (provide 'gnus-art)
7052
7053 (run-hooks 'gnus-art-load-hook)
7054
7055 ;;; gnus-art.el ends here