20ba0b3a2362265148817ffbb24abb029eca8ba8
[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 nil
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 (defvar gnus-article-wash-function nil
1625   "Function used for converting HTML into text.")
1626
1627 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1628                               (mm-coding-system-p 'utf-8)
1629                               (executable-find idna-program))
1630   "Whether IDNA decoding of headers is used when viewing messages.
1631 This requires GNU Libidn, and by default only enabled if it is found."
1632   :version "22.1"
1633   :group 'gnus-article-headers
1634   :type 'boolean)
1635
1636 (defcustom gnus-article-over-scroll nil
1637   "If non-nil, allow scrolling the article buffer even when there no more text."
1638   :version "22.1"
1639   :group 'gnus-article
1640   :type 'boolean)
1641
1642 (defcustom gnus-blocked-images "."
1643   "Images that have URLs matching this regexp will be blocked."
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-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 (defun article-translate-characters (from to)
2118   "Translate all characters in the body of the article according to FROM and TO.
2119 FROM is a string of characters to translate from; to is a string of
2120 characters to translate to."
2121   (save-excursion
2122     (when (article-goto-body)
2123       (let ((inhibit-read-only t)
2124             (x (make-string 225 ?x))
2125             (i -1))
2126         (while (< (incf i) (length x))
2127           (aset x i i))
2128         (setq i 0)
2129         (while (< i (length from))
2130           (aset x (aref from i) (aref to i))
2131           (incf i))
2132         (translate-region (point) (point-max) x)))))
2133
2134 (defun article-translate-strings (map)
2135   "Translate all string in the body of the article according to MAP.
2136 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2137   (save-excursion
2138     (when (article-goto-body)
2139       (let ((inhibit-read-only t))
2140         (dolist (elem map)
2141           (let ((from (car elem))
2142                 (to (cadr elem)))
2143             (save-excursion
2144               (if (stringp from)
2145                   (while (search-forward from nil t)
2146                     (replace-match to))
2147                 (while (not (eobp))
2148                   (if (eq (following-char) from)
2149                       (progn
2150                         (delete-char 1)
2151                         (insert to))
2152                     (forward-char 1)))))))))))
2153
2154 (defun article-treat-overstrike ()
2155   "Translate overstrikes into bold text."
2156   (interactive)
2157   (save-excursion
2158     (when (article-goto-body)
2159       (let ((inhibit-read-only t))
2160         (while (search-forward "\b" nil t)
2161           (let ((next (char-after))
2162                 (previous (char-after (- (point) 2))))
2163             ;; We do the boldification/underlining by hiding the
2164             ;; overstrikes and putting the proper text property
2165             ;; on the letters.
2166             (cond
2167              ((eq next previous)
2168               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2169               (put-text-property (point) (1+ (point)) 'face 'bold))
2170              ((eq next ?_)
2171               (gnus-article-hide-text-type
2172                (1- (point)) (1+ (point)) 'overstrike)
2173               (put-text-property
2174                (- (point) 2) (1- (point)) 'face 'underline))
2175              ((eq previous ?_)
2176               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2177               (put-text-property
2178                (point) (1+ (point)) 'face 'underline)))))))))
2179
2180 (defun article-treat-ansi-sequences ()
2181   "Translate ANSI SGR control sequences into overlays or extents."
2182   (interactive)
2183   (save-excursion
2184     (when (article-goto-body)
2185       (let ((inhibit-read-only t))
2186         (ansi-color-apply-on-region (point) (point-max))))))
2187
2188 (defun gnus-article-treat-unfold-headers ()
2189   "Unfold folded message headers.
2190 Only the headers that fit into the current window width will be
2191 unfolded."
2192   (interactive)
2193   (gnus-with-article-headers
2194     (let (length)
2195       (while (not (eobp))
2196         (save-restriction
2197           (mail-header-narrow-to-field)
2198           (let* ((header (buffer-string))
2199                  (unfoldable
2200                   (or (equal gnus-article-unfold-long-headers t)
2201                       (and (stringp gnus-article-unfold-long-headers)
2202                            (string-match gnus-article-unfold-long-headers header)))))
2203             (with-temp-buffer
2204               (insert header)
2205               (goto-char (point-min))
2206               (while (re-search-forward "\n[\t ]" nil t)
2207                 (replace-match " " t t)))
2208             (setq length (- (point-max) (point-min) 1))
2209             (when (or unfoldable
2210                       (< length (window-width)))
2211               (while (re-search-forward "\n[\t ]" nil t)
2212                 (replace-match " " t t))))
2213           (goto-char (point-max)))))))
2214
2215 (defun gnus-article-treat-fold-headers ()
2216   "Fold message headers."
2217   (interactive)
2218   (gnus-with-article-headers
2219     (while (not (eobp))
2220       (save-restriction
2221         (mail-header-narrow-to-field)
2222         (mail-header-fold-field)
2223         (goto-char (point-max))))))
2224
2225 (defun gnus-treat-smiley ()
2226   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2227   (interactive)
2228   (gnus-with-article-buffer
2229     (if (memq 'smiley gnus-article-wash-types)
2230         (gnus-delete-images 'smiley)
2231       (article-goto-body)
2232       (let ((images (smiley-region (point) (point-max))))
2233         (when images
2234           (gnus-add-wash-type 'smiley)
2235           (dolist (image images)
2236             (gnus-add-image 'smiley image)))))))
2237
2238 (defun gnus-article-remove-images ()
2239   "Remove all images from the article buffer."
2240   (interactive)
2241   (gnus-with-article-buffer
2242     (dolist (elem gnus-article-image-alist)
2243       (gnus-delete-images (car elem)))))
2244
2245 (defun gnus-article-treat-fold-newsgroups ()
2246   "Unfold folded message headers.
2247 Only the headers that fit into the current window width will be
2248 unfolded."
2249   (interactive)
2250   (gnus-with-article-headers
2251     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2252       (save-restriction
2253         (mail-header-narrow-to-field)
2254         (while (re-search-forward ", *" nil t)
2255           (replace-match ", " t t))
2256         (mail-header-fold-field)
2257         (goto-char (point-max))))))
2258
2259 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2260   "Value of `truncate-lines' in Gnus Article buffer.
2261 Valid values are nil, t, `head', `first', `last', an integer or a
2262 predicate.  See Info node `(gnus)Customizing Articles'."
2263   :version "23.1" ;; No Gnus
2264   :group 'gnus-article
2265   ;; :link '(custom-manual "(gnus)Customizing Articles")
2266   :type 'boolean)
2267
2268 (defun gnus-article-toggle-truncate-lines (&optional arg)
2269   "Toggle whether to fold or truncate long lines in article the buffer.
2270 If ARG is non-nil and not a number, toggle
2271 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2272 long lines if and only if arg is positive."
2273   (interactive "P")
2274   (cond
2275    ((and (numberp arg) (> arg 0))
2276     (setq gnus-article-truncate-lines t))
2277    ((numberp arg)
2278     (setq gnus-article-truncate-lines nil))
2279    (arg
2280     (setq gnus-article-truncate-lines
2281           (not gnus-article-truncate-lines))))
2282   (gnus-with-article-buffer
2283     (cond
2284      ((and (numberp arg) (> arg 0))
2285       (setq truncate-lines nil))
2286      ((numberp arg)
2287       (setq truncate-lines t)))
2288     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2289     ;; `toggle-truncate-lines' needs an argument.
2290     (toggle-truncate-lines)))
2291
2292 (defun gnus-article-treat-body-boundary ()
2293   "Place a boundary line at the end of the headers."
2294   (interactive)
2295   (when (and gnus-body-boundary-delimiter
2296              (> (length gnus-body-boundary-delimiter) 0))
2297     (gnus-with-article-headers
2298       (goto-char (point-max))
2299       (let ((start (point)))
2300         (insert "X-Boundary: ")
2301         (gnus-add-text-properties start (point) '(invisible t intangible t))
2302         (insert (let (str)
2303                   (while (>= (window-width) (length str))
2304                     (setq str (concat str gnus-body-boundary-delimiter)))
2305                   (substring str 0 (window-width)))
2306                 "\n")
2307         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2308
2309 (defun article-fill-long-lines ()
2310   "Fill lines that are wider than the window width."
2311   (interactive)
2312   (save-excursion
2313     (let ((inhibit-read-only t)
2314           (width (window-width (get-buffer-window (current-buffer)))))
2315       (save-restriction
2316         (article-goto-body)
2317         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2318           (while (not (eobp))
2319             (end-of-line)
2320             (when (>= (current-column) (min fill-column width))
2321               (narrow-to-region (min (1+ (point)) (point-max))
2322                                 (point-at-bol))
2323               (let ((goback (point-marker)))
2324                 (fill-paragraph nil)
2325                 (goto-char (marker-position goback)))
2326               (widen))
2327             (forward-line 1)))))))
2328
2329 (defun article-capitalize-sentences ()
2330   "Capitalize the first word in each sentence."
2331   (interactive)
2332   (save-excursion
2333     (let ((inhibit-read-only t)
2334           (paragraph-start "^[\n\^L]"))
2335       (article-goto-body)
2336       (while (not (eobp))
2337         (capitalize-word 1)
2338         (forward-sentence)))))
2339
2340 (defun article-remove-cr ()
2341   "Remove trailing CRs and then translate remaining CRs into LFs."
2342   (interactive)
2343   (save-excursion
2344     (let ((inhibit-read-only t))
2345       (goto-char (point-min))
2346       (while (re-search-forward "\r+$" nil t)
2347         (replace-match "" t t))
2348       (goto-char (point-min))
2349       (while (search-forward "\r" nil t)
2350         (replace-match "\n" t t)))))
2351
2352 (defun article-remove-trailing-blank-lines ()
2353   "Remove all trailing blank lines from the article."
2354   (interactive)
2355   (save-excursion
2356     (let ((inhibit-read-only t))
2357       (goto-char (point-max))
2358       (delete-region
2359        (point)
2360        (progn
2361          (while (and (not (bobp))
2362                      (looking-at "^[ \t]*$")
2363                      (not (gnus-annotation-in-region-p
2364                            (point) (point-at-eol))))
2365            (forward-line -1))
2366          (forward-line 1)
2367          (point))))))
2368
2369 (defvar gnus-face-properties-alist)
2370
2371 (defun article-display-face (&optional force)
2372   "Display any Face headers in the header."
2373   (interactive (list 'force))
2374   (let ((wash-face-p buffer-read-only))
2375     (gnus-with-article-headers
2376       ;; When displaying parts, this function can be called several times on
2377       ;; the same article, without any intended toggle semantic (as typing `W
2378       ;; D d' would have). So face deletion must occur only when we come from
2379       ;; an interactive command, that is when the *Article* buffer is
2380       ;; read-only.
2381       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2382           (gnus-delete-images 'face)
2383         (let ((from (message-fetch-field "from"))
2384               face faces)
2385           (save-current-buffer
2386             (when (and wash-face-p
2387                        (gnus-buffer-live-p gnus-original-article-buffer)
2388                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2389               (set-buffer gnus-original-article-buffer))
2390             (save-restriction
2391               (mail-narrow-to-head)
2392               (when (or force
2393                         ;; Check whether this face is censored.
2394                         (not (and gnus-article-x-face-too-ugly
2395                                   (or from
2396                                       (setq from (message-fetch-field "from")))
2397                                   (string-match gnus-article-x-face-too-ugly
2398                                                 from))))
2399                 (while (gnus-article-goto-header "Face")
2400                   (push (mail-header-field-value) faces)))))
2401           (when faces
2402             (goto-char (point-min))
2403             (let (png image)
2404               (unless (setq from (gnus-article-goto-header "from"))
2405                 (insert "From:")
2406                 (setq from (point))
2407                 (insert " [no `from' set]\n"))
2408               (while faces
2409                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2410                   (setq image
2411                         (apply 'gnus-create-image png 'png t
2412                                (cdr (assq 'png gnus-face-properties-alist))))
2413                   (goto-char from)
2414                   (gnus-add-wash-type 'face)
2415                   (gnus-add-image 'face image)
2416                   (gnus-put-image image nil 'face))))))))))
2417
2418 (defun article-display-x-face (&optional force)
2419   "Look for an X-Face header and display it if present."
2420   (interactive (list 'force))
2421   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2422     (gnus-with-article-headers
2423       ;; Delete the old process, if any.
2424       (when (process-status "article-x-face")
2425         (delete-process "article-x-face"))
2426       ;; See the comment in `article-display-face'.
2427       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2428           ;; We have already displayed X-Faces, so we remove them
2429           ;; instead.
2430           (gnus-delete-images 'xface)
2431         ;; Display X-Faces.
2432         (let ((from (message-fetch-field "from"))
2433               x-faces face)
2434           (save-current-buffer
2435             (when (and wash-face-p
2436                        (gnus-buffer-live-p gnus-original-article-buffer)
2437                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2438               ;; If type `W f', use gnus-original-article-buffer,
2439               ;; otherwise use the current buffer because displaying
2440               ;; RFC822 parts calls this function too.
2441               (set-buffer gnus-original-article-buffer))
2442             (save-restriction
2443               (mail-narrow-to-head)
2444               (and gnus-article-x-face-command
2445                    (or force
2446                        ;; Check whether this face is censored.
2447                        (not (and gnus-article-x-face-too-ugly
2448                                  (or from
2449                                      (setq from (message-fetch-field "from")))
2450                                  (string-match gnus-article-x-face-too-ugly
2451                                                from))))
2452                    (while (gnus-article-goto-header "X-Face")
2453                      (push (mail-header-field-value) x-faces)))))
2454           (when x-faces
2455             ;; We display the face.
2456             (cond ((functionp gnus-article-x-face-command)
2457                    ;; The command is a lisp function, so we call it.
2458                    (mapc gnus-article-x-face-command x-faces))
2459                   ((stringp gnus-article-x-face-command)
2460                    ;; The command is a string, so we interpret the command
2461                    ;; as a, well, command, and fork it off.
2462                    (let ((process-connection-type nil))
2463                      (gnus-set-process-query-on-exit-flag
2464                       (start-process
2465                        "article-x-face" nil shell-file-name
2466                        shell-command-switch gnus-article-x-face-command)
2467                       nil)
2468                      ;; Sending multiple EOFs to xv doesn't work,
2469                      ;; so we only do a single external face.
2470                      (with-temp-buffer
2471                        (insert (car x-faces))
2472                        (process-send-region "article-x-face"
2473                                             (point-min) (point-max)))
2474                      (process-send-eof "article-x-face")))
2475                   (t
2476                    (error "`%s' set to `%s' is not a function"
2477                           gnus-article-x-face-command
2478                           'gnus-article-x-face-command)))))))))
2479
2480 (defun article-decode-mime-words ()
2481   "Decode all MIME-encoded words in the article."
2482   (interactive)
2483   (gnus-with-article-buffer
2484     (let ((inhibit-point-motion-hooks t)
2485           (mail-parse-charset gnus-newsgroup-charset)
2486           (mail-parse-ignored-charsets
2487            (with-current-buffer gnus-summary-buffer
2488              gnus-newsgroup-ignored-charsets)))
2489       (mail-decode-encoded-word-region (point-min) (point-max)))))
2490
2491 (defun article-decode-charset (&optional prompt)
2492   "Decode charset-encoded text in the article.
2493 If PROMPT (the prefix), prompt for a coding system to use."
2494   (interactive "P")
2495   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2496         (inhibit-read-only t)
2497         (mail-parse-charset gnus-newsgroup-charset)
2498         (mail-parse-ignored-charsets
2499          (save-excursion (condition-case nil
2500                              (set-buffer gnus-summary-buffer)
2501                            (error))
2502                          gnus-newsgroup-ignored-charsets))
2503         ct cte ctl charset format)
2504     (save-excursion
2505       (save-restriction
2506         (article-narrow-to-head)
2507         (setq ct (message-fetch-field "Content-Type" t)
2508               cte (message-fetch-field "Content-Transfer-Encoding" t)
2509               ctl (and ct (mail-header-parse-content-type ct))
2510               charset (cond
2511                        (prompt
2512                         (mm-read-coding-system "Charset to decode: "))
2513                        (ctl
2514                         (mail-content-type-get ctl 'charset)))
2515               format (and ctl (mail-content-type-get ctl 'format)))
2516         (when cte
2517           (setq cte (mail-header-strip cte)))
2518         (if (and ctl (not (string-match "/" (car ctl))))
2519             (setq ctl nil))
2520         (goto-char (point-max)))
2521       (forward-line 1)
2522       (save-restriction
2523         (narrow-to-region (point) (point-max))
2524         (when (and (eq mail-parse-charset 'gnus-decoded)
2525                    (eq (mm-body-7-or-8) '8bit))
2526           ;; The text code could have been decoded.
2527           (setq charset mail-parse-charset))
2528         (when (and (or (not ctl)
2529                        (equal (car ctl) "text/plain"))
2530                    (not format)) ;; article with format will decode later.
2531           (mm-decode-body
2532            charset (and cte (intern (downcase
2533                                      (gnus-strip-whitespace cte))))
2534            (car ctl)))))))
2535
2536 (defun article-decode-encoded-words ()
2537   "Remove encoded-word encoding from headers."
2538   (let ((inhibit-point-motion-hooks t)
2539         (mail-parse-charset gnus-newsgroup-charset)
2540         (mail-parse-ignored-charsets
2541          (save-excursion (condition-case nil
2542                              (set-buffer gnus-summary-buffer)
2543                            (error))
2544                          gnus-newsgroup-ignored-charsets))
2545         (inhibit-read-only t)
2546         end start)
2547     (goto-char (point-min))
2548     (when (search-forward "\n\n" nil 'move)
2549       (forward-line -1))
2550     (setq end (point))
2551     (while (not (bobp))
2552       (while (progn
2553                (forward-line -1)
2554                (and (not (bobp))
2555                     (memq (char-after) '(?\t ? )))))
2556       (setq start (point))
2557       (if (looking-at "\
2558 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2559 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2560           (funcall gnus-decode-address-function start end)
2561         (funcall gnus-decode-header-function start end))
2562       (goto-char (setq end start)))))
2563
2564 (defun article-decode-group-name ()
2565   "Decode group names in Newsgroups, Followup-To and Xref headers."
2566   (let ((inhibit-point-motion-hooks t)
2567         (inhibit-read-only t)
2568         (method (gnus-find-method-for-group gnus-newsgroup-name))
2569         regexp)
2570     (when (and (or gnus-group-name-charset-method-alist
2571                    gnus-group-name-charset-group-alist)
2572                (gnus-buffer-live-p gnus-original-article-buffer))
2573       (save-restriction
2574         (article-narrow-to-head)
2575         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2576           (with-current-buffer gnus-original-article-buffer
2577             (goto-char (point-min)))
2578           (setq regexp (concat "^" header
2579                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2580           (while (re-search-forward regexp nil t)
2581             (replace-match (save-match-data
2582                              (gnus-decode-newsgroups
2583                               ;; XXX how to use data in article buffer?
2584                               (with-current-buffer gnus-original-article-buffer
2585                                 (re-search-forward regexp nil t)
2586                                 (match-string 1))
2587                               gnus-newsgroup-name method))
2588                            t t nil 1))
2589           (goto-char (point-min)))))))
2590
2591 (autoload 'idna-to-unicode "idna")
2592
2593 (defun article-decode-idna-rhs ()
2594   "Decode IDNA strings in RHS in various headers in current buffer.
2595 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2596 Mail-Reply-To: and Mail-Followup-To:."
2597   (when gnus-use-idna
2598     (save-restriction
2599       (let ((inhibit-point-motion-hooks t)
2600             (inhibit-read-only t))
2601         (article-narrow-to-head)
2602         (goto-char (point-min))
2603         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2604           (let (ace unicode)
2605             (when (save-match-data
2606                     (and (setq ace (match-string 1))
2607                          (save-excursion
2608                            (and (re-search-backward "^[^ \t]" nil t)
2609                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2610                          (setq unicode (idna-to-unicode ace))))
2611               (unless (string= ace unicode)
2612                 (replace-match unicode nil nil nil 1)))))))))
2613
2614 (defun article-de-quoted-unreadable (&optional force read-charset)
2615   "Translate a quoted-printable-encoded article.
2616 If FORCE, decode the article whether it is marked as quoted-printable
2617 or not.
2618 If READ-CHARSET, ask for a coding system."
2619   (interactive (list 'force current-prefix-arg))
2620   (save-excursion
2621     (let ((inhibit-read-only t) type charset)
2622       (if (gnus-buffer-live-p gnus-original-article-buffer)
2623           (with-current-buffer gnus-original-article-buffer
2624             (setq type
2625                   (gnus-fetch-field "content-transfer-encoding"))
2626             (let* ((ct (gnus-fetch-field "content-type"))
2627                    (ctl (and ct (mail-header-parse-content-type ct))))
2628               (setq charset (and ctl
2629                                  (mail-content-type-get ctl 'charset)))
2630               (if (stringp charset)
2631                   (setq charset (intern (downcase charset)))))))
2632       (if read-charset
2633           (setq charset (mm-read-coding-system "Charset: " charset)))
2634       (unless charset
2635         (setq charset gnus-newsgroup-charset))
2636       (when (or force
2637                 (and type (let ((case-fold-search t))
2638                             (string-match "quoted-printable" type))))
2639         (article-goto-body)
2640         (quoted-printable-decode-region
2641          (point) (point-max) (mm-charset-to-coding-system charset))))))
2642
2643 (defun article-de-base64-unreadable (&optional force read-charset)
2644   "Translate a base64 article.
2645 If FORCE, decode the article whether it is marked as base64 not.
2646 If READ-CHARSET, ask for a coding system."
2647   (interactive (list 'force current-prefix-arg))
2648   (save-excursion
2649     (let ((inhibit-read-only t) type charset)
2650       (if (gnus-buffer-live-p gnus-original-article-buffer)
2651           (with-current-buffer gnus-original-article-buffer
2652             (setq type
2653                   (gnus-fetch-field "content-transfer-encoding"))
2654             (let* ((ct (gnus-fetch-field "content-type"))
2655                    (ctl (and ct (mail-header-parse-content-type ct))))
2656               (setq charset (and ctl
2657                                  (mail-content-type-get ctl 'charset)))
2658               (if (stringp charset)
2659                   (setq charset (intern (downcase charset)))))))
2660       (if read-charset
2661           (setq charset (mm-read-coding-system "Charset: " charset)))
2662       (unless charset
2663         (setq charset gnus-newsgroup-charset))
2664       (when (or force
2665                 (and type (let ((case-fold-search t))
2666                             (string-match "base64" type))))
2667         (article-goto-body)
2668         (save-restriction
2669           (narrow-to-region (point) (point-max))
2670           (base64-decode-region (point-min) (point-max))
2671           (mm-decode-coding-region
2672            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2673
2674 (eval-when-compile
2675   (require 'rfc1843))
2676
2677 (defun article-decode-HZ ()
2678   "Translate a HZ-encoded article."
2679   (interactive)
2680   (require 'rfc1843)
2681   (save-excursion
2682     (let ((inhibit-read-only t))
2683       (rfc1843-decode-region (point-min) (point-max)))))
2684
2685 (defun article-unsplit-urls ()
2686   "Remove the newlines that some other mailers insert into URLs."
2687   (interactive)
2688   (save-excursion
2689     (let ((inhibit-read-only t))
2690       (goto-char (point-min))
2691       (while (re-search-forward
2692               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2693         (replace-match "\\1\\3" t)))
2694     (when (interactive-p)
2695       (gnus-treat-article nil))))
2696
2697
2698 (defun article-wash-html (&optional read-charset)
2699   "Format an HTML article.
2700 If READ-CHARSET, ask for a coding system.  If it is a number, the
2701 charset defined in `gnus-summary-show-article-charset-alist' is used."
2702   (interactive "P")
2703   (save-excursion
2704     (let ((inhibit-read-only t)
2705           charset)
2706       (if read-charset
2707           (if (or (and (numberp read-charset)
2708                        (setq charset
2709                              (cdr
2710                               (assq read-charset
2711                                     gnus-summary-show-article-charset-alist))))
2712                   (setq charset (mm-read-coding-system "Charset: ")))
2713               (let ((gnus-summary-show-article-charset-alist
2714                      (list (cons 1 charset))))
2715                 (with-current-buffer gnus-summary-buffer
2716                   (gnus-summary-show-article 1)))
2717             (error "No charset is given"))
2718         (when (gnus-buffer-live-p gnus-original-article-buffer)
2719           (with-current-buffer gnus-original-article-buffer
2720             (let* ((ct (gnus-fetch-field "content-type"))
2721                    (ctl (and ct (mail-header-parse-content-type ct))))
2722               (setq charset (and ctl
2723                                  (mail-content-type-get ctl 'charset)))
2724               (when (stringp charset)
2725                 (setq charset (intern (downcase charset)))))))
2726         (unless charset
2727           (setq charset gnus-newsgroup-charset)))
2728       (article-goto-body)
2729       (save-window-excursion
2730         (save-restriction
2731           (narrow-to-region (point) (point-max))
2732           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2733                  (entry (assq func mm-text-html-washer-alist)))
2734             (when entry
2735               (setq func (cdr entry)))
2736             (cond
2737              ((functionp func)
2738               (funcall func))
2739              (t
2740               (apply (car func) (cdr func))))))))))
2741
2742 ;; External.
2743 (declare-function w3-region "ext:w3-display" (st nd))
2744
2745 (defun gnus-article-wash-html-with-w3 ()
2746   "Wash the current buffer with w3."
2747   (mm-setup-w3)
2748   (let ((w3-strict-width (window-width))
2749         (url-standalone-mode t)
2750         (url-gateway-unplugged t)
2751         (w3-honor-stylesheets nil))
2752     (condition-case ()
2753         (w3-region (point-min) (point-max))
2754       (error))))
2755
2756 ;; External.
2757 (declare-function w3m-region "ext:w3m" (start end &optional url charset))
2758
2759 (defun gnus-article-wash-html-with-w3m ()
2760   "Wash the current buffer with emacs-w3m."
2761   (mm-setup-w3m)
2762   (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2763         w3m-force-redisplay)
2764     (w3m-region (point-min) (point-max)))
2765   ;; Put the mark meaning this part was rendered by emacs-w3m.
2766   (put-text-property (point-min) (point-max) 'mm-inline-text-html-with-w3m t)
2767   (when (and mm-inline-text-html-with-w3m-keymap
2768              (boundp 'w3m-minor-mode-map)
2769              w3m-minor-mode-map)
2770     (if (and (boundp 'w3m-link-map)
2771              w3m-link-map)
2772         (let* ((start (point-min))
2773                (end (point-max))
2774                (on (get-text-property start 'w3m-href-anchor))
2775                (map (copy-keymap w3m-link-map))
2776                next)
2777           (set-keymap-parent map w3m-minor-mode-map)
2778           (while (< start end)
2779             (if on
2780                 (progn
2781                   (setq next (or (text-property-any start end
2782                                                     'w3m-href-anchor nil)
2783                                  end))
2784                   (put-text-property start next 'keymap map))
2785               (setq next (or (text-property-not-all start end
2786                                                     'w3m-href-anchor nil)
2787                              end))
2788               (put-text-property start next 'keymap w3m-minor-mode-map))
2789             (setq start next
2790                   on (not on))))
2791       (put-text-property (point-min) (point-max) 'keymap w3m-minor-mode-map))))
2792
2793 (defvar charset) ;; Bound by `article-wash-html'.
2794
2795 (defun gnus-article-wash-html-with-w3m-standalone ()
2796   "Wash the current buffer with w3m."
2797   (if (mm-w3m-standalone-supports-m17n-p)
2798       (progn
2799         (unless (mm-coding-system-p charset) ;; Bound by `article-wash-html'.
2800           ;; The default.
2801           (setq charset 'iso-8859-1))
2802         (let ((coding-system-for-write charset)
2803               (coding-system-for-read charset))
2804           (call-process-region
2805            (point-min) (point-max)
2806            "w3m" t t nil "-dump" "-T" "text/html"
2807            "-I" (symbol-name charset) "-O" (symbol-name charset))))
2808     (mm-inline-wash-with-stdin nil "w3m" "-dump" "-T" "text/html")))
2809
2810 (defvar gnus-article-browse-html-temp-list nil
2811   "List of temporary files created by `gnus-article-browse-html-parts'.
2812 Internal variable.")
2813
2814 (defcustom gnus-article-browse-delete-temp 'ask
2815   "What to do with temporary files from `gnus-article-browse-html-parts'.
2816 If nil, don't delete temporary files.  If it is t, delete them on
2817 exit from the summary buffer.  If it is the symbol `file', query
2818 on each file, if it is `ask' ask once when exiting from the
2819 summary buffer."
2820   :group 'gnus-article
2821   :version "23.1" ;; No Gnus
2822   :type '(choice (const :tag "Don't delete" nil)
2823                  (const :tag "Don't ask" t)
2824                  (const :tag "Ask" ask)
2825                  (const :tag "Ask for each file" file)))
2826
2827 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2828
2829 (defun gnus-article-browse-delete-temp-files (&optional how)
2830   "Delete temp-files created by `gnus-article-browse-html-parts'."
2831   (when (and gnus-article-browse-html-temp-list
2832              (progn
2833                (or how (setq how gnus-article-browse-delete-temp))
2834                (if (eq how 'ask)
2835                    (let ((files (length gnus-article-browse-html-temp-list)))
2836                      (gnus-y-or-n-p (format
2837                                      "Delete all %s temporary HTML file%s? "
2838                                      files
2839                                      (if (> files 1) "s" ""))))
2840                  how)))
2841     (dolist (file gnus-article-browse-html-temp-list)
2842       (cond ((file-directory-p file)
2843              (when (or (not (eq how 'file))
2844                        (gnus-y-or-n-p
2845                         (format
2846                          "Delete temporary HTML file(s) in directory `%s'? "
2847                          (file-name-as-directory file))))
2848                (gnus-delete-directory file)))
2849             ((file-exists-p file)
2850              (when (or (not (eq how 'file))
2851                        (gnus-y-or-n-p
2852                         (format "Delete temporary HTML file `%s'? " file)))
2853                (delete-file file)))))
2854     ;; Also remove file from the list when not deleted or if file doesn't
2855     ;; exist anymore.
2856     (setq gnus-article-browse-html-temp-list nil))
2857   gnus-article-browse-html-temp-list)
2858
2859 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2860   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2861 Return file name."
2862   (save-match-data
2863     (let (file type)
2864       (catch 'found
2865         (dolist (handle handles)
2866           (cond
2867            ((not (listp handle)))
2868            ((equal (mm-handle-media-supertype handle) "multipart")
2869             (when (setq file (gnus-article-browse-html-save-cid-content
2870                               cid handle directory))
2871               (throw 'found file)))
2872            ((equal (concat "<" cid ">") (mm-handle-id handle))
2873             (setq file
2874                   (expand-file-name
2875                    (or (mail-content-type-get
2876                         (mm-handle-disposition handle) 'filename)
2877                        (mail-content-type-get
2878                         (setq type (mm-handle-type handle)) 'name)
2879                        (concat
2880                         (make-temp-name "cid")
2881                         (car (rassoc (car type) mailcap-mime-extensions))))
2882                    directory))
2883             (mm-save-part-to-file handle file)
2884             (throw 'found file))))))))
2885
2886 (defun gnus-article-browse-html-parts (list &optional header)
2887   "View all \"text/html\" parts from LIST.
2888 Recurse into multiparts.  The optional HEADER that should be a decoded
2889 message header will be added to the bodies of the \"text/html\" parts."
2890   ;; Internal function used by `gnus-article-browse-html-article'.
2891   (let (type file charset content cid-dir tmp-file showed)
2892     ;; Find and show the html-parts.
2893     (dolist (handle list)
2894       ;; If HTML, show it:
2895       (cond ((not (listp handle)))
2896             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2897                  (and (equal (car type) "message/external-body")
2898                       (or header
2899                           (setq file (or (mail-content-type-get type 'name)
2900                                          (mail-content-type-get
2901                                           (mm-handle-disposition handle)
2902                                           'filename))))
2903                       (or (mm-handle-cache handle)
2904                           (condition-case code
2905                               (progn (mm-extern-cache-contents handle) t)
2906                             (error
2907                              (gnus-message 3 "%s" (error-message-string code))
2908                              (when (>= gnus-verbose 3) (sit-for 2))
2909                              nil)))
2910                       (progn
2911                         (setq handle (mm-handle-cache handle)
2912                               type (mm-handle-type handle))
2913                         (equal (car type) "text/html"))))
2914              (setq charset (mail-content-type-get type 'charset)
2915                    content (mm-get-part handle))
2916              (with-temp-buffer
2917                (if (eq charset 'gnus-decoded)
2918                    (mm-enable-multibyte)
2919                  (mm-disable-multibyte))
2920                (insert content)
2921                ;; resolve cid contents
2922                (let ((case-fold-search t)
2923                      cid-file)
2924                  (goto-char (point-min))
2925                  (while (re-search-forward "\
2926 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2927                                            nil t)
2928                    (unless cid-dir
2929                      (setq cid-dir (mm-make-temp-file "cid" t))
2930                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2931                    (setq file nil
2932                          content nil)
2933                    (when (setq cid-file
2934                                (gnus-article-browse-html-save-cid-content
2935                                 (match-string 2)
2936                                 (with-current-buffer gnus-article-buffer
2937                                   gnus-article-mime-handles)
2938                                 cid-dir))
2939                      (replace-match (concat "file://" cid-file)
2940                                     nil nil nil 1))))
2941                (unless content (setq content (buffer-string))))
2942              (when (or charset header (not file))
2943                (setq tmp-file (mm-make-temp-file
2944                                ;; Do we need to care for 8.3 filenames?
2945                                "mm-" nil ".html")))
2946              ;; Add a meta html tag to specify charset and a header.
2947              (cond
2948               (header
2949                (let (title eheader body hcharset coding force-charset)
2950                  (with-temp-buffer
2951                    (mm-enable-multibyte)
2952                    (setq case-fold-search t)
2953                    (insert header "\n")
2954                    (setq title (message-fetch-field "subject"))
2955                    (goto-char (point-min))
2956                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2957                      (replace-match (cond ((match-beginning 1) "&lt;")
2958                                           ((match-beginning 2) "&gt;")
2959                                           (t "&amp;"))))
2960                    (goto-char (point-min))
2961                    (insert "<pre>\n")
2962                    (goto-char (point-max))
2963                    (insert "</pre>\n<hr>\n")
2964                    ;; We have to examine charset one by one since
2965                    ;; charset specified in parts might be different.
2966                    (if (eq charset 'gnus-decoded)
2967                        (setq charset 'utf-8
2968                              eheader (mm-encode-coding-string (buffer-string)
2969                                                               charset)
2970                              title (when title
2971                                      (mm-encode-coding-string title charset))
2972                              body (mm-encode-coding-string content charset)
2973                              force-charset t)
2974                      (setq hcharset (mm-find-mime-charset-region (point-min)
2975                                                                  (point-max)))
2976                      (cond ((= (length hcharset) 1)
2977                             (setq hcharset (car hcharset)
2978                                   coding (mm-charset-to-coding-system
2979                                           hcharset)))
2980                            ((> (length hcharset) 1)
2981                             (setq hcharset 'utf-8
2982                                   coding hcharset)))
2983                      (if coding
2984                          (if charset
2985                              (progn
2986                                (setq body
2987                                      (mm-charset-to-coding-system charset))
2988                                (if (eq coding body)
2989                                    (setq eheader (mm-encode-coding-string
2990                                                   (buffer-string) coding)
2991                                          title (when title
2992                                                  (mm-encode-coding-string
2993                                                   title coding))
2994                                          body content)
2995                                  (setq charset 'utf-8
2996                                        eheader (mm-encode-coding-string
2997                                                 (buffer-string) charset)
2998                                        title (when title
2999                                                (mm-encode-coding-string
3000                                                 title charset))
3001                                        body (mm-encode-coding-string
3002                                              (mm-decode-coding-string
3003                                               content body)
3004                                              charset)
3005                                        force-charset t)))
3006                            (setq charset hcharset
3007                                  eheader (mm-encode-coding-string
3008                                           (buffer-string) coding)
3009                                  title (when title
3010                                          (mm-encode-coding-string
3011                                           title coding))
3012                                  body content))
3013                        (setq eheader (mm-string-as-unibyte (buffer-string))
3014                              body content)))
3015                    (erase-buffer)
3016                    (mm-disable-multibyte)
3017                    (insert body)
3018                    (when charset
3019                      (mm-add-meta-html-tag handle charset force-charset))
3020                    (when title
3021                      (goto-char (point-min))
3022                      (unless (search-forward "<title>" nil t)
3023                        (re-search-forward "<head>\\s-*" nil t)
3024                        (insert "<title>" title "</title>\n")))
3025                    (goto-char (point-min))
3026                    (or (re-search-forward
3027                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
3028                        (re-search-forward
3029                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
3030                    (insert eheader)
3031                    (mm-write-region (point-min) (point-max)
3032                                     tmp-file nil nil nil 'binary t))))
3033               (charset
3034                (mm-with-unibyte-buffer
3035                  (insert (if (eq charset 'gnus-decoded)
3036                              (mm-encode-coding-string content
3037                                                       (setq charset 'utf-8))
3038                            content))
3039                  (if (or (mm-add-meta-html-tag handle charset)
3040                          (not file))
3041                      (mm-write-region (point-min) (point-max)
3042                                       tmp-file nil nil nil 'binary t)
3043                    (setq tmp-file nil))))
3044               (tmp-file
3045                (mm-save-part-to-file handle tmp-file)))
3046              (when tmp-file
3047                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
3048              (add-hook 'gnus-summary-prepare-exit-hook
3049                        'gnus-article-browse-delete-temp-files)
3050              (add-hook 'gnus-exit-gnus-hook
3051                        (lambda  ()
3052                          (gnus-article-browse-delete-temp-files t)))
3053              ;; FIXME: Warn if there's an <img> tag?
3054              (browse-url-of-file (or tmp-file (expand-file-name file)))
3055              (setq showed t))
3056             ;; If multipart, recurse
3057             ((equal (mm-handle-media-supertype handle) "multipart")
3058              (when (gnus-article-browse-html-parts handle header)
3059                (setq showed t)))
3060             ((equal (mm-handle-media-type handle) "message/rfc822")
3061              (mm-with-multibyte-buffer
3062                (mm-insert-part handle)
3063                (setq handle (mm-dissect-buffer t t))
3064                (when (and (bufferp (car handle))
3065                           (stringp (car (mm-handle-type handle))))
3066                  (setq handle (list handle)))
3067                (when header
3068                  (article-decode-encoded-words)
3069                  (let ((gnus-visible-headers
3070                         (or (get 'gnus-visible-headers 'standard-value)
3071                             gnus-visible-headers)))
3072                    (article-hide-headers))
3073                  (goto-char (point-min))
3074                  (search-forward "\n\n" nil 'move)
3075                  (skip-chars-backward "\t\n ")
3076                  (setq header (buffer-substring (point-min) (point)))))
3077              (when (prog1
3078                        (gnus-article-browse-html-parts handle header)
3079                      (mm-destroy-parts handle))
3080                (setq showed t)))))
3081     showed))
3082
3083 (defun gnus-article-browse-html-article (&optional arg)
3084   "View \"text/html\" parts of the current article with a WWW browser.
3085 Inline images embedded in a message using the cid scheme, as they are
3086 generally considered to be safe, will be processed properly.
3087 The message header is added to the beginning of every html part unless
3088 the prefix argument ARG is given.
3089
3090 Warning: Spammers use links to images (using the http scheme) in HTML
3091 articles to verify whether you have read the message.  As
3092 `gnus-article-browse-html-article' passes the HTML content to the
3093 browser without eliminating these \"web bugs\" you should only
3094 use it for mails from trusted senders.
3095
3096 If you always want to display HTML parts in the browser, set
3097 `mm-text-html-renderer' to nil.
3098
3099 This command creates temporary files to pass HTML contents including
3100 images if any to the browser, and deletes them when exiting the group
3101 \(if you want)."
3102   ;; Cf. `mm-w3m-safe-url-regexp'
3103   (interactive "P")
3104   (if arg
3105       (gnus-summary-show-article)
3106     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3107                                     gnus-visible-headers))
3108           ;; As we insert a <hr>, there's no need for the body boundary.
3109           (gnus-treat-body-boundary nil))
3110       (gnus-summary-show-article)))
3111   (with-current-buffer gnus-article-buffer
3112     (let ((header (unless arg
3113                     (save-restriction
3114                       (widen)
3115                       (buffer-substring-no-properties
3116                        (goto-char (point-min))
3117                        (if (search-forward "\n\n" nil t)
3118                            (match-beginning 0)
3119                          (goto-char (point-max))
3120                          (skip-chars-backward "\t\n ")
3121                          (point))))))
3122           parts)
3123       (set-buffer gnus-original-article-buffer)
3124       (setq parts (mm-dissect-buffer t t))
3125       ;; If singlepart, enforce a list.
3126       (when (and (bufferp (car parts))
3127                  (stringp (car (mm-handle-type parts))))
3128         (setq parts (list parts)))
3129       ;; Process the list
3130       (unless (gnus-article-browse-html-parts parts header)
3131         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3132       (mm-destroy-parts parts)
3133       (unless arg
3134         (gnus-summary-show-article)))))
3135
3136 (defun article-hide-list-identifiers ()
3137   "Remove list identifies from the Subject header.
3138 The `gnus-list-identifiers' variable specifies what to do."
3139   (interactive)
3140   (let ((inhibit-point-motion-hooks t)
3141         (regexp (if (consp gnus-list-identifiers)
3142                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3143                   gnus-list-identifiers))
3144         (inhibit-read-only t))
3145     (when regexp
3146       (save-excursion
3147         (save-restriction
3148           (article-narrow-to-head)
3149           (goto-char (point-min))
3150           (while (re-search-forward
3151                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3152                   nil t)
3153             (delete-region (match-beginning 2) (match-end 0))
3154             (beginning-of-line))
3155           (when (re-search-forward
3156                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3157             (delete-region (match-beginning 1) (match-end 1))))))))
3158
3159 (defun article-hide-pem (&optional arg)
3160   "Toggle hiding of any PEM headers and signatures in the current article.
3161 If given a negative prefix, always show; if given a positive prefix,
3162 always hide."
3163   (interactive (gnus-article-hidden-arg))
3164   (unless (gnus-article-check-hidden-text 'pem arg)
3165     (save-excursion
3166       (let ((inhibit-read-only t) end)
3167         (goto-char (point-min))
3168         ;; Hide the horrendously ugly "header".
3169         (when (and (search-forward
3170                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3171                     nil t)
3172                    (setq end (1+ (match-beginning 0))))
3173           (gnus-add-wash-type 'pem)
3174           (gnus-article-hide-text-type
3175            end
3176            (if (search-forward "\n\n" nil t)
3177                (match-end 0)
3178              (point-max))
3179            'pem)
3180           ;; Hide the trailer as well
3181           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3182                                 nil t)
3183             (gnus-article-hide-text-type
3184              (match-beginning 0) (match-end 0) 'pem)))))))
3185
3186 (defun article-strip-banner ()
3187   "Strip the banners specified by the `banner' group parameter and by
3188 `gnus-article-address-banner-alist'."
3189   (interactive)
3190   (save-excursion
3191     (save-restriction
3192       (let ((inhibit-point-motion-hooks t))
3193         (when (gnus-parameter-banner gnus-newsgroup-name)
3194           (article-really-strip-banner
3195            (gnus-parameter-banner gnus-newsgroup-name)))
3196         (when gnus-article-address-banner-alist
3197           ;; Note that the From header is decoded here, so it is
3198           ;; required that the *-extract-address-components function
3199           ;; supports non-ASCII text.
3200           (let ((from (save-restriction
3201                         (widen)
3202                         (article-narrow-to-head)
3203                         (mail-fetch-field "from"))))
3204             (when (and from
3205                        (setq from
3206                              (cadr (funcall gnus-extract-address-components
3207                                             from))))
3208               (catch 'found
3209                 (dolist (pair gnus-article-address-banner-alist)
3210                   (when (string-match (car pair) from)
3211                     (throw 'found
3212                            (article-really-strip-banner (cdr pair)))))))))))))
3213
3214 (defun article-really-strip-banner (banner)
3215   "Strip the banner specified by the argument."
3216   (save-excursion
3217     (save-restriction
3218       (let ((inhibit-point-motion-hooks t)
3219             (gnus-signature-limit nil)
3220             (inhibit-read-only t))
3221         (article-goto-body)
3222         (cond
3223          ((eq banner 'signature)
3224           (when (gnus-article-narrow-to-signature)
3225             (widen)
3226             (forward-line -1)
3227             (delete-region (point) (point-max))))
3228          ((symbolp banner)
3229           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3230               (while (re-search-forward banner nil t)
3231                 (delete-region (match-beginning 0) (match-end 0)))))
3232          ((stringp banner)
3233           (while (re-search-forward banner nil t)
3234             (delete-region (match-beginning 0) (match-end 0)))))))))
3235
3236 (defun article-babel ()
3237   "Translate article using an online translation service."
3238   (interactive)
3239   (require 'babel)
3240   (gnus-with-article-buffer
3241     (when (article-goto-body)
3242       (let* ((start (point))
3243              (end (point-max))
3244              (orig (buffer-substring start end))
3245              (trans (babel-as-string orig)))
3246         (save-restriction
3247           (narrow-to-region start end)
3248           (delete-region start end)
3249           (insert trans))))))
3250
3251 (defun article-hide-signature (&optional arg)
3252   "Hide the signature in the current article.
3253 If given a negative prefix, always show; if given a positive prefix,
3254 always hide."
3255   (interactive (gnus-article-hidden-arg))
3256   (unless (gnus-article-check-hidden-text 'signature arg)
3257     (save-excursion
3258       (save-restriction
3259         (let ((inhibit-read-only t))
3260           (when (gnus-article-narrow-to-signature)
3261             (gnus-article-hide-text-type
3262              (point-min) (point-max) 'signature))))))
3263   (gnus-set-mode-line 'article))
3264
3265 (defun article-strip-headers-in-body ()
3266   "Strip offensive headers from bodies."
3267   (interactive)
3268   (save-excursion
3269     (article-goto-body)
3270     (let ((case-fold-search t))
3271       (when (looking-at "x-no-archive:")
3272         (gnus-delete-line)))))
3273
3274 (defun article-strip-leading-blank-lines ()
3275   "Remove all blank lines from the beginning of the article."
3276   (interactive)
3277   (save-excursion
3278     (let ((inhibit-point-motion-hooks t)
3279           (inhibit-read-only t))
3280       (when (article-goto-body)
3281         (while (and (not (eobp))
3282                     (looking-at "[ \t]*$"))
3283           (gnus-delete-line))))))
3284
3285 (defun article-narrow-to-head ()
3286   "Narrow the buffer to the head of the message.
3287 Point is left at the beginning of the narrowed-to region."
3288   (narrow-to-region
3289    (goto-char (point-min))
3290    (if (search-forward "\n\n" nil 1)
3291        (1- (point))
3292      (point-max)))
3293   (goto-char (point-min)))
3294
3295 (defun article-goto-body ()
3296   "Place point at the start of the body."
3297   (goto-char (point-min))
3298   (cond
3299    ;; This variable is only bound when dealing with separate
3300    ;; MIME body parts.
3301    (article-goto-body-goes-to-point-min-p
3302     t)
3303    ((search-forward "\n\n" nil t)
3304     t)
3305    (t
3306     (goto-char (point-max))
3307     nil)))
3308
3309 (defun article-strip-multiple-blank-lines ()
3310   "Replace consecutive blank lines with one empty line."
3311   (interactive)
3312   (save-excursion
3313     (let ((inhibit-point-motion-hooks t)
3314           (inhibit-read-only t))
3315       ;; First make all blank lines empty.
3316       (article-goto-body)
3317       (while (re-search-forward "^[ \t]+$" nil t)
3318         (unless (gnus-annotation-in-region-p
3319                  (match-beginning 0) (match-end 0))
3320           (replace-match "" nil t)))
3321       ;; Then replace multiple empty lines with a single empty line.
3322       (article-goto-body)
3323       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3324         (unless (gnus-annotation-in-region-p
3325                  (match-beginning 0) (match-end 0))
3326           (delete-region (match-beginning 1) (match-end 1)))))))
3327
3328 (defun article-strip-leading-space ()
3329   "Remove all white space from the beginning of the lines in the article."
3330   (interactive)
3331   (save-excursion
3332     (let ((inhibit-point-motion-hooks t)
3333           (inhibit-read-only t))
3334       (article-goto-body)
3335       (while (re-search-forward "^[ \t]+" nil t)
3336         (replace-match "" t t)))))
3337
3338 (defun article-strip-trailing-space ()
3339   "Remove all white space from the end of the lines in the article."
3340   (interactive)
3341   (save-excursion
3342     (let ((inhibit-point-motion-hooks t)
3343           (inhibit-read-only t))
3344       (article-goto-body)
3345       (while (re-search-forward "[ \t]+$" nil t)
3346         (replace-match "" t t)))))
3347
3348 (defun article-strip-blank-lines ()
3349   "Strip leading, trailing and multiple blank lines."
3350   (interactive)
3351   (article-strip-leading-blank-lines)
3352   (article-remove-trailing-blank-lines)
3353   (article-strip-multiple-blank-lines))
3354
3355 (defun article-strip-all-blank-lines ()
3356   "Strip all blank lines."
3357   (interactive)
3358   (save-excursion
3359     (let ((inhibit-point-motion-hooks t)
3360           (inhibit-read-only t))
3361       (article-goto-body)
3362       (while (re-search-forward "^[ \t]*\n" nil t)
3363         (replace-match "" t t)))))
3364
3365 (defun gnus-article-narrow-to-signature ()
3366   "Narrow to the signature; return t if a signature is found, else nil."
3367   (let ((inhibit-point-motion-hooks t))
3368     (when (gnus-article-search-signature)
3369       (forward-line 1)
3370       ;; Check whether we have some limits to what we consider
3371       ;; to be a signature.
3372       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3373                       (list gnus-signature-limit)))
3374             limit limited)
3375         (while (setq limit (pop limits))
3376           (if (or (and (integerp limit)
3377                        (< (- (point-max) (point)) limit))
3378                   (and (floatp limit)
3379                        (< (count-lines (point) (point-max)) limit))
3380                   (and (functionp limit)
3381                        (funcall limit))
3382                   (and (stringp limit)
3383                        (not (re-search-forward limit nil t))))
3384               ()                        ; This limit did not succeed.
3385             (setq limited t
3386                   limits nil)))
3387         (unless limited
3388           (narrow-to-region (point) (point-max))
3389           t)))))
3390
3391 (defun gnus-article-search-signature ()
3392   "Search the current buffer for the signature separator.
3393 Put point at the beginning of the signature separator."
3394   (let ((cur (point)))
3395     (goto-char (point-max))
3396     (if (if (stringp gnus-signature-separator)
3397             (re-search-backward gnus-signature-separator nil t)
3398           (let ((seps gnus-signature-separator))
3399             (while (and seps
3400                         (not (re-search-backward (car seps) nil t)))
3401               (pop seps))
3402             seps))
3403         t
3404       (goto-char cur)
3405       nil)))
3406
3407 (defun gnus-article-hidden-arg ()
3408   "Return the current prefix arg as a number, or 0 if no prefix."
3409   (list (if current-prefix-arg
3410             (prefix-numeric-value current-prefix-arg)
3411           0)))
3412
3413 (defun gnus-article-check-hidden-text (type arg)
3414   "Return nil if hiding is necessary.
3415 Arg can be nil or a number.  nil and positive means hide, negative
3416 means show, 0 means toggle."
3417   (save-excursion
3418     (save-restriction
3419       (let ((hide (gnus-article-hidden-text-p type)))
3420         (cond
3421          ((or (null arg)
3422               (> arg 0))
3423           nil)
3424          ((< arg 0)
3425           (gnus-article-show-hidden-text type)
3426           t)
3427          (t
3428           (if (eq hide 'hidden)
3429               (progn
3430                 (gnus-article-show-hidden-text type)
3431                 t)
3432             nil)))))))
3433
3434 (defun gnus-article-hidden-text-p (type)
3435   "Say whether the current buffer contains hidden text of type TYPE."
3436   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3437     (while (and pos
3438                 (not (get-text-property pos 'invisible))
3439                 (not (get-text-property pos 'dummy-invisible)))
3440       (setq pos
3441             (text-property-any (1+ pos) (point-max) 'article-type type)))
3442     (if pos
3443         'hidden
3444       nil)))
3445
3446 (defun gnus-article-show-hidden-text (type &optional dummy)
3447   "Show all hidden text of type TYPE.
3448 Originally it is hide instead of DUMMY."
3449   (let ((inhibit-read-only t)
3450         (inhibit-point-motion-hooks t))
3451     (gnus-remove-text-properties-when
3452      'article-type type
3453      (point-min) (point-max)
3454      (cons 'article-type (cons type
3455                                gnus-hidden-properties)))
3456     (gnus-delete-wash-type type)))
3457
3458 (defconst article-time-units
3459   `((year . ,(* 365.25 24 60 60))
3460     (week . ,(* 7 24 60 60))
3461     (day . ,(* 24 60 60))
3462     (hour . ,(* 60 60))
3463     (minute . 60)
3464     (second . 1))
3465   "Mapping from time units to seconds.")
3466
3467 (defun gnus-article-forward-header ()
3468   "Move point to the start of the next header.
3469 If the current header is a continuation header, this can be several
3470 lines forward."
3471   (let ((ended nil))
3472     (while (not ended)
3473       (forward-line 1)
3474       (if (looking-at "[ \t]+[^ \t]")
3475           (forward-line 1)
3476         (setq ended t)))))
3477
3478 (defun article-date-ut (&optional type highlight)
3479   "Convert DATE date to universal time in the current article.
3480 If TYPE is `local', convert to local time; if it is `lapsed', output
3481 how much time has lapsed since DATE.  For `lapsed', the value of
3482 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3483 should replace the \"Date:\" one, or should be added below it."
3484   (interactive (list 'ut t))
3485   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3486          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3487                              tdate-regexp)
3488                             ((eq type 'lapsed)
3489                              "^X-Sent:[ \t]")
3490                             (article-lapsed-timer
3491                              "^Date:[ \t]")
3492                             (t
3493                              tdate-regexp)))
3494          (case-fold-search t)
3495          (inhibit-read-only t)
3496          (inhibit-point-motion-hooks t)
3497          pos date bface eface)
3498     (save-excursion
3499       (save-restriction
3500         (widen)
3501         (goto-char (point-min))
3502         (while (or (setq date (get-text-property (setq pos (point))
3503                                                  'original-date))
3504                    (when (setq pos (next-single-property-change
3505                                     (point) 'original-date))
3506                      (setq date (get-text-property pos 'original-date))
3507                      t))
3508           (narrow-to-region
3509            pos (if (setq pos (text-property-any pos (point-max)
3510                                                 'original-date nil))
3511                    (progn
3512                      (goto-char pos)
3513                      (if (or (bolp) (eobp))
3514                          (point)
3515                        (1+ (point))))
3516                  (point-max)))
3517           (goto-char (point-min))
3518           (when (re-search-forward tdate-regexp nil t)
3519             (setq bface (get-text-property (point-at-bol) 'face)
3520                   eface (get-text-property (1- (point-at-eol)) 'face)))
3521           (goto-char (point-min))
3522           (setq pos nil)
3523           ;; Delete any old Date headers.
3524           (while (re-search-forward date-regexp nil t)
3525             (if pos
3526                 (delete-region (point-at-bol) (progn
3527                                                 (gnus-article-forward-header)
3528                                                 (point)))
3529               (delete-region (point-at-bol) (progn
3530                                               (gnus-article-forward-header)
3531                                               (forward-char -1)
3532                                               (point)))
3533               (setq pos (point))))
3534           (when (and (not pos)
3535                      (re-search-forward tdate-regexp nil t))
3536             (forward-line 1))
3537           (gnus-goto-char pos)
3538           (insert (article-make-date-line date (or type 'ut)))
3539           (unless pos
3540             (insert "\n")
3541             (forward-line -1))
3542           ;; Do highlighting.
3543           (beginning-of-line)
3544           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3545             (put-text-property (match-beginning 1) (1+ (match-end 1))
3546                                'face bface)
3547             (put-text-property (match-beginning 2) (match-end 2)
3548                                'face eface))
3549           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3550           (goto-char (point-max))
3551           (widen))))))
3552
3553 (defun article-make-date-line (date type)
3554   "Return a DATE line of TYPE."
3555   (unless (memq type '(local ut original user iso8601 lapsed english))
3556     (error "Unknown conversion type: %s" type))
3557   (condition-case ()
3558       (let ((time (date-to-time date)))
3559         (cond
3560          ;; Convert to the local timezone.
3561          ((eq type 'local)
3562           (concat "Date: " (message-make-date time)))
3563          ;; Convert to Universal Time.
3564          ((eq type 'ut)
3565           (concat "Date: "
3566                   (substring
3567                    (message-make-date
3568                     (let* ((e (parse-time-string date))
3569                            (tm (apply 'encode-time e))
3570                            (ms (car tm))
3571                            (ls (- (cadr tm) (car (current-time-zone time)))))
3572                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3573                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3574                             (t (list ms ls)))))
3575                    0 -5)
3576                   "UT"))
3577          ;; Get the original date from the article.
3578          ((eq type 'original)
3579           (concat "Date: " (if (string-match "\n+$" date)
3580                                (substring date 0 (match-beginning 0))
3581                              date)))
3582          ;; Let the user define the format.
3583          ((eq type 'user)
3584           (let ((format (or (condition-case nil
3585                                 (with-current-buffer gnus-summary-buffer
3586                                   gnus-article-time-format)
3587                               (error nil))
3588                             gnus-article-time-format)))
3589             (if (functionp format)
3590                 (funcall format time)
3591               (concat "Date: " (format-time-string format time)))))
3592          ;; ISO 8601.
3593          ((eq type 'iso8601)
3594           (let ((tz (car (current-time-zone time))))
3595             (concat
3596              "Date: "
3597              (format-time-string "%Y%m%dT%H%M%S" time)
3598              (format "%s%02d%02d"
3599                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3600                      (/ (% (abs tz) 3600) 60)))))
3601          ;; Do an X-Sent lapsed format.
3602          ((eq type 'lapsed)
3603           ;; If the date is seriously mangled, the timezone functions are
3604           ;; liable to bug out, so we ignore all errors.
3605           (let* ((now (current-time))
3606                  (real-time (subtract-time now time))
3607                  (real-sec (and real-time
3608                                 (+ (* (float (car real-time)) 65536)
3609                                    (cadr real-time))))
3610                  (sec (and real-time (abs real-sec)))
3611                  num prev)
3612             (cond
3613              ((null real-time)
3614               "X-Sent: Unknown")
3615              ((zerop sec)
3616               "X-Sent: Now")
3617              (t
3618               (concat
3619                "X-Sent: "
3620                ;; This is a bit convoluted, but basically we go
3621                ;; through the time units for years, weeks, etc,
3622                ;; and divide things to see whether that results
3623                ;; in positive answers.
3624                (mapconcat
3625                 (lambda (unit)
3626                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3627                       ;; The (remaining) seconds are too few to
3628                       ;; be divided into this time unit.
3629                       ""
3630                     ;; It's big enough, so we output it.
3631                     (setq sec (- sec (* num (cdr unit))))
3632                     (prog1
3633                         (concat (if prev ", " "") (int-to-string
3634                                                    (floor num))
3635                                 " " (symbol-name (car unit))
3636                                 (if (> num 1) "s" ""))
3637                       (setq prev t))))
3638                 article-time-units "")
3639                ;; If dates are odd, then it might appear like the
3640                ;; article was sent in the future.
3641                (if (> real-sec 0)
3642                    " ago"
3643                  " in the future"))))))
3644          ;; Display the date in proper English
3645          ((eq type 'english)
3646           (let ((dtime (decode-time time)))
3647             (concat
3648              "Date: the "
3649              (number-to-string (nth 3 dtime))
3650              (let ((digit (% (nth 3 dtime) 10)))
3651                (cond
3652                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3653                 ((= digit 1) "st")
3654                 ((= digit 2) "nd")
3655                 ((= digit 3) "rd")
3656                 (t "th")))
3657              " of "
3658              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3659              " "
3660              (number-to-string (nth 5 dtime))
3661              " at "
3662              (format "%02d" (nth 2 dtime))
3663              ":"
3664              (format "%02d" (nth 1 dtime)))))))
3665     (error
3666      (format "Date: %s (from Gnus)" date))))
3667
3668 (defun article-date-local (&optional highlight)
3669   "Convert the current article date to the local timezone."
3670   (interactive (list t))
3671   (article-date-ut 'local highlight))
3672
3673 (defun article-date-english (&optional highlight)
3674   "Convert the current article date to something that is proper English."
3675   (interactive (list t))
3676   (article-date-ut 'english highlight))
3677
3678 (defun article-date-original (&optional highlight)
3679   "Convert the current article date to what it was originally.
3680 This is only useful if you have used some other date conversion
3681 function and want to see what the date was before converting."
3682   (interactive (list t))
3683   (article-date-ut 'original highlight))
3684
3685 (defun article-date-lapsed (&optional highlight)
3686   "Convert the current article date to time lapsed since it was sent."
3687   (interactive (list t))
3688   (article-date-ut 'lapsed highlight))
3689
3690 (defun article-update-date-lapsed ()
3691   "Function to be run from a timer to update the lapsed time line."
3692   (save-match-data
3693     (let (deactivate-mark)
3694       (save-excursion
3695         (ignore-errors
3696          (walk-windows
3697           (lambda (w)
3698             (set-buffer (window-buffer w))
3699             (when (eq major-mode 'gnus-article-mode)
3700               (let ((mark (point-marker)))
3701                 (goto-char (point-min))
3702                 (when (re-search-forward "^X-Sent:" nil t)
3703                   (article-date-lapsed t))
3704                 (goto-char (marker-position mark))
3705                 (move-marker mark nil))))
3706           nil 'visible))))))
3707
3708 (defun gnus-start-date-timer (&optional n)
3709   "Start a timer to update the X-Sent header in the article buffers.
3710 The numerical prefix says how frequently (in seconds) the function
3711 is to run."
3712   (interactive "p")
3713   (unless n
3714     (setq n 1))
3715   (gnus-stop-date-timer)
3716   (setq article-lapsed-timer
3717         (run-at-time 1 n 'article-update-date-lapsed)))
3718
3719 (defun gnus-stop-date-timer ()
3720   "Stop the X-Sent timer."
3721   (interactive)
3722   (when article-lapsed-timer
3723     (nnheader-cancel-timer article-lapsed-timer)
3724     (setq article-lapsed-timer nil)))
3725
3726 (defun article-date-user (&optional highlight)
3727   "Convert the current article date to the user-defined format.
3728 This format is defined by the `gnus-article-time-format' variable."
3729   (interactive (list t))
3730   (article-date-ut 'user highlight))
3731
3732 (defun article-date-iso8601 (&optional highlight)
3733   "Convert the current article date to ISO8601."
3734   (interactive (list t))
3735   (article-date-ut 'iso8601 highlight))
3736
3737 (defmacro gnus-article-save-original-date (&rest forms)
3738   "Save the original date as a text property and evaluate FORMS."
3739   `(let* ((case-fold-search t)
3740           (start (progn
3741                    (goto-char (point-min))
3742                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3743                               (not (bolp)))
3744                      (match-end 0))))
3745           (date (when (and start
3746                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3747                                               nil t))
3748                   (buffer-substring-no-properties start
3749                                                   (match-beginning 0)))))
3750      (goto-char (point-max))
3751      (skip-chars-backward "\n")
3752      (put-text-property (point-min) (point) 'original-date date)
3753      ,@forms
3754      (goto-char (point-max))
3755      (skip-chars-backward "\n")
3756      (put-text-property (point-min) (point) 'original-date date)))
3757
3758 ;; (defun article-show-all ()
3759 ;;   "Show all hidden text in the article buffer."
3760 ;;   (interactive)
3761 ;;   (save-excursion
3762 ;;     (let ((inhibit-read-only t))
3763 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3764
3765 (defun article-remove-leading-whitespace ()
3766   "Remove excessive whitespace from all headers."
3767   (interactive)
3768   (save-excursion
3769     (save-restriction
3770       (let ((inhibit-read-only t))
3771         (article-narrow-to-head)
3772         (goto-char (point-min))
3773         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3774           (delete-region (match-beginning 1) (match-end 1)))))))
3775
3776 (defun article-emphasize (&optional arg)
3777   "Emphasize text according to `gnus-emphasis-alist'."
3778   (interactive (gnus-article-hidden-arg))
3779   (unless (gnus-article-check-hidden-text 'emphasis arg)
3780     (save-excursion
3781       (let ((alist (or
3782                     (condition-case nil
3783                         (with-current-buffer gnus-summary-buffer
3784                           gnus-article-emphasis-alist)
3785                       (error))
3786                     gnus-emphasis-alist))
3787             (inhibit-read-only t)
3788             (props (append '(article-type emphasis)
3789                            gnus-hidden-properties))
3790             regexp elem beg invisible visible face)
3791         (article-goto-body)
3792         (setq beg (point))
3793         (while (setq elem (pop alist))
3794           (goto-char beg)
3795           (setq regexp (car elem)
3796                 invisible (nth 1 elem)
3797                 visible (nth 2 elem)
3798                 face (nth 3 elem))
3799           (while (re-search-forward regexp nil t)
3800             (when (and (match-beginning visible) (match-beginning invisible))
3801               (gnus-article-hide-text
3802                (match-beginning invisible) (match-end invisible) props)
3803               (gnus-article-unhide-text-type
3804                (match-beginning visible) (match-end visible) 'emphasis)
3805               (gnus-put-overlay-excluding-newlines
3806                (match-beginning visible) (match-end visible) 'face face)
3807               (gnus-add-wash-type 'emphasis)
3808               (goto-char (match-end invisible)))))))))
3809
3810 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3811   "Setup newsgroup emphasis alist."
3812   (unless gnus-article-emphasis-alist
3813     (let ((name (and gnus-newsgroup-name
3814                      (gnus-group-real-name gnus-newsgroup-name))))
3815       (make-local-variable 'gnus-article-emphasis-alist)
3816       (setq gnus-article-emphasis-alist
3817             (nconc
3818              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3819                (while (setq elem (pop alist))
3820                  (when (and name (string-match (car elem) name))
3821                    (setq alist nil
3822                          highlight (copy-sequence (cdr elem)))))
3823                highlight)
3824              (copy-sequence highlight-words)
3825              (if gnus-newsgroup-name
3826                  (copy-sequence (gnus-group-find-parameter
3827                                  gnus-newsgroup-name 'highlight-words t)))
3828              gnus-emphasis-alist)))))
3829
3830 (defvar gnus-summary-article-menu)
3831 (defvar gnus-summary-post-menu)
3832
3833 ;;; Saving functions.
3834
3835 (defun gnus-article-save (save-buffer file &optional num)
3836   "Save the currently selected article."
3837   (when (or (get gnus-default-article-saver :headers)
3838             (not gnus-save-all-headers))
3839     ;; Remove headers according to `gnus-saved-headers' or the value
3840     ;; of the `:headers' property that the saver function might have.
3841     (let ((gnus-visible-headers
3842            (or (symbol-value (get gnus-default-article-saver :headers))
3843                gnus-saved-headers gnus-visible-headers))
3844           ;; Ignore group parameter.  See `article-hide-headers'.
3845           (gnus-summary-buffer nil))
3846       (with-current-buffer save-buffer
3847         (article-hide-headers 1 t))))
3848   (save-window-excursion
3849     (if (not gnus-default-article-saver)
3850         (error "No default saver is defined")
3851       ;; !!! Magic!  The saving functions all save
3852       ;; `gnus-save-article-buffer' (or so they think), but we
3853       ;; bind that variable to our save-buffer.
3854       (set-buffer gnus-article-buffer)
3855       (let* ((gnus-save-article-buffer save-buffer)
3856              (filename
3857               (cond
3858                ((not gnus-prompt-before-saving) 'default)
3859                ((eq gnus-prompt-before-saving 'always) nil)
3860                (t file)))
3861              (gnus-number-of-articles-to-be-saved
3862               (when (eq gnus-prompt-before-saving t)
3863                 num)))                  ; Magic
3864         (set-buffer gnus-article-current-summary)
3865         (funcall gnus-default-article-saver filename)))))
3866
3867 (defun gnus-read-save-file-name (prompt &optional filename
3868                                         function group headers variable
3869                                         dir-var)
3870   (let ((default-name
3871           (funcall function group headers (symbol-value variable)))
3872         result)
3873     (setq result
3874           (expand-file-name
3875            (cond
3876             ((eq filename 'default)
3877              default-name)
3878             ((eq filename t)
3879              default-name)
3880             (filename filename)
3881             (t
3882              (when (symbol-value dir-var)
3883                (setq default-name (expand-file-name
3884                                    (file-name-nondirectory default-name)
3885                                    (symbol-value dir-var))))
3886              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3887                     (prompt
3888                      (format prompt
3889                              (if (and gnus-number-of-articles-to-be-saved
3890                                       (> gnus-number-of-articles-to-be-saved 1))
3891                                  (format "these %d articles"
3892                                          gnus-number-of-articles-to-be-saved)
3893                                "this article")))
3894                     (file
3895                      ;; Let the split methods have their say.
3896                      (cond
3897                       ;; No split name was found.
3898                       ((null split-name)
3899                        (read-file-name
3900                         (concat prompt " (default "
3901                                 (file-name-nondirectory default-name) "): ")
3902                         (file-name-directory default-name)
3903                         default-name))
3904                       ;; A single group name is returned.
3905                       ((stringp split-name)
3906                        (setq default-name
3907                              (funcall function split-name headers
3908                                       (symbol-value variable)))
3909                        (read-file-name
3910                         (concat prompt " (default "
3911                                 (file-name-nondirectory default-name) "): ")
3912                         (file-name-directory default-name)
3913                         default-name))
3914                       ;; A single split name was found
3915                       ((= 1 (length split-name))
3916                        (let* ((name (expand-file-name
3917                                      (car split-name)
3918                                      gnus-article-save-directory))
3919                               (dir (cond ((file-directory-p name)
3920                                           (file-name-as-directory name))
3921                                          ((file-exists-p name) name)
3922                                          (t gnus-article-save-directory))))
3923                          (read-file-name
3924                           (concat prompt " (default " name "): ")
3925                           dir name)))
3926                       ;; A list of splits was found.
3927                       (t
3928                        (setq split-name (nreverse split-name))
3929                        (let (result)
3930                          (let ((file-name-history
3931                                 (nconc split-name file-name-history)))
3932                            (setq result
3933                                  (expand-file-name
3934                                   (read-file-name
3935                                    (concat prompt " (`M-p' for defaults): ")
3936                                    gnus-article-save-directory
3937                                    (car split-name))
3938                                   gnus-article-save-directory)))
3939                          (car (push result file-name-history)))))))
3940                ;; Create the directory.
3941                (gnus-make-directory (file-name-directory file))
3942                ;; If we have read a directory, we append the default file name.
3943                (when (file-directory-p file)
3944                  (setq file (expand-file-name (file-name-nondirectory
3945                                                default-name)
3946                                               (file-name-as-directory file))))
3947                ;; Possibly translate some characters.
3948                (nnheader-translate-file-chars file))))))
3949     (gnus-make-directory (file-name-directory result))
3950     (when variable
3951       (set variable result))
3952     (when dir-var
3953       (set dir-var (file-name-directory result)))
3954     result))
3955
3956 (defun gnus-article-archive-name (group)
3957   "Return the first instance of an \"Archive-name\" in the current buffer."
3958   (let ((case-fold-search t))
3959     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3960       (nnheader-concat gnus-article-save-directory
3961                        (match-string 1)))))
3962
3963 (defun gnus-article-nndoc-name (group)
3964   "If GROUP is an nndoc group, return the name of the parent group."
3965   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3966     (gnus-group-get-parameter group 'save-article-group)))
3967
3968 (defun gnus-summary-save-in-rmail (&optional filename)
3969   "Append this article to Rmail file.
3970 Optional argument FILENAME specifies file name.
3971 Directory to save to is default to `gnus-article-save-directory'."
3972   (setq filename (gnus-read-save-file-name
3973                   "Save %s in rmail file" filename
3974                   gnus-rmail-save-name gnus-newsgroup-name
3975                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3976   (with-current-buffer gnus-save-article-buffer
3977     (save-excursion
3978       (save-restriction
3979         (widen)
3980         ;; Note that unlike gnus-summary-save-in-mail, there is no
3981         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3982         ;; not use Babyl.
3983         (gnus-output-to-rmail filename))))
3984   filename)
3985
3986 (defun gnus-summary-save-in-mail (&optional filename)
3987   "Append this article to Unix mail file.
3988 Optional argument FILENAME specifies file name.
3989 Directory to save to is default to `gnus-article-save-directory'."
3990   (setq filename (gnus-read-save-file-name
3991                   "Save %s in Unix mail file" filename
3992                   gnus-mail-save-name gnus-newsgroup-name
3993                   gnus-current-headers 'gnus-newsgroup-last-mail))
3994   (with-current-buffer gnus-save-article-buffer
3995     (save-excursion
3996       (save-restriction
3997         (widen)
3998         (if (and (file-readable-p filename)
3999                  (file-regular-p filename)
4000                  (mail-file-babyl-p filename))
4001             (gnus-output-to-rmail filename)
4002           (gnus-output-to-mail filename)))))
4003   filename)
4004
4005 (put 'gnus-summary-save-in-file :decode t)
4006 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
4007 (defun gnus-summary-save-in-file (&optional filename overwrite)
4008   "Append this article to file.
4009 Optional argument FILENAME specifies file name.
4010 Directory to save to is default to `gnus-article-save-directory'."
4011   (setq filename (gnus-read-save-file-name
4012                   "Save %s in file" filename
4013                   gnus-file-save-name gnus-newsgroup-name
4014                   gnus-current-headers 'gnus-newsgroup-last-file))
4015   (with-current-buffer gnus-save-article-buffer
4016     (save-excursion
4017       (save-restriction
4018         (widen)
4019         (when (and overwrite
4020                    (file-exists-p filename))
4021           (delete-file filename))
4022         (gnus-output-to-file filename))))
4023   filename)
4024
4025 (put 'gnus-summary-write-to-file :decode t)
4026 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
4027 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
4028 (defun gnus-summary-write-to-file (&optional filename)
4029   "Write this article to a file, overwriting it if the file exists.
4030 Optional argument FILENAME specifies file name.
4031 The directory to save in defaults to `gnus-article-save-directory'."
4032   (setq filename (gnus-read-save-file-name
4033                   "Save %s in file" filename
4034                   gnus-file-save-name gnus-newsgroup-name
4035                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4036   (gnus-summary-save-in-file filename t))
4037
4038 (put 'gnus-summary-save-body-in-file :decode t)
4039 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
4040   "Append this article body to a file.
4041 Optional argument FILENAME specifies file name.
4042 The directory to save in defaults to `gnus-article-save-directory'."
4043   (setq filename (gnus-read-save-file-name
4044                   "Save %s body in file" filename
4045                   gnus-file-save-name gnus-newsgroup-name
4046                   gnus-current-headers 'gnus-newsgroup-last-file))
4047   (with-current-buffer gnus-save-article-buffer
4048     (save-excursion
4049       (save-restriction
4050         (widen)
4051         (when (article-goto-body)
4052           (narrow-to-region (point) (point-max)))
4053         (when (and overwrite
4054                    (file-exists-p filename))
4055           (delete-file filename))
4056         (gnus-output-to-file filename))))
4057   filename)
4058
4059 (put 'gnus-summary-write-body-to-file :decode t)
4060 (put 'gnus-summary-write-body-to-file
4061      :function 'gnus-summary-save-body-in-file)
4062 (defun gnus-summary-write-body-to-file (&optional filename)
4063   "Write this article body to a file, overwriting it if the file exists.
4064 Optional argument FILENAME specifies file name.
4065 The directory to save in defaults to `gnus-article-save-directory'."
4066   (setq filename (gnus-read-save-file-name
4067                   "Save %s body in file" filename
4068                   gnus-file-save-name gnus-newsgroup-name
4069                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4070   (gnus-summary-save-body-in-file filename t))
4071
4072 (put 'gnus-summary-save-in-pipe :decode t)
4073 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
4074 (defun gnus-summary-save-in-pipe (&optional command raw)
4075   "Pipe this article to subprocess COMMAND.
4076 Valid values for COMMAND include:
4077   a string
4078     The executable command name and possibly arguments.
4079   nil
4080     You will be prompted for the command in the minibuffer.
4081   the symbol `default'
4082     It will be replaced with the command which the variable
4083     `gnus-summary-pipe-output-default-command' holds or the command
4084     last used for saving.
4085 Non-nil value for RAW overrides `:decode' and `:headers' properties
4086 and the raw article including all headers will be piped."
4087   (let ((article (gnus-summary-article-number))
4088         (decode (unless raw
4089                   (get 'gnus-summary-save-in-pipe :decode)))
4090         save-buffer default)
4091     (if article
4092         (if (vectorp (gnus-summary-article-header article))
4093             (save-current-buffer
4094               (gnus-summary-select-article decode decode nil article)
4095               (insert-buffer-substring
4096                (prog1
4097                    (if decode
4098                        gnus-article-buffer
4099                      gnus-original-article-buffer)
4100                  (setq save-buffer
4101                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4102               ;; Remove unwanted headers.
4103               (when (and (not raw)
4104                          (or (get 'gnus-summary-save-in-pipe :headers)
4105                              (not gnus-save-all-headers)))
4106                 (let ((gnus-visible-headers
4107                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4108                                               :headers))
4109                            gnus-saved-headers gnus-visible-headers))
4110                       (gnus-summary-buffer nil))
4111                   (article-hide-headers 1 t))))
4112           (error "%d is not a real article" article))
4113       (error "No article to pipe"))
4114     (setq default (or gnus-summary-pipe-output-default-command
4115                       gnus-last-shell-command))
4116     (unless (stringp command)
4117       (setq command
4118             (if (and (eq command 'default) default)
4119                 default
4120               (gnus-read-shell-command "Shell command on this article: "
4121                                        default))))
4122     (when (string-equal command "")
4123       (if default
4124           (setq command default)
4125         (error "A command is required")))
4126     (with-current-buffer save-buffer
4127       (save-restriction
4128         (widen)
4129         (shell-command-on-region (point-min) (point-max) command nil)))
4130     (gnus-kill-buffer save-buffer))
4131   (setq gnus-summary-pipe-output-default-command command))
4132
4133 (defun gnus-summary-pipe-to-muttprint (&optional command)
4134   "Pipe this article to muttprint."
4135   (unless (stringp command)
4136     (setq command (read-string
4137                    "Print using command: " gnus-summary-muttprint-program
4138                    nil gnus-summary-muttprint-program)))
4139   (let ((gnus-summary-pipe-output-default-command
4140          gnus-summary-pipe-output-default-command))
4141     (gnus-summary-save-in-pipe command))
4142   (setq gnus-summary-muttprint-program command))
4143
4144 ;;; Article file names when saving.
4145
4146 (defun gnus-capitalize-newsgroup (newsgroup)
4147   "Capitalize NEWSGROUP name."
4148   (when (not (zerop (length newsgroup)))
4149     (concat (char-to-string (upcase (aref newsgroup 0)))
4150             (substring newsgroup 1))))
4151
4152 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4153   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4154 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4155 Otherwise, it is like ~/News/news/group/num."
4156   (let ((default
4157           (expand-file-name
4158            (concat (if (gnus-use-long-file-name 'not-save)
4159                        (gnus-capitalize-newsgroup newsgroup)
4160                      (gnus-newsgroup-directory-form newsgroup))
4161                    "/" (int-to-string (mail-header-number headers)))
4162            gnus-article-save-directory)))
4163     (if (and last-file
4164              (string-equal (file-name-directory default)
4165                            (file-name-directory last-file))
4166              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4167         default
4168       (or last-file default))))
4169
4170 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4171   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4172 If variable `gnus-use-long-file-name' is non-nil, it is
4173 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4174   (let ((default
4175           (expand-file-name
4176            (concat (if (gnus-use-long-file-name 'not-save)
4177                        newsgroup
4178                      (gnus-newsgroup-directory-form newsgroup))
4179                    "/" (int-to-string (mail-header-number headers)))
4180            gnus-article-save-directory)))
4181     (if (and last-file
4182              (string-equal (file-name-directory default)
4183                            (file-name-directory last-file))
4184              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4185         default
4186       (or last-file default))))
4187
4188 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4189   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4190 If variable `gnus-use-long-file-name' is non-nil, it is
4191 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4192   (or last-file
4193       (expand-file-name
4194        (if (gnus-use-long-file-name 'not-save)
4195            newsgroup
4196          (file-relative-name
4197           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4198           default-directory))
4199        gnus-article-save-directory)))
4200
4201 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4202   "Generate file name from sender."
4203   (let ((from (mail-header-from headers)))
4204     (expand-file-name
4205      (if (and from (string-match "\\([^ <]+\\)@" from))
4206          (match-string 1 from)
4207        "nobody")
4208      gnus-article-save-directory)))
4209
4210 (defun article-verify-x-pgp-sig ()
4211   "Verify X-PGP-Sig."
4212   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4213   (interactive)
4214   (if (gnus-buffer-live-p gnus-original-article-buffer)
4215       (let ((sig (with-current-buffer gnus-original-article-buffer
4216                    (gnus-fetch-field "X-PGP-Sig")))
4217             items info headers)
4218         (when (and sig
4219                    mml2015-use
4220                    (mml2015-clear-verify-function))
4221           (with-temp-buffer
4222             (insert-buffer-substring gnus-original-article-buffer)
4223             (setq items (split-string sig))
4224             (message-narrow-to-head)
4225             (let ((inhibit-point-motion-hooks t)
4226                   (case-fold-search t))
4227               ;; Don't verify multiple headers.
4228               (setq headers (mapconcat (lambda (header)
4229                                          (concat header ": "
4230                                                  (mail-fetch-field header)
4231                                                  "\n"))
4232                                        (split-string (nth 1 items) ",") "")))
4233             (delete-region (point-min) (point-max))
4234             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4235             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4236             (insert headers)
4237             (widen)
4238             (forward-line)
4239             (while (not (eobp))
4240               (if (looking-at "^-")
4241                   (insert "- "))
4242               (forward-line))
4243             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4244             (insert "Version: " (car items) "\n\n")
4245             (insert (mapconcat 'identity (cddr items) "\n"))
4246             (insert "\n-----END PGP SIGNATURE-----\n")
4247             (let ((mm-security-handle (list (format "multipart/signed"))))
4248               (mml2015-clean-buffer)
4249               (let ((coding-system-for-write (or gnus-newsgroup-charset
4250                                                  'iso-8859-1)))
4251                 (funcall (mml2015-clear-verify-function)))
4252               (setq info
4253                     (or (mm-handle-multipart-ctl-parameter
4254                          mm-security-handle 'gnus-details)
4255                         (mm-handle-multipart-ctl-parameter
4256                          mm-security-handle 'gnus-info)))))
4257           (when info
4258             (let ((inhibit-read-only t) bface eface)
4259               (save-restriction
4260                 (message-narrow-to-head)
4261                 (goto-char (point-max))
4262                 (forward-line -1)
4263                 (setq bface (get-text-property (point-at-bol) 'face)
4264                       eface (get-text-property (1- (point-at-eol)) 'face))
4265                 (message-remove-header "X-Gnus-PGP-Verify")
4266                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4267                     (forward-line)
4268                   (goto-char (point-max)))
4269                 (narrow-to-region (point) (point))
4270                 (insert "X-Gnus-PGP-Verify: " info "\n")
4271                 (goto-char (point-min))
4272                 (forward-line)
4273                 (while (not (eobp))
4274                   (if (not (looking-at "^[ \t]"))
4275                       (insert " "))
4276                   (forward-line))
4277                 ;; Do highlighting.
4278                 (goto-char (point-min))
4279                 (when (looking-at "\\([^:]+\\): *")
4280                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4281                                      'face bface)
4282                   (put-text-property (match-end 0) (point-max)
4283                                      'face eface)))))))))
4284
4285 (autoload 'canlock-verify "canlock" nil t) ;; for XEmacs.
4286
4287 (defun article-verify-cancel-lock ()
4288   "Verify Cancel-Lock header."
4289   (interactive)
4290   (if (gnus-buffer-live-p gnus-original-article-buffer)
4291       (canlock-verify gnus-original-article-buffer)))
4292
4293 (eval-and-compile
4294   (mapc
4295    (lambda (func)
4296      (let (afunc gfunc)
4297        (if (consp func)
4298            (setq afunc (car func)
4299                  gfunc (cdr func))
4300          (setq afunc func
4301                gfunc (intern (format "gnus-%s" func))))
4302        (defalias gfunc
4303          (when (fboundp afunc)
4304            `(lambda (&optional interactive &rest args)
4305               ,(documentation afunc t)
4306               (interactive (list t))
4307               (with-current-buffer gnus-article-buffer
4308                 (if interactive
4309                     (call-interactively ',afunc)
4310                   (apply ',afunc args))))))))
4311    '(article-hide-headers
4312      article-verify-x-pgp-sig
4313      article-verify-cancel-lock
4314      article-hide-boring-headers
4315      article-treat-overstrike
4316      article-treat-ansi-sequences
4317      article-fill-long-lines
4318      article-capitalize-sentences
4319      article-remove-cr
4320      article-remove-leading-whitespace
4321      article-display-x-face
4322      article-display-face
4323      article-de-quoted-unreadable
4324      article-de-base64-unreadable
4325      article-decode-HZ
4326      article-wash-html
4327      article-unsplit-urls
4328      article-hide-list-identifiers
4329      article-strip-banner
4330      article-babel
4331      article-hide-pem
4332      article-hide-signature
4333      article-strip-headers-in-body
4334      article-remove-trailing-blank-lines
4335      article-strip-leading-blank-lines
4336      article-strip-multiple-blank-lines
4337      article-strip-leading-space
4338      article-strip-trailing-space
4339      article-strip-blank-lines
4340      article-strip-all-blank-lines
4341      article-date-local
4342      article-date-english
4343      article-date-iso8601
4344      article-date-original
4345      article-date-ut
4346      article-decode-mime-words
4347      article-decode-charset
4348      article-decode-encoded-words
4349      article-date-user
4350      article-date-lapsed
4351      article-emphasize
4352      article-treat-dumbquotes
4353      article-normalize-headers
4354      ;;(article-show-all . gnus-article-show-all-headers)
4355      )))
4356 \f
4357 ;;;
4358 ;;; Gnus article mode
4359 ;;;
4360
4361 (put 'gnus-article-mode 'mode-class 'special)
4362
4363 (set-keymap-parent gnus-article-mode-map widget-keymap)
4364
4365 (gnus-define-keys gnus-article-mode-map
4366   " " gnus-article-goto-next-page
4367   "\177" gnus-article-goto-prev-page
4368   [delete] gnus-article-goto-prev-page
4369   [backspace] gnus-article-goto-prev-page
4370   "\C-c^" gnus-article-refer-article
4371   "h" gnus-article-show-summary
4372   "s" gnus-article-show-summary
4373   "\C-c\C-m" gnus-article-mail
4374   "?" gnus-article-describe-briefly
4375   "<" beginning-of-buffer
4376   ">" end-of-buffer
4377   "\C-c\C-i" gnus-info-find-node
4378   "\C-c\C-b" gnus-bug
4379   "R" gnus-article-reply-with-original
4380   "F" gnus-article-followup-with-original
4381   "\C-hk" gnus-article-describe-key
4382   "\C-hc" gnus-article-describe-key-briefly
4383   "\C-hb" gnus-article-describe-bindings
4384
4385   "e" gnus-article-read-summary-keys
4386   "\C-d" gnus-article-read-summary-keys
4387   "\M-*" gnus-article-read-summary-keys
4388   "\M-#" gnus-article-read-summary-keys
4389   "\M-^" gnus-article-read-summary-keys
4390   "\M-g" gnus-article-read-summary-keys)
4391
4392 (substitute-key-definition
4393  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4394
4395 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4396   "W" gnus-article-wide-reply-with-original)
4397 (if (featurep 'xemacs)
4398     (set-keymap-default-binding gnus-article-send-map
4399                                 'gnus-article-read-summary-send-keys)
4400   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4401
4402 (defun gnus-article-make-menu-bar ()
4403   (unless (boundp 'gnus-article-commands-menu)
4404     (gnus-summary-make-menu-bar))
4405   (gnus-turn-off-edit-menu 'article)
4406   (unless (boundp 'gnus-article-article-menu)
4407     (easy-menu-define
4408      gnus-article-article-menu gnus-article-mode-map ""
4409      '("Article"
4410        ["Scroll forwards" gnus-article-goto-next-page t]
4411        ["Scroll backwards" gnus-article-goto-prev-page t]
4412        ["Show summary" gnus-article-show-summary t]
4413        ["Fetch Message-ID at point" gnus-article-refer-article t]
4414        ["Mail to address at point" gnus-article-mail t]
4415        ["Send a bug report" gnus-bug t]))
4416
4417     (easy-menu-define
4418      gnus-article-treatment-menu gnus-article-mode-map ""
4419      ;; Fixme: this should use :active (and maybe :visible).
4420      '("Treatment"
4421        ["Hide headers" gnus-article-hide-headers t]
4422        ["Hide signature" gnus-article-hide-signature t]
4423        ["Hide citation" gnus-article-hide-citation t]
4424        ["Treat overstrike" gnus-article-treat-overstrike t]
4425        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4426        ["Remove carriage return" gnus-article-remove-cr t]
4427        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4428        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4429        ["Remove base64" gnus-article-de-base64-unreadable t]
4430        ["Treat html" gnus-article-wash-html t]
4431        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4432        ["Decode HZ" gnus-article-decode-HZ t]))
4433
4434     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4435
4436     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4437
4438     (gnus-run-hooks 'gnus-article-menu-hook)))
4439
4440 (defvar bookmark-make-record-function)
4441
4442 (defun gnus-article-mode ()
4443   "Major mode for displaying an article.
4444
4445 All normal editing commands are switched off.
4446
4447 The following commands are available in addition to all summary mode
4448 commands:
4449 \\<gnus-article-mode-map>
4450 \\[gnus-article-next-page]\t Scroll the article one page forwards
4451 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4452 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4453 \\[gnus-article-show-summary]\t Display the summary buffer
4454 \\[gnus-article-mail]\t Send a reply to the address near point
4455 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4456 \\[gnus-info-find-node]\t Go to the Gnus info node"
4457   (interactive)
4458   (kill-all-local-variables)
4459   (gnus-simplify-mode-line)
4460   (setq mode-name "Article")
4461   (setq major-mode 'gnus-article-mode)
4462   (make-local-variable 'minor-mode-alist)
4463   (use-local-map gnus-article-mode-map)
4464   (when (gnus-visual-p 'article-menu 'menu)
4465     (gnus-article-make-menu-bar)
4466     (when gnus-summary-tool-bar-map
4467       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4468   (gnus-update-format-specifications nil 'article-mode)
4469   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4470   (set (make-local-variable 'gnus-page-broken) nil)
4471   (make-local-variable 'gnus-button-marker-list)
4472   (make-local-variable 'gnus-article-current-summary)
4473   (make-local-variable 'gnus-article-mime-handles)
4474   (make-local-variable 'gnus-article-decoded-p)
4475   (make-local-variable 'gnus-article-mime-handle-alist)
4476   (make-local-variable 'gnus-article-wash-types)
4477   (make-local-variable 'gnus-article-image-alist)
4478   (make-local-variable 'gnus-article-charset)
4479   (make-local-variable 'gnus-article-ignored-charsets)
4480   (set (make-local-variable 'bookmark-make-record-function)
4481        'gnus-summary-bookmark-make-record)
4482   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4483   ;; face.
4484   (set (make-local-variable 'nobreak-char-display) nil)
4485   (setq cursor-in-non-selected-windows nil)
4486   (gnus-set-default-directory)
4487   (buffer-disable-undo)
4488   (setq buffer-read-only t
4489         show-trailing-whitespace nil)
4490   (set-syntax-table gnus-article-mode-syntax-table)
4491   (mm-enable-multibyte)
4492   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4493
4494 (defvar gnus-button-marker-list nil
4495   "Regexp matching any of the regexps from `gnus-button-alist'.
4496 Internal variable.")
4497
4498 (defun gnus-article-setup-buffer ()
4499   "Initialize the article buffer."
4500   (let* ((name (if gnus-single-article-buffer "*Article*"
4501                  (concat "*Article " gnus-newsgroup-name "*")))
4502          (original
4503           (progn (string-match "\\*Article" name)
4504                  (concat " *Original Article"
4505                          (substring name (match-end 0))))))
4506     (setq gnus-article-buffer name)
4507     (setq gnus-original-article-buffer original)
4508     (setq gnus-article-mime-handle-alist nil)
4509     (with-current-buffer gnus-summary-buffer
4510       ;; This might be a variable local to the summary buffer.
4511       (unless gnus-single-article-buffer
4512         (setq gnus-article-buffer name)
4513         (setq gnus-original-article-buffer original)
4514         (gnus-set-global-variables)))
4515     (gnus-article-setup-highlight-words)
4516     ;; Init original article buffer.
4517     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4518       (mm-enable-multibyte)
4519       (setq major-mode 'gnus-original-article-mode)
4520       (make-local-variable 'gnus-original-article))
4521     (if (and (get-buffer name)
4522              (with-current-buffer name
4523                (if gnus-article-edit-mode
4524                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4525                        (progn
4526                          (set-buffer-modified-p nil)
4527                          (gnus-kill-buffer name)
4528                          (message "")
4529                          nil)
4530                      (error "Action aborted"))
4531                  t)))
4532         (with-current-buffer name
4533           (set (make-local-variable 'gnus-article-edit-mode) nil)
4534           (when gnus-article-mime-handles
4535             (mm-destroy-parts gnus-article-mime-handles)
4536             (setq gnus-article-mime-handles nil))
4537           ;; Set it to nil in article-buffer!
4538           (setq gnus-article-mime-handle-alist nil)
4539           (buffer-disable-undo)
4540           (setq buffer-read-only t)
4541           ;; This list just keeps growing if we don't reset it.
4542           (setq gnus-button-marker-list nil)
4543           (unless (eq major-mode 'gnus-article-mode)
4544             (gnus-article-mode))
4545           (setq truncate-lines gnus-article-truncate-lines)
4546           (current-buffer))
4547       (with-current-buffer (gnus-get-buffer-create name)
4548         (gnus-article-mode)
4549         (setq truncate-lines gnus-article-truncate-lines)
4550         (make-local-variable 'gnus-summary-buffer)
4551         (setq gnus-summary-buffer
4552               (gnus-summary-buffer-name gnus-newsgroup-name))
4553         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4554         (current-buffer)))))
4555
4556 ;; Set article window start at LINE, where LINE is the number of lines
4557 ;; from the head of the article.
4558 (defun gnus-article-set-window-start (&optional line)
4559   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4560     (when article-window
4561       (set-window-start
4562        article-window
4563        (with-current-buffer gnus-article-buffer
4564          (goto-char (point-min))
4565          (if (not line)
4566              (point-min)
4567            (gnus-message 6 "Moved to bookmark")
4568            (search-forward "\n\n" nil t)
4569            (forward-line line)
4570            (point)))))))
4571
4572 (defun gnus-article-prepare (article &optional all-headers header)
4573   "Prepare ARTICLE in article mode buffer.
4574 ARTICLE should either be an article number or a Message-ID.
4575 If ARTICLE is an id, HEADER should be the article headers.
4576 If ALL-HEADERS is non-nil, no headers are hidden."
4577   (save-excursion
4578     ;; Make sure we start in a summary buffer.
4579     (unless (eq major-mode 'gnus-summary-mode)
4580       (set-buffer gnus-summary-buffer))
4581     (setq gnus-summary-buffer (current-buffer))
4582     (let* ((gnus-article (if header (mail-header-number header) article))
4583            (summary-buffer (current-buffer))
4584            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4585            (group gnus-newsgroup-name)
4586            result)
4587       (save-excursion
4588         (gnus-article-setup-buffer)
4589         (set-buffer gnus-article-buffer)
4590         ;; Deactivate active regions.
4591         (when (and (boundp 'transient-mark-mode)
4592                    transient-mark-mode)
4593           (setq mark-active nil))
4594         (if (not (setq result (let ((inhibit-read-only t))
4595                                 (gnus-request-article-this-buffer
4596                                  article group))))
4597             ;; There is no such article.
4598             (save-excursion
4599               (when (and (numberp article)
4600                          (not (memq article gnus-newsgroup-sparse)))
4601                 (setq gnus-article-current
4602                       (cons gnus-newsgroup-name article))
4603                 (set-buffer gnus-summary-buffer)
4604                 (setq gnus-current-article article)
4605                 (if (and (memq article gnus-newsgroup-undownloaded)
4606                          (not (gnus-online (gnus-find-method-for-group
4607                                             gnus-newsgroup-name))))
4608                     (progn
4609                       (gnus-summary-set-agent-mark article)
4610                       (message "Message marked for downloading"))
4611                   (gnus-summary-mark-article article gnus-canceled-mark)
4612                   (unless (memq article gnus-newsgroup-sparse)
4613                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4614           (if (or (eq result 'pseudo)
4615                   (eq result 'nneething))
4616               (progn
4617                 (with-current-buffer summary-buffer
4618                   (push article gnus-newsgroup-history)
4619                   (setq gnus-last-article gnus-current-article
4620                         gnus-current-article 0
4621                         gnus-current-headers nil
4622                         gnus-article-current nil)
4623                   (if (eq result 'nneething)
4624                       (gnus-configure-windows 'summary)
4625                     (gnus-configure-windows 'article))
4626                   (gnus-set-global-variables))
4627                 (let ((gnus-article-mime-handle-alist-1
4628                        gnus-article-mime-handle-alist))
4629                   (gnus-set-mode-line 'article)))
4630             ;; The result from the `request' was an actual article -
4631             ;; or at least some text that is now displayed in the
4632             ;; article buffer.
4633             (when (and (numberp article)
4634                        (not (eq article gnus-current-article)))
4635               ;; Seems like a new article has been selected.
4636               ;; `gnus-current-article' must be an article number.
4637               (with-current-buffer summary-buffer
4638                 (push article gnus-newsgroup-history)
4639                 (setq gnus-last-article gnus-current-article
4640                       gnus-current-article article
4641                       gnus-current-headers
4642                       (gnus-summary-article-header gnus-current-article)
4643                       gnus-article-current
4644                       (cons gnus-newsgroup-name gnus-current-article))
4645                 (unless (vectorp gnus-current-headers)
4646                   (setq gnus-current-headers nil))
4647                 (gnus-summary-goto-subject gnus-current-article)
4648                 (when (gnus-summary-show-thread)
4649                   ;; If the summary buffer really was folded, the
4650                   ;; previous goto may not actually have gone to
4651                   ;; the right article, but the thread root instead.
4652                   ;; So we go again.
4653                   (gnus-summary-goto-subject gnus-current-article))
4654                 (gnus-run-hooks 'gnus-mark-article-hook)
4655                 (gnus-set-mode-line 'summary)
4656                 (when (gnus-visual-p 'article-highlight 'highlight)
4657                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4658                 ;; Set the global newsgroup variables here.
4659                 (gnus-set-global-variables)
4660                 (setq gnus-have-all-headers
4661                       (or all-headers gnus-show-all-headers))))
4662             (save-excursion
4663               (gnus-configure-windows 'article))
4664             (when (or (numberp article)
4665                       (stringp article))
4666               (gnus-article-prepare-display)
4667               ;; Do page break.
4668               (goto-char (point-min))
4669               (when gnus-break-pages
4670                 (gnus-narrow-to-page)))
4671             (let ((gnus-article-mime-handle-alist-1
4672                    gnus-article-mime-handle-alist))
4673               (gnus-set-mode-line 'article))
4674             (article-goto-body)
4675             (unless (bobp)
4676               (forward-line -1))
4677             (set-window-point (get-buffer-window (current-buffer)) (point))
4678             (gnus-configure-windows 'article)
4679             t))))))
4680
4681 ;;;###autoload
4682 (defun gnus-article-prepare-display ()
4683   "Make the current buffer look like a nice article."
4684   ;; Hooks for getting information from the article.
4685   ;; This hook must be called before being narrowed.
4686   (let ((gnus-article-buffer (current-buffer))
4687         buffer-read-only
4688         (inhibit-read-only t))
4689     (unless (eq major-mode 'gnus-article-mode)
4690       (gnus-article-mode))
4691     (setq buffer-read-only nil
4692           gnus-article-wash-types nil
4693           gnus-article-image-alist nil)
4694     (gnus-run-hooks 'gnus-tmp-internal-hook)
4695     (when gnus-display-mime-function
4696       (funcall gnus-display-mime-function))
4697     (gnus-run-hooks 'gnus-article-prepare-hook)))
4698
4699 ;;;
4700 ;;; Gnus Sticky Article Mode
4701 ;;;
4702
4703 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4704   "Mode for sticky articles."
4705   ;; Release bindings that won't work.
4706   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4707                              gnus-sticky-article-mode-map)
4708   (substitute-key-definition 'gnus-article-refer-article 'undefined
4709                              gnus-sticky-article-mode-map)
4710   (dolist (k '("e" "h" "s" "F" "R"))
4711     (define-key gnus-sticky-article-mode-map k nil))
4712   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4713   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4714   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4715   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4716
4717 (defun gnus-sticky-article (arg)
4718   "Make the current article sticky.
4719 If a prefix ARG is given, ask for a name for this sticky article buffer."
4720   (interactive "P")
4721   (gnus-summary-show-thread)
4722   (gnus-summary-select-article nil nil 'pseudo)
4723   (let (new-art-buf-name)
4724     (gnus-eval-in-buffer-window gnus-article-buffer
4725       (setq new-art-buf-name
4726             (concat
4727              "*Sticky Article: "
4728              (if arg
4729                  (read-from-minibuffer "Sticky article buffer name: ")
4730                (gnus-with-article-headers
4731                  (gnus-article-goto-header "subject")
4732                  (setq new-art-buf-name
4733                        (buffer-substring-no-properties
4734                         (line-beginning-position) (line-end-position)))
4735                  (goto-char (point-min))
4736                  (gnus-article-goto-header "from")
4737                  (setq new-art-buf-name
4738                        (concat
4739                         new-art-buf-name ", "
4740                         (buffer-substring-no-properties
4741                          (line-beginning-position) (line-end-position))))
4742                  (goto-char (point-min))
4743                  (gnus-article-goto-header "date")
4744                  (setq new-art-buf-name
4745                        (concat
4746                         new-art-buf-name ", "
4747                         (buffer-substring-no-properties
4748                          (line-beginning-position) (line-end-position))))))
4749              "*"))
4750       (if (and (gnus-buffer-live-p new-art-buf-name)
4751                (with-current-buffer new-art-buf-name
4752                  (eq major-mode 'gnus-sticky-article-mode)))
4753           (switch-to-buffer new-art-buf-name)
4754         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4755       (gnus-sticky-article-mode))
4756     (setq gnus-article-buffer new-art-buf-name))
4757   (gnus-summary-recenter)
4758   (gnus-summary-position-point))
4759
4760 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4761   "Kill the given sticky article BUFFER.
4762 If none is given, assume the current buffer and kill it if it has
4763 `gnus-sticky-article-mode'."
4764   (interactive)
4765   (unless buffer
4766     (setq buffer (current-buffer)))
4767   (with-current-buffer buffer
4768     (when (eq major-mode 'gnus-sticky-article-mode)
4769       (gnus-kill-buffer buffer))))
4770
4771 (defun gnus-kill-sticky-article-buffers (arg)
4772   "Kill all sticky article buffers.
4773 If a prefix ARG is given, ask for confirmation."
4774   (interactive "P")
4775   (dolist (buf (gnus-buffers))
4776     (with-current-buffer buf
4777       (when (eq major-mode 'gnus-sticky-article-mode)
4778         (if (not arg)
4779             (gnus-kill-buffer buf)
4780           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4781             (gnus-kill-buffer buf)))))))
4782
4783 ;;;
4784 ;;; Gnus MIME viewing functions
4785 ;;;
4786
4787 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4788   "Format of the MIME buttons.
4789
4790 Valid specifiers include:
4791 %t  The MIME type
4792 %T  MIME type, along with additional info
4793 %n  The `name' parameter
4794 %d  The description, if any
4795 %l  The length of the encoded part
4796 %p  The part identifier number
4797 %e  Dots if the part isn't displayed
4798
4799 General format specifiers can also be used.  See Info node
4800 `(gnus)Formatting Variables'.")
4801
4802 (defvar gnus-mime-button-line-format-alist
4803   '((?t gnus-tmp-type ?s)
4804     (?T gnus-tmp-type-long ?s)
4805     (?n gnus-tmp-name ?s)
4806     (?d gnus-tmp-description ?s)
4807     (?p gnus-tmp-id ?s)
4808     (?l gnus-tmp-length ?d)
4809     (?e gnus-tmp-dots ?s)))
4810
4811 (defvar gnus-mime-button-commands
4812   '((gnus-article-press-button "\r" "Toggle Display")
4813     (gnus-mime-view-part "v" "View Interactively...")
4814     (gnus-mime-view-part-as-type "t" "View As Type...")
4815     (gnus-mime-view-part-as-charset "C" "View As charset...")
4816     (gnus-mime-save-part "o" "Save...")
4817     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4818     (gnus-mime-replace-part "r" "Replace part")
4819     (gnus-mime-delete-part "d" "Delete part")
4820     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4821     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4822     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4823     (gnus-mime-view-part-externally "e" "View Externally")
4824     (gnus-mime-print-part "p" "Print")
4825     (gnus-mime-pipe-part "|" "Pipe To Command...")
4826     (gnus-mime-action-on-part "." "Take action on the part...")))
4827
4828 (defun gnus-article-mime-part-status ()
4829   (if gnus-article-mime-handle-alist-1
4830       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4831           " (1 part)"
4832         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4833     ""))
4834
4835 (defvar gnus-mime-button-map
4836   (let ((map (make-sparse-keymap)))
4837     (define-key map gnus-mouse-2 'gnus-article-push-button)
4838     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4839     (dolist (c gnus-mime-button-commands)
4840       (define-key map (cadr c) (car c)))
4841     map))
4842
4843 (easy-menu-define
4844   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4845   `("MIME Part"
4846     ,@(mapcar (lambda (c)
4847                 (vector (caddr c) (car c) :active t))
4848               gnus-mime-button-commands)))
4849
4850 (defvar gnus-url-button-commands
4851   '((gnus-article-copy-string "u" "Copy URL to kill ring")))
4852
4853 (defvar gnus-url-button-map
4854   (let ((map (make-sparse-keymap)))
4855     (dolist (c gnus-url-button-commands)
4856       (define-key map (cadr c) (car c)))
4857     map))
4858
4859 (easy-menu-define
4860   gnus-url-button-menu gnus-url-button-map "URL button menu."
4861   `("Url Button"
4862     ,@(mapcar (lambda (c)
4863                 (vector (caddr c) (car c) :active t))
4864               gnus-url-button-commands)))
4865
4866 (defmacro gnus-bind-safe-url-regexp (&rest body)
4867   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4868   `(let ((mm-w3m-safe-url-regexp
4869           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4870                                 (gnus-buffer-live-p
4871                                  gnus-article-current-summary))
4872                            (with-current-buffer gnus-article-current-summary
4873                              gnus-newsgroup-name)
4874                          gnus-newsgroup-name)))
4875             (if (cond ((not group)
4876                        ;; Maybe we're in a mml-preview buffer
4877                        ;; and no group is selected.
4878                        t)
4879                       ((stringp gnus-safe-html-newsgroups)
4880                        (string-match gnus-safe-html-newsgroups group))
4881                       ((consp gnus-safe-html-newsgroups)
4882                        (member group gnus-safe-html-newsgroups)))
4883                 nil
4884               mm-w3m-safe-url-regexp))))
4885      ,@body))
4886
4887 (defun gnus-mime-button-menu (event prefix)
4888  "Construct a context-sensitive menu of MIME commands."
4889  (interactive "e\nP")
4890  (save-window-excursion
4891    (let ((pos (event-start event)))
4892      (select-window (posn-window pos))
4893      (goto-char (posn-point pos))
4894      (gnus-article-check-buffer)
4895      (popup-menu gnus-mime-button-menu nil prefix))))
4896
4897 (defun gnus-mime-view-all-parts (&optional handles)
4898   "View all the MIME parts."
4899   (interactive)
4900   (with-current-buffer gnus-article-buffer
4901     (let ((handles (or handles gnus-article-mime-handles))
4902           (mail-parse-charset gnus-newsgroup-charset)
4903           (mail-parse-ignored-charsets
4904            (with-current-buffer gnus-summary-buffer
4905              gnus-newsgroup-ignored-charsets)))
4906       (when handles
4907         (mm-remove-parts handles)
4908         (goto-char (point-min))
4909         (or (search-forward "\n\n") (goto-char (point-max)))
4910         (let ((inhibit-read-only t))
4911           (delete-region (point) (point-max))
4912           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4913
4914 (defun gnus-article-jump-to-part (n)
4915   "Jump to MIME part N."
4916   (interactive "P")
4917   (pop-to-buffer gnus-article-buffer)
4918   ;; FIXME: why is it necessary?
4919   (sit-for 0)
4920   (let ((parts (length gnus-article-mime-handle-alist)))
4921     (or n (setq n (read-number (format "Jump to part (2..%s): " parts))))
4922     (unless (and (integerp n) (<= n parts) (>= n 1))
4923       (setq n
4924             (progn
4925               (gnus-message 7 "Invalid part `%s', using %s instead."
4926                             n parts)
4927               parts)))
4928     (gnus-message 9 "Jumping to part %s." n)
4929     (cond ((>= gnus-auto-select-part 1)
4930            (while (and (<= n parts)
4931                        (not (gnus-article-goto-part n)))
4932              (setq n (1+ n))))
4933           ((< gnus-auto-select-part 0)
4934            (while (and (>= n 1)
4935                        (not (gnus-article-goto-part n)))
4936              (setq n (1- n))))
4937           (t
4938            (gnus-article-goto-part n)))))
4939
4940 (defvar gnus-mime-buttonized-part-id nil
4941   "ID of a mime part that should be buttonized.
4942 `gnus-mime-save-part-and-strip' and `gnus-mime-delete-part' bind it.")
4943
4944 (eval-when-compile
4945   (defsubst gnus-article-edit-part (handles &optional current-id)
4946     "Edit an article in order to delete a mime part.
4947 This function is exclusively used by `gnus-mime-save-part-and-strip'
4948 and `gnus-mime-delete-part', and not provided at run-time normally."
4949     (gnus-article-edit-article
4950      `(lambda ()
4951         (buffer-disable-undo)
4952         (erase-buffer)
4953         (let ((mail-parse-charset (or gnus-article-charset
4954                                       ',gnus-newsgroup-charset))
4955               (mail-parse-ignored-charsets
4956                (or gnus-article-ignored-charsets
4957                    ',gnus-newsgroup-ignored-charsets))
4958               (mbl mml-buffer-list))
4959           (setq mml-buffer-list nil)
4960           (insert-buffer-substring gnus-original-article-buffer)
4961           (mime-to-mml ',handles)
4962           (setq gnus-article-mime-handles nil)
4963           (let ((mbl1 mml-buffer-list))
4964             (setq mml-buffer-list mbl)
4965             (set (make-local-variable 'mml-buffer-list) mbl1))
4966           (gnus-make-local-hook 'kill-buffer-hook)
4967           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4968      `(lambda (no-highlight)
4969         (let ((mail-parse-charset (or gnus-article-charset
4970                                       ',gnus-newsgroup-charset))
4971               (message-options message-options)
4972               (message-options-set-recipient)
4973               (mail-parse-ignored-charsets
4974                (or gnus-article-ignored-charsets
4975                    ',gnus-newsgroup-ignored-charsets)))
4976           (mml-to-mime)
4977           (mml-destroy-buffers)
4978           (remove-hook 'kill-buffer-hook
4979                        'mml-destroy-buffers t)
4980           (kill-local-variable 'mml-buffer-list))
4981         (gnus-summary-edit-article-done
4982          ,(or (mail-header-references gnus-current-headers) "")
4983          ,(gnus-group-read-only-p)
4984          ,gnus-summary-buffer no-highlight))
4985      t)
4986     ;; Force buttonizing this part.
4987     (let ((gnus-mime-buttonized-part-id current-id))
4988       (gnus-article-edit-done))
4989     (gnus-configure-windows 'article)
4990     (when (and current-id (integerp gnus-auto-select-part))
4991       (gnus-article-jump-to-part
4992        (min (max (+ current-id gnus-auto-select-part) 1)
4993             (with-current-buffer gnus-article-buffer
4994               (length gnus-article-mime-handle-alist)))))))
4995
4996 (defun gnus-mime-replace-part (file)
4997   "Replace MIME part under point with an external body."
4998   ;; Useful if file has already been saved to disk
4999   (interactive
5000    (list
5001     (read-file-name "Replace MIME part with file: "
5002                     (or mm-default-directory default-directory)
5003                     nil nil)))
5004   (gnus-mime-save-part-and-strip file))
5005
5006 (defun gnus-mime-save-part-and-strip (&optional file)
5007   "Save the MIME part under point then replace it with an external body.
5008 If FILE is given, use it for the external part."
5009   (interactive)
5010   (gnus-article-check-buffer)
5011   (when (gnus-group-read-only-p)
5012     (error "The current group does not support deleting of parts"))
5013   (when (mm-complicated-handles gnus-article-mime-handles)
5014     (error "\
5015 The current article has a complicated MIME structure, giving up..."))
5016   (let* ((data (get-text-property (point) 'gnus-data))
5017          (id (get-text-property (point) 'gnus-part))
5018          param
5019          (handles gnus-article-mime-handles))
5020     (unless file
5021       (setq file
5022             (and data (mm-save-part data "Delete MIME part and save to: "))))
5023     (when file
5024       (with-current-buffer (mm-handle-buffer data)
5025         (erase-buffer)
5026         (insert "Content-Type: " (mm-handle-media-type data))
5027         (mml-insert-parameter-string (cdr (mm-handle-type data))
5028                                      '(charset))
5029         ;; Add a filename for the sake of saving the part again.
5030         (mml-insert-parameter
5031          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
5032         (insert "\n")
5033         (insert "Content-ID: " (message-make-message-id) "\n")
5034         (insert "Content-Transfer-Encoding: binary\n")
5035         (insert "\n"))
5036       (setcdr data
5037               (cdr (mm-make-handle nil
5038                                    `("message/external-body"
5039                                      (access-type . "LOCAL-FILE")
5040                                      (name . ,file)))))
5041       ;; (set-buffer gnus-summary-buffer)
5042       (gnus-article-edit-part handles id))))
5043
5044 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
5045 ;; parts...>') but with stripping would be nice.
5046
5047 (defun gnus-mime-delete-part ()
5048   "Delete the MIME part under point.
5049 Replace it with some information about the removed part."
5050   (interactive)
5051   (gnus-article-check-buffer)
5052   (when (gnus-group-read-only-p)
5053     (error "The current group does not support deleting of parts"))
5054   (when (mm-complicated-handles gnus-article-mime-handles)
5055     (error "\
5056 The current article has a complicated MIME structure, giving up..."))
5057   (when (or gnus-expert-user
5058             (gnus-yes-or-no-p "\
5059 Deleting parts may malfunction or destroy the article; continue? "))
5060     (let* ((data (get-text-property (point) 'gnus-data))
5061            (id (get-text-property (point) 'gnus-part))
5062            (handles gnus-article-mime-handles)
5063            (none "(none)")
5064            (description
5065             (let ((desc (mm-handle-description data)))
5066               (when desc
5067                 (mail-decode-encoded-word-string desc))))
5068            (filename
5069             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
5070                 none))
5071            (type (mm-handle-media-type data)))
5072       (unless data
5073         (error "No MIME part under point"))
5074       (with-current-buffer (mm-handle-buffer data)
5075         (let ((bsize (buffer-size)))
5076           (erase-buffer)
5077           (insert
5078            (concat
5079             ",----\n"
5080             "| The following attachment has been deleted:\n"
5081             "|\n"
5082             "| Type:           " type "\n"
5083             "| Filename:       " filename "\n"
5084             "| Size (encoded): " (format "%s byte%s\n"
5085                                          bsize (if (= bsize 1)
5086                                                    ""
5087                                                  "s"))
5088             (when description
5089               (concat    "| Description:    " description "\n"))
5090             "`----\n"))
5091           (setcdr data
5092                   (cdr (mm-make-handle
5093                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5094                         (list "attachment")
5095                         (format "Deleted attachment (%s bytes)" bsize))))))
5096       ;; (set-buffer gnus-summary-buffer)
5097       (gnus-article-edit-part handles id))))
5098
5099 (defun gnus-mime-save-part ()
5100   "Save the MIME part under point."
5101   (interactive)
5102   (gnus-article-check-buffer)
5103   (let ((data (get-text-property (point) 'gnus-data)))
5104     (when data
5105       (mm-save-part data))))
5106
5107 (defun gnus-mime-pipe-part (&optional cmd)
5108   "Pipe the MIME part under point to a process.
5109 Use CMD as the process."
5110   (interactive)
5111   (gnus-article-check-buffer)
5112   (let ((data (get-text-property (point) 'gnus-data)))
5113     (when data
5114       (mm-pipe-part data cmd))))
5115
5116 (defun gnus-mime-view-part ()
5117   "Interactively choose a viewing method for the MIME part under point."
5118   (interactive)
5119   (gnus-article-check-buffer)
5120   (let ((data (get-text-property (point) 'gnus-data)))
5121     (when data
5122       (setq gnus-article-mime-handles
5123             (mm-merge-handles
5124              gnus-article-mime-handles (setq data (copy-sequence data))))
5125       (mm-interactively-view-part data))))
5126
5127 (defun gnus-mime-view-part-as-type-internal ()
5128   (gnus-article-check-buffer)
5129   (let* ((handle (get-text-property (point) 'gnus-data))
5130          (name (or
5131                 ;; Content-Type: foo/bar; name=...
5132                 (mail-content-type-get (mm-handle-type handle) 'name)
5133                 ;; Content-Disposition: attachment; filename=...
5134                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5135          (def-type (and name (mm-default-file-encoding name))))
5136     (or (and def-type (cons def-type 0))
5137         (and handle
5138              (equal (mm-handle-media-supertype handle) "text")
5139              '("text/plain" . 0))
5140         '("application/octet-stream" . 0))))
5141
5142 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5143   "Choose a MIME media type, and view the part as such.
5144 If non-nil, PRED is a predicate to use during completion to limit the
5145 available media-types."
5146   (interactive)
5147   (unless mime-type
5148     (setq mime-type
5149           (let ((default (gnus-mime-view-part-as-type-internal)))
5150             (gnus-completing-read
5151              "View as MIME type"
5152              (if pred
5153                  (gnus-remove-if-not pred (mailcap-mime-types))
5154                (mailcap-mime-types))
5155              nil nil nil
5156              (car default)))))
5157   (gnus-article-check-buffer)
5158   (let ((handle (get-text-property (point) 'gnus-data)))
5159     (when handle
5160       (when (equal (mm-handle-media-type handle) "message/external-body")
5161         (unless (mm-handle-cache handle)
5162           (mm-extern-cache-contents handle))
5163         (setq handle (mm-handle-cache handle)))
5164       (setq handle
5165             (mm-make-handle (mm-handle-buffer handle)
5166                             (cons mime-type (cdr (mm-handle-type handle)))
5167                             (mm-handle-encoding handle)
5168                             (mm-handle-undisplayer handle)
5169                             (mm-handle-disposition handle)
5170                             (mm-handle-description handle)
5171                             nil
5172                             (mm-handle-id handle)))
5173       (setq gnus-article-mime-handles
5174             (mm-merge-handles gnus-article-mime-handles handle))
5175       (when (mm-handle-displayed-p handle)
5176         (mm-remove-part handle))
5177       (gnus-mm-display-part handle))))
5178
5179 (defun gnus-mime-copy-part (&optional handle arg)
5180   "Put the MIME part under point into a new buffer.
5181 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5182 are decompressed."
5183   (interactive (list nil current-prefix-arg))
5184   (gnus-article-check-buffer)
5185   (unless handle
5186     (setq handle (get-text-property (point) 'gnus-data)))
5187   (when handle
5188     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5189                                                'name)
5190                         (mail-content-type-get (mm-handle-disposition handle)
5191                                                'filename)))
5192           contents dont-decode charset coding-system)
5193       (mm-with-unibyte-buffer
5194         (mm-insert-part handle)
5195         (setq contents (or (condition-case nil
5196                                (mm-decompress-buffer filename nil 'sig)
5197                              (error
5198                               (setq dont-decode t)
5199                               nil))
5200                            (buffer-string))))
5201       (setq filename (cond (filename (file-name-nondirectory filename))
5202                            (dont-decode "*raw data*")
5203                            (t "*decoded*")))
5204       (cond
5205        (dont-decode)
5206        ((not arg)
5207         (unless (setq charset (mail-content-type-get
5208                                (mm-handle-type handle) 'charset))
5209           (unless (setq coding-system (mm-with-unibyte-buffer
5210                                         (insert contents)
5211                                         (mm-find-buffer-file-coding-system)))
5212             (setq charset gnus-newsgroup-charset))))
5213        ((numberp arg)
5214         (setq charset (or (cdr (assq arg
5215                                      gnus-summary-show-article-charset-alist))
5216                           (mm-read-coding-system "Charset: ")))))
5217       (switch-to-buffer (generate-new-buffer filename))
5218       (if (or coding-system
5219               (and charset
5220                    (setq coding-system (mm-charset-to-coding-system charset))
5221                    (not (eq charset 'ascii))))
5222           (progn
5223             (mm-enable-multibyte)
5224             (insert (mm-decode-coding-string contents coding-system))
5225             (setq buffer-file-coding-system
5226                   (if (boundp 'last-coding-system-used)
5227                       (symbol-value 'last-coding-system-used)
5228                     coding-system)))
5229         (mm-disable-multibyte)
5230         (insert contents)
5231         (setq buffer-file-coding-system mm-binary-coding-system))
5232       ;; We do it this way to make `normal-mode' set the appropriate mode.
5233       (unwind-protect
5234           (progn
5235             (setq buffer-file-name (expand-file-name filename))
5236             (normal-mode))
5237         (setq buffer-file-name nil))
5238       (goto-char (point-min)))))
5239
5240 (defun gnus-mime-print-part (&optional handle filename)
5241   "Print the MIME part under point."
5242   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5243   (gnus-article-check-buffer)
5244   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5245          (contents (and handle (mm-get-part handle)))
5246          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5247          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5248     (when contents
5249         (if printer
5250             (unwind-protect
5251                 (progn
5252                   (mm-save-part-to-file handle file)
5253                   (call-process shell-file-name nil
5254                                 (generate-new-buffer " *mm*")
5255                                 nil
5256                                 shell-command-switch
5257                                 (mm-mailcap-command
5258                                  printer file (mm-handle-type handle))))
5259               (delete-file file))
5260           (with-temp-buffer
5261             (insert contents)
5262             (gnus-print-buffer))
5263           (ps-despool filename)))))
5264
5265 (defun gnus-mime-inline-part (&optional handle arg)
5266   "Insert the MIME part under point into the current buffer.
5267 Compressed files like .gz and .bz2 are decompressed."
5268   (interactive (list nil current-prefix-arg))
5269   (gnus-article-check-buffer)
5270   (unless handle
5271     (setq handle (get-text-property (point) 'gnus-data)))
5272   (when handle
5273     (let ((b (point))
5274           (inhibit-read-only t)
5275           contents charset coding-system)
5276       (if (and (not arg) (mm-handle-undisplayer handle))
5277           (mm-remove-part handle)
5278         (mm-with-unibyte-buffer
5279           (mm-insert-part handle)
5280           (setq contents
5281                 (or (mm-decompress-buffer
5282                      (or (mail-content-type-get (mm-handle-type handle)
5283                                                 'name)
5284                          (mail-content-type-get (mm-handle-disposition handle)
5285                                                 'filename))
5286                      nil t)
5287                     (buffer-string))))
5288         (cond
5289          ((not arg)
5290           (unless (setq charset (mail-content-type-get
5291                                  (mm-handle-type handle) 'charset))
5292             (unless (setq coding-system
5293                           (mm-with-unibyte-buffer
5294                             (insert contents)
5295                             (mm-find-buffer-file-coding-system)))
5296               (setq charset gnus-newsgroup-charset))))
5297          ((numberp arg)
5298           (if (mm-handle-undisplayer handle)
5299               (mm-remove-part handle))
5300           (setq charset
5301                 (or (cdr (assq arg
5302                                gnus-summary-show-article-charset-alist))
5303                     (mm-read-coding-system "Charset: "))))
5304          (t
5305           (if (mm-handle-undisplayer handle)
5306               (mm-remove-part handle))))
5307         (forward-line 2)
5308         (mm-insert-inline
5309          handle
5310          (if (or coding-system
5311                  (and charset
5312                       (setq coding-system
5313                             (mm-charset-to-coding-system charset))
5314                       (not (eq coding-system 'ascii))))
5315              (mm-decode-coding-string contents coding-system)
5316            (mm-string-to-multibyte contents)))
5317         (goto-char b)))))
5318
5319 (defun gnus-mime-set-charset-parameters (handle charset)
5320   "Set CHARSET to parameters in HANDLE.
5321 CHARSET may either be a string or a symbol."
5322   (unless (stringp charset)
5323     (setq charset (symbol-name charset)))
5324   (if (stringp (car handle))
5325       (dolist (h (cdr handle))
5326         (gnus-mime-set-charset-parameters h charset))
5327     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5328                                             "message/external-body")
5329                                      (progn
5330                                        (unless (mm-handle-cache handle)
5331                                          (mm-extern-cache-contents handle))
5332                                        (mm-handle-cache handle))
5333                                    handle)))
5334            (param (assq 'charset (cdr type))))
5335       (if param
5336           (setcdr param charset)
5337         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5338
5339 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5340   "Insert the MIME part under point into the current buffer using the
5341 specified charset."
5342   (interactive (list nil current-prefix-arg))
5343   (gnus-article-check-buffer)
5344   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5345         (fun (get-text-property (point) 'gnus-callback))
5346         (gnus-newsgroup-ignored-charsets 'gnus-all)
5347         charset form preferred parts)
5348     (when handle
5349       (when (prog1
5350                 (and fun
5351                      (setq charset
5352                            (or (cdr (assq
5353                                      arg
5354                                      gnus-summary-show-article-charset-alist))
5355                                (mm-read-coding-system "Charset: "))))
5356               (if (mm-handle-undisplayer handle)
5357                   (mm-remove-part handle)))
5358         (gnus-mime-set-charset-parameters handle charset)
5359         (when (and (consp (setq form (cdr-safe fun)))
5360                    (setq form (ignore-errors
5361                                 (assq 'gnus-mime-display-alternative form)))
5362                    (setq preferred (caddr form))
5363                    (progn
5364                      (when (eq (car preferred) 'quote)
5365                        (setq preferred (cadr preferred)))
5366                      (not (equal preferred
5367                                  (get-text-property (point) 'gnus-data))))
5368                    (setq parts (get-text-property (point) 'gnus-part))
5369                    (setq parts (cdr (assq parts
5370                                           gnus-article-mime-handle-alist)))
5371                    (equal (mm-handle-media-type parts) "multipart/alternative")
5372                    (setq parts (reverse (cdr parts))))
5373           (setcar (cddr form)
5374                   (list 'quote (or (cadr (member preferred parts))
5375                                    (car parts)))))
5376         (funcall fun handle)))))
5377
5378 (defun gnus-mime-view-part-externally (&optional handle)
5379   "View the MIME part under point with an external viewer."
5380   (interactive)
5381   (gnus-article-check-buffer)
5382   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5383          (mm-user-display-methods nil)
5384          (mm-inlined-types nil)
5385          (mail-parse-charset gnus-newsgroup-charset)
5386          (mail-parse-ignored-charsets
5387           (with-current-buffer gnus-summary-buffer
5388             gnus-newsgroup-ignored-charsets))
5389          (type (mm-handle-media-type handle))
5390          (method (mailcap-mime-info type))
5391          (mm-enable-external t))
5392     (if (not (stringp method))
5393         (gnus-mime-view-part-as-type
5394          nil (lambda (type) (stringp (mailcap-mime-info type))))
5395       (when handle
5396         (if (mm-handle-undisplayer handle)
5397             (mm-remove-part handle)
5398           (mm-display-part handle))))))
5399
5400 (defun gnus-mime-view-part-internally (&optional handle)
5401   "View the MIME part under point with an internal viewer.
5402 If no internal viewer is available, use an external viewer."
5403   (interactive)
5404   (gnus-article-check-buffer)
5405   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5406          (mm-inlined-types '(".*"))
5407          (mm-inline-large-images t)
5408          (mail-parse-charset gnus-newsgroup-charset)
5409          (mail-parse-ignored-charsets
5410           (with-current-buffer gnus-summary-buffer
5411             gnus-newsgroup-ignored-charsets))
5412          (inhibit-read-only t))
5413     (if (not (mm-inlinable-p handle))
5414         (gnus-mime-view-part-as-type
5415          nil (lambda (type) (mm-inlinable-p handle type)))
5416       (when handle
5417         (if (mm-handle-undisplayer handle)
5418             (mm-remove-part handle)
5419           (gnus-bind-safe-url-regexp (mm-display-part handle)))))))
5420
5421 (defun gnus-mime-action-on-part (&optional action)
5422   "Do something with the MIME attachment at \(point\)."
5423   (interactive
5424    (list (gnus-completing-read "Action" (mapcar 'car gnus-mime-action-alist) t)))
5425   (gnus-article-check-buffer)
5426   (let ((action-pair (assoc action gnus-mime-action-alist)))
5427     (if action-pair
5428         (funcall (cdr action-pair)))))
5429
5430 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5431   "Call FUNCTION on MIME part N.
5432 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5433 If INTERACTIVE, call FUNCTION interactivly."
5434   (let (window frame)
5435     ;; Check whether the article is displayed.
5436     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5437                  (setq window (get-buffer-window gnus-article-buffer t))
5438                  (frame-visible-p (setq frame (window-frame window))))
5439       (error "No article is displayed"))
5440     (with-current-buffer gnus-article-buffer
5441       ;; Check whether the article displays the right contents.
5442       (unless (with-current-buffer gnus-summary-buffer
5443                 (eq gnus-current-article (gnus-summary-article-number)))
5444         (error "You should select the right article first"))
5445       (if n
5446           (setq n (prefix-numeric-value n))
5447         (let ((pt (point)))
5448           (setq n (or (get-text-property pt 'gnus-part)
5449                       (and (not (bobp))
5450                            (get-text-property (1- pt) 'gnus-part))
5451                       (get-text-property (prog2
5452                                              (forward-line 1)
5453                                              (point)
5454                                            (goto-char pt))
5455                                          'gnus-part)
5456                       (get-text-property
5457                        (or (and (setq pt (previous-single-property-change
5458                                           pt 'gnus-part))
5459                                 (1- pt))
5460                            (next-single-property-change (point) 'gnus-part)
5461                            (point))
5462                        'gnus-part)
5463                       1))))
5464       ;; Check whether the specified part exists.
5465       (when (> n (length gnus-article-mime-handle-alist))
5466         (error "No such part")))
5467     (unless
5468         (progn
5469           ;; To select the window is needed so that the cursor
5470           ;; might be visible on the MIME button.
5471           (select-window (prog1
5472                              window
5473                            (setq window (selected-window))
5474                            ;; Article may be displayed in the other frame.
5475                            (gnus-select-frame-set-input-focus
5476                             (prog1
5477                                 frame
5478                               (setq frame (selected-frame))))))
5479           (when (gnus-article-goto-part n)
5480             ;; We point the cursor and the arrow at the MIME button
5481             ;; when the `function' prompt the user for something.
5482             (let ((cursor-in-non-selected-windows t)
5483                   (overlay-arrow-string "=>")
5484                   (overlay-arrow-position (point-marker)))
5485               (unwind-protect
5486                   (cond
5487                    ((and no-handle interactive)
5488                     (call-interactively function))
5489                    (no-handle
5490                     (funcall function))
5491                    (interactive
5492                     (call-interactively
5493                      function
5494                      (cdr (assq n gnus-article-mime-handle-alist))))
5495                    (t
5496                     (funcall function
5497                              (cdr (assq n gnus-article-mime-handle-alist)))))
5498                 (set-marker overlay-arrow-position nil)
5499                 (unless gnus-auto-select-part
5500                   (gnus-select-frame-set-input-focus frame)
5501                   (select-window window))))
5502             t))
5503       (if gnus-inhibit-mime-unbuttonizing
5504           ;; This is the default though the program shouldn't reach here.
5505           (error "No such part")
5506         ;; The part which doesn't have the MIME button is selected.
5507         ;; So, we display all the buttons and redo it.
5508         (let ((gnus-inhibit-mime-unbuttonizing t))
5509           (gnus-summary-show-article)
5510           (gnus-article-part-wrapper n function no-handle))))))
5511
5512 (defun gnus-article-pipe-part (n)
5513   "Pipe MIME part N, which is the numerical prefix."
5514   (interactive "P")
5515   (gnus-article-part-wrapper n 'mm-pipe-part))
5516
5517 (defun gnus-article-save-part (n)
5518   "Save MIME part N, which is the numerical prefix."
5519   (interactive "P")
5520   (gnus-article-part-wrapper n 'mm-save-part))
5521
5522 (defun gnus-article-interactively-view-part (n)
5523   "View MIME part N interactively, which is the numerical prefix."
5524   (interactive "P")
5525   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5526
5527 (defun gnus-article-copy-part (n)
5528   "Copy MIME part N, which is the numerical prefix."
5529   (interactive "P")
5530   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5531
5532 (defun gnus-article-view-part-as-charset (n)
5533   "View MIME part N using a specified charset.
5534 N is the numerical prefix."
5535   (interactive "P")
5536   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5537
5538 (defun gnus-article-view-part-externally (n)
5539   "View MIME part N externally, which is the numerical prefix."
5540   (interactive "P")
5541   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5542
5543 (defun gnus-article-inline-part (n)
5544   "Inline MIME part N, which is the numerical prefix."
5545   (interactive "P")
5546   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5547
5548 (defun gnus-article-save-part-and-strip (n)
5549   "Save MIME part N and replace it with an external body.
5550 N is the numerical prefix."
5551   (interactive "P")
5552   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5553
5554 (defun gnus-article-replace-part (n)
5555   "Replace MIME part N with an external body.
5556 N is the numerical prefix."
5557   (interactive "P")
5558   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5559
5560 (defun gnus-article-delete-part (n)
5561   "Delete MIME part N and add some information about the removed part.
5562 N is the numerical prefix."
5563   (interactive "P")
5564   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5565
5566 (defun gnus-article-view-part-as-type (n)
5567   "Choose a MIME media type, and view part N as such.
5568 N is the numerical prefix."
5569   (interactive "P")
5570   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5571
5572 (defun gnus-article-mime-match-handle-first (condition)
5573   (if condition
5574       (let (n)
5575         (dolist (ihandle gnus-article-mime-handle-alist)
5576           (if (and (cond
5577                     ((functionp condition)
5578                      (funcall condition (cdr ihandle)))
5579                     ((eq condition 'undisplayed)
5580                      (not (or (mm-handle-undisplayer (cdr ihandle))
5581                               (equal (mm-handle-media-type (cdr ihandle))
5582                                      "multipart/alternative"))))
5583                     ((eq condition 'undisplayed-alternative)
5584                      (not (mm-handle-undisplayer (cdr ihandle))))
5585                     (t t))
5586                    (gnus-article-goto-part (car ihandle))
5587                    (or (not n) (< (car ihandle) n)))
5588               (setq n (car ihandle))))
5589         (or n 1))
5590     1))
5591
5592 (defun gnus-article-view-part (&optional n)
5593   "View MIME part N, which is the numerical prefix.
5594 If the part is already shown, hide the part.  If N is nil, view
5595 all parts."
5596   (interactive "P")
5597   (with-current-buffer gnus-article-buffer
5598     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5599                              gnus-article-mime-match-handle-function)))
5600     (when (> n (length gnus-article-mime-handle-alist))
5601       (error "No such part"))
5602     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5603       (when (gnus-article-goto-part n)
5604         (if (equal (car handle) "multipart/alternative")
5605             (gnus-article-press-button)
5606           (when (eq (gnus-mm-display-part handle) 'internal)
5607             (gnus-set-window-start)))))))
5608
5609 (defsubst gnus-article-mime-total-parts ()
5610   (if (bufferp (car gnus-article-mime-handles))
5611       1 ;; single part
5612     (1- (length gnus-article-mime-handles))))
5613
5614 (defun gnus-mm-display-part (handle)
5615   "Display HANDLE and fix MIME button."
5616   (let ((id (get-text-property (point) 'gnus-part))
5617         (point (point))
5618         (inhibit-read-only t))
5619     (forward-line 1)
5620     (prog1
5621         (let ((window (selected-window))
5622               (mail-parse-charset gnus-newsgroup-charset)
5623               (mail-parse-ignored-charsets
5624                (if (gnus-buffer-live-p gnus-summary-buffer)
5625                    (with-current-buffer gnus-summary-buffer
5626                      gnus-newsgroup-ignored-charsets)
5627                  nil)))
5628           (save-excursion
5629             (unwind-protect
5630                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5631                       (beg (point)))
5632                   (when win
5633                     (select-window win))
5634                   (goto-char point)
5635                   (forward-line)
5636                   (if (mm-handle-displayed-p handle)
5637                       ;; This will remove the part.
5638                       (mm-display-part handle)
5639                     (save-restriction
5640                       (narrow-to-region (point)
5641                                         (if (eobp) (point) (1+ (point))))
5642                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5643                       ;; We narrow to the part itself and
5644                       ;; then call the treatment functions.
5645                       (goto-char (point-min))
5646                       (forward-line 1)
5647                       (narrow-to-region (point) (point-max))
5648                       (gnus-treat-article
5649                        nil id
5650                        (gnus-article-mime-total-parts)
5651                        (mm-handle-media-type handle)))))
5652               (if (window-live-p window)
5653                   (select-window window)))))
5654       (goto-char point)
5655       (gnus-delete-line)
5656       (gnus-insert-mime-button
5657        handle id (list (mm-handle-displayed-p handle)))
5658       (goto-char point))))
5659
5660 (defun gnus-article-goto-part (n)
5661   "Go to MIME part N."
5662   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5663
5664 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5665   (let ((gnus-tmp-name
5666          (or (mail-content-type-get (mm-handle-type handle) 'name)
5667              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5668              (mail-content-type-get (mm-handle-type handle) 'url)
5669              ""))
5670         (gnus-tmp-type (mm-handle-media-type handle))
5671         (gnus-tmp-description (or (mm-handle-description handle) ""))
5672         (gnus-tmp-dots
5673          (if (if displayed (car displayed)
5674                (mm-handle-displayed-p handle))
5675              "" "..."))
5676         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5677                            (buffer-size)))
5678         gnus-tmp-type-long b e)
5679     (when (string-match ".*/" gnus-tmp-name)
5680       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5681     (setq gnus-tmp-type-long (concat gnus-tmp-type
5682                                      (and (not (equal gnus-tmp-name ""))
5683                                           (concat "; " gnus-tmp-name))))
5684     (unless (equal gnus-tmp-description "")
5685       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5686     (unless (bolp)
5687       (insert "\n"))
5688     (setq b (point))
5689     (gnus-eval-format
5690      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5691      `(keymap ,gnus-mime-button-map
5692               gnus-callback gnus-mm-display-part
5693               gnus-part ,gnus-tmp-id
5694               article-type annotation
5695               gnus-data ,handle))
5696     (setq e (if (bolp)
5697                 ;; Exclude a newline.
5698                 (1- (point))
5699               (point)))
5700     (when gnus-article-button-face
5701       (gnus-overlay-put (gnus-make-overlay b e nil t)
5702                         'face gnus-article-button-face))
5703     (widget-convert-button
5704      'link b e
5705      :mime-handle handle
5706      :action 'gnus-widget-press-button
5707      :button-keymap gnus-mime-button-map
5708      :help-echo
5709      (lambda (widget)
5710        ;; Needed to properly clear the message due to a bug in
5711        ;; wid-edit (XEmacs only).
5712        (if (boundp 'help-echo-owns-message)
5713            (setq help-echo-owns-message t))
5714        (format
5715         "%S: %s the MIME part; %S: more options"
5716         (aref gnus-mouse-2 0)
5717         (if (mm-handle-displayed-p (widget-get widget :mime-handle))
5718             "hide" "show")
5719         (aref gnus-down-mouse-3 0))))))
5720
5721 (defun gnus-widget-press-button (elems el)
5722   (goto-char (widget-get elems :from))
5723   (gnus-article-press-button))
5724
5725 (defvar gnus-displaying-mime nil)
5726
5727 (defun gnus-display-mime (&optional ihandles)
5728   "Display the MIME parts."
5729   (save-excursion
5730     (save-selected-window
5731       (let ((window (get-buffer-window gnus-article-buffer))
5732             (point (point)))
5733         (when window
5734           (select-window window)
5735           ;; We have to do this since selecting the window
5736           ;; may change the point.  So we set the window point.
5737           (set-window-point window point)))
5738       (let ((handles ihandles)
5739             (inhibit-read-only t)
5740             handle)
5741         (cond (handles)
5742               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5743                (when gnus-article-emulate-mime
5744                  (mm-uu-dissect-text-parts handles)))
5745               (gnus-article-emulate-mime
5746                (setq handles (mm-uu-dissect))))
5747         (when (and (not ihandles)
5748                    (not gnus-displaying-mime))
5749           ;; Top-level call; we clean up.
5750           (when gnus-article-mime-handles
5751             (mm-destroy-parts gnus-article-mime-handles)
5752             (setq gnus-article-mime-handle-alist nil));; A trick.
5753           (setq gnus-article-mime-handles handles)
5754           ;; We allow users to glean info from the handles.
5755           (when gnus-article-mime-part-function
5756             (gnus-mime-part-function handles)))
5757         (if (and handles
5758                  (or (not (stringp (car handles)))
5759                      (cdr handles)))
5760             (progn
5761               (when (and (not ihandles)
5762                          (not gnus-displaying-mime))
5763                 ;; Clean up for mime parts.
5764                 (article-goto-body)
5765                 (delete-region (point) (point-max)))
5766               (let ((gnus-displaying-mime t))
5767                 (gnus-mime-display-part handles)))
5768           (save-restriction
5769             (article-goto-body)
5770             (narrow-to-region (point) (point-max))
5771             (gnus-treat-article nil 1 1)
5772             (widen)))
5773         (unless ihandles
5774           ;; Highlight the headers.
5775           (save-excursion
5776             (save-restriction
5777               (article-goto-body)
5778               (narrow-to-region (point-min) (point))
5779               (gnus-article-save-original-date
5780                (gnus-treat-article 'head)))))))
5781     ;; Cope with broken MIME messages.
5782     (goto-char (point-max))
5783     (unless (bolp)
5784       (insert "\n"))))
5785
5786 (defcustom gnus-mime-display-multipart-as-mixed nil
5787   "Display \"multipart\" parts as  \"multipart/mixed\".
5788
5789 If t, it overrides nil values of
5790 `gnus-mime-display-multipart-alternative-as-mixed' and
5791 `gnus-mime-display-multipart-related-as-mixed'."
5792   :group 'gnus-article-mime
5793   :type 'boolean)
5794
5795 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5796   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5797   :version "22.1"
5798   :group 'gnus-article-mime
5799   :type 'boolean)
5800
5801 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5802   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5803
5804 If displaying \"text/html\" is discouraged \(see
5805 `mm-discouraged-alternatives'\) images or other material inside a
5806 \"multipart/related\" part might be overlooked when this variable is nil."
5807   :version "22.1"
5808   :group 'gnus-article-mime
5809   :type 'boolean)
5810
5811 (defun gnus-mime-display-part (handle)
5812   (cond
5813    ;; Maybe a broken MIME message.
5814    ((null handle))
5815    ;; Single part.
5816    ((not (stringp (car handle)))
5817     (gnus-mime-display-single handle))
5818    ;; User-defined multipart
5819    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5820     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5821              handle))
5822    ;; multipart/alternative
5823    ((and (equal (car handle) "multipart/alternative")
5824          (not (or gnus-mime-display-multipart-as-mixed
5825                   gnus-mime-display-multipart-alternative-as-mixed)))
5826     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5827       (push (cons id handle) gnus-article-mime-handle-alist)
5828       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5829    ;; multipart/related
5830    ((and (equal (car handle) "multipart/related")
5831          (not (or gnus-mime-display-multipart-as-mixed
5832                   gnus-mime-display-multipart-related-as-mixed)))
5833     ;;;!!!We should find the start part, but we just default
5834     ;;;!!!to the first part.
5835     ;;(gnus-mime-display-part (cadr handle))
5836     ;;;!!! Most multipart/related is an HTML message plus images.
5837     ;;;!!! Unfortunately we are unable to let W3 display those
5838     ;;;!!! included images, so we just display it as a mixed multipart.
5839     ;;(gnus-mime-display-mixed (cdr handle))
5840     ;;;!!! No, w3 can display everything just fine.
5841     (gnus-mime-display-part (cadr handle)))
5842    ((equal (car handle) "multipart/signed")
5843     (gnus-add-wash-type 'signed)
5844     (gnus-mime-display-security handle))
5845    ((equal (car handle) "multipart/encrypted")
5846     (gnus-add-wash-type 'encrypted)
5847     (gnus-mime-display-security handle))
5848    ;; Other multiparts are handled like multipart/mixed.
5849    (t
5850     (gnus-mime-display-mixed (cdr handle)))))
5851
5852 (defun gnus-mime-part-function (handles)
5853   (if (stringp (car handles))
5854       (mapcar 'gnus-mime-part-function (cdr handles))
5855     (funcall gnus-article-mime-part-function handles)))
5856
5857 (defun gnus-mime-display-mixed (handles)
5858   (mapcar 'gnus-mime-display-part handles))
5859
5860 (defun gnus-mime-display-single (handle)
5861   (let ((type (mm-handle-media-type handle))
5862         (ignored gnus-ignored-mime-types)
5863         (not-attachment t)
5864         (move nil)
5865         display text)
5866     (catch 'ignored
5867       (progn
5868         (while ignored
5869           (when (string-match (pop ignored) type)
5870             (throw 'ignored nil)))
5871         (if (and (setq not-attachment
5872                        (and (not (mm-inline-override-p handle))
5873                             (or (not (mm-handle-disposition handle))
5874                                 (equal (car (mm-handle-disposition handle))
5875                                        "inline")
5876                                 (mm-attachment-override-p handle))))
5877                  (mm-automatic-display-p handle)
5878                  (or (and
5879                       (mm-inlinable-p handle)
5880                       (mm-inlined-p handle))
5881                      (mm-automatic-external-display-p type)))
5882             (setq display t)
5883           (when (equal (mm-handle-media-supertype handle) "text")
5884             (setq text t)))
5885         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5886               beg)
5887           (push (cons id handle) gnus-article-mime-handle-alist)
5888           (when (and display
5889                      (equal (mm-handle-media-supertype handle) "message"))
5890             (insert-char
5891              ?\n
5892              (cond ((not (bolp)) 2)
5893                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5894                    (t 1))))
5895           (when (or (not display)
5896                     (not (gnus-unbuttonized-mime-type-p type))
5897                     (eq id gnus-mime-buttonized-part-id))
5898             (gnus-insert-mime-button
5899              handle id (list (or display (and not-attachment text))))
5900             (gnus-article-insert-newline)
5901             ;; Remember modify the number of forward lines.
5902             (setq move t))
5903           (setq beg (point))
5904           (cond
5905            (display
5906             (when move
5907               (forward-line -1)
5908               (setq beg (point)))
5909             (let ((mail-parse-charset gnus-newsgroup-charset)
5910                   (mail-parse-ignored-charsets
5911                    (save-excursion (condition-case ()
5912                                        (set-buffer gnus-summary-buffer)
5913                                      (error))
5914                                    gnus-newsgroup-ignored-charsets)))
5915               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5916             (goto-char (point-max)))
5917            ((and text not-attachment)
5918             (when move
5919               (forward-line -1)
5920               (setq beg (point)))
5921             (gnus-article-insert-newline)
5922             (mm-insert-inline
5923              handle
5924              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5925                                                        'charset)
5926                                 (and (equal type "text/calendar") 'utf-8))))
5927                (cond ((not charset)
5928                       (mm-string-as-multibyte (mm-get-part handle)))
5929                      ((eq charset 'gnus-decoded)
5930                       (with-current-buffer (mm-handle-buffer handle)
5931                         (buffer-string)))
5932                      (t
5933                       (mm-decode-string (mm-get-part handle) charset)))))
5934             (goto-char (point-max))))
5935           ;; Do highlighting.
5936           (save-excursion
5937             (save-restriction
5938               (narrow-to-region beg (point))
5939               (if (eq handle gnus-article-mime-handles)
5940                   ;; The format=flowed case.
5941                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5942                 ;; Don't count signature parts that are never displayed.
5943                 ;; The part number should be re-calculated supposing this
5944                 ;; might be a message/rfc822 part.
5945                 (let (handles)
5946                   (dolist (part gnus-article-mime-handles)
5947                     (unless (or (stringp part)
5948                                 (equal (car (mm-handle-type part))
5949                                        "application/pgp-signature"))
5950                       (push part handles)))
5951                   (gnus-treat-article
5952                    nil (length (memq handle handles)) (length handles)
5953                    (mm-handle-media-type handle)))))))))))
5954
5955 (defun gnus-unbuttonized-mime-type-p (type)
5956   "Say whether TYPE is to be unbuttonized."
5957   (unless gnus-inhibit-mime-unbuttonizing
5958     (when (catch 'found
5959             (let ((types gnus-unbuttonized-mime-types))
5960               (while types
5961                 (when (string-match (pop types) type)
5962                   (throw 'found t)))))
5963       (not (catch 'found
5964              (let ((types gnus-buttonized-mime-types))
5965                (while types
5966                  (when (string-match (pop types) type)
5967                    (throw 'found t)))))))))
5968
5969 (defun gnus-article-insert-newline ()
5970   "Insert a newline, but mark it as undeletable."
5971   (gnus-put-text-property
5972    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5973
5974 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5975   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5976          (ihandles handles)
5977          (point (point))
5978          handle (inhibit-read-only t) from props begend not-pref)
5979     (save-window-excursion
5980       (save-restriction
5981         (when ibegend
5982           (narrow-to-region (car ibegend)
5983                             (or (cdr ibegend)
5984                                 (progn
5985                                   (goto-char (car ibegend))
5986                                   (forward-line 2)
5987                                   (point))))
5988           (delete-region (point-min) (point-max))
5989           (mm-remove-parts handles))
5990         (setq begend (list (point-marker)))
5991         ;; Do the toggle.
5992         (unless (setq not-pref (cadr (member preferred ihandles)))
5993           (setq not-pref (car ihandles)))
5994         (when (or ibegend
5995                   (not preferred)
5996                   (not (gnus-unbuttonized-mime-type-p
5997                         "multipart/alternative")))
5998           (gnus-add-text-properties
5999            (setq from (point))
6000            (progn
6001              (insert (format "%d.  " id))
6002              (point))
6003            `(gnus-callback
6004              (lambda (handles)
6005                (unless ,(not ibegend)
6006                  (setq gnus-article-mime-handle-alist
6007                        ',gnus-article-mime-handle-alist))
6008                (gnus-mime-display-alternative
6009                 ',ihandles ',not-pref ',begend ,id))
6010              keymap ,gnus-mime-button-map
6011              ,gnus-mouse-face-prop ,gnus-article-mouse-face
6012              face ,gnus-article-button-face
6013              gnus-part ,id
6014              article-type multipart))
6015           (widget-convert-button 'link from (point)
6016                                  :action 'gnus-widget-press-button
6017                                  :button-keymap gnus-widget-button-keymap)
6018           ;; Do the handles
6019           (while (setq handle (pop handles))
6020             (gnus-add-text-properties
6021              (setq from (point))
6022              (progn
6023                (insert (format "(%c) %-18s"
6024                                (if (equal handle preferred) ?* ? )
6025                                (mm-handle-media-type handle)))
6026                (point))
6027              `(gnus-callback
6028                (lambda (handles)
6029                  (unless ,(not ibegend)
6030                    (setq gnus-article-mime-handle-alist
6031                          ',gnus-article-mime-handle-alist))
6032                  (gnus-mime-display-alternative
6033                   ',ihandles ',handle ',begend ,id))
6034                keymap ,gnus-mime-button-map
6035                ,gnus-mouse-face-prop ,gnus-article-mouse-face
6036                face ,gnus-article-button-face
6037                gnus-part ,id
6038                gnus-data ,handle))
6039             (widget-convert-button 'link from (point)
6040                                    :action 'gnus-widget-press-button
6041                                    :button-keymap gnus-widget-button-keymap)
6042             (insert "  "))
6043           (insert "\n\n"))
6044         (when preferred
6045           (if (stringp (car preferred))
6046               (gnus-display-mime preferred)
6047             (let ((mail-parse-charset gnus-newsgroup-charset)
6048                   (mail-parse-ignored-charsets
6049                    (with-current-buffer gnus-summary-buffer
6050                      gnus-newsgroup-ignored-charsets)))
6051               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6052               ;; Do highlighting.
6053               (save-excursion
6054                 (save-restriction
6055                   (narrow-to-region (car begend) (point-max))
6056                   (gnus-treat-article
6057                    nil (length gnus-article-mime-handle-alist)
6058                    (gnus-article-mime-total-parts)
6059                    (mm-handle-media-type handle))))))
6060           (goto-char (point-max))
6061           (setcdr begend (point-marker)))))
6062     (when ibegend
6063       (goto-char point))))
6064
6065 (defconst gnus-article-wash-status-strings
6066   (let ((alist '((cite "c" "Possible hidden citation text"
6067                        " " "All citation text visible")
6068                  (headers "h" "Hidden headers"
6069                           " " "All headers visible.")
6070                  (pgp "p" "Encrypted or signed message status hidden"
6071                       " " "No hidden encryption nor digital signature status")
6072                  (signature "s" "Signature has been hidden"
6073                             " " "Signature is visible")
6074                  (overstrike "o" "Overstrike (^H) characters applied"
6075                              " " "No overstrike characters applied")
6076                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6077                            " " "No /*_emphasis_*/ characters applied")))
6078         result)
6079     (dolist (entry alist result)
6080       (let ((key (nth 0 entry))
6081             (on (copy-sequence (nth 1 entry)))
6082             (on-help (nth 2 entry))
6083             (off (copy-sequence (nth 3 entry)))
6084             (off-help (nth 4 entry)))
6085         (put-text-property 0 1 'help-echo on-help on)
6086         (put-text-property 0 1 'help-echo off-help off)
6087         (push (list key on off) result))))
6088   "Alist of strings describing wash status in the mode line.
6089 Each entry has the form (KEY ON OF), where the KEY is a symbol
6090 representing the particular washing function, ON is the string to use
6091 in the article mode line when the washing function is active, and OFF
6092 is the string to use when it is inactive.")
6093
6094 (defun gnus-article-wash-status-entry (key value)
6095   (let ((entry (assoc key gnus-article-wash-status-strings)))
6096     (if value (nth 1 entry) (nth 2 entry))))
6097
6098 (defun gnus-article-wash-status ()
6099   "Return a string which display status of article washing."
6100   (with-current-buffer gnus-article-buffer
6101     (let ((cite (memq 'cite gnus-article-wash-types))
6102           (headers (memq 'headers gnus-article-wash-types))
6103           (boring (memq 'boring-headers gnus-article-wash-types))
6104           (pgp (memq 'pgp gnus-article-wash-types))
6105           (pem (memq 'pem gnus-article-wash-types))
6106           (signed (memq 'signed gnus-article-wash-types))
6107           (encrypted (memq 'encrypted gnus-article-wash-types))
6108           (signature (memq 'signature gnus-article-wash-types))
6109           (overstrike (memq 'overstrike gnus-article-wash-types))
6110           (emphasis (memq 'emphasis gnus-article-wash-types)))
6111       (concat
6112        (gnus-article-wash-status-entry 'cite cite)
6113        (gnus-article-wash-status-entry 'headers (or headers boring))
6114        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6115        (gnus-article-wash-status-entry 'signature signature)
6116        (gnus-article-wash-status-entry 'overstrike overstrike)
6117        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6118
6119 (defun gnus-add-wash-type (type)
6120   "Add a washing of TYPE to the current status."
6121   (add-to-list 'gnus-article-wash-types type))
6122
6123 (defun gnus-delete-wash-type (type)
6124   "Add a washing of TYPE to the current status."
6125   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6126
6127 (defun gnus-add-image (category image)
6128   "Add IMAGE of CATEGORY to the list of displayed images."
6129   (let ((entry (assq category gnus-article-image-alist)))
6130     (unless entry
6131       (setq entry (list category))
6132       (push entry gnus-article-image-alist))
6133     (nconc entry (list image))))
6134
6135 (defun gnus-delete-images (category)
6136   "Delete all images in CATEGORY."
6137   (let ((entry (assq category gnus-article-image-alist)))
6138     (dolist (image (cdr entry))
6139       (gnus-remove-image image category))
6140     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6141     (gnus-delete-wash-type category)))
6142
6143 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6144
6145 (defun gnus-article-maybe-hide-headers ()
6146   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6147 Provided for backwards compatibility."
6148   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6149                  (not (with-current-buffer gnus-summary-buffer
6150                         gnus-have-all-headers)))
6151              (not gnus-inhibit-hiding))
6152     (gnus-article-hide-headers)))
6153
6154 ;;; Article savers.
6155
6156 (defun gnus-output-to-file (file-name)
6157   "Append the current article to a file named FILE-NAME.
6158 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6159 text and used as the value of the coding cookie which is added to the
6160 top of a file.  Otherwise, this function saves a raw article without
6161 the coding cookie."
6162   (let* ((artbuf (current-buffer))
6163          (file-name-coding-system nnmail-pathname-coding-system)
6164          (coding gnus-article-save-coding-system)
6165          (coding-system-for-read (if coding
6166                                      nil ;; Rely on the coding cookie.
6167                                    mm-text-coding-system))
6168          (coding-system-for-write (or coding
6169                                       mm-text-coding-system-for-write
6170                                       mm-text-coding-system))
6171          (exists (file-exists-p file-name)))
6172     (with-temp-buffer
6173       (when exists
6174         (insert-file-contents file-name)
6175         (goto-char (point-min))
6176         ;; Remove the existing coding cookie.
6177         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6178           (delete-region (match-beginning 0) (match-end 0))))
6179       (goto-char (point-max))
6180       (insert-buffer-substring artbuf)
6181       ;; Append newline at end of the buffer as separator, and then
6182       ;; save it to file.
6183       (goto-char (point-max))
6184       (insert "\n")
6185       (when coding
6186         ;; If the coding system is not suitable to encode the text,
6187         ;; ask a user for a proper one.
6188         (when (fboundp 'select-safe-coding-system)
6189           (setq coding (coding-system-base
6190                         (save-window-excursion
6191                           (select-safe-coding-system (point-min) (point-max)
6192                                                      coding))))
6193           (setq coding-system-for-write
6194                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6195                     coding)))
6196         (goto-char (point-min))
6197         ;; Add the coding cookie.
6198         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6199                         coding-system-for-write)))
6200       (if exists
6201           (progn
6202             (write-region (point-min) (point-max) file-name nil 'no-message)
6203             (message "Appended to %s" file-name))
6204         (write-region (point-min) (point-max) file-name))))
6205   t)
6206
6207 (defun gnus-narrow-to-page (&optional arg)
6208   "Narrow the article buffer to a page.
6209 If given a numerical ARG, move forward ARG pages."
6210   (interactive "P")
6211   (setq arg (if arg (prefix-numeric-value arg) 0))
6212   (with-current-buffer gnus-article-buffer
6213     (widen)
6214     ;; Remove any old next/prev buttons.
6215     (when (gnus-visual-p 'page-marker)
6216       (let ((inhibit-read-only t))
6217         (gnus-remove-text-with-property 'gnus-prev)
6218         (gnus-remove-text-with-property 'gnus-next)))
6219     (let (st nd pt)
6220       (when (save-excursion
6221               (cond ((< arg 0)
6222                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6223                          (prog1
6224                              (setq nd (match-beginning 0)
6225                                    pt nd)
6226                            (when (re-search-backward page-delimiter nil t)
6227                              (setq st (match-end 0))))
6228                        (when (re-search-forward page-delimiter nil t)
6229                          (setq nd (match-beginning 0)
6230                                pt (point-min)))))
6231                     ((> arg 0)
6232                      (if (re-search-forward page-delimiter nil 'move arg)
6233                          (prog1
6234                              (setq st (match-end 0)
6235                                    pt st)
6236                            (when (re-search-forward page-delimiter nil t)
6237                              (setq nd (match-beginning 0))))
6238                        (when (re-search-backward page-delimiter nil t)
6239                          (setq st (match-end 0)
6240                                pt (point-max)))))
6241                     (t
6242                      (when (re-search-backward page-delimiter nil t)
6243                        (goto-char (setq st (match-end 0))))
6244                      (when (re-search-forward page-delimiter nil t)
6245                        (setq nd (match-beginning 0)))
6246                      (or st nd))))
6247         (setq gnus-page-broken t)
6248         (when pt (goto-char pt))
6249         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6250         (when (gnus-visual-p 'page-marker)
6251           (save-excursion
6252             (when nd
6253               (goto-char nd)
6254               (gnus-insert-next-page-button))
6255             (when st
6256               (goto-char st)
6257               (gnus-insert-prev-page-button))))))))
6258
6259 ;; Article mode commands
6260
6261 (defun gnus-article-goto-next-page ()
6262   "Show the next page of the article."
6263   (interactive)
6264   (when (gnus-article-next-page)
6265     (goto-char (point-min))
6266     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6267
6268
6269 (defun gnus-article-goto-prev-page ()
6270   "Show the previous page of the article."
6271   (interactive)
6272   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6273       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6274     (gnus-article-prev-page nil)))
6275
6276 ;; This is cleaner but currently breaks `gnus-pick-mode':
6277 ;;
6278 ;; (defun gnus-article-goto-next-page ()
6279 ;;   "Show the next page of the article."
6280 ;;   (interactive)
6281 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6282 ;;     (gnus-summary-next-page)))
6283 ;;
6284 ;; (defun gnus-article-goto-prev-page ()
6285 ;;   "Show the next page of the article."
6286 ;;   (interactive)
6287 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6288 ;;     (gnus-summary-prev-page)))
6289
6290 (defun gnus-article-next-page (&optional lines)
6291   "Show the next page of the current article.
6292 If end of article, return non-nil.  Otherwise return nil.
6293 Argument LINES specifies lines to be scrolled up."
6294   (interactive "p")
6295   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6296   (if (and (not (and gnus-article-over-scroll
6297                      (> (count-lines (window-start) (point-max))
6298                         (if (featurep 'xemacs)
6299                             (or lines (1- (window-height)))
6300                           (+ (or lines (1- (window-height))) scroll-margin)))))
6301            (save-excursion
6302              (end-of-line)
6303              (and (pos-visible-in-window-p)     ;Not continuation line.
6304                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6305       ;; Nothing in this page.
6306       (if (or (not gnus-page-broken)
6307               (save-excursion
6308                 (save-restriction
6309                   (widen)
6310                   (forward-line)
6311                   (eobp)))) ;Real end-of-buffer?
6312           (progn
6313             (when gnus-article-over-scroll
6314               (gnus-article-next-page-1 lines))
6315             t)                  ;Nothing more.
6316         (gnus-narrow-to-page 1)         ;Go to next page.
6317         nil)
6318     ;; More in this page.
6319     (gnus-article-next-page-1 lines)
6320     nil))
6321
6322 (defun gnus-article-beginning-of-window ()
6323   "Move point to the beginning of the window.
6324 In Emacs, the point is placed at the line number which `scroll-margin'
6325 specifies."
6326   (if (featurep 'xemacs)
6327       (move-to-window-line 0)
6328     ;; There is an obscure bug in Emacs that makes it impossible to
6329     ;; scroll past big pictures in the article buffer.  Try to fix
6330     ;; this by adding a sanity check by counting the lines visible.
6331     (when (> (count-lines (window-start) (window-end)) 30)
6332       (move-to-window-line
6333        (min (max 0 scroll-margin)
6334             (max 1 (- (window-height)
6335                       (if mode-line-format 1 0)
6336                       (if header-line-format 1 0)
6337                       2)))))))
6338
6339 (defun gnus-article-next-page-1 (lines)
6340   (condition-case ()
6341       (let ((scroll-in-place nil))
6342         (scroll-up lines))
6343     (end-of-buffer
6344      ;; Long lines may cause an end-of-buffer error.
6345      (goto-char (point-max))))
6346   (gnus-article-beginning-of-window))
6347
6348 (defun gnus-article-prev-page (&optional lines)
6349   "Show previous page of current article.
6350 Argument LINES specifies lines to be scrolled down."
6351   (interactive "p")
6352   (move-to-window-line 0)
6353   (if (and gnus-page-broken
6354            (bobp)
6355            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6356       (progn
6357         (gnus-narrow-to-page -1)        ;Go to previous page.
6358         (goto-char (point-max))
6359         (recenter (if gnus-article-over-scroll
6360                       (if lines
6361                           (max (if (featurep 'xemacs)
6362                                    lines
6363                                  (+ lines scroll-margin))
6364                                3)
6365                         (- (window-height) 2))
6366                     -1)))
6367     (prog1
6368         (condition-case ()
6369             (let ((scroll-in-place nil))
6370               (scroll-down lines))
6371           (beginning-of-buffer
6372            (goto-char (point-min))))
6373       (gnus-article-beginning-of-window))))
6374
6375 (defun gnus-article-only-boring-p ()
6376   "Decide whether there is only boring text remaining in the article.
6377 Something \"interesting\" is a word of at least two letters that does
6378 not have a face in `gnus-article-boring-faces'."
6379   (when (and gnus-article-skip-boring
6380              (boundp 'gnus-article-boring-faces)
6381              (symbol-value 'gnus-article-boring-faces))
6382     (save-excursion
6383       (let ((inhibit-point-motion-hooks t))
6384         (catch 'only-boring
6385           (while (re-search-forward "\\b\\w\\w" nil t)
6386             (forward-char -1)
6387             (when (not (gnus-intersection
6388                         (gnus-faces-at (point))
6389                         (symbol-value 'gnus-article-boring-faces)))
6390               (throw 'only-boring nil)))
6391           (throw 'only-boring t))))))
6392
6393 (defun gnus-article-refer-article ()
6394   "Read article specified by message-id around point."
6395   (interactive)
6396   (save-excursion
6397     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6398     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6399     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6400         (let ((msg-id (concat "<" (match-string 0) ">")))
6401           (set-buffer gnus-summary-buffer)
6402           (gnus-summary-refer-article msg-id))
6403       (error "No references around point"))))
6404
6405 (defun gnus-article-show-summary ()
6406   "Reconfigure windows to show summary buffer."
6407   (interactive)
6408   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6409       (error "There is no summary buffer for this article buffer")
6410     (gnus-article-set-globals)
6411     (gnus-configure-windows 'article)
6412     (gnus-summary-goto-subject gnus-current-article)
6413     (gnus-summary-position-point)))
6414
6415 (defun gnus-article-describe-briefly ()
6416   "Describe article mode commands briefly."
6417   (interactive)
6418   (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")))
6419
6420 (defun gnus-article-check-buffer ()
6421   "Beep if not in an article buffer."
6422   (unless (equal major-mode 'gnus-article-mode)
6423     (error "Command invoked outside of a Gnus article buffer")))
6424
6425 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6426   "Read a summary buffer key sequence and execute it from the article buffer."
6427   (interactive "P")
6428   (gnus-article-check-buffer)
6429   (let ((nosaves
6430          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6431            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6432            "=" "^" "\M-^" "|"))
6433         (nosave-but-article
6434          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6435            "An" "Ap" [?A (meta return)] [?A delete]))
6436         (nosave-in-article
6437          '("AS" "\C-d"))
6438         (up-to-top
6439          '("n" "Gn" "p" "Gp"))
6440         keys new-sum-point)
6441     (with-current-buffer gnus-article-current-summary
6442       (let (gnus-pick-mode)
6443         (setq unread-command-events (nconc unread-command-events
6444                                            (list (or key last-command-event)))
6445               keys (if (featurep 'xemacs)
6446                        (events-to-keys (read-key-sequence nil t))
6447                      (read-key-sequence nil t)))))
6448
6449     (message "")
6450
6451     (cond
6452      ((eq (aref keys (1- (length keys))) ?\C-h)
6453       (gnus-article-describe-bindings (substring keys 0 -1)))
6454      ((or (member keys nosaves)
6455           (member keys nosave-but-article)
6456           (member keys nosave-in-article))
6457       (let (func)
6458         (save-window-excursion
6459           (pop-to-buffer gnus-article-current-summary)
6460           ;; We disable the pick minor mode commands.
6461           (let (gnus-pick-mode)
6462             (setq func (key-binding keys t))))
6463         (if (or (not func)
6464                 (numberp func))
6465             (ding)
6466           (unless (member keys nosave-in-article)
6467             (set-buffer gnus-article-current-summary))
6468           (call-interactively func)
6469           (setq new-sum-point (point)))
6470         (when (member keys nosave-but-article)
6471           (pop-to-buffer gnus-article-buffer))))
6472      (t
6473       ;; These commands should restore window configuration.
6474       (let ((obuf (current-buffer))
6475             (owin (current-window-configuration))
6476             win func in-buffer selected new-sum-start new-sum-hscroll err)
6477         (cond (not-restore-window
6478                (pop-to-buffer gnus-article-current-summary)
6479                (setq win (selected-window)))
6480               ((setq win (get-buffer-window gnus-article-current-summary))
6481                (select-window win))
6482               (t
6483                (let ((summary-buffer gnus-article-current-summary))
6484                  (gnus-configure-windows 'article)
6485                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6486                    (let ((gnus-buffer-configuration
6487                           '((article ((vertical 1.0
6488                                                 (summary 0.25 point)
6489                                                 (article 1.0)))))))
6490                      (gnus-configure-windows 'article))
6491                    (setq win (get-buffer-window summary-buffer 'visible)))
6492                  (gnus-select-frame-set-input-focus (window-frame win))
6493                  (select-window win))))
6494         (setq in-buffer (current-buffer))
6495         ;; We disable the pick minor mode commands.
6496         (if (and (setq func (let (gnus-pick-mode)
6497                               (key-binding keys t)))
6498                  (functionp func)
6499                  (condition-case code
6500                      (progn
6501                        (call-interactively func)
6502                        t)
6503                    (error
6504                     (setq err code)
6505                     nil)))
6506             (progn
6507               (when (eq win (selected-window))
6508                 (setq new-sum-point (point)
6509                       new-sum-start (window-start win)
6510                       new-sum-hscroll (window-hscroll win)))
6511               (when (or (eq in-buffer (current-buffer))
6512                         (when (eq obuf (current-buffer))
6513                           (set-buffer in-buffer)
6514                           t))
6515                 (setq selected (gnus-summary-select-article))
6516                 (set-buffer obuf)
6517                 (unless not-restore-window
6518                   (set-window-configuration owin))
6519                 (when (and (eq selected 'old)
6520                            new-sum-point)
6521                   (set-window-start (get-buffer-window (current-buffer))
6522                                     1)
6523                   (set-window-point (get-buffer-window (current-buffer))
6524                                     (if (article-goto-body)
6525                                         (1- (point))
6526                                       (point))))
6527                 (when (and (not not-restore-window)
6528                            new-sum-point
6529                            (window-live-p win)
6530                            (with-current-buffer (window-buffer win)
6531                              (eq major-mode 'gnus-summary-mode)))
6532                   (set-window-point win new-sum-point)
6533                   (set-window-start win new-sum-start)
6534                   (set-window-hscroll win new-sum-hscroll))))
6535           (set-window-configuration owin)
6536           (if err
6537               (signal (car err) (cdr err))
6538             (ding))))))))
6539
6540 (defun gnus-article-read-summary-send-keys ()
6541   (interactive)
6542   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6543     (gnus-article-read-summary-keys)))
6544
6545 (defun gnus-article-describe-key (key)
6546   "Display documentation of the function invoked by KEY.
6547 KEY is a string or a vector."
6548   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6549                        (read-key-sequence "Describe key: "))))
6550   (gnus-article-check-buffer)
6551   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6552                                   gnus-article-read-summary-send-keys))
6553       (with-current-buffer gnus-article-current-summary
6554         (setq unread-command-events
6555               (if (featurep 'xemacs)
6556                   (append key nil)
6557                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6558                                         (list 'meta (- x 128))
6559                                       x))
6560                         key)))
6561         (let ((cursor-in-echo-area t)
6562               gnus-pick-mode)
6563           (describe-key (read-key-sequence nil t))))
6564     (describe-key key)))
6565
6566 (defun gnus-article-describe-key-briefly (key &optional insert)
6567   "Display documentation of the function invoked by KEY.
6568 KEY is a string or a vector."
6569   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6570                        (read-key-sequence "Describe key: "))
6571                      current-prefix-arg))
6572   (gnus-article-check-buffer)
6573   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6574                                   gnus-article-read-summary-send-keys))
6575       (with-current-buffer gnus-article-current-summary
6576         (setq unread-command-events
6577               (if (featurep 'xemacs)
6578                   (append key nil)
6579                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6580                                         (list 'meta (- x 128))
6581                                       x))
6582                         key)))
6583         (let ((cursor-in-echo-area t)
6584               gnus-pick-mode)
6585           (describe-key-briefly (read-key-sequence nil t) insert)))
6586     (describe-key-briefly key insert)))
6587
6588 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6589 (defvar gnus-agent-summary-mode)
6590 (defvar gnus-draft-mode)
6591 ;; Calling help-buffer will autoload help-mode.
6592 (defvar help-xref-stack-item)
6593 ;; Emacs 22 doesn't load it in the batch mode.
6594 (eval-when-compile
6595   (autoload 'help-buffer "help-mode"))
6596
6597 (defun gnus-article-describe-bindings (&optional prefix)
6598   "Show a list of all defined keys, and their definitions.
6599 The optional argument PREFIX, if non-nil, should be a key sequence;
6600 then we display only bindings that start with that prefix."
6601   (interactive)
6602   (gnus-article-check-buffer)
6603   (let ((keymap (copy-keymap gnus-article-mode-map))
6604         (map (copy-keymap gnus-article-send-map))
6605         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6606         parent agent draft)
6607     (define-key keymap "S" map)
6608     (define-key map [t] nil)
6609     (with-current-buffer gnus-article-current-summary
6610       (set-keymap-parent
6611        keymap
6612        (if (setq parent (keymap-parent gnus-article-mode-map))
6613            (prog1
6614                (setq parent (copy-keymap parent))
6615              (set-keymap-parent parent (current-local-map)))
6616          (current-local-map)))
6617       (set-keymap-parent map (key-binding "S"))
6618       (let (key def gnus-pick-mode)
6619         (while sumkeys
6620           (setq key (pop sumkeys))
6621           (cond ((and (vectorp key) (= (length key) 1)
6622                       (consp (setq def (aref key 0)))
6623                       (numberp (car def)) (numberp (cdr def)))
6624                  (when (< (max (car def) (cdr def)) 128)
6625                    (setq sumkeys
6626                          (append (mapcar
6627                                   #'vector
6628                                   (nreverse (gnus-uncompress-range def)))
6629                                  sumkeys))))
6630                 ((setq def (key-binding key))
6631                  (unless (eq def 'undefined)
6632                    (define-key keymap key def))))))
6633       (when (boundp 'gnus-agent-summary-mode)
6634         (setq agent gnus-agent-summary-mode))
6635       (when (boundp 'gnus-draft-mode)
6636         (setq draft gnus-draft-mode)))
6637     (with-temp-buffer
6638       (use-local-map keymap)
6639       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6640       (set (make-local-variable 'gnus-draft-mode) draft)
6641       (describe-bindings prefix))
6642     (let ((item `((lambda (prefix)
6643                     (with-current-buffer ,(current-buffer)
6644                       (gnus-article-describe-bindings prefix)))
6645                   ,prefix)))
6646       (with-current-buffer (let (help-xref-following) (help-buffer))
6647         (setq help-xref-stack-item item)))))
6648
6649 (defun gnus-article-reply-with-original (&optional wide)
6650   "Start composing a reply mail to the current message.
6651 The text in the region will be yanked.  If the region isn't active,
6652 the entire article will be yanked."
6653   (interactive)
6654   (let ((article (cdr gnus-article-current))
6655         contents)
6656     (if (not (gnus-region-active-p))
6657         (with-current-buffer gnus-summary-buffer
6658           (gnus-summary-reply (list (list article)) wide))
6659       (setq contents (buffer-substring (point) (mark t)))
6660       ;; Deactivate active regions.
6661       (when (and (boundp 'transient-mark-mode)
6662                  transient-mark-mode)
6663         (setq mark-active nil))
6664       (with-current-buffer gnus-summary-buffer
6665         (gnus-summary-reply
6666          (list (list article contents)) wide)))))
6667
6668 (defun gnus-article-wide-reply-with-original ()
6669   "Start composing a wide reply mail to the current message.
6670 The text in the region will be yanked.  If the region isn't active,
6671 the entire article will be yanked."
6672   (interactive)
6673   (gnus-article-reply-with-original t))
6674
6675 (defun gnus-article-followup-with-original ()
6676   "Compose a followup to the current article.
6677 The text in the region will be yanked.  If the region isn't active,
6678 the entire article will be yanked."
6679   (interactive)
6680   (let ((article (cdr gnus-article-current))
6681         contents)
6682       (if (not (gnus-region-active-p))
6683           (with-current-buffer gnus-summary-buffer
6684             (gnus-summary-followup (list (list article))))
6685         (setq contents (buffer-substring (point) (mark t)))
6686         ;; Deactivate active regions.
6687         (when (and (boundp 'transient-mark-mode)
6688                    transient-mark-mode)
6689           (setq mark-active nil))
6690         (with-current-buffer gnus-summary-buffer
6691           (gnus-summary-followup
6692            (list (list article contents)))))))
6693
6694 (defun gnus-article-hide (&optional arg force)
6695   "Hide all the gruft in the current article.
6696 This means that signatures, cited text and (some) headers will be
6697 hidden.
6698 If given a prefix, show the hidden text instead."
6699   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6700   (gnus-article-hide-headers arg)
6701   (gnus-article-hide-list-identifiers arg)
6702   (gnus-article-hide-citation-maybe arg force)
6703   (gnus-article-hide-signature arg))
6704
6705 (defun gnus-article-maybe-highlight ()
6706   "Do some article highlighting if article highlighting is requested."
6707   (when (gnus-visual-p 'article-highlight 'highlight)
6708     (gnus-article-highlight-some)))
6709
6710 (defun gnus-check-group-server ()
6711   ;; Make sure the connection to the server is alive.
6712   (unless (gnus-server-opened
6713            (gnus-find-method-for-group gnus-newsgroup-name))
6714     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6715     (gnus-request-group gnus-newsgroup-name t)))
6716
6717 (eval-when-compile
6718   (autoload 'nneething-get-file-name "nneething"))
6719
6720 (defun gnus-request-article-this-buffer (article group)
6721   "Get an article and insert it into this buffer."
6722   (let (do-update-line sparse-header)
6723     (prog1
6724         (save-excursion
6725           (erase-buffer)
6726           (gnus-kill-all-overlays)
6727           (setq group (or group gnus-newsgroup-name))
6728
6729           ;; Using `gnus-request-article' directly will insert the article into
6730           ;; `nntp-server-buffer' - so we'll save some time by not having to
6731           ;; copy it from the server buffer into the article buffer.
6732
6733           ;; We only request an article by message-id when we do not have the
6734           ;; headers for it, so we'll have to get those.
6735           (when (stringp article)
6736             (gnus-read-header article))
6737
6738           ;; If the article number is negative, that means that this article
6739           ;; doesn't belong in this newsgroup (possibly), so we find its
6740           ;; message-id and request it by id instead of number.
6741           (when (and (numberp article)
6742                      gnus-summary-buffer
6743                      (get-buffer gnus-summary-buffer)
6744                      (gnus-buffer-exists-p gnus-summary-buffer))
6745             (with-current-buffer gnus-summary-buffer
6746               (let ((header (gnus-summary-article-header article)))
6747                 (when (< article 0)
6748                   (cond
6749                    ((memq article gnus-newsgroup-sparse)
6750                     ;; This is a sparse gap article.
6751                     (setq do-update-line article)
6752                     (setq article (mail-header-id header))
6753                     (setq sparse-header (gnus-read-header article))
6754                     (setq gnus-newsgroup-sparse
6755                           (delq article gnus-newsgroup-sparse)))
6756                    ((vectorp header)
6757                     ;; It's a real article.
6758                     (setq article (mail-header-id header)))
6759                    (t
6760                     ;; It is an extracted pseudo-article.
6761                     (setq article 'pseudo)
6762                     (gnus-request-pseudo-article header))))
6763
6764                 (let ((method (gnus-find-method-for-group
6765                                gnus-newsgroup-name)))
6766                   (when (and (eq (car method) 'nneething)
6767                              (vectorp header))
6768                     (let ((dir (nneething-get-file-name
6769                                 (mail-header-id header))))
6770                       (when (and (stringp dir)
6771                                  (file-directory-p dir))
6772                         (setq article 'nneething)
6773                         (gnus-group-enter-directory dir))))))))
6774
6775           (cond
6776            ;; Refuse to select canceled articles.
6777            ((and (numberp article)
6778                  gnus-summary-buffer
6779                  (get-buffer gnus-summary-buffer)
6780                  (gnus-buffer-exists-p gnus-summary-buffer)
6781                  (eq (cdr (with-current-buffer gnus-summary-buffer
6782                             (assq article gnus-newsgroup-reads)))
6783                      gnus-canceled-mark))
6784             nil)
6785            ;; We first check `gnus-original-article-buffer'.
6786            ((and (get-buffer gnus-original-article-buffer)
6787                  (numberp article)
6788                  (with-current-buffer gnus-original-article-buffer
6789                    (and (equal (car gnus-original-article) group)
6790                         (eq (cdr gnus-original-article) article))))
6791             ;; `insert-buffer-substring' would incorrectly use the
6792             ;; equivalent of string-make-multibyte which amount to decoding
6793             ;; with locale-coding-system, causing failure of
6794             ;; subsequent decoding.
6795             (insert (mm-string-to-multibyte
6796                      (with-current-buffer gnus-original-article-buffer
6797                        (buffer-substring (point-min) (point-max)))))
6798             'article)
6799            ;; Check the backlog.
6800            ((and gnus-keep-backlog
6801                  (gnus-backlog-request-article group article (current-buffer)))
6802             'article)
6803            ;; Check asynchronous pre-fetch.
6804            ((gnus-async-request-fetched-article group article (current-buffer))
6805             (gnus-async-prefetch-next group article gnus-summary-buffer)
6806             (when (and (numberp article) gnus-keep-backlog)
6807               (gnus-backlog-enter-article group article (current-buffer)))
6808             'article)
6809            ;; Check the cache.
6810            ((and gnus-use-cache
6811                  (numberp article)
6812                  (gnus-cache-request-article article group))
6813             'article)
6814            ;; Check the agent cache.
6815            ((gnus-agent-request-article article group)
6816             'article)
6817            ;; Get the article and put into the article buffer.
6818            ((or (stringp article)
6819                 (numberp article))
6820             (let ((gnus-override-method gnus-override-method)
6821                   (methods (and (stringp article)
6822                                 gnus-refer-article-method))
6823                   (backend (car (gnus-find-method-for-group
6824                                  gnus-newsgroup-name)))
6825                   result
6826                   (inhibit-read-only t))
6827               (if (or (not (listp methods))
6828                       (and (symbolp (car methods))
6829                            (assq (car methods) nnoo-definition-alist)))
6830                   (setq methods (list methods)))
6831               (when (and (null gnus-override-method)
6832                          methods)
6833                 (setq gnus-override-method (pop methods)))
6834               (while (not result)
6835                 (when (eq gnus-override-method 'current)
6836                   (setq gnus-override-method
6837                         (with-current-buffer gnus-summary-buffer
6838                           gnus-current-select-method)))
6839                 (erase-buffer)
6840                 (gnus-kill-all-overlays)
6841                 (let ((gnus-newsgroup-name group))
6842                   (gnus-check-group-server))
6843                 (cond
6844                  ((gnus-request-article article group (current-buffer))
6845                   (when (numberp article)
6846                     (gnus-async-prefetch-next group article
6847                                               gnus-summary-buffer)
6848                     (when gnus-keep-backlog
6849                       (gnus-backlog-enter-article
6850                        group article (current-buffer))))
6851                   (setq result 'article))
6852                  (methods
6853                   (setq gnus-override-method (pop methods)))
6854                  ((not (string-match "^400 "
6855                                      (nnheader-get-report backend)))
6856                   ;; If we get 400 server disconnect, reconnect and
6857                   ;; retry; otherwise, assume the article has expired.
6858                   (setq result 'done))))
6859               (and (eq result 'article) 'article)))
6860            ;; It was a pseudo.
6861            (t article)))
6862
6863       ;; Associate this article with the current summary buffer.
6864       (setq gnus-article-current-summary gnus-summary-buffer)
6865
6866       ;; Take the article from the original article buffer
6867       ;; and place it in the buffer it's supposed to be in.
6868       (when (and (get-buffer gnus-article-buffer)
6869                  (equal (buffer-name (current-buffer))
6870                         (buffer-name (get-buffer gnus-article-buffer))))
6871         (save-excursion
6872           (if (get-buffer gnus-original-article-buffer)
6873               (set-buffer gnus-original-article-buffer)
6874             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6875             (buffer-disable-undo)
6876             (setq major-mode 'gnus-original-article-mode)
6877             (setq buffer-read-only t))
6878           (let ((inhibit-read-only t))
6879             (erase-buffer)
6880             (insert-buffer-substring gnus-article-buffer))
6881           (setq gnus-original-article (cons group article)))
6882
6883         ;; Decode charsets.
6884         (run-hooks 'gnus-article-decode-hook)
6885         ;; Mark article as decoded or not.
6886         (setq gnus-article-decoded-p gnus-article-decode-hook))
6887
6888       ;; Update sparse articles.
6889       (when (and do-update-line
6890                  (or (numberp article)
6891                      (stringp article)))
6892         (let ((buf (current-buffer)))
6893           (set-buffer gnus-summary-buffer)
6894           (gnus-summary-update-article do-update-line sparse-header)
6895           (gnus-summary-goto-subject do-update-line nil t)
6896           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6897                             (point))
6898           (set-buffer buf))))))
6899
6900 ;;;
6901 ;;; Article editing
6902 ;;;
6903
6904 (defcustom gnus-article-edit-mode-hook nil
6905   "Hook run in article edit mode buffers."
6906   :group 'gnus-article-various
6907   :type 'hook)
6908
6909 (defvar gnus-article-edit-done-function nil)
6910
6911 (defvar gnus-article-edit-mode-map nil)
6912
6913 ;; Should we be using derived.el for this?
6914 (unless gnus-article-edit-mode-map
6915   (setq gnus-article-edit-mode-map (make-keymap))
6916   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6917
6918   (gnus-define-keys gnus-article-edit-mode-map
6919     "\C-c?"    describe-mode
6920     "\C-c\C-c" gnus-article-edit-done
6921     "\C-c\C-k" gnus-article-edit-exit
6922     "\C-c\C-f\C-t" message-goto-to
6923     "\C-c\C-f\C-o" message-goto-from
6924     "\C-c\C-f\C-b" message-goto-bcc
6925     ;;"\C-c\C-f\C-w" message-goto-fcc
6926     "\C-c\C-f\C-c" message-goto-cc
6927     "\C-c\C-f\C-s" message-goto-subject
6928     "\C-c\C-f\C-r" message-goto-reply-to
6929     "\C-c\C-f\C-n" message-goto-newsgroups
6930     "\C-c\C-f\C-d" message-goto-distribution
6931     "\C-c\C-f\C-f" message-goto-followup-to
6932     "\C-c\C-f\C-m" message-goto-mail-followup-to
6933     "\C-c\C-f\C-k" message-goto-keywords
6934     "\C-c\C-f\C-u" message-goto-summary
6935     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6936     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6937     "\C-c\C-b" message-goto-body
6938     "\C-c\C-i" message-goto-signature
6939
6940     "\C-c\C-t" message-insert-to
6941     "\C-c\C-n" message-insert-newsgroups
6942     "\C-c\C-o" message-sort-headers
6943     "\C-c\C-e" message-elide-region
6944     "\C-c\C-v" message-delete-not-region
6945     "\C-c\C-z" message-kill-to-signature
6946     "\M-\r" message-newline-and-reformat
6947     "\C-c\C-a" mml-attach-file
6948     "\C-a" message-beginning-of-line
6949     "\t" message-tab
6950     "\M-;" comment-region)
6951
6952   (gnus-define-keys (gnus-article-edit-wash-map
6953                      "\C-c\C-w" gnus-article-edit-mode-map)
6954     "f" gnus-article-edit-full-stops))
6955
6956 (easy-menu-define
6957   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6958   '("Field"
6959     ["Fetch To" message-insert-to t]
6960     ["Fetch Newsgroups" message-insert-newsgroups t]
6961     "----"
6962     ["To" message-goto-to t]
6963     ["From" message-goto-from t]
6964     ["Subject" message-goto-subject t]
6965     ["Cc" message-goto-cc t]
6966     ["Reply-To" message-goto-reply-to t]
6967     ["Summary" message-goto-summary t]
6968     ["Keywords" message-goto-keywords t]
6969     ["Newsgroups" message-goto-newsgroups t]
6970     ["Followup-To" message-goto-followup-to t]
6971     ["Mail-Followup-To" message-goto-mail-followup-to t]
6972     ["Distribution" message-goto-distribution t]
6973     ["Body" message-goto-body t]
6974     ["Signature" message-goto-signature t]))
6975
6976 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6977   "Major mode for editing articles.
6978 This is an extended text-mode.
6979
6980 \\{gnus-article-edit-mode-map}"
6981   (make-local-variable 'gnus-article-edit-done-function)
6982   (make-local-variable 'gnus-prev-winconf)
6983   (set (make-local-variable 'font-lock-defaults)
6984        '(message-font-lock-keywords t))
6985   (set (make-local-variable 'mail-header-separator) "")
6986   (set (make-local-variable 'gnus-article-edit-mode) t)
6987   (easy-menu-add message-mode-field-menu message-mode-map)
6988   (mml-mode)
6989   (setq buffer-read-only nil)
6990   (buffer-enable-undo)
6991   (widen))
6992
6993 (defun gnus-article-edit (&optional force)
6994   "Edit the current article.
6995 This will have permanent effect only in mail groups.
6996 If FORCE is non-nil, allow editing of articles even in read-only
6997 groups."
6998   (interactive "P")
6999   (when (and (not force)
7000              (gnus-group-read-only-p))
7001     (error "The current newsgroup does not support article editing"))
7002   (gnus-article-date-original)
7003   (gnus-article-edit-article
7004    'ignore
7005    `(lambda (no-highlight)
7006       'ignore
7007       (gnus-summary-edit-article-done
7008        ,(or (mail-header-references gnus-current-headers) "")
7009        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
7010
7011 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
7012   "Start editing the contents of the current article buffer."
7013   (let ((winconf (current-window-configuration)))
7014     (set-buffer gnus-article-buffer)
7015     (let ((message-auto-save-directory
7016            ;; Don't associate the article buffer with a draft file.
7017            nil))
7018       (gnus-article-edit-mode))
7019     (funcall start-func)
7020     (set-buffer-modified-p nil)
7021     (gnus-configure-windows 'edit-article)
7022     (setq gnus-article-edit-done-function exit-func)
7023     (setq gnus-prev-winconf winconf)
7024     (unless quiet
7025       (gnus-message 6 "C-c C-c to end edits"))))
7026
7027 (defun gnus-article-edit-done (&optional arg)
7028   "Update the article edits and exit."
7029   (interactive "P")
7030   (let ((func gnus-article-edit-done-function)
7031         (buf (current-buffer))
7032         (start (window-start))
7033         (p (point))
7034         (winconf gnus-prev-winconf))
7035     (widen) ;; Widen it in case that users narrowed the buffer.
7036     (funcall func arg)
7037     (set-buffer buf)
7038     ;; The cache and backlog have to be flushed somewhat.
7039     (when gnus-keep-backlog
7040       (gnus-backlog-remove-article
7041        (car gnus-article-current) (cdr gnus-article-current)))
7042     ;; Flush original article as well.
7043     (gnus-flush-original-article-buffer)
7044     (when gnus-use-cache
7045       (gnus-cache-update-article
7046        (car gnus-article-current) (cdr gnus-article-current)))
7047     ;; We remove all text props from the article buffer.
7048     (kill-all-local-variables)
7049     (set-text-properties (point-min) (point-max) nil)
7050     (gnus-article-mode)
7051     (set-window-configuration winconf)
7052     (set-buffer buf)
7053     (set-window-start (get-buffer-window buf) start)
7054     (set-window-point (get-buffer-window buf) (point)))
7055   (gnus-summary-show-article))
7056
7057 (defun gnus-flush-original-article-buffer ()
7058   (when (get-buffer gnus-original-article-buffer)
7059     (with-current-buffer gnus-original-article-buffer
7060       (setq gnus-original-article nil))))
7061
7062 (defun gnus-article-edit-exit ()
7063   "Exit the article editing without updating."
7064   (interactive)
7065   (when (or (not (buffer-modified-p))
7066             (yes-or-no-p "Article modified; kill anyway? "))
7067     (let ((curbuf (current-buffer))
7068           (p (point))
7069           (window-start (window-start)))
7070       (erase-buffer)
7071       (if (gnus-buffer-live-p gnus-original-article-buffer)
7072           (insert-buffer-substring gnus-original-article-buffer))
7073       (let ((winconf gnus-prev-winconf))
7074         (kill-all-local-variables)
7075         (gnus-article-mode)
7076         (set-window-configuration winconf)
7077         ;; Tippy-toe some to make sure that point remains where it was.
7078         (save-current-buffer
7079           (set-buffer curbuf)
7080           (set-window-start (get-buffer-window (current-buffer)) window-start)
7081           (goto-char p))))
7082     (gnus-summary-show-article)))
7083
7084 (defun gnus-article-edit-full-stops ()
7085   "Interactively repair spacing at end of sentences."
7086   (interactive)
7087   (save-excursion
7088     (goto-char (point-min))
7089     (search-forward-regexp "^$" nil t)
7090     (let ((case-fold-search nil))
7091       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7092
7093 ;;;
7094 ;;; Article highlights
7095 ;;;
7096
7097 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7098
7099 ;;; Internal Variables:
7100
7101 (defcustom gnus-button-url-regexp
7102   (concat
7103    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7104    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7105    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7106    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7107        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7108              (punct "!?:;.,"))
7109          (concat
7110           "\\(?:"
7111           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7112           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7113           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7114           "\\|"
7115           "[" chars punct     "]+" "[" chars "]"
7116           "\\)"))
7117      (concat ;; XEmacs 21.4 doesn't support POSIX.
7118       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7119       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7120    "\\)")
7121   "Regular expression that matches URLs."
7122   :group 'gnus-article-buttons
7123   :type 'regexp)
7124
7125 (defcustom gnus-button-valid-fqdn-regexp
7126   message-valid-fqdn-regexp
7127   "Regular expression that matches a valid FQDN."
7128   :version "22.1"
7129   :group 'gnus-article-buttons
7130   :type 'regexp)
7131
7132 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7133 (defcustom gnus-button-valid-localpart-regexp
7134   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7135   "Regular expression that matches a localpart of mail addresses or MIDs."
7136   :version "22.1"
7137   :group 'gnus-article-buttons
7138   :type 'regexp)
7139
7140 (defcustom gnus-button-man-handler 'manual-entry
7141   "Function to use for displaying man pages.
7142 The function must take at least one argument with a string naming the
7143 man page."
7144   :version "22.1"
7145   :type '(choice (function-item :tag "Man" manual-entry)
7146                  (function-item :tag "Woman" woman)
7147                  (function :tag "Other"))
7148   :group 'gnus-article-buttons)
7149
7150 (defcustom gnus-button-mid-or-mail-regexp
7151   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7152           gnus-button-valid-fqdn-regexp
7153           ">?\\)\\b")
7154   "Regular expression that matches a message ID or a mail address."
7155   :version "22.1"
7156   :group 'gnus-article-buttons
7157   :type 'regexp)
7158
7159 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7160   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7161 Strings like this can be either a message ID or a mail address.  If it is one
7162 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7163 message ID or a mail address, respectively.  If this variable is set to the
7164 symbol `ask', always query the user what do do.  If it is a function, this
7165 function will be called with the string as its only argument.  The function
7166 must return `mid', `mail', `invalid' or `ask'."
7167   :version "22.1"
7168   :group 'gnus-article-buttons
7169   :type '(choice (function-item :tag "Heuristic function"
7170                                 gnus-button-mid-or-mail-heuristic)
7171                  (const ask)
7172                  (const mid)
7173                  (const mail)))
7174
7175 (defcustom gnus-button-mid-or-mail-heuristic-alist
7176   '((-10.0 . ".+\\$.+@")
7177     (-10.0 . "#")
7178     (-10.0 . "\\*")
7179     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7180     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7181     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7182     (-1.0  . "^[^a-z]+@")
7183     ;;
7184     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7185     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7186     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7187     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7188     ;;
7189     (-2.0  . "^[0-9]")
7190     (-1.0  . "^[0-9][0-9]")
7191     ;;
7192     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7193     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7194     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7195     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7196     ;;
7197     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7198     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7199     ;;       "[0-9]{8,}.*\@"
7200     (-3.0
7201      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7202     ;; "[0-9]{12,}.*\@"
7203     ;; compensation for TDMA dated mail addresses:
7204     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7205     ;;
7206     (-20.0 . "\\.fsf@") ;; Gnus
7207     (-20.0 . "^slrn")
7208     (-20.0 . "^Pine")
7209     (-20.0 . "^alpine\\.")
7210     (-20.0 . "_-_") ;; Subject change in thread
7211     ;;
7212     (-20.0 . "\\.ln@") ;; leafnode
7213     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7214     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7215     ;;
7216     ;; (5.0 . "") ;; $local_part_len <= 7
7217     (10.0  . "^[^0-9]+@")
7218     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7219     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7220     (3.0   . "\@stud")
7221     ;;
7222     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7223     ;;
7224     (0.5   . "^[A-Z][a-z]")
7225     (0.5   . "^[A-Z][a-z][a-z]")
7226     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7227     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7228   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7229
7230 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7231 address.  The REGEXP is processed with `case-fold-search' set to nil."
7232   :version "22.1"
7233   :group 'gnus-article-buttons
7234   :type '(repeat (cons (number :tag "Rate")
7235                        (regexp :tag "Regexp"))))
7236
7237 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7238   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7239 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7240 address, `ask' if unsure and `invalid' if the string is invalid."
7241   (let ((case-fold-search nil)
7242         (list gnus-button-mid-or-mail-heuristic-alist)
7243         (result 0) rate regexp lpartlen elem)
7244     (setq lpartlen
7245           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7246     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7247     ;; Certain special cases...
7248     (when (string-match
7249            (concat
7250             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7251             "^[0-9]+\\.[0-9]+@compuserve\\|"
7252             "@public\\.gmane\\.org")
7253            mid-or-mail)
7254       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7255       (setq result 'mail))
7256     (when (string-match "@.*@\\| " mid-or-mail)
7257       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7258       (setq result 'invalid))
7259     ;; Nothing more to do, if result is not a number here...
7260     (when (numberp result)
7261       (while list
7262         (setq elem (car list)
7263               rate (car elem)
7264               regexp (cdr elem)
7265               list (cdr list))
7266         (when (string-match regexp mid-or-mail)
7267           (setq result (+ result rate))
7268           (gnus-message
7269            9 "`%s' matched `%s', rate `%s', result `%s'."
7270            mid-or-mail regexp rate result)))
7271       (when (<= lpartlen 7)
7272         (setq result (+ result 5.0))
7273         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7274                       mid-or-mail result))
7275       (when (>= lpartlen 12)
7276         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7277         (cond
7278          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7279           ;; Long local part should contain realname if e-mail address,
7280           ;; too many digits: message-id.
7281           ;; $score -= 5.0 + 0.1 * $local_part_len;
7282           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7283           (setq result (+ result rate))
7284           (gnus-message
7285            9 "Many digits in `%s', rate `%s', result `%s'."
7286            mid-or-mail rate result))
7287          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7288                         mid-or-mail)
7289           ;; Too few vowels [^aeiouy]{4,}.*\@
7290           (setq result (+ result -5.0))
7291           (gnus-message
7292            9 "Few vowels in `%s', rate `%s', result `%s'."
7293            mid-or-mail -5.0 result))
7294          (t
7295           (setq result (+ result 5.0))
7296           (gnus-message
7297            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7298     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7299     ;; Maybe we should make this a customizable alist: (condition . 'result)
7300     (cond
7301      ((symbolp result) result)
7302      ;; Now convert number into proper results:
7303      ((< result -10.0) 'mid)
7304      ((> result  10.0) 'mail)
7305      (t 'ask))))
7306
7307 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7308   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7309          (url-mid (concat "news" ":" mid-or-mail))
7310          (url-mailto (concat "mailto" ":" mid-or-mail)))
7311     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7312     (when (fboundp pref)
7313       (setq guessed
7314             ;; get rid of surrounding angles...
7315             (funcall pref
7316                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7317       (if (or (eq 'mid guessed) (eq 'mail guessed))
7318           (setq pref guessed)
7319         (setq pref 'ask)))
7320     (if (eq pref 'ask)
7321         (save-window-excursion
7322           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7323               (setq pref 'mail)
7324             (setq pref 'mid))))
7325     (cond ((eq pref 'mid)
7326            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7327            (gnus-button-handle-news url-mid))
7328           ((eq pref 'mail)
7329            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7330            (gnus-url-mailto url-mailto))
7331           (t (gnus-message 3 "Invalid string.")))))
7332
7333 (defun gnus-button-handle-custom (fun arg)
7334   "Call function FUN on argument ARG.
7335 Both FUN and ARG are supposed to be strings.  ARG will be passed
7336 as a symbol to FUN."
7337   (funcall (intern fun)
7338            (if (string-match "^customize-apropos" fun)
7339                arg
7340              (intern arg))))
7341
7342 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7343
7344 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7345 ;; stuff?
7346
7347 (defun gnus-button-handle-describe-function (url)
7348   "Call `describe-function' when pushing the corresponding URL button."
7349   (describe-function
7350    (intern
7351     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7352
7353 (defun gnus-button-handle-describe-variable (url)
7354   "Call `describe-variable' when pushing the corresponding URL button."
7355   (describe-variable
7356    (intern
7357     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7358
7359 (defun gnus-button-handle-symbol (url)
7360 "Display help on variable or function.
7361 Calls `describe-variable' or `describe-function'."
7362   (let ((sym (intern url)))
7363     (cond
7364      ((fboundp sym) (describe-function sym))
7365      ((boundp sym) (describe-variable sym))
7366      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7367
7368 (defun gnus-button-handle-describe-key (url)
7369   "Call `describe-key' when pushing the corresponding URL button."
7370   (let* ((key-string
7371           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7372          (keys (ignore-errors (eval `(kbd ,key-string)))))
7373     (if keys
7374         (describe-key keys)
7375       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7376
7377 (defun gnus-button-handle-apropos (url)
7378   "Call `apropos' when pushing the corresponding URL button."
7379   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7380
7381 (defun gnus-button-handle-apropos-command (url)
7382   "Call `apropos' when pushing the corresponding URL button."
7383   (apropos-command
7384    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7385
7386 (defun gnus-button-handle-apropos-variable (url)
7387   "Call `apropos' when pushing the corresponding URL button."
7388   (funcall
7389    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7390    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7391
7392 (defun gnus-button-handle-apropos-documentation (url)
7393   "Call `apropos' when pushing the corresponding URL button."
7394   (funcall
7395    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7396    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7397
7398 (defun gnus-button-handle-library (url)
7399   "Call `locate-library' when pushing the corresponding URL button."
7400   (gnus-message 9 "url=`%s'" url)
7401   (let* ((lib (locate-library url))
7402          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7403     (if (not lib)
7404         (gnus-message 1 "Cannot locale library `%s'." url)
7405       (find-file-read-only file))))
7406
7407 (defcustom gnus-button-man-level 5
7408   "*Integer that says how many man-related buttons Gnus will show.
7409 The higher the number, the more buttons will appear and the more false
7410 positives are possible.  Note that you can set this variable local to
7411 specific groups.  Setting it higher in Unix groups is probably a good idea.
7412 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7413 how to set variables in specific groups."
7414   :version "22.1"
7415   :group 'gnus-article-buttons
7416   :link '(custom-manual "(gnus)Group Parameters")
7417   :type 'integer)
7418
7419 (defcustom gnus-button-emacs-level 5
7420   "*Integer that says how many emacs-related buttons Gnus will show.
7421 The higher the number, the more buttons will appear and the more false
7422 positives are possible.  Note that you can set this variable local to
7423 specific groups.  Setting it higher in Emacs or Gnus related groups is
7424 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7425 `gnus-parameters' on how to set variables in specific groups."
7426   :version "22.1"
7427   :group 'gnus-article-buttons
7428   :link '(custom-manual "(gnus)Group Parameters")
7429   :type 'integer)
7430
7431 (defcustom gnus-button-message-level 5
7432   "*Integer that says how many buttons for news or mail messages will appear.
7433 The higher the number, the more buttons will appear and the more false
7434 positives are possible."
7435   ;; mail addresses, MIDs, URLs for news, ...
7436   :version "22.1"
7437   :group 'gnus-article-buttons
7438   :type 'integer)
7439
7440 (defcustom gnus-button-browse-level 5
7441   "*Integer that says how many buttons for browsing will appear.
7442 The higher the number, the more buttons will appear and the more false
7443 positives are possible."
7444   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7445   :version "22.1"
7446   :group 'gnus-article-buttons
7447   :type 'integer)
7448
7449 (defcustom gnus-button-alist
7450   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7451      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7452     ((concat "\\b\\(nntp\\|news\\):\\("
7453              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7454      0 t gnus-button-handle-news 2)
7455     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7456      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7457     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7458      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7459     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7460     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7461      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7462     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7463      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7464     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7465      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7466     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7467      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7468     ;; RFC 2368 (The mailto URL scheme)
7469     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7470      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7471     ("\\bmailto:\\([^ \n\t]+\\)"
7472      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7473     ;; Info Konqueror style <info:/foo/bar baz>.
7474     ;; Must come before " Gnus home-grown style".
7475     ("\\binfo://?\\([^'\">\n\t]+\\)"
7476      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7477    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7478     ("\\binfo://\\([^'\">\n\t ]+\\)"
7479      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7480     ;; Info GNOME style <info:foo#bar_baz>
7481     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7482      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7483     ;; Info KDE style <info:(foo)bar baz>
7484     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7485      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7486     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7487      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7488     ("\\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,]*\\)\\)?"
7489      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7490      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7491     ;; This is custom
7492     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7493      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7494     ;; Emacs help commands
7495     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7496      ;; regexp doesn't match arguments containing ` '.
7497      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7498     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7499      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7500     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7501      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7502     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7503      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7504     ;; The following entries may lead to many false positives so don't enable
7505     ;; them by default (use a high button level).
7506     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7507      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7508      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7509     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7510      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7511     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7512      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7513     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7514      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7515     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7516      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7517     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7518      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7519     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7520      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7521     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7522      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7523     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7524      ;; Unlike the other regexps we really have to require quoting
7525      ;; here to determine where it ends.
7526      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7527     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7528     ("<URL: *\\([^\n<>]*\\)>"
7529      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7530     ;; RFC 2396 (2.4.3., delims) ...
7531     ("\"URL: *\\([^\n\"]*\\)\""
7532      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7533     ;; Raw URLs.
7534     (gnus-button-url-regexp
7535      0 (>= gnus-button-browse-level 0) browse-url 0)
7536     ;; man pages
7537     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7538      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7539      gnus-button-handle-man 1)
7540     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7541     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7542      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7543      gnus-button-handle-man 1)
7544     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7545     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7546     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7547      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7548     ;; Recognizing patches to .el files.  This is somewhat obscure,
7549     ;; but considering the percentage of Gnus users who hack Emacs
7550     ;; Lisp files...
7551     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7552      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7553     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7554      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7555     ;; MID or mail: To avoid too many false positives we don't try to catch
7556     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7557     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7558     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7559     ;; so that non-ambiguous entries (see above) match first.
7560     (gnus-button-mid-or-mail-regexp
7561      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7562   "*Alist of regexps matching buttons in article bodies.
7563
7564 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7565 REGEXP: is the string (case insensitive) matching text around the button (can
7566 also be Lisp expression evaluating to a string),
7567 BUTTON: is the number of the regexp grouping actually matching the button,
7568 FORM: is a Lisp expression which must eval to true for the button to
7569 be added,
7570 CALLBACK: is the function to call when the user push this button, and each
7571 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7572
7573 CALLBACK can also be a variable, in that case the value of that
7574 variable it the real callback function."
7575   :group 'gnus-article-buttons
7576   :type '(repeat (list (choice regexp variable sexp)
7577                        (integer :tag "Button")
7578                        (sexp :tag "Form")
7579                        (function :tag "Callback")
7580                        (repeat :tag "Par"
7581                                :inline t
7582                                (integer :tag "Regexp group")))))
7583 (put 'gnus-button-alist 'risky-local-variable t)
7584
7585 (defcustom gnus-header-button-alist
7586   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7587      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7588     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7589      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7590     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7591      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7592     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7593      0 (>= gnus-button-browse-level 0) browse-url 0)
7594     ("^Subject:" gnus-button-url-regexp
7595      0 (>= gnus-button-browse-level 0) browse-url 0)
7596     ("^[^:]+:" gnus-button-url-regexp
7597      0 (>= gnus-button-browse-level 0) browse-url 0)
7598     ("^OpenPGP:.*url=" gnus-button-url-regexp
7599      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7600     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7601      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7602     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7603      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7604   "*Alist of headers and regexps to match buttons in article heads.
7605
7606 This alist is very similar to `gnus-button-alist', except that each
7607 alist has an additional HEADER element first in each entry:
7608
7609 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7610
7611 HEADER is a regexp to match a header.  For a fuller explanation, see
7612 `gnus-button-alist'."
7613   :group 'gnus-article-buttons
7614   :group 'gnus-article-headers
7615   :type '(repeat (list (regexp :tag "Header")
7616                        (choice regexp variable)
7617                        (integer :tag "Button")
7618                        (sexp :tag "Form")
7619                        (function :tag "Callback")
7620                        (repeat :tag "Par"
7621                                :inline t
7622                                (integer :tag "Regexp group")))))
7623 (put 'gnus-header-button-alist 'risky-local-variable t)
7624
7625 ;;; Commands:
7626
7627 (defun gnus-article-push-button (event)
7628   "Check text under the mouse pointer for a callback function.
7629 If the text under the mouse pointer has a `gnus-callback' property,
7630 call it with the value of the `gnus-data' text property."
7631   (interactive "e")
7632   (set-buffer (window-buffer (posn-window (event-start event))))
7633   (let* ((pos (posn-point (event-start event)))
7634          (data (get-text-property pos 'gnus-data))
7635          (fun (get-text-property pos 'gnus-callback)))
7636     (goto-char pos)
7637     (when fun
7638       (funcall fun data))))
7639
7640 (defun gnus-article-press-button ()
7641   "Check text at point for a callback function.
7642 If the text at point has a `gnus-callback' property,
7643 call it with the value of the `gnus-data' text property."
7644   (interactive)
7645   (let ((data (get-text-property (point) 'gnus-data))
7646         (fun (get-text-property (point) 'gnus-callback)))
7647     (when fun
7648       (funcall fun data))))
7649
7650 (defun gnus-article-highlight (&optional force)
7651   "Highlight current article.
7652 This function calls `gnus-article-highlight-headers',
7653 `gnus-article-highlight-citation',
7654 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7655 do the highlighting.  See the documentation for those functions."
7656   (interactive (list 'force))
7657   (gnus-article-highlight-headers)
7658   (gnus-article-highlight-citation force)
7659   (gnus-article-highlight-signature)
7660   (gnus-article-add-buttons force)
7661   (gnus-article-add-buttons-to-head))
7662
7663 (defun gnus-article-highlight-some (&optional force)
7664   "Highlight current article.
7665 This function calls `gnus-article-highlight-headers',
7666 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7667 do the highlighting.  See the documentation for those functions."
7668   (interactive (list 'force))
7669   (gnus-article-highlight-headers)
7670   (gnus-article-highlight-signature)
7671   (gnus-article-add-buttons))
7672
7673 (defun gnus-article-highlight-headers ()
7674   "Highlight article headers as specified by `gnus-header-face-alist'."
7675   (interactive)
7676   (gnus-with-article-headers
7677     (let (regexp header-face field-face from hpoints fpoints)
7678       (dolist (entry gnus-header-face-alist)
7679         (goto-char (point-min))
7680         (setq regexp (concat "^\\("
7681                              (if (string-equal "" (nth 0 entry))
7682                                  "[^\t ]"
7683                                (nth 0 entry))
7684                              "\\)")
7685               header-face (nth 1 entry)
7686               field-face (nth 2 entry))
7687         (while (and (re-search-forward regexp nil t)
7688                     (not (eobp)))
7689           (beginning-of-line)
7690           (setq from (point))
7691           (unless (search-forward ":" nil t)
7692             (forward-char 1))
7693           (when (and header-face
7694                      (not (memq (point) hpoints)))
7695             (push (point) hpoints)
7696             (gnus-put-text-property from (point) 'face header-face))
7697           (when (and field-face
7698                      (not (memq (setq from (point)) fpoints)))
7699             (push from fpoints)
7700             (if (re-search-forward "^[^ \t]" nil t)
7701                 (forward-char -2)
7702               (goto-char (point-max)))
7703             (gnus-put-text-property from (point) 'face field-face)))))))
7704
7705 (defun gnus-article-highlight-signature ()
7706   "Highlight the signature in an article.
7707 It does this by highlighting everything after
7708 `gnus-signature-separator' using the face `gnus-signature'."
7709   (interactive)
7710   (gnus-with-article-buffer
7711     (let ((inhibit-point-motion-hooks t))
7712       (save-restriction
7713         (when (and gnus-signature-face
7714                    (gnus-article-narrow-to-signature))
7715           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7716                             'face gnus-signature-face)
7717           (widen)
7718           (gnus-article-search-signature)
7719           (let ((start (match-beginning 0))
7720                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7721             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7722                                      end)))))))
7723
7724 (defun gnus-button-in-region-p (b e prop)
7725   "Say whether PROP exists in the region."
7726   (text-property-not-all b e prop nil))
7727
7728 (defun gnus-article-add-buttons (&optional force)
7729   "Find external references in the article and make buttons of them.
7730 \"External references\" are things like Message-IDs and URLs, as
7731 specified by `gnus-button-alist'."
7732   (interactive (list 'force))
7733   (gnus-with-article-buffer
7734     (let ((inhibit-point-motion-hooks t)
7735           (case-fold-search t)
7736           (alist gnus-button-alist)
7737           beg entry regexp)
7738       ;; Remove all old markers.
7739       (let (marker entry new-list)
7740         (while (setq marker (pop gnus-button-marker-list))
7741           (if (or (< marker (point-min)) (>= marker (point-max)))
7742               (push marker new-list)
7743             (goto-char marker)
7744             (when (setq entry (gnus-button-entry))
7745               (put-text-property (match-beginning (nth 1 entry))
7746                                  (match-end (nth 1 entry))
7747                                  'gnus-callback nil))
7748             (set-marker marker nil)))
7749         (setq gnus-button-marker-list new-list))
7750       ;; We skip the headers.
7751       (article-goto-body)
7752       (setq beg (point))
7753       (while (setq entry (pop alist))
7754         (setq regexp (eval (car entry)))
7755         (goto-char beg)
7756         (while (re-search-forward regexp nil t)
7757           (let ((start (match-beginning (nth 1 entry)))
7758                 (end (match-end (nth 1 entry)))
7759                 (from (match-beginning 0)))
7760             (when (and (or (eq t (nth 2 entry))
7761                            (eval (nth 2 entry)))
7762                        (not (gnus-button-in-region-p
7763                              start end 'gnus-callback)))
7764               ;; That optional form returned non-nil, so we add the
7765               ;; button.
7766               (setq from (set-marker (make-marker) from))
7767               (push from gnus-button-marker-list)
7768               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7769                            (gnus-article-extend-url-button from start end))
7770                 (gnus-article-add-button start end
7771                                          'gnus-button-push from)
7772                 (gnus-put-text-property
7773                  start end
7774                  'gnus-string (buffer-substring-no-properties
7775                                start end))))))))))
7776
7777 (defun gnus-article-extend-url-button (beg start end)
7778   "Extend url button if url is folded into two or more lines.
7779 Return non-nil if button is extended.  BEG is a marker that points to
7780 the beginning position of a text containing url.  START and END are
7781 the endpoints of a url button before it is extended.  The concatenated
7782 url is put as the `gnus-button-url' overlay property on the button."
7783   (let ((opoint (point))
7784         (points (list start end))
7785         url delim regexp)
7786     (prog1
7787         (when (and (progn
7788                      (goto-char end)
7789                      (not (looking-at "[\t ]*[\">]")))
7790                    (progn
7791                      (goto-char start)
7792                      (string-match
7793                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7794                       (buffer-substring (point-at-bol) start)))
7795                    (progn
7796                      (setq url (list (buffer-substring start end))
7797                            delim (if (match-beginning 1) ">" "\""))
7798                      (beginning-of-line)
7799                      (setq regexp (concat
7800                                    (when (and (looking-at
7801                                                message-cite-prefix-regexp)
7802                                               (< (match-end 0) start))
7803                                      (regexp-quote (match-string 0)))
7804                                    "\
7805 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7806                                    delim "\\)"))
7807                      (while (progn
7808                               (forward-line 1)
7809                               (and (looking-at regexp)
7810                                    (prog1
7811                                        (match-beginning 1)
7812                                      (push (or (match-string 2)
7813                                                (match-string 1))
7814                                            url)
7815                                      (push (setq end (or (match-end 2)
7816                                                          (match-end 1)))
7817                                            points)
7818                                      (push (or (match-beginning 2)
7819                                                (match-beginning 1))
7820                                            points)))))
7821                      (match-beginning 2)))
7822           (let (gnus-article-mouse-face widget-mouse-face)
7823             (while points
7824               (gnus-article-add-button (pop points) (pop points)
7825                                        'gnus-button-push beg)))
7826           (let ((overlay (gnus-make-overlay start end)))
7827             (gnus-overlay-put overlay 'evaporate t)
7828             (gnus-overlay-put overlay 'gnus-button-url
7829                               (list (mapconcat 'identity (nreverse url) "")))
7830             (when gnus-article-mouse-face
7831               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7832           t)
7833       (goto-char opoint))))
7834
7835 ;; Add buttons to the head of an article.
7836 (defun gnus-article-add-buttons-to-head ()
7837   "Add buttons to the head of the article."
7838   (interactive)
7839   (gnus-with-article-headers
7840     (let (beg end)
7841       (dolist (entry gnus-header-button-alist)
7842         ;; Each alist entry.
7843         (goto-char (point-min))
7844         (while (re-search-forward (car entry) nil t)
7845           ;; Each header matching the entry.
7846           (setq beg (match-beginning 0))
7847           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7848                              (match-beginning 0))
7849                         (point-max)))
7850           (goto-char beg)
7851           (while (re-search-forward (eval (nth 1 entry)) end t)
7852             ;; Each match within a header.
7853             (let* ((entry (cdr entry))
7854                    (start (match-beginning (nth 1 entry)))
7855                    (end (match-end (nth 1 entry)))
7856                    (form (nth 2 entry)))
7857               (goto-char (match-end 0))
7858               (when (eval form)
7859                 (gnus-article-add-button
7860                  start end (nth 3 entry)
7861                  (buffer-substring (match-beginning (nth 4 entry))
7862                                    (match-end (nth 4 entry)))))))
7863           (goto-char end))))))
7864
7865 ;;; External functions:
7866
7867 (defun gnus-article-add-button (from to fun &optional data text)
7868   "Create a button between FROM and TO with callback FUN and data DATA."
7869   (when gnus-article-button-face
7870     (gnus-overlay-put (gnus-make-overlay from to nil t)
7871                       'face gnus-article-button-face))
7872   (gnus-add-text-properties
7873    from to
7874    (nconc (and gnus-article-mouse-face
7875                (list gnus-mouse-face-prop gnus-article-mouse-face))
7876           (list 'gnus-callback fun)
7877           (and data (list 'gnus-data data))))
7878   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7879                          :help-echo (or text "Follow the link")
7880                          :keymap gnus-url-button-map
7881                          :button-keymap gnus-widget-button-keymap))
7882
7883 (defun gnus-article-copy-string ()
7884   "Copy the string in the button to the kill ring."
7885   (interactive)
7886   (gnus-article-check-buffer)
7887   (let ((data (get-text-property (point) 'gnus-string)))
7888     (when data
7889       (with-temp-buffer
7890         (insert data)
7891         (copy-region-as-kill (point-min) (point-max))
7892         (message "Copied %s" data)))))
7893
7894 ;;; Internal functions:
7895
7896 (defun gnus-article-set-globals ()
7897   (with-current-buffer gnus-summary-buffer
7898     (gnus-set-global-variables)))
7899
7900 (defun gnus-signature-toggle (end)
7901   (gnus-with-article-buffer
7902     (let ((inhibit-point-motion-hooks t))
7903       (if (text-property-any end (point-max) 'article-type 'signature)
7904           (progn
7905             (gnus-delete-wash-type 'signature)
7906             (gnus-remove-text-properties-when
7907              'article-type 'signature end (point-max)
7908              (cons 'article-type (cons 'signature
7909                                        gnus-hidden-properties))))
7910         (gnus-add-wash-type 'signature)
7911         (gnus-add-text-properties-when
7912          'article-type nil end (point-max)
7913          (cons 'article-type (cons 'signature
7914                                    gnus-hidden-properties)))))
7915     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7916       (gnus-set-mode-line 'article))))
7917
7918 (defun gnus-button-entry ()
7919   ;; Return the first entry in `gnus-button-alist' matching this place.
7920   (let ((alist gnus-button-alist)
7921         (entry nil))
7922     (while alist
7923       (setq entry (pop alist))
7924       (if (looking-at (eval (car entry)))
7925           (setq alist nil)
7926         (setq entry nil)))
7927     entry))
7928
7929 (defun gnus-button-push (marker)
7930   ;; Push button starting at MARKER.
7931   (save-excursion
7932     (goto-char marker)
7933     (let* ((entry (gnus-button-entry))
7934            (inhibit-point-motion-hooks t)
7935            (fun (nth 3 entry))
7936            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7937                           (get-char-property marker 'gnus-button-url))
7938                      (mapcar (lambda (group)
7939                                (let ((string (match-string group)))
7940                                  (set-text-properties
7941                                   0 (length string) nil string)
7942                                  string))
7943                              (nthcdr 4 entry)))))
7944       (cond
7945        ((fboundp fun)
7946         (apply fun args))
7947        ((and (boundp fun)
7948              (fboundp (symbol-value fun)))
7949         (apply (symbol-value fun) args))
7950        (t
7951         (gnus-message 1 "You must define `%S' to use this button"
7952                       (cons fun args)))))))
7953
7954 (defun gnus-parse-news-url (url)
7955   (let (scheme server port group message-id articles)
7956     (with-temp-buffer
7957       (insert url)
7958       (goto-char (point-min))
7959       (when (looking-at "\\([A-Za-z]+\\):")
7960         (setq scheme (match-string 1))
7961         (goto-char (match-end 0)))
7962       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7963         (setq server (match-string 1))
7964         (setq port (if (stringp (match-string 3))
7965                        (string-to-number (match-string 3))
7966                      (match-string 3)))
7967         (goto-char (match-end 0)))
7968
7969       (cond
7970        ((looking-at "\\(.*@.*\\)")
7971         (setq message-id (match-string 1)))
7972        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7973         (setq group (match-string 1)
7974               articles (split-string (match-string 2) "-")))
7975        ((looking-at "\\([^/]+\\)/?")
7976         (setq group (match-string 1)))
7977        (t
7978         (error "Unknown news URL syntax"))))
7979     (list scheme server port group message-id articles)))
7980
7981 (defun gnus-button-handle-news (url)
7982   "Fetch a news URL."
7983   (destructuring-bind (scheme server port group message-id articles)
7984       (gnus-parse-news-url url)
7985     (cond
7986      (message-id
7987       (with-current-buffer gnus-summary-buffer
7988         (if server
7989             (let ((gnus-refer-article-method
7990                    (nconc (list (list 'nntp server))
7991                           gnus-refer-article-method))
7992                   (nntp-port-number (or port "nntp")))
7993               (gnus-message 7 "Fetching %s with %s"
7994                             message-id gnus-refer-article-method)
7995               (gnus-summary-refer-article message-id))
7996           (gnus-summary-refer-article message-id))))
7997      (group
7998       (gnus-button-fetch-group url)))))
7999
8000 (defun gnus-button-patch (library line)
8001   "Visit an Emacs Lisp library LIBRARY on line LINE."
8002   (interactive)
8003   (let ((file (locate-library (file-name-nondirectory library))))
8004     (unless file
8005       (error "Couldn't find library %s" library))
8006     (find-file file)
8007     (goto-char (point-min))
8008     (forward-line (1- (string-to-number line)))))
8009
8010 (defun gnus-button-handle-man (url)
8011   "Fetch a man page."
8012   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8013   (when (eq gnus-button-man-handler 'woman)
8014     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
8015   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8016   (funcall gnus-button-man-handler url))
8017
8018 (defun gnus-button-handle-info-url (url)
8019   "Fetch an info URL."
8020   (setq url (mm-subst-char-in-string ?+ ?\  url))
8021   (cond
8022    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
8023     (gnus-info-find-node
8024      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
8025                      "Gnus")
8026              ")" (gnus-url-unhex-string (match-string 2 url)))))
8027    ((string-match "([^)\"]+)[^\"]+" url)
8028     (setq url
8029           (gnus-replace-in-string
8030            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8031     (gnus-info-find-node url))
8032    (t (error "Can't parse %s" url))))
8033
8034 (defun gnus-button-handle-info-url-gnome (url)
8035   "Fetch GNOME style info URL."
8036   (setq url (mm-subst-char-in-string ?_ ?\  url))
8037   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8038       (gnus-info-find-node
8039        (concat "("
8040                (gnus-url-unhex-string
8041                  (match-string 1 url))
8042                ")"
8043                (or (gnus-url-unhex-string
8044                     (match-string 2 url))
8045                    "Top")))
8046     (error "Can't parse %s" url)))
8047
8048 (defun gnus-button-handle-info-url-kde (url)
8049   "Fetch KDE style info URL."
8050   (gnus-info-find-node (gnus-url-unhex-string url)))
8051
8052 ;; (info) will autoload info.el
8053 (declare-function Info-menu "info" (menu-item &optional fork))
8054 (declare-function Info-index-next "info" (num))
8055
8056 (defun gnus-button-handle-info-keystrokes (url)
8057   "Call `info' when pushing the corresponding URL button."
8058   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8059   (let (node indx comma)
8060     (if (string-match
8061          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8062                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8063                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
8064                  "\\(?:[ \t\n,]*\\)\\)?")
8065          url)
8066         (setq node (match-string 2 url)
8067               indx (match-string 3 url))
8068       (error "Can't parse %s" url))
8069     (info)
8070     (Info-directory)
8071     (Info-menu node)
8072     (when (> (length indx) 0)
8073       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8074                             "\\([ \t\n,]*\\)")
8075                     indx)
8076       (setq comma (match-string 2 indx))
8077       (setq indx  (match-string 1 indx))
8078       (Info-index indx)
8079       (when comma
8080         (dotimes (i (with-temp-buffer
8081                       (insert comma)
8082                       ;; Note: the XEmacs version of `how-many' takes
8083                       ;; no optional argument.
8084                       (goto-char (point-min))
8085                       (how-many ",")))
8086           (Info-index-next 1)))
8087       nil)))
8088
8089 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8090 (declare-function pgg-display-output-buffer "pgg" (start end status))
8091
8092 (defun gnus-button-openpgp (url)
8093   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8094   (with-temp-buffer
8095     (mm-url-insert-file-contents-external url)
8096     (pgg-snarf-keys-region (point-min) (point-max))
8097     (pgg-display-output-buffer nil nil nil)))
8098
8099 (defun gnus-button-message-id (message-id)
8100   "Fetch MESSAGE-ID."
8101   (with-current-buffer gnus-summary-buffer
8102     (gnus-summary-refer-article message-id)))
8103
8104 (defun gnus-button-fetch-group (address &rest ignore)
8105   "Fetch GROUP specified by ADDRESS."
8106   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8107                       address)
8108     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8109     ;; for nntp:// and news://
8110     (setq address (match-string 3 address)))
8111   (if (not (string-match "[:/]" address))
8112       ;; This is just a simple group url.
8113       (gnus-group-read-ephemeral-group address gnus-select-method)
8114     (if (not
8115          (string-match
8116           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8117           address))
8118         (error "Can't parse %s" address)
8119       (gnus-group-read-ephemeral-group
8120        (match-string 4 address)
8121        `(nntp ,(match-string 1 address)
8122               (nntp-address ,(match-string 1 address))
8123               (nntp-port-number ,(if (match-end 3)
8124                                      (match-string 3 address)
8125                                    "nntp")))
8126        nil nil nil
8127        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8128
8129 (defun gnus-url-parse-query-string (query &optional downcase)
8130   (let (retval pairs cur key val)
8131     (setq pairs (split-string query "&"))
8132     (while pairs
8133       (setq cur (car pairs)
8134             pairs (cdr pairs))
8135       (if (not (string-match "=" cur))
8136           nil                           ; Grace
8137         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8138               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8139         (if downcase
8140             (setq key (downcase key)))
8141         (setq cur (assoc key retval))
8142         (if cur
8143             (setcdr cur (cons val (cdr cur)))
8144           (setq retval (cons (list key val) retval)))))
8145     retval))
8146
8147 (defun gnus-url-mailto (url)
8148   ;; Send mail to someone
8149   (when (string-match "mailto:/*\\(.*\\)" url)
8150     (setq url (substring url (match-beginning 1) nil)))
8151   (let (to args subject func)
8152     (setq args (gnus-url-parse-query-string
8153                 (if (string-match "^\\?" url)
8154                     (substring url 1)
8155                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8156                       (concat "to=" (match-string 1 url) "&"
8157                               (match-string 2 url))
8158                     (concat "to=" url)))
8159                 t)
8160           subject (cdr-safe (assoc "subject" args)))
8161     (gnus-msg-mail)
8162     (while args
8163       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8164       (if (fboundp func)
8165           (funcall func)
8166         (message-position-on-field (caar args)))
8167       (insert (gnus-replace-in-string
8168                (mapconcat 'identity (reverse (cdar args)) ", ")
8169                "\r\n" "\n" t))
8170       (setq args (cdr args)))
8171     (if subject
8172         (message-goto-body)
8173       (message-goto-subject))))
8174
8175 (defun gnus-button-embedded-url (address)
8176   "Activate ADDRESS with `browse-url'."
8177   (browse-url (gnus-strip-whitespace address)))
8178
8179 ;;; Next/prev buttons in the article buffer.
8180
8181 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8182 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8183
8184 (defvar gnus-prev-page-map
8185   (let ((map (make-sparse-keymap)))
8186     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8187     (define-key map "\r" 'gnus-button-prev-page)
8188     map))
8189
8190 (defvar gnus-next-page-map
8191   (let ((map (make-sparse-keymap)))
8192     (define-key map gnus-mouse-2 'gnus-button-next-page)
8193     (define-key map "\r" 'gnus-button-next-page)
8194     map))
8195
8196 (defun gnus-insert-prev-page-button ()
8197   (let ((b (point)) e
8198         (inhibit-read-only t))
8199     (gnus-eval-format
8200      gnus-prev-page-line-format nil
8201      `(keymap ,gnus-prev-page-map
8202               gnus-prev t
8203               gnus-callback gnus-article-button-prev-page
8204               article-type annotation))
8205     (setq e (if (bolp)
8206                 ;; Exclude a newline.
8207                 (1- (point))
8208               (point)))
8209     (when gnus-article-button-face
8210       (gnus-overlay-put (gnus-make-overlay b e nil t)
8211                         'face gnus-article-button-face))
8212     (widget-convert-button
8213      'link b e
8214      :action 'gnus-button-prev-page
8215      :button-keymap gnus-prev-page-map)))
8216
8217 (defun gnus-button-next-page (&optional args more-args)
8218   "Go to the next page."
8219   (interactive)
8220   (let ((win (selected-window)))
8221     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8222     (gnus-article-next-page)
8223     (select-window win)))
8224
8225 (defun gnus-button-prev-page (&optional args more-args)
8226   "Go to the prev page."
8227   (interactive)
8228   (let ((win (selected-window)))
8229     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8230     (gnus-article-prev-page)
8231     (select-window win)))
8232
8233 (defun gnus-insert-next-page-button ()
8234   (let ((b (point)) e
8235         (inhibit-read-only t))
8236     (gnus-eval-format gnus-next-page-line-format nil
8237                       `(keymap ,gnus-next-page-map
8238                                gnus-next t
8239                                gnus-callback gnus-article-button-next-page
8240                                article-type annotation))
8241     (setq e (if (bolp)
8242                 ;; Exclude a newline.
8243                 (1- (point))
8244               (point)))
8245     (when gnus-article-button-face
8246       (gnus-overlay-put (gnus-make-overlay b e nil t)
8247                         'face gnus-article-button-face))
8248     (widget-convert-button
8249      'link b e
8250      :action 'gnus-button-next-page
8251      :button-keymap gnus-next-page-map)))
8252
8253 (defun gnus-article-button-next-page (arg)
8254   "Go to the next page."
8255   (interactive "P")
8256   (let ((win (selected-window)))
8257     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8258     (gnus-article-next-page)
8259     (select-window win)))
8260
8261 (defun gnus-article-button-prev-page (arg)
8262   "Go to the prev page."
8263   (interactive "P")
8264   (let ((win (selected-window)))
8265     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8266     (gnus-article-prev-page)
8267     (select-window win)))
8268
8269 (defvar gnus-decode-header-methods
8270   '(mail-decode-encoded-word-region)
8271   "List of methods used to decode headers.
8272
8273 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8274 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8275 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8276 whose names match REGEXP.
8277
8278 For example:
8279 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8280  mail-decode-encoded-word-region
8281  (\"chinese\" . rfc1843-decode-region))
8282 ")
8283
8284 (defvar gnus-decode-header-methods-cache nil)
8285
8286 (defun gnus-multi-decode-header (start end)
8287   "Apply the functions from `gnus-encoded-word-methods' that match."
8288   (unless (and gnus-decode-header-methods-cache
8289                (eq gnus-newsgroup-name
8290                    (car gnus-decode-header-methods-cache)))
8291     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8292     (dolist (x gnus-decode-header-methods)
8293       (if (symbolp x)
8294           (nconc gnus-decode-header-methods-cache (list x))
8295         (if (and gnus-newsgroup-name
8296                  (string-match (car x) gnus-newsgroup-name))
8297             (nconc gnus-decode-header-methods-cache
8298                    (list (cdr x)))))))
8299   (let ((xlist gnus-decode-header-methods-cache))
8300     (pop xlist)
8301     (save-restriction
8302       (narrow-to-region start end)
8303       (while xlist
8304         (funcall (pop xlist) (point-min) (point-max))))))
8305
8306 ;;;
8307 ;;; Treatment top-level handling.
8308 ;;;
8309
8310 (defun gnus-treat-article (condition &optional part-number total-parts type)
8311   (let ((length (- (point-max) (point-min)))
8312         (alist gnus-treatment-function-alist)
8313         (article-goto-body-goes-to-point-min-p t)
8314         (treated-type
8315          (or (not type)
8316              (catch 'found
8317                (let ((list gnus-article-treat-types))
8318                  (while list
8319                    (when (string-match (pop list) type)
8320                      (throw 'found t)))))))
8321         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8322         val elem)
8323     (gnus-run-hooks 'gnus-part-display-hook)
8324     (dolist (elem alist)
8325       (setq val
8326             (save-excursion
8327               (when (gnus-buffer-live-p gnus-summary-buffer)
8328                 (set-buffer gnus-summary-buffer))
8329               (symbol-value (car elem))))
8330       (when (and (or (consp val)
8331                      treated-type)
8332                  (gnus-treat-predicate val)
8333                  (or (not (get (car elem) 'highlight))
8334                      highlightp))
8335         (save-restriction
8336           (funcall (cadr elem)))))))
8337
8338 ;; Dynamic variables.
8339 (defvar part-number)
8340 (defvar total-parts)
8341 (defvar type)
8342 (defvar condition)
8343 (defvar length)
8344
8345 (defun gnus-treat-predicate (val)
8346   (cond
8347    ((null val)
8348     nil)
8349    (condition
8350     (eq condition val))
8351    ((and (listp val)
8352          (stringp (car val)))
8353     (apply 'gnus-or (mapcar `(lambda (s)
8354                                (string-match s ,(or gnus-newsgroup-name "")))
8355                             val)))
8356    ((listp val)
8357     (let ((pred (pop val)))
8358       (cond
8359        ((eq pred 'or)
8360         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8361        ((eq pred 'and)
8362         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8363        ((eq pred 'not)
8364         (not (gnus-treat-predicate (car val))))
8365        ((eq pred 'typep)
8366         (equal (car val) type))
8367        (t
8368         (error "%S is not a valid predicate" pred)))))
8369    ((eq val t)
8370     t)
8371    ((eq val 'head)
8372     nil)
8373    ((eq val 'first)
8374     (eq part-number 1))
8375    ((eq val 'last)
8376     (eq part-number total-parts))
8377    ((numberp val)
8378     (< length val))
8379    (t
8380     (error "%S is not a valid value" val))))
8381
8382 (defun gnus-article-encrypt-body (protocol &optional n)
8383   "Encrypt the article body."
8384   (interactive
8385    (list
8386     (or gnus-article-encrypt-protocol
8387         (gnus-completing-read "Encrypt protocol"
8388                               (mapcar 'car gnus-article-encrypt-protocol-alist)
8389                               t))
8390     current-prefix-arg))
8391   ;; User might hit `K E' instead of `K e', so prompt once.
8392   (when (and gnus-article-encrypt-protocol
8393              gnus-novice-user)
8394     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8395       (error "Encrypt aborted")))
8396   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8397     (unless func
8398       (error "Can't find the encrypt protocol %s" protocol))
8399     (if (member gnus-newsgroup-name '("nndraft:delayed"
8400                                       "nndraft:drafts"
8401                                       "nndraft:queue"))
8402         (error "Can't encrypt the article in group %s"
8403                gnus-newsgroup-name))
8404     (gnus-summary-iterate n
8405       (with-current-buffer gnus-summary-buffer
8406         (let ((mail-parse-charset gnus-newsgroup-charset)
8407               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8408               (summary-buffer gnus-summary-buffer)
8409               references point)
8410           (gnus-set-global-variables)
8411           (when (gnus-group-read-only-p)
8412             (error "The current newsgroup does not support article encrypt"))
8413           (gnus-summary-show-article t)
8414           (setq references
8415               (or (mail-header-references gnus-current-headers) ""))
8416           (set-buffer gnus-article-buffer)
8417           (let* ((inhibit-read-only t)
8418                  (headers
8419                   (mapcar (lambda (field)
8420                             (and (save-restriction
8421                                    (message-narrow-to-head)
8422                                    (goto-char (point-min))
8423                                    (search-forward field nil t))
8424                                  (prog2
8425                                      (message-narrow-to-field)
8426                                      (buffer-string)
8427                                    (delete-region (point-min) (point-max))
8428                                    (widen))))
8429                           '("Content-Type:" "Content-Transfer-Encoding:"
8430                             "Content-Disposition:"))))
8431             (message-narrow-to-head)
8432             (message-remove-header "MIME-Version")
8433             (goto-char (point-max))
8434             (setq point (point))
8435             (insert (apply 'concat headers))
8436             (widen)
8437             (narrow-to-region point (point-max))
8438             (let ((message-options message-options))
8439               (message-options-set 'message-sender user-mail-address)
8440               (message-options-set 'message-recipients user-mail-address)
8441               (message-options-set 'message-sign-encrypt 'not)
8442               (funcall func))
8443             (goto-char (point-min))
8444             (insert "MIME-Version: 1.0\n")
8445             (widen)
8446             (gnus-summary-edit-article-done
8447              references nil summary-buffer t))
8448           (when gnus-keep-backlog
8449             (gnus-backlog-remove-article
8450              (car gnus-article-current) (cdr gnus-article-current)))
8451           (gnus-flush-original-article-buffer)
8452           (when gnus-use-cache
8453             (gnus-cache-update-article
8454              (car gnus-article-current) (cdr gnus-article-current))))))))
8455
8456 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8457   "The following specs can be used:
8458 %t  The security MIME type
8459 %i  Additional info
8460 %d  Details
8461 %D  Details if button is pressed")
8462
8463 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8464   "The following specs can be used:
8465 %t  The security MIME type
8466 %i  Additional info
8467 %d  Details
8468 %D  Details if button is pressed")
8469
8470 (defvar gnus-mime-security-button-line-format-alist
8471   '((?t gnus-tmp-type ?s)
8472     (?i gnus-tmp-info ?s)
8473     (?d gnus-tmp-details ?s)
8474     (?D gnus-tmp-pressed-details ?s)))
8475
8476 (defvar gnus-mime-security-button-commands
8477   '((gnus-article-press-button "\r" "Show Detail")
8478     (undefined "v")
8479     (undefined "t")
8480     (undefined "C")
8481     (gnus-mime-security-save-part "o" "Save...")
8482     (undefined "\C-o")
8483     (undefined "r")
8484     (undefined "d")
8485     (undefined "c")
8486     (undefined "i")
8487     (undefined "E")
8488     (undefined "e")
8489     (undefined "p")
8490     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8491     (undefined ".")))
8492
8493 (defvar gnus-mime-security-button-map
8494   (let ((map (make-sparse-keymap)))
8495     (define-key map gnus-mouse-2 'gnus-article-push-button)
8496     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8497     (dolist (c gnus-mime-security-button-commands)
8498       (define-key map (cadr c) (car c)))
8499     map))
8500
8501 (easy-menu-define
8502   gnus-mime-security-button-menu gnus-mime-security-button-map
8503   "Security button menu."
8504   `("Security Part"
8505     ,@(delq nil
8506             (mapcar (lambda (c)
8507                       (unless (eq (car c) 'undefined)
8508                         (vector (caddr c) (car c) :active t)))
8509                     gnus-mime-security-button-commands))))
8510
8511 (defun gnus-mime-security-button-menu (event prefix)
8512   "Construct a context-sensitive menu of security commands."
8513   (interactive "e\nP")
8514   (save-window-excursion
8515     (let ((pos (event-start event)))
8516       (select-window (posn-window pos))
8517       (goto-char (posn-point pos))
8518       (gnus-article-check-buffer)
8519       (popup-menu gnus-mime-security-button-menu nil prefix))))
8520
8521 (defvar gnus-mime-security-details-buffer nil)
8522
8523 (defvar gnus-mime-security-button-pressed nil)
8524
8525 (defvar gnus-mime-security-show-details-inline t
8526   "If non-nil, show details in the article buffer.")
8527
8528 (defun gnus-mime-security-verify-or-decrypt (handle)
8529   (mm-remove-parts (cdr handle))
8530   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8531         point (inhibit-read-only t))
8532     (if region
8533         (goto-char (car region)))
8534     (setq point (point))
8535     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8536       (let* ((mm-verify-option 'known)
8537              (mm-decrypt-option 'known)
8538              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8539         (unless (eq nparts (cdr handle))
8540           (mm-destroy-parts (cdr handle))
8541           (setcdr handle nparts))))
8542     (gnus-mime-display-security handle)
8543     (when region
8544       (delete-region (point) (cdr region))
8545       (set-marker (car region) nil)
8546       (set-marker (cdr region) nil))
8547     (goto-char point)))
8548
8549 (defun gnus-mime-security-show-details (handle)
8550   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8551     (if (not details)
8552         (gnus-message 5 "No details.")
8553       (if gnus-mime-security-show-details-inline
8554           (let ((gnus-mime-security-button-pressed
8555                  (not (get-text-property (point) 'gnus-mime-details)))
8556                 (gnus-mime-security-button-line-format
8557                  (get-text-property (point) 'gnus-line-format))
8558                 (inhibit-read-only t))
8559             (forward-char -1)
8560             (while (eq (get-text-property (point) 'gnus-line-format)
8561                        gnus-mime-security-button-line-format)
8562               (forward-char -1))
8563             (forward-char)
8564             (save-restriction
8565               (narrow-to-region (point) (point))
8566               (gnus-insert-mime-security-button handle))
8567             (delete-region (point)
8568                            (or (text-property-not-all
8569                                 (point) (point-max)
8570                                 'gnus-line-format
8571                                 gnus-mime-security-button-line-format)
8572                                (point-max))))
8573         ;; Not inlined.
8574         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8575             (with-current-buffer gnus-mime-security-details-buffer
8576               (erase-buffer)
8577               t)
8578           (setq gnus-mime-security-details-buffer
8579                 (gnus-get-buffer-create "*MIME Security Details*")))
8580         (with-current-buffer gnus-mime-security-details-buffer
8581           (insert details)
8582           (goto-char (point-min)))
8583         (pop-to-buffer gnus-mime-security-details-buffer)))))
8584
8585 (defun gnus-mime-security-press-button (handle)
8586   (save-excursion
8587     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8588         (gnus-mime-security-show-details handle)
8589       (gnus-mime-security-verify-or-decrypt handle))))
8590
8591 (defun gnus-insert-mime-security-button (handle &optional displayed)
8592   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8593          (gnus-tmp-type
8594           (concat
8595            (or (nth 2 (assoc protocol mm-verify-function-alist))
8596                (nth 2 (assoc protocol mm-decrypt-function-alist))
8597                "Unknown")
8598            (if (equal (car handle) "multipart/signed")
8599                " Signed" " Encrypted")
8600            " Part"))
8601          (gnus-tmp-info
8602           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8603               "Undecided"))
8604          (gnus-tmp-details
8605           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8606          gnus-tmp-pressed-details
8607          b e)
8608     (setq gnus-tmp-details
8609           (if gnus-tmp-details
8610               (concat "\n" gnus-tmp-details)
8611             ""))
8612     (setq gnus-tmp-pressed-details
8613           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8614     (unless (bolp)
8615       (insert "\n"))
8616     (setq b (point))
8617     (gnus-eval-format
8618      gnus-mime-security-button-line-format
8619      gnus-mime-security-button-line-format-alist
8620      `(keymap ,gnus-mime-security-button-map
8621          gnus-callback gnus-mime-security-press-button
8622          gnus-line-format ,gnus-mime-security-button-line-format
8623          gnus-mime-details ,gnus-mime-security-button-pressed
8624          article-type annotation
8625          gnus-data ,handle))
8626     (setq e (if (bolp)
8627                 ;; Exclude a newline.
8628                 (1- (point))
8629               (point)))
8630     (when gnus-article-button-face
8631       (gnus-overlay-put (gnus-make-overlay b e nil t)
8632                         'face gnus-article-button-face))
8633     (widget-convert-button
8634      'link b e
8635      :mime-handle handle
8636      :action 'gnus-widget-press-button
8637      :button-keymap gnus-mime-security-button-map
8638      :help-echo
8639      (lambda (widget)
8640        ;; Needed to properly clear the message due to a bug in
8641        ;; wid-edit (XEmacs only).
8642        (when (boundp 'help-echo-owns-message)
8643          (setq help-echo-owns-message t))
8644        (format
8645         "%S: show detail; %S: more options"
8646         (aref gnus-mouse-2 0)
8647         (aref gnus-down-mouse-3 0))))))
8648
8649 (defun gnus-mime-display-security (handle)
8650   (save-restriction
8651     (narrow-to-region (point) (point))
8652     (unless (gnus-unbuttonized-mime-type-p (car handle))
8653       (gnus-insert-mime-security-button handle))
8654     (gnus-mime-display-part (cadr handle))
8655     (unless (bolp)
8656       (insert "\n"))
8657     (unless (gnus-unbuttonized-mime-type-p (car handle))
8658       (let ((gnus-mime-security-button-line-format
8659              gnus-mime-security-button-end-line-format))
8660         (gnus-insert-mime-security-button handle)))
8661     (mm-set-handle-multipart-parameter
8662      handle 'gnus-region
8663      (cons (set-marker (make-marker) (point-min))
8664            (set-marker (make-marker) (point-max))))
8665     (goto-char (point-max))))
8666
8667 (defun gnus-mime-security-run-function (function)
8668   "Run FUNCTION with the security part under point."
8669   (gnus-article-check-buffer)
8670   (let ((data (get-text-property (point) 'gnus-data))
8671         buffer handle)
8672     (when (and (stringp (car-safe data))
8673                (setq buffer (mm-handle-multipart-original-buffer data))
8674                (setq handle (cadr data)))
8675       (if (bufferp (mm-handle-buffer handle))
8676           (progn
8677             (setq handle (cons buffer (copy-sequence (cdr handle))))
8678             (mm-handle-set-undisplayer handle nil))
8679         (setq handle (mm-make-handle
8680                       buffer
8681                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8682                       nil nil nil nil nil nil)))
8683       (funcall function handle))))
8684
8685 (defun gnus-mime-security-save-part ()
8686   "Save the security part under point."
8687   (interactive)
8688   (gnus-mime-security-run-function 'mm-save-part))
8689
8690 (defun gnus-mime-security-pipe-part ()
8691   "Pipe the security part under point to a process."
8692   (interactive)
8693   (gnus-mime-security-run-function 'mm-pipe-part))
8694
8695 (gnus-ems-redefine)
8696
8697 (provide 'gnus-art)
8698
8699 (run-hooks 'gnus-art-load-hook)
8700
8701 ;;; gnus-art.el ends here