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