gnus-art.el (article-treat-non-ascii): Make it work for XEmacs (at least 21.5).
[gnus] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 ;; For Emacs <22.2 and XEmacs.
29 (eval-and-compile
30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
31 (eval-when-compile
32   (require 'cl))
33 (defvar tool-bar-map)
34 (defvar w3m-minor-mode-map)
35
36 (require 'gnus)
37 (require 'gnus-sum)
38 (require 'gnus-spec)
39 (require 'gnus-int)
40 (require 'gnus-win)
41 (require 'mm-bodies)
42 (require 'mail-parse)
43 (require 'mm-decode)
44 (require 'mm-view)
45 (require 'wid-edit)
46 (require 'mm-uu)
47 (require 'message)
48
49 (autoload 'gnus-msg-mail "gnus-msg" nil t)
50 (autoload 'gnus-button-mailto "gnus-msg")
51 (autoload 'gnus-button-reply "gnus-msg" nil t)
52 (autoload 'parse-time-string "parse-time" nil nil)
53 (autoload 'ansi-color-apply-on-region "ansi-color")
54 (autoload 'mm-url-insert-file-contents-external "mm-url")
55 (autoload 'mm-extern-cache-contents "mm-extern")
56
57 (defgroup gnus-article nil
58   "Article display."
59   :link '(custom-manual "(gnus)Article Buffer")
60   :group 'gnus)
61
62 (defgroup gnus-article-treat nil
63   "Treating article parts."
64   :link '(custom-manual "(gnus)Article Hiding")
65   :group 'gnus-article)
66
67 (defgroup gnus-article-hiding nil
68   "Hiding article parts."
69   :link '(custom-manual "(gnus)Article Hiding")
70   :group 'gnus-article)
71
72 (defgroup gnus-article-highlight nil
73   "Article highlighting."
74   :link '(custom-manual "(gnus)Article Highlighting")
75   :group 'gnus-article
76   :group 'gnus-visual)
77
78 (defgroup gnus-article-signature nil
79   "Article signatures."
80   :link '(custom-manual "(gnus)Article Signature")
81   :group 'gnus-article)
82
83 (defgroup gnus-article-headers nil
84   "Article headers."
85   :link '(custom-manual "(gnus)Hiding Headers")
86   :group 'gnus-article)
87
88 (defgroup gnus-article-washing nil
89   "Special commands on articles."
90   :link '(custom-manual "(gnus)Article Washing")
91   :group 'gnus-article)
92
93 (defgroup gnus-article-emphasis nil
94   "Fontisizing articles."
95   :link '(custom-manual "(gnus)Article Fontisizing")
96   :group 'gnus-article)
97
98 (defgroup gnus-article-saving nil
99   "Saving articles."
100   :link '(custom-manual "(gnus)Saving Articles")
101   :group 'gnus-article)
102
103 (defgroup gnus-article-mime nil
104   "Worshiping the MIME wonder."
105   :link '(custom-manual "(gnus)Using MIME")
106   :group 'gnus-article)
107
108 (defgroup gnus-article-buttons nil
109   "Pushable buttons in the article buffer."
110   :link '(custom-manual "(gnus)Article Buttons")
111   :group 'gnus-article)
112
113 (defgroup gnus-article-various nil
114   "Other article options."
115   :link '(custom-manual "(gnus)Misc Article")
116   :group 'gnus-article)
117
118 (defcustom gnus-ignored-headers
119   (mapcar
120    (lambda (header)
121      (concat "^" header ":"))
122    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
123      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
124      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
125      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
126      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
127      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
128      "X-Attribution" "X-Originating-IP" "Delivered-To"
129      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
130      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
131      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
132      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
133      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
134      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
135      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
136      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
137      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
138      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
139      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
140      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
141      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
142      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
143      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
144      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
145      "List-[A-Za-z]+" "X-Listprocessor-Version"
146      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
147      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
148      "X-Received" "Content-length" "X-precedence"
149      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
150      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
151      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
152      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
153      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
154      "X-Content-length" "X-Posting-Agent" "Original-Received"
155      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
156      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
157      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
158      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
159      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
160      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
161      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
162      "Envelope-Sender" "Envelope-Recipients"))
163   "*All headers that start with this regexp will be hidden.
164 This variable can also be a list of regexps of headers to be ignored.
165 If `gnus-visible-headers' is non-nil, this variable will be ignored."
166   :type '(choice :custom-show nil
167                  regexp
168                  (repeat regexp))
169   :group 'gnus-article-hiding)
170
171 (defcustom gnus-visible-headers
172   "^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:"
173   "*All headers that do not match this regexp will be hidden.
174 This variable can also be a list of regexp of headers to remain visible.
175 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
176   :type '(choice
177           (repeat :value-to-internal (lambda (widget value)
178                                        (custom-split-regexp-maybe value))
179                   :match (lambda (widget value)
180                            (or (stringp value)
181                                (widget-editable-list-match widget value)))
182                   regexp)
183           (const :tag "Use gnus-ignored-headers" nil)
184           regexp)
185   :group 'gnus-article-hiding)
186
187 (defcustom gnus-sorted-header-list
188   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
189     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
190   "*This variable is a list of regular expressions.
191 If it is non-nil, headers that match the regular expressions will
192 be placed first in the article buffer in the sequence specified by
193 this list."
194   :type '(repeat regexp)
195   :group 'gnus-article-hiding)
196
197 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
198   "Headers that are only to be displayed if they have interesting data.
199 Possible values in this list are:
200
201   'empty       Headers with no content.
202   'newsgroups  Newsgroup identical to Gnus group.
203   'to-address  To identical to To-address.
204   'to-list     To identical to To-list.
205   'cc-list     CC identical to To-list.
206   'followup-to Followup-to identical to Newsgroups.
207   'reply-to    Reply-to identical to From.
208   'date        Date less than four days old.
209   'long-to     To and/or Cc longer than 1024 characters.
210   'many-to     Multiple To and/or Cc."
211   :type '(set (const :tag "Headers with no content." empty)
212               (const :tag "Newsgroups identical to Gnus group." newsgroups)
213               (const :tag "To identical to To-address." to-address)
214               (const :tag "To identical to To-list." to-list)
215               (const :tag "CC identical to To-list." cc-list)
216               (const :tag "Followup-to identical to Newsgroups." followup-to)
217               (const :tag "Reply-to identical to From." reply-to)
218               (const :tag "Date less than four days old." date)
219               (const :tag "To and/or Cc longer than 1024 characters." long-to)
220               (const :tag "Multiple To and/or Cc headers." many-to))
221   :group 'gnus-article-hiding)
222
223 (defcustom gnus-article-skip-boring nil
224   "Skip over text that is not worth reading.
225 By default, if you set this t, then Gnus will display citations and
226 signatures, but will never scroll down to show you a page consisting
227 only of boring text.  Boring text is controlled by
228 `gnus-article-boring-faces'."
229   :version "22.1"
230   :type 'boolean
231   :group 'gnus-article-hiding)
232
233 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
234   "Regexp matching signature separator.
235 This can also be a list of regexps.  In that case, it will be checked
236 from head to tail looking for a separator.  Searches will be done from
237 the end of the buffer."
238   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
239                  (regexp)
240                  (repeat :tag "List of regexp" regexp))
241   :group 'gnus-article-signature)
242
243 (defcustom gnus-signature-limit nil
244   "Provide a limit to what is considered a signature.
245 If it is a number, no signature may not be longer (in characters) than
246 that number.  If it is a floating point number, no signature may be
247 longer (in lines) than that number.  If it is a function, the function
248 will be called without any parameters, and if it returns nil, there is
249 no signature in the buffer.  If it is a string, it will be used as a
250 regexp.  If it matches, the text in question is not a signature.
251
252 This can also be a list of the above values."
253   :type '(choice (const nil)
254                  (integer :value 200)
255                  (number :value 4.0)
256                  function
257                  (regexp :value ".*"))
258   :group 'gnus-article-signature)
259
260 (defcustom gnus-hidden-properties '(invisible t intangible t)
261   "Property list to use for hiding text."
262   :type 'sexp
263   :group 'gnus-article-hiding)
264
265 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
266 ;; frames in a session.
267 (defcustom gnus-article-x-face-command
268   (if (featurep 'xemacs)
269       (if (or (gnus-image-type-available-p 'xface)
270               (gnus-image-type-available-p 'pbm))
271           'gnus-display-x-face-in-from
272         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
273     (if (gnus-image-type-available-p 'pbm)
274         'gnus-display-x-face-in-from
275       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
276 display -"))
277   "*String or function to be executed to display an X-Face header.
278 If it is a string, the command will be executed in a sub-shell
279 asynchronously.  The compressed face will be piped to this command."
280   :type `(choice string
281                  (function-item gnus-display-x-face-in-from)
282                  function)
283   :version "21.1"
284   :group 'gnus-picon
285   :group 'gnus-article-washing)
286
287 (defcustom gnus-article-x-face-too-ugly nil
288   "Regexp matching posters whose face shouldn't be shown automatically."
289   :type '(choice regexp (const nil))
290   :group 'gnus-article-washing)
291
292 (defcustom gnus-article-banner-alist nil
293   "Banner alist for stripping.
294 For example,
295      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
296   :version "21.1"
297   :type '(repeat (cons symbol regexp))
298   :group 'gnus-article-washing)
299
300 (gnus-define-group-parameter
301  banner
302  :variable-document
303  "Alist of regexps (to match group names) and banner."
304  :variable-group gnus-article-washing
305  :parameter-type
306  '(choice :tag "Banner"
307           :value nil
308           (const :tag "Remove signature" signature)
309           (symbol :tag "Item in `gnus-article-banner-alist'" none)
310           regexp
311           (const :tag "None" nil))
312  :parameter-document
313  "If non-nil, specify how to remove `banners' from articles.
314
315 Symbol `signature' means to remove signatures delimited by
316 `gnus-signature-separator'.  Any other symbol is used to look up a
317 regular expression to match the banner in `gnus-article-banner-alist'.
318 A string is used as a regular expression to match the banner
319 directly.")
320
321 (defcustom gnus-article-address-banner-alist nil
322   "Alist of mail addresses and banners.
323 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
324 to match a mail address in the From: header, BANNER is one of a symbol
325 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
326 If ADDRESS matches author's mail address, it will remove things like
327 advertisements.  For example:
328
329 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
330 "
331   :type '(repeat
332           (cons
333            (regexp :tag "Address")
334            (choice :tag "Banner" :value nil
335                    (const :tag "Remove signature" signature)
336                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
337                    regexp
338                    (const :tag "None" nil))))
339   :version "22.1"
340   :group 'gnus-article-washing)
341
342 (defmacro gnus-emphasis-custom-with-format (&rest body)
343   `(let ((format "\
344 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
345 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
346      ,@body))
347
348 (defun gnus-emphasis-custom-value-to-external (value)
349   (gnus-emphasis-custom-with-format
350    (if (consp (car value))
351        (list (format format (car (car value)) (cdr (car value)))
352              2
353              (if (nth 1 value) 2 3)
354              (nth 2 value))
355      value)))
356
357 (defun gnus-emphasis-custom-value-to-internal (value)
358   (gnus-emphasis-custom-with-format
359    (let ((regexp (concat "\\`"
360                          (format (regexp-quote format)
361                                  "\\([^()]+\\)" "\\([^()]+\\)")
362                          "\\'"))
363          pattern)
364      (if (string-match regexp (setq pattern (car value)))
365          (list (cons (match-string 1 pattern) (match-string 2 pattern))
366                (= (nth 2 value) 2)
367                (nth 3 value))
368        value))))
369
370 (defcustom gnus-emphasis-alist
371   (let ((types
372          '(("\\*" "\\*" bold nil 2)
373            ("_" "_" underline)
374            ("/" "/" italic)
375            ("_/" "/_" underline-italic)
376            ("_\\*" "\\*_" underline-bold)
377            ("\\*/" "/\\*" bold-italic)
378            ("_\\*/" "/\\*_" underline-bold-italic))))
379     (nconc
380      (gnus-emphasis-custom-with-format
381       (mapcar (lambda (spec)
382                 (list (format format (car spec) (cadr spec))
383                       (or (nth 3 spec) 2)
384                       (or (nth 4 spec) 3)
385                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
386               types))
387      '(;; I've never seen anyone use this strikethru convention whereas I've
388        ;; several times seen it triggered by normal text.  --Stef
389        ;; Miles suggests that this form is sometimes used but for italics,
390        ;; so maybe we should map it to `italic'.
391        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
392        ;; 2 3 gnus-emphasis-strikethru)
393        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
394         2 3 gnus-emphasis-underline))))
395   "*Alist that says how to fontify certain phrases.
396 Each item looks like this:
397
398   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
399
400 The first element is a regular expression to be matched.  The second
401 is a number that says what regular expression grouping used to find
402 the entire emphasized word.  The third is a number that says what
403 regexp grouping should be displayed and highlighted.  The fourth
404 is the face used for highlighting."
405   :type
406   '(repeat
407     (menu-choice
408      :format "%[Customizing Style%]\n%v"
409      :indent 2
410      (group :tag "Default"
411             :value ("" 0 0 default)
412             :value-create
413             (lambda (widget)
414               (let ((value (widget-get
415                             (cadr (widget-get (widget-get widget :parent)
416                                               :args))
417                             :value)))
418                 (if (not (eq (nth 2 value) 'default))
419                     (widget-put
420                      widget
421                      :value
422                      (gnus-emphasis-custom-value-to-external value))))
423               (widget-group-value-create widget))
424             regexp
425             (integer :format "Match group: %v")
426             (integer :format "Emphasize group: %v")
427             face)
428      (group :tag "Simple"
429             :value (("_" . "_") nil default)
430             (cons :format "%v"
431                   (regexp :format "Start regexp: %v")
432                   (regexp :format "End regexp: %v"))
433             (boolean :format "Show start and end patterns: %[%v%]\n"
434                      :on " On " :off " Off ")
435             face)))
436   :get (lambda (symbol)
437          (mapcar 'gnus-emphasis-custom-value-to-internal
438                  (default-value symbol)))
439   :set (lambda (symbol value)
440          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
441                                      value)))
442   :group 'gnus-article-emphasis)
443
444 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
445   "A regexp to describe whitespace which should not be emphasized.
446 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
447 The former avoids underlining of leading and trailing whitespace,
448 and the latter avoids underlining any whitespace at all."
449   :version "21.1"
450   :group 'gnus-article-emphasis
451   :type 'regexp)
452
453 (defface gnus-emphasis-bold '((t (:bold t)))
454   "Face used for displaying strong emphasized text (*word*)."
455   :group 'gnus-article-emphasis)
456
457 (defface gnus-emphasis-italic '((t (:italic t)))
458   "Face used for displaying italic emphasized text (/word/)."
459   :group 'gnus-article-emphasis)
460
461 (defface gnus-emphasis-underline '((t (:underline t)))
462   "Face used for displaying underlined emphasized text (_word_)."
463   :group 'gnus-article-emphasis)
464
465 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
466   "Face used for displaying underlined bold emphasized text (_*word*_)."
467   :group 'gnus-article-emphasis)
468
469 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
470   "Face used for displaying underlined italic emphasized text (_/word/_)."
471   :group 'gnus-article-emphasis)
472
473 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
474   "Face used for displaying bold italic emphasized text (/*word*/)."
475   :group 'gnus-article-emphasis)
476
477 (defface gnus-emphasis-underline-bold-italic
478   '((t (:bold t :italic t :underline t)))
479   "Face used for displaying underlined bold italic emphasized text.
480 Example: (_/*word*/_)."
481   :group 'gnus-article-emphasis)
482
483 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
484                                       '((t (:strikethru t)))
485                                     '((t (:strike-through t))))
486   "Face used for displaying strike-through text (-word-)."
487   :group 'gnus-article-emphasis)
488
489 (defface gnus-emphasis-highlight-words
490   '((t (:background "black" :foreground "yellow")))
491   "Face used for displaying highlighted words."
492   :group 'gnus-article-emphasis)
493
494 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
495   "Format for display of Date headers in article bodies.
496 See `format-time-string' for the possible values.
497
498 The variable can also be function, which should return a complete Date
499 header.  The function is called with one argument, the time, which can
500 be fed to `format-time-string'."
501   :type '(choice string function)
502   :link '(custom-manual "(gnus)Article Date")
503   :group 'gnus-article-washing)
504
505 (defcustom gnus-save-all-headers t
506   "*If non-nil, don't remove any headers before saving.
507 This will be overridden by the `:headers' property that the symbol of
508 the saver function, which is specified by `gnus-default-article-saver',
509 might have."
510   :group 'gnus-article-saving
511   :type 'boolean)
512
513 (defcustom gnus-prompt-before-saving 'always
514   "*This variable says how much prompting is to be done when saving articles.
515 If it is nil, no prompting will be done, and the articles will be
516 saved to the default files.  If this variable is `always', each and
517 every article that is saved will be preceded by a prompt, even when
518 saving large batches of articles.  If this variable is neither nil not
519 `always', there the user will be prompted once for a file name for
520 each invocation of the saving commands."
521   :group 'gnus-article-saving
522   :type '(choice (item always)
523                  (item :tag "never" nil)
524                  (sexp :tag "once" :format "%t\n" :value t)))
525
526 (defcustom gnus-saved-headers gnus-visible-headers
527   "Headers to keep if `gnus-save-all-headers' is nil.
528 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
529 If that variable is nil, however, all headers that match this regexp
530 will be kept while the rest will be deleted before saving.  This and
531 `gnus-save-all-headers' will be overridden by the `:headers' property
532 that the symbol of the saver function, which is specified by
533 `gnus-default-article-saver', might have."
534   :group 'gnus-article-saving
535   :type 'regexp)
536
537 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
538 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
539   "A function to save articles in your favourite format.
540 The function will be called by way of the `gnus-summary-save-article'
541 command, and friends such as `gnus-summary-save-article-rmail'.
542
543 Gnus provides the following functions:
544
545 * gnus-summary-save-in-rmail (Rmail format)
546 * gnus-summary-save-in-mail (Unix mail format)
547 * gnus-summary-save-in-folder (MH folder)
548 * gnus-summary-save-in-file (article format)
549 * gnus-summary-save-body-in-file (article body)
550 * gnus-summary-save-in-vm (use VM's folder format)
551 * gnus-summary-write-to-file (article format -- overwrite)
552 * gnus-summary-write-body-to-file (article body -- overwrite)
553 * gnus-summary-save-in-pipe (article format)
554
555 The symbol of each function may have the following properties:
556
557 * :decode
558 The value non-nil means save decoded articles.  This is meaningful
559 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
560 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
561 `gnus-summary-save-in-pipe'.
562
563 * :function
564 The value specifies an alternative function which appends, not
565 overwrites, articles to a file.  This implies that when saving many
566 articles at a time, `gnus-prompt-before-saving' is bound to t and all
567 articles are saved in a single file.  This is meaningful only with
568 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
569
570 * :headers
571 The value specifies the symbol of a variable of which the value
572 specifies headers to be saved.  If it is omitted,
573 `gnus-save-all-headers' and `gnus-saved-headers' control what
574 headers should be saved."
575   :group 'gnus-article-saving
576   :type '(radio (function-item gnus-summary-save-in-rmail)
577                 (function-item gnus-summary-save-in-mail)
578                 (function-item gnus-summary-save-in-folder)
579                 (function-item gnus-summary-save-in-file)
580                 (function-item gnus-summary-save-body-in-file)
581                 (function-item gnus-summary-save-in-vm)
582                 (function-item gnus-summary-write-to-file)
583                 (function-item gnus-summary-write-body-to-file)
584                 (function-item gnus-summary-save-in-pipe)
585                 (function)))
586
587 (defcustom gnus-article-save-coding-system
588   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
589       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
590       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
591       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
592   "Coding system used to save decoded articles to a file.
593
594 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
595 which can safely encode any characters in text.  This is used by the
596 commands including:
597
598 * gnus-summary-save-article-file
599 * gnus-summary-save-article-body-file
600 * gnus-summary-write-article-file
601 * gnus-summary-write-article-body-file
602
603 and the functions to which you may set `gnus-default-article-saver':
604
605 * gnus-summary-save-in-file
606 * gnus-summary-save-body-in-file
607 * gnus-summary-write-to-file
608 * gnus-summary-write-body-to-file
609
610 Those commands and functions save just text displayed in the article
611 buffer to a file if the value of this variable is non-nil.  Note that
612 buttonized MIME parts will be lost in a saved file in that case.
613 Otherwise, raw articles will be saved."
614   :group 'gnus-article-saving
615   :type `(choice
616           :format "%{%t%}:\n %[Value Menu%] %v"
617           (const :tag "Save raw articles" nil)
618           ,@(delq nil
619                   (mapcar
620                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
621                    '((const :tag "UTF-8" utf-8)
622                      (const :tag "iso-2022-7bit" iso-2022-7bit)
623                      (const :tag "Emacs internal" emacs-mule)
624                      (const :tag "escape-quoted" escape-quoted))))
625           (symbol :tag "Coding system")))
626
627 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
628   "A function generating a file name to save articles in Rmail format.
629 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
630   :group 'gnus-article-saving
631   :type 'function)
632
633 (defcustom gnus-mail-save-name 'gnus-plain-save-name
634   "A function generating a file name to save articles in Unix mail format.
635 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
636   :group 'gnus-article-saving
637   :type 'function)
638
639 (defcustom gnus-folder-save-name 'gnus-folder-save-name
640   "A function generating a file name to save articles in MH folder.
641 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
642   :group 'gnus-article-saving
643   :type 'function)
644
645 (defcustom gnus-file-save-name 'gnus-numeric-save-name
646   "A function generating a file name to save articles in article format.
647 The function is called with NEWSGROUP, HEADERS, and optional
648 LAST-FILE."
649   :group 'gnus-article-saving
650   :type 'function)
651
652 (defcustom gnus-split-methods
653   '((gnus-article-archive-name)
654     (gnus-article-nndoc-name))
655   "*Variable used to suggest where articles are to be saved.
656 For instance, if you would like to save articles related to Gnus in
657 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
658 you could set this variable to something like:
659
660  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
661    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
662
663 This variable is an alist where the key is the match and the
664 value is a list of possible files to save in if the match is
665 non-nil.
666
667 If the match is a string, it is used as a regexp match on the
668 article.  If the match is a symbol, that symbol will be funcalled
669 from the buffer of the article to be saved with the newsgroup as the
670 parameter.  If it is a list, it will be evaled in the same buffer.
671
672 If this form or function returns a string, this string will be used as a
673 possible file name; and if it returns a non-nil list, that list will be
674 used as possible file names."
675   :group 'gnus-article-saving
676   :type '(repeat (choice (list :value (fun) function)
677                          (cons :value ("" "") regexp (repeat string))
678                          (sexp :value nil))))
679
680 (defcustom gnus-page-delimiter "^\^L"
681   "*Regexp describing what to use as article page delimiters.
682 The default value is \"^\^L\", which is a form linefeed at the
683 beginning of a line."
684   :type 'regexp
685   :group 'gnus-article-various)
686
687 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
688   "*The format specification for the article mode line.
689 See `gnus-summary-mode-line-format' for a closer description.
690
691 The following additional specs are available:
692
693 %w  The article washing status.
694 %m  The number of MIME parts in the article."
695   :type 'string
696   :group 'gnus-article-various)
697
698 (defcustom gnus-article-mode-hook nil
699   "*A hook for Gnus article mode."
700   :type 'hook
701   :group 'gnus-article-various)
702
703 (when (featurep 'xemacs)
704   ;; Extracted from gnus-xmas-define in order to preserve user settings
705   (when (fboundp 'turn-off-scroll-in-place)
706     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
707   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
708   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
709
710 (defcustom gnus-article-menu-hook nil
711   "*Hook run after the creation of the article mode menu."
712   :type 'hook
713   :group 'gnus-article-various)
714
715 (defcustom gnus-article-prepare-hook nil
716   "*A hook called after an article has been prepared in the article buffer."
717   :type 'hook
718   :group 'gnus-article-various)
719
720 (defcustom gnus-copy-article-ignored-headers nil
721   "List of headers to be removed when copying an article.
722 Each element is a regular expression."
723   :version "23.1" ;; No Gnus
724   :type '(repeat regexp)
725   :group 'gnus-article-various)
726
727 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
728                         "Gnus 5.10 (Emacs 22.1)")
729
730 (defface gnus-button
731   '((t (:weight bold)))
732   "Face used for highlighting a button in the article buffer."
733   :group 'gnus-article-buttons)
734
735 (defcustom gnus-article-button-face 'gnus-button
736   "Face used for highlighting buttons in the article buffer.
737
738 An article button is a piece of text that you can activate by pressing
739 `RET' or `mouse-2' above it."
740   :type 'face
741   :group 'gnus-article-buttons)
742
743 (defcustom gnus-article-mouse-face 'highlight
744   "Face used for mouse highlighting in the article buffer.
745
746 Article buttons will be displayed in this face when the cursor is
747 above them."
748   :type 'face
749   :group 'gnus-article-buttons)
750
751 (defcustom gnus-signature-face 'gnus-signature
752   "Face used for highlighting a signature in the article buffer.
753 Obsolete; use the face `gnus-signature' for customizations instead."
754   :type 'face
755   :group 'gnus-article-highlight
756   :group 'gnus-article-signature)
757
758 (defface gnus-signature
759   '((t
760      (:italic t)))
761   "Face used for highlighting a signature in the article buffer."
762   :group 'gnus-article-highlight
763   :group 'gnus-article-signature)
764 ;; backward-compatibility alias
765 (put 'gnus-signature-face 'face-alias 'gnus-signature)
766 (put 'gnus-signature-face 'obsolete-face "22.1")
767
768 (defface gnus-header-from
769   '((((class color)
770       (background dark))
771      (:foreground "PaleGreen1"))
772     (((class color)
773       (background light))
774      (:foreground "red3"))
775     (t
776      (:italic t)))
777   "Face used for displaying from headers."
778   :group 'gnus-article-headers
779   :group 'gnus-article-highlight)
780 ;; backward-compatibility alias
781 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
782 (put 'gnus-header-from-face 'obsolete-face "22.1")
783
784 (defface gnus-header-subject
785   '((((class color)
786       (background dark))
787      (:foreground "SeaGreen1"))
788     (((class color)
789       (background light))
790      (:foreground "red4"))
791     (t
792      (:bold t :italic t)))
793   "Face used for displaying subject headers."
794   :group 'gnus-article-headers
795   :group 'gnus-article-highlight)
796 ;; backward-compatibility alias
797 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
798 (put 'gnus-header-subject-face 'obsolete-face "22.1")
799
800 (defface gnus-header-newsgroups
801   '((((class color)
802       (background dark))
803      (:foreground "yellow" :italic t))
804     (((class color)
805       (background light))
806      (:foreground "MidnightBlue" :italic t))
807     (t
808      (:italic t)))
809   "Face used for displaying newsgroups headers.
810 In the default setup this face is only used for crossposted
811 articles."
812   :group 'gnus-article-headers
813   :group 'gnus-article-highlight)
814 ;; backward-compatibility alias
815 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
816 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
817
818 (defface gnus-header-name
819   '((((class color)
820       (background dark))
821      (:foreground "SpringGreen2"))
822     (((class color)
823       (background light))
824      (:foreground "maroon"))
825     (t
826      (:bold t)))
827   "Face used for displaying header names."
828   :group 'gnus-article-headers
829   :group 'gnus-article-highlight)
830 ;; backward-compatibility alias
831 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
832 (put 'gnus-header-name-face 'obsolete-face "22.1")
833
834 (defface gnus-header-content
835   '((((class color)
836       (background dark))
837      (:foreground "SpringGreen1" :italic t))
838     (((class color)
839       (background light))
840      (:foreground "indianred4" :italic t))
841     (t
842      (:italic t)))  "Face used for displaying header content."
843   :group 'gnus-article-headers
844   :group 'gnus-article-highlight)
845 ;; backward-compatibility alias
846 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
847 (put 'gnus-header-content-face 'obsolete-face "22.1")
848
849 (defcustom gnus-header-face-alist
850   '(("From" nil gnus-header-from)
851     ("Subject" nil gnus-header-subject)
852     ("Newsgroups:.*," nil gnus-header-newsgroups)
853     ("" gnus-header-name gnus-header-content))
854   "*Controls highlighting of article headers.
855
856 An alist of the form (HEADER NAME CONTENT).
857
858 HEADER is a regular expression which should match the name of a
859 header and NAME and CONTENT are either face names or nil.
860
861 The name of each header field will be displayed using the face
862 specified by the first element in the list where HEADER matches
863 the header name and NAME is non-nil.  Similarly, the content will
864 be displayed by the first non-nil matching CONTENT face."
865   :group 'gnus-article-headers
866   :group 'gnus-article-highlight
867   :type '(repeat (list (regexp :tag "Header")
868                        (choice :tag "Name"
869                                (item :tag "skip" nil)
870                                (face :value default))
871                        (choice :tag "Content"
872                                (item :tag "skip" nil)
873                                (face :value default)))))
874
875 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
876                                           '((xface . (:face gnus-x-face)))
877                                         '((pbm . (:face gnus-x-face))
878                                           (png . nil)))
879   "Alist of image types and properties applied to Face and X-Face images.
880 Here are examples:
881
882 ;; Specify the altitude of Face images in the From header.
883 \(setq gnus-face-properties-alist
884       '((pbm . (:face gnus-x-face :ascent 80))
885         (png . (:ascent 80))))
886
887 ;; Show Face images as pressed buttons.
888 \(setq gnus-face-properties-alist
889       '((pbm . (:face gnus-x-face :relief -2))
890         (png . (:relief -2))))
891
892 See the manual for the valid properties for various image types.
893 Currently, `pbm' is used for X-Face images and `png' is used for Face
894 images in Emacs.  Only the `:face' property is effective on the `xface'
895 image type in XEmacs if it is built with the libcompface library."
896   :version "23.1" ;; No Gnus
897   :group 'gnus-article-headers
898   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
899
900 (defcustom gnus-article-decode-hook
901   '(article-decode-charset article-decode-encoded-words
902                            article-decode-group-name article-decode-idna-rhs)
903   "*Hook run to decode charsets in articles."
904   :group 'gnus-article-headers
905   :type 'hook)
906
907 (defcustom gnus-display-mime-function 'gnus-display-mime
908   "Function to display MIME articles."
909   :group 'gnus-article-mime
910   :type 'function)
911
912 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
913   "Function used to decode headers.")
914
915 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
916   "Function used to decode addresses.")
917
918 (defvar gnus-article-dumbquotes-map
919   '((?\200 "EUR")
920     (?\202 ",")
921     (?\203 "f")
922     (?\204 ",,")
923     (?\205 "...")
924     (?\213 "<")
925     (?\214 "OE")
926     (?\221 "`")
927     (?\222 "'")
928     (?\223 "``")
929     (?\224 "\"")
930     (?\225 "*")
931     (?\226 "-")
932     (?\227 "--")
933     (?\230 "~")
934     (?\231 "(TM)")
935     (?\233 ">")
936     (?\234 "oe")
937     (?\264 "'"))
938   "Table for MS-to-Latin1 translation.")
939
940 (defcustom gnus-ignored-mime-types nil
941   "List of MIME types that should be ignored by Gnus."
942   :version "21.1"
943   :group 'gnus-article-mime
944   :type '(repeat regexp))
945
946 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
947   "List of MIME types that should not be given buttons when rendered inline.
948 See also `gnus-buttonized-mime-types' which may override this variable.
949 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
950   :version "21.1"
951   :group 'gnus-article-mime
952   :type '(repeat regexp))
953
954 (defcustom gnus-buttonized-mime-types nil
955   "List of MIME types that should be given buttons when rendered inline.
956 If set, this variable overrides `gnus-unbuttonized-mime-types'.
957 To see e.g. security buttons you could set this to
958 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
959 this list to display radio buttons that allow you to choose one of two
960 media types those mails include.  See also `mm-discouraged-alternatives'.
961 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
962   :version "22.1"
963   :group 'gnus-article-mime
964   :type '(repeat regexp))
965
966 (defcustom gnus-inhibit-mime-unbuttonizing nil
967   "If non-nil, all MIME parts get buttons.
968 When nil (the default value), then some MIME parts do not get buttons,
969 as described by the variables `gnus-buttonized-mime-types' and
970 `gnus-unbuttonized-mime-types'."
971   :version "22.1"
972   :group 'gnus-article-mime
973   :type 'boolean)
974
975 (defcustom gnus-body-boundary-delimiter "_"
976   "String used to delimit header and body.
977 This variable is used by `gnus-article-treat-body-boundary' which can
978 be controlled by `gnus-treat-body-boundary'."
979   :version "22.1"
980   :group 'gnus-article-various
981   :type '(choice (item :tag "None" :value nil)
982                  string))
983
984 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
985                                   "/usr/share/picons")
986   "Defines the location of the faces database.
987 For information on obtaining this database of pretty pictures, please
988 see http://www.cs.indiana.edu/picons/ftp/index.html"
989   :version "22.1"
990   :type '(repeat directory)
991   :link '(url-link :tag "download"
992                    "http://www.cs.indiana.edu/picons/ftp/index.html")
993   :link '(custom-manual "(gnus)Picons")
994   :group 'gnus-picon)
995
996 (defun gnus-picons-installed-p ()
997   "Say whether picons are installed on your machine."
998   (let ((installed nil))
999     (dolist (database gnus-picon-databases)
1000       (when (file-exists-p database)
1001         (setq installed t)))
1002     installed))
1003
1004 (defcustom gnus-article-mime-part-function nil
1005   "Function called with a MIME handle as the argument.
1006 This is meant for people who want to do something automatic based
1007 on parts -- for instance, adding Vcard info to a database."
1008   :group 'gnus-article-mime
1009   :type '(choice (const nil)
1010                  function))
1011
1012 (defcustom gnus-mime-multipart-functions nil
1013   "An alist of MIME types to functions to display them."
1014   :version "21.1"
1015   :group 'gnus-article-mime
1016   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1017
1018 (defcustom gnus-article-date-lapsed-new-header nil
1019   "Whether the X-Sent and Date headers can coexist.
1020 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
1021 either replace the old \"Date:\" header (if this variable is nil), or
1022 be added below it (otherwise)."
1023   :version "21.1"
1024   :group 'gnus-article-headers
1025   :type 'boolean)
1026
1027 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1028   "Function called with a MIME handle as the argument.
1029 This is meant for people who want to view first matched part.
1030 For `undisplayed-alternative' (default), the first undisplayed
1031 part or alternative part is used.  For `undisplayed', the first
1032 undisplayed part is used.  For a function, the first part which
1033 the function return t is used.  For nil, the first part is
1034 used."
1035   :version "21.1"
1036   :group 'gnus-article-mime
1037   :type '(choice
1038           (item :tag "first" :value nil)
1039           (item :tag "undisplayed" :value undisplayed)
1040           (item :tag "undisplayed or alternative"
1041                 :value undisplayed-alternative)
1042           (function)))
1043
1044 (defcustom gnus-mime-action-alist
1045   '(("save to file" . gnus-mime-save-part)
1046     ("save and strip" . gnus-mime-save-part-and-strip)
1047     ("replace with file" . gnus-mime-replace-part)
1048     ("delete part" . gnus-mime-delete-part)
1049     ("display as text" . gnus-mime-inline-part)
1050     ("view the part" . gnus-mime-view-part)
1051     ("pipe to command" . gnus-mime-pipe-part)
1052     ("toggle display" . gnus-article-press-button)
1053     ("toggle display" . gnus-article-view-part-as-charset)
1054     ("view as type" . gnus-mime-view-part-as-type)
1055     ("view internally" . gnus-mime-view-part-internally)
1056     ("view externally" . gnus-mime-view-part-externally))
1057   "An alist of actions that run on the MIME attachment."
1058   :group 'gnus-article-mime
1059   :type '(repeat (cons (string :tag "name")
1060                        (function))))
1061
1062 (defcustom gnus-auto-select-part 1
1063   "Advance to next MIME part when deleting or stripping parts.
1064
1065 When 0, point will be placed on the same part as before.  When
1066 positive (negative), move point forward (backwards) this many
1067 parts.  When nil, redisplay article."
1068   :version "23.1" ;; No Gnus
1069   :group 'gnus-article-mime
1070   :type '(choice (const nil :tag "Redisplay article.")
1071                  (const 1 :tag "Next part.")
1072                  (const 0 :tag "Current part.")
1073                  integer))
1074
1075 ;;;
1076 ;;; The treatment variables
1077 ;;;
1078
1079 (defvar gnus-part-display-hook nil
1080   "Hook called on parts that are to receive treatment.")
1081
1082 (defvar gnus-article-treat-custom
1083   '(choice (const :tag "Off" nil)
1084            (const :tag "On" t)
1085            (const :tag "Header" head)
1086            (const :tag "First" first)
1087            (const :tag "Last" last)
1088            (integer :tag "Less")
1089            (repeat :tag "Groups" regexp)
1090            (sexp :tag "Predicate")))
1091
1092 (defvar gnus-article-treat-head-custom
1093   '(choice (const :tag "Off" nil)
1094            (const :tag "Header" head)))
1095
1096 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1097                                    "text/x-patch")
1098   "Parts to treat.")
1099
1100 (defvar gnus-inhibit-treatment nil
1101   "Whether to inhibit treatment.")
1102
1103 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1104   "Highlight the signature.
1105 Valid values are nil, t, `head', `first', `last', an integer or a
1106 predicate.  See Info node `(gnus)Customizing Articles'."
1107   :group 'gnus-article-treat
1108   :link '(custom-manual "(gnus)Customizing Articles")
1109   :type gnus-article-treat-custom)
1110 (put 'gnus-treat-highlight-signature 'highlight t)
1111
1112 (defcustom gnus-treat-buttonize 100000
1113   "Add buttons.
1114 Valid values are nil, t, `head', `first', `last', an integer or a
1115 predicate.  See Info node `(gnus)Customizing Articles'."
1116   :group 'gnus-article-treat
1117   :link '(custom-manual "(gnus)Customizing Articles")
1118   :type gnus-article-treat-custom)
1119 (put 'gnus-treat-buttonize 'highlight t)
1120
1121 (defcustom gnus-treat-buttonize-head 'head
1122   "Add buttons to the head.
1123 Valid values are nil, t, `head', `first', `last', an integer or a
1124 predicate.  See Info node `(gnus)Customizing Articles'."
1125   :group 'gnus-article-treat
1126   :link '(custom-manual "(gnus)Customizing Articles")
1127   :type gnus-article-treat-head-custom)
1128 (put 'gnus-treat-buttonize-head 'highlight t)
1129
1130 (defcustom gnus-treat-emphasize 50000
1131   "Emphasize text.
1132 Valid values are nil, t, `head', `first', `last', an integer or a
1133 predicate.  See Info node `(gnus)Customizing Articles'."
1134   :group 'gnus-article-treat
1135   :link '(custom-manual "(gnus)Customizing Articles")
1136   :type gnus-article-treat-custom)
1137 (put 'gnus-treat-emphasize 'highlight t)
1138
1139 (defcustom gnus-treat-strip-cr nil
1140   "Remove carriage returns.
1141 Valid values are nil, t, `head', `first', `last', an integer or a
1142 predicate.  See Info node `(gnus)Customizing Articles'."
1143   :version "22.1"
1144   :group 'gnus-article-treat
1145   :link '(custom-manual "(gnus)Customizing Articles")
1146   :type gnus-article-treat-custom)
1147
1148 (defcustom gnus-treat-unsplit-urls nil
1149   "Remove newlines from within URLs.
1150 Valid values are nil, t, `head', `first', `last', an integer or a
1151 predicate.  See Info node `(gnus)Customizing Articles'."
1152   :version "22.1"
1153   :group 'gnus-article-treat
1154   :link '(custom-manual "(gnus)Customizing Articles")
1155   :type gnus-article-treat-custom)
1156
1157 (defcustom gnus-treat-leading-whitespace nil
1158   "Remove leading whitespace in headers.
1159 Valid values are nil, t, `head', `first', `last', an integer or a
1160 predicate.  See Info node `(gnus)Customizing Articles'."
1161   :version "22.1"
1162   :group 'gnus-article-treat
1163   :link '(custom-manual "(gnus)Customizing Articles")
1164   :type gnus-article-treat-custom)
1165
1166 (defcustom gnus-treat-hide-headers 'head
1167   "Hide headers.
1168 Valid values are nil, t, `head', `first', `last', an integer or a
1169 predicate.  See Info node `(gnus)Customizing Articles'."
1170   :group 'gnus-article-treat
1171   :link '(custom-manual "(gnus)Customizing Articles")
1172   :type gnus-article-treat-head-custom)
1173
1174 (defcustom gnus-treat-hide-boring-headers nil
1175   "Hide boring headers.
1176 Valid values are nil, t, `head', `first', `last', an integer or a
1177 predicate.  See Info node `(gnus)Customizing Articles'."
1178   :group 'gnus-article-treat
1179   :link '(custom-manual "(gnus)Customizing Articles")
1180   :type gnus-article-treat-head-custom)
1181
1182 (defcustom gnus-treat-hide-signature nil
1183   "Hide the signature.
1184 Valid values are nil, t, `head', `first', `last', an integer or a
1185 predicate.  See Info node `(gnus)Customizing Articles'."
1186   :group 'gnus-article-treat
1187   :link '(custom-manual "(gnus)Customizing Articles")
1188   :type gnus-article-treat-custom)
1189
1190 (defcustom gnus-treat-fill-article nil
1191   "Fill the article.
1192 Valid values are nil, t, `head', `first', `last', an integer or a
1193 predicate.  See Info node `(gnus)Customizing Articles'."
1194   :group 'gnus-article-treat
1195   :link '(custom-manual "(gnus)Customizing Articles")
1196   :type gnus-article-treat-custom)
1197
1198 (defcustom gnus-treat-hide-citation nil
1199   "Hide cited text.
1200 Valid values are nil, t, `head', `first', `last', an integer or a
1201 predicate.  See Info node `(gnus)Customizing Articles'."
1202   :group 'gnus-article-treat
1203   :link '(custom-manual "(gnus)Customizing Articles")
1204   :type gnus-article-treat-custom)
1205
1206 (defcustom gnus-treat-hide-citation-maybe nil
1207   "Hide cited text.
1208 Valid values are nil, t, `head', `first', `last', an integer or a
1209 predicate.  See Info node `(gnus)Customizing Articles'."
1210   :group 'gnus-article-treat
1211   :link '(custom-manual "(gnus)Customizing Articles")
1212   :type gnus-article-treat-custom)
1213
1214 (defcustom gnus-treat-strip-list-identifiers 'head
1215   "Strip list identifiers from `gnus-list-identifiers`.
1216 Valid values are nil, t, `head', `first', `last', an integer or a
1217 predicate.  See Info node `(gnus)Customizing Articles'."
1218   :version "21.1"
1219   :group 'gnus-article-treat
1220   :link '(custom-manual "(gnus)Customizing Articles")
1221   :type gnus-article-treat-custom)
1222
1223 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1224                         "Gnus 5.10 (Emacs 22.1)")
1225
1226 (defcustom gnus-treat-strip-pem nil
1227   "Strip PEM signatures.
1228 Valid values are nil, t, `head', `first', `last', an integer or a
1229 predicate.  See Info node `(gnus)Customizing Articles'."
1230   :group 'gnus-article-treat
1231   :link '(custom-manual "(gnus)Customizing Articles")
1232   :type gnus-article-treat-custom)
1233
1234 (defcustom gnus-treat-strip-banner t
1235   "Strip banners from articles.
1236 The banner to be stripped is specified in the `banner' group parameter.
1237 Valid values are nil, t, `head', `first', `last', an integer or a
1238 predicate.  See Info node `(gnus)Customizing Articles'."
1239   :group 'gnus-article-treat
1240   :link '(custom-manual "(gnus)Customizing Articles")
1241   :type gnus-article-treat-custom)
1242
1243 (defcustom gnus-treat-highlight-headers 'head
1244   "Highlight the headers.
1245 Valid values are nil, t, `head', `first', `last', an integer or a
1246 predicate.  See Info node `(gnus)Customizing Articles'."
1247   :group 'gnus-article-treat
1248   :link '(custom-manual "(gnus)Customizing Articles")
1249   :type gnus-article-treat-head-custom)
1250 (put 'gnus-treat-highlight-headers 'highlight t)
1251
1252 (defcustom gnus-treat-highlight-citation t
1253   "Highlight cited text.
1254 Valid values are nil, t, `head', `first', `last', an integer or a
1255 predicate.  See Info node `(gnus)Customizing Articles'."
1256   :group 'gnus-article-treat
1257   :link '(custom-manual "(gnus)Customizing Articles")
1258   :type gnus-article-treat-custom)
1259 (put 'gnus-treat-highlight-citation 'highlight t)
1260
1261 (defcustom gnus-treat-date-ut nil
1262   "Display the Date in UT (GMT).
1263 Valid values are nil, t, `head', `first', `last', an integer or a
1264 predicate.  See Info node `(gnus)Customizing Articles'."
1265   :group 'gnus-article-treat
1266   :link '(custom-manual "(gnus)Customizing Articles")
1267   :type gnus-article-treat-head-custom)
1268
1269 (defcustom gnus-treat-date-local nil
1270   "Display the Date in the local timezone.
1271 Valid values are nil, t, `head', `first', `last', an integer or a
1272 predicate.  See Info node `(gnus)Customizing Articles'."
1273   :group 'gnus-article-treat
1274   :link '(custom-manual "(gnus)Customizing Articles")
1275   :type gnus-article-treat-head-custom)
1276
1277 (defcustom gnus-treat-date-english nil
1278   "Display the Date in a format that can be read aloud in English.
1279 Valid values are nil, t, `head', `first', `last', an integer or a
1280 predicate.  See Info node `(gnus)Customizing Articles'."
1281   :version "22.1"
1282   :group 'gnus-article-treat
1283   :link '(custom-manual "(gnus)Customizing Articles")
1284   :type gnus-article-treat-head-custom)
1285
1286 (defcustom gnus-treat-date-lapsed nil
1287   "Display the Date header in a way that says how much time has elapsed.
1288 Valid values are nil, t, `head', `first', `last', an integer or a
1289 predicate.  See Info node `(gnus)Customizing Articles'."
1290   :group 'gnus-article-treat
1291   :link '(custom-manual "(gnus)Customizing Articles")
1292   :type gnus-article-treat-head-custom)
1293
1294 (defcustom gnus-treat-date-original nil
1295   "Display the date in the original timezone.
1296 Valid values are nil, t, `head', `first', `last', an integer or a
1297 predicate.  See Info node `(gnus)Customizing Articles'."
1298   :group 'gnus-article-treat
1299   :link '(custom-manual "(gnus)Customizing Articles")
1300   :type gnus-article-treat-head-custom)
1301
1302 (defcustom gnus-treat-date-iso8601 nil
1303   "Display the date in the ISO8601 format.
1304 Valid values are nil, t, `head', `first', `last', an integer or a
1305 predicate.  See Info node `(gnus)Customizing Articles'."
1306   :version "21.1"
1307   :group 'gnus-article-treat
1308   :link '(custom-manual "(gnus)Customizing Articles")
1309   :type gnus-article-treat-head-custom)
1310
1311 (defcustom gnus-treat-date-user-defined nil
1312   "Display the date in a user-defined format.
1313 The format is defined by the `gnus-article-time-format' variable.
1314 Valid values are nil, t, `head', `first', `last', an integer or a
1315 predicate.  See Info node `(gnus)Customizing Articles'."
1316   :group 'gnus-article-treat
1317   :link '(custom-manual "(gnus)Customizing Articles")
1318   :type gnus-article-treat-head-custom)
1319
1320 (defcustom gnus-treat-strip-headers-in-body t
1321   "Strip the X-No-Archive header line from the beginning of the body.
1322 Valid values are nil, t, `head', `first', `last', an integer or a
1323 predicate.  See Info node `(gnus)Customizing Articles'."
1324   :version "21.1"
1325   :group 'gnus-article-treat
1326   :link '(custom-manual "(gnus)Customizing Articles")
1327   :type gnus-article-treat-custom)
1328
1329 (defcustom gnus-treat-strip-trailing-blank-lines nil
1330   "Strip trailing blank lines.
1331 Valid values are nil, t, `head', `first', `last', an integer or a
1332 predicate.  See Info node `(gnus)Customizing Articles'.
1333
1334 When set to t, it also strips trailing blanks in all MIME parts.
1335 Consider to use `last' instead."
1336   :group 'gnus-article-treat
1337   :link '(custom-manual "(gnus)Customizing Articles")
1338   :type gnus-article-treat-custom)
1339
1340 (defcustom gnus-treat-strip-leading-blank-lines nil
1341   "Strip leading blank lines.
1342 Valid values are nil, t, `head', `first', `last', an integer or a
1343 predicate.  See Info node `(gnus)Customizing Articles'.
1344
1345 When set to t, it also strips trailing blanks in all MIME parts."
1346   :group 'gnus-article-treat
1347   :link '(custom-manual "(gnus)Customizing Articles")
1348   :type gnus-article-treat-custom)
1349
1350 (defcustom gnus-treat-strip-multiple-blank-lines nil
1351   "Strip multiple blank lines.
1352 Valid values are nil, t, `head', `first', `last', an integer or a
1353 predicate.  See Info node `(gnus)Customizing Articles'."
1354   :group 'gnus-article-treat
1355   :link '(custom-manual "(gnus)Customizing Articles")
1356   :type gnus-article-treat-custom)
1357
1358 (defcustom gnus-treat-unfold-headers 'head
1359   "Unfold folded header lines.
1360 Valid values are nil, t, `head', `first', `last', an integer or a
1361 predicate.  See Info node `(gnus)Customizing Articles'."
1362   :version "22.1"
1363   :group 'gnus-article-treat
1364   :link '(custom-manual "(gnus)Customizing Articles")
1365   :type gnus-article-treat-custom)
1366
1367 (defcustom gnus-article-unfold-long-headers nil
1368   "If non-nil, allow unfolding headers even if the header is long.
1369 If it is a regexp, only long headers matching this regexp are unfolded.
1370 If it is t, all long headers are unfolded.
1371
1372 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1373   :version "23.1" ;; No Gnus
1374   :group 'gnus-article-treat
1375   :type '(choice (const nil)
1376                  (const :tag "all" t)
1377                  (regexp)))
1378
1379 (defcustom gnus-treat-fold-headers nil
1380   "Fold headers.
1381 Valid values are nil, t, `head', `first', `last', an integer or a
1382 predicate.  See Info node `(gnus)Customizing Articles'."
1383   :version "22.1"
1384   :group 'gnus-article-treat
1385   :link '(custom-manual "(gnus)Customizing Articles")
1386   :type gnus-article-treat-custom)
1387
1388 (defcustom gnus-treat-fold-newsgroups 'head
1389   "Fold the Newsgroups and Followup-To headers.
1390 Valid values are nil, t, `head', `first', `last', an integer or a
1391 predicate.  See Info node `(gnus)Customizing Articles'."
1392   :version "22.1"
1393   :group 'gnus-article-treat
1394   :link '(custom-manual "(gnus)Customizing Articles")
1395   :type gnus-article-treat-custom)
1396
1397 (defcustom gnus-treat-overstrike t
1398   "Treat overstrike highlighting.
1399 Valid values are nil, t, `head', `first', `last', an integer or a
1400 predicate.  See Info node `(gnus)Customizing Articles'."
1401   :group 'gnus-article-treat
1402   :link '(custom-manual "(gnus)Customizing Articles")
1403   :type gnus-article-treat-custom)
1404 (put 'gnus-treat-overstrike 'highlight t)
1405
1406 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1407   "Treat ANSI SGR control sequences.
1408 Valid values are nil, t, `head', `first', `last', an integer or a
1409 predicate.  See Info node `(gnus)Customizing Articles'."
1410   :group 'gnus-article-treat
1411   :link '(custom-manual "(gnus)Customizing Articles")
1412   :type gnus-article-treat-custom)
1413
1414 (make-obsolete-variable 'gnus-treat-display-xface
1415                         'gnus-treat-display-x-face "Emacs 22.1")
1416
1417 (defcustom gnus-treat-display-x-face
1418   (and (not noninteractive)
1419        (gnus-image-type-available-p 'xbm)
1420        (if (featurep 'xemacs)
1421            (featurep 'xface)
1422          (condition-case nil
1423              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1424                   (executable-find "icontopbm"))
1425            ;; shell-command-to-string may signal an error, e.g. if
1426            ;; shell-file-name is not found.
1427            (error nil)))
1428        'head)
1429   "Display X-Face headers.
1430 Valid values are nil and `head'.
1431 See Info node `(gnus)Customizing Articles' and Info node
1432 `(gnus)X-Face' for details."
1433   :group 'gnus-article-treat
1434   :version "21.1"
1435   :link '(custom-manual "(gnus)Customizing Articles")
1436   :link '(custom-manual "(gnus)X-Face")
1437   :type gnus-article-treat-head-custom
1438   :set (lambda (symbol value)
1439          (set-default
1440           symbol
1441           (cond ((or (boundp symbol) (get symbol 'saved-value))
1442                  value)
1443                 ((boundp 'gnus-treat-display-xface)
1444                  (message "\
1445 ** gnus-treat-display-xface is an obsolete variable;\
1446  use gnus-treat-display-x-face instead")
1447                  (default-value 'gnus-treat-display-xface))
1448                 ((get 'gnus-treat-display-xface 'saved-value)
1449                  (message "\
1450 ** gnus-treat-display-xface is an obsolete variable;\
1451  use gnus-treat-display-x-face instead")
1452                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1453                 (t
1454                  value)))))
1455 (put 'gnus-treat-display-x-face 'highlight t)
1456
1457 (defcustom gnus-treat-display-face
1458   (and (not noninteractive)
1459        (gnus-image-type-available-p 'png)
1460        'head)
1461   "Display Face headers.
1462 Valid values are nil, t, `head', `first', `last', an integer or a
1463 predicate.  See Info node `(gnus)Customizing Articles' and Info
1464 node `(gnus)Face' for details."
1465   :group 'gnus-article-treat
1466   :version "22.1"
1467   :link '(custom-manual "(gnus)Customizing Articles")
1468   :link '(custom-manual "(gnus)X-Face")
1469   :type gnus-article-treat-head-custom)
1470 (put 'gnus-treat-display-face 'highlight t)
1471
1472 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1473   "Display smileys.
1474 Valid values are nil, t, `head', `first', `last', an integer or a
1475 predicate.  See Info node `(gnus)Customizing Articles' and Info
1476 node `(gnus)Smileys' for details."
1477   :group 'gnus-article-treat
1478   :version "21.1"
1479   :link '(custom-manual "(gnus)Customizing Articles")
1480   :link '(custom-manual "(gnus)Smileys")
1481   :type gnus-article-treat-custom)
1482 (put 'gnus-treat-display-smileys 'highlight t)
1483
1484 (defcustom gnus-treat-from-picon
1485   (if (and (gnus-image-type-available-p 'xpm)
1486            (gnus-picons-installed-p))
1487       'head nil)
1488   "Display picons in the From header.
1489 Valid values are nil, t, `head', `first', `last', an integer or a
1490 predicate.  See Info node `(gnus)Customizing Articles' and Info
1491 node `(gnus)Picons' for details."
1492   :version "22.1"
1493   :group 'gnus-article-treat
1494   :group 'gnus-picon
1495   :link '(custom-manual "(gnus)Customizing Articles")
1496   :link '(custom-manual "(gnus)Picons")
1497   :type gnus-article-treat-head-custom)
1498 (put 'gnus-treat-from-picon 'highlight t)
1499
1500 (defcustom gnus-treat-mail-picon
1501   (if (and (gnus-image-type-available-p 'xpm)
1502            (gnus-picons-installed-p))
1503       'head nil)
1504   "Display picons in To and Cc headers.
1505 Valid values are nil, t, `head', `first', `last', an integer or a
1506 predicate.  See Info node `(gnus)Customizing Articles' and Info
1507 node `(gnus)Picons' for details."
1508   :version "22.1"
1509   :group 'gnus-article-treat
1510   :group 'gnus-picon
1511   :link '(custom-manual "(gnus)Customizing Articles")
1512   :link '(custom-manual "(gnus)Picons")
1513   :type gnus-article-treat-head-custom)
1514 (put 'gnus-treat-mail-picon 'highlight t)
1515
1516 (defcustom gnus-treat-newsgroups-picon
1517   (if (and (gnus-image-type-available-p 'xpm)
1518            (gnus-picons-installed-p))
1519       'head nil)
1520   "Display picons in the Newsgroups and Followup-To headers.
1521 Valid values are nil, t, `head', `first', `last', an integer or a
1522 predicate.  See Info node `(gnus)Customizing Articles' and Info
1523 node `(gnus)Picons' for details."
1524   :version "22.1"
1525   :group 'gnus-article-treat
1526   :group 'gnus-picon
1527   :link '(custom-manual "(gnus)Customizing Articles")
1528   :link '(custom-manual "(gnus)Picons")
1529   :type gnus-article-treat-head-custom)
1530 (put 'gnus-treat-newsgroups-picon 'highlight t)
1531
1532 (defcustom gnus-treat-from-gravatar nil
1533   "Display gravatars in the From header.
1534 Valid values are nil, t, `head', `first', `last', an integer or a
1535 predicate.  See Info node `(gnus)Customizing Articles' and Info
1536 node `(gnus)Gravatars' for details."
1537   :version "24.1"
1538   :group 'gnus-article-treat
1539   :group 'gnus-gravatar
1540   :link '(custom-manual "(gnus)Customizing Articles")
1541   :link '(custom-manual "(gnus)Gravatars")
1542   :type gnus-article-treat-head-custom)
1543 (put 'gnus-treat-from-gravatar 'highlight t)
1544
1545 (defcustom gnus-treat-mail-gravatar nil
1546   "Display gravatars in To and Cc headers.
1547 Valid values are nil, t, `head', `first', `last', an integer or a
1548 predicate.  See Info node `(gnus)Customizing Articles' and Info
1549 node `(gnus)Gravatars' for details."
1550   :version "24.1"
1551   :group 'gnus-article-treat
1552   :group 'gnus-gravatar
1553   :link '(custom-manual "(gnus)Customizing Articles")
1554   :link '(custom-manual "(gnus)Gravatars")
1555   :type gnus-article-treat-head-custom)
1556 (put 'gnus-treat-mail-gravatar 'highlight t)
1557
1558 (defcustom gnus-treat-body-boundary
1559   (if (or gnus-treat-newsgroups-picon
1560           gnus-treat-mail-picon
1561           gnus-treat-from-picon
1562           gnus-treat-from-gravatar
1563           gnus-treat-mail-gravatar)
1564       ;; If there's much decoration, the user might prefer a boundery.
1565       'head
1566     nil)
1567   "Draw a boundary at the end of the headers.
1568 Valid values are nil and `head'.
1569 See Info node `(gnus)Customizing Articles' for details."
1570   :version "22.1"
1571   :group 'gnus-article-treat
1572   :link '(custom-manual "(gnus)Customizing Articles")
1573   :type gnus-article-treat-head-custom)
1574
1575 (defcustom gnus-treat-capitalize-sentences nil
1576   "Capitalize sentence-starting words.
1577 Valid values are nil, t, `head', `first', `last', an integer or a
1578 predicate.  See Info node `(gnus)Customizing Articles'."
1579   :version "21.1"
1580   :group 'gnus-article-treat
1581   :link '(custom-manual "(gnus)Customizing Articles")
1582   :type gnus-article-treat-custom)
1583
1584 (defcustom gnus-treat-wash-html nil
1585   "Format as HTML.
1586 Valid values are nil, t, `head', `first', `last', an integer or a
1587 predicate.  See Info node `(gnus)Customizing Articles'."
1588   :version "22.1"
1589   :group 'gnus-article-treat
1590   :link '(custom-manual "(gnus)Customizing Articles")
1591   :type gnus-article-treat-custom)
1592
1593 (defcustom gnus-treat-fill-long-lines '(typep "text/plain")
1594   "Fill long lines.
1595 Valid values are nil, t, `head', `first', `last', an integer or a
1596 predicate.  See Info node `(gnus)Customizing Articles'."
1597   :group 'gnus-article-treat
1598   :link '(custom-manual "(gnus)Customizing Articles")
1599   :type gnus-article-treat-custom)
1600
1601 (defcustom gnus-treat-x-pgp-sig nil
1602   "Verify X-PGP-Sig.
1603 To automatically treat X-PGP-Sig, set it to head.
1604 Valid values are nil, t, `head', `first', `last', an integer or a
1605 predicate.  See Info node `(gnus)Customizing Articles'."
1606   :version "22.1"
1607   :group 'gnus-article-treat
1608   :group 'mime-security
1609   :link '(custom-manual "(gnus)Customizing Articles")
1610   :type gnus-article-treat-custom)
1611
1612 (defvar gnus-article-encrypt-protocol-alist
1613   '(("PGP" . mml2015-self-encrypt)))
1614
1615 ;; Set to nil if more than one protocol added to
1616 ;; gnus-article-encrypt-protocol-alist.
1617 (defcustom gnus-article-encrypt-protocol "PGP"
1618   "The protocol used for encrypt articles.
1619 It is a string, such as \"PGP\". If nil, ask user."
1620   :version "22.1"
1621   :type 'string
1622   :group 'mime-security)
1623
1624 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1625                               (mm-coding-system-p 'utf-8)
1626                               (executable-find idna-program))
1627   "Whether IDNA decoding of headers is used when viewing messages.
1628 This requires GNU Libidn, and by default only enabled if it is found."
1629   :version "22.1"
1630   :group 'gnus-article-headers
1631   :type 'boolean)
1632
1633 (defcustom gnus-article-over-scroll nil
1634   "If non-nil, allow scrolling the article buffer even when there no more text."
1635   :version "22.1"
1636   :group 'gnus-article
1637   :type 'boolean)
1638
1639 (defcustom gnus-blocked-images 'gnus-block-private-groups
1640   "Images that have URLs matching this regexp will be blocked.
1641 This can also be a function to be evaluated.  If so, it will be
1642 called with the group name as the parameter, and should return a
1643 regexp."
1644   :version "24.1"
1645   :group 'gnus-art
1646   :type 'regexp)
1647
1648 ;;; Internal variables
1649
1650 (defvar gnus-english-month-names
1651   '("January" "February" "March" "April" "May" "June" "July" "August"
1652     "September" "October" "November" "December"))
1653
1654 (defvar article-goto-body-goes-to-point-min-p nil)
1655 (defvar gnus-article-wash-types nil)
1656 (defvar gnus-article-emphasis-alist nil)
1657 (defvar gnus-article-image-alist nil)
1658
1659 (defvar gnus-article-mime-handle-alist-1 nil)
1660 (defvar gnus-treatment-function-alist
1661   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1662     (gnus-treat-strip-banner gnus-article-strip-banner)
1663     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1664     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1665     (gnus-treat-buttonize gnus-article-add-buttons)
1666     (gnus-treat-fill-article gnus-article-fill-cited-article)
1667     (gnus-treat-fill-long-lines gnus-article-fill-cited-long-lines)
1668     (gnus-treat-strip-cr gnus-article-remove-cr)
1669     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1670     (gnus-treat-date-ut gnus-article-date-ut)
1671     (gnus-treat-date-local gnus-article-date-local)
1672     (gnus-treat-date-english gnus-article-date-english)
1673     (gnus-treat-date-original gnus-article-date-original)
1674     (gnus-treat-date-user-defined gnus-article-date-user)
1675     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1676     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1677     (gnus-treat-display-x-face gnus-article-display-x-face)
1678     (gnus-treat-display-face gnus-article-display-face)
1679     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1680     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1681     (gnus-treat-hide-signature gnus-article-hide-signature)
1682     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1683     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1684     (gnus-treat-from-picon gnus-treat-from-picon)
1685     (gnus-treat-mail-picon gnus-treat-mail-picon)
1686     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1687     (gnus-treat-strip-pem gnus-article-hide-pem)
1688     (gnus-treat-from-gravatar gnus-treat-from-gravatar)
1689     (gnus-treat-mail-gravatar gnus-treat-mail-gravatar)
1690     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1691     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1692     (gnus-treat-strip-trailing-blank-lines
1693      gnus-article-remove-trailing-blank-lines)
1694     (gnus-treat-strip-leading-blank-lines
1695      gnus-article-strip-leading-blank-lines)
1696     (gnus-treat-strip-multiple-blank-lines
1697      gnus-article-strip-multiple-blank-lines)
1698     (gnus-treat-overstrike gnus-article-treat-overstrike)
1699     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1700     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1701     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1702     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1703     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1704     (gnus-treat-display-smileys gnus-treat-smiley)
1705     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1706     (gnus-treat-wash-html gnus-article-wash-html)
1707     (gnus-treat-emphasize gnus-article-emphasize)
1708     (gnus-treat-hide-citation gnus-article-hide-citation)
1709     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1710     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1711     (gnus-treat-body-boundary gnus-article-treat-body-boundary)))
1712
1713 (defvar gnus-article-mime-handle-alist nil)
1714 (defvar article-lapsed-timer nil)
1715 (defvar gnus-article-current-summary nil)
1716
1717 (defvar gnus-article-mode-syntax-table
1718   (let ((table (copy-syntax-table text-mode-syntax-table)))
1719     ;; This causes the citation match run O(2^n).
1720     ;; (modify-syntax-entry ?- "w" table)
1721     (modify-syntax-entry ?> ")<" table)
1722     (modify-syntax-entry ?< "(>" table)
1723     ;; make M-. in article buffers work for `foo' strings
1724     (modify-syntax-entry ?' " " table)
1725     (modify-syntax-entry ?` " " table)
1726     table)
1727   "Syntax table used in article mode buffers.
1728 Initialized from `text-mode-syntax-table.")
1729
1730 (defvar gnus-save-article-buffer nil)
1731
1732 (defvar gnus-number-of-articles-to-be-saved nil)
1733
1734 (defvar gnus-inhibit-hiding nil)
1735
1736 (defvar gnus-article-edit-mode nil)
1737
1738 ;;; Macros for dealing with the article buffer.
1739
1740 (defmacro gnus-with-article-headers (&rest forms)
1741   `(with-current-buffer gnus-article-buffer
1742      (save-restriction
1743        (let ((inhibit-read-only t)
1744              (inhibit-point-motion-hooks t)
1745              (case-fold-search t))
1746          (article-narrow-to-head)
1747          ,@forms))))
1748
1749 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1750 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1751
1752 (defmacro gnus-with-article-buffer (&rest forms)
1753   `(with-current-buffer gnus-article-buffer
1754      (let ((inhibit-read-only t))
1755        ,@forms)))
1756
1757 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1758 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1759
1760 (defun gnus-article-goto-header (header)
1761   "Go to HEADER, which is a regular expression."
1762   (re-search-forward (concat "^\\(" header "\\):") nil t))
1763
1764 (defsubst gnus-article-hide-text (b e props)
1765   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1766   (gnus-add-text-properties-when 'article-type nil b e props)
1767   (when (memq 'intangible props)
1768     (put-text-property
1769      (max (1- b) (point-min))
1770      b 'intangible (cddr (memq 'intangible props)))))
1771
1772 (defsubst gnus-article-unhide-text (b e)
1773   "Remove hidden text properties from region between B and E."
1774   (remove-text-properties b e gnus-hidden-properties)
1775   (when (memq 'intangible gnus-hidden-properties)
1776     (put-text-property (max (1- b) (point-min))
1777                        b 'intangible nil)))
1778
1779 (defun gnus-article-hide-text-type (b e type)
1780   "Hide text of TYPE between B and E."
1781   (gnus-add-wash-type type)
1782   (gnus-article-hide-text
1783    b e (cons 'article-type (cons type gnus-hidden-properties))))
1784
1785 (defun gnus-article-unhide-text-type (b e type)
1786   "Unhide text of TYPE between B and E."
1787   (gnus-delete-wash-type type)
1788   (remove-text-properties
1789    b e (cons 'article-type (cons type gnus-hidden-properties)))
1790   (when (memq 'intangible gnus-hidden-properties)
1791     (put-text-property (max (1- b) (point-min))
1792                        b 'intangible nil)))
1793
1794 (defun gnus-article-hide-text-of-type (type)
1795   "Hide text of TYPE in the current buffer."
1796   (save-excursion
1797     (let ((b (point-min))
1798           (e (point-max)))
1799       (while (setq b (text-property-any b e 'article-type type))
1800         (add-text-properties b (incf b) gnus-hidden-properties)))))
1801
1802 (defun gnus-article-delete-text-of-type (type)
1803   "Delete text of TYPE in the current buffer."
1804   (save-excursion
1805     (let ((b (point-min)))
1806       (if (eq type 'multipart)
1807           ;; Remove MIME buttons associated with multipart/alternative parts.
1808           (progn
1809             (goto-char b)
1810             (while (if (get-text-property (point) 'gnus-part)
1811                        (setq b (point))
1812                      (when (setq b (next-single-property-change (point)
1813                                                                 'gnus-part))
1814                        (goto-char b)
1815                        t))
1816               (end-of-line)
1817               (skip-chars-forward "\n")
1818               (when (eq (get-text-property b 'article-type) 'multipart)
1819                 (delete-region b (point)))))
1820         (while (setq b (text-property-any b (point-max) 'article-type type))
1821           (delete-region
1822            b (or (text-property-not-all b (point-max) 'article-type type)
1823                  (point-max))))))))
1824
1825 (defun gnus-article-delete-invisible-text ()
1826   "Delete all invisible text in the current buffer."
1827   (save-excursion
1828     (let ((b (point-min)))
1829       (while (setq b (text-property-any b (point-max) 'invisible t))
1830         (delete-region
1831          b (or (text-property-not-all b (point-max) 'invisible t)
1832                (point-max)))))))
1833
1834 (defun gnus-article-text-type-exists-p (type)
1835   "Say whether any text of type TYPE exists in the buffer."
1836   (text-property-any (point-min) (point-max) 'article-type type))
1837
1838 (defsubst gnus-article-header-rank ()
1839   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1840   (let ((list gnus-sorted-header-list)
1841         (i 1))
1842     (while list
1843       (if (looking-at (car list))
1844           (setq list nil)
1845         (setq list (cdr list))
1846         (incf i)))
1847       i))
1848
1849 (defun article-hide-headers (&optional arg delete)
1850   "Hide unwanted headers and possibly sort them as well."
1851   (interactive)
1852   ;; This function might be inhibited.
1853   (unless gnus-inhibit-hiding
1854     (let ((inhibit-read-only t)
1855           (case-fold-search t)
1856           (max (1+ (length gnus-sorted-header-list)))
1857           (inhibit-point-motion-hooks t)
1858           (cur (current-buffer))
1859           ignored visible beg)
1860       (save-excursion
1861         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1862         ;; group parameters, so we should go to the summary buffer.
1863         (when (prog1
1864                   (condition-case nil
1865                       (progn (set-buffer gnus-summary-buffer) t)
1866                     (error nil))
1867                 (setq ignored (when (not gnus-visible-headers)
1868                                 (cond ((stringp gnus-ignored-headers)
1869                                        gnus-ignored-headers)
1870                                       ((listp gnus-ignored-headers)
1871                                        (mapconcat 'identity
1872                                                   gnus-ignored-headers
1873                                                   "\\|"))))
1874                       visible (cond ((stringp gnus-visible-headers)
1875                                      gnus-visible-headers)
1876                                     ((and gnus-visible-headers
1877                                           (listp gnus-visible-headers))
1878                                      (mapconcat 'identity
1879                                                 gnus-visible-headers
1880                                                 "\\|")))))
1881           (set-buffer cur))
1882         (save-restriction
1883           ;; First we narrow to just the headers.
1884           (article-narrow-to-head)
1885           ;; Hide any "From " lines at the beginning of (mail) articles.
1886           (while (looking-at "From ")
1887             (forward-line 1))
1888           (unless (bobp)
1889             (delete-region (point-min) (point)))
1890           ;; Then treat the rest of the header lines.
1891           ;; Then we use the two regular expressions
1892           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1893           ;; select which header lines is to remain visible in the
1894           ;; article buffer.
1895           (while (re-search-forward "^[^ \t:]*:" nil t)
1896             (beginning-of-line)
1897             ;; Mark the rank of the header.
1898             (put-text-property
1899              (point) (1+ (point)) 'message-rank
1900              (if (or (and visible (looking-at visible))
1901                      (and ignored
1902                           (not (looking-at ignored))))
1903                  (gnus-article-header-rank)
1904                (+ 2 max)))
1905             (forward-line 1))
1906           (message-sort-headers-1)
1907           (when (setq beg (text-property-any
1908                            (point-min) (point-max) 'message-rank (+ 2 max)))
1909             ;; We delete the unwanted headers.
1910             (gnus-add-wash-type 'headers)
1911             (add-text-properties (point-min) (+ 5 (point-min))
1912                                  '(article-type headers dummy-invisible t))
1913             (delete-region beg (point-max))))))))
1914
1915 (defun article-hide-boring-headers (&optional arg)
1916   "Toggle hiding of headers that aren't very interesting.
1917 If given a negative prefix, always show; if given a positive prefix,
1918 always hide."
1919   (interactive (gnus-article-hidden-arg))
1920   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1921              (not gnus-show-all-headers))
1922     (save-excursion
1923       (save-restriction
1924         (let ((inhibit-read-only t)
1925               (inhibit-point-motion-hooks t))
1926           (article-narrow-to-head)
1927           (dolist (elem gnus-boring-article-headers)
1928             (goto-char (point-min))
1929             (cond
1930              ;; Hide empty headers.
1931              ((eq elem 'empty)
1932               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1933                 (forward-line -1)
1934                 (gnus-article-hide-text-type
1935                  (point-at-bol)
1936                  (progn
1937                    (end-of-line)
1938                    (if (re-search-forward "^[^ \t]" nil t)
1939                        (match-beginning 0)
1940                      (point-max)))
1941                  'boring-headers)))
1942              ;; Hide boring Newsgroups header.
1943              ((eq elem 'newsgroups)
1944               (when (gnus-string-equal
1945                      (gnus-fetch-field "newsgroups")
1946                      (gnus-group-real-name
1947                       (if (boundp 'gnus-newsgroup-name)
1948                           gnus-newsgroup-name
1949                         "")))
1950                 (gnus-article-hide-header "newsgroups")))
1951              ((eq elem 'to-address)
1952               (let ((to (message-fetch-field "to"))
1953                     (to-address
1954                      (gnus-parameter-to-address
1955                       (if (boundp 'gnus-newsgroup-name)
1956                           gnus-newsgroup-name ""))))
1957                 (when (and to to-address
1958                            (ignore-errors
1959                              (gnus-string-equal
1960                               ;; only one address in To
1961                               (nth 1 (mail-extract-address-components to))
1962                               to-address)))
1963                   (gnus-article-hide-header "to"))))
1964              ((eq elem 'to-list)
1965               (let ((to (message-fetch-field "to"))
1966                     (to-list
1967                      (gnus-parameter-to-list
1968                       (if (boundp 'gnus-newsgroup-name)
1969                           gnus-newsgroup-name ""))))
1970                 (when (and to to-list
1971                            (ignore-errors
1972                              (gnus-string-equal
1973                               ;; only one address in To
1974                               (nth 1 (mail-extract-address-components to))
1975                               to-list)))
1976                   (gnus-article-hide-header "to"))))
1977              ((eq elem 'cc-list)
1978               (let ((cc (message-fetch-field "cc"))
1979                     (to-list
1980                      (gnus-parameter-to-list
1981                       (if (boundp 'gnus-newsgroup-name)
1982                           gnus-newsgroup-name ""))))
1983                 (when (and cc to-list
1984                            (ignore-errors
1985                              (gnus-string-equal
1986                               ;; only one address in CC
1987                               (nth 1 (mail-extract-address-components cc))
1988                               to-list)))
1989                   (gnus-article-hide-header "cc"))))
1990              ((eq elem 'followup-to)
1991               (when (gnus-string-equal
1992                      (message-fetch-field "followup-to")
1993                      (message-fetch-field "newsgroups"))
1994                 (gnus-article-hide-header "followup-to")))
1995              ((eq elem 'reply-to)
1996               (if (gnus-group-find-parameter
1997                    gnus-newsgroup-name 'broken-reply-to)
1998                   (gnus-article-hide-header "reply-to")
1999                 (let ((from (message-fetch-field "from"))
2000                       (reply-to (message-fetch-field "reply-to")))
2001                   (when
2002                       (and
2003                        from reply-to
2004                        (ignore-errors
2005                          (equal
2006                           (sort (mapcar
2007                                  (lambda (x) (downcase (cadr x)))
2008                                  (mail-extract-address-components from t))
2009                                 'string<)
2010                           (sort (mapcar
2011                                  (lambda (x) (downcase (cadr x)))
2012                                  (mail-extract-address-components reply-to t))
2013                                 'string<))))
2014                     (gnus-article-hide-header "reply-to")))))
2015              ((eq elem 'date)
2016               (let ((date (with-current-buffer gnus-original-article-buffer
2017                             ;; If date in `gnus-article-buffer' is localized
2018                             ;; (`gnus-treat-date-user-defined'),
2019                             ;; `days-between' might fail.
2020                             (message-fetch-field "date"))))
2021                 (when (and date
2022                            (< (days-between (current-time-string) date)
2023                               4))
2024                   (gnus-article-hide-header "date"))))
2025              ((eq elem 'long-to)
2026               (let ((to (message-fetch-field "to"))
2027                     (cc (message-fetch-field "cc")))
2028                 (when (> (length to) 1024)
2029                   (gnus-article-hide-header "to"))
2030                 (when (> (length cc) 1024)
2031                   (gnus-article-hide-header "cc"))))
2032              ((eq elem 'many-to)
2033               (let ((to-count 0)
2034                     (cc-count 0))
2035                 (goto-char (point-min))
2036                 (while (re-search-forward "^to:" nil t)
2037                   (setq to-count (1+ to-count)))
2038                 (when (> to-count 1)
2039                   (while (> to-count 0)
2040                     (goto-char (point-min))
2041                     (save-restriction
2042                       (re-search-forward "^to:" nil nil to-count)
2043                       (forward-line -1)
2044                       (narrow-to-region (point) (point-max))
2045                       (gnus-article-hide-header "to"))
2046                     (setq to-count (1- to-count))))
2047                 (goto-char (point-min))
2048                 (while (re-search-forward "^cc:" nil t)
2049                   (setq cc-count (1+ cc-count)))
2050                 (when (> cc-count 1)
2051                   (while (> cc-count 0)
2052                     (goto-char (point-min))
2053                     (save-restriction
2054                       (re-search-forward "^cc:" nil nil cc-count)
2055                       (forward-line -1)
2056                       (narrow-to-region (point) (point-max))
2057                       (gnus-article-hide-header "cc"))
2058                     (setq cc-count (1- cc-count)))))))))))))
2059
2060 (defun gnus-article-hide-header (header)
2061   (save-excursion
2062     (goto-char (point-min))
2063     (when (re-search-forward (concat "^" header ":") nil t)
2064       (gnus-article-hide-text-type
2065        (point-at-bol)
2066        (progn
2067          (end-of-line)
2068          (if (re-search-forward "^[^ \t]" nil t)
2069              (match-beginning 0)
2070            (point-max)))
2071        'boring-headers))))
2072
2073 (defvar gnus-article-normalized-header-length 40
2074   "Length of normalized headers.")
2075
2076 (defun article-normalize-headers ()
2077   "Make all header lines 40 characters long."
2078   (interactive)
2079   (let ((inhibit-read-only t)
2080         column)
2081     (save-excursion
2082       (save-restriction
2083         (article-narrow-to-head)
2084         (while (not (eobp))
2085           (cond
2086            ((< (setq column (- (point-at-eol) (point)))
2087                gnus-article-normalized-header-length)
2088             (end-of-line)
2089             (insert (make-string
2090                      (- gnus-article-normalized-header-length column)
2091                      ? )))
2092            ((> column gnus-article-normalized-header-length)
2093             (gnus-put-text-property
2094              (progn
2095                (forward-char gnus-article-normalized-header-length)
2096                (point))
2097              (point-at-eol)
2098              'invisible t))
2099            (t
2100             ;; Do nothing.
2101             ))
2102           (forward-line 1))))))
2103
2104 (defun article-treat-dumbquotes ()
2105   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2106 Note that this function guesses whether a character is a sm*rtq**t* or
2107 not, so it should only be used interactively.
2108
2109 Sm*rtq**t*s are M****s***'s unilateral extension to the
2110 iso-8859-1 character map in an attempt to provide more quoting
2111 characters.  If you see something like \\222 or \\264 where
2112 you're expecting some kind of apostrophe or quotation mark, then
2113 try this wash."
2114   (interactive)
2115   (article-translate-strings gnus-article-dumbquotes-map))
2116
2117 (defvar org-entities)
2118
2119 (defun article-treat-non-ascii ()
2120   "Translate many Unicode characters into their ASCII equivalents."
2121   (interactive)
2122   (require 'org-entities)
2123   (let ((table (make-char-table (if (featurep 'xemacs) 'generic))))
2124     (dolist (elem org-entities)
2125       (when (and (listp elem)
2126                  (= (length (nth 6 elem)) 1))
2127         (if (featurep 'xemacs)
2128             (put-char-table (aref (nth 6 elem) 0) (nth 4 elem) table)
2129           (set-char-table-range table (aref (nth 6 elem) 0) (nth 4 elem)))))
2130     (save-excursion
2131       (when (article-goto-body)
2132         (let ((inhibit-read-only t)
2133               replace)
2134           (while (not (eobp))
2135             (if (not (setq replace (if (featurep 'xemacs)
2136                                        (get-char-table (following-char) table)
2137                                      (aref table (following-char)))))
2138                 (forward-char 1)
2139               (delete-char 1)
2140               (insert replace))))))))
2141
2142 (defun article-translate-characters (from to)
2143   "Translate all characters in the body of the article according to FROM and TO.
2144 FROM is a string of characters to translate from; to is a string of
2145 characters to translate to."
2146   (save-excursion
2147     (when (article-goto-body)
2148       (let ((inhibit-read-only t)
2149             (x (make-string 225 ?x))
2150             (i -1))
2151         (while (< (incf i) (length x))
2152           (aset x i i))
2153         (setq i 0)
2154         (while (< i (length from))
2155           (aset x (aref from i) (aref to i))
2156           (incf i))
2157         (translate-region (point) (point-max) x)))))
2158
2159 (defun article-translate-strings (map)
2160   "Translate all string in the body of the article according to MAP.
2161 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2162   (save-excursion
2163     (when (article-goto-body)
2164       (let ((inhibit-read-only t))
2165         (dolist (elem map)
2166           (let ((from (car elem))
2167                 (to (cadr elem)))
2168             (save-excursion
2169               (if (stringp from)
2170                   (while (search-forward from nil t)
2171                     (replace-match to))
2172                 (while (not (eobp))
2173                   (if (eq (following-char) from)
2174                       (progn
2175                         (delete-char 1)
2176                         (insert to))
2177                     (forward-char 1)))))))))))
2178
2179 (defun article-treat-overstrike ()
2180   "Translate overstrikes into bold text."
2181   (interactive)
2182   (save-excursion
2183     (when (article-goto-body)
2184       (let ((inhibit-read-only t))
2185         (while (search-forward "\b" nil t)
2186           (let ((next (char-after))
2187                 (previous (char-after (- (point) 2))))
2188             ;; We do the boldification/underlining by hiding the
2189             ;; overstrikes and putting the proper text property
2190             ;; on the letters.
2191             (cond
2192              ((eq next previous)
2193               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2194               (put-text-property (point) (1+ (point)) 'face 'bold))
2195              ((eq next ?_)
2196               (gnus-article-hide-text-type
2197                (1- (point)) (1+ (point)) 'overstrike)
2198               (put-text-property
2199                (- (point) 2) (1- (point)) 'face 'underline))
2200              ((eq previous ?_)
2201               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2202               (put-text-property
2203                (point) (1+ (point)) 'face 'underline)))))))))
2204
2205 (defun article-treat-ansi-sequences ()
2206   "Translate ANSI SGR control sequences into overlays or extents."
2207   (interactive)
2208   (save-excursion
2209     (when (article-goto-body)
2210       (let ((inhibit-read-only t))
2211         (ansi-color-apply-on-region (point) (point-max))))))
2212
2213 (defun gnus-article-treat-unfold-headers ()
2214   "Unfold folded message headers.
2215 Only the headers that fit into the current window width will be
2216 unfolded."
2217   (interactive)
2218   (gnus-with-article-headers
2219     (let (length)
2220       (while (not (eobp))
2221         (save-restriction
2222           (mail-header-narrow-to-field)
2223           (let* ((header (buffer-string))
2224                  (unfoldable
2225                   (or (equal gnus-article-unfold-long-headers t)
2226                       (and (stringp gnus-article-unfold-long-headers)
2227                            (string-match gnus-article-unfold-long-headers header)))))
2228             (with-temp-buffer
2229               (insert header)
2230               (goto-char (point-min))
2231               (while (re-search-forward "\n[\t ]" nil t)
2232                 (replace-match " " t t)))
2233             (setq length (- (point-max) (point-min) 1))
2234             (when (or unfoldable
2235                       (< length (window-width)))
2236               (while (re-search-forward "\n[\t ]" nil t)
2237                 (replace-match " " t t))))
2238           (goto-char (point-max)))))))
2239
2240 (defun gnus-article-treat-fold-headers ()
2241   "Fold message headers."
2242   (interactive)
2243   (gnus-with-article-headers
2244     (while (not (eobp))
2245       (save-restriction
2246         (mail-header-narrow-to-field)
2247         (mail-header-fold-field)
2248         (goto-char (point-max))))))
2249
2250 (defun gnus-treat-smiley ()
2251   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2252   (interactive)
2253   (gnus-with-article-buffer
2254     (if (memq 'smiley gnus-article-wash-types)
2255         (gnus-delete-images 'smiley)
2256       (article-goto-body)
2257       (let ((images (smiley-region (point) (point-max))))
2258         (when images
2259           (gnus-add-wash-type 'smiley)
2260           (dolist (image images)
2261             (gnus-add-image 'smiley image)))))))
2262
2263 (defun gnus-article-remove-images ()
2264   "Remove all images from the article buffer."
2265   (interactive)
2266   (gnus-with-article-buffer
2267     (dolist (elem gnus-article-image-alist)
2268       (gnus-delete-images (car elem)))))
2269
2270 (defun gnus-article-treat-fold-newsgroups ()
2271   "Unfold folded message headers.
2272 Only the headers that fit into the current window width will be
2273 unfolded."
2274   (interactive)
2275   (gnus-with-article-headers
2276     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2277       (save-restriction
2278         (mail-header-narrow-to-field)
2279         (while (re-search-forward ", *" nil t)
2280           (replace-match ", " t t))
2281         (mail-header-fold-field)
2282         (goto-char (point-max))))))
2283
2284 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2285   "Value of `truncate-lines' in Gnus Article buffer.
2286 Valid values are nil, t, `head', `first', `last', an integer or a
2287 predicate.  See Info node `(gnus)Customizing Articles'."
2288   :version "23.1" ;; No Gnus
2289   :group 'gnus-article
2290   ;; :link '(custom-manual "(gnus)Customizing Articles")
2291   :type 'boolean)
2292
2293 (defun gnus-article-toggle-truncate-lines (&optional arg)
2294   "Toggle whether to fold or truncate long lines in article the buffer.
2295 If ARG is non-nil and not a number, toggle
2296 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2297 long lines if and only if arg is positive."
2298   (interactive "P")
2299   (cond
2300    ((and (numberp arg) (> arg 0))
2301     (setq gnus-article-truncate-lines t))
2302    ((numberp arg)
2303     (setq gnus-article-truncate-lines nil))
2304    (arg
2305     (setq gnus-article-truncate-lines
2306           (not gnus-article-truncate-lines))))
2307   (gnus-with-article-buffer
2308     (cond
2309      ((and (numberp arg) (> arg 0))
2310       (setq truncate-lines nil))
2311      ((numberp arg)
2312       (setq truncate-lines t)))
2313     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2314     ;; `toggle-truncate-lines' needs an argument.
2315     (toggle-truncate-lines)))
2316
2317 (defun gnus-article-treat-body-boundary ()
2318   "Place a boundary line at the end of the headers."
2319   (interactive)
2320   (when (and gnus-body-boundary-delimiter
2321              (> (length gnus-body-boundary-delimiter) 0))
2322     (gnus-with-article-headers
2323       (goto-char (point-max))
2324       (let ((start (point)))
2325         (insert "X-Boundary: ")
2326         (gnus-add-text-properties start (point) '(invisible t intangible t))
2327         (insert (let (str)
2328                   (while (>= (window-width) (length str))
2329                     (setq str (concat str gnus-body-boundary-delimiter)))
2330                   (substring str 0 (window-width)))
2331                 "\n")
2332         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2333
2334 (defun article-fill-long-lines ()
2335   "Fill lines that are wider than the window width."
2336   (interactive)
2337   (save-excursion
2338     (let ((inhibit-read-only t)
2339           (width (window-width (get-buffer-window (current-buffer)))))
2340       (save-restriction
2341         (article-goto-body)
2342         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2343           (while (not (eobp))
2344             (end-of-line)
2345             (when (>= (current-column) (min fill-column width))
2346               (narrow-to-region (min (1+ (point)) (point-max))
2347                                 (point-at-bol))
2348               (let ((goback (point-marker)))
2349                 (fill-paragraph nil)
2350                 (goto-char (marker-position goback)))
2351               (widen))
2352             (forward-line 1)))))))
2353
2354 (defun article-capitalize-sentences ()
2355   "Capitalize the first word in each sentence."
2356   (interactive)
2357   (save-excursion
2358     (let ((inhibit-read-only t)
2359           (paragraph-start "^[\n\^L]"))
2360       (article-goto-body)
2361       (while (not (eobp))
2362         (capitalize-word 1)
2363         (forward-sentence)))))
2364
2365 (defun article-remove-cr ()
2366   "Remove trailing CRs and then translate remaining CRs into LFs."
2367   (interactive)
2368   (save-excursion
2369     (let ((inhibit-read-only t))
2370       (goto-char (point-min))
2371       (while (re-search-forward "\r+$" nil t)
2372         (replace-match "" t t))
2373       (goto-char (point-min))
2374       (while (search-forward "\r" nil t)
2375         (replace-match "\n" t t)))))
2376
2377 (defun article-remove-trailing-blank-lines ()
2378   "Remove all trailing blank lines from the article."
2379   (interactive)
2380   (save-excursion
2381     (let ((inhibit-read-only t))
2382       (goto-char (point-max))
2383       (delete-region
2384        (point)
2385        (progn
2386          (while (and (not (bobp))
2387                      (looking-at "^[ \t]*$")
2388                      (not (gnus-annotation-in-region-p
2389                            (point) (point-at-eol))))
2390            (forward-line -1))
2391          (forward-line 1)
2392          (point))))))
2393
2394 (defvar gnus-face-properties-alist)
2395
2396 (defun article-display-face (&optional force)
2397   "Display any Face headers in the header."
2398   (interactive (list 'force))
2399   (let ((wash-face-p buffer-read-only))
2400     (gnus-with-article-headers
2401       ;; When displaying parts, this function can be called several times on
2402       ;; the same article, without any intended toggle semantic (as typing `W
2403       ;; D d' would have). So face deletion must occur only when we come from
2404       ;; an interactive command, that is when the *Article* buffer is
2405       ;; read-only.
2406       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2407           (gnus-delete-images 'face)
2408         (let ((from (message-fetch-field "from"))
2409               face faces)
2410           (save-current-buffer
2411             (when (and wash-face-p
2412                        (gnus-buffer-live-p gnus-original-article-buffer)
2413                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2414               (set-buffer gnus-original-article-buffer))
2415             (save-restriction
2416               (mail-narrow-to-head)
2417               (when (or force
2418                         ;; Check whether this face is censored.
2419                         (not (and gnus-article-x-face-too-ugly
2420                                   (or from
2421                                       (setq from (message-fetch-field "from")))
2422                                   (string-match gnus-article-x-face-too-ugly
2423                                                 from))))
2424                 (while (gnus-article-goto-header "Face")
2425                   (push (mail-header-field-value) faces)))))
2426           (when faces
2427             (goto-char (point-min))
2428             (let (png image)
2429               (unless (setq from (gnus-article-goto-header "from"))
2430                 (insert "From:")
2431                 (setq from (point))
2432                 (insert " [no `from' set]\n"))
2433               (while faces
2434                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2435                   (setq image
2436                         (apply 'gnus-create-image png 'png t
2437                                (cdr (assq 'png gnus-face-properties-alist))))
2438                   (goto-char from)
2439                   (gnus-add-wash-type 'face)
2440                   (gnus-add-image 'face image)
2441                   (gnus-put-image image nil 'face))))))))))
2442
2443 (defun article-display-x-face (&optional force)
2444   "Look for an X-Face header and display it if present."
2445   (interactive (list 'force))
2446   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2447     (gnus-with-article-headers
2448       ;; Delete the old process, if any.
2449       (when (process-status "article-x-face")
2450         (delete-process "article-x-face"))
2451       ;; See the comment in `article-display-face'.
2452       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2453           ;; We have already displayed X-Faces, so we remove them
2454           ;; instead.
2455           (gnus-delete-images 'xface)
2456         ;; Display X-Faces.
2457         (let ((from (message-fetch-field "from"))
2458               x-faces face)
2459           (save-current-buffer
2460             (when (and wash-face-p
2461                        (gnus-buffer-live-p gnus-original-article-buffer)
2462                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2463               ;; If type `W f', use gnus-original-article-buffer,
2464               ;; otherwise use the current buffer because displaying
2465               ;; RFC822 parts calls this function too.
2466               (set-buffer gnus-original-article-buffer))
2467             (save-restriction
2468               (mail-narrow-to-head)
2469               (and gnus-article-x-face-command
2470                    (or force
2471                        ;; Check whether this face is censored.
2472                        (not (and gnus-article-x-face-too-ugly
2473                                  (or from
2474                                      (setq from (message-fetch-field "from")))
2475                                  (string-match gnus-article-x-face-too-ugly
2476                                                from))))
2477                    (while (gnus-article-goto-header "X-Face")
2478                      (push (mail-header-field-value) x-faces)))))
2479           (when x-faces
2480             ;; We display the face.
2481             (cond ((functionp gnus-article-x-face-command)
2482                    ;; The command is a lisp function, so we call it.
2483                    (mapc gnus-article-x-face-command x-faces))
2484                   ((stringp gnus-article-x-face-command)
2485                    ;; The command is a string, so we interpret the command
2486                    ;; as a, well, command, and fork it off.
2487                    (let ((process-connection-type nil))
2488                      (gnus-set-process-query-on-exit-flag
2489                       (start-process
2490                        "article-x-face" nil shell-file-name
2491                        shell-command-switch gnus-article-x-face-command)
2492                       nil)
2493                      ;; Sending multiple EOFs to xv doesn't work,
2494                      ;; so we only do a single external face.
2495                      (with-temp-buffer
2496                        (insert (car x-faces))
2497                        (process-send-region "article-x-face"
2498                                             (point-min) (point-max)))
2499                      (process-send-eof "article-x-face")))
2500                   (t
2501                    (error "`%s' set to `%s' is not a function"
2502                           gnus-article-x-face-command
2503                           'gnus-article-x-face-command)))))))))
2504
2505 (defun article-decode-mime-words ()
2506   "Decode all MIME-encoded words in the article."
2507   (interactive)
2508   (gnus-with-article-buffer
2509     (let ((inhibit-point-motion-hooks t)
2510           (mail-parse-charset gnus-newsgroup-charset)
2511           (mail-parse-ignored-charsets
2512            (with-current-buffer gnus-summary-buffer
2513              gnus-newsgroup-ignored-charsets)))
2514       (mail-decode-encoded-word-region (point-min) (point-max)))))
2515
2516 (defun article-decode-charset (&optional prompt)
2517   "Decode charset-encoded text in the article.
2518 If PROMPT (the prefix), prompt for a coding system to use."
2519   (interactive "P")
2520   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2521         (inhibit-read-only t)
2522         (mail-parse-charset gnus-newsgroup-charset)
2523         (mail-parse-ignored-charsets
2524          (save-excursion (condition-case nil
2525                              (set-buffer gnus-summary-buffer)
2526                            (error))
2527                          gnus-newsgroup-ignored-charsets))
2528         ct cte ctl charset format)
2529     (save-excursion
2530       (save-restriction
2531         (article-narrow-to-head)
2532         (setq ct (message-fetch-field "Content-Type" t)
2533               cte (message-fetch-field "Content-Transfer-Encoding" t)
2534               ctl (and ct (mail-header-parse-content-type ct))
2535               charset (cond
2536                        (prompt
2537                         (mm-read-coding-system "Charset to decode: "))
2538                        (ctl
2539                         (mail-content-type-get ctl 'charset)))
2540               format (and ctl (mail-content-type-get ctl 'format)))
2541         (when cte
2542           (setq cte (mail-header-strip cte)))
2543         (if (and ctl (not (string-match "/" (car ctl))))
2544             (setq ctl nil))
2545         (goto-char (point-max)))
2546       (forward-line 1)
2547       (save-restriction
2548         (narrow-to-region (point) (point-max))
2549         (when (and (eq mail-parse-charset 'gnus-decoded)
2550                    (eq (mm-body-7-or-8) '8bit))
2551           ;; The text code could have been decoded.
2552           (setq charset mail-parse-charset))
2553         (when (and (or (not ctl)
2554                        (equal (car ctl) "text/plain"))
2555                    (not format)) ;; article with format will decode later.
2556           (mm-decode-body
2557            charset (and cte (intern (downcase
2558                                      (gnus-strip-whitespace cte))))
2559            (car ctl)))))))
2560
2561 (defun article-decode-encoded-words ()
2562   "Remove encoded-word encoding from headers."
2563   (let ((inhibit-point-motion-hooks t)
2564         (mail-parse-charset gnus-newsgroup-charset)
2565         (mail-parse-ignored-charsets
2566          (save-excursion (condition-case nil
2567                              (set-buffer gnus-summary-buffer)
2568                            (error))
2569                          gnus-newsgroup-ignored-charsets))
2570         (inhibit-read-only t)
2571         end start)
2572     (goto-char (point-min))
2573     (when (search-forward "\n\n" nil 'move)
2574       (forward-line -1))
2575     (setq end (point))
2576     (while (not (bobp))
2577       (while (progn
2578                (forward-line -1)
2579                (and (not (bobp))
2580                     (memq (char-after) '(?\t ? )))))
2581       (setq start (point))
2582       (if (looking-at "\
2583 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2584 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2585           (funcall gnus-decode-address-function start end)
2586         (funcall gnus-decode-header-function start end))
2587       (goto-char (setq end start)))))
2588
2589 (defun article-decode-group-name ()
2590   "Decode group names in Newsgroups, Followup-To and Xref headers."
2591   (let ((inhibit-point-motion-hooks t)
2592         (inhibit-read-only t)
2593         (method (gnus-find-method-for-group gnus-newsgroup-name))
2594         regexp)
2595     (when (and (or gnus-group-name-charset-method-alist
2596                    gnus-group-name-charset-group-alist)
2597                (gnus-buffer-live-p gnus-original-article-buffer))
2598       (save-restriction
2599         (article-narrow-to-head)
2600         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2601           (with-current-buffer gnus-original-article-buffer
2602             (goto-char (point-min)))
2603           (setq regexp (concat "^" header
2604                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2605           (while (re-search-forward regexp nil t)
2606             (replace-match (save-match-data
2607                              (gnus-decode-newsgroups
2608                               ;; XXX how to use data in article buffer?
2609                               (with-current-buffer gnus-original-article-buffer
2610                                 (re-search-forward regexp nil t)
2611                                 (match-string 1))
2612                               gnus-newsgroup-name method))
2613                            t t nil 1))
2614           (goto-char (point-min)))))))
2615
2616 (autoload 'idna-to-unicode "idna")
2617
2618 (defun article-decode-idna-rhs ()
2619   "Decode IDNA strings in RHS in various headers in current buffer.
2620 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2621 Mail-Reply-To: and Mail-Followup-To:."
2622   (when gnus-use-idna
2623     (save-restriction
2624       (let ((inhibit-point-motion-hooks t)
2625             (inhibit-read-only t))
2626         (article-narrow-to-head)
2627         (goto-char (point-min))
2628         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2629           (let (ace unicode)
2630             (when (save-match-data
2631                     (and (setq ace (match-string 1))
2632                          (save-excursion
2633                            (and (re-search-backward "^[^ \t]" nil t)
2634                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2635                          (setq unicode (idna-to-unicode ace))))
2636               (unless (string= ace unicode)
2637                 (replace-match unicode nil nil nil 1)))))))))
2638
2639 (defun article-de-quoted-unreadable (&optional force read-charset)
2640   "Translate a quoted-printable-encoded article.
2641 If FORCE, decode the article whether it is marked as quoted-printable
2642 or not.
2643 If READ-CHARSET, ask for a coding system."
2644   (interactive (list 'force current-prefix-arg))
2645   (save-excursion
2646     (let ((inhibit-read-only t) type charset)
2647       (if (gnus-buffer-live-p gnus-original-article-buffer)
2648           (with-current-buffer gnus-original-article-buffer
2649             (setq type
2650                   (gnus-fetch-field "content-transfer-encoding"))
2651             (let* ((ct (gnus-fetch-field "content-type"))
2652                    (ctl (and ct (mail-header-parse-content-type ct))))
2653               (setq charset (and ctl
2654                                  (mail-content-type-get ctl 'charset)))
2655               (if (stringp charset)
2656                   (setq charset (intern (downcase charset)))))))
2657       (if read-charset
2658           (setq charset (mm-read-coding-system "Charset: " charset)))
2659       (unless charset
2660         (setq charset gnus-newsgroup-charset))
2661       (when (or force
2662                 (and type (let ((case-fold-search t))
2663                             (string-match "quoted-printable" type))))
2664         (article-goto-body)
2665         (quoted-printable-decode-region
2666          (point) (point-max) (mm-charset-to-coding-system charset))))))
2667
2668 (defun article-de-base64-unreadable (&optional force read-charset)
2669   "Translate a base64 article.
2670 If FORCE, decode the article whether it is marked as base64 not.
2671 If READ-CHARSET, ask for a coding system."
2672   (interactive (list 'force current-prefix-arg))
2673   (save-excursion
2674     (let ((inhibit-read-only t) type charset)
2675       (if (gnus-buffer-live-p gnus-original-article-buffer)
2676           (with-current-buffer gnus-original-article-buffer
2677             (setq type
2678                   (gnus-fetch-field "content-transfer-encoding"))
2679             (let* ((ct (gnus-fetch-field "content-type"))
2680                    (ctl (and ct (mail-header-parse-content-type ct))))
2681               (setq charset (and ctl
2682                                  (mail-content-type-get ctl 'charset)))
2683               (if (stringp charset)
2684                   (setq charset (intern (downcase charset)))))))
2685       (if read-charset
2686           (setq charset (mm-read-coding-system "Charset: " charset)))
2687       (unless charset
2688         (setq charset gnus-newsgroup-charset))
2689       (when (or force
2690                 (and type (let ((case-fold-search t))
2691                             (string-match "base64" type))))
2692         (article-goto-body)
2693         (save-restriction
2694           (narrow-to-region (point) (point-max))
2695           (base64-decode-region (point-min) (point-max))
2696           (mm-decode-coding-region
2697            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2698
2699 (eval-when-compile
2700   (require 'rfc1843))
2701
2702 (defun article-decode-HZ ()
2703   "Translate a HZ-encoded article."
2704   (interactive)
2705   (require 'rfc1843)
2706   (save-excursion
2707     (let ((inhibit-read-only t))
2708       (rfc1843-decode-region (point-min) (point-max)))))
2709
2710 (defun article-unsplit-urls ()
2711   "Remove the newlines that some other mailers insert into URLs."
2712   (interactive)
2713   (save-excursion
2714     (let ((inhibit-read-only t))
2715       (goto-char (point-min))
2716       (while (re-search-forward
2717               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2718         (replace-match "\\1\\3" t)))
2719     (when (interactive-p)
2720       (gnus-treat-article nil))))
2721
2722 (defun article-wash-html ()
2723   "Format an HTML article."
2724   (interactive)
2725   (let ((handles nil)
2726         (buffer-read-only nil))
2727     (when (gnus-buffer-live-p gnus-original-article-buffer)
2728       (setq handles (mm-dissect-buffer t t)))
2729     (article-goto-body)
2730     (delete-region (point) (point-max))
2731     (mm-inline-text-html handles)))
2732
2733 (defvar gnus-article-browse-html-temp-list nil
2734   "List of temporary files created by `gnus-article-browse-html-parts'.
2735 Internal variable.")
2736
2737 (defcustom gnus-article-browse-delete-temp 'ask
2738   "What to do with temporary files from `gnus-article-browse-html-parts'.
2739 If nil, don't delete temporary files.  If it is t, delete them on
2740 exit from the summary buffer.  If it is the symbol `file', query
2741 on each file, if it is `ask' ask once when exiting from the
2742 summary buffer."
2743   :group 'gnus-article
2744   :version "23.1" ;; No Gnus
2745   :type '(choice (const :tag "Don't delete" nil)
2746                  (const :tag "Don't ask" t)
2747                  (const :tag "Ask" ask)
2748                  (const :tag "Ask for each file" file)))
2749
2750 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2751
2752 (defun gnus-article-browse-delete-temp-files (&optional how)
2753   "Delete temp-files created by `gnus-article-browse-html-parts'."
2754   (when (and gnus-article-browse-html-temp-list
2755              (progn
2756                (or how (setq how gnus-article-browse-delete-temp))
2757                (if (eq how 'ask)
2758                    (let ((files (length gnus-article-browse-html-temp-list)))
2759                      (gnus-y-or-n-p (format
2760                                      "Delete all %s temporary HTML file%s? "
2761                                      files
2762                                      (if (> files 1) "s" ""))))
2763                  how)))
2764     (dolist (file gnus-article-browse-html-temp-list)
2765       (cond ((file-directory-p file)
2766              (when (or (not (eq how 'file))
2767                        (gnus-y-or-n-p
2768                         (format
2769                          "Delete temporary HTML file(s) in directory `%s'? "
2770                          (file-name-as-directory file))))
2771                (gnus-delete-directory file)))
2772             ((file-exists-p file)
2773              (when (or (not (eq how 'file))
2774                        (gnus-y-or-n-p
2775                         (format "Delete temporary HTML file `%s'? " file)))
2776                (delete-file file)))))
2777     ;; Also remove file from the list when not deleted or if file doesn't
2778     ;; exist anymore.
2779     (setq gnus-article-browse-html-temp-list nil))
2780   gnus-article-browse-html-temp-list)
2781
2782 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2783   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2784 Return file name."
2785   (save-match-data
2786     (let (file type)
2787       (catch 'found
2788         (dolist (handle handles)
2789           (cond
2790            ((not (listp handle)))
2791            ((equal (mm-handle-media-supertype handle) "multipart")
2792             (when (setq file (gnus-article-browse-html-save-cid-content
2793                               cid handle directory))
2794               (throw 'found file)))
2795            ((equal (concat "<" cid ">") (mm-handle-id handle))
2796             (setq file
2797                   (expand-file-name
2798                    (or (mail-content-type-get
2799                         (mm-handle-disposition handle) 'filename)
2800                        (mail-content-type-get
2801                         (setq type (mm-handle-type handle)) 'name)
2802                        (concat
2803                         (make-temp-name "cid")
2804                         (car (rassoc (car type) mailcap-mime-extensions))))
2805                    directory))
2806             (mm-save-part-to-file handle file)
2807             (throw 'found file))))))))
2808
2809 (defun gnus-article-browse-html-parts (list &optional header)
2810   "View all \"text/html\" parts from LIST.
2811 Recurse into multiparts.  The optional HEADER that should be a decoded
2812 message header will be added to the bodies of the \"text/html\" parts."
2813   ;; Internal function used by `gnus-article-browse-html-article'.
2814   (let (type file charset content cid-dir tmp-file showed)
2815     ;; Find and show the html-parts.
2816     (dolist (handle list)
2817       ;; If HTML, show it:
2818       (cond ((not (listp handle)))
2819             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2820                  (and (equal (car type) "message/external-body")
2821                       (or header
2822                           (setq file (or (mail-content-type-get type 'name)
2823                                          (mail-content-type-get
2824                                           (mm-handle-disposition handle)
2825                                           'filename))))
2826                       (or (mm-handle-cache handle)
2827                           (condition-case code
2828                               (progn (mm-extern-cache-contents handle) t)
2829                             (error
2830                              (gnus-message 3 "%s" (error-message-string code))
2831                              (when (>= gnus-verbose 3) (sit-for 2))
2832                              nil)))
2833                       (progn
2834                         (setq handle (mm-handle-cache handle)
2835                               type (mm-handle-type handle))
2836                         (equal (car type) "text/html"))))
2837              (setq charset (mail-content-type-get type 'charset)
2838                    content (mm-get-part handle))
2839              (with-temp-buffer
2840                (if (eq charset 'gnus-decoded)
2841                    (mm-enable-multibyte)
2842                  (mm-disable-multibyte))
2843                (insert content)
2844                ;; resolve cid contents
2845                (let ((case-fold-search t)
2846                      cid-file)
2847                  (goto-char (point-min))
2848                  (while (re-search-forward "\
2849 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2850                                            nil t)
2851                    (unless cid-dir
2852                      (setq cid-dir (mm-make-temp-file "cid" t))
2853                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2854                    (setq file nil
2855                          content nil)
2856                    (when (setq cid-file
2857                                (gnus-article-browse-html-save-cid-content
2858                                 (match-string 2)
2859                                 (with-current-buffer gnus-article-buffer
2860                                   gnus-article-mime-handles)
2861                                 cid-dir))
2862                      (replace-match (concat "file://" cid-file)
2863                                     nil nil nil 1))))
2864                (unless content (setq content (buffer-string))))
2865              (when (or charset header (not file))
2866                (setq tmp-file (mm-make-temp-file
2867                                ;; Do we need to care for 8.3 filenames?
2868                                "mm-" nil ".html")))
2869              ;; Add a meta html tag to specify charset and a header.
2870              (cond
2871               (header
2872                (let (title eheader body hcharset coding force-charset)
2873                  (with-temp-buffer
2874                    (mm-enable-multibyte)
2875                    (setq case-fold-search t)
2876                    (insert header "\n")
2877                    (setq title (message-fetch-field "subject"))
2878                    (goto-char (point-min))
2879                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2880                      (replace-match (cond ((match-beginning 1) "&lt;")
2881                                           ((match-beginning 2) "&gt;")
2882                                           (t "&amp;"))))
2883                    (goto-char (point-min))
2884                    (insert "<pre>\n")
2885                    (goto-char (point-max))
2886                    (insert "</pre>\n<hr>\n")
2887                    ;; We have to examine charset one by one since
2888                    ;; charset specified in parts might be different.
2889                    (if (eq charset 'gnus-decoded)
2890                        (setq charset 'utf-8
2891                              eheader (mm-encode-coding-string (buffer-string)
2892                                                               charset)
2893                              title (when title
2894                                      (mm-encode-coding-string title charset))
2895                              body (mm-encode-coding-string content charset)
2896                              force-charset t)
2897                      (setq hcharset (mm-find-mime-charset-region (point-min)
2898                                                                  (point-max)))
2899                      (cond ((= (length hcharset) 1)
2900                             (setq hcharset (car hcharset)
2901                                   coding (mm-charset-to-coding-system
2902                                           hcharset)))
2903                            ((> (length hcharset) 1)
2904                             (setq hcharset 'utf-8
2905                                   coding hcharset)))
2906                      (if coding
2907                          (if charset
2908                              (progn
2909                                (setq body
2910                                      (mm-charset-to-coding-system charset))
2911                                (if (eq coding body)
2912                                    (setq eheader (mm-encode-coding-string
2913                                                   (buffer-string) coding)
2914                                          title (when title
2915                                                  (mm-encode-coding-string
2916                                                   title coding))
2917                                          body content)
2918                                  (setq charset 'utf-8
2919                                        eheader (mm-encode-coding-string
2920                                                 (buffer-string) charset)
2921                                        title (when title
2922                                                (mm-encode-coding-string
2923                                                 title charset))
2924                                        body (mm-encode-coding-string
2925                                              (mm-decode-coding-string
2926                                               content body)
2927                                              charset)
2928                                        force-charset t)))
2929                            (setq charset hcharset
2930                                  eheader (mm-encode-coding-string
2931                                           (buffer-string) coding)
2932                                  title (when title
2933                                          (mm-encode-coding-string
2934                                           title coding))
2935                                  body content))
2936                        (setq eheader (mm-string-as-unibyte (buffer-string))
2937                              body content)))
2938                    (erase-buffer)
2939                    (mm-disable-multibyte)
2940                    (insert body)
2941                    (when charset
2942                      (mm-add-meta-html-tag handle charset force-charset))
2943                    (when title
2944                      (goto-char (point-min))
2945                      (unless (search-forward "<title>" nil t)
2946                        (re-search-forward "<head>\\s-*" nil t)
2947                        (insert "<title>" title "</title>\n")))
2948                    (goto-char (point-min))
2949                    (or (re-search-forward
2950                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
2951                        (re-search-forward
2952                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
2953                    (insert eheader)
2954                    (mm-write-region (point-min) (point-max)
2955                                     tmp-file nil nil nil 'binary t))))
2956               (charset
2957                (mm-with-unibyte-buffer
2958                  (insert (if (eq charset 'gnus-decoded)
2959                              (mm-encode-coding-string content
2960                                                       (setq charset 'utf-8))
2961                            content))
2962                  (if (or (mm-add-meta-html-tag handle charset)
2963                          (not file))
2964                      (mm-write-region (point-min) (point-max)
2965                                       tmp-file nil nil nil 'binary t)
2966                    (setq tmp-file nil))))
2967               (tmp-file
2968                (mm-save-part-to-file handle tmp-file)))
2969              (when tmp-file
2970                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
2971              (add-hook 'gnus-summary-prepare-exit-hook
2972                        'gnus-article-browse-delete-temp-files)
2973              (add-hook 'gnus-exit-gnus-hook
2974                        (lambda  ()
2975                          (gnus-article-browse-delete-temp-files t)))
2976              ;; FIXME: Warn if there's an <img> tag?
2977              (browse-url-of-file (or tmp-file (expand-file-name file)))
2978              (setq showed t))
2979             ;; If multipart, recurse
2980             ((equal (mm-handle-media-supertype handle) "multipart")
2981              (when (gnus-article-browse-html-parts handle header)
2982                (setq showed t)))
2983             ((equal (mm-handle-media-type handle) "message/rfc822")
2984              (mm-with-multibyte-buffer
2985                (mm-insert-part handle)
2986                (setq handle (mm-dissect-buffer t t))
2987                (when (and (bufferp (car handle))
2988                           (stringp (car (mm-handle-type handle))))
2989                  (setq handle (list handle)))
2990                (when header
2991                  (article-decode-encoded-words)
2992                  (let ((gnus-visible-headers
2993                         (or (get 'gnus-visible-headers 'standard-value)
2994                             gnus-visible-headers)))
2995                    (article-hide-headers))
2996                  (goto-char (point-min))
2997                  (search-forward "\n\n" nil 'move)
2998                  (skip-chars-backward "\t\n ")
2999                  (setq header (buffer-substring (point-min) (point)))))
3000              (when (prog1
3001                        (gnus-article-browse-html-parts handle header)
3002                      (mm-destroy-parts handle))
3003                (setq showed t)))))
3004     showed))
3005
3006 (defun gnus-article-browse-html-article (&optional arg)
3007   "View \"text/html\" parts of the current article with a WWW browser.
3008 Inline images embedded in a message using the cid scheme, as they are
3009 generally considered to be safe, will be processed properly.
3010 The message header is added to the beginning of every html part unless
3011 the prefix argument ARG is given.
3012
3013 Warning: Spammers use links to images (using the http scheme) in HTML
3014 articles to verify whether you have read the message.  As
3015 `gnus-article-browse-html-article' passes the HTML content to the
3016 browser without eliminating these \"web bugs\" you should only
3017 use it for mails from trusted senders.
3018
3019 If you always want to display HTML parts in the browser, set
3020 `mm-text-html-renderer' to nil.
3021
3022 This command creates temporary files to pass HTML contents including
3023 images if any to the browser, and deletes them when exiting the group
3024 \(if you want)."
3025   ;; Cf. `mm-w3m-safe-url-regexp'
3026   (interactive "P")
3027   (if arg
3028       (gnus-summary-show-article)
3029     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3030                                     gnus-visible-headers))
3031           ;; As we insert a <hr>, there's no need for the body boundary.
3032           (gnus-treat-body-boundary nil))
3033       (gnus-summary-show-article)))
3034   (with-current-buffer gnus-article-buffer
3035     (let ((header (unless arg
3036                     (save-restriction
3037                       (widen)
3038                       (buffer-substring-no-properties
3039                        (goto-char (point-min))
3040                        (if (search-forward "\n\n" nil t)
3041                            (match-beginning 0)
3042                          (goto-char (point-max))
3043                          (skip-chars-backward "\t\n ")
3044                          (point))))))
3045           parts)
3046       (set-buffer gnus-original-article-buffer)
3047       (setq parts (mm-dissect-buffer t t))
3048       ;; If singlepart, enforce a list.
3049       (when (and (bufferp (car parts))
3050                  (stringp (car (mm-handle-type parts))))
3051         (setq parts (list parts)))
3052       ;; Process the list
3053       (unless (gnus-article-browse-html-parts parts header)
3054         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3055       (mm-destroy-parts parts)
3056       (unless arg
3057         (gnus-summary-show-article)))))
3058
3059 (defun article-hide-list-identifiers ()
3060   "Remove list identifies from the Subject header.
3061 The `gnus-list-identifiers' variable specifies what to do."
3062   (interactive)
3063   (let ((inhibit-point-motion-hooks t)
3064         (regexp (if (consp gnus-list-identifiers)
3065                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3066                   gnus-list-identifiers))
3067         (inhibit-read-only t))
3068     (when regexp
3069       (save-excursion
3070         (save-restriction
3071           (article-narrow-to-head)
3072           (goto-char (point-min))
3073           (while (re-search-forward
3074                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3075                   nil t)
3076             (delete-region (match-beginning 2) (match-end 0))
3077             (beginning-of-line))
3078           (when (re-search-forward
3079                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3080             (delete-region (match-beginning 1) (match-end 1))))))))
3081
3082 (defun article-hide-pem (&optional arg)
3083   "Toggle hiding of any PEM headers and signatures in the current article.
3084 If given a negative prefix, always show; if given a positive prefix,
3085 always hide."
3086   (interactive (gnus-article-hidden-arg))
3087   (unless (gnus-article-check-hidden-text 'pem arg)
3088     (save-excursion
3089       (let ((inhibit-read-only t) end)
3090         (goto-char (point-min))
3091         ;; Hide the horrendously ugly "header".
3092         (when (and (search-forward
3093                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3094                     nil t)
3095                    (setq end (1+ (match-beginning 0))))
3096           (gnus-add-wash-type 'pem)
3097           (gnus-article-hide-text-type
3098            end
3099            (if (search-forward "\n\n" nil t)
3100                (match-end 0)
3101              (point-max))
3102            'pem)
3103           ;; Hide the trailer as well
3104           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3105                                 nil t)
3106             (gnus-article-hide-text-type
3107              (match-beginning 0) (match-end 0) 'pem)))))))
3108
3109 (defun article-strip-banner ()
3110   "Strip the banners specified by the `banner' group parameter and by
3111 `gnus-article-address-banner-alist'."
3112   (interactive)
3113   (save-excursion
3114     (save-restriction
3115       (let ((inhibit-point-motion-hooks t))
3116         (when (gnus-parameter-banner gnus-newsgroup-name)
3117           (article-really-strip-banner
3118            (gnus-parameter-banner gnus-newsgroup-name)))
3119         (when gnus-article-address-banner-alist
3120           ;; Note that the From header is decoded here, so it is
3121           ;; required that the *-extract-address-components function
3122           ;; supports non-ASCII text.
3123           (let ((from (save-restriction
3124                         (widen)
3125                         (article-narrow-to-head)
3126                         (mail-fetch-field "from"))))
3127             (when (and from
3128                        (setq from
3129                              (cadr (funcall gnus-extract-address-components
3130                                             from))))
3131               (catch 'found
3132                 (dolist (pair gnus-article-address-banner-alist)
3133                   (when (string-match (car pair) from)
3134                     (throw 'found
3135                            (article-really-strip-banner (cdr pair)))))))))))))
3136
3137 (defun article-really-strip-banner (banner)
3138   "Strip the banner specified by the argument."
3139   (save-excursion
3140     (save-restriction
3141       (let ((inhibit-point-motion-hooks t)
3142             (gnus-signature-limit nil)
3143             (inhibit-read-only t))
3144         (article-goto-body)
3145         (cond
3146          ((eq banner 'signature)
3147           (when (gnus-article-narrow-to-signature)
3148             (widen)
3149             (forward-line -1)
3150             (delete-region (point) (point-max))))
3151          ((symbolp banner)
3152           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3153               (while (re-search-forward banner nil t)
3154                 (delete-region (match-beginning 0) (match-end 0)))))
3155          ((stringp banner)
3156           (while (re-search-forward banner nil t)
3157             (delete-region (match-beginning 0) (match-end 0)))))))))
3158
3159 (defun article-babel ()
3160   "Translate article using an online translation service."
3161   (interactive)
3162   (require 'babel)
3163   (gnus-with-article-buffer
3164     (when (article-goto-body)
3165       (let* ((start (point))
3166              (end (point-max))
3167              (orig (buffer-substring start end))
3168              (trans (babel-as-string orig)))
3169         (save-restriction
3170           (narrow-to-region start end)
3171           (delete-region start end)
3172           (insert trans))))))
3173
3174 (defun article-hide-signature (&optional arg)
3175   "Hide the signature in the current article.
3176 If given a negative prefix, always show; if given a positive prefix,
3177 always hide."
3178   (interactive (gnus-article-hidden-arg))
3179   (unless (gnus-article-check-hidden-text 'signature arg)
3180     (save-excursion
3181       (save-restriction
3182         (let ((inhibit-read-only t))
3183           (when (gnus-article-narrow-to-signature)
3184             (gnus-article-hide-text-type
3185              (point-min) (point-max) 'signature))))))
3186   (gnus-set-mode-line 'article))
3187
3188 (defun article-strip-headers-in-body ()
3189   "Strip offensive headers from bodies."
3190   (interactive)
3191   (save-excursion
3192     (article-goto-body)
3193     (let ((case-fold-search t))
3194       (when (looking-at "x-no-archive:")
3195         (gnus-delete-line)))))
3196
3197 (defun article-strip-leading-blank-lines ()
3198   "Remove all blank lines from the beginning of the article."
3199   (interactive)
3200   (save-excursion
3201     (let ((inhibit-point-motion-hooks t)
3202           (inhibit-read-only t))
3203       (when (article-goto-body)
3204         (while (and (not (eobp))
3205                     (looking-at "[ \t]*$"))
3206           (gnus-delete-line))))))
3207
3208 (defun article-narrow-to-head ()
3209   "Narrow the buffer to the head of the message.
3210 Point is left at the beginning of the narrowed-to region."
3211   (narrow-to-region
3212    (goto-char (point-min))
3213    (if (search-forward "\n\n" nil 1)
3214        (1- (point))
3215      (point-max)))
3216   (goto-char (point-min)))
3217
3218 (defun article-goto-body ()
3219   "Place point at the start of the body."
3220   (goto-char (point-min))
3221   (cond
3222    ;; This variable is only bound when dealing with separate
3223    ;; MIME body parts.
3224    (article-goto-body-goes-to-point-min-p
3225     t)
3226    ((search-forward "\n\n" nil t)
3227     t)
3228    (t
3229     (goto-char (point-max))
3230     nil)))
3231
3232 (defun article-strip-multiple-blank-lines ()
3233   "Replace consecutive blank lines with one empty line."
3234   (interactive)
3235   (save-excursion
3236     (let ((inhibit-point-motion-hooks t)
3237           (inhibit-read-only t))
3238       ;; First make all blank lines empty.
3239       (article-goto-body)
3240       (while (re-search-forward "^[ \t]+$" nil t)
3241         (unless (gnus-annotation-in-region-p
3242                  (match-beginning 0) (match-end 0))
3243           (replace-match "" nil t)))
3244       ;; Then replace multiple empty lines with a single empty line.
3245       (article-goto-body)
3246       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3247         (unless (gnus-annotation-in-region-p
3248                  (match-beginning 0) (match-end 0))
3249           (delete-region (match-beginning 1) (match-end 1)))))))
3250
3251 (defun article-strip-leading-space ()
3252   "Remove all white space from the beginning of the lines in the article."
3253   (interactive)
3254   (save-excursion
3255     (let ((inhibit-point-motion-hooks t)
3256           (inhibit-read-only t))
3257       (article-goto-body)
3258       (while (re-search-forward "^[ \t]+" nil t)
3259         (replace-match "" t t)))))
3260
3261 (defun article-strip-trailing-space ()
3262   "Remove all white space from the end of the lines in the article."
3263   (interactive)
3264   (save-excursion
3265     (let ((inhibit-point-motion-hooks t)
3266           (inhibit-read-only t))
3267       (article-goto-body)
3268       (while (re-search-forward "[ \t]+$" nil t)
3269         (replace-match "" t t)))))
3270
3271 (defun article-strip-blank-lines ()
3272   "Strip leading, trailing and multiple blank lines."
3273   (interactive)
3274   (article-strip-leading-blank-lines)
3275   (article-remove-trailing-blank-lines)
3276   (article-strip-multiple-blank-lines))
3277
3278 (defun article-strip-all-blank-lines ()
3279   "Strip all blank lines."
3280   (interactive)
3281   (save-excursion
3282     (let ((inhibit-point-motion-hooks t)
3283           (inhibit-read-only t))
3284       (article-goto-body)
3285       (while (re-search-forward "^[ \t]*\n" nil t)
3286         (replace-match "" t t)))))
3287
3288 (defun gnus-article-narrow-to-signature ()
3289   "Narrow to the signature; return t if a signature is found, else nil."
3290   (let ((inhibit-point-motion-hooks t))
3291     (when (gnus-article-search-signature)
3292       (forward-line 1)
3293       ;; Check whether we have some limits to what we consider
3294       ;; to be a signature.
3295       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3296                       (list gnus-signature-limit)))
3297             limit limited)
3298         (while (setq limit (pop limits))
3299           (if (or (and (integerp limit)
3300                        (< (- (point-max) (point)) limit))
3301                   (and (floatp limit)
3302                        (< (count-lines (point) (point-max)) limit))
3303                   (and (functionp limit)
3304                        (funcall limit))
3305                   (and (stringp limit)
3306                        (not (re-search-forward limit nil t))))
3307               ()                        ; This limit did not succeed.
3308             (setq limited t
3309                   limits nil)))
3310         (unless limited
3311           (narrow-to-region (point) (point-max))
3312           t)))))
3313
3314 (defun gnus-article-search-signature ()
3315   "Search the current buffer for the signature separator.
3316 Put point at the beginning of the signature separator."
3317   (let ((cur (point)))
3318     (goto-char (point-max))
3319     (if (if (stringp gnus-signature-separator)
3320             (re-search-backward gnus-signature-separator nil t)
3321           (let ((seps gnus-signature-separator))
3322             (while (and seps
3323                         (not (re-search-backward (car seps) nil t)))
3324               (pop seps))
3325             seps))
3326         t
3327       (goto-char cur)
3328       nil)))
3329
3330 (defun gnus-article-hidden-arg ()
3331   "Return the current prefix arg as a number, or 0 if no prefix."
3332   (list (if current-prefix-arg
3333             (prefix-numeric-value current-prefix-arg)
3334           0)))
3335
3336 (defun gnus-article-check-hidden-text (type arg)
3337   "Return nil if hiding is necessary.
3338 Arg can be nil or a number.  nil and positive means hide, negative
3339 means show, 0 means toggle."
3340   (save-excursion
3341     (save-restriction
3342       (let ((hide (gnus-article-hidden-text-p type)))
3343         (cond
3344          ((or (null arg)
3345               (> arg 0))
3346           nil)
3347          ((< arg 0)
3348           (gnus-article-show-hidden-text type)
3349           t)
3350          (t
3351           (if (eq hide 'hidden)
3352               (progn
3353                 (gnus-article-show-hidden-text type)
3354                 t)
3355             nil)))))))
3356
3357 (defun gnus-article-hidden-text-p (type)
3358   "Say whether the current buffer contains hidden text of type TYPE."
3359   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3360     (while (and pos
3361                 (not (get-text-property pos 'invisible))
3362                 (not (get-text-property pos 'dummy-invisible)))
3363       (setq pos
3364             (text-property-any (1+ pos) (point-max) 'article-type type)))
3365     (if pos
3366         'hidden
3367       nil)))
3368
3369 (defun gnus-article-show-hidden-text (type &optional dummy)
3370   "Show all hidden text of type TYPE.
3371 Originally it is hide instead of DUMMY."
3372   (let ((inhibit-read-only t)
3373         (inhibit-point-motion-hooks t))
3374     (gnus-remove-text-properties-when
3375      'article-type type
3376      (point-min) (point-max)
3377      (cons 'article-type (cons type
3378                                gnus-hidden-properties)))
3379     (gnus-delete-wash-type type)))
3380
3381 (defconst article-time-units
3382   `((year . ,(* 365.25 24 60 60))
3383     (week . ,(* 7 24 60 60))
3384     (day . ,(* 24 60 60))
3385     (hour . ,(* 60 60))
3386     (minute . 60)
3387     (second . 1))
3388   "Mapping from time units to seconds.")
3389
3390 (defun gnus-article-forward-header ()
3391   "Move point to the start of the next header.
3392 If the current header is a continuation header, this can be several
3393 lines forward."
3394   (let ((ended nil))
3395     (while (not ended)
3396       (forward-line 1)
3397       (if (looking-at "[ \t]+[^ \t]")
3398           (forward-line 1)
3399         (setq ended t)))))
3400
3401 (defun article-date-ut (&optional type highlight)
3402   "Convert DATE date to universal time in the current article.
3403 If TYPE is `local', convert to local time; if it is `lapsed', output
3404 how much time has lapsed since DATE.  For `lapsed', the value of
3405 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3406 should replace the \"Date:\" one, or should be added below it."
3407   (interactive (list 'ut t))
3408   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3409          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3410                              tdate-regexp)
3411                             ((eq type 'lapsed)
3412                              "^X-Sent:[ \t]")
3413                             (article-lapsed-timer
3414                              "^Date:[ \t]")
3415                             (t
3416                              tdate-regexp)))
3417          (case-fold-search t)
3418          (inhibit-read-only t)
3419          (inhibit-point-motion-hooks t)
3420          pos date bface eface)
3421     (save-excursion
3422       (save-restriction
3423         (widen)
3424         (goto-char (point-min))
3425         (while (or (setq date (get-text-property (setq pos (point))
3426                                                  'original-date))
3427                    (when (setq pos (next-single-property-change
3428                                     (point) 'original-date))
3429                      (setq date (get-text-property pos 'original-date))
3430                      t))
3431           (narrow-to-region
3432            pos (if (setq pos (text-property-any pos (point-max)
3433                                                 'original-date nil))
3434                    (progn
3435                      (goto-char pos)
3436                      (if (or (bolp) (eobp))
3437                          (point)
3438                        (1+ (point))))
3439                  (point-max)))
3440           (goto-char (point-min))
3441           (when (re-search-forward tdate-regexp nil t)
3442             (setq bface (get-text-property (point-at-bol) 'face)
3443                   eface (get-text-property (1- (point-at-eol)) 'face)))
3444           (goto-char (point-min))
3445           (setq pos nil)
3446           ;; Delete any old Date headers.
3447           (while (re-search-forward date-regexp nil t)
3448             (if pos
3449                 (delete-region (point-at-bol) (progn
3450                                                 (gnus-article-forward-header)
3451                                                 (point)))
3452               (delete-region (point-at-bol) (progn
3453                                               (gnus-article-forward-header)
3454                                               (forward-char -1)
3455                                               (point)))
3456               (setq pos (point))))
3457           (when (and (not pos)
3458                      (re-search-forward tdate-regexp nil t))
3459             (forward-line 1))
3460           (gnus-goto-char pos)
3461           (insert (article-make-date-line date (or type 'ut)))
3462           (unless pos
3463             (insert "\n")
3464             (forward-line -1))
3465           ;; Do highlighting.
3466           (beginning-of-line)
3467           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3468             (put-text-property (match-beginning 1) (1+ (match-end 1))
3469                                'face bface)
3470             (put-text-property (match-beginning 2) (match-end 2)
3471                                'face eface))
3472           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3473           (goto-char (point-max))
3474           (widen))))))
3475
3476 (defun article-make-date-line (date type)
3477   "Return a DATE line of TYPE."
3478   (unless (memq type '(local ut original user iso8601 lapsed english))
3479     (error "Unknown conversion type: %s" type))
3480   (condition-case ()
3481       (let ((time (date-to-time date)))
3482         (cond
3483          ;; Convert to the local timezone.
3484          ((eq type 'local)
3485           (concat "Date: " (message-make-date time)))
3486          ;; Convert to Universal Time.
3487          ((eq type 'ut)
3488           (concat "Date: "
3489                   (substring
3490                    (message-make-date
3491                     (let* ((e (parse-time-string date))
3492                            (tm (apply 'encode-time e))
3493                            (ms (car tm))
3494                            (ls (- (cadr tm) (car (current-time-zone time)))))
3495                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3496                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3497                             (t (list ms ls)))))
3498                    0 -5)
3499                   "UT"))
3500          ;; Get the original date from the article.
3501          ((eq type 'original)
3502           (concat "Date: " (if (string-match "\n+$" date)
3503                                (substring date 0 (match-beginning 0))
3504                              date)))
3505          ;; Let the user define the format.
3506          ((eq type 'user)
3507           (let ((format (or (condition-case nil
3508                                 (with-current-buffer gnus-summary-buffer
3509                                   gnus-article-time-format)
3510                               (error nil))
3511                             gnus-article-time-format)))
3512             (if (functionp format)
3513                 (funcall format time)
3514               (concat "Date: " (format-time-string format time)))))
3515          ;; ISO 8601.
3516          ((eq type 'iso8601)
3517           (let ((tz (car (current-time-zone time))))
3518             (concat
3519              "Date: "
3520              (format-time-string "%Y%m%dT%H%M%S" time)
3521              (format "%s%02d%02d"
3522                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3523                      (/ (% (abs tz) 3600) 60)))))
3524          ;; Do an X-Sent lapsed format.
3525          ((eq type 'lapsed)
3526           ;; If the date is seriously mangled, the timezone functions are
3527           ;; liable to bug out, so we ignore all errors.
3528           (let* ((now (current-time))
3529                  (real-time (subtract-time now time))
3530                  (real-sec (and real-time
3531                                 (+ (* (float (car real-time)) 65536)
3532                                    (cadr real-time))))
3533                  (sec (and real-time (abs real-sec)))
3534                  num prev)
3535             (cond
3536              ((null real-time)
3537               "X-Sent: Unknown")
3538              ((zerop sec)
3539               "X-Sent: Now")
3540              (t
3541               (concat
3542                "X-Sent: "
3543                ;; This is a bit convoluted, but basically we go
3544                ;; through the time units for years, weeks, etc,
3545                ;; and divide things to see whether that results
3546                ;; in positive answers.
3547                (mapconcat
3548                 (lambda (unit)
3549                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3550                       ;; The (remaining) seconds are too few to
3551                       ;; be divided into this time unit.
3552                       ""
3553                     ;; It's big enough, so we output it.
3554                     (setq sec (- sec (* num (cdr unit))))
3555                     (prog1
3556                         (concat (if prev ", " "") (int-to-string
3557                                                    (floor num))
3558                                 " " (symbol-name (car unit))
3559                                 (if (> num 1) "s" ""))
3560                       (setq prev t))))
3561                 article-time-units "")
3562                ;; If dates are odd, then it might appear like the
3563                ;; article was sent in the future.
3564                (if (> real-sec 0)
3565                    " ago"
3566                  " in the future"))))))
3567          ;; Display the date in proper English
3568          ((eq type 'english)
3569           (let ((dtime (decode-time time)))
3570             (concat
3571              "Date: the "
3572              (number-to-string (nth 3 dtime))
3573              (let ((digit (% (nth 3 dtime) 10)))
3574                (cond
3575                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3576                 ((= digit 1) "st")
3577                 ((= digit 2) "nd")
3578                 ((= digit 3) "rd")
3579                 (t "th")))
3580              " of "
3581              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3582              " "
3583              (number-to-string (nth 5 dtime))
3584              " at "
3585              (format "%02d" (nth 2 dtime))
3586              ":"
3587              (format "%02d" (nth 1 dtime)))))))
3588     (error
3589      (format "Date: %s (from Gnus)" date))))
3590
3591 (defun article-date-local (&optional highlight)
3592   "Convert the current article date to the local timezone."
3593   (interactive (list t))
3594   (article-date-ut 'local highlight))
3595
3596 (defun article-date-english (&optional highlight)
3597   "Convert the current article date to something that is proper English."
3598   (interactive (list t))
3599   (article-date-ut 'english highlight))
3600
3601 (defun article-date-original (&optional highlight)
3602   "Convert the current article date to what it was originally.
3603 This is only useful if you have used some other date conversion
3604 function and want to see what the date was before converting."
3605   (interactive (list t))
3606   (article-date-ut 'original highlight))
3607
3608 (defun article-date-lapsed (&optional highlight)
3609   "Convert the current article date to time lapsed since it was sent."
3610   (interactive (list t))
3611   (article-date-ut 'lapsed highlight))
3612
3613 (defun article-update-date-lapsed ()
3614   "Function to be run from a timer to update the lapsed time line."
3615   (save-match-data
3616     (let (deactivate-mark)
3617       (save-excursion
3618         (ignore-errors
3619          (walk-windows
3620           (lambda (w)
3621             (set-buffer (window-buffer w))
3622             (when (eq major-mode 'gnus-article-mode)
3623               (let ((mark (point-marker)))
3624                 (goto-char (point-min))
3625                 (when (re-search-forward "^X-Sent:" nil t)
3626                   (article-date-lapsed t))
3627                 (goto-char (marker-position mark))
3628                 (move-marker mark nil))))
3629           nil 'visible))))))
3630
3631 (defun gnus-start-date-timer (&optional n)
3632   "Start a timer to update the X-Sent header in the article buffers.
3633 The numerical prefix says how frequently (in seconds) the function
3634 is to run."
3635   (interactive "p")
3636   (unless n
3637     (setq n 1))
3638   (gnus-stop-date-timer)
3639   (setq article-lapsed-timer
3640         (run-at-time 1 n 'article-update-date-lapsed)))
3641
3642 (defun gnus-stop-date-timer ()
3643   "Stop the X-Sent timer."
3644   (interactive)
3645   (when article-lapsed-timer
3646     (nnheader-cancel-timer article-lapsed-timer)
3647     (setq article-lapsed-timer nil)))
3648
3649 (defun article-date-user (&optional highlight)
3650   "Convert the current article date to the user-defined format.
3651 This format is defined by the `gnus-article-time-format' variable."
3652   (interactive (list t))
3653   (article-date-ut 'user highlight))
3654
3655 (defun article-date-iso8601 (&optional highlight)
3656   "Convert the current article date to ISO8601."
3657   (interactive (list t))
3658   (article-date-ut 'iso8601 highlight))
3659
3660 (defmacro gnus-article-save-original-date (&rest forms)
3661   "Save the original date as a text property and evaluate FORMS."
3662   `(let* ((case-fold-search t)
3663           (start (progn
3664                    (goto-char (point-min))
3665                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3666                               (not (bolp)))
3667                      (match-end 0))))
3668           (date (when (and start
3669                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3670                                               nil t))
3671                   (buffer-substring-no-properties start
3672                                                   (match-beginning 0)))))
3673      (goto-char (point-max))
3674      (skip-chars-backward "\n")
3675      (put-text-property (point-min) (point) 'original-date date)
3676      ,@forms
3677      (goto-char (point-max))
3678      (skip-chars-backward "\n")
3679      (put-text-property (point-min) (point) 'original-date date)))
3680
3681 ;; (defun article-show-all ()
3682 ;;   "Show all hidden text in the article buffer."
3683 ;;   (interactive)
3684 ;;   (save-excursion
3685 ;;     (let ((inhibit-read-only t))
3686 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3687
3688 (defun article-remove-leading-whitespace ()
3689   "Remove excessive whitespace from all headers."
3690   (interactive)
3691   (save-excursion
3692     (save-restriction
3693       (let ((inhibit-read-only t))
3694         (article-narrow-to-head)
3695         (goto-char (point-min))
3696         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3697           (delete-region (match-beginning 1) (match-end 1)))))))
3698
3699 (defun article-emphasize (&optional arg)
3700   "Emphasize text according to `gnus-emphasis-alist'."
3701   (interactive (gnus-article-hidden-arg))
3702   (unless (gnus-article-check-hidden-text 'emphasis arg)
3703     (save-excursion
3704       (let ((alist (or
3705                     (condition-case nil
3706                         (with-current-buffer gnus-summary-buffer
3707                           gnus-article-emphasis-alist)
3708                       (error))
3709                     gnus-emphasis-alist))
3710             (inhibit-read-only t)
3711             (props (append '(article-type emphasis)
3712                            gnus-hidden-properties))
3713             regexp elem beg invisible visible face)
3714         (article-goto-body)
3715         (setq beg (point))
3716         (while (setq elem (pop alist))
3717           (goto-char beg)
3718           (setq regexp (car elem)
3719                 invisible (nth 1 elem)
3720                 visible (nth 2 elem)
3721                 face (nth 3 elem))
3722           (while (re-search-forward regexp nil t)
3723             (when (and (match-beginning visible) (match-beginning invisible))
3724               (gnus-article-hide-text
3725                (match-beginning invisible) (match-end invisible) props)
3726               (gnus-article-unhide-text-type
3727                (match-beginning visible) (match-end visible) 'emphasis)
3728               (gnus-put-overlay-excluding-newlines
3729                (match-beginning visible) (match-end visible) 'face face)
3730               (gnus-add-wash-type 'emphasis)
3731               (goto-char (match-end invisible)))))))))
3732
3733 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3734   "Setup newsgroup emphasis alist."
3735   (unless gnus-article-emphasis-alist
3736     (let ((name (and gnus-newsgroup-name
3737                      (gnus-group-real-name gnus-newsgroup-name))))
3738       (make-local-variable 'gnus-article-emphasis-alist)
3739       (setq gnus-article-emphasis-alist
3740             (nconc
3741              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3742                (while (setq elem (pop alist))
3743                  (when (and name (string-match (car elem) name))
3744                    (setq alist nil
3745                          highlight (copy-sequence (cdr elem)))))
3746                highlight)
3747              (copy-sequence highlight-words)
3748              (if gnus-newsgroup-name
3749                  (copy-sequence (gnus-group-find-parameter
3750                                  gnus-newsgroup-name 'highlight-words t)))
3751              gnus-emphasis-alist)))))
3752
3753 (defvar gnus-summary-article-menu)
3754 (defvar gnus-summary-post-menu)
3755
3756 ;;; Saving functions.
3757
3758 (defun gnus-article-save (save-buffer file &optional num)
3759   "Save the currently selected article."
3760   (when (or (get gnus-default-article-saver :headers)
3761             (not gnus-save-all-headers))
3762     ;; Remove headers according to `gnus-saved-headers' or the value
3763     ;; of the `:headers' property that the saver function might have.
3764     (let ((gnus-visible-headers
3765            (or (symbol-value (get gnus-default-article-saver :headers))
3766                gnus-saved-headers gnus-visible-headers))
3767           ;; Ignore group parameter.  See `article-hide-headers'.
3768           (gnus-summary-buffer nil))
3769       (with-current-buffer save-buffer
3770         (article-hide-headers 1 t))))
3771   (save-window-excursion
3772     (if (not gnus-default-article-saver)
3773         (error "No default saver is defined")
3774       ;; !!! Magic!  The saving functions all save
3775       ;; `gnus-save-article-buffer' (or so they think), but we
3776       ;; bind that variable to our save-buffer.
3777       (set-buffer gnus-article-buffer)
3778       (let* ((gnus-save-article-buffer save-buffer)
3779              (filename
3780               (cond
3781                ((not gnus-prompt-before-saving) 'default)
3782                ((eq gnus-prompt-before-saving 'always) nil)
3783                (t file)))
3784              (gnus-number-of-articles-to-be-saved
3785               (when (eq gnus-prompt-before-saving t)
3786                 num)))                  ; Magic
3787         (set-buffer gnus-article-current-summary)
3788         (funcall gnus-default-article-saver filename)))))
3789
3790 (defun gnus-read-save-file-name (prompt &optional filename
3791                                         function group headers variable
3792                                         dir-var)
3793   (let ((default-name
3794           (funcall function group headers (symbol-value variable)))
3795         result)
3796     (setq result
3797           (expand-file-name
3798            (cond
3799             ((eq filename 'default)
3800              default-name)
3801             ((eq filename t)
3802              default-name)
3803             (filename filename)
3804             (t
3805              (when (symbol-value dir-var)
3806                (setq default-name (expand-file-name
3807                                    (file-name-nondirectory default-name)
3808                                    (symbol-value dir-var))))
3809              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3810                     (prompt
3811                      (format prompt
3812                              (if (and gnus-number-of-articles-to-be-saved
3813                                       (> gnus-number-of-articles-to-be-saved 1))
3814                                  (format "these %d articles"
3815                                          gnus-number-of-articles-to-be-saved)
3816                                "this article")))
3817                     (file
3818                      ;; Let the split methods have their say.
3819                      (cond
3820                       ;; No split name was found.
3821                       ((null split-name)
3822                        (read-file-name
3823                         (concat prompt " (default "
3824                                 (file-name-nondirectory default-name) "): ")
3825                         (file-name-directory default-name)
3826                         default-name))
3827                       ;; A single group name is returned.
3828                       ((stringp split-name)
3829                        (setq default-name
3830                              (funcall function split-name headers
3831                                       (symbol-value variable)))
3832                        (read-file-name
3833                         (concat prompt " (default "
3834                                 (file-name-nondirectory default-name) "): ")
3835                         (file-name-directory default-name)
3836                         default-name))
3837                       ;; A single split name was found
3838                       ((= 1 (length split-name))
3839                        (let* ((name (expand-file-name
3840                                      (car split-name)
3841                                      gnus-article-save-directory))
3842                               (dir (cond ((file-directory-p name)
3843                                           (file-name-as-directory name))
3844                                          ((file-exists-p name) name)
3845                                          (t gnus-article-save-directory))))
3846                          (read-file-name
3847                           (concat prompt " (default " name "): ")
3848                           dir name)))
3849                       ;; A list of splits was found.
3850                       (t
3851                        (setq split-name (nreverse split-name))
3852                        (let (result)
3853                          (let ((file-name-history
3854                                 (nconc split-name file-name-history)))
3855                            (setq result
3856                                  (expand-file-name
3857                                   (read-file-name
3858                                    (concat prompt " (`M-p' for defaults): ")
3859                                    gnus-article-save-directory
3860                                    (car split-name))
3861                                   gnus-article-save-directory)))
3862                          (car (push result file-name-history)))))))
3863                ;; Create the directory.
3864                (gnus-make-directory (file-name-directory file))
3865                ;; If we have read a directory, we append the default file name.
3866                (when (file-directory-p file)
3867                  (setq file (expand-file-name (file-name-nondirectory
3868                                                default-name)
3869                                               (file-name-as-directory file))))
3870                ;; Possibly translate some characters.
3871                (nnheader-translate-file-chars file))))))
3872     (gnus-make-directory (file-name-directory result))
3873     (when variable
3874       (set variable result))
3875     (when dir-var
3876       (set dir-var (file-name-directory result)))
3877     result))
3878
3879 (defun gnus-article-archive-name (group)
3880   "Return the first instance of an \"Archive-name\" in the current buffer."
3881   (let ((case-fold-search t))
3882     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3883       (nnheader-concat gnus-article-save-directory
3884                        (match-string 1)))))
3885
3886 (defun gnus-article-nndoc-name (group)
3887   "If GROUP is an nndoc group, return the name of the parent group."
3888   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3889     (gnus-group-get-parameter group 'save-article-group)))
3890
3891 (defun gnus-summary-save-in-rmail (&optional filename)
3892   "Append this article to Rmail file.
3893 Optional argument FILENAME specifies file name.
3894 Directory to save to is default to `gnus-article-save-directory'."
3895   (setq filename (gnus-read-save-file-name
3896                   "Save %s in rmail file" filename
3897                   gnus-rmail-save-name gnus-newsgroup-name
3898                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3899   (with-current-buffer gnus-save-article-buffer
3900     (save-excursion
3901       (save-restriction
3902         (widen)
3903         ;; Note that unlike gnus-summary-save-in-mail, there is no
3904         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3905         ;; not use Babyl.
3906         (gnus-output-to-rmail filename))))
3907   filename)
3908
3909 (defun gnus-summary-save-in-mail (&optional filename)
3910   "Append this article to Unix mail file.
3911 Optional argument FILENAME specifies file name.
3912 Directory to save to is default to `gnus-article-save-directory'."
3913   (setq filename (gnus-read-save-file-name
3914                   "Save %s in Unix mail file" filename
3915                   gnus-mail-save-name gnus-newsgroup-name
3916                   gnus-current-headers 'gnus-newsgroup-last-mail))
3917   (with-current-buffer gnus-save-article-buffer
3918     (save-excursion
3919       (save-restriction
3920         (widen)
3921         (if (and (file-readable-p filename)
3922                  (file-regular-p filename)
3923                  (mail-file-babyl-p filename))
3924             (gnus-output-to-rmail filename)
3925           (gnus-output-to-mail filename)))))
3926   filename)
3927
3928 (put 'gnus-summary-save-in-file :decode t)
3929 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3930 (defun gnus-summary-save-in-file (&optional filename overwrite)
3931   "Append this article to file.
3932 Optional argument FILENAME specifies file name.
3933 Directory to save to is default to `gnus-article-save-directory'."
3934   (setq filename (gnus-read-save-file-name
3935                   "Save %s in file" filename
3936                   gnus-file-save-name gnus-newsgroup-name
3937                   gnus-current-headers 'gnus-newsgroup-last-file))
3938   (with-current-buffer gnus-save-article-buffer
3939     (save-excursion
3940       (save-restriction
3941         (widen)
3942         (when (and overwrite
3943                    (file-exists-p filename))
3944           (delete-file filename))
3945         (gnus-output-to-file filename))))
3946   filename)
3947
3948 (put 'gnus-summary-write-to-file :decode t)
3949 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
3950 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
3951 (defun gnus-summary-write-to-file (&optional filename)
3952   "Write this article to a file, overwriting it if the file exists.
3953 Optional argument FILENAME specifies file name.
3954 The directory to save in defaults to `gnus-article-save-directory'."
3955   (setq filename (gnus-read-save-file-name
3956                   "Save %s in file" filename
3957                   gnus-file-save-name gnus-newsgroup-name
3958                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3959   (gnus-summary-save-in-file filename t))
3960
3961 (put 'gnus-summary-save-body-in-file :decode t)
3962 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
3963   "Append this article body to a file.
3964 Optional argument FILENAME specifies file name.
3965 The directory to save in defaults to `gnus-article-save-directory'."
3966   (setq filename (gnus-read-save-file-name
3967                   "Save %s body in file" filename
3968                   gnus-file-save-name gnus-newsgroup-name
3969                   gnus-current-headers 'gnus-newsgroup-last-file))
3970   (with-current-buffer gnus-save-article-buffer
3971     (save-excursion
3972       (save-restriction
3973         (widen)
3974         (when (article-goto-body)
3975           (narrow-to-region (point) (point-max)))
3976         (when (and overwrite
3977                    (file-exists-p filename))
3978           (delete-file filename))
3979         (gnus-output-to-file filename))))
3980   filename)
3981
3982 (put 'gnus-summary-write-body-to-file :decode t)
3983 (put 'gnus-summary-write-body-to-file
3984      :function 'gnus-summary-save-body-in-file)
3985 (defun gnus-summary-write-body-to-file (&optional filename)
3986   "Write this article body to a file, overwriting it if the file exists.
3987 Optional argument FILENAME specifies file name.
3988 The directory to save in defaults to `gnus-article-save-directory'."
3989   (setq filename (gnus-read-save-file-name
3990                   "Save %s body in file" filename
3991                   gnus-file-save-name gnus-newsgroup-name
3992                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3993   (gnus-summary-save-body-in-file filename t))
3994
3995 (put 'gnus-summary-save-in-pipe :decode t)
3996 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
3997 (defun gnus-summary-save-in-pipe (&optional command raw)
3998   "Pipe this article to subprocess COMMAND.
3999 Valid values for COMMAND include:
4000   a string
4001     The executable command name and possibly arguments.
4002   nil
4003     You will be prompted for the command in the minibuffer.
4004   the symbol `default'
4005     It will be replaced with the command which the variable
4006     `gnus-summary-pipe-output-default-command' holds or the command
4007     last used for saving.
4008 Non-nil value for RAW overrides `:decode' and `:headers' properties
4009 and the raw article including all headers will be piped."
4010   (let ((article (gnus-summary-article-number))
4011         (decode (unless raw
4012                   (get 'gnus-summary-save-in-pipe :decode)))
4013         save-buffer default)
4014     (if article
4015         (if (vectorp (gnus-summary-article-header article))
4016             (save-current-buffer
4017               (gnus-summary-select-article decode decode nil article)
4018               (insert-buffer-substring
4019                (prog1
4020                    (if decode
4021                        gnus-article-buffer
4022                      gnus-original-article-buffer)
4023                  (setq save-buffer
4024                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4025               ;; Remove unwanted headers.
4026               (when (and (not raw)
4027                          (or (get 'gnus-summary-save-in-pipe :headers)
4028                              (not gnus-save-all-headers)))
4029                 (let ((gnus-visible-headers
4030                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4031                                               :headers))
4032                            gnus-saved-headers gnus-visible-headers))
4033                       (gnus-summary-buffer nil))
4034                   (article-hide-headers 1 t))))
4035           (error "%d is not a real article" article))
4036       (error "No article to pipe"))
4037     (setq default (or gnus-summary-pipe-output-default-command
4038                       gnus-last-shell-command))
4039     (unless (stringp command)
4040       (setq command
4041             (if (and (eq command 'default) default)
4042                 default
4043               (gnus-read-shell-command "Shell command on this article: "
4044                                        default))))
4045     (when (string-equal command "")
4046       (if default
4047           (setq command default)
4048         (error "A command is required")))
4049     (with-current-buffer save-buffer
4050       (save-restriction
4051         (widen)
4052         (shell-command-on-region (point-min) (point-max) command nil)))
4053     (gnus-kill-buffer save-buffer))
4054   (setq gnus-summary-pipe-output-default-command command))
4055
4056 (defun gnus-summary-pipe-to-muttprint (&optional command)
4057   "Pipe this article to muttprint."
4058   (unless (stringp command)
4059     (setq command (read-string
4060                    "Print using command: " gnus-summary-muttprint-program
4061                    nil gnus-summary-muttprint-program)))
4062   (let ((gnus-summary-pipe-output-default-command
4063          gnus-summary-pipe-output-default-command))
4064     (gnus-summary-save-in-pipe command))
4065   (setq gnus-summary-muttprint-program command))
4066
4067 ;;; Article file names when saving.
4068
4069 (defun gnus-capitalize-newsgroup (newsgroup)
4070   "Capitalize NEWSGROUP name."
4071   (when (not (zerop (length newsgroup)))
4072     (concat (char-to-string (upcase (aref newsgroup 0)))
4073             (substring newsgroup 1))))
4074
4075 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4076   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4077 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4078 Otherwise, it is like ~/News/news/group/num."
4079   (let ((default
4080           (expand-file-name
4081            (concat (if (gnus-use-long-file-name 'not-save)
4082                        (gnus-capitalize-newsgroup newsgroup)
4083                      (gnus-newsgroup-directory-form newsgroup))
4084                    "/" (int-to-string (mail-header-number headers)))
4085            gnus-article-save-directory)))
4086     (if (and last-file
4087              (string-equal (file-name-directory default)
4088                            (file-name-directory last-file))
4089              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4090         default
4091       (or last-file default))))
4092
4093 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4094   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4095 If variable `gnus-use-long-file-name' is non-nil, it is
4096 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4097   (let ((default
4098           (expand-file-name
4099            (concat (if (gnus-use-long-file-name 'not-save)
4100                        newsgroup
4101                      (gnus-newsgroup-directory-form newsgroup))
4102                    "/" (int-to-string (mail-header-number headers)))
4103            gnus-article-save-directory)))
4104     (if (and last-file
4105              (string-equal (file-name-directory default)
4106                            (file-name-directory last-file))
4107              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4108         default
4109       (or last-file default))))
4110
4111 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4112   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4113 If variable `gnus-use-long-file-name' is non-nil, it is
4114 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4115   (or last-file
4116       (expand-file-name
4117        (if (gnus-use-long-file-name 'not-save)
4118            newsgroup
4119          (file-relative-name
4120           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4121           default-directory))
4122        gnus-article-save-directory)))
4123
4124 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4125   "Generate file name from sender."
4126   (let ((from (mail-header-from headers)))
4127     (expand-file-name
4128      (if (and from (string-match "\\([^ <]+\\)@" from))
4129          (match-string 1 from)
4130        "nobody")
4131      gnus-article-save-directory)))
4132
4133 (defun article-verify-x-pgp-sig ()
4134   "Verify X-PGP-Sig."
4135   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4136   (interactive)
4137   (if (gnus-buffer-live-p gnus-original-article-buffer)
4138       (let ((sig (with-current-buffer gnus-original-article-buffer
4139                    (gnus-fetch-field "X-PGP-Sig")))
4140             items info headers)
4141         (when (and sig
4142                    mml2015-use
4143                    (mml2015-clear-verify-function))
4144           (with-temp-buffer
4145             (insert-buffer-substring gnus-original-article-buffer)
4146             (setq items (split-string sig))
4147             (message-narrow-to-head)
4148             (let ((inhibit-point-motion-hooks t)
4149                   (case-fold-search t))
4150               ;; Don't verify multiple headers.
4151               (setq headers (mapconcat (lambda (header)
4152                                          (concat header ": "
4153                                                  (mail-fetch-field header)
4154                                                  "\n"))
4155                                        (split-string (nth 1 items) ",") "")))
4156             (delete-region (point-min) (point-max))
4157             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4158             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4159             (insert headers)
4160             (widen)
4161             (forward-line)
4162             (while (not (eobp))
4163               (if (looking-at "^-")
4164                   (insert "- "))
4165               (forward-line))
4166             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4167             (insert "Version: " (car items) "\n\n")
4168             (insert (mapconcat 'identity (cddr items) "\n"))
4169             (insert "\n-----END PGP SIGNATURE-----\n")
4170             (let ((mm-security-handle (list (format "multipart/signed"))))
4171               (mml2015-clean-buffer)
4172               (let ((coding-system-for-write (or gnus-newsgroup-charset
4173                                                  'iso-8859-1)))
4174                 (funcall (mml2015-clear-verify-function)))
4175               (setq info
4176                     (or (mm-handle-multipart-ctl-parameter
4177                          mm-security-handle 'gnus-details)
4178                         (mm-handle-multipart-ctl-parameter
4179                          mm-security-handle 'gnus-info)))))
4180           (when info
4181             (let ((inhibit-read-only t) bface eface)
4182               (save-restriction
4183                 (message-narrow-to-head)
4184                 (goto-char (point-max))
4185                 (forward-line -1)
4186                 (setq bface (get-text-property (point-at-bol) 'face)
4187                       eface (get-text-property (1- (point-at-eol)) 'face))
4188                 (message-remove-header "X-Gnus-PGP-Verify")
4189                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4190                     (forward-line)
4191                   (goto-char (point-max)))
4192                 (narrow-to-region (point) (point))
4193                 (insert "X-Gnus-PGP-Verify: " info "\n")
4194                 (goto-char (point-min))
4195                 (forward-line)
4196                 (while (not (eobp))
4197                   (if (not (looking-at "^[ \t]"))
4198                       (insert " "))
4199                   (forward-line))
4200                 ;; Do highlighting.
4201                 (goto-char (point-min))
4202                 (when (looking-at "\\([^:]+\\): *")
4203                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4204                                      'face bface)
4205                   (put-text-property (match-end 0) (point-max)
4206                                      'face eface)))))))))
4207
4208 (autoload 'canlock-verify "canlock" nil t) ;; for XEmacs.
4209
4210 (defun article-verify-cancel-lock ()
4211   "Verify Cancel-Lock header."
4212   (interactive)
4213   (if (gnus-buffer-live-p gnus-original-article-buffer)
4214       (canlock-verify gnus-original-article-buffer)))
4215
4216 (eval-and-compile
4217   (mapc
4218    (lambda (func)
4219      (let (afunc gfunc)
4220        (if (consp func)
4221            (setq afunc (car func)
4222                  gfunc (cdr func))
4223          (setq afunc func
4224                gfunc (intern (format "gnus-%s" func))))
4225        (defalias gfunc
4226          (when (fboundp afunc)
4227            `(lambda (&optional interactive &rest args)
4228               ,(documentation afunc t)
4229               (interactive (list t))
4230               (with-current-buffer gnus-article-buffer
4231                 (if interactive
4232                     (call-interactively ',afunc)
4233                   (apply ',afunc args))))))))
4234    '(article-hide-headers
4235      article-verify-x-pgp-sig
4236      article-verify-cancel-lock
4237      article-hide-boring-headers
4238      article-treat-overstrike
4239      article-treat-ansi-sequences
4240      article-fill-long-lines
4241      article-capitalize-sentences
4242      article-remove-cr
4243      article-remove-leading-whitespace
4244      article-display-x-face
4245      article-display-face
4246      article-de-quoted-unreadable
4247      article-de-base64-unreadable
4248      article-decode-HZ
4249      article-wash-html
4250      article-unsplit-urls
4251      article-hide-list-identifiers
4252      article-strip-banner
4253      article-babel
4254      article-hide-pem
4255      article-hide-signature
4256      article-strip-headers-in-body
4257      article-remove-trailing-blank-lines
4258      article-strip-leading-blank-lines
4259      article-strip-multiple-blank-lines
4260      article-strip-leading-space
4261      article-strip-trailing-space
4262      article-strip-blank-lines
4263      article-strip-all-blank-lines
4264      article-date-local
4265      article-date-english
4266      article-date-iso8601
4267      article-date-original
4268      article-date-ut
4269      article-decode-mime-words
4270      article-decode-charset
4271      article-decode-encoded-words
4272      article-date-user
4273      article-date-lapsed
4274      article-emphasize
4275      article-treat-dumbquotes
4276      article-treat-non-ascii
4277      article-normalize-headers
4278      ;;(article-show-all . gnus-article-show-all-headers)
4279      )))
4280 \f
4281 ;;;
4282 ;;; Gnus article mode
4283 ;;;
4284
4285 (put 'gnus-article-mode 'mode-class 'special)
4286
4287 (set-keymap-parent gnus-article-mode-map widget-keymap)
4288
4289 (gnus-define-keys gnus-article-mode-map
4290   " " gnus-article-goto-next-page
4291   "\177" gnus-article-goto-prev-page
4292   [delete] gnus-article-goto-prev-page
4293   [backspace] gnus-article-goto-prev-page
4294   "\C-c^" gnus-article-refer-article
4295   "h" gnus-article-show-summary
4296   "s" gnus-article-show-summary
4297   "\C-c\C-m" gnus-article-mail
4298   "?" gnus-article-describe-briefly
4299   "<" beginning-of-buffer
4300   ">" end-of-buffer
4301   "\C-c\C-i" gnus-info-find-node
4302   "\C-c\C-b" gnus-bug
4303   "R" gnus-article-reply-with-original
4304   "F" gnus-article-followup-with-original
4305   "\C-hk" gnus-article-describe-key
4306   "\C-hc" gnus-article-describe-key-briefly
4307   "\C-hb" gnus-article-describe-bindings
4308
4309   "e" gnus-article-read-summary-keys
4310   "\C-d" gnus-article-read-summary-keys
4311   "\M-*" gnus-article-read-summary-keys
4312   "\M-#" gnus-article-read-summary-keys
4313   "\M-^" gnus-article-read-summary-keys
4314   "\M-g" gnus-article-read-summary-keys)
4315
4316 (substitute-key-definition
4317  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4318
4319 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4320   "W" gnus-article-wide-reply-with-original)
4321 (if (featurep 'xemacs)
4322     (set-keymap-default-binding gnus-article-send-map
4323                                 'gnus-article-read-summary-send-keys)
4324   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4325
4326 (defun gnus-article-make-menu-bar ()
4327   (unless (boundp 'gnus-article-commands-menu)
4328     (gnus-summary-make-menu-bar))
4329   (unless (boundp 'gnus-article-article-menu)
4330     (easy-menu-define
4331      gnus-article-article-menu gnus-article-mode-map ""
4332      '("Article"
4333        ["Scroll forwards" gnus-article-goto-next-page t]
4334        ["Scroll backwards" gnus-article-goto-prev-page t]
4335        ["Show summary" gnus-article-show-summary t]
4336        ["Fetch Message-ID at point" gnus-article-refer-article t]
4337        ["Mail to address at point" gnus-article-mail t]
4338        ["Send a bug report" gnus-bug t]))
4339
4340     (easy-menu-define
4341      gnus-article-treatment-menu gnus-article-mode-map ""
4342      ;; Fixme: this should use :active (and maybe :visible).
4343      '("Treatment"
4344        ["Hide headers" gnus-article-hide-headers t]
4345        ["Hide signature" gnus-article-hide-signature t]
4346        ["Hide citation" gnus-article-hide-citation t]
4347        ["Treat overstrike" gnus-article-treat-overstrike t]
4348        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4349        ["Remove carriage return" gnus-article-remove-cr t]
4350        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4351        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4352        ["Remove base64" gnus-article-de-base64-unreadable t]
4353        ["Treat html" gnus-article-wash-html t]
4354        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4355        ["Decode HZ" gnus-article-decode-HZ t]))
4356
4357     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4358
4359     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4360
4361     (gnus-run-hooks 'gnus-article-menu-hook)))
4362
4363 (defvar bookmark-make-record-function)
4364
4365 (defun gnus-article-mode ()
4366   "Major mode for displaying an article.
4367
4368 All normal editing commands are switched off.
4369
4370 The following commands are available in addition to all summary mode
4371 commands:
4372 \\<gnus-article-mode-map>
4373 \\[gnus-article-next-page]\t Scroll the article one page forwards
4374 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4375 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4376 \\[gnus-article-show-summary]\t Display the summary buffer
4377 \\[gnus-article-mail]\t Send a reply to the address near point
4378 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4379 \\[gnus-info-find-node]\t Go to the Gnus info node"
4380   (interactive)
4381   (kill-all-local-variables)
4382   (gnus-simplify-mode-line)
4383   (setq mode-name "Article")
4384   (setq major-mode 'gnus-article-mode)
4385   (make-local-variable 'minor-mode-alist)
4386   (use-local-map gnus-article-mode-map)
4387   (when (gnus-visual-p 'article-menu 'menu)
4388     (gnus-article-make-menu-bar)
4389     (when gnus-summary-tool-bar-map
4390       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4391   (gnus-update-format-specifications nil 'article-mode)
4392   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4393   (set (make-local-variable 'gnus-page-broken) nil)
4394   (make-local-variable 'gnus-button-marker-list)
4395   (make-local-variable 'gnus-article-current-summary)
4396   (make-local-variable 'gnus-article-mime-handles)
4397   (make-local-variable 'gnus-article-decoded-p)
4398   (make-local-variable 'gnus-article-mime-handle-alist)
4399   (make-local-variable 'gnus-article-wash-types)
4400   (make-local-variable 'gnus-article-image-alist)
4401   (make-local-variable 'gnus-article-charset)
4402   (make-local-variable 'gnus-article-ignored-charsets)
4403   (set (make-local-variable 'bookmark-make-record-function)
4404        'gnus-summary-bookmark-make-record)
4405   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4406   ;; face.
4407   (set (make-local-variable 'nobreak-char-display) nil)
4408   (setq cursor-in-non-selected-windows nil)
4409   (gnus-set-default-directory)
4410   (buffer-disable-undo)
4411   (setq buffer-read-only t
4412         show-trailing-whitespace nil)
4413   (set-syntax-table gnus-article-mode-syntax-table)
4414   (mm-enable-multibyte)
4415   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4416
4417 (defvar gnus-button-marker-list nil
4418   "Regexp matching any of the regexps from `gnus-button-alist'.
4419 Internal variable.")
4420
4421 (defun gnus-article-setup-buffer ()
4422   "Initialize the article buffer."
4423   (let* ((name (if gnus-single-article-buffer "*Article*"
4424                  (concat "*Article " gnus-newsgroup-name "*")))
4425          (original
4426           (progn (string-match "\\*Article" name)
4427                  (concat " *Original Article"
4428                          (substring name (match-end 0))))))
4429     (setq gnus-article-buffer name)
4430     (setq gnus-original-article-buffer original)
4431     (setq gnus-article-mime-handle-alist nil)
4432     (with-current-buffer gnus-summary-buffer
4433       ;; This might be a variable local to the summary buffer.
4434       (unless gnus-single-article-buffer
4435         (setq gnus-article-buffer name)
4436         (setq gnus-original-article-buffer original)
4437         (gnus-set-global-variables)))
4438     (gnus-article-setup-highlight-words)
4439     ;; Init original article buffer.
4440     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4441       (mm-enable-multibyte)
4442       (setq major-mode 'gnus-original-article-mode)
4443       (make-local-variable 'gnus-original-article))
4444     (if (and (get-buffer name)
4445              (with-current-buffer name
4446                (if gnus-article-edit-mode
4447                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4448                        (progn
4449                          (set-buffer-modified-p nil)
4450                          (gnus-kill-buffer name)
4451                          (message "")
4452                          nil)
4453                      (error "Action aborted"))
4454                  t)))
4455         (with-current-buffer name
4456           (set (make-local-variable 'gnus-article-edit-mode) nil)
4457           (when gnus-article-mime-handles
4458             (mm-destroy-parts gnus-article-mime-handles)
4459             (setq gnus-article-mime-handles nil))
4460           ;; Set it to nil in article-buffer!
4461           (setq gnus-article-mime-handle-alist nil)
4462           (buffer-disable-undo)
4463           (setq buffer-read-only t)
4464           ;; This list just keeps growing if we don't reset it.
4465           (setq gnus-button-marker-list nil)
4466           (unless (eq major-mode 'gnus-article-mode)
4467             (gnus-article-mode))
4468           (setq truncate-lines gnus-article-truncate-lines)
4469           (current-buffer))
4470       (with-current-buffer (gnus-get-buffer-create name)
4471         (gnus-article-mode)
4472         (setq truncate-lines gnus-article-truncate-lines)
4473         (make-local-variable 'gnus-summary-buffer)
4474         (setq gnus-summary-buffer
4475               (gnus-summary-buffer-name gnus-newsgroup-name))
4476         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4477         (current-buffer)))))
4478
4479 ;; Set article window start at LINE, where LINE is the number of lines
4480 ;; from the head of the article.
4481 (defun gnus-article-set-window-start (&optional line)
4482   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4483     (when article-window
4484       (set-window-start
4485        article-window
4486        (with-current-buffer gnus-article-buffer
4487          (goto-char (point-min))
4488          (if (not line)
4489              (point-min)
4490            (gnus-message 6 "Moved to bookmark")
4491            (search-forward "\n\n" nil t)
4492            (forward-line line)
4493            (point)))))))
4494
4495 (defun gnus-article-prepare (article &optional all-headers header)
4496   "Prepare ARTICLE in article mode buffer.
4497 ARTICLE should either be an article number or a Message-ID.
4498 If ARTICLE is an id, HEADER should be the article headers.
4499 If ALL-HEADERS is non-nil, no headers are hidden."
4500   (save-excursion
4501     ;; Make sure we start in a summary buffer.
4502     (unless (eq major-mode 'gnus-summary-mode)
4503       (set-buffer gnus-summary-buffer))
4504     (setq gnus-summary-buffer (current-buffer))
4505     (let* ((gnus-article (if header (mail-header-number header) article))
4506            (summary-buffer (current-buffer))
4507            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4508            (group gnus-newsgroup-name)
4509            result)
4510       (save-excursion
4511         (gnus-article-setup-buffer)
4512         (set-buffer gnus-article-buffer)
4513         ;; Deactivate active regions.
4514         (when (and (boundp 'transient-mark-mode)
4515                    transient-mark-mode)
4516           (setq mark-active nil))
4517         (if (not (setq result (let ((inhibit-read-only t))
4518                                 (gnus-request-article-this-buffer
4519                                  article group))))
4520             ;; There is no such article.
4521             (save-excursion
4522               (when (and (numberp article)
4523                          (not (memq article gnus-newsgroup-sparse)))
4524                 (setq gnus-article-current
4525                       (cons gnus-newsgroup-name article))
4526                 (set-buffer gnus-summary-buffer)
4527                 (setq gnus-current-article article)
4528                 (if (and (memq article gnus-newsgroup-undownloaded)
4529                          (not (gnus-online (gnus-find-method-for-group
4530                                             gnus-newsgroup-name))))
4531                     (progn
4532                       (gnus-summary-set-agent-mark article)
4533                       (message "Message marked for downloading"))
4534                   (gnus-summary-mark-article article gnus-canceled-mark)
4535                   (unless (memq article gnus-newsgroup-sparse)
4536                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4537           (if (or (eq result 'pseudo)
4538                   (eq result 'nneething))
4539               (progn
4540                 (with-current-buffer summary-buffer
4541                   (push article gnus-newsgroup-history)
4542                   (setq gnus-last-article gnus-current-article
4543                         gnus-current-article 0
4544                         gnus-current-headers nil
4545                         gnus-article-current nil)
4546                   (if (eq result 'nneething)
4547                       (gnus-configure-windows 'summary)
4548                     (gnus-configure-windows 'article))
4549                   (gnus-set-global-variables))
4550                 (let ((gnus-article-mime-handle-alist-1
4551                        gnus-article-mime-handle-alist))
4552                   (gnus-set-mode-line 'article)))
4553             ;; The result from the `request' was an actual article -
4554             ;; or at least some text that is now displayed in the
4555             ;; article buffer.
4556             (when (and (numberp article)
4557                        (not (eq article gnus-current-article)))
4558               ;; Seems like a new article has been selected.
4559               ;; `gnus-current-article' must be an article number.
4560               (with-current-buffer summary-buffer
4561                 (push article gnus-newsgroup-history)
4562                 (setq gnus-last-article gnus-current-article
4563                       gnus-current-article article
4564                       gnus-current-headers
4565                       (gnus-summary-article-header gnus-current-article)
4566                       gnus-article-current
4567                       (cons gnus-newsgroup-name gnus-current-article))
4568                 (unless (vectorp gnus-current-headers)
4569                   (setq gnus-current-headers nil))
4570                 (gnus-summary-goto-subject gnus-current-article)
4571                 (when (gnus-summary-show-thread)
4572                   ;; If the summary buffer really was folded, the
4573                   ;; previous goto may not actually have gone to
4574                   ;; the right article, but the thread root instead.
4575                   ;; So we go again.
4576                   (gnus-summary-goto-subject gnus-current-article))
4577                 (gnus-run-hooks 'gnus-mark-article-hook)
4578                 (gnus-set-mode-line 'summary)
4579                 (when (gnus-visual-p 'article-highlight 'highlight)
4580                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4581                 ;; Set the global newsgroup variables here.
4582                 (gnus-set-global-variables)
4583                 (setq gnus-have-all-headers
4584                       (or all-headers gnus-show-all-headers))))
4585             (save-excursion
4586               (gnus-configure-windows 'article))
4587             (when (or (numberp article)
4588                       (stringp article))
4589               (gnus-article-prepare-display)
4590               ;; Do page break.
4591               (goto-char (point-min))
4592               (when gnus-break-pages
4593                 (gnus-narrow-to-page)))
4594             (let ((gnus-article-mime-handle-alist-1
4595                    gnus-article-mime-handle-alist))
4596               (gnus-set-mode-line 'article))
4597             (article-goto-body)
4598             (unless (bobp)
4599               (forward-line -1))
4600             (set-window-point (get-buffer-window (current-buffer)) (point))
4601             (gnus-configure-windows 'article)
4602             t))))))
4603
4604 ;;;###autoload
4605 (defun gnus-article-prepare-display ()
4606   "Make the current buffer look like a nice article."
4607   ;; Hooks for getting information from the article.
4608   ;; This hook must be called before being narrowed.
4609   (let ((gnus-article-buffer (current-buffer))
4610         buffer-read-only
4611         (inhibit-read-only t))
4612     (unless (eq major-mode 'gnus-article-mode)
4613       (gnus-article-mode))
4614     (setq buffer-read-only nil
4615           gnus-article-wash-types nil
4616           gnus-article-image-alist nil)
4617     (gnus-run-hooks 'gnus-tmp-internal-hook)
4618     (when gnus-display-mime-function
4619       (funcall gnus-display-mime-function))
4620     (gnus-run-hooks 'gnus-article-prepare-hook)))
4621
4622 ;;;
4623 ;;; Gnus Sticky Article Mode
4624 ;;;
4625
4626 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4627   "Mode for sticky articles."
4628   ;; Release bindings that won't work.
4629   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4630                              gnus-sticky-article-mode-map)
4631   (substitute-key-definition 'gnus-article-refer-article 'undefined
4632                              gnus-sticky-article-mode-map)
4633   (dolist (k '("e" "h" "s" "F" "R"))
4634     (define-key gnus-sticky-article-mode-map k nil))
4635   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4636   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4637   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4638   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4639
4640 (defun gnus-sticky-article (arg)
4641   "Make the current article sticky.
4642 If a prefix ARG is given, ask for a name for this sticky article buffer."
4643   (interactive "P")
4644   (gnus-summary-show-thread)
4645   (gnus-summary-select-article nil nil 'pseudo)
4646   (let (new-art-buf-name)
4647     (gnus-eval-in-buffer-window gnus-article-buffer
4648       (setq new-art-buf-name
4649             (concat
4650              "*Sticky Article: "
4651              (if arg
4652                  (read-from-minibuffer "Sticky article buffer name: ")
4653                (gnus-with-article-headers
4654                  (gnus-article-goto-header "subject")
4655                  (setq new-art-buf-name
4656                        (buffer-substring-no-properties
4657                         (line-beginning-position) (line-end-position)))
4658                  (goto-char (point-min))
4659                  (gnus-article-goto-header "from")
4660                  (setq new-art-buf-name
4661                        (concat
4662                         new-art-buf-name ", "
4663                         (buffer-substring-no-properties
4664                          (line-beginning-position) (line-end-position))))
4665                  (goto-char (point-min))
4666                  (gnus-article-goto-header "date")
4667                  (setq new-art-buf-name
4668                        (concat
4669                         new-art-buf-name ", "
4670                         (buffer-substring-no-properties
4671                          (line-beginning-position) (line-end-position))))))
4672              "*"))
4673       (if (and (gnus-buffer-live-p new-art-buf-name)
4674                (with-current-buffer new-art-buf-name
4675                  (eq major-mode 'gnus-sticky-article-mode)))
4676           (switch-to-buffer new-art-buf-name)
4677         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4678       (gnus-sticky-article-mode))
4679     (setq gnus-article-buffer new-art-buf-name))
4680   (gnus-summary-recenter)
4681   (gnus-summary-position-point))
4682
4683 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4684   "Kill the given sticky article BUFFER.
4685 If none is given, assume the current buffer and kill it if it has
4686 `gnus-sticky-article-mode'."
4687   (interactive)
4688   (unless buffer
4689     (setq buffer (current-buffer)))
4690   (with-current-buffer buffer
4691     (when (eq major-mode 'gnus-sticky-article-mode)
4692       (gnus-kill-buffer buffer))))
4693
4694 (defun gnus-kill-sticky-article-buffers (arg)
4695   "Kill all sticky article buffers.
4696 If a prefix ARG is given, ask for confirmation."
4697   (interactive "P")
4698   (dolist (buf (gnus-buffers))
4699     (with-current-buffer buf
4700       (when (eq major-mode 'gnus-sticky-article-mode)
4701         (if (not arg)
4702             (gnus-kill-buffer buf)
4703           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4704             (gnus-kill-buffer buf)))))))
4705
4706 ;;;
4707 ;;; Gnus MIME viewing functions
4708 ;;;
4709
4710 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4711   "Format of the MIME buttons.
4712
4713 Valid specifiers include:
4714 %t  The MIME type
4715 %T  MIME type, along with additional info
4716 %n  The `name' parameter
4717 %d  The description, if any
4718 %l  The length of the encoded part
4719 %p  The part identifier number
4720 %e  Dots if the part isn't displayed
4721
4722 General format specifiers can also be used.  See Info node
4723 `(gnus)Formatting Variables'.")
4724
4725 (defvar gnus-mime-button-line-format-alist
4726   '((?t gnus-tmp-type ?s)
4727     (?T gnus-tmp-type-long ?s)
4728     (?n gnus-tmp-name ?s)
4729     (?d gnus-tmp-description ?s)
4730     (?p gnus-tmp-id ?s)
4731     (?l gnus-tmp-length ?d)
4732     (?e gnus-tmp-dots ?s)))
4733
4734 (defvar gnus-mime-button-commands
4735   '((gnus-article-press-button "\r" "Toggle Display")
4736     (gnus-mime-view-part "v" "View Interactively...")
4737     (gnus-mime-view-part-as-type "t" "View As Type...")
4738     (gnus-mime-view-part-as-charset "C" "View As charset...")
4739     (gnus-mime-save-part "o" "Save...")
4740     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4741     (gnus-mime-replace-part "r" "Replace part")
4742     (gnus-mime-delete-part "d" "Delete part")
4743     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4744     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4745     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4746     (gnus-mime-view-part-externally "e" "View Externally")
4747     (gnus-mime-print-part "p" "Print")
4748     (gnus-mime-pipe-part "|" "Pipe To Command...")
4749     (gnus-mime-action-on-part "." "Take action on the part...")))
4750
4751 (defun gnus-article-mime-part-status ()
4752   (if gnus-article-mime-handle-alist-1
4753       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4754           " (1 part)"
4755         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4756     ""))
4757
4758 (defvar gnus-mime-button-map
4759   (let ((map (make-sparse-keymap)))
4760     (define-key map gnus-mouse-2 'gnus-article-push-button)
4761     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4762     (dolist (c gnus-mime-button-commands)
4763       (define-key map (cadr c) (car c)))
4764     map))
4765
4766 (easy-menu-define
4767   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4768   `("MIME Part"
4769     ,@(mapcar (lambda (c)
4770                 (vector (caddr c) (car c) :active t))
4771               gnus-mime-button-commands)))
4772
4773 (defvar gnus-url-button-commands
4774   '((gnus-article-copy-string "u" "Copy URL to kill ring")))
4775
4776 (defvar gnus-url-button-map
4777   (let ((map (make-sparse-keymap)))
4778     (dolist (c gnus-url-button-commands)
4779       (define-key map (cadr c) (car c)))
4780     map))
4781
4782 (easy-menu-define
4783   gnus-url-button-menu gnus-url-button-map "URL button menu."
4784   `("Url Button"
4785     ,@(mapcar (lambda (c)
4786                 (vector (caddr c) (car c) :active t))
4787               gnus-url-button-commands)))
4788
4789 (defmacro gnus-bind-safe-url-regexp (&rest body)
4790   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4791   `(let ((mm-w3m-safe-url-regexp
4792           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4793                                 (gnus-buffer-live-p
4794                                  gnus-article-current-summary))
4795                            (with-current-buffer gnus-article-current-summary
4796                              gnus-newsgroup-name)
4797                          gnus-newsgroup-name)))
4798             (if (cond ((not group)
4799                        ;; Maybe we're in a mml-preview buffer
4800                        ;; and no group is selected.
4801                        t)
4802                       ((stringp gnus-safe-html-newsgroups)
4803                        (string-match gnus-safe-html-newsgroups group))
4804                       ((consp gnus-safe-html-newsgroups)
4805                        (member group gnus-safe-html-newsgroups)))
4806                 nil
4807               mm-w3m-safe-url-regexp))))
4808      ,@body))
4809
4810 (defun gnus-mime-button-menu (event prefix)
4811  "Construct a context-sensitive menu of MIME commands."
4812  (interactive "e\nP")
4813  (save-window-excursion
4814    (let ((pos (event-start event)))
4815      (select-window (posn-window pos))
4816      (goto-char (posn-point pos))
4817      (gnus-article-check-buffer)
4818      (popup-menu gnus-mime-button-menu nil prefix))))
4819
4820 (defun gnus-mime-view-all-parts (&optional handles)
4821   "View all the MIME parts."
4822   (interactive)
4823   (with-current-buffer gnus-article-buffer
4824     (let ((handles (or handles gnus-article-mime-handles))
4825           (mail-parse-charset gnus-newsgroup-charset)
4826           (mail-parse-ignored-charsets
4827            (with-current-buffer gnus-summary-buffer
4828              gnus-newsgroup-ignored-charsets)))
4829       (when handles
4830         (mm-remove-parts handles)
4831         (goto-char (point-min))
4832         (or (search-forward "\n\n") (goto-char (point-max)))
4833         (let ((inhibit-read-only t))
4834           (delete-region (point) (point-max))
4835           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4836
4837 (defun gnus-article-jump-to-part (n)
4838   "Jump to MIME part N."
4839   (interactive "P")
4840   (let ((parts (with-current-buffer gnus-article-buffer
4841                  (length gnus-article-mime-handle-alist))))
4842     (when (zerop parts)
4843       (error "No such part"))
4844     (pop-to-buffer gnus-article-buffer)
4845     ;; FIXME: why is it necessary?
4846     (sit-for 0)
4847     (or n
4848         (setq n (if (= parts 1)
4849                     1
4850                   (read-number (format "Jump to part (1..%s): " parts)))))
4851     (unless (and (integerp n) (<= n parts) (>= n 1))
4852       (setq n
4853             (progn
4854               (gnus-message 7 "Invalid part `%s', using %s instead."
4855                             n parts)
4856               parts)))
4857     (gnus-message 9 "Jumping to part %s." n)
4858     (cond ((>= gnus-auto-select-part 1)
4859            (while (and (<= n parts)
4860                        (not (gnus-article-goto-part n)))
4861              (setq n (1+ n))))
4862           ((< gnus-auto-select-part 0)
4863            (while (and (>= n 1)
4864                        (not (gnus-article-goto-part n)))
4865              (setq n (1- n))))
4866           (t
4867            (gnus-article-goto-part n)))))
4868
4869 (defvar gnus-mime-buttonized-part-id nil
4870   "ID of a mime part that should be buttonized.
4871 `gnus-mime-save-part-and-strip' and `gnus-mime-delete-part' bind it.")
4872
4873 (eval-when-compile
4874   (defsubst gnus-article-edit-part (handles &optional current-id)
4875     "Edit an article in order to delete a mime part.
4876 This function is exclusively used by `gnus-mime-save-part-and-strip'
4877 and `gnus-mime-delete-part', and not provided at run-time normally."
4878     (gnus-article-edit-article
4879      `(lambda ()
4880         (buffer-disable-undo)
4881         (erase-buffer)
4882         (let ((mail-parse-charset (or gnus-article-charset
4883                                       ',gnus-newsgroup-charset))
4884               (mail-parse-ignored-charsets
4885                (or gnus-article-ignored-charsets
4886                    ',gnus-newsgroup-ignored-charsets))
4887               (mbl mml-buffer-list))
4888           (setq mml-buffer-list nil)
4889           (insert-buffer-substring gnus-original-article-buffer)
4890           (mime-to-mml ',handles)
4891           (setq gnus-article-mime-handles nil)
4892           (let ((mbl1 mml-buffer-list))
4893             (setq mml-buffer-list mbl)
4894             (set (make-local-variable 'mml-buffer-list) mbl1))
4895           (gnus-make-local-hook 'kill-buffer-hook)
4896           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4897      `(lambda (no-highlight)
4898         (let ((mail-parse-charset (or gnus-article-charset
4899                                       ',gnus-newsgroup-charset))
4900               (message-options message-options)
4901               (message-options-set-recipient)
4902               (mail-parse-ignored-charsets
4903                (or gnus-article-ignored-charsets
4904                    ',gnus-newsgroup-ignored-charsets)))
4905           (mml-to-mime)
4906           (mml-destroy-buffers)
4907           (remove-hook 'kill-buffer-hook
4908                        'mml-destroy-buffers t)
4909           (kill-local-variable 'mml-buffer-list))
4910         (gnus-summary-edit-article-done
4911          ,(or (mail-header-references gnus-current-headers) "")
4912          ,(gnus-group-read-only-p)
4913          ,gnus-summary-buffer no-highlight))
4914      t)
4915     ;; Force buttonizing this part.
4916     (let ((gnus-mime-buttonized-part-id current-id))
4917       (gnus-article-edit-done))
4918     (gnus-configure-windows 'article)
4919     (when (and current-id (integerp gnus-auto-select-part))
4920       (gnus-article-jump-to-part
4921        (min (max (+ current-id gnus-auto-select-part) 1)
4922             (with-current-buffer gnus-article-buffer
4923               (length gnus-article-mime-handle-alist)))))))
4924
4925 (defun gnus-mime-replace-part (file)
4926   "Replace MIME part under point with an external body."
4927   ;; Useful if file has already been saved to disk
4928   (interactive
4929    (list
4930     (read-file-name "Replace MIME part with file: "
4931                     (or mm-default-directory default-directory)
4932                     nil nil)))
4933   (gnus-mime-save-part-and-strip file))
4934
4935 (defun gnus-mime-save-part-and-strip (&optional file)
4936   "Save the MIME part under point then replace it with an external body.
4937 If FILE is given, use it for the external part."
4938   (interactive)
4939   (gnus-article-check-buffer)
4940   (when (gnus-group-read-only-p)
4941     (error "The current group does not support deleting of parts"))
4942   (when (mm-complicated-handles gnus-article-mime-handles)
4943     (error "\
4944 The current article has a complicated MIME structure, giving up..."))
4945   (let* ((data (get-text-property (point) 'gnus-data))
4946          (id (get-text-property (point) 'gnus-part))
4947          param
4948          (handles gnus-article-mime-handles))
4949     (unless file
4950       (setq file
4951             (and data (mm-save-part data "Delete MIME part and save to: "))))
4952     (when file
4953       (with-current-buffer (mm-handle-buffer data)
4954         (erase-buffer)
4955         (insert "Content-Type: " (mm-handle-media-type data))
4956         (mml-insert-parameter-string (cdr (mm-handle-type data))
4957                                      '(charset))
4958         ;; Add a filename for the sake of saving the part again.
4959         (mml-insert-parameter
4960          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4961         (insert "\n")
4962         (insert "Content-ID: " (message-make-message-id) "\n")
4963         (insert "Content-Transfer-Encoding: binary\n")
4964         (insert "\n"))
4965       (setcdr data
4966               (cdr (mm-make-handle nil
4967                                    `("message/external-body"
4968                                      (access-type . "LOCAL-FILE")
4969                                      (name . ,file)))))
4970       ;; (set-buffer gnus-summary-buffer)
4971       (gnus-article-edit-part handles id))))
4972
4973 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4974 ;; parts...>') but with stripping would be nice.
4975
4976 (defun gnus-mime-delete-part ()
4977   "Delete the MIME part under point.
4978 Replace it with some information about the removed part."
4979   (interactive)
4980   (gnus-article-check-buffer)
4981   (when (gnus-group-read-only-p)
4982     (error "The current group does not support deleting of parts"))
4983   (when (mm-complicated-handles gnus-article-mime-handles)
4984     (error "\
4985 The current article has a complicated MIME structure, giving up..."))
4986   (when (or gnus-expert-user
4987             (gnus-yes-or-no-p "\
4988 Deleting parts may malfunction or destroy the article; continue? "))
4989     (let* ((data (get-text-property (point) 'gnus-data))
4990            (id (get-text-property (point) 'gnus-part))
4991            (handles gnus-article-mime-handles)
4992            (none "(none)")
4993            (description
4994             (let ((desc (mm-handle-description data)))
4995               (when desc
4996                 (mail-decode-encoded-word-string desc))))
4997            (filename
4998             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4999                 none))
5000            (type (mm-handle-media-type data)))
5001       (unless data
5002         (error "No MIME part under point"))
5003       (with-current-buffer (mm-handle-buffer data)
5004         (let ((bsize (buffer-size)))
5005           (erase-buffer)
5006           (insert
5007            (concat
5008             ",----\n"
5009             "| The following attachment has been deleted:\n"
5010             "|\n"
5011             "| Type:           " type "\n"
5012             "| Filename:       " filename "\n"
5013             "| Size (encoded): " (format "%s byte%s\n"
5014                                          bsize (if (= bsize 1)
5015                                                    ""
5016                                                  "s"))
5017             (when description
5018               (concat    "| Description:    " description "\n"))
5019             "`----\n"))
5020           (setcdr data
5021                   (cdr (mm-make-handle
5022                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5023                         (list "attachment")
5024                         (format "Deleted attachment (%s bytes)" bsize))))))
5025       ;; (set-buffer gnus-summary-buffer)
5026       (gnus-article-edit-part handles id))))
5027
5028 (defun gnus-mime-save-part ()
5029   "Save the MIME part under point."
5030   (interactive)
5031   (gnus-article-check-buffer)
5032   (let ((data (get-text-property (point) 'gnus-data)))
5033     (when data
5034       (mm-save-part data))))
5035
5036 (defun gnus-mime-pipe-part (&optional cmd)
5037   "Pipe the MIME part under point to a process.
5038 Use CMD as the process."
5039   (interactive)
5040   (gnus-article-check-buffer)
5041   (let ((data (get-text-property (point) 'gnus-data)))
5042     (when data
5043       (mm-pipe-part data cmd))))
5044
5045 (defun gnus-mime-view-part ()
5046   "Interactively choose a viewing method for the MIME part under point."
5047   (interactive)
5048   (gnus-article-check-buffer)
5049   (let ((data (get-text-property (point) 'gnus-data)))
5050     (when data
5051       (setq gnus-article-mime-handles
5052             (mm-merge-handles
5053              gnus-article-mime-handles (setq data (copy-sequence data))))
5054       (mm-interactively-view-part data))))
5055
5056 (defun gnus-mime-view-part-as-type-internal ()
5057   (gnus-article-check-buffer)
5058   (let* ((handle (get-text-property (point) 'gnus-data))
5059          (name (or
5060                 ;; Content-Type: foo/bar; name=...
5061                 (mail-content-type-get (mm-handle-type handle) 'name)
5062                 ;; Content-Disposition: attachment; filename=...
5063                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5064          (def-type (and name (mm-default-file-encoding name))))
5065     (or (and def-type (cons def-type 0))
5066         (and handle
5067              (equal (mm-handle-media-supertype handle) "text")
5068              '("text/plain" . 0))
5069         '("application/octet-stream" . 0))))
5070
5071 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5072   "Choose a MIME media type, and view the part as such.
5073 If non-nil, PRED is a predicate to use during completion to limit the
5074 available media-types."
5075   (interactive)
5076   (unless mime-type
5077     (setq mime-type
5078           (let ((default (gnus-mime-view-part-as-type-internal)))
5079             (gnus-completing-read
5080              "View as MIME type"
5081              (if pred
5082                  (gnus-remove-if-not pred (mailcap-mime-types))
5083                (mailcap-mime-types))
5084              nil nil nil
5085              (car default)))))
5086   (gnus-article-check-buffer)
5087   (let ((handle (get-text-property (point) 'gnus-data)))
5088     (when handle
5089       (when (equal (mm-handle-media-type handle) "message/external-body")
5090         (unless (mm-handle-cache handle)
5091           (mm-extern-cache-contents handle))
5092         (setq handle (mm-handle-cache handle)))
5093       (setq handle
5094             (mm-make-handle (mm-handle-buffer handle)
5095                             (cons mime-type (cdr (mm-handle-type handle)))
5096                             (mm-handle-encoding handle)
5097                             (mm-handle-undisplayer handle)
5098                             (mm-handle-disposition handle)
5099                             (mm-handle-description handle)
5100                             nil
5101                             (mm-handle-id handle)))
5102       (setq gnus-article-mime-handles
5103             (mm-merge-handles gnus-article-mime-handles handle))
5104       (when (mm-handle-displayed-p handle)
5105         (mm-remove-part handle))
5106       (gnus-mm-display-part handle))))
5107
5108 (defun gnus-mime-copy-part (&optional handle arg)
5109   "Put the MIME part under point into a new buffer.
5110 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5111 are decompressed."
5112   (interactive (list nil current-prefix-arg))
5113   (gnus-article-check-buffer)
5114   (unless handle
5115     (setq handle (get-text-property (point) 'gnus-data)))
5116   (when handle
5117     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5118                                                'name)
5119                         (mail-content-type-get (mm-handle-disposition handle)
5120                                                'filename)))
5121           contents dont-decode charset coding-system)
5122       (mm-with-unibyte-buffer
5123         (mm-insert-part handle)
5124         (setq contents (or (condition-case nil
5125                                (mm-decompress-buffer filename nil 'sig)
5126                              (error
5127                               (setq dont-decode t)
5128                               nil))
5129                            (buffer-string))))
5130       (setq filename (cond (filename (file-name-nondirectory filename))
5131                            (dont-decode "*raw data*")
5132                            (t "*decoded*")))
5133       (cond
5134        (dont-decode)
5135        ((not arg)
5136         (unless (setq charset (mail-content-type-get
5137                                (mm-handle-type handle) 'charset))
5138           (unless (setq coding-system (mm-with-unibyte-buffer
5139                                         (insert contents)
5140                                         (mm-find-buffer-file-coding-system)))
5141             (setq charset gnus-newsgroup-charset))))
5142        ((numberp arg)
5143         (setq charset (or (cdr (assq arg
5144                                      gnus-summary-show-article-charset-alist))
5145                           (mm-read-coding-system "Charset: ")))))
5146       (switch-to-buffer (generate-new-buffer filename))
5147       (if (or coding-system
5148               (and charset
5149                    (setq coding-system (mm-charset-to-coding-system charset))
5150                    (not (eq coding-system 'ascii))))
5151           (progn
5152             (mm-enable-multibyte)
5153             (insert (mm-decode-coding-string contents coding-system))
5154             (setq buffer-file-coding-system
5155                   (if (boundp 'last-coding-system-used)
5156                       (symbol-value 'last-coding-system-used)
5157                     coding-system)))
5158         (mm-disable-multibyte)
5159         (insert contents)
5160         (setq buffer-file-coding-system mm-binary-coding-system))
5161       ;; We do it this way to make `normal-mode' set the appropriate mode.
5162       (unwind-protect
5163           (progn
5164             (setq buffer-file-name (expand-file-name filename))
5165             (normal-mode))
5166         (setq buffer-file-name nil))
5167       (goto-char (point-min)))))
5168
5169 (defun gnus-mime-print-part (&optional handle filename)
5170   "Print the MIME part under point."
5171   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5172   (gnus-article-check-buffer)
5173   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5174          (contents (and handle (mm-get-part handle)))
5175          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5176          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5177     (when contents
5178         (if printer
5179             (unwind-protect
5180                 (progn
5181                   (mm-save-part-to-file handle file)
5182                   (call-process shell-file-name nil
5183                                 (generate-new-buffer " *mm*")
5184                                 nil
5185                                 shell-command-switch
5186                                 (mm-mailcap-command
5187                                  printer file (mm-handle-type handle))))
5188               (delete-file file))
5189           (with-temp-buffer
5190             (insert contents)
5191             (gnus-print-buffer))
5192           (ps-despool filename)))))
5193
5194 (defun gnus-mime-inline-part (&optional handle arg)
5195   "Insert the MIME part under point into the current buffer.
5196 Compressed files like .gz and .bz2 are decompressed."
5197   (interactive (list nil current-prefix-arg))
5198   (gnus-article-check-buffer)
5199   (unless handle
5200     (setq handle (get-text-property (point) 'gnus-data)))
5201   (when handle
5202     (let ((b (point))
5203           (inhibit-read-only t)
5204           contents charset coding-system)
5205       (if (and (not arg) (mm-handle-undisplayer handle))
5206           (mm-remove-part handle)
5207         (mm-with-unibyte-buffer
5208           (mm-insert-part handle)
5209           (setq contents
5210                 (or (mm-decompress-buffer
5211                      (or (mail-content-type-get (mm-handle-type handle)
5212                                                 'name)
5213                          (mail-content-type-get (mm-handle-disposition handle)
5214                                                 'filename))
5215                      nil t)
5216                     (buffer-string))))
5217         (cond
5218          ((not arg)
5219           (unless (setq charset (mail-content-type-get
5220                                  (mm-handle-type handle) 'charset))
5221             (unless (setq coding-system
5222                           (mm-with-unibyte-buffer
5223                             (insert contents)
5224                             (mm-find-buffer-file-coding-system)))
5225               (setq charset gnus-newsgroup-charset))))
5226          ((numberp arg)
5227           (if (mm-handle-undisplayer handle)
5228               (mm-remove-part handle))
5229           (setq charset
5230                 (or (cdr (assq arg
5231                                gnus-summary-show-article-charset-alist))
5232                     (mm-read-coding-system "Charset: "))))
5233          (t
5234           (if (mm-handle-undisplayer handle)
5235               (mm-remove-part handle))))
5236         (forward-line 2)
5237         (mm-insert-inline
5238          handle
5239          (if (or coding-system
5240                  (and charset
5241                       (setq coding-system
5242                             (mm-charset-to-coding-system charset))
5243                       (not (eq coding-system 'ascii))))
5244              (mm-decode-coding-string contents coding-system)
5245            (mm-string-to-multibyte contents)))
5246         (goto-char b)))))
5247
5248 (defun gnus-mime-set-charset-parameters (handle charset)
5249   "Set CHARSET to parameters in HANDLE.
5250 CHARSET may either be a string or a symbol."
5251   (unless (stringp charset)
5252     (setq charset (symbol-name charset)))
5253   (if (stringp (car handle))
5254       (dolist (h (cdr handle))
5255         (gnus-mime-set-charset-parameters h charset))
5256     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5257                                             "message/external-body")
5258                                      (progn
5259                                        (unless (mm-handle-cache handle)
5260                                          (mm-extern-cache-contents handle))
5261                                        (mm-handle-cache handle))
5262                                    handle)))
5263            (param (assq 'charset (cdr type))))
5264       (if param
5265           (setcdr param charset)
5266         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5267
5268 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5269   "Insert the MIME part under point into the current buffer using the
5270 specified charset."
5271   (interactive (list nil current-prefix-arg))
5272   (gnus-article-check-buffer)
5273   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5274         (fun (get-text-property (point) 'gnus-callback))
5275         (gnus-newsgroup-ignored-charsets 'gnus-all)
5276         charset form preferred parts)
5277     (when handle
5278       (when (prog1
5279                 (and fun
5280                      (setq charset
5281                            (or (cdr (assq
5282                                      arg
5283                                      gnus-summary-show-article-charset-alist))
5284                                (mm-read-coding-system "Charset: "))))
5285               (if (mm-handle-undisplayer handle)
5286                   (mm-remove-part handle)))
5287         (gnus-mime-set-charset-parameters handle charset)
5288         (when (and (consp (setq form (cdr-safe fun)))
5289                    (setq form (ignore-errors
5290                                 (assq 'gnus-mime-display-alternative form)))
5291                    (setq preferred (caddr form))
5292                    (progn
5293                      (when (eq (car preferred) 'quote)
5294                        (setq preferred (cadr preferred)))
5295                      (not (equal preferred
5296                                  (get-text-property (point) 'gnus-data))))
5297                    (setq parts (get-text-property (point) 'gnus-part))
5298                    (setq parts (cdr (assq parts
5299                                           gnus-article-mime-handle-alist)))
5300                    (equal (mm-handle-media-type parts) "multipart/alternative")
5301                    (setq parts (reverse (cdr parts))))
5302           (setcar (cddr form)
5303                   (list 'quote (or (cadr (member preferred parts))
5304                                    (car parts)))))
5305         (funcall fun handle)))))
5306
5307 (defun gnus-mime-view-part-externally (&optional handle)
5308   "View the MIME part under point with an external viewer."
5309   (interactive)
5310   (gnus-article-check-buffer)
5311   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5312          (mm-user-display-methods nil)
5313          (mm-inlined-types nil)
5314          (mail-parse-charset gnus-newsgroup-charset)
5315          (mail-parse-ignored-charsets
5316           (with-current-buffer gnus-summary-buffer
5317             gnus-newsgroup-ignored-charsets))
5318          (type (mm-handle-media-type handle))
5319          (method (mailcap-mime-info type))
5320          (mm-enable-external t))
5321     (if (not (stringp method))
5322         (gnus-mime-view-part-as-type
5323          nil (lambda (type) (stringp (mailcap-mime-info type))))
5324       (when handle
5325         (mm-display-part handle nil t)))))
5326
5327 (defun gnus-mime-view-part-internally (&optional handle)
5328   "View the MIME part under point with an internal viewer.
5329 If no internal viewer is available, use an external viewer."
5330   (interactive)
5331   (gnus-article-check-buffer)
5332   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5333          (mm-inlined-types '(".*"))
5334          (mm-inline-large-images t)
5335          (mail-parse-charset gnus-newsgroup-charset)
5336          (mail-parse-ignored-charsets
5337           (with-current-buffer gnus-summary-buffer
5338             gnus-newsgroup-ignored-charsets))
5339          (inhibit-read-only t))
5340     (if (not (mm-inlinable-p handle))
5341         (gnus-mime-view-part-as-type
5342          nil (lambda (type) (mm-inlinable-p handle type)))
5343       (when handle
5344         (gnus-bind-safe-url-regexp (mm-display-part handle))))))
5345
5346 (defun gnus-mime-action-on-part (&optional action)
5347   "Do something with the MIME attachment at \(point\)."
5348   (interactive
5349    (list (gnus-completing-read "Action" (mapcar 'car gnus-mime-action-alist) t)))
5350   (gnus-article-check-buffer)
5351   (let ((action-pair (assoc action gnus-mime-action-alist)))
5352     (if action-pair
5353         (funcall (cdr action-pair)))))
5354
5355 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5356   "Call FUNCTION on MIME part N.
5357 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5358 If INTERACTIVE, call FUNCTION interactivly."
5359   (let (window frame)
5360     ;; Check whether the article is displayed.
5361     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5362                  (setq window (get-buffer-window gnus-article-buffer t))
5363                  (frame-visible-p (setq frame (window-frame window))))
5364       (error "No article is displayed"))
5365     (with-current-buffer gnus-article-buffer
5366       ;; Check whether the article displays the right contents.
5367       (unless (with-current-buffer gnus-summary-buffer
5368                 (eq gnus-current-article (gnus-summary-article-number)))
5369         (error "You should select the right article first"))
5370       (if n
5371           (setq n (prefix-numeric-value n))
5372         (let ((pt (point)))
5373           (setq n (or (get-text-property pt 'gnus-part)
5374                       (and (not (bobp))
5375                            (get-text-property (1- pt) 'gnus-part))
5376                       (get-text-property (prog2
5377                                              (forward-line 1)
5378                                              (point)
5379                                            (goto-char pt))
5380                                          'gnus-part)
5381                       (get-text-property
5382                        (or (and (setq pt (previous-single-property-change
5383                                           pt 'gnus-part))
5384                                 (1- pt))
5385                            (next-single-property-change (point) 'gnus-part)
5386                            (point))
5387                        'gnus-part)
5388                       1))))
5389       ;; Check whether the specified part exists.
5390       (when (> n (length gnus-article-mime-handle-alist))
5391         (error "No such part")))
5392     (unless
5393         (progn
5394           ;; To select the window is needed so that the cursor
5395           ;; might be visible on the MIME button.
5396           (select-window (prog1
5397                              window
5398                            (setq window (selected-window))
5399                            ;; Article may be displayed in the other frame.
5400                            (gnus-select-frame-set-input-focus
5401                             (prog1
5402                                 frame
5403                               (setq frame (selected-frame))))))
5404           (when (gnus-article-goto-part n)
5405             ;; We point the cursor and the arrow at the MIME button
5406             ;; when the `function' prompt the user for something.
5407             (unless (and (pos-visible-in-window-p)
5408                          (> (count-lines (point) (window-end))
5409                             (/ (1- (window-height)) 3)))
5410               (recenter (/ (1- (window-height)) 3)))
5411             (let ((cursor-in-non-selected-windows t)
5412                   (overlay-arrow-string "=>")
5413                   (overlay-arrow-position (point-marker)))
5414               (unwind-protect
5415                   (cond
5416                    ((and no-handle interactive)
5417                     (call-interactively function))
5418                    (no-handle
5419                     (funcall function))
5420                    (interactive
5421                     (call-interactively
5422                      function (get-text-property (point) 'gnus-data)))
5423                    (t
5424                     (funcall function
5425                              (get-text-property (point) 'gnus-data))))
5426                 (set-marker overlay-arrow-position nil)
5427                 (unless gnus-auto-select-part
5428                   (gnus-select-frame-set-input-focus frame)
5429                   (select-window window))))
5430             t))
5431       (if gnus-inhibit-mime-unbuttonizing
5432           ;; This is the default though the program shouldn't reach here.
5433           (error "No such part")
5434         ;; The part which doesn't have the MIME button is selected.
5435         ;; So, we display all the buttons and redo it.
5436         (let ((gnus-inhibit-mime-unbuttonizing t))
5437           (gnus-summary-show-article)
5438           (gnus-article-part-wrapper n function no-handle))))))
5439
5440 (defun gnus-article-pipe-part (n)
5441   "Pipe MIME part N, which is the numerical prefix."
5442   (interactive "P")
5443   (gnus-article-part-wrapper n 'mm-pipe-part))
5444
5445 (defun gnus-article-save-part (n)
5446   "Save MIME part N, which is the numerical prefix."
5447   (interactive "P")
5448   (gnus-article-part-wrapper n 'mm-save-part))
5449
5450 (defun gnus-article-interactively-view-part (n)
5451   "View MIME part N interactively, which is the numerical prefix."
5452   (interactive "P")
5453   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5454
5455 (defun gnus-article-copy-part (n)
5456   "Copy MIME part N, which is the numerical prefix."
5457   (interactive "P")
5458   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5459
5460 (defun gnus-article-view-part-as-charset (n)
5461   "View MIME part N using a specified charset.
5462 N is the numerical prefix."
5463   (interactive "P")
5464   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5465
5466 (defun gnus-article-view-part-externally (n)
5467   "View MIME part N externally, which is the numerical prefix."
5468   (interactive "P")
5469   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5470
5471 (defun gnus-article-inline-part (n)
5472   "Inline MIME part N, which is the numerical prefix."
5473   (interactive "P")
5474   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5475
5476 (defun gnus-article-save-part-and-strip (n)
5477   "Save MIME part N and replace it with an external body.
5478 N is the numerical prefix."
5479   (interactive "P")
5480   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5481
5482 (defun gnus-article-replace-part (n)
5483   "Replace MIME part N with an external body.
5484 N is the numerical prefix."
5485   (interactive "P")
5486   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5487
5488 (defun gnus-article-delete-part (n)
5489   "Delete MIME part N and add some information about the removed part.
5490 N is the numerical prefix."
5491   (interactive "P")
5492   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5493
5494 (defun gnus-article-view-part-as-type (n)
5495   "Choose a MIME media type, and view part N as such.
5496 N is the numerical prefix."
5497   (interactive "P")
5498   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5499
5500 (defun gnus-article-mime-match-handle-first (condition)
5501   (if condition
5502       (let (n)
5503         (dolist (ihandle gnus-article-mime-handle-alist)
5504           (if (and (cond
5505                     ((functionp condition)
5506                      (funcall condition (cdr ihandle)))
5507                     ((eq condition 'undisplayed)
5508                      (not (or (mm-handle-undisplayer (cdr ihandle))
5509                               (equal (mm-handle-media-type (cdr ihandle))
5510                                      "multipart/alternative"))))
5511                     ((eq condition 'undisplayed-alternative)
5512                      (not (mm-handle-undisplayer (cdr ihandle))))
5513                     (t t))
5514                    (gnus-article-goto-part (car ihandle))
5515                    (or (not n) (< (car ihandle) n)))
5516               (setq n (car ihandle))))
5517         (or n 1))
5518     1))
5519
5520 (defun gnus-article-view-part (&optional n)
5521   "View MIME part N, which is the numerical prefix.
5522 If the part is already shown, hide the part.  If N is nil, view
5523 all parts."
5524   (interactive "P")
5525   (with-current-buffer gnus-article-buffer
5526     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5527                              gnus-article-mime-match-handle-function)))
5528     (when (> n (length gnus-article-mime-handle-alist))
5529       (error "No such part"))
5530     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5531       (when (gnus-article-goto-part n)
5532         (if (equal (car handle) "multipart/alternative")
5533             (gnus-article-press-button)
5534           (when (eq (gnus-mm-display-part handle) 'internal)
5535             (gnus-set-window-start)))))))
5536
5537 (defsubst gnus-article-mime-total-parts ()
5538   (if (bufferp (car gnus-article-mime-handles))
5539       1 ;; single part
5540     (1- (length gnus-article-mime-handles))))
5541
5542 (defun gnus-mm-display-part (handle)
5543   "Display HANDLE and fix MIME button."
5544   (let ((id (get-text-property (point) 'gnus-part))
5545         (point (point))
5546         (inhibit-read-only t))
5547     (forward-line 1)
5548     (prog1
5549         (let ((window (selected-window))
5550               (mail-parse-charset gnus-newsgroup-charset)
5551               (mail-parse-ignored-charsets
5552                (if (gnus-buffer-live-p gnus-summary-buffer)
5553                    (with-current-buffer gnus-summary-buffer
5554                      gnus-newsgroup-ignored-charsets)
5555                  nil)))
5556           (save-excursion
5557             (unwind-protect
5558                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5559                       (beg (point)))
5560                   (when win
5561                     (select-window win))
5562                   (goto-char point)
5563                   (forward-line)
5564                   (if (mm-handle-displayed-p handle)
5565                       ;; This will remove the part.
5566                       (mm-display-part handle)
5567                     (save-restriction
5568                       (narrow-to-region (point)
5569                                         (if (eobp) (point) (1+ (point))))
5570                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5571                       ;; We narrow to the part itself and
5572                       ;; then call the treatment functions.
5573                       (goto-char (point-min))
5574                       (forward-line 1)
5575                       (narrow-to-region (point) (point-max))
5576                       (gnus-treat-article
5577                        nil id
5578                        (gnus-article-mime-total-parts)
5579                        (mm-handle-media-type handle)))))
5580               (if (window-live-p window)
5581                   (select-window window)))))
5582       (goto-char point)
5583       (gnus-delete-line)
5584       (gnus-insert-mime-button
5585        handle id (list (mm-handle-displayed-p handle)))
5586       (goto-char point))))
5587
5588 (defun gnus-article-goto-part (n)
5589   "Go to MIME part N."
5590   (when gnus-break-pages
5591     (widen))
5592   (prog1
5593       (let ((start (text-property-any (point-min) (point-max) 'gnus-part n))
5594             part handle end next handles)
5595         (when start
5596           (goto-char start)
5597           (if (setq handle (get-text-property start 'gnus-data))
5598               start
5599             ;; Go to the displayed subpart, assuming this is
5600             ;; multipart/alternative.
5601             (setq part start
5602                   end (point-at-eol))
5603             (while (and (not handle)
5604                         part
5605                         (< part end)
5606                         (setq next (text-property-not-all part end
5607                                                           'gnus-data nil)))
5608               (setq part next
5609                     handle (get-text-property part 'gnus-data))
5610               (push (cons handle part) handles)
5611               (unless (mm-handle-displayed-p handle)
5612                 (setq handle nil
5613                       part (text-property-any part end 'gnus-data nil))))
5614             (unless handle
5615               ;; No subpart is displayed, so we find preferred one.
5616               (setq part
5617                     (cdr (assq (mm-preferred-alternative
5618                                 (nreverse (mapcar 'car handles)))
5619                                handles))))
5620             (if part
5621                 (goto-char (1+ part))
5622               start))))
5623     (when gnus-break-pages
5624       (gnus-narrow-to-page))))
5625
5626 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5627   (let ((gnus-tmp-name
5628          (or (mail-content-type-get (mm-handle-type handle) 'name)
5629              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5630              (mail-content-type-get (mm-handle-type handle) 'url)
5631              ""))
5632         (gnus-tmp-type (mm-handle-media-type handle))
5633         (gnus-tmp-description (or (mm-handle-description handle) ""))
5634         (gnus-tmp-dots
5635          (if (if displayed (car displayed)
5636                (mm-handle-displayed-p handle))
5637              "" "..."))
5638         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5639                            (buffer-size)))
5640         gnus-tmp-type-long b e)
5641     (when (string-match ".*/" gnus-tmp-name)
5642       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5643     (setq gnus-tmp-type-long (concat gnus-tmp-type
5644                                      (and (not (equal gnus-tmp-name ""))
5645                                           (concat "; " gnus-tmp-name))))
5646     (unless (equal gnus-tmp-description "")
5647       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5648     (unless (bolp)
5649       (insert "\n"))
5650     (setq b (point))
5651     (gnus-eval-format
5652      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5653      `(keymap ,gnus-mime-button-map
5654               gnus-callback gnus-mm-display-part
5655               gnus-part ,gnus-tmp-id
5656               article-type annotation
5657               gnus-data ,handle))
5658     (setq e (if (bolp)
5659                 ;; Exclude a newline.
5660                 (1- (point))
5661               (point)))
5662     (when gnus-article-button-face
5663       (gnus-overlay-put (gnus-make-overlay b e nil t)
5664                         'face gnus-article-button-face))
5665     (widget-convert-button
5666      'link b e
5667      :mime-handle handle
5668      :action 'gnus-widget-press-button
5669      :button-keymap gnus-mime-button-map
5670      :help-echo
5671      (lambda (widget)
5672        ;; Needed to properly clear the message due to a bug in
5673        ;; wid-edit (XEmacs only).
5674        (if (boundp 'help-echo-owns-message)
5675            (setq help-echo-owns-message t))
5676        (format
5677         "%S: %s the MIME part; %S: more options"
5678         (aref gnus-mouse-2 0)
5679         (if (mm-handle-displayed-p (widget-get widget :mime-handle))
5680             "hide" "show")
5681         (aref gnus-down-mouse-3 0))))))
5682
5683 (defun gnus-widget-press-button (elems el)
5684   (goto-char (widget-get elems :from))
5685   (gnus-article-press-button))
5686
5687 (defvar gnus-displaying-mime nil)
5688
5689 (defun gnus-display-mime (&optional ihandles)
5690   "Display the MIME parts."
5691   (save-excursion
5692     (save-selected-window
5693       (let ((window (get-buffer-window gnus-article-buffer))
5694             (point (point)))
5695         (when window
5696           (select-window window)
5697           ;; We have to do this since selecting the window
5698           ;; may change the point.  So we set the window point.
5699           (set-window-point window point)))
5700       (let ((handles ihandles)
5701             (inhibit-read-only t)
5702             handle)
5703         (cond (handles)
5704               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5705                (when gnus-article-emulate-mime
5706                  (mm-uu-dissect-text-parts handles)))
5707               (gnus-article-emulate-mime
5708                (setq handles (mm-uu-dissect))))
5709         (when (and (not ihandles)
5710                    (not gnus-displaying-mime))
5711           ;; Top-level call; we clean up.
5712           (when gnus-article-mime-handles
5713             (mm-destroy-parts gnus-article-mime-handles)
5714             (setq gnus-article-mime-handle-alist nil));; A trick.
5715           (setq gnus-article-mime-handles handles)
5716           ;; We allow users to glean info from the handles.
5717           (when gnus-article-mime-part-function
5718             (gnus-mime-part-function handles)))
5719         (if (and handles
5720                  (or (not (stringp (car handles)))
5721                      (cdr handles)))
5722             (progn
5723               (when (and (not ihandles)
5724                          (not gnus-displaying-mime))
5725                 ;; Clean up for mime parts.
5726                 (article-goto-body)
5727                 (delete-region (point) (point-max)))
5728               (let ((gnus-displaying-mime t))
5729                 (gnus-mime-display-part handles)))
5730           (save-restriction
5731             (article-goto-body)
5732             (narrow-to-region (point) (point-max))
5733             (gnus-treat-article nil 1 1 "text/plain")
5734             (widen)))
5735         (unless ihandles
5736           ;; Highlight the headers.
5737           (save-excursion
5738             (save-restriction
5739               (article-goto-body)
5740               (narrow-to-region (point-min) (point))
5741               (gnus-article-save-original-date
5742                (gnus-treat-article 'head)))))))
5743     ;; Cope with broken MIME messages.
5744     (goto-char (point-max))
5745     (unless (bolp)
5746       (insert "\n"))))
5747
5748 (defcustom gnus-mime-display-multipart-as-mixed nil
5749   "Display \"multipart\" parts as  \"multipart/mixed\".
5750
5751 If t, it overrides nil values of
5752 `gnus-mime-display-multipart-alternative-as-mixed' and
5753 `gnus-mime-display-multipart-related-as-mixed'."
5754   :group 'gnus-article-mime
5755   :type 'boolean)
5756
5757 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5758   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5759   :version "22.1"
5760   :group 'gnus-article-mime
5761   :type 'boolean)
5762
5763 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5764   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5765
5766 If displaying \"text/html\" is discouraged \(see
5767 `mm-discouraged-alternatives'\) images or other material inside a
5768 \"multipart/related\" part might be overlooked when this variable is nil."
5769   :version "22.1"
5770   :group 'gnus-article-mime
5771   :type 'boolean)
5772
5773 (defun gnus-mime-display-part (handle)
5774   (cond
5775    ;; Maybe a broken MIME message.
5776    ((null handle))
5777    ;; Single part.
5778    ((not (stringp (car handle)))
5779     (gnus-mime-display-single handle))
5780    ;; User-defined multipart
5781    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5782     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5783              handle))
5784    ;; multipart/alternative
5785    ((and (equal (car handle) "multipart/alternative")
5786          (not (or gnus-mime-display-multipart-as-mixed
5787                   gnus-mime-display-multipart-alternative-as-mixed)))
5788     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5789       (push (cons id handle) gnus-article-mime-handle-alist)
5790       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5791    ;; multipart/related
5792    ((and (equal (car handle) "multipart/related")
5793          (not (or gnus-mime-display-multipart-as-mixed
5794                   gnus-mime-display-multipart-related-as-mixed)))
5795     ;;;!!!We should find the start part, but we just default
5796     ;;;!!!to the first part.
5797     ;;(gnus-mime-display-part (cadr handle))
5798     ;;;!!! Most multipart/related is an HTML message plus images.
5799     ;;;!!! Unfortunately we are unable to let W3 display those
5800     ;;;!!! included images, so we just display it as a mixed multipart.
5801     ;;(gnus-mime-display-mixed (cdr handle))
5802     ;;;!!! No, w3 can display everything just fine.
5803     (gnus-mime-display-part (cadr handle)))
5804    ((equal (car handle) "multipart/signed")
5805     (gnus-add-wash-type 'signed)
5806     (gnus-mime-display-security handle))
5807    ((equal (car handle) "multipart/encrypted")
5808     (gnus-add-wash-type 'encrypted)
5809     (gnus-mime-display-security handle))
5810    ;; Other multiparts are handled like multipart/mixed.
5811    (t
5812     (gnus-mime-display-mixed (cdr handle)))))
5813
5814 (defun gnus-mime-part-function (handles)
5815   (if (stringp (car handles))
5816       (mapcar 'gnus-mime-part-function (cdr handles))
5817     (funcall gnus-article-mime-part-function handles)))
5818
5819 (defun gnus-mime-display-mixed (handles)
5820   (mapcar 'gnus-mime-display-part handles))
5821
5822 (defun gnus-mime-display-single (handle)
5823   (let ((type (mm-handle-media-type handle))
5824         (ignored gnus-ignored-mime-types)
5825         (not-attachment t)
5826         (move nil)
5827         display text)
5828     (catch 'ignored
5829       (progn
5830         (while ignored
5831           (when (string-match (pop ignored) type)
5832             (throw 'ignored nil)))
5833         (if (and (setq not-attachment
5834                        (and (not (mm-inline-override-p handle))
5835                             (or (not (mm-handle-disposition handle))
5836                                 (equal (car (mm-handle-disposition handle))
5837                                        "inline")
5838                                 (mm-attachment-override-p handle))))
5839                  (mm-automatic-display-p handle)
5840                  (or (and
5841                       (mm-inlinable-p handle)
5842                       (mm-inlined-p handle))
5843                      (mm-automatic-external-display-p type)))
5844             (setq display t)
5845           (when (equal (mm-handle-media-supertype handle) "text")
5846             (setq text t)))
5847         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5848               beg)
5849           (push (cons id handle) gnus-article-mime-handle-alist)
5850           (when (and display
5851                      (equal (mm-handle-media-supertype handle) "message"))
5852             (insert-char
5853              ?\n
5854              (cond ((not (bolp)) 2)
5855                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5856                    (t 1))))
5857           (when (or (not display)
5858                     (not (gnus-unbuttonized-mime-type-p type))
5859                     (eq id gnus-mime-buttonized-part-id))
5860             (gnus-insert-mime-button
5861              handle id (list (or display (and not-attachment text))))
5862             (gnus-article-insert-newline)
5863             ;; Remember modify the number of forward lines.
5864             (setq move t))
5865           (setq beg (point))
5866           (cond
5867            (display
5868             (when move
5869               (forward-line -1)
5870               (setq beg (point)))
5871             (let ((mail-parse-charset gnus-newsgroup-charset)
5872                   (mail-parse-ignored-charsets
5873                    (save-excursion (condition-case ()
5874                                        (set-buffer gnus-summary-buffer)
5875                                      (error))
5876                                    gnus-newsgroup-ignored-charsets)))
5877               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5878             (goto-char (point-max)))
5879            ((and text not-attachment)
5880             (when move
5881               (forward-line -1)
5882               (setq beg (point)))
5883             (gnus-article-insert-newline)
5884             (mm-insert-inline
5885              handle
5886              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5887                                                        'charset)
5888                                 (and (equal type "text/calendar") 'utf-8))))
5889                (cond ((not charset)
5890                       (mm-string-as-multibyte (mm-get-part handle)))
5891                      ((eq charset 'gnus-decoded)
5892                       (with-current-buffer (mm-handle-buffer handle)
5893                         (buffer-string)))
5894                      (t
5895                       (mm-decode-string (mm-get-part handle) charset)))))
5896             (goto-char (point-max))))
5897           ;; Do highlighting.
5898           (save-excursion
5899             (save-restriction
5900               (narrow-to-region beg (point))
5901               (if (eq handle gnus-article-mime-handles)
5902                   ;; The format=flowed case.
5903                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5904                 ;; Don't count signature parts that are never displayed.
5905                 ;; The part number should be re-calculated supposing this
5906                 ;; might be a message/rfc822 part.
5907                 (let (handles)
5908                   (dolist (part gnus-article-mime-handles)
5909                     (unless (or (stringp part)
5910                                 (equal (car (mm-handle-type part))
5911                                        "application/pgp-signature"))
5912                       (push part handles)))
5913                   (gnus-treat-article
5914                    nil (length (memq handle handles)) (length handles)
5915                    (mm-handle-media-type handle)))))))))))
5916
5917 (defun gnus-unbuttonized-mime-type-p (type)
5918   "Say whether TYPE is to be unbuttonized."
5919   (unless gnus-inhibit-mime-unbuttonizing
5920     (when (catch 'found
5921             (let ((types gnus-unbuttonized-mime-types))
5922               (while types
5923                 (when (string-match (pop types) type)
5924                   (throw 'found t)))))
5925       (not (catch 'found
5926              (let ((types gnus-buttonized-mime-types))
5927                (while types
5928                  (when (string-match (pop types) type)
5929                    (throw 'found t)))))))))
5930
5931 (defun gnus-article-insert-newline ()
5932   "Insert a newline, but mark it as undeletable."
5933   (gnus-put-text-property
5934    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5935
5936 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5937   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5938          (ihandles handles)
5939          (point (point))
5940          handle (inhibit-read-only t) from props begend not-pref)
5941     (save-window-excursion
5942       (save-restriction
5943         (when ibegend
5944           (narrow-to-region (car ibegend)
5945                             (or (cdr ibegend)
5946                                 (progn
5947                                   (goto-char (car ibegend))
5948                                   (forward-line 2)
5949                                   (point))))
5950           (delete-region (point-min) (point-max))
5951           (mm-remove-parts handles))
5952         (setq begend (list (point-marker)))
5953         ;; Do the toggle.
5954         (unless (setq not-pref (cadr (member preferred ihandles)))
5955           (setq not-pref (car ihandles)))
5956         (when (or ibegend
5957                   (not preferred)
5958                   (not (gnus-unbuttonized-mime-type-p
5959                         "multipart/alternative")))
5960           (gnus-add-text-properties
5961            (setq from (point))
5962            (progn
5963              (insert (format "%d.  " id))
5964              (point))
5965            `(gnus-callback
5966              (lambda (handles)
5967                (unless ,(not ibegend)
5968                  (setq gnus-article-mime-handle-alist
5969                        ',gnus-article-mime-handle-alist))
5970                (gnus-mime-display-alternative
5971                 ',ihandles ',not-pref ',begend ,id))
5972              keymap ,gnus-mime-button-map
5973              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5974              face ,gnus-article-button-face
5975              gnus-part ,id
5976              article-type multipart))
5977           (widget-convert-button 'link from (point)
5978                                  :action 'gnus-widget-press-button
5979                                  :button-keymap gnus-widget-button-keymap)
5980           ;; Do the handles
5981           (while (setq handle (pop handles))
5982             (gnus-add-text-properties
5983              (setq from (point))
5984              (progn
5985                (insert (format "(%c) %-18s"
5986                                (if (equal handle preferred) ?* ? )
5987                                (mm-handle-media-type handle)))
5988                (point))
5989              `(gnus-callback
5990                (lambda (handles)
5991                  (unless ,(not ibegend)
5992                    (setq gnus-article-mime-handle-alist
5993                          ',gnus-article-mime-handle-alist))
5994                  (gnus-mime-display-alternative
5995                   ',ihandles ',handle ',begend ,id))
5996                keymap ,gnus-mime-button-map
5997                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5998                face ,gnus-article-button-face
5999                gnus-part ,id
6000                gnus-data ,handle))
6001             (widget-convert-button 'link from (point)
6002                                    :action 'gnus-widget-press-button
6003                                    :button-keymap gnus-widget-button-keymap)
6004             (insert "  "))
6005           (insert "\n\n"))
6006         (when preferred
6007           (if (stringp (car preferred))
6008               (gnus-display-mime preferred)
6009             (let ((mail-parse-charset gnus-newsgroup-charset)
6010                   (mail-parse-ignored-charsets
6011                    (with-current-buffer gnus-summary-buffer
6012                      gnus-newsgroup-ignored-charsets)))
6013               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6014               ;; Do highlighting.
6015               (save-excursion
6016                 (save-restriction
6017                   (narrow-to-region (car begend) (point-max))
6018                   (gnus-treat-article
6019                    nil (length gnus-article-mime-handle-alist)
6020                    (gnus-article-mime-total-parts)
6021                    (mm-handle-media-type preferred))))))
6022           (goto-char (point-max))
6023           (setcdr begend (point-marker)))))
6024     (when ibegend
6025       (goto-char point))))
6026
6027 (defconst gnus-article-wash-status-strings
6028   (let ((alist '((cite "c" "Possible hidden citation text"
6029                        " " "All citation text visible")
6030                  (headers "h" "Hidden headers"
6031                           " " "All headers visible.")
6032                  (pgp "p" "Encrypted or signed message status hidden"
6033                       " " "No hidden encryption nor digital signature status")
6034                  (signature "s" "Signature has been hidden"
6035                             " " "Signature is visible")
6036                  (overstrike "o" "Overstrike (^H) characters applied"
6037                              " " "No overstrike characters applied")
6038                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6039                            " " "No /*_emphasis_*/ characters applied")))
6040         result)
6041     (dolist (entry alist result)
6042       (let ((key (nth 0 entry))
6043             (on (copy-sequence (nth 1 entry)))
6044             (on-help (nth 2 entry))
6045             (off (copy-sequence (nth 3 entry)))
6046             (off-help (nth 4 entry)))
6047         (put-text-property 0 1 'help-echo on-help on)
6048         (put-text-property 0 1 'help-echo off-help off)
6049         (push (list key on off) result))))
6050   "Alist of strings describing wash status in the mode line.
6051 Each entry has the form (KEY ON OF), where the KEY is a symbol
6052 representing the particular washing function, ON is the string to use
6053 in the article mode line when the washing function is active, and OFF
6054 is the string to use when it is inactive.")
6055
6056 (defun gnus-article-wash-status-entry (key value)
6057   (let ((entry (assoc key gnus-article-wash-status-strings)))
6058     (if value (nth 1 entry) (nth 2 entry))))
6059
6060 (defun gnus-article-wash-status ()
6061   "Return a string which display status of article washing."
6062   (with-current-buffer gnus-article-buffer
6063     (let ((cite (memq 'cite gnus-article-wash-types))
6064           (headers (memq 'headers gnus-article-wash-types))
6065           (boring (memq 'boring-headers gnus-article-wash-types))
6066           (pgp (memq 'pgp gnus-article-wash-types))
6067           (pem (memq 'pem gnus-article-wash-types))
6068           (signed (memq 'signed gnus-article-wash-types))
6069           (encrypted (memq 'encrypted gnus-article-wash-types))
6070           (signature (memq 'signature gnus-article-wash-types))
6071           (overstrike (memq 'overstrike gnus-article-wash-types))
6072           (emphasis (memq 'emphasis gnus-article-wash-types)))
6073       (concat
6074        (gnus-article-wash-status-entry 'cite cite)
6075        (gnus-article-wash-status-entry 'headers (or headers boring))
6076        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6077        (gnus-article-wash-status-entry 'signature signature)
6078        (gnus-article-wash-status-entry 'overstrike overstrike)
6079        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6080
6081 (defun gnus-add-wash-type (type)
6082   "Add a washing of TYPE to the current status."
6083   (add-to-list 'gnus-article-wash-types type))
6084
6085 (defun gnus-delete-wash-type (type)
6086   "Add a washing of TYPE to the current status."
6087   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6088
6089 (defun gnus-add-image (category image)
6090   "Add IMAGE of CATEGORY to the list of displayed images."
6091   (let ((entry (assq category gnus-article-image-alist)))
6092     (unless entry
6093       (setq entry (list category))
6094       (push entry gnus-article-image-alist))
6095     (nconc entry (list image))))
6096
6097 (defun gnus-delete-images (category)
6098   "Delete all images in CATEGORY."
6099   (let ((entry (assq category gnus-article-image-alist)))
6100     (dolist (image (cdr entry))
6101       (gnus-remove-image image category))
6102     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6103     (gnus-delete-wash-type category)))
6104
6105 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6106
6107 (defun gnus-article-maybe-hide-headers ()
6108   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6109 Provided for backwards compatibility."
6110   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6111                  (not (with-current-buffer gnus-summary-buffer
6112                         gnus-have-all-headers)))
6113              (not gnus-inhibit-hiding))
6114     (gnus-article-hide-headers)))
6115
6116 ;;; Article savers.
6117
6118 (defun gnus-output-to-file (file-name)
6119   "Append the current article to a file named FILE-NAME.
6120 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6121 text and used as the value of the coding cookie which is added to the
6122 top of a file.  Otherwise, this function saves a raw article without
6123 the coding cookie."
6124   (let* ((artbuf (current-buffer))
6125          (file-name-coding-system nnmail-pathname-coding-system)
6126          (coding gnus-article-save-coding-system)
6127          (coding-system-for-read (if coding
6128                                      nil ;; Rely on the coding cookie.
6129                                    mm-text-coding-system))
6130          (coding-system-for-write (or coding
6131                                       mm-text-coding-system-for-write
6132                                       mm-text-coding-system))
6133          (exists (file-exists-p file-name)))
6134     (with-temp-buffer
6135       (when exists
6136         (insert-file-contents file-name)
6137         (goto-char (point-min))
6138         ;; Remove the existing coding cookie.
6139         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6140           (delete-region (match-beginning 0) (match-end 0))))
6141       (goto-char (point-max))
6142       (insert-buffer-substring artbuf)
6143       ;; Append newline at end of the buffer as separator, and then
6144       ;; save it to file.
6145       (goto-char (point-max))
6146       (insert "\n")
6147       (when coding
6148         ;; If the coding system is not suitable to encode the text,
6149         ;; ask a user for a proper one.
6150         (when (fboundp 'select-safe-coding-system)
6151           (setq coding (coding-system-base
6152                         (save-window-excursion
6153                           (select-safe-coding-system (point-min) (point-max)
6154                                                      coding))))
6155           (setq coding-system-for-write
6156                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6157                     coding)))
6158         (goto-char (point-min))
6159         ;; Add the coding cookie.
6160         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6161                         coding-system-for-write)))
6162       (if exists
6163           (progn
6164             (write-region (point-min) (point-max) file-name nil 'no-message)
6165             (message "Appended to %s" file-name))
6166         (write-region (point-min) (point-max) file-name))))
6167   t)
6168
6169 (defun gnus-narrow-to-page (&optional arg)
6170   "Narrow the article buffer to a page.
6171 If given a numerical ARG, move forward ARG pages."
6172   (interactive "P")
6173   (setq arg (if arg (prefix-numeric-value arg) 0))
6174   (with-current-buffer gnus-article-buffer
6175     (widen)
6176     ;; Remove any old next/prev buttons.
6177     (when (gnus-visual-p 'page-marker)
6178       (let ((inhibit-read-only t))
6179         (gnus-remove-text-with-property 'gnus-prev)
6180         (gnus-remove-text-with-property 'gnus-next)))
6181     (let (st nd pt)
6182       (when (save-excursion
6183               (cond ((< arg 0)
6184                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6185                          (prog1
6186                              (setq nd (match-beginning 0)
6187                                    pt nd)
6188                            (when (re-search-backward page-delimiter nil t)
6189                              (setq st (match-end 0))))
6190                        (when (re-search-forward page-delimiter nil t)
6191                          (setq nd (match-beginning 0)
6192                                pt (point-min)))))
6193                     ((> arg 0)
6194                      (if (re-search-forward page-delimiter nil 'move arg)
6195                          (prog1
6196                              (setq st (match-end 0)
6197                                    pt st)
6198                            (when (re-search-forward page-delimiter nil t)
6199                              (setq nd (match-beginning 0))))
6200                        (when (re-search-backward page-delimiter nil t)
6201                          (setq st (match-end 0)
6202                                pt (point-max)))))
6203                     (t
6204                      (when (re-search-backward page-delimiter nil t)
6205                        (goto-char (setq st (match-end 0))))
6206                      (when (re-search-forward page-delimiter nil t)
6207                        (setq nd (match-beginning 0)))
6208                      (or st nd))))
6209         (setq gnus-page-broken t)
6210         (when pt (goto-char pt))
6211         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6212         (when (gnus-visual-p 'page-marker)
6213           (save-excursion
6214             (when nd
6215               (goto-char nd)
6216               (gnus-insert-next-page-button))
6217             (when st
6218               (goto-char st)
6219               (gnus-insert-prev-page-button))))))))
6220
6221 ;; Article mode commands
6222
6223 (defun gnus-article-goto-next-page ()
6224   "Show the next page of the article."
6225   (interactive)
6226   (when (gnus-article-next-page)
6227     (goto-char (point-min))
6228     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6229
6230
6231 (defun gnus-article-goto-prev-page ()
6232   "Show the previous page of the article."
6233   (interactive)
6234   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6235       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6236     (gnus-article-prev-page nil)))
6237
6238 ;; This is cleaner but currently breaks `gnus-pick-mode':
6239 ;;
6240 ;; (defun gnus-article-goto-next-page ()
6241 ;;   "Show the next page of the article."
6242 ;;   (interactive)
6243 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6244 ;;     (gnus-summary-next-page)))
6245 ;;
6246 ;; (defun gnus-article-goto-prev-page ()
6247 ;;   "Show the next page of the article."
6248 ;;   (interactive)
6249 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6250 ;;     (gnus-summary-prev-page)))
6251
6252 (defun gnus-article-next-page (&optional lines)
6253   "Show the next page of the current article.
6254 If end of article, return non-nil.  Otherwise return nil.
6255 Argument LINES specifies lines to be scrolled up."
6256   (interactive "p")
6257   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6258   (if (and (not (and gnus-article-over-scroll
6259                      (> (count-lines (window-start) (point-max))
6260                         (if (featurep 'xemacs)
6261                             (or lines (1- (window-height)))
6262                           (+ (or lines (1- (window-height))) scroll-margin)))))
6263            (save-excursion
6264              (end-of-line)
6265              (and (pos-visible-in-window-p)     ;Not continuation line.
6266                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6267       ;; Nothing in this page.
6268       (if (or (not gnus-page-broken)
6269               (save-excursion
6270                 (save-restriction
6271                   (widen)
6272                   (forward-line)
6273                   (eobp)))) ;Real end-of-buffer?
6274           (progn
6275             (when gnus-article-over-scroll
6276               (gnus-article-next-page-1 lines))
6277             t)                  ;Nothing more.
6278         (gnus-narrow-to-page 1)         ;Go to next page.
6279         nil)
6280     ;; More in this page.
6281     (gnus-article-next-page-1 lines)
6282     nil))
6283
6284 (defun gnus-article-beginning-of-window ()
6285   "Move point to the beginning of the window.
6286 In Emacs, the point is placed at the line number which `scroll-margin'
6287 specifies."
6288   (if (featurep 'xemacs)
6289       (move-to-window-line 0)
6290     ;; There is an obscure bug in Emacs that makes it impossible to
6291     ;; scroll past big pictures in the article buffer.  Try to fix
6292     ;; this by adding a sanity check by counting the lines visible.
6293     (when (> (count-lines (window-start) (window-end)) 30)
6294       (move-to-window-line
6295        (min (max 0 scroll-margin)
6296             (max 1 (- (window-height)
6297                       (if mode-line-format 1 0)
6298                       (if header-line-format 1 0)
6299                       2)))))))
6300
6301 (defun gnus-article-next-page-1 (lines)
6302   (condition-case ()
6303       (let ((scroll-in-place nil))
6304         (scroll-up lines))
6305     (end-of-buffer
6306      ;; Long lines may cause an end-of-buffer error.
6307      (goto-char (point-max))))
6308   (gnus-article-beginning-of-window))
6309
6310 (defun gnus-article-prev-page (&optional lines)
6311   "Show previous page of current article.
6312 Argument LINES specifies lines to be scrolled down."
6313   (interactive "p")
6314   (move-to-window-line 0)
6315   (if (and gnus-page-broken
6316            (bobp)
6317            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6318       (progn
6319         (gnus-narrow-to-page -1)        ;Go to previous page.
6320         (goto-char (point-max))
6321         (recenter (if gnus-article-over-scroll
6322                       (if lines
6323                           (max (if (featurep 'xemacs)
6324                                    lines
6325                                  (+ lines scroll-margin))
6326                                3)
6327                         (- (window-height) 2))
6328                     -1)))
6329     (prog1
6330         (condition-case ()
6331             (let ((scroll-in-place nil))
6332               (scroll-down lines))
6333           (beginning-of-buffer
6334            (goto-char (point-min))))
6335       (gnus-article-beginning-of-window))))
6336
6337 (defun gnus-article-only-boring-p ()
6338   "Decide whether there is only boring text remaining in the article.
6339 Something \"interesting\" is a word of at least two letters that does
6340 not have a face in `gnus-article-boring-faces'."
6341   (when (and gnus-article-skip-boring
6342              (boundp 'gnus-article-boring-faces)
6343              (symbol-value 'gnus-article-boring-faces))
6344     (save-excursion
6345       (let ((inhibit-point-motion-hooks t))
6346         (catch 'only-boring
6347           (while (re-search-forward "\\b\\w\\w" nil t)
6348             (forward-char -1)
6349             (when (not (gnus-intersection
6350                         (gnus-faces-at (point))
6351                         (symbol-value 'gnus-article-boring-faces)))
6352               (throw 'only-boring nil)))
6353           (throw 'only-boring t))))))
6354
6355 (defun gnus-article-refer-article ()
6356   "Read article specified by message-id around point."
6357   (interactive)
6358   (save-excursion
6359     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6360     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6361     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6362         (let ((msg-id (concat "<" (match-string 0) ">")))
6363           (set-buffer gnus-summary-buffer)
6364           (gnus-summary-refer-article msg-id))
6365       (error "No references around point"))))
6366
6367 (defun gnus-article-show-summary ()
6368   "Reconfigure windows to show summary buffer."
6369   (interactive)
6370   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6371       (error "There is no summary buffer for this article buffer")
6372     (gnus-article-set-globals)
6373     (gnus-configure-windows 'article)
6374     (gnus-summary-goto-subject gnus-current-article)
6375     (gnus-summary-position-point)))
6376
6377 (defun gnus-article-describe-briefly ()
6378   "Describe article mode commands briefly."
6379   (interactive)
6380   (gnus-message 6 "%s" (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")))
6381
6382 (defun gnus-article-check-buffer ()
6383   "Beep if not in an article buffer."
6384   (unless (equal major-mode 'gnus-article-mode)
6385     (error "Command invoked outside of a Gnus article buffer")))
6386
6387 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6388   "Read a summary buffer key sequence and execute it from the article buffer."
6389   (interactive "P")
6390   (gnus-article-check-buffer)
6391   (let ((nosaves
6392          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6393            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6394            "=" "^" "\M-^" "|"))
6395         (nosave-but-article
6396          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6397            "An" "Ap" [?A (meta return)] [?A delete]))
6398         (nosave-in-article
6399          '("AS" "\C-d"))
6400         (up-to-top
6401          '("n" "Gn" "p" "Gp"))
6402         keys new-sum-point)
6403     (with-current-buffer gnus-article-current-summary
6404       (let (gnus-pick-mode)
6405         (setq unread-command-events (nconc unread-command-events
6406                                            (list (or key last-command-event)))
6407               keys (if (featurep 'xemacs)
6408                        (events-to-keys (read-key-sequence nil t))
6409                      (read-key-sequence nil t)))))
6410
6411     (message "")
6412
6413     (cond
6414      ((eq (aref keys (1- (length keys))) ?\C-h)
6415       (gnus-article-describe-bindings (substring keys 0 -1)))
6416      ((or (member keys nosaves)
6417           (member keys nosave-but-article)
6418           (member keys nosave-in-article))
6419       (let (func)
6420         (save-window-excursion
6421           (pop-to-buffer gnus-article-current-summary)
6422           ;; We disable the pick minor mode commands.
6423           (let (gnus-pick-mode)
6424             (setq func (key-binding keys t))))
6425         (if (or (not func)
6426                 (numberp func))
6427             (ding)
6428           (unless (member keys nosave-in-article)
6429             (set-buffer gnus-article-current-summary))
6430           (call-interactively func)
6431           (setq new-sum-point (point)))
6432         (when (member keys nosave-but-article)
6433           (pop-to-buffer gnus-article-buffer))))
6434      (t
6435       ;; These commands should restore window configuration.
6436       (let ((obuf (current-buffer))
6437             (owin (current-window-configuration))
6438             win func in-buffer selected new-sum-start new-sum-hscroll err)
6439         (cond (not-restore-window
6440                (pop-to-buffer gnus-article-current-summary)
6441                (setq win (selected-window)))
6442               ((setq win (get-buffer-window gnus-article-current-summary))
6443                (select-window win))
6444               (t
6445                (let ((summary-buffer gnus-article-current-summary))
6446                  (gnus-configure-windows 'article)
6447                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6448                    (let ((gnus-buffer-configuration
6449                           '((article ((vertical 1.0
6450                                                 (summary 0.25 point)
6451                                                 (article 1.0)))))))
6452                      (gnus-configure-windows 'article))
6453                    (setq win (get-buffer-window summary-buffer 'visible)))
6454                  (gnus-select-frame-set-input-focus (window-frame win))
6455                  (select-window win))))
6456         (setq in-buffer (current-buffer))
6457         ;; We disable the pick minor mode commands.
6458         (if (and (setq func (let (gnus-pick-mode)
6459                               (key-binding keys t)))
6460                  (functionp func)
6461                  (condition-case code
6462                      (progn
6463                        (call-interactively func)
6464                        t)
6465                    (error
6466                     (setq err code)
6467                     nil)))
6468             (progn
6469               (when (eq win (selected-window))
6470                 (setq new-sum-point (point)
6471                       new-sum-start (window-start win)
6472                       new-sum-hscroll (window-hscroll win)))
6473               (when (or (eq in-buffer (current-buffer))
6474                         (when (eq obuf (current-buffer))
6475                           (set-buffer in-buffer)
6476                           t))
6477                 (setq selected (gnus-summary-select-article))
6478                 (set-buffer obuf)
6479                 (unless not-restore-window
6480                   (set-window-configuration owin))
6481                 (when (and (eq selected 'old)
6482                            new-sum-point)
6483                   (set-window-start (get-buffer-window (current-buffer))
6484                                     1)
6485                   (set-window-point (get-buffer-window (current-buffer))
6486                                     (if (article-goto-body)
6487                                         (1- (point))
6488                                       (point))))
6489                 (when (and (not not-restore-window)
6490                            new-sum-point
6491                            (window-live-p win)
6492                            (with-current-buffer (window-buffer win)
6493                              (eq major-mode 'gnus-summary-mode)))
6494                   (set-window-point win new-sum-point)
6495                   (set-window-start win new-sum-start)
6496                   (set-window-hscroll win new-sum-hscroll))))
6497           (set-window-configuration owin)
6498           (if err
6499               (signal (car err) (cdr err))
6500             (ding))))))))
6501
6502 (defun gnus-article-read-summary-send-keys ()
6503   (interactive)
6504   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6505     (gnus-article-read-summary-keys)))
6506
6507 (defun gnus-article-describe-key (key)
6508   "Display documentation of the function invoked by KEY.
6509 KEY is a string or a vector."
6510   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6511                        (read-key-sequence "Describe key: "))))
6512   (gnus-article-check-buffer)
6513   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6514                                   gnus-article-read-summary-send-keys))
6515       (with-current-buffer gnus-article-current-summary
6516         (setq unread-command-events
6517               (if (featurep 'xemacs)
6518                   (append key nil)
6519                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6520                                         (list 'meta (- x 128))
6521                                       x))
6522                         key)))
6523         (let ((cursor-in-echo-area t)
6524               gnus-pick-mode)
6525           (describe-key (read-key-sequence nil t))))
6526     (describe-key key)))
6527
6528 (defun gnus-article-describe-key-briefly (key &optional insert)
6529   "Display documentation of the function invoked by KEY.
6530 KEY is a string or a vector."
6531   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6532                        (read-key-sequence "Describe key: "))
6533                      current-prefix-arg))
6534   (gnus-article-check-buffer)
6535   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6536                                   gnus-article-read-summary-send-keys))
6537       (with-current-buffer gnus-article-current-summary
6538         (setq unread-command-events
6539               (if (featurep 'xemacs)
6540                   (append key nil)
6541                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6542                                         (list 'meta (- x 128))
6543                                       x))
6544                         key)))
6545         (let ((cursor-in-echo-area t)
6546               gnus-pick-mode)
6547           (describe-key-briefly (read-key-sequence nil t) insert)))
6548     (describe-key-briefly key insert)))
6549
6550 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6551 (defvar gnus-agent-summary-mode)
6552 (defvar gnus-draft-mode)
6553 ;; Calling help-buffer will autoload help-mode.
6554 (defvar help-xref-stack-item)
6555 ;; Emacs 22 doesn't load it in the batch mode.
6556 (eval-when-compile
6557   (autoload 'help-buffer "help-mode"))
6558
6559 (defun gnus-article-describe-bindings (&optional prefix)
6560   "Show a list of all defined keys, and their definitions.
6561 The optional argument PREFIX, if non-nil, should be a key sequence;
6562 then we display only bindings that start with that prefix."
6563   (interactive)
6564   (gnus-article-check-buffer)
6565   (let ((keymap (copy-keymap gnus-article-mode-map))
6566         (map (copy-keymap gnus-article-send-map))
6567         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6568         parent agent draft)
6569     (define-key keymap "S" map)
6570     (define-key map [t] nil)
6571     (with-current-buffer gnus-article-current-summary
6572       (set-keymap-parent
6573        keymap
6574        (if (setq parent (keymap-parent gnus-article-mode-map))
6575            (prog1
6576                (setq parent (copy-keymap parent))
6577              (set-keymap-parent parent (current-local-map)))
6578          (current-local-map)))
6579       (set-keymap-parent map (key-binding "S"))
6580       (let (key def gnus-pick-mode)
6581         (while sumkeys
6582           (setq key (pop sumkeys))
6583           (cond ((and (vectorp key) (= (length key) 1)
6584                       (consp (setq def (aref key 0)))
6585                       (numberp (car def)) (numberp (cdr def)))
6586                  (when (< (max (car def) (cdr def)) 128)
6587                    (setq sumkeys
6588                          (append (mapcar
6589                                   #'vector
6590                                   (nreverse (gnus-uncompress-range def)))
6591                                  sumkeys))))
6592                 ((setq def (key-binding key))
6593                  (unless (eq def 'undefined)
6594                    (define-key keymap key def))))))
6595       (when (boundp 'gnus-agent-summary-mode)
6596         (setq agent gnus-agent-summary-mode))
6597       (when (boundp 'gnus-draft-mode)
6598         (setq draft gnus-draft-mode)))
6599     (with-temp-buffer
6600       (use-local-map keymap)
6601       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6602       (set (make-local-variable 'gnus-draft-mode) draft)
6603       (describe-bindings prefix))
6604     (let ((item `((lambda (prefix)
6605                     (with-current-buffer ,(current-buffer)
6606                       (gnus-article-describe-bindings prefix)))
6607                   ,prefix)))
6608       (with-current-buffer (let (help-xref-following) (help-buffer))
6609         (setq help-xref-stack-item item)))))
6610
6611 (defun gnus-article-reply-with-original (&optional wide)
6612   "Start composing a reply mail to the current message.
6613 The text in the region will be yanked.  If the region isn't active,
6614 the entire article will be yanked."
6615   (interactive)
6616   (let ((article (cdr gnus-article-current))
6617         contents)
6618     (if (not (gnus-region-active-p))
6619         (with-current-buffer gnus-summary-buffer
6620           (gnus-summary-reply (list (list article)) wide))
6621       (setq contents (buffer-substring (point) (mark t)))
6622       ;; Deactivate active regions.
6623       (when (and (boundp 'transient-mark-mode)
6624                  transient-mark-mode)
6625         (setq mark-active nil))
6626       (with-current-buffer gnus-summary-buffer
6627         (gnus-summary-reply
6628          (list (list article contents)) wide)))))
6629
6630 (defun gnus-article-wide-reply-with-original ()
6631   "Start composing a wide reply mail to the current message.
6632 The text in the region will be yanked.  If the region isn't active,
6633 the entire article will be yanked."
6634   (interactive)
6635   (gnus-article-reply-with-original t))
6636
6637 (defun gnus-article-followup-with-original ()
6638   "Compose a followup to the current article.
6639 The text in the region will be yanked.  If the region isn't active,
6640 the entire article will be yanked."
6641   (interactive)
6642   (let ((article (cdr gnus-article-current))
6643         contents)
6644       (if (not (gnus-region-active-p))
6645           (with-current-buffer gnus-summary-buffer
6646             (gnus-summary-followup (list (list article))))
6647         (setq contents (buffer-substring (point) (mark t)))
6648         ;; Deactivate active regions.
6649         (when (and (boundp 'transient-mark-mode)
6650                    transient-mark-mode)
6651           (setq mark-active nil))
6652         (with-current-buffer gnus-summary-buffer
6653           (gnus-summary-followup
6654            (list (list article contents)))))))
6655
6656 (defun gnus-article-hide (&optional arg force)
6657   "Hide all the gruft in the current article.
6658 This means that signatures, cited text and (some) headers will be
6659 hidden.
6660 If given a prefix, show the hidden text instead."
6661   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6662   (gnus-article-hide-headers arg)
6663   (gnus-article-hide-list-identifiers arg)
6664   (gnus-article-hide-citation-maybe arg force)
6665   (gnus-article-hide-signature arg))
6666
6667 (defun gnus-article-maybe-highlight ()
6668   "Do some article highlighting if article highlighting is requested."
6669   (when (gnus-visual-p 'article-highlight 'highlight)
6670     (gnus-article-highlight-some)))
6671
6672 (defun gnus-check-group-server ()
6673   ;; Make sure the connection to the server is alive.
6674   (unless (gnus-server-opened
6675            (gnus-find-method-for-group gnus-newsgroup-name))
6676     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6677     (gnus-request-group gnus-newsgroup-name t)))
6678
6679 (eval-when-compile
6680   (autoload 'nneething-get-file-name "nneething"))
6681
6682 (defun gnus-request-article-this-buffer (article group)
6683   "Get an article and insert it into this buffer."
6684   (let (do-update-line sparse-header)
6685     (prog1
6686         (save-excursion
6687           (erase-buffer)
6688           (gnus-kill-all-overlays)
6689           (setq group (or group gnus-newsgroup-name))
6690
6691           ;; Using `gnus-request-article' directly will insert the article into
6692           ;; `nntp-server-buffer' - so we'll save some time by not having to
6693           ;; copy it from the server buffer into the article buffer.
6694
6695           ;; We only request an article by message-id when we do not have the
6696           ;; headers for it, so we'll have to get those.
6697           (when (stringp article)
6698             (gnus-read-header article))
6699
6700           ;; If the article number is negative, that means that this article
6701           ;; doesn't belong in this newsgroup (possibly), so we find its
6702           ;; message-id and request it by id instead of number.
6703           (when (and (numberp article)
6704                      gnus-summary-buffer
6705                      (get-buffer gnus-summary-buffer)
6706                      (gnus-buffer-exists-p gnus-summary-buffer))
6707             (with-current-buffer gnus-summary-buffer
6708               (let ((header (gnus-summary-article-header article)))
6709                 (when (< article 0)
6710                   (cond
6711                    ((memq article gnus-newsgroup-sparse)
6712                     ;; This is a sparse gap article.
6713                     (setq do-update-line article)
6714                     (setq article (mail-header-id header))
6715                     (setq sparse-header (gnus-read-header article))
6716                     (setq gnus-newsgroup-sparse
6717                           (delq article gnus-newsgroup-sparse)))
6718                    ((vectorp header)
6719                     ;; It's a real article.
6720                     (setq article (mail-header-id header)))
6721                    (t
6722                     ;; It is an extracted pseudo-article.
6723                     (setq article 'pseudo)
6724                     (gnus-request-pseudo-article header))))
6725
6726                 (let ((method (gnus-find-method-for-group
6727                                gnus-newsgroup-name)))
6728                   (when (and (eq (car method) 'nneething)
6729                              (vectorp header))
6730                     (let ((dir (nneething-get-file-name
6731                                 (mail-header-id header))))
6732                       (when (and (stringp dir)
6733                                  (file-directory-p dir))
6734                         (setq article 'nneething)
6735                         (gnus-group-enter-directory dir))))))))
6736
6737           (cond
6738            ;; Refuse to select canceled articles.
6739            ((and (numberp article)
6740                  gnus-summary-buffer
6741                  (get-buffer gnus-summary-buffer)
6742                  (gnus-buffer-exists-p gnus-summary-buffer)
6743                  (eq (cdr (with-current-buffer gnus-summary-buffer
6744                             (assq article gnus-newsgroup-reads)))
6745                      gnus-canceled-mark))
6746             nil)
6747            ;; We first check `gnus-original-article-buffer'.
6748            ((and (get-buffer gnus-original-article-buffer)
6749                  (numberp article)
6750                  (with-current-buffer gnus-original-article-buffer
6751                    (and (equal (car gnus-original-article) group)
6752                         (eq (cdr gnus-original-article) article))))
6753             ;; `insert-buffer-substring' would incorrectly use the
6754             ;; equivalent of string-make-multibyte which amount to decoding
6755             ;; with locale-coding-system, causing failure of
6756             ;; subsequent decoding.
6757             (insert (mm-string-to-multibyte
6758                      (with-current-buffer gnus-original-article-buffer
6759                        (buffer-substring (point-min) (point-max)))))
6760             'article)
6761            ;; Check the backlog.
6762            ((and gnus-keep-backlog
6763                  (gnus-backlog-request-article group article (current-buffer)))
6764             'article)
6765            ;; Check asynchronous pre-fetch.
6766            ((gnus-async-request-fetched-article group article (current-buffer))
6767             (gnus-async-prefetch-next group article gnus-summary-buffer)
6768             (when (and (numberp article) gnus-keep-backlog)
6769               (gnus-backlog-enter-article group article (current-buffer)))
6770             'article)
6771            ;; Check the cache.
6772            ((and gnus-use-cache
6773                  (numberp article)
6774                  (gnus-cache-request-article article group))
6775             'article)
6776            ;; Check the agent cache.
6777            ((gnus-agent-request-article article group)
6778             'article)
6779            ;; Get the article and put into the article buffer.
6780            ((or (stringp article)
6781                 (numberp article))
6782             (let ((gnus-override-method gnus-override-method)
6783                   (methods (and (stringp article)
6784                                 gnus-refer-article-method))
6785                   (backend (car (gnus-find-method-for-group
6786                                  gnus-newsgroup-name)))
6787                   result
6788                   (inhibit-read-only t))
6789               (if (or (not (listp methods))
6790                       (and (symbolp (car methods))
6791                            (assq (car methods) nnoo-definition-alist)))
6792                   (setq methods (list methods)))
6793               (when (and (null gnus-override-method)
6794                          methods)
6795                 (setq gnus-override-method (pop methods)))
6796               (while (not result)
6797                 (when (eq gnus-override-method 'current)
6798                   (setq gnus-override-method
6799                         (with-current-buffer gnus-summary-buffer
6800                           gnus-current-select-method)))
6801                 (erase-buffer)
6802                 (gnus-kill-all-overlays)
6803                 (let ((gnus-newsgroup-name group))
6804                   (gnus-check-group-server))
6805                 (cond
6806                  ((gnus-request-article article group (current-buffer))
6807                   (when (numberp article)
6808                     (gnus-async-prefetch-next group article
6809                                               gnus-summary-buffer)
6810                     (when gnus-keep-backlog
6811                       (gnus-backlog-enter-article
6812                        group article (current-buffer))))
6813                   (setq result 'article))
6814                  (methods
6815                   (setq gnus-override-method (pop methods)))
6816                  ((not (string-match "^400 "
6817                                      (nnheader-get-report backend)))
6818                   ;; If we get 400 server disconnect, reconnect and
6819                   ;; retry; otherwise, assume the article has expired.
6820                   (setq result 'done))))
6821               (and (eq result 'article) 'article)))
6822            ;; It was a pseudo.
6823            (t article)))
6824
6825       ;; Associate this article with the current summary buffer.
6826       (setq gnus-article-current-summary gnus-summary-buffer)
6827
6828       ;; Take the article from the original article buffer
6829       ;; and place it in the buffer it's supposed to be in.
6830       (when (and (get-buffer gnus-article-buffer)
6831                  (equal (buffer-name (current-buffer))
6832                         (buffer-name (get-buffer gnus-article-buffer))))
6833         (save-excursion
6834           (if (get-buffer gnus-original-article-buffer)
6835               (set-buffer gnus-original-article-buffer)
6836             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6837             (buffer-disable-undo)
6838             (setq major-mode 'gnus-original-article-mode)
6839             (setq buffer-read-only t))
6840           (let ((inhibit-read-only t))
6841             (erase-buffer)
6842             (insert-buffer-substring gnus-article-buffer))
6843           (setq gnus-original-article (cons group article)))
6844
6845         ;; Decode charsets.
6846         (run-hooks 'gnus-article-decode-hook)
6847         ;; Mark article as decoded or not.
6848         (setq gnus-article-decoded-p gnus-article-decode-hook))
6849
6850       ;; Update sparse articles.
6851       (when (and do-update-line
6852                  (or (numberp article)
6853                      (stringp article)))
6854         (let ((buf (current-buffer)))
6855           (set-buffer gnus-summary-buffer)
6856           (gnus-summary-update-article do-update-line sparse-header)
6857           (gnus-summary-goto-subject do-update-line nil t)
6858           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6859                             (point))
6860           (set-buffer buf))))))
6861
6862 (defun gnus-block-private-groups (group)
6863   (if (gnus-news-group-p group)
6864       ;; Block nothing in news groups.
6865       nil
6866     ;; Block everything anywhere else.
6867     "."))
6868
6869 (defun gnus-blocked-images ()
6870   (if (functionp gnus-blocked-images)
6871       (funcall gnus-blocked-images gnus-newsgroup-name)
6872     gnus-blocked-images))
6873
6874 ;;;
6875 ;;; Article editing
6876 ;;;
6877
6878 (defcustom gnus-article-edit-mode-hook nil
6879   "Hook run in article edit mode buffers."
6880   :group 'gnus-article-various
6881   :type 'hook)
6882
6883 (defvar gnus-article-edit-done-function nil)
6884
6885 (defvar gnus-article-edit-mode-map nil)
6886
6887 ;; Should we be using derived.el for this?
6888 (unless gnus-article-edit-mode-map
6889   (setq gnus-article-edit-mode-map (make-keymap))
6890   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6891
6892   (gnus-define-keys gnus-article-edit-mode-map
6893     "\C-c?"    describe-mode
6894     "\C-c\C-c" gnus-article-edit-done
6895     "\C-c\C-k" gnus-article-edit-exit
6896     "\C-c\C-f\C-t" message-goto-to
6897     "\C-c\C-f\C-o" message-goto-from
6898     "\C-c\C-f\C-b" message-goto-bcc
6899     ;;"\C-c\C-f\C-w" message-goto-fcc
6900     "\C-c\C-f\C-c" message-goto-cc
6901     "\C-c\C-f\C-s" message-goto-subject
6902     "\C-c\C-f\C-r" message-goto-reply-to
6903     "\C-c\C-f\C-n" message-goto-newsgroups
6904     "\C-c\C-f\C-d" message-goto-distribution
6905     "\C-c\C-f\C-f" message-goto-followup-to
6906     "\C-c\C-f\C-m" message-goto-mail-followup-to
6907     "\C-c\C-f\C-k" message-goto-keywords
6908     "\C-c\C-f\C-u" message-goto-summary
6909     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6910     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6911     "\C-c\C-b" message-goto-body
6912     "\C-c\C-i" message-goto-signature
6913
6914     "\C-c\C-t" message-insert-to
6915     "\C-c\C-n" message-insert-newsgroups
6916     "\C-c\C-o" message-sort-headers
6917     "\C-c\C-e" message-elide-region
6918     "\C-c\C-v" message-delete-not-region
6919     "\C-c\C-z" message-kill-to-signature
6920     "\M-\r" message-newline-and-reformat
6921     "\C-c\C-a" mml-attach-file
6922     "\C-a" message-beginning-of-line
6923     "\t" message-tab
6924     "\M-;" comment-region)
6925
6926   (gnus-define-keys (gnus-article-edit-wash-map
6927                      "\C-c\C-w" gnus-article-edit-mode-map)
6928     "f" gnus-article-edit-full-stops))
6929
6930 (easy-menu-define
6931   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6932   '("Field"
6933     ["Fetch To" message-insert-to t]
6934     ["Fetch Newsgroups" message-insert-newsgroups t]
6935     "----"
6936     ["To" message-goto-to t]
6937     ["From" message-goto-from t]
6938     ["Subject" message-goto-subject t]
6939     ["Cc" message-goto-cc t]
6940     ["Reply-To" message-goto-reply-to t]
6941     ["Summary" message-goto-summary t]
6942     ["Keywords" message-goto-keywords t]
6943     ["Newsgroups" message-goto-newsgroups t]
6944     ["Followup-To" message-goto-followup-to t]
6945     ["Mail-Followup-To" message-goto-mail-followup-to t]
6946     ["Distribution" message-goto-distribution t]
6947     ["Body" message-goto-body t]
6948     ["Signature" message-goto-signature t]))
6949
6950 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6951   "Major mode for editing articles.
6952 This is an extended text-mode.
6953
6954 \\{gnus-article-edit-mode-map}"
6955   (make-local-variable 'gnus-article-edit-done-function)
6956   (make-local-variable 'gnus-prev-winconf)
6957   (set (make-local-variable 'font-lock-defaults)
6958        '(message-font-lock-keywords t))
6959   (set (make-local-variable 'mail-header-separator) "")
6960   (set (make-local-variable 'gnus-article-edit-mode) t)
6961   (easy-menu-add message-mode-field-menu message-mode-map)
6962   (mml-mode)
6963   (setq buffer-read-only nil)
6964   (buffer-enable-undo)
6965   (widen))
6966
6967 (defun gnus-article-edit (&optional force)
6968   "Edit the current article.
6969 This will have permanent effect only in mail groups.
6970 If FORCE is non-nil, allow editing of articles even in read-only
6971 groups."
6972   (interactive "P")
6973   (when (and (not force)
6974              (gnus-group-read-only-p))
6975     (error "The current newsgroup does not support article editing"))
6976   (gnus-article-date-original)
6977   (gnus-article-edit-article
6978    'ignore
6979    `(lambda (no-highlight)
6980       'ignore
6981       (gnus-summary-edit-article-done
6982        ,(or (mail-header-references gnus-current-headers) "")
6983        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6984
6985 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6986   "Start editing the contents of the current article buffer."
6987   (let ((winconf (current-window-configuration)))
6988     (set-buffer gnus-article-buffer)
6989     (let ((message-auto-save-directory
6990            ;; Don't associate the article buffer with a draft file.
6991            nil))
6992       (gnus-article-edit-mode))
6993     (funcall start-func)
6994     (set-buffer-modified-p nil)
6995     (gnus-configure-windows 'edit-article)
6996     (setq gnus-article-edit-done-function exit-func)
6997     (setq gnus-prev-winconf winconf)
6998     (unless quiet
6999       (gnus-message 6 "C-c C-c to end edits"))))
7000
7001 (defun gnus-article-edit-done (&optional arg)
7002   "Update the article edits and exit."
7003   (interactive "P")
7004   (let ((func gnus-article-edit-done-function)
7005         (buf (current-buffer))
7006         (start (window-start))
7007         (p (point))
7008         (winconf gnus-prev-winconf))
7009     (widen) ;; Widen it in case that users narrowed the buffer.
7010     (funcall func arg)
7011     (set-buffer buf)
7012     ;; The cache and backlog have to be flushed somewhat.
7013     (when gnus-keep-backlog
7014       (gnus-backlog-remove-article
7015        (car gnus-article-current) (cdr gnus-article-current)))
7016     ;; Flush original article as well.
7017     (gnus-flush-original-article-buffer)
7018     (when gnus-use-cache
7019       (gnus-cache-update-article
7020        (car gnus-article-current) (cdr gnus-article-current)))
7021     ;; We remove all text props from the article buffer.
7022     (kill-all-local-variables)
7023     (set-text-properties (point-min) (point-max) nil)
7024     (gnus-article-mode)
7025     (set-window-configuration winconf)
7026     (set-buffer buf)
7027     (set-window-start (get-buffer-window buf) start)
7028     (set-window-point (get-buffer-window buf) (point)))
7029   (gnus-summary-show-article))
7030
7031 (defun gnus-flush-original-article-buffer ()
7032   (when (get-buffer gnus-original-article-buffer)
7033     (with-current-buffer gnus-original-article-buffer
7034       (setq gnus-original-article nil))))
7035
7036 (defun gnus-article-edit-exit ()
7037   "Exit the article editing without updating."
7038   (interactive)
7039   (when (or (not (buffer-modified-p))
7040             (yes-or-no-p "Article modified; kill anyway? "))
7041     (let ((curbuf (current-buffer))
7042           (p (point))
7043           (window-start (window-start)))
7044       (erase-buffer)
7045       (if (gnus-buffer-live-p gnus-original-article-buffer)
7046           (insert-buffer-substring gnus-original-article-buffer))
7047       (let ((winconf gnus-prev-winconf))
7048         (kill-all-local-variables)
7049         (gnus-article-mode)
7050         (set-window-configuration winconf)
7051         ;; Tippy-toe some to make sure that point remains where it was.
7052         (save-current-buffer
7053           (set-buffer curbuf)
7054           (set-window-start (get-buffer-window (current-buffer)) window-start)
7055           (goto-char p))))
7056     (gnus-summary-show-article)))
7057
7058 (defun gnus-article-edit-full-stops ()
7059   "Interactively repair spacing at end of sentences."
7060   (interactive)
7061   (save-excursion
7062     (goto-char (point-min))
7063     (search-forward-regexp "^$" nil t)
7064     (let ((case-fold-search nil))
7065       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7066
7067 ;;;
7068 ;;; Article highlights
7069 ;;;
7070
7071 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7072
7073 ;;; Internal Variables:
7074
7075 (defcustom gnus-button-url-regexp
7076   (concat
7077    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7078    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7079    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7080    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7081        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7082              (punct "!?:;.,"))
7083          (concat
7084           "\\(?:"
7085           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7086           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7087           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7088           "\\|"
7089           "[" chars punct     "]+" "[" chars "]"
7090           "\\)"))
7091      (concat ;; XEmacs 21.4 doesn't support POSIX.
7092       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7093       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7094    "\\)")
7095   "Regular expression that matches URLs."
7096   :group 'gnus-article-buttons
7097   :type 'regexp)
7098
7099 (defcustom gnus-button-valid-fqdn-regexp
7100   message-valid-fqdn-regexp
7101   "Regular expression that matches a valid FQDN."
7102   :version "22.1"
7103   :group 'gnus-article-buttons
7104   :type 'regexp)
7105
7106 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7107 (defcustom gnus-button-valid-localpart-regexp
7108   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7109   "Regular expression that matches a localpart of mail addresses or MIDs."
7110   :version "22.1"
7111   :group 'gnus-article-buttons
7112   :type 'regexp)
7113
7114 (defcustom gnus-button-man-handler 'manual-entry
7115   "Function to use for displaying man pages.
7116 The function must take at least one argument with a string naming the
7117 man page."
7118   :version "22.1"
7119   :type '(choice (function-item :tag "Man" manual-entry)
7120                  (function-item :tag "Woman" woman)
7121                  (function :tag "Other"))
7122   :group 'gnus-article-buttons)
7123
7124 (defcustom gnus-button-mid-or-mail-regexp
7125   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7126           gnus-button-valid-fqdn-regexp
7127           ">?\\)\\b")
7128   "Regular expression that matches a message ID or a mail address."
7129   :version "22.1"
7130   :group 'gnus-article-buttons
7131   :type 'regexp)
7132
7133 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7134   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7135 Strings like this can be either a message ID or a mail address.  If it is one
7136 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7137 message ID or a mail address, respectively.  If this variable is set to the
7138 symbol `ask', always query the user what do do.  If it is a function, this
7139 function will be called with the string as its only argument.  The function
7140 must return `mid', `mail', `invalid' or `ask'."
7141   :version "22.1"
7142   :group 'gnus-article-buttons
7143   :type '(choice (function-item :tag "Heuristic function"
7144                                 gnus-button-mid-or-mail-heuristic)
7145                  (const ask)
7146                  (const mid)
7147                  (const mail)))
7148
7149 (defcustom gnus-button-mid-or-mail-heuristic-alist
7150   '((-10.0 . ".+\\$.+@")
7151     (-10.0 . "#")
7152     (-10.0 . "\\*")
7153     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7154     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7155     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7156     (-1.0  . "^[^a-z]+@")
7157     ;;
7158     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7159     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7160     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7161     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7162     ;;
7163     (-2.0  . "^[0-9]")
7164     (-1.0  . "^[0-9][0-9]")
7165     ;;
7166     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7167     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7168     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7169     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7170     ;;
7171     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7172     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7173     ;;       "[0-9]{8,}.*\@"
7174     (-3.0
7175      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7176     ;; "[0-9]{12,}.*\@"
7177     ;; compensation for TDMA dated mail addresses:
7178     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7179     ;;
7180     (-20.0 . "\\.fsf@") ;; Gnus
7181     (-20.0 . "^slrn")
7182     (-20.0 . "^Pine")
7183     (-20.0 . "^alpine\\.")
7184     (-20.0 . "_-_") ;; Subject change in thread
7185     ;;
7186     (-20.0 . "\\.ln@") ;; leafnode
7187     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7188     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7189     ;;
7190     ;; (5.0 . "") ;; $local_part_len <= 7
7191     (10.0  . "^[^0-9]+@")
7192     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7193     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7194     (3.0   . "\@stud")
7195     ;;
7196     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7197     ;;
7198     (0.5   . "^[A-Z][a-z]")
7199     (0.5   . "^[A-Z][a-z][a-z]")
7200     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7201     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7202   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7203
7204 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7205 address.  The REGEXP is processed with `case-fold-search' set to nil."
7206   :version "22.1"
7207   :group 'gnus-article-buttons
7208   :type '(repeat (cons (number :tag "Rate")
7209                        (regexp :tag "Regexp"))))
7210
7211 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7212   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7213 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7214 address, `ask' if unsure and `invalid' if the string is invalid."
7215   (let ((case-fold-search nil)
7216         (list gnus-button-mid-or-mail-heuristic-alist)
7217         (result 0) rate regexp lpartlen elem)
7218     (setq lpartlen
7219           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7220     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7221     ;; Certain special cases...
7222     (when (string-match
7223            (concat
7224             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7225             "^[0-9]+\\.[0-9]+@compuserve\\|"
7226             "@public\\.gmane\\.org")
7227            mid-or-mail)
7228       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7229       (setq result 'mail))
7230     (when (string-match "@.*@\\| " mid-or-mail)
7231       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7232       (setq result 'invalid))
7233     ;; Nothing more to do, if result is not a number here...
7234     (when (numberp result)
7235       (while list
7236         (setq elem (car list)
7237               rate (car elem)
7238               regexp (cdr elem)
7239               list (cdr list))
7240         (when (string-match regexp mid-or-mail)
7241           (setq result (+ result rate))
7242           (gnus-message
7243            9 "`%s' matched `%s', rate `%s', result `%s'."
7244            mid-or-mail regexp rate result)))
7245       (when (<= lpartlen 7)
7246         (setq result (+ result 5.0))
7247         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7248                       mid-or-mail result))
7249       (when (>= lpartlen 12)
7250         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7251         (cond
7252          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7253           ;; Long local part should contain realname if e-mail address,
7254           ;; too many digits: message-id.
7255           ;; $score -= 5.0 + 0.1 * $local_part_len;
7256           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7257           (setq result (+ result rate))
7258           (gnus-message
7259            9 "Many digits in `%s', rate `%s', result `%s'."
7260            mid-or-mail rate result))
7261          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7262                         mid-or-mail)
7263           ;; Too few vowels [^aeiouy]{4,}.*\@
7264           (setq result (+ result -5.0))
7265           (gnus-message
7266            9 "Few vowels in `%s', rate `%s', result `%s'."
7267            mid-or-mail -5.0 result))
7268          (t
7269           (setq result (+ result 5.0))
7270           (gnus-message
7271            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7272     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7273     ;; Maybe we should make this a customizable alist: (condition . 'result)
7274     (cond
7275      ((symbolp result) result)
7276      ;; Now convert number into proper results:
7277      ((< result -10.0) 'mid)
7278      ((> result  10.0) 'mail)
7279      (t 'ask))))
7280
7281 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7282   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7283          (url-mid (concat "news" ":" mid-or-mail))
7284          (url-mailto (concat "mailto" ":" mid-or-mail)))
7285     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7286     (when (fboundp pref)
7287       (setq guessed
7288             ;; get rid of surrounding angles...
7289             (funcall pref
7290                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7291       (if (or (eq 'mid guessed) (eq 'mail guessed))
7292           (setq pref guessed)
7293         (setq pref 'ask)))
7294     (if (eq pref 'ask)
7295         (save-window-excursion
7296           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7297               (setq pref 'mail)
7298             (setq pref 'mid))))
7299     (cond ((eq pref 'mid)
7300            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7301            (gnus-button-handle-news url-mid))
7302           ((eq pref 'mail)
7303            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7304            (gnus-url-mailto url-mailto))
7305           (t (gnus-message 3 "Invalid string.")))))
7306
7307 (defun gnus-button-handle-custom (fun arg)
7308   "Call function FUN on argument ARG.
7309 Both FUN and ARG are supposed to be strings.  ARG will be passed
7310 as a symbol to FUN."
7311   (funcall (intern fun)
7312            (if (string-match "^customize-apropos" fun)
7313                arg
7314              (intern arg))))
7315
7316 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7317
7318 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7319 ;; stuff?
7320
7321 (defun gnus-button-handle-describe-function (url)
7322   "Call `describe-function' when pushing the corresponding URL button."
7323   (describe-function
7324    (intern
7325     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7326
7327 (defun gnus-button-handle-describe-variable (url)
7328   "Call `describe-variable' when pushing the corresponding URL button."
7329   (describe-variable
7330    (intern
7331     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7332
7333 (defun gnus-button-handle-symbol (url)
7334 "Display help on variable or function.
7335 Calls `describe-variable' or `describe-function'."
7336   (let ((sym (intern url)))
7337     (cond
7338      ((fboundp sym) (describe-function sym))
7339      ((boundp sym) (describe-variable sym))
7340      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7341
7342 (defun gnus-button-handle-describe-key (url)
7343   "Call `describe-key' when pushing the corresponding URL button."
7344   (let* ((key-string
7345           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7346          (keys (ignore-errors (eval `(kbd ,key-string)))))
7347     (if keys
7348         (describe-key keys)
7349       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7350
7351 (defun gnus-button-handle-apropos (url)
7352   "Call `apropos' when pushing the corresponding URL button."
7353   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7354
7355 (defun gnus-button-handle-apropos-command (url)
7356   "Call `apropos' when pushing the corresponding URL button."
7357   (apropos-command
7358    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7359
7360 (defun gnus-button-handle-apropos-variable (url)
7361   "Call `apropos' when pushing the corresponding URL button."
7362   (funcall
7363    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7364    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7365
7366 (defun gnus-button-handle-apropos-documentation (url)
7367   "Call `apropos' when pushing the corresponding URL button."
7368   (funcall
7369    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7370    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7371
7372 (defun gnus-button-handle-library (url)
7373   "Call `locate-library' when pushing the corresponding URL button."
7374   (gnus-message 9 "url=`%s'" url)
7375   (let* ((lib (locate-library url))
7376          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7377     (if (not lib)
7378         (gnus-message 1 "Cannot locale library `%s'." url)
7379       (find-file-read-only file))))
7380
7381 (defcustom gnus-button-man-level 5
7382   "*Integer that says how many man-related buttons Gnus will show.
7383 The higher the number, the more buttons will appear and the more false
7384 positives are possible.  Note that you can set this variable local to
7385 specific groups.  Setting it higher in Unix groups is probably a good idea.
7386 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7387 how to set variables in specific groups."
7388   :version "22.1"
7389   :group 'gnus-article-buttons
7390   :link '(custom-manual "(gnus)Group Parameters")
7391   :type 'integer)
7392
7393 (defcustom gnus-button-emacs-level 5
7394   "*Integer that says how many emacs-related buttons Gnus will show.
7395 The higher the number, the more buttons will appear and the more false
7396 positives are possible.  Note that you can set this variable local to
7397 specific groups.  Setting it higher in Emacs or Gnus related groups is
7398 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7399 `gnus-parameters' on how to set variables in specific groups."
7400   :version "22.1"
7401   :group 'gnus-article-buttons
7402   :link '(custom-manual "(gnus)Group Parameters")
7403   :type 'integer)
7404
7405 (defcustom gnus-button-message-level 5
7406   "*Integer that says how many buttons for news or mail messages will appear.
7407 The higher the number, the more buttons will appear and the more false
7408 positives are possible."
7409   ;; mail addresses, MIDs, URLs for news, ...
7410   :version "22.1"
7411   :group 'gnus-article-buttons
7412   :type 'integer)
7413
7414 (defcustom gnus-button-browse-level 5
7415   "*Integer that says how many buttons for browsing will appear.
7416 The higher the number, the more buttons will appear and the more false
7417 positives are possible."
7418   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7419   :version "22.1"
7420   :group 'gnus-article-buttons
7421   :type 'integer)
7422
7423 (defcustom gnus-button-alist
7424   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7425      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7426     ((concat "\\b\\(nntp\\|news\\):\\("
7427              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7428      0 t gnus-button-handle-news 2)
7429     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7430      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7431     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7432      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7433     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7434     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7435      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7436     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7437      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7438     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7439      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7440     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7441      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7442     ;; RFC 2368 (The mailto URL scheme)
7443     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7444      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7445     ("\\bmailto:\\([^ \n\t]+\\)"
7446      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7447     ;; Info Konqueror style <info:/foo/bar baz>.
7448     ;; Must come before " Gnus home-grown style".
7449     ("\\binfo://?\\([^'\">\n\t]+\\)"
7450      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7451    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7452     ("\\binfo://\\([^'\">\n\t ]+\\)"
7453      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7454     ;; Info GNOME style <info:foo#bar_baz>
7455     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7456      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7457     ;; Info KDE style <info:(foo)bar baz>
7458     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7459      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7460     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7461      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7462     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n,]*\\)\\)?"
7463      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7464      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7465     ;; This is custom
7466     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7467      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7468     ;; Emacs help commands
7469     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7470      ;; regexp doesn't match arguments containing ` '.
7471      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7472     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7473      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7474     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7475      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7476     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7477      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7478     ;; The following entries may lead to many false positives so don't enable
7479     ;; them by default (use a high button level).
7480     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7481      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7482      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7483     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7484      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7485     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7486      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7487     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7488      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7489     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7490      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7491     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7492      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7493     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7494      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7495     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7496      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7497     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7498      ;; Unlike the other regexps we really have to require quoting
7499      ;; here to determine where it ends.
7500      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7501     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7502     ("<URL: *\\([^\n<>]*\\)>"
7503      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7504     ;; RFC 2396 (2.4.3., delims) ...
7505     ("\"URL: *\\([^\n\"]*\\)\""
7506      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7507     ;; Raw URLs.
7508     (gnus-button-url-regexp
7509      0 (>= gnus-button-browse-level 0) browse-url 0)
7510     ;; man pages
7511     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7512      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7513      gnus-button-handle-man 1)
7514     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7515     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7516      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7517      gnus-button-handle-man 1)
7518     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7519     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7520     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7521      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7522     ;; Recognizing patches to .el files.  This is somewhat obscure,
7523     ;; but considering the percentage of Gnus users who hack Emacs
7524     ;; Lisp files...
7525     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7526      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7527     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7528      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7529     ;; MID or mail: To avoid too many false positives we don't try to catch
7530     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7531     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7532     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7533     ;; so that non-ambiguous entries (see above) match first.
7534     (gnus-button-mid-or-mail-regexp
7535      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7536   "*Alist of regexps matching buttons in article bodies.
7537
7538 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7539 REGEXP: is the string (case insensitive) matching text around the button (can
7540 also be Lisp expression evaluating to a string),
7541 BUTTON: is the number of the regexp grouping actually matching the button,
7542 FORM: is a Lisp expression which must eval to true for the button to
7543 be added,
7544 CALLBACK: is the function to call when the user push this button, and each
7545 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7546
7547 CALLBACK can also be a variable, in that case the value of that
7548 variable it the real callback function."
7549   :group 'gnus-article-buttons
7550   :type '(repeat (list (choice regexp variable sexp)
7551                        (integer :tag "Button")
7552                        (sexp :tag "Form")
7553                        (function :tag "Callback")
7554                        (repeat :tag "Par"
7555                                :inline t
7556                                (integer :tag "Regexp group")))))
7557 (put 'gnus-button-alist 'risky-local-variable t)
7558
7559 (defcustom gnus-header-button-alist
7560   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7561      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7562     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7563      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7564     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7565      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7566     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7567      0 (>= gnus-button-browse-level 0) browse-url 0)
7568     ("^Subject:" gnus-button-url-regexp
7569      0 (>= gnus-button-browse-level 0) browse-url 0)
7570     ("^[^:]+:" gnus-button-url-regexp
7571      0 (>= gnus-button-browse-level 0) browse-url 0)
7572     ("^OpenPGP:.*url=" gnus-button-url-regexp
7573      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7574     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7575      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7576     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7577      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7578   "*Alist of headers and regexps to match buttons in article heads.
7579
7580 This alist is very similar to `gnus-button-alist', except that each
7581 alist has an additional HEADER element first in each entry:
7582
7583 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7584
7585 HEADER is a regexp to match a header.  For a fuller explanation, see
7586 `gnus-button-alist'."
7587   :group 'gnus-article-buttons
7588   :group 'gnus-article-headers
7589   :type '(repeat (list (regexp :tag "Header")
7590                        (choice regexp variable)
7591                        (integer :tag "Button")
7592                        (sexp :tag "Form")
7593                        (function :tag "Callback")
7594                        (repeat :tag "Par"
7595                                :inline t
7596                                (integer :tag "Regexp group")))))
7597 (put 'gnus-header-button-alist 'risky-local-variable t)
7598
7599 ;;; Commands:
7600
7601 (defun gnus-article-push-button (event)
7602   "Check text under the mouse pointer for a callback function.
7603 If the text under the mouse pointer has a `gnus-callback' property,
7604 call it with the value of the `gnus-data' text property."
7605   (interactive "e")
7606   (set-buffer (window-buffer (posn-window (event-start event))))
7607   (let* ((pos (posn-point (event-start event)))
7608          (data (get-text-property pos 'gnus-data))
7609          (fun (get-text-property pos 'gnus-callback)))
7610     (goto-char pos)
7611     (when fun
7612       (funcall fun data))))
7613
7614 (defun gnus-article-press-button ()
7615   "Check text at point for a callback function.
7616 If the text at point has a `gnus-callback' property,
7617 call it with the value of the `gnus-data' text property."
7618   (interactive)
7619   (let ((data (get-text-property (point) 'gnus-data))
7620         (fun (get-text-property (point) 'gnus-callback)))
7621     (when fun
7622       (funcall fun data))))
7623
7624 (defun gnus-article-highlight (&optional force)
7625   "Highlight current article.
7626 This function calls `gnus-article-highlight-headers',
7627 `gnus-article-highlight-citation',
7628 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7629 do the highlighting.  See the documentation for those functions."
7630   (interactive (list 'force))
7631   (gnus-article-highlight-headers)
7632   (gnus-article-highlight-citation force)
7633   (gnus-article-highlight-signature)
7634   (gnus-article-add-buttons force)
7635   (gnus-article-add-buttons-to-head))
7636
7637 (defun gnus-article-highlight-some (&optional force)
7638   "Highlight current article.
7639 This function calls `gnus-article-highlight-headers',
7640 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7641 do the highlighting.  See the documentation for those functions."
7642   (interactive (list 'force))
7643   (gnus-article-highlight-headers)
7644   (gnus-article-highlight-signature)
7645   (gnus-article-add-buttons))
7646
7647 (defun gnus-article-highlight-headers ()
7648   "Highlight article headers as specified by `gnus-header-face-alist'."
7649   (interactive)
7650   (gnus-with-article-headers
7651     (let (regexp header-face field-face from hpoints fpoints)
7652       (dolist (entry gnus-header-face-alist)
7653         (goto-char (point-min))
7654         (setq regexp (concat "^\\("
7655                              (if (string-equal "" (nth 0 entry))
7656                                  "[^\t ]"
7657                                (nth 0 entry))
7658                              "\\)")
7659               header-face (nth 1 entry)
7660               field-face (nth 2 entry))
7661         (while (and (re-search-forward regexp nil t)
7662                     (not (eobp)))
7663           (beginning-of-line)
7664           (setq from (point))
7665           (unless (search-forward ":" nil t)
7666             (forward-char 1))
7667           (when (and header-face
7668                      (not (memq (point) hpoints)))
7669             (push (point) hpoints)
7670             (gnus-put-text-property from (point) 'face header-face))
7671           (when (and field-face
7672                      (not (memq (setq from (point)) fpoints)))
7673             (push from fpoints)
7674             (if (re-search-forward "^[^ \t]" nil t)
7675                 (forward-char -2)
7676               (goto-char (point-max)))
7677             (gnus-put-text-property from (point) 'face field-face)))))))
7678
7679 (defun gnus-article-highlight-signature ()
7680   "Highlight the signature in an article.
7681 It does this by highlighting everything after
7682 `gnus-signature-separator' using the face `gnus-signature'."
7683   (interactive)
7684   (gnus-with-article-buffer
7685     (let ((inhibit-point-motion-hooks t))
7686       (save-restriction
7687         (when (and gnus-signature-face
7688                    (gnus-article-narrow-to-signature))
7689           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7690                             'face gnus-signature-face)
7691           (widen)
7692           (gnus-article-search-signature)
7693           (let ((start (match-beginning 0))
7694                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7695             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7696                                      end)))))))
7697
7698 (defun gnus-button-in-region-p (b e prop)
7699   "Say whether PROP exists in the region."
7700   (text-property-not-all b e prop nil))
7701
7702 (defun gnus-article-add-buttons (&optional force)
7703   "Find external references in the article and make buttons of them.
7704 \"External references\" are things like Message-IDs and URLs, as
7705 specified by `gnus-button-alist'."
7706   (interactive (list 'force))
7707   (gnus-with-article-buffer
7708     (let ((inhibit-point-motion-hooks t)
7709           (case-fold-search t)
7710           (alist gnus-button-alist)
7711           beg entry regexp)
7712       ;; Remove all old markers.
7713       (let (marker entry new-list)
7714         (while (setq marker (pop gnus-button-marker-list))
7715           (if (or (< marker (point-min)) (>= marker (point-max)))
7716               (push marker new-list)
7717             (goto-char marker)
7718             (when (setq entry (gnus-button-entry))
7719               (put-text-property (match-beginning (nth 1 entry))
7720                                  (match-end (nth 1 entry))
7721                                  'gnus-callback nil))
7722             (set-marker marker nil)))
7723         (setq gnus-button-marker-list new-list))
7724       ;; We skip the headers.
7725       (article-goto-body)
7726       (setq beg (point))
7727       (while (setq entry (pop alist))
7728         (setq regexp (eval (car entry)))
7729         (goto-char beg)
7730         (while (re-search-forward regexp nil t)
7731           (let ((start (match-beginning (nth 1 entry)))
7732                 (end (match-end (nth 1 entry)))
7733                 (from (match-beginning 0)))
7734             (when (and (or (eq t (nth 2 entry))
7735                            (eval (nth 2 entry)))
7736                        (not (gnus-button-in-region-p
7737                              start end 'gnus-callback)))
7738               ;; That optional form returned non-nil, so we add the
7739               ;; button.
7740               (setq from (set-marker (make-marker) from))
7741               (push from gnus-button-marker-list)
7742               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7743                            (gnus-article-extend-url-button from start end))
7744                 (gnus-article-add-button start end
7745                                          'gnus-button-push from)
7746                 (gnus-put-text-property
7747                  start end
7748                  'gnus-string (buffer-substring-no-properties
7749                                start end))))))))))
7750
7751 (defun gnus-article-extend-url-button (beg start end)
7752   "Extend url button if url is folded into two or more lines.
7753 Return non-nil if button is extended.  BEG is a marker that points to
7754 the beginning position of a text containing url.  START and END are
7755 the endpoints of a url button before it is extended.  The concatenated
7756 url is put as the `gnus-button-url' overlay property on the button."
7757   (let ((opoint (point))
7758         (points (list start end))
7759         url delim regexp)
7760     (prog1
7761         (when (and (progn
7762                      (goto-char end)
7763                      (not (looking-at "[\t ]*[\">]")))
7764                    (progn
7765                      (goto-char start)
7766                      (string-match
7767                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7768                       (buffer-substring (point-at-bol) start)))
7769                    (progn
7770                      (setq url (list (buffer-substring start end))
7771                            delim (if (match-beginning 1) ">" "\""))
7772                      (beginning-of-line)
7773                      (setq regexp (concat
7774                                    (when (and (looking-at
7775                                                message-cite-prefix-regexp)
7776                                               (< (match-end 0) start))
7777                                      (regexp-quote (match-string 0)))
7778                                    "\
7779 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7780                                    delim "\\)"))
7781                      (while (progn
7782                               (forward-line 1)
7783                               (and (looking-at regexp)
7784                                    (prog1
7785                                        (match-beginning 1)
7786                                      (push (or (match-string 2)
7787                                                (match-string 1))
7788                                            url)
7789                                      (push (setq end (or (match-end 2)
7790                                                          (match-end 1)))
7791                                            points)
7792                                      (push (or (match-beginning 2)
7793                                                (match-beginning 1))
7794                                            points)))))
7795                      (match-beginning 2)))
7796           (let (gnus-article-mouse-face widget-mouse-face)
7797             (while points
7798               (gnus-article-add-button (pop points) (pop points)
7799                                        'gnus-button-push beg)))
7800           (let ((overlay (gnus-make-overlay start end)))
7801             (gnus-overlay-put overlay 'evaporate t)
7802             (gnus-overlay-put overlay 'gnus-button-url
7803                               (list (mapconcat 'identity (nreverse url) "")))
7804             (when gnus-article-mouse-face
7805               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7806           t)
7807       (goto-char opoint))))
7808
7809 ;; Add buttons to the head of an article.
7810 (defun gnus-article-add-buttons-to-head ()
7811   "Add buttons to the head of the article."
7812   (interactive)
7813   (gnus-with-article-headers
7814     (let (beg end)
7815       (dolist (entry gnus-header-button-alist)
7816         ;; Each alist entry.
7817         (goto-char (point-min))
7818         (while (re-search-forward (car entry) nil t)
7819           ;; Each header matching the entry.
7820           (setq beg (match-beginning 0))
7821           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7822                              (match-beginning 0))
7823                         (point-max)))
7824           (goto-char beg)
7825           (while (re-search-forward (eval (nth 1 entry)) end t)
7826             ;; Each match within a header.
7827             (let* ((entry (cdr entry))
7828                    (start (match-beginning (nth 1 entry)))
7829                    (end (match-end (nth 1 entry)))
7830                    (form (nth 2 entry)))
7831               (goto-char (match-end 0))
7832               (when (eval form)
7833                 (gnus-article-add-button
7834                  start end (nth 3 entry)
7835                  (buffer-substring (match-beginning (nth 4 entry))
7836                                    (match-end (nth 4 entry)))))))
7837           (goto-char end))))))
7838
7839 ;;; External functions:
7840
7841 (defun gnus-article-add-button (from to fun &optional data text)
7842   "Create a button between FROM and TO with callback FUN and data DATA."
7843   (when gnus-article-button-face
7844     (gnus-overlay-put (gnus-make-overlay from to nil t)
7845                       'face gnus-article-button-face))
7846   (gnus-add-text-properties
7847    from to
7848    (nconc (and gnus-article-mouse-face
7849                (list gnus-mouse-face-prop gnus-article-mouse-face))
7850           (list 'gnus-callback fun)
7851           (and data (list 'gnus-data data))))
7852   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7853                          :help-echo (or text "Follow the link")
7854                          :keymap gnus-url-button-map
7855                          :button-keymap gnus-widget-button-keymap))
7856
7857 (defun gnus-article-copy-string ()
7858   "Copy the string in the button to the kill ring."
7859   (interactive)
7860   (gnus-article-check-buffer)
7861   (let ((data (get-text-property (point) 'gnus-string)))
7862     (when data
7863       (with-temp-buffer
7864         (insert data)
7865         (copy-region-as-kill (point-min) (point-max))
7866         (message "Copied %s" data)))))
7867
7868 ;;; Internal functions:
7869
7870 (defun gnus-article-set-globals ()
7871   (with-current-buffer gnus-summary-buffer
7872     (gnus-set-global-variables)))
7873
7874 (defun gnus-signature-toggle (end)
7875   (gnus-with-article-buffer
7876     (let ((inhibit-point-motion-hooks t))
7877       (if (text-property-any end (point-max) 'article-type 'signature)
7878           (progn
7879             (gnus-delete-wash-type 'signature)
7880             (gnus-remove-text-properties-when
7881              'article-type 'signature end (point-max)
7882              (cons 'article-type (cons 'signature
7883                                        gnus-hidden-properties))))
7884         (gnus-add-wash-type 'signature)
7885         (gnus-add-text-properties-when
7886          'article-type nil end (point-max)
7887          (cons 'article-type (cons 'signature
7888                                    gnus-hidden-properties)))))
7889     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7890       (gnus-set-mode-line 'article))))
7891
7892 (defun gnus-button-entry ()
7893   ;; Return the first entry in `gnus-button-alist' matching this place.
7894   (let ((alist gnus-button-alist)
7895         (entry nil))
7896     (while alist
7897       (setq entry (pop alist))
7898       (if (looking-at (eval (car entry)))
7899           (setq alist nil)
7900         (setq entry nil)))
7901     entry))
7902
7903 (defun gnus-button-push (marker)
7904   ;; Push button starting at MARKER.
7905   (save-excursion
7906     (goto-char marker)
7907     (let* ((entry (gnus-button-entry))
7908            (inhibit-point-motion-hooks t)
7909            (fun (nth 3 entry))
7910            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7911                           (get-char-property marker 'gnus-button-url))
7912                      (mapcar (lambda (group)
7913                                (let ((string (match-string group)))
7914                                  (set-text-properties
7915                                   0 (length string) nil string)
7916                                  string))
7917                              (nthcdr 4 entry)))))
7918       (cond
7919        ((fboundp fun)
7920         (apply fun args))
7921        ((and (boundp fun)
7922              (fboundp (symbol-value fun)))
7923         (apply (symbol-value fun) args))
7924        (t
7925         (gnus-message 1 "You must define `%S' to use this button"
7926                       (cons fun args)))))))
7927
7928 (defun gnus-parse-news-url (url)
7929   (let (scheme server port group message-id articles)
7930     (with-temp-buffer
7931       (insert url)
7932       (goto-char (point-min))
7933       (when (looking-at "\\([A-Za-z]+\\):")
7934         (setq scheme (match-string 1))
7935         (goto-char (match-end 0)))
7936       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7937         (setq server (match-string 1))
7938         (setq port (if (stringp (match-string 3))
7939                        (string-to-number (match-string 3))
7940                      (match-string 3)))
7941         (goto-char (match-end 0)))
7942
7943       (cond
7944        ((looking-at "\\(.*@.*\\)")
7945         (setq message-id (match-string 1)))
7946        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7947         (setq group (match-string 1)
7948               articles (split-string (match-string 2) "-")))
7949        ((looking-at "\\([^/]+\\)/?")
7950         (setq group (match-string 1)))
7951        (t
7952         (error "Unknown news URL syntax"))))
7953     (list scheme server port group message-id articles)))
7954
7955 (defun gnus-button-handle-news (url)
7956   "Fetch a news URL."
7957   (destructuring-bind (scheme server port group message-id articles)
7958       (gnus-parse-news-url url)
7959     (cond
7960      (message-id
7961       (with-current-buffer gnus-summary-buffer
7962         (if server
7963             (let ((gnus-refer-article-method
7964                    (nconc (list (list 'nntp server))
7965                           gnus-refer-article-method))
7966                   (nntp-port-number (or port "nntp")))
7967               (gnus-message 7 "Fetching %s with %s"
7968                             message-id gnus-refer-article-method)
7969               (gnus-summary-refer-article message-id))
7970           (gnus-summary-refer-article message-id))))
7971      (group
7972       (gnus-button-fetch-group url)))))
7973
7974 (defun gnus-button-patch (library line)
7975   "Visit an Emacs Lisp library LIBRARY on line LINE."
7976   (interactive)
7977   (let ((file (locate-library (file-name-nondirectory library))))
7978     (unless file
7979       (error "Couldn't find library %s" library))
7980     (find-file file)
7981     (goto-char (point-min))
7982     (forward-line (1- (string-to-number line)))))
7983
7984 (defun gnus-button-handle-man (url)
7985   "Fetch a man page."
7986   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7987   (when (eq gnus-button-man-handler 'woman)
7988     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7989   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7990   (funcall gnus-button-man-handler url))
7991
7992 (defun gnus-button-handle-info-url (url)
7993   "Fetch an info URL."
7994   (setq url (mm-subst-char-in-string ?+ ?\  url))
7995   (cond
7996    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7997     (gnus-info-find-node
7998      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7999                      "Gnus")
8000              ")" (gnus-url-unhex-string (match-string 2 url)))))
8001    ((string-match "([^)\"]+)[^\"]+" url)
8002     (setq url
8003           (gnus-replace-in-string
8004            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8005     (gnus-info-find-node url))
8006    (t (error "Can't parse %s" url))))
8007
8008 (defun gnus-button-handle-info-url-gnome (url)
8009   "Fetch GNOME style info URL."
8010   (setq url (mm-subst-char-in-string ?_ ?\  url))
8011   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8012       (gnus-info-find-node
8013        (concat "("
8014                (gnus-url-unhex-string
8015                  (match-string 1 url))
8016                ")"
8017                (or (gnus-url-unhex-string
8018                     (match-string 2 url))
8019                    "Top")))
8020     (error "Can't parse %s" url)))
8021
8022 (defun gnus-button-handle-info-url-kde (url)
8023   "Fetch KDE style info URL."
8024   (gnus-info-find-node (gnus-url-unhex-string url)))
8025
8026 ;; (info) will autoload info.el
8027 (declare-function Info-menu "info" (menu-item &optional fork))
8028 (declare-function Info-index-next "info" (num))
8029
8030 (defun gnus-button-handle-info-keystrokes (url)
8031   "Call `info' when pushing the corresponding URL button."
8032   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8033   (let (node indx comma)
8034     (if (string-match
8035          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8036                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8037                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
8038                  "\\(?:[ \t\n,]*\\)\\)?")
8039          url)
8040         (setq node (match-string 2 url)
8041               indx (match-string 3 url))
8042       (error "Can't parse %s" url))
8043     (info)
8044     (Info-directory)
8045     (Info-menu node)
8046     (when (> (length indx) 0)
8047       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8048                             "\\([ \t\n,]*\\)")
8049                     indx)
8050       (setq comma (match-string 2 indx))
8051       (setq indx  (match-string 1 indx))
8052       (Info-index indx)
8053       (when comma
8054         (dotimes (i (with-temp-buffer
8055                       (insert comma)
8056                       ;; Note: the XEmacs version of `how-many' takes
8057                       ;; no optional argument.
8058                       (goto-char (point-min))
8059                       (how-many ",")))
8060           (Info-index-next 1)))
8061       nil)))
8062
8063 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8064 (declare-function pgg-display-output-buffer "pgg" (start end status))
8065
8066 (defun gnus-button-openpgp (url)
8067   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8068   (with-temp-buffer
8069     (mm-url-insert-file-contents-external url)
8070     (pgg-snarf-keys-region (point-min) (point-max))
8071     (pgg-display-output-buffer nil nil nil)))
8072
8073 (defun gnus-button-message-id (message-id)
8074   "Fetch MESSAGE-ID."
8075   (with-current-buffer gnus-summary-buffer
8076     (gnus-summary-refer-article message-id)))
8077
8078 (defun gnus-button-fetch-group (address &rest ignore)
8079   "Fetch GROUP specified by ADDRESS."
8080   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8081                       address)
8082     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8083     ;; for nntp:// and news://
8084     (setq address (match-string 3 address)))
8085   (if (not (string-match "[:/]" address))
8086       ;; This is just a simple group url.
8087       (gnus-group-read-ephemeral-group address gnus-select-method)
8088     (if (not
8089          (string-match
8090           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8091           address))
8092         (error "Can't parse %s" address)
8093       (gnus-group-read-ephemeral-group
8094        (match-string 4 address)
8095        `(nntp ,(match-string 1 address)
8096               (nntp-address ,(match-string 1 address))
8097               (nntp-port-number ,(if (match-end 3)
8098                                      (match-string 3 address)
8099                                    "nntp")))
8100        nil nil nil
8101        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8102
8103 (defun gnus-url-parse-query-string (query &optional downcase)
8104   (let (retval pairs cur key val)
8105     (setq pairs (split-string query "&"))
8106     (while pairs
8107       (setq cur (car pairs)
8108             pairs (cdr pairs))
8109       (if (not (string-match "=" cur))
8110           nil                           ; Grace
8111         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8112               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8113         (if downcase
8114             (setq key (downcase key)))
8115         (setq cur (assoc key retval))
8116         (if cur
8117             (setcdr cur (cons val (cdr cur)))
8118           (setq retval (cons (list key val) retval)))))
8119     retval))
8120
8121 (defun gnus-url-mailto (url)
8122   ;; Send mail to someone
8123   (when (string-match "mailto:/*\\(.*\\)" url)
8124     (setq url (substring url (match-beginning 1) nil)))
8125   (let (to args subject func)
8126     (setq args (gnus-url-parse-query-string
8127                 (if (string-match "^\\?" url)
8128                     (substring url 1)
8129                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8130                       (concat "to=" (match-string 1 url) "&"
8131                               (match-string 2 url))
8132                     (concat "to=" url)))
8133                 t)
8134           subject (cdr-safe (assoc "subject" args)))
8135     (gnus-msg-mail)
8136     (while args
8137       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8138       (if (fboundp func)
8139           (funcall func)
8140         (message-position-on-field (caar args)))
8141       (insert (gnus-replace-in-string
8142                (mapconcat 'identity (reverse (cdar args)) ", ")
8143                "\r\n" "\n" t))
8144       (setq args (cdr args)))
8145     (if subject
8146         (message-goto-body)
8147       (message-goto-subject))))
8148
8149 (defun gnus-button-embedded-url (address)
8150   "Activate ADDRESS with `browse-url'."
8151   (browse-url (gnus-strip-whitespace address)))
8152
8153 ;;; Next/prev buttons in the article buffer.
8154
8155 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8156 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8157
8158 (defvar gnus-prev-page-map
8159   (let ((map (make-sparse-keymap)))
8160     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8161     (define-key map "\r" 'gnus-button-prev-page)
8162     map))
8163
8164 (defvar gnus-next-page-map
8165   (let ((map (make-sparse-keymap)))
8166     (define-key map gnus-mouse-2 'gnus-button-next-page)
8167     (define-key map "\r" 'gnus-button-next-page)
8168     map))
8169
8170 (defun gnus-insert-prev-page-button ()
8171   (let ((b (point)) e
8172         (inhibit-read-only t))
8173     (gnus-eval-format
8174      gnus-prev-page-line-format nil
8175      `(keymap ,gnus-prev-page-map
8176               gnus-prev t
8177               gnus-callback gnus-article-button-prev-page
8178               article-type annotation))
8179     (setq e (if (bolp)
8180                 ;; Exclude a newline.
8181                 (1- (point))
8182               (point)))
8183     (when gnus-article-button-face
8184       (gnus-overlay-put (gnus-make-overlay b e nil t)
8185                         'face gnus-article-button-face))
8186     (widget-convert-button
8187      'link b e
8188      :action 'gnus-button-prev-page
8189      :button-keymap gnus-prev-page-map)))
8190
8191 (defun gnus-button-next-page (&optional args more-args)
8192   "Go to the next page."
8193   (interactive)
8194   (let ((win (selected-window)))
8195     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8196     (gnus-article-next-page)
8197     (select-window win)))
8198
8199 (defun gnus-button-prev-page (&optional args more-args)
8200   "Go to the prev page."
8201   (interactive)
8202   (let ((win (selected-window)))
8203     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8204     (gnus-article-prev-page)
8205     (select-window win)))
8206
8207 (defun gnus-insert-next-page-button ()
8208   (let ((b (point)) e
8209         (inhibit-read-only t))
8210     (gnus-eval-format gnus-next-page-line-format nil
8211                       `(keymap ,gnus-next-page-map
8212                                gnus-next t
8213                                gnus-callback gnus-article-button-next-page
8214                                article-type annotation))
8215     (setq e (if (bolp)
8216                 ;; Exclude a newline.
8217                 (1- (point))
8218               (point)))
8219     (when gnus-article-button-face
8220       (gnus-overlay-put (gnus-make-overlay b e nil t)
8221                         'face gnus-article-button-face))
8222     (widget-convert-button
8223      'link b e
8224      :action 'gnus-button-next-page
8225      :button-keymap gnus-next-page-map)))
8226
8227 (defun gnus-article-button-next-page (arg)
8228   "Go to the next page."
8229   (interactive "P")
8230   (let ((win (selected-window)))
8231     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8232     (gnus-article-next-page)
8233     (select-window win)))
8234
8235 (defun gnus-article-button-prev-page (arg)
8236   "Go to the prev page."
8237   (interactive "P")
8238   (let ((win (selected-window)))
8239     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8240     (gnus-article-prev-page)
8241     (select-window win)))
8242
8243 (defvar gnus-decode-header-methods
8244   '(mail-decode-encoded-word-region)
8245   "List of methods used to decode headers.
8246
8247 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8248 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8249 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8250 whose names match REGEXP.
8251
8252 For example:
8253 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8254  mail-decode-encoded-word-region
8255  (\"chinese\" . rfc1843-decode-region))
8256 ")
8257
8258 (defvar gnus-decode-header-methods-cache nil)
8259
8260 (defun gnus-multi-decode-header (start end)
8261   "Apply the functions from `gnus-encoded-word-methods' that match."
8262   (unless (and gnus-decode-header-methods-cache
8263                (eq gnus-newsgroup-name
8264                    (car gnus-decode-header-methods-cache)))
8265     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8266     (dolist (x gnus-decode-header-methods)
8267       (if (symbolp x)
8268           (nconc gnus-decode-header-methods-cache (list x))
8269         (if (and gnus-newsgroup-name
8270                  (string-match (car x) gnus-newsgroup-name))
8271             (nconc gnus-decode-header-methods-cache
8272                    (list (cdr x)))))))
8273   (let ((xlist gnus-decode-header-methods-cache))
8274     (pop xlist)
8275     (save-restriction
8276       (narrow-to-region start end)
8277       (while xlist
8278         (funcall (pop xlist) (point-min) (point-max))))))
8279
8280 ;;;
8281 ;;; Treatment top-level handling.
8282 ;;;
8283
8284 (defvar gnus-inhibit-article-treatments nil)
8285
8286 (defun gnus-treat-article (gnus-treat-condition
8287                            &optional part-number total-parts gnus-treat-type)
8288   (let ((gnus-treat-length (- (point-max) (point-min)))
8289         (alist gnus-treatment-function-alist)
8290         (article-goto-body-goes-to-point-min-p t)
8291         (treated-type
8292          (or (not gnus-treat-type)
8293              (catch 'found
8294                (let ((list gnus-article-treat-types))
8295                  (while list
8296                    (when (string-match (pop list) gnus-treat-type)
8297                      (throw 'found t)))))))
8298         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8299         val elem)
8300     (gnus-run-hooks 'gnus-part-display-hook)
8301     (dolist (elem alist)
8302       (setq val
8303             (save-excursion
8304               (when (gnus-buffer-live-p gnus-summary-buffer)
8305                 (set-buffer gnus-summary-buffer))
8306               (symbol-value (car elem))))
8307       (when (and (or (consp val)
8308                      treated-type)
8309                  (or (not gnus-inhibit-article-treatments)
8310                      (eq gnus-treat-condition 'head))
8311                  (gnus-treat-predicate val)
8312                  (or (not (get (car elem) 'highlight))
8313                      highlightp))
8314         (save-restriction
8315           (funcall (cadr elem)))))))
8316
8317 ;; Dynamic variables.
8318 (defvar part-number)
8319 (defvar total-parts)
8320 (defvar gnus-treat-type)
8321 (defvar gnus-treat-condition)
8322 (defvar gnus-treat-length)
8323
8324 (defun gnus-treat-predicate (val)
8325   (cond
8326    ((null val)
8327     nil)
8328    (gnus-treat-condition
8329     (eq gnus-treat-condition val))
8330    ((and (listp val)
8331          (stringp (car val)))
8332     (apply 'gnus-or (mapcar `(lambda (s)
8333                                (string-match s ,(or gnus-newsgroup-name "")))
8334                             val)))
8335    ((listp val)
8336     (let ((pred (pop val)))
8337       (cond
8338        ((eq pred 'or)
8339         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8340        ((eq pred 'and)
8341         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8342        ((eq pred 'not)
8343         (not (gnus-treat-predicate (car val))))
8344        ((eq pred 'typep)
8345         (equal (car val) gnus-treat-type))
8346        (t
8347         (error "%S is not a valid predicate" pred)))))
8348    ((eq val t)
8349     t)
8350    ((eq val 'head)
8351     nil)
8352    ((eq val 'first)
8353     (eq part-number 1))
8354    ((eq val 'last)
8355     (eq part-number total-parts))
8356    ((numberp val)
8357     (< gnus-treat-length val))
8358    (t
8359     (error "%S is not a valid value" val))))
8360
8361 (defun gnus-article-encrypt-body (protocol &optional n)
8362   "Encrypt the article body."
8363   (interactive
8364    (list
8365     (or gnus-article-encrypt-protocol
8366         (gnus-completing-read "Encrypt protocol"
8367                               (mapcar 'car gnus-article-encrypt-protocol-alist)
8368                               t))
8369     current-prefix-arg))
8370   ;; User might hit `K E' instead of `K e', so prompt once.
8371   (when (and gnus-article-encrypt-protocol
8372              gnus-novice-user)
8373     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8374       (error "Encrypt aborted")))
8375   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8376     (unless func
8377       (error "Can't find the encrypt protocol %s" protocol))
8378     (if (member gnus-newsgroup-name '("nndraft:delayed"
8379                                       "nndraft:drafts"
8380                                       "nndraft:queue"))
8381         (error "Can't encrypt the article in group %s"
8382                gnus-newsgroup-name))
8383     (gnus-summary-iterate n
8384       (with-current-buffer gnus-summary-buffer
8385         (let ((mail-parse-charset gnus-newsgroup-charset)
8386               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8387               (summary-buffer gnus-summary-buffer)
8388               references point)
8389           (gnus-set-global-variables)
8390           (when (gnus-group-read-only-p)
8391             (error "The current newsgroup does not support article encrypt"))
8392           (gnus-summary-show-article t)
8393           (setq references
8394               (or (mail-header-references gnus-current-headers) ""))
8395           (set-buffer gnus-article-buffer)
8396           (let* ((inhibit-read-only t)
8397                  (headers
8398                   (mapcar (lambda (field)
8399                             (and (save-restriction
8400                                    (message-narrow-to-head)
8401                                    (goto-char (point-min))
8402                                    (search-forward field nil t))
8403                                  (prog2
8404                                      (message-narrow-to-field)
8405                                      (buffer-string)
8406                                    (delete-region (point-min) (point-max))
8407                                    (widen))))
8408                           '("Content-Type:" "Content-Transfer-Encoding:"
8409                             "Content-Disposition:"))))
8410             (message-narrow-to-head)
8411             (message-remove-header "MIME-Version")
8412             (goto-char (point-max))
8413             (setq point (point))
8414             (insert (apply 'concat headers))
8415             (widen)
8416             (narrow-to-region point (point-max))
8417             (let ((message-options message-options))
8418               (message-options-set 'message-sender user-mail-address)
8419               (message-options-set 'message-recipients user-mail-address)
8420               (message-options-set 'message-sign-encrypt 'not)
8421               (funcall func))
8422             (goto-char (point-min))
8423             (insert "MIME-Version: 1.0\n")
8424             (widen)
8425             (gnus-summary-edit-article-done
8426              references nil summary-buffer t))
8427           (when gnus-keep-backlog
8428             (gnus-backlog-remove-article
8429              (car gnus-article-current) (cdr gnus-article-current)))
8430           (gnus-flush-original-article-buffer)
8431           (when gnus-use-cache
8432             (gnus-cache-update-article
8433              (car gnus-article-current) (cdr gnus-article-current))))))))
8434
8435 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8436   "The following specs can be used:
8437 %t  The security MIME type
8438 %i  Additional info
8439 %d  Details
8440 %D  Details if button is pressed")
8441
8442 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8443   "The following specs can be used:
8444 %t  The security MIME type
8445 %i  Additional info
8446 %d  Details
8447 %D  Details if button is pressed")
8448
8449 (defvar gnus-mime-security-button-line-format-alist
8450   '((?t gnus-tmp-type ?s)
8451     (?i gnus-tmp-info ?s)
8452     (?d gnus-tmp-details ?s)
8453     (?D gnus-tmp-pressed-details ?s)))
8454
8455 (defvar gnus-mime-security-button-commands
8456   '((gnus-article-press-button "\r" "Show Detail")
8457     (undefined "v")
8458     (undefined "t")
8459     (undefined "C")
8460     (gnus-mime-security-save-part "o" "Save...")
8461     (undefined "\C-o")
8462     (undefined "r")
8463     (undefined "d")
8464     (undefined "c")
8465     (undefined "i")
8466     (undefined "E")
8467     (undefined "e")
8468     (undefined "p")
8469     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8470     (undefined ".")))
8471
8472 (defvar gnus-mime-security-button-map
8473   (let ((map (make-sparse-keymap)))
8474     (define-key map gnus-mouse-2 'gnus-article-push-button)
8475     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8476     (dolist (c gnus-mime-security-button-commands)
8477       (define-key map (cadr c) (car c)))
8478     map))
8479
8480 (easy-menu-define
8481   gnus-mime-security-button-menu gnus-mime-security-button-map
8482   "Security button menu."
8483   `("Security Part"
8484     ,@(delq nil
8485             (mapcar (lambda (c)
8486                       (unless (eq (car c) 'undefined)
8487                         (vector (caddr c) (car c) :active t)))
8488                     gnus-mime-security-button-commands))))
8489
8490 (defun gnus-mime-security-button-menu (event prefix)
8491   "Construct a context-sensitive menu of security commands."
8492   (interactive "e\nP")
8493   (save-window-excursion
8494     (let ((pos (event-start event)))
8495       (select-window (posn-window pos))
8496       (goto-char (posn-point pos))
8497       (gnus-article-check-buffer)
8498       (popup-menu gnus-mime-security-button-menu nil prefix))))
8499
8500 (defvar gnus-mime-security-details-buffer nil)
8501
8502 (defvar gnus-mime-security-button-pressed nil)
8503
8504 (defvar gnus-mime-security-show-details-inline t
8505   "If non-nil, show details in the article buffer.")
8506
8507 (defun gnus-mime-security-verify-or-decrypt (handle)
8508   (mm-remove-parts (cdr handle))
8509   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8510         point (inhibit-read-only t))
8511     (if region
8512         (goto-char (car region)))
8513     (setq point (point))
8514     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8515       (let* ((mm-verify-option 'known)
8516              (mm-decrypt-option 'known)
8517              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8518         (unless (eq nparts (cdr handle))
8519           (mm-destroy-parts (cdr handle))
8520           (setcdr handle nparts))))
8521     (gnus-mime-display-security handle)
8522     (when region
8523       (delete-region (point) (cdr region))
8524       (set-marker (car region) nil)
8525       (set-marker (cdr region) nil))
8526     (goto-char point)))
8527
8528 (defun gnus-mime-security-show-details (handle)
8529   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8530     (if (not details)
8531         (gnus-message 5 "No details.")
8532       (if gnus-mime-security-show-details-inline
8533           (let ((gnus-mime-security-button-pressed
8534                  (not (get-text-property (point) 'gnus-mime-details)))
8535                 (gnus-mime-security-button-line-format
8536                  (get-text-property (point) 'gnus-line-format))
8537                 (inhibit-read-only t))
8538             (forward-char -1)
8539             (while (eq (get-text-property (point) 'gnus-line-format)
8540                        gnus-mime-security-button-line-format)
8541               (forward-char -1))
8542             (forward-char)
8543             (save-restriction
8544               (narrow-to-region (point) (point))
8545               (gnus-insert-mime-security-button handle))
8546             (delete-region (point)
8547                            (or (text-property-not-all
8548                                 (point) (point-max)
8549                                 'gnus-line-format
8550                                 gnus-mime-security-button-line-format)
8551                                (point-max))))
8552         ;; Not inlined.
8553         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8554             (with-current-buffer gnus-mime-security-details-buffer
8555               (erase-buffer)
8556               t)
8557           (setq gnus-mime-security-details-buffer
8558                 (gnus-get-buffer-create "*MIME Security Details*")))
8559         (with-current-buffer gnus-mime-security-details-buffer
8560           (insert details)
8561           (goto-char (point-min)))
8562         (pop-to-buffer gnus-mime-security-details-buffer)))))
8563
8564 (defun gnus-mime-security-press-button (handle)
8565   (save-excursion
8566     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8567         (gnus-mime-security-show-details handle)
8568       (gnus-mime-security-verify-or-decrypt handle))))
8569
8570 (defun gnus-insert-mime-security-button (handle &optional displayed)
8571   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8572          (gnus-tmp-type
8573           (concat
8574            (or (nth 2 (assoc protocol mm-verify-function-alist))
8575                (nth 2 (assoc protocol mm-decrypt-function-alist))
8576                "Unknown")
8577            (if (equal (car handle) "multipart/signed")
8578                " Signed" " Encrypted")
8579            " Part"))
8580          (gnus-tmp-info
8581           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8582               "Undecided"))
8583          (gnus-tmp-details
8584           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8585          gnus-tmp-pressed-details
8586          b e)
8587     (setq gnus-tmp-details
8588           (if gnus-tmp-details
8589               (concat "\n" gnus-tmp-details)
8590             ""))
8591     (setq gnus-tmp-pressed-details
8592           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8593     (unless (bolp)
8594       (insert "\n"))
8595     (setq b (point))
8596     (gnus-eval-format
8597      gnus-mime-security-button-line-format
8598      gnus-mime-security-button-line-format-alist
8599      `(keymap ,gnus-mime-security-button-map
8600          gnus-callback gnus-mime-security-press-button
8601          gnus-line-format ,gnus-mime-security-button-line-format
8602          gnus-mime-details ,gnus-mime-security-button-pressed
8603          article-type annotation
8604          gnus-data ,handle))
8605     (setq e (if (bolp)
8606                 ;; Exclude a newline.
8607                 (1- (point))
8608               (point)))
8609     (when gnus-article-button-face
8610       (gnus-overlay-put (gnus-make-overlay b e nil t)
8611                         'face gnus-article-button-face))
8612     (widget-convert-button
8613      'link b e
8614      :mime-handle handle
8615      :action 'gnus-widget-press-button
8616      :button-keymap gnus-mime-security-button-map
8617      :help-echo
8618      (lambda (widget)
8619        ;; Needed to properly clear the message due to a bug in
8620        ;; wid-edit (XEmacs only).
8621        (when (boundp 'help-echo-owns-message)
8622          (setq help-echo-owns-message t))
8623        (format
8624         "%S: show detail; %S: more options"
8625         (aref gnus-mouse-2 0)
8626         (aref gnus-down-mouse-3 0))))))
8627
8628 (defun gnus-mime-display-security (handle)
8629   (save-restriction
8630     (narrow-to-region (point) (point))
8631     (unless (gnus-unbuttonized-mime-type-p (car handle))
8632       (gnus-insert-mime-security-button handle))
8633     (gnus-mime-display-part (cadr handle))
8634     (unless (bolp)
8635       (insert "\n"))
8636     (unless (gnus-unbuttonized-mime-type-p (car handle))
8637       (let ((gnus-mime-security-button-line-format
8638              gnus-mime-security-button-end-line-format))
8639         (gnus-insert-mime-security-button handle)))
8640     (mm-set-handle-multipart-parameter
8641      handle 'gnus-region
8642      (cons (set-marker (make-marker) (point-min))
8643            (set-marker (make-marker) (point-max))))
8644     (goto-char (point-max))))
8645
8646 (defun gnus-mime-security-run-function (function)
8647   "Run FUNCTION with the security part under point."
8648   (gnus-article-check-buffer)
8649   (let ((data (get-text-property (point) 'gnus-data))
8650         buffer handle)
8651     (when (and (stringp (car-safe data))
8652                (setq buffer (mm-handle-multipart-original-buffer data))
8653                (setq handle (cadr data)))
8654       (if (bufferp (mm-handle-buffer handle))
8655           (progn
8656             (setq handle (cons buffer (copy-sequence (cdr handle))))
8657             (mm-handle-set-undisplayer handle nil))
8658         (setq handle (mm-make-handle
8659                       buffer
8660                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8661                       nil nil nil nil nil nil)))
8662       (funcall function handle))))
8663
8664 (defun gnus-mime-security-save-part ()
8665   "Save the security part under point."
8666   (interactive)
8667   (gnus-mime-security-run-function 'mm-save-part))
8668
8669 (defun gnus-mime-security-pipe-part ()
8670   "Pipe the security part under point to a process."
8671   (interactive)
8672   (gnus-mime-security-run-function 'mm-pipe-part))
8673
8674 (gnus-ems-redefine)
8675
8676 (provide 'gnus-art)
8677
8678 (run-hooks 'gnus-art-load-hook)
8679
8680 ;;; gnus-art.el ends here