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