Add `fill-column' local variable.
[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     (with-current-buffer gnus-summary-buffer
4000       ;; This might be a variable local to the summary buffer.
4001       (unless gnus-single-article-buffer
4002         (setq gnus-article-buffer name)
4003         (setq gnus-original-article-buffer original)
4004         (gnus-set-global-variables)))
4005     (gnus-article-setup-highlight-words)
4006     ;; Init original article buffer.
4007     (save-excursion
4008       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4009       (mm-enable-multibyte)
4010       (setq major-mode 'gnus-original-article-mode)
4011       (make-local-variable 'gnus-original-article))
4012     (if (and (get-buffer name)
4013              (with-current-buffer name
4014                (if gnus-article-edit-mode
4015                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4016                        (progn
4017                          (set-buffer-modified-p nil)
4018                          (gnus-kill-buffer name)
4019                          (message "")
4020                          nil)
4021                      (error "Action aborted"))
4022                  t)))
4023         (save-excursion
4024           (set-buffer name)
4025           (set (make-local-variable 'gnus-article-edit-mode) nil)
4026           (when gnus-article-mime-handles
4027             (mm-destroy-parts gnus-article-mime-handles)
4028             (setq gnus-article-mime-handles nil))
4029           ;; Set it to nil in article-buffer!
4030           (setq gnus-article-mime-handle-alist nil)
4031           (buffer-disable-undo)
4032           (setq buffer-read-only t)
4033           ;; This list just keeps growing if we don't reset it.
4034           (setq gnus-button-marker-list nil)
4035           (unless (eq major-mode 'gnus-article-mode)
4036             (gnus-article-mode))
4037           (current-buffer))
4038       (save-excursion
4039         (set-buffer (gnus-get-buffer-create name))
4040         (gnus-article-mode)
4041         (make-local-variable 'gnus-summary-buffer)
4042         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4043         (current-buffer)))))
4044
4045 ;; Set article window start at LINE, where LINE is the number of lines
4046 ;; from the head of the article.
4047 (defun gnus-article-set-window-start (&optional line)
4048   (set-window-start
4049    (gnus-get-buffer-window gnus-article-buffer t)
4050    (save-excursion
4051      (set-buffer gnus-article-buffer)
4052      (goto-char (point-min))
4053      (if (not line)
4054          (point-min)
4055        (gnus-message 6 "Moved to bookmark")
4056        (search-forward "\n\n" nil t)
4057        (forward-line line)
4058        (point)))))
4059
4060 (defun gnus-article-prepare (article &optional all-headers header)
4061   "Prepare ARTICLE in article mode buffer.
4062 ARTICLE should either be an article number or a Message-ID.
4063 If ARTICLE is an id, HEADER should be the article headers.
4064 If ALL-HEADERS is non-nil, no headers are hidden."
4065   (save-excursion
4066     ;; Make sure we start in a summary buffer.
4067     (unless (eq major-mode 'gnus-summary-mode)
4068       (set-buffer gnus-summary-buffer))
4069     (setq gnus-summary-buffer (current-buffer))
4070     (let* ((gnus-article (if header (mail-header-number header) article))
4071            (summary-buffer (current-buffer))
4072            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4073            (group gnus-newsgroup-name)
4074            result)
4075       (save-excursion
4076         (gnus-article-setup-buffer)
4077         (set-buffer gnus-article-buffer)
4078         ;; Deactivate active regions.
4079         (when (and (boundp 'transient-mark-mode)
4080                    transient-mark-mode)
4081           (setq mark-active nil))
4082         (if (not (setq result (let ((inhibit-read-only t))
4083                                 (gnus-request-article-this-buffer
4084                                  article group))))
4085             ;; There is no such article.
4086             (save-excursion
4087               (when (and (numberp article)
4088                          (not (memq article gnus-newsgroup-sparse)))
4089                 (setq gnus-article-current
4090                       (cons gnus-newsgroup-name article))
4091                 (set-buffer gnus-summary-buffer)
4092                 (setq gnus-current-article article)
4093                 (if (and (memq article gnus-newsgroup-undownloaded)
4094                          (not (gnus-online (gnus-find-method-for-group
4095                                             gnus-newsgroup-name))))
4096                     (progn
4097                       (gnus-summary-set-agent-mark article)
4098                       (message "Message marked for downloading"))
4099                   (gnus-summary-mark-article article gnus-canceled-mark)
4100                   (unless (memq article gnus-newsgroup-sparse)
4101                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4102           (if (or (eq result 'pseudo)
4103                   (eq result 'nneething))
4104               (progn
4105                 (save-excursion
4106                   (set-buffer summary-buffer)
4107                   (push article gnus-newsgroup-history)
4108                   (setq gnus-last-article gnus-current-article
4109                         gnus-current-article 0
4110                         gnus-current-headers nil
4111                         gnus-article-current nil)
4112                   (if (eq result 'nneething)
4113                       (gnus-configure-windows 'summary)
4114                     (gnus-configure-windows 'article))
4115                   (gnus-set-global-variables))
4116                 (let ((gnus-article-mime-handle-alist-1
4117                        gnus-article-mime-handle-alist))
4118                   (gnus-set-mode-line 'article)))
4119             ;; The result from the `request' was an actual article -
4120             ;; or at least some text that is now displayed in the
4121             ;; article buffer.
4122             (when (and (numberp article)
4123                        (not (eq article gnus-current-article)))
4124               ;; Seems like a new article has been selected.
4125               ;; `gnus-current-article' must be an article number.
4126               (save-excursion
4127                 (set-buffer summary-buffer)
4128                 (push article gnus-newsgroup-history)
4129                 (setq gnus-last-article gnus-current-article
4130                       gnus-current-article article
4131                       gnus-current-headers
4132                       (gnus-summary-article-header gnus-current-article)
4133                       gnus-article-current
4134                       (cons gnus-newsgroup-name gnus-current-article))
4135                 (unless (vectorp gnus-current-headers)
4136                   (setq gnus-current-headers nil))
4137                 (gnus-summary-goto-subject gnus-current-article)
4138                 (when (gnus-summary-show-thread)
4139                   ;; If the summary buffer really was folded, the
4140                   ;; previous goto may not actually have gone to
4141                   ;; the right article, but the thread root instead.
4142                   ;; So we go again.
4143                   (gnus-summary-goto-subject gnus-current-article))
4144                 (gnus-run-hooks 'gnus-mark-article-hook)
4145                 (gnus-set-mode-line 'summary)
4146                 (when (gnus-visual-p 'article-highlight 'highlight)
4147                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4148                 ;; Set the global newsgroup variables here.
4149                 (gnus-set-global-variables)
4150                 (setq gnus-have-all-headers
4151                       (or all-headers gnus-show-all-headers))))
4152             (save-excursion
4153               (gnus-configure-windows 'article))
4154             (when (or (numberp article)
4155                       (stringp article))
4156               (gnus-article-prepare-display)
4157               ;; Do page break.
4158               (goto-char (point-min))
4159               (when gnus-break-pages
4160                 (gnus-narrow-to-page)))
4161             (let ((gnus-article-mime-handle-alist-1
4162                    gnus-article-mime-handle-alist))
4163               (gnus-set-mode-line 'article))
4164             (article-goto-body)
4165             (unless (bobp)
4166               (forward-line -1))
4167             (set-window-point (get-buffer-window (current-buffer)) (point))
4168             (gnus-configure-windows 'article)
4169             t))))))
4170
4171 ;;;###autoload
4172 (defun gnus-article-prepare-display ()
4173   "Make the current buffer look like a nice article."
4174   ;; Hooks for getting information from the article.
4175   ;; This hook must be called before being narrowed.
4176   (let ((gnus-article-buffer (current-buffer))
4177         buffer-read-only
4178         (inhibit-read-only t))
4179     (unless (eq major-mode 'gnus-article-mode)
4180       (gnus-article-mode))
4181     (setq buffer-read-only nil
4182           gnus-article-wash-types nil
4183           gnus-article-image-alist nil)
4184     (gnus-run-hooks 'gnus-tmp-internal-hook)
4185     (when gnus-display-mime-function
4186       (funcall gnus-display-mime-function))
4187     (gnus-run-hooks 'gnus-article-prepare-hook)))
4188
4189 ;;;
4190 ;;; Gnus MIME viewing functions
4191 ;;;
4192
4193 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4194   "Format of the MIME buttons.
4195
4196 Valid specifiers include:
4197 %t  The MIME type
4198 %T  MIME type, along with additional info
4199 %n  The `name' parameter
4200 %d  The description, if any
4201 %l  The length of the encoded part
4202 %p  The part identifier number
4203 %e  Dots if the part isn't displayed
4204
4205 General format specifiers can also be used.  See Info node
4206 `(gnus)Formatting Variables'.")
4207
4208 (defvar gnus-mime-button-line-format-alist
4209   '((?t gnus-tmp-type ?s)
4210     (?T gnus-tmp-type-long ?s)
4211     (?n gnus-tmp-name ?s)
4212     (?d gnus-tmp-description ?s)
4213     (?p gnus-tmp-id ?s)
4214     (?l gnus-tmp-length ?d)
4215     (?e gnus-tmp-dots ?s)))
4216
4217 (defvar gnus-mime-button-commands
4218   '((gnus-article-press-button "\r" "Toggle Display")
4219     (gnus-mime-view-part "v" "View Interactively...")
4220     (gnus-mime-view-part-as-type "t" "View As Type...")
4221     (gnus-mime-view-part-as-charset "C" "View As charset...")
4222     (gnus-mime-save-part "o" "Save...")
4223     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4224     (gnus-mime-replace-part "r" "Replace part")
4225     (gnus-mime-delete-part "d" "Delete part")
4226     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4227     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4228     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4229     (gnus-mime-view-part-externally "e" "View Externally")
4230     (gnus-mime-print-part "p" "Print")
4231     (gnus-mime-pipe-part "|" "Pipe To Command...")
4232     (gnus-mime-action-on-part "." "Take action on the part...")))
4233
4234 (defun gnus-article-mime-part-status ()
4235   (if gnus-article-mime-handle-alist-1
4236       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4237           " (1 part)"
4238         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4239     ""))
4240
4241 (defvar gnus-mime-button-map
4242   (let ((map (make-sparse-keymap)))
4243     (define-key map gnus-mouse-2 'gnus-article-push-button)
4244     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4245     (dolist (c gnus-mime-button-commands)
4246       (define-key map (cadr c) (car c)))
4247     map))
4248
4249 (easy-menu-define
4250   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4251   `("MIME Part"
4252     ,@(mapcar (lambda (c)
4253                 (vector (caddr c) (car c) :active t))
4254               gnus-mime-button-commands)))
4255
4256 (defun gnus-mime-button-menu (event prefix)
4257  "Construct a context-sensitive menu of MIME commands."
4258  (interactive "e\nP")
4259  (save-window-excursion
4260    (let ((pos (event-start event)))
4261      (select-window (posn-window pos))
4262      (goto-char (posn-point pos))
4263      (gnus-article-check-buffer)
4264      (popup-menu gnus-mime-button-menu nil prefix))))
4265
4266 (defun gnus-mime-view-all-parts (&optional handles)
4267   "View all the MIME parts."
4268   (interactive)
4269   (with-current-buffer gnus-article-buffer
4270     (let ((handles (or handles gnus-article-mime-handles))
4271           (mail-parse-charset gnus-newsgroup-charset)
4272           (mail-parse-ignored-charsets
4273            (with-current-buffer gnus-summary-buffer
4274              gnus-newsgroup-ignored-charsets)))
4275       (when handles
4276         (mm-remove-parts handles)
4277         (goto-char (point-min))
4278         (or (search-forward "\n\n") (goto-char (point-max)))
4279         (let ((inhibit-read-only t))
4280           (delete-region (point) (point-max))
4281           (mm-display-parts handles))))))
4282
4283 (defun gnus-article-jump-to-part (n)
4284   "Jump to MIME part N."
4285   (interactive "P")
4286   (pop-to-buffer gnus-article-buffer)
4287   ;; FIXME: why is it necessary?
4288   (sit-for 0)
4289   (let ((parts (length gnus-article-mime-handle-alist)))
4290     (or n (setq n
4291                 (string-to-number
4292                  (read-string ;; Emacs 21 doesn't have `read-number'.
4293                   (format "Jump to part (2..%s): " parts)))))
4294     (unless (and (integerp n) (<= n parts) (>= n 1))
4295       (setq n
4296             (progn
4297               (gnus-message 7 "Invalid part `%s', using %s instead."
4298                             n parts)
4299               parts)))
4300     (gnus-message 9 "Jumping to part %s." n)
4301     (cond ((>= gnus-auto-select-part 1)
4302            (while (and (<= n parts)
4303                        (not (gnus-article-goto-part n)))
4304              (setq n (1+ n))))
4305           ((< gnus-auto-select-part 0)
4306            (while (and (>= n 1)
4307                        (not (gnus-article-goto-part n)))
4308              (setq n (1- n))))
4309           (t
4310            (gnus-article-goto-part n)))))
4311
4312 (eval-when-compile
4313   (defsubst gnus-article-edit-part (handles &optional current-id)
4314     "Edit an article in order to delete a mime part.
4315 This function is exclusively used by `gnus-mime-save-part-and-strip'
4316 and `gnus-mime-delete-part', and not provided at run-time normally."
4317     (gnus-article-edit-article
4318      `(lambda ()
4319         (buffer-disable-undo)
4320         (erase-buffer)
4321         (let ((mail-parse-charset (or gnus-article-charset
4322                                       ',gnus-newsgroup-charset))
4323               (mail-parse-ignored-charsets
4324                (or gnus-article-ignored-charsets
4325                    ',gnus-newsgroup-ignored-charsets))
4326               (mbl mml-buffer-list))
4327           (setq mml-buffer-list nil)
4328           (insert-buffer-substring gnus-original-article-buffer)
4329           (mime-to-mml ',handles)
4330           (setq gnus-article-mime-handles nil)
4331           (let ((mbl1 mml-buffer-list))
4332             (setq mml-buffer-list mbl)
4333             (set (make-local-variable 'mml-buffer-list) mbl1))
4334           (gnus-make-local-hook 'kill-buffer-hook)
4335           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4336      `(lambda (no-highlight)
4337         (let ((mail-parse-charset (or gnus-article-charset
4338                                       ',gnus-newsgroup-charset))
4339               (message-options message-options)
4340               (message-options-set-recipient)
4341               (mail-parse-ignored-charsets
4342                (or gnus-article-ignored-charsets
4343                    ',gnus-newsgroup-ignored-charsets)))
4344           (mml-to-mime)
4345           (mml-destroy-buffers)
4346           (remove-hook 'kill-buffer-hook
4347                        'mml-destroy-buffers t)
4348           (kill-local-variable 'mml-buffer-list))
4349         (gnus-summary-edit-article-done
4350          ,(or (mail-header-references gnus-current-headers) "")
4351          ,(gnus-group-read-only-p)
4352          ,gnus-summary-buffer no-highlight))
4353      t)
4354     (gnus-article-edit-done)
4355     (gnus-summary-expand-window)
4356     (gnus-summary-show-article)
4357     (when (and current-id (integerp gnus-auto-select-part))
4358       (gnus-article-jump-to-part
4359        (+ current-id gnus-auto-select-part)))))
4360
4361 (defun gnus-mime-replace-part (file)
4362   "Replace MIME part under point with an external body."
4363   ;; Useful if file has already been saved to disk
4364   (interactive
4365    (list
4366     (mm-with-multibyte
4367       (read-file-name "Replace MIME part with file: "
4368                       (or mm-default-directory default-directory)
4369                       nil nil))))
4370   (gnus-mime-save-part-and-strip file))
4371
4372 (defun gnus-mime-save-part-and-strip (&optional file)
4373   "Save the MIME part under point then replace it with an external body.
4374 If FILE is given, use it for the external part."
4375   (interactive)
4376   (gnus-article-check-buffer)
4377   (when (gnus-group-read-only-p)
4378     (error "The current group does not support deleting of parts"))
4379   (when (mm-complicated-handles gnus-article-mime-handles)
4380     (error "\
4381 The current article has a complicated MIME structure, giving up..."))
4382   (let* ((data (get-text-property (point) 'gnus-data))
4383          (id (get-text-property (point) 'gnus-part))
4384          param
4385          (handles gnus-article-mime-handles))
4386     (unless file
4387       (setq file
4388             (and data (mm-save-part data "Delete MIME part and save to: "))))
4389     (when file
4390       (with-current-buffer (mm-handle-buffer data)
4391         (erase-buffer)
4392         (insert "Content-Type: " (mm-handle-media-type data))
4393         (mml-insert-parameter-string (cdr (mm-handle-type data))
4394                                      '(charset))
4395         ;; Add a filename for the sake of saving the part again.
4396         (mml-insert-parameter
4397          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4398         (insert "\n")
4399         (insert "Content-ID: " (message-make-message-id) "\n")
4400         (insert "Content-Transfer-Encoding: binary\n")
4401         (insert "\n"))
4402       (setcdr data
4403               (cdr (mm-make-handle nil
4404                                    `("message/external-body"
4405                                      (access-type . "LOCAL-FILE")
4406                                      (name . ,file)))))
4407       ;; (set-buffer gnus-summary-buffer)
4408       (gnus-article-edit-part handles id))))
4409
4410 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4411 ;; parts...>') but with stripping would be nice.
4412
4413 (defun gnus-mime-delete-part ()
4414   "Delete the MIME part under point.
4415 Replace it with some information about the removed part."
4416   (interactive)
4417   (gnus-article-check-buffer)
4418   (when (gnus-group-read-only-p)
4419     (error "The current group does not support deleting of parts"))
4420   (when (mm-complicated-handles gnus-article-mime-handles)
4421     (error "\
4422 The current article has a complicated MIME structure, giving up..."))
4423   (when (or gnus-expert-user
4424             (gnus-yes-or-no-p "\
4425 Deleting parts may malfunction or destroy the article; continue? "))
4426     (let* ((data (get-text-property (point) 'gnus-data))
4427            (id (get-text-property (point) 'gnus-part))
4428            (handles gnus-article-mime-handles)
4429            (none "(none)")
4430            (description
4431             (or
4432              (mail-decode-encoded-word-string (or (mm-handle-description data)
4433                                                   none))))
4434            (filename
4435             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4436                 none))
4437            (type (mm-handle-media-type data)))
4438       (unless data
4439         (error "No MIME part under point"))
4440       (with-current-buffer (mm-handle-buffer data)
4441         (let ((bsize (format "%s" (buffer-size))))
4442           (erase-buffer)
4443           (insert
4444            (concat
4445             ",----\n"
4446             "| The following attachment has been deleted:\n"
4447             "|\n"
4448             "| Type:           " type "\n"
4449             "| Filename:       " filename "\n"
4450             "| Size (encoded): " bsize " Byte\n"
4451             "| Description:    " description "\n"
4452             "`----\n"))
4453           (setcdr data
4454                   (cdr (mm-make-handle
4455                         nil `("text/plain") nil nil
4456                         (list "attachment")
4457                         (format "Deleted attachment (%s bytes)" bsize))))))
4458       ;; (set-buffer gnus-summary-buffer)
4459       (gnus-article-edit-part handles id))))
4460
4461 (defun gnus-mime-save-part ()
4462   "Save the MIME part under point."
4463   (interactive)
4464   (gnus-article-check-buffer)
4465   (let ((data (get-text-property (point) 'gnus-data)))
4466     (when data
4467       (mm-save-part data))))
4468
4469 (defun gnus-mime-pipe-part ()
4470   "Pipe the MIME part under point to a process."
4471   (interactive)
4472   (gnus-article-check-buffer)
4473   (let ((data (get-text-property (point) 'gnus-data)))
4474     (when data
4475       (mm-pipe-part data))))
4476
4477 (defun gnus-mime-view-part ()
4478   "Interactively choose a viewing method for the MIME part under point."
4479   (interactive)
4480   (gnus-article-check-buffer)
4481   (let ((data (get-text-property (point) 'gnus-data)))
4482     (when data
4483       (setq gnus-article-mime-handles
4484             (mm-merge-handles
4485              gnus-article-mime-handles (setq data (copy-sequence data))))
4486       (mm-interactively-view-part data))))
4487
4488 (defun gnus-mime-view-part-as-type-internal ()
4489   (gnus-article-check-buffer)
4490   (let* ((handle (get-text-property (point) 'gnus-data))
4491          (name (or
4492                 ;; Content-Type: foo/bar; name=...
4493                 (mail-content-type-get (mm-handle-type handle) 'name)
4494                 ;; Content-Disposition: attachment; filename=...
4495                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
4496          (def-type (and name (mm-default-file-encoding name))))
4497     (and def-type (cons def-type 0))))
4498
4499 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
4500   "Choose a MIME media type, and view the part as such.
4501 If non-nil, PRED is a predicate to use during completion to limit the
4502 available media-types."
4503   (interactive)
4504   (unless mime-type
4505     (setq mime-type
4506           (let ((default (gnus-mime-view-part-as-type-internal)))
4507             (completing-read
4508              (format "View as MIME type (default %s): "
4509                      (car default))
4510              (mapcar #'list (mailcap-mime-types))
4511              pred nil nil nil
4512              (car default)))))
4513   (gnus-article-check-buffer)
4514   (let ((handle (get-text-property (point) 'gnus-data)))
4515     (when handle
4516       (when (equal (mm-handle-media-type handle) "message/external-body")
4517         (unless (mm-handle-cache handle)
4518           (mm-extern-cache-contents handle))
4519         (setq handle (mm-handle-cache handle)))
4520       (setq handle
4521             (mm-make-handle (mm-handle-buffer handle)
4522                             (cons mime-type (cdr (mm-handle-type handle)))
4523                             (mm-handle-encoding handle)
4524                             (mm-handle-undisplayer handle)
4525                             (mm-handle-disposition handle)
4526                             (mm-handle-description handle)
4527                             nil
4528                             (mm-handle-id handle)))
4529       (setq gnus-article-mime-handles
4530             (mm-merge-handles gnus-article-mime-handles handle))
4531       (gnus-mm-display-part handle))))
4532
4533 (defun gnus-mime-copy-part (&optional handle arg)
4534   "Put the MIME part under point into a new buffer.
4535 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4536 are decompressed."
4537   (interactive (list nil current-prefix-arg))
4538   (gnus-article-check-buffer)
4539   (unless handle
4540     (setq handle (get-text-property (point) 'gnus-data)))
4541   (when handle
4542     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
4543                                                'name)
4544                         (mail-content-type-get (mm-handle-disposition handle)
4545                                                'filename)))
4546           contents dont-decode charset coding-system)
4547       (mm-with-unibyte-buffer
4548         (mm-insert-part handle)
4549         (setq contents (or (condition-case nil
4550                                (mm-decompress-buffer filename nil 'sig)
4551                              (error
4552                               (setq dont-decode t)
4553                               nil))
4554                            (buffer-string))))
4555       (setq filename (cond (filename (file-name-nondirectory filename))
4556                            (dont-decode "*raw data*")
4557                            (t "*decoded*")))
4558       (cond
4559        (dont-decode)
4560        ((not arg)
4561         (unless (setq charset (mail-content-type-get
4562                                (mm-handle-type handle) 'charset))
4563           (unless (setq coding-system (mm-with-unibyte-buffer
4564                                         (insert contents)
4565                                         (mm-find-buffer-file-coding-system)))
4566             (setq charset gnus-newsgroup-charset))))
4567        ((numberp arg)
4568         (setq charset (or (cdr (assq arg
4569                                      gnus-summary-show-article-charset-alist))
4570                           (mm-read-coding-system "Charset: ")))))
4571       (switch-to-buffer (generate-new-buffer filename))
4572       (if (or coding-system
4573               (and charset
4574                    (setq coding-system (mm-charset-to-coding-system charset))
4575                    (not (eq charset 'ascii))))
4576           (progn
4577             (mm-enable-multibyte)
4578             (insert (mm-decode-coding-string contents coding-system))
4579             (setq buffer-file-coding-system
4580                   (if (boundp 'last-coding-system-used)
4581                       (symbol-value 'last-coding-system-used)
4582                     coding-system)))
4583         (mm-disable-multibyte)
4584         (insert contents)
4585         (setq buffer-file-coding-system mm-binary-coding-system))
4586       ;; We do it this way to make `normal-mode' set the appropriate mode.
4587       (unwind-protect
4588           (progn
4589             (setq buffer-file-name (expand-file-name filename))
4590             (normal-mode))
4591         (setq buffer-file-name nil))
4592       (goto-char (point-min)))))
4593
4594 (defun gnus-mime-print-part (&optional handle filename)
4595   "Print the MIME part under point."
4596   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4597   (gnus-article-check-buffer)
4598   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4599          (contents (and handle (mm-get-part handle)))
4600          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4601          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4602     (when contents
4603         (if printer
4604             (unwind-protect
4605                 (progn
4606                   (mm-save-part-to-file handle file)
4607                   (call-process shell-file-name nil
4608                                 (generate-new-buffer " *mm*")
4609                                 nil
4610                                 shell-command-switch
4611                                 (mm-mailcap-command
4612                                  printer file (mm-handle-type handle))))
4613               (delete-file file))
4614           (with-temp-buffer
4615             (insert contents)
4616             (gnus-print-buffer))
4617           (ps-despool filename)))))
4618
4619 (defun gnus-mime-inline-part (&optional handle arg)
4620   "Insert the MIME part under point into the current buffer.
4621 Compressed files like .gz and .bz2 are decompressed."
4622   (interactive (list nil current-prefix-arg))
4623   (gnus-article-check-buffer)
4624   (unless handle
4625     (setq handle (get-text-property (point) 'gnus-data)))
4626   (when handle
4627     (let ((b (point))
4628           (inhibit-read-only t)
4629           contents charset coding-system)
4630       (if (and (not arg) (mm-handle-undisplayer handle))
4631           (mm-remove-part handle)
4632         (mm-with-unibyte-buffer
4633           (mm-insert-part handle)
4634           (setq contents
4635                 (or (mm-decompress-buffer
4636                      (or (mail-content-type-get (mm-handle-type handle)
4637                                                 'name)
4638                          (mail-content-type-get (mm-handle-disposition handle)
4639                                                 'filename))
4640                      nil t)
4641                     (buffer-string))))
4642         (cond
4643          ((not arg)
4644           (unless (setq charset (mail-content-type-get
4645                                  (mm-handle-type handle) 'charset))
4646             (unless (setq coding-system
4647                           (mm-with-unibyte-buffer
4648                             (insert contents)
4649                             (mm-find-buffer-file-coding-system)))
4650               (setq charset gnus-newsgroup-charset))))
4651          ((numberp arg)
4652           (if (mm-handle-undisplayer handle)
4653               (mm-remove-part handle))
4654           (setq charset
4655                 (or (cdr (assq arg
4656                                gnus-summary-show-article-charset-alist))
4657                     (mm-read-coding-system "Charset: "))))
4658          (t
4659           (if (mm-handle-undisplayer handle)
4660               (mm-remove-part handle))))
4661         (forward-line 2)
4662         (mm-insert-inline
4663          handle
4664          (if (or coding-system
4665                  (and charset
4666                       (setq coding-system
4667                             (mm-charset-to-coding-system charset))
4668                       (not (eq coding-system 'ascii))))
4669              (mm-decode-coding-string contents coding-system)
4670            (mm-string-to-multibyte contents)))
4671         (goto-char b)))))
4672
4673 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4674   "Insert the MIME part under point into the current buffer using the
4675 specified charset."
4676   (interactive (list nil current-prefix-arg))
4677   (gnus-article-check-buffer)
4678   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
4679         (fun (get-text-property (point) 'gnus-callback))
4680         (gnus-newsgroup-ignored-charsets 'gnus-all)
4681         gnus-newsgroup-charset type charset)
4682     (when handle
4683       (if (mm-handle-undisplayer handle)
4684           (mm-remove-part handle))
4685       (when fun
4686         (setq gnus-newsgroup-charset
4687               (or (cdr (assq arg gnus-summary-show-article-charset-alist))
4688                   (mm-read-coding-system "Charset: ")))
4689         ;; Strip the charset parameter from `handle'.
4690         (setq type (mm-handle-type
4691                     (if (equal (mm-handle-media-type handle)
4692                                "message/external-body")
4693                         (progn
4694                           (unless (mm-handle-cache handle)
4695                             (mm-extern-cache-contents handle))
4696                           (mm-handle-cache handle))
4697                       handle))
4698               charset (assq 'charset (cdr type)))
4699         (delq charset type)
4700         (funcall fun handle)))))
4701
4702 (defun gnus-mime-view-part-externally (&optional handle)
4703   "View the MIME part under point with an external viewer."
4704   (interactive)
4705   (gnus-article-check-buffer)
4706   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4707          (mm-user-display-methods nil)
4708          (mm-inlined-types nil)
4709          (mail-parse-charset gnus-newsgroup-charset)
4710          (mail-parse-ignored-charsets
4711           (with-current-buffer gnus-summary-buffer
4712             gnus-newsgroup-ignored-charsets))
4713          (type (mm-handle-media-type handle))
4714          (method (mailcap-mime-info type))
4715          (mm-enable-external t))
4716     (if (not (stringp method))
4717         (gnus-mime-view-part-as-type
4718          nil (lambda (type) (stringp (mailcap-mime-info type))))
4719       (when handle
4720         (if (mm-handle-undisplayer handle)
4721             (mm-remove-part handle)
4722           (mm-display-part handle))))))
4723
4724 (defun gnus-mime-view-part-internally (&optional handle)
4725   "View the MIME part under point with an internal viewer.
4726 If no internal viewer is available, use an external viewer."
4727   (interactive)
4728   (gnus-article-check-buffer)
4729   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4730          (mm-inlined-types '(".*"))
4731          (mm-inline-large-images t)
4732          (mail-parse-charset gnus-newsgroup-charset)
4733          (mail-parse-ignored-charsets
4734           (with-current-buffer gnus-summary-buffer
4735             gnus-newsgroup-ignored-charsets))
4736          (inhibit-read-only t))
4737     (if (not (mm-inlinable-p handle))
4738         (gnus-mime-view-part-as-type
4739          nil (lambda (type) (mm-inlinable-p handle type)))
4740       (when handle
4741         (if (mm-handle-undisplayer handle)
4742             (mm-remove-part handle)
4743           (mm-display-part handle))))))
4744
4745 (defun gnus-mime-action-on-part (&optional action)
4746   "Do something with the MIME attachment at \(point\)."
4747   (interactive
4748    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
4749   (gnus-article-check-buffer)
4750   (let ((action-pair (assoc action gnus-mime-action-alist)))
4751     (if action-pair
4752         (funcall (cdr action-pair)))))
4753
4754 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
4755   "Call FUNCTION on MIME part N.
4756 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
4757 If INTERACTIVE, call FUNCTION interactivly."
4758   (let (window frame)
4759     ;; Check whether the article is displayed.
4760     (unless (and (gnus-buffer-live-p gnus-article-buffer)
4761                  (setq window (get-buffer-window gnus-article-buffer t))
4762                  (frame-visible-p (setq frame (window-frame window))))
4763       (error "No article is displayed"))
4764     (with-current-buffer gnus-article-buffer
4765       ;; Check whether the article displays the right contents.
4766       (unless (with-current-buffer gnus-summary-buffer
4767                 (eq gnus-current-article (gnus-summary-article-number)))
4768         (error "You should select the right article first"))
4769       ;; Check whether the specified part exists.
4770       (when (> n (length gnus-article-mime-handle-alist))
4771         (error "No such part")))
4772     (unless
4773         (progn
4774           ;; To select the window is needed so that the cursor
4775           ;; might be visible on the MIME button.
4776           (select-window (prog1
4777                              window
4778                            (setq window (selected-window))
4779                            ;; Article may be displayed in the other frame.
4780                            (gnus-select-frame-set-input-focus
4781                             (prog1
4782                                 frame
4783                               (setq frame (selected-frame))))))
4784           (when (gnus-article-goto-part n)
4785             ;; We point the cursor and the arrow at the MIME button
4786             ;; when the `function' prompt the user for something.
4787             (let ((cursor-in-non-selected-windows t)
4788                   (overlay-arrow-string "=>")
4789                   (overlay-arrow-position (point-marker)))
4790               (unwind-protect
4791                   (cond
4792                    ((and no-handle interactive)
4793                     (call-interactively function))
4794                    (no-handle
4795                     (funcall function))
4796                    (interactive
4797                     (call-interactively
4798                      function
4799                      (cdr (assq n gnus-article-mime-handle-alist))))
4800                    (t
4801                     (funcall function
4802                              (cdr (assq n gnus-article-mime-handle-alist)))))
4803                 (set-marker overlay-arrow-position nil)
4804                 (unless gnus-auto-select-part
4805                   (gnus-select-frame-set-input-focus frame)
4806                   (select-window window))))
4807             t))
4808       (if gnus-inhibit-mime-unbuttonizing
4809           ;; This is the default though the program shouldn't reach here.
4810           (error "No such part")
4811         ;; The part which doesn't have the MIME button is selected.
4812         ;; So, we display all the buttons and redo it.
4813         (let ((gnus-inhibit-mime-unbuttonizing t))
4814           (gnus-summary-show-article)
4815           (gnus-article-part-wrapper n function no-handle))))))
4816
4817 (defun gnus-article-pipe-part (n)
4818   "Pipe MIME part N, which is the numerical prefix."
4819   (interactive "p")
4820   (gnus-article-part-wrapper n 'mm-pipe-part))
4821
4822 (defun gnus-article-save-part (n)
4823   "Save MIME part N, which is the numerical prefix."
4824   (interactive "p")
4825   (gnus-article-part-wrapper n 'mm-save-part))
4826
4827 (defun gnus-article-interactively-view-part (n)
4828   "View MIME part N interactively, which is the numerical prefix."
4829   (interactive "p")
4830   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4831
4832 (defun gnus-article-copy-part (n)
4833   "Copy MIME part N, which is the numerical prefix."
4834   (interactive "p")
4835   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4836
4837 (defun gnus-article-view-part-as-charset (n)
4838   "View MIME part N using a specified charset.
4839 N is the numerical prefix."
4840   (interactive "p")
4841   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4842
4843 (defun gnus-article-view-part-externally (n)
4844   "View MIME part N externally, which is the numerical prefix."
4845   (interactive "p")
4846   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4847
4848 (defun gnus-article-inline-part (n)
4849   "Inline MIME part N, which is the numerical prefix."
4850   (interactive "p")
4851   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4852
4853 (defun gnus-article-save-part-and-strip (n)
4854   "Save MIME part N and replace it with an external body.
4855 N is the numerical prefix."
4856   (interactive "p")
4857   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
4858
4859 (defun gnus-article-replace-part (n)
4860   "Replace MIME part N with an external body.
4861 N is the numerical prefix."
4862   (interactive "p")
4863   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
4864
4865 (defun gnus-article-delete-part (n)
4866   "Delete MIME part N and add some information about the removed part.
4867 N is the numerical prefix."
4868   (interactive "p")
4869   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
4870
4871 (defun gnus-article-view-part-as-type (n)
4872   "Choose a MIME media type, and view part N as such.
4873 N is the numerical prefix."
4874   (interactive "p")
4875   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
4876
4877 (defun gnus-article-mime-match-handle-first (condition)
4878   (if condition
4879       (let (n)
4880         (dolist (ihandle gnus-article-mime-handle-alist)
4881           (if (and (cond
4882                     ((functionp condition)
4883                      (funcall condition (cdr ihandle)))
4884                     ((eq condition 'undisplayed)
4885                      (not (or (mm-handle-undisplayer (cdr ihandle))
4886                               (equal (mm-handle-media-type (cdr ihandle))
4887                                      "multipart/alternative"))))
4888                     ((eq condition 'undisplayed-alternative)
4889                      (not (mm-handle-undisplayer (cdr ihandle))))
4890                     (t t))
4891                    (gnus-article-goto-part (car ihandle))
4892                    (or (not n) (< (car ihandle) n)))
4893               (setq n (car ihandle))))
4894         (or n 1))
4895     1))
4896
4897 (defun gnus-article-view-part (&optional n)
4898   "View MIME part N, which is the numerical prefix."
4899   (interactive "P")
4900   (with-current-buffer gnus-article-buffer
4901     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4902                              gnus-article-mime-match-handle-function)))
4903     (when (> n (length gnus-article-mime-handle-alist))
4904       (error "No such part"))
4905     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4906       (when (gnus-article-goto-part n)
4907         (if (equal (car handle) "multipart/alternative")
4908             (gnus-article-press-button)
4909           (when (eq (gnus-mm-display-part handle) 'internal)
4910             (gnus-set-window-start)))))))
4911
4912 (defsubst gnus-article-mime-total-parts ()
4913   (if (bufferp (car gnus-article-mime-handles))
4914       1 ;; single part
4915     (1- (length gnus-article-mime-handles))))
4916
4917 (defun gnus-mm-display-part (handle)
4918   "Display HANDLE and fix MIME button."
4919   (let ((id (get-text-property (point) 'gnus-part))
4920         (point (point))
4921         (inhibit-read-only t))
4922     (forward-line 1)
4923     (prog1
4924         (let ((window (selected-window))
4925               (mail-parse-charset gnus-newsgroup-charset)
4926               (mail-parse-ignored-charsets
4927                (if (gnus-buffer-live-p gnus-summary-buffer)
4928                    (with-current-buffer gnus-summary-buffer
4929                      gnus-newsgroup-ignored-charsets)
4930                  nil)))
4931           (save-excursion
4932             (unwind-protect
4933                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4934                       (beg (point)))
4935                   (when win
4936                     (select-window win))
4937                   (goto-char point)
4938                   (forward-line)
4939                   (if (mm-handle-displayed-p handle)
4940                       ;; This will remove the part.
4941                       (mm-display-part handle)
4942                     (save-restriction
4943                       (narrow-to-region (point)
4944                                         (if (eobp) (point) (1+ (point))))
4945                       (mm-display-part handle)
4946                       ;; We narrow to the part itself and
4947                       ;; then call the treatment functions.
4948                       (goto-char (point-min))
4949                       (forward-line 1)
4950                       (narrow-to-region (point) (point-max))
4951                       (gnus-treat-article
4952                        nil id
4953                        (gnus-article-mime-total-parts)
4954                        (mm-handle-media-type handle)))))
4955               (if (window-live-p window)
4956                   (select-window window)))))
4957       (goto-char point)
4958       (gnus-delete-line)
4959       (gnus-insert-mime-button
4960        handle id (list (mm-handle-displayed-p handle)))
4961       (goto-char point))))
4962
4963 (defun gnus-article-goto-part (n)
4964   "Go to MIME part N."
4965   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
4966
4967 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4968   (let ((gnus-tmp-name
4969          (or (mail-content-type-get (mm-handle-type handle) 'name)
4970              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4971              (mail-content-type-get (mm-handle-type handle) 'url)
4972              ""))
4973         (gnus-tmp-type (mm-handle-media-type handle))
4974         (gnus-tmp-description
4975          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4976                                               "")))
4977         (gnus-tmp-dots
4978          (if (if displayed (car displayed)
4979                (mm-handle-displayed-p handle))
4980              "" "..."))
4981         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4982                            (buffer-size)))
4983         gnus-tmp-type-long b e)
4984     (when (string-match ".*/" gnus-tmp-name)
4985       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4986     (setq gnus-tmp-type-long (concat gnus-tmp-type
4987                                      (and (not (equal gnus-tmp-name ""))
4988                                           (concat "; " gnus-tmp-name))))
4989     (unless (equal gnus-tmp-description "")
4990       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4991     (unless (bolp)
4992       (insert "\n"))
4993     (setq b (point))
4994     (gnus-eval-format
4995      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4996      `(keymap ,gnus-mime-button-map
4997               gnus-callback gnus-mm-display-part
4998               gnus-part ,gnus-tmp-id
4999               article-type annotation
5000               gnus-data ,handle))
5001     (setq e (if (bolp)
5002                 ;; Exclude a newline.
5003                 (1- (point))
5004               (point)))
5005     (widget-convert-button
5006      'link b e
5007      :mime-handle handle
5008      :action 'gnus-widget-press-button
5009      :button-keymap gnus-mime-button-map
5010      :help-echo
5011      (lambda (widget/window &optional overlay pos)
5012        ;; Needed to properly clear the message due to a bug in
5013        ;; wid-edit (XEmacs only).
5014        (if (boundp 'help-echo-owns-message)
5015            (setq help-echo-owns-message t))
5016        (format
5017         "%S: %s the MIME part; %S: more options"
5018         (aref gnus-mouse-2 0)
5019         ;; XEmacs will get a single widget arg; Emacs 21 will get
5020         ;; window, overlay, position.
5021         (if (mm-handle-displayed-p
5022              (if overlay
5023                  (with-current-buffer (gnus-overlay-buffer overlay)
5024                    (widget-get (widget-at (gnus-overlay-start overlay))
5025                                :mime-handle))
5026                (widget-get widget/window :mime-handle)))
5027             "hide" "show")
5028         (aref gnus-down-mouse-3 0))))))
5029
5030 (defun gnus-widget-press-button (elems el)
5031   (goto-char (widget-get elems :from))
5032   (gnus-article-press-button))
5033
5034 (defvar gnus-displaying-mime nil)
5035
5036 (defun gnus-display-mime (&optional ihandles)
5037   "Display the MIME parts."
5038   (save-excursion
5039     (save-selected-window
5040       (let ((window (get-buffer-window gnus-article-buffer))
5041             (point (point)))
5042         (when window
5043           (select-window window)
5044           ;; We have to do this since selecting the window
5045           ;; may change the point.  So we set the window point.
5046           (set-window-point window point)))
5047       (let ((handles ihandles)
5048             (inhibit-read-only t)
5049             handle)
5050         (cond (handles)
5051               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5052                (when gnus-article-emulate-mime
5053                  (mm-uu-dissect-text-parts handles)))
5054               (gnus-article-emulate-mime
5055                (setq handles (mm-uu-dissect))))
5056         (when (and (not ihandles)
5057                    (not gnus-displaying-mime))
5058           ;; Top-level call; we clean up.
5059           (when gnus-article-mime-handles
5060             (mm-destroy-parts gnus-article-mime-handles)
5061             (setq gnus-article-mime-handle-alist nil));; A trick.
5062           (setq gnus-article-mime-handles handles)
5063           ;; We allow users to glean info from the handles.
5064           (when gnus-article-mime-part-function
5065             (gnus-mime-part-function handles)))
5066         (if (and handles
5067                  (or (not (stringp (car handles)))
5068                      (cdr handles)))
5069             (progn
5070               (when (and (not ihandles)
5071                          (not gnus-displaying-mime))
5072                 ;; Clean up for mime parts.
5073                 (article-goto-body)
5074                 (delete-region (point) (point-max)))
5075               (let ((gnus-displaying-mime t))
5076                 (gnus-mime-display-part handles)))
5077           (save-restriction
5078             (article-goto-body)
5079             (narrow-to-region (point) (point-max))
5080             (gnus-treat-article nil 1 1)
5081             (widen)))
5082         (unless ihandles
5083           ;; Highlight the headers.
5084           (save-excursion
5085             (save-restriction
5086               (article-goto-body)
5087               (narrow-to-region (point-min) (point))
5088               (gnus-article-save-original-date
5089                (gnus-treat-article 'head)))))))))
5090
5091 (defcustom gnus-mime-display-multipart-as-mixed nil
5092   "Display \"multipart\" parts as  \"multipart/mixed\".
5093
5094 If t, it overrides nil values of
5095 `gnus-mime-display-multipart-alternative-as-mixed' and
5096 `gnus-mime-display-multipart-related-as-mixed'."
5097   :group 'gnus-article-mime
5098   :type 'boolean)
5099
5100 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5101   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5102   :version "22.1"
5103   :group 'gnus-article-mime
5104   :type 'boolean)
5105
5106 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5107   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5108
5109 If displaying \"text/html\" is discouraged \(see
5110 `mm-discouraged-alternatives'\) images or other material inside a
5111 \"multipart/related\" part might be overlooked when this variable is nil."
5112   :version "22.1"
5113   :group 'gnus-article-mime
5114   :type 'boolean)
5115
5116 (defun gnus-mime-display-part (handle)
5117   (cond
5118    ;; Maybe a broken MIME message.
5119    ((null handle))
5120    ;; Single part.
5121    ((not (stringp (car handle)))
5122     (gnus-mime-display-single handle))
5123    ;; User-defined multipart
5124    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5125     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5126              handle))
5127    ;; multipart/alternative
5128    ((and (equal (car handle) "multipart/alternative")
5129          (not (or gnus-mime-display-multipart-as-mixed
5130                   gnus-mime-display-multipart-alternative-as-mixed)))
5131     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5132       (push (cons id handle) gnus-article-mime-handle-alist)
5133       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5134    ;; multipart/related
5135    ((and (equal (car handle) "multipart/related")
5136          (not (or gnus-mime-display-multipart-as-mixed
5137                   gnus-mime-display-multipart-related-as-mixed)))
5138     ;;;!!!We should find the start part, but we just default
5139     ;;;!!!to the first part.
5140     ;;(gnus-mime-display-part (cadr handle))
5141     ;;;!!! Most multipart/related is an HTML message plus images.
5142     ;;;!!! Unfortunately we are unable to let W3 display those
5143     ;;;!!! included images, so we just display it as a mixed multipart.
5144     ;;(gnus-mime-display-mixed (cdr handle))
5145     ;;;!!! No, w3 can display everything just fine.
5146     (gnus-mime-display-part (cadr handle)))
5147    ((equal (car handle) "multipart/signed")
5148     (gnus-add-wash-type 'signed)
5149     (gnus-mime-display-security handle))
5150    ((equal (car handle) "multipart/encrypted")
5151     (gnus-add-wash-type 'encrypted)
5152     (gnus-mime-display-security handle))
5153    ;; Other multiparts are handled like multipart/mixed.
5154    (t
5155     (gnus-mime-display-mixed (cdr handle)))))
5156
5157 (defun gnus-mime-part-function (handles)
5158   (if (stringp (car handles))
5159       (mapcar 'gnus-mime-part-function (cdr handles))
5160     (funcall gnus-article-mime-part-function handles)))
5161
5162 (defun gnus-mime-display-mixed (handles)
5163   (mapcar 'gnus-mime-display-part handles))
5164
5165 (defun gnus-mime-display-single (handle)
5166   (let ((type (mm-handle-media-type handle))
5167         (ignored gnus-ignored-mime-types)
5168         (not-attachment t)
5169         (move nil)
5170         display text)
5171     (catch 'ignored
5172       (progn
5173         (while ignored
5174           (when (string-match (pop ignored) type)
5175             (throw 'ignored nil)))
5176         (if (and (setq not-attachment
5177                        (and (not (mm-inline-override-p handle))
5178                             (or (not (mm-handle-disposition handle))
5179                                 (equal (car (mm-handle-disposition handle))
5180                                        "inline")
5181                                 (mm-attachment-override-p handle))))
5182                  (mm-automatic-display-p handle)
5183                  (or (and
5184                       (mm-inlinable-p handle)
5185                       (mm-inlined-p handle))
5186                      (mm-automatic-external-display-p type)))
5187             (setq display t)
5188           (when (equal (mm-handle-media-supertype handle) "text")
5189             (setq text t)))
5190         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5191               beg)
5192           (push (cons id handle) gnus-article-mime-handle-alist)
5193           (when (and display
5194                      (equal (mm-handle-media-supertype handle) "message"))
5195             (insert-char
5196              ?\n
5197              (cond ((not (bolp)) 2)
5198                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5199                    (t 1))))
5200           (when (or (not display)
5201                     (not (gnus-unbuttonized-mime-type-p type)))
5202             (gnus-insert-mime-button
5203              handle id (list (or display (and not-attachment text))))
5204             (gnus-article-insert-newline)
5205             ;; Remember modify the number of forward lines.
5206             (setq move t))
5207           (setq beg (point))
5208           (cond
5209            (display
5210             (when move
5211               (forward-line -1)
5212               (setq beg (point)))
5213             (let ((mail-parse-charset gnus-newsgroup-charset)
5214                   (mail-parse-ignored-charsets
5215                    (save-excursion (condition-case ()
5216                                        (set-buffer gnus-summary-buffer)
5217                                      (error))
5218                                    gnus-newsgroup-ignored-charsets)))
5219               (mm-display-part handle t))
5220             (goto-char (point-max)))
5221            ((and text not-attachment)
5222             (when move
5223               (forward-line -1)
5224               (setq beg (point)))
5225             (gnus-article-insert-newline)
5226             (mm-insert-inline
5227              handle
5228              (let ((charset (mail-content-type-get (mm-handle-type handle)
5229                                                    'charset)))
5230                (cond ((not charset)
5231                       (mm-string-as-multibyte (mm-get-part handle)))
5232                      ((eq charset 'gnus-decoded)
5233                       (with-current-buffer (mm-handle-buffer handle)
5234                         (buffer-string)))
5235                      (t
5236                       (mm-decode-string (mm-get-part handle) charset)))))
5237             (goto-char (point-max))))
5238           ;; Do highlighting.
5239           (save-excursion
5240             (save-restriction
5241               (narrow-to-region beg (point))
5242               (gnus-treat-article
5243                nil id
5244                (gnus-article-mime-total-parts)
5245                (mm-handle-media-type handle)))))))))
5246
5247 (defun gnus-unbuttonized-mime-type-p (type)
5248   "Say whether TYPE is to be unbuttonized."
5249   (unless gnus-inhibit-mime-unbuttonizing
5250     (when (catch 'found
5251             (let ((types gnus-unbuttonized-mime-types))
5252               (while types
5253                 (when (string-match (pop types) type)
5254                   (throw 'found t)))))
5255       (not (catch 'found
5256              (let ((types gnus-buttonized-mime-types))
5257                (while types
5258                  (when (string-match (pop types) type)
5259                    (throw 'found t)))))))))
5260
5261 (defun gnus-article-insert-newline ()
5262   "Insert a newline, but mark it as undeletable."
5263   (gnus-put-text-property
5264    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5265
5266 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5267   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5268          (ihandles handles)
5269          (point (point))
5270          handle (inhibit-read-only t) from props begend not-pref)
5271     (save-window-excursion
5272       (save-restriction
5273         (when ibegend
5274           (narrow-to-region (car ibegend)
5275                             (or (cdr ibegend)
5276                                 (progn
5277                                   (goto-char (car ibegend))
5278                                   (forward-line 2)
5279                                   (point))))
5280           (delete-region (point-min) (point-max))
5281           (mm-remove-parts handles))
5282         (setq begend (list (point-marker)))
5283         ;; Do the toggle.
5284         (unless (setq not-pref (cadr (member preferred ihandles)))
5285           (setq not-pref (car ihandles)))
5286         (when (or ibegend
5287                   (not preferred)
5288                   (not (gnus-unbuttonized-mime-type-p
5289                         "multipart/alternative")))
5290           (gnus-add-text-properties
5291            (setq from (point))
5292            (progn
5293              (insert (format "%d.  " id))
5294              (point))
5295            `(gnus-callback
5296              (lambda (handles)
5297                (unless ,(not ibegend)
5298                  (setq gnus-article-mime-handle-alist
5299                        ',gnus-article-mime-handle-alist))
5300                (gnus-mime-display-alternative
5301                 ',ihandles ',not-pref ',begend ,id))
5302              keymap ,gnus-mime-button-map
5303              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5304              face ,gnus-article-button-face
5305              gnus-part ,id
5306              article-type multipart))
5307           (widget-convert-button 'link from (point)
5308                                  :action 'gnus-widget-press-button
5309                                  :button-keymap gnus-widget-button-keymap)
5310           ;; Do the handles
5311           (while (setq handle (pop handles))
5312             (gnus-add-text-properties
5313              (setq from (point))
5314              (progn
5315                (insert (format "(%c) %-18s"
5316                                (if (equal handle preferred) ?* ? )
5317                                (mm-handle-media-type handle)))
5318                (point))
5319              `(gnus-callback
5320                (lambda (handles)
5321                  (unless ,(not ibegend)
5322                    (setq gnus-article-mime-handle-alist
5323                          ',gnus-article-mime-handle-alist))
5324                  (gnus-mime-display-alternative
5325                   ',ihandles ',handle ',begend ,id))
5326                keymap ,gnus-mime-button-map
5327                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5328                face ,gnus-article-button-face
5329                gnus-part ,id
5330                gnus-data ,handle))
5331             (widget-convert-button 'link from (point)
5332                                    :action 'gnus-widget-press-button
5333                                    :button-keymap gnus-widget-button-keymap)
5334             (insert "  "))
5335           (insert "\n\n"))
5336         (when preferred
5337           (if (stringp (car preferred))
5338               (gnus-display-mime preferred)
5339             (let ((mail-parse-charset gnus-newsgroup-charset)
5340                   (mail-parse-ignored-charsets
5341                    (with-current-buffer gnus-summary-buffer
5342                      gnus-newsgroup-ignored-charsets)))
5343               (mm-display-part preferred)
5344               ;; Do highlighting.
5345               (save-excursion
5346                 (save-restriction
5347                   (narrow-to-region (car begend) (point-max))
5348                   (gnus-treat-article
5349                    nil (length gnus-article-mime-handle-alist)
5350                    (gnus-article-mime-total-parts)
5351                    (mm-handle-media-type handle))))))
5352           (goto-char (point-max))
5353           (setcdr begend (point-marker)))))
5354     (when ibegend
5355       (goto-char point))))
5356
5357 (defconst gnus-article-wash-status-strings
5358   (let ((alist '((cite "c" "Possible hidden citation text"
5359                        " " "All citation text visible")
5360                  (headers "h" "Hidden headers"
5361                           " " "All headers visible.")
5362                  (pgp "p" "Encrypted or signed message status hidden"
5363                       " " "No hidden encryption nor digital signature status")
5364                  (signature "s" "Signature has been hidden"
5365                             " " "Signature is visible")
5366                  (overstrike "o" "Overstrike (^H) characters applied"
5367                              " " "No overstrike characters applied")
5368                  (emphasis "e" "/*_Emphasis_*/ characters applied"
5369                            " " "No /*_emphasis_*/ characters applied")))
5370         result)
5371     (dolist (entry alist result)
5372       (let ((key (nth 0 entry))
5373             (on (copy-sequence (nth 1 entry)))
5374             (on-help (nth 2 entry))
5375             (off (copy-sequence (nth 3 entry)))
5376             (off-help (nth 4 entry)))
5377         (put-text-property 0 1 'help-echo on-help on)
5378         (put-text-property 0 1 'help-echo off-help off)
5379         (push (list key on off) result))))
5380   "Alist of strings describing wash status in the mode line.
5381 Each entry has the form (KEY ON OF), where the KEY is a symbol
5382 representing the particular washing function, ON is the string to use
5383 in the article mode line when the washing function is active, and OFF
5384 is the string to use when it is inactive.")
5385
5386 (defun gnus-article-wash-status-entry (key value)
5387   (let ((entry (assoc key gnus-article-wash-status-strings)))
5388     (if value (nth 1 entry) (nth 2 entry))))
5389
5390 (defun gnus-article-wash-status ()
5391   "Return a string which display status of article washing."
5392   (with-current-buffer gnus-article-buffer
5393     (let ((cite (memq 'cite gnus-article-wash-types))
5394           (headers (memq 'headers gnus-article-wash-types))
5395           (boring (memq 'boring-headers gnus-article-wash-types))
5396           (pgp (memq 'pgp gnus-article-wash-types))
5397           (pem (memq 'pem gnus-article-wash-types))
5398           (signed (memq 'signed gnus-article-wash-types))
5399           (encrypted (memq 'encrypted gnus-article-wash-types))
5400           (signature (memq 'signature gnus-article-wash-types))
5401           (overstrike (memq 'overstrike gnus-article-wash-types))
5402           (emphasis (memq 'emphasis gnus-article-wash-types)))
5403       (concat
5404        (gnus-article-wash-status-entry 'cite cite)
5405        (gnus-article-wash-status-entry 'headers (or headers boring))
5406        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
5407        (gnus-article-wash-status-entry 'signature signature)
5408        (gnus-article-wash-status-entry 'overstrike overstrike)
5409        (gnus-article-wash-status-entry 'emphasis emphasis)))))
5410
5411 (defun gnus-add-wash-type (type)
5412   "Add a washing of TYPE to the current status."
5413   (add-to-list 'gnus-article-wash-types type))
5414
5415 (defun gnus-delete-wash-type (type)
5416   "Add a washing of TYPE to the current status."
5417   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
5418
5419 (defun gnus-add-image (category image)
5420   "Add IMAGE of CATEGORY to the list of displayed images."
5421   (let ((entry (assq category gnus-article-image-alist)))
5422     (unless entry
5423       (setq entry (list category))
5424       (push entry gnus-article-image-alist))
5425     (nconc entry (list image))))
5426
5427 (defun gnus-delete-images (category)
5428   "Delete all images in CATEGORY."
5429   (let ((entry (assq category gnus-article-image-alist)))
5430     (dolist (image (cdr entry))
5431       (gnus-remove-image image category))
5432     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
5433     (gnus-delete-wash-type category)))
5434
5435 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
5436
5437 (defun gnus-article-maybe-hide-headers ()
5438   "Hide unwanted headers if `gnus-have-all-headers' is nil.
5439 Provided for backwards compatibility."
5440   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
5441                  (not (with-current-buffer gnus-summary-buffer
5442                         gnus-have-all-headers)))
5443              (not gnus-inhibit-hiding))
5444     (gnus-article-hide-headers)))
5445
5446 ;;; Article savers.
5447
5448 (defun gnus-output-to-file (file-name)
5449   "Append the current article to a file named FILE-NAME."
5450   (let ((artbuf (current-buffer)))
5451     (with-temp-buffer
5452       (insert-buffer-substring artbuf)
5453       ;; Append newline at end of the buffer as separator, and then
5454       ;; save it to file.
5455       (goto-char (point-max))
5456       (insert "\n")
5457       (let ((file-name-coding-system nnmail-pathname-coding-system))
5458         (mm-append-to-file (point-min) (point-max) file-name))
5459       t)))
5460
5461 (defun gnus-narrow-to-page (&optional arg)
5462   "Narrow the article buffer to a page.
5463 If given a numerical ARG, move forward ARG pages."
5464   (interactive "P")
5465   (setq arg (if arg (prefix-numeric-value arg) 0))
5466   (save-excursion
5467     (set-buffer gnus-article-buffer)
5468     (goto-char (point-min))
5469     (widen)
5470     ;; Remove any old next/prev buttons.
5471     (when (gnus-visual-p 'page-marker)
5472       (let ((inhibit-read-only t))
5473         (gnus-remove-text-with-property 'gnus-prev)
5474         (gnus-remove-text-with-property 'gnus-next)))
5475     (if
5476         (cond ((< arg 0)
5477                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
5478               ((> arg 0)
5479                (re-search-forward page-delimiter nil 'move arg)))
5480         (goto-char (match-end 0))
5481       (save-excursion
5482         (goto-char (point-min))
5483         (setq gnus-page-broken
5484               (and (re-search-forward page-delimiter nil t) t))))
5485     (when gnus-page-broken
5486       (narrow-to-region
5487        (point)
5488        (if (re-search-forward page-delimiter nil 'move)
5489            (match-beginning 0)
5490          (point)))
5491       (when (and (gnus-visual-p 'page-marker)
5492                  (> (point-min) (save-restriction (widen) (point-min))))
5493         (save-excursion
5494           (goto-char (point-min))
5495           (gnus-insert-prev-page-button)))
5496       (when (and (gnus-visual-p 'page-marker)
5497                  (< (point-max) (save-restriction (widen) (point-max))))
5498         (save-excursion
5499           (goto-char (point-max))
5500           (gnus-insert-next-page-button))))))
5501
5502 ;; Article mode commands
5503
5504 (defun gnus-article-goto-next-page ()
5505   "Show the next page of the article."
5506   (interactive)
5507   (when (gnus-article-next-page)
5508     (goto-char (point-min))
5509     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
5510
5511
5512 (defun gnus-article-goto-prev-page ()
5513   "Show the previous page of the article."
5514   (interactive)
5515   (if (bobp)
5516       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
5517     (gnus-article-prev-page nil)))
5518
5519 ;; This is cleaner but currently breaks `gnus-pick-mode':
5520 ;;
5521 ;; (defun gnus-article-goto-next-page ()
5522 ;;   "Show the next page of the article."
5523 ;;   (interactive)
5524 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5525 ;;     (gnus-summary-next-page)))
5526 ;;
5527 ;; (defun gnus-article-goto-prev-page ()
5528 ;;   "Show the next page of the article."
5529 ;;   (interactive)
5530 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5531 ;;     (gnus-summary-prev-page)))
5532
5533 (defun gnus-article-next-page (&optional lines)
5534   "Show the next page of the current article.
5535 If end of article, return non-nil.  Otherwise return nil.
5536 Argument LINES specifies lines to be scrolled up."
5537   (interactive "p")
5538   (move-to-window-line -1)
5539   (if (save-excursion
5540         (end-of-line)
5541         (and (pos-visible-in-window-p)  ;Not continuation line.
5542              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
5543       ;; Nothing in this page.
5544       (if (or (not gnus-page-broken)
5545               (save-excursion
5546                 (save-restriction
5547                   (widen)
5548                   (forward-line)
5549                   (eobp)))) ;Real end-of-buffer?
5550           (progn
5551             (when gnus-article-over-scroll
5552               (gnus-article-next-page-1 lines))
5553             t)                  ;Nothing more.
5554         (gnus-narrow-to-page 1)         ;Go to next page.
5555         nil)
5556     ;; More in this page.
5557     (gnus-article-next-page-1 lines)
5558     nil))
5559
5560 (defmacro gnus-article-beginning-of-window ()
5561   "Move point to the beginning of the window.
5562 In Emacs, the point is placed at the line number which `scroll-margin'
5563 specifies."
5564   (if (featurep 'xemacs)
5565       '(move-to-window-line 0)
5566     '(move-to-window-line
5567       (min (max 0 scroll-margin)
5568            (max 1 (- (window-height)
5569                      (if mode-line-format 1 0)
5570                      (if header-line-format 1 0)))))))
5571
5572 (defun gnus-article-next-page-1 (lines)
5573   (when (and (not (featurep 'xemacs))
5574              (numberp lines)
5575              (> lines 0)
5576              (numberp (symbol-value 'scroll-margin))
5577              (> (symbol-value 'scroll-margin) 0))
5578     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
5579     ;; too many number of lines if `scroll-margin' is set as two or greater.
5580     (setq lines (min lines
5581                      (max 0 (- (count-lines (window-start) (point-max))
5582                                (symbol-value 'scroll-margin))))))
5583   (condition-case ()
5584       (let ((scroll-in-place nil))
5585         (scroll-up lines))
5586     (end-of-buffer
5587      ;; Long lines may cause an end-of-buffer error.
5588      (goto-char (point-max))))
5589   (gnus-article-beginning-of-window))
5590
5591 (defun gnus-article-prev-page (&optional lines)
5592   "Show previous page of current article.
5593 Argument LINES specifies lines to be scrolled down."
5594   (interactive "p")
5595   (move-to-window-line 0)
5596   (if (and gnus-page-broken
5597            (bobp)
5598            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
5599       (progn
5600         (gnus-narrow-to-page -1)        ;Go to previous page.
5601         (goto-char (point-max))
5602         (recenter -1))
5603     (prog1
5604         (condition-case ()
5605             (let ((scroll-in-place nil))
5606               (scroll-down lines))
5607           (beginning-of-buffer
5608            (goto-char (point-min))))
5609       (gnus-article-beginning-of-window))))
5610
5611 (defun gnus-article-only-boring-p ()
5612   "Decide whether there is only boring text remaining in the article.
5613 Something \"interesting\" is a word of at least two letters that does
5614 not have a face in `gnus-article-boring-faces'."
5615   (when (and gnus-article-skip-boring
5616              (boundp 'gnus-article-boring-faces)
5617              (symbol-value 'gnus-article-boring-faces))
5618     (save-excursion
5619       (let ((inhibit-point-motion-hooks t))
5620         (catch 'only-boring
5621           (while (re-search-forward "\\b\\w\\w" nil t)
5622             (forward-char -1)
5623             (when (not (gnus-intersection
5624                         (gnus-faces-at (point))
5625                         (symbol-value 'gnus-article-boring-faces)))
5626               (throw 'only-boring nil)))
5627           (throw 'only-boring t))))))
5628
5629 (defun gnus-article-refer-article ()
5630   "Read article specified by message-id around point."
5631   (interactive)
5632   (save-excursion
5633     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
5634     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
5635     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
5636         (let ((msg-id (concat "<" (match-string 0) ">")))
5637           (set-buffer gnus-summary-buffer)
5638           (gnus-summary-refer-article msg-id))
5639       (error "No references around point"))))
5640
5641 (defun gnus-article-show-summary ()
5642   "Reconfigure windows to show summary buffer."
5643   (interactive)
5644   (if (not (gnus-buffer-live-p gnus-summary-buffer))
5645       (error "There is no summary buffer for this article buffer")
5646     (gnus-article-set-globals)
5647     (gnus-configure-windows 'article)
5648     (gnus-summary-goto-subject gnus-current-article)
5649     (gnus-summary-position-point)))
5650
5651 (defun gnus-article-describe-briefly ()
5652   "Describe article mode commands briefly."
5653   (interactive)
5654   (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")))
5655
5656 (defun gnus-article-summary-command ()
5657   "Execute the last keystroke in the summary buffer."
5658   (interactive)
5659   (let ((obuf (current-buffer))
5660         (owin (current-window-configuration))
5661         func)
5662     (switch-to-buffer gnus-article-current-summary 'norecord)
5663     (setq func (lookup-key (current-local-map) (this-command-keys)))
5664     (call-interactively func)
5665     (set-buffer obuf)
5666     (set-window-configuration owin)
5667     (set-window-point (get-buffer-window (current-buffer)) (point))))
5668
5669 (defun gnus-article-summary-command-nosave ()
5670   "Execute the last keystroke in the summary buffer."
5671   (interactive)
5672   (let (func)
5673     (pop-to-buffer gnus-article-current-summary 'norecord)
5674     (setq func (lookup-key (current-local-map) (this-command-keys)))
5675     (call-interactively func)))
5676
5677 (defun gnus-article-check-buffer ()
5678   "Beep if not in an article buffer."
5679   (unless (equal major-mode 'gnus-article-mode)
5680     (error "Command invoked outside of a Gnus article buffer")))
5681
5682 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
5683   "Read a summary buffer key sequence and execute it from the article buffer."
5684   (interactive "P")
5685   (gnus-article-check-buffer)
5686   (let ((nosaves
5687          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
5688            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
5689            "=" "^" "\M-^" "|"))
5690         (nosave-but-article
5691          '("A\r"))
5692         (nosave-in-article
5693          '("\C-d"))
5694         (up-to-top
5695          '("n" "Gn" "p" "Gp"))
5696         keys new-sum-point)
5697     (save-excursion
5698       (set-buffer gnus-article-current-summary)
5699       (let (gnus-pick-mode)
5700         (push (or key last-command-event) unread-command-events)
5701         (setq keys (if (featurep 'xemacs)
5702                        (events-to-keys (read-key-sequence nil))
5703                      (read-key-sequence nil)))))
5704
5705     (message "")
5706
5707     (if (or (member keys nosaves)
5708             (member keys nosave-but-article)
5709             (member keys nosave-in-article))
5710         (let (func)
5711           (save-window-excursion
5712             (pop-to-buffer gnus-article-current-summary 'norecord)
5713             ;; We disable the pick minor mode commands.
5714             (let (gnus-pick-mode)
5715               (setq func (lookup-key (current-local-map) keys))))
5716           (if (or (not func)
5717                   (numberp func))
5718               (ding)
5719             (unless (member keys nosave-in-article)
5720               (set-buffer gnus-article-current-summary))
5721             (call-interactively func)
5722             (setq new-sum-point (point)))
5723           (when (member keys nosave-but-article)
5724             (pop-to-buffer gnus-article-buffer 'norecord)))
5725       ;; These commands should restore window configuration.
5726       (let ((obuf (current-buffer))
5727             (owin (current-window-configuration))
5728             (opoint (point))
5729             win func in-buffer selected new-sum-start new-sum-hscroll)
5730         (cond (not-restore-window
5731                (pop-to-buffer gnus-article-current-summary 'norecord))
5732               ((setq win (get-buffer-window gnus-article-current-summary))
5733                (select-window win))
5734               (t
5735                (switch-to-buffer gnus-article-current-summary 'norecord)))
5736         (setq in-buffer (current-buffer))
5737         ;; We disable the pick minor mode commands.
5738         (if (and (setq func (let (gnus-pick-mode)
5739                               (lookup-key (current-local-map) keys)))
5740                  (functionp func))
5741             (progn
5742               (call-interactively func)
5743               (when (eq win (selected-window))
5744                 (setq new-sum-point (point)
5745                       new-sum-start (window-start win)
5746                       new-sum-hscroll (window-hscroll win)))
5747               (when (eq in-buffer (current-buffer))
5748                 (setq selected (gnus-summary-select-article))
5749                 (set-buffer obuf)
5750                 (unless not-restore-window
5751                   (set-window-configuration owin))
5752                 (when (eq selected 'old)
5753                   (article-goto-body)
5754                   (set-window-start (get-buffer-window (current-buffer))
5755                                     1)
5756                   (set-window-point (get-buffer-window (current-buffer))
5757                                     (point)))
5758                 (when (and (not not-restore-window)
5759                            new-sum-point)
5760                   (set-window-point win new-sum-point)
5761                   (set-window-start win new-sum-start)
5762                   (set-window-hscroll win new-sum-hscroll))))
5763           (set-window-configuration owin)
5764           (ding))))))
5765
5766 (defun gnus-article-describe-key (key)
5767   "Display documentation of the function invoked by KEY.  KEY is a string."
5768   (interactive "kDescribe key: ")
5769   (gnus-article-check-buffer)
5770   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5771       (save-excursion
5772         (set-buffer gnus-article-current-summary)
5773         (let (gnus-pick-mode)
5774           (if (featurep 'xemacs)
5775               (progn
5776                 (push (elt key 0) unread-command-events)
5777                 (setq key (events-to-keys
5778                            (read-key-sequence "Describe key: "))))
5779             (setq unread-command-events
5780                   (mapcar
5781                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5782                    (string-to-list key)))
5783             (setq key (read-key-sequence "Describe key: "))))
5784         (describe-key key))
5785     (describe-key key)))
5786
5787 (defun gnus-article-describe-key-briefly (key &optional insert)
5788   "Display documentation of the function invoked by KEY.  KEY is a string."
5789   (interactive "kDescribe key: \nP")
5790   (gnus-article-check-buffer)
5791   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5792       (save-excursion
5793         (set-buffer gnus-article-current-summary)
5794         (let (gnus-pick-mode)
5795           (if (featurep 'xemacs)
5796               (progn
5797                 (push (elt key 0) unread-command-events)
5798                 (setq key (events-to-keys
5799                            (read-key-sequence "Describe key: "))))
5800             (setq unread-command-events
5801                   (mapcar
5802                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5803                    (string-to-list key)))
5804             (setq key (read-key-sequence "Describe key: "))))
5805         (describe-key-briefly key insert))
5806     (describe-key-briefly key insert)))
5807
5808 (defun gnus-article-reply-with-original (&optional wide)
5809   "Start composing a reply mail to the current message.
5810 The text in the region will be yanked.  If the region isn't active,
5811 the entire article will be yanked."
5812   (interactive "P")
5813   (let ((article (cdr gnus-article-current))
5814         contents)
5815     (if (not (gnus-region-active-p))
5816         (with-current-buffer gnus-summary-buffer
5817           (gnus-summary-reply (list (list article)) wide))
5818       (setq contents (buffer-substring (point) (mark t)))
5819       ;; Deactivate active regions.
5820       (when (and (boundp 'transient-mark-mode)
5821                  transient-mark-mode)
5822         (setq mark-active nil))
5823       (with-current-buffer gnus-summary-buffer
5824         (gnus-summary-reply
5825          (list (list article contents)) wide)))))
5826
5827 (defun gnus-article-followup-with-original ()
5828   "Compose a followup to the current article.
5829 The text in the region will be yanked.  If the region isn't active,
5830 the entire article will be yanked."
5831   (interactive)
5832   (let ((article (cdr gnus-article-current))
5833         contents)
5834       (if (not (gnus-region-active-p))
5835           (with-current-buffer gnus-summary-buffer
5836             (gnus-summary-followup (list (list article))))
5837         (setq contents (buffer-substring (point) (mark t)))
5838         ;; Deactivate active regions.
5839         (when (and (boundp 'transient-mark-mode)
5840                    transient-mark-mode)
5841           (setq mark-active nil))
5842         (with-current-buffer gnus-summary-buffer
5843           (gnus-summary-followup
5844            (list (list article contents)))))))
5845
5846 (defun gnus-article-hide (&optional arg force)
5847   "Hide all the gruft in the current article.
5848 This means that signatures, cited text and (some) headers will be
5849 hidden.
5850 If given a prefix, show the hidden text instead."
5851   (interactive (append (gnus-article-hidden-arg) (list 'force)))
5852   (gnus-article-hide-headers arg)
5853   (gnus-article-hide-list-identifiers arg)
5854   (gnus-article-hide-citation-maybe arg force)
5855   (gnus-article-hide-signature arg))
5856
5857 (defun gnus-article-maybe-highlight ()
5858   "Do some article highlighting if article highlighting is requested."
5859   (when (gnus-visual-p 'article-highlight 'highlight)
5860     (gnus-article-highlight-some)))
5861
5862 (defun gnus-check-group-server ()
5863   ;; Make sure the connection to the server is alive.
5864   (unless (gnus-server-opened
5865            (gnus-find-method-for-group gnus-newsgroup-name))
5866     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5867     (gnus-request-group gnus-newsgroup-name t)))
5868
5869 (eval-when-compile
5870   (autoload 'nneething-get-file-name "nneething"))
5871
5872 (defun gnus-request-article-this-buffer (article group)
5873   "Get an article and insert it into this buffer."
5874   (let (do-update-line sparse-header)
5875     (prog1
5876         (save-excursion
5877           (erase-buffer)
5878           (gnus-kill-all-overlays)
5879           (setq group (or group gnus-newsgroup-name))
5880
5881           ;; Using `gnus-request-article' directly will insert the article into
5882           ;; `nntp-server-buffer' - so we'll save some time by not having to
5883           ;; copy it from the server buffer into the article buffer.
5884
5885           ;; We only request an article by message-id when we do not have the
5886           ;; headers for it, so we'll have to get those.
5887           (when (stringp article)
5888             (gnus-read-header article))
5889
5890           ;; If the article number is negative, that means that this article
5891           ;; doesn't belong in this newsgroup (possibly), so we find its
5892           ;; message-id and request it by id instead of number.
5893           (when (and (numberp article)
5894                      gnus-summary-buffer
5895                      (get-buffer gnus-summary-buffer)
5896                      (gnus-buffer-exists-p gnus-summary-buffer))
5897             (save-excursion
5898               (set-buffer gnus-summary-buffer)
5899               (let ((header (gnus-summary-article-header article)))
5900                 (when (< article 0)
5901                   (cond
5902                    ((memq article gnus-newsgroup-sparse)
5903                     ;; This is a sparse gap article.
5904                     (setq do-update-line article)
5905                     (setq article (mail-header-id header))
5906                     (setq sparse-header (gnus-read-header article))
5907                     (setq gnus-newsgroup-sparse
5908                           (delq article gnus-newsgroup-sparse)))
5909                    ((vectorp header)
5910                     ;; It's a real article.
5911                     (setq article (mail-header-id header)))
5912                    (t
5913                     ;; It is an extracted pseudo-article.
5914                     (setq article 'pseudo)
5915                     (gnus-request-pseudo-article header))))
5916
5917                 (let ((method (gnus-find-method-for-group
5918                                gnus-newsgroup-name)))
5919                   (when (and (eq (car method) 'nneething)
5920                              (vectorp header))
5921                     (let ((dir (nneething-get-file-name
5922                                 (mail-header-id header))))
5923                       (when (and (stringp dir)
5924                                  (file-directory-p dir))
5925                         (setq article 'nneething)
5926                         (gnus-group-enter-directory dir))))))))
5927
5928           (cond
5929            ;; Refuse to select canceled articles.
5930            ((and (numberp article)
5931                  gnus-summary-buffer
5932                  (get-buffer gnus-summary-buffer)
5933                  (gnus-buffer-exists-p gnus-summary-buffer)
5934                  (eq (cdr (with-current-buffer gnus-summary-buffer
5935                             (assq article gnus-newsgroup-reads)))
5936                      gnus-canceled-mark))
5937             nil)
5938            ;; We first check `gnus-original-article-buffer'.
5939            ((and (get-buffer gnus-original-article-buffer)
5940                  (numberp article)
5941                  (with-current-buffer gnus-original-article-buffer
5942                    (and (equal (car gnus-original-article) group)
5943                         (eq (cdr gnus-original-article) article))))
5944             (insert-buffer-substring gnus-original-article-buffer)
5945             'article)
5946            ;; Check the backlog.
5947            ((and gnus-keep-backlog
5948                  (gnus-backlog-request-article group article (current-buffer)))
5949             'article)
5950            ;; Check asynchronous pre-fetch.
5951            ((gnus-async-request-fetched-article group article (current-buffer))
5952             (gnus-async-prefetch-next group article gnus-summary-buffer)
5953             (when (and (numberp article) gnus-keep-backlog)
5954               (gnus-backlog-enter-article group article (current-buffer)))
5955             'article)
5956            ;; Check the cache.
5957            ((and gnus-use-cache
5958                  (numberp article)
5959                  (gnus-cache-request-article article group))
5960             'article)
5961            ;; Check the agent cache.
5962            ((gnus-agent-request-article article group)
5963             'article)
5964            ;; Get the article and put into the article buffer.
5965            ((or (stringp article)
5966                 (numberp article))
5967             (let ((gnus-override-method gnus-override-method)
5968                   (methods (and (stringp article)
5969                                 gnus-refer-article-method))
5970                   (backend (car (gnus-find-method-for-group
5971                                  gnus-newsgroup-name)))
5972                   result
5973                   (inhibit-read-only t))
5974               (if (or (not (listp methods))
5975                       (and (symbolp (car methods))
5976                            (assq (car methods) nnoo-definition-alist)))
5977                   (setq methods (list methods)))
5978               (when (and (null gnus-override-method)
5979                          methods)
5980                 (setq gnus-override-method (pop methods)))
5981               (while (not result)
5982                 (when (eq gnus-override-method 'current)
5983                   (setq gnus-override-method
5984                         (with-current-buffer gnus-summary-buffer
5985                           gnus-current-select-method)))
5986                 (erase-buffer)
5987                 (gnus-kill-all-overlays)
5988                 (let ((gnus-newsgroup-name group))
5989                   (gnus-check-group-server))
5990                 (cond
5991                  ((gnus-request-article article group (current-buffer))
5992                   (when (numberp article)
5993                     (gnus-async-prefetch-next group article
5994                                               gnus-summary-buffer)
5995                     (when gnus-keep-backlog
5996                       (gnus-backlog-enter-article
5997                        group article (current-buffer))))
5998                   (setq result 'article))
5999                  (methods
6000                   (setq gnus-override-method (pop methods)))
6001                  ((not (string-match "^400 "
6002                                      (nnheader-get-report backend)))
6003                   ;; If we get 400 server disconnect, reconnect and
6004                   ;; retry; otherwise, assume the article has expired.
6005                   (setq result 'done))))
6006               (and (eq result 'article) 'article)))
6007            ;; It was a pseudo.
6008            (t article)))
6009
6010       ;; Associate this article with the current summary buffer.
6011       (setq gnus-article-current-summary gnus-summary-buffer)
6012
6013       ;; Take the article from the original article buffer
6014       ;; and place it in the buffer it's supposed to be in.
6015       (when (and (get-buffer gnus-article-buffer)
6016                  (equal (buffer-name (current-buffer))
6017                         (buffer-name (get-buffer gnus-article-buffer))))
6018         (save-excursion
6019           (if (get-buffer gnus-original-article-buffer)
6020               (set-buffer gnus-original-article-buffer)
6021             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6022             (buffer-disable-undo)
6023             (setq major-mode 'gnus-original-article-mode)
6024             (setq buffer-read-only t))
6025           (let ((inhibit-read-only t))
6026             (erase-buffer)
6027             (insert-buffer-substring gnus-article-buffer))
6028           (setq gnus-original-article (cons group article)))
6029
6030         ;; Decode charsets.
6031         (run-hooks 'gnus-article-decode-hook)
6032         ;; Mark article as decoded or not.
6033         (setq gnus-article-decoded-p gnus-article-decode-hook))
6034
6035       ;; Update sparse articles.
6036       (when (and do-update-line
6037                  (or (numberp article)
6038                      (stringp article)))
6039         (let ((buf (current-buffer)))
6040           (set-buffer gnus-summary-buffer)
6041           (gnus-summary-update-article do-update-line sparse-header)
6042           (gnus-summary-goto-subject do-update-line nil t)
6043           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6044                             (point))
6045           (set-buffer buf))))))
6046
6047 ;;;
6048 ;;; Article editing
6049 ;;;
6050
6051 (defcustom gnus-article-edit-mode-hook nil
6052   "Hook run in article edit mode buffers."
6053   :group 'gnus-article-various
6054   :type 'hook)
6055
6056 (defvar gnus-article-edit-done-function nil)
6057
6058 (defvar gnus-article-edit-mode-map nil)
6059
6060 ;; Should we be using derived.el for this?
6061 (unless gnus-article-edit-mode-map
6062   (setq gnus-article-edit-mode-map (make-keymap))
6063   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6064
6065   (gnus-define-keys gnus-article-edit-mode-map
6066     "\C-c?"    describe-mode
6067     "\C-c\C-c" gnus-article-edit-done
6068     "\C-c\C-k" gnus-article-edit-exit
6069     "\C-c\C-f\C-t" message-goto-to
6070     "\C-c\C-f\C-o" message-goto-from
6071     "\C-c\C-f\C-b" message-goto-bcc
6072     ;;"\C-c\C-f\C-w" message-goto-fcc
6073     "\C-c\C-f\C-c" message-goto-cc
6074     "\C-c\C-f\C-s" message-goto-subject
6075     "\C-c\C-f\C-r" message-goto-reply-to
6076     "\C-c\C-f\C-n" message-goto-newsgroups
6077     "\C-c\C-f\C-d" message-goto-distribution
6078     "\C-c\C-f\C-f" message-goto-followup-to
6079     "\C-c\C-f\C-m" message-goto-mail-followup-to
6080     "\C-c\C-f\C-k" message-goto-keywords
6081     "\C-c\C-f\C-u" message-goto-summary
6082     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6083     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6084     "\C-c\C-b" message-goto-body
6085     "\C-c\C-i" message-goto-signature
6086
6087     "\C-c\C-t" message-insert-to
6088     "\C-c\C-n" message-insert-newsgroups
6089     "\C-c\C-o" message-sort-headers
6090     "\C-c\C-e" message-elide-region
6091     "\C-c\C-v" message-delete-not-region
6092     "\C-c\C-z" message-kill-to-signature
6093     "\M-\r" message-newline-and-reformat
6094     "\C-c\C-a" mml-attach-file
6095     "\C-a" message-beginning-of-line
6096     "\t" message-tab
6097     "\M-;" comment-region)
6098
6099   (gnus-define-keys (gnus-article-edit-wash-map
6100                      "\C-c\C-w" gnus-article-edit-mode-map)
6101     "f" gnus-article-edit-full-stops))
6102
6103 (easy-menu-define
6104   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6105   '("Field"
6106     ["Fetch To" message-insert-to t]
6107     ["Fetch Newsgroups" message-insert-newsgroups t]
6108     "----"
6109     ["To" message-goto-to t]
6110     ["From" message-goto-from t]
6111     ["Subject" message-goto-subject t]
6112     ["Cc" message-goto-cc t]
6113     ["Reply-To" message-goto-reply-to t]
6114     ["Summary" message-goto-summary t]
6115     ["Keywords" message-goto-keywords t]
6116     ["Newsgroups" message-goto-newsgroups t]
6117     ["Followup-To" message-goto-followup-to t]
6118     ["Mail-Followup-To" message-goto-mail-followup-to t]
6119     ["Distribution" message-goto-distribution t]
6120     ["Body" message-goto-body t]
6121     ["Signature" message-goto-signature t]))
6122
6123 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6124   "Major mode for editing articles.
6125 This is an extended text-mode.
6126
6127 \\{gnus-article-edit-mode-map}"
6128   (make-local-variable 'gnus-article-edit-done-function)
6129   (make-local-variable 'gnus-prev-winconf)
6130   (set (make-local-variable 'font-lock-defaults)
6131        '(message-font-lock-keywords t))
6132   (set (make-local-variable 'mail-header-separator) "")
6133   (set (make-local-variable 'gnus-article-edit-mode) t)
6134   (easy-menu-add message-mode-field-menu message-mode-map)
6135   (mml-mode)
6136   (setq buffer-read-only nil)
6137   (buffer-enable-undo)
6138   (widen))
6139
6140 (defun gnus-article-edit (&optional force)
6141   "Edit the current article.
6142 This will have permanent effect only in mail groups.
6143 If FORCE is non-nil, allow editing of articles even in read-only
6144 groups."
6145   (interactive "P")
6146   (when (and (not force)
6147              (gnus-group-read-only-p))
6148     (error "The current newsgroup does not support article editing"))
6149   (gnus-article-date-original)
6150   (gnus-article-edit-article
6151    'ignore
6152    `(lambda (no-highlight)
6153       'ignore
6154       (gnus-summary-edit-article-done
6155        ,(or (mail-header-references gnus-current-headers) "")
6156        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6157
6158 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6159   "Start editing the contents of the current article buffer."
6160   (let ((winconf (current-window-configuration)))
6161     (set-buffer gnus-article-buffer)
6162     (let ((message-auto-save-directory
6163            ;; Don't associate the article buffer with a draft file.
6164            nil))
6165       (gnus-article-edit-mode))
6166     (funcall start-func)
6167     (set-buffer-modified-p nil)
6168     (gnus-configure-windows 'edit-article)
6169     (setq gnus-article-edit-done-function exit-func)
6170     (setq gnus-prev-winconf winconf)
6171     (unless quiet
6172       (gnus-message 6 "C-c C-c to end edits"))))
6173
6174 (defun gnus-article-edit-done (&optional arg)
6175   "Update the article edits and exit."
6176   (interactive "P")
6177   (let ((func gnus-article-edit-done-function)
6178         (buf (current-buffer))
6179         (start (window-start))
6180         (p (point))
6181         (winconf gnus-prev-winconf))
6182     (widen) ;; Widen it in case that users narrowed the buffer.
6183     (funcall func arg)
6184     (set-buffer buf)
6185     ;; The cache and backlog have to be flushed somewhat.
6186     (when gnus-keep-backlog
6187       (gnus-backlog-remove-article
6188        (car gnus-article-current) (cdr gnus-article-current)))
6189     ;; Flush original article as well.
6190     (save-excursion
6191       (when (get-buffer gnus-original-article-buffer)
6192         (set-buffer gnus-original-article-buffer)
6193         (setq gnus-original-article nil)))
6194     (when gnus-use-cache
6195       (gnus-cache-update-article
6196        (car gnus-article-current) (cdr gnus-article-current)))
6197     ;; We remove all text props from the article buffer.
6198     (kill-all-local-variables)
6199     (set-text-properties (point-min) (point-max) nil)
6200     (gnus-article-mode)
6201     (set-window-configuration winconf)
6202     (set-buffer buf)
6203     (set-window-start (get-buffer-window buf) start)
6204     (set-window-point (get-buffer-window buf) (point)))
6205   (gnus-summary-show-article))
6206
6207 (defun gnus-article-edit-exit ()
6208   "Exit the article editing without updating."
6209   (interactive)
6210   (when (or (not (buffer-modified-p))
6211             (yes-or-no-p "Article modified; kill anyway? "))
6212     (let ((curbuf (current-buffer))
6213           (p (point))
6214           (window-start (window-start)))
6215       (erase-buffer)
6216       (if (gnus-buffer-live-p gnus-original-article-buffer)
6217           (insert-buffer-substring gnus-original-article-buffer))
6218       (let ((winconf gnus-prev-winconf))
6219         (kill-all-local-variables)
6220         (gnus-article-mode)
6221         (set-window-configuration winconf)
6222         ;; Tippy-toe some to make sure that point remains where it was.
6223         (save-current-buffer
6224           (set-buffer curbuf)
6225           (set-window-start (get-buffer-window (current-buffer)) window-start)
6226           (goto-char p))))
6227     (gnus-summary-show-article)))
6228
6229 (defun gnus-article-edit-full-stops ()
6230   "Interactively repair spacing at end of sentences."
6231   (interactive)
6232   (save-excursion
6233     (goto-char (point-min))
6234     (search-forward-regexp "^$" nil t)
6235     (let ((case-fold-search nil))
6236       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
6237
6238 ;;;
6239 ;;; Article highlights
6240 ;;;
6241
6242 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
6243
6244 ;;; Internal Variables:
6245
6246 (defcustom gnus-button-url-regexp
6247   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
6248       "\\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:]]\\)"
6249     "\\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\\)\\)")
6250   "Regular expression that matches URLs."
6251   :group 'gnus-article-buttons
6252   :type 'regexp)
6253
6254 (defcustom gnus-button-valid-fqdn-regexp
6255   message-valid-fqdn-regexp
6256   "Regular expression that matches a valid FQDN."
6257   :version "22.1"
6258   :group 'gnus-article-buttons
6259   :type 'regexp)
6260
6261 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
6262 (defcustom gnus-button-valid-localpart-regexp
6263   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
6264   "Regular expression that matches a localpart of mail addresses or MIDs."
6265   :version "22.1"
6266   :group 'gnus-article-buttons
6267   :type 'regexp)
6268
6269 (defcustom gnus-button-man-handler 'manual-entry
6270   "Function to use for displaying man pages.
6271 The function must take at least one argument with a string naming the
6272 man page."
6273   :version "22.1"
6274   :type '(choice (function-item :tag "Man" manual-entry)
6275                  (function-item :tag "Woman" woman)
6276                  (function :tag "Other"))
6277   :group 'gnus-article-buttons)
6278
6279 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
6280   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
6281 If the default site is too slow, try to find a CTAN mirror, see
6282 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
6283 the variable `gnus-button-handle-ctan'."
6284   :version "22.1"
6285   :group 'gnus-article-buttons
6286   :link '(custom-manual "(gnus)Group Parameters")
6287   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
6288                  (const "http://tug.ctan.org/tex-archive/")
6289                  (const "http://www.dante.de/CTAN/")
6290                  (string :tag "Other")))
6291
6292 (defcustom gnus-button-ctan-handler 'browse-url
6293   "Function to use for displaying CTAN links.
6294 The function must take one argument, the string naming the URL."
6295   :version "22.1"
6296   :type '(choice (function-item :tag "Browse Url" browse-url)
6297                  (function :tag "Other"))
6298   :group 'gnus-article-buttons)
6299
6300 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
6301   "Bogus strings removed from CTAN URLs."
6302   :version "22.1"
6303   :group 'gnus-article-buttons
6304   :type '(choice (const "^/?tex-archive/\\|/")
6305                  (regexp :tag "Other")))
6306
6307 (defcustom gnus-button-ctan-directory-regexp
6308   (regexp-opt
6309    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
6310          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
6311          "languages" "macros" "nonfree" "obsolete" "support" "systems"
6312          "tds" "tools" "usergrps" "web") t)
6313   "Regular expression for ctan directories.
6314 It should match all directories in the top level of `gnus-ctan-url'."
6315   :version "22.1"
6316   :group 'gnus-article-buttons
6317   :type 'regexp)
6318
6319 (defcustom gnus-button-mid-or-mail-regexp
6320   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
6321           gnus-button-valid-fqdn-regexp
6322           ">?\\)\\b")
6323   "Regular expression that matches a message ID or a mail address."
6324   :version "22.1"
6325   :group 'gnus-article-buttons
6326   :type 'regexp)
6327
6328 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
6329   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
6330 Strings like this can be either a message ID or a mail address.  If it is one
6331 of the symbols `mid' or `mail', Gnus will always assume that the string is a
6332 message ID or a mail address, respectively.  If this variable is set to the
6333 symbol `ask', always query the user what do do.  If it is a function, this
6334 function will be called with the string as it's only argument.  The function
6335 must return `mid', `mail', `invalid' or `ask'."
6336   :version "22.1"
6337   :group 'gnus-article-buttons
6338   :type '(choice (function-item :tag "Heuristic function"
6339                                 gnus-button-mid-or-mail-heuristic)
6340                  (const ask)
6341                  (const mid)
6342                  (const mail)))
6343
6344 (defcustom gnus-button-mid-or-mail-heuristic-alist
6345   '((-10.0 . ".+\\$.+@")
6346     (-10.0 . "#")
6347     (-10.0 . "\\*")
6348     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
6349     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
6350     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
6351     (-1.0  . "^[^a-z]+@")
6352     ;;
6353     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
6354     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
6355     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
6356     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
6357     ;;
6358     (-2.0  . "^[0-9]")
6359     (-1.0  . "^[0-9][0-9]")
6360     ;;
6361     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
6362     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6363     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
6364     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6365     ;;
6366     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
6367     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
6368     ;;       "[0-9]{8,}.*\@"
6369     (-3.0
6370      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
6371     ;; "[0-9]{12,}.*\@"
6372     ;; compensation for TDMA dated mail addresses:
6373     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
6374     ;;
6375     (-20.0 . "\\.fsf@") ;; Gnus
6376     (-20.0 . "^slrn")
6377     (-20.0 . "^Pine")
6378     (-20.0 . "_-_") ;; Subject change in thread
6379     ;;
6380     (-20.0 . "\\.ln@") ;; leafnode
6381     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
6382     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
6383     ;;
6384     ;; (5.0 . "") ;; $local_part_len <= 7
6385     (10.0  . "^[^0-9]+@")
6386     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
6387     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
6388     (3.0   . "\@stud")
6389     ;;
6390     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
6391     ;;
6392     (0.5   . "^[A-Z][a-z]")
6393     (0.5   . "^[A-Z][a-z][a-z]")
6394     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
6395     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
6396   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
6397
6398 A negative RATE indicates a message IDs, whereas a positive indicates a mail
6399 address.  The REGEXP is processed with `case-fold-search' set to nil."
6400   :version "22.1"
6401   :group 'gnus-article-buttons
6402   :type '(repeat (cons (number :tag "Rate")
6403                        (regexp :tag "Regexp"))))
6404
6405 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
6406   "Guess whether MID-OR-MAIL is a message ID or a mail address.
6407 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
6408 address, `ask' if unsure and `invalid' if the string is invalid."
6409   (let ((case-fold-search nil)
6410         (list gnus-button-mid-or-mail-heuristic-alist)
6411         (result 0) rate regexp lpartlen elem)
6412     (setq lpartlen
6413           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
6414     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
6415     ;; Certain special cases...
6416     (when (string-match
6417            (concat
6418             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
6419             "^[0-9]+\\.[0-9]+@compuserve\\|"
6420             "@public\\.gmane\\.org")
6421            mid-or-mail)
6422       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
6423       (setq result 'mail))
6424     (when (string-match "@.*@\\| " mid-or-mail)
6425       (gnus-message 8 "`%s' is invalid." mid-or-mail)
6426       (setq result 'invalid))
6427     ;; Nothing more to do, if result is not a number here...
6428     (when (numberp result)
6429       (while list
6430         (setq elem (car list)
6431               rate (car elem)
6432               regexp (cdr elem)
6433               list (cdr list))
6434         (when (string-match regexp mid-or-mail)
6435           (setq result (+ result rate))
6436           (gnus-message
6437            9 "`%s' matched `%s', rate `%s', result `%s'."
6438            mid-or-mail regexp rate result)))
6439       (when (<= lpartlen 7)
6440         (setq result (+ result 5.0))
6441         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
6442                       mid-or-mail result))
6443       (when (>= lpartlen 12)
6444         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
6445         (cond
6446          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
6447           ;; Long local part should contain realname if e-mail address,
6448           ;; too many digits: message-id.
6449           ;; $score -= 5.0 + 0.1 * $local_part_len;
6450           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
6451           (setq result (+ result rate))
6452           (gnus-message
6453            9 "Many digits in `%s', rate `%s', result `%s'."
6454            mid-or-mail rate result))
6455          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
6456                         mid-or-mail)
6457           ;; Too few vowels [^aeiouy]{4,}.*\@
6458           (setq result (+ result -5.0))
6459           (gnus-message
6460            9 "Few vowels in `%s', rate `%s', result `%s'."
6461            mid-or-mail -5.0 result))
6462          (t
6463           (setq result (+ result 5.0))
6464           (gnus-message
6465            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
6466     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
6467     ;; Maybe we should make this a customizable alist: (condition . 'result)
6468     (cond
6469      ((symbolp result) result)
6470      ;; Now convert number into proper results:
6471      ((< result -10.0) 'mid)
6472      ((> result  10.0) 'mail)
6473      (t 'ask))))
6474
6475 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
6476   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
6477          (url-mid (concat "news" ":" mid-or-mail))
6478          (url-mailto (concat "mailto" ":" mid-or-mail)))
6479     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
6480     (when (fboundp pref)
6481       (setq guessed
6482             ;; get rid of surrounding angles...
6483             (funcall pref
6484                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
6485       (if (or (eq 'mid guessed) (eq 'mail guessed))
6486           (setq pref guessed)
6487         (setq pref 'ask)))
6488     (if (eq pref 'ask)
6489         (save-window-excursion
6490           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
6491               (setq pref 'mail)
6492             (setq pref 'mid))))
6493     (cond ((eq pref 'mid)
6494            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
6495            (gnus-button-handle-news url-mid))
6496           ((eq pref 'mail)
6497            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
6498            (gnus-url-mailto url-mailto))
6499           (t (gnus-message 3 "Invalid string.")))))
6500
6501 (defun gnus-button-handle-custom (fun arg)
6502   "Call function FUN on argument ARG.
6503 Both FUN and ARG are supposed to be strings.  ARG will be passed
6504 as a symbol to FUN."
6505   (funcall (intern fun) (intern arg)))
6506
6507 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
6508
6509 ;; FIXME: Maybe we should merge some of the functions that do quite similar
6510 ;; stuff?
6511
6512 (defun gnus-button-handle-describe-function (url)
6513   "Call `describe-function' when pushing the corresponding URL button."
6514   (describe-function
6515    (intern
6516     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6517
6518 (defun gnus-button-handle-describe-variable (url)
6519   "Call `describe-variable' when pushing the corresponding URL button."
6520   (describe-variable
6521    (intern
6522     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6523
6524 (defun gnus-button-handle-symbol (url)
6525 "Display help on variable or function.
6526 Calls `describe-variable' or `describe-function'."
6527   (let ((sym (intern url)))
6528     (cond
6529      ((fboundp sym) (describe-function sym))
6530      ((boundp sym) (describe-variable sym))
6531      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
6532
6533 (defun gnus-button-handle-describe-key (url)
6534   "Call `describe-key' when pushing the corresponding URL button."
6535   (let* ((key-string
6536           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
6537          (keys (ignore-errors (eval `(kbd ,key-string)))))
6538     (if keys
6539         (describe-key keys)
6540       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
6541
6542 (defun gnus-button-handle-apropos (url)
6543   "Call `apropos' when pushing the corresponding URL button."
6544   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6545
6546 (defun gnus-button-handle-apropos-command (url)
6547   "Call `apropos' when pushing the corresponding URL button."
6548   (apropos-command
6549    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6550
6551 (defun gnus-button-handle-apropos-variable (url)
6552   "Call `apropos' when pushing the corresponding URL button."
6553   (funcall
6554    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
6555    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6556
6557 (defun gnus-button-handle-apropos-documentation (url)
6558   "Call `apropos' when pushing the corresponding URL button."
6559   (funcall
6560    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
6561    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6562
6563 (defun gnus-button-handle-library (url)
6564   "Call `locate-library' when pushing the corresponding URL button."
6565   (gnus-message 9 "url=`%s'" url)
6566   (let* ((lib (locate-library url))
6567          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
6568     (if (not lib)
6569         (gnus-message 1 "Cannot locale library `%s'." url)
6570       (find-file-read-only file))))
6571
6572 (defun gnus-button-handle-ctan (url)
6573   "Call `browse-url' when pushing a CTAN URL button."
6574   (funcall
6575    gnus-button-ctan-handler
6576    (concat
6577     gnus-ctan-url
6578     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
6579
6580 (defcustom gnus-button-tex-level 5
6581   "*Integer that says how many TeX-related buttons Gnus will show.
6582 The higher the number, the more buttons will appear and the more false
6583 positives are possible.  Note that you can set this variable local to
6584 specific groups.  Setting it higher in TeX groups is probably a good idea.
6585 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
6586 how to set variables in specific groups."
6587   :version "22.1"
6588   :group 'gnus-article-buttons
6589   :link '(custom-manual "(gnus)Group Parameters")
6590   :type 'integer)
6591
6592 (defcustom gnus-button-man-level 5
6593   "*Integer that says how many man-related buttons Gnus will show.
6594 The higher the number, the more buttons will appear and the more false
6595 positives are possible.  Note that you can set this variable local to
6596 specific groups.  Setting it higher in Unix groups is probably a good idea.
6597 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
6598 how to set variables in specific groups."
6599   :version "22.1"
6600   :group 'gnus-article-buttons
6601   :link '(custom-manual "(gnus)Group Parameters")
6602   :type 'integer)
6603
6604 (defcustom gnus-button-emacs-level 5
6605   "*Integer that says how many emacs-related buttons Gnus will show.
6606 The higher the number, the more buttons will appear and the more false
6607 positives are possible.  Note that you can set this variable local to
6608 specific groups.  Setting it higher in Emacs or Gnus related groups is
6609 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
6610 `gnus-parameters' on how to set variables in specific groups."
6611   :version "22.1"
6612   :group 'gnus-article-buttons
6613   :link '(custom-manual "(gnus)Group Parameters")
6614   :type 'integer)
6615
6616 (defcustom gnus-button-message-level 5
6617   "*Integer that says how many buttons for news or mail messages will appear.
6618 The higher the number, the more buttons will appear and the more false
6619 positives are possible."
6620   ;; mail addresses, MIDs, URLs for news, ...
6621   :version "22.1"
6622   :group 'gnus-article-buttons
6623   :type 'integer)
6624
6625 (defcustom gnus-button-browse-level 5
6626   "*Integer that says how many buttons for browsing will appear.
6627 The higher the number, the more buttons will appear and the more false
6628 positives are possible."
6629   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
6630   :version "22.1"
6631   :group 'gnus-article-buttons
6632   :type 'integer)
6633
6634 (defcustom gnus-button-alist
6635   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
6636      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
6637     ((concat "\\b\\(nntp\\|news\\):\\("
6638              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
6639      0 t gnus-button-handle-news 2)
6640     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
6641      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
6642     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
6643      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
6644     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
6645     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
6646      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
6647     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
6648      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
6649     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
6650      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
6651     ;; RFC 2368 (The mailto URL scheme)
6652     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6653      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6654     ("\\bmailto:\\([^ \n\t]+\\)"
6655      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6656     ;; CTAN
6657     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
6658              gnus-button-ctan-directory-regexp
6659              "[^][>)!;:,'\n\t ]+\\)")
6660      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
6661     ((concat "\\btex-archive/\\("
6662              gnus-button-ctan-directory-regexp
6663              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
6664      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
6665     ((concat
6666       "\\b\\("
6667       gnus-button-ctan-directory-regexp
6668       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
6669      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
6670     ;; This is info (home-grown style) <info://foo/bar+baz>
6671     ("\\binfo://\\([^'\">\n\t ]+\\)"
6672      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
6673     ;; Info GNOME style <info:foo#bar_baz>
6674     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
6675      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
6676     ;; Info KDE style <info:(foo)bar baz>
6677     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
6678      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
6679     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
6680      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6681     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
6682      ;; Info links like `C-h i d m CC Mode RET'
6683      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
6684     ;; This is custom
6685     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
6686      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
6687     ;; Emacs help commands
6688     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6689      ;; regexp doesn't match arguments containing ` '.
6690      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
6691     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6692      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
6693     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6694      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
6695     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6696      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
6697     ;; The following entries may lead to many false positives so don't enable
6698     ;; them by default (use a high button level).
6699     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
6700      ;; Exclude [.?] for URLs in gmane.emacs.cvs
6701      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6702     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
6703      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6704     ("`\\([a-z][a-z0-9]+-[a-z]+-[-a-z]+\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
6705      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
6706     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
6707      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
6708     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
6709      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
6710     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6711      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
6712     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6713      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
6714     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6715      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
6716     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
6717      ;; Unlike the other regexps we really have to require quoting
6718      ;; here to determine where it ends.
6719      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
6720     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
6721     ("<URL: *\\([^<>]*\\)>"
6722      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6723     ;; RFC 2396 (2.4.3., delims) ...
6724     ("\"URL: *\\([^\"]*\\)\""
6725      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6726     ;; RFC 2396 (2.4.3., delims) ...
6727     ("\"URL: *\\([^\"]*\\)\""
6728      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6729     ;; Raw URLs.
6730     (gnus-button-url-regexp
6731      0 (>= gnus-button-browse-level 0) browse-url 0)
6732     ;; man pages
6733     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
6734      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
6735      gnus-button-handle-man 1)
6736     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
6737     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
6738      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
6739      gnus-button-handle-man 1)
6740     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
6741     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
6742     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
6743      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
6744     ;; Recognizing patches to .el files.  This is somewhat obscure,
6745     ;; but considering the percentage of Gnus users who hack Emacs
6746     ;; Lisp files...
6747     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
6748      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
6749     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
6750      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
6751     ;; MID or mail: To avoid too many false positives we don't try to catch
6752     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
6753     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
6754     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
6755     ;; so that non-ambiguous entries (see above) match first.
6756     (gnus-button-mid-or-mail-regexp
6757      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
6758   "*Alist of regexps matching buttons in article bodies.
6759
6760 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
6761 REGEXP: is the string (case insensitive) matching text around the button (can
6762 also be Lisp expression evaluating to a string),
6763 BUTTON: is the number of the regexp grouping actually matching the button,
6764 FORM: is a Lisp expression which must eval to true for the button to
6765 be added,
6766 CALLBACK: is the function to call when the user push this button, and each
6767 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
6768
6769 CALLBACK can also be a variable, in that case the value of that
6770 variable it the real callback function."
6771   :group 'gnus-article-buttons
6772   :type '(repeat (list (choice regexp variable sexp)
6773                        (integer :tag "Button")
6774                        (sexp :tag "Form")
6775                        (function :tag "Callback")
6776                        (repeat :tag "Par"
6777                                :inline t
6778                                (integer :tag "Regexp group")))))
6779
6780 (defcustom gnus-header-button-alist
6781   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
6782      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
6783     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
6784      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
6785     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
6786      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
6787     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
6788      0 (>= gnus-button-browse-level 0) browse-url 0)
6789     ("^Subject:" gnus-button-url-regexp
6790      0 (>= gnus-button-browse-level 0) browse-url 0)
6791     ("^[^:]+:" gnus-button-url-regexp
6792      0 (>= gnus-button-browse-level 0) browse-url 0)
6793     ("^OpenPGP:.*url=" gnus-button-url-regexp
6794      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
6795     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6796      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6797     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
6798      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
6799   "*Alist of headers and regexps to match buttons in article heads.
6800
6801 This alist is very similar to `gnus-button-alist', except that each
6802 alist has an additional HEADER element first in each entry:
6803
6804 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
6805
6806 HEADER is a regexp to match a header.  For a fuller explanation, see
6807 `gnus-button-alist'."
6808   :group 'gnus-article-buttons
6809   :group 'gnus-article-headers
6810   :type '(repeat (list (regexp :tag "Header")
6811                        (choice regexp variable)
6812                        (integer :tag "Button")
6813                        (sexp :tag "Form")
6814                        (function :tag "Callback")
6815                        (repeat :tag "Par"
6816                                :inline t
6817                                (integer :tag "Regexp group")))))
6818
6819 ;;; Commands:
6820
6821 (defun gnus-article-push-button (event)
6822   "Check text under the mouse pointer for a callback function.
6823 If the text under the mouse pointer has a `gnus-callback' property,
6824 call it with the value of the `gnus-data' text property."
6825   (interactive "e")
6826   (set-buffer (window-buffer (posn-window (event-start event))))
6827   (let* ((pos (posn-point (event-start event)))
6828          (data (get-text-property pos 'gnus-data))
6829          (fun (get-text-property pos 'gnus-callback)))
6830     (goto-char pos)
6831     (when fun
6832       (funcall fun data))))
6833
6834 (defun gnus-article-press-button ()
6835   "Check text at point for a callback function.
6836 If the text at point has a `gnus-callback' property,
6837 call it with the value of the `gnus-data' text property."
6838   (interactive)
6839   (let ((data (get-text-property (point) 'gnus-data))
6840         (fun (get-text-property (point) 'gnus-callback)))
6841     (when fun
6842       (funcall fun data))))
6843
6844 (defun gnus-article-highlight (&optional force)
6845   "Highlight current article.
6846 This function calls `gnus-article-highlight-headers',
6847 `gnus-article-highlight-citation',
6848 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6849 do the highlighting.  See the documentation for those functions."
6850   (interactive (list 'force))
6851   (gnus-article-highlight-headers)
6852   (gnus-article-highlight-citation force)
6853   (gnus-article-highlight-signature)
6854   (gnus-article-add-buttons force)
6855   (gnus-article-add-buttons-to-head))
6856
6857 (defun gnus-article-highlight-some (&optional force)
6858   "Highlight current article.
6859 This function calls `gnus-article-highlight-headers',
6860 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6861 do the highlighting.  See the documentation for those functions."
6862   (interactive (list 'force))
6863   (gnus-article-highlight-headers)
6864   (gnus-article-highlight-signature)
6865   (gnus-article-add-buttons))
6866
6867 (defun gnus-article-highlight-headers ()
6868   "Highlight article headers as specified by `gnus-header-face-alist'."
6869   (interactive)
6870   (gnus-with-article-headers
6871     (let (regexp header-face field-face from hpoints fpoints)
6872       (dolist (entry gnus-header-face-alist)
6873         (goto-char (point-min))
6874         (setq regexp (concat "^\\("
6875                              (if (string-equal "" (nth 0 entry))
6876                                  "[^\t ]"
6877                                (nth 0 entry))
6878                              "\\)")
6879               header-face (nth 1 entry)
6880               field-face (nth 2 entry))
6881         (while (and (re-search-forward regexp nil t)
6882                     (not (eobp)))
6883           (beginning-of-line)
6884           (setq from (point))
6885           (unless (search-forward ":" nil t)
6886             (forward-char 1))
6887           (when (and header-face
6888                      (not (memq (point) hpoints)))
6889             (push (point) hpoints)
6890             (gnus-put-text-property from (point) 'face header-face))
6891           (when (and field-face
6892                      (not (memq (setq from (point)) fpoints)))
6893             (push from fpoints)
6894             (if (re-search-forward "^[^ \t]" nil t)
6895                 (forward-char -2)
6896               (goto-char (point-max)))
6897             (gnus-put-text-property from (point) 'face field-face)))))))
6898
6899 (defun gnus-article-highlight-signature ()
6900   "Highlight the signature in an article.
6901 It does this by highlighting everything after
6902 `gnus-signature-separator' using the face `gnus-signature'."
6903   (interactive)
6904   (gnus-with-article-buffer
6905     (let ((inhibit-point-motion-hooks t))
6906       (save-restriction
6907         (when (and gnus-signature-face
6908                    (gnus-article-narrow-to-signature))
6909           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
6910                             'face gnus-signature-face)
6911           (widen)
6912           (gnus-article-search-signature)
6913           (let ((start (match-beginning 0))
6914                 (end (set-marker (make-marker) (1+ (match-end 0)))))
6915             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
6916                                      end)))))))
6917
6918 (defun gnus-button-in-region-p (b e prop)
6919   "Say whether PROP exists in the region."
6920   (text-property-not-all b e prop nil))
6921
6922 (defun gnus-article-add-buttons (&optional force)
6923   "Find external references in the article and make buttons of them.
6924 \"External references\" are things like Message-IDs and URLs, as
6925 specified by `gnus-button-alist'."
6926   (interactive (list 'force))
6927   (gnus-with-article-buffer
6928     (let ((inhibit-point-motion-hooks t)
6929           (case-fold-search t)
6930           (alist gnus-button-alist)
6931           beg entry regexp)
6932       ;; Remove all old markers.
6933       (let (marker entry new-list)
6934         (while (setq marker (pop gnus-button-marker-list))
6935           (if (or (< marker (point-min)) (>= marker (point-max)))
6936               (push marker new-list)
6937             (goto-char marker)
6938             (when (setq entry (gnus-button-entry))
6939               (put-text-property (match-beginning (nth 1 entry))
6940                                  (match-end (nth 1 entry))
6941                                  'gnus-callback nil))
6942             (set-marker marker nil)))
6943         (setq gnus-button-marker-list new-list))
6944       ;; We skip the headers.
6945       (article-goto-body)
6946       (setq beg (point))
6947       (while (setq entry (pop alist))
6948         (setq regexp (eval (car entry)))
6949         (goto-char beg)
6950         (while (re-search-forward regexp nil t)
6951           (let* ((start (and entry (match-beginning (nth 1 entry))))
6952                  (end (and entry (match-end (nth 1 entry))))
6953                  (from (match-beginning 0)))
6954             (when (and (or (eq t (nth 2 entry))
6955                            (eval (nth 2 entry)))
6956                        (not (gnus-button-in-region-p
6957                              start end 'gnus-callback)))
6958               ;; That optional form returned non-nil, so we add the
6959               ;; button.
6960               (gnus-article-add-button
6961                start end 'gnus-button-push
6962                (car (push (set-marker (make-marker) from)
6963                           gnus-button-marker-list))))))))))
6964
6965 ;; Add buttons to the head of an article.
6966 (defun gnus-article-add-buttons-to-head ()
6967   "Add buttons to the head of the article."
6968   (interactive)
6969   (gnus-with-article-headers
6970     (let (beg end)
6971       (dolist (entry gnus-header-button-alist)
6972         ;; Each alist entry.
6973         (goto-char (point-min))
6974         (while (re-search-forward (car entry) nil t)
6975           ;; Each header matching the entry.
6976           (setq beg (match-beginning 0))
6977           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
6978                              (match-beginning 0))
6979                         (point-max)))
6980           (goto-char beg)
6981           (while (re-search-forward (eval (nth 1 entry)) end t)
6982             ;; Each match within a header.
6983             (let* ((entry (cdr entry))
6984                    (start (match-beginning (nth 1 entry)))
6985                    (end (match-end (nth 1 entry)))
6986                    (form (nth 2 entry)))
6987               (goto-char (match-end 0))
6988               (when (eval form)
6989                 (gnus-article-add-button
6990                  start end (nth 3 entry)
6991                  (buffer-substring (match-beginning (nth 4 entry))
6992                                    (match-end (nth 4 entry)))))))
6993           (goto-char end))))))
6994
6995 ;;; External functions:
6996
6997 (defun gnus-article-add-button (from to fun &optional data)
6998   "Create a button between FROM and TO with callback FUN and data DATA."
6999   (when gnus-article-button-face
7000     (gnus-overlay-put (gnus-make-overlay from to)
7001                       'face gnus-article-button-face))
7002   (gnus-add-text-properties
7003    from to
7004    (nconc (and gnus-article-mouse-face
7005                (list gnus-mouse-face-prop gnus-article-mouse-face))
7006           (list 'gnus-callback fun)
7007           (and data (list 'gnus-data data))))
7008   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7009                          :button-keymap gnus-widget-button-keymap))
7010
7011 ;;; Internal functions:
7012
7013 (defun gnus-article-set-globals ()
7014   (with-current-buffer gnus-summary-buffer
7015     (gnus-set-global-variables)))
7016
7017 (defun gnus-signature-toggle (end)
7018   (gnus-with-article-buffer
7019     (let ((inhibit-point-motion-hooks t))
7020       (if (text-property-any end (point-max) 'article-type 'signature)
7021           (progn
7022             (gnus-delete-wash-type 'signature)
7023             (gnus-remove-text-properties-when
7024              'article-type 'signature end (point-max)
7025              (cons 'article-type (cons 'signature
7026                                        gnus-hidden-properties))))
7027         (gnus-add-wash-type 'signature)
7028         (gnus-add-text-properties-when
7029          'article-type nil end (point-max)
7030          (cons 'article-type (cons 'signature
7031                                    gnus-hidden-properties)))))
7032     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7033       (gnus-set-mode-line 'article))))
7034
7035 (defun gnus-button-entry ()
7036   ;; Return the first entry in `gnus-button-alist' matching this place.
7037   (let ((alist gnus-button-alist)
7038         (entry nil))
7039     (while alist
7040       (setq entry (pop alist))
7041       (if (looking-at (eval (car entry)))
7042           (setq alist nil)
7043         (setq entry nil)))
7044     entry))
7045
7046 (defun gnus-button-push (marker)
7047   ;; Push button starting at MARKER.
7048   (save-excursion
7049     (goto-char marker)
7050     (let* ((entry (gnus-button-entry))
7051            (inhibit-point-motion-hooks t)
7052            (fun (nth 3 entry))
7053            (args (mapcar (lambda (group)
7054                            (let ((string (match-string group)))
7055                              (set-text-properties
7056                               0 (length string) nil string)
7057                              string))
7058                          (nthcdr 4 entry))))
7059       (cond
7060        ((fboundp fun)
7061         (apply fun args))
7062        ((and (boundp fun)
7063              (fboundp (symbol-value fun)))
7064         (apply (symbol-value fun) args))
7065        (t
7066         (gnus-message 1 "You must define `%S' to use this button"
7067                       (cons fun args)))))))
7068
7069 (defun gnus-parse-news-url (url)
7070   (let (scheme server port group message-id articles)
7071     (with-temp-buffer
7072       (insert url)
7073       (goto-char (point-min))
7074       (when (looking-at "\\([A-Za-z]+\\):")
7075         (setq scheme (match-string 1))
7076         (goto-char (match-end 0)))
7077       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7078         (setq server (match-string 1))
7079         (setq port (if (stringp (match-string 3))
7080                        (string-to-number (match-string 3))
7081                      (match-string 3)))
7082         (goto-char (match-end 0)))
7083
7084       (cond
7085        ((looking-at "\\(.*@.*\\)")
7086         (setq message-id (match-string 1)))
7087        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7088         (setq group (match-string 1)
7089               articles (split-string (match-string 2) "-")))
7090        ((looking-at "\\([^/]+\\)/?")
7091         (setq group (match-string 1)))
7092        (t
7093         (error "Unknown news URL syntax"))))
7094     (list scheme server port group message-id articles)))
7095
7096 (defun gnus-button-handle-news (url)
7097   "Fetch a news URL."
7098   (destructuring-bind (scheme server port group message-id articles)
7099       (gnus-parse-news-url url)
7100     (cond
7101      (message-id
7102       (save-excursion
7103         (set-buffer gnus-summary-buffer)
7104         (if server
7105             (let ((gnus-refer-article-method
7106                    (nconc (list (list 'nntp server))
7107                           gnus-refer-article-method))
7108                   (nntp-port-number (or port "nntp")))
7109               (gnus-message 7 "Fetching %s with %s"
7110                             message-id gnus-refer-article-method)
7111               (gnus-summary-refer-article message-id))
7112           (gnus-summary-refer-article message-id))))
7113      (group
7114       (gnus-button-fetch-group url)))))
7115
7116 (defun gnus-button-patch (library line)
7117   "Visit an Emacs Lisp library LIBRARY on line LINE."
7118   (interactive)
7119   (let ((file (locate-library (file-name-nondirectory library))))
7120     (unless file
7121       (error "Couldn't find library %s" library))
7122     (find-file file)
7123     (goto-line (string-to-number line))))
7124
7125 (defun gnus-button-handle-man (url)
7126   "Fetch a man page."
7127   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7128   (when (eq gnus-button-man-handler 'woman)
7129     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7130   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7131   (funcall gnus-button-man-handler url))
7132
7133 (defun gnus-button-handle-info-url (url)
7134   "Fetch an info URL."
7135   (setq url (mm-subst-char-in-string ?+ ?\  url))
7136   (cond
7137    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7138     (gnus-info-find-node
7139      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7140                      "Gnus")
7141              ")" (gnus-url-unhex-string (match-string 2 url)))))
7142    ((string-match "([^)\"]+)[^\"]+" url)
7143     (setq url
7144           (gnus-replace-in-string
7145            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
7146     (gnus-info-find-node url))
7147    (t (error "Can't parse %s" url))))
7148
7149 (defun gnus-button-handle-info-url-gnome (url)
7150   "Fetch GNOME style info URL."
7151   (setq url (mm-subst-char-in-string ?_ ?\  url))
7152   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
7153       (gnus-info-find-node
7154        (concat "("
7155                (gnus-url-unhex-string
7156                  (match-string 1 url))
7157                ")"
7158                (or (gnus-url-unhex-string
7159                     (match-string 2 url))
7160                    "Top")))
7161     (error "Can't parse %s" url)))
7162
7163 (defun gnus-button-handle-info-url-kde (url)
7164   "Fetch KDE style info URL."
7165   (gnus-info-find-node (gnus-url-unhex-string url)))
7166
7167 (defun gnus-button-handle-info-keystrokes (url)
7168   "Call `info' when pushing the corresponding URL button."
7169   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
7170   (info)
7171   (Info-directory)
7172   (Info-menu url))
7173
7174 (defun gnus-button-openpgp (url)
7175   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
7176   (with-temp-buffer
7177     (mm-url-insert-file-contents-external url)
7178     (pgg-snarf-keys-region (point-min) (point-max))
7179     (pgg-display-output-buffer nil nil nil)))
7180
7181 (defun gnus-button-message-id (message-id)
7182   "Fetch MESSAGE-ID."
7183   (with-current-buffer gnus-summary-buffer
7184     (gnus-summary-refer-article message-id)))
7185
7186 (defun gnus-button-fetch-group (address)
7187   "Fetch GROUP specified by ADDRESS."
7188   (if (not (string-match "[:/]" address))
7189       ;; This is just a simple group url.
7190       (gnus-group-read-ephemeral-group address gnus-select-method)
7191     (if (not
7192          (string-match
7193           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
7194           address))
7195         (error "Can't parse %s" address)
7196       (gnus-group-read-ephemeral-group
7197        (match-string 4 address)
7198        `(nntp ,(match-string 1 address)
7199               (nntp-address ,(match-string 1 address))
7200               (nntp-port-number ,(if (match-end 3)
7201                                      (match-string 3 address)
7202                                    "nntp")))
7203        nil nil nil
7204        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
7205
7206 (defun gnus-url-parse-query-string (query &optional downcase)
7207   (let (retval pairs cur key val)
7208     (setq pairs (split-string query "&"))
7209     (while pairs
7210       (setq cur (car pairs)
7211             pairs (cdr pairs))
7212       (if (not (string-match "=" cur))
7213           nil                           ; Grace
7214         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
7215               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
7216         (if downcase
7217             (setq key (downcase key)))
7218         (setq cur (assoc key retval))
7219         (if cur
7220             (setcdr cur (cons val (cdr cur)))
7221           (setq retval (cons (list key val) retval)))))
7222     retval))
7223
7224 (defun gnus-url-mailto (url)
7225   ;; Send mail to someone
7226   (when (string-match "mailto:/*\\(.*\\)" url)
7227     (setq url (substring url (match-beginning 1) nil)))
7228   (let (to args subject func)
7229     (setq args (gnus-url-parse-query-string
7230                 (if (string-match "^\\?" url)
7231                     (substring url 1)
7232                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
7233                       (concat "to=" (match-string 1 url) "&"
7234                               (match-string 2 url))
7235                     (concat "to=" url)))
7236                 t)
7237           subject (cdr-safe (assoc "subject" args)))
7238     (gnus-msg-mail)
7239     (while args
7240       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
7241       (if (fboundp func)
7242           (funcall func)
7243         (message-position-on-field (caar args)))
7244       (insert (gnus-replace-in-string
7245                (mapconcat 'identity (reverse (cdar args)) ", ")
7246                "\r\n" "\n" t))
7247       (setq args (cdr args)))
7248     (if subject
7249         (message-goto-body)
7250       (message-goto-subject))))
7251
7252 (defun gnus-button-embedded-url (address)
7253   "Activate ADDRESS with `browse-url'."
7254   (browse-url (gnus-strip-whitespace address)))
7255
7256 ;;; Next/prev buttons in the article buffer.
7257
7258 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
7259 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
7260
7261 (defvar gnus-prev-page-map
7262   (let ((map (make-sparse-keymap)))
7263     (define-key map gnus-mouse-2 'gnus-button-prev-page)
7264     (define-key map "\r" 'gnus-button-prev-page)
7265     map))
7266
7267 (defvar gnus-next-page-map
7268   (let ((map (make-sparse-keymap)))
7269     (unless (>= emacs-major-version 21)
7270       ;; XEmacs doesn't care.
7271       (set-keymap-parent map gnus-article-mode-map))
7272     (define-key map gnus-mouse-2 'gnus-button-next-page)
7273     (define-key map "\r" 'gnus-button-next-page)
7274     map))
7275
7276 (defun gnus-insert-prev-page-button ()
7277   (let ((b (point))
7278         (inhibit-read-only t))
7279     (gnus-eval-format
7280      gnus-prev-page-line-format nil
7281      `(keymap ,gnus-prev-page-map
7282          gnus-prev t
7283          gnus-callback gnus-article-button-prev-page
7284          article-type annotation))
7285     (widget-convert-button
7286      'link b (if (bolp)
7287                  ;; Exclude a newline.
7288                  (1- (point))
7289                (point))
7290      :action 'gnus-button-prev-page
7291      :button-keymap gnus-prev-page-map)))
7292
7293 (defun gnus-button-next-page (&optional args more-args)
7294   "Go to the next page."
7295   (interactive)
7296   (let ((win (selected-window)))
7297     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7298     (gnus-article-next-page)
7299     (select-window win)))
7300
7301 (defun gnus-button-prev-page (&optional args more-args)
7302   "Go to the prev page."
7303   (interactive)
7304   (let ((win (selected-window)))
7305     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7306     (gnus-article-prev-page)
7307     (select-window win)))
7308
7309 (defun gnus-insert-next-page-button ()
7310   (let ((b (point))
7311         (inhibit-read-only t))
7312     (gnus-eval-format gnus-next-page-line-format nil
7313                       `(keymap ,gnus-next-page-map
7314                           gnus-next t
7315                           gnus-callback gnus-article-button-next-page
7316                           article-type annotation))
7317     (widget-convert-button
7318      'link b (if (bolp)
7319                  ;; Exclude a newline.
7320                  (1- (point))
7321                (point))
7322      :action 'gnus-button-next-page
7323      :button-keymap gnus-next-page-map)))
7324
7325 (defun gnus-article-button-next-page (arg)
7326   "Go to the next page."
7327   (interactive "P")
7328   (let ((win (selected-window)))
7329     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7330     (gnus-article-next-page)
7331     (select-window win)))
7332
7333 (defun gnus-article-button-prev-page (arg)
7334   "Go to the prev page."
7335   (interactive "P")
7336   (let ((win (selected-window)))
7337     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7338     (gnus-article-prev-page)
7339     (select-window win)))
7340
7341 (defvar gnus-decode-header-methods
7342   '(mail-decode-encoded-word-region)
7343   "List of methods used to decode headers.
7344
7345 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
7346 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
7347 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
7348 whose names match REGEXP.
7349
7350 For example:
7351 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
7352  mail-decode-encoded-word-region
7353  (\"chinese\" . rfc1843-decode-region))
7354 ")
7355
7356 (defvar gnus-decode-header-methods-cache nil)
7357
7358 (defun gnus-multi-decode-header (start end)
7359   "Apply the functions from `gnus-encoded-word-methods' that match."
7360   (unless (and gnus-decode-header-methods-cache
7361                (eq gnus-newsgroup-name
7362                    (car gnus-decode-header-methods-cache)))
7363     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
7364     (mapcar (lambda (x)
7365               (if (symbolp x)
7366                   (nconc gnus-decode-header-methods-cache (list x))
7367                 (if (and gnus-newsgroup-name
7368                          (string-match (car x) gnus-newsgroup-name))
7369                     (nconc gnus-decode-header-methods-cache
7370                            (list (cdr x))))))
7371           gnus-decode-header-methods))
7372   (let ((xlist gnus-decode-header-methods-cache))
7373     (pop xlist)
7374     (save-restriction
7375       (narrow-to-region start end)
7376       (while xlist
7377         (funcall (pop xlist) (point-min) (point-max))))))
7378
7379 ;;;
7380 ;;; Treatment top-level handling.
7381 ;;;
7382
7383 (defun gnus-treat-article (condition &optional part-number total-parts type)
7384   (let ((length (- (point-max) (point-min)))
7385         (alist gnus-treatment-function-alist)
7386         (article-goto-body-goes-to-point-min-p t)
7387         (treated-type
7388          (or (not type)
7389              (catch 'found
7390                (let ((list gnus-article-treat-types))
7391                  (while list
7392                    (when (string-match (pop list) type)
7393                      (throw 'found t)))))))
7394         (highlightp (gnus-visual-p 'article-highlight 'highlight))
7395         val elem)
7396     (gnus-run-hooks 'gnus-part-display-hook)
7397     (dolist (elem alist)
7398       (setq val
7399             (save-excursion
7400               (when (gnus-buffer-live-p gnus-summary-buffer)
7401                 (set-buffer gnus-summary-buffer))
7402               (symbol-value (car elem))))
7403       (when (and (or (consp val)
7404                      treated-type)
7405                  (gnus-treat-predicate val)
7406                  (or (not (get (car elem) 'highlight))
7407                      highlightp))
7408         (save-restriction
7409           (funcall (cadr elem)))))))
7410
7411 ;; Dynamic variables.
7412 (eval-when-compile
7413   (defvar part-number)
7414   (defvar total-parts)
7415   (defvar type)
7416   (defvar condition)
7417   (defvar length))
7418
7419 (defun gnus-treat-predicate (val)
7420   (cond
7421    ((null val)
7422     nil)
7423    (condition
7424     (eq condition val))
7425    ((and (listp val)
7426          (stringp (car val)))
7427     (apply 'gnus-or (mapcar `(lambda (s)
7428                                (string-match s ,(or gnus-newsgroup-name "")))
7429                             val)))
7430    ((listp val)
7431     (let ((pred (pop val)))
7432       (cond
7433        ((eq pred 'or)
7434         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
7435        ((eq pred 'and)
7436         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
7437        ((eq pred 'not)
7438         (not (gnus-treat-predicate (car val))))
7439        ((eq pred 'typep)
7440         (equal (car val) type))
7441        (t
7442         (error "%S is not a valid predicate" pred)))))
7443    ((eq val t)
7444     t)
7445    ((eq val 'head)
7446     nil)
7447    ((eq val 'first)
7448     (eq part-number 1))
7449    ((eq val 'last)
7450     (eq part-number total-parts))
7451    ((numberp val)
7452     (< length val))
7453    (t
7454     (error "%S is not a valid value" val))))
7455
7456 (defun gnus-article-encrypt-body (protocol &optional n)
7457   "Encrypt the article body."
7458   (interactive
7459    (list
7460     (or gnus-article-encrypt-protocol
7461         (completing-read "Encrypt protocol: "
7462                          gnus-article-encrypt-protocol-alist
7463                          nil t))
7464     current-prefix-arg))
7465   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
7466     (unless func
7467       (error "Can't find the encrypt protocol %s" protocol))
7468     (if (member gnus-newsgroup-name '("nndraft:delayed"
7469                                       "nndraft:drafts"
7470                                       "nndraft:queue"))
7471         (error "Can't encrypt the article in group %s"
7472                gnus-newsgroup-name))
7473     (gnus-summary-iterate n
7474       (save-excursion
7475         (set-buffer gnus-summary-buffer)
7476         (let ((mail-parse-charset gnus-newsgroup-charset)
7477               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
7478               (summary-buffer gnus-summary-buffer)
7479               references point)
7480           (gnus-set-global-variables)
7481           (when (gnus-group-read-only-p)
7482             (error "The current newsgroup does not support article encrypt"))
7483           (gnus-summary-show-article t)
7484           (setq references
7485               (or (mail-header-references gnus-current-headers) ""))
7486           (set-buffer gnus-article-buffer)
7487           (let* ((inhibit-read-only t)
7488                  (headers
7489                   (mapcar (lambda (field)
7490                             (and (save-restriction
7491                                    (message-narrow-to-head)
7492                                    (goto-char (point-min))
7493                                    (search-forward field nil t))
7494                                  (prog2
7495                                      (message-narrow-to-field)
7496                                      (buffer-string)
7497                                    (delete-region (point-min) (point-max))
7498                                    (widen))))
7499                           '("Content-Type:" "Content-Transfer-Encoding:"
7500                             "Content-Disposition:"))))
7501             (message-narrow-to-head)
7502             (message-remove-header "MIME-Version")
7503             (goto-char (point-max))
7504             (setq point (point))
7505             (insert (apply 'concat headers))
7506             (widen)
7507             (narrow-to-region point (point-max))
7508             (let ((message-options message-options))
7509               (message-options-set 'message-sender user-mail-address)
7510               (message-options-set 'message-recipients user-mail-address)
7511               (message-options-set 'message-sign-encrypt 'not)
7512               (funcall func))
7513             (goto-char (point-min))
7514             (insert "MIME-Version: 1.0\n")
7515             (widen)
7516             (gnus-summary-edit-article-done
7517              references nil summary-buffer t))
7518           (when gnus-keep-backlog
7519             (gnus-backlog-remove-article
7520              (car gnus-article-current) (cdr gnus-article-current)))
7521           (save-excursion
7522             (when (get-buffer gnus-original-article-buffer)
7523               (set-buffer gnus-original-article-buffer)
7524               (setq gnus-original-article nil)))
7525           (when gnus-use-cache
7526             (gnus-cache-update-article
7527              (car gnus-article-current) (cdr gnus-article-current))))))))
7528
7529 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
7530   "The following specs can be used:
7531 %t  The security MIME type
7532 %i  Additional info
7533 %d  Details
7534 %D  Details if button is pressed")
7535
7536 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
7537   "The following specs can be used:
7538 %t  The security MIME type
7539 %i  Additional info
7540 %d  Details
7541 %D  Details if button is pressed")
7542
7543 (defvar gnus-mime-security-button-line-format-alist
7544   '((?t gnus-tmp-type ?s)
7545     (?i gnus-tmp-info ?s)
7546     (?d gnus-tmp-details ?s)
7547     (?D gnus-tmp-pressed-details ?s)))
7548
7549 (defvar gnus-mime-security-button-commands
7550   '((gnus-article-press-button "\r" "Show Detail")
7551     (undefined "v")
7552     (undefined "t")
7553     (undefined "C")
7554     (gnus-mime-security-save-part "o" "Save...")
7555     (undefined "\C-o")
7556     (undefined "r")
7557     (undefined "d")
7558     (undefined "c")
7559     (undefined "i")
7560     (undefined "E")
7561     (undefined "e")
7562     (undefined "p")
7563     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
7564     (undefined ".")))
7565
7566 (defvar gnus-mime-security-button-map
7567   (let ((map (make-sparse-keymap)))
7568     (define-key map gnus-mouse-2 'gnus-article-push-button)
7569     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
7570     (dolist (c gnus-mime-security-button-commands)
7571       (define-key map (cadr c) (car c)))
7572     map))
7573
7574 (easy-menu-define
7575   gnus-mime-security-button-menu gnus-mime-security-button-map
7576   "Security button menu."
7577   `("Security Part"
7578     ,@(delq nil
7579             (mapcar (lambda (c)
7580                       (unless (eq (car c) 'undefined)
7581                         (vector (caddr c) (car c) :active t)))
7582                     gnus-mime-security-button-commands))))
7583
7584 (defun gnus-mime-security-button-menu (event prefix)
7585   "Construct a context-sensitive menu of security commands."
7586   (interactive "e\nP")
7587   (save-window-excursion
7588     (let ((pos (event-start event)))
7589       (select-window (posn-window pos))
7590       (goto-char (posn-point pos))
7591       (gnus-article-check-buffer)
7592       (popup-menu gnus-mime-security-button-menu nil prefix))))
7593
7594 (defvar gnus-mime-security-details-buffer nil)
7595
7596 (defvar gnus-mime-security-button-pressed nil)
7597
7598 (defvar gnus-mime-security-show-details-inline t
7599   "If non-nil, show details in the article buffer.")
7600
7601 (defun gnus-mime-security-verify-or-decrypt (handle)
7602   (mm-remove-parts (cdr handle))
7603   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
7604         point (inhibit-read-only t))
7605     (if region
7606         (goto-char (car region)))
7607     (save-restriction
7608       (narrow-to-region (point) (point))
7609       (with-current-buffer (mm-handle-multipart-original-buffer handle)
7610         (let* ((mm-verify-option 'known)
7611                (mm-decrypt-option 'known)
7612                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
7613           (unless (eq nparts (cdr handle))
7614             (mm-destroy-parts (cdr handle))
7615             (setcdr handle nparts))))
7616       (setq point (point))
7617       (gnus-mime-display-security handle)
7618       (goto-char (point-max)))
7619     (when region
7620       (delete-region (point) (cdr region))
7621       (set-marker (car region) nil)
7622       (set-marker (cdr region) nil))
7623     (goto-char point)))
7624
7625 (defun gnus-mime-security-show-details (handle)
7626   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
7627     (if (not details)
7628         (gnus-message 5 "No details.")
7629       (if gnus-mime-security-show-details-inline
7630           (let ((gnus-mime-security-button-pressed
7631                  (not (get-text-property (point) 'gnus-mime-details)))
7632                 (gnus-mime-security-button-line-format
7633                  (get-text-property (point) 'gnus-line-format))
7634                 (inhibit-read-only t))
7635             (forward-char -1)
7636             (while (eq (get-text-property (point) 'gnus-line-format)
7637                        gnus-mime-security-button-line-format)
7638               (forward-char -1))
7639             (forward-char)
7640             (save-restriction
7641               (narrow-to-region (point) (point))
7642               (gnus-insert-mime-security-button handle))
7643             (delete-region (point)
7644                            (or (text-property-not-all
7645                                 (point) (point-max)
7646                                 'gnus-line-format
7647                                 gnus-mime-security-button-line-format)
7648                                (point-max))))
7649         ;; Not inlined.
7650         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
7651             (with-current-buffer gnus-mime-security-details-buffer
7652               (erase-buffer)
7653               t)
7654           (setq gnus-mime-security-details-buffer
7655                 (gnus-get-buffer-create "*MIME Security Details*")))
7656         (with-current-buffer gnus-mime-security-details-buffer
7657           (insert details)
7658           (goto-char (point-min)))
7659         (pop-to-buffer gnus-mime-security-details-buffer)))))
7660
7661 (defun gnus-mime-security-press-button (handle)
7662   (save-excursion
7663     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
7664         (gnus-mime-security-show-details handle)
7665       (gnus-mime-security-verify-or-decrypt handle))))
7666
7667 (defun gnus-insert-mime-security-button (handle &optional displayed)
7668   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
7669          (gnus-tmp-type
7670           (concat
7671            (or (nth 2 (assoc protocol mm-verify-function-alist))
7672                (nth 2 (assoc protocol mm-decrypt-function-alist))
7673                "Unknown")
7674            (if (equal (car handle) "multipart/signed")
7675                " Signed" " Encrypted")
7676            " Part"))
7677          (gnus-tmp-info
7678           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
7679               "Undecided"))
7680          (gnus-tmp-details
7681           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
7682          gnus-tmp-pressed-details
7683          b e)
7684     (setq gnus-tmp-details
7685           (if gnus-tmp-details
7686               (concat "\n" gnus-tmp-details)
7687             ""))
7688     (setq gnus-tmp-pressed-details
7689           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
7690     (unless (bolp)
7691       (insert "\n"))
7692     (setq b (point))
7693     (gnus-eval-format
7694      gnus-mime-security-button-line-format
7695      gnus-mime-security-button-line-format-alist
7696      `(keymap ,gnus-mime-security-button-map
7697          gnus-callback gnus-mime-security-press-button
7698          gnus-line-format ,gnus-mime-security-button-line-format
7699          gnus-mime-details ,gnus-mime-security-button-pressed
7700          article-type annotation
7701          gnus-data ,handle))
7702     (setq e (if (bolp)
7703                 ;; Exclude a newline.
7704                 (1- (point))
7705               (point)))
7706     (widget-convert-button
7707      'link b e
7708      :mime-handle handle
7709      :action 'gnus-widget-press-button
7710      :button-keymap gnus-mime-security-button-map
7711      :help-echo
7712      (lambda (widget/window &optional overlay pos)
7713        ;; Needed to properly clear the message due to a bug in
7714        ;; wid-edit (XEmacs only).
7715        (when (boundp 'help-echo-owns-message)
7716          (setq help-echo-owns-message t))
7717        (format
7718         "%S: show detail; %S: more options"
7719         (aref gnus-mouse-2 0)
7720         (aref gnus-down-mouse-3 0))))))
7721
7722 (defun gnus-mime-display-security (handle)
7723   (save-restriction
7724     (narrow-to-region (point) (point))
7725     (unless (gnus-unbuttonized-mime-type-p (car handle))
7726       (gnus-insert-mime-security-button handle))
7727     (gnus-mime-display-part (cadr handle))
7728     (unless (bolp)
7729       (insert "\n"))
7730     (unless (gnus-unbuttonized-mime-type-p (car handle))
7731       (let ((gnus-mime-security-button-line-format
7732              gnus-mime-security-button-end-line-format))
7733         (gnus-insert-mime-security-button handle)))
7734     (mm-set-handle-multipart-parameter
7735      handle 'gnus-region
7736      (cons (set-marker (make-marker) (point-min))
7737            (set-marker (make-marker) (point-max))))))
7738
7739 (defun gnus-mime-security-run-function (function)
7740   "Run FUNCTION with the security part under point."
7741   (gnus-article-check-buffer)
7742   (let ((data (get-text-property (point) 'gnus-data))
7743         buffer handle)
7744     (when (and (stringp (car-safe data))
7745                (setq buffer (mm-handle-multipart-original-buffer data))
7746                (setq handle (cadr data)))
7747       (if (bufferp (mm-handle-buffer handle))
7748           (progn
7749             (setq handle (cons buffer (copy-sequence (cdr handle))))
7750             (mm-handle-set-undisplayer handle nil))
7751         (setq handle (mm-make-handle
7752                       buffer
7753                       (mm-handle-multipart-ctl-parameter handle 'protocol)
7754                       nil nil nil nil nil nil)))
7755       (funcall function handle))))
7756
7757 (defun gnus-mime-security-save-part ()
7758   "Save the security part under point."
7759   (interactive)
7760   (gnus-mime-security-run-function 'mm-save-part))
7761
7762 (defun gnus-mime-security-pipe-part ()
7763   "Pipe the security part under point to a process."
7764   (interactive)
7765   (gnus-mime-security-run-function 'mm-pipe-part))
7766
7767 (gnus-ems-redefine)
7768
7769 (provide 'gnus-art)
7770
7771 (run-hooks 'gnus-art-load-hook)
7772
7773 ;;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
7774 ;;; gnus-art.el ends here