The ChangeLog entry was committed, but the code change wasn't. This
[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 (memq article gnus-newsgroup-undownloaded)
3576                     (progn
3577                       (gnus-summary-set-agent-mark article)
3578                       (message "Message marked for downloading"))
3579                   (gnus-summary-mark-article article gnus-canceled-mark)
3580                   (unless (memq article gnus-newsgroup-sparse)
3581                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
3582           (if (or (eq result 'pseudo)
3583                   (eq result 'nneething))
3584               (progn
3585                 (save-excursion
3586                   (set-buffer summary-buffer)
3587                   (push article gnus-newsgroup-history)
3588                   (setq gnus-last-article gnus-current-article
3589                         gnus-current-article 0
3590                         gnus-current-headers nil
3591                         gnus-article-current nil)
3592                   (if (eq result 'nneething)
3593                       (gnus-configure-windows 'summary)
3594                     (gnus-configure-windows 'article))
3595                   (gnus-set-global-variables))
3596                 (let ((gnus-article-mime-handle-alist-1
3597                        gnus-article-mime-handle-alist))
3598                   (gnus-set-mode-line 'article)))
3599             ;; The result from the `request' was an actual article -
3600             ;; or at least some text that is now displayed in the
3601             ;; article buffer.
3602             (when (and (numberp article)
3603                        (not (eq article gnus-current-article)))
3604               ;; Seems like a new article has been selected.
3605               ;; `gnus-current-article' must be an article number.
3606               (save-excursion
3607                 (set-buffer summary-buffer)
3608                 (push article gnus-newsgroup-history)
3609                 (setq gnus-last-article gnus-current-article
3610                       gnus-current-article article
3611                       gnus-current-headers
3612                       (gnus-summary-article-header gnus-current-article)
3613                       gnus-article-current
3614                       (cons gnus-newsgroup-name gnus-current-article))
3615                 (unless (vectorp gnus-current-headers)
3616                   (setq gnus-current-headers nil))
3617                 (gnus-summary-goto-subject gnus-current-article)
3618                 (when (gnus-summary-show-thread)
3619                   ;; If the summary buffer really was folded, the
3620                   ;; previous goto may not actually have gone to
3621                   ;; the right article, but the thread root instead.
3622                   ;; So we go again.
3623                   (gnus-summary-goto-subject gnus-current-article))
3624                 (gnus-run-hooks 'gnus-mark-article-hook)
3625                 (gnus-set-mode-line 'summary)
3626                 (when (gnus-visual-p 'article-highlight 'highlight)
3627                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
3628                 ;; Set the global newsgroup variables here.
3629                 (gnus-set-global-variables)
3630                 (setq gnus-have-all-headers
3631                       (or all-headers gnus-show-all-headers))))
3632             (save-excursion
3633               (gnus-configure-windows 'article))
3634             (when (or (numberp article)
3635                       (stringp article))
3636               (gnus-article-prepare-display)
3637               ;; Do page break.
3638               (goto-char (point-min))
3639               (setq gnus-page-broken
3640                     (when gnus-break-pages
3641                       (gnus-narrow-to-page)
3642                       t)))
3643             (let ((gnus-article-mime-handle-alist-1
3644                    gnus-article-mime-handle-alist))
3645               (gnus-set-mode-line 'article))
3646             (article-goto-body)
3647             (unless (bobp)
3648               (forward-line -1))
3649             (set-window-point (get-buffer-window (current-buffer)) (point))
3650             (gnus-configure-windows 'article)
3651             t))))))
3652
3653 ;;;###autoload
3654 (defun gnus-article-prepare-display ()
3655   "Make the current buffer look like a nice article."
3656   ;; Hooks for getting information from the article.
3657   ;; This hook must be called before being narrowed.
3658   (let ((gnus-article-buffer (current-buffer))
3659         buffer-read-only)
3660     (unless (eq major-mode 'gnus-article-mode)
3661       (gnus-article-mode))
3662     (setq buffer-read-only nil
3663           gnus-article-wash-types nil
3664           gnus-article-image-alist nil)
3665     (gnus-run-hooks 'gnus-tmp-internal-hook)
3666     (when gnus-display-mime-function
3667       (funcall gnus-display-mime-function))
3668     (gnus-run-hooks 'gnus-article-prepare-hook)))
3669
3670 ;;;
3671 ;;; Gnus MIME viewing functions
3672 ;;;
3673
3674 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
3675   "Format of the MIME buttons.
3676
3677 Valid specifiers include:
3678 %t  The MIME type
3679 %T  MIME type, along with additional info
3680 %n  The `name' parameter
3681 %d  The description, if any
3682 %l  The length of the encoded part
3683 %p  The part identifier number
3684 %e  Dots if the part isn't displayed
3685
3686 General format specifiers can also be used.  See Info node
3687 `(gnus)Formatting Variables'.")
3688
3689 (defvar gnus-mime-button-line-format-alist
3690   '((?t gnus-tmp-type ?s)
3691     (?T gnus-tmp-type-long ?s)
3692     (?n gnus-tmp-name ?s)
3693     (?d gnus-tmp-description ?s)
3694     (?p gnus-tmp-id ?s)
3695     (?l gnus-tmp-length ?d)
3696     (?e gnus-tmp-dots ?s)))
3697
3698 (defvar gnus-mime-button-commands
3699   '((gnus-article-press-button "\r" "Toggle Display")
3700     (gnus-mime-view-part "v" "View Interactively...")
3701     (gnus-mime-view-part-as-type "t" "View As Type...")
3702     (gnus-mime-view-part-as-charset "C" "View As charset...")
3703     (gnus-mime-save-part "o" "Save...")
3704     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
3705     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
3706     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
3707     (gnus-mime-view-part-internally "E" "View Internally")
3708     (gnus-mime-view-part-externally "e" "View Externally")
3709     (gnus-mime-print-part "p" "Print")
3710     (gnus-mime-pipe-part "|" "Pipe To Command...")
3711     (gnus-mime-action-on-part "." "Take action on the part")))
3712
3713 (defun gnus-article-mime-part-status ()
3714   (if gnus-article-mime-handle-alist-1
3715       (if (eq 1 (length gnus-article-mime-handle-alist-1))
3716           " (1 part)"
3717         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
3718     ""))
3719
3720 (defvar gnus-mime-button-map
3721   (let ((map (make-sparse-keymap)))
3722     (unless (>= (string-to-number emacs-version) 21)
3723       ;; XEmacs doesn't care.
3724       (set-keymap-parent map gnus-article-mode-map))
3725     (define-key map gnus-mouse-2 'gnus-article-push-button)
3726     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
3727     (dolist (c gnus-mime-button-commands)
3728       (define-key map (cadr c) (car c)))
3729     map))
3730
3731 (defun gnus-mime-button-menu (event)
3732   "Construct a context-sensitive menu of MIME commands."
3733   (interactive "e")
3734   (save-window-excursion
3735     (let ((pos (event-start event)))
3736       (select-window (posn-window pos))
3737       (goto-char (posn-point pos))
3738       (gnus-article-check-buffer)
3739       (let ((response (x-popup-menu
3740                        t `("MIME Part"
3741                            ("" ,@(mapcar (lambda (c)
3742                                            (cons (caddr c) (car c)))
3743                                          gnus-mime-button-commands))))))
3744         (if response
3745             (call-interactively response))))))
3746
3747 (defun gnus-mime-view-all-parts (&optional handles)
3748   "View all the MIME parts."
3749   (interactive)
3750   (save-current-buffer
3751     (set-buffer gnus-article-buffer)
3752     (let ((handles (or handles gnus-article-mime-handles))
3753           (mail-parse-charset gnus-newsgroup-charset)
3754           (mail-parse-ignored-charsets
3755            (with-current-buffer gnus-summary-buffer
3756              gnus-newsgroup-ignored-charsets)))
3757       (when handles
3758         (mm-remove-parts handles)
3759         (goto-char (point-min))
3760         (or (search-forward "\n\n") (goto-char (point-max)))
3761         (let (buffer-read-only)
3762           (delete-region (point) (point-max))
3763           (mm-display-parts handles))))))
3764
3765 (defun gnus-mime-save-part-and-strip ()
3766   "Save the MIME part under point then replace it with an external body."
3767   (interactive)
3768   (gnus-article-check-buffer)
3769   (let* ((data (get-text-property (point) 'gnus-data))
3770          file param
3771          (handles gnus-article-mime-handles))
3772     (if (mm-multiple-handles gnus-article-mime-handles)
3773         (error "This function is not implemented"))
3774     (setq file (and data (mm-save-part data)))
3775     (when file
3776       (with-current-buffer (mm-handle-buffer data)
3777         (erase-buffer)
3778         (insert "Content-Type: " (mm-handle-media-type data))
3779         (mml-insert-parameter-string (cdr (mm-handle-type data))
3780                                      '(charset))
3781         (insert "\n")
3782         (insert "Content-ID: " (message-make-message-id) "\n")
3783         (insert "Content-Transfer-Encoding: binary\n")
3784         (insert "\n"))
3785       (setcdr data
3786               (cdr (mm-make-handle nil
3787                                    `("message/external-body"
3788                                      (access-type . "LOCAL-FILE")
3789                                      (name . ,file)))))
3790       (set-buffer gnus-summary-buffer)
3791       (gnus-article-edit-article
3792        `(lambda ()
3793            (erase-buffer)
3794            (let ((mail-parse-charset (or gnus-article-charset
3795                                          ',gnus-newsgroup-charset))
3796                  (mail-parse-ignored-charsets
3797                   (or gnus-article-ignored-charsets
3798                       ',gnus-newsgroup-ignored-charsets))
3799                  (mbl mml-buffer-list))
3800              (setq mml-buffer-list nil)
3801              (insert-buffer gnus-original-article-buffer)
3802              (mime-to-mml ',handles)
3803              (setq gnus-article-mime-handles nil)
3804              (let ((mbl1 mml-buffer-list))
3805                (setq mml-buffer-list mbl)
3806                (set (make-local-variable 'mml-buffer-list) mbl1))
3807              ;; LOCAL argument of add-hook differs between GNU Emacs
3808              ;; and XEmacs. make-local-hook makes sure they are local.
3809              (make-local-hook 'kill-buffer-hook)
3810              (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
3811        `(lambda (no-highlight)
3812           (let ((mail-parse-charset (or gnus-article-charset
3813                                         ',gnus-newsgroup-charset))
3814                 (message-options message-options)
3815                 (message-options-set-recipient)
3816                 (mail-parse-ignored-charsets
3817                  (or gnus-article-ignored-charsets
3818                      ',gnus-newsgroup-ignored-charsets)))
3819            (mml-to-mime)
3820            (mml-destroy-buffers)
3821            (remove-hook 'kill-buffer-hook
3822                         'mml-destroy-buffers t)
3823            (kill-local-variable 'mml-buffer-list))
3824           (gnus-summary-edit-article-done
3825            ,(or (mail-header-references gnus-current-headers) "")
3826            ,(gnus-group-read-only-p)
3827            ,gnus-summary-buffer no-highlight))))))
3828
3829 (defun gnus-mime-save-part ()
3830   "Save the MIME part under point."
3831   (interactive)
3832   (gnus-article-check-buffer)
3833   (let ((data (get-text-property (point) 'gnus-data)))
3834     (when data
3835       (mm-save-part data))))
3836
3837 (defun gnus-mime-pipe-part ()
3838   "Pipe the MIME part under point to a process."
3839   (interactive)
3840   (gnus-article-check-buffer)
3841   (let ((data (get-text-property (point) 'gnus-data)))
3842     (when data
3843       (mm-pipe-part data))))
3844
3845 (defun gnus-mime-view-part ()
3846   "Interactively choose a viewing method for the MIME part under point."
3847   (interactive)
3848   (gnus-article-check-buffer)
3849   (let ((data (get-text-property (point) 'gnus-data)))
3850     (when data
3851       (setq gnus-article-mime-handles
3852             (mm-merge-handles
3853              gnus-article-mime-handles (setq data (copy-sequence data))))
3854       (mm-interactively-view-part data))))
3855
3856 (defun gnus-mime-view-part-as-type-internal ()
3857   (gnus-article-check-buffer)
3858   (let* ((name (mail-content-type-get
3859                 (mm-handle-type (get-text-property (point) 'gnus-data))
3860                 'name))
3861          (def-type (and name (mm-default-file-encoding name))))
3862     (and def-type (cons def-type 0))))
3863
3864 (defun gnus-mime-view-part-as-type (&optional mime-type)
3865   "Choose a MIME media type, and view the part as such."
3866   (interactive)
3867   (unless mime-type
3868     (setq mime-type (completing-read
3869                      "View as MIME type: "
3870                      (mapcar #'list (mailcap-mime-types))
3871                      nil nil
3872                      (gnus-mime-view-part-as-type-internal))))
3873   (gnus-article-check-buffer)
3874   (let ((handle (get-text-property (point) 'gnus-data)))
3875     (when handle
3876       (setq handle
3877             (mm-make-handle (mm-handle-buffer handle)
3878                             (cons mime-type (cdr (mm-handle-type handle)))
3879                             (mm-handle-encoding handle)
3880                             (mm-handle-undisplayer handle)
3881                             (mm-handle-disposition handle)
3882                             (mm-handle-description handle)
3883                             nil
3884                             (mm-handle-id handle)))
3885       (setq gnus-article-mime-handles
3886             (mm-merge-handles gnus-article-mime-handles handle))
3887       (gnus-mm-display-part handle))))
3888
3889 (eval-when-compile
3890   (require 'jka-compr))
3891
3892 ;; jka-compr.el uses a "sh -c" to direct stderr to err-file, but these days
3893 ;; emacs can do that itself.
3894 ;;
3895 (defun gnus-mime-jka-compr-maybe-uncompress ()
3896   "Uncompress the current buffer if `auto-compression-mode' is enabled.
3897 The uncompress method used is derived from `buffer-file-name'."
3898   (when (and (fboundp 'jka-compr-installed-p)
3899              (jka-compr-installed-p))
3900     (let ((info (jka-compr-get-compression-info buffer-file-name)))
3901       (when info
3902         (let ((basename (file-name-nondirectory buffer-file-name))
3903               (args     (jka-compr-info-uncompress-args    info))
3904               (prog     (jka-compr-info-uncompress-program info))
3905               (message  (jka-compr-info-uncompress-message info))
3906               (err-file (jka-compr-make-temp-name)))
3907           (if message
3908               (message "%s %s..." message basename))
3909           (unwind-protect
3910               (unless (memq (apply 'call-process-region
3911                                    (point-min) (point-max) 
3912                                    prog
3913                                    t (list t err-file) nil
3914                                    args)
3915                             jka-compr-acceptable-retval-list)
3916                 (jka-compr-error prog args basename message err-file))
3917             (jka-compr-delete-temp-file err-file)))))))
3918
3919 (defun gnus-mime-copy-part (&optional handle)
3920   "Put the MIME part under point into a new buffer.
3921 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
3922 are decompressed."
3923   (interactive)
3924   (gnus-article-check-buffer)
3925   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3926          (contents (and handle (mm-get-part handle)))
3927          (base (and handle
3928                     (file-name-nondirectory
3929                      (or
3930                       (mail-content-type-get (mm-handle-type handle) 'name)
3931                       (mail-content-type-get (mm-handle-disposition handle)
3932                                              'filename)
3933                       "*decoded*"))))
3934          (buffer (and base (generate-new-buffer base))))
3935     (when contents
3936       (switch-to-buffer buffer)
3937       (insert contents)
3938       ;; We do it this way to make `normal-mode' set the appropriate mode.
3939       (unwind-protect
3940           (progn
3941             (setq buffer-file-name (expand-file-name base))
3942             (gnus-mime-jka-compr-maybe-uncompress)
3943             (normal-mode))
3944         (setq buffer-file-name nil))
3945       (goto-char (point-min)))))
3946
3947 (defun gnus-mime-print-part (&optional handle filename)
3948   "Print the MIME part under point."
3949   (interactive (list nil (ps-print-preprint current-prefix-arg)))
3950   (gnus-article-check-buffer)
3951   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3952          (contents (and handle (mm-get-part handle)))
3953          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
3954          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
3955     (when contents
3956         (if printer
3957             (unwind-protect
3958                 (progn
3959                   (mm-save-part-to-file handle file)
3960                   (call-process shell-file-name nil
3961                                 (generate-new-buffer " *mm*")
3962                                 nil
3963                                 shell-command-switch
3964                                 (mm-mailcap-command
3965                                  printer file (mm-handle-type handle))))
3966               (delete-file file))
3967           (with-temp-buffer
3968             (insert contents)
3969             (gnus-print-buffer))
3970           (ps-despool filename)))))
3971
3972 (defun gnus-mime-inline-part (&optional handle arg)
3973   "Insert the MIME part under point into the current buffer."
3974   (interactive (list nil current-prefix-arg))
3975   (gnus-article-check-buffer)
3976   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3977          contents charset
3978          (b (point))
3979          buffer-read-only)
3980     (when handle
3981       (if (and (not arg) (mm-handle-undisplayer handle))
3982           (mm-remove-part handle)
3983         (setq contents (mm-get-part handle))
3984         (cond
3985          ((not arg)
3986           (setq charset (or (mail-content-type-get
3987                              (mm-handle-type handle) 'charset)
3988                             gnus-newsgroup-charset)))
3989          ((numberp arg)
3990           (if (mm-handle-undisplayer handle)
3991               (mm-remove-part handle))
3992           (setq charset
3993                 (or (cdr (assq arg
3994                                gnus-summary-show-article-charset-alist))
3995                     (mm-read-coding-system "Charset: ")))))
3996         (forward-line 2)
3997         (mm-insert-inline handle
3998                           (if (and charset
3999                                    (setq charset (mm-charset-to-coding-system
4000                                                   charset))
4001                                    (not (eq charset 'ascii)))
4002                               (mm-decode-coding-string contents charset)
4003                             contents))
4004         (goto-char b)))))
4005
4006 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4007   "Insert the MIME part under point into the current buffer using the
4008 specified charset."
4009   (interactive (list nil current-prefix-arg))
4010   (gnus-article-check-buffer)
4011   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4012          contents charset
4013          (b (point))
4014          buffer-read-only)
4015     (when handle
4016       (if (mm-handle-undisplayer handle)
4017           (mm-remove-part handle))
4018       (let ((gnus-newsgroup-charset
4019              (or (cdr (assq arg
4020                             gnus-summary-show-article-charset-alist))
4021                  (mm-read-coding-system "Charset: ")))
4022           (gnus-newsgroup-ignored-charsets 'gnus-all))
4023         (gnus-article-press-button)))))
4024
4025 (defun gnus-mime-view-part-externally (&optional handle)
4026   "View the MIME part under point with an external viewer."
4027   (interactive)
4028   (gnus-article-check-buffer)
4029   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4030          (mm-user-display-methods nil)
4031          (mm-inlined-types nil)
4032          (mail-parse-charset gnus-newsgroup-charset)
4033          (mail-parse-ignored-charsets
4034           (save-excursion (set-buffer gnus-summary-buffer)
4035                           gnus-newsgroup-ignored-charsets)))
4036     (when handle
4037       (if (mm-handle-undisplayer handle)
4038           (mm-remove-part handle)
4039         (mm-display-part handle)))))
4040
4041 (defun gnus-mime-view-part-internally (&optional handle)
4042   "View the MIME part under point with an internal viewer.
4043 If no internal viewer is available, use an external viewer."
4044   (interactive)
4045   (gnus-article-check-buffer)
4046   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4047          (mm-inlined-types '(".*"))
4048          (mm-inline-large-images t)
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          buffer-read-only)
4054     (when handle
4055       (if (mm-handle-undisplayer handle)
4056           (mm-remove-part handle)
4057         (mm-display-part handle)))))
4058
4059 (defun gnus-mime-action-on-part (&optional action)
4060   "Do something with the MIME attachment at \(point\)."
4061   (interactive
4062    (list (completing-read "Action: " gnus-mime-action-alist)))
4063   (gnus-article-check-buffer)
4064   (let ((action-pair (assoc action gnus-mime-action-alist)))
4065     (if action-pair
4066         (funcall (cdr action-pair)))))
4067
4068 (defun gnus-article-part-wrapper (n function)
4069   (save-current-buffer
4070     (set-buffer gnus-article-buffer)
4071     (when (> n (length gnus-article-mime-handle-alist))
4072       (error "No such part"))
4073     (gnus-article-goto-part n)
4074     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4075       (funcall function handle))))
4076
4077 (defun gnus-article-pipe-part (n)
4078   "Pipe MIME part N, which is the numerical prefix."
4079   (interactive "p")
4080   (gnus-article-part-wrapper n 'mm-pipe-part))
4081
4082 (defun gnus-article-save-part (n)
4083   "Save MIME part N, which is the numerical prefix."
4084   (interactive "p")
4085   (gnus-article-part-wrapper n 'mm-save-part))
4086
4087 (defun gnus-article-interactively-view-part (n)
4088   "View MIME part N interactively, which is the numerical prefix."
4089   (interactive "p")
4090   (gnus-article-part-wrapper n 'mm-interactively-view-part))
4091
4092 (defun gnus-article-copy-part (n)
4093   "Copy MIME part N, which is the numerical prefix."
4094   (interactive "p")
4095   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
4096
4097 (defun gnus-article-view-part-as-charset (n)
4098   "Copy MIME part N, which is the numerical prefix."
4099   (interactive "p")
4100   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
4101
4102 (defun gnus-article-view-part-externally (n)
4103   "View MIME part N externally, which is the numerical prefix."
4104   (interactive "p")
4105   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
4106
4107 (defun gnus-article-inline-part (n)
4108   "Inline MIME part N, which is the numerical prefix."
4109   (interactive "p")
4110   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
4111
4112 (defun gnus-article-mime-match-handle-first (condition)
4113   (if condition
4114       (let ((alist gnus-article-mime-handle-alist) ihandle n)
4115         (while (setq ihandle (pop alist))
4116           (if (and (cond
4117                     ((functionp condition)
4118                      (funcall condition (cdr ihandle)))
4119                     ((eq condition 'undisplayed)
4120                      (not (or (mm-handle-undisplayer (cdr ihandle))
4121                               (equal (mm-handle-media-type (cdr ihandle))
4122                                      "multipart/alternative"))))
4123                     ((eq condition 'undisplayed-alternative)
4124                      (not (mm-handle-undisplayer (cdr ihandle))))
4125                     (t t))
4126                    (gnus-article-goto-part (car ihandle))
4127                    (or (not n) (< (car ihandle) n)))
4128               (setq n (car ihandle))))
4129         (or n 1))
4130     1))
4131
4132 (defun gnus-article-view-part (&optional n)
4133   "View MIME part N, which is the numerical prefix."
4134   (interactive "P")
4135   (save-current-buffer
4136     (set-buffer gnus-article-buffer)
4137     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
4138                              gnus-article-mime-match-handle-function)))
4139     (when (> n (length gnus-article-mime-handle-alist))
4140       (error "No such part"))
4141     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
4142       (when (gnus-article-goto-part n)
4143         (if (equal (car handle) "multipart/alternative")
4144             (gnus-article-press-button)
4145           (when (eq (gnus-mm-display-part handle) 'internal)
4146             (gnus-set-window-start)))))))
4147
4148 (defsubst gnus-article-mime-total-parts ()
4149   (if (bufferp (car gnus-article-mime-handles))
4150       1 ;; single part
4151     (1- (length gnus-article-mime-handles))))
4152
4153 (defun gnus-mm-display-part (handle)
4154   "Display HANDLE and fix MIME button."
4155   (let ((id (get-text-property (point) 'gnus-part))
4156         (point (point))
4157         buffer-read-only)
4158     (forward-line 1)
4159     (prog1
4160         (let ((window (selected-window))
4161               (mail-parse-charset gnus-newsgroup-charset)
4162               (mail-parse-ignored-charsets
4163                (if (gnus-buffer-live-p gnus-summary-buffer)
4164                    (save-excursion
4165                      (set-buffer gnus-summary-buffer)
4166                      gnus-newsgroup-ignored-charsets)
4167                  nil)))
4168           (save-excursion
4169             (unwind-protect
4170                 (let ((win (gnus-get-buffer-window (current-buffer) t))
4171                       (beg (point)))
4172                   (when win
4173                     (select-window win))
4174                   (goto-char point)
4175                   (forward-line)
4176                   (if (mm-handle-displayed-p handle)
4177                       ;; This will remove the part.
4178                       (mm-display-part handle)
4179                     (save-restriction
4180                       (narrow-to-region (point)
4181                                         (if (eobp) (point) (1+ (point))))
4182                       (mm-display-part handle)
4183                       ;; We narrow to the part itself and
4184                       ;; then call the treatment functions.
4185                       (goto-char (point-min))
4186                       (forward-line 1)
4187                       (narrow-to-region (point) (point-max))
4188                       (gnus-treat-article
4189                        nil id
4190                        (gnus-article-mime-total-parts)
4191                        (mm-handle-media-type handle)))))
4192               (if (window-live-p window)
4193                   (select-window window)))))
4194       (goto-char point)
4195       (delete-region (gnus-point-at-bol) (progn (forward-line 1) (point)))
4196       (gnus-insert-mime-button
4197        handle id (list (mm-handle-displayed-p handle)))
4198       (goto-char point))))
4199
4200 (defun gnus-article-goto-part (n)
4201   "Go to MIME part N."
4202   (let ((point (text-property-any (point-min) (point-max) 'gnus-part n)))
4203     (when point
4204       (goto-char point))))
4205
4206 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
4207   (let ((gnus-tmp-name
4208          (or (mail-content-type-get (mm-handle-type handle) 'name)
4209              (mail-content-type-get (mm-handle-disposition handle) 'filename)
4210              (mail-content-type-get (mm-handle-type handle) 'url)
4211              ""))
4212         (gnus-tmp-type (mm-handle-media-type handle))
4213         (gnus-tmp-description
4214          (mail-decode-encoded-word-string (or (mm-handle-description handle)
4215                                               "")))
4216         (gnus-tmp-dots
4217          (if (if displayed (car displayed)
4218                (mm-handle-displayed-p handle))
4219              "" "..."))
4220         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
4221                            (buffer-size)))
4222         gnus-tmp-type-long b e)
4223     (when (string-match ".*/" gnus-tmp-name)
4224       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
4225     (setq gnus-tmp-type-long (concat gnus-tmp-type
4226                                      (and (not (equal gnus-tmp-name ""))
4227                                           (concat "; " gnus-tmp-name))))
4228     (unless (equal gnus-tmp-description "")
4229       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
4230     (unless (bolp)
4231       (insert "\n"))
4232     (setq b (point))
4233     (gnus-eval-format
4234      gnus-mime-button-line-format gnus-mime-button-line-format-alist
4235      `(,@(gnus-local-map-property gnus-mime-button-map)
4236          gnus-callback gnus-mm-display-part
4237          gnus-part ,gnus-tmp-id
4238          article-type annotation
4239          gnus-data ,handle))
4240     (setq e (point))
4241     (widget-convert-button
4242      'link b e
4243      :mime-handle handle
4244      :action 'gnus-widget-press-button
4245      :button-keymap gnus-mime-button-map
4246      :help-echo
4247      (lambda (widget/window &optional overlay pos)
4248        ;; Needed to properly clear the message due to a bug in
4249        ;; wid-edit (XEmacs only).
4250        (if (boundp 'help-echo-owns-message)
4251            (setq help-echo-owns-message t))
4252        (format
4253         "%S: %s the MIME part; %S: more options"
4254         (aref gnus-mouse-2 0)
4255         ;; XEmacs will get a single widget arg; Emacs 21 will get
4256         ;; window, overlay, position.
4257         (if (mm-handle-displayed-p
4258              (if overlay
4259                  (with-current-buffer (gnus-overlay-buffer overlay)
4260                    (widget-get (widget-at (gnus-overlay-start overlay))
4261                                :mime-handle))
4262                (widget-get widget/window :mime-handle)))
4263             "hide" "show")
4264         (aref gnus-down-mouse-3 0))))))
4265
4266 (defun gnus-widget-press-button (elems el)
4267   (goto-char (widget-get elems :from))
4268   (gnus-article-press-button))
4269
4270 (defvar gnus-displaying-mime nil)
4271
4272 (defun gnus-display-mime (&optional ihandles)
4273   "Display the MIME parts."
4274   (save-excursion
4275     (save-selected-window
4276       (let ((window (get-buffer-window gnus-article-buffer))
4277             (point (point)))
4278         (when window
4279           (select-window window)
4280           ;; We have to do this since selecting the window
4281           ;; may change the point.  So we set the window point.
4282           (set-window-point window point)))
4283       (let* ((handles (or ihandles
4284                           (mm-dissect-buffer nil gnus-article-loose-mime)
4285                           (and gnus-article-emulate-mime
4286                                (mm-uu-dissect))))
4287              buffer-read-only handle name type b e display)
4288         (when (and (not ihandles)
4289                    (not gnus-displaying-mime))
4290           ;; Top-level call; we clean up.
4291           (when gnus-article-mime-handles
4292             (mm-destroy-parts gnus-article-mime-handles)
4293             (setq gnus-article-mime-handle-alist nil));; A trick.
4294           (setq gnus-article-mime-handles handles)
4295           ;; We allow users to glean info from the handles.
4296           (when gnus-article-mime-part-function
4297             (gnus-mime-part-function handles)))
4298         (if (and handles
4299                  (or (not (stringp (car handles)))
4300                      (cdr handles)))
4301             (progn
4302               (when (and (not ihandles)
4303                          (not gnus-displaying-mime))
4304                 ;; Clean up for mime parts.
4305                 (article-goto-body)
4306                 (delete-region (point) (point-max)))
4307               (let ((gnus-displaying-mime t))
4308                 (gnus-mime-display-part handles)))
4309           (save-restriction
4310             (article-goto-body)
4311             (narrow-to-region (point) (point-max))
4312             (gnus-treat-article nil 1 1)
4313             (widen)))
4314         (unless ihandles
4315           ;; Highlight the headers.
4316           (save-excursion
4317             (save-restriction
4318               (article-goto-body)
4319               (narrow-to-region (point-min) (point))
4320               (gnus-treat-article 'head))))))))
4321
4322 (defvar gnus-mime-display-multipart-as-mixed nil)
4323 (defvar gnus-mime-display-multipart-alternative-as-mixed nil)
4324 (defvar gnus-mime-display-multipart-related-as-mixed nil)
4325
4326 (defun gnus-mime-display-part (handle)
4327   (cond
4328    ;; Single part.
4329    ((not (stringp (car handle)))
4330     (gnus-mime-display-single handle))
4331    ;; User-defined multipart
4332    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
4333     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
4334              handle))
4335    ;; multipart/alternative
4336    ((and (equal (car handle) "multipart/alternative")
4337          (not (or gnus-mime-display-multipart-as-mixed
4338                   gnus-mime-display-multipart-alternative-as-mixed)))
4339     (let ((id (1+ (length gnus-article-mime-handle-alist))))
4340       (push (cons id handle) gnus-article-mime-handle-alist)
4341       (gnus-mime-display-alternative (cdr handle) nil nil id)))
4342    ;; multipart/related
4343    ((and (equal (car handle) "multipart/related")
4344          (not (or gnus-mime-display-multipart-as-mixed
4345                   gnus-mime-display-multipart-related-as-mixed)))
4346     ;;;!!!We should find the start part, but we just default
4347     ;;;!!!to the first part.
4348     ;;(gnus-mime-display-part (cadr handle))
4349     ;;;!!! Most multipart/related is an HTML message plus images.
4350     ;;;!!! Unfortunately we are unable to let W3 display those
4351     ;;;!!! included images, so we just display it as a mixed multipart.
4352     ;;(gnus-mime-display-mixed (cdr handle))
4353     ;;;!!! No, w3 can display everything just fine.
4354     (gnus-mime-display-part (cadr handle)))
4355    ((equal (car handle) "multipart/signed")
4356     (gnus-add-wash-type 'signed)
4357     (gnus-mime-display-security handle))
4358    ((equal (car handle) "multipart/encrypted")
4359     (gnus-add-wash-type 'encrypted)
4360     (gnus-mime-display-security handle))
4361    ;; Other multiparts are handled like multipart/mixed.
4362    (t
4363     (gnus-mime-display-mixed (cdr handle)))))
4364
4365 (defun gnus-mime-part-function (handles)
4366   (if (stringp (car handles))
4367       (mapcar 'gnus-mime-part-function (cdr handles))
4368     (funcall gnus-article-mime-part-function handles)))
4369
4370 (defun gnus-mime-display-mixed (handles)
4371   (mapcar 'gnus-mime-display-part handles))
4372
4373 (defun gnus-mime-display-single (handle)
4374   (let ((type (mm-handle-media-type handle))
4375         (ignored gnus-ignored-mime-types)
4376         (not-attachment t)
4377         (move nil)
4378         display text)
4379     (catch 'ignored
4380       (progn
4381         (while ignored
4382           (when (string-match (pop ignored) type)
4383             (throw 'ignored nil)))
4384         (if (and (setq not-attachment
4385                        (and (not (mm-inline-override-p handle))
4386                             (or (not (mm-handle-disposition handle))
4387                                 (equal (car (mm-handle-disposition handle))
4388                                        "inline")
4389                                 (mm-attachment-override-p handle))))
4390                  (mm-automatic-display-p handle)
4391                  (or (and
4392                       (mm-inlinable-p handle)
4393                       (mm-inlined-p handle))
4394                      (mm-automatic-external-display-p type)))
4395             (setq display t)
4396           (when (equal (mm-handle-media-supertype handle) "text")
4397             (setq text t)))
4398         (let ((id (1+ (length gnus-article-mime-handle-alist)))
4399               beg)
4400           (push (cons id handle) gnus-article-mime-handle-alist)
4401           (when (or (not display)
4402                     (not (gnus-unbuttonized-mime-type-p type)))
4403             ;(gnus-article-insert-newline)
4404             (gnus-insert-mime-button
4405              handle id (list (or display (and not-attachment text))))
4406             (gnus-article-insert-newline)
4407             ;(gnus-article-insert-newline)
4408             ;; Remember modify the number of forward lines.
4409             (setq move t))
4410           (setq beg (point))
4411           (cond
4412            (display
4413             (when move
4414               (forward-line -1)
4415               (setq beg (point)))
4416             (let ((mail-parse-charset gnus-newsgroup-charset)
4417                   (mail-parse-ignored-charsets
4418                    (save-excursion (condition-case ()
4419                                        (set-buffer gnus-summary-buffer)
4420                                      (error))
4421                                    gnus-newsgroup-ignored-charsets)))
4422               (mm-display-part handle t))
4423             (goto-char (point-max)))
4424            ((and text not-attachment)
4425             (when move
4426               (forward-line -1)
4427               (setq beg (point)))
4428             (gnus-article-insert-newline)
4429             (mm-insert-inline handle (mm-get-part handle))
4430             (goto-char (point-max))))
4431           ;; Do highlighting.
4432           (save-excursion
4433             (save-restriction
4434               (narrow-to-region beg (point))
4435               (gnus-treat-article
4436                nil id
4437                (gnus-article-mime-total-parts)
4438                (mm-handle-media-type handle)))))))))
4439
4440 (defun gnus-unbuttonized-mime-type-p (type)
4441   "Say whether TYPE is to be unbuttonized."
4442   (unless gnus-inhibit-mime-unbuttonizing
4443     (when (catch 'found
4444             (let ((types gnus-unbuttonized-mime-types))
4445               (while types
4446                 (when (string-match (pop types) type)
4447                   (throw 'found t)))))
4448       (not (catch 'found
4449              (let ((types gnus-buttonized-mime-types))
4450                (while types
4451                  (when (string-match (pop types) type)
4452                    (throw 'found t)))))))))
4453
4454 (defun gnus-article-insert-newline ()
4455   "Insert a newline, but mark it as undeletable."
4456   (gnus-put-text-property
4457    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
4458
4459 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
4460   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
4461          (ihandles handles)
4462          (point (point))
4463          handle buffer-read-only from props begend not-pref)
4464     (save-window-excursion
4465       (save-restriction
4466         (when ibegend
4467           (narrow-to-region (car ibegend)
4468                             (or (cdr ibegend)
4469                                 (progn
4470                                   (goto-char (car ibegend))
4471                                   (forward-line 2)
4472                                   (point))))
4473           (delete-region (point-min) (point-max))
4474           (mm-remove-parts handles))
4475         (setq begend (list (point-marker)))
4476         ;; Do the toggle.
4477         (unless (setq not-pref (cadr (member preferred ihandles)))
4478           (setq not-pref (car ihandles)))
4479         (when (or ibegend
4480                   (not preferred)
4481                   (not (gnus-unbuttonized-mime-type-p
4482                         "multipart/alternative")))
4483           (gnus-add-text-properties
4484            (setq from (point))
4485            (progn
4486              (insert (format "%d.  " id))
4487              (point))
4488            `(gnus-callback
4489              (lambda (handles)
4490                (unless ,(not ibegend)
4491                  (setq gnus-article-mime-handle-alist
4492                        ',gnus-article-mime-handle-alist))
4493                (gnus-mime-display-alternative
4494                 ',ihandles ',not-pref ',begend ,id))
4495              ,@(gnus-local-map-property gnus-mime-button-map)
4496              ,gnus-mouse-face-prop ,gnus-article-mouse-face
4497              face ,gnus-article-button-face
4498              gnus-part ,id
4499              gnus-data ,handle))
4500           (widget-convert-button 'link from (point)
4501                                  :action 'gnus-widget-press-button
4502                                  :button-keymap gnus-widget-button-keymap)
4503           ;; Do the handles
4504           (while (setq handle (pop handles))
4505             (gnus-add-text-properties
4506              (setq from (point))
4507              (progn
4508                (insert (format "(%c) %-18s"
4509                                (if (equal handle preferred) ?* ? )
4510                                (mm-handle-media-type handle)))
4511                (point))
4512              `(gnus-callback
4513                (lambda (handles)
4514                  (unless ,(not ibegend)
4515                    (setq gnus-article-mime-handle-alist
4516                          ',gnus-article-mime-handle-alist))
4517                  (gnus-mime-display-alternative
4518                   ',ihandles ',handle ',begend ,id))
4519                ,@(gnus-local-map-property gnus-mime-button-map)
4520                ,gnus-mouse-face-prop ,gnus-article-mouse-face
4521                face ,gnus-article-button-face
4522                gnus-part ,id
4523                gnus-data ,handle))
4524             (widget-convert-button 'link from (point)
4525                                    :action 'gnus-widget-press-button
4526                                    :button-keymap gnus-widget-button-keymap)
4527             (insert "  "))
4528           (insert "\n\n"))
4529         (when preferred
4530           (if (stringp (car preferred))
4531               (gnus-display-mime preferred)
4532             (let ((mail-parse-charset gnus-newsgroup-charset)
4533                   (mail-parse-ignored-charsets
4534                    (save-excursion (set-buffer gnus-summary-buffer)
4535                                    gnus-newsgroup-ignored-charsets)))
4536               (mm-display-part preferred)
4537               ;; Do highlighting.
4538               (save-excursion
4539                 (save-restriction
4540                   (narrow-to-region (car begend) (point-max))
4541                   (gnus-treat-article
4542                    nil (length gnus-article-mime-handle-alist)
4543                    (gnus-article-mime-total-parts)
4544                    (mm-handle-media-type handle))))))
4545           (goto-char (point-max))
4546           (setcdr begend (point-marker)))))
4547     (when ibegend
4548       (goto-char point))))
4549
4550 (defconst gnus-article-wash-status-strings
4551   (let ((alist '((cite "c" "Possible hidden citation text"
4552                        " " "All citation text visible")
4553                  (headers "h" "Hidden headers"
4554                           " " "All headers visible.")
4555                  (pgp "p" "Encrypted or signed message status hidden"
4556                       " " "No hidden encryption nor digital signature status")
4557                  (signature "s" "Signature has been hidden"
4558                             " " "Signature is visible")
4559                  (overstrike "o" "Overstrike (^H) characters applied"
4560                              " " "No overstrike characters applied")
4561                  (emphasis "e" "/*_Emphasis_*/ characters applied"
4562                            " " "No /*_emphasis_*/ characters applied")))
4563         result)
4564     (dolist (entry alist result)
4565       (let ((key (nth 0 entry))
4566             (on (copy-sequence (nth 1 entry)))
4567             (on-help (nth 2 entry))
4568             (off (copy-sequence (nth 3 entry)))
4569             (off-help (nth 4 entry)))
4570         (put-text-property 0 1 'help-echo on-help on)
4571         (put-text-property 0 1 'help-echo off-help off)
4572         (push (list key on off) result))))
4573   "Alist of strings describing wash status in the mode line.
4574 Each entry has the form (KEY ON OF), where the KEY is a symbol
4575 representing the particular washing function, ON is the string to use
4576 in the article mode line when the washing function is active, and OFF
4577 is the string to use when it is inactive.")
4578
4579 (defun gnus-article-wash-status-entry (key value)
4580   (let ((entry (assoc key gnus-article-wash-status-strings)))
4581     (if value (nth 1 entry) (nth 2 entry))))
4582
4583 (defun gnus-article-wash-status ()
4584   "Return a string which display status of article washing."
4585   (save-excursion
4586     (set-buffer gnus-article-buffer)
4587     (let ((cite (memq 'cite gnus-article-wash-types))
4588           (headers (memq 'headers gnus-article-wash-types))
4589           (boring (memq 'boring-headers gnus-article-wash-types))
4590           (pgp (memq 'pgp gnus-article-wash-types))
4591           (pem (memq 'pem gnus-article-wash-types))
4592           (signed (memq 'signed gnus-article-wash-types))
4593           (encrypted (memq 'encrypted gnus-article-wash-types))
4594           (signature (memq 'signature gnus-article-wash-types))
4595           (overstrike (memq 'overstrike gnus-article-wash-types))
4596           (emphasis (memq 'emphasis gnus-article-wash-types)))
4597       (concat
4598        (gnus-article-wash-status-entry 'cite cite)
4599        (gnus-article-wash-status-entry 'headers (or headers boring))
4600        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
4601        (gnus-article-wash-status-entry 'signature signature)
4602        (gnus-article-wash-status-entry 'overstrike overstrike)
4603        (gnus-article-wash-status-entry 'emphasis emphasis)))))
4604
4605 (defun gnus-add-wash-type (type)
4606   "Add a washing of TYPE to the current status."
4607   (add-to-list 'gnus-article-wash-types type))
4608
4609 (defun gnus-delete-wash-type (type)
4610   "Add a washing of TYPE to the current status."
4611   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
4612
4613 (defun gnus-add-image (category image)
4614   "Add IMAGE of CATEGORY to the list of displayed images."
4615   (let ((entry (assq category gnus-article-image-alist)))
4616     (unless entry
4617       (setq entry (list category))
4618       (push entry gnus-article-image-alist))
4619     (nconc entry (list image))))
4620
4621 (defun gnus-delete-images (category)
4622   "Delete all images in CATEGORY."
4623   (let ((entry (assq category gnus-article-image-alist)))
4624     (dolist (image (cdr entry))
4625       (gnus-remove-image image))
4626     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
4627     (gnus-delete-wash-type category)))
4628
4629 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
4630
4631 (defun gnus-article-maybe-hide-headers ()
4632   "Hide unwanted headers if `gnus-have-all-headers' is nil.
4633 Provided for backwards compatibility."
4634   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
4635                  (not (save-excursion (set-buffer gnus-summary-buffer)
4636                                       gnus-have-all-headers)))
4637              (not gnus-inhibit-hiding))
4638     (gnus-article-hide-headers)))
4639
4640 ;;; Article savers.
4641
4642 (defun gnus-output-to-file (file-name)
4643   "Append the current article to a file named FILE-NAME."
4644   (let ((artbuf (current-buffer)))
4645     (with-temp-buffer
4646       (insert-buffer-substring artbuf)
4647       ;; Append newline at end of the buffer as separator, and then
4648       ;; save it to file.
4649       (goto-char (point-max))
4650       (insert "\n")
4651       (let ((file-name-coding-system nnmail-pathname-coding-system))
4652         (mm-append-to-file (point-min) (point-max) file-name))
4653       t)))
4654
4655 (defun gnus-narrow-to-page (&optional arg)
4656   "Narrow the article buffer to a page.
4657 If given a numerical ARG, move forward ARG pages."
4658   (interactive "P")
4659   (setq arg (if arg (prefix-numeric-value arg) 0))
4660   (save-excursion
4661     (set-buffer gnus-article-buffer)
4662     (goto-char (point-min))
4663     (widen)
4664     ;; Remove any old next/prev buttons.
4665     (when (gnus-visual-p 'page-marker)
4666       (let ((buffer-read-only nil))
4667         (gnus-remove-text-with-property 'gnus-prev)
4668         (gnus-remove-text-with-property 'gnus-next)))
4669     (when
4670         (cond ((< arg 0)
4671                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
4672               ((> arg 0)
4673                (re-search-forward page-delimiter nil 'move arg)))
4674       (goto-char (match-end 0)))
4675     (narrow-to-region
4676      (point)
4677      (if (re-search-forward page-delimiter nil 'move)
4678          (match-beginning 0)
4679        (point)))
4680     (when (and (gnus-visual-p 'page-marker)
4681                (not (= (point-min) 1)))
4682       (save-excursion
4683         (goto-char (point-min))
4684         (gnus-insert-prev-page-button)))
4685     (when (and (gnus-visual-p 'page-marker)
4686                (< (+ (point-max) 2) (buffer-size)))
4687       (save-excursion
4688         (goto-char (point-max))
4689         (gnus-insert-next-page-button)))))
4690
4691 ;; Article mode commands
4692
4693 (defun gnus-article-goto-next-page ()
4694   "Show the next page of the article."
4695   (interactive)
4696   (gnus-eval-in-buffer-window gnus-summary-buffer
4697     (gnus-summary-next-page)))
4698
4699 (defun gnus-article-goto-prev-page ()
4700   "Show the next page of the article."
4701   (interactive)
4702   (gnus-eval-in-buffer-window gnus-summary-buffer
4703     (gnus-summary-prev-page)))
4704
4705 (defun gnus-article-next-page (&optional lines)
4706   "Show the next page of the current article.
4707 If end of article, return non-nil.  Otherwise return nil.
4708 Argument LINES specifies lines to be scrolled up."
4709   (interactive "p")
4710   (move-to-window-line -1)
4711   (if (save-excursion
4712         (end-of-line)
4713         (and (pos-visible-in-window-p)  ;Not continuation line.
4714              (>= (1+ (point)) (point-max)))) ;Allow for trailing newline.
4715       ;; Nothing in this page.
4716       (if (or (not gnus-page-broken)
4717               (save-excursion
4718                 (save-restriction
4719                   (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
4720           t                             ;Nothing more.
4721         (gnus-narrow-to-page 1)         ;Go to next page.
4722         nil)
4723     ;; More in this page.
4724     (let ((scroll-in-place nil))
4725       (condition-case ()
4726           (scroll-up lines)
4727         (end-of-buffer
4728          ;; Long lines may cause an end-of-buffer error.
4729          (goto-char (point-max)))))
4730     (move-to-window-line 0)
4731     nil))
4732
4733 (defun gnus-article-prev-page (&optional lines)
4734   "Show previous page of current article.
4735 Argument LINES specifies lines to be scrolled down."
4736   (interactive "p")
4737   (move-to-window-line 0)
4738   (if (and gnus-page-broken
4739            (bobp)
4740            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
4741       (progn
4742         (gnus-narrow-to-page -1)        ;Go to previous page.
4743         (goto-char (point-max))
4744         (recenter -1))
4745     (let ((scroll-in-place nil))
4746       (prog1
4747           (condition-case ()
4748               (scroll-down lines)
4749             (beginning-of-buffer
4750              (goto-char (point-min))))
4751         (move-to-window-line 0)))))
4752
4753 (defun gnus-article-only-boring-p ()
4754   "Decide whether there is only boring text remaining in the article.
4755 Something \"interesting\" is a word of at least two letters that does
4756 not have a face in `gnus-article-boring-faces'."
4757   (when (and gnus-article-skip-boring
4758              (boundp 'gnus-article-boring-faces)
4759              (symbol-value 'gnus-article-boring-faces))
4760     (save-excursion
4761       (catch 'only-boring
4762         (while (re-search-forward "\\b\\w\\w" nil t)
4763           (forward-char -1)
4764           (when (not (gnus-intersection
4765                       (gnus-faces-at (point))
4766                       (symbol-value 'gnus-article-boring-faces)))
4767             (throw 'only-boring nil)))
4768         (throw 'only-boring t)))))
4769
4770 (defun gnus-article-refer-article ()
4771   "Read article specified by message-id around point."
4772   (interactive)
4773   (let ((point (point)))
4774     (search-forward ">" nil t)          ;Move point to end of "<....>".
4775     (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
4776         (let ((message-id (gnus-replace-in-string (match-string 1) "<news:" "<" )))
4777           (goto-char point)
4778           (set-buffer gnus-summary-buffer)
4779           (gnus-summary-refer-article message-id))
4780       (goto-char (point))
4781       (error "No references around point"))))
4782
4783 (defun gnus-article-show-summary ()
4784   "Reconfigure windows to show summary buffer."
4785   (interactive)
4786   (if (not (gnus-buffer-live-p gnus-summary-buffer))
4787       (error "There is no summary buffer for this article buffer")
4788     (gnus-article-set-globals)
4789     (gnus-configure-windows 'article)
4790     (gnus-summary-goto-subject gnus-current-article)
4791     (gnus-summary-position-point)))
4792
4793 (defun gnus-article-describe-briefly ()
4794   "Describe article mode commands briefly."
4795   (interactive)
4796   (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")))
4797
4798 (defun gnus-article-summary-command ()
4799   "Execute the last keystroke in the summary buffer."
4800   (interactive)
4801   (let ((obuf (current-buffer))
4802         (owin (current-window-configuration))
4803         func)
4804     (switch-to-buffer gnus-article-current-summary 'norecord)
4805     (setq func (lookup-key (current-local-map) (this-command-keys)))
4806     (call-interactively func)
4807     (set-buffer obuf)
4808     (set-window-configuration owin)
4809     (set-window-point (get-buffer-window (current-buffer)) (point))))
4810
4811 (defun gnus-article-summary-command-nosave ()
4812   "Execute the last keystroke in the summary buffer."
4813   (interactive)
4814   (let (func)
4815     (pop-to-buffer gnus-article-current-summary 'norecord)
4816     (setq func (lookup-key (current-local-map) (this-command-keys)))
4817     (call-interactively func)))
4818
4819 (defun gnus-article-check-buffer ()
4820   "Beep if not in an article buffer."
4821   (unless (equal major-mode 'gnus-article-mode)
4822     (error "Command invoked outside of a Gnus article buffer")))
4823
4824 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
4825   "Read a summary buffer key sequence and execute it from the article buffer."
4826   (interactive "P")
4827   (gnus-article-check-buffer)
4828   (let ((nosaves
4829          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
4830            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
4831            "=" "^" "\M-^" "|"))
4832         (nosave-but-article
4833          '("A\r"))
4834         (nosave-in-article
4835          '("\C-d"))
4836         (up-to-top
4837          '("n" "Gn" "p" "Gp"))
4838         keys new-sum-point)
4839     (save-excursion
4840       (set-buffer gnus-article-current-summary)
4841       (let (gnus-pick-mode)
4842         (push (or key last-command-event) unread-command-events)
4843         (setq keys (if (featurep 'xemacs)
4844                        (events-to-keys (read-key-sequence nil))
4845                      (read-key-sequence nil)))))
4846
4847     (message "")
4848
4849     (if (or (member keys nosaves)
4850             (member keys nosave-but-article)
4851             (member keys nosave-in-article))
4852         (let (func)
4853           (save-window-excursion
4854             (pop-to-buffer gnus-article-current-summary 'norecord)
4855             ;; We disable the pick minor mode commands.
4856             (let (gnus-pick-mode)
4857               (setq func (lookup-key (current-local-map) keys))))
4858           (if (or (not func)
4859                   (numberp func))
4860               (ding)
4861             (unless (member keys nosave-in-article)
4862               (set-buffer gnus-article-current-summary))
4863             (call-interactively func)
4864             (setq new-sum-point (point)))
4865           (when (member keys nosave-but-article)
4866             (pop-to-buffer gnus-article-buffer 'norecord)))
4867       ;; These commands should restore window configuration.
4868       (let ((obuf (current-buffer))
4869             (owin (current-window-configuration))
4870             (opoint (point))
4871             (summary gnus-article-current-summary)
4872             func in-buffer selected)
4873         (if not-restore-window
4874             (pop-to-buffer summary 'norecord)
4875           (switch-to-buffer summary 'norecord))
4876         (setq in-buffer (current-buffer))
4877         ;; We disable the pick minor mode commands.
4878         (if (and (setq func (let (gnus-pick-mode)
4879                               (lookup-key (current-local-map) keys)))
4880                  (functionp func))
4881             (progn
4882               (call-interactively func)
4883               (setq new-sum-point (point))
4884               (when (eq in-buffer (current-buffer))
4885                 (setq selected (gnus-summary-select-article))
4886                 (set-buffer obuf)
4887                 (unless not-restore-window
4888                   (set-window-configuration owin))
4889                 (when (eq selected 'old)
4890                   (article-goto-body)
4891                   (set-window-start (get-buffer-window (current-buffer))
4892                                     1)
4893                   (set-window-point (get-buffer-window (current-buffer))
4894                                     (point)))
4895                 (let ((win (get-buffer-window gnus-article-current-summary)))
4896                   (when win
4897                     (set-window-point win new-sum-point))))    )
4898           (switch-to-buffer gnus-article-buffer)
4899           (ding))))))
4900
4901 (defun gnus-article-describe-key (key)
4902   "Display documentation of the function invoked by KEY.  KEY is a string."
4903   (interactive "kDescribe key: ")
4904   (gnus-article-check-buffer)
4905   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
4906       (save-excursion
4907         (set-buffer gnus-article-current-summary)
4908         (let (gnus-pick-mode)
4909           (if (featurep 'xemacs)
4910               (progn
4911                 (push (elt key 0) unread-command-events)
4912                 (setq key (events-to-keys
4913                            (read-key-sequence "Describe key: "))))
4914             (setq unread-command-events
4915                   (mapcar
4916                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
4917                    (string-to-list key)))
4918             (setq key (read-key-sequence "Describe key: "))))
4919         (describe-key key))
4920     (describe-key key)))
4921
4922 (defun gnus-article-describe-key-briefly (key &optional insert)
4923   "Display documentation of the function invoked by KEY.  KEY is a string."
4924   (interactive "kDescribe key: \nP")
4925   (gnus-article-check-buffer)
4926   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
4927       (save-excursion
4928         (set-buffer gnus-article-current-summary)
4929         (let (gnus-pick-mode)
4930           (if (featurep 'xemacs)
4931               (progn
4932                 (push (elt key 0) unread-command-events)
4933                 (setq key (events-to-keys
4934                            (read-key-sequence "Describe key: "))))
4935             (setq unread-command-events
4936                   (mapcar
4937                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
4938                    (string-to-list key)))
4939             (setq key (read-key-sequence "Describe key: "))))
4940         (describe-key-briefly key insert))
4941     (describe-key-briefly key insert)))
4942
4943 (defun gnus-article-reply-with-original (&optional wide)
4944   "Start composing a reply mail to the current message.
4945 The text in the region will be yanked.  If the region isn't active,
4946 the entire article will be yanked."
4947   (interactive "P")
4948   (let ((article (cdr gnus-article-current))
4949         contents)
4950     (if (not (gnus-mark-active-p))
4951         (with-current-buffer gnus-summary-buffer
4952           (gnus-summary-reply (list (list article)) wide))
4953       (setq contents (buffer-substring (point) (mark t)))
4954       ;; Deactivate active regions.
4955       (when (and (boundp 'transient-mark-mode)
4956                  transient-mark-mode)
4957         (setq mark-active nil))
4958       (with-current-buffer gnus-summary-buffer
4959         (gnus-summary-reply
4960          (list (list article contents)) wide)))))
4961
4962 (defun gnus-article-followup-with-original ()
4963   "Compose a followup to the current article.
4964 The text in the region will be yanked.  If the region isn't active,
4965 the entire article will be yanked."
4966   (interactive)
4967   (let ((article (cdr gnus-article-current))
4968         contents)
4969       (if (not (gnus-mark-active-p))
4970           (with-current-buffer gnus-summary-buffer
4971             (gnus-summary-followup (list (list article))))
4972         (setq contents (buffer-substring (point) (mark t)))
4973         ;; Deactivate active regions.
4974         (when (and (boundp 'transient-mark-mode)
4975                    transient-mark-mode)
4976           (setq mark-active nil))
4977         (with-current-buffer gnus-summary-buffer
4978           (gnus-summary-followup
4979            (list (list article contents)))))))
4980
4981 (defun gnus-article-hide (&optional arg force)
4982   "Hide all the gruft in the current article.
4983 This means that signatures, cited text and (some) headers will be
4984 hidden.
4985 If given a prefix, show the hidden text instead."
4986   (interactive (append (gnus-article-hidden-arg) (list 'force)))
4987   (gnus-article-hide-headers arg)
4988   (gnus-article-hide-list-identifiers arg)
4989   (gnus-article-hide-citation-maybe arg force)
4990   (gnus-article-hide-signature arg))
4991
4992 (defun gnus-article-maybe-highlight ()
4993   "Do some article highlighting if article highlighting is requested."
4994   (when (gnus-visual-p 'article-highlight 'highlight)
4995     (gnus-article-highlight-some)))
4996
4997 (defun gnus-check-group-server ()
4998   ;; Make sure the connection to the server is alive.
4999   (unless (gnus-server-opened
5000            (gnus-find-method-for-group gnus-newsgroup-name))
5001     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
5002     (gnus-request-group gnus-newsgroup-name t)))
5003
5004 (eval-when-compile
5005   (autoload 'nneething-get-file-name "nneething"))
5006
5007 (defun gnus-request-article-this-buffer (article group)
5008   "Get an article and insert it into this buffer."
5009   (let (do-update-line sparse-header)
5010     (prog1
5011         (save-excursion
5012           (erase-buffer)
5013           (gnus-kill-all-overlays)
5014           (setq group (or group gnus-newsgroup-name))
5015
5016           ;; Using `gnus-request-article' directly will insert the article into
5017           ;; `nntp-server-buffer' - so we'll save some time by not having to
5018           ;; copy it from the server buffer into the article buffer.
5019
5020           ;; We only request an article by message-id when we do not have the
5021           ;; headers for it, so we'll have to get those.
5022           (when (stringp article)
5023             (gnus-read-header article))
5024
5025           ;; If the article number is negative, that means that this article
5026           ;; doesn't belong in this newsgroup (possibly), so we find its
5027           ;; message-id and request it by id instead of number.
5028           (when (and (numberp article)
5029                      gnus-summary-buffer
5030                      (get-buffer gnus-summary-buffer)
5031                      (gnus-buffer-exists-p gnus-summary-buffer))
5032             (save-excursion
5033               (set-buffer gnus-summary-buffer)
5034               (let ((header (gnus-summary-article-header article)))
5035                 (when (< article 0)
5036                   (cond
5037                    ((memq article gnus-newsgroup-sparse)
5038                     ;; This is a sparse gap article.
5039                     (setq do-update-line article)
5040                     (setq article (mail-header-id header))
5041                     (setq sparse-header (gnus-read-header article))
5042                     (setq gnus-newsgroup-sparse
5043                           (delq article gnus-newsgroup-sparse)))
5044                    ((vectorp header)
5045                     ;; It's a real article.
5046                     (setq article (mail-header-id header)))
5047                    (t
5048                     ;; It is an extracted pseudo-article.
5049                     (setq article 'pseudo)
5050                     (gnus-request-pseudo-article header))))
5051
5052                 (let ((method (gnus-find-method-for-group
5053                                gnus-newsgroup-name)))
5054                   (when (and (eq (car method) 'nneething)
5055                              (vectorp header))
5056                     (let ((dir (nneething-get-file-name
5057                                 (mail-header-id header))))
5058                       (when (and (stringp dir)
5059                                  (file-directory-p dir))
5060                         (setq article 'nneething)
5061                         (gnus-group-enter-directory dir))))))))
5062
5063           (cond
5064            ;; Refuse to select canceled articles.
5065            ((and (numberp article)
5066                  gnus-summary-buffer
5067                  (get-buffer gnus-summary-buffer)
5068                  (gnus-buffer-exists-p gnus-summary-buffer)
5069                  (eq (cdr (save-excursion
5070                             (set-buffer gnus-summary-buffer)
5071                             (assq article gnus-newsgroup-reads)))
5072                      gnus-canceled-mark))
5073             nil)
5074            ;; We first check `gnus-original-article-buffer'.
5075            ((and (get-buffer gnus-original-article-buffer)
5076                  (numberp article)
5077                  (save-excursion
5078                    (set-buffer gnus-original-article-buffer)
5079                    (and (equal (car gnus-original-article) group)
5080                         (eq (cdr gnus-original-article) article))))
5081             (insert-buffer-substring gnus-original-article-buffer)
5082             'article)
5083            ;; Check the backlog.
5084            ((and gnus-keep-backlog
5085                  (gnus-backlog-request-article group article (current-buffer)))
5086             'article)
5087            ;; Check asynchronous pre-fetch.
5088            ((gnus-async-request-fetched-article group article (current-buffer))
5089             (gnus-async-prefetch-next group article gnus-summary-buffer)
5090             (when (and (numberp article) gnus-keep-backlog)
5091               (gnus-backlog-enter-article group article (current-buffer)))
5092             'article)
5093            ;; Check the cache.
5094            ((and gnus-use-cache
5095                  (numberp article)
5096                  (gnus-cache-request-article article group))
5097             'article)
5098            ;; Check the agent cache.
5099            ((and gnus-agent gnus-agent-cache gnus-plugged
5100                  (numberp article)
5101                  (gnus-agent-request-article article group))
5102             'article)
5103            ;; Get the article and put into the article buffer.
5104            ((or (stringp article)
5105                 (numberp article))
5106             (let ((gnus-override-method gnus-override-method)
5107                   (methods (and (stringp article)
5108                                 gnus-refer-article-method))
5109                   (backend (car (gnus-find-method-for-group
5110                                  gnus-newsgroup-name)))
5111                   result
5112                   (buffer-read-only nil))
5113               (if (or (not (listp methods))
5114                       (and (symbolp (car methods))
5115                            (assq (car methods) nnoo-definition-alist)))
5116                   (setq methods (list methods)))
5117               (when (and (null gnus-override-method)
5118                          methods)
5119                 (setq gnus-override-method (pop methods)))
5120               (while (not result)
5121                 (when (eq gnus-override-method 'current)
5122                   (setq gnus-override-method
5123                         (with-current-buffer gnus-summary-buffer
5124                           gnus-current-select-method)))
5125                 (erase-buffer)
5126                 (gnus-kill-all-overlays)
5127                 (let ((gnus-newsgroup-name group))
5128                   (gnus-check-group-server))
5129                 (cond
5130                  ((gnus-request-article article group (current-buffer))
5131                   (when (numberp article)
5132                     (gnus-async-prefetch-next group article
5133                                               gnus-summary-buffer)
5134                     (when gnus-keep-backlog
5135                       (gnus-backlog-enter-article
5136                        group article (current-buffer))))
5137                   (setq result 'article))
5138                  (methods
5139                   (setq gnus-override-method (pop methods)))
5140                  ((not (string-match "^400 "
5141                                      (nnheader-get-report backend)))
5142                   ;; If we get 400 server disconnect, reconnect and
5143                   ;; retry; otherwise, assume the article has expired.
5144                   (setq result 'done))))
5145               (and (eq result 'article) 'article)))
5146            ;; It was a pseudo.
5147            (t article)))
5148
5149       ;; Associate this article with the current summary buffer.
5150       (setq gnus-article-current-summary gnus-summary-buffer)
5151
5152       ;; Take the article from the original article buffer
5153       ;; and place it in the buffer it's supposed to be in.
5154       (when (and (get-buffer gnus-article-buffer)
5155                  (equal (buffer-name (current-buffer))
5156                         (buffer-name (get-buffer gnus-article-buffer))))
5157         (save-excursion
5158           (if (get-buffer gnus-original-article-buffer)
5159               (set-buffer gnus-original-article-buffer)
5160             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
5161             (buffer-disable-undo)
5162             (setq major-mode 'gnus-original-article-mode)
5163             (setq buffer-read-only t))
5164           (let (buffer-read-only)
5165             (erase-buffer)
5166             (insert-buffer-substring gnus-article-buffer))
5167           (setq gnus-original-article (cons group article)))
5168
5169         ;; Decode charsets.
5170         (run-hooks 'gnus-article-decode-hook)
5171         ;; Mark article as decoded or not.
5172         (setq gnus-article-decoded-p gnus-article-decode-hook))
5173
5174       ;; Update sparse articles.
5175       (when (and do-update-line
5176                  (or (numberp article)
5177                      (stringp article)))
5178         (let ((buf (current-buffer)))
5179           (set-buffer gnus-summary-buffer)
5180           (gnus-summary-update-article do-update-line sparse-header)
5181           (gnus-summary-goto-subject do-update-line nil t)
5182           (set-window-point (gnus-get-buffer-window (current-buffer) t)
5183                             (point))
5184           (set-buffer buf))))))
5185
5186 ;;;
5187 ;;; Article editing
5188 ;;;
5189
5190 (defcustom gnus-article-edit-mode-hook nil
5191   "Hook run in article edit mode buffers."
5192   :group 'gnus-article-various
5193   :type 'hook)
5194
5195 (defvar gnus-article-edit-done-function nil)
5196
5197 (defvar gnus-article-edit-mode-map nil)
5198 (defvar gnus-article-edit-mode nil)
5199
5200 ;; Should we be using derived.el for this?
5201 (unless gnus-article-edit-mode-map
5202   (setq gnus-article-edit-mode-map (make-keymap))
5203   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
5204
5205   (gnus-define-keys gnus-article-edit-mode-map
5206     "\C-c?"    describe-mode
5207     "\C-c\C-c" gnus-article-edit-done
5208     "\C-c\C-k" gnus-article-edit-exit
5209     "\C-c\C-f\C-t" message-goto-to
5210     "\C-c\C-f\C-o" message-goto-from
5211     "\C-c\C-f\C-b" message-goto-bcc
5212     ;;"\C-c\C-f\C-w" message-goto-fcc
5213     "\C-c\C-f\C-c" message-goto-cc
5214     "\C-c\C-f\C-s" message-goto-subject
5215     "\C-c\C-f\C-r" message-goto-reply-to
5216     "\C-c\C-f\C-n" message-goto-newsgroups
5217     "\C-c\C-f\C-d" message-goto-distribution
5218     "\C-c\C-f\C-f" message-goto-followup-to
5219     "\C-c\C-f\C-m" message-goto-mail-followup-to
5220     "\C-c\C-f\C-k" message-goto-keywords
5221     "\C-c\C-f\C-u" message-goto-summary
5222     "\C-c\C-f\C-i" message-insert-or-toggle-importance
5223     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
5224     "\C-c\C-b" message-goto-body
5225     "\C-c\C-i" message-goto-signature
5226
5227     "\C-c\C-t" message-insert-to
5228     "\C-c\C-n" message-insert-newsgroups
5229     "\C-c\C-o" message-sort-headers
5230     "\C-c\C-e" message-elide-region
5231     "\C-c\C-v" message-delete-not-region
5232     "\C-c\C-z" message-kill-to-signature
5233     "\M-\r" message-newline-and-reformat
5234     "\C-c\C-a" mml-attach-file
5235     "\C-a" message-beginning-of-line
5236     "\t" message-tab
5237     "\M-;" comment-region)
5238
5239   (gnus-define-keys (gnus-article-edit-wash-map
5240                      "\C-c\C-w" gnus-article-edit-mode-map)
5241     "f" gnus-article-edit-full-stops))
5242
5243 (easy-menu-define
5244   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
5245   '("Field"
5246     ["Fetch To" message-insert-to t]
5247     ["Fetch Newsgroups" message-insert-newsgroups t]
5248     "----"
5249     ["To" message-goto-to t]
5250     ["From" message-goto-from t]
5251     ["Subject" message-goto-subject t]
5252     ["Cc" message-goto-cc t]
5253     ["Reply-To" message-goto-reply-to t]
5254     ["Summary" message-goto-summary t]
5255     ["Keywords" message-goto-keywords t]
5256     ["Newsgroups" message-goto-newsgroups t]
5257     ["Followup-To" message-goto-followup-to t]
5258     ["Mail-Followup-To" message-goto-mail-followup-to t]
5259     ["Distribution" message-goto-distribution t]
5260     ["Body" message-goto-body t]
5261     ["Signature" message-goto-signature t]))
5262
5263 (define-derived-mode gnus-article-edit-mode text-mode "Article Edit"
5264   "Major mode for editing articles.
5265 This is an extended text-mode.
5266
5267 \\{gnus-article-edit-mode-map}"
5268   (make-local-variable 'gnus-article-edit-done-function)
5269   (make-local-variable 'gnus-prev-winconf)
5270   (set (make-local-variable 'font-lock-defaults)
5271        '(message-font-lock-keywords t))
5272   (set (make-local-variable 'mail-header-separator) "")
5273   (set (make-local-variable 'gnus-article-edit-mode) t)
5274   (easy-menu-add message-mode-field-menu message-mode-map)
5275   (mml-mode)
5276   (setq buffer-read-only nil)
5277   (buffer-enable-undo)
5278   (widen))
5279
5280 (defun gnus-article-edit (&optional force)
5281   "Edit the current article.
5282 This will have permanent effect only in mail groups.
5283 If FORCE is non-nil, allow editing of articles even in read-only
5284 groups."
5285   (interactive "P")
5286   (when (and (not force)
5287              (gnus-group-read-only-p))
5288     (error "The current newsgroup does not support article editing"))
5289   (gnus-article-date-original)
5290   (gnus-article-edit-article
5291    'ignore
5292    `(lambda (no-highlight)
5293       'ignore
5294       (gnus-summary-edit-article-done
5295        ,(or (mail-header-references gnus-current-headers) "")
5296        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
5297
5298 (defun gnus-article-edit-article (start-func exit-func)
5299   "Start editing the contents of the current article buffer."
5300   (let ((winconf (current-window-configuration)))
5301     (set-buffer gnus-article-buffer)
5302     (gnus-article-edit-mode)
5303     (funcall start-func)
5304     (set-buffer-modified-p nil)
5305     (gnus-configure-windows 'edit-article)
5306     (setq gnus-article-edit-done-function exit-func)
5307     (setq gnus-prev-winconf winconf)
5308     (gnus-message 6 "C-c C-c to end edits")))
5309
5310 (defun gnus-article-edit-done (&optional arg)
5311   "Update the article edits and exit."
5312   (interactive "P")
5313   (let ((func gnus-article-edit-done-function)
5314         (buf (current-buffer))
5315         (start (window-start))
5316         (p (point))
5317         (winconf gnus-prev-winconf))
5318     (widen) ;; Widen it in case that users narrowed the buffer.
5319     (funcall func arg)
5320     (set-buffer buf)
5321     ;; The cache and backlog have to be flushed somewhat.
5322     (when gnus-keep-backlog
5323       (gnus-backlog-remove-article
5324        (car gnus-article-current) (cdr gnus-article-current)))
5325     ;; Flush original article as well.
5326     (save-excursion
5327       (when (get-buffer gnus-original-article-buffer)
5328         (set-buffer gnus-original-article-buffer)
5329         (setq gnus-original-article nil)))
5330     (when gnus-use-cache
5331       (gnus-cache-update-article
5332        (car gnus-article-current) (cdr gnus-article-current)))
5333     ;; We remove all text props from the article buffer.
5334     (kill-all-local-variables)
5335     (gnus-set-text-properties (point-min) (point-max) nil)
5336     (gnus-article-mode)
5337     (set-window-configuration winconf)
5338     (set-buffer buf)
5339     (set-window-start (get-buffer-window buf) start)
5340     (set-window-point (get-buffer-window buf) (point))))
5341
5342 (defun gnus-article-edit-exit ()
5343   "Exit the article editing without updating."
5344   (interactive)
5345   (when (or (not (buffer-modified-p))
5346             (yes-or-no-p "Article modified; kill anyway? "))
5347     (let ((curbuf (current-buffer))
5348           (p (point))
5349           (window-start (window-start)))
5350       (erase-buffer)
5351       (if (gnus-buffer-live-p gnus-original-article-buffer)
5352           (insert-buffer gnus-original-article-buffer))
5353       (let ((winconf gnus-prev-winconf))
5354         (kill-all-local-variables)
5355         (gnus-article-mode)
5356         (set-window-configuration winconf)
5357         ;; Tippy-toe some to make sure that point remains where it was.
5358         (save-current-buffer
5359           (set-buffer curbuf)
5360           (set-window-start (get-buffer-window (current-buffer)) window-start)
5361           (goto-char p))))))
5362
5363 (defun gnus-article-edit-full-stops ()
5364   "Interactively repair spacing at end of sentences."
5365   (interactive)
5366   (save-excursion
5367     (goto-char (point-min))
5368     (search-forward-regexp "^$" nil t)
5369     (let ((case-fold-search nil))
5370       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
5371
5372 ;;;
5373 ;;; Article highlights
5374 ;;;
5375
5376 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
5377
5378 ;;; Internal Variables:
5379
5380 (defcustom gnus-button-url-regexp
5381   (if (string-match "[[:digit:]]" "1") ;; support POSIX?
5382       "\\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:]]\\)"
5383     "\\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\\)\\)")
5384   "Regular expression that matches URLs."
5385   :group 'gnus-article-buttons
5386   :type 'regexp)
5387
5388 (defcustom gnus-button-valid-fqdn-regexp
5389   (concat "[a-z0-9][-.a-z0-9]+\\." ;; [hostname.subdomain.]domain.
5390           ;; valid TLDs:
5391           "\\([a-z][a-z]" ;; two letter country TDLs
5392           "\\|biz\\|com\\|edu\\|gov\\|int\\|mil\\|net\\|org"
5393           "\\|aero\\|coop\\|info\\|name\\|museum"
5394           "\\|arpa\\|pro\\|uucp\\|bitnet\\|bofh" ;; old style?
5395           "\\)")
5396   "Regular expression that matches a valid FQDN."
5397   :group 'gnus-article-buttons
5398   :type 'regexp)
5399
5400 (defcustom gnus-button-man-handler 'manual-entry
5401   "Function to use for displaying man pages.
5402 The function must take at least one argument with a string naming the
5403 man page."
5404   :type '(choice (function-item :tag "Man" manual-entry)
5405                  (function-item :tag "Woman" woman)
5406                  (function :tag "Other"))
5407   :group 'gnus-article-buttons)
5408
5409 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
5410   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
5411 If the default site is too slow, try to find a CTAN mirror, see
5412 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
5413 the variable `gnus-button-handle-ctan'."
5414   :group 'gnus-article-buttons
5415   :link '(custom-manual "(gnus)Group Parameters")
5416   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
5417                  (const "http://tug.ctan.org/tex-archive/")
5418                  (const "http://www.dante.de/CTAN/")
5419                  (string :tag "Other")))
5420
5421 (defcustom gnus-button-ctan-handler 'browse-url
5422   "Function to use for displaying CTAN links.
5423 The function must take one argument, the string naming the URL."
5424   :type '(choice (function-item :tag "Browse Url" browse-url)
5425                  (function :tag "Other"))
5426   :group 'gnus-article-buttons)
5427
5428 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
5429   "Bogus strings removed from CTAN URLs."
5430   :group 'gnus-article-buttons
5431   :type '(choice (const "^/?tex-archive/\\|/")
5432                  (regexp :tag "Other")))
5433
5434 (defcustom gnus-button-mid-or-mail-regexp
5435   (concat "\\b\\(<?[a-z0-9][^<>\")!;:,{}\n\t ]*@"
5436           gnus-button-valid-fqdn-regexp
5437           ">?\\)\\b")
5438   "Regular expression that matches a message ID or a mail address."
5439   :group 'gnus-article-buttons
5440   :type 'regexp)
5441
5442 (defcustom gnus-button-prefer-mid-or-mail 'guess
5443   "What to do when the button on a string as \"foo123@bar.com\" is pushed.
5444 Strings like this can be either a message ID or a mail address.  If the
5445 variable is set to the symbol `ask', query the user what do do.  If it is the
5446 symbol `guess', Gnus will do a guess and query the user what do do if it is
5447 ambiguous.  See the variable `gnus-button-guessed-mid-regexp' for details
5448 concerning the guessing.  If it is one of the sybols `mid' or `mail', Gnus
5449 will always assume that the string is a message ID or a mail address,
5450 respectivly."
5451   ;; FIXME: doc-string could/should be improved.
5452   :group 'gnus-article-buttons
5453   :type '(choice (const ask)
5454                  (const guess)
5455                  (const mid)
5456                  (const mail)))
5457
5458 (defcustom gnus-button-guessed-mid-regexp
5459   (concat
5460    "^<?\\(slrn\\|Pine\\.\\)"
5461    "\\|\\.fsf@\\|\\.fsf_-_@\\|\\.ln@"
5462    "\\|@4ax\\.com\\|@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de"
5463           "\\|^<?.*[0-9].*[0-9].*[0-9].*[0-9].*[0-9].*[0-9].*@")
5464   "Regular expression that matches message IDs and not mail addresses."
5465   ;; TODO: Incorporate more matches from
5466   ;; <URL:http://piology.org/perl/id-or-mail.pl.html>. I.e. translate the
5467   ;; Perl-REs to Elisp-REs.
5468   :group 'gnus-article-buttons
5469   :type 'regexp)
5470
5471 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
5472   (let* ((pref gnus-button-prefer-mid-or-mail)
5473          (url-mid (concat "news" ":" mid-or-mail))
5474          (url-mailto (concat "mailto" ":" mid-or-mail)))
5475     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
5476     ;; If it looks like a MID (well known readers or servers) use 'mid,
5477     ;; otherwise 'ask the user.
5478     (if (eq pref 'guess)
5479         (if (string-match gnus-button-guessed-mid-regexp mid-or-mail)
5480             (setq pref 'mid)
5481           (setq pref 'ask)))
5482     (if (eq pref 'ask)
5483         (save-window-excursion
5484           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
5485               (setq pref 'mail)
5486             (setq pref 'mid))))
5487     (cond ((eq pref 'mid)
5488            (gnus-message 9 "calling `gnus-button-handle-news' %s" url-mid)
5489            (gnus-button-handle-news url-mid))
5490           ((eq pref 'mail)
5491            (gnus-message 9 "calling `gnus-url-mailto'  %s" url-mailto)
5492            (gnus-url-mailto url-mailto)))))
5493
5494 (defun gnus-button-handle-custom (url)
5495   "Follow a Custom URL."
5496   (customize-apropos (gnus-url-unhex-string url)))
5497
5498 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
5499
5500 (defun gnus-button-handle-describe-function (url)
5501   "Call `describe-function' when pushing the corresponding URL button."
5502   (describe-function
5503    (intern
5504     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5505
5506 (defun gnus-button-handle-describe-variable (url)
5507   "Call `describe-variable' when pushing the corresponding URL button."
5508   (describe-variable
5509    (intern
5510     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
5511
5512 (defun gnus-button-handle-describe-key (url)
5513   "Call `describe-key' when pushing the corresponding URL button."
5514   (let* ((key-string
5515           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
5516          (keys (ignore-errors (eval `(kbd ,key-string)))))
5517     (if keys
5518         (describe-key keys)
5519       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
5520
5521 (defun gnus-button-handle-apropos (url)
5522   "Call `apropos' when pushing the corresponding URL button."
5523   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5524
5525 (defun gnus-button-handle-apropos-command (url)
5526   "Call `apropos' when pushing the corresponding URL button."
5527   (apropos-command
5528    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5529
5530 (defun gnus-button-handle-apropos-variable (url)
5531   "Call `apropos' when pushing the corresponding URL button."
5532   (funcall
5533    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
5534    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5535
5536 (defun gnus-button-handle-apropos-documentation (url)
5537   "Call `apropos' when pushing the corresponding URL button."
5538   (funcall
5539    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
5540    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
5541
5542 (defun gnus-button-handle-ctan (url)
5543   "Call `browse-url' when pushing a CTAN URL button."
5544   (funcall
5545    gnus-button-ctan-handler
5546    (concat
5547     gnus-ctan-url
5548     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
5549
5550 (defcustom gnus-button-tex-level 5
5551   "*Integer that says how many TeX-related buttons Gnus will show.
5552 The higher the number, the more buttons will appear and the more false
5553 positives are possible.  Note that you can set this variable local to
5554 specifific groups.  Setting it higher in TeX groups is probably a good idea.
5555 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5556 how to set variables in specific groups."
5557   :group 'gnus-article-buttons
5558   :link '(custom-manual "(gnus)Group Parameters")
5559   :type 'integer)
5560
5561 (defcustom gnus-button-man-level 5
5562   "*Integer that says how many man-related buttons Gnus will show.
5563 The higher the number, the more buttons will appear and the more false
5564 positives are possible.  Note that you can set this variable local to
5565 specifific groups.  Setting it higher in Unix groups is probably a good idea.
5566 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
5567 how to set variables in specific groups."
5568   :group 'gnus-article-buttons
5569   :link '(custom-manual "(gnus)Group Parameters")
5570   :type 'integer)
5571
5572 (defcustom gnus-button-emacs-level 5
5573   "*Integer that says how many emacs-related buttons Gnus will show.
5574 The higher the number, the more buttons will appear and the more false
5575 positives are possible.  Note that you can set this variable local to
5576 specifific groups.  Setting it higher in Emacs or Gnus related groups is
5577 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
5578 `gnus-parameters' on how to set variables in specific groups."
5579   :group 'gnus-article-buttons
5580   :link '(custom-manual "(gnus)Group Parameters")
5581   :type 'integer)
5582
5583 (defcustom gnus-button-mail-level 5
5584   "*Integer that says how many buttons for message IDs or mail addresses will appear.
5585 The higher the number, the more buttons will appear and the more false
5586 positives are possible."
5587   :group 'gnus-article-buttons
5588   :type 'integer)
5589
5590 (defcustom gnus-button-alist
5591   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
5592      0 t gnus-button-handle-news 3)
5593     ("\\b\\(nntp\\|news\\):\\([^>\n\t ]*@[^>)!;:,\n\t ]*\\)" 0 t
5594      gnus-button-handle-news 2)
5595     ("\\(\\b<\\(url:[>\n\t ]*\\)?news:[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
5596      1 t
5597      gnus-button-fetch-group 4)
5598     ("\\bnews:\\(//\\)?\\([^'\">\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
5599     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
5600      t gnus-button-message-id 3)
5601     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 2)
5602     ("mailto:\\([-a-z.@_+0-9%=?]+\\)" 0 t gnus-url-mailto 1)
5603     ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 1)
5604     ;; CTAN
5605     ("\\bCTAN:[ \t\n]*\\([^>)!;:,\n\t ]*\\)" 0 (>= gnus-button-tex-level 1)
5606      gnus-button-handle-ctan 1)
5607     ;; This is info
5608     ("\\binfo:\\(//\\)?\\([^'\">\n\t ]+\\)" 0
5609      (>= gnus-button-emacs-level 1) gnus-button-handle-info 2)
5610     ;; This is custom
5611     ("\\bcustom:\\(//\\)?\\([^'\">\n\t ]+\\)" 0
5612      (>= gnus-button-emacs-level 5) gnus-button-handle-custom 2)
5613     ("M-x[ \t\n]customize-[^ ]+[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
5614      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1)
5615     ;; Emacs help commands
5616     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5617      ;; regexp doesn't match arguments containing ` '.
5618      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
5619     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5620      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
5621     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5622      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
5623     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5624      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
5625     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5626      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
5627     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
5628      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
5629     ("`\\(\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'" 1
5630      ;; Unlike the other regexps we really have to require quoting
5631      ;; here to determine where it ends.
5632      (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
5633     ;; This is how URLs _should_ be embedded in text...
5634     ("<URL: *\\([^<>]*\\)>" 1 t gnus-button-embedded-url 1)
5635     ;; Raw URLs.
5636     (gnus-button-url-regexp 0 t browse-url 0)
5637     ;; man pages
5638     ("\\b\\([a-z][a-z]+\\)([1-9])\\W" 0
5639      (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
5640      gnus-button-handle-man 1)
5641     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
5642     ("\\b\\([a-z][-_.a-z0-9]+\\)([1-9])\\W" 0
5643      (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
5644      gnus-button-handle-man 1)
5645     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
5646     ;; SoWWWAnchor(3iv), XSelectInput(3X11)
5647     ("\\b\\([a-z][-_.:a-z0-9]+\\)([1-9][X1a-z]*)\\W" 0
5648      (>= gnus-button-man-level 5) gnus-button-handle-man 1)
5649     ;; MID or mail: To avoid too many false positives we don't try to catch
5650     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
5651     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
5652     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
5653     ;; so that non-ambiguous entries (see above) match first.
5654     (gnus-button-mid-or-mail-regexp
5655      0 (>= gnus-button-mail-level 5) gnus-button-handle-mid-or-mail 1))
5656   "*Alist of regexps matching buttons in article bodies.
5657
5658 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
5659 REGEXP: is the string (case insensitive) matching text around the button (can
5660 also be lisp expression evaluating to a string),
5661 BUTTON: is the number of the regexp grouping actually matching the button,
5662 FORM: is a lisp expression which must eval to true for the button to
5663 be added,
5664 CALLBACK: is the function to call when the user push this button, and each
5665 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
5666
5667 CALLBACK can also be a variable, in that case the value of that
5668 variable it the real callback function."
5669   :group 'gnus-article-buttons
5670   :type '(repeat (list (choice regexp variable)
5671                        (integer :tag "Button")
5672                        (sexp :tag "Form")
5673                        (function :tag "Callback")
5674                        (repeat :tag "Par"
5675                                :inline t
5676                                (integer :tag "Regexp group")))))
5677
5678 (defcustom gnus-header-button-alist
5679   '(("^\\(References\\|Message-I[Dd]\\):" "<[^<>]+>"
5680      0 t gnus-button-message-id 0)
5681     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
5682     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
5683      0 t gnus-button-mailto 0)
5684     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp 0 t browse-url 0)
5685     ("^Subject:" gnus-button-url-regexp 0 t browse-url 0)
5686     ("^[^:]+:" gnus-button-url-regexp 0 t browse-url 0)
5687     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?]+\\)" 0 t gnus-url-mailto 1)
5688     ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
5689      gnus-button-message-id 3))
5690   "*Alist of headers and regexps to match buttons in article heads.
5691
5692 This alist is very similar to `gnus-button-alist', except that each
5693 alist has an additional HEADER element first in each entry:
5694
5695 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
5696
5697 HEADER is a regexp to match a header.  For a fuller explanation, see
5698 `gnus-button-alist'."
5699   :group 'gnus-article-buttons
5700   :group 'gnus-article-headers
5701   :type '(repeat (list (regexp :tag "Header")
5702                        regexp
5703                        (integer :tag "Button")
5704                        (sexp :tag "Form")
5705                        (function :tag "Callback")
5706                        (repeat :tag "Par"
5707                                :inline t
5708                                (integer :tag "Regexp group")))))
5709
5710 (defvar gnus-button-regexp nil)
5711 (defvar gnus-button-marker-list nil)
5712 ;; Regexp matching any of the regexps from `gnus-button-alist'.
5713
5714 (defvar gnus-button-last nil)
5715 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
5716
5717 ;;; Commands:
5718
5719 (defun gnus-article-push-button (event)
5720   "Check text under the mouse pointer for a callback function.
5721 If the text under the mouse pointer has a `gnus-callback' property,
5722 call it with the value of the `gnus-data' text property."
5723   (interactive "e")
5724   (set-buffer (window-buffer (posn-window (event-start event))))
5725   (let* ((pos (posn-point (event-start event)))
5726          (data (get-text-property pos 'gnus-data))
5727          (fun (get-text-property pos 'gnus-callback)))
5728     (goto-char pos)
5729     (when fun
5730       (funcall fun data))))
5731
5732 (defun gnus-article-press-button ()
5733   "Check text at point for a callback function.
5734 If the text at point has a `gnus-callback' property,
5735 call it with the value of the `gnus-data' text property."
5736   (interactive)
5737   (let ((data (get-text-property (point) 'gnus-data))
5738         (fun (get-text-property (point) 'gnus-callback)))
5739     (when fun
5740       (funcall fun data))))
5741
5742 (defun gnus-article-highlight (&optional force)
5743   "Highlight current article.
5744 This function calls `gnus-article-highlight-headers',
5745 `gnus-article-highlight-citation',
5746 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
5747 do the highlighting.  See the documentation for those functions."
5748   (interactive (list 'force))
5749   (gnus-article-highlight-headers)
5750   (gnus-article-highlight-citation force)
5751   (gnus-article-highlight-signature)
5752   (gnus-article-add-buttons force)
5753   (gnus-article-add-buttons-to-head))
5754
5755 (defun gnus-article-highlight-some (&optional force)
5756   "Highlight current article.
5757 This function calls `gnus-article-highlight-headers',
5758 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
5759 do the highlighting.  See the documentation for those functions."
5760   (interactive (list 'force))
5761   (gnus-article-highlight-headers)
5762   (gnus-article-highlight-signature)
5763   (gnus-article-add-buttons))
5764
5765 (defun gnus-article-highlight-headers ()
5766   "Highlight article headers as specified by `gnus-header-face-alist'."
5767   (interactive)
5768   (save-excursion
5769     (set-buffer gnus-article-buffer)
5770     (save-restriction
5771       (let ((alist gnus-header-face-alist)
5772             (buffer-read-only nil)
5773             (case-fold-search t)
5774             (inhibit-point-motion-hooks t)
5775             entry regexp header-face field-face from hpoints fpoints)
5776         (article-narrow-to-head)
5777         (while (setq entry (pop alist))
5778           (goto-char (point-min))
5779           (setq regexp (concat "^\\("
5780                                (if (string-equal "" (nth 0 entry))
5781                                    "[^\t ]"
5782                                  (nth 0 entry))
5783                                "\\)")
5784                 header-face (nth 1 entry)
5785                 field-face (nth 2 entry))
5786           (while (and (re-search-forward regexp nil t)
5787                       (not (eobp)))
5788             (beginning-of-line)
5789             (setq from (point))
5790             (unless (search-forward ":" nil t)
5791               (forward-char 1))
5792             (when (and header-face
5793                        (not (memq (point) hpoints)))
5794               (push (point) hpoints)
5795               (gnus-put-text-property from (point) 'face header-face))
5796             (when (and field-face
5797                        (not (memq (setq from (point)) fpoints)))
5798               (push from fpoints)
5799               (if (re-search-forward "^[^ \t]" nil t)
5800                   (forward-char -2)
5801                 (goto-char (point-max)))
5802               (gnus-put-text-property from (point) 'face field-face))))))))
5803
5804 (defun gnus-article-highlight-signature ()
5805   "Highlight the signature in an article.
5806 It does this by highlighting everything after
5807 `gnus-signature-separator' using `gnus-signature-face'."
5808   (interactive)
5809   (save-excursion
5810     (set-buffer gnus-article-buffer)
5811     (let ((buffer-read-only nil)
5812           (inhibit-point-motion-hooks t))
5813       (save-restriction
5814         (when (and gnus-signature-face
5815                    (gnus-article-narrow-to-signature))
5816           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
5817                             'face gnus-signature-face)
5818           (widen)
5819           (gnus-article-search-signature)
5820           (let ((start (match-beginning 0))
5821                 (end (set-marker (make-marker) (1+ (match-end 0)))))
5822             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
5823                                      end)))))))
5824
5825 (defun gnus-button-in-region-p (b e prop)
5826   "Say whether PROP exists in the region."
5827   (text-property-not-all b e prop nil))
5828
5829 (defun gnus-article-add-buttons (&optional force)
5830   "Find external references in the article and make buttons of them.
5831 \"External references\" are things like Message-IDs and URLs, as
5832 specified by `gnus-button-alist'."
5833   (interactive (list 'force))
5834   (save-excursion
5835     (set-buffer gnus-article-buffer)
5836     (let ((buffer-read-only nil)
5837           (inhibit-point-motion-hooks t)
5838           (case-fold-search t)
5839           (alist gnus-button-alist)
5840           beg entry regexp)
5841       ;; Remove all old markers.
5842       (let (marker entry new-list)
5843         (while (setq marker (pop gnus-button-marker-list))
5844           (if (or (< marker (point-min)) (>= marker (point-max)))
5845               (push marker new-list)
5846             (goto-char marker)
5847             (when (setq entry (gnus-button-entry))
5848               (put-text-property (match-beginning (nth 1 entry))
5849                                  (match-end (nth 1 entry))
5850                                  'gnus-callback nil))
5851             (set-marker marker nil)))
5852         (setq gnus-button-marker-list new-list))
5853       ;; We skip the headers.
5854       (article-goto-body)
5855       (setq beg (point))
5856       (while (setq entry (pop alist))
5857         (setq regexp (eval (car entry)))
5858         (goto-char beg)
5859         (while (re-search-forward regexp nil t)
5860           (let* ((start (and entry (match-beginning (nth 1 entry))))
5861                  (end (and entry (match-end (nth 1 entry))))
5862                  (from (match-beginning 0)))
5863             (when (and (or (eq t (nth 2 entry))
5864                            (eval (nth 2 entry)))
5865                        (not (gnus-button-in-region-p
5866                              start end 'gnus-callback)))
5867               ;; That optional form returned non-nil, so we add the
5868               ;; button.
5869               (gnus-article-add-button
5870                start end 'gnus-button-push
5871                (car (push (set-marker (make-marker) from)
5872                           gnus-button-marker-list))))))))))
5873
5874 ;; Add buttons to the head of an article.
5875 (defun gnus-article-add-buttons-to-head ()
5876   "Add buttons to the head of the article."
5877   (interactive)
5878   (save-excursion
5879     (set-buffer gnus-article-buffer)
5880     (save-restriction
5881       (let ((buffer-read-only nil)
5882             (inhibit-point-motion-hooks t)
5883             (case-fold-search t)
5884             (alist gnus-header-button-alist)
5885             entry beg end)
5886         (article-narrow-to-head)
5887         (while alist
5888           ;; Each alist entry.
5889           (setq entry (car alist)
5890                 alist (cdr alist))
5891           (goto-char (point-min))
5892           (while (re-search-forward (car entry) nil t)
5893             ;; Each header matching the entry.
5894             (setq beg (match-beginning 0))
5895             (setq end (or (and (re-search-forward "^[^ \t]" nil t)
5896                                (match-beginning 0))
5897                           (point-max)))
5898             (goto-char beg)
5899             (while (re-search-forward (eval (nth 1 entry)) end t)
5900               ;; Each match within a header.
5901               (let* ((entry (cdr entry))
5902                      (start (match-beginning (nth 1 entry)))
5903                      (end (match-end (nth 1 entry)))
5904                      (form (nth 2 entry)))
5905                 (goto-char (match-end 0))
5906                 (when (eval form)
5907                   (gnus-article-add-button
5908                    start end (nth 3 entry)
5909                    (buffer-substring (match-beginning (nth 4 entry))
5910                                      (match-end (nth 4 entry)))))))
5911             (goto-char end)))))))
5912
5913 ;;; External functions:
5914
5915 (defun gnus-article-add-button (from to fun &optional data)
5916   "Create a button between FROM and TO with callback FUN and data DATA."
5917   (when gnus-article-button-face
5918     (gnus-overlay-put (gnus-make-overlay from to)
5919                       'face gnus-article-button-face))
5920   (gnus-add-text-properties
5921    from to
5922    (nconc (and gnus-article-mouse-face
5923                (list gnus-mouse-face-prop gnus-article-mouse-face))
5924           (list 'gnus-callback fun)
5925           (and data (list 'gnus-data data))))
5926   (widget-convert-button 'link from to :action 'gnus-widget-press-button
5927                          :button-keymap gnus-widget-button-keymap))
5928
5929 ;;; Internal functions:
5930
5931 (defun gnus-article-set-globals ()
5932   (save-excursion
5933     (set-buffer gnus-summary-buffer)
5934     (gnus-set-global-variables)))
5935
5936 (defun gnus-signature-toggle (end)
5937   (save-excursion
5938     (set-buffer gnus-article-buffer)
5939     (let ((buffer-read-only nil)
5940           (inhibit-point-motion-hooks t))
5941       (if (text-property-any end (point-max) 'article-type 'signature)
5942           (progn
5943             (gnus-delete-wash-type 'signature)
5944             (gnus-remove-text-properties-when
5945              'article-type 'signature end (point-max)
5946              (cons 'article-type (cons 'signature
5947                                        gnus-hidden-properties))))
5948         (gnus-add-wash-type 'signature)
5949         (gnus-add-text-properties-when
5950          'article-type nil end (point-max)
5951          (cons 'article-type (cons 'signature
5952                                    gnus-hidden-properties)))))
5953     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
5954       (gnus-set-mode-line 'article))))
5955
5956 (defun gnus-button-entry ()
5957   ;; Return the first entry in `gnus-button-alist' matching this place.
5958   (let ((alist gnus-button-alist)
5959         (entry nil))
5960     (while alist
5961       (setq entry (pop alist))
5962       (if (looking-at (eval (car entry)))
5963           (setq alist nil)
5964         (setq entry nil)))
5965     entry))
5966
5967 (defun gnus-button-push (marker)
5968   ;; Push button starting at MARKER.
5969   (save-excursion
5970     (goto-char marker)
5971     (let* ((entry (gnus-button-entry))
5972            (inhibit-point-motion-hooks t)
5973            (fun (nth 3 entry))
5974            (args (mapcar (lambda (group)
5975                            (let ((string (match-string group)))
5976                              (gnus-set-text-properties
5977                               0 (length string) nil string)
5978                              string))
5979                          (nthcdr 4 entry))))
5980       (cond
5981        ((fboundp fun)
5982         (apply fun args))
5983        ((and (boundp fun)
5984              (fboundp (symbol-value fun)))
5985         (apply (symbol-value fun) args))
5986        (t
5987         (gnus-message 1 "You must define `%S' to use this button"
5988                       (cons fun args)))))))
5989
5990 (defun gnus-parse-news-url (url)
5991   (let (scheme server group message-id articles)
5992     (with-temp-buffer
5993       (insert url)
5994       (goto-char (point-min))
5995       (when (looking-at "\\([A-Za-z]+\\):")
5996         (setq scheme (match-string 1))
5997         (goto-char (match-end 0)))
5998       (when (looking-at "//\\([^/]+\\)/")
5999         (setq server (match-string 1))
6000         (goto-char (match-end 0)))
6001
6002       (cond
6003        ((looking-at "\\(.*@.*\\)")
6004         (setq message-id (match-string 1)))
6005        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
6006         (setq group (match-string 1)
6007               articles (split-string (match-string 2) "-")))
6008        ((looking-at "\\([^/]+\\)/?")
6009         (setq group (match-string 1)))
6010        (t
6011         (error "Unknown news URL syntax"))))
6012     (list scheme server group message-id articles)))
6013
6014 (defun gnus-button-handle-news (url)
6015   "Fetch a news URL."
6016   (destructuring-bind (scheme server group message-id articles)
6017       (gnus-parse-news-url url)
6018     (cond
6019      (message-id
6020       (save-excursion
6021         (set-buffer gnus-summary-buffer)
6022         (if server
6023             (let ((gnus-refer-article-method (list (list 'nntp server))))
6024               (gnus-summary-refer-article message-id))
6025           (gnus-summary-refer-article message-id))))
6026      (group
6027       (gnus-button-fetch-group url)))))
6028
6029 (defun gnus-button-handle-man (url)
6030   "Fetch a man page."
6031   (funcall gnus-button-man-handler url))
6032
6033 (defun gnus-button-handle-info (url)
6034   "Fetch an info URL."
6035   (if (string-match
6036        "^\\([^:/]+\\)?/\\(.*\\)"
6037        url)
6038       (gnus-info-find-node
6039        (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
6040                        "Gnus")
6041                ")"
6042                (gnus-url-unhex-string (match-string 2 url))))
6043     (error "Can't parse %s" url)))
6044
6045 (defun gnus-button-message-id (message-id)
6046   "Fetch MESSAGE-ID."
6047   (save-excursion
6048     (set-buffer gnus-summary-buffer)
6049     (gnus-summary-refer-article message-id)))
6050
6051 (defun gnus-button-fetch-group (address)
6052   "Fetch GROUP specified by ADDRESS."
6053   (if (not (string-match "[:/]" address))
6054       ;; This is just a simple group url.
6055       (gnus-group-read-ephemeral-group address gnus-select-method)
6056     (if (not
6057          (string-match
6058           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
6059           address))
6060         (error "Can't parse %s" address)
6061       (gnus-group-read-ephemeral-group
6062        (match-string 4 address)
6063        `(nntp ,(match-string 1 address)
6064               (nntp-address ,(match-string 1 address))
6065               (nntp-port-number ,(if (match-end 3)
6066                                      (match-string 3 address)
6067                                    "nntp")))
6068        nil nil nil
6069        (and (match-end 6) (list (string-to-int (match-string 6 address))))))))
6070
6071 (defun gnus-url-parse-query-string (query &optional downcase)
6072   (let (retval pairs cur key val)
6073     (setq pairs (split-string query "&"))
6074     (while pairs
6075       (setq cur (car pairs)
6076             pairs (cdr pairs))
6077       (if (not (string-match "=" cur))
6078           nil                           ; Grace
6079         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
6080               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
6081         (if downcase
6082             (setq key (downcase key)))
6083         (setq cur (assoc key retval))
6084         (if cur
6085             (setcdr cur (cons val (cdr cur)))
6086           (setq retval (cons (list key val) retval)))))
6087     retval))
6088
6089 (defun gnus-url-mailto (url)
6090   ;; Send mail to someone
6091   (when (string-match "mailto:/*\\(.*\\)" url)
6092     (setq url (substring url (match-beginning 1) nil)))
6093   (let (to args subject func)
6094     (if (string-match (regexp-quote "?") url)
6095         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
6096               args (gnus-url-parse-query-string
6097                     (substring url (match-end 0) nil) t))
6098       (setq to (gnus-url-unhex-string url)))
6099     (setq args (cons (list "to" to) args)
6100           subject (cdr-safe (assoc "subject" args)))
6101     (gnus-msg-mail)
6102     (while args
6103       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
6104       (if (fboundp func)
6105           (funcall func)
6106         (message-position-on-field (caar args)))
6107       (insert (mapconcat 'identity (cdar args) ", "))
6108       (setq args (cdr args)))
6109     (if subject
6110         (message-goto-body)
6111       (message-goto-subject))))
6112
6113 (defun gnus-button-embedded-url (address)
6114   "Activate ADDRESS with `browse-url'."
6115   (browse-url (gnus-strip-whitespace address)))
6116
6117 ;;; Next/prev buttons in the article buffer.
6118
6119 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
6120 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
6121
6122 (defvar gnus-prev-page-map
6123   (let ((map (make-sparse-keymap)))
6124     (unless (>= emacs-major-version 21)
6125       ;; XEmacs doesn't care.
6126       (set-keymap-parent map gnus-article-mode-map))
6127     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6128     (define-key map "\r" 'gnus-button-prev-page)
6129     map))
6130
6131 (defun gnus-insert-prev-page-button ()
6132   (let ((b (point))
6133         (buffer-read-only nil))
6134     (gnus-eval-format
6135      gnus-prev-page-line-format nil
6136      `(,@(gnus-local-map-property gnus-prev-page-map)
6137          gnus-prev t
6138          gnus-callback gnus-article-button-prev-page
6139          article-type annotation))
6140     (widget-convert-button
6141      'link b (point)
6142      :action 'gnus-button-prev-page
6143      :button-keymap gnus-prev-page-map)))
6144
6145 (defvar gnus-prev-page-map
6146   (let ((map (make-sparse-keymap)))
6147     (unless (>= emacs-major-version 21)
6148       ;; XEmacs doesn't care.
6149       (set-keymap-parent map gnus-article-mode-map))
6150     (define-key map gnus-mouse-2 'gnus-button-prev-page)
6151     (define-key map "\r" 'gnus-button-prev-page)
6152     map))
6153
6154 (defvar gnus-next-page-map
6155   (let ((map (make-sparse-keymap)))
6156     (unless (>= emacs-major-version 21)
6157       ;; XEmacs doesn't care.
6158       (set-keymap-parent map gnus-article-mode-map))
6159     (define-key map gnus-mouse-2 'gnus-button-next-page)
6160     (define-key map "\r" 'gnus-button-next-page)
6161     map))
6162
6163 (defun gnus-button-next-page (&optional args more-args)
6164   "Go to the next page."
6165   (interactive)
6166   (let ((win (selected-window)))
6167     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6168     (gnus-article-next-page)
6169     (select-window win)))
6170
6171 (defun gnus-button-prev-page (&optional args more-args)
6172   "Go to the prev page."
6173   (interactive)
6174   (let ((win (selected-window)))
6175     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6176     (gnus-article-prev-page)
6177     (select-window win)))
6178
6179 (defun gnus-insert-next-page-button ()
6180   (let ((b (point))
6181         (buffer-read-only nil))
6182     (gnus-eval-format gnus-next-page-line-format nil
6183                       `(,@(gnus-local-map-property gnus-next-page-map)
6184                           gnus-next t
6185                           gnus-callback gnus-article-button-next-page
6186                           article-type annotation))
6187     (widget-convert-button
6188      'link b (point)
6189      :action 'gnus-button-next-page
6190      :button-keymap gnus-next-page-map)))
6191
6192 (defun gnus-article-button-next-page (arg)
6193   "Go to the next page."
6194   (interactive "P")
6195   (let ((win (selected-window)))
6196     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6197     (gnus-article-next-page)
6198     (select-window win)))
6199
6200 (defun gnus-article-button-prev-page (arg)
6201   "Go to the prev page."
6202   (interactive "P")
6203   (let ((win (selected-window)))
6204     (select-window (gnus-get-buffer-window gnus-article-buffer t))
6205     (gnus-article-prev-page)
6206     (select-window win)))
6207
6208 (defvar gnus-decode-header-methods
6209   '(mail-decode-encoded-word-region)
6210   "List of methods used to decode headers.
6211
6212 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
6213 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
6214 \(REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
6215 whose names match REGEXP.
6216
6217 For example:
6218 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
6219  mail-decode-encoded-word-region
6220  (\"chinese\" . rfc1843-decode-region))
6221 ")
6222
6223 (defvar gnus-decode-header-methods-cache nil)
6224
6225 (defun gnus-multi-decode-header (start end)
6226   "Apply the functions from `gnus-encoded-word-methods' that match."
6227   (unless (and gnus-decode-header-methods-cache
6228                (eq gnus-newsgroup-name
6229                    (car gnus-decode-header-methods-cache)))
6230     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
6231     (mapcar (lambda (x)
6232               (if (symbolp x)
6233                   (nconc gnus-decode-header-methods-cache (list x))
6234                 (if (and gnus-newsgroup-name
6235                          (string-match (car x) gnus-newsgroup-name))
6236                     (nconc gnus-decode-header-methods-cache
6237                            (list (cdr x))))))
6238           gnus-decode-header-methods))
6239   (let ((xlist gnus-decode-header-methods-cache))
6240     (pop xlist)
6241     (save-restriction
6242       (narrow-to-region start end)
6243       (while xlist
6244         (funcall (pop xlist) (point-min) (point-max))))))
6245
6246 ;;;
6247 ;;; Treatment top-level handling.
6248 ;;;
6249
6250 (defun gnus-treat-article (condition &optional part-number total-parts type)
6251   (let ((length (- (point-max) (point-min)))
6252         (alist gnus-treatment-function-alist)
6253         (article-goto-body-goes-to-point-min-p t)
6254         (treated-type
6255          (or (not type)
6256              (catch 'found
6257                (let ((list gnus-article-treat-types))
6258                  (while list
6259                    (when (string-match (pop list) type)
6260                      (throw 'found t)))))))
6261         (highlightp (gnus-visual-p 'article-highlight 'highlight))
6262         val elem)
6263     (gnus-run-hooks 'gnus-part-display-hook)
6264     (dolist (elem alist)
6265       (setq val
6266             (save-excursion
6267               (when (gnus-buffer-live-p gnus-summary-buffer)
6268                 (set-buffer gnus-summary-buffer))
6269               (symbol-value (car elem))))
6270       (when (and (or (consp val)
6271                      treated-type)
6272                  (gnus-treat-predicate val)
6273                  (or (not (get (car elem) 'highlight))
6274                      highlightp))
6275         (save-restriction
6276           (funcall (cadr elem)))))))
6277
6278 ;; Dynamic variables.
6279 (eval-when-compile
6280   (defvar part-number)
6281   (defvar total-parts)
6282   (defvar type)
6283   (defvar condition)
6284   (defvar length))
6285
6286 (defun gnus-treat-predicate (val)
6287   (cond
6288    ((null val)
6289     nil)
6290    (condition
6291     (eq condition val))
6292    ((and (listp val)
6293          (stringp (car val)))
6294     (apply 'gnus-or (mapcar `(lambda (s)
6295                                (string-match s ,(or gnus-newsgroup-name "")))
6296                             val)))
6297    ((listp val)
6298     (let ((pred (pop val)))
6299       (cond
6300        ((eq pred 'or)
6301         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
6302        ((eq pred 'and)
6303         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
6304        ((eq pred 'not)
6305         (not (gnus-treat-predicate (car val))))
6306        ((eq pred 'typep)
6307         (equal (car val) type))
6308        (t
6309         (error "%S is not a valid predicate" pred)))))
6310    ((eq val t)
6311     t)
6312    ((eq val 'head)
6313     nil)
6314    ((eq val 'last)
6315     (eq part-number total-parts))
6316    ((numberp val)
6317     (< length val))
6318    (t
6319     (error "%S is not a valid value" val))))
6320
6321 (defun gnus-article-encrypt-body (protocol &optional n)
6322   "Encrypt the article body."
6323   (interactive
6324    (list
6325     (or gnus-article-encrypt-protocol
6326         (completing-read "Encrypt protocol: "
6327                          gnus-article-encrypt-protocol-alist
6328                          nil t))
6329     current-prefix-arg))
6330   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
6331     (unless func
6332       (error (format "Can't find the encrypt protocol %s" protocol)))
6333     (if (member gnus-newsgroup-name '("nndraft:delayed"
6334                                       "nndraft:drafts"
6335                                       "nndraft:queue"))
6336         (error "Can't encrypt the article in group %s"
6337                gnus-newsgroup-name))
6338     (gnus-summary-iterate n
6339       (save-excursion
6340         (set-buffer gnus-summary-buffer)
6341         (let ((mail-parse-charset gnus-newsgroup-charset)
6342               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
6343               (summary-buffer gnus-summary-buffer)
6344               references point)
6345           (gnus-set-global-variables)
6346           (when (gnus-group-read-only-p)
6347             (error "The current newsgroup does not support article encrypt"))
6348           (gnus-summary-show-article t)
6349           (setq references
6350               (or (mail-header-references gnus-current-headers) ""))
6351           (set-buffer gnus-article-buffer)
6352           (let* ((buffer-read-only nil)
6353                  (headers
6354                   (mapcar (lambda (field)
6355                             (and (save-restriction
6356                                    (message-narrow-to-head)
6357                                    (goto-char (point-min))
6358                                    (search-forward field nil t))
6359                                  (prog2
6360                                      (message-narrow-to-field)
6361                                      (buffer-substring (point-min) (point-max))
6362                                    (delete-region (point-min) (point-max))
6363                                    (widen))))
6364                           '("Content-Type:" "Content-Transfer-Encoding:"
6365                             "Content-Disposition:"))))
6366             (message-narrow-to-head)
6367             (message-remove-header "MIME-Version")
6368             (goto-char (point-max))
6369             (setq point (point))
6370             (insert (apply 'concat headers))
6371             (widen)
6372             (narrow-to-region point (point-max))
6373             (let ((message-options message-options))
6374               (message-options-set 'message-sender user-mail-address)
6375               (message-options-set 'message-recipients user-mail-address)
6376               (message-options-set 'message-sign-encrypt 'not)
6377               (funcall func))
6378             (goto-char (point-min))
6379             (insert "MIME-Version: 1.0\n")
6380             (widen)
6381             (gnus-summary-edit-article-done
6382              references nil summary-buffer t))
6383           (when gnus-keep-backlog
6384             (gnus-backlog-remove-article
6385              (car gnus-article-current) (cdr gnus-article-current)))
6386           (save-excursion
6387             (when (get-buffer gnus-original-article-buffer)
6388               (set-buffer gnus-original-article-buffer)
6389               (setq gnus-original-article nil)))
6390           (when gnus-use-cache
6391             (gnus-cache-update-article
6392              (car gnus-article-current) (cdr gnus-article-current))))))))
6393
6394 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
6395   "The following specs can be used:
6396 %t  The security MIME type
6397 %i  Additional info
6398 %d  Details
6399 %D  Details if button is pressed")
6400
6401 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
6402   "The following specs can be used:
6403 %t  The security MIME type
6404 %i  Additional info
6405 %d  Details
6406 %D  Details if button is pressed")
6407
6408 (defvar gnus-mime-security-button-line-format-alist
6409   '((?t gnus-tmp-type ?s)
6410     (?i gnus-tmp-info ?s)
6411     (?d gnus-tmp-details ?s)
6412     (?D gnus-tmp-pressed-details ?s)))
6413
6414 (defvar gnus-mime-security-button-map
6415   (let ((map (make-sparse-keymap)))
6416     (unless (>= (string-to-number emacs-version) 21)
6417       (set-keymap-parent map gnus-article-mode-map))
6418     (define-key map gnus-mouse-2 'gnus-article-push-button)
6419     (define-key map "\r" 'gnus-article-press-button)
6420     map))
6421
6422 (defvar gnus-mime-security-details-buffer nil)
6423
6424 (defvar gnus-mime-security-button-pressed nil)
6425
6426 (defvar gnus-mime-security-show-details-inline t
6427   "If non-nil, show details in the article buffer.")
6428
6429 (defun gnus-mime-security-verify-or-decrypt (handle)
6430   (mm-remove-parts (cdr handle))
6431   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
6432         point buffer-read-only)
6433     (if region
6434         (goto-char (car region)))
6435     (save-restriction
6436       (narrow-to-region (point) (point))
6437       (with-current-buffer (mm-handle-multipart-original-buffer handle)
6438         (let* ((mm-verify-option 'known)
6439                (mm-decrypt-option 'known)
6440                (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
6441           (unless (eq nparts (cdr handle))
6442             (mm-destroy-parts (cdr handle))
6443             (setcdr handle nparts))))
6444       (setq point (point))
6445       (gnus-mime-display-security handle)
6446       (goto-char (point-max)))
6447     (when region
6448       (delete-region (point) (cdr region))
6449       (set-marker (car region) nil)
6450       (set-marker (cdr region) nil))
6451     (goto-char point)))
6452
6453 (defun gnus-mime-security-show-details (handle)
6454   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
6455     (if (not details)
6456         (gnus-message 5 "No details.")
6457       (if gnus-mime-security-show-details-inline
6458           (let ((gnus-mime-security-button-pressed
6459                  (not (get-text-property (point) 'gnus-mime-details)))
6460                 (gnus-mime-security-button-line-format
6461                  (get-text-property (point) 'gnus-line-format))
6462                 buffer-read-only)
6463             (forward-char -1)
6464             (while (eq (get-text-property (point) 'gnus-line-format)
6465                        gnus-mime-security-button-line-format)
6466               (forward-char -1))
6467             (forward-char)
6468             (save-restriction
6469               (narrow-to-region (point) (point))
6470               (gnus-insert-mime-security-button handle))
6471             (delete-region (point)
6472                            (or (text-property-not-all
6473                                 (point) (point-max)
6474                                 'gnus-line-format
6475                                 gnus-mime-security-button-line-format)
6476                                (point-max))))
6477         ;; Not inlined.
6478         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
6479             (with-current-buffer gnus-mime-security-details-buffer
6480               (erase-buffer)
6481               t)
6482           (setq gnus-mime-security-details-buffer
6483                 (gnus-get-buffer-create "*MIME Security Details*")))
6484         (with-current-buffer gnus-mime-security-details-buffer
6485           (insert details)
6486           (goto-char (point-min)))
6487         (pop-to-buffer gnus-mime-security-details-buffer)))))
6488
6489 (defun gnus-mime-security-press-button (handle)
6490   (save-excursion
6491     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6492         (gnus-mime-security-show-details handle)
6493       (gnus-mime-security-verify-or-decrypt handle))))
6494
6495 (defun gnus-insert-mime-security-button (handle &optional displayed)
6496   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
6497          (gnus-tmp-type
6498           (concat
6499            (or (nth 2 (assoc protocol mm-verify-function-alist))
6500                (nth 2 (assoc protocol mm-decrypt-function-alist))
6501                "Unknown")
6502            (if (equal (car handle) "multipart/signed")
6503                " Signed" " Encrypted")
6504            " Part"))
6505          (gnus-tmp-info
6506           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
6507               "Undecided"))
6508          (gnus-tmp-details
6509           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
6510          gnus-tmp-pressed-details
6511          b e)
6512     (setq gnus-tmp-details
6513           (if gnus-tmp-details
6514               (concat "\n" gnus-tmp-details)
6515             ""))
6516     (setq gnus-tmp-pressed-details
6517           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
6518     (unless (bolp)
6519       (insert "\n"))
6520     (setq b (point))
6521     (gnus-eval-format
6522      gnus-mime-security-button-line-format
6523      gnus-mime-security-button-line-format-alist
6524      `(,@(gnus-local-map-property gnus-mime-security-button-map)
6525          gnus-callback gnus-mime-security-press-button
6526          gnus-line-format ,gnus-mime-security-button-line-format
6527          gnus-mime-details ,gnus-mime-security-button-pressed
6528          article-type annotation
6529          gnus-data ,handle))
6530     (setq e (point))
6531     (widget-convert-button
6532      'link b e
6533      :mime-handle handle
6534      :action 'gnus-widget-press-button
6535      :button-keymap gnus-mime-security-button-map
6536      :help-echo
6537      (lambda (widget/window &optional overlay pos)
6538        ;; Needed to properly clear the message due to a bug in
6539        ;; wid-edit (XEmacs only).
6540        (when (boundp 'help-echo-owns-message)
6541          (setq help-echo-owns-message t))
6542        (format
6543         "%S: show detail"
6544         (aref gnus-mouse-2 0))))))
6545
6546 (defun gnus-mime-display-security (handle)
6547   (save-restriction
6548     (narrow-to-region (point) (point))
6549     (unless (gnus-unbuttonized-mime-type-p (car handle))
6550       (gnus-insert-mime-security-button handle))
6551     (gnus-mime-display-mixed (cdr handle))
6552     (unless (bolp)
6553       (insert "\n"))
6554     (unless (gnus-unbuttonized-mime-type-p (car handle))
6555       (let ((gnus-mime-security-button-line-format
6556              gnus-mime-security-button-end-line-format))
6557         (gnus-insert-mime-security-button handle)))
6558     (mm-set-handle-multipart-parameter
6559      handle 'gnus-region
6560      (cons (set-marker (make-marker) (point-min))
6561            (set-marker (make-marker) (point-max))))))
6562
6563 (gnus-ems-redefine)
6564
6565 (provide 'gnus-art)
6566
6567 (run-hooks 'gnus-art-load-hook)
6568
6569 ;;; gnus-art.el ends here