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