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