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