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