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