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