* gnus-art.el (gnus-mime-delete-part): Error message when no MIME
[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           ;; It is necessary to encode from fields before checking,
2489           ;; because `mail-header-parse-addresses' does not work
2490           ;; (reliably) on decoded headers.  And more, it is
2491           ;; impossible to use `gnus-fetch-original-field' here,
2492           ;; because `article-strip-banner' may be called in draft
2493           ;; buffers to preview them.
2494           (let ((from (save-restriction
2495                         (widen)
2496                         (article-narrow-to-head)
2497                         (mail-fetch-field "from"))))
2498             (when (and from
2499                        (setq from
2500                              (caar (mail-header-parse-addresses
2501                                     (mail-encode-encoded-word-string from)))))
2502               (catch 'found
2503                 (dolist (pair gnus-article-address-banner-alist)
2504                   (when (string-match (car pair) from)
2505                     (throw 'found
2506                            (article-really-strip-banner (cdr pair)))))))))))))
2507
2508 (defun article-really-strip-banner (banner)
2509   "Strip the banner specified by the argument."
2510   (save-excursion
2511     (save-restriction
2512       (let ((inhibit-point-motion-hooks t)
2513             (gnus-signature-limit nil)
2514             buffer-read-only)
2515         (article-goto-body)
2516         (cond
2517          ((eq banner 'signature)
2518           (when (gnus-article-narrow-to-signature)
2519             (widen)
2520             (forward-line -1)
2521             (delete-region (point) (point-max))))
2522          ((symbolp banner)
2523           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
2524               (while (re-search-forward banner nil t)
2525                 (delete-region (match-beginning 0) (match-end 0)))))
2526          ((stringp banner)
2527           (while (re-search-forward banner nil t)
2528             (delete-region (match-beginning 0) (match-end 0)))))))))
2529
2530 (defun article-babel ()
2531   "Translate article using an online translation service."
2532   (interactive)
2533   (require 'babel)
2534   (gnus-with-article-buffer
2535     (when (article-goto-body)
2536       (let* ((start (point))
2537              (end (point-max))
2538              (orig (buffer-substring start end))
2539              (trans (babel-as-string orig)))
2540         (save-restriction
2541           (narrow-to-region start end)
2542           (delete-region start end)
2543           (insert trans))))))
2544
2545 (defun article-hide-signature (&optional arg)
2546   "Hide the signature in the current article.
2547 If given a negative prefix, always show; if given a positive prefix,
2548 always hide."
2549   (interactive (gnus-article-hidden-arg))
2550   (unless (gnus-article-check-hidden-text 'signature arg)
2551     (save-excursion
2552       (save-restriction
2553         (let ((buffer-read-only nil))
2554           (when (gnus-article-narrow-to-signature)
2555             (gnus-article-hide-text-type
2556              (point-min) (point-max) 'signature))))))
2557   (gnus-set-mode-line 'article))
2558
2559 (defun article-strip-headers-in-body ()
2560   "Strip offensive headers from bodies."
2561   (interactive)
2562   (save-excursion
2563     (article-goto-body)
2564     (let ((case-fold-search t))
2565       (when (looking-at "x-no-archive:")
2566         (gnus-delete-line)))))
2567
2568 (defun article-strip-leading-blank-lines ()
2569   "Remove all blank lines from the beginning of the article."
2570   (interactive)
2571   (save-excursion
2572     (let ((inhibit-point-motion-hooks t)
2573           buffer-read-only)
2574       (when (article-goto-body)
2575         (while (and (not (eobp))
2576                     (looking-at "[ \t]*$"))
2577           (gnus-delete-line))))))
2578
2579 (defun article-narrow-to-head ()
2580   "Narrow the buffer to the head of the message.
2581 Point is left at the beginning of the narrowed-to region."
2582   (narrow-to-region
2583    (goto-char (point-min))
2584    (if (search-forward "\n\n" nil 1)
2585        (1- (point))
2586      (point-max)))
2587   (goto-char (point-min)))
2588
2589 (defun article-goto-body ()
2590   "Place point at the start of the body."
2591   (goto-char (point-min))
2592   (cond
2593    ;; This variable is only bound when dealing with separate
2594    ;; MIME body parts.
2595    (article-goto-body-goes-to-point-min-p
2596     t)
2597    ((search-forward "\n\n" nil t)
2598     t)
2599    (t
2600     (goto-char (point-max))
2601     nil)))
2602
2603 (defun article-strip-multiple-blank-lines ()
2604   "Replace consecutive blank lines with one empty line."
2605   (interactive)
2606   (save-excursion
2607     (let ((inhibit-point-motion-hooks t)
2608           buffer-read-only)
2609       ;; First make all blank lines empty.
2610       (article-goto-body)
2611       (while (re-search-forward "^[ \t]+$" nil t)
2612         (unless (gnus-annotation-in-region-p
2613                  (match-beginning 0) (match-end 0))
2614           (replace-match "" nil t)))
2615       ;; Then replace multiple empty lines with a single empty line.
2616       (article-goto-body)
2617       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
2618         (unless (gnus-annotation-in-region-p
2619                  (match-beginning 0) (match-end 0))
2620           (delete-region (match-beginning 1) (match-end 1)))))))
2621
2622 (defun article-strip-leading-space ()
2623   "Remove all white space from the beginning of the lines in the article."
2624   (interactive)
2625   (save-excursion
2626     (let ((inhibit-point-motion-hooks t)
2627           buffer-read-only)
2628       (article-goto-body)
2629       (while (re-search-forward "^[ \t]+" nil t)
2630         (replace-match "" t t)))))
2631
2632 (defun article-strip-trailing-space ()
2633   "Remove all white space from the end of the lines in the article."
2634   (interactive)
2635   (save-excursion
2636     (let ((inhibit-point-motion-hooks t)
2637           buffer-read-only)
2638       (article-goto-body)
2639       (while (re-search-forward "[ \t]+$" nil t)
2640         (replace-match "" t t)))))
2641
2642 (defun article-strip-blank-lines ()
2643   "Strip leading, trailing and multiple blank lines."
2644   (interactive)
2645   (article-strip-leading-blank-lines)
2646   (article-remove-trailing-blank-lines)
2647   (article-strip-multiple-blank-lines))
2648
2649 (defun article-strip-all-blank-lines ()
2650   "Strip all blank lines."
2651   (interactive)
2652   (save-excursion
2653     (let ((inhibit-point-motion-hooks t)
2654           buffer-read-only)
2655       (article-goto-body)
2656       (while (re-search-forward "^[ \t]*\n" nil t)
2657         (replace-match "" t t)))))
2658
2659 (defun gnus-article-narrow-to-signature ()
2660   "Narrow to the signature; return t if a signature is found, else nil."
2661   (let ((inhibit-point-motion-hooks t))
2662     (when (gnus-article-search-signature)
2663       (forward-line 1)
2664       ;; Check whether we have some limits to what we consider
2665       ;; to be a signature.
2666       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
2667                       (list gnus-signature-limit)))
2668             limit limited)
2669         (while (setq limit (pop limits))
2670           (if (or (and (integerp limit)
2671                        (< (- (point-max) (point)) limit))
2672                   (and (floatp limit)
2673                        (< (count-lines (point) (point-max)) limit))
2674                   (and (functionp limit)
2675                        (funcall limit))
2676                   (and (stringp limit)
2677                        (not (re-search-forward limit nil t))))
2678               ()                        ; This limit did not succeed.
2679             (setq limited t
2680                   limits nil)))
2681         (unless limited
2682           (narrow-to-region (point) (point-max))
2683           t)))))
2684
2685 (defun gnus-article-search-signature ()
2686   "Search the current buffer for the signature separator.
2687 Put point at the beginning of the signature separator."
2688   (let ((cur (point)))
2689     (goto-char (point-max))
2690     (if (if (stringp gnus-signature-separator)
2691             (re-search-backward gnus-signature-separator nil t)
2692           (let ((seps gnus-signature-separator))
2693             (while (and seps
2694                         (not (re-search-backward (car seps) nil t)))
2695               (pop seps))
2696             seps))
2697         t
2698       (goto-char cur)
2699       nil)))
2700
2701 (defun gnus-article-hidden-arg ()
2702   "Return the current prefix arg as a number, or 0 if no prefix."
2703   (list (if current-prefix-arg
2704             (prefix-numeric-value current-prefix-arg)
2705           0)))
2706
2707 (defun gnus-article-check-hidden-text (type arg)
2708   "Return nil if hiding is necessary.
2709 Arg can be nil or a number.  nil and positive means hide, negative
2710 means show, 0 means toggle."
2711   (save-excursion
2712     (save-restriction
2713       (let ((hide (gnus-article-hidden-text-p type)))
2714         (cond
2715          ((or (null arg)
2716               (> arg 0))
2717           nil)
2718          ((< arg 0)
2719           (gnus-article-show-hidden-text type)
2720           t)
2721          (t
2722           (if (eq hide 'hidden)
2723               (progn
2724                 (gnus-article-show-hidden-text type)
2725                 t)
2726             nil)))))))
2727
2728 (defun gnus-article-hidden-text-p (type)
2729   "Say whether the current buffer contains hidden text of type TYPE."
2730   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
2731     (while (and pos
2732                 (not (get-text-property pos 'invisible))
2733                 (not (get-text-property pos 'dummy-invisible)))
2734       (setq pos
2735             (text-property-any (1+ pos) (point-max) 'article-type type)))
2736     (if pos
2737         'hidden
2738       nil)))
2739
2740 (defun gnus-article-show-hidden-text (type &optional dummy)
2741   "Show all hidden text of type TYPE.
2742 Originally it is hide instead of DUMMY."
2743   (let ((buffer-read-only nil)
2744         (inhibit-point-motion-hooks t))
2745     (gnus-remove-text-properties-when
2746      'article-type type
2747      (point-min) (point-max)
2748      (cons 'article-type (cons type
2749                                gnus-hidden-properties)))
2750     (gnus-delete-wash-type type)))
2751
2752 (defconst article-time-units
2753   `((year . ,(* 365.25 24 60 60))
2754     (week . ,(* 7 24 60 60))
2755     (day . ,(* 24 60 60))
2756     (hour . ,(* 60 60))
2757     (minute . 60)
2758     (second . 1))
2759   "Mapping from time units to seconds.")
2760
2761 (defun gnus-article-forward-header ()
2762   "Move point to the start of the next header.
2763 If the current header is a continuation header, this can be several
2764 lines forward."
2765   (let ((ended nil))
2766     (while (not ended)
2767       (forward-line 1)
2768       (if (looking-at "[ \t]+[^ \t]")
2769           (forward-line 1)
2770         (setq ended t)))))
2771
2772 (defun article-date-ut (&optional type highlight header)
2773   "Convert DATE date to universal time in the current article.
2774 If TYPE is `local', convert to local time; if it is `lapsed', output
2775 how much time has lapsed since DATE.  For `lapsed', the value of
2776 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
2777 should replace the \"Date:\" one, or should be added below it."
2778   (interactive (list 'ut t))
2779   (let* ((header (or header
2780                      (message-fetch-field "date")
2781                      ""))
2782          (tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
2783          (date-regexp
2784           (cond
2785            ((not gnus-article-date-lapsed-new-header)
2786             tdate-regexp)
2787            ((eq type 'lapsed)
2788             "^X-Sent:[ \t]")
2789            (t
2790             "^Date:[ \t]")))
2791          (date (if (vectorp header) (mail-header-date header)
2792                  header))
2793          (inhibit-point-motion-hooks t)
2794          pos
2795          bface eface)
2796     (save-excursion
2797       (save-restriction
2798         (article-narrow-to-head)
2799         (when (re-search-forward tdate-regexp nil t)
2800           (setq bface (get-text-property (point-at-bol) 'face)
2801                 date (or (get-text-property (point-at-bol)
2802                                             'original-date)
2803                          date)
2804                 eface (get-text-property (1- (point-at-eol)) 'face))
2805           (forward-line 1))
2806         (when (and date (not (string= date "")))
2807           (goto-char (point-min))
2808           (let ((buffer-read-only nil))
2809             ;; Delete any old Date headers.
2810             (while (re-search-forward date-regexp nil t)
2811               (if pos
2812                   (delete-region (point-at-bol)
2813                                  (progn (gnus-article-forward-header)
2814                                         (point)))
2815                 (delete-region (point-at-bol)
2816                                (progn (gnus-article-forward-header)
2817                                       (forward-char -1)
2818                                       (point)))
2819                 (setq pos (point))))
2820             (when (and (not pos)
2821                        (re-search-forward tdate-regexp nil t))
2822               (forward-line 1))
2823             (gnus-goto-char pos)
2824             (insert (article-make-date-line date (or type 'ut)))
2825             (unless pos
2826               (insert "\n")
2827               (forward-line -1))
2828             ;; Do highlighting.
2829             (beginning-of-line)
2830             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
2831               (put-text-property (match-beginning 1) (1+ (match-end 1))
2832                                  'original-date date)
2833               (put-text-property (match-beginning 1) (1+ (match-end 1))
2834                                  'face bface)
2835               (put-text-property (match-beginning 2) (match-end 2)
2836                                  'face eface))))))))
2837
2838 (defun article-make-date-line (date type)
2839   "Return a DATE line of TYPE."
2840   (unless (memq type '(local ut original user iso8601 lapsed english))
2841     (error "Unknown conversion type: %s" type))
2842   (condition-case ()
2843       (let ((time (date-to-time date)))
2844         (cond
2845          ;; Convert to the local timezone.
2846          ((eq type 'local)
2847           (let ((tz (car (current-time-zone time))))
2848             (format "Date: %s %s%02d%02d" (current-time-string time)
2849                     (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2850                     (/ (% (abs tz) 3600) 60))))
2851          ;; Convert to Universal Time.
2852          ((eq type 'ut)
2853           (concat "Date: "
2854                   (current-time-string
2855                    (let* ((e (parse-time-string date))
2856                           (tm (apply 'encode-time e))
2857                           (ms (car tm))
2858                           (ls (- (cadr tm) (car (current-time-zone time)))))
2859                      (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
2860                            ((> ls 65535) (list (1+ ms) (- ls 65536)))
2861                            (t (list ms ls)))))
2862                   " UT"))
2863          ;; Get the original date from the article.
2864          ((eq type 'original)
2865           (concat "Date: " (if (string-match "\n+$" date)
2866                                (substring date 0 (match-beginning 0))
2867                              date)))
2868          ;; Let the user define the format.
2869          ((eq type 'user)
2870           (let ((format (or (condition-case nil
2871                                 (with-current-buffer gnus-summary-buffer
2872                                   gnus-article-time-format)
2873                               (error nil))
2874                             gnus-article-time-format)))
2875             (if (functionp format)
2876                 (funcall format time)
2877               (concat "Date: " (format-time-string format time)))))
2878          ;; ISO 8601.
2879          ((eq type 'iso8601)
2880           (let ((tz (car (current-time-zone time))))
2881             (concat
2882              "Date: "
2883              (format-time-string "%Y%m%dT%H%M%S" time)
2884              (format "%s%02d%02d"
2885                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
2886                      (/ (% (abs tz) 3600) 60)))))
2887          ;; Do an X-Sent lapsed format.
2888          ((eq type 'lapsed)
2889           ;; If the date is seriously mangled, the timezone functions are
2890           ;; liable to bug out, so we ignore all errors.
2891           (let* ((now (current-time))
2892                  (real-time (subtract-time now time))
2893                  (real-sec (and real-time
2894                                 (+ (* (float (car real-time)) 65536)
2895                                    (cadr real-time))))
2896                  (sec (and real-time (abs real-sec)))
2897                  num prev)
2898             (cond
2899              ((null real-time)
2900               "X-Sent: Unknown")
2901              ((zerop sec)
2902               "X-Sent: Now")
2903              (t
2904               (concat
2905                "X-Sent: "
2906                ;; This is a bit convoluted, but basically we go
2907                ;; through the time units for years, weeks, etc,
2908                ;; and divide things to see whether that results
2909                ;; in positive answers.
2910                (mapconcat
2911                 (lambda (unit)
2912                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
2913                       ;; The (remaining) seconds are too few to
2914                       ;; be divided into this time unit.
2915                       ""
2916                     ;; It's big enough, so we output it.
2917                     (setq sec (- sec (* num (cdr unit))))
2918                     (prog1
2919                         (concat (if prev ", " "") (int-to-string
2920                                                    (floor num))
2921                                 " " (symbol-name (car unit))
2922                                 (if (> num 1) "s" ""))
2923                       (setq prev t))))
2924                 article-time-units "")
2925                ;; If dates are odd, then it might appear like the
2926                ;; article was sent in the future.
2927                (if (> real-sec 0)
2928                    " ago"
2929                  " in the future"))))))
2930          ;; Display the date in proper English
2931          ((eq type 'english)
2932           (let ((dtime (decode-time time)))
2933             (concat
2934              "Date: the "
2935              (number-to-string (nth 3 dtime))
2936              (let ((digit (% (nth 3 dtime) 10)))
2937                (cond
2938                 ((memq (nth 3 dtime) '(11 12 13)) "th")
2939                 ((= digit 1) "st")
2940                 ((= digit 2) "nd")
2941                 ((= digit 3) "rd")
2942                 (t "th")))
2943              " of "
2944              (nth (1- (nth 4 dtime)) gnus-english-month-names)
2945              " "
2946              (number-to-string (nth 5 dtime))
2947              " at "
2948              (format "%02d" (nth 2 dtime))
2949              ":"
2950              (format "%02d" (nth 1 dtime)))))))
2951     (error
2952      (format "Date: %s (from Gnus)" date))))
2953
2954 (defun article-date-local (&optional highlight)
2955   "Convert the current article date to the local timezone."
2956   (interactive (list t))
2957   (article-date-ut 'local highlight))
2958
2959 (defun article-date-english (&optional highlight)
2960   "Convert the current article date to something that is proper English."
2961   (interactive (list t))
2962   (article-date-ut 'english highlight))
2963
2964 (defun article-date-original (&optional highlight)
2965   "Convert the current article date to what it was originally.
2966 This is only useful if you have used some other date conversion
2967 function and want to see what the date was before converting."
2968   (interactive (list t))
2969   (article-date-ut 'original highlight))
2970
2971 (defun article-date-lapsed (&optional highlight)
2972   "Convert the current article date to time lapsed since it was sent."
2973   (interactive (list t))
2974   (article-date-ut 'lapsed highlight))
2975
2976 (defun article-update-date-lapsed ()
2977   "Function to be run from a timer to update the lapsed time line."
2978   (let (deactivate-mark)
2979     (save-excursion
2980       (ignore-errors
2981         (walk-windows
2982          (lambda (w)
2983            (set-buffer (window-buffer w))
2984            (when (eq major-mode 'gnus-article-mode)
2985              (let ((mark (point-marker)))
2986                (goto-char (point-min))
2987                (when (re-search-forward "^X-Sent:" nil t)
2988                  (article-date-lapsed t))
2989                (goto-char (marker-position mark))
2990                (move-marker mark nil))))
2991          nil 'visible)))))
2992
2993 (defun gnus-start-date-timer (&optional n)
2994   "Start a timer to update the X-Sent header in the article buffers.
2995 The numerical prefix says how frequently (in seconds) the function
2996 is to run."
2997   (interactive "p")
2998   (unless n
2999     (setq n 1))
3000   (gnus-stop-date-timer)
3001   (setq article-lapsed-timer
3002         (run-at-time 1 n 'article-update-date-lapsed)))
3003
3004 (defun gnus-stop-date-timer ()
3005   "Stop the X-Sent timer."
3006   (interactive)
3007   (when article-lapsed-timer
3008     (nnheader-cancel-timer article-lapsed-timer)
3009     (setq article-lapsed-timer nil)))
3010
3011 (defun article-date-user (&optional highlight)
3012   "Convert the current article date to the user-defined format.
3013 This format is defined by the `gnus-article-time-format' variable."
3014   (interactive (list t))
3015   (article-date-ut 'user highlight))
3016
3017 (defun article-date-iso8601 (&optional highlight)
3018   "Convert the current article date to ISO8601."
3019   (interactive (list t))
3020   (article-date-ut 'iso8601 highlight))
3021
3022 ;; (defun article-show-all ()
3023 ;;   "Show all hidden text in the article buffer."
3024 ;;   (interactive)
3025 ;;   (save-excursion
3026 ;;     (let ((buffer-read-only nil))
3027 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3028
3029 (defun article-remove-leading-whitespace ()
3030   "Remove excessive whitespace from all headers."
3031   (interactive)
3032   (save-excursion
3033     (save-restriction
3034       (let ((buffer-read-only nil))
3035         (article-narrow-to-head)
3036         (goto-char (point-min))
3037         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3038           (delete-region (match-beginning 1) (match-end 1)))))))
3039
3040 (defun article-emphasize (&optional arg)
3041   "Emphasize text according to `gnus-emphasis-alist'."
3042   (interactive (gnus-article-hidden-arg))
3043   (unless (gnus-article-check-hidden-text 'emphasis arg)
3044     (save-excursion
3045       (let ((alist (or
3046                     (condition-case nil
3047                         (with-current-buffer gnus-summary-buffer
3048                           gnus-article-emphasis-alist)
3049                       (error))
3050                     gnus-emphasis-alist))
3051             (buffer-read-only nil)
3052             (props (append '(article-type emphasis)
3053                            gnus-hidden-properties))
3054             regexp elem beg invisible visible face)
3055         (article-goto-body)
3056         (setq beg (point))
3057         (while (setq elem (pop alist))
3058           (goto-char beg)
3059           (setq regexp (car elem)
3060                 invisible (nth 1 elem)
3061                 visible (nth 2 elem)
3062                 face (nth 3 elem))
3063           (while (re-search-forward regexp nil t)
3064             (when (and (match-beginning visible) (match-beginning invisible))
3065               (gnus-article-hide-text
3066                (match-beginning invisible) (match-end invisible) props)
3067               (gnus-article-unhide-text-type
3068                (match-beginning visible) (match-end visible) 'emphasis)
3069               (gnus-put-overlay-excluding-newlines
3070                (match-beginning visible) (match-end visible) 'face face)
3071               (gnus-add-wash-type 'emphasis)
3072               (goto-char (match-end invisible)))))))))
3073
3074 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3075   "Setup newsgroup emphasis alist."
3076   (unless gnus-article-emphasis-alist
3077     (let ((name (and gnus-newsgroup-name
3078                      (gnus-group-real-name gnus-newsgroup-name))))
3079       (make-local-variable 'gnus-article-emphasis-alist)
3080       (setq gnus-article-emphasis-alist
3081             (nconc
3082              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3083                (while (setq elem (pop alist))
3084                  (when (and name (string-match (car elem) name))
3085                    (setq alist nil
3086                          highlight (copy-sequence (cdr elem)))))
3087                highlight)
3088              (copy-sequence highlight-words)
3089              (if gnus-newsgroup-name
3090                  (copy-sequence (gnus-group-find-parameter
3091                                  gnus-newsgroup-name 'highlight-words t)))
3092              gnus-emphasis-alist)))))
3093
3094 (eval-when-compile
3095   (defvar gnus-summary-article-menu)
3096   (defvar gnus-summary-post-menu))
3097
3098 ;;; Saving functions.
3099
3100 (defun gnus-article-save (save-buffer file &optional num)
3101   "Save the currently selected article."
3102   (unless gnus-save-all-headers
3103     ;; Remove headers according to `gnus-saved-headers'.
3104     (let ((gnus-visible-headers
3105            (or gnus-saved-headers gnus-visible-headers))
3106           (gnus-article-buffer save-buffer))
3107       (save-excursion
3108         (set-buffer save-buffer)
3109         (article-hide-headers 1 t))))
3110   (save-window-excursion
3111     (if (not gnus-default-article-saver)
3112         (error "No default saver is defined")
3113       ;; !!! Magic!  The saving functions all save
3114       ;; `gnus-save-article-buffer' (or so they think), but we
3115       ;; bind that variable to our save-buffer.
3116       (set-buffer gnus-article-buffer)
3117       (let* ((gnus-save-article-buffer save-buffer)
3118              (filename
3119               (cond
3120                ((not gnus-prompt-before-saving) 'default)
3121                ((eq gnus-prompt-before-saving 'always) nil)
3122                (t file)))
3123              (gnus-number-of-articles-to-be-saved
3124               (when (eq gnus-prompt-before-saving t)
3125                 num)))                  ; Magic
3126         (set-buffer gnus-article-current-summary)
3127         (funcall gnus-default-article-saver filename)))))
3128
3129 (defun gnus-read-save-file-name (prompt &optional filename
3130                                         function group headers variable)
3131   (let ((default-name
3132           (funcall function group headers (symbol-value variable)))
3133         result)
3134     (setq result
3135           (expand-file-name
3136            (cond
3137             ((eq filename 'default)
3138              default-name)
3139             ((eq filename t)
3140              default-name)
3141             (filename filename)
3142             (t
3143              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3144                     (prompt
3145                      (format prompt
3146                              (if (and gnus-number-of-articles-to-be-saved
3147                                       (> gnus-number-of-articles-to-be-saved 1))
3148                                  (format "these %d articles"
3149                                          gnus-number-of-articles-to-be-saved)
3150                                "this article")))
3151                     (file
3152                      ;; Let the split methods have their say.
3153                      (cond
3154                       ;; No split name was found.
3155                       ((null split-name)
3156                        (read-file-name
3157                         (concat prompt " (default "
3158                                 (file-name-nondirectory default-name) ") ")
3159                         (file-name-directory default-name)
3160                         default-name))
3161                       ;; A single group name is returned.
3162                       ((stringp split-name)
3163                        (setq default-name
3164                              (funcall function split-name headers
3165                                       (symbol-value variable)))
3166                        (read-file-name
3167                         (concat prompt " (default "
3168                                 (file-name-nondirectory default-name) ") ")
3169                         (file-name-directory default-name)
3170                         default-name))
3171                       ;; A single split name was found
3172                       ((= 1 (length split-name))
3173                        (let* ((name (expand-file-name
3174                                      (car split-name)
3175                                      gnus-article-save-directory))
3176                               (dir (cond ((file-directory-p name)
3177                                           (file-name-as-directory name))
3178                                          ((file-exists-p name) name)
3179                                          (t gnus-article-save-directory))))
3180                          (read-file-name
3181                           (concat prompt " (default " name ") ")
3182                           dir name)))
3183                       ;; A list of splits was found.
3184                       (t
3185                        (setq split-name (nreverse split-name))
3186                        (let (result)
3187                          (let ((file-name-history
3188                                 (nconc split-name file-name-history)))
3189                            (setq result
3190                                  (expand-file-name
3191                                   (read-file-name
3192                                    (concat prompt " (`M-p' for defaults) ")
3193                                    gnus-article-save-directory
3194                                    (car split-name))
3195                                   gnus-article-save-directory)))
3196                          (car (push result file-name-history)))))))
3197                ;; Create the directory.
3198                (gnus-make-directory (file-name-directory file))
3199                ;; If we have read a directory, we append the default file name.
3200                (when (file-directory-p file)
3201                  (setq file (expand-file-name (file-name-nondirectory
3202                                                default-name)
3203                                               (file-name-as-directory file))))
3204                ;; Possibly translate some characters.
3205                (nnheader-translate-file-chars file))))))
3206     (gnus-make-directory (file-name-directory result))
3207     (set variable result)))
3208
3209 (defun gnus-article-archive-name (group)
3210   "Return the first instance of an \"Archive-name\" in the current buffer."
3211   (let ((case-fold-search t))
3212     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3213       (nnheader-concat gnus-article-save-directory
3214                        (match-string 1)))))
3215
3216 (defun gnus-article-nndoc-name (group)
3217   "If GROUP is an nndoc group, return the name of the parent group."
3218   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3219     (gnus-group-get-parameter group 'save-article-group)))
3220
3221 (defun gnus-summary-save-in-rmail (&optional filename)
3222   "Append this article to Rmail file.
3223 Optional argument FILENAME specifies file name.
3224 Directory to save to is default to `gnus-article-save-directory'."
3225   (setq filename (gnus-read-save-file-name
3226                   "Save %s in rmail file:" filename
3227                   gnus-rmail-save-name gnus-newsgroup-name
3228                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3229   (gnus-eval-in-buffer-window gnus-save-article-buffer
3230     (save-excursion
3231       (save-restriction
3232         (widen)
3233         (gnus-output-to-rmail filename))))
3234   filename)
3235
3236 (defun gnus-summary-save-in-mail (&optional filename)
3237   "Append this article to Unix mail file.
3238 Optional argument FILENAME specifies file name.
3239 Directory to save to is default to `gnus-article-save-directory'."
3240   (setq filename (gnus-read-save-file-name
3241                   "Save %s in Unix mail file:" filename
3242                   gnus-mail-save-name gnus-newsgroup-name
3243                   gnus-current-headers 'gnus-newsgroup-last-mail))
3244   (gnus-eval-in-buffer-window gnus-save-article-buffer
3245     (save-excursion
3246       (save-restriction
3247         (widen)
3248         (if (and (file-readable-p filename)
3249                  (file-regular-p filename)
3250                  (mail-file-babyl-p filename))
3251             (rmail-output-to-rmail-file filename t)
3252           (gnus-output-to-mail filename)))))
3253   filename)
3254
3255 (defun gnus-summary-save-in-file (&optional filename overwrite)
3256   "Append this article to file.
3257 Optional argument FILENAME specifies file name.
3258 Directory to save to is default to `gnus-article-save-directory'."
3259   (setq filename (gnus-read-save-file-name
3260                   "Save %s in file:" filename
3261                   gnus-file-save-name gnus-newsgroup-name
3262                   gnus-current-headers 'gnus-newsgroup-last-file))
3263   (gnus-eval-in-buffer-window gnus-save-article-buffer
3264     (save-excursion
3265       (save-restriction
3266         (widen)
3267         (when (and overwrite
3268                    (file-exists-p filename))
3269           (delete-file filename))
3270         (gnus-output-to-file filename))))
3271   filename)
3272
3273 (defun gnus-summary-write-to-file (&optional filename)
3274   "Write this article to a file, overwriting it if the file exists.
3275 Optional argument FILENAME specifies file name.
3276 The directory to save in defaults to `gnus-article-save-directory'."
3277   (gnus-summary-save-in-file nil t))
3278
3279 (defun gnus-summary-save-body-in-file (&optional filename)
3280   "Append this article body to a file.
3281 Optional argument FILENAME specifies file name.
3282 The directory to save in defaults to `gnus-article-save-directory'."
3283   (setq filename (gnus-read-save-file-name
3284                   "Save %s body in file:" filename
3285                   gnus-file-save-name gnus-newsgroup-name
3286                   gnus-current-headers 'gnus-newsgroup-last-file))
3287   (gnus-eval-in-buffer-window gnus-save-article-buffer
3288     (save-excursion
3289       (save-restriction
3290         (widen)
3291         (when (article-goto-body)
3292           (narrow-to-region (point) (point-max)))
3293         (gnus-output-to-file filename))))
3294   filename)
3295
3296 (defun gnus-summary-save-in-pipe (&optional command)
3297   "Pipe this article to subprocess."
3298   (setq command
3299         (cond ((and (eq command 'default)
3300                     gnus-last-shell-command)
3301                gnus-last-shell-command)
3302               ((stringp command)
3303                command)
3304               (t (read-string
3305                   (format
3306                    "Shell command on %s: "
3307                    (if (and gnus-number-of-articles-to-be-saved
3308                             (> gnus-number-of-articles-to-be-saved 1))
3309                        (format "these %d articles"
3310                                gnus-number-of-articles-to-be-saved)
3311                      "this article"))
3312                   gnus-last-shell-command))))
3313   (when (string-equal command "")
3314     (if gnus-last-shell-command
3315         (setq command gnus-last-shell-command)
3316       (error "A command is required")))
3317   (gnus-eval-in-buffer-window gnus-article-buffer
3318     (save-restriction
3319       (widen)
3320       (shell-command-on-region (point-min) (point-max) command nil)))
3321   (setq gnus-last-shell-command command))
3322
3323 (defun gnus-summary-pipe-to-muttprint (&optional command)
3324   "Pipe this article to muttprint."
3325   (setq command (read-string
3326                  "Print using command: " gnus-summary-muttprint-program
3327                  nil gnus-summary-muttprint-program))
3328   (gnus-summary-save-in-pipe command))
3329
3330 ;;; Article file names when saving.
3331
3332 (defun gnus-capitalize-newsgroup (newsgroup)
3333   "Capitalize NEWSGROUP name."
3334   (when (not (zerop (length newsgroup)))
3335     (concat (char-to-string (upcase (aref newsgroup 0)))
3336             (substring newsgroup 1))))
3337
3338 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3339   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3340 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3341 Otherwise, it is like ~/News/news/group/num."
3342   (let ((default
3343           (expand-file-name
3344            (concat (if (gnus-use-long-file-name 'not-save)
3345                        (gnus-capitalize-newsgroup newsgroup)
3346                      (gnus-newsgroup-directory-form newsgroup))
3347                    "/" (int-to-string (mail-header-number headers)))
3348            gnus-article-save-directory)))
3349     (if (and last-file
3350              (string-equal (file-name-directory default)
3351                            (file-name-directory last-file))
3352              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3353         default
3354       (or last-file default))))
3355
3356 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
3357   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3358 If variable `gnus-use-long-file-name' is non-nil, it is
3359 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
3360   (let ((default
3361           (expand-file-name
3362            (concat (if (gnus-use-long-file-name 'not-save)
3363                        newsgroup
3364                      (gnus-newsgroup-directory-form newsgroup))
3365                    "/" (int-to-string (mail-header-number headers)))
3366            gnus-article-save-directory)))
3367     (if (and last-file
3368              (string-equal (file-name-directory default)
3369                            (file-name-directory last-file))
3370              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3371         default
3372       (or last-file default))))
3373
3374 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
3375   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3376 If variable `gnus-use-long-file-name' is non-nil, it is
3377 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
3378   (or last-file
3379       (expand-file-name
3380        (if (gnus-use-long-file-name 'not-save)
3381            newsgroup
3382          (file-relative-name
3383           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
3384           default-directory))
3385        gnus-article-save-directory)))
3386
3387 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
3388   "Generate file name from sender."
3389   (let ((from (mail-header-from headers)))
3390     (expand-file-name
3391      (if (and from (string-match "\\([^ <]+\\)@" from))
3392          (match-string 1 from)
3393        "nobody")
3394      gnus-article-save-directory)))
3395
3396 (defun article-verify-x-pgp-sig ()
3397   "Verify X-PGP-Sig."
3398   (interactive)
3399   (if (gnus-buffer-live-p gnus-original-article-buffer)
3400       (let ((sig (with-current-buffer gnus-original-article-buffer
3401                    (gnus-fetch-field "X-PGP-Sig")))
3402             items info headers)
3403         (when (and sig
3404                    mml2015-use
3405                    (mml2015-clear-verify-function))
3406           (with-temp-buffer
3407             (insert-buffer-substring gnus-original-article-buffer)
3408             (setq items (split-string sig))
3409             (message-narrow-to-head)
3410             (let ((inhibit-point-motion-hooks t)
3411                   (case-fold-search t))
3412               ;; Don't verify multiple headers.
3413               (setq headers (mapconcat (lambda (header)
3414                                          (concat header ": "
3415                                                  (mail-fetch-field header)
3416                                                  "\n"))
3417                                        (split-string (nth 1 items) ",") "")))
3418             (delete-region (point-min) (point-max))
3419             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
3420             (insert "X-Signed-Headers: " (nth 1 items) "\n")
3421             (insert headers)
3422             (widen)
3423             (forward-line)
3424             (while (not (eobp))
3425               (if (looking-at "^-")
3426                   (insert "- "))
3427               (forward-line))
3428             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
3429             (insert "Version: " (car items) "\n\n")
3430             (insert (mapconcat 'identity (cddr items) "\n"))
3431             (insert "\n-----END PGP SIGNATURE-----\n")
3432             (let ((mm-security-handle (list (format "multipart/signed"))))
3433               (mml2015-clean-buffer)
3434               (let ((coding-system-for-write (or gnus-newsgroup-charset
3435                                                  'iso-8859-1)))
3436                 (funcall (mml2015-clear-verify-function)))
3437               (setq info
3438                     (or (mm-handle-multipart-ctl-parameter
3439                          mm-security-handle 'gnus-details)
3440                         (mm-handle-multipart-ctl-parameter
3441                          mm-security-handle 'gnus-info)))))
3442           (when info
3443             (let (buffer-read-only bface eface)
3444               (save-restriction
3445                 (message-narrow-to-head)
3446                 (goto-char (point-max))
3447                 (forward-line -1)
3448                 (setq bface (get-text-property (point-at-bol) 'face)
3449                       eface (get-text-property (1- (point-at-eol)) 'face))
3450                 (message-remove-header "X-Gnus-PGP-Verify")
3451                 (if (re-search-forward "^X-PGP-Sig:" nil t)
3452                     (forward-line)
3453                   (goto-char (point-max)))
3454                 (narrow-to-region (point) (point))
3455                 (insert "X-Gnus-PGP-Verify: " info "\n")
3456                 (goto-char (point-min))
3457                 (forward-line)
3458                 (while (not (eobp))
3459                   (if (not (looking-at "^[ \t]"))
3460                       (insert " "))
3461                   (forward-line))
3462                 ;; Do highlighting.
3463                 (goto-char (point-min))
3464                 (when (looking-at "\\([^:]+\\): *")
3465                   (put-text-property (match-beginning 1) (1+ (match-end 1))
3466                                      'face bface)
3467                   (put-text-property (match-end 0) (point-max)
3468                                      'face eface)))))))))
3469
3470 (defun article-verify-cancel-lock ()
3471   "Verify Cancel-Lock header."
3472   (interactive)
3473   (if (gnus-buffer-live-p gnus-original-article-buffer)
3474       (canlock-verify gnus-original-article-buffer)))
3475
3476 (eval-and-compile
3477   (mapcar
3478    (lambda (func)
3479      (let (afunc gfunc)
3480        (if (consp func)
3481            (setq afunc (car func)
3482                  gfunc (cdr func))
3483          (setq afunc func
3484                gfunc (intern (format "gnus-%s" func))))
3485        (defalias gfunc
3486          (when (fboundp afunc)
3487            `(lambda (&optional interactive &rest args)
3488               ,(documentation afunc t)
3489               (interactive (list t))
3490               (save-excursion
3491                 (set-buffer gnus-article-buffer)
3492                 (if interactive
3493                     (call-interactively ',afunc)
3494                   (apply ',afunc args))))))))
3495    '(article-hide-headers
3496      article-verify-x-pgp-sig
3497      article-verify-cancel-lock
3498      article-hide-boring-headers
3499      article-treat-overstrike
3500      article-treat-ansi-sequences
3501      article-fill-long-lines
3502      article-capitalize-sentences
3503      article-remove-cr
3504      article-remove-leading-whitespace
3505      article-display-x-face
3506      article-display-face
3507      article-de-quoted-unreadable
3508      article-de-base64-unreadable
3509      article-decode-HZ
3510      article-wash-html
3511      article-unsplit-urls
3512      article-hide-list-identifiers
3513      article-strip-banner
3514      article-babel
3515      article-hide-pem
3516      article-hide-signature
3517      article-strip-headers-in-body
3518      article-remove-trailing-blank-lines
3519      article-strip-leading-blank-lines
3520      article-strip-multiple-blank-lines
3521      article-strip-leading-space
3522      article-strip-trailing-space
3523      article-strip-blank-lines
3524      article-strip-all-blank-lines
3525      article-date-local
3526      article-date-english
3527      article-date-iso8601
3528      article-date-original
3529      article-date-ut
3530      article-decode-mime-words
3531      article-decode-charset
3532      article-decode-encoded-words
3533      article-date-user
3534      article-date-lapsed
3535      article-emphasize
3536      article-treat-dumbquotes
3537      article-normalize-headers
3538 ;;     (article-show-all . gnus-article-show-all-headers)
3539      )))
3540 \f
3541 ;;;
3542 ;;; Gnus article mode
3543 ;;;
3544
3545 (put 'gnus-article-mode 'mode-class 'special)
3546
3547 (set-keymap-parent gnus-article-mode-map widget-keymap)
3548
3549 (gnus-define-keys gnus-article-mode-map
3550   " " gnus-article-goto-next-page
3551   "\177" gnus-article-goto-prev-page
3552   [delete] gnus-article-goto-prev-page
3553   [backspace] gnus-article-goto-prev-page
3554   "\C-c^" gnus-article-refer-article
3555   "h" gnus-article-show-summary
3556   "s" gnus-article-show-summary
3557   "\C-c\C-m" gnus-article-mail
3558   "?" gnus-article-describe-briefly
3559   "e" gnus-summary-edit-article
3560   "<" beginning-of-buffer
3561   ">" end-of-buffer
3562   "\C-c\C-i" gnus-info-find-node
3563   "\C-c\C-b" gnus-bug
3564   "R" gnus-article-reply-with-original
3565   "F" gnus-article-followup-with-original
3566   "\C-hk" gnus-article-describe-key
3567   "\C-hc" gnus-article-describe-key-briefly
3568
3569   "\C-d" gnus-article-read-summary-keys
3570   "\M-*" gnus-article-read-summary-keys
3571   "\M-#" gnus-article-read-summary-keys
3572   "\M-^" gnus-article-read-summary-keys
3573   "\M-g" gnus-article-read-summary-keys)
3574
3575 (substitute-key-definition
3576  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
3577
3578 (defun gnus-article-make-menu-bar ()
3579   (unless (boundp 'gnus-article-commands-menu)
3580     (gnus-summary-make-menu-bar))
3581   (gnus-turn-off-edit-menu 'article)
3582   (unless (boundp 'gnus-article-article-menu)
3583     (easy-menu-define
3584      gnus-article-article-menu gnus-article-mode-map ""
3585      '("Article"
3586        ["Scroll forwards" gnus-article-goto-next-page t]
3587        ["Scroll backwards" gnus-article-goto-prev-page t]
3588        ["Show summary" gnus-article-show-summary t]
3589        ["Fetch Message-ID at point" gnus-article-refer-article t]
3590        ["Mail to address at point" gnus-article-mail t]
3591        ["Send a bug report" gnus-bug t]))
3592
3593     (easy-menu-define
3594      gnus-article-treatment-menu gnus-article-mode-map ""
3595      ;; Fixme: this should use :active (and maybe :visible).
3596      '("Treatment"
3597        ["Hide headers" gnus-article-hide-headers t]
3598        ["Hide signature" gnus-article-hide-signature t]
3599        ["Hide citation" gnus-article-hide-citation t]
3600        ["Treat overstrike" gnus-article-treat-overstrike t]
3601        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
3602        ["Remove carriage return" gnus-article-remove-cr t]
3603        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
3604        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
3605        ["Remove base64" gnus-article-de-base64-unreadable t]
3606        ["Treat html" gnus-article-wash-html t]
3607        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
3608        ["Decode HZ" gnus-article-decode-HZ t]))
3609
3610     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
3611
3612     ;; Note "Post" menu is defined in gnus-sum.el for consistency
3613
3614     (gnus-run-hooks 'gnus-article-menu-hook)))
3615
3616 (defun gnus-article-mode ()
3617   "Major mode for displaying an article.
3618
3619 All normal editing commands are switched off.
3620
3621 The following commands are available in addition to all summary mode
3622 commands:
3623 \\<gnus-article-mode-map>
3624 \\[gnus-article-next-page]\t Scroll the article one page forwards
3625 \\[gnus-article-prev-page]\t Scroll the article one page backwards
3626 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
3627 \\[gnus-article-show-summary]\t Display the summary buffer
3628 \\[gnus-article-mail]\t Send a reply to the address near point
3629 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
3630 \\[gnus-info-find-node]\t Go to the Gnus info node"
3631   (interactive)
3632   (gnus-simplify-mode-line)
3633   (setq mode-name "Article")
3634   (setq major-mode 'gnus-article-mode)
3635   (make-local-variable 'minor-mode-alist)
3636   (use-local-map gnus-article-mode-map)
3637   (when (gnus-visual-p 'article-menu 'menu)
3638     (gnus-article-make-menu-bar)
3639     (when gnus-summary-tool-bar-map
3640       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
3641   (gnus-update-format-specifications nil 'article-mode)
3642   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
3643   (set (make-local-variable 'gnus-page-broken) nil)
3644   (make-local-variable 'gnus-button-marker-list)
3645   (make-local-variable 'gnus-article-current-summary)
3646   (make-local-variable 'gnus-article-mime-handles)
3647   (make-local-variable 'gnus-article-decoded-p)
3648   (make-local-variable 'gnus-article-mime-handle-alist)
3649   (make-local-variable 'gnus-article-wash-types)
3650   (make-local-variable 'gnus-article-image-alist)
3651   (make-local-variable 'gnus-article-charset)
3652   (make-local-variable 'gnus-article-ignored-charsets)
3653   (gnus-set-default-directory)
3654   (buffer-disable-undo)
3655   (setq buffer-read-only t)
3656   (set-syntax-table gnus-article-mode-syntax-table)
3657   (mm-enable-multibyte)
3658   (gnus-run-hooks 'gnus-article-mode-hook))
3659
3660 (defun gnus-article-setup-buffer ()
3661   "Initialize the article buffer."
3662   (let* ((name (if gnus-single-article-buffer "*Article*"
3663                  (concat "*Article " gnus-newsgroup-name "*")))
3664          (original
3665           (progn (string-match "\\*Article" name)
3666                  (concat " *Original Article"
3667                          (substring name (match-end 0))))))
3668     (setq gnus-article-buffer name)
3669     (setq gnus-original-article-buffer original)
3670     (setq gnus-article-mime-handle-alist nil)
3671     ;; This might be a variable local to the summary buffer.
3672     (unless gnus-single-article-buffer
3673       (save-excursion
3674         (set-buffer gnus-summary-buffer)
3675         (setq gnus-article-buffer name)
3676         (setq gnus-original-article-buffer original)
3677         (gnus-set-global-variables)))
3678     (gnus-article-setup-highlight-words)
3679     ;; Init original article buffer.
3680     (save-excursion
3681       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
3682       (mm-enable-multibyte)
3683       (setq major-mode 'gnus-original-article-mode)
3684       (make-local-variable 'gnus-original-article))
3685     (if (get-buffer name)
3686         (save-excursion
3687           (set-buffer name)
3688           (when (and gnus-article-edit-mode
3689                      (buffer-modified-p)
3690                      (not
3691                       (y-or-n-p "Article mode edit in progress; discard? ")))
3692             (error "Action aborted"))
3693           (set (make-local-variable 'gnus-article-edit-mode) nil)
3694           (when gnus-article-mime-handles
3695             (mm-destroy-parts gnus-article-mime-handles)
3696             (setq gnus-article-mime-handles nil))
3697           ;; Set it to nil in article-buffer!
3698           (setq gnus-article-mime-handle-alist nil)
3699           (buffer-disable-undo)
3700           (setq buffer-read-only t)
3701           ;; This list just keeps growing if we don't reset it.
3702           (setq gnus-button-marker-list nil)
3703           (unless (eq major-mode 'gnus-article-mode)
3704             (gnus-article-mode))
3705           (current-buffer))
3706       (save-excursion
3707         (set-buffer (gnus-get-buffer-create name))
3708         (gnus-article-mode)
3709         (make-local-variable 'gnus-summary-buffer)
3710         (gnus-summary-set-local-parameters gnus-newsgroup-name)
3711         (current-buffer)))))
3712
3713 ;; Set article window start at LINE, where LINE is the number of lines
3714 ;; from the head of the article.
3715 (defun gnus-article-set-window-start (&optional line)
3716   (set-window-start
3717    (gnus-get-buffer-window gnus-article-buffer t)
3718    (save-excursion
3719      (set-buffer gnus-article-buffer)
3720      (goto-char (point-min))
3721      (if (not line)
3722          (point-min)
3723        (gnus-message 6 "Moved to bookmark")
3724        (search-forward "\n\n" nil t)
3725        (forward-line line)
3726        (point)))))
3727
3728 (defun gnus-article-prepare (article &optional all-headers header)
3729   "Prepare ARTICLE in article mode buffer.
3730 ARTICLE should either be an article number or a Message-ID.
3731 If ARTICLE is an id, HEADER should be the article headers.
3732 If ALL-HEADERS is non-nil, no headers are hidden."
3733   (save-excursion
3734     ;; Make sure we start in a summary buffer.
3735     (unless (eq major-mode 'gnus-summary-mode)
3736       (set-buffer gnus-summary-buffer))
3737     (setq gnus-summary-buffer (current-buffer))
3738     (let* ((gnus-article (if header (mail-header-number header) article))
3739            (summary-buffer (current-buffer))
3740            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
3741            (group gnus-newsgroup-name)
3742            result)
3743       (save-excursion
3744         (gnus-article-setup-buffer)
3745         (set-buffer gnus-article-buffer)
3746         ;; Deactivate active regions.
3747         (when (and (boundp 'transient-mark-mode)
3748                    transient-mark-mode)
3749           (setq mark-active nil))
3750         (if (not (setq result (let ((buffer-read-only nil))
3751                                 (gnus-request-article-this-buffer
3752                                  article group))))
3753             ;; There is no such article.
3754             (save-excursion
3755               (when (and (numberp article)
3756                          (not (memq article gnus-newsgroup-sparse)))
3757                 (setq gnus-article-current
3758                       (cons gnus-newsgroup-name article))
3759                 (set-buffer gnus-summary-buffer)
3760                 (setq gnus-current-article article)
3761                 (if (and (memq article gnus-newsgroup-undownloaded)
3762                          (not (gnus-online (gnus-find-method-for-group
3763                                             gnus-newsgroup-name))))
3764                     (progn
3765                       (gnus-summary-set-agent-mark article)
3766                       (message "Message marked for downloading"))
3767                   (gnus-summary-mark-article article gnus-canceled-mark)
3768                   (unless (memq article gnus-newsgroup-sparse)
3769                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
3770           (if (or (eq result 'pseudo)
3771                   (eq result 'nneething))
3772               (progn
3773                 (save-excursion
3774                   (set-buffer summary-buffer)
3775                   (push article gnus-newsgroup-history)
3776                   (setq gnus-last-article gnus-current-article
3777                         gnus-current-article 0
3778                         gnus-current-headers nil
3779                         gnus-article-current nil)
3780                   (if (eq result 'nneething)
3781                       (gnus-configure-windows 'summary)
3782                     (gnus-configure-windows 'article))
3783                   (gnus-set-global-variables))
3784                 (let ((gnus-article-mime-handle-alist-1
3785                        gnus-article-mime-handle-alist))
3786                   (gnus-set-mode-line 'article)))
3787             ;; The result from the `request' was an actual article -
3788             ;; or at least some text that is now displayed in the
3789             ;; article buffer.
3790             (when (and (numberp article)
3791                        (not (eq article gnus-current-article)))
3792               ;; Seems like a new article has been selected.
3793               ;; `gnus-current-article' must be an article number.
3794               (save-excursion
3795                 (set-buffer summary-buffer)
3796                 (push article gnus-newsgroup-history)
3797                 (setq gnus-last-article gnus-current-article
3798                       gnus-current-article article
3799                       gnus-current-headers
3800                       (gnus-summary-article-header gnus-current-article)
3801                       gnus-article-current
3802                       (cons gnus-newsgroup-name gnus-current-article))
3803                 (unless (vectorp gnus-current-headers)
3804                   (setq gnus-current-headers nil))
3805                 (gnus-summary-goto-subject gnus-current-article)
3806                 (when (gnus-summary-show-thread)
3807                   ;; If the summary buffer really was folded, the
3808                   ;; previous goto may not actually have gone to
3809                   ;; the right article, but the thread root instead.
3810                   ;; So we go again.
3811                   (gnus-summary-goto-subject gnus-current-article))
3812                 (gnus-run-hooks 'gnus-mark-article-hook)
3813                 (gnus-set-mode-line 'summary)
3814                 (when (gnus-visual-p 'article-highlight 'highlight)
3815                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
3816                 ;; Set the global newsgroup variables here.
3817                 (gnus-set-global-variables)
3818                 (setq gnus-have-all-headers
3819                       (or all-headers gnus-show-all-headers))))
3820             (save-excursion
3821               (gnus-configure-windows 'article))
3822             (when (or (numberp article)
3823                       (stringp article))
3824               (gnus-article-prepare-display)
3825               ;; Do page break.
3826               (goto-char (point-min))
3827               (when gnus-break-pages
3828                 (gnus-narrow-to-page)))
3829             (let ((gnus-article-mime-handle-alist-1
3830                    gnus-article-mime-handle-alist))
3831               (gnus-set-mode-line 'article))
3832             (article-goto-body)
3833             (unless (bobp)
3834               (forward-line -1))
3835             (set-window-point (get-buffer-window (current-buffer)) (point))
3836             (gnus-configure-windows 'article)
3837             t))))))
3838
3839 ;;;###autoload
3840 (defun gnus-article-prepare-display ()
3841   "Make the current buffer look like a nice article."
3842   ;; Hooks for getting information from the article.
3843   ;; This hook must be called before being narrowed.
3844   (let ((gnus-article-buffer (current-buffer))
3845         buffer-read-only)
3846     (unless (eq major-mode 'gnus-article-mode)
3847       (gnus-article-mode))
3848     (setq buffer-read-only nil
3849           gnus-article-wash-types nil
3850           gnus-article-image-alist nil)
3851     (gnus-run-hooks 'gnus-tmp-internal-hook)
3852     (when gnus-display-mime-function
3853       (funcall gnus-display-mime-function))
3854     (gnus-run-hooks 'gnus-article-prepare-hook)))
3855
3856 ;;;
3857 ;;; Gnus MIME viewing functions
3858 ;;;
3859
3860 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
3861   "Format of the MIME buttons.
3862
3863 Valid specifiers include:
3864 %t  The MIME type
3865 %T  MIME type, along with additional info
3866 %n  The `name' parameter
3867 %d  The description, if any
3868 %l  The length of the encoded part
3869 %p  The part identifier number
3870 %e  Dots if the part isn't displayed
3871
3872 General format specifiers can also be used.  See Info node
3873 `(gnus)Formatting Variables'.")
3874
3875 (defvar gnus-mime-button-line-format-alist
3876   '((?t gnus-tmp-type ?s)
3877     (?T gnus-tmp-type-long ?s)
3878     (?n gnus-tmp-name ?s)
3879     (?d gnus-tmp-description ?s)
3880     (?p gnus-tmp-id ?s)
3881     (?l gnus-tmp-length ?d)
3882     (?e gnus-tmp-dots ?s)))
3883
3884 (defvar gnus-mime-button-commands
3885   '((gnus-article-press-button "\r" "Toggle Display")
3886     (gnus-mime-view-part "v" "View Interactively...")
3887     (gnus-mime-view-part-as-type "t" "View As Type...")
3888     (gnus-mime-view-part-as-charset "C" "View As charset...")
3889     (gnus-mime-save-part "o" "Save...")
3890     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
3891     (gnus-mime-delete-part "d" "Delete part")
3892     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
3893     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
3894     (gnus-mime-view-part-internally "E" "View Internally")
3895     (gnus-mime-view-part-externally "e" "View Externally")
3896     (gnus-mime-print-part "p" "Print")
3897     (gnus-mime-pipe-part "|" "Pipe To Command...")
3898     (gnus-mime-action-on-part "." "Take action on the part...")))
3899
3900 (defun gnus-article-mime-part-status ()
3901   (if gnus-article-mime-handle-alist-1
3902       (if (eq 1 (length gnus-article-mime-handle-alist-1))
3903           " (1 part)"
3904         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
3905     ""))
3906
3907 (defvar gnus-mime-button-map
3908   (let ((map (make-sparse-keymap)))
3909     (define-key map gnus-mouse-2 'gnus-article-push-button)
3910     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
3911     (dolist (c gnus-mime-button-commands)
3912       (define-key map (cadr c) (car c)))
3913     map))
3914
3915 (easy-menu-define
3916   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
3917   `("MIME Part"
3918     ,@(mapcar (lambda (c)
3919                 (vector (caddr c) (car c) :enable t))
3920               gnus-mime-button-commands)))
3921
3922 (defun gnus-mime-button-menu (event prefix)
3923  "Construct a context-sensitive menu of MIME commands."
3924  (interactive "e\nP")
3925  (save-window-excursion
3926    (let ((pos (event-start event)))
3927      (select-window (posn-window pos))
3928      (goto-char (posn-point pos))
3929      (gnus-article-check-buffer)
3930      (popup-menu gnus-mime-button-menu nil prefix))))
3931
3932 (defun gnus-mime-view-all-parts (&optional handles)
3933   "View all the MIME parts."
3934   (interactive)
3935   (with-current-buffer gnus-article-buffer
3936     (let ((handles (or handles gnus-article-mime-handles))
3937           (mail-parse-charset gnus-newsgroup-charset)
3938           (mail-parse-ignored-charsets
3939            (with-current-buffer gnus-summary-buffer
3940              gnus-newsgroup-ignored-charsets)))
3941       (when handles
3942         (mm-remove-parts handles)
3943         (goto-char (point-min))
3944         (or (search-forward "\n\n") (goto-char (point-max)))
3945         (let (buffer-read-only)
3946           (delete-region (point) (point-max))
3947           (mm-display-parts handles))))))
3948
3949 (eval-when-compile
3950   (defsubst gnus-article-edit-part (handles)
3951     "Edit an article in order to delete a mime part.
3952 This function is exclusively used by `gnus-mime-save-part-and-strip'
3953 and `gnus-mime-delete-part', and not provided at run-time normally."
3954     (gnus-article-edit-article
3955      `(lambda ()
3956         (erase-buffer)
3957         (let ((mail-parse-charset (or gnus-article-charset
3958                                       ',gnus-newsgroup-charset))
3959               (mail-parse-ignored-charsets
3960                (or gnus-article-ignored-charsets
3961                    ',gnus-newsgroup-ignored-charsets))
3962               (mbl mml-buffer-list))
3963           (setq mml-buffer-list nil)
3964           (insert-buffer gnus-original-article-buffer)
3965           (mime-to-mml ',handles)
3966           (setq gnus-article-mime-handles nil)
3967           (let ((mbl1 mml-buffer-list))
3968             (setq mml-buffer-list mbl)
3969             (set (make-local-variable 'mml-buffer-list) mbl1))
3970           (gnus-make-local-hook 'kill-buffer-hook)
3971           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
3972      `(lambda (no-highlight)
3973         (let ((mail-parse-charset (or gnus-article-charset
3974                                       ',gnus-newsgroup-charset))
3975               (message-options message-options)
3976               (message-options-set-recipient)
3977               (mail-parse-ignored-charsets
3978                (or gnus-article-ignored-charsets
3979                    ',gnus-newsgroup-ignored-charsets)))
3980           (mml-to-mime)
3981           (mml-destroy-buffers)
3982           (remove-hook 'kill-buffer-hook
3983                        'mml-destroy-buffers t)
3984           (kill-local-variable 'mml-buffer-list))
3985         (gnus-summary-edit-article-done
3986          ,(or (mail-header-references gnus-current-headers) "")
3987          ,(gnus-group-read-only-p)
3988          ,gnus-summary-buffer no-highlight)))
3989     (gnus-article-edit-done)
3990     (gnus-summary-expand-window)
3991     (gnus-summary-show-article)))
3992
3993 (defun gnus-mime-save-part-and-strip ()
3994   "Save the MIME part under point then replace it with an external body."
3995   (interactive)
3996   (gnus-article-check-buffer)
3997   (when (gnus-group-read-only-p)
3998     (error "The current group does not support deleting of parts"))
3999   (when (mm-complicated-handles gnus-article-mime-handles)
4000     (error "\
4001 The current article has a complicated MIME structure, giving up..."))
4002   (when (gnus-yes-or-no-p "\
4003 Deleting parts may malfunction or destroy the article; continue? ")
4004     (let* ((data (get-text-property (point) 'gnus-data))
4005            file param
4006            (handles gnus-article-mime-handles))
4007       (setq file (and data (mm-save-part data)))
4008       (when file
4009         (with-current-buffer (mm-handle-buffer data)
4010           (erase-buffer)
4011           (insert "Content-Type: " (mm-handle-media-type data))
4012           (mml-insert-parameter-string (cdr (mm-handle-type data))
4013                                        '(charset))
4014           (insert "\n")
4015           (insert "Content-ID: " (message-make-message-id) "\n")
4016           (insert "Content-Transfer-Encoding: binary\n")
4017           (insert "\n"))
4018         (setcdr data
4019                 (cdr (mm-make-handle nil
4020                                      `("message/external-body"
4021                                        (access-type . "LOCAL-FILE")
4022                                        (name . ,file)))))
4023         (set-buffer gnus-summary-buffer)
4024         (gnus-article-edit-part handles)))))
4025
4026 (defun gnus-mime-delete-part ()
4027   "Delete the MIME part under point.
4028 Replace it with some information about the removed part."
4029   (interactive)
4030   (gnus-article-check-buffer)
4031   (when (gnus-group-read-only-p)
4032     (error "The current group does not support deleting of parts"))
4033   (when (mm-complicated-handles gnus-article-mime-handles)
4034     (error "\
4035 The current article has a complicated MIME structure, giving up..."))
4036   (when (gnus-yes-or-no-p "\
4037 Deleting parts may malfunction or destroy the article; continue? ")
4038     (let* ((data (get-text-property (point) 'gnus-data))
4039            (handles gnus-article-mime-handles)
4040            (none "(none)")
4041            (description
4042             (or
4043              (mail-decode-encoded-word-string (or (mm-handle-description data)
4044                                                   none))))
4045            (filename
4046             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4047                 none))
4048            (type (mm-handle-media-type data)))
4049       (unless data
4050         (error "No MIME part under point"))
4051       (with-current-buffer (mm-handle-buffer data)
4052         (let ((bsize (format "%s" (buffer-size))))
4053           (erase-buffer)
4054           (insert
4055            (concat
4056             ",----\n"
4057             "| The following attachment has been deleted:\n"
4058             "|\n"
4059             "| Type:           " type "\n"
4060             "| Filename:       " filename "\n"
4061             "| Size (encoded): " bsize " Byte\n"
4062             "| Description:    " description "\n"
4063             "`----\n"))
4064           (setcdr data
4065                   (cdr (mm-make-handle
4066                         nil `("text/plain") nil nil
4067                         (list "attachment")
4068                         (format "Deleted attachment (%s bytes)" bsize))))))
4069       (set-buffer gnus-summary-buffer)
4070       (gnus-article-edit-part handles))))
4071
4072 (defun gnus-mime-save-part ()
4073   "Save the MIME part under point."
4074   (interactive)
4075   (gnus-article-check-buffer)
4076   (let ((data (get-text-property (point) 'gnus-data)))
4077     (when data
4078       (mm-save-part data))))
4079
4080 (defun gnus-mime-pipe-part ()
4081   "Pipe the MIME part under point to a process."
4082   (interactive)
4083   (gnus-article-check-buffer)
4084   (let ((data (get-text-property (point) 'gnus-data)))
4085     (when data
4086       (mm-pipe-part data))))
4087
4088 (defun gnus-mime-view-part ()
4089   "Interactively choose a viewing method for the MIME part under point."
4090   (interactive)
4091   (gnus-article-check-buffer)
4092   (let ((data (get-text-property (point) 'gnus-data)))
4093     (when data
4094       (setq gnus-article-mime-handles
4095             (mm-merge-handles
4096              gnus-article-mime-handles (setq data (copy-sequence data))))
4097       (mm-interactively-view-part data))))
4098
4099 (defun gnus-mime-view-part-as-type-internal ()
4100   (gnus-article-check-buffer)
4101   (let* ((name (mail-content-type-get
4102                 (mm-handle-type (get-text-property (point) 'gnus-data))
4103                 'name))
4104          (def-type (and name (mm-default-file-encoding name))))
4105     (and def-type (cons def-type 0))))
4106
4107 (defun gnus-mime-view-part-as-type (&optional mime-type)
4108   "Choose a MIME media type, and view the part as such."
4109   (interactive)
4110   (unless mime-type
4111     (setq mime-type (completing-read
4112                      "View as MIME type: "
4113                      (mapcar #'list (mailcap-mime-types))
4114                      nil nil
4115                      (gnus-mime-view-part-as-type-internal))))
4116   (gnus-article-check-buffer)
4117   (let ((handle (get-text-property (point) 'gnus-data)))
4118     (when handle
4119       (setq handle
4120             (mm-make-handle (mm-handle-buffer handle)
4121                             (cons mime-type (cdr (mm-handle-type handle)))
4122                             (mm-handle-encoding handle)
4123                             (mm-handle-undisplayer handle)
4124                             (mm-handle-disposition handle)
4125                             (mm-handle-description handle)
4126                             nil
4127                             (mm-handle-id handle)))
4128       (setq gnus-article-mime-handles
4129             (mm-merge-handles gnus-article-mime-handles handle))
4130       (gnus-mm-display-part handle))))
4131
4132 (eval-when-compile
4133   (require 'jka-compr))
4134
4135 ;; jka-compr.el uses a "sh -c" to direct stderr to err-file, but these days
4136 ;; emacs can do that itself.
4137 ;;
4138 (defun gnus-mime-jka-compr-maybe-uncompress ()
4139   "Uncompress the current buffer if `auto-compression-mode' is enabled.
4140 The uncompress method used is derived from `buffer-file-name'."
4141   (when (and (fboundp 'jka-compr-installed-p)
4142              (jka-compr-installed-p))
4143     (let ((info (jka-compr-get-compression-info buffer-file-name)))
4144       (when info
4145         (let ((basename (file-name-nondirectory buffer-file-name))
4146               (args     (jka-compr-info-uncompress-args    info))
4147               (prog     (jka-compr-info-uncompress-program info))
4148               (message  (jka-compr-info-uncompress-message info))
4149               (err-file (jka-compr-make-temp-name)))
4150           (if message
4151               (message "%s %s..." message basename))
4152           (unwind-protect
4153               (unless (memq (apply 'call-process-region
4154                                    (point-min) (point-max)
4155                                    prog
4156                                    t (list t err-file) nil
4157                                    args)
4158                             jka-compr-acceptable-retval-list)
4159                 (jka-compr-error prog args basename message err-file))
4160             (jka-compr-delete-temp-file err-file)))))))
4161
4162 (defun gnus-mime-copy-part (&optional handle)
4163   "Put the MIME part under point into a new buffer.
4164 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4165 are decompressed."
4166   (interactive)
4167   (gnus-article-check-buffer)
4168   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4169          (contents (and handle (mm-get-part handle)))
4170          (base (and handle
4171                     (file-name-nondirectory
4172                      (or
4173                       (mail-content-type-get (mm-handle-type handle) 'name)
4174                       (mail-content-type-get (mm-handle-disposition handle)
4175                                              'filename)
4176                       "*decoded*"))))
4177          (buffer (and base (generate-new-buffer base))))
4178     (when contents
4179       (switch-to-buffer buffer)
4180       (insert contents)
4181       ;; We do it this way to make `normal-mode' set the appropriate mode.
4182       (unwind-protect
4183           (progn
4184             (setq buffer-file-name (expand-file-name base))
4185             (gnus-mime-jka-compr-maybe-uncompress)
4186             (normal-mode))
4187         (setq buffer-file-name nil))
4188       (goto-char (point-min)))))
4189
4190 (defun gnus-mime-print-part (&optional handle filename)
4191   "Print the MIME part under point."
4192   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4193   (gnus-article-check-buffer)
4194   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4195          (contents (and handle (mm-get-part handle)))
4196          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4197          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4198     (when contents
4199         (if printer
4200             (unwind-protect
4201                 (progn
4202                   (mm-save-part-to-file handle file)
4203                   (call-process shell-file-name nil
4204                                 (generate-new-buffer " *mm*")
4205                                 nil
4206                                 shell-command-switch
4207                                 (mm-mailcap-command
4208                                  printer file (mm-handle-type handle))))
4209               (delete-file file))
4210           (with-temp-buffer
4211             (insert contents)
4212             (gnus-print-buffer))
4213           (ps-despool filename)))))
4214
4215 (defun gnus-mime-inline-part (&optional handle arg)
4216   "Insert the MIME part under point into the current buffer."
4217   (interactive (list nil current-prefix-arg))
4218   (gnus-article-check-buffer)
4219   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4220          contents charset
4221          (b (point))
4222          buffer-read-only)
4223     (when handle
4224       (if (and (not arg) (mm-handle-undisplayer handle))
4225           (mm-remove-part handle)
4226         (setq contents (mm-get-part handle))
4227         (cond
4228          ((not arg)
4229           (setq charset (or (mail-content-type-get
4230                              (mm-handle-type handle) 'charset)
4231                             gnus-newsgroup-charset)))
4232          ((numberp arg)
4233           (if (mm-handle-undisplayer handle)
4234               (mm-remove-part handle))
4235           (setq charset
4236                 (or (cdr (assq arg
4237                                gnus-summary-show-article-charset-alist))
4238                     (mm-read-coding-system "Charset: ")))))
4239         (forward-line 2)
4240         (mm-insert-inline handle
4241                           (if (and charset
4242                                    (setq charset (mm-charset-to-coding-system
4243                                                   charset))
4244                                    (not (eq charset 'ascii)))
4245                               (mm-decode-coding-string contents charset)
4246                             contents))
4247         (goto-char b)))))
4248
4249 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4250   "Insert the MIME part under point into the current buffer using the
4251 specified charset."
4252   (interactive (list nil current-prefix-arg))
4253   (gnus-article-check-buffer)
4254   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4255          contents charset
4256          (b (point))
4257          buffer-read-only)
4258     (when handle
4259       (if (mm-handle-undisplayer handle)
4260           (mm-remove-part handle))
4261       (let ((gnus-newsgroup-charset
4262              (or (cdr (assq arg
4263                             gnus-summary-show-article-charset-alist))
4264                  (mm-read-coding-system "Charset: ")))
4265           (gnus-newsgroup-ignored-charsets 'gnus-all))
4266         (gnus-article-press-button)))))
4267
4268 (defun gnus-mime-view-part-externally (&optional handle)
4269   "View the MIME part under point with an external viewer."
4270   (interactive)
4271   (gnus-article-check-buffer)
4272   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4273          (mm-user-display-methods nil)
4274          (mm-inlined-types nil)
4275          (mail-parse-charset gnus-newsgroup-charset)
4276          (mail-parse-ignored-charsets
4277           (with-current-buffer gnus-summary-buffer
4278             gnus-newsgroup-ignored-charsets)))
4279     (when handle
4280       (if (mm-handle-undisplayer handle)
4281           (mm-remove-part handle)
4282         (mm-display-part handle)))))
4283
4284 (defun gnus-mime-view-part-internally (&optional handle)
4285   "View the MIME part under point with an internal viewer.
4286 If no internal viewer is available, use an external viewer."
4287   (interactive)
4288   (gnus-article-check-buffer)
4289   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4290          (mm-inlined-types '(".*"))
4291          (mm-inline-large-images t)
4292          (mail-parse-charset gnus-newsgroup-charset)
4293          (mail-parse-ignored-charsets
4294           (with-current-buffer gnus-summary-buffer
4295             gnus-newsgroup-ignored-charsets))
4296          buffer-read-only)
4297     (when handle
4298       (if (mm-handle-undisplayer handle)
4299           (mm-remove-part handle)
4300         (mm-display-part handle)))))
4301
4302 (defun gnus-mime-action-on-part (&optional action)
4303   "Do something with the MIME attachment at \(point\)."
4304   (interactive
4305    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
4306   (gnus-article-check-buffer)
4307   (let ((action-pair (assoc action gnus-mime-action-alist)))
4308     (if action-pair
4309         (funcall (cdr action-pair)))))
4310
4311 (defun gnus-article-part-wrapper (n function)
4312   (with-current-buffer gnus-article-buffer
4313     (when (> n (length gnus-article-mime-handle-alist))
4314       (error "No such part"))
4315     (gnus-article-goto-part n)
4316     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4317       (funcall function handle))))
4318
4319 (defun gnus-article-pipe-part (n)
4320   "Pipe MIME part N, which is the numerical prefix."
4321   (interactive "p")
4322   (gnus-article-part-wrapper n 'mm-pipe-part))
4323
4324 (defun gnus-article-save-part (n)
4325   "Save MIME part N, which is the numerical prefix."
4326   (interactive "p")
4327   (gnus-article-part-wrapper n 'mm-save-part))
4328
4329 (defun gnus-article-interactively-view-part (n)
4330   "View MIME part N interactively, which is the numerical prefix."
4331   (interactive "p")
4332   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4333
4334 (defun gnus-article-copy-part (n)
4335   "Copy MIME part N, which is the numerical prefix."
4336   (interactive "p")
4337   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4338
4339 (defun gnus-article-view-part-as-charset (n)
4340   "View MIME part N using a specified charset.
4341 N is the numerical prefix."
4342   (interactive "p")
4343   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4344
4345 (defun gnus-article-view-part-externally (n)
4346   "View MIME part N externally, which is the numerical prefix."
4347   (interactive "p")
4348   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4349
4350 (defun gnus-article-inline-part (n)
4351   "Inline MIME part N, which is the numerical prefix."
4352   (interactive "p")
4353   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4354
4355 (defun gnus-article-mime-match-handle-first (condition)
4356   (if condition
4357       (let ((alist gnus-article-mime-handle-alist) ihandle n)
4358         (while (setq ihandle (pop alist))
4359           (if (and (cond
4360                     ((functionp condition)
4361                      (funcall condition (cdr ihandle)))
4362                     ((eq condition 'undisplayed)
4363                      (not (or (mm-handle-undisplayer (cdr ihandle))
4364                               (equal (mm-handle-media-type (cdr ihandle))
4365                                      "multipart/alternative"))))
4366                     ((eq condition 'undisplayed-alternative)
4367                      (not (mm-handle-undisplayer (cdr ihandle))))
4368                     (t t))
4369                    (gnus-article-goto-part (car ihandle))
4370                    (or (not n) (< (car ihandle) n)))
4371               (setq n (car ihandle))))
4372         (or n 1))
4373     1))
4374
4375 (defun gnus-article-view-part (&optional n)
4376   "View MIME part N, which is the numerical prefix."
4377   (interactive "P")
4378   (with-current-buffer gnus-article-buffer
4379     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4380                              gnus-article-mime-match-handle-function)))
4381     (when (> n (length gnus-article-mime-handle-alist))
4382       (error "No such part"))
4383     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4384       (when (gnus-article-goto-part n)
4385         (if (equal (car handle) "multipart/alternative")
4386             (gnus-article-press-button)
4387           (when (eq (gnus-mm-display-part handle) 'internal)
4388             (gnus-set-window-start)))))))
4389
4390 (defsubst gnus-article-mime-total-parts ()
4391   (if (bufferp (car gnus-article-mime-handles))
4392       1 ;; single part
4393     (1- (length gnus-article-mime-handles))))
4394
4395 (defun gnus-mm-display-part (handle)
4396   "Display HANDLE and fix MIME button."
4397   (let ((id (get-text-property (point) 'gnus-part))
4398         (point (point))
4399         buffer-read-only)
4400     (forward-line 1)
4401     (prog1
4402         (let ((window (selected-window))
4403               (mail-parse-charset gnus-newsgroup-charset)
4404               (mail-parse-ignored-charsets
4405                (if (gnus-buffer-live-p gnus-summary-buffer)
4406                    (with-current-buffer gnus-summary-buffer
4407                      gnus-newsgroup-ignored-charsets)
4408                  nil)))
4409           (save-excursion
4410             (unwind-protect
4411                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4412                       (beg (point)))
4413                   (when win
4414                     (select-window win))
4415                   (goto-char point)
4416                   (forward-line)
4417                   (if (mm-handle-displayed-p handle)
4418                       ;; This will remove the part.
4419                       (mm-display-part handle)
4420                     (save-restriction
4421                       (narrow-to-region (point)
4422                                         (if (eobp) (point) (1+ (point))))
4423                       (mm-display-part handle)
4424                       ;; We narrow to the part itself and
4425                       ;; then call the treatment functions.
4426                       (goto-char (point-min))
4427                       (forward-line 1)
4428                       (narrow-to-region (point) (point-max))
4429                       (gnus-treat-article
4430                        nil id
4431                        (gnus-article-mime-total-parts)
4432                        (mm-handle-media-type handle)))))
4433               (if (window-live-p window)
4434                   (select-window window)))))
4435       (goto-char point)
4436       (gnus-delete-line)
4437       (gnus-insert-mime-button
4438        handle id (list (mm-handle-displayed-p handle)))
4439       (goto-char point))))
4440
4441 (defun gnus-article-goto-part (n)
4442   "Go to MIME part N."
4443   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
4444
4445 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4446   (let ((gnus-tmp-name
4447          (or (mail-content-type-get (mm-handle-type handle) 'name)
4448              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4449              (mail-content-type-get (mm-handle-type handle) 'url)
4450              ""))
4451         (gnus-tmp-type (mm-handle-media-type handle))
4452         (gnus-tmp-description
4453          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4454                                               "")))
4455         (gnus-tmp-dots
4456          (if (if displayed (car displayed)
4457                (mm-handle-displayed-p handle))
4458              "" "..."))
4459         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4460                            (buffer-size)))
4461         gnus-tmp-type-long b e)
4462     (when (string-match ".*/" gnus-tmp-name)
4463       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4464     (setq gnus-tmp-type-long (concat gnus-tmp-type
4465                                      (and (not (equal gnus-tmp-name ""))
4466                                           (concat "; " gnus-tmp-name))))
4467     (unless (equal gnus-tmp-description "")
4468       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4469     (unless (bolp)
4470       (insert "\n"))
4471     (setq b (point))
4472     (gnus-eval-format
4473      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4474      `(keymap ,gnus-mime-button-map
4475               gnus-callback gnus-mm-display-part
4476               gnus-part ,gnus-tmp-id
4477               article-type annotation
4478               gnus-data ,handle))
4479     (setq e (if (bolp)
4480                 ;; Exclude a newline.
4481                 (1- (point))
4482               (point)))
4483     (widget-convert-button
4484      'link b e
4485      :mime-handle handle
4486      :action 'gnus-widget-press-button
4487      :button-keymap gnus-mime-button-map
4488      :help-echo
4489      (lambda (widget/window &optional overlay pos)
4490        ;; Needed to properly clear the message due to a bug in
4491        ;; wid-edit (XEmacs only).
4492        (if (boundp 'help-echo-owns-message)
4493            (setq help-echo-owns-message t))
4494        (format
4495         "%S: %s the MIME part; %S: more options"
4496         (aref gnus-mouse-2 0)
4497         ;; XEmacs will get a single widget arg; Emacs 21 will get
4498         ;; window, overlay, position.
4499         (if (mm-handle-displayed-p
4500              (if overlay
4501                  (with-current-buffer (gnus-overlay-buffer overlay)
4502                    (widget-get (widget-at (gnus-overlay-start overlay))
4503                                :mime-handle))
4504                (widget-get widget/window :mime-handle)))
4505             "hide" "show")
4506         (aref gnus-down-mouse-3 0))))))
4507
4508 (defun gnus-widget-press-button (elems el)
4509   (goto-char (widget-get elems :from))
4510   (gnus-article-press-button))
4511
4512 (defvar gnus-displaying-mime nil)
4513
4514 (defun gnus-display-mime (&optional ihandles)
4515   "Display the MIME parts."
4516   (save-excursion
4517     (save-selected-window
4518       (let ((window (get-buffer-window gnus-article-buffer))
4519             (point (point)))
4520         (when window
4521           (select-window window)
4522           ;; We have to do this since selecting the window
4523           ;; may change the point.  So we set the window point.
4524           (set-window-point window point)))
4525       (let* ((handles (or ihandles
4526                           (mm-dissect-buffer nil gnus-article-loose-mime)
4527                           (and gnus-article-emulate-mime
4528                                (mm-uu-dissect))))
4529              buffer-read-only handle name type b e display)
4530         (when (and (not ihandles)
4531                    (not gnus-displaying-mime))
4532           ;; Top-level call; we clean up.
4533           (when gnus-article-mime-handles
4534             (mm-destroy-parts gnus-article-mime-handles)
4535             (setq gnus-article-mime-handle-alist nil));; A trick.
4536           (setq gnus-article-mime-handles handles)
4537           ;; We allow users to glean info from the handles.
4538           (when gnus-article-mime-part-function
4539             (gnus-mime-part-function handles)))
4540         (if (and handles
4541                  (or (not (stringp (car handles)))
4542                      (cdr handles)))
4543             (progn
4544               (when (and (not ihandles)
4545                          (not gnus-displaying-mime))
4546                 ;; Clean up for mime parts.
4547                 (article-goto-body)
4548                 (delete-region (point) (point-max)))
4549               (let ((gnus-displaying-mime t))
4550                 (gnus-mime-display-part handles)))
4551           (save-restriction
4552             (article-goto-body)
4553             (narrow-to-region (point) (point-max))
4554             (gnus-treat-article nil 1 1)
4555             (widen)))
4556         (unless ihandles
4557           ;; Highlight the headers.
4558           (save-excursion
4559             (save-restriction
4560               (article-goto-body)
4561               (narrow-to-region (point-min) (point))
4562               (gnus-treat-article 'head))))))))
4563
4564 (defcustom gnus-mime-display-multipart-as-mixed nil
4565   "Display \"multipart\" parts as  \"multipart/mixed\".
4566
4567 If t, it overrides nil values of
4568 `gnus-mime-display-multipart-alternative-as-mixed' and
4569 `gnus-mime-display-multipart-related-as-mixed'."
4570   :group 'gnus-article-mime
4571   :type 'boolean)
4572
4573 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
4574   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
4575   :group 'gnus-article-mime
4576   :type 'boolean)
4577
4578 (defcustom gnus-mime-display-multipart-related-as-mixed nil
4579   "Display \"multipart/related\" parts as  \"multipart/mixed\".
4580
4581 If displaying \"text/html\" is discouraged \(see
4582 `mm-discouraged-alternatives'\) images or other material inside a
4583 \"multipart/related\" part might be overlooked when this variable is nil."
4584   :group 'gnus-article-mime
4585   :type 'boolean)
4586
4587 (defun gnus-mime-display-part (handle)
4588   (cond
4589    ;; Single part.
4590    ((not (stringp (car handle)))
4591     (gnus-mime-display-single handle))
4592    ;; User-defined multipart
4593    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
4594     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
4595              handle))
4596    ;; multipart/alternative
4597    ((and (equal (car handle) "multipart/alternative")
4598          (not (or gnus-mime-display-multipart-as-mixed
4599                   gnus-mime-display-multipart-alternative-as-mixed)))
4600     (let ((id (1+ (length gnus-article-mime-handle-alist))))
4601       (push (cons id handle) gnus-article-mime-handle-alist)
4602       (gnus-mime-display-alternative (cdr handle) nil nil id)))
4603    ;; multipart/related
4604    ((and (equal (car handle) "multipart/related")
4605          (not (or gnus-mime-display-multipart-as-mixed
4606                   gnus-mime-display-multipart-related-as-mixed)))
4607     ;;;!!!We should find the start part, but we just default
4608     ;;;!!!to the first part.
4609     ;;(gnus-mime-display-part (cadr handle))
4610     ;;;!!! Most multipart/related is an HTML message plus images.
4611     ;;;!!! Unfortunately we are unable to let W3 display those
4612     ;;;!!! included images, so we just display it as a mixed multipart.
4613     ;;(gnus-mime-display-mixed (cdr handle))
4614     ;;;!!! No, w3 can display everything just fine.
4615     (gnus-mime-display-part (cadr handle)))
4616    ((equal (car handle) "multipart/signed")
4617     (gnus-add-wash-type 'signed)
4618     (gnus-mime-display-security handle))
4619    ((equal (car handle) "multipart/encrypted")
4620     (gnus-add-wash-type 'encrypted)
4621     (gnus-mime-display-security handle))
4622    ;; Other multiparts are handled like multipart/mixed.
4623    (t
4624     (gnus-mime-display-mixed (cdr handle)))))
4625
4626 (defun gnus-mime-part-function (handles)
4627   (if (stringp (car handles))
4628       (mapcar 'gnus-mime-part-function (cdr handles))
4629     (funcall gnus-article-mime-part-function handles)))
4630
4631 (defun gnus-mime-display-mixed (handles)
4632   (mapcar 'gnus-mime-display-part handles))
4633
4634 (defun gnus-mime-display-single (handle)
4635   (let ((type (mm-handle-media-type handle))
4636         (ignored gnus-ignored-mime-types)
4637         (not-attachment t)
4638         (move nil)
4639         display text)
4640     (catch 'ignored
4641       (progn
4642         (while ignored
4643           (when (string-match (pop ignored) type)
4644             (throw 'ignored nil)))
4645         (if (and (setq not-attachment
4646                        (and (not (mm-inline-override-p handle))
4647                             (or (not (mm-handle-disposition handle))
4648                                 (equal (car (mm-handle-disposition handle))
4649                                        "inline")
4650                                 (mm-attachment-override-p handle))))
4651                  (mm-automatic-display-p handle)
4652                  (or (and
4653                       (mm-inlinable-p handle)
4654                       (mm-inlined-p handle))
4655                      (mm-automatic-external-display-p type)))
4656             (setq display t)
4657           (when (equal (mm-handle-media-supertype handle) "text")
4658             (setq text t)))
4659         (let ((id (1+ (length gnus-article-mime-handle-alist)))
4660               beg)
4661           (push (cons id handle) gnus-article-mime-handle-alist)
4662           (when (or (not display)
4663                     (not (gnus-unbuttonized-mime-type-p type)))
4664             (gnus-insert-mime-button
4665              handle id (list (or display (and not-attachment text))))
4666             (gnus-article-insert-newline)
4667             ;; Remember modify the number of forward lines.
4668             (setq move t))
4669           (setq beg (point))
4670           (cond
4671            (display
4672             (when move
4673               (forward-line -1)
4674               (setq beg (point)))
4675             (let ((mail-parse-charset gnus-newsgroup-charset)
4676                   (mail-parse-ignored-charsets
4677                    (save-excursion (condition-case ()
4678                                        (set-buffer gnus-summary-buffer)
4679                                      (error))
4680                                    gnus-newsgroup-ignored-charsets)))
4681               (mm-display-part handle t))
4682             (goto-char (point-max)))
4683            ((and text not-attachment)
4684             (when move
4685               (forward-line -1)
4686               (setq beg (point)))
4687             (gnus-article-insert-newline)
4688             (mm-insert-inline handle (mm-get-part handle))
4689             (goto-char (point-max))))
4690           ;; Do highlighting.
4691           (save-excursion
4692             (save-restriction
4693               (narrow-to-region beg (point))
4694               (gnus-treat-article
4695                nil id
4696                (gnus-article-mime-total-parts)
4697                (mm-handle-media-type handle)))))))))
4698
4699 (defun gnus-unbuttonized-mime-type-p (type)
4700   "Say whether TYPE is to be unbuttonized."
4701   (unless gnus-inhibit-mime-unbuttonizing
4702     (when (catch 'found
4703             (let ((types gnus-unbuttonized-mime-types))
4704               (while types
4705                 (when (string-match (pop types) type)
4706                   (throw 'found t)))))
4707       (not (catch 'found
4708              (let ((types gnus-buttonized-mime-types))
4709                (while types
4710                  (when (string-match (pop types) type)
4711                    (throw 'found t)))))))))
4712
4713 (defun gnus-article-insert-newline ()
4714   "Insert a newline, but mark it as undeletable."
4715   (gnus-put-text-property
4716    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
4717
4718 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
4719   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
4720          (ihandles handles)
4721          (point (point))
4722          handle buffer-read-only from props begend not-pref)
4723     (save-window-excursion
4724       (save-restriction
4725         (when ibegend
4726           (narrow-to-region (car ibegend)
4727                             (or (cdr ibegend)
4728                                 (progn
4729                                   (goto-char (car ibegend))
4730                                   (forward-line 2)
4731                                   (point))))
4732           (delete-region (point-min) (point-max))
4733           (mm-remove-parts handles))
4734         (setq begend (list (point-marker)))
4735         ;; Do the toggle.
4736         (unless (setq not-pref (cadr (member preferred ihandles)))
4737           (setq not-pref (car ihandles)))
4738         (when (or ibegend
4739                   (not preferred)
4740                   (not (gnus-unbuttonized-mime-type-p
4741                         "multipart/alternative")))
4742           (gnus-add-text-properties
4743            (setq from (point))
4744            (progn
4745              (insert (format "%d.  " id))
4746              (point))
4747            `(gnus-callback
4748              (lambda (handles)
4749                (unless ,(not ibegend)
4750                  (setq gnus-article-mime-handle-alist
4751                        ',gnus-article-mime-handle-alist))
4752                (gnus-mime-display-alternative
4753                 ',ihandles ',not-pref ',begend ,id))
4754              keymap ,gnus-mime-button-map
4755              ,gnus-mouse-face-prop ,gnus-article-mouse-face
4756              face ,gnus-article-button-face
4757              gnus-part ,id
4758              gnus-data ,handle))
4759           (widget-convert-button 'link from (point)
4760                                  :action 'gnus-widget-press-button
4761                                  :button-keymap gnus-widget-button-keymap)
4762           ;; Do the handles
4763           (while (setq handle (pop handles))
4764             (gnus-add-text-properties
4765              (setq from (point))
4766              (progn
4767                (insert (format "(%c) %-18s"
4768                                (if (equal handle preferred) ?* ? )
4769                                (mm-handle-media-type handle)))
4770                (point))
4771              `(gnus-callback
4772                (lambda (handles)
4773                  (unless ,(not ibegend)
4774                    (setq gnus-article-mime-handle-alist
4775                          ',gnus-article-mime-handle-alist))
4776                  (gnus-mime-display-alternative
4777                   ',ihandles ',handle ',begend ,id))
4778                keymap ,gnus-mime-button-map
4779                ,gnus-mouse-face-prop ,gnus-article-mouse-face
4780                face ,gnus-article-button-face
4781                gnus-part ,id
4782                gnus-data ,handle))
4783             (widget-convert-button 'link from (point)
4784                                    :action 'gnus-widget-press-button
4785                                    :button-keymap gnus-widget-button-keymap)
4786             (insert "  "))
4787           (insert "\n\n"))
4788         (when preferred
4789           (if (stringp (car preferred))
4790               (gnus-display-mime preferred)
4791             (let ((mail-parse-charset gnus-newsgroup-charset)
4792                   (mail-parse-ignored-charsets
4793                    (with-current-buffer gnus-summary-buffer
4794                      gnus-newsgroup-ignored-charsets)))
4795               (mm-display-part preferred)
4796               ;; Do highlighting.
4797               (save-excursion
4798                 (save-restriction
4799                   (narrow-to-region (car begend) (point-max))
4800                   (gnus-treat-article
4801                    nil (length gnus-article-mime-handle-alist)
4802                    (gnus-article-mime-total-parts)
4803                    (mm-handle-media-type handle))))))
4804           (goto-char (point-max))
4805           (setcdr begend (point-marker)))))
4806     (when ibegend
4807       (goto-char point))))
4808
4809 (defconst gnus-article-wash-status-strings
4810   (let ((alist '((cite "c" "Possible hidden citation text"
4811                        " " "All citation text visible")
4812                  (headers "h" "Hidden headers"
4813                           " " "All headers visible.")
4814                  (pgp "p" "Encrypted or signed message status hidden"
4815                       " " "No hidden encryption nor digital signature status")
4816                  (signature "s" "Signature has been hidden"
4817                             " " "Signature is visible")
4818                  (overstrike "o" "Overstrike (^H) characters applied"
4819                              " " "No overstrike characters applied")
4820                  (emphasis "e" "/*_Emphasis_*/ characters applied"
4821                            " " "No /*_emphasis_*/ characters applied")))
4822         result)
4823     (dolist (entry alist result)
4824       (let ((key (nth 0 entry))
4825             (on (copy-sequence (nth 1 entry)))
4826             (on-help (nth 2 entry))
4827             (off (copy-sequence (nth 3 entry)))
4828             (off-help (nth 4 entry)))
4829         (put-text-property 0 1 'help-echo on-help on)
4830         (put-text-property 0 1 'help-echo off-help off)
4831         (push (list key on off) result))))
4832   "Alist of strings describing wash status in the mode line.
4833 Each entry has the form (KEY ON OF), where the KEY is a symbol
4834 representing the particular washing function, ON is the string to use
4835 in the article mode line when the washing function is active, and OFF
4836 is the string to use when it is inactive.")
4837
4838 (defun gnus-article-wash-status-entry (key value)
4839   (let ((entry (assoc key gnus-article-wash-status-strings)))
4840     (if value (nth 1 entry) (nth 2 entry))))
4841
4842 (defun gnus-article-wash-status ()
4843   "Return a string which display status of article washing."
4844   (with-current-buffer gnus-article-buffer
4845     (let ((cite (memq 'cite gnus-article-wash-types))
4846           (headers (memq 'headers gnus-article-wash-types))
4847           (boring (memq 'boring-headers gnus-article-wash-types))
4848           (pgp (memq 'pgp gnus-article-wash-types))
4849           (pem (memq 'pem gnus-article-wash-types))
4850           (signed (memq 'signed gnus-article-wash-types))
4851           (encrypted (memq 'encrypted gnus-article-wash-types))
4852           (signature (memq 'signature gnus-article-wash-types))
4853           (overstrike (memq 'overstrike gnus-article-wash-types))
4854           (emphasis (memq 'emphasis gnus-article-wash-types)))
4855       (concat
4856        (gnus-article-wash-status-entry 'cite cite)
4857        (gnus-article-wash-status-entry 'headers (or headers boring))
4858        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
4859        (gnus-article-wash-status-entry 'signature signature)
4860        (gnus-article-wash-status-entry 'overstrike overstrike)
4861        (gnus-article-wash-status-entry 'emphasis emphasis)))))
4862
4863 (defun gnus-add-wash-type (type)
4864   "Add a washing of TYPE to the current status."
4865   (add-to-list 'gnus-article-wash-types type))
4866
4867 (defun gnus-delete-wash-type (type)
4868   "Add a washing of TYPE to the current status."
4869   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
4870
4871 (defun gnus-add-image (category image)
4872   "Add IMAGE of CATEGORY to the list of displayed images."
4873   (let ((entry (assq category gnus-article-image-alist)))
4874     (unless entry
4875       (setq entry (list category))
4876       (push entry gnus-article-image-alist))
4877     (nconc entry (list image))))
4878
4879 (defun gnus-delete-images (category)
4880   "Delete all images in CATEGORY."
4881   (let ((entry (assq category gnus-article-image-alist)))
4882     (dolist (image (cdr entry))
4883       (gnus-remove-image image category))
4884     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
4885     (gnus-delete-wash-type category)))
4886
4887 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
4888
4889 (defun gnus-article-maybe-hide-headers ()
4890   "Hide unwanted headers if `gnus-have-all-headers' is nil.
4891 Provided for backwards compatibility."
4892   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
4893                  (not (with-current-buffer gnus-summary-buffer
4894                         gnus-have-all-headers)))
4895              (not gnus-inhibit-hiding))
4896     (gnus-article-hide-headers)))
4897
4898 ;;; Article savers.
4899
4900 (defun gnus-output-to-file (file-name)
4901   "Append the current article to a file named FILE-NAME."
4902   (let ((artbuf (current-buffer)))
4903     (with-temp-buffer
4904       (insert-buffer-substring artbuf)
4905       ;; Append newline at end of the buffer as separator, and then
4906       ;; save it to file.
4907       (goto-char (point-max))
4908       (insert "\n")
4909       (let ((file-name-coding-system nnmail-pathname-coding-system))
4910         (mm-append-to-file (point-min) (point-max) file-name))
4911       t)))
4912
4913 (defun gnus-narrow-to-page (&optional arg)
4914   "Narrow the article buffer to a page.
4915 If given a numerical ARG, move forward ARG pages."
4916   (interactive "P")
4917   (setq arg (if arg (prefix-numeric-value arg) 0))
4918   (save-excursion
4919     (set-buffer gnus-article-buffer)
4920     (goto-char (point-min))
4921     (widen)
4922     ;; Remove any old next/prev buttons.
4923     (when (gnus-visual-p 'page-marker)
4924       (let ((buffer-read-only nil))
4925         (gnus-remove-text-with-property 'gnus-prev)
4926         (gnus-remove-text-with-property 'gnus-next)))
4927     (if
4928         (cond ((< arg 0)
4929                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
4930               ((> arg 0)
4931                (re-search-forward page-delimiter nil 'move arg)))
4932         (goto-char (match-end 0))
4933       (save-excursion
4934         (goto-char (point-min))
4935         (setq gnus-page-broken
4936               (and (re-search-forward page-delimiter nil t) t))))
4937     (when gnus-page-broken
4938       (narrow-to-region
4939        (point)
4940        (if (re-search-forward page-delimiter nil 'move)
4941            (match-beginning 0)
4942          (point)))
4943       (when (and (gnus-visual-p 'page-marker)
4944                  (not (= (point-min) 1)))
4945         (save-excursion
4946           (goto-char (point-min))
4947           (gnus-insert-prev-page-button)))
4948       (when (and (gnus-visual-p 'page-marker)
4949                  (< (+ (point-max) 2) (buffer-size)))
4950         (save-excursion
4951           (goto-char (point-max))
4952           (gnus-insert-next-page-button))))))
4953
4954 ;; Article mode commands
4955
4956 (defun gnus-article-goto-next-page ()
4957   "Show the next page of the article."
4958   (interactive)
4959   (when (gnus-article-next-page)
4960     (goto-char (point-min))
4961     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
4962
4963
4964 (defun gnus-article-goto-prev-page ()
4965   "Show the previous page of the article."
4966   (interactive)
4967   (if (bobp)
4968       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
4969     (gnus-article-prev-page nil)))
4970
4971 ;; This is cleaner but currently breaks `gnus-pick-mode':
4972 ;;
4973 ;; (defun gnus-article-goto-next-page ()
4974 ;;   "Show the next page of the article."
4975 ;;   (interactive)
4976 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4977 ;;     (gnus-summary-next-page)))
4978 ;;
4979 ;; (defun gnus-article-goto-prev-page ()
4980 ;;   "Show the next page of the article."
4981 ;;   (interactive)
4982 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
4983 ;;     (gnus-summary-prev-page)))
4984
4985 (defun gnus-article-next-page (&optional lines)
4986   "Show the next page of the current article.
4987 If end of article, return non-nil.  Otherwise return nil.
4988 Argument LINES specifies lines to be scrolled up."
4989   (interactive "p")
4990   (move-to-window-line -1)
4991   (if (save-excursion
4992         (end-of-line)
4993         (and (pos-visible-in-window-p)  ;Not continuation line.
4994              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
4995       ;; Nothing in this page.
4996       (if (or (not gnus-page-broken)
4997               (save-excursion
4998                 (save-restriction
4999                   (widen)
5000                   (eobp)))) ;Real end-of-buffer?
5001           (progn
5002             (when gnus-article-over-scroll
5003               (gnus-article-next-page-1 lines))
5004             t)                  ;Nothing more.
5005         (gnus-narrow-to-page 1)         ;Go to next page.
5006         nil)
5007     ;; More in this page.
5008     (gnus-article-next-page-1 lines)
5009     nil))
5010
5011 (defun gnus-article-next-page-1 (lines)
5012   (let ((scroll-in-place nil))
5013     (condition-case ()
5014         (scroll-up lines)
5015       (end-of-buffer
5016        ;; Long lines may cause an end-of-buffer error.
5017        (goto-char (point-max)))))
5018   (move-to-window-line 0))
5019
5020 (defun gnus-article-prev-page (&optional lines)
5021   "Show previous page of current article.
5022 Argument LINES specifies lines to be scrolled down."
5023   (interactive "p")
5024   (move-to-window-line 0)
5025   (if (and gnus-page-broken
5026            (bobp)
5027            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
5028       (progn
5029         (gnus-narrow-to-page -1)        ;Go to previous page.
5030         (goto-char (point-max))
5031         (recenter -1))
5032     (let ((scroll-in-place nil))
5033       (prog1
5034           (condition-case ()
5035               (scroll-down lines)
5036             (beginning-of-buffer
5037              (goto-char (point-min))))
5038         (move-to-window-line 0)))))
5039
5040 (defun gnus-article-only-boring-p ()
5041   "Decide whether there is only boring text remaining in the article.
5042 Something \"interesting\" is a word of at least two letters that does
5043 not have a face in `gnus-article-boring-faces'."
5044   (when (and gnus-article-skip-boring
5045              (boundp 'gnus-article-boring-faces)
5046              (symbol-value 'gnus-article-boring-faces))
5047     (save-excursion
5048       (catch 'only-boring
5049         (while (re-search-forward "\\b\\w\\w" nil t)
5050           (forward-char -1)
5051           (when (not (gnus-intersection
5052                       (gnus-faces-at (point))
5053                       (symbol-value 'gnus-article-boring-faces)))
5054             (throw 'only-boring nil)))
5055         (throw 'only-boring t)))))
5056
5057 (defun gnus-article-refer-article ()
5058   "Read article specified by message-id around point."
5059   (interactive)
5060   (save-excursion
5061     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
5062     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
5063     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
5064         (let ((msg-id (concat "<" (match-string 0) ">")))
5065           (set-buffer gnus-summary-buffer)
5066           (gnus-summary-refer-article msg-id))
5067       (error "No references around point"))))
5068
5069 (defun gnus-article-show-summary ()
5070   "Reconfigure windows to show summary buffer."
5071   (interactive)
5072   (if (not (gnus-buffer-live-p gnus-summary-buffer))
5073       (error "There is no summary buffer for this article buffer")
5074     (gnus-article-set-globals)
5075     (gnus-configure-windows 'article)
5076     (gnus-summary-goto-subject gnus-current-article)
5077     (gnus-summary-position-point)))
5078
5079 (defun gnus-article-describe-briefly ()
5080   "Describe article mode commands briefly."
5081   (interactive)
5082   (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")))
5083
5084 (defun gnus-article-summary-command ()
5085   "Execute the last keystroke in the summary buffer."
5086   (interactive)
5087   (let ((obuf (current-buffer))
5088         (owin (current-window-configuration))
5089         func)
5090     (switch-to-buffer gnus-article-current-summary 'norecord)
5091     (setq func (lookup-key (current-local-map) (this-command-keys)))
5092     (call-interactively func)
5093     (set-buffer obuf)
5094     (set-window-configuration owin)
5095     (set-window-point (get-buffer-window (current-buffer)) (point))))
5096
5097 (defun gnus-article-summary-command-nosave ()
5098   "Execute the last keystroke in the summary buffer."
5099   (interactive)
5100   (let (func)
5101     (pop-to-buffer gnus-article-current-summary 'norecord)
5102     (setq func (lookup-key (current-local-map) (this-command-keys)))
5103     (call-interactively func)))
5104
5105 (defun gnus-article-check-buffer ()
5106   "Beep if not in an article buffer."
5107   (unless (equal major-mode 'gnus-article-mode)
5108     (error "Command invoked outside of a Gnus article buffer")))
5109
5110 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
5111   "Read a summary buffer key sequence and execute it from the article buffer."
5112   (interactive "P")
5113   (gnus-article-check-buffer)
5114   (let ((nosaves
5115          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
5116            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
5117            "=" "^" "\M-^" "|"))
5118         (nosave-but-article
5119          '("A\r"))
5120         (nosave-in-article
5121          '("\C-d"))
5122         (up-to-top
5123          '("n" "Gn" "p" "Gp"))
5124         keys new-sum-point)
5125     (save-excursion
5126       (set-buffer gnus-article-current-summary)
5127       (let (gnus-pick-mode)
5128         (push (or key last-command-event) unread-command-events)
5129         (setq keys (if (featurep 'xemacs)
5130                        (events-to-keys (read-key-sequence nil))
5131                      (read-key-sequence nil)))))
5132
5133     (message "")
5134
5135     (if (or (member keys nosaves)
5136             (member keys nosave-but-article)
5137             (member keys nosave-in-article))
5138         (let (func)
5139           (save-window-excursion
5140             (pop-to-buffer gnus-article-current-summary 'norecord)
5141             ;; We disable the pick minor mode commands.
5142             (let (gnus-pick-mode)
5143               (setq func (lookup-key (current-local-map) keys))))
5144           (if (or (not func)
5145                   (numberp func))
5146               (ding)
5147             (unless (member keys nosave-in-article)
5148               (set-buffer gnus-article-current-summary))
5149             (call-interactively func)
5150             (setq new-sum-point (point)))
5151           (when (member keys nosave-but-article)
5152             (pop-to-buffer gnus-article-buffer 'norecord)))
5153       ;; These commands should restore window configuration.
5154       (let ((obuf (current-buffer))
5155             (owin (current-window-configuration))
5156             (opoint (point))
5157             win func in-buffer selected new-sum-start new-sum-hscroll)
5158         (cond (not-restore-window
5159                (pop-to-buffer gnus-article-current-summary 'norecord))
5160               ((setq win (get-buffer-window gnus-article-current-summary))
5161                (select-window win))
5162               (t
5163                (switch-to-buffer gnus-article-current-summary 'norecord)))
5164         (setq in-buffer (current-buffer))
5165         ;; We disable the pick minor mode commands.
5166         (if (and (setq func (let (gnus-pick-mode)
5167                               (lookup-key (current-local-map) keys)))
5168                  (functionp func))
5169             (progn
5170               (call-interactively func)
5171               (when (eq win (selected-window))
5172                 (setq new-sum-point (point)
5173                       new-sum-start (window-start win)
5174                       new-sum-hscroll (window-hscroll win))
5175               (when (eq in-buffer (current-buffer))
5176                 (setq selected (gnus-summary-select-article))
5177                 (set-buffer obuf)
5178                 (unless not-restore-window
5179                   (set-window-configuration owin))
5180                 (when (eq selected 'old)
5181                   (article-goto-body)
5182                   (set-window-start (get-buffer-window (current-buffer))
5183                                     1)
5184                   (set-window-point (get-buffer-window (current-buffer))
5185                                     (point)))
5186                 (when (and (not not-restore-window)
5187                            new-sum-point)
5188                   (set-window-point win new-sum-point)
5189                   (set-window-start win new-sum-start)
5190                   (set-window-hscroll win new-sum-hscroll)))))
5191           (set-window-configuration owin)
5192           (ding))))))
5193
5194 (defun gnus-article-describe-key (key)
5195   "Display documentation of the function invoked by KEY.  KEY is a string."
5196   (interactive "kDescribe key: ")
5197   (gnus-article-check-buffer)
5198   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5199       (save-excursion
5200         (set-buffer gnus-article-current-summary)
5201         (let (gnus-pick-mode)
5202           (if (featurep 'xemacs)
5203               (progn
5204                 (push (elt key 0) unread-command-events)
5205                 (setq key (events-to-keys
5206                            (read-key-sequence "Describe key: "))))
5207             (setq unread-command-events
5208                   (mapcar
5209                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5210                    (string-to-list key)))
5211             (setq key (read-key-sequence "Describe key: "))))
5212         (describe-key key))
5213     (describe-key key)))
5214
5215 (defun gnus-article-describe-key-briefly (key &optional insert)
5216   "Display documentation of the function invoked by KEY.  KEY is a string."
5217   (interactive "kDescribe key: \nP")
5218   (gnus-article-check-buffer)
5219   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5220       (save-excursion
5221         (set-buffer gnus-article-current-summary)
5222         (let (gnus-pick-mode)
5223           (if (featurep 'xemacs)
5224               (progn
5225                 (push (elt key 0) unread-command-events)
5226                 (setq key (events-to-keys
5227                            (read-key-sequence "Describe key: "))))
5228             (setq unread-command-events
5229                   (mapcar
5230                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5231                    (string-to-list key)))
5232             (setq key (read-key-sequence "Describe key: "))))
5233         (describe-key-briefly key insert))
5234     (describe-key-briefly key insert)))
5235
5236 (defun gnus-article-reply-with-original (&optional wide)
5237   "Start composing a reply mail to the current message.
5238 The text in the region will be yanked.  If the region isn't active,
5239 the entire article will be yanked."
5240   (interactive "P")
5241   (let ((article (cdr gnus-article-current))
5242         contents)
5243     (if (not (gnus-mark-active-p))
5244         (with-current-buffer gnus-summary-buffer
5245           (gnus-summary-reply (list (list article)) wide))
5246       (setq contents (buffer-substring (point) (mark t)))
5247       ;; Deactivate active regions.
5248       (when (and (boundp 'transient-mark-mode)
5249                  transient-mark-mode)
5250         (setq mark-active nil))
5251       (with-current-buffer gnus-summary-buffer
5252         (gnus-summary-reply
5253          (list (list article contents)) wide)))))
5254
5255 (defun gnus-article-followup-with-original ()
5256   "Compose a followup to the current article.
5257 The text in the region will be yanked.  If the region isn't active,
5258 the entire article will be yanked."
5259   (interactive)
5260   (let ((article (cdr gnus-article-current))
5261         contents)
5262       (if (not (gnus-mark-active-p))
5263           (with-current-buffer gnus-summary-buffer
5264             (gnus-summary-followup (list (list article))))
5265         (setq contents (buffer-substring (point) (mark t)))
5266         ;; Deactivate active regions.
5267         (when (and (boundp 'transient-mark-mode)
5268                    transient-mark-mode)
5269           (setq mark-active nil))
5270         (with-current-buffer gnus-summary-buffer
5271           (gnus-summary-followup
5272            (list (list article contents)))))))
5273
5274 (defun gnus-article-hide (&optional arg force)
5275   "Hide all the gruft in the current article.
5276 This means that signatures, cited text and (some) headers will be
5277 hidden.
5278 If given a prefix, show the hidden text instead."
5279   (interactive (append (gnus-article-hidden-arg) (list 'force)))
5280   (gnus-article-hide-headers arg)
5281   (gnus-article-hide-list-identifiers arg)
5282   (gnus-article-hide-citation-maybe arg force)
5283   (gnus-article-hide-signature arg))
5284
5285 (defun gnus-article-maybe-highlight ()
5286   "Do some article highlighting if article highlighting is requested."
5287   (when (gnus-visual-p 'article-highlight 'highlight)
5288     (gnus-article-highlight-some)))
5289
5290 (defun gnus-check-group-server ()
5291   ;; Make sure the connection to the server is alive.
5292   (unless (gnus-server-opened
5293            (gnus-find-method-for-group gnus-newsgroup-name))
5294     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5295     (gnus-request-group gnus-newsgroup-name t)))
5296
5297 (eval-when-compile
5298   (autoload 'nneething-get-file-name "nneething"))
5299
5300 (defun gnus-request-article-this-buffer (article group)
5301   "Get an article and insert it into this buffer."
5302   (let (do-update-line sparse-header)
5303     (prog1
5304         (save-excursion
5305           (erase-buffer)
5306           (gnus-kill-all-overlays)
5307           (setq group (or group gnus-newsgroup-name))
5308
5309           ;; Using `gnus-request-article' directly will insert the article into
5310           ;; `nntp-server-buffer' - so we'll save some time by not having to
5311           ;; copy it from the server buffer into the article buffer.
5312
5313           ;; We only request an article by message-id when we do not have the
5314           ;; headers for it, so we'll have to get those.
5315           (when (stringp article)
5316             (gnus-read-header article))
5317
5318           ;; If the article number is negative, that means that this article
5319           ;; doesn't belong in this newsgroup (possibly), so we find its
5320           ;; message-id and request it by id instead of number.
5321           (when (and (numberp article)
5322                      gnus-summary-buffer
5323                      (get-buffer gnus-summary-buffer)
5324                      (gnus-buffer-exists-p gnus-summary-buffer))
5325             (save-excursion
5326               (set-buffer gnus-summary-buffer)
5327               (let ((header (gnus-summary-article-header article)))
5328                 (when (< article 0)
5329                   (cond
5330                    ((memq article gnus-newsgroup-sparse)
5331                     ;; This is a sparse gap article.
5332                     (setq do-update-line article)
5333                     (setq article (mail-header-id header))
5334                     (setq sparse-header (gnus-read-header article))
5335                     (setq gnus-newsgroup-sparse
5336                           (delq article gnus-newsgroup-sparse)))
5337                    ((vectorp header)
5338                     ;; It's a real article.
5339                     (setq article (mail-header-id header)))
5340                    (t
5341                     ;; It is an extracted pseudo-article.
5342                     (setq article 'pseudo)
5343                     (gnus-request-pseudo-article header))))
5344
5345                 (let ((method (gnus-find-method-for-group
5346                                gnus-newsgroup-name)))
5347                   (when (and (eq (car method) 'nneething)
5348                              (vectorp header))
5349                     (let ((dir (nneething-get-file-name
5350                                 (mail-header-id header))))
5351                       (when (and (stringp dir)
5352                                  (file-directory-p dir))
5353                         (setq article 'nneething)
5354                         (gnus-group-enter-directory dir))))))))
5355
5356           (cond
5357            ;; Refuse to select canceled articles.
5358            ((and (numberp article)
5359                  gnus-summary-buffer
5360                  (get-buffer gnus-summary-buffer)
5361                  (gnus-buffer-exists-p gnus-summary-buffer)
5362                  (eq (cdr (with-current-buffer gnus-summary-buffer
5363                             (assq article gnus-newsgroup-reads)))
5364                      gnus-canceled-mark))
5365             nil)
5366            ;; We first check `gnus-original-article-buffer'.
5367            ((and (get-buffer gnus-original-article-buffer)
5368                  (numberp article)
5369                  (with-current-buffer gnus-original-article-buffer
5370                    (and (equal (car gnus-original-article) group)
5371                         (eq (cdr gnus-original-article) article))))
5372             (insert-buffer-substring gnus-original-article-buffer)
5373             'article)
5374            ;; Check the backlog.
5375            ((and gnus-keep-backlog
5376                  (gnus-backlog-request-article group article (current-buffer)))
5377             'article)
5378            ;; Check asynchronous pre-fetch.
5379            ((gnus-async-request-fetched-article group article (current-buffer))
5380             (gnus-async-prefetch-next group article gnus-summary-buffer)
5381             (when (and (numberp article) gnus-keep-backlog)
5382               (gnus-backlog-enter-article group article (current-buffer)))
5383             'article)
5384            ;; Check the cache.
5385            ((and gnus-use-cache
5386                  (numberp article)
5387                  (gnus-cache-request-article article group))
5388             'article)
5389            ;; Check the agent cache.
5390            ((gnus-agent-request-article article group)
5391             'article)
5392            ;; Get the article and put into the article buffer.
5393            ((or (stringp article)
5394                 (numberp article))
5395             (let ((gnus-override-method gnus-override-method)
5396                   (methods (and (stringp article)
5397                                 gnus-refer-article-method))
5398                   (backend (car (gnus-find-method-for-group
5399                                  gnus-newsgroup-name)))
5400                   result
5401                   (buffer-read-only nil))
5402               (if (or (not (listp methods))
5403                       (and (symbolp (car methods))
5404                            (assq (car methods) nnoo-definition-alist)))
5405                   (setq methods (list methods)))
5406               (when (and (null gnus-override-method)
5407                          methods)
5408                 (setq gnus-override-method (pop methods)))
5409               (while (not result)
5410                 (when (eq gnus-override-method 'current)
5411                   (setq gnus-override-method
5412                         (with-current-buffer gnus-summary-buffer
5413                           gnus-current-select-method)))
5414                 (erase-buffer)
5415                 (gnus-kill-all-overlays)
5416                 (let ((gnus-newsgroup-name group))
5417                   (gnus-check-group-server))
5418                 (cond
5419                  ((gnus-request-article article group (current-buffer))
5420                   (when (numberp article)
5421                     (gnus-async-prefetch-next group article
5422                                               gnus-summary-buffer)
5423                     (when gnus-keep-backlog
5424                       (gnus-backlog-enter-article
5425                        group article (current-buffer))))
5426                   (setq result 'article))
5427                  (methods
5428                   (setq gnus-override-method (pop methods)))
5429                  ((not (string-match "^400 "
5430                                      (nnheader-get-report backend)))
5431                   ;; If we get 400 server disconnect, reconnect and
5432                   ;; retry; otherwise, assume the article has expired.
5433                   (setq result 'done))))
5434               (and (eq result 'article) 'article)))
5435            ;; It was a pseudo.
5436            (t article)))
5437
5438       ;; Associate this article with the current summary buffer.
5439       (setq gnus-article-current-summary gnus-summary-buffer)
5440
5441       ;; Take the article from the original article buffer
5442       ;; and place it in the buffer it's supposed to be in.
5443       (when (and (get-buffer gnus-article-buffer)
5444                  (equal (buffer-name (current-buffer))
5445                         (buffer-name (get-buffer gnus-article-buffer))))
5446         (save-excursion
5447           (if (get-buffer gnus-original-article-buffer)
5448               (set-buffer gnus-original-article-buffer)
5449             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
5450             (buffer-disable-undo)
5451             (setq major-mode 'gnus-original-article-mode)
5452             (setq buffer-read-only t))
5453           (let (buffer-read-only)
5454             (erase-buffer)
5455             (insert-buffer-substring gnus-article-buffer))
5456           (setq gnus-original-article (cons group article)))
5457
5458         ;; Decode charsets.
5459         (run-hooks 'gnus-article-decode-hook)
5460         ;; Mark article as decoded or not.
5461         (setq gnus-article-decoded-p gnus-article-decode-hook))
5462
5463       ;; Update sparse articles.
5464       (when (and do-update-line
5465                  (or (numberp article)
5466                      (stringp article)))
5467         (let ((buf (current-buffer)))
5468           (set-buffer gnus-summary-buffer)
5469           (gnus-summary-update-article do-update-line sparse-header)
5470           (gnus-summary-goto-subject do-update-line nil t)
5471           (set-window-point (gnus-get-buffer-window (current-buffer) t)
5472                             (point))
5473           (set-buffer buf))))))
5474
5475 ;;;
5476 ;;; Article editing
5477 ;;;
5478
5479 (defcustom gnus-article-edit-mode-hook nil
5480   "Hook run in article edit mode buffers."
5481   :group 'gnus-article-various
5482   :type 'hook)
5483
5484 (defvar gnus-article-edit-done-function nil)
5485
5486 (defvar gnus-article-edit-mode-map nil)
5487
5488 ;; Should we be using derived.el for this?
5489 (unless gnus-article-edit-mode-map
5490   (setq gnus-article-edit-mode-map (make-keymap))
5491   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
5492
5493   (gnus-define-keys gnus-article-edit-mode-map
5494     "\C-c?"    describe-mode
5495     "\C-c\C-c" gnus-article-edit-done
5496     "\C-c\C-k" gnus-article-edit-exit
5497     "\C-c\C-f\C-t" message-goto-to
5498     "\C-c\C-f\C-o" message-goto-from
5499     "\C-c\C-f\C-b" message-goto-bcc
5500     ;;"\C-c\C-f\C-w" message-goto-fcc
5501     "\C-c\C-f\C-c" message-goto-cc
5502     "\C-c\C-f\C-s" message-goto-subject
5503     "\C-c\C-f\C-r" message-goto-reply-to
5504     "\C-c\C-f\C-n" message-goto-newsgroups
5505     "\C-c\C-f\C-d" message-goto-distribution
5506     "\C-c\C-f\C-f" message-goto-followup-to
5507     "\C-c\C-f\C-m" message-goto-mail-followup-to
5508     "\C-c\C-f\C-k" message-goto-keywords
5509     "\C-c\C-f\C-u" message-goto-summary
5510     "\C-c\C-f\C-i" message-insert-or-toggle-importance
5511     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
5512     "\C-c\C-b" message-goto-body
5513     "\C-c\C-i" message-goto-signature
5514
5515     "\C-c\C-t" message-insert-to
5516     "\C-c\C-n" message-insert-newsgroups
5517     "\C-c\C-o" message-sort-headers
5518     "\C-c\C-e" message-elide-region
5519     "\C-c\C-v" message-delete-not-region
5520     "\C-c\C-z" message-kill-to-signature
5521     "\M-\r" message-newline-and-reformat
5522     "\C-c\C-a" mml-attach-file
5523     "\C-a" message-beginning-of-line
5524     "\t" message-tab
5525     "\M-;" comment-region)
5526
5527   (gnus-define-keys (gnus-article-edit-wash-map
5528                      "\C-c\C-w" gnus-article-edit-mode-map)
5529     "f" gnus-article-edit-full-stops))
5530
5531 (easy-menu-define
5532   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
5533   '("Field"
5534     ["Fetch To" message-insert-to t]
5535     ["Fetch Newsgroups" message-insert-newsgroups t]
5536     "----"
5537     ["To" message-goto-to t]
5538     ["From" message-goto-from t]
5539     ["Subject" message-goto-subject t]
5540     ["Cc" message-goto-cc t]
5541     ["Reply-To" message-goto-reply-to t]
5542     ["Summary" message-goto-summary t]
5543     ["Keywords" message-goto-keywords t]
5544     ["Newsgroups" message-goto-newsgroups t]
5545     ["Followup-To" message-goto-followup-to t]
5546     ["Mail-Followup-To" message-goto-mail-followup-to t]
5547     ["Distribution" message-goto-distribution t]
5548     ["Body" message-goto-body t]
5549     ["Signature" message-goto-signature t]))
5550
5551 (define-derived-mode gnus-article-edit-mode text-mode "Article Edit"
5552   "Major mode for editing articles.
5553 This is an extended text-mode.
5554
5555 \\{gnus-article-edit-mode-map}"
5556   (make-local-variable 'gnus-article-edit-done-function)
5557   (make-local-variable 'gnus-prev-winconf)
5558   (set (make-local-variable 'font-lock-defaults)
5559        '(message-font-lock-keywords t))
5560   (set (make-local-variable 'mail-header-separator) "")
5561   (set (make-local-variable 'gnus-article-edit-mode) t)
5562   (easy-menu-add message-mode-field-menu message-mode-map)
5563   (mml-mode)
5564   (setq buffer-read-only nil)
5565   (buffer-enable-undo)
5566   (widen))
5567
5568 (defun gnus-article-edit (&optional force)
5569   "Edit the current article.
5570 This will have permanent effect only in mail groups.
5571 If FORCE is non-nil, allow editing of articles even in read-only
5572 groups."
5573   (interactive "P")
5574   (when (and (not force)
5575              (gnus-group-read-only-p))
5576     (error "The current newsgroup does not support article editing"))
5577   (gnus-article-date-original)
5578   (gnus-article-edit-article
5579    'ignore
5580    `(lambda (no-highlight)
5581       'ignore
5582       (gnus-summary-edit-article-done
5583        ,(or (mail-header-references gnus-current-headers) "")
5584        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
5585
5586 (defun gnus-article-edit-article (start-func exit-func)
5587   "Start editing the contents of the current article buffer."
5588   (let ((winconf (current-window-configuration)))
5589     (set-buffer gnus-article-buffer)
5590     (gnus-article-edit-mode)
5591     (funcall start-func)
5592     (set-buffer-modified-p nil)
5593     (gnus-configure-windows 'edit-article)
5594     (setq gnus-article-edit-done-function exit-func)
5595     (setq gnus-prev-winconf winconf)
5596     (gnus-message 6 "C-c C-c to end edits")))
5597
5598 (defun gnus-article-edit-done (&optional arg)
5599   "Update the article edits and exit."
5600   (interactive "P")
5601   (let ((func gnus-article-edit-done-function)
5602         (buf (current-buffer))
5603         (start (window-start))
5604         (p (point))
5605         (winconf gnus-prev-winconf))
5606     (widen) ;; Widen it in case that users narrowed the buffer.
5607     (funcall func arg)
5608     (set-buffer buf)
5609     ;; The cache and backlog have to be flushed somewhat.
5610     (when gnus-keep-backlog
5611       (gnus-backlog-remove-article
5612        (car gnus-article-current) (cdr gnus-article-current)))
5613     ;; Flush original article as well.
5614     (save-excursion
5615       (when (get-buffer gnus-original-article-buffer)
5616         (set-buffer gnus-original-article-buffer)
5617         (setq gnus-original-article nil)))
5618     (when gnus-use-cache
5619       (gnus-cache-update-article
5620        (car gnus-article-current) (cdr gnus-article-current)))
5621     ;; We remove all text props from the article buffer.
5622     (kill-all-local-variables)
5623     (set-text-properties (point-min) (point-max) nil)
5624     (gnus-article-mode)
5625     (set-window-configuration winconf)
5626     (set-buffer buf)
5627     (set-window-start (get-buffer-window buf) start)
5628     (set-window-point (get-buffer-window buf) (point)))
5629   (gnus-summary-show-article))
5630
5631 (defun gnus-article-edit-exit ()
5632   "Exit the article editing without updating."
5633   (interactive)
5634   (when (or (not (buffer-modified-p))
5635             (yes-or-no-p "Article modified; kill anyway? "))
5636     (let ((curbuf (current-buffer))
5637           (p (point))
5638           (window-start (window-start)))
5639       (erase-buffer)
5640       (if (gnus-buffer-live-p gnus-original-article-buffer)
5641           (insert-buffer gnus-original-article-buffer))
5642       (let ((winconf gnus-prev-winconf))
5643         (kill-all-local-variables)
5644         (gnus-article-mode)
5645         (set-window-configuration winconf)
5646         ;; Tippy-toe some to make sure that point remains where it was.
5647         (save-current-buffer
5648           (set-buffer curbuf)
5649           (set-window-start (get-buffer-window (current-buffer)) window-start)
5650           (goto-char p))))
5651     (gnus-summary-show-article)))
5652
5653 (defun gnus-article-edit-full-stops ()
5654   "Interactively repair spacing at end of sentences."
5655   (interactive)
5656   (save-excursion
5657     (goto-char (point-min))
5658     (search-forward-regexp "^$" nil t)
5659     (let ((case-fold-search nil))
5660       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
5661
5662 ;;;
5663 ;;; Article highlights
5664 ;;;
5665
5666 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
5667
5668 ;;; Internal Variables:
5669
5670 (defcustom gnus-button-url-regexp
5671   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
5672       "\\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:]]\\)"
5673     "\\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\\)\\)")
5674   "Regular expression that matches URLs."
5675   :group 'gnus-article-buttons
5676   :type 'regexp)
5677
5678 (defcustom gnus-button-valid-fqdn-regexp
5679   message-valid-fqdn-regexp
5680   "Regular expression that matches a valid FQDN."
5681   :group 'gnus-article-buttons
5682   :type 'regexp)
5683
5684 (defcustom gnus-button-man-handler 'manual-entry
5685   "Function to use for displaying man pages.
5686 The function must take at least one argument with a string naming the
5687 man page."
5688   :type '(choice (function-item :tag "Man" manual-entry)
5689                  (function-item :tag "Woman" woman)
5690                  (function :tag "Other"))
5691   :group 'gnus-article-buttons)
5692
5693 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
5694   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
5695 If the default site is too slow, try to find a CTAN mirror, see
5696 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
5697 the variable `gnus-button-handle-ctan'."
5698   :group 'gnus-article-buttons
5699   :link '(custom-manual "(gnus)Group Parameters")
5700   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
5701                  (const "http://tug.ctan.org/tex-archive/")
5702                  (const "http://www.dante.de/CTAN/")
5703                  (string :tag "Other")))
5704
5705 (defcustom gnus-button-ctan-handler 'browse-url
5706   "Function to use for displaying CTAN links.
5707 The function must take one argument, the string naming the URL."
5708   :type '(choice (function-item :tag "Browse Url" browse-url)
5709                  (function :tag "Other"))
5710   :group 'gnus-article-buttons)
5711
5712 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
5713   "Bogus strings removed from CTAN URLs."
5714   :group 'gnus-article-buttons
5715   :type '(choice (const "^/?tex-archive/\\|/")
5716                  (regexp :tag "Other")))
5717
5718 (defcustom gnus-button-ctan-directory-regexp
5719   (concat
5720    "\\(?:"
5721    "biblio\\|digests\\|dviware\\|fonts\\|graphics\\|help\\|"
5722    "indexing\\|info\\|language\\|macros\\|support\\|systems\\|"
5723    "tds\\|tools\\|usergrps\\|web\\|nonfree\\|obsolete"
5724    "\\)")
5725   "Regular expression for ctan directories.
5726 It should match all directories in the top level of `gnus-ctan-url'."
5727   :group 'gnus-article-buttons
5728   :type 'regexp)
5729
5730 (defcustom gnus-button-mid-or-mail-regexp
5731   (concat "\\b\\(<?[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t ]*@"
5732           ;; Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
5733           gnus-button-valid-fqdn-regexp
5734           ">?\\)\\b")
5735   "Regular expression that matches a message ID or a mail address."
5736   :group 'gnus-article-buttons
5737   :type 'regexp)
5738
5739 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
5740   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
5741 Strings like this can be either a message ID or a mail address.  If it is one
5742 of the symbols `mid' or `mail', Gnus will always assume that the string is a
5743 message ID or a mail address, respectively.  If this variable is set to the
5744 symbol `ask', always query the user what do do.  If it is a function, this
5745 function will be called with the string as it's only argument.  The function
5746 must return `mid', `mail', `invalid' or `ask'."
5747   :group 'gnus-article-buttons
5748   :type '(choice (function-item :tag "Heuristic function"
5749                                 gnus-button-mid-or-mail-heuristic)
5750                  (const ask)
5751                  (const mid)
5752                  (const mail)))
5753
5754 (defcustom gnus-button-mid-or-mail-heuristic-alist
5755   '((-10.0 . ".+\\$.+@")
5756     (-10.0 . "#")
5757     (-10.0 . "\\*")
5758     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
5759     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
5760     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
5761     (-1.0  . "^[^a-z]+@")
5762     ;;
5763     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
5764     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
5765     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
5766     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
5767     ;;
5768     (-2.0  . "^[0-9]")
5769     (-1.0  . "^[0-9][0-9]")
5770     ;;
5771     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
5772     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5773     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
5774     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
5775     ;;
5776     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
5777     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
5778     ;;       "[0-9]{8,}.*\@"
5779     (-3.0
5780      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
5781     ;; "[0-9]{12,}.*\@"
5782     ;; compensation for TDMA dated mail addresses:
5783     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
5784     ;;
5785     (-20.0 . "\\.fsf@") ;; Gnus
5786     (-20.0 . "^slrn")
5787     (-20.0 . "^Pine")
5788     (-20.0 . "_-_") ;; Subject change in thread
5789     ;;
5790     (-20.0 . "\\.ln@") ;; leafnode
5791     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
5792     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
5793     ;;
5794     ;; (5.0 . "") ;; $local_part_len <= 7
5795     (10.0  . "^[^0-9]+@")
5796     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
5797     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
5798     (3.0   . "\@stud")
5799     ;;
5800     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
5801     ;;
5802     (0.5   . "^[A-Z][a-z]")
5803     (0.5   . "^[A-Z][a-z][a-z]")
5804     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
5805     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
5806   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
5807
5808 A negative RATE indicates a message IDs, whereas a positive indicates a mail
5809 address.  The REGEXP is processed with `case-fold-search' set to nil."
5810   :group 'gnus-article-buttons
5811   :type '(repeat (cons (number :tag "Rate")
5812                        (regexp :tag "Regexp"))))
5813
5814 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
5815   "Guess whether MID-OR-MAIL is a message ID or a mail address.
5816 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
5817 address, `ask' if unsure and `invalid' if the string is invalid."
5818   (let ((case-fold-search nil)
5819         (list gnus-button-mid-or-mail-heuristic-alist)
5820         (result 0) rate regexp lpartlen elem)
5821     (setq lpartlen
5822           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
5823     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
5824     ;; Certain special cases...
5825     (when (string-match
5826            (concat
5827             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
5828             "^[0-9]+\\.[0-9]+@compuserve\\|"
5829             "@public\\.gmane\\.org")
5830            mid-or-mail)
5831       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
5832       (setq result 'mail))
5833     (when (string-match "@.*@\\| " mid-or-mail)
5834       (gnus-message 8 "`%s' is invalid." mid-or-mail)
5835       (setq result 'invalid))
5836     ;; Nothing more to do, if result is not a number here...
5837     (when (numberp result)
5838       (while list
5839         (setq elem (car list)
5840               rate (car elem)
5841               regexp (cdr elem)
5842               list (cdr list))
5843         (when (string-match regexp mid-or-mail)
5844           (setq result (+ result rate))
5845           (gnus-message
5846            9 "`%s' matched `%s', rate `%s', result `%s'."
5847            mid-or-mail regexp rate result)))
5848       (when (<= lpartlen 7)
5849         (setq result (+ result 5.0))
5850         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
5851                       mid-or-mail result))
5852       (when (>= lpartlen 12)
5853         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
5854         (cond
5855          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
5856           ;; Long local part should contain realname if e-mail address,
5857           ;; too many digits: message-id.
5858           ;; $score -= 5.0 + 0.1 * $local_part_len;
5859           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
5860           (setq result (+ result rate))
5861           (gnus-message
5862            9 "Many digits in `%s', rate `%s', result `%s'."
5863            mid-or-mail rate result))
5864          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
5865                         mid-or-mail)
5866           ;; Too few vowels [^aeiouy]{4,}.*\@
5867           (setq result (+ result -5.0))
5868           (gnus-message
5869            9 "Few vowels in `%s', rate `%s', result `%s'."
5870            mid-or-mail -5.0 result))
5871          (t
5872           (setq result (+ result 5.0))
5873           (gnus-message
5874            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
5875     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
5876     ;; Maybe we should make this a customizable alist: (condition . 'result)
5877     (cond
5878      ((symbolp result) result)
5879      ;; Now convert number into proper results:
5880      ((< result -10.0) 'mid)
5881      ((> result  10.0) 'mail)
5882      (t 'ask))))
5883
5884 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
5885   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
5886          (url-mid (concat "news" ":" mid-or-mail))
5887          (url-mailto (concat "mailto" ":" mid-or-mail)))
5888     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
5889     (when (fboundp pref)
5890       (setq guessed
5891             ;; get rid of surrounding angles...
5892             (funcall pref
5893                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
5894       (if (or (eq 'mid guessed) (eq 'mail guessed))
5895           (setq pref guessed)
5896         (setq pref 'ask)))
5897     (if (eq pref 'ask)
5898         (save-window-excursion
5899           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
5900               (setq pref 'mail)
5901             (setq pref 'mid))))
5902     (cond ((eq pref 'mid)
5903            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
5904            (gnus-button-handle-news url-mid))
5905           ((eq pref 'mail)
5906            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
5907            (gnus-url-mailto url-mailto))
5908           (t (gnus-message 3 "Invalid string.")))))
5909
5910 (defun gnus-button-handle-custom (url)
5911   "Follow a Custom URL."
5912   (customize-apropos (gnus-url-unhex-string url)))
5913
5914 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
5915
5916 ;; FIXME: Maybe we should merge some of the functions that do quite similar
5917 ;; stuff?
5918
5919 (defun gnus-button-handle-describe-function (url)
5920   "Call `describe-function' when pushing the corresponding URL button."
5921   (describe-function
5922    (intern
5923     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5924
5925 (defun gnus-button-handle-describe-variable (url)
5926   "Call `describe-variable' when pushing the corresponding URL button."
5927   (describe-variable
5928    (intern
5929     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5930
5931 (defun gnus-button-handle-symbol (url)
5932 "Display help on variable or function.
5933 Calls `describe-variable' or `describe-function'."
5934   (let ((sym (intern url)))
5935     (cond
5936      ((fboundp sym) (describe-function sym))
5937      ((boundp sym) (describe-variable sym))
5938      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
5939
5940 (defun gnus-button-handle-describe-key (url)
5941   "Call `describe-key' when pushing the corresponding URL button."
5942   (let* ((key-string
5943           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
5944          (keys (ignore-errors (eval `(kbd ,key-string)))))
5945     (if keys
5946         (describe-key keys)
5947       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
5948
5949 (defun gnus-button-handle-apropos (url)
5950   "Call `apropos' when pushing the corresponding URL button."
5951   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5952
5953 (defun gnus-button-handle-apropos-command (url)
5954   "Call `apropos' when pushing the corresponding URL button."
5955   (apropos-command
5956    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5957
5958 (defun gnus-button-handle-apropos-variable (url)
5959   "Call `apropos' when pushing the corresponding URL button."
5960   (funcall
5961    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
5962    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5963
5964 (defun gnus-button-handle-apropos-documentation (url)
5965   "Call `apropos' when pushing the corresponding URL button."
5966   (funcall
5967    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
5968    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5969
5970 (defun gnus-button-handle-library (url)
5971   "Call `locate-library' when pushing the corresponding URL button."
5972   (gnus-message 9 "url=`%s'" url)
5973   (let* ((lib (locate-library url))
5974          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
5975     (if (not lib)
5976         (gnus-message 1 "Cannot locale library `%s'." url)
5977       (find-file-read-only file))))
5978
5979 (defun gnus-button-handle-ctan (url)
5980   "Call `browse-url' when pushing a CTAN URL button."
5981   (funcall
5982    gnus-button-ctan-handler
5983    (concat
5984     gnus-ctan-url
5985     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
5986
5987 (defcustom gnus-button-tex-level 5
5988   "*Integer that says how many TeX-related buttons Gnus will show.
5989 The higher the number, the more buttons will appear and the more false
5990 positives are possible.  Note that you can set this variable local to
5991 specific groups.  Setting it higher in TeX groups is probably a good idea.
5992 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5993 how to set variables in specific groups."
5994   :group 'gnus-article-buttons
5995   :link '(custom-manual "(gnus)Group Parameters")
5996   :type 'integer)
5997
5998 (defcustom gnus-button-man-level 5
5999   "*Integer that says how many man-related buttons Gnus will show.
6000 The higher the number, the more buttons will appear and the more false
6001 positives are possible.  Note that you can set this variable local to
6002 specific groups.  Setting it higher in Unix groups is probably a good idea.
6003 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
6004 how to set variables in specific groups."
6005   :group 'gnus-article-buttons
6006   :link '(custom-manual "(gnus)Group Parameters")
6007   :type 'integer)
6008
6009 (defcustom gnus-button-emacs-level 5
6010   "*Integer that says how many emacs-related buttons Gnus will show.
6011 The higher the number, the more buttons will appear and the more false
6012 positives are possible.  Note that you can set this variable local to
6013 specific groups.  Setting it higher in Emacs or Gnus related groups is
6014 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
6015 `gnus-parameters' on how to set variables in specific groups."
6016   :group 'gnus-article-buttons
6017   :link '(custom-manual "(gnus)Group Parameters")
6018   :type 'integer)
6019
6020 (defcustom gnus-button-message-level 5
6021   "*Integer that says how many buttons for news or mail messages will appear.
6022 The higher the number, the more buttons will appear and the more false
6023 positives are possible."
6024   ;; mail addresses, MIDs, URLs for news, ...
6025   :group 'gnus-article-buttons
6026   :type 'integer)
6027
6028 (defcustom gnus-button-browse-level 5
6029   "*Integer that says how many buttons for browsing will appear.
6030 The higher the number, the more buttons will appear and the more false
6031 positives are possible."
6032   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
6033   :group 'gnus-article-buttons
6034   :type 'integer)
6035
6036 (defcustom gnus-button-alist
6037   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
6038      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
6039     ("\\b\\(nntp\\|news\\):\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t
6040      gnus-button-handle-news 2)
6041     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
6042      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
6043     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
6044      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
6045     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
6046     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
6047      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
6048     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
6049      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
6050     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
6051      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
6052     ;; RFC 2368 (The mailto URL scheme)
6053     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6054      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6055     ("\\bmailto:\\([^ \n\t]+\\)"
6056      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6057     ;; CTAN
6058     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
6059              gnus-button-ctan-directory-regexp
6060              "[^][>)!;:,'\n\t ]+\\)")
6061      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
6062     ((concat "\\btex-archive/\\("
6063              gnus-button-ctan-directory-regexp
6064              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
6065      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
6066     ((concat
6067       "\\b\\("
6068       gnus-button-ctan-directory-regexp
6069       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
6070      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
6071     ;; This is info (home-grown style) <info://foo/bar+baz>
6072     ("\\binfo://\\([^'\">\n\t ]+\\)"
6073      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
6074     ;; Info GNOME style <info:foo#bar_baz>
6075     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
6076      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
6077     ;; Info KDE style <info:(foo)bar baz>
6078     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
6079      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
6080     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
6081      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6082     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
6083      ;; Info links like `C-h i d m CC Mode RET'
6084      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
6085     ;; This is custom
6086     ("\\bcustom:\\(//\\)?\\([^'\">\n\t ]+\\)"
6087      0 (>= gnus-button-emacs-level 5) gnus-button-handle-custom 2)
6088     ("M-x[ \t\n]customize-[^ ]+[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
6089      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1)
6090     ;; Emacs help commands
6091     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6092      ;; regexp doesn't match arguments containing ` '.
6093      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
6094     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6095      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
6096     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6097      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
6098     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6099      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
6100     ;; The following entries may lead to many false positives so don't enable
6101     ;; them by default (use a high button level):
6102     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>"
6103      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6104     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
6105      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6106     ("`\\([a-z][a-z0-9]+-[a-z]+-[-a-z]+\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
6107      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
6108     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
6109      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
6110     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
6111      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
6112     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6113      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
6114     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6115      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
6116     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6117      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
6118     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
6119      ;; Unlike the other regexps we really have to require quoting
6120      ;; here to determine where it ends.
6121      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
6122     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
6123     ("<URL: *\\([^<>]*\\)>"
6124      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6125     ;; RFC 2396 (2.4.3., delims) ...
6126     ("\"URL: *\\([^\"]*\\)\""
6127      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6128     ;; RFC 2396 (2.4.3., delims) ...
6129     ("\"URL: *\\([^\"]*\\)\""
6130      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6131     ;; Raw URLs.
6132     (gnus-button-url-regexp
6133      0 (>= gnus-button-browse-level 0) browse-url 0)
6134     ;; man pages
6135     ("\\b\\([a-z][a-z]+\\)([1-9])\\W"
6136      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
6137      gnus-button-handle-man 1)
6138     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
6139     ("\\b\\([a-z][-_.a-z0-9]+\\)([1-9])\\W"
6140      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
6141      gnus-button-handle-man 1)
6142     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
6143     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
6144     ("\\b\\([a-z][-+_.:a-z0-9]+\\)([1-9][X1a-z]*)\\W\\|\\b\\(X\\)([1-9])\\W"
6145      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
6146     ;; MID or mail: To avoid too many false positives we don't try to catch
6147     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
6148     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
6149     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
6150     ;; so that non-ambiguous entries (see above) match first.
6151     (gnus-button-mid-or-mail-regexp
6152      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
6153   "*Alist of regexps matching buttons in article bodies.
6154
6155 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
6156 REGEXP: is the string (case insensitive) matching text around the button (can
6157 also be Lisp expression evaluating to a string),
6158 BUTTON: is the number of the regexp grouping actually matching the button,
6159 FORM: is a Lisp expression which must eval to true for the button to
6160 be added,
6161 CALLBACK: is the function to call when the user push this button, and each
6162 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
6163
6164 CALLBACK can also be a variable, in that case the value of that
6165 variable it the real callback function."
6166   :group 'gnus-article-buttons
6167   :type '(repeat (list (choice regexp variable sexp)
6168                        (integer :tag "Button")
6169                        (sexp :tag "Form")
6170                        (function :tag "Callback")
6171                        (repeat :tag "Par"
6172                                :inline t
6173                                (integer :tag "Regexp group")))))
6174
6175 (defcustom gnus-header-button-alist
6176   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
6177      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
6178     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
6179      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
6180     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
6181      0 (>= gnus-button-message-level 0) gnus-button-mailto 0)
6182     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
6183      0 (>= gnus-button-browse-level 0) browse-url 0)
6184     ("^Subject:" gnus-button-url-regexp
6185      0 (>= gnus-button-browse-level 0) browse-url 0)
6186     ("^[^:]+:" gnus-button-url-regexp
6187      0 (>= gnus-button-browse-level 0) browse-url 0)
6188     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6189      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6190     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
6191      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
6192   "*Alist of headers and regexps to match buttons in article heads.
6193
6194 This alist is very similar to `gnus-button-alist', except that each
6195 alist has an additional HEADER element first in each entry:
6196
6197 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
6198
6199 HEADER is a regexp to match a header.  For a fuller explanation, see
6200 `gnus-button-alist'."
6201   :group 'gnus-article-buttons
6202   :group 'gnus-article-headers
6203   :type '(repeat (list (regexp :tag "Header")
6204                        (choice regexp variable)
6205                        (integer :tag "Button")
6206                        (sexp :tag "Form")
6207                        (function :tag "Callback")
6208                        (repeat :tag "Par"
6209                                :inline t
6210                                (integer :tag "Regexp group")))))
6211
6212 ;;; Commands:
6213
6214 (defun gnus-article-push-button (event)
6215   "Check text under the mouse pointer for a callback function.
6216 If the text under the mouse pointer has a `gnus-callback' property,
6217 call it with the value of the `gnus-data' text property."
6218   (interactive "e")
6219   (set-buffer (window-buffer (posn-window (event-start event))))
6220   (let* ((pos (posn-point (event-start event)))
6221          (data (get-text-property pos 'gnus-data))
6222          (fun (get-text-property pos 'gnus-callback)))
6223     (goto-char pos)
6224     (when fun
6225       (funcall fun data))))
6226
6227 (defun gnus-article-press-button ()
6228   "Check text at point for a callback function.
6229 If the text at point has a `gnus-callback' property,
6230 call it with the value of the `gnus-data' text property."
6231   (interactive)
6232   (let ((data (get-text-property (point) 'gnus-data))
6233         (fun (get-text-property (point) 'gnus-callback)))
6234     (when fun
6235       (funcall fun data))))
6236
6237 (defun gnus-article-highlight (&optional force)
6238   "Highlight current article.
6239 This function calls `gnus-article-highlight-headers',
6240 `gnus-article-highlight-citation',
6241 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6242 do the highlighting.  See the documentation for those functions."
6243   (interactive (list 'force))
6244   (gnus-article-highlight-headers)
6245   (gnus-article-highlight-citation force)
6246   (gnus-article-highlight-signature)
6247   (gnus-article-add-buttons force)
6248   (gnus-article-add-buttons-to-head))
6249
6250 (defun gnus-article-highlight-some (&optional force)
6251   "Highlight current article.
6252 This function calls `gnus-article-highlight-headers',
6253 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6254 do the highlighting.  See the documentation for those functions."
6255   (interactive (list 'force))
6256   (gnus-article-highlight-headers)
6257   (gnus-article-highlight-signature)
6258   (gnus-article-add-buttons))
6259
6260 (defun gnus-article-highlight-headers ()
6261   "Highlight article headers as specified by `gnus-header-face-alist'."
6262   (interactive)
6263   (gnus-with-article-headers
6264     (let ((alist gnus-header-face-alist)
6265           entry regexp header-face field-face from hpoints fpoints)
6266       (while (setq entry (pop alist))
6267         (goto-char (point-min))
6268         (setq regexp (concat "^\\("
6269                              (if (string-equal "" (nth 0 entry))
6270                                  "[^\t ]"
6271                                (nth 0 entry))
6272                              "\\)")
6273               header-face (nth 1 entry)
6274               field-face (nth 2 entry))
6275         (while (and (re-search-forward regexp nil t)
6276                     (not (eobp)))
6277           (beginning-of-line)
6278           (setq from (point))
6279           (unless (search-forward ":" nil t)
6280             (forward-char 1))
6281           (when (and header-face
6282                      (not (memq (point) hpoints)))
6283             (push (point) hpoints)
6284             (gnus-put-text-property from (point) 'face header-face))
6285           (when (and field-face
6286                      (not (memq (setq from (point)) fpoints)))
6287             (push from fpoints)
6288             (if (re-search-forward "^[^ \t]" nil t)
6289                 (forward-char -2)
6290               (goto-char (point-max)))
6291             (gnus-put-text-property from (point) 'face field-face)))))))
6292
6293 (defun gnus-article-highlight-signature ()
6294   "Highlight the signature in an article.
6295 It does this by highlighting everything after
6296 `gnus-signature-separator' using `gnus-signature-face'."
6297   (interactive)
6298   (gnus-with-article-buffer
6299     (let ((inhibit-point-motion-hooks t))
6300       (save-restriction
6301         (when (and gnus-signature-face
6302                    (gnus-article-narrow-to-signature))
6303           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
6304                             'face gnus-signature-face)
6305           (widen)
6306           (gnus-article-search-signature)
6307           (let ((start (match-beginning 0))
6308                 (end (set-marker (make-marker) (1+ (match-end 0)))))
6309             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
6310                                      end)))))))
6311
6312 (defun gnus-button-in-region-p (b e prop)
6313   "Say whether PROP exists in the region."
6314   (text-property-not-all b e prop nil))
6315
6316 (defun gnus-article-add-buttons (&optional force)
6317   "Find external references in the article and make buttons of them.
6318 \"External references\" are things like Message-IDs and URLs, as
6319 specified by `gnus-button-alist'."
6320   (interactive (list 'force))
6321   (gnus-with-article-buffer
6322     (let ((inhibit-point-motion-hooks t)
6323           (case-fold-search t)
6324           (alist gnus-button-alist)
6325           beg entry regexp)
6326       ;; Remove all old markers.
6327       (let (marker entry new-list)
6328         (while (setq marker (pop gnus-button-marker-list))
6329           (if (or (< marker (point-min)) (>= marker (point-max)))
6330               (push marker new-list)
6331             (goto-char marker)
6332             (when (setq entry (gnus-button-entry))
6333               (put-text-property (match-beginning (nth 1 entry))
6334                                  (match-end (nth 1 entry))
6335                                  'gnus-callback nil))
6336             (set-marker marker nil)))
6337         (setq gnus-button-marker-list new-list))
6338       ;; We skip the headers.
6339       (article-goto-body)
6340       (setq beg (point))
6341       (while (setq entry (pop alist))
6342         (setq regexp (eval (car entry)))
6343         (goto-char beg)
6344         (while (re-search-forward regexp nil t)
6345           (let* ((start (and entry (match-beginning (nth 1 entry))))
6346                  (end (and entry (match-end (nth 1 entry))))
6347                  (from (match-beginning 0)))
6348             (when (and (or (eq t (nth 2 entry))
6349                            (eval (nth 2 entry)))
6350                        (not (gnus-button-in-region-p
6351                              start end 'gnus-callback)))
6352               ;; That optional form returned non-nil, so we add the
6353               ;; button.
6354               (gnus-article-add-button
6355                start end 'gnus-button-push
6356                (car (push (set-marker (make-marker) from)
6357                           gnus-button-marker-list))))))))))
6358
6359 ;; Add buttons to the head of an article.
6360 (defun gnus-article-add-buttons-to-head ()
6361   "Add buttons to the head of the article."
6362   (interactive)
6363   (gnus-with-article-headers
6364     (let ((alist gnus-header-button-alist)
6365           entry beg end)
6366       (while alist
6367         ;; Each alist entry.
6368         (setq entry (pop alist))
6369         (goto-char (point-min))
6370         (while (re-search-forward (car entry) nil t)
6371           ;; Each header matching the entry.
6372           (setq beg (match-beginning 0))
6373           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
6374                              (match-beginning 0))
6375                         (point-max)))
6376           (goto-char beg)
6377           (while (re-search-forward (eval (nth 1 entry)) end t)
6378             ;; Each match within a header.
6379             (let* ((entry (cdr entry))
6380                    (start (match-beginning (nth 1 entry)))
6381                    (end (match-end (nth 1 entry)))
6382                    (form (nth 2 entry)))
6383               (goto-char (match-end 0))
6384               (when (eval form)
6385                 (gnus-article-add-button
6386                  start end (nth 3 entry)
6387                  (buffer-substring (match-beginning (nth 4 entry))
6388                                    (match-end (nth 4 entry)))))))
6389           (goto-char end))))))
6390
6391 ;;; External functions:
6392
6393 (defun gnus-article-add-button (from to fun &optional data)
6394   "Create a button between FROM and TO with callback FUN and data DATA."
6395   (when gnus-article-button-face
6396     (gnus-overlay-put (gnus-make-overlay from to)
6397                       'face gnus-article-button-face))
6398   (gnus-add-text-properties
6399    from to
6400    (nconc (and gnus-article-mouse-face
6401                (list gnus-mouse-face-prop gnus-article-mouse-face))
6402           (list 'gnus-callback fun)
6403           (and data (list 'gnus-data data))))
6404   (widget-convert-button 'link from to :action 'gnus-widget-press-button
6405                          :button-keymap gnus-widget-button-keymap))
6406
6407 ;;; Internal functions:
6408
6409 (defun gnus-article-set-globals ()
6410   (with-current-buffer gnus-summary-buffer
6411     (gnus-set-global-variables)))
6412
6413 (defun gnus-signature-toggle (end)
6414   (gnus-with-article-buffer
6415     (let ((inhibit-point-motion-hooks t))
6416       (if (text-property-any end (point-max) 'article-type 'signature)
6417           (progn
6418             (gnus-delete-wash-type 'signature)
6419             (gnus-remove-text-properties-when
6420              'article-type 'signature end (point-max)
6421              (cons 'article-type (cons 'signature
6422                                        gnus-hidden-properties))))
6423         (gnus-add-wash-type 'signature)
6424         (gnus-add-text-properties-when
6425          'article-type nil end (point-max)
6426          (cons 'article-type (cons 'signature
6427                                    gnus-hidden-properties)))))
6428     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
6429       (gnus-set-mode-line 'article))))
6430
6431 (defun gnus-button-entry ()
6432   ;; Return the first entry in `gnus-button-alist' matching this place.
6433   (let ((alist gnus-button-alist)
6434         (entry nil))
6435     (while alist
6436       (setq entry (pop alist))
6437       (if (looking-at (eval (car entry)))
6438           (setq alist nil)
6439         (setq entry nil)))
6440     entry))
6441
6442 (defun gnus-button-push (marker)
6443   ;; Push button starting at MARKER.
6444   (save-excursion
6445     (goto-char marker)
6446     (let* ((entry (gnus-button-entry))
6447            (inhibit-point-motion-hooks t)
6448            (fun (nth 3 entry))
6449            (args (mapcar (lambda (group)
6450                            (let ((string (match-string group)))
6451                              (set-text-properties
6452                               0 (length string) nil string)
6453                              string))
6454                          (nthcdr 4 entry))))
6455       (cond
6456        ((fboundp fun)
6457         (apply fun args))
6458        ((and (boundp fun)
6459              (fboundp (symbol-value fun)))
6460         (apply (symbol-value fun) args))
6461        (t
6462         (gnus-message 1 "You must define `%S' to use this button"
6463                       (cons fun args)))))))
6464
6465 (defun gnus-parse-news-url (url)
6466   (let (scheme server group message-id articles)
6467     (with-temp-buffer
6468       (insert url)
6469       (goto-char (point-min))
6470       (when (looking-at "\\([A-Za-z]+\\):")
6471         (setq scheme (match-string 1))
6472         (goto-char (match-end 0)))
6473       (when (looking-at "//\\([^/]+\\)/")
6474         (setq server (match-string 1))
6475         (goto-char (match-end 0)))
6476
6477       (cond
6478        ((looking-at "\\(.*@.*\\)")
6479         (setq message-id (match-string 1)))
6480        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
6481         (setq group (match-string 1)
6482               articles (split-string (match-string 2) "-")))
6483        ((looking-at "\\([^/]+\\)/?")
6484         (setq group (match-string 1)))
6485        (t
6486         (error "Unknown news URL syntax"))))
6487     (list scheme server group message-id articles)))
6488
6489 (defun gnus-button-handle-news (url)
6490   "Fetch a news URL."
6491   (destructuring-bind (scheme server group message-id articles)
6492       (gnus-parse-news-url url)
6493     (cond
6494      (message-id
6495       (save-excursion
6496         (set-buffer gnus-summary-buffer)
6497         (if server
6498             (let ((gnus-refer-article-method (list (list 'nntp server))))
6499               (gnus-summary-refer-article message-id))
6500           (gnus-summary-refer-article message-id))))
6501      (group
6502       (gnus-button-fetch-group url)))))
6503
6504 (defun gnus-button-handle-man (url)
6505   "Fetch a man page."
6506   (funcall gnus-button-man-handler url))
6507
6508 (defun gnus-button-handle-info-url (url)
6509   "Fetch an info URL."
6510   (setq url (mm-subst-char-in-string ?+ ?\  url))
6511   (cond
6512    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
6513     (gnus-info-find-node
6514      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
6515                      "Gnus")
6516              ")" (gnus-url-unhex-string (match-string 2 url)))))
6517    ((string-match "([^)\"]+)[^\"]+" url)
6518     (setq url
6519           (gnus-replace-in-string
6520            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
6521     (gnus-info-find-node url))
6522    (t (error "Can't parse %s" url))))
6523
6524 (defun gnus-button-handle-info-url-gnome (url)
6525   "Fetch GNOME style info URL."
6526   (setq url (mm-subst-char-in-string ?_ ?\  url))
6527   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
6528       (gnus-info-find-node
6529        (concat "("
6530                (gnus-url-unhex-string 
6531                  (match-string 1 url))
6532                ")"
6533                (or (gnus-url-unhex-string 
6534                     (match-string 2 url))
6535                    "Top")))
6536     (error "Can't parse %s" url)))
6537
6538 (defun gnus-button-handle-info-url-kde (url)
6539   "Fetch KDE style info URL."
6540   (gnus-info-find-node (gnus-url-unhex-string url)))
6541
6542 (defun gnus-button-handle-info-keystrokes (url)
6543   "Call `info' when pushing the corresponding URL button."
6544   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
6545   (info)
6546   (Info-directory)
6547   (Info-menu url))
6548
6549 (defun gnus-button-message-id (message-id)
6550   "Fetch MESSAGE-ID."
6551   (with-current-buffer gnus-summary-buffer
6552     (gnus-summary-refer-article message-id)))
6553
6554 (defun gnus-button-fetch-group (address)
6555   "Fetch GROUP specified by ADDRESS."
6556   (if (not (string-match "[:/]" address))
6557       ;; This is just a simple group url.
6558       (gnus-group-read-ephemeral-group address gnus-select-method)
6559     (if (not
6560          (string-match
6561           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
6562           address))
6563         (error "Can't parse %s" address)
6564       (gnus-group-read-ephemeral-group
6565        (match-string 4 address)
6566        `(nntp ,(match-string 1 address)
6567               (nntp-address ,(match-string 1 address))
6568               (nntp-port-number ,(if (match-end 3)
6569                                      (match-string 3 address)
6570                                    "nntp")))
6571        nil nil nil
6572        (and (match-end 6) (list (string-to-int (match-string 6 address))))))))
6573
6574 (defun gnus-url-parse-query-string (query &optional downcase)
6575   (let (retval pairs cur key val)
6576     (setq pairs (split-string query "&"))
6577     (while pairs
6578       (setq cur (car pairs)
6579             pairs (cdr pairs))
6580       (if (not (string-match "=" cur))
6581           nil                           ; Grace
6582         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
6583               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
6584         (if downcase
6585             (setq key (downcase key)))
6586         (setq cur (assoc key retval))
6587         (if cur
6588             (setcdr cur (cons val (cdr cur)))
6589           (setq retval (cons (list key val) retval)))))
6590     retval))
6591
6592 (defun gnus-url-mailto (url)
6593   ;; Send mail to someone
6594   (when (string-match "mailto:/*\\(.*\\)" url)
6595     (setq url (substring url (match-beginning 1) nil)))
6596   (let (to args subject func)
6597     (setq args (gnus-url-parse-query-string
6598                 (if (string-match "^\\?" url)
6599                     (substring url 1)
6600                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
6601                       (concat "to=" (match-string 1 url) "&"
6602                               (match-string 2 url))
6603                     (concat "to=" url)))
6604                 t)
6605           subject (cdr-safe (assoc "subject" args)))
6606     (gnus-msg-mail)
6607     (while args
6608       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
6609       (if (fboundp func)
6610           (funcall func)
6611         (message-position-on-field (caar args)))
6612       (insert (gnus-replace-in-string
6613                (mapconcat 'identity (reverse (cdar args)) ", ")
6614                "\r\n" "\n" t))
6615       (setq args (cdr args)))
6616     (if subject
6617         (message-goto-body)
6618       (message-goto-subject))))
6619
6620 (defun gnus-button-embedded-url (address)
6621   "Activate ADDRESS with `browse-url'."
6622   (browse-url (gnus-strip-whitespace address)))
6623
6624 ;;; Next/prev buttons in the article buffer.
6625
6626 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
6627 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
6628
6629 (defvar gnus-prev-page-map
6630   (let ((map (make-sparse-keymap)))
6631     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6632     (define-key map "\r" 'gnus-button-prev-page)
6633     map))
6634
6635 (defvar gnus-next-page-map
6636   (let ((map (make-sparse-keymap)))
6637     (define-key map gnus-mouse-2 'gnus-button-next-page)
6638     (define-key map "\r" 'gnus-button-next-page)
6639     map))
6640
6641 (defun gnus-insert-prev-page-button ()
6642   (let ((b (point))
6643         (buffer-read-only nil))
6644     (gnus-eval-format
6645      gnus-prev-page-line-format nil
6646      `(keymap ,gnus-prev-page-map
6647          gnus-prev t
6648          gnus-callback gnus-article-button-prev-page
6649          article-type annotation))
6650     (widget-convert-button
6651      'link b (if (bolp)
6652                  ;; Exclude a newline.
6653                  (1- (point))
6654                (point))
6655      :action 'gnus-button-prev-page
6656      :button-keymap gnus-prev-page-map)))
6657
6658 (defun gnus-button-next-page (&optional args more-args)
6659   "Go to the next page."
6660   (interactive)
6661   (let ((win (selected-window)))
6662     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6663     (gnus-article-next-page)
6664     (select-window win)))
6665
6666 (defun gnus-button-prev-page (&optional args more-args)
6667   "Go to the prev page."
6668   (interactive)
6669   (let ((win (selected-window)))
6670     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6671     (gnus-article-prev-page)
6672     (select-window win)))
6673
6674 (defun gnus-insert-next-page-button ()
6675   (let ((b (point))
6676         (buffer-read-only nil))
6677     (gnus-eval-format gnus-next-page-line-format nil
6678                       `(keymap ,gnus-next-page-map
6679                           gnus-next t
6680                           gnus-callback gnus-article-button-next-page
6681                           article-type annotation))
6682     (widget-convert-button
6683      'link b (if (bolp)
6684                  ;; Exclude a newline.
6685                  (1- (point))
6686                (point))
6687      :action 'gnus-button-next-page
6688      :button-keymap gnus-next-page-map)))
6689
6690 (defun gnus-article-button-next-page (arg)
6691   "Go to the next page."
6692   (interactive "P")
6693   (let ((win (selected-window)))
6694     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6695     (gnus-article-next-page)
6696     (select-window win)))
6697
6698 (defun gnus-article-button-prev-page (arg)
6699   "Go to the prev page."
6700   (interactive "P")
6701   (let ((win (selected-window)))
6702     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6703     (gnus-article-prev-page)
6704     (select-window win)))
6705
6706 (defvar gnus-decode-header-methods
6707   '(mail-decode-encoded-word-region)
6708   "List of methods used to decode headers.
6709
6710 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
6711 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
6712 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
6713 whose names match REGEXP.
6714
6715 For example:
6716 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
6717  mail-decode-encoded-word-region
6718  (\"chinese\" . rfc1843-decode-region))
6719 ")
6720
6721 (defvar gnus-decode-header-methods-cache nil)
6722
6723 (defun gnus-multi-decode-header (start end)
6724   "Apply the functions from `gnus-encoded-word-methods' that match."
6725   (unless (and gnus-decode-header-methods-cache
6726                (eq gnus-newsgroup-name
6727                    (car gnus-decode-header-methods-cache)))
6728     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
6729     (mapcar (lambda (x)
6730               (if (symbolp x)
6731                   (nconc gnus-decode-header-methods-cache (list x))
6732                 (if (and gnus-newsgroup-name
6733                          (string-match (car x) gnus-newsgroup-name))
6734                     (nconc gnus-decode-header-methods-cache
6735                            (list (cdr x))))))
6736           gnus-decode-header-methods))
6737   (let ((xlist gnus-decode-header-methods-cache))
6738     (pop xlist)
6739     (save-restriction
6740       (narrow-to-region start end)
6741       (while xlist
6742         (funcall (pop xlist) (point-min) (point-max))))))
6743
6744 ;;;
6745 ;;; Treatment top-level handling.
6746 ;;;
6747
6748 (defun gnus-treat-article (condition &optional part-number total-parts type)
6749   (let ((length (- (point-max) (point-min)))
6750         (alist gnus-treatment-function-alist)
6751         (article-goto-body-goes-to-point-min-p t)
6752         (treated-type
6753          (or (not type)
6754              (catch 'found
6755                (let ((list gnus-article-treat-types))
6756                  (while list
6757                    (when (string-match (pop list) type)
6758                      (throw 'found t)))))))
6759         (highlightp (gnus-visual-p 'article-highlight 'highlight))
6760         val elem)
6761     (gnus-run-hooks 'gnus-part-display-hook)
6762     (dolist (elem alist)
6763       (setq val
6764             (save-excursion
6765               (when (gnus-buffer-live-p gnus-summary-buffer)
6766                 (set-buffer gnus-summary-buffer))
6767               (symbol-value (car elem))))
6768       (when (and (or (consp val)
6769                      treated-type)
6770                  (gnus-treat-predicate val)
6771                  (or (not (get (car elem) 'highlight))
6772                      highlightp))
6773         (save-restriction
6774           (funcall (cadr elem)))))))
6775
6776 ;; Dynamic variables.
6777 (eval-when-compile
6778   (defvar part-number)
6779   (defvar total-parts)
6780   (defvar type)
6781   (defvar condition)
6782   (defvar length))
6783
6784 (defun gnus-treat-predicate (val)
6785   (cond
6786    ((null val)
6787     nil)
6788    (condition
6789     (eq condition val))
6790    ((and (listp val)
6791          (stringp (car val)))
6792     (apply 'gnus-or (mapcar `(lambda (s)
6793                                (string-match s ,(or gnus-newsgroup-name "")))
6794                             val)))
6795    ((listp val)
6796     (let ((pred (pop val)))
6797       (cond
6798        ((eq pred 'or)
6799         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
6800        ((eq pred 'and)
6801         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
6802        ((eq pred 'not)
6803         (not (gnus-treat-predicate (car val))))
6804        ((eq pred 'typep)
6805         (equal (car val) type))
6806        (t
6807         (error "%S is not a valid predicate" pred)))))
6808    ((eq val t)
6809     t)
6810    ((eq val 'head)
6811     nil)
6812    ((eq val 'last)
6813     (eq part-number total-parts))
6814    ((numberp val)
6815     (< length val))
6816    (t
6817     (error "%S is not a valid value" val))))
6818
6819 (defun gnus-article-encrypt-body (protocol &optional n)
6820   "Encrypt the article body."
6821   (interactive
6822    (list
6823     (or gnus-article-encrypt-protocol
6824         (completing-read "Encrypt protocol: "
6825                          gnus-article-encrypt-protocol-alist
6826                          nil t))
6827     current-prefix-arg))
6828   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
6829     (unless func
6830       (error (format "Can't find the encrypt protocol %s" protocol)))
6831     (if (member gnus-newsgroup-name '("nndraft:delayed"
6832                                       "nndraft:drafts"
6833                                       "nndraft:queue"))
6834         (error "Can't encrypt the article in group %s"
6835                gnus-newsgroup-name))
6836     (gnus-summary-iterate n
6837       (save-excursion
6838         (set-buffer gnus-summary-buffer)
6839         (let ((mail-parse-charset gnus-newsgroup-charset)
6840               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6841               (summary-buffer gnus-summary-buffer)
6842               references point)
6843           (gnus-set-global-variables)
6844           (when (gnus-group-read-only-p)
6845             (error "The current newsgroup does not support article encrypt"))
6846           (gnus-summary-show-article t)
6847           (setq references
6848               (or (mail-header-references gnus-current-headers) ""))
6849           (set-buffer gnus-article-buffer)
6850           (let* ((buffer-read-only nil)
6851                  (headers
6852                   (mapcar (lambda (field)
6853                             (and (save-restriction
6854                                    (message-narrow-to-head)
6855                                    (goto-char (point-min))
6856                                    (search-forward field nil t))
6857                                  (prog2
6858                                      (message-narrow-to-field)
6859                                      (buffer-string)
6860                                    (delete-region (point-min) (point-max))
6861                                    (widen))))
6862                           '("Content-Type:" "Content-Transfer-Encoding:"
6863                             "Content-Disposition:"))))
6864             (message-narrow-to-head)
6865             (message-remove-header "MIME-Version")
6866             (goto-char (point-max))
6867             (setq point (point))
6868             (insert (apply 'concat headers))
6869             (widen)
6870             (narrow-to-region point (point-max))
6871             (let ((message-options message-options))
6872               (message-options-set 'message-sender user-mail-address)
6873               (message-options-set 'message-recipients user-mail-address)
6874               (message-options-set 'message-sign-encrypt 'not)
6875               (funcall func))
6876             (goto-char (point-min))
6877             (insert "MIME-Version: 1.0\n")
6878             (widen)
6879             (gnus-summary-edit-article-done
6880              references nil summary-buffer t))
6881           (when gnus-keep-backlog
6882             (gnus-backlog-remove-article
6883              (car gnus-article-current) (cdr gnus-article-current)))
6884           (save-excursion
6885             (when (get-buffer gnus-original-article-buffer)
6886               (set-buffer gnus-original-article-buffer)
6887               (setq gnus-original-article nil)))
6888           (when gnus-use-cache
6889             (gnus-cache-update-article
6890              (car gnus-article-current) (cdr gnus-article-current))))))))
6891
6892 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
6893   "The following specs can be used:
6894 %t  The security MIME type
6895 %i  Additional info
6896 %d  Details
6897 %D  Details if button is pressed")
6898
6899 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
6900   "The following specs can be used:
6901 %t  The security MIME type
6902 %i  Additional info
6903 %d  Details
6904 %D  Details if button is pressed")
6905
6906 (defvar gnus-mime-security-button-line-format-alist
6907   '((?t gnus-tmp-type ?s)
6908     (?i gnus-tmp-info ?s)
6909     (?d gnus-tmp-details ?s)
6910     (?D gnus-tmp-pressed-details ?s)))
6911
6912 (defvar gnus-mime-security-button-map
6913   (let ((map (make-sparse-keymap)))
6914     (define-key map gnus-mouse-2 'gnus-article-push-button)
6915     (define-key map "\r" 'gnus-article-press-button)
6916     map))
6917
6918 (defvar gnus-mime-security-details-buffer nil)
6919
6920 (defvar gnus-mime-security-button-pressed nil)
6921
6922 (defvar gnus-mime-security-show-details-inline t
6923   "If non-nil, show details in the article buffer.")
6924
6925 (defun gnus-mime-security-verify-or-decrypt (handle)
6926   (mm-remove-parts (cdr handle))
6927   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
6928         point buffer-read-only)
6929     (if region
6930         (goto-char (car region)))
6931     (save-restriction
6932       (narrow-to-region (point) (point))
6933       (with-current-buffer (mm-handle-multipart-original-buffer handle)
6934         (let* ((mm-verify-option 'known)
6935                (mm-decrypt-option 'known)
6936                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
6937           (unless (eq nparts (cdr handle))
6938             (mm-destroy-parts (cdr handle))
6939             (setcdr handle nparts))))
6940       (setq point (point))
6941       (gnus-mime-display-security handle)
6942       (goto-char (point-max)))
6943     (when region
6944       (delete-region (point) (cdr region))
6945       (set-marker (car region) nil)
6946       (set-marker (cdr region) nil))
6947     (goto-char point)))
6948
6949 (defun gnus-mime-security-show-details (handle)
6950   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
6951     (if (not details)
6952         (gnus-message 5 "No details.")
6953       (if gnus-mime-security-show-details-inline
6954           (let ((gnus-mime-security-button-pressed
6955                  (not (get-text-property (point) 'gnus-mime-details)))
6956                 (gnus-mime-security-button-line-format
6957                  (get-text-property (point) 'gnus-line-format))
6958                 buffer-read-only)
6959             (forward-char -1)
6960             (while (eq (get-text-property (point) 'gnus-line-format)
6961                        gnus-mime-security-button-line-format)
6962               (forward-char -1))
6963             (forward-char)
6964             (save-restriction
6965               (narrow-to-region (point) (point))
6966               (gnus-insert-mime-security-button handle))
6967             (delete-region (point)
6968                            (or (text-property-not-all
6969                                 (point) (point-max)
6970                                 'gnus-line-format
6971                                 gnus-mime-security-button-line-format)
6972                                (point-max))))
6973         ;; Not inlined.
6974         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
6975             (with-current-buffer gnus-mime-security-details-buffer
6976               (erase-buffer)
6977               t)
6978           (setq gnus-mime-security-details-buffer
6979                 (gnus-get-buffer-create "*MIME Security Details*")))
6980         (with-current-buffer gnus-mime-security-details-buffer
6981           (insert details)
6982           (goto-char (point-min)))
6983         (pop-to-buffer gnus-mime-security-details-buffer)))))
6984
6985 (defun gnus-mime-security-press-button (handle)
6986   (save-excursion
6987     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6988         (gnus-mime-security-show-details handle)
6989       (gnus-mime-security-verify-or-decrypt handle))))
6990
6991 (defun gnus-insert-mime-security-button (handle &optional displayed)
6992   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
6993          (gnus-tmp-type
6994           (concat
6995            (or (nth 2 (assoc protocol mm-verify-function-alist))
6996                (nth 2 (assoc protocol mm-decrypt-function-alist))
6997                "Unknown")
6998            (if (equal (car handle) "multipart/signed")
6999                " Signed" " Encrypted")
7000            " Part"))
7001          (gnus-tmp-info
7002           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
7003               "Undecided"))
7004          (gnus-tmp-details
7005           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
7006          gnus-tmp-pressed-details
7007          b e)
7008     (setq gnus-tmp-details
7009           (if gnus-tmp-details
7010               (concat "\n" gnus-tmp-details)
7011             ""))
7012     (setq gnus-tmp-pressed-details
7013           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
7014     (unless (bolp)
7015       (insert "\n"))
7016     (setq b (point))
7017     (gnus-eval-format
7018      gnus-mime-security-button-line-format
7019      gnus-mime-security-button-line-format-alist
7020      `(keymap ,gnus-mime-security-button-map
7021          gnus-callback gnus-mime-security-press-button
7022          gnus-line-format ,gnus-mime-security-button-line-format
7023          gnus-mime-details ,gnus-mime-security-button-pressed
7024          article-type annotation
7025          gnus-data ,handle))
7026     (setq e (if (bolp)
7027                 ;; Exclude a newline.
7028                 (1- (point))
7029               (point)))
7030     (widget-convert-button
7031      'link b e
7032      :mime-handle handle
7033      :action 'gnus-widget-press-button
7034      :button-keymap gnus-mime-security-button-map
7035      :help-echo
7036      (lambda (widget/window &optional overlay pos)
7037        ;; Needed to properly clear the message due to a bug in
7038        ;; wid-edit (XEmacs only).
7039        (when (boundp 'help-echo-owns-message)
7040          (setq help-echo-owns-message t))
7041        (format
7042         "%S: show detail"
7043         (aref gnus-mouse-2 0))))))
7044
7045 (defun gnus-mime-display-security (handle)
7046   (save-restriction
7047     (narrow-to-region (point) (point))
7048     (unless (gnus-unbuttonized-mime-type-p (car handle))
7049       (gnus-insert-mime-security-button handle))
7050     (gnus-mime-display-mixed (cdr handle))
7051     (unless (bolp)
7052       (insert "\n"))
7053     (unless (gnus-unbuttonized-mime-type-p (car handle))
7054       (let ((gnus-mime-security-button-line-format
7055              gnus-mime-security-button-end-line-format))
7056         (gnus-insert-mime-security-button handle)))
7057     (mm-set-handle-multipart-parameter
7058      handle 'gnus-region
7059      (cons (set-marker (make-marker) (point-min))
7060            (set-marker (make-marker) (point-max))))))
7061
7062 (gnus-ems-redefine)
7063
7064 (provide 'gnus-art)
7065
7066 (run-hooks 'gnus-art-load-hook)
7067
7068 ;;; gnus-art.el ends here