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