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