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