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