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