2006-05-23 Michael Cadilhac <michael.cadilhac@lrde.org>
[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 (defun gnus-article-browse-html-article ()
2712   "View \"text/html\" parts of the current article with a WWW browser."
2713   (interactive)
2714   (save-window-excursion
2715     ;; Open raw article and select the buffer
2716     (gnus-summary-show-article t)
2717     (gnus-summary-select-article-buffer)
2718     (let ((parts (mm-dissect-buffer t t)))
2719       ;; If singlepart, enforce a list.
2720       (when (and (bufferp (car parts))
2721                  (stringp (car (mm-handle-type parts))))
2722         (setq parts (list parts)))
2723       ;; Process the list
2724       (unless (gnus-article-browse-html-parts parts)
2725         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
2726       (gnus-summary-show-article))))
2727
2728 (defun article-hide-list-identifiers ()
2729   "Remove list identifies from the Subject header.
2730 The `gnus-list-identifiers' variable specifies what to do."
2731   (interactive)
2732   (let ((inhibit-point-motion-hooks t)
2733         (regexp (if (consp gnus-list-identifiers)
2734                     (mapconcat 'identity gnus-list-identifiers " *\\|")
2735                   gnus-list-identifiers))
2736         (inhibit-read-only t))
2737     (when regexp
2738       (save-excursion
2739         (save-restriction
2740           (article-narrow-to-head)
2741           (goto-char (point-min))
2742           (while (re-search-forward
2743                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
2744                   nil t)
2745             (delete-region (match-beginning 2) (match-end 0))
2746             (beginning-of-line))
2747           (when (re-search-forward
2748                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
2749             (delete-region (match-beginning 1) (match-end 1))))))))
2750
2751 (defun article-hide-pem (&optional arg)
2752   "Toggle hiding of any PEM headers and signatures in the current article.
2753 If given a negative prefix, always show; if given a positive prefix,
2754 always hide."
2755   (interactive (gnus-article-hidden-arg))
2756   (unless (gnus-article-check-hidden-text 'pem arg)
2757     (save-excursion
2758       (let ((inhibit-read-only t) end)
2759         (goto-char (point-min))
2760         ;; Hide the horrendously ugly "header".
2761         (when (and (search-forward
2762                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
2763                     nil t)
2764                    (setq end (1+ (match-beginning 0))))
2765           (gnus-add-wash-type 'pem)
2766           (gnus-article-hide-text-type
2767            end
2768            (if (search-forward "\n\n" nil t)
2769                (match-end 0)
2770              (point-max))
2771            'pem)
2772           ;; Hide the trailer as well
2773           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
2774                                 nil t)
2775             (gnus-article-hide-text-type
2776              (match-beginning 0) (match-end 0) 'pem)))))))
2777
2778 (defun article-strip-banner ()
2779   "Strip the banners specified by the `banner' group parameter and by
2780 `gnus-article-address-banner-alist'."
2781   (interactive)
2782   (save-excursion
2783     (save-restriction
2784       (let ((inhibit-point-motion-hooks t))
2785         (when (gnus-parameter-banner gnus-newsgroup-name)
2786           (article-really-strip-banner
2787            (gnus-parameter-banner gnus-newsgroup-name)))
2788         (when gnus-article-address-banner-alist
2789           ;; Note that the From header is decoded here, so it is
2790           ;; required that the *-extract-address-components function
2791           ;; supports non-ASCII text.
2792           (let ((from (save-restriction
2793                         (widen)
2794                         (article-narrow-to-head)
2795                         (mail-fetch-field "from"))))
2796             (when (and from
2797                        (setq from
2798                              (cadr (funcall gnus-extract-address-components
2799                                             from))))
2800               (catch 'found
2801                 (dolist (pair gnus-article-address-banner-alist)
2802                   (when (string-match (car pair) from)
2803                     (throw 'found
2804                            (article-really-strip-banner (cdr pair)))))))))))))
2805
2806 (defun article-really-strip-banner (banner)
2807   "Strip the banner specified by the argument."
2808   (save-excursion
2809     (save-restriction
2810       (let ((inhibit-point-motion-hooks t)
2811             (gnus-signature-limit nil)
2812             (inhibit-read-only t))
2813         (article-goto-body)
2814         (cond
2815          ((eq banner 'signature)
2816           (when (gnus-article-narrow-to-signature)
2817             (widen)
2818             (forward-line -1)
2819             (delete-region (point) (point-max))))
2820          ((symbolp banner)
2821           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
2822               (while (re-search-forward banner nil t)
2823                 (delete-region (match-beginning 0) (match-end 0)))))
2824          ((stringp banner)
2825           (while (re-search-forward banner nil t)
2826             (delete-region (match-beginning 0) (match-end 0)))))))))
2827
2828 (defun article-babel ()
2829   "Translate article using an online translation service."
2830   (interactive)
2831   (require 'babel)
2832   (gnus-with-article-buffer
2833     (when (article-goto-body)
2834       (let* ((start (point))
2835              (end (point-max))
2836              (orig (buffer-substring start end))
2837              (trans (babel-as-string orig)))
2838         (save-restriction
2839           (narrow-to-region start end)
2840           (delete-region start end)
2841           (insert trans))))))
2842
2843 (defun article-hide-signature (&optional arg)
2844   "Hide the signature in the current article.
2845 If given a negative prefix, always show; if given a positive prefix,
2846 always hide."
2847   (interactive (gnus-article-hidden-arg))
2848   (unless (gnus-article-check-hidden-text 'signature arg)
2849     (save-excursion
2850       (save-restriction
2851         (let ((inhibit-read-only t))
2852           (when (gnus-article-narrow-to-signature)
2853             (gnus-article-hide-text-type
2854              (point-min) (point-max) 'signature))))))
2855   (gnus-set-mode-line 'article))
2856
2857 (defun article-strip-headers-in-body ()
2858   "Strip offensive headers from bodies."
2859   (interactive)
2860   (save-excursion
2861     (article-goto-body)
2862     (let ((case-fold-search t))
2863       (when (looking-at "x-no-archive:")
2864         (gnus-delete-line)))))
2865
2866 (defun article-strip-leading-blank-lines ()
2867   "Remove all blank lines from the beginning of the article."
2868   (interactive)
2869   (save-excursion
2870     (let ((inhibit-point-motion-hooks t)
2871           (inhibit-read-only t))
2872       (when (article-goto-body)
2873         (while (and (not (eobp))
2874                     (looking-at "[ \t]*$"))
2875           (gnus-delete-line))))))
2876
2877 (defun article-narrow-to-head ()
2878   "Narrow the buffer to the head of the message.
2879 Point is left at the beginning of the narrowed-to region."
2880   (narrow-to-region
2881    (goto-char (point-min))
2882    (if (search-forward "\n\n" nil 1)
2883        (1- (point))
2884      (point-max)))
2885   (goto-char (point-min)))
2886
2887 (defun article-goto-body ()
2888   "Place point at the start of the body."
2889   (goto-char (point-min))
2890   (cond
2891    ;; This variable is only bound when dealing with separate
2892    ;; MIME body parts.
2893    (article-goto-body-goes-to-point-min-p
2894     t)
2895    ((search-forward "\n\n" nil t)
2896     t)
2897    (t
2898     (goto-char (point-max))
2899     nil)))
2900
2901 (defun article-strip-multiple-blank-lines ()
2902   "Replace consecutive blank lines with one empty line."
2903   (interactive)
2904   (save-excursion
2905     (let ((inhibit-point-motion-hooks t)
2906           (inhibit-read-only t))
2907       ;; First make all blank lines empty.
2908       (article-goto-body)
2909       (while (re-search-forward "^[ \t]+$" nil t)
2910         (unless (gnus-annotation-in-region-p
2911                  (match-beginning 0) (match-end 0))
2912           (replace-match "" nil t)))
2913       ;; Then replace multiple empty lines with a single empty line.
2914       (article-goto-body)
2915       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
2916         (unless (gnus-annotation-in-region-p
2917                  (match-beginning 0) (match-end 0))
2918           (delete-region (match-beginning 1) (match-end 1)))))))
2919
2920 (defun article-strip-leading-space ()
2921   "Remove all white space from the beginning of the lines in the article."
2922   (interactive)
2923   (save-excursion
2924     (let ((inhibit-point-motion-hooks t)
2925           (inhibit-read-only t))
2926       (article-goto-body)
2927       (while (re-search-forward "^[ \t]+" nil t)
2928         (replace-match "" t t)))))
2929
2930 (defun article-strip-trailing-space ()
2931   "Remove all white space from the end of the lines in the article."
2932   (interactive)
2933   (save-excursion
2934     (let ((inhibit-point-motion-hooks t)
2935           (inhibit-read-only t))
2936       (article-goto-body)
2937       (while (re-search-forward "[ \t]+$" nil t)
2938         (replace-match "" t t)))))
2939
2940 (defun article-strip-blank-lines ()
2941   "Strip leading, trailing and multiple blank lines."
2942   (interactive)
2943   (article-strip-leading-blank-lines)
2944   (article-remove-trailing-blank-lines)
2945   (article-strip-multiple-blank-lines))
2946
2947 (defun article-strip-all-blank-lines ()
2948   "Strip all blank lines."
2949   (interactive)
2950   (save-excursion
2951     (let ((inhibit-point-motion-hooks t)
2952           (inhibit-read-only t))
2953       (article-goto-body)
2954       (while (re-search-forward "^[ \t]*\n" nil t)
2955         (replace-match "" t t)))))
2956
2957 (defun gnus-article-narrow-to-signature ()
2958   "Narrow to the signature; return t if a signature is found, else nil."
2959   (let ((inhibit-point-motion-hooks t))
2960     (when (gnus-article-search-signature)
2961       (forward-line 1)
2962       ;; Check whether we have some limits to what we consider
2963       ;; to be a signature.
2964       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
2965                       (list gnus-signature-limit)))
2966             limit limited)
2967         (while (setq limit (pop limits))
2968           (if (or (and (integerp limit)
2969                        (< (- (point-max) (point)) limit))
2970                   (and (floatp limit)
2971                        (< (count-lines (point) (point-max)) limit))
2972                   (and (functionp limit)
2973                        (funcall limit))
2974                   (and (stringp limit)
2975                        (not (re-search-forward limit nil t))))
2976               ()                        ; This limit did not succeed.
2977             (setq limited t
2978                   limits nil)))
2979         (unless limited
2980           (narrow-to-region (point) (point-max))
2981           t)))))
2982
2983 (defun gnus-article-search-signature ()
2984   "Search the current buffer for the signature separator.
2985 Put point at the beginning of the signature separator."
2986   (let ((cur (point)))
2987     (goto-char (point-max))
2988     (if (if (stringp gnus-signature-separator)
2989             (re-search-backward gnus-signature-separator nil t)
2990           (let ((seps gnus-signature-separator))
2991             (while (and seps
2992                         (not (re-search-backward (car seps) nil t)))
2993               (pop seps))
2994             seps))
2995         t
2996       (goto-char cur)
2997       nil)))
2998
2999 (defun gnus-article-hidden-arg ()
3000   "Return the current prefix arg as a number, or 0 if no prefix."
3001   (list (if current-prefix-arg
3002             (prefix-numeric-value current-prefix-arg)
3003           0)))
3004
3005 (defun gnus-article-check-hidden-text (type arg)
3006   "Return nil if hiding is necessary.
3007 Arg can be nil or a number.  nil and positive means hide, negative
3008 means show, 0 means toggle."
3009   (save-excursion
3010     (save-restriction
3011       (let ((hide (gnus-article-hidden-text-p type)))
3012         (cond
3013          ((or (null arg)
3014               (> arg 0))
3015           nil)
3016          ((< arg 0)
3017           (gnus-article-show-hidden-text type)
3018           t)
3019          (t
3020           (if (eq hide 'hidden)
3021               (progn
3022                 (gnus-article-show-hidden-text type)
3023                 t)
3024             nil)))))))
3025
3026 (defun gnus-article-hidden-text-p (type)
3027   "Say whether the current buffer contains hidden text of type TYPE."
3028   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3029     (while (and pos
3030                 (not (get-text-property pos 'invisible))
3031                 (not (get-text-property pos 'dummy-invisible)))
3032       (setq pos
3033             (text-property-any (1+ pos) (point-max) 'article-type type)))
3034     (if pos
3035         'hidden
3036       nil)))
3037
3038 (defun gnus-article-show-hidden-text (type &optional dummy)
3039   "Show all hidden text of type TYPE.
3040 Originally it is hide instead of DUMMY."
3041   (let ((inhibit-read-only t)
3042         (inhibit-point-motion-hooks t))
3043     (gnus-remove-text-properties-when
3044      'article-type type
3045      (point-min) (point-max)
3046      (cons 'article-type (cons type
3047                                gnus-hidden-properties)))
3048     (gnus-delete-wash-type type)))
3049
3050 (defconst article-time-units
3051   `((year . ,(* 365.25 24 60 60))
3052     (week . ,(* 7 24 60 60))
3053     (day . ,(* 24 60 60))
3054     (hour . ,(* 60 60))
3055     (minute . 60)
3056     (second . 1))
3057   "Mapping from time units to seconds.")
3058
3059 (defun gnus-article-forward-header ()
3060   "Move point to the start of the next header.
3061 If the current header is a continuation header, this can be several
3062 lines forward."
3063   (let ((ended nil))
3064     (while (not ended)
3065       (forward-line 1)
3066       (if (looking-at "[ \t]+[^ \t]")
3067           (forward-line 1)
3068         (setq ended t)))))
3069
3070 (defun article-date-ut (&optional type highlight)
3071   "Convert DATE date to universal time in the current article.
3072 If TYPE is `local', convert to local time; if it is `lapsed', output
3073 how much time has lapsed since DATE.  For `lapsed', the value of
3074 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3075 should replace the \"Date:\" one, or should be added below it."
3076   (interactive (list 'ut t))
3077   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3078          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3079                              tdate-regexp)
3080                             ((eq type 'lapsed)
3081                              "^X-Sent:[ \t]")
3082                             (article-lapsed-timer
3083                              "^Date:[ \t]")
3084                             (t
3085                              tdate-regexp)))
3086          (case-fold-search t)
3087          (inhibit-read-only t)
3088          (inhibit-point-motion-hooks t)
3089          pos date bface eface)
3090     (save-excursion
3091       (save-restriction
3092         (widen)
3093         (goto-char (point-min))
3094         (while (or (setq date (get-text-property (setq pos (point))
3095                                                  'original-date))
3096                    (when (setq pos (next-single-property-change
3097                                     (point) 'original-date))
3098                      (setq date (get-text-property pos 'original-date))
3099                      t))
3100           (narrow-to-region pos (or (text-property-any pos (point-max)
3101                                                        'original-date nil)
3102                                     (point-max)))
3103           (goto-char (point-min))
3104           (when (re-search-forward tdate-regexp nil t)
3105             (setq bface (get-text-property (point-at-bol) 'face)
3106                   eface (get-text-property (1- (point-at-eol)) 'face)))
3107           (goto-char (point-min))
3108           (setq pos nil)
3109           ;; Delete any old Date headers.
3110           (while (re-search-forward date-regexp nil t)
3111             (if pos
3112                 (delete-region (point-at-bol) (progn
3113                                                 (gnus-article-forward-header)
3114                                                 (point)))
3115               (delete-region (point-at-bol) (progn
3116                                               (gnus-article-forward-header)
3117                                               (forward-char -1)
3118                                               (point)))
3119               (setq pos (point))))
3120           (when (and (not pos)
3121                      (re-search-forward tdate-regexp nil t))
3122             (forward-line 1))
3123           (gnus-goto-char pos)
3124           (insert (article-make-date-line date (or type 'ut)))
3125           (unless pos
3126             (insert "\n")
3127             (forward-line -1))
3128           ;; Do highlighting.
3129           (beginning-of-line)
3130           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3131             (put-text-property (match-beginning 1) (1+ (match-end 1))
3132                                'face bface)
3133             (put-text-property (match-beginning 2) (match-end 2)
3134                                'face eface))
3135           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3136           (goto-char (point-max))
3137           (widen))))))
3138
3139 (defun article-make-date-line (date type)
3140   "Return a DATE line of TYPE."
3141   (unless (memq type '(local ut original user iso8601 lapsed english))
3142     (error "Unknown conversion type: %s" type))
3143   (condition-case ()
3144       (let ((time (date-to-time date)))
3145         (cond
3146          ;; Convert to the local timezone.
3147          ((eq type 'local)
3148           (concat "Date: " (message-make-date time)))
3149          ;; Convert to Universal Time.
3150          ((eq type 'ut)
3151           (concat "Date: "
3152                   (substring
3153                    (message-make-date
3154                     (let* ((e (parse-time-string date))
3155                            (tm (apply 'encode-time e))
3156                            (ms (car tm))
3157                            (ls (- (cadr tm) (car (current-time-zone time)))))
3158                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3159                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3160                             (t (list ms ls)))))
3161                    0 -5)
3162                   "UT"))
3163          ;; Get the original date from the article.
3164          ((eq type 'original)
3165           (concat "Date: " (if (string-match "\n+$" date)
3166                                (substring date 0 (match-beginning 0))
3167                              date)))
3168          ;; Let the user define the format.
3169          ((eq type 'user)
3170           (let ((format (or (condition-case nil
3171                                 (with-current-buffer gnus-summary-buffer
3172                                   gnus-article-time-format)
3173                               (error nil))
3174                             gnus-article-time-format)))
3175             (if (functionp format)
3176                 (funcall format time)
3177               (concat "Date: " (format-time-string format time)))))
3178          ;; ISO 8601.
3179          ((eq type 'iso8601)
3180           (let ((tz (car (current-time-zone time))))
3181             (concat
3182              "Date: "
3183              (format-time-string "%Y%m%dT%H%M%S" time)
3184              (format "%s%02d%02d"
3185                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3186                      (/ (% (abs tz) 3600) 60)))))
3187          ;; Do an X-Sent lapsed format.
3188          ((eq type 'lapsed)
3189           ;; If the date is seriously mangled, the timezone functions are
3190           ;; liable to bug out, so we ignore all errors.
3191           (let* ((now (current-time))
3192                  (real-time (subtract-time now time))
3193                  (real-sec (and real-time
3194                                 (+ (* (float (car real-time)) 65536)
3195                                    (cadr real-time))))
3196                  (sec (and real-time (abs real-sec)))
3197                  num prev)
3198             (cond
3199              ((null real-time)
3200               "X-Sent: Unknown")
3201              ((zerop sec)
3202               "X-Sent: Now")
3203              (t
3204               (concat
3205                "X-Sent: "
3206                ;; This is a bit convoluted, but basically we go
3207                ;; through the time units for years, weeks, etc,
3208                ;; and divide things to see whether that results
3209                ;; in positive answers.
3210                (mapconcat
3211                 (lambda (unit)
3212                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3213                       ;; The (remaining) seconds are too few to
3214                       ;; be divided into this time unit.
3215                       ""
3216                     ;; It's big enough, so we output it.
3217                     (setq sec (- sec (* num (cdr unit))))
3218                     (prog1
3219                         (concat (if prev ", " "") (int-to-string
3220                                                    (floor num))
3221                                 " " (symbol-name (car unit))
3222                                 (if (> num 1) "s" ""))
3223                       (setq prev t))))
3224                 article-time-units "")
3225                ;; If dates are odd, then it might appear like the
3226                ;; article was sent in the future.
3227                (if (> real-sec 0)
3228                    " ago"
3229                  " in the future"))))))
3230          ;; Display the date in proper English
3231          ((eq type 'english)
3232           (let ((dtime (decode-time time)))
3233             (concat
3234              "Date: the "
3235              (number-to-string (nth 3 dtime))
3236              (let ((digit (% (nth 3 dtime) 10)))
3237                (cond
3238                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3239                 ((= digit 1) "st")
3240                 ((= digit 2) "nd")
3241                 ((= digit 3) "rd")
3242                 (t "th")))
3243              " of "
3244              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3245              " "
3246              (number-to-string (nth 5 dtime))
3247              " at "
3248              (format "%02d" (nth 2 dtime))
3249              ":"
3250              (format "%02d" (nth 1 dtime)))))))
3251     (error
3252      (format "Date: %s (from Gnus)" date))))
3253
3254 (defun article-date-local (&optional highlight)
3255   "Convert the current article date to the local timezone."
3256   (interactive (list t))
3257   (article-date-ut 'local highlight))
3258
3259 (defun article-date-english (&optional highlight)
3260   "Convert the current article date to something that is proper English."
3261   (interactive (list t))
3262   (article-date-ut 'english highlight))
3263
3264 (defun article-date-original (&optional highlight)
3265   "Convert the current article date to what it was originally.
3266 This is only useful if you have used some other date conversion
3267 function and want to see what the date was before converting."
3268   (interactive (list t))
3269   (article-date-ut 'original highlight))
3270
3271 (defun article-date-lapsed (&optional highlight)
3272   "Convert the current article date to time lapsed since it was sent."
3273   (interactive (list t))
3274   (article-date-ut 'lapsed highlight))
3275
3276 (defun article-update-date-lapsed ()
3277   "Function to be run from a timer to update the lapsed time line."
3278   (save-match-data
3279     (let (deactivate-mark)
3280       (save-excursion
3281         (ignore-errors
3282          (walk-windows
3283           (lambda (w)
3284             (set-buffer (window-buffer w))
3285             (when (eq major-mode 'gnus-article-mode)
3286               (let ((mark (point-marker)))
3287                 (goto-char (point-min))
3288                 (when (re-search-forward "^X-Sent:" nil t)
3289                   (article-date-lapsed t))
3290                 (goto-char (marker-position mark))
3291                 (move-marker mark nil))))
3292           nil 'visible))))))
3293
3294 (defun gnus-start-date-timer (&optional n)
3295   "Start a timer to update the X-Sent header in the article buffers.
3296 The numerical prefix says how frequently (in seconds) the function
3297 is to run."
3298   (interactive "p")
3299   (unless n
3300     (setq n 1))
3301   (gnus-stop-date-timer)
3302   (setq article-lapsed-timer
3303         (run-at-time 1 n 'article-update-date-lapsed)))
3304
3305 (defun gnus-stop-date-timer ()
3306   "Stop the X-Sent timer."
3307   (interactive)
3308   (when article-lapsed-timer
3309     (nnheader-cancel-timer article-lapsed-timer)
3310     (setq article-lapsed-timer nil)))
3311
3312 (defun article-date-user (&optional highlight)
3313   "Convert the current article date to the user-defined format.
3314 This format is defined by the `gnus-article-time-format' variable."
3315   (interactive (list t))
3316   (article-date-ut 'user highlight))
3317
3318 (defun article-date-iso8601 (&optional highlight)
3319   "Convert the current article date to ISO8601."
3320   (interactive (list t))
3321   (article-date-ut 'iso8601 highlight))
3322
3323 (defmacro gnus-article-save-original-date (&rest forms)
3324   "Save the original date as a text property and evaluate FORMS."
3325   `(let* ((case-fold-search t)
3326           (start (progn
3327                    (goto-char (point-min))
3328                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3329                               (not (bolp)))
3330                      (match-end 0))))
3331           (date (when (and start
3332                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3333                                               nil t))
3334                   (buffer-substring-no-properties start
3335                                                   (match-beginning 0)))))
3336      (goto-char (point-max))
3337      (skip-chars-backward "\n")
3338      (put-text-property (point-min) (point) 'original-date date)
3339      ,@forms
3340      (goto-char (point-max))
3341      (skip-chars-backward "\n")
3342      (put-text-property (point-min) (point) 'original-date date)))
3343
3344 ;; (defun article-show-all ()
3345 ;;   "Show all hidden text in the article buffer."
3346 ;;   (interactive)
3347 ;;   (save-excursion
3348 ;;     (let ((inhibit-read-only t))
3349 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3350
3351 (defun article-remove-leading-whitespace ()
3352   "Remove excessive whitespace from all headers."
3353   (interactive)
3354   (save-excursion
3355     (save-restriction
3356       (let ((inhibit-read-only t))
3357         (article-narrow-to-head)
3358         (goto-char (point-min))
3359         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3360           (delete-region (match-beginning 1) (match-end 1)))))))
3361
3362 (defun article-emphasize (&optional arg)
3363   "Emphasize text according to `gnus-emphasis-alist'."
3364   (interactive (gnus-article-hidden-arg))
3365   (unless (gnus-article-check-hidden-text 'emphasis arg)
3366     (save-excursion
3367       (let ((alist (or
3368                     (condition-case nil
3369                         (with-current-buffer gnus-summary-buffer
3370                           gnus-article-emphasis-alist)
3371                       (error))
3372                     gnus-emphasis-alist))
3373             (inhibit-read-only t)
3374             (props (append '(article-type emphasis)
3375                            gnus-hidden-properties))
3376             regexp elem beg invisible visible face)
3377         (article-goto-body)
3378         (setq beg (point))
3379         (while (setq elem (pop alist))
3380           (goto-char beg)
3381           (setq regexp (car elem)
3382                 invisible (nth 1 elem)
3383                 visible (nth 2 elem)
3384                 face (nth 3 elem))
3385           (while (re-search-forward regexp nil t)
3386             (when (and (match-beginning visible) (match-beginning invisible))
3387               (gnus-article-hide-text
3388                (match-beginning invisible) (match-end invisible) props)
3389               (gnus-article-unhide-text-type
3390                (match-beginning visible) (match-end visible) 'emphasis)
3391               (gnus-put-overlay-excluding-newlines
3392                (match-beginning visible) (match-end visible) 'face face)
3393               (gnus-add-wash-type 'emphasis)
3394               (goto-char (match-end invisible)))))))))
3395
3396 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3397   "Setup newsgroup emphasis alist."
3398   (unless gnus-article-emphasis-alist
3399     (let ((name (and gnus-newsgroup-name
3400                      (gnus-group-real-name gnus-newsgroup-name))))
3401       (make-local-variable 'gnus-article-emphasis-alist)
3402       (setq gnus-article-emphasis-alist
3403             (nconc
3404              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3405                (while (setq elem (pop alist))
3406                  (when (and name (string-match (car elem) name))
3407                    (setq alist nil
3408                          highlight (copy-sequence (cdr elem)))))
3409                highlight)
3410              (copy-sequence highlight-words)
3411              (if gnus-newsgroup-name
3412                  (copy-sequence (gnus-group-find-parameter
3413                                  gnus-newsgroup-name 'highlight-words t)))
3414              gnus-emphasis-alist)))))
3415
3416 (eval-when-compile
3417   (defvar gnus-summary-article-menu)
3418   (defvar gnus-summary-post-menu))
3419
3420 ;;; Saving functions.
3421
3422 (defun gnus-article-save (save-buffer file &optional num)
3423   "Save the currently selected article."
3424   (unless gnus-save-all-headers
3425     ;; Remove headers according to `gnus-saved-headers'.
3426     (let ((gnus-visible-headers
3427            (or gnus-saved-headers gnus-visible-headers))
3428           (gnus-article-buffer save-buffer))
3429       (save-excursion
3430         (set-buffer save-buffer)
3431         (article-hide-headers 1 t))))
3432   (save-window-excursion
3433     (if (not gnus-default-article-saver)
3434         (error "No default saver is defined")
3435       ;; !!! Magic!  The saving functions all save
3436       ;; `gnus-save-article-buffer' (or so they think), but we
3437       ;; bind that variable to our save-buffer.
3438       (set-buffer gnus-article-buffer)
3439       (let* ((gnus-save-article-buffer save-buffer)
3440              (filename
3441               (cond
3442                ((not gnus-prompt-before-saving) 'default)
3443                ((eq gnus-prompt-before-saving 'always) nil)
3444                (t file)))
3445              (gnus-number-of-articles-to-be-saved
3446               (when (eq gnus-prompt-before-saving t)
3447                 num)))                  ; Magic
3448         (set-buffer gnus-article-current-summary)
3449         (funcall gnus-default-article-saver filename)))))
3450
3451 (defun gnus-read-save-file-name (prompt &optional filename
3452                                         function group headers variable)
3453   (let ((default-name
3454           (funcall function group headers (symbol-value variable)))
3455         result)
3456     (setq result
3457           (expand-file-name
3458            (cond
3459             ((eq filename 'default)
3460              default-name)
3461             ((eq filename t)
3462              default-name)
3463             (filename filename)
3464             (t
3465              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3466                     (prompt
3467                      (format prompt
3468                              (if (and gnus-number-of-articles-to-be-saved
3469                                       (> gnus-number-of-articles-to-be-saved 1))
3470                                  (format "these %d articles"
3471                                          gnus-number-of-articles-to-be-saved)
3472                                "this article")))
3473                     (file
3474                      ;; Let the split methods have their say.
3475                      (cond
3476                       ;; No split name was found.
3477                       ((null split-name)
3478                        (read-file-name
3479                         (concat prompt " (default "
3480                                 (file-name-nondirectory default-name) "): ")
3481                         (file-name-directory default-name)
3482                         default-name))
3483                       ;; A single group name is returned.
3484                       ((stringp split-name)
3485                        (setq default-name
3486                              (funcall function split-name headers
3487                                       (symbol-value variable)))
3488                        (read-file-name
3489                         (concat prompt " (default "
3490                                 (file-name-nondirectory default-name) "): ")
3491                         (file-name-directory default-name)
3492                         default-name))
3493                       ;; A single split name was found
3494                       ((= 1 (length split-name))
3495                        (let* ((name (expand-file-name
3496                                      (car split-name)
3497                                      gnus-article-save-directory))
3498                               (dir (cond ((file-directory-p name)
3499                                           (file-name-as-directory name))
3500                                          ((file-exists-p name) name)
3501                                          (t gnus-article-save-directory))))
3502                          (read-file-name
3503                           (concat prompt " (default " name "): ")
3504                           dir name)))
3505                       ;; A list of splits was found.
3506                       (t
3507                        (setq split-name (nreverse split-name))
3508                        (let (result)
3509                          (let ((file-name-history
3510                                 (nconc split-name file-name-history)))
3511                            (setq result
3512                                  (expand-file-name
3513                                   (read-file-name
3514                                    (concat prompt " (`M-p' for defaults): ")
3515                                    gnus-article-save-directory
3516                                    (car split-name))
3517                                   gnus-article-save-directory)))
3518                          (car (push result file-name-history)))))))
3519                ;; Create the directory.
3520                (gnus-make-directory (file-name-directory file))
3521                ;; If we have read a directory, we append the default file name.
3522                (when (file-directory-p file)
3523                  (setq file (expand-file-name (file-name-nondirectory
3524                                                default-name)
3525                                               (file-name-as-directory file))))
3526                ;; Possibly translate some characters.
3527                (nnheader-translate-file-chars file))))))
3528     (gnus-make-directory (file-name-directory result))
3529     (set variable result)))
3530
3531 (defun gnus-article-archive-name (group)
3532   "Return the first instance of an \"Archive-name\" in the current buffer."
3533   (let ((case-fold-search t))
3534     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3535       (nnheader-concat gnus-article-save-directory
3536                        (match-string 1)))))
3537
3538 (defun gnus-article-nndoc-name (group)
3539   "If GROUP is an nndoc group, return the name of the parent group."
3540   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3541     (gnus-group-get-parameter group 'save-article-group)))
3542
3543 (defun gnus-summary-save-in-rmail (&optional filename)
3544   "Append this article to Rmail file.
3545 Optional argument FILENAME specifies file name.
3546 Directory to save to is default to `gnus-article-save-directory'."
3547   (setq filename (gnus-read-save-file-name
3548                   "Save %s in rmail file" filename
3549                   gnus-rmail-save-name gnus-newsgroup-name
3550                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3551   (gnus-eval-in-buffer-window gnus-save-article-buffer
3552     (save-excursion
3553       (save-restriction
3554         (widen)
3555         (gnus-output-to-rmail filename))))
3556   filename)
3557
3558 (defun gnus-summary-save-in-mail (&optional filename)
3559   "Append this article to Unix mail file.
3560 Optional argument FILENAME specifies file name.
3561 Directory to save to is default to `gnus-article-save-directory'."
3562   (setq filename (gnus-read-save-file-name
3563                   "Save %s in Unix mail file" filename
3564                   gnus-mail-save-name gnus-newsgroup-name
3565                   gnus-current-headers 'gnus-newsgroup-last-mail))
3566   (gnus-eval-in-buffer-window gnus-save-article-buffer
3567     (save-excursion
3568       (save-restriction
3569         (widen)
3570         (if (and (file-readable-p filename)
3571                  (file-regular-p filename)
3572                  (mail-file-babyl-p filename))
3573             (rmail-output-to-rmail-file filename t)
3574           (gnus-output-to-mail filename)))))
3575   filename)
3576
3577 (defun gnus-summary-save-in-file (&optional filename overwrite)
3578   "Append this article to file.
3579 Optional argument FILENAME specifies file name.
3580 Directory to save to is default to `gnus-article-save-directory'."
3581   (setq filename (gnus-read-save-file-name
3582                   "Save %s in file" filename
3583                   gnus-file-save-name gnus-newsgroup-name
3584                   gnus-current-headers 'gnus-newsgroup-last-file))
3585   (gnus-eval-in-buffer-window gnus-save-article-buffer
3586     (save-excursion
3587       (save-restriction
3588         (widen)
3589         (when (and overwrite
3590                    (file-exists-p filename))
3591           (delete-file filename))
3592         (gnus-output-to-file filename))))
3593   filename)
3594
3595 (defun gnus-summary-write-to-file (&optional filename)
3596   "Write this article to a file, overwriting it if the file exists.
3597 Optional argument FILENAME specifies file name.
3598 The directory to save in defaults to `gnus-article-save-directory'."
3599   (gnus-summary-save-in-file nil t))
3600
3601 (defun gnus-summary-save-body-in-file (&optional filename)
3602   "Append this article body to a file.
3603 Optional argument FILENAME specifies file name.
3604 The directory to save in defaults to `gnus-article-save-directory'."
3605   (setq filename (gnus-read-save-file-name
3606                   "Save %s body in file" filename
3607                   gnus-file-save-name gnus-newsgroup-name
3608                   gnus-current-headers 'gnus-newsgroup-last-file))
3609   (gnus-eval-in-buffer-window gnus-save-article-buffer
3610     (save-excursion
3611       (save-restriction
3612         (widen)
3613         (when (article-goto-body)
3614           (narrow-to-region (point) (point-max)))
3615         (gnus-output-to-file filename))))
3616   filename)
3617
3618 (defun gnus-summary-save-in-pipe (&optional command)
3619   "Pipe this article to subprocess."
3620   (setq command
3621         (cond ((and (eq command 'default)
3622                     gnus-last-shell-command)
3623                gnus-last-shell-command)
3624               ((stringp command)
3625                command)
3626               (t (read-string
3627                   (format
3628                    "Shell command on %s: "
3629                    (if (and gnus-number-of-articles-to-be-saved
3630                             (> gnus-number-of-articles-to-be-saved 1))
3631                        (format "these %d articles"
3632                                gnus-number-of-articles-to-be-saved)
3633                      "this article"))
3634                   gnus-last-shell-command))))
3635   (when (string-equal command "")
3636     (if gnus-last-shell-command
3637         (setq command gnus-last-shell-command)
3638       (error "A command is required")))
3639   (gnus-eval-in-buffer-window gnus-article-buffer
3640     (save-restriction
3641       (widen)
3642       (shell-command-on-region (point-min) (point-max) command nil)))
3643   (setq gnus-last-shell-command command))
3644
3645 (defun gnus-summary-pipe-to-muttprint (&optional command)
3646   "Pipe this article to muttprint."
3647   (setq command (read-string
3648                  "Print using command: " gnus-summary-muttprint-program
3649                  nil gnus-summary-muttprint-program))
3650   (gnus-summary-save-in-pipe command))
3651
3652 ;;; Article file names when saving.
3653
3654 (defun gnus-capitalize-newsgroup (newsgroup)
3655   "Capitalize NEWSGROUP name."
3656   (when (not (zerop (length newsgroup)))
3657     (concat (char-to-string (upcase (aref newsgroup 0)))
3658             (substring newsgroup 1))))
3659
3660 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3661   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3662 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3663 Otherwise, it is like ~/News/news/group/num."
3664   (let ((default
3665           (expand-file-name
3666            (concat (if (gnus-use-long-file-name 'not-save)
3667                        (gnus-capitalize-newsgroup newsgroup)
3668                      (gnus-newsgroup-directory-form newsgroup))
3669                    "/" (int-to-string (mail-header-number headers)))
3670            gnus-article-save-directory)))
3671     (if (and last-file
3672              (string-equal (file-name-directory default)
3673                            (file-name-directory last-file))
3674              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3675         default
3676       (or last-file default))))
3677
3678 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
3679   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3680 If variable `gnus-use-long-file-name' is non-nil, it is
3681 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
3682   (let ((default
3683           (expand-file-name
3684            (concat (if (gnus-use-long-file-name 'not-save)
3685                        newsgroup
3686                      (gnus-newsgroup-directory-form newsgroup))
3687                    "/" (int-to-string (mail-header-number headers)))
3688            gnus-article-save-directory)))
3689     (if (and last-file
3690              (string-equal (file-name-directory default)
3691                            (file-name-directory last-file))
3692              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3693         default
3694       (or last-file default))))
3695
3696 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
3697   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3698 If variable `gnus-use-long-file-name' is non-nil, it is
3699 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
3700   (or last-file
3701       (expand-file-name
3702        (if (gnus-use-long-file-name 'not-save)
3703            newsgroup
3704          (file-relative-name
3705           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
3706           default-directory))
3707        gnus-article-save-directory)))
3708
3709 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
3710   "Generate file name from sender."
3711   (let ((from (mail-header-from headers)))
3712     (expand-file-name
3713      (if (and from (string-match "\\([^ <]+\\)@" from))
3714          (match-string 1 from)
3715        "nobody")
3716      gnus-article-save-directory)))
3717
3718 (defun article-verify-x-pgp-sig ()
3719   "Verify X-PGP-Sig."
3720   (interactive)
3721   (if (gnus-buffer-live-p gnus-original-article-buffer)
3722       (let ((sig (with-current-buffer gnus-original-article-buffer
3723                    (gnus-fetch-field "X-PGP-Sig")))
3724             items info headers)
3725         (when (and sig
3726                    mml2015-use
3727                    (mml2015-clear-verify-function))
3728           (with-temp-buffer
3729             (insert-buffer-substring gnus-original-article-buffer)
3730             (setq items (split-string sig))
3731             (message-narrow-to-head)
3732             (let ((inhibit-point-motion-hooks t)
3733                   (case-fold-search t))
3734               ;; Don't verify multiple headers.
3735               (setq headers (mapconcat (lambda (header)
3736                                          (concat header ": "
3737                                                  (mail-fetch-field header)
3738                                                  "\n"))
3739                                        (split-string (nth 1 items) ",") "")))
3740             (delete-region (point-min) (point-max))
3741             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
3742             (insert "X-Signed-Headers: " (nth 1 items) "\n")
3743             (insert headers)
3744             (widen)
3745             (forward-line)
3746             (while (not (eobp))
3747               (if (looking-at "^-")
3748                   (insert "- "))
3749               (forward-line))
3750             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
3751             (insert "Version: " (car items) "\n\n")
3752             (insert (mapconcat 'identity (cddr items) "\n"))
3753             (insert "\n-----END PGP SIGNATURE-----\n")
3754             (let ((mm-security-handle (list (format "multipart/signed"))))
3755               (mml2015-clean-buffer)
3756               (let ((coding-system-for-write (or gnus-newsgroup-charset
3757                                                  'iso-8859-1)))
3758                 (funcall (mml2015-clear-verify-function)))
3759               (setq info
3760                     (or (mm-handle-multipart-ctl-parameter
3761                          mm-security-handle 'gnus-details)
3762                         (mm-handle-multipart-ctl-parameter
3763                          mm-security-handle 'gnus-info)))))
3764           (when info
3765             (let ((inhibit-read-only t) bface eface)
3766               (save-restriction
3767                 (message-narrow-to-head)
3768                 (goto-char (point-max))
3769                 (forward-line -1)
3770                 (setq bface (get-text-property (point-at-bol) 'face)
3771                       eface (get-text-property (1- (point-at-eol)) 'face))
3772                 (message-remove-header "X-Gnus-PGP-Verify")
3773                 (if (re-search-forward "^X-PGP-Sig:" nil t)
3774                     (forward-line)
3775                   (goto-char (point-max)))
3776                 (narrow-to-region (point) (point))
3777                 (insert "X-Gnus-PGP-Verify: " info "\n")
3778                 (goto-char (point-min))
3779                 (forward-line)
3780                 (while (not (eobp))
3781                   (if (not (looking-at "^[ \t]"))
3782                       (insert " "))
3783                   (forward-line))
3784                 ;; Do highlighting.
3785                 (goto-char (point-min))
3786                 (when (looking-at "\\([^:]+\\): *")
3787                   (put-text-property (match-beginning 1) (1+ (match-end 1))
3788                                      'face bface)
3789                   (put-text-property (match-end 0) (point-max)
3790                                      'face eface)))))))))
3791
3792 (defun article-verify-cancel-lock ()
3793   "Verify Cancel-Lock header."
3794   (interactive)
3795   (if (gnus-buffer-live-p gnus-original-article-buffer)
3796       (canlock-verify gnus-original-article-buffer)))
3797
3798 (eval-and-compile
3799   (mapcar
3800    (lambda (func)
3801      (let (afunc gfunc)
3802        (if (consp func)
3803            (setq afunc (car func)
3804                  gfunc (cdr func))
3805          (setq afunc func
3806                gfunc (intern (format "gnus-%s" func))))
3807        (defalias gfunc
3808          (when (fboundp afunc)
3809            `(lambda (&optional interactive &rest args)
3810               ,(documentation afunc t)
3811               (interactive (list t))
3812               (save-excursion
3813                 (set-buffer gnus-article-buffer)
3814                 (if interactive
3815                     (call-interactively ',afunc)
3816                   (apply ',afunc args))))))))
3817    '(article-hide-headers
3818      article-verify-x-pgp-sig
3819      article-verify-cancel-lock
3820      article-hide-boring-headers
3821      article-treat-overstrike
3822      article-treat-ansi-sequences
3823      article-fill-long-lines
3824      article-capitalize-sentences
3825      article-remove-cr
3826      article-remove-leading-whitespace
3827      article-display-x-face
3828      article-display-face
3829      article-de-quoted-unreadable
3830      article-de-base64-unreadable
3831      article-decode-HZ
3832      article-wash-html
3833      article-unsplit-urls
3834      article-hide-list-identifiers
3835      article-strip-banner
3836      article-babel
3837      article-hide-pem
3838      article-hide-signature
3839      article-strip-headers-in-body
3840      article-remove-trailing-blank-lines
3841      article-strip-leading-blank-lines
3842      article-strip-multiple-blank-lines
3843      article-strip-leading-space
3844      article-strip-trailing-space
3845      article-strip-blank-lines
3846      article-strip-all-blank-lines
3847      article-date-local
3848      article-date-english
3849      article-date-iso8601
3850      article-date-original
3851      article-date-ut
3852      article-decode-mime-words
3853      article-decode-charset
3854      article-decode-encoded-words
3855      article-date-user
3856      article-date-lapsed
3857      article-emphasize
3858      article-treat-dumbquotes
3859      article-normalize-headers
3860 ;;     (article-show-all . gnus-article-show-all-headers)
3861      )))
3862 \f
3863 ;;;
3864 ;;; Gnus article mode
3865 ;;;
3866
3867 (put 'gnus-article-mode 'mode-class 'special)
3868
3869 (set-keymap-parent gnus-article-mode-map widget-keymap)
3870
3871 (gnus-define-keys gnus-article-mode-map
3872   " " gnus-article-goto-next-page
3873   "\177" gnus-article-goto-prev-page
3874   [delete] gnus-article-goto-prev-page
3875   [backspace] gnus-article-goto-prev-page
3876   "\C-c^" gnus-article-refer-article
3877   "h" gnus-article-show-summary
3878   "s" gnus-article-show-summary
3879   "\C-c\C-m" gnus-article-mail
3880   "?" gnus-article-describe-briefly
3881   "e" gnus-summary-edit-article
3882   "<" beginning-of-buffer
3883   ">" end-of-buffer
3884   "\C-c\C-i" gnus-info-find-node
3885   "\C-c\C-b" gnus-bug
3886   "R" gnus-article-reply-with-original
3887   "F" gnus-article-followup-with-original
3888   "\C-hk" gnus-article-describe-key
3889   "\C-hc" gnus-article-describe-key-briefly
3890
3891   "\C-d" gnus-article-read-summary-keys
3892   "\M-*" gnus-article-read-summary-keys
3893   "\M-#" gnus-article-read-summary-keys
3894   "\M-^" gnus-article-read-summary-keys
3895   "\M-g" gnus-article-read-summary-keys)
3896
3897 (substitute-key-definition
3898  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
3899
3900 (defun gnus-article-make-menu-bar ()
3901   (unless (boundp 'gnus-article-commands-menu)
3902     (gnus-summary-make-menu-bar))
3903   (gnus-turn-off-edit-menu 'article)
3904   (unless (boundp 'gnus-article-article-menu)
3905     (easy-menu-define
3906      gnus-article-article-menu gnus-article-mode-map ""
3907      '("Article"
3908        ["Scroll forwards" gnus-article-goto-next-page t]
3909        ["Scroll backwards" gnus-article-goto-prev-page t]
3910        ["Show summary" gnus-article-show-summary t]
3911        ["Fetch Message-ID at point" gnus-article-refer-article t]
3912        ["Mail to address at point" gnus-article-mail t]
3913        ["Send a bug report" gnus-bug t]))
3914
3915     (easy-menu-define
3916      gnus-article-treatment-menu gnus-article-mode-map ""
3917      ;; Fixme: this should use :active (and maybe :visible).
3918      '("Treatment"
3919        ["Hide headers" gnus-article-hide-headers t]
3920        ["Hide signature" gnus-article-hide-signature t]
3921        ["Hide citation" gnus-article-hide-citation t]
3922        ["Treat overstrike" gnus-article-treat-overstrike t]
3923        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
3924        ["Remove carriage return" gnus-article-remove-cr t]
3925        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
3926        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
3927        ["Remove base64" gnus-article-de-base64-unreadable t]
3928        ["Treat html" gnus-article-wash-html t]
3929        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
3930        ["Decode HZ" gnus-article-decode-HZ t]))
3931
3932     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
3933
3934     ;; Note "Post" menu is defined in gnus-sum.el for consistency
3935
3936     (gnus-run-hooks 'gnus-article-menu-hook)))
3937
3938 (defun gnus-article-mode ()
3939   "Major mode for displaying an article.
3940
3941 All normal editing commands are switched off.
3942
3943 The following commands are available in addition to all summary mode
3944 commands:
3945 \\<gnus-article-mode-map>
3946 \\[gnus-article-next-page]\t Scroll the article one page forwards
3947 \\[gnus-article-prev-page]\t Scroll the article one page backwards
3948 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
3949 \\[gnus-article-show-summary]\t Display the summary buffer
3950 \\[gnus-article-mail]\t Send a reply to the address near point
3951 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
3952 \\[gnus-info-find-node]\t Go to the Gnus info node"
3953   (interactive)
3954   (kill-all-local-variables)
3955   (gnus-simplify-mode-line)
3956   (setq mode-name "Article")
3957   (setq major-mode 'gnus-article-mode)
3958   (make-local-variable 'minor-mode-alist)
3959   (use-local-map gnus-article-mode-map)
3960   (when (gnus-visual-p 'article-menu 'menu)
3961     (gnus-article-make-menu-bar)
3962     (when gnus-summary-tool-bar-map
3963       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
3964   (gnus-update-format-specifications nil 'article-mode)
3965   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
3966   (set (make-local-variable 'gnus-page-broken) nil)
3967   (make-local-variable 'gnus-button-marker-list)
3968   (make-local-variable 'gnus-article-current-summary)
3969   (make-local-variable 'gnus-article-mime-handles)
3970   (make-local-variable 'gnus-article-decoded-p)
3971   (make-local-variable 'gnus-article-mime-handle-alist)
3972   (make-local-variable 'gnus-article-wash-types)
3973   (make-local-variable 'gnus-article-image-alist)
3974   (make-local-variable 'gnus-article-charset)
3975   (make-local-variable 'gnus-article-ignored-charsets)
3976   ;; Prevent recent Emacsen from displaying non-break space as "\ ".
3977   (set (make-local-variable 'nobreak-char-display) nil)
3978   (setq cursor-in-non-selected-windows nil)
3979   (gnus-set-default-directory)
3980   (buffer-disable-undo)
3981   (setq buffer-read-only t
3982         show-trailing-whitespace nil)
3983   (set-syntax-table gnus-article-mode-syntax-table)
3984   (mm-enable-multibyte)
3985   (gnus-run-mode-hooks 'gnus-article-mode-hook))
3986
3987 (defun gnus-article-setup-buffer ()
3988   "Initialize the article buffer."
3989   (let* ((name (if gnus-single-article-buffer "*Article*"
3990                  (concat "*Article " gnus-newsgroup-name "*")))
3991          (original
3992           (progn (string-match "\\*Article" name)
3993                  (concat " *Original Article"
3994                          (substring name (match-end 0))))))
3995     (setq gnus-article-buffer name)
3996     (setq gnus-original-article-buffer original)
3997     (setq gnus-article-mime-handle-alist nil)
3998     (with-current-buffer gnus-summary-buffer
3999       ;; This might be a variable local to the summary buffer.
4000       (unless gnus-single-article-buffer
4001         (setq gnus-article-buffer name)
4002         (setq gnus-original-article-buffer original)
4003         (gnus-set-global-variables)))
4004     (gnus-article-setup-highlight-words)
4005     ;; Init original article buffer.
4006     (save-excursion
4007       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4008       (mm-enable-multibyte)
4009       (setq major-mode 'gnus-original-article-mode)
4010       (make-local-variable 'gnus-original-article))
4011     (if (and (get-buffer name)
4012              (with-current-buffer name
4013                (if gnus-article-edit-mode
4014                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4015                        (progn
4016                          (set-buffer-modified-p nil)
4017                          (gnus-kill-buffer name)
4018                          (message "")
4019                          nil)
4020                      (error "Action aborted"))
4021                  t)))
4022         (save-excursion
4023           (set-buffer name)
4024           (set (make-local-variable 'gnus-article-edit-mode) nil)
4025           (when gnus-article-mime-handles
4026             (mm-destroy-parts gnus-article-mime-handles)
4027             (setq gnus-article-mime-handles nil))
4028           ;; Set it to nil in article-buffer!
4029           (setq gnus-article-mime-handle-alist nil)
4030           (buffer-disable-undo)
4031           (setq buffer-read-only t)
4032           ;; This list just keeps growing if we don't reset it.
4033           (setq gnus-button-marker-list nil)
4034           (unless (eq major-mode 'gnus-article-mode)
4035             (gnus-article-mode))
4036           (current-buffer))
4037       (save-excursion
4038         (set-buffer (gnus-get-buffer-create name))
4039         (gnus-article-mode)
4040         (make-local-variable 'gnus-summary-buffer)
4041         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4042         (current-buffer)))))
4043
4044 ;; Set article window start at LINE, where LINE is the number of lines
4045 ;; from the head of the article.
4046 (defun gnus-article-set-window-start (&optional line)
4047   (set-window-start
4048    (gnus-get-buffer-window gnus-article-buffer t)
4049    (save-excursion
4050      (set-buffer gnus-article-buffer)
4051      (goto-char (point-min))
4052      (if (not line)
4053          (point-min)
4054        (gnus-message 6 "Moved to bookmark")
4055        (search-forward "\n\n" nil t)
4056        (forward-line line)
4057        (point)))))
4058
4059 (defun gnus-article-prepare (article &optional all-headers header)
4060   "Prepare ARTICLE in article mode buffer.
4061 ARTICLE should either be an article number or a Message-ID.
4062 If ARTICLE is an id, HEADER should be the article headers.
4063 If ALL-HEADERS is non-nil, no headers are hidden."
4064   (save-excursion
4065     ;; Make sure we start in a summary buffer.
4066     (unless (eq major-mode 'gnus-summary-mode)
4067       (set-buffer gnus-summary-buffer))
4068     (setq gnus-summary-buffer (current-buffer))
4069     (let* ((gnus-article (if header (mail-header-number header) article))
4070            (summary-buffer (current-buffer))
4071            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4072            (group gnus-newsgroup-name)
4073            result)
4074       (save-excursion
4075         (gnus-article-setup-buffer)
4076         (set-buffer gnus-article-buffer)
4077         ;; Deactivate active regions.
4078         (when (and (boundp 'transient-mark-mode)
4079                    transient-mark-mode)
4080           (setq mark-active nil))
4081         (if (not (setq result (let ((inhibit-read-only t))
4082                                 (gnus-request-article-this-buffer
4083                                  article group))))
4084             ;; There is no such article.
4085             (save-excursion
4086               (when (and (numberp article)
4087                          (not (memq article gnus-newsgroup-sparse)))
4088                 (setq gnus-article-current
4089                       (cons gnus-newsgroup-name article))
4090                 (set-buffer gnus-summary-buffer)
4091                 (setq gnus-current-article article)
4092                 (if (and (memq article gnus-newsgroup-undownloaded)
4093                          (not (gnus-online (gnus-find-method-for-group
4094                                             gnus-newsgroup-name))))
4095                     (progn
4096                       (gnus-summary-set-agent-mark article)
4097                       (message "Message marked for downloading"))
4098                   (gnus-summary-mark-article article gnus-canceled-mark)
4099                   (unless (memq article gnus-newsgroup-sparse)
4100                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4101           (if (or (eq result 'pseudo)
4102                   (eq result 'nneething))
4103               (progn
4104                 (save-excursion
4105                   (set-buffer summary-buffer)
4106                   (push article gnus-newsgroup-history)
4107                   (setq gnus-last-article gnus-current-article
4108                         gnus-current-article 0
4109                         gnus-current-headers nil
4110                         gnus-article-current nil)
4111                   (if (eq result 'nneething)
4112                       (gnus-configure-windows 'summary)
4113                     (gnus-configure-windows 'article))
4114                   (gnus-set-global-variables))
4115                 (let ((gnus-article-mime-handle-alist-1
4116                        gnus-article-mime-handle-alist))
4117                   (gnus-set-mode-line 'article)))
4118             ;; The result from the `request' was an actual article -
4119             ;; or at least some text that is now displayed in the
4120             ;; article buffer.
4121             (when (and (numberp article)
4122                        (not (eq article gnus-current-article)))
4123               ;; Seems like a new article has been selected.
4124               ;; `gnus-current-article' must be an article number.
4125               (save-excursion
4126                 (set-buffer summary-buffer)
4127                 (push article gnus-newsgroup-history)
4128                 (setq gnus-last-article gnus-current-article
4129                       gnus-current-article article
4130                       gnus-current-headers
4131                       (gnus-summary-article-header gnus-current-article)
4132                       gnus-article-current
4133                       (cons gnus-newsgroup-name gnus-current-article))
4134                 (unless (vectorp gnus-current-headers)
4135                   (setq gnus-current-headers nil))
4136                 (gnus-summary-goto-subject gnus-current-article)
4137                 (when (gnus-summary-show-thread)
4138                   ;; If the summary buffer really was folded, the
4139                   ;; previous goto may not actually have gone to
4140                   ;; the right article, but the thread root instead.
4141                   ;; So we go again.
4142                   (gnus-summary-goto-subject gnus-current-article))
4143                 (gnus-run-hooks 'gnus-mark-article-hook)
4144                 (gnus-set-mode-line 'summary)
4145                 (when (gnus-visual-p 'article-highlight 'highlight)
4146                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4147                 ;; Set the global newsgroup variables here.
4148                 (gnus-set-global-variables)
4149                 (setq gnus-have-all-headers
4150                       (or all-headers gnus-show-all-headers))))
4151             (save-excursion
4152               (gnus-configure-windows 'article))
4153             (when (or (numberp article)
4154                       (stringp article))
4155               (gnus-article-prepare-display)
4156               ;; Do page break.
4157               (goto-char (point-min))
4158               (when gnus-break-pages
4159                 (gnus-narrow-to-page)))
4160             (let ((gnus-article-mime-handle-alist-1
4161                    gnus-article-mime-handle-alist))
4162               (gnus-set-mode-line 'article))
4163             (article-goto-body)
4164             (unless (bobp)
4165               (forward-line -1))
4166             (set-window-point (get-buffer-window (current-buffer)) (point))
4167             (gnus-configure-windows 'article)
4168             t))))))
4169
4170 ;;;###autoload
4171 (defun gnus-article-prepare-display ()
4172   "Make the current buffer look like a nice article."
4173   ;; Hooks for getting information from the article.
4174   ;; This hook must be called before being narrowed.
4175   (let ((gnus-article-buffer (current-buffer))
4176         buffer-read-only
4177         (inhibit-read-only t))
4178     (unless (eq major-mode 'gnus-article-mode)
4179       (gnus-article-mode))
4180     (setq buffer-read-only nil
4181           gnus-article-wash-types nil
4182           gnus-article-image-alist nil)
4183     (gnus-run-hooks 'gnus-tmp-internal-hook)
4184     (when gnus-display-mime-function
4185       (funcall gnus-display-mime-function))
4186     (gnus-run-hooks 'gnus-article-prepare-hook)))
4187
4188 ;;;
4189 ;;; Gnus MIME viewing functions
4190 ;;;
4191
4192 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4193   "Format of the MIME buttons.
4194
4195 Valid specifiers include:
4196 %t  The MIME type
4197 %T  MIME type, along with additional info
4198 %n  The `name' parameter
4199 %d  The description, if any
4200 %l  The length of the encoded part
4201 %p  The part identifier number
4202 %e  Dots if the part isn't displayed
4203
4204 General format specifiers can also be used.  See Info node
4205 `(gnus)Formatting Variables'.")
4206
4207 (defvar gnus-mime-button-line-format-alist
4208   '((?t gnus-tmp-type ?s)
4209     (?T gnus-tmp-type-long ?s)
4210     (?n gnus-tmp-name ?s)
4211     (?d gnus-tmp-description ?s)
4212     (?p gnus-tmp-id ?s)
4213     (?l gnus-tmp-length ?d)
4214     (?e gnus-tmp-dots ?s)))
4215
4216 (defvar gnus-mime-button-commands
4217   '((gnus-article-press-button "\r" "Toggle Display")
4218     (gnus-mime-view-part "v" "View Interactively...")
4219     (gnus-mime-view-part-as-type "t" "View As Type...")
4220     (gnus-mime-view-part-as-charset "C" "View As charset...")
4221     (gnus-mime-save-part "o" "Save...")
4222     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4223     (gnus-mime-replace-part "r" "Replace part")
4224     (gnus-mime-delete-part "d" "Delete part")
4225     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4226     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4227     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4228     (gnus-mime-view-part-externally "e" "View Externally")
4229     (gnus-mime-print-part "p" "Print")
4230     (gnus-mime-pipe-part "|" "Pipe To Command...")
4231     (gnus-mime-action-on-part "." "Take action on the part...")))
4232
4233 (defun gnus-article-mime-part-status ()
4234   (if gnus-article-mime-handle-alist-1
4235       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4236           " (1 part)"
4237         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4238     ""))
4239
4240 (defvar gnus-mime-button-map
4241   (let ((map (make-sparse-keymap)))
4242     (define-key map gnus-mouse-2 'gnus-article-push-button)
4243     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4244     (dolist (c gnus-mime-button-commands)
4245       (define-key map (cadr c) (car c)))
4246     map))
4247
4248 (easy-menu-define
4249   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4250   `("MIME Part"
4251     ,@(mapcar (lambda (c)
4252                 (vector (caddr c) (car c) :active t))
4253               gnus-mime-button-commands)))
4254
4255 (defun gnus-mime-button-menu (event prefix)
4256  "Construct a context-sensitive menu of MIME commands."
4257  (interactive "e\nP")
4258  (save-window-excursion
4259    (let ((pos (event-start event)))
4260      (select-window (posn-window pos))
4261      (goto-char (posn-point pos))
4262      (gnus-article-check-buffer)
4263      (popup-menu gnus-mime-button-menu nil prefix))))
4264
4265 (defun gnus-mime-view-all-parts (&optional handles)
4266   "View all the MIME parts."
4267   (interactive)
4268   (with-current-buffer gnus-article-buffer
4269     (let ((handles (or handles gnus-article-mime-handles))
4270           (mail-parse-charset gnus-newsgroup-charset)
4271           (mail-parse-ignored-charsets
4272            (with-current-buffer gnus-summary-buffer
4273              gnus-newsgroup-ignored-charsets)))
4274       (when handles
4275         (mm-remove-parts handles)
4276         (goto-char (point-min))
4277         (or (search-forward "\n\n") (goto-char (point-max)))
4278         (let ((inhibit-read-only t))
4279           (delete-region (point) (point-max))
4280           (mm-display-parts handles))))))
4281
4282 (defun gnus-article-jump-to-part (n)
4283   "Jump to MIME part N."
4284   (interactive "P")
4285   (pop-to-buffer gnus-article-buffer)
4286   ;; FIXME: why is it necessary?
4287   (sit-for 0)
4288   (let ((parts (length gnus-article-mime-handle-alist)))
4289     (or n (setq n
4290                 (string-to-number
4291                  (read-string ;; Emacs 21 doesn't have `read-number'.
4292                   (format "Jump to part (2..%s): " parts)))))
4293     (unless (and (integerp n) (<= n parts) (>= n 1))
4294       (setq n
4295             (progn
4296               (gnus-message 7 "Invalid part `%s', using %s instead."
4297                             n parts)
4298               parts)))
4299     (gnus-message 9 "Jumping to part %s." n)
4300     (cond ((>= gnus-auto-select-part 1)
4301            (while (and (<= n parts)
4302                        (not (gnus-article-goto-part n)))
4303              (setq n (1+ n))))
4304           ((< gnus-auto-select-part 0)
4305            (while (and (>= n 1)
4306                        (not (gnus-article-goto-part n)))
4307              (setq n (1- n))))
4308           (t
4309            (gnus-article-goto-part n)))))
4310
4311 (eval-when-compile
4312   (defsubst gnus-article-edit-part (handles &optional current-id)
4313     "Edit an article in order to delete a mime part.
4314 This function is exclusively used by `gnus-mime-save-part-and-strip'
4315 and `gnus-mime-delete-part', and not provided at run-time normally."
4316     (gnus-article-edit-article
4317      `(lambda ()
4318         (buffer-disable-undo)
4319         (erase-buffer)
4320         (let ((mail-parse-charset (or gnus-article-charset
4321                                       ',gnus-newsgroup-charset))
4322               (mail-parse-ignored-charsets
4323                (or gnus-article-ignored-charsets
4324                    ',gnus-newsgroup-ignored-charsets))
4325               (mbl mml-buffer-list))
4326           (setq mml-buffer-list nil)
4327           (insert-buffer-substring gnus-original-article-buffer)
4328           (mime-to-mml ',handles)
4329           (setq gnus-article-mime-handles nil)
4330           (let ((mbl1 mml-buffer-list))
4331             (setq mml-buffer-list mbl)
4332             (set (make-local-variable 'mml-buffer-list) mbl1))
4333           (gnus-make-local-hook 'kill-buffer-hook)
4334           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4335      `(lambda (no-highlight)
4336         (let ((mail-parse-charset (or gnus-article-charset
4337                                       ',gnus-newsgroup-charset))
4338               (message-options message-options)
4339               (message-options-set-recipient)
4340               (mail-parse-ignored-charsets
4341                (or gnus-article-ignored-charsets
4342                    ',gnus-newsgroup-ignored-charsets)))
4343           (mml-to-mime)
4344           (mml-destroy-buffers)
4345           (remove-hook 'kill-buffer-hook
4346                        'mml-destroy-buffers t)
4347           (kill-local-variable 'mml-buffer-list))
4348         (gnus-summary-edit-article-done
4349          ,(or (mail-header-references gnus-current-headers) "")
4350          ,(gnus-group-read-only-p)
4351          ,gnus-summary-buffer no-highlight))
4352      t)
4353     (gnus-article-edit-done)
4354     (gnus-summary-expand-window)
4355     (gnus-summary-show-article)
4356     (when (and current-id (integerp gnus-auto-select-part))
4357       (gnus-article-jump-to-part
4358        (+ current-id gnus-auto-select-part)))))
4359
4360 (defun gnus-mime-replace-part (file)
4361   "Replace MIME part under point with an external body."
4362   ;; Useful if file has already been saved to disk
4363   (interactive
4364    (list
4365     (mm-with-multibyte
4366       (read-file-name "Replace MIME part with file: "
4367                       (or mm-default-directory default-directory)
4368                       nil nil))))
4369   (gnus-mime-save-part-and-strip file))
4370
4371 (defun gnus-mime-save-part-and-strip (&optional file)
4372   "Save the MIME part under point then replace it with an external body.
4373 If FILE is given, use it for the external part."
4374   (interactive)
4375   (gnus-article-check-buffer)
4376   (when (gnus-group-read-only-p)
4377     (error "The current group does not support deleting of parts"))
4378   (when (mm-complicated-handles gnus-article-mime-handles)
4379     (error "\
4380 The current article has a complicated MIME structure, giving up..."))
4381   (let* ((data (get-text-property (point) 'gnus-data))
4382          (id (get-text-property (point) 'gnus-part))
4383          param
4384          (handles gnus-article-mime-handles))
4385     (unless file
4386       (setq file
4387             (and data (mm-save-part data "Delete MIME part and save to: "))))
4388     (when file
4389       (with-current-buffer (mm-handle-buffer data)
4390         (erase-buffer)
4391         (insert "Content-Type: " (mm-handle-media-type data))
4392         (mml-insert-parameter-string (cdr (mm-handle-type data))
4393                                      '(charset))
4394         ;; Add a filename for the sake of saving the part again.
4395         (mml-insert-parameter
4396          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4397         (insert "\n")
4398         (insert "Content-ID: " (message-make-message-id) "\n")
4399         (insert "Content-Transfer-Encoding: binary\n")
4400         (insert "\n"))
4401       (setcdr data
4402               (cdr (mm-make-handle nil
4403                                    `("message/external-body"
4404                                      (access-type . "LOCAL-FILE")
4405                                      (name . ,file)))))
4406       ;; (set-buffer gnus-summary-buffer)
4407       (gnus-article-edit-part handles id))))
4408
4409 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4410 ;; parts...>') but with stripping would be nice.
4411
4412 (defun gnus-mime-delete-part ()
4413   "Delete the MIME part under point.
4414 Replace it with some information about the removed part."
4415   (interactive)
4416   (gnus-article-check-buffer)
4417   (when (gnus-group-read-only-p)
4418     (error "The current group does not support deleting of parts"))
4419   (when (mm-complicated-handles gnus-article-mime-handles)
4420     (error "\
4421 The current article has a complicated MIME structure, giving up..."))
4422   (when (or gnus-expert-user
4423             (gnus-yes-or-no-p "\
4424 Deleting parts may malfunction or destroy the article; continue? "))
4425     (let* ((data (get-text-property (point) 'gnus-data))
4426            (id (get-text-property (point) 'gnus-part))
4427            (handles gnus-article-mime-handles)
4428            (none "(none)")
4429            (description
4430             (or
4431              (mail-decode-encoded-word-string (or (mm-handle-description data)
4432                                                   none))))
4433            (filename
4434             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4435                 none))
4436            (type (mm-handle-media-type data)))
4437       (unless data
4438         (error "No MIME part under point"))
4439       (with-current-buffer (mm-handle-buffer data)
4440         (let ((bsize (format "%s" (buffer-size))))
4441           (erase-buffer)
4442           (insert
4443            (concat
4444             ",----\n"
4445             "| The following attachment has been deleted:\n"
4446             "|\n"
4447             "| Type:           " type "\n"
4448             "| Filename:       " filename "\n"
4449             "| Size (encoded): " bsize " Byte\n"
4450             "| Description:    " description "\n"
4451             "`----\n"))
4452           (setcdr data
4453                   (cdr (mm-make-handle
4454                         nil `("text/plain") nil nil
4455                         (list "attachment")
4456                         (format "Deleted attachment (%s bytes)" bsize))))))
4457       ;; (set-buffer gnus-summary-buffer)
4458       (gnus-article-edit-part handles id))))
4459
4460 (defun gnus-mime-save-part ()
4461   "Save the MIME part under point."
4462   (interactive)
4463   (gnus-article-check-buffer)
4464   (let ((data (get-text-property (point) 'gnus-data)))
4465     (when data
4466       (mm-save-part data))))
4467
4468 (defun gnus-mime-pipe-part ()
4469   "Pipe the MIME part under point to a process."
4470   (interactive)
4471   (gnus-article-check-buffer)
4472   (let ((data (get-text-property (point) 'gnus-data)))
4473     (when data
4474       (mm-pipe-part data))))
4475
4476 (defun gnus-mime-view-part ()
4477   "Interactively choose a viewing method for the MIME part under point."
4478   (interactive)
4479   (gnus-article-check-buffer)
4480   (let ((data (get-text-property (point) 'gnus-data)))
4481     (when data
4482       (setq gnus-article-mime-handles
4483             (mm-merge-handles
4484              gnus-article-mime-handles (setq data (copy-sequence data))))
4485       (mm-interactively-view-part data))))
4486
4487 (defun gnus-mime-view-part-as-type-internal ()
4488   (gnus-article-check-buffer)
4489   (let* ((handle (get-text-property (point) 'gnus-data))
4490          (name (or
4491                 ;; Content-Type: foo/bar; name=...
4492                 (mail-content-type-get (mm-handle-type handle) 'name)
4493                 ;; Content-Disposition: attachment; filename=...
4494                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
4495          (def-type (and name (mm-default-file-encoding name))))
4496     (and def-type (cons def-type 0))))
4497
4498 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
4499   "Choose a MIME media type, and view the part as such.
4500 If non-nil, PRED is a predicate to use during completion to limit the
4501 available media-types."
4502   (interactive)
4503   (unless mime-type
4504     (setq mime-type
4505           (let ((default (gnus-mime-view-part-as-type-internal)))
4506             (completing-read
4507              (format "View as MIME type (default %s): "
4508                      (car default))
4509              (mapcar #'list (mailcap-mime-types))
4510              pred nil nil nil
4511              (car default)))))
4512   (gnus-article-check-buffer)
4513   (let ((handle (get-text-property (point) 'gnus-data)))
4514     (when handle
4515       (when (equal (mm-handle-media-type handle) "message/external-body")
4516         (unless (mm-handle-cache handle)
4517           (mm-extern-cache-contents handle))
4518         (setq handle (mm-handle-cache handle)))
4519       (setq handle
4520             (mm-make-handle (mm-handle-buffer handle)
4521                             (cons mime-type (cdr (mm-handle-type handle)))
4522                             (mm-handle-encoding handle)
4523                             (mm-handle-undisplayer handle)
4524                             (mm-handle-disposition handle)
4525                             (mm-handle-description handle)
4526                             nil
4527                             (mm-handle-id handle)))
4528       (setq gnus-article-mime-handles
4529             (mm-merge-handles gnus-article-mime-handles handle))
4530       (gnus-mm-display-part handle))))
4531
4532 (defun gnus-mime-copy-part (&optional handle arg)
4533   "Put the MIME part under point into a new buffer.
4534 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4535 are decompressed."
4536   (interactive (list nil current-prefix-arg))
4537   (gnus-article-check-buffer)
4538   (unless handle
4539     (setq handle (get-text-property (point) 'gnus-data)))
4540   (when handle
4541     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
4542                                                'name)
4543                         (mail-content-type-get (mm-handle-disposition handle)
4544                                                'filename)))
4545           contents dont-decode charset coding-system)
4546       (mm-with-unibyte-buffer
4547         (mm-insert-part handle)
4548         (setq contents (or (condition-case nil
4549                                (mm-decompress-buffer filename nil 'sig)
4550                              (error
4551                               (setq dont-decode t)
4552                               nil))
4553                            (buffer-string))))
4554       (setq filename (cond (filename (file-name-nondirectory filename))
4555                            (dont-decode "*raw data*")
4556                            (t "*decoded*")))
4557       (cond
4558        (dont-decode)
4559        ((not arg)
4560         (unless (setq charset (mail-content-type-get
4561                                (mm-handle-type handle) 'charset))
4562           (unless (setq coding-system (mm-with-unibyte-buffer
4563                                         (insert contents)
4564                                         (mm-find-buffer-file-coding-system)))
4565             (setq charset gnus-newsgroup-charset))))
4566        ((numberp arg)
4567         (setq charset (or (cdr (assq arg
4568                                      gnus-summary-show-article-charset-alist))
4569                           (mm-read-coding-system "Charset: ")))))
4570       (switch-to-buffer (generate-new-buffer filename))
4571       (if (or coding-system
4572               (and charset
4573                    (setq coding-system (mm-charset-to-coding-system charset))
4574                    (not (eq charset 'ascii))))
4575           (progn
4576             (mm-enable-multibyte)
4577             (insert (mm-decode-coding-string contents coding-system))
4578             (setq buffer-file-coding-system
4579                   (if (boundp 'last-coding-system-used)
4580                       (symbol-value 'last-coding-system-used)
4581                     coding-system)))
4582         (mm-disable-multibyte)
4583         (insert contents)
4584         (setq buffer-file-coding-system mm-binary-coding-system))
4585       ;; We do it this way to make `normal-mode' set the appropriate mode.
4586       (unwind-protect
4587           (progn
4588             (setq buffer-file-name (expand-file-name filename))
4589             (normal-mode))
4590         (setq buffer-file-name nil))
4591       (goto-char (point-min)))))
4592
4593 (defun gnus-mime-print-part (&optional handle filename)
4594   "Print the MIME part under point."
4595   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4596   (gnus-article-check-buffer)
4597   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4598          (contents (and handle (mm-get-part handle)))
4599          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4600          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4601     (when contents
4602         (if printer
4603             (unwind-protect
4604                 (progn
4605                   (mm-save-part-to-file handle file)
4606                   (call-process shell-file-name nil
4607                                 (generate-new-buffer " *mm*")
4608                                 nil
4609                                 shell-command-switch
4610                                 (mm-mailcap-command
4611                                  printer file (mm-handle-type handle))))
4612               (delete-file file))
4613           (with-temp-buffer
4614             (insert contents)
4615             (gnus-print-buffer))
4616           (ps-despool filename)))))
4617
4618 (defun gnus-mime-inline-part (&optional handle arg)
4619   "Insert the MIME part under point into the current buffer.
4620 Compressed files like .gz and .bz2 are decompressed."
4621   (interactive (list nil current-prefix-arg))
4622   (gnus-article-check-buffer)
4623   (unless handle
4624     (setq handle (get-text-property (point) 'gnus-data)))
4625   (when handle
4626     (let ((b (point))
4627           (inhibit-read-only t)
4628           contents charset coding-system)
4629       (if (and (not arg) (mm-handle-undisplayer handle))
4630           (mm-remove-part handle)
4631         (mm-with-unibyte-buffer
4632           (mm-insert-part handle)
4633           (setq contents
4634                 (or (mm-decompress-buffer
4635                      (or (mail-content-type-get (mm-handle-type handle)
4636                                                 'name)
4637                          (mail-content-type-get (mm-handle-disposition handle)
4638                                                 'filename))
4639                      nil t)
4640                     (buffer-string))))
4641         (cond
4642          ((not arg)
4643           (unless (setq charset (mail-content-type-get
4644                                  (mm-handle-type handle) 'charset))
4645             (unless (setq coding-system
4646                           (mm-with-unibyte-buffer
4647                             (insert contents)
4648                             (mm-find-buffer-file-coding-system)))
4649               (setq charset gnus-newsgroup-charset))))
4650          ((numberp arg)
4651           (if (mm-handle-undisplayer handle)
4652               (mm-remove-part handle))
4653           (setq charset
4654                 (or (cdr (assq arg
4655                                gnus-summary-show-article-charset-alist))
4656                     (mm-read-coding-system "Charset: "))))
4657          (t
4658           (if (mm-handle-undisplayer handle)
4659               (mm-remove-part handle))))
4660         (forward-line 2)
4661         (mm-insert-inline
4662          handle
4663          (if (or coding-system
4664                  (and charset
4665                       (setq coding-system
4666                             (mm-charset-to-coding-system charset))
4667                       (not (eq coding-system 'ascii))))
4668              (mm-decode-coding-string contents coding-system)
4669            (mm-string-to-multibyte contents)))
4670         (goto-char b)))))
4671
4672 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4673   "Insert the MIME part under point into the current buffer using the
4674 specified charset."
4675   (interactive (list nil current-prefix-arg))
4676   (gnus-article-check-buffer)
4677   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
4678         (fun (get-text-property (point) 'gnus-callback))
4679         (gnus-newsgroup-ignored-charsets 'gnus-all)
4680         gnus-newsgroup-charset type charset)
4681     (when handle
4682       (if (mm-handle-undisplayer handle)
4683           (mm-remove-part handle))
4684       (when fun
4685         (setq gnus-newsgroup-charset
4686               (or (cdr (assq arg gnus-summary-show-article-charset-alist))
4687                   (mm-read-coding-system "Charset: ")))
4688         ;; Strip the charset parameter from `handle'.
4689         (setq type (mm-handle-type
4690                     (if (equal (mm-handle-media-type handle)
4691                                "message/external-body")
4692                         (progn
4693                           (unless (mm-handle-cache handle)
4694                             (mm-extern-cache-contents handle))
4695                           (mm-handle-cache handle))
4696                       handle))
4697               charset (assq 'charset (cdr type)))
4698         (delq charset type)
4699         (funcall fun handle)))))
4700
4701 (defun gnus-mime-view-part-externally (&optional handle)
4702   "View the MIME part under point with an external viewer."
4703   (interactive)
4704   (gnus-article-check-buffer)
4705   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4706          (mm-user-display-methods nil)
4707          (mm-inlined-types nil)
4708          (mail-parse-charset gnus-newsgroup-charset)
4709          (mail-parse-ignored-charsets
4710           (with-current-buffer gnus-summary-buffer
4711             gnus-newsgroup-ignored-charsets))
4712          (type (mm-handle-media-type handle))
4713          (method (mailcap-mime-info type))
4714          (mm-enable-external t))
4715     (if (not (stringp method))
4716         (gnus-mime-view-part-as-type
4717          nil (lambda (type) (stringp (mailcap-mime-info type))))
4718       (when handle
4719         (if (mm-handle-undisplayer handle)
4720             (mm-remove-part handle)
4721           (mm-display-part handle))))))
4722
4723 (defun gnus-mime-view-part-internally (&optional handle)
4724   "View the MIME part under point with an internal viewer.
4725 If no internal viewer is available, use an external viewer."
4726   (interactive)
4727   (gnus-article-check-buffer)
4728   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4729          (mm-inlined-types '(".*"))
4730          (mm-inline-large-images t)
4731          (mail-parse-charset gnus-newsgroup-charset)
4732          (mail-parse-ignored-charsets
4733           (with-current-buffer gnus-summary-buffer
4734             gnus-newsgroup-ignored-charsets))
4735          (inhibit-read-only t))
4736     (if (not (mm-inlinable-p handle))
4737         (gnus-mime-view-part-as-type
4738          nil (lambda (type) (mm-inlinable-p handle type)))
4739       (when handle
4740         (if (mm-handle-undisplayer handle)
4741             (mm-remove-part handle)
4742           (mm-display-part handle))))))
4743
4744 (defun gnus-mime-action-on-part (&optional action)
4745   "Do something with the MIME attachment at \(point\)."
4746   (interactive
4747    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
4748   (gnus-article-check-buffer)
4749   (let ((action-pair (assoc action gnus-mime-action-alist)))
4750     (if action-pair
4751         (funcall (cdr action-pair)))))
4752
4753 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
4754   "Call FUNCTION on MIME part N.
4755 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
4756 If INTERACTIVE, call FUNCTION interactivly."
4757   (let (window frame)
4758     ;; Check whether the article is displayed.
4759     (unless (and (gnus-buffer-live-p gnus-article-buffer)
4760                  (setq window (get-buffer-window gnus-article-buffer t))
4761                  (frame-visible-p (setq frame (window-frame window))))
4762       (error "No article is displayed"))
4763     (with-current-buffer gnus-article-buffer
4764       ;; Check whether the article displays the right contents.
4765       (unless (with-current-buffer gnus-summary-buffer
4766                 (eq gnus-current-article (gnus-summary-article-number)))
4767         (error "You should select the right article first"))
4768       ;; Check whether the specified part exists.
4769       (when (> n (length gnus-article-mime-handle-alist))
4770         (error "No such part")))
4771     (unless
4772         (progn
4773           ;; To select the window is needed so that the cursor
4774           ;; might be visible on the MIME button.
4775           (select-window (prog1
4776                              window
4777                            (setq window (selected-window))
4778                            ;; Article may be displayed in the other frame.
4779                            (gnus-select-frame-set-input-focus
4780                             (prog1
4781                                 frame
4782                               (setq frame (selected-frame))))))
4783           (when (gnus-article-goto-part n)
4784             ;; We point the cursor and the arrow at the MIME button
4785             ;; when the `function' prompt the user for something.
4786             (let ((cursor-in-non-selected-windows t)
4787                   (overlay-arrow-string "=>")
4788                   (overlay-arrow-position (point-marker)))
4789               (unwind-protect
4790                   (cond
4791                    ((and no-handle interactive)
4792                     (call-interactively function))
4793                    (no-handle
4794                     (funcall function))
4795                    (interactive
4796                     (call-interactively
4797                      function
4798                      (cdr (assq n gnus-article-mime-handle-alist))))
4799                    (t
4800                     (funcall function
4801                              (cdr (assq n gnus-article-mime-handle-alist)))))
4802                 (set-marker overlay-arrow-position nil)
4803                 (unless gnus-auto-select-part
4804                   (gnus-select-frame-set-input-focus frame)
4805                   (select-window window))))
4806             t))
4807       (if gnus-inhibit-mime-unbuttonizing
4808           ;; This is the default though the program shouldn't reach here.
4809           (error "No such part")
4810         ;; The part which doesn't have the MIME button is selected.
4811         ;; So, we display all the buttons and redo it.
4812         (let ((gnus-inhibit-mime-unbuttonizing t))
4813           (gnus-summary-show-article)
4814           (gnus-article-part-wrapper n function no-handle))))))
4815
4816 (defun gnus-article-pipe-part (n)
4817   "Pipe MIME part N, which is the numerical prefix."
4818   (interactive "p")
4819   (gnus-article-part-wrapper n 'mm-pipe-part))
4820
4821 (defun gnus-article-save-part (n)
4822   "Save MIME part N, which is the numerical prefix."
4823   (interactive "p")
4824   (gnus-article-part-wrapper n 'mm-save-part))
4825
4826 (defun gnus-article-interactively-view-part (n)
4827   "View MIME part N interactively, which is the numerical prefix."
4828   (interactive "p")
4829   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4830
4831 (defun gnus-article-copy-part (n)
4832   "Copy MIME part N, which is the numerical prefix."
4833   (interactive "p")
4834   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4835
4836 (defun gnus-article-view-part-as-charset (n)
4837   "View MIME part N using a specified charset.
4838 N is the numerical prefix."
4839   (interactive "p")
4840   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4841
4842 (defun gnus-article-view-part-externally (n)
4843   "View MIME part N externally, which is the numerical prefix."
4844   (interactive "p")
4845   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4846
4847 (defun gnus-article-inline-part (n)
4848   "Inline MIME part N, which is the numerical prefix."
4849   (interactive "p")
4850   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4851
4852 (defun gnus-article-save-part-and-strip (n)
4853   "Save MIME part N and replace it with an external body.
4854 N is the numerical prefix."
4855   (interactive "p")
4856   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
4857
4858 (defun gnus-article-replace-part (n)
4859   "Replace MIME part N with an external body.
4860 N is the numerical prefix."
4861   (interactive "p")
4862   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
4863
4864 (defun gnus-article-delete-part (n)
4865   "Delete MIME part N and add some information about the removed part.
4866 N is the numerical prefix."
4867   (interactive "p")
4868   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
4869
4870 (defun gnus-article-view-part-as-type (n)
4871   "Choose a MIME media type, and view part N as such.
4872 N is the numerical prefix."
4873   (interactive "p")
4874   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
4875
4876 (defun gnus-article-mime-match-handle-first (condition)
4877   (if condition
4878       (let (n)
4879         (dolist (ihandle gnus-article-mime-handle-alist)
4880           (if (and (cond
4881                     ((functionp condition)
4882                      (funcall condition (cdr ihandle)))
4883                     ((eq condition 'undisplayed)
4884                      (not (or (mm-handle-undisplayer (cdr ihandle))
4885                               (equal (mm-handle-media-type (cdr ihandle))
4886                                      "multipart/alternative"))))
4887                     ((eq condition 'undisplayed-alternative)
4888                      (not (mm-handle-undisplayer (cdr ihandle))))
4889                     (t t))
4890                    (gnus-article-goto-part (car ihandle))
4891                    (or (not n) (< (car ihandle) n)))
4892               (setq n (car ihandle))))
4893         (or n 1))
4894     1))
4895
4896 (defun gnus-article-view-part (&optional n)
4897   "View MIME part N, which is the numerical prefix."
4898   (interactive "P")
4899   (with-current-buffer gnus-article-buffer
4900     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4901                              gnus-article-mime-match-handle-function)))
4902     (when (> n (length gnus-article-mime-handle-alist))
4903       (error "No such part"))
4904     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4905       (when (gnus-article-goto-part n)
4906         (if (equal (car handle) "multipart/alternative")
4907             (gnus-article-press-button)
4908           (when (eq (gnus-mm-display-part handle) 'internal)
4909             (gnus-set-window-start)))))))
4910
4911 (defsubst gnus-article-mime-total-parts ()
4912   (if (bufferp (car gnus-article-mime-handles))
4913       1 ;; single part
4914     (1- (length gnus-article-mime-handles))))
4915
4916 (defun gnus-mm-display-part (handle)
4917   "Display HANDLE and fix MIME button."
4918   (let ((id (get-text-property (point) 'gnus-part))
4919         (point (point))
4920         (inhibit-read-only t))
4921     (forward-line 1)
4922     (prog1
4923         (let ((window (selected-window))
4924               (mail-parse-charset gnus-newsgroup-charset)
4925               (mail-parse-ignored-charsets
4926                (if (gnus-buffer-live-p gnus-summary-buffer)
4927                    (with-current-buffer gnus-summary-buffer
4928                      gnus-newsgroup-ignored-charsets)
4929                  nil)))
4930           (save-excursion
4931             (unwind-protect
4932                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4933                       (beg (point)))
4934                   (when win
4935                     (select-window win))
4936                   (goto-char point)
4937                   (forward-line)
4938                   (if (mm-handle-displayed-p handle)
4939                       ;; This will remove the part.
4940                       (mm-display-part handle)
4941                     (save-restriction
4942                       (narrow-to-region (point)
4943                                         (if (eobp) (point) (1+ (point))))
4944                       (mm-display-part handle)
4945                       ;; We narrow to the part itself and
4946                       ;; then call the treatment functions.
4947                       (goto-char (point-min))
4948                       (forward-line 1)
4949                       (narrow-to-region (point) (point-max))
4950                       (gnus-treat-article
4951                        nil id
4952                        (gnus-article-mime-total-parts)
4953                        (mm-handle-media-type handle)))))
4954               (if (window-live-p window)
4955                   (select-window window)))))
4956       (goto-char point)
4957       (gnus-delete-line)
4958       (gnus-insert-mime-button
4959        handle id (list (mm-handle-displayed-p handle)))
4960       (goto-char point))))
4961
4962 (defun gnus-article-goto-part (n)
4963   "Go to MIME part N."
4964   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
4965
4966 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4967   (let ((gnus-tmp-name
4968          (or (mail-content-type-get (mm-handle-type handle) 'name)
4969              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4970              (mail-content-type-get (mm-handle-type handle) 'url)
4971              ""))
4972         (gnus-tmp-type (mm-handle-media-type handle))
4973         (gnus-tmp-description
4974          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4975                                               "")))
4976         (gnus-tmp-dots
4977          (if (if displayed (car displayed)
4978                (mm-handle-displayed-p handle))
4979              "" "..."))
4980         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4981                            (buffer-size)))
4982         gnus-tmp-type-long b e)
4983     (when (string-match ".*/" gnus-tmp-name)
4984       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4985     (setq gnus-tmp-type-long (concat gnus-tmp-type
4986                                      (and (not (equal gnus-tmp-name ""))
4987                                           (concat "; " gnus-tmp-name))))
4988     (unless (equal gnus-tmp-description "")
4989       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4990     (unless (bolp)
4991       (insert "\n"))
4992     (setq b (point))
4993     (gnus-eval-format
4994      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4995      `(keymap ,gnus-mime-button-map
4996               gnus-callback gnus-mm-display-part
4997               gnus-part ,gnus-tmp-id
4998               article-type annotation
4999               gnus-data ,handle))
5000     (setq e (if (bolp)
5001                 ;; Exclude a newline.
5002                 (1- (point))
5003               (point)))
5004     (widget-convert-button
5005      'link b e
5006      :mime-handle handle
5007      :action 'gnus-widget-press-button
5008      :button-keymap gnus-mime-button-map
5009      :help-echo
5010      (lambda (widget/window &optional overlay pos)
5011        ;; Needed to properly clear the message due to a bug in
5012        ;; wid-edit (XEmacs only).
5013        (if (boundp 'help-echo-owns-message)
5014            (setq help-echo-owns-message t))
5015        (format
5016         "%S: %s the MIME part; %S: more options"
5017         (aref gnus-mouse-2 0)
5018         ;; XEmacs will get a single widget arg; Emacs 21 will get
5019         ;; window, overlay, position.
5020         (if (mm-handle-displayed-p
5021              (if overlay
5022                  (with-current-buffer (gnus-overlay-buffer overlay)
5023                    (widget-get (widget-at (gnus-overlay-start overlay))
5024                                :mime-handle))
5025                (widget-get widget/window :mime-handle)))
5026             "hide" "show")
5027         (aref gnus-down-mouse-3 0))))))
5028
5029 (defun gnus-widget-press-button (elems el)
5030   (goto-char (widget-get elems :from))
5031   (gnus-article-press-button))
5032
5033 (defvar gnus-displaying-mime nil)
5034
5035 (defun gnus-display-mime (&optional ihandles)
5036   "Display the MIME parts."
5037   (save-excursion
5038     (save-selected-window
5039       (let ((window (get-buffer-window gnus-article-buffer))
5040             (point (point)))
5041         (when window
5042           (select-window window)
5043           ;; We have to do this since selecting the window
5044           ;; may change the point.  So we set the window point.
5045           (set-window-point window point)))
5046       (let ((handles ihandles)
5047             (inhibit-read-only t)
5048             handle)
5049         (cond (handles)
5050               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5051                (when gnus-article-emulate-mime
5052                  (mm-uu-dissect-text-parts handles)))
5053               (gnus-article-emulate-mime
5054                (setq handles (mm-uu-dissect))))
5055         (when (and (not ihandles)
5056                    (not gnus-displaying-mime))
5057           ;; Top-level call; we clean up.
5058           (when gnus-article-mime-handles
5059             (mm-destroy-parts gnus-article-mime-handles)
5060             (setq gnus-article-mime-handle-alist nil));; A trick.
5061           (setq gnus-article-mime-handles handles)
5062           ;; We allow users to glean info from the handles.
5063           (when gnus-article-mime-part-function
5064             (gnus-mime-part-function handles)))
5065         (if (and handles
5066                  (or (not (stringp (car handles)))
5067                      (cdr handles)))
5068             (progn
5069               (when (and (not ihandles)
5070                          (not gnus-displaying-mime))
5071                 ;; Clean up for mime parts.
5072                 (article-goto-body)
5073                 (delete-region (point) (point-max)))
5074               (let ((gnus-displaying-mime t))
5075                 (gnus-mime-display-part handles)))
5076           (save-restriction
5077             (article-goto-body)
5078             (narrow-to-region (point) (point-max))
5079             (gnus-treat-article nil 1 1)
5080             (widen)))
5081         (unless ihandles
5082           ;; Highlight the headers.
5083           (save-excursion
5084             (save-restriction
5085               (article-goto-body)
5086               (narrow-to-region (point-min) (point))
5087               (gnus-article-save-original-date
5088                (gnus-treat-article 'head)))))))))
5089
5090 (defcustom gnus-mime-display-multipart-as-mixed nil
5091   "Display \"multipart\" parts as  \"multipart/mixed\".
5092
5093 If t, it overrides nil values of
5094 `gnus-mime-display-multipart-alternative-as-mixed' and
5095 `gnus-mime-display-multipart-related-as-mixed'."
5096   :group 'gnus-article-mime
5097   :type 'boolean)
5098
5099 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5100   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5101   :version "22.1"
5102   :group 'gnus-article-mime
5103   :type 'boolean)
5104
5105 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5106   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5107
5108 If displaying \"text/html\" is discouraged \(see
5109 `mm-discouraged-alternatives'\) images or other material inside a
5110 \"multipart/related\" part might be overlooked when this variable is nil."
5111   :version "22.1"
5112   :group 'gnus-article-mime
5113   :type 'boolean)
5114
5115 (defun gnus-mime-display-part (handle)
5116   (cond
5117    ;; Maybe a broken MIME message.
5118    ((null handle))
5119    ;; Single part.
5120    ((not (stringp (car handle)))
5121     (gnus-mime-display-single handle))
5122    ;; User-defined multipart
5123    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5124     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5125              handle))
5126    ;; multipart/alternative
5127    ((and (equal (car handle) "multipart/alternative")
5128          (not (or gnus-mime-display-multipart-as-mixed
5129                   gnus-mime-display-multipart-alternative-as-mixed)))
5130     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5131       (push (cons id handle) gnus-article-mime-handle-alist)
5132       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5133    ;; multipart/related
5134    ((and (equal (car handle) "multipart/related")
5135          (not (or gnus-mime-display-multipart-as-mixed
5136                   gnus-mime-display-multipart-related-as-mixed)))
5137     ;;;!!!We should find the start part, but we just default
5138     ;;;!!!to the first part.
5139     ;;(gnus-mime-display-part (cadr handle))
5140     ;;;!!! Most multipart/related is an HTML message plus images.
5141     ;;;!!! Unfortunately we are unable to let W3 display those
5142     ;;;!!! included images, so we just display it as a mixed multipart.
5143     ;;(gnus-mime-display-mixed (cdr handle))
5144     ;;;!!! No, w3 can display everything just fine.
5145     (gnus-mime-display-part (cadr handle)))
5146    ((equal (car handle) "multipart/signed")
5147     (gnus-add-wash-type 'signed)
5148     (gnus-mime-display-security handle))
5149    ((equal (car handle) "multipart/encrypted")
5150     (gnus-add-wash-type 'encrypted)
5151     (gnus-mime-display-security handle))
5152    ;; Other multiparts are handled like multipart/mixed.
5153    (t
5154     (gnus-mime-display-mixed (cdr handle)))))
5155
5156 (defun gnus-mime-part-function (handles)
5157   (if (stringp (car handles))
5158       (mapcar 'gnus-mime-part-function (cdr handles))
5159     (funcall gnus-article-mime-part-function handles)))
5160
5161 (defun gnus-mime-display-mixed (handles)
5162   (mapcar 'gnus-mime-display-part handles))
5163
5164 (defun gnus-mime-display-single (handle)
5165   (let ((type (mm-handle-media-type handle))
5166         (ignored gnus-ignored-mime-types)
5167         (not-attachment t)
5168         (move nil)
5169         display text)
5170     (catch 'ignored
5171       (progn
5172         (while ignored
5173           (when (string-match (pop ignored) type)
5174             (throw 'ignored nil)))
5175         (if (and (setq not-attachment
5176                        (and (not (mm-inline-override-p handle))
5177                             (or (not (mm-handle-disposition handle))
5178                                 (equal (car (mm-handle-disposition handle))
5179                                        "inline")
5180                                 (mm-attachment-override-p handle))))
5181                  (mm-automatic-display-p handle)
5182                  (or (and
5183                       (mm-inlinable-p handle)
5184                       (mm-inlined-p handle))
5185                      (mm-automatic-external-display-p type)))
5186             (setq display t)
5187           (when (equal (mm-handle-media-supertype handle) "text")
5188             (setq text t)))
5189         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5190               beg)
5191           (push (cons id handle) gnus-article-mime-handle-alist)
5192           (when (and display
5193                      (equal (mm-handle-media-supertype handle) "message"))
5194             (insert-char
5195              ?\n
5196              (cond ((not (bolp)) 2)
5197                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5198                    (t 1))))
5199           (when (or (not display)
5200                     (not (gnus-unbuttonized-mime-type-p type)))
5201             (gnus-insert-mime-button
5202              handle id (list (or display (and not-attachment text))))
5203             (gnus-article-insert-newline)
5204             ;; Remember modify the number of forward lines.
5205             (setq move t))
5206           (setq beg (point))
5207           (cond
5208            (display
5209             (when move
5210               (forward-line -1)
5211               (setq beg (point)))
5212             (let ((mail-parse-charset gnus-newsgroup-charset)
5213                   (mail-parse-ignored-charsets
5214                    (save-excursion (condition-case ()
5215                                        (set-buffer gnus-summary-buffer)
5216                                      (error))
5217                                    gnus-newsgroup-ignored-charsets)))
5218               (mm-display-part handle t))
5219             (goto-char (point-max)))
5220            ((and text not-attachment)
5221             (when move
5222               (forward-line -1)
5223               (setq beg (point)))
5224             (gnus-article-insert-newline)
5225             (mm-insert-inline
5226              handle
5227              (let ((charset (mail-content-type-get (mm-handle-type handle)
5228                                                    'charset)))
5229                (cond ((not charset)
5230                       (mm-string-as-multibyte (mm-get-part handle)))
5231                      ((eq charset 'gnus-decoded)
5232                       (with-current-buffer (mm-handle-buffer handle)
5233                         (buffer-string)))
5234                      (t
5235                       (mm-decode-string (mm-get-part handle) charset)))))
5236             (goto-char (point-max))))
5237           ;; Do highlighting.
5238           (save-excursion
5239             (save-restriction
5240               (narrow-to-region beg (point))
5241               (gnus-treat-article
5242                nil id
5243                (gnus-article-mime-total-parts)
5244                (mm-handle-media-type handle)))))))))
5245
5246 (defun gnus-unbuttonized-mime-type-p (type)
5247   "Say whether TYPE is to be unbuttonized."
5248   (unless gnus-inhibit-mime-unbuttonizing
5249     (when (catch 'found
5250             (let ((types gnus-unbuttonized-mime-types))
5251               (while types
5252                 (when (string-match (pop types) type)
5253                   (throw 'found t)))))
5254       (not (catch 'found
5255              (let ((types gnus-buttonized-mime-types))
5256                (while types
5257                  (when (string-match (pop types) type)
5258                    (throw 'found t)))))))))
5259
5260 (defun gnus-article-insert-newline ()
5261   "Insert a newline, but mark it as undeletable."
5262   (gnus-put-text-property
5263    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5264
5265 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5266   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5267          (ihandles handles)
5268          (point (point))
5269          handle (inhibit-read-only t) from props begend not-pref)
5270     (save-window-excursion
5271       (save-restriction
5272         (when ibegend
5273           (narrow-to-region (car ibegend)
5274                             (or (cdr ibegend)
5275                                 (progn
5276                                   (goto-char (car ibegend))
5277                                   (forward-line 2)
5278                                   (point))))
5279           (delete-region (point-min) (point-max))
5280           (mm-remove-parts handles))
5281         (setq begend (list (point-marker)))
5282         ;; Do the toggle.
5283         (unless (setq not-pref (cadr (member preferred ihandles)))
5284           (setq not-pref (car ihandles)))
5285         (when (or ibegend
5286                   (not preferred)
5287                   (not (gnus-unbuttonized-mime-type-p
5288                         "multipart/alternative")))
5289           (gnus-add-text-properties
5290            (setq from (point))
5291            (progn
5292              (insert (format "%d.  " id))
5293              (point))
5294            `(gnus-callback
5295              (lambda (handles)
5296                (unless ,(not ibegend)
5297                  (setq gnus-article-mime-handle-alist
5298                        ',gnus-article-mime-handle-alist))
5299                (gnus-mime-display-alternative
5300                 ',ihandles ',not-pref ',begend ,id))
5301              keymap ,gnus-mime-button-map
5302              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5303              face ,gnus-article-button-face
5304              gnus-part ,id
5305              article-type multipart))
5306           (widget-convert-button 'link from (point)
5307                                  :action 'gnus-widget-press-button
5308                                  :button-keymap gnus-widget-button-keymap)
5309           ;; Do the handles
5310           (while (setq handle (pop handles))
5311             (gnus-add-text-properties
5312              (setq from (point))
5313              (progn
5314                (insert (format "(%c) %-18s"
5315                                (if (equal handle preferred) ?* ? )
5316                                (mm-handle-media-type handle)))
5317                (point))
5318              `(gnus-callback
5319                (lambda (handles)
5320                  (unless ,(not ibegend)
5321                    (setq gnus-article-mime-handle-alist
5322                          ',gnus-article-mime-handle-alist))
5323                  (gnus-mime-display-alternative
5324                   ',ihandles ',handle ',begend ,id))
5325                keymap ,gnus-mime-button-map
5326                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5327                face ,gnus-article-button-face
5328                gnus-part ,id
5329                gnus-data ,handle))
5330             (widget-convert-button 'link from (point)
5331                                    :action 'gnus-widget-press-button
5332                                    :button-keymap gnus-widget-button-keymap)
5333             (insert "  "))
5334           (insert "\n\n"))
5335         (when preferred
5336           (if (stringp (car preferred))
5337               (gnus-display-mime preferred)
5338             (let ((mail-parse-charset gnus-newsgroup-charset)
5339                   (mail-parse-ignored-charsets
5340                    (with-current-buffer gnus-summary-buffer
5341                      gnus-newsgroup-ignored-charsets)))
5342               (mm-display-part preferred)
5343               ;; Do highlighting.
5344               (save-excursion
5345                 (save-restriction
5346                   (narrow-to-region (car begend) (point-max))
5347                   (gnus-treat-article
5348                    nil (length gnus-article-mime-handle-alist)
5349                    (gnus-article-mime-total-parts)
5350                    (mm-handle-media-type handle))))))
5351           (goto-char (point-max))
5352           (setcdr begend (point-marker)))))
5353     (when ibegend
5354       (goto-char point))))
5355
5356 (defconst gnus-article-wash-status-strings
5357   (let ((alist '((cite "c" "Possible hidden citation text"
5358                        " " "All citation text visible")
5359                  (headers "h" "Hidden headers"
5360                           " " "All headers visible.")
5361                  (pgp "p" "Encrypted or signed message status hidden"
5362                       " " "No hidden encryption nor digital signature status")
5363                  (signature "s" "Signature has been hidden"
5364                             " " "Signature is visible")
5365                  (overstrike "o" "Overstrike (^H) characters applied"
5366                              " " "No overstrike characters applied")
5367                  (emphasis "e" "/*_Emphasis_*/ characters applied"
5368                            " " "No /*_emphasis_*/ characters applied")))
5369         result)
5370     (dolist (entry alist result)
5371       (let ((key (nth 0 entry))
5372             (on (copy-sequence (nth 1 entry)))
5373             (on-help (nth 2 entry))
5374             (off (copy-sequence (nth 3 entry)))
5375             (off-help (nth 4 entry)))
5376         (put-text-property 0 1 'help-echo on-help on)
5377         (put-text-property 0 1 'help-echo off-help off)
5378         (push (list key on off) result))))
5379   "Alist of strings describing wash status in the mode line.
5380 Each entry has the form (KEY ON OF), where the KEY is a symbol
5381 representing the particular washing function, ON is the string to use
5382 in the article mode line when the washing function is active, and OFF
5383 is the string to use when it is inactive.")
5384
5385 (defun gnus-article-wash-status-entry (key value)
5386   (let ((entry (assoc key gnus-article-wash-status-strings)))
5387     (if value (nth 1 entry) (nth 2 entry))))
5388
5389 (defun gnus-article-wash-status ()
5390   "Return a string which display status of article washing."
5391   (with-current-buffer gnus-article-buffer
5392     (let ((cite (memq 'cite gnus-article-wash-types))
5393           (headers (memq 'headers gnus-article-wash-types))
5394           (boring (memq 'boring-headers gnus-article-wash-types))
5395           (pgp (memq 'pgp gnus-article-wash-types))
5396           (pem (memq 'pem gnus-article-wash-types))
5397           (signed (memq 'signed gnus-article-wash-types))
5398           (encrypted (memq 'encrypted gnus-article-wash-types))
5399           (signature (memq 'signature gnus-article-wash-types))
5400           (overstrike (memq 'overstrike gnus-article-wash-types))
5401           (emphasis (memq 'emphasis gnus-article-wash-types)))
5402       (concat
5403        (gnus-article-wash-status-entry 'cite cite)
5404        (gnus-article-wash-status-entry 'headers (or headers boring))
5405        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
5406        (gnus-article-wash-status-entry 'signature signature)
5407        (gnus-article-wash-status-entry 'overstrike overstrike)
5408        (gnus-article-wash-status-entry 'emphasis emphasis)))))
5409
5410 (defun gnus-add-wash-type (type)
5411   "Add a washing of TYPE to the current status."
5412   (add-to-list 'gnus-article-wash-types type))
5413
5414 (defun gnus-delete-wash-type (type)
5415   "Add a washing of TYPE to the current status."
5416   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
5417
5418 (defun gnus-add-image (category image)
5419   "Add IMAGE of CATEGORY to the list of displayed images."
5420   (let ((entry (assq category gnus-article-image-alist)))
5421     (unless entry
5422       (setq entry (list category))
5423       (push entry gnus-article-image-alist))
5424     (nconc entry (list image))))
5425
5426 (defun gnus-delete-images (category)
5427   "Delete all images in CATEGORY."
5428   (let ((entry (assq category gnus-article-image-alist)))
5429     (dolist (image (cdr entry))
5430       (gnus-remove-image image category))
5431     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
5432     (gnus-delete-wash-type category)))
5433
5434 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
5435
5436 (defun gnus-article-maybe-hide-headers ()
5437   "Hide unwanted headers if `gnus-have-all-headers' is nil.
5438 Provided for backwards compatibility."
5439   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
5440                  (not (with-current-buffer gnus-summary-buffer
5441                         gnus-have-all-headers)))
5442              (not gnus-inhibit-hiding))
5443     (gnus-article-hide-headers)))
5444
5445 ;;; Article savers.
5446
5447 (defun gnus-output-to-file (file-name)
5448   "Append the current article to a file named FILE-NAME."
5449   (let ((artbuf (current-buffer)))
5450     (with-temp-buffer
5451       (insert-buffer-substring artbuf)
5452       ;; Append newline at end of the buffer as separator, and then
5453       ;; save it to file.
5454       (goto-char (point-max))
5455       (insert "\n")
5456       (let ((file-name-coding-system nnmail-pathname-coding-system))
5457         (mm-append-to-file (point-min) (point-max) file-name))
5458       t)))
5459
5460 (defun gnus-narrow-to-page (&optional arg)
5461   "Narrow the article buffer to a page.
5462 If given a numerical ARG, move forward ARG pages."
5463   (interactive "P")
5464   (setq arg (if arg (prefix-numeric-value arg) 0))
5465   (save-excursion
5466     (set-buffer gnus-article-buffer)
5467     (goto-char (point-min))
5468     (widen)
5469     ;; Remove any old next/prev buttons.
5470     (when (gnus-visual-p 'page-marker)
5471       (let ((inhibit-read-only t))
5472         (gnus-remove-text-with-property 'gnus-prev)
5473         (gnus-remove-text-with-property 'gnus-next)))
5474     (if
5475         (cond ((< arg 0)
5476                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
5477               ((> arg 0)
5478                (re-search-forward page-delimiter nil 'move arg)))
5479         (goto-char (match-end 0))
5480       (save-excursion
5481         (goto-char (point-min))
5482         (setq gnus-page-broken
5483               (and (re-search-forward page-delimiter nil t) t))))
5484     (when gnus-page-broken
5485       (narrow-to-region
5486        (point)
5487        (if (re-search-forward page-delimiter nil 'move)
5488            (match-beginning 0)
5489          (point)))
5490       (when (and (gnus-visual-p 'page-marker)
5491                  (> (point-min) (save-restriction (widen) (point-min))))
5492         (save-excursion
5493           (goto-char (point-min))
5494           (gnus-insert-prev-page-button)))
5495       (when (and (gnus-visual-p 'page-marker)
5496                  (< (point-max) (save-restriction (widen) (point-max))))
5497         (save-excursion
5498           (goto-char (point-max))
5499           (gnus-insert-next-page-button))))))
5500
5501 ;; Article mode commands
5502
5503 (defun gnus-article-goto-next-page ()
5504   "Show the next page of the article."
5505   (interactive)
5506   (when (gnus-article-next-page)
5507     (goto-char (point-min))
5508     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
5509
5510
5511 (defun gnus-article-goto-prev-page ()
5512   "Show the previous page of the article."
5513   (interactive)
5514   (if (bobp)
5515       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
5516     (gnus-article-prev-page nil)))
5517
5518 ;; This is cleaner but currently breaks `gnus-pick-mode':
5519 ;;
5520 ;; (defun gnus-article-goto-next-page ()
5521 ;;   "Show the next page of the article."
5522 ;;   (interactive)
5523 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5524 ;;     (gnus-summary-next-page)))
5525 ;;
5526 ;; (defun gnus-article-goto-prev-page ()
5527 ;;   "Show the next page of the article."
5528 ;;   (interactive)
5529 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5530 ;;     (gnus-summary-prev-page)))
5531
5532 (defun gnus-article-next-page (&optional lines)
5533   "Show the next page of the current article.
5534 If end of article, return non-nil.  Otherwise return nil.
5535 Argument LINES specifies lines to be scrolled up."
5536   (interactive "p")
5537   (move-to-window-line -1)
5538   (if (save-excursion
5539         (end-of-line)
5540         (and (pos-visible-in-window-p)  ;Not continuation line.
5541              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
5542       ;; Nothing in this page.
5543       (if (or (not gnus-page-broken)
5544               (save-excursion
5545                 (save-restriction
5546                   (widen)
5547                   (forward-line)
5548                   (eobp)))) ;Real end-of-buffer?
5549           (progn
5550             (when gnus-article-over-scroll
5551               (gnus-article-next-page-1 lines))
5552             t)                  ;Nothing more.
5553         (gnus-narrow-to-page 1)         ;Go to next page.
5554         nil)
5555     ;; More in this page.
5556     (gnus-article-next-page-1 lines)
5557     nil))
5558
5559 (defmacro gnus-article-beginning-of-window ()
5560   "Move point to the beginning of the window.
5561 In Emacs, the point is placed at the line number which `scroll-margin'
5562 specifies."
5563   (if (featurep 'xemacs)
5564       '(move-to-window-line 0)
5565     '(move-to-window-line
5566       (min (max 0 scroll-margin)
5567            (max 1 (- (window-height)
5568                      (if mode-line-format 1 0)
5569                      (if header-line-format 1 0)))))))
5570
5571 (defun gnus-article-next-page-1 (lines)
5572   (when (and (not (featurep 'xemacs))
5573              (numberp lines)
5574              (> lines 0)
5575              (numberp (symbol-value 'scroll-margin))
5576              (> (symbol-value 'scroll-margin) 0))
5577     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
5578     ;; too many number of lines if `scroll-margin' is set as two or greater.
5579     (setq lines (min lines
5580                      (max 0 (- (count-lines (window-start) (point-max))
5581                                (symbol-value 'scroll-margin))))))
5582   (condition-case ()
5583       (let ((scroll-in-place nil))
5584         (scroll-up lines))
5585     (end-of-buffer
5586      ;; Long lines may cause an end-of-buffer error.
5587      (goto-char (point-max))))
5588   (gnus-article-beginning-of-window))
5589
5590 (defun gnus-article-prev-page (&optional lines)
5591   "Show previous page of current article.
5592 Argument LINES specifies lines to be scrolled down."
5593   (interactive "p")
5594   (move-to-window-line 0)
5595   (if (and gnus-page-broken
5596            (bobp)
5597            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
5598       (progn
5599         (gnus-narrow-to-page -1)        ;Go to previous page.
5600         (goto-char (point-max))
5601         (recenter -1))
5602     (prog1
5603         (condition-case ()
5604             (let ((scroll-in-place nil))
5605               (scroll-down lines))
5606           (beginning-of-buffer
5607            (goto-char (point-min))))
5608       (gnus-article-beginning-of-window))))
5609
5610 (defun gnus-article-only-boring-p ()
5611   "Decide whether there is only boring text remaining in the article.
5612 Something \"interesting\" is a word of at least two letters that does
5613 not have a face in `gnus-article-boring-faces'."
5614   (when (and gnus-article-skip-boring
5615              (boundp 'gnus-article-boring-faces)
5616              (symbol-value 'gnus-article-boring-faces))
5617     (save-excursion
5618       (let ((inhibit-point-motion-hooks t))
5619         (catch 'only-boring
5620           (while (re-search-forward "\\b\\w\\w" nil t)
5621             (forward-char -1)
5622             (when (not (gnus-intersection
5623                         (gnus-faces-at (point))
5624                         (symbol-value 'gnus-article-boring-faces)))
5625               (throw 'only-boring nil)))
5626           (throw 'only-boring t))))))
5627
5628 (defun gnus-article-refer-article ()
5629   "Read article specified by message-id around point."
5630   (interactive)
5631   (save-excursion
5632     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
5633     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
5634     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
5635         (let ((msg-id (concat "<" (match-string 0) ">")))
5636           (set-buffer gnus-summary-buffer)
5637           (gnus-summary-refer-article msg-id))
5638       (error "No references around point"))))
5639
5640 (defun gnus-article-show-summary ()
5641   "Reconfigure windows to show summary buffer."
5642   (interactive)
5643   (if (not (gnus-buffer-live-p gnus-summary-buffer))
5644       (error "There is no summary buffer for this article buffer")
5645     (gnus-article-set-globals)
5646     (gnus-configure-windows 'article)
5647     (gnus-summary-goto-subject gnus-current-article)
5648     (gnus-summary-position-point)))
5649
5650 (defun gnus-article-describe-briefly ()
5651   "Describe article mode commands briefly."
5652   (interactive)
5653   (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")))
5654
5655 (defun gnus-article-summary-command ()
5656   "Execute the last keystroke in the summary buffer."
5657   (interactive)
5658   (let ((obuf (current-buffer))
5659         (owin (current-window-configuration))
5660         func)
5661     (switch-to-buffer gnus-article-current-summary 'norecord)
5662     (setq func (lookup-key (current-local-map) (this-command-keys)))
5663     (call-interactively func)
5664     (set-buffer obuf)
5665     (set-window-configuration owin)
5666     (set-window-point (get-buffer-window (current-buffer)) (point))))
5667
5668 (defun gnus-article-summary-command-nosave ()
5669   "Execute the last keystroke in the summary buffer."
5670   (interactive)
5671   (let (func)
5672     (pop-to-buffer gnus-article-current-summary 'norecord)
5673     (setq func (lookup-key (current-local-map) (this-command-keys)))
5674     (call-interactively func)))
5675
5676 (defun gnus-article-check-buffer ()
5677   "Beep if not in an article buffer."
5678   (unless (equal major-mode 'gnus-article-mode)
5679     (error "Command invoked outside of a Gnus article buffer")))
5680
5681 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
5682   "Read a summary buffer key sequence and execute it from the article buffer."
5683   (interactive "P")
5684   (gnus-article-check-buffer)
5685   (let ((nosaves
5686          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
5687            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
5688            "=" "^" "\M-^" "|"))
5689         (nosave-but-article
5690          '("A\r"))
5691         (nosave-in-article
5692          '("\C-d"))
5693         (up-to-top
5694          '("n" "Gn" "p" "Gp"))
5695         keys new-sum-point)
5696     (save-excursion
5697       (set-buffer gnus-article-current-summary)
5698       (let (gnus-pick-mode)
5699         (push (or key last-command-event) unread-command-events)
5700         (setq keys (if (featurep 'xemacs)
5701                        (events-to-keys (read-key-sequence nil))
5702                      (read-key-sequence nil)))))
5703
5704     (message "")
5705
5706     (if (or (member keys nosaves)
5707             (member keys nosave-but-article)
5708             (member keys nosave-in-article))
5709         (let (func)
5710           (save-window-excursion
5711             (pop-to-buffer gnus-article-current-summary 'norecord)
5712             ;; We disable the pick minor mode commands.
5713             (let (gnus-pick-mode)
5714               (setq func (lookup-key (current-local-map) keys))))
5715           (if (or (not func)
5716                   (numberp func))
5717               (ding)
5718             (unless (member keys nosave-in-article)
5719               (set-buffer gnus-article-current-summary))
5720             (call-interactively func)
5721             (setq new-sum-point (point)))
5722           (when (member keys nosave-but-article)
5723             (pop-to-buffer gnus-article-buffer 'norecord)))
5724       ;; These commands should restore window configuration.
5725       (let ((obuf (current-buffer))
5726             (owin (current-window-configuration))
5727             (opoint (point))
5728             win func in-buffer selected new-sum-start new-sum-hscroll)
5729         (cond (not-restore-window
5730                (pop-to-buffer gnus-article-current-summary 'norecord))
5731               ((setq win (get-buffer-window gnus-article-current-summary))
5732                (select-window win))
5733               (t
5734                (switch-to-buffer gnus-article-current-summary 'norecord)))
5735         (setq in-buffer (current-buffer))
5736         ;; We disable the pick minor mode commands.
5737         (if (and (setq func (let (gnus-pick-mode)
5738                               (lookup-key (current-local-map) keys)))
5739                  (functionp func))
5740             (progn
5741               (call-interactively func)
5742               (when (eq win (selected-window))
5743                 (setq new-sum-point (point)
5744                       new-sum-start (window-start win)
5745                       new-sum-hscroll (window-hscroll win)))
5746               (when (eq in-buffer (current-buffer))
5747                 (setq selected (gnus-summary-select-article))
5748                 (set-buffer obuf)
5749                 (unless not-restore-window
5750                   (set-window-configuration owin))
5751                 (when (eq selected 'old)
5752                   (article-goto-body)
5753                   (set-window-start (get-buffer-window (current-buffer))
5754                                     1)
5755                   (set-window-point (get-buffer-window (current-buffer))
5756                                     (point)))
5757                 (when (and (not not-restore-window)
5758                            new-sum-point)
5759                   (set-window-point win new-sum-point)
5760                   (set-window-start win new-sum-start)
5761                   (set-window-hscroll win new-sum-hscroll))))
5762           (set-window-configuration owin)
5763           (ding))))))
5764
5765 (defun gnus-article-describe-key (key)
5766   "Display documentation of the function invoked by KEY.  KEY is a string."
5767   (interactive "kDescribe key: ")
5768   (gnus-article-check-buffer)
5769   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5770       (save-excursion
5771         (set-buffer gnus-article-current-summary)
5772         (let (gnus-pick-mode)
5773           (if (featurep 'xemacs)
5774               (progn
5775                 (push (elt key 0) unread-command-events)
5776                 (setq key (events-to-keys
5777                            (read-key-sequence "Describe key: "))))
5778             (setq unread-command-events
5779                   (mapcar
5780                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5781                    (string-to-list key)))
5782             (setq key (read-key-sequence "Describe key: "))))
5783         (describe-key key))
5784     (describe-key key)))
5785
5786 (defun gnus-article-describe-key-briefly (key &optional insert)
5787   "Display documentation of the function invoked by KEY.  KEY is a string."
5788   (interactive "kDescribe key: \nP")
5789   (gnus-article-check-buffer)
5790   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
5791       (save-excursion
5792         (set-buffer gnus-article-current-summary)
5793         (let (gnus-pick-mode)
5794           (if (featurep 'xemacs)
5795               (progn
5796                 (push (elt key 0) unread-command-events)
5797                 (setq key (events-to-keys
5798                            (read-key-sequence "Describe key: "))))
5799             (setq unread-command-events
5800                   (mapcar
5801                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
5802                    (string-to-list key)))
5803             (setq key (read-key-sequence "Describe key: "))))
5804         (describe-key-briefly key insert))
5805     (describe-key-briefly key insert)))
5806
5807 (defun gnus-article-reply-with-original (&optional wide)
5808   "Start composing a reply mail to the current message.
5809 The text in the region will be yanked.  If the region isn't active,
5810 the entire article will be yanked."
5811   (interactive "P")
5812   (let ((article (cdr gnus-article-current))
5813         contents)
5814     (if (not (gnus-region-active-p))
5815         (with-current-buffer gnus-summary-buffer
5816           (gnus-summary-reply (list (list article)) wide))
5817       (setq contents (buffer-substring (point) (mark t)))
5818       ;; Deactivate active regions.
5819       (when (and (boundp 'transient-mark-mode)
5820                  transient-mark-mode)
5821         (setq mark-active nil))
5822       (with-current-buffer gnus-summary-buffer
5823         (gnus-summary-reply
5824          (list (list article contents)) wide)))))
5825
5826 (defun gnus-article-followup-with-original ()
5827   "Compose a followup to the current article.
5828 The text in the region will be yanked.  If the region isn't active,
5829 the entire article will be yanked."
5830   (interactive)
5831   (let ((article (cdr gnus-article-current))
5832         contents)
5833       (if (not (gnus-region-active-p))
5834           (with-current-buffer gnus-summary-buffer
5835             (gnus-summary-followup (list (list article))))
5836         (setq contents (buffer-substring (point) (mark t)))
5837         ;; Deactivate active regions.
5838         (when (and (boundp 'transient-mark-mode)
5839                    transient-mark-mode)
5840           (setq mark-active nil))
5841         (with-current-buffer gnus-summary-buffer
5842           (gnus-summary-followup
5843            (list (list article contents)))))))
5844
5845 (defun gnus-article-hide (&optional arg force)
5846   "Hide all the gruft in the current article.
5847 This means that signatures, cited text and (some) headers will be
5848 hidden.
5849 If given a prefix, show the hidden text instead."
5850   (interactive (append (gnus-article-hidden-arg) (list 'force)))
5851   (gnus-article-hide-headers arg)
5852   (gnus-article-hide-list-identifiers arg)
5853   (gnus-article-hide-citation-maybe arg force)
5854   (gnus-article-hide-signature arg))
5855
5856 (defun gnus-article-maybe-highlight ()
5857   "Do some article highlighting if article highlighting is requested."
5858   (when (gnus-visual-p 'article-highlight 'highlight)
5859     (gnus-article-highlight-some)))
5860
5861 (defun gnus-check-group-server ()
5862   ;; Make sure the connection to the server is alive.
5863   (unless (gnus-server-opened
5864            (gnus-find-method-for-group gnus-newsgroup-name))
5865     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5866     (gnus-request-group gnus-newsgroup-name t)))
5867
5868 (eval-when-compile
5869   (autoload 'nneething-get-file-name "nneething"))
5870
5871 (defun gnus-request-article-this-buffer (article group)
5872   "Get an article and insert it into this buffer."
5873   (let (do-update-line sparse-header)
5874     (prog1
5875         (save-excursion
5876           (erase-buffer)
5877           (gnus-kill-all-overlays)
5878           (setq group (or group gnus-newsgroup-name))
5879
5880           ;; Using `gnus-request-article' directly will insert the article into
5881           ;; `nntp-server-buffer' - so we'll save some time by not having to
5882           ;; copy it from the server buffer into the article buffer.
5883
5884           ;; We only request an article by message-id when we do not have the
5885           ;; headers for it, so we'll have to get those.
5886           (when (stringp article)
5887             (gnus-read-header article))
5888
5889           ;; If the article number is negative, that means that this article
5890           ;; doesn't belong in this newsgroup (possibly), so we find its
5891           ;; message-id and request it by id instead of number.
5892           (when (and (numberp article)
5893                      gnus-summary-buffer
5894                      (get-buffer gnus-summary-buffer)
5895                      (gnus-buffer-exists-p gnus-summary-buffer))
5896             (save-excursion
5897               (set-buffer gnus-summary-buffer)
5898               (let ((header (gnus-summary-article-header article)))
5899                 (when (< article 0)
5900                   (cond
5901                    ((memq article gnus-newsgroup-sparse)
5902                     ;; This is a sparse gap article.
5903                     (setq do-update-line article)
5904                     (setq article (mail-header-id header))
5905                     (setq sparse-header (gnus-read-header article))
5906                     (setq gnus-newsgroup-sparse
5907                           (delq article gnus-newsgroup-sparse)))
5908                    ((vectorp header)
5909                     ;; It's a real article.
5910                     (setq article (mail-header-id header)))
5911                    (t
5912                     ;; It is an extracted pseudo-article.
5913                     (setq article 'pseudo)
5914                     (gnus-request-pseudo-article header))))
5915
5916                 (let ((method (gnus-find-method-for-group
5917                                gnus-newsgroup-name)))
5918                   (when (and (eq (car method) 'nneething)
5919                              (vectorp header))
5920                     (let ((dir (nneething-get-file-name
5921                                 (mail-header-id header))))
5922                       (when (and (stringp dir)
5923                                  (file-directory-p dir))
5924                         (setq article 'nneething)
5925                         (gnus-group-enter-directory dir))))))))
5926
5927           (cond
5928            ;; Refuse to select canceled articles.
5929            ((and (numberp article)
5930                  gnus-summary-buffer
5931                  (get-buffer gnus-summary-buffer)
5932                  (gnus-buffer-exists-p gnus-summary-buffer)
5933                  (eq (cdr (with-current-buffer gnus-summary-buffer
5934                             (assq article gnus-newsgroup-reads)))
5935                      gnus-canceled-mark))
5936             nil)
5937            ;; We first check `gnus-original-article-buffer'.
5938            ((and (get-buffer gnus-original-article-buffer)
5939                  (numberp article)
5940                  (with-current-buffer gnus-original-article-buffer
5941                    (and (equal (car gnus-original-article) group)
5942                         (eq (cdr gnus-original-article) article))))
5943             (insert-buffer-substring gnus-original-article-buffer)
5944             'article)
5945            ;; Check the backlog.
5946            ((and gnus-keep-backlog
5947                  (gnus-backlog-request-article group article (current-buffer)))
5948             'article)
5949            ;; Check asynchronous pre-fetch.
5950            ((gnus-async-request-fetched-article group article (current-buffer))
5951             (gnus-async-prefetch-next group article gnus-summary-buffer)
5952             (when (and (numberp article) gnus-keep-backlog)
5953               (gnus-backlog-enter-article group article (current-buffer)))
5954             'article)
5955            ;; Check the cache.
5956            ((and gnus-use-cache
5957                  (numberp article)
5958                  (gnus-cache-request-article article group))
5959             'article)
5960            ;; Check the agent cache.
5961            ((gnus-agent-request-article article group)
5962             'article)
5963            ;; Get the article and put into the article buffer.
5964            ((or (stringp article)
5965                 (numberp article))
5966             (let ((gnus-override-method gnus-override-method)
5967                   (methods (and (stringp article)
5968                                 gnus-refer-article-method))
5969                   (backend (car (gnus-find-method-for-group
5970                                  gnus-newsgroup-name)))
5971                   result
5972                   (inhibit-read-only t))
5973               (if (or (not (listp methods))
5974                       (and (symbolp (car methods))
5975                            (assq (car methods) nnoo-definition-alist)))
5976                   (setq methods (list methods)))
5977               (when (and (null gnus-override-method)
5978                          methods)
5979                 (setq gnus-override-method (pop methods)))
5980               (while (not result)
5981                 (when (eq gnus-override-method 'current)
5982                   (setq gnus-override-method
5983                         (with-current-buffer gnus-summary-buffer
5984                           gnus-current-select-method)))
5985                 (erase-buffer)
5986                 (gnus-kill-all-overlays)
5987                 (let ((gnus-newsgroup-name group))
5988                   (gnus-check-group-server))
5989                 (cond
5990                  ((gnus-request-article article group (current-buffer))
5991                   (when (numberp article)
5992                     (gnus-async-prefetch-next group article
5993                                               gnus-summary-buffer)
5994                     (when gnus-keep-backlog
5995                       (gnus-backlog-enter-article
5996                        group article (current-buffer))))
5997                   (setq result 'article))
5998                  (methods
5999                   (setq gnus-override-method (pop methods)))
6000                  ((not (string-match "^400 "
6001                                      (nnheader-get-report backend)))
6002                   ;; If we get 400 server disconnect, reconnect and
6003                   ;; retry; otherwise, assume the article has expired.
6004                   (setq result 'done))))
6005               (and (eq result 'article) 'article)))
6006            ;; It was a pseudo.
6007            (t article)))
6008
6009       ;; Associate this article with the current summary buffer.
6010       (setq gnus-article-current-summary gnus-summary-buffer)
6011
6012       ;; Take the article from the original article buffer
6013       ;; and place it in the buffer it's supposed to be in.
6014       (when (and (get-buffer gnus-article-buffer)
6015                  (equal (buffer-name (current-buffer))
6016                         (buffer-name (get-buffer gnus-article-buffer))))
6017         (save-excursion
6018           (if (get-buffer gnus-original-article-buffer)
6019               (set-buffer gnus-original-article-buffer)
6020             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6021             (buffer-disable-undo)
6022             (setq major-mode 'gnus-original-article-mode)
6023             (setq buffer-read-only t))
6024           (let ((inhibit-read-only t))
6025             (erase-buffer)
6026             (insert-buffer-substring gnus-article-buffer))
6027           (setq gnus-original-article (cons group article)))
6028
6029         ;; Decode charsets.
6030         (run-hooks 'gnus-article-decode-hook)
6031         ;; Mark article as decoded or not.
6032         (setq gnus-article-decoded-p gnus-article-decode-hook))
6033
6034       ;; Update sparse articles.
6035       (when (and do-update-line
6036                  (or (numberp article)
6037                      (stringp article)))
6038         (let ((buf (current-buffer)))
6039           (set-buffer gnus-summary-buffer)
6040           (gnus-summary-update-article do-update-line sparse-header)
6041           (gnus-summary-goto-subject do-update-line nil t)
6042           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6043                             (point))
6044           (set-buffer buf))))))
6045
6046 ;;;
6047 ;;; Article editing
6048 ;;;
6049
6050 (defcustom gnus-article-edit-mode-hook nil
6051   "Hook run in article edit mode buffers."
6052   :group 'gnus-article-various
6053   :type 'hook)
6054
6055 (defvar gnus-article-edit-done-function nil)
6056
6057 (defvar gnus-article-edit-mode-map nil)
6058
6059 ;; Should we be using derived.el for this?
6060 (unless gnus-article-edit-mode-map
6061   (setq gnus-article-edit-mode-map (make-keymap))
6062   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6063
6064   (gnus-define-keys gnus-article-edit-mode-map
6065     "\C-c?"    describe-mode
6066     "\C-c\C-c" gnus-article-edit-done
6067     "\C-c\C-k" gnus-article-edit-exit
6068     "\C-c\C-f\C-t" message-goto-to
6069     "\C-c\C-f\C-o" message-goto-from
6070     "\C-c\C-f\C-b" message-goto-bcc
6071     ;;"\C-c\C-f\C-w" message-goto-fcc
6072     "\C-c\C-f\C-c" message-goto-cc
6073     "\C-c\C-f\C-s" message-goto-subject
6074     "\C-c\C-f\C-r" message-goto-reply-to
6075     "\C-c\C-f\C-n" message-goto-newsgroups
6076     "\C-c\C-f\C-d" message-goto-distribution
6077     "\C-c\C-f\C-f" message-goto-followup-to
6078     "\C-c\C-f\C-m" message-goto-mail-followup-to
6079     "\C-c\C-f\C-k" message-goto-keywords
6080     "\C-c\C-f\C-u" message-goto-summary
6081     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6082     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6083     "\C-c\C-b" message-goto-body
6084     "\C-c\C-i" message-goto-signature
6085
6086     "\C-c\C-t" message-insert-to
6087     "\C-c\C-n" message-insert-newsgroups
6088     "\C-c\C-o" message-sort-headers
6089     "\C-c\C-e" message-elide-region
6090     "\C-c\C-v" message-delete-not-region
6091     "\C-c\C-z" message-kill-to-signature
6092     "\M-\r" message-newline-and-reformat
6093     "\C-c\C-a" mml-attach-file
6094     "\C-a" message-beginning-of-line
6095     "\t" message-tab
6096     "\M-;" comment-region)
6097
6098   (gnus-define-keys (gnus-article-edit-wash-map
6099                      "\C-c\C-w" gnus-article-edit-mode-map)
6100     "f" gnus-article-edit-full-stops))
6101
6102 (easy-menu-define
6103   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6104   '("Field"
6105     ["Fetch To" message-insert-to t]
6106     ["Fetch Newsgroups" message-insert-newsgroups t]
6107     "----"
6108     ["To" message-goto-to t]
6109     ["From" message-goto-from t]
6110     ["Subject" message-goto-subject t]
6111     ["Cc" message-goto-cc t]
6112     ["Reply-To" message-goto-reply-to t]
6113     ["Summary" message-goto-summary t]
6114     ["Keywords" message-goto-keywords t]
6115     ["Newsgroups" message-goto-newsgroups t]
6116     ["Followup-To" message-goto-followup-to t]
6117     ["Mail-Followup-To" message-goto-mail-followup-to t]
6118     ["Distribution" message-goto-distribution t]
6119     ["Body" message-goto-body t]
6120     ["Signature" message-goto-signature t]))
6121
6122 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6123   "Major mode for editing articles.
6124 This is an extended text-mode.
6125
6126 \\{gnus-article-edit-mode-map}"
6127   (make-local-variable 'gnus-article-edit-done-function)
6128   (make-local-variable 'gnus-prev-winconf)
6129   (set (make-local-variable 'font-lock-defaults)
6130        '(message-font-lock-keywords t))
6131   (set (make-local-variable 'mail-header-separator) "")
6132   (set (make-local-variable 'gnus-article-edit-mode) t)
6133   (easy-menu-add message-mode-field-menu message-mode-map)
6134   (mml-mode)
6135   (setq buffer-read-only nil)
6136   (buffer-enable-undo)
6137   (widen))
6138
6139 (defun gnus-article-edit (&optional force)
6140   "Edit the current article.
6141 This will have permanent effect only in mail groups.
6142 If FORCE is non-nil, allow editing of articles even in read-only
6143 groups."
6144   (interactive "P")
6145   (when (and (not force)
6146              (gnus-group-read-only-p))
6147     (error "The current newsgroup does not support article editing"))
6148   (gnus-article-date-original)
6149   (gnus-article-edit-article
6150    'ignore
6151    `(lambda (no-highlight)
6152       'ignore
6153       (gnus-summary-edit-article-done
6154        ,(or (mail-header-references gnus-current-headers) "")
6155        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6156
6157 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6158   "Start editing the contents of the current article buffer."
6159   (let ((winconf (current-window-configuration)))
6160     (set-buffer gnus-article-buffer)
6161     (let ((message-auto-save-directory
6162            ;; Don't associate the article buffer with a draft file.
6163            nil))
6164       (gnus-article-edit-mode))
6165     (funcall start-func)
6166     (set-buffer-modified-p nil)
6167     (gnus-configure-windows 'edit-article)
6168     (setq gnus-article-edit-done-function exit-func)
6169     (setq gnus-prev-winconf winconf)
6170     (unless quiet
6171       (gnus-message 6 "C-c C-c to end edits"))))
6172
6173 (defun gnus-article-edit-done (&optional arg)
6174   "Update the article edits and exit."
6175   (interactive "P")
6176   (let ((func gnus-article-edit-done-function)
6177         (buf (current-buffer))
6178         (start (window-start))
6179         (p (point))
6180         (winconf gnus-prev-winconf))
6181     (widen) ;; Widen it in case that users narrowed the buffer.
6182     (funcall func arg)
6183     (set-buffer buf)
6184     ;; The cache and backlog have to be flushed somewhat.
6185     (when gnus-keep-backlog
6186       (gnus-backlog-remove-article
6187        (car gnus-article-current) (cdr gnus-article-current)))
6188     ;; Flush original article as well.
6189     (save-excursion
6190       (when (get-buffer gnus-original-article-buffer)
6191         (set-buffer gnus-original-article-buffer)
6192         (setq gnus-original-article nil)))
6193     (when gnus-use-cache
6194       (gnus-cache-update-article
6195        (car gnus-article-current) (cdr gnus-article-current)))
6196     ;; We remove all text props from the article buffer.
6197     (kill-all-local-variables)
6198     (set-text-properties (point-min) (point-max) nil)
6199     (gnus-article-mode)
6200     (set-window-configuration winconf)
6201     (set-buffer buf)
6202     (set-window-start (get-buffer-window buf) start)
6203     (set-window-point (get-buffer-window buf) (point)))
6204   (gnus-summary-show-article))
6205
6206 (defun gnus-article-edit-exit ()
6207   "Exit the article editing without updating."
6208   (interactive)
6209   (when (or (not (buffer-modified-p))
6210             (yes-or-no-p "Article modified; kill anyway? "))
6211     (let ((curbuf (current-buffer))
6212           (p (point))
6213           (window-start (window-start)))
6214       (erase-buffer)
6215       (if (gnus-buffer-live-p gnus-original-article-buffer)
6216           (insert-buffer-substring gnus-original-article-buffer))
6217       (let ((winconf gnus-prev-winconf))
6218         (kill-all-local-variables)
6219         (gnus-article-mode)
6220         (set-window-configuration winconf)
6221         ;; Tippy-toe some to make sure that point remains where it was.
6222         (save-current-buffer
6223           (set-buffer curbuf)
6224           (set-window-start (get-buffer-window (current-buffer)) window-start)
6225           (goto-char p))))
6226     (gnus-summary-show-article)))
6227
6228 (defun gnus-article-edit-full-stops ()
6229   "Interactively repair spacing at end of sentences."
6230   (interactive)
6231   (save-excursion
6232     (goto-char (point-min))
6233     (search-forward-regexp "^$" nil t)
6234     (let ((case-fold-search nil))
6235       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
6236
6237 ;;;
6238 ;;; Article highlights
6239 ;;;
6240
6241 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
6242
6243 ;;; Internal Variables:
6244
6245 (defcustom gnus-button-url-regexp
6246   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
6247       "\\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:]]\\)"
6248     "\\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\\)\\)")
6249   "Regular expression that matches URLs."
6250   :group 'gnus-article-buttons
6251   :type 'regexp)
6252
6253 (defcustom gnus-button-valid-fqdn-regexp
6254   message-valid-fqdn-regexp
6255   "Regular expression that matches a valid FQDN."
6256   :version "22.1"
6257   :group 'gnus-article-buttons
6258   :type 'regexp)
6259
6260 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
6261 (defcustom gnus-button-valid-localpart-regexp
6262   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
6263   "Regular expression that matches a localpart of mail addresses or MIDs."
6264   :version "22.1"
6265   :group 'gnus-article-buttons
6266   :type 'regexp)
6267
6268 (defcustom gnus-button-man-handler 'manual-entry
6269   "Function to use for displaying man pages.
6270 The function must take at least one argument with a string naming the
6271 man page."
6272   :version "22.1"
6273   :type '(choice (function-item :tag "Man" manual-entry)
6274                  (function-item :tag "Woman" woman)
6275                  (function :tag "Other"))
6276   :group 'gnus-article-buttons)
6277
6278 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
6279   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
6280 If the default site is too slow, try to find a CTAN mirror, see
6281 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
6282 the variable `gnus-button-handle-ctan'."
6283   :version "22.1"
6284   :group 'gnus-article-buttons
6285   :link '(custom-manual "(gnus)Group Parameters")
6286   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
6287                  (const "http://tug.ctan.org/tex-archive/")
6288                  (const "http://www.dante.de/CTAN/")
6289                  (string :tag "Other")))
6290
6291 (defcustom gnus-button-ctan-handler 'browse-url
6292   "Function to use for displaying CTAN links.
6293 The function must take one argument, the string naming the URL."
6294   :version "22.1"
6295   :type '(choice (function-item :tag "Browse Url" browse-url)
6296                  (function :tag "Other"))
6297   :group 'gnus-article-buttons)
6298
6299 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
6300   "Bogus strings removed from CTAN URLs."
6301   :version "22.1"
6302   :group 'gnus-article-buttons
6303   :type '(choice (const "^/?tex-archive/\\|/")
6304                  (regexp :tag "Other")))
6305
6306 (defcustom gnus-button-ctan-directory-regexp
6307   (regexp-opt
6308    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
6309          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
6310          "languages" "macros" "nonfree" "obsolete" "support" "systems"
6311          "tds" "tools" "usergrps" "web") t)
6312   "Regular expression for ctan directories.
6313 It should match all directories in the top level of `gnus-ctan-url'."
6314   :version "22.1"
6315   :group 'gnus-article-buttons
6316   :type 'regexp)
6317
6318 (defcustom gnus-button-mid-or-mail-regexp
6319   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
6320           gnus-button-valid-fqdn-regexp
6321           ">?\\)\\b")
6322   "Regular expression that matches a message ID or a mail address."
6323   :version "22.1"
6324   :group 'gnus-article-buttons
6325   :type 'regexp)
6326
6327 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
6328   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
6329 Strings like this can be either a message ID or a mail address.  If it is one
6330 of the symbols `mid' or `mail', Gnus will always assume that the string is a
6331 message ID or a mail address, respectively.  If this variable is set to the
6332 symbol `ask', always query the user what do do.  If it is a function, this
6333 function will be called with the string as it's only argument.  The function
6334 must return `mid', `mail', `invalid' or `ask'."
6335   :version "22.1"
6336   :group 'gnus-article-buttons
6337   :type '(choice (function-item :tag "Heuristic function"
6338                                 gnus-button-mid-or-mail-heuristic)
6339                  (const ask)
6340                  (const mid)
6341                  (const mail)))
6342
6343 (defcustom gnus-button-mid-or-mail-heuristic-alist
6344   '((-10.0 . ".+\\$.+@")
6345     (-10.0 . "#")
6346     (-10.0 . "\\*")
6347     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
6348     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
6349     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
6350     (-1.0  . "^[^a-z]+@")
6351     ;;
6352     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
6353     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
6354     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
6355     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
6356     ;;
6357     (-2.0  . "^[0-9]")
6358     (-1.0  . "^[0-9][0-9]")
6359     ;;
6360     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
6361     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6362     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
6363     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6364     ;;
6365     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
6366     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
6367     ;;       "[0-9]{8,}.*\@"
6368     (-3.0
6369      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
6370     ;; "[0-9]{12,}.*\@"
6371     ;; compensation for TDMA dated mail addresses:
6372     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
6373     ;;
6374     (-20.0 . "\\.fsf@") ;; Gnus
6375     (-20.0 . "^slrn")
6376     (-20.0 . "^Pine")
6377     (-20.0 . "_-_") ;; Subject change in thread
6378     ;;
6379     (-20.0 . "\\.ln@") ;; leafnode
6380     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
6381     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
6382     ;;
6383     ;; (5.0 . "") ;; $local_part_len <= 7
6384     (10.0  . "^[^0-9]+@")
6385     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
6386     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
6387     (3.0   . "\@stud")
6388     ;;
6389     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
6390     ;;
6391     (0.5   . "^[A-Z][a-z]")
6392     (0.5   . "^[A-Z][a-z][a-z]")
6393     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
6394     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
6395   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
6396
6397 A negative RATE indicates a message IDs, whereas a positive indicates a mail
6398 address.  The REGEXP is processed with `case-fold-search' set to nil."
6399   :version "22.1"
6400   :group 'gnus-article-buttons
6401   :type '(repeat (cons (number :tag "Rate")
6402                        (regexp :tag "Regexp"))))
6403
6404 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
6405   "Guess whether MID-OR-MAIL is a message ID or a mail address.
6406 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
6407 address, `ask' if unsure and `invalid' if the string is invalid."
6408   (let ((case-fold-search nil)
6409         (list gnus-button-mid-or-mail-heuristic-alist)
6410         (result 0) rate regexp lpartlen elem)
6411     (setq lpartlen
6412           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
6413     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
6414     ;; Certain special cases...
6415     (when (string-match
6416            (concat
6417             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
6418             "^[0-9]+\\.[0-9]+@compuserve\\|"
6419             "@public\\.gmane\\.org")
6420            mid-or-mail)
6421       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
6422       (setq result 'mail))
6423     (when (string-match "@.*@\\| " mid-or-mail)
6424       (gnus-message 8 "`%s' is invalid." mid-or-mail)
6425       (setq result 'invalid))
6426     ;; Nothing more to do, if result is not a number here...
6427     (when (numberp result)
6428       (while list
6429         (setq elem (car list)
6430               rate (car elem)
6431               regexp (cdr elem)
6432               list (cdr list))
6433         (when (string-match regexp mid-or-mail)
6434           (setq result (+ result rate))
6435           (gnus-message
6436            9 "`%s' matched `%s', rate `%s', result `%s'."
6437            mid-or-mail regexp rate result)))
6438       (when (<= lpartlen 7)
6439         (setq result (+ result 5.0))
6440         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
6441                       mid-or-mail result))
6442       (when (>= lpartlen 12)
6443         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
6444         (cond
6445          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
6446           ;; Long local part should contain realname if e-mail address,
6447           ;; too many digits: message-id.
6448           ;; $score -= 5.0 + 0.1 * $local_part_len;
6449           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
6450           (setq result (+ result rate))
6451           (gnus-message
6452            9 "Many digits in `%s', rate `%s', result `%s'."
6453            mid-or-mail rate result))
6454          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
6455                         mid-or-mail)
6456           ;; Too few vowels [^aeiouy]{4,}.*\@
6457           (setq result (+ result -5.0))
6458           (gnus-message
6459            9 "Few vowels in `%s', rate `%s', result `%s'."
6460            mid-or-mail -5.0 result))
6461          (t
6462           (setq result (+ result 5.0))
6463           (gnus-message
6464            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
6465     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
6466     ;; Maybe we should make this a customizable alist: (condition . 'result)
6467     (cond
6468      ((symbolp result) result)
6469      ;; Now convert number into proper results:
6470      ((< result -10.0) 'mid)
6471      ((> result  10.0) 'mail)
6472      (t 'ask))))
6473
6474 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
6475   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
6476          (url-mid (concat "news" ":" mid-or-mail))
6477          (url-mailto (concat "mailto" ":" mid-or-mail)))
6478     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
6479     (when (fboundp pref)
6480       (setq guessed
6481             ;; get rid of surrounding angles...
6482             (funcall pref
6483                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
6484       (if (or (eq 'mid guessed) (eq 'mail guessed))
6485           (setq pref guessed)
6486         (setq pref 'ask)))
6487     (if (eq pref 'ask)
6488         (save-window-excursion
6489           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
6490               (setq pref 'mail)
6491             (setq pref 'mid))))
6492     (cond ((eq pref 'mid)
6493            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
6494            (gnus-button-handle-news url-mid))
6495           ((eq pref 'mail)
6496            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
6497            (gnus-url-mailto url-mailto))
6498           (t (gnus-message 3 "Invalid string.")))))
6499
6500 (defun gnus-button-handle-custom (fun arg)
6501   "Call function FUN on argument ARG.
6502 Both FUN and ARG are supposed to be strings.  ARG will be passed
6503 as a symbol to FUN."
6504   (funcall (intern fun) (intern arg)))
6505
6506 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
6507
6508 ;; FIXME: Maybe we should merge some of the functions that do quite similar
6509 ;; stuff?
6510
6511 (defun gnus-button-handle-describe-function (url)
6512   "Call `describe-function' when pushing the corresponding URL button."
6513   (describe-function
6514    (intern
6515     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6516
6517 (defun gnus-button-handle-describe-variable (url)
6518   "Call `describe-variable' when pushing the corresponding URL button."
6519   (describe-variable
6520    (intern
6521     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6522
6523 (defun gnus-button-handle-symbol (url)
6524 "Display help on variable or function.
6525 Calls `describe-variable' or `describe-function'."
6526   (let ((sym (intern url)))
6527     (cond
6528      ((fboundp sym) (describe-function sym))
6529      ((boundp sym) (describe-variable sym))
6530      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
6531
6532 (defun gnus-button-handle-describe-key (url)
6533   "Call `describe-key' when pushing the corresponding URL button."
6534   (let* ((key-string
6535           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
6536          (keys (ignore-errors (eval `(kbd ,key-string)))))
6537     (if keys
6538         (describe-key keys)
6539       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
6540
6541 (defun gnus-button-handle-apropos (url)
6542   "Call `apropos' when pushing the corresponding URL button."
6543   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6544
6545 (defun gnus-button-handle-apropos-command (url)
6546   "Call `apropos' when pushing the corresponding URL button."
6547   (apropos-command
6548    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6549
6550 (defun gnus-button-handle-apropos-variable (url)
6551   "Call `apropos' when pushing the corresponding URL button."
6552   (funcall
6553    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
6554    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6555
6556 (defun gnus-button-handle-apropos-documentation (url)
6557   "Call `apropos' when pushing the corresponding URL button."
6558   (funcall
6559    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
6560    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6561
6562 (defun gnus-button-handle-library (url)
6563   "Call `locate-library' when pushing the corresponding URL button."
6564   (gnus-message 9 "url=`%s'" url)
6565   (let* ((lib (locate-library url))
6566          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
6567     (if (not lib)
6568         (gnus-message 1 "Cannot locale library `%s'." url)
6569       (find-file-read-only file))))
6570
6571 (defun gnus-button-handle-ctan (url)
6572   "Call `browse-url' when pushing a CTAN URL button."
6573   (funcall
6574    gnus-button-ctan-handler
6575    (concat
6576     gnus-ctan-url
6577     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
6578
6579 (defcustom gnus-button-tex-level 5
6580   "*Integer that says how many TeX-related buttons Gnus will show.
6581 The higher the number, the more buttons will appear and the more false
6582 positives are possible.  Note that you can set this variable local to
6583 specific groups.  Setting it higher in TeX groups is probably a good idea.
6584 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
6585 how to set variables in specific groups."
6586   :version "22.1"
6587   :group 'gnus-article-buttons
6588   :link '(custom-manual "(gnus)Group Parameters")
6589   :type 'integer)
6590
6591 (defcustom gnus-button-man-level 5
6592   "*Integer that says how many man-related buttons Gnus will show.
6593 The higher the number, the more buttons will appear and the more false
6594 positives are possible.  Note that you can set this variable local to
6595 specific groups.  Setting it higher in Unix groups is probably a good idea.
6596 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
6597 how to set variables in specific groups."
6598   :version "22.1"
6599   :group 'gnus-article-buttons
6600   :link '(custom-manual "(gnus)Group Parameters")
6601   :type 'integer)
6602
6603 (defcustom gnus-button-emacs-level 5
6604   "*Integer that says how many emacs-related buttons Gnus will show.
6605 The higher the number, the more buttons will appear and the more false
6606 positives are possible.  Note that you can set this variable local to
6607 specific groups.  Setting it higher in Emacs or Gnus related groups is
6608 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
6609 `gnus-parameters' on how to set variables in specific groups."
6610   :version "22.1"
6611   :group 'gnus-article-buttons
6612   :link '(custom-manual "(gnus)Group Parameters")
6613   :type 'integer)
6614
6615 (defcustom gnus-button-message-level 5
6616   "*Integer that says how many buttons for news or mail messages will appear.
6617 The higher the number, the more buttons will appear and the more false
6618 positives are possible."
6619   ;; mail addresses, MIDs, URLs for news, ...
6620   :version "22.1"
6621   :group 'gnus-article-buttons
6622   :type 'integer)
6623
6624 (defcustom gnus-button-browse-level 5
6625   "*Integer that says how many buttons for browsing will appear.
6626 The higher the number, the more buttons will appear and the more false
6627 positives are possible."
6628   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
6629   :version "22.1"
6630   :group 'gnus-article-buttons
6631   :type 'integer)
6632
6633 (defcustom gnus-button-alist
6634   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
6635      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
6636     ((concat "\\b\\(nntp\\|news\\):\\("
6637              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
6638      0 t gnus-button-handle-news 2)
6639     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
6640      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
6641     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
6642      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
6643     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
6644     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
6645      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
6646     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
6647      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
6648     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
6649      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
6650     ;; RFC 2368 (The mailto URL scheme)
6651     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6652      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6653     ("\\bmailto:\\([^ \n\t]+\\)"
6654      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6655     ;; CTAN
6656     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
6657              gnus-button-ctan-directory-regexp
6658              "[^][>)!;:,'\n\t ]+\\)")
6659      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
6660     ((concat "\\btex-archive/\\("
6661              gnus-button-ctan-directory-regexp
6662              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
6663      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
6664     ((concat
6665       "\\b\\("
6666       gnus-button-ctan-directory-regexp
6667       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
6668      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
6669     ;; This is info (home-grown style) <info://foo/bar+baz>
6670     ("\\binfo://\\([^'\">\n\t ]+\\)"
6671      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
6672     ;; Info GNOME style <info:foo#bar_baz>
6673     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
6674      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
6675     ;; Info KDE style <info:(foo)bar baz>
6676     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
6677      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
6678     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
6679      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
6680     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
6681      ;; Info links like `C-h i d m CC Mode RET'
6682      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
6683     ;; This is custom
6684     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
6685      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
6686     ;; Emacs help commands
6687     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6688      ;; regexp doesn't match arguments containing ` '.
6689      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
6690     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6691      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
6692     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6693      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
6694     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6695      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
6696     ;; The following entries may lead to many false positives so don't enable
6697     ;; them by default (use a high button level).
6698     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
6699      ;; Exclude [.?] for URLs in gmane.emacs.cvs
6700      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6701     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
6702      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
6703     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
6704      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
6705     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
6706      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
6707     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
6708      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
6709     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6710      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
6711     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6712      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
6713     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
6714      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
6715     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
6716      ;; Unlike the other regexps we really have to require quoting
6717      ;; here to determine where it ends.
6718      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
6719     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
6720     ("<URL: *\\([^<>]*\\)>"
6721      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6722     ;; RFC 2396 (2.4.3., delims) ...
6723     ("\"URL: *\\([^\"]*\\)\""
6724      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6725     ;; RFC 2396 (2.4.3., delims) ...
6726     ("\"URL: *\\([^\"]*\\)\""
6727      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
6728     ;; Raw URLs.
6729     (gnus-button-url-regexp
6730      0 (>= gnus-button-browse-level 0) browse-url 0)
6731     ;; man pages
6732     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
6733      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
6734      gnus-button-handle-man 1)
6735     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
6736     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
6737      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
6738      gnus-button-handle-man 1)
6739     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
6740     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
6741     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
6742      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
6743     ;; Recognizing patches to .el files.  This is somewhat obscure,
6744     ;; but considering the percentage of Gnus users who hack Emacs
6745     ;; Lisp files...
6746     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
6747      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
6748     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
6749      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
6750     ;; MID or mail: To avoid too many false positives we don't try to catch
6751     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
6752     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
6753     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
6754     ;; so that non-ambiguous entries (see above) match first.
6755     (gnus-button-mid-or-mail-regexp
6756      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
6757   "*Alist of regexps matching buttons in article bodies.
6758
6759 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
6760 REGEXP: is the string (case insensitive) matching text around the button (can
6761 also be Lisp expression evaluating to a string),
6762 BUTTON: is the number of the regexp grouping actually matching the button,
6763 FORM: is a Lisp expression which must eval to true for the button to
6764 be added,
6765 CALLBACK: is the function to call when the user push this button, and each
6766 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
6767
6768 CALLBACK can also be a variable, in that case the value of that
6769 variable it the real callback function."
6770   :group 'gnus-article-buttons
6771   :type '(repeat (list (choice regexp variable sexp)
6772                        (integer :tag "Button")
6773                        (sexp :tag "Form")
6774                        (function :tag "Callback")
6775                        (repeat :tag "Par"
6776                                :inline t
6777                                (integer :tag "Regexp group")))))
6778
6779 (defcustom gnus-header-button-alist
6780   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
6781      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
6782     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
6783      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
6784     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
6785      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
6786     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
6787      0 (>= gnus-button-browse-level 0) browse-url 0)
6788     ("^Subject:" gnus-button-url-regexp
6789      0 (>= gnus-button-browse-level 0) browse-url 0)
6790     ("^[^:]+:" gnus-button-url-regexp
6791      0 (>= gnus-button-browse-level 0) browse-url 0)
6792     ("^OpenPGP:.*url=" gnus-button-url-regexp
6793      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
6794     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
6795      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
6796     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
6797      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
6798   "*Alist of headers and regexps to match buttons in article heads.
6799
6800 This alist is very similar to `gnus-button-alist', except that each
6801 alist has an additional HEADER element first in each entry:
6802
6803 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
6804
6805 HEADER is a regexp to match a header.  For a fuller explanation, see
6806 `gnus-button-alist'."
6807   :group 'gnus-article-buttons
6808   :group 'gnus-article-headers
6809   :type '(repeat (list (regexp :tag "Header")
6810                        (choice regexp variable)
6811                        (integer :tag "Button")
6812                        (sexp :tag "Form")
6813                        (function :tag "Callback")
6814                        (repeat :tag "Par"
6815                                :inline t
6816                                (integer :tag "Regexp group")))))
6817
6818 ;;; Commands:
6819
6820 (defun gnus-article-push-button (event)
6821   "Check text under the mouse pointer for a callback function.
6822 If the text under the mouse pointer has a `gnus-callback' property,
6823 call it with the value of the `gnus-data' text property."
6824   (interactive "e")
6825   (set-buffer (window-buffer (posn-window (event-start event))))
6826   (let* ((pos (posn-point (event-start event)))
6827          (data (get-text-property pos 'gnus-data))
6828          (fun (get-text-property pos 'gnus-callback)))
6829     (goto-char pos)
6830     (when fun
6831       (funcall fun data))))
6832
6833 (defun gnus-article-press-button ()
6834   "Check text at point for a callback function.
6835 If the text at point has a `gnus-callback' property,
6836 call it with the value of the `gnus-data' text property."
6837   (interactive)
6838   (let ((data (get-text-property (point) 'gnus-data))
6839         (fun (get-text-property (point) 'gnus-callback)))
6840     (when fun
6841       (funcall fun data))))
6842
6843 (defun gnus-article-highlight (&optional force)
6844   "Highlight current article.
6845 This function calls `gnus-article-highlight-headers',
6846 `gnus-article-highlight-citation',
6847 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6848 do the highlighting.  See the documentation for those functions."
6849   (interactive (list 'force))
6850   (gnus-article-highlight-headers)
6851   (gnus-article-highlight-citation force)
6852   (gnus-article-highlight-signature)
6853   (gnus-article-add-buttons force)
6854   (gnus-article-add-buttons-to-head))
6855
6856 (defun gnus-article-highlight-some (&optional force)
6857   "Highlight current article.
6858 This function calls `gnus-article-highlight-headers',
6859 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
6860 do the highlighting.  See the documentation for those functions."
6861   (interactive (list 'force))
6862   (gnus-article-highlight-headers)
6863   (gnus-article-highlight-signature)
6864   (gnus-article-add-buttons))
6865
6866 (defun gnus-article-highlight-headers ()
6867   "Highlight article headers as specified by `gnus-header-face-alist'."
6868   (interactive)
6869   (gnus-with-article-headers
6870     (let (regexp header-face field-face from hpoints fpoints)
6871       (dolist (entry gnus-header-face-alist)
6872         (goto-char (point-min))
6873         (setq regexp (concat "^\\("
6874                              (if (string-equal "" (nth 0 entry))
6875                                  "[^\t ]"
6876                                (nth 0 entry))
6877                              "\\)")
6878               header-face (nth 1 entry)
6879               field-face (nth 2 entry))
6880         (while (and (re-search-forward regexp nil t)
6881                     (not (eobp)))
6882           (beginning-of-line)
6883           (setq from (point))
6884           (unless (search-forward ":" nil t)
6885             (forward-char 1))
6886           (when (and header-face
6887                      (not (memq (point) hpoints)))
6888             (push (point) hpoints)
6889             (gnus-put-text-property from (point) 'face header-face))
6890           (when (and field-face
6891                      (not (memq (setq from (point)) fpoints)))
6892             (push from fpoints)
6893             (if (re-search-forward "^[^ \t]" nil t)
6894                 (forward-char -2)
6895               (goto-char (point-max)))
6896             (gnus-put-text-property from (point) 'face field-face)))))))
6897
6898 (defun gnus-article-highlight-signature ()
6899   "Highlight the signature in an article.
6900 It does this by highlighting everything after
6901 `gnus-signature-separator' using the face `gnus-signature'."
6902   (interactive)
6903   (gnus-with-article-buffer
6904     (let ((inhibit-point-motion-hooks t))
6905       (save-restriction
6906         (when (and gnus-signature-face
6907                    (gnus-article-narrow-to-signature))
6908           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
6909                             'face gnus-signature-face)
6910           (widen)
6911           (gnus-article-search-signature)
6912           (let ((start (match-beginning 0))
6913                 (end (set-marker (make-marker) (1+ (match-end 0)))))
6914             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
6915                                      end)))))))
6916
6917 (defun gnus-button-in-region-p (b e prop)
6918   "Say whether PROP exists in the region."
6919   (text-property-not-all b e prop nil))
6920
6921 (defun gnus-article-add-buttons (&optional force)
6922   "Find external references in the article and make buttons of them.
6923 \"External references\" are things like Message-IDs and URLs, as
6924 specified by `gnus-button-alist'."
6925   (interactive (list 'force))
6926   (gnus-with-article-buffer
6927     (let ((inhibit-point-motion-hooks t)
6928           (case-fold-search t)
6929           (alist gnus-button-alist)
6930           beg entry regexp)
6931       ;; Remove all old markers.
6932       (let (marker entry new-list)
6933         (while (setq marker (pop gnus-button-marker-list))
6934           (if (or (< marker (point-min)) (>= marker (point-max)))
6935               (push marker new-list)
6936             (goto-char marker)
6937             (when (setq entry (gnus-button-entry))
6938               (put-text-property (match-beginning (nth 1 entry))
6939                                  (match-end (nth 1 entry))
6940                                  'gnus-callback nil))
6941             (set-marker marker nil)))
6942         (setq gnus-button-marker-list new-list))
6943       ;; We skip the headers.
6944       (article-goto-body)
6945       (setq beg (point))
6946       (while (setq entry (pop alist))
6947         (setq regexp (eval (car entry)))
6948         (goto-char beg)
6949         (while (re-search-forward regexp nil t)
6950           (let* ((start (and entry (match-beginning (nth 1 entry))))
6951                  (end (and entry (match-end (nth 1 entry))))
6952                  (from (match-beginning 0)))
6953             (when (and (or (eq t (nth 2 entry))
6954                            (eval (nth 2 entry)))
6955                        (not (gnus-button-in-region-p
6956                              start end 'gnus-callback)))
6957               ;; That optional form returned non-nil, so we add the
6958               ;; button.
6959               (gnus-article-add-button
6960                start end 'gnus-button-push
6961                (car (push (set-marker (make-marker) from)
6962                           gnus-button-marker-list))))))))))
6963
6964 ;; Add buttons to the head of an article.
6965 (defun gnus-article-add-buttons-to-head ()
6966   "Add buttons to the head of the article."
6967   (interactive)
6968   (gnus-with-article-headers
6969     (let (beg end)
6970       (dolist (entry gnus-header-button-alist)
6971         ;; Each alist entry.
6972         (goto-char (point-min))
6973         (while (re-search-forward (car entry) nil t)
6974           ;; Each header matching the entry.
6975           (setq beg (match-beginning 0))
6976           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
6977                              (match-beginning 0))
6978                         (point-max)))
6979           (goto-char beg)
6980           (while (re-search-forward (eval (nth 1 entry)) end t)
6981             ;; Each match within a header.
6982             (let* ((entry (cdr entry))
6983                    (start (match-beginning (nth 1 entry)))
6984                    (end (match-end (nth 1 entry)))
6985                    (form (nth 2 entry)))
6986               (goto-char (match-end 0))
6987               (when (eval form)
6988                 (gnus-article-add-button
6989                  start end (nth 3 entry)
6990                  (buffer-substring (match-beginning (nth 4 entry))
6991                                    (match-end (nth 4 entry)))))))
6992           (goto-char end))))))
6993
6994 ;;; External functions:
6995
6996 (defun gnus-article-add-button (from to fun &optional data)
6997   "Create a button between FROM and TO with callback FUN and data DATA."
6998   (when gnus-article-button-face
6999     (gnus-overlay-put (gnus-make-overlay from to)
7000                       'face gnus-article-button-face))
7001   (gnus-add-text-properties
7002    from to
7003    (nconc (and gnus-article-mouse-face
7004                (list gnus-mouse-face-prop gnus-article-mouse-face))
7005           (list 'gnus-callback fun)
7006           (and data (list 'gnus-data data))))
7007   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7008                          :button-keymap gnus-widget-button-keymap))
7009
7010 ;;; Internal functions:
7011
7012 (defun gnus-article-set-globals ()
7013   (with-current-buffer gnus-summary-buffer
7014     (gnus-set-global-variables)))
7015
7016 (defun gnus-signature-toggle (end)
7017   (gnus-with-article-buffer
7018     (let ((inhibit-point-motion-hooks t))
7019       (if (text-property-any end (point-max) 'article-type 'signature)
7020           (progn
7021             (gnus-delete-wash-type 'signature)
7022             (gnus-remove-text-properties-when
7023              'article-type 'signature end (point-max)
7024              (cons 'article-type (cons 'signature
7025                                        gnus-hidden-properties))))
7026         (gnus-add-wash-type 'signature)
7027         (gnus-add-text-properties-when
7028          'article-type nil end (point-max)
7029          (cons 'article-type (cons 'signature
7030                                    gnus-hidden-properties)))))
7031     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7032       (gnus-set-mode-line 'article))))
7033
7034 (defun gnus-button-entry ()
7035   ;; Return the first entry in `gnus-button-alist' matching this place.
7036   (let ((alist gnus-button-alist)
7037         (entry nil))
7038     (while alist
7039       (setq entry (pop alist))
7040       (if (looking-at (eval (car entry)))
7041           (setq alist nil)
7042         (setq entry nil)))
7043     entry))
7044
7045 (defun gnus-button-push (marker)
7046   ;; Push button starting at MARKER.
7047   (save-excursion
7048     (goto-char marker)
7049     (let* ((entry (gnus-button-entry))
7050            (inhibit-point-motion-hooks t)
7051            (fun (nth 3 entry))
7052            (args (mapcar (lambda (group)
7053                            (let ((string (match-string group)))
7054                              (set-text-properties
7055                               0 (length string) nil string)
7056                              string))
7057                          (nthcdr 4 entry))))
7058       (cond
7059        ((fboundp fun)
7060         (apply fun args))
7061        ((and (boundp fun)
7062              (fboundp (symbol-value fun)))
7063         (apply (symbol-value fun) args))
7064        (t
7065         (gnus-message 1 "You must define `%S' to use this button"
7066                       (cons fun args)))))))
7067
7068 (defun gnus-parse-news-url (url)
7069   (let (scheme server port group message-id articles)
7070     (with-temp-buffer
7071       (insert url)
7072       (goto-char (point-min))
7073       (when (looking-at "\\([A-Za-z]+\\):")
7074         (setq scheme (match-string 1))
7075         (goto-char (match-end 0)))
7076       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7077         (setq server (match-string 1))
7078         (setq port (if (stringp (match-string 3))
7079                        (string-to-number (match-string 3))
7080                      (match-string 3)))
7081         (goto-char (match-end 0)))
7082
7083       (cond
7084        ((looking-at "\\(.*@.*\\)")
7085         (setq message-id (match-string 1)))
7086        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7087         (setq group (match-string 1)
7088               articles (split-string (match-string 2) "-")))
7089        ((looking-at "\\([^/]+\\)/?")
7090         (setq group (match-string 1)))
7091        (t
7092         (error "Unknown news URL syntax"))))
7093     (list scheme server port group message-id articles)))
7094
7095 (defun gnus-button-handle-news (url)
7096   "Fetch a news URL."
7097   (destructuring-bind (scheme server port group message-id articles)
7098       (gnus-parse-news-url url)
7099     (cond
7100      (message-id
7101       (save-excursion
7102         (set-buffer gnus-summary-buffer)
7103         (if server
7104             (let ((gnus-refer-article-method
7105                    (nconc (list (list 'nntp server))
7106                           gnus-refer-article-method))
7107                   (nntp-port-number (or port "nntp")))
7108               (gnus-message 7 "Fetching %s with %s"
7109                             message-id gnus-refer-article-method)
7110               (gnus-summary-refer-article message-id))
7111           (gnus-summary-refer-article message-id))))
7112      (group
7113       (gnus-button-fetch-group url)))))
7114
7115 (defun gnus-button-patch (library line)
7116   "Visit an Emacs Lisp library LIBRARY on line LINE."
7117   (interactive)
7118   (let ((file (locate-library (file-name-nondirectory library))))
7119     (unless file
7120       (error "Couldn't find library %s" library))
7121     (find-file file)
7122     (goto-line (string-to-number line))))
7123
7124 (defun gnus-button-handle-man (url)
7125   "Fetch a man page."
7126   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7127   (when (eq gnus-button-man-handler 'woman)
7128     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7129   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7130   (funcall gnus-button-man-handler url))
7131
7132 (defun gnus-button-handle-info-url (url)
7133   "Fetch an info URL."
7134   (setq url (mm-subst-char-in-string ?+ ?\  url))
7135   (cond
7136    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7137     (gnus-info-find-node
7138      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7139                      "Gnus")
7140              ")" (gnus-url-unhex-string (match-string 2 url)))))
7141    ((string-match "([^)\"]+)[^\"]+" url)
7142     (setq url
7143           (gnus-replace-in-string
7144            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
7145     (gnus-info-find-node url))
7146    (t (error "Can't parse %s" url))))
7147
7148 (defun gnus-button-handle-info-url-gnome (url)
7149   "Fetch GNOME style info URL."
7150   (setq url (mm-subst-char-in-string ?_ ?\  url))
7151   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
7152       (gnus-info-find-node
7153        (concat "("
7154                (gnus-url-unhex-string
7155                  (match-string 1 url))
7156                ")"
7157                (or (gnus-url-unhex-string
7158                     (match-string 2 url))
7159                    "Top")))
7160     (error "Can't parse %s" url)))
7161
7162 (defun gnus-button-handle-info-url-kde (url)
7163   "Fetch KDE style info URL."
7164   (gnus-info-find-node (gnus-url-unhex-string url)))
7165
7166 (defun gnus-button-handle-info-keystrokes (url)
7167   "Call `info' when pushing the corresponding URL button."
7168   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
7169   (info)
7170   (Info-directory)
7171   (Info-menu url))
7172
7173 (defun gnus-button-openpgp (url)
7174   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
7175   (with-temp-buffer
7176     (mm-url-insert-file-contents-external url)
7177     (pgg-snarf-keys-region (point-min) (point-max))
7178     (pgg-display-output-buffer nil nil nil)))
7179
7180 (defun gnus-button-message-id (message-id)
7181   "Fetch MESSAGE-ID."
7182   (with-current-buffer gnus-summary-buffer
7183     (gnus-summary-refer-article message-id)))
7184
7185 (defun gnus-button-fetch-group (address)
7186   "Fetch GROUP specified by ADDRESS."
7187   (if (not (string-match "[:/]" address))
7188       ;; This is just a simple group url.
7189       (gnus-group-read-ephemeral-group address gnus-select-method)
7190     (if (not
7191          (string-match
7192           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
7193           address))
7194         (error "Can't parse %s" address)
7195       (gnus-group-read-ephemeral-group
7196        (match-string 4 address)
7197        `(nntp ,(match-string 1 address)
7198               (nntp-address ,(match-string 1 address))
7199               (nntp-port-number ,(if (match-end 3)
7200                                      (match-string 3 address)
7201                                    "nntp")))
7202        nil nil nil
7203        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
7204
7205 (defun gnus-url-parse-query-string (query &optional downcase)
7206   (let (retval pairs cur key val)
7207     (setq pairs (split-string query "&"))
7208     (while pairs
7209       (setq cur (car pairs)
7210             pairs (cdr pairs))
7211       (if (not (string-match "=" cur))
7212           nil                           ; Grace
7213         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
7214               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
7215         (if downcase
7216             (setq key (downcase key)))
7217         (setq cur (assoc key retval))
7218         (if cur
7219             (setcdr cur (cons val (cdr cur)))
7220           (setq retval (cons (list key val) retval)))))
7221     retval))
7222
7223 (defun gnus-url-mailto (url)
7224   ;; Send mail to someone
7225   (when (string-match "mailto:/*\\(.*\\)" url)
7226     (setq url (substring url (match-beginning 1) nil)))
7227   (let (to args subject func)
7228     (setq args (gnus-url-parse-query-string
7229                 (if (string-match "^\\?" url)
7230                     (substring url 1)
7231                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
7232                       (concat "to=" (match-string 1 url) "&"
7233                               (match-string 2 url))
7234                     (concat "to=" url)))
7235                 t)
7236           subject (cdr-safe (assoc "subject" args)))
7237     (gnus-msg-mail)
7238     (while args
7239       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
7240       (if (fboundp func)
7241           (funcall func)
7242         (message-position-on-field (caar args)))
7243       (insert (gnus-replace-in-string
7244                (mapconcat 'identity (reverse (cdar args)) ", ")
7245                "\r\n" "\n" t))
7246       (setq args (cdr args)))
7247     (if subject
7248         (message-goto-body)
7249       (message-goto-subject))))
7250
7251 (defun gnus-button-embedded-url (address)
7252   "Activate ADDRESS with `browse-url'."
7253   (browse-url (gnus-strip-whitespace address)))
7254
7255 ;;; Next/prev buttons in the article buffer.
7256
7257 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
7258 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
7259
7260 (defvar gnus-prev-page-map
7261   (let ((map (make-sparse-keymap)))
7262     (define-key map gnus-mouse-2 'gnus-button-prev-page)
7263     (define-key map "\r" 'gnus-button-prev-page)
7264     map))
7265
7266 (defvar gnus-next-page-map
7267   (let ((map (make-sparse-keymap)))
7268     (unless (>= emacs-major-version 21)
7269       ;; XEmacs doesn't care.
7270       (set-keymap-parent map gnus-article-mode-map))
7271     (define-key map gnus-mouse-2 'gnus-button-next-page)
7272     (define-key map "\r" 'gnus-button-next-page)
7273     map))
7274
7275 (defun gnus-insert-prev-page-button ()
7276   (let ((b (point))
7277         (inhibit-read-only t))
7278     (gnus-eval-format
7279      gnus-prev-page-line-format nil
7280      `(keymap ,gnus-prev-page-map
7281          gnus-prev t
7282          gnus-callback gnus-article-button-prev-page
7283          article-type annotation))
7284     (widget-convert-button
7285      'link b (if (bolp)
7286                  ;; Exclude a newline.
7287                  (1- (point))
7288                (point))
7289      :action 'gnus-button-prev-page
7290      :button-keymap gnus-prev-page-map)))
7291
7292 (defun gnus-button-next-page (&optional args more-args)
7293   "Go to the next page."
7294   (interactive)
7295   (let ((win (selected-window)))
7296     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7297     (gnus-article-next-page)
7298     (select-window win)))
7299
7300 (defun gnus-button-prev-page (&optional args more-args)
7301   "Go to the prev page."
7302   (interactive)
7303   (let ((win (selected-window)))
7304     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7305     (gnus-article-prev-page)
7306     (select-window win)))
7307
7308 (defun gnus-insert-next-page-button ()
7309   (let ((b (point))
7310         (inhibit-read-only t))
7311     (gnus-eval-format gnus-next-page-line-format nil
7312                       `(keymap ,gnus-next-page-map
7313                           gnus-next t
7314                           gnus-callback gnus-article-button-next-page
7315                           article-type annotation))
7316     (widget-convert-button
7317      'link b (if (bolp)
7318                  ;; Exclude a newline.
7319                  (1- (point))
7320                (point))
7321      :action 'gnus-button-next-page
7322      :button-keymap gnus-next-page-map)))
7323
7324 (defun gnus-article-button-next-page (arg)
7325   "Go to the next page."
7326   (interactive "P")
7327   (let ((win (selected-window)))
7328     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7329     (gnus-article-next-page)
7330     (select-window win)))
7331
7332 (defun gnus-article-button-prev-page (arg)
7333   "Go to the prev page."
7334   (interactive "P")
7335   (let ((win (selected-window)))
7336     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7337     (gnus-article-prev-page)
7338     (select-window win)))
7339
7340 (defvar gnus-decode-header-methods
7341   '(mail-decode-encoded-word-region)
7342   "List of methods used to decode headers.
7343
7344 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
7345 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
7346 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
7347 whose names match REGEXP.
7348
7349 For example:
7350 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
7351  mail-decode-encoded-word-region
7352  (\"chinese\" . rfc1843-decode-region))
7353 ")
7354
7355 (defvar gnus-decode-header-methods-cache nil)
7356
7357 (defun gnus-multi-decode-header (start end)
7358   "Apply the functions from `gnus-encoded-word-methods' that match."
7359   (unless (and gnus-decode-header-methods-cache
7360                (eq gnus-newsgroup-name
7361                    (car gnus-decode-header-methods-cache)))
7362     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
7363     (mapcar (lambda (x)
7364               (if (symbolp x)
7365                   (nconc gnus-decode-header-methods-cache (list x))
7366                 (if (and gnus-newsgroup-name
7367                          (string-match (car x) gnus-newsgroup-name))
7368                     (nconc gnus-decode-header-methods-cache
7369                            (list (cdr x))))))
7370           gnus-decode-header-methods))
7371   (let ((xlist gnus-decode-header-methods-cache))
7372     (pop xlist)
7373     (save-restriction
7374       (narrow-to-region start end)
7375       (while xlist
7376         (funcall (pop xlist) (point-min) (point-max))))))
7377
7378 ;;;
7379 ;;; Treatment top-level handling.
7380 ;;;
7381
7382 (defun gnus-treat-article (condition &optional part-number total-parts type)
7383   (let ((length (- (point-max) (point-min)))
7384         (alist gnus-treatment-function-alist)
7385         (article-goto-body-goes-to-point-min-p t)
7386         (treated-type
7387          (or (not type)
7388              (catch 'found
7389                (let ((list gnus-article-treat-types))
7390                  (while list
7391                    (when (string-match (pop list) type)
7392                      (throw 'found t)))))))
7393         (highlightp (gnus-visual-p 'article-highlight 'highlight))
7394         val elem)
7395     (gnus-run-hooks 'gnus-part-display-hook)
7396     (dolist (elem alist)
7397       (setq val
7398             (save-excursion
7399               (when (gnus-buffer-live-p gnus-summary-buffer)
7400                 (set-buffer gnus-summary-buffer))
7401               (symbol-value (car elem))))
7402       (when (and (or (consp val)
7403                      treated-type)
7404                  (gnus-treat-predicate val)
7405                  (or (not (get (car elem) 'highlight))
7406                      highlightp))
7407         (save-restriction
7408           (funcall (cadr elem)))))))
7409
7410 ;; Dynamic variables.
7411 (eval-when-compile
7412   (defvar part-number)
7413   (defvar total-parts)
7414   (defvar type)
7415   (defvar condition)
7416   (defvar length))
7417
7418 (defun gnus-treat-predicate (val)
7419   (cond
7420    ((null val)
7421     nil)
7422    (condition
7423     (eq condition val))
7424    ((and (listp val)
7425          (stringp (car val)))
7426     (apply 'gnus-or (mapcar `(lambda (s)
7427                                (string-match s ,(or gnus-newsgroup-name "")))
7428                             val)))
7429    ((listp val)
7430     (let ((pred (pop val)))
7431       (cond
7432        ((eq pred 'or)
7433         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
7434        ((eq pred 'and)
7435         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
7436        ((eq pred 'not)
7437         (not (gnus-treat-predicate (car val))))
7438        ((eq pred 'typep)
7439         (equal (car val) type))
7440        (t
7441         (error "%S is not a valid predicate" pred)))))
7442    ((eq val t)
7443     t)
7444    ((eq val 'head)
7445     nil)
7446    ((eq val 'first)
7447     (eq part-number 1))
7448    ((eq val 'last)
7449     (eq part-number total-parts))
7450    ((numberp val)
7451     (< length val))
7452    (t
7453     (error "%S is not a valid value" val))))
7454
7455 (defun gnus-article-encrypt-body (protocol &optional n)
7456   "Encrypt the article body."
7457   (interactive
7458    (list
7459     (or gnus-article-encrypt-protocol
7460         (completing-read "Encrypt protocol: "
7461                          gnus-article-encrypt-protocol-alist
7462                          nil t))
7463     current-prefix-arg))
7464   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
7465     (unless func
7466       (error "Can't find the encrypt protocol %s" protocol))
7467     (if (member gnus-newsgroup-name '("nndraft:delayed"
7468                                       "nndraft:drafts"
7469                                       "nndraft:queue"))
7470         (error "Can't encrypt the article in group %s"
7471                gnus-newsgroup-name))
7472     (gnus-summary-iterate n
7473       (save-excursion
7474         (set-buffer gnus-summary-buffer)
7475         (let ((mail-parse-charset gnus-newsgroup-charset)
7476               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
7477               (summary-buffer gnus-summary-buffer)
7478               references point)
7479           (gnus-set-global-variables)
7480           (when (gnus-group-read-only-p)
7481             (error "The current newsgroup does not support article encrypt"))
7482           (gnus-summary-show-article t)
7483           (setq references
7484               (or (mail-header-references gnus-current-headers) ""))
7485           (set-buffer gnus-article-buffer)
7486           (let* ((inhibit-read-only t)
7487                  (headers
7488                   (mapcar (lambda (field)
7489                             (and (save-restriction
7490                                    (message-narrow-to-head)
7491                                    (goto-char (point-min))
7492                                    (search-forward field nil t))
7493                                  (prog2
7494                                      (message-narrow-to-field)
7495                                      (buffer-string)
7496                                    (delete-region (point-min) (point-max))
7497                                    (widen))))
7498                           '("Content-Type:" "Content-Transfer-Encoding:"
7499                             "Content-Disposition:"))))
7500             (message-narrow-to-head)
7501             (message-remove-header "MIME-Version")
7502             (goto-char (point-max))
7503             (setq point (point))
7504             (insert (apply 'concat headers))
7505             (widen)
7506             (narrow-to-region point (point-max))
7507             (let ((message-options message-options))
7508               (message-options-set 'message-sender user-mail-address)
7509               (message-options-set 'message-recipients user-mail-address)
7510               (message-options-set 'message-sign-encrypt 'not)
7511               (funcall func))
7512             (goto-char (point-min))
7513             (insert "MIME-Version: 1.0\n")
7514             (widen)
7515             (gnus-summary-edit-article-done
7516              references nil summary-buffer t))
7517           (when gnus-keep-backlog
7518             (gnus-backlog-remove-article
7519              (car gnus-article-current) (cdr gnus-article-current)))
7520           (save-excursion
7521             (when (get-buffer gnus-original-article-buffer)
7522               (set-buffer gnus-original-article-buffer)
7523               (setq gnus-original-article nil)))
7524           (when gnus-use-cache
7525             (gnus-cache-update-article
7526              (car gnus-article-current) (cdr gnus-article-current))))))))
7527
7528 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
7529   "The following specs can be used:
7530 %t  The security MIME type
7531 %i  Additional info
7532 %d  Details
7533 %D  Details if button is pressed")
7534
7535 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
7536   "The following specs can be used:
7537 %t  The security MIME type
7538 %i  Additional info
7539 %d  Details
7540 %D  Details if button is pressed")
7541
7542 (defvar gnus-mime-security-button-line-format-alist
7543   '((?t gnus-tmp-type ?s)
7544     (?i gnus-tmp-info ?s)
7545     (?d gnus-tmp-details ?s)
7546     (?D gnus-tmp-pressed-details ?s)))
7547
7548 (defvar gnus-mime-security-button-commands
7549   '((gnus-article-press-button "\r" "Show Detail")
7550     (undefined "v")
7551     (undefined "t")
7552     (undefined "C")
7553     (gnus-mime-security-save-part "o" "Save...")
7554     (undefined "\C-o")
7555     (undefined "r")
7556     (undefined "d")
7557     (undefined "c")
7558     (undefined "i")
7559     (undefined "E")
7560     (undefined "e")
7561     (undefined "p")
7562     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
7563     (undefined ".")))
7564
7565 (defvar gnus-mime-security-button-map
7566   (let ((map (make-sparse-keymap)))
7567     (define-key map gnus-mouse-2 'gnus-article-push-button)
7568     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
7569     (dolist (c gnus-mime-security-button-commands)
7570       (define-key map (cadr c) (car c)))
7571     map))
7572
7573 (easy-menu-define
7574   gnus-mime-security-button-menu gnus-mime-security-button-map
7575   "Security button menu."
7576   `("Security Part"
7577     ,@(delq nil
7578             (mapcar (lambda (c)
7579                       (unless (eq (car c) 'undefined)
7580                         (vector (caddr c) (car c) :active t)))
7581                     gnus-mime-security-button-commands))))
7582
7583 (defun gnus-mime-security-button-menu (event prefix)
7584   "Construct a context-sensitive menu of security commands."
7585   (interactive "e\nP")
7586   (save-window-excursion
7587     (let ((pos (event-start event)))
7588       (select-window (posn-window pos))
7589       (goto-char (posn-point pos))
7590       (gnus-article-check-buffer)
7591       (popup-menu gnus-mime-security-button-menu nil prefix))))
7592
7593 (defvar gnus-mime-security-details-buffer nil)
7594
7595 (defvar gnus-mime-security-button-pressed nil)
7596
7597 (defvar gnus-mime-security-show-details-inline t
7598   "If non-nil, show details in the article buffer.")
7599
7600 (defun gnus-mime-security-verify-or-decrypt (handle)
7601   (mm-remove-parts (cdr handle))
7602   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
7603         point (inhibit-read-only t))
7604     (if region
7605         (goto-char (car region)))
7606     (save-restriction
7607       (narrow-to-region (point) (point))
7608       (with-current-buffer (mm-handle-multipart-original-buffer handle)
7609         (let* ((mm-verify-option 'known)
7610                (mm-decrypt-option 'known)
7611                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
7612           (unless (eq nparts (cdr handle))
7613             (mm-destroy-parts (cdr handle))
7614             (setcdr handle nparts))))
7615       (setq point (point))
7616       (gnus-mime-display-security handle)
7617       (goto-char (point-max)))
7618     (when region
7619       (delete-region (point) (cdr region))
7620       (set-marker (car region) nil)
7621       (set-marker (cdr region) nil))
7622     (goto-char point)))
7623
7624 (defun gnus-mime-security-show-details (handle)
7625   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
7626     (if (not details)
7627         (gnus-message 5 "No details.")
7628       (if gnus-mime-security-show-details-inline
7629           (let ((gnus-mime-security-button-pressed
7630                  (not (get-text-property (point) 'gnus-mime-details)))
7631                 (gnus-mime-security-button-line-format
7632                  (get-text-property (point) 'gnus-line-format))
7633                 (inhibit-read-only t))
7634             (forward-char -1)
7635             (while (eq (get-text-property (point) 'gnus-line-format)
7636                        gnus-mime-security-button-line-format)
7637               (forward-char -1))
7638             (forward-char)
7639             (save-restriction
7640               (narrow-to-region (point) (point))
7641               (gnus-insert-mime-security-button handle))
7642             (delete-region (point)
7643                            (or (text-property-not-all
7644                                 (point) (point-max)
7645                                 'gnus-line-format
7646                                 gnus-mime-security-button-line-format)
7647                                (point-max))))
7648         ;; Not inlined.
7649         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
7650             (with-current-buffer gnus-mime-security-details-buffer
7651               (erase-buffer)
7652               t)
7653           (setq gnus-mime-security-details-buffer
7654                 (gnus-get-buffer-create "*MIME Security Details*")))
7655         (with-current-buffer gnus-mime-security-details-buffer
7656           (insert details)
7657           (goto-char (point-min)))
7658         (pop-to-buffer gnus-mime-security-details-buffer)))))
7659
7660 (defun gnus-mime-security-press-button (handle)
7661   (save-excursion
7662     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
7663         (gnus-mime-security-show-details handle)
7664       (gnus-mime-security-verify-or-decrypt handle))))
7665
7666 (defun gnus-insert-mime-security-button (handle &optional displayed)
7667   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
7668          (gnus-tmp-type
7669           (concat
7670            (or (nth 2 (assoc protocol mm-verify-function-alist))
7671                (nth 2 (assoc protocol mm-decrypt-function-alist))
7672                "Unknown")
7673            (if (equal (car handle) "multipart/signed")
7674                " Signed" " Encrypted")
7675            " Part"))
7676          (gnus-tmp-info
7677           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
7678               "Undecided"))
7679          (gnus-tmp-details
7680           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
7681          gnus-tmp-pressed-details
7682          b e)
7683     (setq gnus-tmp-details
7684           (if gnus-tmp-details
7685               (concat "\n" gnus-tmp-details)
7686             ""))
7687     (setq gnus-tmp-pressed-details
7688           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
7689     (unless (bolp)
7690       (insert "\n"))
7691     (setq b (point))
7692     (gnus-eval-format
7693      gnus-mime-security-button-line-format
7694      gnus-mime-security-button-line-format-alist
7695      `(keymap ,gnus-mime-security-button-map
7696          gnus-callback gnus-mime-security-press-button
7697          gnus-line-format ,gnus-mime-security-button-line-format
7698          gnus-mime-details ,gnus-mime-security-button-pressed
7699          article-type annotation
7700          gnus-data ,handle))
7701     (setq e (if (bolp)
7702                 ;; Exclude a newline.
7703                 (1- (point))
7704               (point)))
7705     (widget-convert-button
7706      'link b e
7707      :mime-handle handle
7708      :action 'gnus-widget-press-button
7709      :button-keymap gnus-mime-security-button-map
7710      :help-echo
7711      (lambda (widget/window &optional overlay pos)
7712        ;; Needed to properly clear the message due to a bug in
7713        ;; wid-edit (XEmacs only).
7714        (when (boundp 'help-echo-owns-message)
7715          (setq help-echo-owns-message t))
7716        (format
7717         "%S: show detail; %S: more options"
7718         (aref gnus-mouse-2 0)
7719         (aref gnus-down-mouse-3 0))))))
7720
7721 (defun gnus-mime-display-security (handle)
7722   (save-restriction
7723     (narrow-to-region (point) (point))
7724     (unless (gnus-unbuttonized-mime-type-p (car handle))
7725       (gnus-insert-mime-security-button handle))
7726     (gnus-mime-display-part (cadr handle))
7727     (unless (bolp)
7728       (insert "\n"))
7729     (unless (gnus-unbuttonized-mime-type-p (car handle))
7730       (let ((gnus-mime-security-button-line-format
7731              gnus-mime-security-button-end-line-format))
7732         (gnus-insert-mime-security-button handle)))
7733     (mm-set-handle-multipart-parameter
7734      handle 'gnus-region
7735      (cons (set-marker (make-marker) (point-min))
7736            (set-marker (make-marker) (point-max))))))
7737
7738 (defun gnus-mime-security-run-function (function)
7739   "Run FUNCTION with the security part under point."
7740   (gnus-article-check-buffer)
7741   (let ((data (get-text-property (point) 'gnus-data))
7742         buffer handle)
7743     (when (and (stringp (car-safe data))
7744                (setq buffer (mm-handle-multipart-original-buffer data))
7745                (setq handle (cadr data)))
7746       (if (bufferp (mm-handle-buffer handle))
7747           (progn
7748             (setq handle (cons buffer (copy-sequence (cdr handle))))
7749             (mm-handle-set-undisplayer handle nil))
7750         (setq handle (mm-make-handle
7751                       buffer
7752                       (mm-handle-multipart-ctl-parameter handle 'protocol)
7753                       nil nil nil nil nil nil)))
7754       (funcall function handle))))
7755
7756 (defun gnus-mime-security-save-part ()
7757   "Save the security part under point."
7758   (interactive)
7759   (gnus-mime-security-run-function 'mm-save-part))
7760
7761 (defun gnus-mime-security-pipe-part ()
7762   "Pipe the security part under point to a process."
7763   (interactive)
7764   (gnus-mime-security-run-function 'mm-pipe-part))
7765
7766 (gnus-ems-redefine)
7767
7768 (provide 'gnus-art)
7769
7770 (run-hooks 'gnus-art-load-hook)
7771
7772 ;;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
7773 ;;; gnus-art.el ends here