gnus-sync.el (gnus-sync): Fix defgroup version.
[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.
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 ;; Avoid the "Recursive load suspected" error in Emacs 21.1.
38 (eval-and-compile
39   (let ((recursive-load-depth-limit 100))
40     (require 'gnus-sum)))
41 (require 'gnus-spec)
42 (require 'gnus-int)
43 (require 'gnus-win)
44 (require 'mm-bodies)
45 (require 'mail-parse)
46 (require 'mm-decode)
47 (require 'mm-view)
48 (require 'wid-edit)
49 (require 'mm-uu)
50 (require 'message)
51
52 (autoload 'gnus-msg-mail "gnus-msg" nil t)
53 (autoload 'gnus-button-mailto "gnus-msg")
54 (autoload 'gnus-button-reply "gnus-msg" nil t)
55 (autoload 'parse-time-string "parse-time" nil nil)
56 (autoload 'ansi-color-apply-on-region "ansi-color")
57 (autoload 'mm-url-insert-file-contents-external "mm-url")
58 (autoload 'mm-extern-cache-contents "mm-extern")
59
60 (defgroup gnus-article nil
61   "Article display."
62   :link '(custom-manual "(gnus)Article Buffer")
63   :group 'gnus)
64
65 (defgroup gnus-article-treat nil
66   "Treating article parts."
67   :link '(custom-manual "(gnus)Article Hiding")
68   :group 'gnus-article)
69
70 (defgroup gnus-article-hiding nil
71   "Hiding article parts."
72   :link '(custom-manual "(gnus)Article Hiding")
73   :group 'gnus-article)
74
75 (defgroup gnus-article-highlight nil
76   "Article highlighting."
77   :link '(custom-manual "(gnus)Article Highlighting")
78   :group 'gnus-article
79   :group 'gnus-visual)
80
81 (defgroup gnus-article-signature nil
82   "Article signatures."
83   :link '(custom-manual "(gnus)Article Signature")
84   :group 'gnus-article)
85
86 (defgroup gnus-article-headers nil
87   "Article headers."
88   :link '(custom-manual "(gnus)Hiding Headers")
89   :group 'gnus-article)
90
91 (defgroup gnus-article-washing nil
92   "Special commands on articles."
93   :link '(custom-manual "(gnus)Article Washing")
94   :group 'gnus-article)
95
96 (defgroup gnus-article-emphasis nil
97   "Fontisizing articles."
98   :link '(custom-manual "(gnus)Article Fontisizing")
99   :group 'gnus-article)
100
101 (defgroup gnus-article-saving nil
102   "Saving articles."
103   :link '(custom-manual "(gnus)Saving Articles")
104   :group 'gnus-article)
105
106 (defgroup gnus-article-mime nil
107   "Worshiping the MIME wonder."
108   :link '(custom-manual "(gnus)Using MIME")
109   :group 'gnus-article)
110
111 (defgroup gnus-article-buttons nil
112   "Pushable buttons in the article buffer."
113   :link '(custom-manual "(gnus)Article Buttons")
114   :group 'gnus-article)
115
116 (defgroup gnus-article-various nil
117   "Other article options."
118   :link '(custom-manual "(gnus)Misc Article")
119   :group 'gnus-article)
120
121 (defcustom gnus-ignored-headers
122   (mapcar
123    (lambda (header)
124      (concat "^" header ":"))
125    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
126      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
127      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
128      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
129      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
130      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
131      "X-Attribution" "X-Originating-IP" "Delivered-To"
132      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
133      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
134      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
135      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
136      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
137      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
138      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
139      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
140      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
141      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
142      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
143      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
144      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
145      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
146      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
147      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
148      "List-[A-Za-z]+" "X-Listprocessor-Version"
149      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
150      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
151      "X-Received" "Content-length" "X-precedence"
152      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
153      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
154      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
155      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
156      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
157      "X-Content-length" "X-Posting-Agent" "Original-Received"
158      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
159      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
160      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
161      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
162      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
163      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
164      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
165      "Envelope-Sender" "Envelope-Recipients"))
166   "*All headers that start with this regexp will be hidden.
167 This variable can also be a list of regexps of headers to be ignored.
168 If `gnus-visible-headers' is non-nil, this variable will be ignored."
169   :type '(choice :custom-show nil
170                  regexp
171                  (repeat regexp))
172   :group 'gnus-article-hiding)
173
174 (defcustom gnus-visible-headers
175   "^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:"
176   "*All headers that do not match this regexp will be hidden.
177 This variable can also be a list of regexp of headers to remain visible.
178 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
179   :type '(choice
180           (repeat :value-to-internal (lambda (widget value)
181                                        (custom-split-regexp-maybe value))
182                   :match (lambda (widget value)
183                            (or (stringp value)
184                                (widget-editable-list-match widget value)))
185                   regexp)
186           (const :tag "Use gnus-ignored-headers" nil)
187           regexp)
188   :group 'gnus-article-hiding)
189
190 (defcustom gnus-sorted-header-list
191   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
192     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
193   "*This variable is a list of regular expressions.
194 If it is non-nil, headers that match the regular expressions will
195 be placed first in the article buffer in the sequence specified by
196 this list."
197   :type '(repeat regexp)
198   :group 'gnus-article-hiding)
199
200 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
201   "Headers that are only to be displayed if they have interesting data.
202 Possible values in this list are:
203
204   'empty       Headers with no content.
205   'newsgroups  Newsgroup identical to Gnus group.
206   'to-address  To identical to To-address.
207   'to-list     To identical to To-list.
208   'cc-list     CC identical to To-list.
209   'followup-to Followup-to identical to Newsgroups.
210   'reply-to    Reply-to identical to From.
211   'date        Date less than four days old.
212   'long-to     To and/or Cc longer than 1024 characters.
213   'many-to     Multiple To and/or Cc."
214   :type '(set (const :tag "Headers with no content." empty)
215               (const :tag "Newsgroups identical to Gnus group." newsgroups)
216               (const :tag "To identical to To-address." to-address)
217               (const :tag "To identical to To-list." to-list)
218               (const :tag "CC identical to To-list." cc-list)
219               (const :tag "Followup-to identical to Newsgroups." followup-to)
220               (const :tag "Reply-to identical to From." reply-to)
221               (const :tag "Date less than four days old." date)
222               (const :tag "To and/or Cc longer than 1024 characters." long-to)
223               (const :tag "Multiple To and/or Cc headers." many-to))
224   :group 'gnus-article-hiding)
225
226 (defcustom gnus-article-skip-boring nil
227   "Skip over text that is not worth reading.
228 By default, if you set this t, then Gnus will display citations and
229 signatures, but will never scroll down to show you a page consisting
230 only of boring text.  Boring text is controlled by
231 `gnus-article-boring-faces'."
232   :version "22.1"
233   :type 'boolean
234   :group 'gnus-article-hiding)
235
236 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
237   "Regexp matching signature separator.
238 This can also be a list of regexps.  In that case, it will be checked
239 from head to tail looking for a separator.  Searches will be done from
240 the end of the buffer."
241   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
242                  (regexp)
243                  (repeat :tag "List of regexp" regexp))
244   :group 'gnus-article-signature)
245
246 (defcustom gnus-signature-limit nil
247   "Provide a limit to what is considered a signature.
248 If it is a number, no signature may not be longer (in characters) than
249 that number.  If it is a floating point number, no signature may be
250 longer (in lines) than that number.  If it is a function, the function
251 will be called without any parameters, and if it returns nil, there is
252 no signature in the buffer.  If it is a string, it will be used as a
253 regexp.  If it matches, the text in question is not a signature.
254
255 This can also be a list of the above values."
256   :type '(choice (const nil)
257                  (integer :value 200)
258                  (number :value 4.0)
259                  function
260                  (regexp :value ".*"))
261   :group 'gnus-article-signature)
262
263 (defcustom gnus-hidden-properties '(invisible t intangible t)
264   "Property list to use for hiding text."
265   :type 'sexp
266   :group 'gnus-article-hiding)
267
268 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
269 ;; frames in a session.
270 (defcustom gnus-article-x-face-command
271   (if (featurep 'xemacs)
272       (if (or (gnus-image-type-available-p 'xface)
273               (gnus-image-type-available-p 'pbm))
274           'gnus-display-x-face-in-from
275         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
276     (if (gnus-image-type-available-p 'pbm)
277         'gnus-display-x-face-in-from
278       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
279 display -"))
280   "*String or function to be executed to display an X-Face header.
281 If it is a string, the command will be executed in a sub-shell
282 asynchronously.  The compressed face will be piped to this command."
283   :type `(choice string
284                  (function-item gnus-display-x-face-in-from)
285                  function)
286   :version "21.1"
287   :group 'gnus-picon
288   :group 'gnus-article-washing)
289
290 (defcustom gnus-article-x-face-too-ugly nil
291   "Regexp matching posters whose face shouldn't be shown automatically."
292   :type '(choice regexp (const nil))
293   :group 'gnus-article-washing)
294
295 (defcustom gnus-article-banner-alist nil
296   "Banner alist for stripping.
297 For example,
298      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
299   :version "21.1"
300   :type '(repeat (cons symbol regexp))
301   :group 'gnus-article-washing)
302
303 (gnus-define-group-parameter
304  banner
305  :variable-document
306  "Alist of regexps (to match group names) and banner."
307  :variable-group gnus-article-washing
308  :parameter-type
309  '(choice :tag "Banner"
310           :value nil
311           (const :tag "Remove signature" signature)
312           (symbol :tag "Item in `gnus-article-banner-alist'" none)
313           regexp
314           (const :tag "None" nil))
315  :parameter-document
316  "If non-nil, specify how to remove `banners' from articles.
317
318 Symbol `signature' means to remove signatures delimited by
319 `gnus-signature-separator'.  Any other symbol is used to look up a
320 regular expression to match the banner in `gnus-article-banner-alist'.
321 A string is used as a regular expression to match the banner
322 directly.")
323
324 (defcustom gnus-article-address-banner-alist nil
325   "Alist of mail addresses and banners.
326 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
327 to match a mail address in the From: header, BANNER is one of a symbol
328 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
329 If ADDRESS matches author's mail address, it will remove things like
330 advertisements.  For example:
331
332 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
333 "
334   :type '(repeat
335           (cons
336            (regexp :tag "Address")
337            (choice :tag "Banner" :value nil
338                    (const :tag "Remove signature" signature)
339                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
340                    regexp
341                    (const :tag "None" nil))))
342   :version "22.1"
343   :group 'gnus-article-washing)
344
345 (defmacro gnus-emphasis-custom-with-format (&rest body)
346   `(let ((format "\
347 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
348 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
349      ,@body))
350
351 (defun gnus-emphasis-custom-value-to-external (value)
352   (gnus-emphasis-custom-with-format
353    (if (consp (car value))
354        (list (format format (car (car value)) (cdr (car value)))
355              2
356              (if (nth 1 value) 2 3)
357              (nth 2 value))
358      value)))
359
360 (defun gnus-emphasis-custom-value-to-internal (value)
361   (gnus-emphasis-custom-with-format
362    (let ((regexp (concat "\\`"
363                          (format (regexp-quote format)
364                                  "\\([^()]+\\)" "\\([^()]+\\)")
365                          "\\'"))
366          pattern)
367      (if (string-match regexp (setq pattern (car value)))
368          (list (cons (match-string 1 pattern) (match-string 2 pattern))
369                (= (nth 2 value) 2)
370                (nth 3 value))
371        value))))
372
373 (defcustom gnus-emphasis-alist
374   (let ((types
375          '(("\\*" "\\*" bold nil 2)
376            ("_" "_" underline)
377            ("/" "/" italic)
378            ("_/" "/_" underline-italic)
379            ("_\\*" "\\*_" underline-bold)
380            ("\\*/" "/\\*" bold-italic)
381            ("_\\*/" "/\\*_" underline-bold-italic))))
382     (nconc
383      (gnus-emphasis-custom-with-format
384       (mapcar (lambda (spec)
385                 (list (format format (car spec) (cadr spec))
386                       (or (nth 3 spec) 2)
387                       (or (nth 4 spec) 3)
388                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
389               types))
390      '(;; I've never seen anyone use this strikethru convention whereas I've
391        ;; several times seen it triggered by normal text.  --Stef
392        ;; Miles suggests that this form is sometimes used but for italics,
393        ;; so maybe we should map it to `italic'.
394        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
395        ;; 2 3 gnus-emphasis-strikethru)
396        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
397         2 3 gnus-emphasis-underline))))
398   "*Alist that says how to fontify certain phrases.
399 Each item looks like this:
400
401   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
402
403 The first element is a regular expression to be matched.  The second
404 is a number that says what regular expression grouping used to find
405 the entire emphasized word.  The third is a number that says what
406 regexp grouping should be displayed and highlighted.  The fourth
407 is the face used for highlighting."
408   :type
409   '(repeat
410     (menu-choice
411      :format "%[Customizing Style%]\n%v"
412      :indent 2
413      (group :tag "Default"
414             :value ("" 0 0 default)
415             :value-create
416             (lambda (widget)
417               (let ((value (widget-get
418                             (cadr (widget-get (widget-get widget :parent)
419                                               :args))
420                             :value)))
421                 (if (not (eq (nth 2 value) 'default))
422                     (widget-put
423                      widget
424                      :value
425                      (gnus-emphasis-custom-value-to-external value))))
426               (widget-group-value-create widget))
427             regexp
428             (integer :format "Match group: %v")
429             (integer :format "Emphasize group: %v")
430             face)
431      (group :tag "Simple"
432             :value (("_" . "_") nil default)
433             (cons :format "%v"
434                   (regexp :format "Start regexp: %v")
435                   (regexp :format "End regexp: %v"))
436             (boolean :format "Show start and end patterns: %[%v%]\n"
437                      :on " On " :off " Off ")
438             face)))
439   :get (lambda (symbol)
440          (mapcar 'gnus-emphasis-custom-value-to-internal
441                  (default-value symbol)))
442   :set (lambda (symbol value)
443          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
444                                      value)))
445   :group 'gnus-article-emphasis)
446
447 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
448   "A regexp to describe whitespace which should not be emphasized.
449 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
450 The former avoids underlining of leading and trailing whitespace,
451 and the latter avoids underlining any whitespace at all."
452   :version "21.1"
453   :group 'gnus-article-emphasis
454   :type 'regexp)
455
456 (defface gnus-emphasis-bold '((t (:bold t)))
457   "Face used for displaying strong emphasized text (*word*)."
458   :group 'gnus-article-emphasis)
459
460 (defface gnus-emphasis-italic '((t (:italic t)))
461   "Face used for displaying italic emphasized text (/word/)."
462   :group 'gnus-article-emphasis)
463
464 (defface gnus-emphasis-underline '((t (:underline t)))
465   "Face used for displaying underlined emphasized text (_word_)."
466   :group 'gnus-article-emphasis)
467
468 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
469   "Face used for displaying underlined bold emphasized text (_*word*_)."
470   :group 'gnus-article-emphasis)
471
472 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
473   "Face used for displaying underlined italic emphasized text (_/word/_)."
474   :group 'gnus-article-emphasis)
475
476 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
477   "Face used for displaying bold italic emphasized text (/*word*/)."
478   :group 'gnus-article-emphasis)
479
480 (defface gnus-emphasis-underline-bold-italic
481   '((t (:bold t :italic t :underline t)))
482   "Face used for displaying underlined bold italic emphasized text.
483 Example: (_/*word*/_)."
484   :group 'gnus-article-emphasis)
485
486 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
487                                       '((t (:strikethru t)))
488                                     '((t (:strike-through t))))
489   "Face used for displaying strike-through text (-word-)."
490   :group 'gnus-article-emphasis)
491
492 (defface gnus-emphasis-highlight-words
493   '((t (:background "black" :foreground "yellow")))
494   "Face used for displaying highlighted words."
495   :group 'gnus-article-emphasis)
496
497 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
498   "Format for display of Date headers in article bodies.
499 See `format-time-string' for the possible values.
500
501 The variable can also be function, which should return a complete Date
502 header.  The function is called with one argument, the time, which can
503 be fed to `format-time-string'."
504   :type '(choice string function)
505   :link '(custom-manual "(gnus)Article Date")
506   :group 'gnus-article-washing)
507
508 (defcustom gnus-save-all-headers t
509   "*If non-nil, don't remove any headers before saving.
510 This will be overridden by the `:headers' property that the symbol of
511 the saver function, which is specified by `gnus-default-article-saver',
512 might have."
513   :group 'gnus-article-saving
514   :type 'boolean)
515
516 (defcustom gnus-prompt-before-saving 'always
517   "*This variable says how much prompting is to be done when saving articles.
518 If it is nil, no prompting will be done, and the articles will be
519 saved to the default files.  If this variable is `always', each and
520 every article that is saved will be preceded by a prompt, even when
521 saving large batches of articles.  If this variable is neither nil not
522 `always', there the user will be prompted once for a file name for
523 each invocation of the saving commands."
524   :group 'gnus-article-saving
525   :type '(choice (item always)
526                  (item :tag "never" nil)
527                  (sexp :tag "once" :format "%t\n" :value t)))
528
529 (defcustom gnus-saved-headers gnus-visible-headers
530   "Headers to keep if `gnus-save-all-headers' is nil.
531 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
532 If that variable is nil, however, all headers that match this regexp
533 will be kept while the rest will be deleted before saving.  This and
534 `gnus-save-all-headers' will be overridden by the `:headers' property
535 that the symbol of the saver function, which is specified by
536 `gnus-default-article-saver', might have."
537   :group 'gnus-article-saving
538   :type 'regexp)
539
540 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
541 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
542   "A function to save articles in your favourite format.
543 The function will be called by way of the `gnus-summary-save-article'
544 command, and friends such as `gnus-summary-save-article-rmail'.
545
546 Gnus provides the following functions:
547
548 * gnus-summary-save-in-rmail (Rmail format)
549 * gnus-summary-save-in-mail (Unix mail format)
550 * gnus-summary-save-in-folder (MH folder)
551 * gnus-summary-save-in-file (article format)
552 * gnus-summary-save-body-in-file (article body)
553 * gnus-summary-save-in-vm (use VM's folder format)
554 * gnus-summary-write-to-file (article format -- overwrite)
555 * gnus-summary-write-body-to-file (article body -- overwrite)
556 * gnus-summary-save-in-pipe (article format)
557
558 The symbol of each function may have the following properties:
559
560 * :decode
561 The value non-nil means save decoded articles.  This is meaningful
562 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
563 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
564 `gnus-summary-save-in-pipe'.
565
566 * :function
567 The value specifies an alternative function which appends, not
568 overwrites, articles to a file.  This implies that when saving many
569 articles at a time, `gnus-prompt-before-saving' is bound to t and all
570 articles are saved in a single file.  This is meaningful only with
571 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
572
573 * :headers
574 The value specifies the symbol of a variable of which the value
575 specifies headers to be saved.  If it is omitted,
576 `gnus-save-all-headers' and `gnus-saved-headers' control what
577 headers should be saved."
578   :group 'gnus-article-saving
579   :type '(radio (function-item gnus-summary-save-in-rmail)
580                 (function-item gnus-summary-save-in-mail)
581                 (function-item gnus-summary-save-in-folder)
582                 (function-item gnus-summary-save-in-file)
583                 (function-item gnus-summary-save-body-in-file)
584                 (function-item gnus-summary-save-in-vm)
585                 (function-item gnus-summary-write-to-file)
586                 (function-item gnus-summary-write-body-to-file)
587                 (function-item gnus-summary-save-in-pipe)
588                 (function)))
589
590 (defcustom gnus-article-save-coding-system
591   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
592       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
593       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
594       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
595   "Coding system used to save decoded articles to a file.
596
597 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
598 which can safely encode any characters in text.  This is used by the
599 commands including:
600
601 * gnus-summary-save-article-file
602 * gnus-summary-save-article-body-file
603 * gnus-summary-write-article-file
604 * gnus-summary-write-article-body-file
605
606 and the functions to which you may set `gnus-default-article-saver':
607
608 * gnus-summary-save-in-file
609 * gnus-summary-save-body-in-file
610 * gnus-summary-write-to-file
611 * gnus-summary-write-body-to-file
612
613 Those commands and functions save just text displayed in the article
614 buffer to a file if the value of this variable is non-nil.  Note that
615 buttonized MIME parts will be lost in a saved file in that case.
616 Otherwise, raw articles will be saved."
617   :group 'gnus-article-saving
618   :type `(choice
619           :format "%{%t%}:\n %[Value Menu%] %v"
620           (const :tag "Save raw articles" nil)
621           ,@(delq nil
622                   (mapcar
623                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
624                    '((const :tag "UTF-8" utf-8)
625                      (const :tag "iso-2022-7bit" iso-2022-7bit)
626                      (const :tag "Emacs internal" emacs-mule)
627                      (const :tag "escape-quoted" escape-quoted))))
628           (symbol :tag "Coding system")))
629
630 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
631   "A function generating a file name to save articles in Rmail format.
632 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
633   :group 'gnus-article-saving
634   :type 'function)
635
636 (defcustom gnus-mail-save-name 'gnus-plain-save-name
637   "A function generating a file name to save articles in Unix mail format.
638 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
639   :group 'gnus-article-saving
640   :type 'function)
641
642 (defcustom gnus-folder-save-name 'gnus-folder-save-name
643   "A function generating a file name to save articles in MH folder.
644 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
645   :group 'gnus-article-saving
646   :type 'function)
647
648 (defcustom gnus-file-save-name 'gnus-numeric-save-name
649   "A function generating a file name to save articles in article format.
650 The function is called with NEWSGROUP, HEADERS, and optional
651 LAST-FILE."
652   :group 'gnus-article-saving
653   :type 'function)
654
655 (defcustom gnus-split-methods
656   '((gnus-article-archive-name)
657     (gnus-article-nndoc-name))
658   "*Variable used to suggest where articles are to be saved.
659 For instance, if you would like to save articles related to Gnus in
660 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
661 you could set this variable to something like:
662
663  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
664    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
665
666 This variable is an alist where the key is the match and the
667 value is a list of possible files to save in if the match is
668 non-nil.
669
670 If the match is a string, it is used as a regexp match on the
671 article.  If the match is a symbol, that symbol will be funcalled
672 from the buffer of the article to be saved with the newsgroup as the
673 parameter.  If it is a list, it will be evaled in the same buffer.
674
675 If this form or function returns a string, this string will be used as a
676 possible file name; and if it returns a non-nil list, that list will be
677 used as possible file names."
678   :group 'gnus-article-saving
679   :type '(repeat (choice (list :value (fun) function)
680                          (cons :value ("" "") regexp (repeat string))
681                          (sexp :value nil))))
682
683 (defcustom gnus-page-delimiter "^\^L"
684   "*Regexp describing what to use as article page delimiters.
685 The default value is \"^\^L\", which is a form linefeed at the
686 beginning of a line."
687   :type 'regexp
688   :group 'gnus-article-various)
689
690 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
691   "*The format specification for the article mode line.
692 See `gnus-summary-mode-line-format' for a closer description.
693
694 The following additional specs are available:
695
696 %w  The article washing status.
697 %m  The number of MIME parts in the article."
698   :type 'string
699   :group 'gnus-article-various)
700
701 (defcustom gnus-article-mode-hook nil
702   "*A hook for Gnus article mode."
703   :type 'hook
704   :group 'gnus-article-various)
705
706 (when (featurep 'xemacs)
707   ;; Extracted from gnus-xmas-define in order to preserve user settings
708   (when (fboundp 'turn-off-scroll-in-place)
709     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
710   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
711   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
712
713 (defcustom gnus-article-menu-hook nil
714   "*Hook run after the creation of the article mode menu."
715   :type 'hook
716   :group 'gnus-article-various)
717
718 (defcustom gnus-article-prepare-hook nil
719   "*A hook called after an article has been prepared in the article buffer."
720   :type 'hook
721   :group 'gnus-article-various)
722
723 (defcustom gnus-copy-article-ignored-headers nil
724   "List of headers to be removed when copying an article.
725 Each element is a regular expression."
726   :version "23.1" ;; No Gnus
727   :type '(repeat regexp)
728   :group 'gnus-article-various)
729
730 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
731                         "Gnus 5.10 (Emacs-22.1)")
732
733 (defface gnus-button
734   '((t (:weight bold)))
735   "Face used for highlighting a button in the article buffer."
736   :group 'gnus-article-buttons)
737
738 (defcustom gnus-article-button-face 'gnus-button
739   "Face used for highlighting buttons in the article buffer.
740
741 An article button is a piece of text that you can activate by pressing
742 `RET' or `mouse-2' above it."
743   :type 'face
744   :group 'gnus-article-buttons)
745
746 (defcustom gnus-article-mouse-face 'highlight
747   "Face used for mouse highlighting in the article buffer.
748
749 Article buttons will be displayed in this face when the cursor is
750 above them."
751   :type 'face
752   :group 'gnus-article-buttons)
753
754 (defcustom gnus-signature-face 'gnus-signature
755   "Face used for highlighting a signature in the article buffer.
756 Obsolete; use the face `gnus-signature' for customizations instead."
757   :type 'face
758   :group 'gnus-article-highlight
759   :group 'gnus-article-signature)
760
761 (defface gnus-signature
762   '((t
763      (:italic t)))
764   "Face used for highlighting a signature in the article buffer."
765   :group 'gnus-article-highlight
766   :group 'gnus-article-signature)
767 ;; backward-compatibility alias
768 (put 'gnus-signature-face 'face-alias 'gnus-signature)
769 (put 'gnus-signature-face 'obsolete-face "22.1")
770
771 (defface gnus-header-from
772   '((((class color)
773       (background dark))
774      (:foreground "PaleGreen1"))
775     (((class color)
776       (background light))
777      (:foreground "red3"))
778     (t
779      (:italic t)))
780   "Face used for displaying from headers."
781   :group 'gnus-article-headers
782   :group 'gnus-article-highlight)
783 ;; backward-compatibility alias
784 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
785 (put 'gnus-header-from-face 'obsolete-face "22.1")
786
787 (defface gnus-header-subject
788   '((((class color)
789       (background dark))
790      (:foreground "SeaGreen1"))
791     (((class color)
792       (background light))
793      (:foreground "red4"))
794     (t
795      (:bold t :italic t)))
796   "Face used for displaying subject headers."
797   :group 'gnus-article-headers
798   :group 'gnus-article-highlight)
799 ;; backward-compatibility alias
800 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
801 (put 'gnus-header-subject-face 'obsolete-face "22.1")
802
803 (defface gnus-header-newsgroups
804   '((((class color)
805       (background dark))
806      (:foreground "yellow" :italic t))
807     (((class color)
808       (background light))
809      (:foreground "MidnightBlue" :italic t))
810     (t
811      (:italic t)))
812   "Face used for displaying newsgroups headers.
813 In the default setup this face is only used for crossposted
814 articles."
815   :group 'gnus-article-headers
816   :group 'gnus-article-highlight)
817 ;; backward-compatibility alias
818 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
819 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
820
821 (defface gnus-header-name
822   '((((class color)
823       (background dark))
824      (:foreground "SpringGreen2"))
825     (((class color)
826       (background light))
827      (:foreground "maroon"))
828     (t
829      (:bold t)))
830   "Face used for displaying header names."
831   :group 'gnus-article-headers
832   :group 'gnus-article-highlight)
833 ;; backward-compatibility alias
834 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
835 (put 'gnus-header-name-face 'obsolete-face "22.1")
836
837 (defface gnus-header-content
838   '((((class color)
839       (background dark))
840      (:foreground "SpringGreen1" :italic t))
841     (((class color)
842       (background light))
843      (:foreground "indianred4" :italic t))
844     (t
845      (:italic t)))  "Face used for displaying header content."
846   :group 'gnus-article-headers
847   :group 'gnus-article-highlight)
848 ;; backward-compatibility alias
849 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
850 (put 'gnus-header-content-face 'obsolete-face "22.1")
851
852 (defcustom gnus-header-face-alist
853   '(("From" nil gnus-header-from)
854     ("Subject" nil gnus-header-subject)
855     ("Newsgroups:.*," nil gnus-header-newsgroups)
856     ("" gnus-header-name gnus-header-content))
857   "*Controls highlighting of article headers.
858
859 An alist of the form (HEADER NAME CONTENT).
860
861 HEADER is a regular expression which should match the name of a
862 header and NAME and CONTENT are either face names or nil.
863
864 The name of each header field will be displayed using the face
865 specified by the first element in the list where HEADER matches
866 the header name and NAME is non-nil.  Similarly, the content will
867 be displayed by the first non-nil matching CONTENT face."
868   :group 'gnus-article-headers
869   :group 'gnus-article-highlight
870   :type '(repeat (list (regexp :tag "Header")
871                        (choice :tag "Name"
872                                (item :tag "skip" nil)
873                                (face :value default))
874                        (choice :tag "Content"
875                                (item :tag "skip" nil)
876                                (face :value default)))))
877
878 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
879                                           '((xface . (:face gnus-x-face)))
880                                         '((pbm . (:face gnus-x-face))
881                                           (png . nil)))
882   "Alist of image types and properties applied to Face and X-Face images.
883 Here are examples:
884
885 ;; Specify the altitude of Face images in the From header.
886 \(setq gnus-face-properties-alist
887       '((pbm . (:face gnus-x-face :ascent 80))
888         (png . (:ascent 80))))
889
890 ;; Show Face images as pressed buttons.
891 \(setq gnus-face-properties-alist
892       '((pbm . (:face gnus-x-face :relief -2))
893         (png . (:relief -2))))
894
895 See the manual for the valid properties for various image types.
896 Currently, `pbm' is used for X-Face images and `png' is used for Face
897 images in Emacs.  Only the `:face' property is effective on the `xface'
898 image type in XEmacs if it is built with the libcompface library."
899   :version "23.1" ;; No Gnus
900   :group 'gnus-article-headers
901   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
902
903 (defcustom gnus-article-decode-hook
904   '(article-decode-charset article-decode-encoded-words
905                            article-decode-group-name article-decode-idna-rhs)
906   "*Hook run to decode charsets in articles."
907   :group 'gnus-article-headers
908   :type 'hook)
909
910 (defcustom gnus-display-mime-function 'gnus-display-mime
911   "Function to display MIME articles."
912   :group 'gnus-article-mime
913   :type 'function)
914
915 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
916   "Function used to decode headers.")
917
918 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
919   "Function used to decode addresses.")
920
921 (defvar gnus-article-dumbquotes-map
922   '(("\200" "EUR")
923     ("\202" ",")
924     ("\203" "f")
925     ("\204" ",,")
926     ("\205" "...")
927     ("\213" "<")
928     ("\214" "OE")
929     ("\221" "`")
930     ("\222" "'")
931     ("\223" "``")
932     ("\224" "\"")
933     ("\225" "*")
934     ("\226" "-")
935     ("\227" "--")
936     ("\230" "~")
937     ("\231" "(TM)")
938     ("\233" ">")
939     ("\234" "oe")
940     ("\264" "'"))
941   "Table for MS-to-Latin1 translation.")
942
943 (defcustom gnus-ignored-mime-types nil
944   "List of MIME types that should be ignored by Gnus."
945   :version "21.1"
946   :group 'gnus-article-mime
947   :type '(repeat regexp))
948
949 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
950   "List of MIME types that should not be given buttons when rendered inline.
951 See also `gnus-buttonized-mime-types' which may override this variable.
952 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
953   :version "21.1"
954   :group 'gnus-article-mime
955   :type '(repeat regexp))
956
957 (defcustom gnus-buttonized-mime-types nil
958   "List of MIME types that should be given buttons when rendered inline.
959 If set, this variable overrides `gnus-unbuttonized-mime-types'.
960 To see e.g. security buttons you could set this to
961 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
962 this list to display radio buttons that allow you to choose one of two
963 media types those mails include.  See also `mm-discouraged-alternatives'.
964 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
965   :version "22.1"
966   :group 'gnus-article-mime
967   :type '(repeat regexp))
968
969 (defcustom gnus-inhibit-mime-unbuttonizing nil
970   "If non-nil, all MIME parts get buttons.
971 When nil (the default value), then some MIME parts do not get buttons,
972 as described by the variables `gnus-buttonized-mime-types' and
973 `gnus-unbuttonized-mime-types'."
974   :version "22.1"
975   :group 'gnus-article-mime
976   :type 'boolean)
977
978 (defcustom gnus-body-boundary-delimiter "_"
979   "String used to delimit header and body.
980 This variable is used by `gnus-article-treat-body-boundary' which can
981 be controlled by `gnus-treat-body-boundary'."
982   :version "22.1"
983   :group 'gnus-article-various
984   :type '(choice (item :tag "None" :value nil)
985                  string))
986
987 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
988                                   "/usr/share/picons")
989   "Defines the location of the faces database.
990 For information on obtaining this database of pretty pictures, please
991 see http://www.cs.indiana.edu/picons/ftp/index.html"
992   :version "22.1"
993   :type '(repeat directory)
994   :link '(url-link :tag "download"
995                    "http://www.cs.indiana.edu/picons/ftp/index.html")
996   :link '(custom-manual "(gnus)Picons")
997   :group 'gnus-picon)
998
999 (defun gnus-picons-installed-p ()
1000   "Say whether picons are installed on your machine."
1001   (let ((installed nil))
1002     (dolist (database gnus-picon-databases)
1003       (when (file-exists-p database)
1004         (setq installed t)))
1005     installed))
1006
1007 (defcustom gnus-article-mime-part-function nil
1008   "Function called with a MIME handle as the argument.
1009 This is meant for people who want to do something automatic based
1010 on parts -- for instance, adding Vcard info to a database."
1011   :group 'gnus-article-mime
1012   :type '(choice (const nil)
1013                  function))
1014
1015 (defcustom gnus-mime-multipart-functions nil
1016   "An alist of MIME types to functions to display them."
1017   :version "21.1"
1018   :group 'gnus-article-mime
1019   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1020
1021 (defcustom gnus-article-date-lapsed-new-header nil
1022   "Whether the X-Sent and Date headers can coexist.
1023 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
1024 either replace the old \"Date:\" header (if this variable is nil), or
1025 be added below it (otherwise)."
1026   :version "21.1"
1027   :group 'gnus-article-headers
1028   :type 'boolean)
1029
1030 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1031   "Function called with a MIME handle as the argument.
1032 This is meant for people who want to view first matched part.
1033 For `undisplayed-alternative' (default), the first undisplayed
1034 part or alternative part is used.  For `undisplayed', the first
1035 undisplayed part is used.  For a function, the first part which
1036 the function return t is used.  For nil, the first part is
1037 used."
1038   :version "21.1"
1039   :group 'gnus-article-mime
1040   :type '(choice
1041           (item :tag "first" :value nil)
1042           (item :tag "undisplayed" :value undisplayed)
1043           (item :tag "undisplayed or alternative"
1044                 :value undisplayed-alternative)
1045           (function)))
1046
1047 (defcustom gnus-mime-action-alist
1048   '(("save to file" . gnus-mime-save-part)
1049     ("save and strip" . gnus-mime-save-part-and-strip)
1050     ("replace with file" . gnus-mime-replace-part)
1051     ("delete part" . gnus-mime-delete-part)
1052     ("display as text" . gnus-mime-inline-part)
1053     ("view the part" . gnus-mime-view-part)
1054     ("pipe to command" . gnus-mime-pipe-part)
1055     ("toggle display" . gnus-article-press-button)
1056     ("toggle display" . gnus-article-view-part-as-charset)
1057     ("view as type" . gnus-mime-view-part-as-type)
1058     ("view internally" . gnus-mime-view-part-internally)
1059     ("view externally" . gnus-mime-view-part-externally))
1060   "An alist of actions that run on the MIME attachment."
1061   :group 'gnus-article-mime
1062   :type '(repeat (cons (string :tag "name")
1063                        (function))))
1064
1065 (defcustom gnus-auto-select-part 1
1066   "Advance to next MIME part when deleting or stripping parts.
1067
1068 When 0, point will be placed on the same part as before.  When
1069 positive (negative), move point forward (backwards) this many
1070 parts.  When nil, redisplay article."
1071   :version "23.1" ;; No Gnus
1072   :group 'gnus-article-mime
1073   :type '(choice (const nil :tag "Redisplay article.")
1074                  (const 1 :tag "Next part.")
1075                  (const 0 :tag "Current part.")
1076                  integer))
1077
1078 ;;;
1079 ;;; The treatment variables
1080 ;;;
1081
1082 (defvar gnus-part-display-hook nil
1083   "Hook called on parts that are to receive treatment.")
1084
1085 (defvar gnus-article-treat-custom
1086   '(choice (const :tag "Off" nil)
1087            (const :tag "On" t)
1088            (const :tag "Header" head)
1089            (const :tag "First" first)
1090            (const :tag "Last" last)
1091            (integer :tag "Less")
1092            (repeat :tag "Groups" regexp)
1093            (sexp :tag "Predicate")))
1094
1095 (defvar gnus-article-treat-head-custom
1096   '(choice (const :tag "Off" nil)
1097            (const :tag "Header" head)))
1098
1099 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1100                                    "text/x-patch")
1101   "Parts to treat.")
1102
1103 (defvar gnus-inhibit-treatment nil
1104   "Whether to inhibit treatment.")
1105
1106 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1107   "Highlight the signature.
1108 Valid values are nil, t, `head', `first', `last', an integer or a
1109 predicate.  See Info node `(gnus)Customizing Articles'."
1110   :group 'gnus-article-treat
1111   :link '(custom-manual "(gnus)Customizing Articles")
1112   :type gnus-article-treat-custom)
1113 (put 'gnus-treat-highlight-signature 'highlight t)
1114
1115 (defcustom gnus-treat-buttonize 100000
1116   "Add buttons.
1117 Valid values are nil, t, `head', `first', `last', an integer or a
1118 predicate.  See Info node `(gnus)Customizing Articles'."
1119   :group 'gnus-article-treat
1120   :link '(custom-manual "(gnus)Customizing Articles")
1121   :type gnus-article-treat-custom)
1122 (put 'gnus-treat-buttonize 'highlight t)
1123
1124 (defcustom gnus-treat-buttonize-head 'head
1125   "Add buttons to the head.
1126 Valid values are nil, t, `head', `first', `last', an integer or a
1127 predicate.  See Info node `(gnus)Customizing Articles'."
1128   :group 'gnus-article-treat
1129   :link '(custom-manual "(gnus)Customizing Articles")
1130   :type gnus-article-treat-head-custom)
1131 (put 'gnus-treat-buttonize-head 'highlight t)
1132
1133 (defcustom gnus-treat-emphasize 50000
1134   "Emphasize text.
1135 Valid values are nil, t, `head', `first', `last', an integer or a
1136 predicate.  See Info node `(gnus)Customizing Articles'."
1137   :group 'gnus-article-treat
1138   :link '(custom-manual "(gnus)Customizing Articles")
1139   :type gnus-article-treat-custom)
1140 (put 'gnus-treat-emphasize 'highlight t)
1141
1142 (defcustom gnus-treat-strip-cr nil
1143   "Remove carriage returns.
1144 Valid values are nil, t, `head', `first', `last', an integer or a
1145 predicate.  See Info node `(gnus)Customizing Articles'."
1146   :version "22.1"
1147   :group 'gnus-article-treat
1148   :link '(custom-manual "(gnus)Customizing Articles")
1149   :type gnus-article-treat-custom)
1150
1151 (defcustom gnus-treat-unsplit-urls nil
1152   "Remove newlines from within URLs.
1153 Valid values are nil, t, `head', `first', `last', an integer or a
1154 predicate.  See Info node `(gnus)Customizing Articles'."
1155   :version "22.1"
1156   :group 'gnus-article-treat
1157   :link '(custom-manual "(gnus)Customizing Articles")
1158   :type gnus-article-treat-custom)
1159
1160 (defcustom gnus-treat-leading-whitespace nil
1161   "Remove leading whitespace in headers.
1162 Valid values are nil, t, `head', `first', `last', an integer or a
1163 predicate.  See Info node `(gnus)Customizing Articles'."
1164   :version "22.1"
1165   :group 'gnus-article-treat
1166   :link '(custom-manual "(gnus)Customizing Articles")
1167   :type gnus-article-treat-custom)
1168
1169 (defcustom gnus-treat-hide-headers 'head
1170   "Hide headers.
1171 Valid values are nil, t, `head', `first', `last', an integer or a
1172 predicate.  See Info node `(gnus)Customizing Articles'."
1173   :group 'gnus-article-treat
1174   :link '(custom-manual "(gnus)Customizing Articles")
1175   :type gnus-article-treat-head-custom)
1176
1177 (defcustom gnus-treat-hide-boring-headers nil
1178   "Hide boring headers.
1179 Valid values are nil, t, `head', `first', `last', an integer or a
1180 predicate.  See Info node `(gnus)Customizing Articles'."
1181   :group 'gnus-article-treat
1182   :link '(custom-manual "(gnus)Customizing Articles")
1183   :type gnus-article-treat-head-custom)
1184
1185 (defcustom gnus-treat-hide-signature nil
1186   "Hide the signature.
1187 Valid values are nil, t, `head', `first', `last', an integer or a
1188 predicate.  See Info node `(gnus)Customizing Articles'."
1189   :group 'gnus-article-treat
1190   :link '(custom-manual "(gnus)Customizing Articles")
1191   :type gnus-article-treat-custom)
1192
1193 (defcustom gnus-treat-fill-article nil
1194   "Fill the article.
1195 Valid values are nil, t, `head', `first', `last', an integer or a
1196 predicate.  See Info node `(gnus)Customizing Articles'."
1197   :group 'gnus-article-treat
1198   :link '(custom-manual "(gnus)Customizing Articles")
1199   :type gnus-article-treat-custom)
1200
1201 (defcustom gnus-treat-hide-citation nil
1202   "Hide cited text.
1203 Valid values are nil, t, `head', `first', `last', an integer or a
1204 predicate.  See Info node `(gnus)Customizing Articles'."
1205   :group 'gnus-article-treat
1206   :link '(custom-manual "(gnus)Customizing Articles")
1207   :type gnus-article-treat-custom)
1208
1209 (defcustom gnus-treat-hide-citation-maybe nil
1210   "Hide cited text.
1211 Valid values are nil, t, `head', `first', `last', an integer or a
1212 predicate.  See Info node `(gnus)Customizing Articles'."
1213   :group 'gnus-article-treat
1214   :link '(custom-manual "(gnus)Customizing Articles")
1215   :type gnus-article-treat-custom)
1216
1217 (defcustom gnus-treat-strip-list-identifiers 'head
1218   "Strip list identifiers from `gnus-list-identifiers`.
1219 Valid values are nil, t, `head', `first', `last', an integer or a
1220 predicate.  See Info node `(gnus)Customizing Articles'."
1221   :version "21.1"
1222   :group 'gnus-article-treat
1223   :link '(custom-manual "(gnus)Customizing Articles")
1224   :type gnus-article-treat-custom)
1225
1226 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1227                         "Gnus 5.10 (Emacs 22.1)")
1228
1229 (defcustom gnus-treat-strip-pem nil
1230   "Strip PEM signatures.
1231 Valid values are nil, t, `head', `first', `last', an integer or a
1232 predicate.  See Info node `(gnus)Customizing Articles'."
1233   :group 'gnus-article-treat
1234   :link '(custom-manual "(gnus)Customizing Articles")
1235   :type gnus-article-treat-custom)
1236
1237 (defcustom gnus-treat-strip-banner t
1238   "Strip banners from articles.
1239 The banner to be stripped is specified in the `banner' group parameter.
1240 Valid values are nil, t, `head', `first', `last', an integer or a
1241 predicate.  See Info node `(gnus)Customizing Articles'."
1242   :group 'gnus-article-treat
1243   :link '(custom-manual "(gnus)Customizing Articles")
1244   :type gnus-article-treat-custom)
1245
1246 (defcustom gnus-treat-highlight-headers 'head
1247   "Highlight the headers.
1248 Valid values are nil, t, `head', `first', `last', an integer or a
1249 predicate.  See Info node `(gnus)Customizing Articles'."
1250   :group 'gnus-article-treat
1251   :link '(custom-manual "(gnus)Customizing Articles")
1252   :type gnus-article-treat-head-custom)
1253 (put 'gnus-treat-highlight-headers 'highlight t)
1254
1255 (defcustom gnus-treat-highlight-citation t
1256   "Highlight cited text.
1257 Valid values are nil, t, `head', `first', `last', an integer or a
1258 predicate.  See Info node `(gnus)Customizing Articles'."
1259   :group 'gnus-article-treat
1260   :link '(custom-manual "(gnus)Customizing Articles")
1261   :type gnus-article-treat-custom)
1262 (put 'gnus-treat-highlight-citation 'highlight t)
1263
1264 (defcustom gnus-treat-date-ut nil
1265   "Display the Date in UT (GMT).
1266 Valid values are nil, t, `head', `first', `last', an integer or a
1267 predicate.  See Info node `(gnus)Customizing Articles'."
1268   :group 'gnus-article-treat
1269   :link '(custom-manual "(gnus)Customizing Articles")
1270   :type gnus-article-treat-head-custom)
1271
1272 (defcustom gnus-treat-date-local nil
1273   "Display the Date in the local timezone.
1274 Valid values are nil, t, `head', `first', `last', an integer or a
1275 predicate.  See Info node `(gnus)Customizing Articles'."
1276   :group 'gnus-article-treat
1277   :link '(custom-manual "(gnus)Customizing Articles")
1278   :type gnus-article-treat-head-custom)
1279
1280 (defcustom gnus-treat-date-english nil
1281   "Display the Date in a format that can be read aloud in English.
1282 Valid values are nil, t, `head', `first', `last', an integer or a
1283 predicate.  See Info node `(gnus)Customizing Articles'."
1284   :version "22.1"
1285   :group 'gnus-article-treat
1286   :link '(custom-manual "(gnus)Customizing Articles")
1287   :type gnus-article-treat-head-custom)
1288
1289 (defcustom gnus-treat-date-lapsed nil
1290   "Display the Date header in a way that says how much time has elapsed.
1291 Valid values are nil, t, `head', `first', `last', an integer or a
1292 predicate.  See Info node `(gnus)Customizing Articles'."
1293   :group 'gnus-article-treat
1294   :link '(custom-manual "(gnus)Customizing Articles")
1295   :type gnus-article-treat-head-custom)
1296
1297 (defcustom gnus-treat-date-original nil
1298   "Display the date in the original timezone.
1299 Valid values are nil, t, `head', `first', `last', an integer or a
1300 predicate.  See Info node `(gnus)Customizing Articles'."
1301   :group 'gnus-article-treat
1302   :link '(custom-manual "(gnus)Customizing Articles")
1303   :type gnus-article-treat-head-custom)
1304
1305 (defcustom gnus-treat-date-iso8601 nil
1306   "Display the date in the ISO8601 format.
1307 Valid values are nil, t, `head', `first', `last', an integer or a
1308 predicate.  See Info node `(gnus)Customizing Articles'."
1309   :version "21.1"
1310   :group 'gnus-article-treat
1311   :link '(custom-manual "(gnus)Customizing Articles")
1312   :type gnus-article-treat-head-custom)
1313
1314 (defcustom gnus-treat-date-user-defined nil
1315   "Display the date in a user-defined format.
1316 The format is defined by the `gnus-article-time-format' variable.
1317 Valid values are nil, t, `head', `first', `last', an integer or a
1318 predicate.  See Info node `(gnus)Customizing Articles'."
1319   :group 'gnus-article-treat
1320   :link '(custom-manual "(gnus)Customizing Articles")
1321   :type gnus-article-treat-head-custom)
1322
1323 (defcustom gnus-treat-strip-headers-in-body t
1324   "Strip the X-No-Archive header line from the beginning of the body.
1325 Valid values are nil, t, `head', `first', `last', an integer or a
1326 predicate.  See Info node `(gnus)Customizing Articles'."
1327   :version "21.1"
1328   :group 'gnus-article-treat
1329   :link '(custom-manual "(gnus)Customizing Articles")
1330   :type gnus-article-treat-custom)
1331
1332 (defcustom gnus-treat-strip-trailing-blank-lines nil
1333   "Strip trailing blank lines.
1334 Valid values are nil, t, `head', `first', `last', an integer or a
1335 predicate.  See Info node `(gnus)Customizing Articles'.
1336
1337 When set to t, it also strips trailing blanks in all MIME parts.
1338 Consider to use `last' instead."
1339   :group 'gnus-article-treat
1340   :link '(custom-manual "(gnus)Customizing Articles")
1341   :type gnus-article-treat-custom)
1342
1343 (defcustom gnus-treat-strip-leading-blank-lines nil
1344   "Strip leading blank lines.
1345 Valid values are nil, t, `head', `first', `last', an integer or a
1346 predicate.  See Info node `(gnus)Customizing Articles'.
1347
1348 When set to t, it also strips trailing blanks in all MIME parts."
1349   :group 'gnus-article-treat
1350   :link '(custom-manual "(gnus)Customizing Articles")
1351   :type gnus-article-treat-custom)
1352
1353 (defcustom gnus-treat-strip-multiple-blank-lines nil
1354   "Strip multiple blank lines.
1355 Valid values are nil, t, `head', `first', `last', an integer or a
1356 predicate.  See Info node `(gnus)Customizing Articles'."
1357   :group 'gnus-article-treat
1358   :link '(custom-manual "(gnus)Customizing Articles")
1359   :type gnus-article-treat-custom)
1360
1361 (defcustom gnus-treat-unfold-headers 'head
1362   "Unfold folded header lines.
1363 Valid values are nil, t, `head', `first', `last', an integer or a
1364 predicate.  See Info node `(gnus)Customizing Articles'."
1365   :version "22.1"
1366   :group 'gnus-article-treat
1367   :link '(custom-manual "(gnus)Customizing Articles")
1368   :type gnus-article-treat-custom)
1369
1370 (defcustom gnus-article-unfold-long-headers nil
1371   "If non-nil, allow unfolding headers even if the header is long.
1372 If it is a regexp, only long headers matching this regexp are unfolded.
1373 If it is t, all long headers are unfolded.
1374
1375 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1376   :version "23.1" ;; No Gnus
1377   :group 'gnus-article-treat
1378   :type '(choice (const nil)
1379                  (const :tag "all" t)
1380                  (regexp)))
1381
1382 (defcustom gnus-treat-fold-headers nil
1383   "Fold headers.
1384 Valid values are nil, t, `head', `first', `last', an integer or a
1385 predicate.  See Info node `(gnus)Customizing Articles'."
1386   :version "22.1"
1387   :group 'gnus-article-treat
1388   :link '(custom-manual "(gnus)Customizing Articles")
1389   :type gnus-article-treat-custom)
1390
1391 (defcustom gnus-treat-fold-newsgroups 'head
1392   "Fold the Newsgroups and Followup-To headers.
1393 Valid values are nil, t, `head', `first', `last', an integer or a
1394 predicate.  See Info node `(gnus)Customizing Articles'."
1395   :version "22.1"
1396   :group 'gnus-article-treat
1397   :link '(custom-manual "(gnus)Customizing Articles")
1398   :type gnus-article-treat-custom)
1399
1400 (defcustom gnus-treat-overstrike t
1401   "Treat overstrike highlighting.
1402 Valid values are nil, t, `head', `first', `last', an integer or a
1403 predicate.  See Info node `(gnus)Customizing Articles'."
1404   :group 'gnus-article-treat
1405   :link '(custom-manual "(gnus)Customizing Articles")
1406   :type gnus-article-treat-custom)
1407 (put 'gnus-treat-overstrike 'highlight t)
1408
1409 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1410   "Treat ANSI SGR control sequences.
1411 Valid values are nil, t, `head', `first', `last', an integer or a
1412 predicate.  See Info node `(gnus)Customizing Articles'."
1413   :group 'gnus-article-treat
1414   :link '(custom-manual "(gnus)Customizing Articles")
1415   :type gnus-article-treat-custom)
1416
1417 (make-obsolete-variable 'gnus-treat-display-xface
1418                         'gnus-treat-display-x-face "22.1")
1419
1420 (defcustom gnus-treat-display-x-face
1421   (and (not noninteractive)
1422        (gnus-image-type-available-p 'xbm)
1423        (if (featurep 'xemacs)
1424            (featurep 'xface)
1425          (condition-case nil
1426              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1427                   (executable-find "icontopbm"))
1428            ;; shell-command-to-string may signal an error, e.g. if
1429            ;; shell-file-name is not found.
1430            (error nil)))
1431        'head)
1432   "Display X-Face headers.
1433 Valid values are nil and `head'.
1434 See Info node `(gnus)Customizing Articles' and Info node
1435 `(gnus)X-Face' for details."
1436   :group 'gnus-article-treat
1437   :version "21.1"
1438   :link '(custom-manual "(gnus)Customizing Articles")
1439   :link '(custom-manual "(gnus)X-Face")
1440   :type gnus-article-treat-head-custom
1441   :set (lambda (symbol value)
1442          (set-default
1443           symbol
1444           (cond ((or (boundp symbol) (get symbol 'saved-value))
1445                  value)
1446                 ((boundp 'gnus-treat-display-xface)
1447                  (message "\
1448 ** gnus-treat-display-xface is an obsolete variable;\
1449  use gnus-treat-display-x-face instead")
1450                  (default-value 'gnus-treat-display-xface))
1451                 ((get 'gnus-treat-display-xface 'saved-value)
1452                  (message "\
1453 ** gnus-treat-display-xface is an obsolete variable;\
1454  use gnus-treat-display-x-face instead")
1455                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1456                 (t
1457                  value)))))
1458 (put 'gnus-treat-display-x-face 'highlight t)
1459
1460 (defcustom gnus-treat-display-face
1461   (and (not noninteractive)
1462        (gnus-image-type-available-p 'png)
1463        'head)
1464   "Display Face headers.
1465 Valid values are nil, t, `head', `first', `last', an integer or a
1466 predicate.  See Info node `(gnus)Customizing Articles' and Info
1467 node `(gnus)Face' for details."
1468   :group 'gnus-article-treat
1469   :version "22.1"
1470   :link '(custom-manual "(gnus)Customizing Articles")
1471   :link '(custom-manual "(gnus)X-Face")
1472   :type gnus-article-treat-head-custom)
1473 (put 'gnus-treat-display-face 'highlight t)
1474
1475 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1476   "Display smileys.
1477 Valid values are nil, t, `head', `first', `last', an integer or a
1478 predicate.  See Info node `(gnus)Customizing Articles' and Info
1479 node `(gnus)Smileys' for details."
1480   :group 'gnus-article-treat
1481   :version "21.1"
1482   :link '(custom-manual "(gnus)Customizing Articles")
1483   :link '(custom-manual "(gnus)Smileys")
1484   :type gnus-article-treat-custom)
1485 (put 'gnus-treat-display-smileys 'highlight t)
1486
1487 (defcustom gnus-treat-from-picon
1488   (if (and (gnus-image-type-available-p 'xpm)
1489            (gnus-picons-installed-p))
1490       'head nil)
1491   "Display picons in the From header.
1492 Valid values are nil, t, `head', `first', `last', an integer or a
1493 predicate.  See Info node `(gnus)Customizing Articles' and Info
1494 node `(gnus)Picons' for details."
1495   :version "22.1"
1496   :group 'gnus-article-treat
1497   :group 'gnus-picon
1498   :link '(custom-manual "(gnus)Customizing Articles")
1499   :link '(custom-manual "(gnus)Picons")
1500   :type gnus-article-treat-head-custom)
1501 (put 'gnus-treat-from-picon 'highlight t)
1502
1503 (defcustom gnus-treat-mail-picon
1504   (if (and (gnus-image-type-available-p 'xpm)
1505            (gnus-picons-installed-p))
1506       'head nil)
1507   "Display picons in To and Cc headers.
1508 Valid values are nil, t, `head', `first', `last', an integer or a
1509 predicate.  See Info node `(gnus)Customizing Articles' and Info
1510 node `(gnus)Picons' for details."
1511   :version "22.1"
1512   :group 'gnus-article-treat
1513   :group 'gnus-picon
1514   :link '(custom-manual "(gnus)Customizing Articles")
1515   :link '(custom-manual "(gnus)Picons")
1516   :type gnus-article-treat-head-custom)
1517 (put 'gnus-treat-mail-picon 'highlight t)
1518
1519 (defcustom gnus-treat-newsgroups-picon
1520   (if (and (gnus-image-type-available-p 'xpm)
1521            (gnus-picons-installed-p))
1522       'head nil)
1523   "Display picons in the Newsgroups and Followup-To headers.
1524 Valid values are nil, t, `head', `first', `last', an integer or a
1525 predicate.  See Info node `(gnus)Customizing Articles' and Info
1526 node `(gnus)Picons' for details."
1527   :version "22.1"
1528   :group 'gnus-article-treat
1529   :group 'gnus-picon
1530   :link '(custom-manual "(gnus)Customizing Articles")
1531   :link '(custom-manual "(gnus)Picons")
1532   :type gnus-article-treat-head-custom)
1533 (put 'gnus-treat-newsgroups-picon 'highlight t)
1534
1535 (defcustom gnus-treat-body-boundary
1536   (if (or gnus-treat-newsgroups-picon
1537           gnus-treat-mail-picon
1538           gnus-treat-from-picon)
1539       ;; If there's much decoration, the user might prefer a boundery.
1540       'head
1541     nil)
1542   "Draw a boundary at the end of the headers.
1543 Valid values are nil and `head'.
1544 See Info node `(gnus)Customizing Articles' for details."
1545   :version "22.1"
1546   :group 'gnus-article-treat
1547   :link '(custom-manual "(gnus)Customizing Articles")
1548   :type gnus-article-treat-head-custom)
1549
1550 (defcustom gnus-treat-capitalize-sentences nil
1551   "Capitalize sentence-starting words.
1552 Valid values are nil, t, `head', `first', `last', an integer or a
1553 predicate.  See Info node `(gnus)Customizing Articles'."
1554   :version "21.1"
1555   :group 'gnus-article-treat
1556   :link '(custom-manual "(gnus)Customizing Articles")
1557   :type gnus-article-treat-custom)
1558
1559 (defcustom gnus-treat-wash-html nil
1560   "Format as HTML.
1561 Valid values are nil, t, `head', `first', `last', an integer or a
1562 predicate.  See Info node `(gnus)Customizing Articles'."
1563   :version "22.1"
1564   :group 'gnus-article-treat
1565   :link '(custom-manual "(gnus)Customizing Articles")
1566   :type gnus-article-treat-custom)
1567
1568 (defcustom gnus-treat-fill-long-lines nil
1569   "Fill long lines.
1570 Valid values are nil, t, `head', `first', `last', an integer or a
1571 predicate.  See Info node `(gnus)Customizing Articles'."
1572   :group 'gnus-article-treat
1573   :link '(custom-manual "(gnus)Customizing Articles")
1574   :type gnus-article-treat-custom)
1575
1576 (defcustom gnus-treat-play-sounds nil
1577   "Play sounds.
1578 Valid values are nil, t, `head', `first', `last', an integer or a
1579 predicate.  See Info node `(gnus)Customizing Articles'."
1580   :version "21.1"
1581   :group 'gnus-article-treat
1582   :link '(custom-manual "(gnus)Customizing Articles")
1583   :type gnus-article-treat-custom)
1584
1585 (defcustom gnus-treat-translate nil
1586   "Translate articles from one language to another.
1587 Valid values are nil, t, `head', `first', `last', an integer or a
1588 predicate.  See Info node `(gnus)Customizing Articles'."
1589   :version "21.1"
1590   :group 'gnus-article-treat
1591   :link '(custom-manual "(gnus)Customizing Articles")
1592   :type gnus-article-treat-custom)
1593
1594 (defcustom gnus-treat-x-pgp-sig nil
1595   "Verify X-PGP-Sig.
1596 To automatically treat X-PGP-Sig, set it to head.
1597 Valid values are nil, t, `head', `first', `last', an integer or a
1598 predicate.  See Info node `(gnus)Customizing Articles'."
1599   :version "22.1"
1600   :group 'gnus-article-treat
1601   :group 'mime-security
1602   :link '(custom-manual "(gnus)Customizing Articles")
1603   :type gnus-article-treat-custom)
1604
1605 (defvar gnus-article-encrypt-protocol-alist
1606   '(("PGP" . mml2015-self-encrypt)))
1607
1608 ;; Set to nil if more than one protocol added to
1609 ;; gnus-article-encrypt-protocol-alist.
1610 (defcustom gnus-article-encrypt-protocol "PGP"
1611   "The protocol used for encrypt articles.
1612 It is a string, such as \"PGP\". If nil, ask user."
1613   :version "22.1"
1614   :type 'string
1615   :group 'mime-security)
1616
1617 (defvar gnus-article-wash-function nil
1618   "Function used for converting HTML into text.")
1619
1620 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1621                               (mm-coding-system-p 'utf-8)
1622                               (executable-find idna-program))
1623   "Whether IDNA decoding of headers is used when viewing messages.
1624 This requires GNU Libidn, and by default only enabled if it is found."
1625   :version "22.1"
1626   :group 'gnus-article-headers
1627   :type 'boolean)
1628
1629 (defcustom gnus-article-over-scroll nil
1630   "If non-nil, allow scrolling the article buffer even when there no more text."
1631   :version "22.1"
1632   :group 'gnus-article
1633   :type 'boolean)
1634
1635 ;;; Internal variables
1636
1637 (defvar gnus-english-month-names
1638   '("January" "February" "March" "April" "May" "June" "July" "August"
1639     "September" "October" "November" "December"))
1640
1641 (defvar article-goto-body-goes-to-point-min-p nil)
1642 (defvar gnus-article-wash-types nil)
1643 (defvar gnus-article-emphasis-alist nil)
1644 (defvar gnus-article-image-alist nil)
1645
1646 (defvar gnus-article-mime-handle-alist-1 nil)
1647 (defvar gnus-treatment-function-alist
1648   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1649     (gnus-treat-strip-banner gnus-article-strip-banner)
1650     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1651     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1652     (gnus-treat-buttonize gnus-article-add-buttons)
1653     (gnus-treat-fill-article gnus-article-fill-cited-article)
1654     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1655     (gnus-treat-strip-cr gnus-article-remove-cr)
1656     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1657     (gnus-treat-date-ut gnus-article-date-ut)
1658     (gnus-treat-date-local gnus-article-date-local)
1659     (gnus-treat-date-english gnus-article-date-english)
1660     (gnus-treat-date-original gnus-article-date-original)
1661     (gnus-treat-date-user-defined gnus-article-date-user)
1662     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1663     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1664     (gnus-treat-display-x-face gnus-article-display-x-face)
1665     (gnus-treat-display-face gnus-article-display-face)
1666     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1667     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1668     (gnus-treat-hide-signature gnus-article-hide-signature)
1669     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1670     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1671     (gnus-treat-strip-pem gnus-article-hide-pem)
1672     (gnus-treat-from-picon gnus-treat-from-picon)
1673     (gnus-treat-mail-picon gnus-treat-mail-picon)
1674     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1675     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1676     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1677     (gnus-treat-strip-trailing-blank-lines
1678      gnus-article-remove-trailing-blank-lines)
1679     (gnus-treat-strip-leading-blank-lines
1680      gnus-article-strip-leading-blank-lines)
1681     (gnus-treat-strip-multiple-blank-lines
1682      gnus-article-strip-multiple-blank-lines)
1683     (gnus-treat-overstrike gnus-article-treat-overstrike)
1684     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1685     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1686     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1687     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1688     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1689     (gnus-treat-display-smileys gnus-treat-smiley)
1690     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1691     (gnus-treat-wash-html gnus-article-wash-html)
1692     (gnus-treat-emphasize gnus-article-emphasize)
1693     (gnus-treat-hide-citation gnus-article-hide-citation)
1694     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1695     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1696     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1697     (gnus-treat-play-sounds gnus-earcon-display)))
1698
1699 (defvar gnus-article-mime-handle-alist nil)
1700 (defvar article-lapsed-timer nil)
1701 (defvar gnus-article-current-summary nil)
1702
1703 (defvar gnus-article-mode-syntax-table
1704   (let ((table (copy-syntax-table text-mode-syntax-table)))
1705     ;; This causes the citation match run O(2^n).
1706     ;; (modify-syntax-entry ?- "w" table)
1707     (modify-syntax-entry ?> ")<" table)
1708     (modify-syntax-entry ?< "(>" table)
1709     ;; make M-. in article buffers work for `foo' strings
1710     (modify-syntax-entry ?' " " table)
1711     (modify-syntax-entry ?` " " table)
1712     table)
1713   "Syntax table used in article mode buffers.
1714 Initialized from `text-mode-syntax-table.")
1715
1716 (defvar gnus-save-article-buffer nil)
1717
1718 (defvar gnus-number-of-articles-to-be-saved nil)
1719
1720 (defvar gnus-inhibit-hiding nil)
1721
1722 (defvar gnus-article-edit-mode nil)
1723
1724 ;;; Macros for dealing with the article buffer.
1725
1726 (defmacro gnus-with-article-headers (&rest forms)
1727   `(with-current-buffer gnus-article-buffer
1728      (save-restriction
1729        (let ((inhibit-read-only t)
1730              (inhibit-point-motion-hooks t)
1731              (case-fold-search t))
1732          (article-narrow-to-head)
1733          ,@forms))))
1734
1735 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1736 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1737
1738 (defmacro gnus-with-article-buffer (&rest forms)
1739   `(with-current-buffer gnus-article-buffer
1740      (let ((inhibit-read-only t))
1741        ,@forms)))
1742
1743 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1744 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1745
1746 (defun gnus-article-goto-header (header)
1747   "Go to HEADER, which is a regular expression."
1748   (re-search-forward (concat "^\\(" header "\\):") nil t))
1749
1750 (defsubst gnus-article-hide-text (b e props)
1751   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1752   (gnus-add-text-properties-when 'article-type nil b e props)
1753   (when (memq 'intangible props)
1754     (put-text-property
1755      (max (1- b) (point-min))
1756      b 'intangible (cddr (memq 'intangible props)))))
1757
1758 (defsubst gnus-article-unhide-text (b e)
1759   "Remove hidden text properties from region between B and E."
1760   (remove-text-properties b e gnus-hidden-properties)
1761   (when (memq 'intangible gnus-hidden-properties)
1762     (put-text-property (max (1- b) (point-min))
1763                        b 'intangible nil)))
1764
1765 (defun gnus-article-hide-text-type (b e type)
1766   "Hide text of TYPE between B and E."
1767   (gnus-add-wash-type type)
1768   (gnus-article-hide-text
1769    b e (cons 'article-type (cons type gnus-hidden-properties))))
1770
1771 (defun gnus-article-unhide-text-type (b e type)
1772   "Unhide text of TYPE between B and E."
1773   (gnus-delete-wash-type type)
1774   (remove-text-properties
1775    b e (cons 'article-type (cons type gnus-hidden-properties)))
1776   (when (memq 'intangible gnus-hidden-properties)
1777     (put-text-property (max (1- b) (point-min))
1778                        b 'intangible nil)))
1779
1780 (defun gnus-article-hide-text-of-type (type)
1781   "Hide text of TYPE in the current buffer."
1782   (save-excursion
1783     (let ((b (point-min))
1784           (e (point-max)))
1785       (while (setq b (text-property-any b e 'article-type type))
1786         (add-text-properties b (incf b) gnus-hidden-properties)))))
1787
1788 (defun gnus-article-delete-text-of-type (type)
1789   "Delete text of TYPE in the current buffer."
1790   (save-excursion
1791     (let ((b (point-min)))
1792       (if (eq type 'multipart)
1793           ;; Remove MIME buttons associated with multipart/alternative parts.
1794           (progn
1795             (goto-char b)
1796             (while (if (get-text-property (point) 'gnus-part)
1797                        (setq b (point))
1798                      (when (setq b (next-single-property-change (point)
1799                                                                 'gnus-part))
1800                        (goto-char b)
1801                        t))
1802               (end-of-line)
1803               (skip-chars-forward "\n")
1804               (when (eq (get-text-property b 'article-type) 'multipart)
1805                 (delete-region b (point)))))
1806         (while (setq b (text-property-any b (point-max) 'article-type type))
1807           (delete-region
1808            b (or (text-property-not-all b (point-max) 'article-type type)
1809                  (point-max))))))))
1810
1811 (defun gnus-article-delete-invisible-text ()
1812   "Delete all invisible text in the current buffer."
1813   (save-excursion
1814     (let ((b (point-min)))
1815       (while (setq b (text-property-any b (point-max) 'invisible t))
1816         (delete-region
1817          b (or (text-property-not-all b (point-max) 'invisible t)
1818                (point-max)))))))
1819
1820 (defun gnus-article-text-type-exists-p (type)
1821   "Say whether any text of type TYPE exists in the buffer."
1822   (text-property-any (point-min) (point-max) 'article-type type))
1823
1824 (defsubst gnus-article-header-rank ()
1825   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1826   (let ((list gnus-sorted-header-list)
1827         (i 1))
1828     (while list
1829       (if (looking-at (car list))
1830           (setq list nil)
1831         (setq list (cdr list))
1832         (incf i)))
1833       i))
1834
1835 (defun article-hide-headers (&optional arg delete)
1836   "Hide unwanted headers and possibly sort them as well."
1837   (interactive)
1838   ;; This function might be inhibited.
1839   (unless gnus-inhibit-hiding
1840     (let ((inhibit-read-only t)
1841           (case-fold-search t)
1842           (max (1+ (length gnus-sorted-header-list)))
1843           (inhibit-point-motion-hooks t)
1844           (cur (current-buffer))
1845           ignored visible beg)
1846       (save-excursion
1847         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1848         ;; group parameters, so we should go to the summary buffer.
1849         (when (prog1
1850                   (condition-case nil
1851                       (progn (set-buffer gnus-summary-buffer) t)
1852                     (error nil))
1853                 (setq ignored (when (not gnus-visible-headers)
1854                                 (cond ((stringp gnus-ignored-headers)
1855                                        gnus-ignored-headers)
1856                                       ((listp gnus-ignored-headers)
1857                                        (mapconcat 'identity
1858                                                   gnus-ignored-headers
1859                                                   "\\|"))))
1860                       visible (cond ((stringp gnus-visible-headers)
1861                                      gnus-visible-headers)
1862                                     ((and gnus-visible-headers
1863                                           (listp gnus-visible-headers))
1864                                      (mapconcat 'identity
1865                                                 gnus-visible-headers
1866                                                 "\\|")))))
1867           (set-buffer cur))
1868         (save-restriction
1869           ;; First we narrow to just the headers.
1870           (article-narrow-to-head)
1871           ;; Hide any "From " lines at the beginning of (mail) articles.
1872           (while (looking-at "From ")
1873             (forward-line 1))
1874           (unless (bobp)
1875             (delete-region (point-min) (point)))
1876           ;; Then treat the rest of the header lines.
1877           ;; Then we use the two regular expressions
1878           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1879           ;; select which header lines is to remain visible in the
1880           ;; article buffer.
1881           (while (re-search-forward "^[^ \t:]*:" nil t)
1882             (beginning-of-line)
1883             ;; Mark the rank of the header.
1884             (put-text-property
1885              (point) (1+ (point)) 'message-rank
1886              (if (or (and visible (looking-at visible))
1887                      (and ignored
1888                           (not (looking-at ignored))))
1889                  (gnus-article-header-rank)
1890                (+ 2 max)))
1891             (forward-line 1))
1892           (message-sort-headers-1)
1893           (when (setq beg (text-property-any
1894                            (point-min) (point-max) 'message-rank (+ 2 max)))
1895             ;; We delete the unwanted headers.
1896             (gnus-add-wash-type 'headers)
1897             (add-text-properties (point-min) (+ 5 (point-min))
1898                                  '(article-type headers dummy-invisible t))
1899             (delete-region beg (point-max))))))))
1900
1901 (defun article-hide-boring-headers (&optional arg)
1902   "Toggle hiding of headers that aren't very interesting.
1903 If given a negative prefix, always show; if given a positive prefix,
1904 always hide."
1905   (interactive (gnus-article-hidden-arg))
1906   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1907              (not gnus-show-all-headers))
1908     (save-excursion
1909       (save-restriction
1910         (let ((inhibit-read-only t)
1911               (inhibit-point-motion-hooks t))
1912           (article-narrow-to-head)
1913           (dolist (elem gnus-boring-article-headers)
1914             (goto-char (point-min))
1915             (cond
1916              ;; Hide empty headers.
1917              ((eq elem 'empty)
1918               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1919                 (forward-line -1)
1920                 (gnus-article-hide-text-type
1921                  (point-at-bol)
1922                  (progn
1923                    (end-of-line)
1924                    (if (re-search-forward "^[^ \t]" nil t)
1925                        (match-beginning 0)
1926                      (point-max)))
1927                  'boring-headers)))
1928              ;; Hide boring Newsgroups header.
1929              ((eq elem 'newsgroups)
1930               (when (gnus-string-equal
1931                      (gnus-fetch-field "newsgroups")
1932                      (gnus-group-real-name
1933                       (if (boundp 'gnus-newsgroup-name)
1934                           gnus-newsgroup-name
1935                         "")))
1936                 (gnus-article-hide-header "newsgroups")))
1937              ((eq elem 'to-address)
1938               (let ((to (message-fetch-field "to"))
1939                     (to-address
1940                      (gnus-parameter-to-address
1941                       (if (boundp 'gnus-newsgroup-name)
1942                           gnus-newsgroup-name ""))))
1943                 (when (and to to-address
1944                            (ignore-errors
1945                              (gnus-string-equal
1946                               ;; only one address in To
1947                               (nth 1 (mail-extract-address-components to))
1948                               to-address)))
1949                   (gnus-article-hide-header "to"))))
1950              ((eq elem 'to-list)
1951               (let ((to (message-fetch-field "to"))
1952                     (to-list
1953                      (gnus-parameter-to-list
1954                       (if (boundp 'gnus-newsgroup-name)
1955                           gnus-newsgroup-name ""))))
1956                 (when (and to to-list
1957                            (ignore-errors
1958                              (gnus-string-equal
1959                               ;; only one address in To
1960                               (nth 1 (mail-extract-address-components to))
1961                               to-list)))
1962                   (gnus-article-hide-header "to"))))
1963              ((eq elem 'cc-list)
1964               (let ((cc (message-fetch-field "cc"))
1965                     (to-list
1966                      (gnus-parameter-to-list
1967                       (if (boundp 'gnus-newsgroup-name)
1968                           gnus-newsgroup-name ""))))
1969                 (when (and cc to-list
1970                            (ignore-errors
1971                              (gnus-string-equal
1972                               ;; only one address in CC
1973                               (nth 1 (mail-extract-address-components cc))
1974                               to-list)))
1975                   (gnus-article-hide-header "cc"))))
1976              ((eq elem 'followup-to)
1977               (when (gnus-string-equal
1978                      (message-fetch-field "followup-to")
1979                      (message-fetch-field "newsgroups"))
1980                 (gnus-article-hide-header "followup-to")))
1981              ((eq elem 'reply-to)
1982               (if (gnus-group-find-parameter
1983                    gnus-newsgroup-name 'broken-reply-to)
1984                   (gnus-article-hide-header "reply-to")
1985                 (let ((from (message-fetch-field "from"))
1986                       (reply-to (message-fetch-field "reply-to")))
1987                   (when
1988                       (and
1989                        from reply-to
1990                        (ignore-errors
1991                          (equal
1992                           (sort (mapcar
1993                                  (lambda (x) (downcase (cadr x)))
1994                                  (mail-extract-address-components from t))
1995                                 'string<)
1996                           (sort (mapcar
1997                                  (lambda (x) (downcase (cadr x)))
1998                                  (mail-extract-address-components reply-to t))
1999                                 'string<))))
2000                     (gnus-article-hide-header "reply-to")))))
2001              ((eq elem 'date)
2002               (let ((date (with-current-buffer gnus-original-article-buffer
2003                             ;; If date in `gnus-article-buffer' is localized
2004                             ;; (`gnus-treat-date-user-defined'),
2005                             ;; `days-between' might fail.
2006                             (message-fetch-field "date"))))
2007                 (when (and date
2008                            (< (days-between (current-time-string) date)
2009                               4))
2010                   (gnus-article-hide-header "date"))))
2011              ((eq elem 'long-to)
2012               (let ((to (message-fetch-field "to"))
2013                     (cc (message-fetch-field "cc")))
2014                 (when (> (length to) 1024)
2015                   (gnus-article-hide-header "to"))
2016                 (when (> (length cc) 1024)
2017                   (gnus-article-hide-header "cc"))))
2018              ((eq elem 'many-to)
2019               (let ((to-count 0)
2020                     (cc-count 0))
2021                 (goto-char (point-min))
2022                 (while (re-search-forward "^to:" nil t)
2023                   (setq to-count (1+ to-count)))
2024                 (when (> to-count 1)
2025                   (while (> to-count 0)
2026                     (goto-char (point-min))
2027                     (save-restriction
2028                       (re-search-forward "^to:" nil nil to-count)
2029                       (forward-line -1)
2030                       (narrow-to-region (point) (point-max))
2031                       (gnus-article-hide-header "to"))
2032                     (setq to-count (1- to-count))))
2033                 (goto-char (point-min))
2034                 (while (re-search-forward "^cc:" nil t)
2035                   (setq cc-count (1+ cc-count)))
2036                 (when (> cc-count 1)
2037                   (while (> cc-count 0)
2038                     (goto-char (point-min))
2039                     (save-restriction
2040                       (re-search-forward "^cc:" nil nil cc-count)
2041                       (forward-line -1)
2042                       (narrow-to-region (point) (point-max))
2043                       (gnus-article-hide-header "cc"))
2044                     (setq cc-count (1- cc-count)))))))))))))
2045
2046 (defun gnus-article-hide-header (header)
2047   (save-excursion
2048     (goto-char (point-min))
2049     (when (re-search-forward (concat "^" header ":") nil t)
2050       (gnus-article-hide-text-type
2051        (point-at-bol)
2052        (progn
2053          (end-of-line)
2054          (if (re-search-forward "^[^ \t]" nil t)
2055              (match-beginning 0)
2056            (point-max)))
2057        'boring-headers))))
2058
2059 (defvar gnus-article-normalized-header-length 40
2060   "Length of normalized headers.")
2061
2062 (defun article-normalize-headers ()
2063   "Make all header lines 40 characters long."
2064   (interactive)
2065   (let ((inhibit-read-only t)
2066         column)
2067     (save-excursion
2068       (save-restriction
2069         (article-narrow-to-head)
2070         (while (not (eobp))
2071           (cond
2072            ((< (setq column (- (point-at-eol) (point)))
2073                gnus-article-normalized-header-length)
2074             (end-of-line)
2075             (insert (make-string
2076                      (- gnus-article-normalized-header-length column)
2077                      ? )))
2078            ((> column gnus-article-normalized-header-length)
2079             (gnus-put-text-property
2080              (progn
2081                (forward-char gnus-article-normalized-header-length)
2082                (point))
2083              (point-at-eol)
2084              'invisible t))
2085            (t
2086             ;; Do nothing.
2087             ))
2088           (forward-line 1))))))
2089
2090 (defun article-treat-dumbquotes ()
2091   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2092 Note that this function guesses whether a character is a sm*rtq**t* or
2093 not, so it should only be used interactively.
2094
2095 Sm*rtq**t*s are M****s***'s unilateral extension to the
2096 iso-8859-1 character map in an attempt to provide more quoting
2097 characters.  If you see something like \\222 or \\264 where
2098 you're expecting some kind of apostrophe or quotation mark, then
2099 try this wash."
2100   (interactive)
2101   (article-translate-strings gnus-article-dumbquotes-map))
2102
2103 (defun article-translate-characters (from to)
2104   "Translate all characters in the body of the article according to FROM and TO.
2105 FROM is a string of characters to translate from; to is a string of
2106 characters to translate to."
2107   (save-excursion
2108     (when (article-goto-body)
2109       (let ((inhibit-read-only t)
2110             (x (make-string 225 ?x))
2111             (i -1))
2112         (while (< (incf i) (length x))
2113           (aset x i i))
2114         (setq i 0)
2115         (while (< i (length from))
2116           (aset x (aref from i) (aref to i))
2117           (incf i))
2118         (translate-region (point) (point-max) x)))))
2119
2120 (defun article-translate-strings (map)
2121   "Translate all string in the body of the article according to MAP.
2122 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2123   (save-excursion
2124     (when (article-goto-body)
2125       (let ((inhibit-read-only t))
2126         (dolist (elem map)
2127           (save-excursion
2128             (while (search-forward (car elem) nil t)
2129               (replace-match (cadr elem)))))))))
2130
2131 (defun article-treat-overstrike ()
2132   "Translate overstrikes into bold text."
2133   (interactive)
2134   (save-excursion
2135     (when (article-goto-body)
2136       (let ((inhibit-read-only t))
2137         (while (search-forward "\b" nil t)
2138           (let ((next (char-after))
2139                 (previous (char-after (- (point) 2))))
2140             ;; We do the boldification/underlining by hiding the
2141             ;; overstrikes and putting the proper text property
2142             ;; on the letters.
2143             (cond
2144              ((eq next previous)
2145               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2146               (put-text-property (point) (1+ (point)) 'face 'bold))
2147              ((eq next ?_)
2148               (gnus-article-hide-text-type
2149                (1- (point)) (1+ (point)) 'overstrike)
2150               (put-text-property
2151                (- (point) 2) (1- (point)) 'face 'underline))
2152              ((eq previous ?_)
2153               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2154               (put-text-property
2155                (point) (1+ (point)) 'face 'underline)))))))))
2156
2157 (defun article-treat-ansi-sequences ()
2158   "Translate ANSI SGR control sequences into overlays or extents."
2159   (interactive)
2160   (save-excursion
2161     (when (article-goto-body)
2162       (let ((inhibit-read-only t))
2163         (ansi-color-apply-on-region (point) (point-max))))))
2164
2165 (defun gnus-article-treat-unfold-headers ()
2166   "Unfold folded message headers.
2167 Only the headers that fit into the current window width will be
2168 unfolded."
2169   (interactive)
2170   (gnus-with-article-headers
2171     (let (length)
2172       (while (not (eobp))
2173         (save-restriction
2174           (mail-header-narrow-to-field)
2175           (let* ((header (buffer-string))
2176                  (unfoldable
2177                   (or (equal gnus-article-unfold-long-headers t)
2178                       (and (stringp gnus-article-unfold-long-headers)
2179                            (string-match gnus-article-unfold-long-headers header)))))
2180             (with-temp-buffer
2181               (insert header)
2182               (goto-char (point-min))
2183               (while (re-search-forward "\n[\t ]" nil t)
2184                 (replace-match " " t t)))
2185             (setq length (- (point-max) (point-min) 1))
2186             (when (or unfoldable
2187                       (< length (window-width)))
2188               (while (re-search-forward "\n[\t ]" nil t)
2189                 (replace-match " " t t))))
2190           (goto-char (point-max)))))))
2191
2192 (defun gnus-article-treat-fold-headers ()
2193   "Fold message headers."
2194   (interactive)
2195   (gnus-with-article-headers
2196     (while (not (eobp))
2197       (save-restriction
2198         (mail-header-narrow-to-field)
2199         (mail-header-fold-field)
2200         (goto-char (point-max))))))
2201
2202 (defun gnus-treat-smiley ()
2203   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2204   (interactive)
2205   (gnus-with-article-buffer
2206     (if (memq 'smiley gnus-article-wash-types)
2207         (gnus-delete-images 'smiley)
2208       (article-goto-body)
2209       (let ((images (smiley-region (point) (point-max))))
2210         (when images
2211           (gnus-add-wash-type 'smiley)
2212           (dolist (image images)
2213             (gnus-add-image 'smiley image)))))))
2214
2215 (defun gnus-article-remove-images ()
2216   "Remove all images from the article buffer."
2217   (interactive)
2218   (gnus-with-article-buffer
2219     (dolist (elem gnus-article-image-alist)
2220       (gnus-delete-images (car elem)))))
2221
2222 (defun gnus-article-treat-fold-newsgroups ()
2223   "Unfold folded message headers.
2224 Only the headers that fit into the current window width will be
2225 unfolded."
2226   (interactive)
2227   (gnus-with-article-headers
2228     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2229       (save-restriction
2230         (mail-header-narrow-to-field)
2231         (while (re-search-forward ", *" nil t)
2232           (replace-match ", " t t))
2233         (mail-header-fold-field)
2234         (goto-char (point-max))))))
2235
2236 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2237   "Value of `truncate-lines' in Gnus Article buffer.
2238 Valid values are nil, t, `head', `first', `last', an integer or a
2239 predicate.  See Info node `(gnus)Customizing Articles'."
2240   :version "23.1" ;; No Gnus
2241   :group 'gnus-article
2242   ;; :link '(custom-manual "(gnus)Customizing Articles")
2243   :type 'boolean)
2244
2245 (defun gnus-article-toggle-truncate-lines (&optional arg)
2246   "Toggle whether to fold or truncate long lines in article the buffer.
2247 If ARG is non-nil and not a number, toggle
2248 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2249 long lines if and only if arg is positive."
2250   (interactive "P")
2251   (cond
2252    ((and (numberp arg) (> arg 0))
2253     (setq gnus-article-truncate-lines t))
2254    ((numberp arg)
2255     (setq gnus-article-truncate-lines nil))
2256    (arg
2257     (setq gnus-article-truncate-lines
2258           (not gnus-article-truncate-lines))))
2259   (gnus-with-article-buffer
2260     (cond
2261      ((and (numberp arg) (> arg 0))
2262       (setq truncate-lines nil))
2263      ((numberp arg)
2264       (setq truncate-lines t)))
2265     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2266     ;; `toggle-truncate-lines' needs an argument.
2267     (toggle-truncate-lines)))
2268
2269 (defun gnus-article-treat-body-boundary ()
2270   "Place a boundary line at the end of the headers."
2271   (interactive)
2272   (when (and gnus-body-boundary-delimiter
2273              (> (length gnus-body-boundary-delimiter) 0))
2274     (gnus-with-article-headers
2275       (goto-char (point-max))
2276       (let ((start (point)))
2277         (insert "X-Boundary: ")
2278         (gnus-add-text-properties start (point) '(invisible t intangible t))
2279         (insert (let (str)
2280                   (while (>= (1- (window-width)) (length str))
2281                     (setq str (concat str gnus-body-boundary-delimiter)))
2282                   (substring str 0 (1- (window-width))))
2283                 "\n")
2284         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2285
2286 (defun article-fill-long-lines ()
2287   "Fill lines that are wider than the window width."
2288   (interactive)
2289   (save-excursion
2290     (let ((inhibit-read-only t)
2291           (width (window-width (get-buffer-window (current-buffer)))))
2292       (save-restriction
2293         (article-goto-body)
2294         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2295           (while (not (eobp))
2296             (end-of-line)
2297             (when (>= (current-column) (min fill-column width))
2298               (narrow-to-region (min (1+ (point)) (point-max))
2299                                 (point-at-bol))
2300               (let ((goback (point-marker)))
2301                 (fill-paragraph nil)
2302                 (goto-char (marker-position goback)))
2303               (widen))
2304             (forward-line 1)))))))
2305
2306 (defun article-capitalize-sentences ()
2307   "Capitalize the first word in each sentence."
2308   (interactive)
2309   (save-excursion
2310     (let ((inhibit-read-only t)
2311           (paragraph-start "^[\n\^L]"))
2312       (article-goto-body)
2313       (while (not (eobp))
2314         (capitalize-word 1)
2315         (forward-sentence)))))
2316
2317 (defun article-remove-cr ()
2318   "Remove trailing CRs and then translate remaining CRs into LFs."
2319   (interactive)
2320   (save-excursion
2321     (let ((inhibit-read-only t))
2322       (goto-char (point-min))
2323       (while (re-search-forward "\r+$" nil t)
2324         (replace-match "" t t))
2325       (goto-char (point-min))
2326       (while (search-forward "\r" nil t)
2327         (replace-match "\n" t t)))))
2328
2329 (defun article-remove-trailing-blank-lines ()
2330   "Remove all trailing blank lines from the article."
2331   (interactive)
2332   (save-excursion
2333     (let ((inhibit-read-only t))
2334       (goto-char (point-max))
2335       (delete-region
2336        (point)
2337        (progn
2338          (while (and (not (bobp))
2339                      (looking-at "^[ \t]*$")
2340                      (not (gnus-annotation-in-region-p
2341                            (point) (point-at-eol))))
2342            (forward-line -1))
2343          (forward-line 1)
2344          (point))))))
2345
2346 (defvar gnus-face-properties-alist)
2347
2348 (defun article-display-face (&optional force)
2349   "Display any Face headers in the header."
2350   (interactive (list 'force))
2351   (let ((wash-face-p buffer-read-only))
2352     (gnus-with-article-headers
2353       ;; When displaying parts, this function can be called several times on
2354       ;; the same article, without any intended toggle semantic (as typing `W
2355       ;; D d' would have). So face deletion must occur only when we come from
2356       ;; an interactive command, that is when the *Article* buffer is
2357       ;; read-only.
2358       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2359           (gnus-delete-images 'face)
2360         (let ((from (message-fetch-field "from"))
2361               face faces)
2362           (save-current-buffer
2363             (when (and wash-face-p
2364                        (gnus-buffer-live-p gnus-original-article-buffer)
2365                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2366               (set-buffer gnus-original-article-buffer))
2367             (save-restriction
2368               (mail-narrow-to-head)
2369               (when (or force
2370                         ;; Check whether this face is censored.
2371                         (not (and gnus-article-x-face-too-ugly
2372                                   (or from
2373                                       (setq from (message-fetch-field "from")))
2374                                   (string-match gnus-article-x-face-too-ugly
2375                                                 from))))
2376                 (while (gnus-article-goto-header "Face")
2377                   (push (mail-header-field-value) faces)))))
2378           (when faces
2379             (goto-char (point-min))
2380             (let (png image)
2381               (unless (setq from (gnus-article-goto-header "from"))
2382                 (insert "From:")
2383                 (setq from (point))
2384                 (insert " [no `from' set]\n"))
2385               (while faces
2386                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2387                   (setq image
2388                         (apply 'gnus-create-image png 'png t
2389                                (cdr (assq 'png gnus-face-properties-alist))))
2390                   (goto-char from)
2391                   (gnus-add-wash-type 'face)
2392                   (gnus-add-image 'face image)
2393                   (gnus-put-image image nil 'face))))))))))
2394
2395 (defun article-display-x-face (&optional force)
2396   "Look for an X-Face header and display it if present."
2397   (interactive (list 'force))
2398   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2399     (gnus-with-article-headers
2400       ;; Delete the old process, if any.
2401       (when (process-status "article-x-face")
2402         (delete-process "article-x-face"))
2403       ;; See the comment in `article-display-face'.
2404       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2405           ;; We have already displayed X-Faces, so we remove them
2406           ;; instead.
2407           (gnus-delete-images 'xface)
2408         ;; Display X-Faces.
2409         (let ((from (message-fetch-field "from"))
2410               x-faces face)
2411           (save-current-buffer
2412             (when (and wash-face-p
2413                        (gnus-buffer-live-p gnus-original-article-buffer)
2414                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2415               ;; If type `W f', use gnus-original-article-buffer,
2416               ;; otherwise use the current buffer because displaying
2417               ;; RFC822 parts calls this function too.
2418               (set-buffer gnus-original-article-buffer))
2419             (save-restriction
2420               (mail-narrow-to-head)
2421               (and gnus-article-x-face-command
2422                    (or force
2423                        ;; Check whether this face is censored.
2424                        (not (and gnus-article-x-face-too-ugly
2425                                  (or from
2426                                      (setq from (message-fetch-field "from")))
2427                                  (string-match gnus-article-x-face-too-ugly
2428                                                from))))
2429                    (while (gnus-article-goto-header "X-Face")
2430                      (push (mail-header-field-value) x-faces)))))
2431           (when x-faces
2432             ;; We display the face.
2433             (cond ((functionp gnus-article-x-face-command)
2434                    ;; The command is a lisp function, so we call it.
2435                    (mapc gnus-article-x-face-command x-faces))
2436                   ((stringp gnus-article-x-face-command)
2437                    ;; The command is a string, so we interpret the command
2438                    ;; as a, well, command, and fork it off.
2439                    (let ((process-connection-type nil))
2440                      (gnus-set-process-query-on-exit-flag
2441                       (start-process
2442                        "article-x-face" nil shell-file-name
2443                        shell-command-switch gnus-article-x-face-command)
2444                       nil)
2445                      ;; Sending multiple EOFs to xv doesn't work,
2446                      ;; so we only do a single external face.
2447                      (with-temp-buffer
2448                        (insert (car x-faces))
2449                        (process-send-region "article-x-face"
2450                                             (point-min) (point-max)))
2451                      (process-send-eof "article-x-face")))
2452                   (t
2453                    (error "`%s' set to `%s' is not a function"
2454                           gnus-article-x-face-command
2455                           'gnus-article-x-face-command)))))))))
2456
2457 (defun article-decode-mime-words ()
2458   "Decode all MIME-encoded words in the article."
2459   (interactive)
2460   (gnus-with-article-buffer
2461     (let ((inhibit-point-motion-hooks t)
2462           (mail-parse-charset gnus-newsgroup-charset)
2463           (mail-parse-ignored-charsets
2464            (with-current-buffer gnus-summary-buffer
2465              gnus-newsgroup-ignored-charsets)))
2466       (mail-decode-encoded-word-region (point-min) (point-max)))))
2467
2468 (defun article-decode-charset (&optional prompt)
2469   "Decode charset-encoded text in the article.
2470 If PROMPT (the prefix), prompt for a coding system to use."
2471   (interactive "P")
2472   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2473         (inhibit-read-only t)
2474         (mail-parse-charset gnus-newsgroup-charset)
2475         (mail-parse-ignored-charsets
2476          (save-excursion (condition-case nil
2477                              (set-buffer gnus-summary-buffer)
2478                            (error))
2479                          gnus-newsgroup-ignored-charsets))
2480         ct cte ctl charset format)
2481     (save-excursion
2482       (save-restriction
2483         (article-narrow-to-head)
2484         (setq ct (message-fetch-field "Content-Type" t)
2485               cte (message-fetch-field "Content-Transfer-Encoding" t)
2486               ctl (and ct (mail-header-parse-content-type ct))
2487               charset (cond
2488                        (prompt
2489                         (mm-read-coding-system "Charset to decode: "))
2490                        (ctl
2491                         (mail-content-type-get ctl 'charset)))
2492               format (and ctl (mail-content-type-get ctl 'format)))
2493         (when cte
2494           (setq cte (mail-header-strip cte)))
2495         (if (and ctl (not (string-match "/" (car ctl))))
2496             (setq ctl nil))
2497         (goto-char (point-max)))
2498       (forward-line 1)
2499       (save-restriction
2500         (narrow-to-region (point) (point-max))
2501         (when (and (eq mail-parse-charset 'gnus-decoded)
2502                    (eq (mm-body-7-or-8) '8bit))
2503           ;; The text code could have been decoded.
2504           (setq charset mail-parse-charset))
2505         (when (and (or (not ctl)
2506                        (equal (car ctl) "text/plain"))
2507                    (not format)) ;; article with format will decode later.
2508           (mm-decode-body
2509            charset (and cte (intern (downcase
2510                                      (gnus-strip-whitespace cte))))
2511            (car ctl)))))))
2512
2513 (defun article-decode-encoded-words ()
2514   "Remove encoded-word encoding from headers."
2515   (let ((inhibit-point-motion-hooks t)
2516         (mail-parse-charset gnus-newsgroup-charset)
2517         (mail-parse-ignored-charsets
2518          (save-excursion (condition-case nil
2519                              (set-buffer gnus-summary-buffer)
2520                            (error))
2521                          gnus-newsgroup-ignored-charsets))
2522         (inhibit-read-only t)
2523         end start)
2524     (goto-char (point-min))
2525     (when (search-forward "\n\n" nil 'move)
2526       (forward-line -1))
2527     (setq end (point))
2528     (while (not (bobp))
2529       (while (progn
2530                (forward-line -1)
2531                (and (not (bobp))
2532                     (memq (char-after) '(?\t ? )))))
2533       (setq start (point))
2534       (if (looking-at "\
2535 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2536 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2537           (funcall gnus-decode-address-function start end)
2538         (funcall gnus-decode-header-function start end))
2539       (goto-char (setq end start)))))
2540
2541 (defun article-decode-group-name ()
2542   "Decode group names in Newsgroups, Followup-To and Xref headers."
2543   (let ((inhibit-point-motion-hooks t)
2544         (inhibit-read-only t)
2545         (method (gnus-find-method-for-group gnus-newsgroup-name))
2546         regexp)
2547     (when (and (or gnus-group-name-charset-method-alist
2548                    gnus-group-name-charset-group-alist)
2549                (gnus-buffer-live-p gnus-original-article-buffer))
2550       (save-restriction
2551         (article-narrow-to-head)
2552         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2553           (with-current-buffer gnus-original-article-buffer
2554             (goto-char (point-min)))
2555           (setq regexp (concat "^" header
2556                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2557           (while (re-search-forward regexp nil t)
2558             (replace-match (save-match-data
2559                              (gnus-decode-newsgroups
2560                               ;; XXX how to use data in article buffer?
2561                               (with-current-buffer gnus-original-article-buffer
2562                                 (re-search-forward regexp nil t)
2563                                 (match-string 1))
2564                               gnus-newsgroup-name method))
2565                            t t nil 1))
2566           (goto-char (point-min)))))))
2567
2568 (autoload 'idna-to-unicode "idna")
2569
2570 (defun article-decode-idna-rhs ()
2571   "Decode IDNA strings in RHS in various headers in current buffer.
2572 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2573 Mail-Reply-To: and Mail-Followup-To:."
2574   (when gnus-use-idna
2575     (save-restriction
2576       (let ((inhibit-point-motion-hooks t)
2577             (inhibit-read-only t))
2578         (article-narrow-to-head)
2579         (goto-char (point-min))
2580         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2581           (let (ace unicode)
2582             (when (save-match-data
2583                     (and (setq ace (match-string 1))
2584                          (save-excursion
2585                            (and (re-search-backward "^[^ \t]" nil t)
2586                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2587                          (setq unicode (idna-to-unicode ace))))
2588               (unless (string= ace unicode)
2589                 (replace-match unicode nil nil nil 1)))))))))
2590
2591 (defun article-de-quoted-unreadable (&optional force read-charset)
2592   "Translate a quoted-printable-encoded article.
2593 If FORCE, decode the article whether it is marked as quoted-printable
2594 or not.
2595 If READ-CHARSET, ask for a coding system."
2596   (interactive (list 'force current-prefix-arg))
2597   (save-excursion
2598     (let ((inhibit-read-only t) type charset)
2599       (if (gnus-buffer-live-p gnus-original-article-buffer)
2600           (with-current-buffer gnus-original-article-buffer
2601             (setq type
2602                   (gnus-fetch-field "content-transfer-encoding"))
2603             (let* ((ct (gnus-fetch-field "content-type"))
2604                    (ctl (and ct (mail-header-parse-content-type ct))))
2605               (setq charset (and ctl
2606                                  (mail-content-type-get ctl 'charset)))
2607               (if (stringp charset)
2608                   (setq charset (intern (downcase charset)))))))
2609       (if read-charset
2610           (setq charset (mm-read-coding-system "Charset: " charset)))
2611       (unless charset
2612         (setq charset gnus-newsgroup-charset))
2613       (when (or force
2614                 (and type (let ((case-fold-search t))
2615                             (string-match "quoted-printable" type))))
2616         (article-goto-body)
2617         (quoted-printable-decode-region
2618          (point) (point-max) (mm-charset-to-coding-system charset))))))
2619
2620 (defun article-de-base64-unreadable (&optional force read-charset)
2621   "Translate a base64 article.
2622 If FORCE, decode the article whether it is marked as base64 not.
2623 If READ-CHARSET, ask for a coding system."
2624   (interactive (list 'force current-prefix-arg))
2625   (save-excursion
2626     (let ((inhibit-read-only t) type charset)
2627       (if (gnus-buffer-live-p gnus-original-article-buffer)
2628           (with-current-buffer gnus-original-article-buffer
2629             (setq type
2630                   (gnus-fetch-field "content-transfer-encoding"))
2631             (let* ((ct (gnus-fetch-field "content-type"))
2632                    (ctl (and ct (mail-header-parse-content-type ct))))
2633               (setq charset (and ctl
2634                                  (mail-content-type-get ctl 'charset)))
2635               (if (stringp charset)
2636                   (setq charset (intern (downcase charset)))))))
2637       (if read-charset
2638           (setq charset (mm-read-coding-system "Charset: " charset)))
2639       (unless charset
2640         (setq charset gnus-newsgroup-charset))
2641       (when (or force
2642                 (and type (let ((case-fold-search t))
2643                             (string-match "base64" type))))
2644         (article-goto-body)
2645         (save-restriction
2646           (narrow-to-region (point) (point-max))
2647           (base64-decode-region (point-min) (point-max))
2648           (mm-decode-coding-region
2649            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2650
2651 (eval-when-compile
2652   (require 'rfc1843))
2653
2654 (defun article-decode-HZ ()
2655   "Translate a HZ-encoded article."
2656   (interactive)
2657   (require 'rfc1843)
2658   (save-excursion
2659     (let ((inhibit-read-only t))
2660       (rfc1843-decode-region (point-min) (point-max)))))
2661
2662 (defun article-unsplit-urls ()
2663   "Remove the newlines that some other mailers insert into URLs."
2664   (interactive)
2665   (save-excursion
2666     (let ((inhibit-read-only t))
2667       (goto-char (point-min))
2668       (while (re-search-forward
2669               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2670         (replace-match "\\1\\3" t)))
2671     (when (interactive-p)
2672       (gnus-treat-article nil))))
2673
2674
2675 (defun article-wash-html (&optional read-charset)
2676   "Format an HTML article.
2677 If READ-CHARSET, ask for a coding system.  If it is a number, the
2678 charset defined in `gnus-summary-show-article-charset-alist' is used."
2679   (interactive "P")
2680   (save-excursion
2681     (let ((inhibit-read-only t)
2682           charset)
2683       (if read-charset
2684           (if (or (and (numberp read-charset)
2685                        (setq charset
2686                              (cdr
2687                               (assq read-charset
2688                                     gnus-summary-show-article-charset-alist))))
2689                   (setq charset (mm-read-coding-system "Charset: ")))
2690               (let ((gnus-summary-show-article-charset-alist
2691                      (list (cons 1 charset))))
2692                 (with-current-buffer gnus-summary-buffer
2693                   (gnus-summary-show-article 1)))
2694             (error "No charset is given"))
2695         (when (gnus-buffer-live-p gnus-original-article-buffer)
2696           (with-current-buffer gnus-original-article-buffer
2697             (let* ((ct (gnus-fetch-field "content-type"))
2698                    (ctl (and ct (mail-header-parse-content-type ct))))
2699               (setq charset (and ctl
2700                                  (mail-content-type-get ctl 'charset)))
2701               (when (stringp charset)
2702                 (setq charset (intern (downcase charset)))))))
2703         (unless charset
2704           (setq charset gnus-newsgroup-charset)))
2705       (article-goto-body)
2706       (save-window-excursion
2707         (save-restriction
2708           (narrow-to-region (point) (point-max))
2709           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2710                  (entry (assq func mm-text-html-washer-alist)))
2711             (when entry
2712               (setq func (cdr entry)))
2713             (cond
2714              ((functionp func)
2715               (funcall func))
2716              (t
2717               (apply (car func) (cdr func))))))))))
2718
2719 ;; External.
2720 (declare-function w3-region "ext:w3-display" (st nd))
2721
2722 (defun gnus-article-wash-html-with-w3 ()
2723   "Wash the current buffer with w3."
2724   (mm-setup-w3)
2725   (let ((w3-strict-width (window-width))
2726         (url-standalone-mode t)
2727         (url-gateway-unplugged t)
2728         (w3-honor-stylesheets nil))
2729     (condition-case ()
2730         (w3-region (point-min) (point-max))
2731       (error))))
2732
2733 ;; External.
2734 (declare-function w3m-region "ext:w3m" (start end &optional url charset))
2735
2736 (defun gnus-article-wash-html-with-w3m ()
2737   "Wash the current buffer with emacs-w3m."
2738   (mm-setup-w3m)
2739   (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2740         w3m-force-redisplay)
2741     (w3m-region (point-min) (point-max)))
2742   ;; Put the mark meaning this part was rendered by emacs-w3m.
2743   (put-text-property (point-min) (point-max) 'mm-inline-text-html-with-w3m t)
2744   (when (and mm-inline-text-html-with-w3m-keymap
2745              (boundp 'w3m-minor-mode-map)
2746              w3m-minor-mode-map)
2747     (if (and (boundp 'w3m-link-map)
2748              w3m-link-map)
2749         (let* ((start (point-min))
2750                (end (point-max))
2751                (on (get-text-property start 'w3m-href-anchor))
2752                (map (copy-keymap w3m-link-map))
2753                next)
2754           (set-keymap-parent map w3m-minor-mode-map)
2755           (while (< start end)
2756             (if on
2757                 (progn
2758                   (setq next (or (text-property-any start end
2759                                                     'w3m-href-anchor nil)
2760                                  end))
2761                   (put-text-property start next 'keymap map))
2762               (setq next (or (text-property-not-all start end
2763                                                     'w3m-href-anchor nil)
2764                              end))
2765               (put-text-property start next 'keymap w3m-minor-mode-map))
2766             (setq start next
2767                   on (not on))))
2768       (put-text-property (point-min) (point-max) 'keymap w3m-minor-mode-map))))
2769
2770 (defvar charset) ;; Bound by `article-wash-html'.
2771
2772 (defun gnus-article-wash-html-with-w3m-standalone ()
2773   "Wash the current buffer with w3m."
2774   (if (mm-w3m-standalone-supports-m17n-p)
2775       (progn
2776         (unless (mm-coding-system-p charset) ;; Bound by `article-wash-html'.
2777           ;; The default.
2778           (setq charset 'iso-8859-1))
2779         (let ((coding-system-for-write charset)
2780               (coding-system-for-read charset))
2781           (call-process-region
2782            (point-min) (point-max)
2783            "w3m" t t nil "-dump" "-T" "text/html"
2784            "-I" (symbol-name charset) "-O" (symbol-name charset))))
2785     (mm-inline-wash-with-stdin nil "w3m" "-dump" "-T" "text/html")))
2786
2787 (defvar gnus-article-browse-html-temp-list nil
2788   "List of temporary files created by `gnus-article-browse-html-parts'.
2789 Internal variable.")
2790
2791 (defcustom gnus-article-browse-delete-temp 'ask
2792   "What to do with temporary files from `gnus-article-browse-html-parts'.
2793 If nil, don't delete temporary files.  If it is t, delete them on
2794 exit from the summary buffer.  If it is the symbol `file', query
2795 on each file, if it is `ask' ask once when exiting from the
2796 summary buffer."
2797   :group 'gnus-article
2798   :version "23.1" ;; No Gnus
2799   :type '(choice (const :tag "Don't delete" nil)
2800                  (const :tag "Don't ask" t)
2801                  (const :tag "Ask" ask)
2802                  (const :tag "Ask for each file" file)))
2803
2804 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2805
2806 (defun gnus-article-browse-delete-temp-files (&optional how)
2807   "Delete temp-files created by `gnus-article-browse-html-parts'."
2808   (when (and gnus-article-browse-html-temp-list
2809              (progn
2810                (or how (setq how gnus-article-browse-delete-temp))
2811                (if (eq how 'ask)
2812                    (let ((files (length gnus-article-browse-html-temp-list)))
2813                      (gnus-y-or-n-p (format
2814                                      "Delete all %s temporary HTML file%s? "
2815                                      files
2816                                      (if (> files 1) "s" ""))))
2817                  how)))
2818     (dolist (file gnus-article-browse-html-temp-list)
2819       (cond ((file-directory-p file)
2820              (when (or (not (eq how 'file))
2821                        (gnus-y-or-n-p
2822                         (format
2823                          "Delete temporary HTML file(s) in directory `%s'? "
2824                          (file-name-as-directory file))))
2825                (gnus-delete-directory file)))
2826             ((file-exists-p file)
2827              (when (or (not (eq how 'file))
2828                        (gnus-y-or-n-p
2829                         (format "Delete temporary HTML file `%s'? " file)))
2830                (delete-file file)))))
2831     ;; Also remove file from the list when not deleted or if file doesn't
2832     ;; exist anymore.
2833     (setq gnus-article-browse-html-temp-list nil))
2834   gnus-article-browse-html-temp-list)
2835
2836 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2837   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2838 Return file name."
2839   (save-match-data
2840     (let (file type)
2841       (catch 'found
2842         (dolist (handle handles)
2843           (cond
2844            ((not (listp handle)))
2845            ((equal (mm-handle-media-supertype handle) "multipart")
2846             (when (setq file (gnus-article-browse-html-save-cid-content
2847                               cid handle directory))
2848               (throw 'found file)))
2849            ((equal (concat "<" cid ">") (mm-handle-id handle))
2850             (setq file
2851                   (expand-file-name
2852                    (or (mail-content-type-get
2853                         (mm-handle-disposition handle) 'filename)
2854                        (mail-content-type-get
2855                         (setq type (mm-handle-type handle)) 'name)
2856                        (concat
2857                         (make-temp-name "cid")
2858                         (car (rassoc (car type) mailcap-mime-extensions))))
2859                    directory))
2860             (mm-save-part-to-file handle file)
2861             (throw 'found file))))))))
2862
2863 (defun gnus-article-browse-html-parts (list &optional header)
2864   "View all \"text/html\" parts from LIST.
2865 Recurse into multiparts.  The optional HEADER that should be a decoded
2866 message header will be added to the bodies of the \"text/html\" parts."
2867   ;; Internal function used by `gnus-article-browse-html-article'.
2868   (let (type file charset content cid-dir tmp-file showed)
2869     ;; Find and show the html-parts.
2870     (dolist (handle list)
2871       ;; If HTML, show it:
2872       (cond ((not (listp handle)))
2873             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2874                  (and (equal (car type) "message/external-body")
2875                       (or header
2876                           (setq file (or (mail-content-type-get type 'name)
2877                                          (mail-content-type-get
2878                                           (mm-handle-disposition handle)
2879                                           'filename))))
2880                       (or (mm-handle-cache handle)
2881                           (condition-case code
2882                               (progn (mm-extern-cache-contents handle) t)
2883                             (error
2884                              (gnus-message 3 "%s" (error-message-string code))
2885                              (when (>= gnus-verbose 3) (sit-for 2))
2886                              nil)))
2887                       (progn
2888                         (setq handle (mm-handle-cache handle)
2889                               type (mm-handle-type handle))
2890                         (equal (car type) "text/html"))))
2891              (setq charset (mail-content-type-get type 'charset)
2892                    content (mm-get-part handle))
2893              (with-temp-buffer
2894                (if (eq charset 'gnus-decoded)
2895                    (mm-enable-multibyte)
2896                  (mm-disable-multibyte))
2897                (insert content)
2898                ;; resolve cid contents
2899                (let ((case-fold-search t)
2900                      cid-file)
2901                  (goto-char (point-min))
2902                  (while (re-search-forward "\
2903 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2904                                            nil t)
2905                    (unless cid-dir
2906                      (setq cid-dir (mm-make-temp-file "cid" t))
2907                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2908                    (setq file nil
2909                          content nil)
2910                    (when (setq cid-file
2911                                (gnus-article-browse-html-save-cid-content
2912                                 (match-string 2)
2913                                 (with-current-buffer gnus-article-buffer
2914                                   gnus-article-mime-handles)
2915                                 cid-dir))
2916                      (replace-match (concat "file://" cid-file)
2917                                     nil nil nil 1))))
2918                (unless content (setq content (buffer-string))))
2919              (when (or charset header (not file))
2920                (setq tmp-file (mm-make-temp-file
2921                                ;; Do we need to care for 8.3 filenames?
2922                                "mm-" nil ".html")))
2923              ;; Add a meta html tag to specify charset and a header.
2924              (cond
2925               (header
2926                (let (title eheader body hcharset coding force-charset)
2927                  (with-temp-buffer
2928                    (mm-enable-multibyte)
2929                    (setq case-fold-search t)
2930                    (insert header "\n")
2931                    (setq title (message-fetch-field "subject"))
2932                    (goto-char (point-min))
2933                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2934                      (replace-match (cond ((match-beginning 1) "&lt;")
2935                                           ((match-beginning 2) "&gt;")
2936                                           (t "&amp;"))))
2937                    (goto-char (point-min))
2938                    (insert "<pre>\n")
2939                    (goto-char (point-max))
2940                    (insert "</pre>\n<hr>\n")
2941                    ;; We have to examine charset one by one since
2942                    ;; charset specified in parts might be different.
2943                    (if (eq charset 'gnus-decoded)
2944                        (setq charset 'utf-8
2945                              eheader (mm-encode-coding-string (buffer-string)
2946                                                               charset)
2947                              title (when title
2948                                      (mm-encode-coding-string title charset))
2949                              body (mm-encode-coding-string content charset)
2950                              force-charset t)
2951                      (setq hcharset (mm-find-mime-charset-region (point-min)
2952                                                                  (point-max)))
2953                      (cond ((= (length hcharset) 1)
2954                             (setq hcharset (car hcharset)
2955                                   coding (mm-charset-to-coding-system
2956                                           hcharset)))
2957                            ((> (length hcharset) 1)
2958                             (setq hcharset 'utf-8
2959                                   coding hcharset)))
2960                      (if coding
2961                          (if charset
2962                              (progn
2963                                (setq body
2964                                      (mm-charset-to-coding-system charset))
2965                                (if (eq coding body)
2966                                    (setq eheader (mm-encode-coding-string
2967                                                   (buffer-string) coding)
2968                                          title (when title
2969                                                  (mm-encode-coding-string
2970                                                   title coding))
2971                                          body content)
2972                                  (setq charset 'utf-8
2973                                        eheader (mm-encode-coding-string
2974                                                 (buffer-string) charset)
2975                                        title (when title
2976                                                (mm-encode-coding-string
2977                                                 title charset))
2978                                        body (mm-encode-coding-string
2979                                              (mm-decode-coding-string
2980                                               content body)
2981                                              charset)
2982                                        force-charset t)))
2983                            (setq charset hcharset
2984                                  eheader (mm-encode-coding-string
2985                                           (buffer-string) coding)
2986                                  title (when title
2987                                          (mm-encode-coding-string
2988                                           title coding))
2989                                  body content))
2990                        (setq eheader (mm-string-as-unibyte (buffer-string))
2991                              body content)))
2992                    (erase-buffer)
2993                    (mm-disable-multibyte)
2994                    (insert body)
2995                    (when charset
2996                      (mm-add-meta-html-tag handle charset force-charset))
2997                    (when title
2998                      (goto-char (point-min))
2999                      (unless (search-forward "<title>" nil t)
3000                        (re-search-forward "<head>\\s-*" nil t)
3001                        (insert "<title>" title "</title>\n")))
3002                    (goto-char (point-min))
3003                    (or (re-search-forward
3004                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
3005                        (re-search-forward
3006                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
3007                    (insert eheader)
3008                    (mm-write-region (point-min) (point-max)
3009                                     tmp-file nil nil nil 'binary t))))
3010               (charset
3011                (mm-with-unibyte-buffer
3012                  (insert (if (eq charset 'gnus-decoded)
3013                              (mm-encode-coding-string content
3014                                                       (setq charset 'utf-8))
3015                            content))
3016                  (if (or (mm-add-meta-html-tag handle charset)
3017                          (not file))
3018                      (mm-write-region (point-min) (point-max)
3019                                       tmp-file nil nil nil 'binary t)
3020                    (setq tmp-file nil))))
3021               (tmp-file
3022                (mm-save-part-to-file handle tmp-file)))
3023              (when tmp-file
3024                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
3025              (add-hook 'gnus-summary-prepare-exit-hook
3026                        'gnus-article-browse-delete-temp-files)
3027              (add-hook 'gnus-exit-gnus-hook
3028                        (lambda  ()
3029                          (gnus-article-browse-delete-temp-files t)))
3030              ;; FIXME: Warn if there's an <img> tag?
3031              (browse-url-of-file (or tmp-file (expand-file-name file)))
3032              (setq showed t))
3033             ;; If multipart, recurse
3034             ((equal (mm-handle-media-supertype handle) "multipart")
3035              (when (gnus-article-browse-html-parts handle header)
3036                (setq showed t)))
3037             ((equal (mm-handle-media-type handle) "message/rfc822")
3038              (mm-with-multibyte-buffer
3039                (mm-insert-part handle)
3040                (setq handle (mm-dissect-buffer t t))
3041                (when (and (bufferp (car handle))
3042                           (stringp (car (mm-handle-type handle))))
3043                  (setq handle (list handle)))
3044                (when header
3045                  (article-decode-encoded-words)
3046                  (let ((gnus-visible-headers
3047                         (or (get 'gnus-visible-headers 'standard-value)
3048                             gnus-visible-headers)))
3049                    (article-hide-headers))
3050                  (goto-char (point-min))
3051                  (search-forward "\n\n" nil 'move)
3052                  (skip-chars-backward "\t\n ")
3053                  (setq header (buffer-substring (point-min) (point)))))
3054              (when (prog1
3055                        (gnus-article-browse-html-parts handle header)
3056                      (mm-destroy-parts handle))
3057                (setq showed t)))))
3058     showed))
3059
3060 (defun gnus-article-browse-html-article (&optional arg)
3061   "View \"text/html\" parts of the current article with a WWW browser.
3062 Inline images embedded in a message using the cid scheme, as they are
3063 generally considered to be safe, will be processed properly.
3064 The message header is added to the beginning of every html part unless
3065 the prefix argument ARG is given.
3066
3067 Warning: Spammers use links to images (using the http scheme) in HTML
3068 articles to verify whether you have read the message.  As
3069 `gnus-article-browse-html-article' passes the HTML content to the
3070 browser without eliminating these \"web bugs\" you should only
3071 use it for mails from trusted senders.
3072
3073 If you always want to display HTML parts in the browser, set
3074 `mm-text-html-renderer' to nil.
3075
3076 This command creates temporary files to pass HTML contents including
3077 images if any to the browser, and deletes them when exiting the group
3078 \(if you want)."
3079   ;; Cf. `mm-w3m-safe-url-regexp'
3080   (interactive "P")
3081   (if arg
3082       (gnus-summary-show-article)
3083     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3084                                     gnus-visible-headers))
3085           ;; As we insert a <hr>, there's no need for the body boundary.
3086           (gnus-treat-body-boundary nil))
3087       (gnus-summary-show-article)))
3088   (with-current-buffer gnus-article-buffer
3089     (let ((header (unless arg
3090                     (save-restriction
3091                       (widen)
3092                       (buffer-substring-no-properties
3093                        (goto-char (point-min))
3094                        (if (search-forward "\n\n" nil t)
3095                            (match-beginning 0)
3096                          (goto-char (point-max))
3097                          (skip-chars-backward "\t\n ")
3098                          (point))))))
3099           parts)
3100       (set-buffer gnus-original-article-buffer)
3101       (setq parts (mm-dissect-buffer t t))
3102       ;; If singlepart, enforce a list.
3103       (when (and (bufferp (car parts))
3104                  (stringp (car (mm-handle-type parts))))
3105         (setq parts (list parts)))
3106       ;; Process the list
3107       (unless (gnus-article-browse-html-parts parts header)
3108         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3109       (mm-destroy-parts parts)
3110       (unless arg
3111         (gnus-summary-show-article)))))
3112
3113 (defun article-hide-list-identifiers ()
3114   "Remove list identifies from the Subject header.
3115 The `gnus-list-identifiers' variable specifies what to do."
3116   (interactive)
3117   (let ((inhibit-point-motion-hooks t)
3118         (regexp (if (consp gnus-list-identifiers)
3119                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3120                   gnus-list-identifiers))
3121         (inhibit-read-only t))
3122     (when regexp
3123       (save-excursion
3124         (save-restriction
3125           (article-narrow-to-head)
3126           (goto-char (point-min))
3127           (while (re-search-forward
3128                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3129                   nil t)
3130             (delete-region (match-beginning 2) (match-end 0))
3131             (beginning-of-line))
3132           (when (re-search-forward
3133                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3134             (delete-region (match-beginning 1) (match-end 1))))))))
3135
3136 (defun article-hide-pem (&optional arg)
3137   "Toggle hiding of any PEM headers and signatures in the current article.
3138 If given a negative prefix, always show; if given a positive prefix,
3139 always hide."
3140   (interactive (gnus-article-hidden-arg))
3141   (unless (gnus-article-check-hidden-text 'pem arg)
3142     (save-excursion
3143       (let ((inhibit-read-only t) end)
3144         (goto-char (point-min))
3145         ;; Hide the horrendously ugly "header".
3146         (when (and (search-forward
3147                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3148                     nil t)
3149                    (setq end (1+ (match-beginning 0))))
3150           (gnus-add-wash-type 'pem)
3151           (gnus-article-hide-text-type
3152            end
3153            (if (search-forward "\n\n" nil t)
3154                (match-end 0)
3155              (point-max))
3156            'pem)
3157           ;; Hide the trailer as well
3158           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3159                                 nil t)
3160             (gnus-article-hide-text-type
3161              (match-beginning 0) (match-end 0) 'pem)))))))
3162
3163 (defun article-strip-banner ()
3164   "Strip the banners specified by the `banner' group parameter and by
3165 `gnus-article-address-banner-alist'."
3166   (interactive)
3167   (save-excursion
3168     (save-restriction
3169       (let ((inhibit-point-motion-hooks t))
3170         (when (gnus-parameter-banner gnus-newsgroup-name)
3171           (article-really-strip-banner
3172            (gnus-parameter-banner gnus-newsgroup-name)))
3173         (when gnus-article-address-banner-alist
3174           ;; Note that the From header is decoded here, so it is
3175           ;; required that the *-extract-address-components function
3176           ;; supports non-ASCII text.
3177           (let ((from (save-restriction
3178                         (widen)
3179                         (article-narrow-to-head)
3180                         (mail-fetch-field "from"))))
3181             (when (and from
3182                        (setq from
3183                              (cadr (funcall gnus-extract-address-components
3184                                             from))))
3185               (catch 'found
3186                 (dolist (pair gnus-article-address-banner-alist)
3187                   (when (string-match (car pair) from)
3188                     (throw 'found
3189                            (article-really-strip-banner (cdr pair)))))))))))))
3190
3191 (defun article-really-strip-banner (banner)
3192   "Strip the banner specified by the argument."
3193   (save-excursion
3194     (save-restriction
3195       (let ((inhibit-point-motion-hooks t)
3196             (gnus-signature-limit nil)
3197             (inhibit-read-only t))
3198         (article-goto-body)
3199         (cond
3200          ((eq banner 'signature)
3201           (when (gnus-article-narrow-to-signature)
3202             (widen)
3203             (forward-line -1)
3204             (delete-region (point) (point-max))))
3205          ((symbolp banner)
3206           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3207               (while (re-search-forward banner nil t)
3208                 (delete-region (match-beginning 0) (match-end 0)))))
3209          ((stringp banner)
3210           (while (re-search-forward banner nil t)
3211             (delete-region (match-beginning 0) (match-end 0)))))))))
3212
3213 (defun article-babel ()
3214   "Translate article using an online translation service."
3215   (interactive)
3216   (require 'babel)
3217   (gnus-with-article-buffer
3218     (when (article-goto-body)
3219       (let* ((start (point))
3220              (end (point-max))
3221              (orig (buffer-substring start end))
3222              (trans (babel-as-string orig)))
3223         (save-restriction
3224           (narrow-to-region start end)
3225           (delete-region start end)
3226           (insert trans))))))
3227
3228 (defun article-hide-signature (&optional arg)
3229   "Hide the signature in the current article.
3230 If given a negative prefix, always show; if given a positive prefix,
3231 always hide."
3232   (interactive (gnus-article-hidden-arg))
3233   (unless (gnus-article-check-hidden-text 'signature arg)
3234     (save-excursion
3235       (save-restriction
3236         (let ((inhibit-read-only t))
3237           (when (gnus-article-narrow-to-signature)
3238             (gnus-article-hide-text-type
3239              (point-min) (point-max) 'signature))))))
3240   (gnus-set-mode-line 'article))
3241
3242 (defun article-strip-headers-in-body ()
3243   "Strip offensive headers from bodies."
3244   (interactive)
3245   (save-excursion
3246     (article-goto-body)
3247     (let ((case-fold-search t))
3248       (when (looking-at "x-no-archive:")
3249         (gnus-delete-line)))))
3250
3251 (defun article-strip-leading-blank-lines ()
3252   "Remove all blank lines from the beginning of the article."
3253   (interactive)
3254   (save-excursion
3255     (let ((inhibit-point-motion-hooks t)
3256           (inhibit-read-only t))
3257       (when (article-goto-body)
3258         (while (and (not (eobp))
3259                     (looking-at "[ \t]*$"))
3260           (gnus-delete-line))))))
3261
3262 (defun article-narrow-to-head ()
3263   "Narrow the buffer to the head of the message.
3264 Point is left at the beginning of the narrowed-to region."
3265   (narrow-to-region
3266    (goto-char (point-min))
3267    (if (search-forward "\n\n" nil 1)
3268        (1- (point))
3269      (point-max)))
3270   (goto-char (point-min)))
3271
3272 (defun article-goto-body ()
3273   "Place point at the start of the body."
3274   (goto-char (point-min))
3275   (cond
3276    ;; This variable is only bound when dealing with separate
3277    ;; MIME body parts.
3278    (article-goto-body-goes-to-point-min-p
3279     t)
3280    ((search-forward "\n\n" nil t)
3281     t)
3282    (t
3283     (goto-char (point-max))
3284     nil)))
3285
3286 (defun article-strip-multiple-blank-lines ()
3287   "Replace consecutive blank lines with one empty line."
3288   (interactive)
3289   (save-excursion
3290     (let ((inhibit-point-motion-hooks t)
3291           (inhibit-read-only t))
3292       ;; First make all blank lines empty.
3293       (article-goto-body)
3294       (while (re-search-forward "^[ \t]+$" nil t)
3295         (unless (gnus-annotation-in-region-p
3296                  (match-beginning 0) (match-end 0))
3297           (replace-match "" nil t)))
3298       ;; Then replace multiple empty lines with a single empty line.
3299       (article-goto-body)
3300       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3301         (unless (gnus-annotation-in-region-p
3302                  (match-beginning 0) (match-end 0))
3303           (delete-region (match-beginning 1) (match-end 1)))))))
3304
3305 (defun article-strip-leading-space ()
3306   "Remove all white space from the beginning of the lines in the article."
3307   (interactive)
3308   (save-excursion
3309     (let ((inhibit-point-motion-hooks t)
3310           (inhibit-read-only t))
3311       (article-goto-body)
3312       (while (re-search-forward "^[ \t]+" nil t)
3313         (replace-match "" t t)))))
3314
3315 (defun article-strip-trailing-space ()
3316   "Remove all white space from the end of the lines in the article."
3317   (interactive)
3318   (save-excursion
3319     (let ((inhibit-point-motion-hooks t)
3320           (inhibit-read-only t))
3321       (article-goto-body)
3322       (while (re-search-forward "[ \t]+$" nil t)
3323         (replace-match "" t t)))))
3324
3325 (defun article-strip-blank-lines ()
3326   "Strip leading, trailing and multiple blank lines."
3327   (interactive)
3328   (article-strip-leading-blank-lines)
3329   (article-remove-trailing-blank-lines)
3330   (article-strip-multiple-blank-lines))
3331
3332 (defun article-strip-all-blank-lines ()
3333   "Strip all blank lines."
3334   (interactive)
3335   (save-excursion
3336     (let ((inhibit-point-motion-hooks t)
3337           (inhibit-read-only t))
3338       (article-goto-body)
3339       (while (re-search-forward "^[ \t]*\n" nil t)
3340         (replace-match "" t t)))))
3341
3342 (defun gnus-article-narrow-to-signature ()
3343   "Narrow to the signature; return t if a signature is found, else nil."
3344   (let ((inhibit-point-motion-hooks t))
3345     (when (gnus-article-search-signature)
3346       (forward-line 1)
3347       ;; Check whether we have some limits to what we consider
3348       ;; to be a signature.
3349       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3350                       (list gnus-signature-limit)))
3351             limit limited)
3352         (while (setq limit (pop limits))
3353           (if (or (and (integerp limit)
3354                        (< (- (point-max) (point)) limit))
3355                   (and (floatp limit)
3356                        (< (count-lines (point) (point-max)) limit))
3357                   (and (functionp limit)
3358                        (funcall limit))
3359                   (and (stringp limit)
3360                        (not (re-search-forward limit nil t))))
3361               ()                        ; This limit did not succeed.
3362             (setq limited t
3363                   limits nil)))
3364         (unless limited
3365           (narrow-to-region (point) (point-max))
3366           t)))))
3367
3368 (defun gnus-article-search-signature ()
3369   "Search the current buffer for the signature separator.
3370 Put point at the beginning of the signature separator."
3371   (let ((cur (point)))
3372     (goto-char (point-max))
3373     (if (if (stringp gnus-signature-separator)
3374             (re-search-backward gnus-signature-separator nil t)
3375           (let ((seps gnus-signature-separator))
3376             (while (and seps
3377                         (not (re-search-backward (car seps) nil t)))
3378               (pop seps))
3379             seps))
3380         t
3381       (goto-char cur)
3382       nil)))
3383
3384 (defun gnus-article-hidden-arg ()
3385   "Return the current prefix arg as a number, or 0 if no prefix."
3386   (list (if current-prefix-arg
3387             (prefix-numeric-value current-prefix-arg)
3388           0)))
3389
3390 (defun gnus-article-check-hidden-text (type arg)
3391   "Return nil if hiding is necessary.
3392 Arg can be nil or a number.  nil and positive means hide, negative
3393 means show, 0 means toggle."
3394   (save-excursion
3395     (save-restriction
3396       (let ((hide (gnus-article-hidden-text-p type)))
3397         (cond
3398          ((or (null arg)
3399               (> arg 0))
3400           nil)
3401          ((< arg 0)
3402           (gnus-article-show-hidden-text type)
3403           t)
3404          (t
3405           (if (eq hide 'hidden)
3406               (progn
3407                 (gnus-article-show-hidden-text type)
3408                 t)
3409             nil)))))))
3410
3411 (defun gnus-article-hidden-text-p (type)
3412   "Say whether the current buffer contains hidden text of type TYPE."
3413   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3414     (while (and pos
3415                 (not (get-text-property pos 'invisible))
3416                 (not (get-text-property pos 'dummy-invisible)))
3417       (setq pos
3418             (text-property-any (1+ pos) (point-max) 'article-type type)))
3419     (if pos
3420         'hidden
3421       nil)))
3422
3423 (defun gnus-article-show-hidden-text (type &optional dummy)
3424   "Show all hidden text of type TYPE.
3425 Originally it is hide instead of DUMMY."
3426   (let ((inhibit-read-only t)
3427         (inhibit-point-motion-hooks t))
3428     (gnus-remove-text-properties-when
3429      'article-type type
3430      (point-min) (point-max)
3431      (cons 'article-type (cons type
3432                                gnus-hidden-properties)))
3433     (gnus-delete-wash-type type)))
3434
3435 (defconst article-time-units
3436   `((year . ,(* 365.25 24 60 60))
3437     (week . ,(* 7 24 60 60))
3438     (day . ,(* 24 60 60))
3439     (hour . ,(* 60 60))
3440     (minute . 60)
3441     (second . 1))
3442   "Mapping from time units to seconds.")
3443
3444 (defun gnus-article-forward-header ()
3445   "Move point to the start of the next header.
3446 If the current header is a continuation header, this can be several
3447 lines forward."
3448   (let ((ended nil))
3449     (while (not ended)
3450       (forward-line 1)
3451       (if (looking-at "[ \t]+[^ \t]")
3452           (forward-line 1)
3453         (setq ended t)))))
3454
3455 (defun article-date-ut (&optional type highlight)
3456   "Convert DATE date to universal time in the current article.
3457 If TYPE is `local', convert to local time; if it is `lapsed', output
3458 how much time has lapsed since DATE.  For `lapsed', the value of
3459 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3460 should replace the \"Date:\" one, or should be added below it."
3461   (interactive (list 'ut t))
3462   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3463          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3464                              tdate-regexp)
3465                             ((eq type 'lapsed)
3466                              "^X-Sent:[ \t]")
3467                             (article-lapsed-timer
3468                              "^Date:[ \t]")
3469                             (t
3470                              tdate-regexp)))
3471          (case-fold-search t)
3472          (inhibit-read-only t)
3473          (inhibit-point-motion-hooks t)
3474          pos date bface eface)
3475     (save-excursion
3476       (save-restriction
3477         (widen)
3478         (goto-char (point-min))
3479         (while (or (setq date (get-text-property (setq pos (point))
3480                                                  'original-date))
3481                    (when (setq pos (next-single-property-change
3482                                     (point) 'original-date))
3483                      (setq date (get-text-property pos 'original-date))
3484                      t))
3485           (narrow-to-region
3486            pos (if (setq pos (text-property-any pos (point-max)
3487                                                 'original-date nil))
3488                    (progn
3489                      (goto-char pos)
3490                      (if (or (bolp) (eobp))
3491                          (point)
3492                        (1+ (point))))
3493                  (point-max)))
3494           (goto-char (point-min))
3495           (when (re-search-forward tdate-regexp nil t)
3496             (setq bface (get-text-property (point-at-bol) 'face)
3497                   eface (get-text-property (1- (point-at-eol)) 'face)))
3498           (goto-char (point-min))
3499           (setq pos nil)
3500           ;; Delete any old Date headers.
3501           (while (re-search-forward date-regexp nil t)
3502             (if pos
3503                 (delete-region (point-at-bol) (progn
3504                                                 (gnus-article-forward-header)
3505                                                 (point)))
3506               (delete-region (point-at-bol) (progn
3507                                               (gnus-article-forward-header)
3508                                               (forward-char -1)
3509                                               (point)))
3510               (setq pos (point))))
3511           (when (and (not pos)
3512                      (re-search-forward tdate-regexp nil t))
3513             (forward-line 1))
3514           (gnus-goto-char pos)
3515           (insert (article-make-date-line date (or type 'ut)))
3516           (unless pos
3517             (insert "\n")
3518             (forward-line -1))
3519           ;; Do highlighting.
3520           (beginning-of-line)
3521           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3522             (put-text-property (match-beginning 1) (1+ (match-end 1))
3523                                'face bface)
3524             (put-text-property (match-beginning 2) (match-end 2)
3525                                'face eface))
3526           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3527           (goto-char (point-max))
3528           (widen))))))
3529
3530 (defun article-make-date-line (date type)
3531   "Return a DATE line of TYPE."
3532   (unless (memq type '(local ut original user iso8601 lapsed english))
3533     (error "Unknown conversion type: %s" type))
3534   (condition-case ()
3535       (let ((time (date-to-time date)))
3536         (cond
3537          ;; Convert to the local timezone.
3538          ((eq type 'local)
3539           (concat "Date: " (message-make-date time)))
3540          ;; Convert to Universal Time.
3541          ((eq type 'ut)
3542           (concat "Date: "
3543                   (substring
3544                    (message-make-date
3545                     (let* ((e (parse-time-string date))
3546                            (tm (apply 'encode-time e))
3547                            (ms (car tm))
3548                            (ls (- (cadr tm) (car (current-time-zone time)))))
3549                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3550                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3551                             (t (list ms ls)))))
3552                    0 -5)
3553                   "UT"))
3554          ;; Get the original date from the article.
3555          ((eq type 'original)
3556           (concat "Date: " (if (string-match "\n+$" date)
3557                                (substring date 0 (match-beginning 0))
3558                              date)))
3559          ;; Let the user define the format.
3560          ((eq type 'user)
3561           (let ((format (or (condition-case nil
3562                                 (with-current-buffer gnus-summary-buffer
3563                                   gnus-article-time-format)
3564                               (error nil))
3565                             gnus-article-time-format)))
3566             (if (functionp format)
3567                 (funcall format time)
3568               (concat "Date: " (format-time-string format time)))))
3569          ;; ISO 8601.
3570          ((eq type 'iso8601)
3571           (let ((tz (car (current-time-zone time))))
3572             (concat
3573              "Date: "
3574              (format-time-string "%Y%m%dT%H%M%S" time)
3575              (format "%s%02d%02d"
3576                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3577                      (/ (% (abs tz) 3600) 60)))))
3578          ;; Do an X-Sent lapsed format.
3579          ((eq type 'lapsed)
3580           ;; If the date is seriously mangled, the timezone functions are
3581           ;; liable to bug out, so we ignore all errors.
3582           (let* ((now (current-time))
3583                  (real-time (subtract-time now time))
3584                  (real-sec (and real-time
3585                                 (+ (* (float (car real-time)) 65536)
3586                                    (cadr real-time))))
3587                  (sec (and real-time (abs real-sec)))
3588                  num prev)
3589             (cond
3590              ((null real-time)
3591               "X-Sent: Unknown")
3592              ((zerop sec)
3593               "X-Sent: Now")
3594              (t
3595               (concat
3596                "X-Sent: "
3597                ;; This is a bit convoluted, but basically we go
3598                ;; through the time units for years, weeks, etc,
3599                ;; and divide things to see whether that results
3600                ;; in positive answers.
3601                (mapconcat
3602                 (lambda (unit)
3603                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3604                       ;; The (remaining) seconds are too few to
3605                       ;; be divided into this time unit.
3606                       ""
3607                     ;; It's big enough, so we output it.
3608                     (setq sec (- sec (* num (cdr unit))))
3609                     (prog1
3610                         (concat (if prev ", " "") (int-to-string
3611                                                    (floor num))
3612                                 " " (symbol-name (car unit))
3613                                 (if (> num 1) "s" ""))
3614                       (setq prev t))))
3615                 article-time-units "")
3616                ;; If dates are odd, then it might appear like the
3617                ;; article was sent in the future.
3618                (if (> real-sec 0)
3619                    " ago"
3620                  " in the future"))))))
3621          ;; Display the date in proper English
3622          ((eq type 'english)
3623           (let ((dtime (decode-time time)))
3624             (concat
3625              "Date: the "
3626              (number-to-string (nth 3 dtime))
3627              (let ((digit (% (nth 3 dtime) 10)))
3628                (cond
3629                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3630                 ((= digit 1) "st")
3631                 ((= digit 2) "nd")
3632                 ((= digit 3) "rd")
3633                 (t "th")))
3634              " of "
3635              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3636              " "
3637              (number-to-string (nth 5 dtime))
3638              " at "
3639              (format "%02d" (nth 2 dtime))
3640              ":"
3641              (format "%02d" (nth 1 dtime)))))))
3642     (error
3643      (format "Date: %s (from Gnus)" date))))
3644
3645 (defun article-date-local (&optional highlight)
3646   "Convert the current article date to the local timezone."
3647   (interactive (list t))
3648   (article-date-ut 'local highlight))
3649
3650 (defun article-date-english (&optional highlight)
3651   "Convert the current article date to something that is proper English."
3652   (interactive (list t))
3653   (article-date-ut 'english highlight))
3654
3655 (defun article-date-original (&optional highlight)
3656   "Convert the current article date to what it was originally.
3657 This is only useful if you have used some other date conversion
3658 function and want to see what the date was before converting."
3659   (interactive (list t))
3660   (article-date-ut 'original highlight))
3661
3662 (defun article-date-lapsed (&optional highlight)
3663   "Convert the current article date to time lapsed since it was sent."
3664   (interactive (list t))
3665   (article-date-ut 'lapsed highlight))
3666
3667 (defun article-update-date-lapsed ()
3668   "Function to be run from a timer to update the lapsed time line."
3669   (save-match-data
3670     (let (deactivate-mark)
3671       (save-excursion
3672         (ignore-errors
3673          (walk-windows
3674           (lambda (w)
3675             (set-buffer (window-buffer w))
3676             (when (eq major-mode 'gnus-article-mode)
3677               (let ((mark (point-marker)))
3678                 (goto-char (point-min))
3679                 (when (re-search-forward "^X-Sent:" nil t)
3680                   (article-date-lapsed t))
3681                 (goto-char (marker-position mark))
3682                 (move-marker mark nil))))
3683           nil 'visible))))))
3684
3685 (defun gnus-start-date-timer (&optional n)
3686   "Start a timer to update the X-Sent header in the article buffers.
3687 The numerical prefix says how frequently (in seconds) the function
3688 is to run."
3689   (interactive "p")
3690   (unless n
3691     (setq n 1))
3692   (gnus-stop-date-timer)
3693   (setq article-lapsed-timer
3694         (run-at-time 1 n 'article-update-date-lapsed)))
3695
3696 (defun gnus-stop-date-timer ()
3697   "Stop the X-Sent timer."
3698   (interactive)
3699   (when article-lapsed-timer
3700     (nnheader-cancel-timer article-lapsed-timer)
3701     (setq article-lapsed-timer nil)))
3702
3703 (defun article-date-user (&optional highlight)
3704   "Convert the current article date to the user-defined format.
3705 This format is defined by the `gnus-article-time-format' variable."
3706   (interactive (list t))
3707   (article-date-ut 'user highlight))
3708
3709 (defun article-date-iso8601 (&optional highlight)
3710   "Convert the current article date to ISO8601."
3711   (interactive (list t))
3712   (article-date-ut 'iso8601 highlight))
3713
3714 (defmacro gnus-article-save-original-date (&rest forms)
3715   "Save the original date as a text property and evaluate FORMS."
3716   `(let* ((case-fold-search t)
3717           (start (progn
3718                    (goto-char (point-min))
3719                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3720                               (not (bolp)))
3721                      (match-end 0))))
3722           (date (when (and start
3723                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3724                                               nil t))
3725                   (buffer-substring-no-properties start
3726                                                   (match-beginning 0)))))
3727      (goto-char (point-max))
3728      (skip-chars-backward "\n")
3729      (put-text-property (point-min) (point) 'original-date date)
3730      ,@forms
3731      (goto-char (point-max))
3732      (skip-chars-backward "\n")
3733      (put-text-property (point-min) (point) 'original-date date)))
3734
3735 ;; (defun article-show-all ()
3736 ;;   "Show all hidden text in the article buffer."
3737 ;;   (interactive)
3738 ;;   (save-excursion
3739 ;;     (let ((inhibit-read-only t))
3740 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3741
3742 (defun article-remove-leading-whitespace ()
3743   "Remove excessive whitespace from all headers."
3744   (interactive)
3745   (save-excursion
3746     (save-restriction
3747       (let ((inhibit-read-only t))
3748         (article-narrow-to-head)
3749         (goto-char (point-min))
3750         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3751           (delete-region (match-beginning 1) (match-end 1)))))))
3752
3753 (defun article-emphasize (&optional arg)
3754   "Emphasize text according to `gnus-emphasis-alist'."
3755   (interactive (gnus-article-hidden-arg))
3756   (unless (gnus-article-check-hidden-text 'emphasis arg)
3757     (save-excursion
3758       (let ((alist (or
3759                     (condition-case nil
3760                         (with-current-buffer gnus-summary-buffer
3761                           gnus-article-emphasis-alist)
3762                       (error))
3763                     gnus-emphasis-alist))
3764             (inhibit-read-only t)
3765             (props (append '(article-type emphasis)
3766                            gnus-hidden-properties))
3767             regexp elem beg invisible visible face)
3768         (article-goto-body)
3769         (setq beg (point))
3770         (while (setq elem (pop alist))
3771           (goto-char beg)
3772           (setq regexp (car elem)
3773                 invisible (nth 1 elem)
3774                 visible (nth 2 elem)
3775                 face (nth 3 elem))
3776           (while (re-search-forward regexp nil t)
3777             (when (and (match-beginning visible) (match-beginning invisible))
3778               (gnus-article-hide-text
3779                (match-beginning invisible) (match-end invisible) props)
3780               (gnus-article-unhide-text-type
3781                (match-beginning visible) (match-end visible) 'emphasis)
3782               (gnus-put-overlay-excluding-newlines
3783                (match-beginning visible) (match-end visible) 'face face)
3784               (gnus-add-wash-type 'emphasis)
3785               (goto-char (match-end invisible)))))))))
3786
3787 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3788   "Setup newsgroup emphasis alist."
3789   (unless gnus-article-emphasis-alist
3790     (let ((name (and gnus-newsgroup-name
3791                      (gnus-group-real-name gnus-newsgroup-name))))
3792       (make-local-variable 'gnus-article-emphasis-alist)
3793       (setq gnus-article-emphasis-alist
3794             (nconc
3795              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3796                (while (setq elem (pop alist))
3797                  (when (and name (string-match (car elem) name))
3798                    (setq alist nil
3799                          highlight (copy-sequence (cdr elem)))))
3800                highlight)
3801              (copy-sequence highlight-words)
3802              (if gnus-newsgroup-name
3803                  (copy-sequence (gnus-group-find-parameter
3804                                  gnus-newsgroup-name 'highlight-words t)))
3805              gnus-emphasis-alist)))))
3806
3807 (defvar gnus-summary-article-menu)
3808 (defvar gnus-summary-post-menu)
3809
3810 ;;; Saving functions.
3811
3812 (defun gnus-article-save (save-buffer file &optional num)
3813   "Save the currently selected article."
3814   (when (or (get gnus-default-article-saver :headers)
3815             (not gnus-save-all-headers))
3816     ;; Remove headers according to `gnus-saved-headers' or the value
3817     ;; of the `:headers' property that the saver function might have.
3818     (let ((gnus-visible-headers
3819            (or (symbol-value (get gnus-default-article-saver :headers))
3820                gnus-saved-headers gnus-visible-headers))
3821           ;; Ignore group parameter.  See `article-hide-headers'.
3822           (gnus-summary-buffer nil))
3823       (with-current-buffer save-buffer
3824         (article-hide-headers 1 t))))
3825   (save-window-excursion
3826     (if (not gnus-default-article-saver)
3827         (error "No default saver is defined")
3828       ;; !!! Magic!  The saving functions all save
3829       ;; `gnus-save-article-buffer' (or so they think), but we
3830       ;; bind that variable to our save-buffer.
3831       (set-buffer gnus-article-buffer)
3832       (let* ((gnus-save-article-buffer save-buffer)
3833              (filename
3834               (cond
3835                ((not gnus-prompt-before-saving) 'default)
3836                ((eq gnus-prompt-before-saving 'always) nil)
3837                (t file)))
3838              (gnus-number-of-articles-to-be-saved
3839               (when (eq gnus-prompt-before-saving t)
3840                 num)))                  ; Magic
3841         (set-buffer gnus-article-current-summary)
3842         (funcall gnus-default-article-saver filename)))))
3843
3844 (defun gnus-read-save-file-name (prompt &optional filename
3845                                         function group headers variable
3846                                         dir-var)
3847   (let ((default-name
3848           (funcall function group headers (symbol-value variable)))
3849         result)
3850     (setq result
3851           (expand-file-name
3852            (cond
3853             ((eq filename 'default)
3854              default-name)
3855             ((eq filename t)
3856              default-name)
3857             (filename filename)
3858             (t
3859              (when (symbol-value dir-var)
3860                (setq default-name (expand-file-name
3861                                    (file-name-nondirectory default-name)
3862                                    (symbol-value dir-var))))
3863              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3864                     (prompt
3865                      (format prompt
3866                              (if (and gnus-number-of-articles-to-be-saved
3867                                       (> gnus-number-of-articles-to-be-saved 1))
3868                                  (format "these %d articles"
3869                                          gnus-number-of-articles-to-be-saved)
3870                                "this article")))
3871                     (file
3872                      ;; Let the split methods have their say.
3873                      (cond
3874                       ;; No split name was found.
3875                       ((null split-name)
3876                        (read-file-name
3877                         (concat prompt " (default "
3878                                 (file-name-nondirectory default-name) "): ")
3879                         (file-name-directory default-name)
3880                         default-name))
3881                       ;; A single group name is returned.
3882                       ((stringp split-name)
3883                        (setq default-name
3884                              (funcall function split-name headers
3885                                       (symbol-value variable)))
3886                        (read-file-name
3887                         (concat prompt " (default "
3888                                 (file-name-nondirectory default-name) "): ")
3889                         (file-name-directory default-name)
3890                         default-name))
3891                       ;; A single split name was found
3892                       ((= 1 (length split-name))
3893                        (let* ((name (expand-file-name
3894                                      (car split-name)
3895                                      gnus-article-save-directory))
3896                               (dir (cond ((file-directory-p name)
3897                                           (file-name-as-directory name))
3898                                          ((file-exists-p name) name)
3899                                          (t gnus-article-save-directory))))
3900                          (read-file-name
3901                           (concat prompt " (default " name "): ")
3902                           dir name)))
3903                       ;; A list of splits was found.
3904                       (t
3905                        (setq split-name (nreverse split-name))
3906                        (let (result)
3907                          (let ((file-name-history
3908                                 (nconc split-name file-name-history)))
3909                            (setq result
3910                                  (expand-file-name
3911                                   (read-file-name
3912                                    (concat prompt " (`M-p' for defaults): ")
3913                                    gnus-article-save-directory
3914                                    (car split-name))
3915                                   gnus-article-save-directory)))
3916                          (car (push result file-name-history)))))))
3917                ;; Create the directory.
3918                (gnus-make-directory (file-name-directory file))
3919                ;; If we have read a directory, we append the default file name.
3920                (when (file-directory-p file)
3921                  (setq file (expand-file-name (file-name-nondirectory
3922                                                default-name)
3923                                               (file-name-as-directory file))))
3924                ;; Possibly translate some characters.
3925                (nnheader-translate-file-chars file))))))
3926     (gnus-make-directory (file-name-directory result))
3927     (when variable
3928       (set variable result))
3929     (when dir-var
3930       (set dir-var (file-name-directory result)))
3931     result))
3932
3933 (defun gnus-article-archive-name (group)
3934   "Return the first instance of an \"Archive-name\" in the current buffer."
3935   (let ((case-fold-search t))
3936     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3937       (nnheader-concat gnus-article-save-directory
3938                        (match-string 1)))))
3939
3940 (defun gnus-article-nndoc-name (group)
3941   "If GROUP is an nndoc group, return the name of the parent group."
3942   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3943     (gnus-group-get-parameter group 'save-article-group)))
3944
3945 (defun gnus-summary-save-in-rmail (&optional filename)
3946   "Append this article to Rmail file.
3947 Optional argument FILENAME specifies file name.
3948 Directory to save to is default to `gnus-article-save-directory'."
3949   (setq filename (gnus-read-save-file-name
3950                   "Save %s in rmail file" filename
3951                   gnus-rmail-save-name gnus-newsgroup-name
3952                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3953   (gnus-eval-in-buffer-window gnus-save-article-buffer
3954     (save-excursion
3955       (save-restriction
3956         (widen)
3957         ;; Note that unlike gnus-summary-save-in-mail, there is no
3958         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3959         ;; not use Babyl.
3960         (gnus-output-to-rmail filename))))
3961   filename)
3962
3963 (defun gnus-summary-save-in-mail (&optional filename)
3964   "Append this article to Unix mail file.
3965 Optional argument FILENAME specifies file name.
3966 Directory to save to is default to `gnus-article-save-directory'."
3967   (setq filename (gnus-read-save-file-name
3968                   "Save %s in Unix mail file" filename
3969                   gnus-mail-save-name gnus-newsgroup-name
3970                   gnus-current-headers 'gnus-newsgroup-last-mail))
3971   (gnus-eval-in-buffer-window gnus-save-article-buffer
3972     (save-excursion
3973       (save-restriction
3974         (widen)
3975         (if (and (file-readable-p filename)
3976                  (file-regular-p filename)
3977                  (mail-file-babyl-p filename))
3978             (gnus-output-to-rmail filename)
3979           (gnus-output-to-mail filename)))))
3980   filename)
3981
3982 (put 'gnus-summary-save-in-file :decode t)
3983 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3984 (defun gnus-summary-save-in-file (&optional filename overwrite)
3985   "Append this article to file.
3986 Optional argument FILENAME specifies file name.
3987 Directory to save to is default to `gnus-article-save-directory'."
3988   (setq filename (gnus-read-save-file-name
3989                   "Save %s in file" filename
3990                   gnus-file-save-name gnus-newsgroup-name
3991                   gnus-current-headers 'gnus-newsgroup-last-file))
3992   (gnus-eval-in-buffer-window gnus-save-article-buffer
3993     (save-excursion
3994       (save-restriction
3995         (widen)
3996         (when (and overwrite
3997                    (file-exists-p filename))
3998           (delete-file filename))
3999         (gnus-output-to-file filename))))
4000   filename)
4001
4002 (put 'gnus-summary-write-to-file :decode t)
4003 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
4004 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
4005 (defun gnus-summary-write-to-file (&optional filename)
4006   "Write this article to a file, overwriting it if the file exists.
4007 Optional argument FILENAME specifies file name.
4008 The directory to save in defaults to `gnus-article-save-directory'."
4009   (setq filename (gnus-read-save-file-name
4010                   "Save %s in file" filename
4011                   gnus-file-save-name gnus-newsgroup-name
4012                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4013   (gnus-summary-save-in-file filename t))
4014
4015 (put 'gnus-summary-save-body-in-file :decode t)
4016 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
4017   "Append this article body to a file.
4018 Optional argument FILENAME specifies file name.
4019 The directory to save in defaults to `gnus-article-save-directory'."
4020   (setq filename (gnus-read-save-file-name
4021                   "Save %s body in file" filename
4022                   gnus-file-save-name gnus-newsgroup-name
4023                   gnus-current-headers 'gnus-newsgroup-last-file))
4024   (gnus-eval-in-buffer-window gnus-save-article-buffer
4025     (save-excursion
4026       (save-restriction
4027         (widen)
4028         (when (article-goto-body)
4029           (narrow-to-region (point) (point-max)))
4030         (when (and overwrite
4031                    (file-exists-p filename))
4032           (delete-file filename))
4033         (gnus-output-to-file filename))))
4034   filename)
4035
4036 (put 'gnus-summary-write-body-to-file :decode t)
4037 (put 'gnus-summary-write-body-to-file
4038      :function 'gnus-summary-save-body-in-file)
4039 (defun gnus-summary-write-body-to-file (&optional filename)
4040   "Write this article body to a file, overwriting it if the file exists.
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 nil 'gnus-newsgroup-last-directory))
4047   (gnus-summary-save-body-in-file filename t))
4048
4049 (put 'gnus-summary-save-in-pipe :decode t)
4050 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
4051 (defun gnus-summary-save-in-pipe (&optional command raw)
4052   "Pipe this article to subprocess COMMAND.
4053 Valid values for COMMAND include:
4054   a string
4055     The executable command name and possibly arguments.
4056   nil
4057     You will be prompted for the command in the minibuffer.
4058   the symbol `default'
4059     It will be replaced with the command which the variable
4060     `gnus-summary-pipe-output-default-command' holds or the command
4061     last used for saving.
4062 Non-nil value for RAW overrides `:decode' and `:headers' properties
4063 and the raw article including all headers will be piped."
4064   (let ((article (gnus-summary-article-number))
4065         (decode (unless raw
4066                   (get 'gnus-summary-save-in-pipe :decode)))
4067         save-buffer default)
4068     (if article
4069         (if (vectorp (gnus-summary-article-header article))
4070             (save-current-buffer
4071               (gnus-summary-select-article decode decode nil article)
4072               (insert-buffer-substring
4073                (prog1
4074                    (if decode
4075                        gnus-article-buffer
4076                      gnus-original-article-buffer)
4077                  (setq save-buffer
4078                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4079               ;; Remove unwanted headers.
4080               (when (and (not raw)
4081                          (or (get 'gnus-summary-save-in-pipe :headers)
4082                              (not gnus-save-all-headers)))
4083                 (let ((gnus-visible-headers
4084                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4085                                               :headers))
4086                            gnus-saved-headers gnus-visible-headers))
4087                       (gnus-summary-buffer nil))
4088                   (article-hide-headers 1 t))))
4089           (error "%d is not a real article" article))
4090       (error "No article to pipe"))
4091     (setq default (or gnus-summary-pipe-output-default-command
4092                       gnus-last-shell-command))
4093     (unless (stringp command)
4094       (setq command
4095             (if (and (eq command 'default) default)
4096                 default
4097               (gnus-read-shell-command "Shell command on this article: "
4098                                        default))))
4099     (when (string-equal command "")
4100       (if default
4101           (setq command default)
4102         (error "A command is required")))
4103     (gnus-eval-in-buffer-window save-buffer
4104       (save-restriction
4105         (widen)
4106         (shell-command-on-region (point-min) (point-max) command nil)))
4107     (gnus-kill-buffer save-buffer))
4108   (setq gnus-summary-pipe-output-default-command command))
4109
4110 (defun gnus-summary-pipe-to-muttprint (&optional command)
4111   "Pipe this article to muttprint."
4112   (unless (stringp command)
4113     (setq command (read-string
4114                    "Print using command: " gnus-summary-muttprint-program
4115                    nil gnus-summary-muttprint-program)))
4116   (let ((gnus-summary-pipe-output-default-command
4117          gnus-summary-pipe-output-default-command))
4118     (gnus-summary-save-in-pipe command))
4119   (setq gnus-summary-muttprint-program command))
4120
4121 ;;; Article file names when saving.
4122
4123 (defun gnus-capitalize-newsgroup (newsgroup)
4124   "Capitalize NEWSGROUP name."
4125   (when (not (zerop (length newsgroup)))
4126     (concat (char-to-string (upcase (aref newsgroup 0)))
4127             (substring newsgroup 1))))
4128
4129 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4130   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4131 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4132 Otherwise, it is like ~/News/news/group/num."
4133   (let ((default
4134           (expand-file-name
4135            (concat (if (gnus-use-long-file-name 'not-save)
4136                        (gnus-capitalize-newsgroup newsgroup)
4137                      (gnus-newsgroup-directory-form newsgroup))
4138                    "/" (int-to-string (mail-header-number headers)))
4139            gnus-article-save-directory)))
4140     (if (and last-file
4141              (string-equal (file-name-directory default)
4142                            (file-name-directory last-file))
4143              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4144         default
4145       (or last-file default))))
4146
4147 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4148   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4149 If variable `gnus-use-long-file-name' is non-nil, it is
4150 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4151   (let ((default
4152           (expand-file-name
4153            (concat (if (gnus-use-long-file-name 'not-save)
4154                        newsgroup
4155                      (gnus-newsgroup-directory-form newsgroup))
4156                    "/" (int-to-string (mail-header-number headers)))
4157            gnus-article-save-directory)))
4158     (if (and last-file
4159              (string-equal (file-name-directory default)
4160                            (file-name-directory last-file))
4161              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4162         default
4163       (or last-file default))))
4164
4165 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4166   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4167 If variable `gnus-use-long-file-name' is non-nil, it is
4168 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4169   (or last-file
4170       (expand-file-name
4171        (if (gnus-use-long-file-name 'not-save)
4172            newsgroup
4173          (file-relative-name
4174           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4175           default-directory))
4176        gnus-article-save-directory)))
4177
4178 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4179   "Generate file name from sender."
4180   (let ((from (mail-header-from headers)))
4181     (expand-file-name
4182      (if (and from (string-match "\\([^ <]+\\)@" from))
4183          (match-string 1 from)
4184        "nobody")
4185      gnus-article-save-directory)))
4186
4187 (defun article-verify-x-pgp-sig ()
4188   "Verify X-PGP-Sig."
4189   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4190   (interactive)
4191   (if (gnus-buffer-live-p gnus-original-article-buffer)
4192       (let ((sig (with-current-buffer gnus-original-article-buffer
4193                    (gnus-fetch-field "X-PGP-Sig")))
4194             items info headers)
4195         (when (and sig
4196                    mml2015-use
4197                    (mml2015-clear-verify-function))
4198           (with-temp-buffer
4199             (insert-buffer-substring gnus-original-article-buffer)
4200             (setq items (split-string sig))
4201             (message-narrow-to-head)
4202             (let ((inhibit-point-motion-hooks t)
4203                   (case-fold-search t))
4204               ;; Don't verify multiple headers.
4205               (setq headers (mapconcat (lambda (header)
4206                                          (concat header ": "
4207                                                  (mail-fetch-field header)
4208                                                  "\n"))
4209                                        (split-string (nth 1 items) ",") "")))
4210             (delete-region (point-min) (point-max))
4211             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4212             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4213             (insert headers)
4214             (widen)
4215             (forward-line)
4216             (while (not (eobp))
4217               (if (looking-at "^-")
4218                   (insert "- "))
4219               (forward-line))
4220             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4221             (insert "Version: " (car items) "\n\n")
4222             (insert (mapconcat 'identity (cddr items) "\n"))
4223             (insert "\n-----END PGP SIGNATURE-----\n")
4224             (let ((mm-security-handle (list (format "multipart/signed"))))
4225               (mml2015-clean-buffer)
4226               (let ((coding-system-for-write (or gnus-newsgroup-charset
4227                                                  'iso-8859-1)))
4228                 (funcall (mml2015-clear-verify-function)))
4229               (setq info
4230                     (or (mm-handle-multipart-ctl-parameter
4231                          mm-security-handle 'gnus-details)
4232                         (mm-handle-multipart-ctl-parameter
4233                          mm-security-handle 'gnus-info)))))
4234           (when info
4235             (let ((inhibit-read-only t) bface eface)
4236               (save-restriction
4237                 (message-narrow-to-head)
4238                 (goto-char (point-max))
4239                 (forward-line -1)
4240                 (setq bface (get-text-property (point-at-bol) 'face)
4241                       eface (get-text-property (1- (point-at-eol)) 'face))
4242                 (message-remove-header "X-Gnus-PGP-Verify")
4243                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4244                     (forward-line)
4245                   (goto-char (point-max)))
4246                 (narrow-to-region (point) (point))
4247                 (insert "X-Gnus-PGP-Verify: " info "\n")
4248                 (goto-char (point-min))
4249                 (forward-line)
4250                 (while (not (eobp))
4251                   (if (not (looking-at "^[ \t]"))
4252                       (insert " "))
4253                   (forward-line))
4254                 ;; Do highlighting.
4255                 (goto-char (point-min))
4256                 (when (looking-at "\\([^:]+\\): *")
4257                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4258                                      'face bface)
4259                   (put-text-property (match-end 0) (point-max)
4260                                      'face eface)))))))))
4261
4262 (autoload 'canlock-verify "canlock" nil t) ;; for Emacs 21.
4263
4264 (defun article-verify-cancel-lock ()
4265   "Verify Cancel-Lock header."
4266   (interactive)
4267   (if (gnus-buffer-live-p gnus-original-article-buffer)
4268       (canlock-verify gnus-original-article-buffer)))
4269
4270 (eval-and-compile
4271   (mapc
4272    (lambda (func)
4273      (let (afunc gfunc)
4274        (if (consp func)
4275            (setq afunc (car func)
4276                  gfunc (cdr func))
4277          (setq afunc func
4278                gfunc (intern (format "gnus-%s" func))))
4279        (defalias gfunc
4280          (when (fboundp afunc)
4281            `(lambda (&optional interactive &rest args)
4282               ,(documentation afunc t)
4283               (interactive (list t))
4284               (with-current-buffer gnus-article-buffer
4285                 (if interactive
4286                     (call-interactively ',afunc)
4287                   (apply ',afunc args))))))))
4288    '(article-hide-headers
4289      article-verify-x-pgp-sig
4290      article-verify-cancel-lock
4291      article-hide-boring-headers
4292      article-treat-overstrike
4293      article-treat-ansi-sequences
4294      article-fill-long-lines
4295      article-capitalize-sentences
4296      article-remove-cr
4297      article-remove-leading-whitespace
4298      article-display-x-face
4299      article-display-face
4300      article-de-quoted-unreadable
4301      article-de-base64-unreadable
4302      article-decode-HZ
4303      article-wash-html
4304      article-unsplit-urls
4305      article-hide-list-identifiers
4306      article-strip-banner
4307      article-babel
4308      article-hide-pem
4309      article-hide-signature
4310      article-strip-headers-in-body
4311      article-remove-trailing-blank-lines
4312      article-strip-leading-blank-lines
4313      article-strip-multiple-blank-lines
4314      article-strip-leading-space
4315      article-strip-trailing-space
4316      article-strip-blank-lines
4317      article-strip-all-blank-lines
4318      article-date-local
4319      article-date-english
4320      article-date-iso8601
4321      article-date-original
4322      article-date-ut
4323      article-decode-mime-words
4324      article-decode-charset
4325      article-decode-encoded-words
4326      article-date-user
4327      article-date-lapsed
4328      article-emphasize
4329      article-treat-dumbquotes
4330      article-normalize-headers
4331      ;;(article-show-all . gnus-article-show-all-headers)
4332      )))
4333 \f
4334 ;;;
4335 ;;; Gnus article mode
4336 ;;;
4337
4338 (put 'gnus-article-mode 'mode-class 'special)
4339
4340 (set-keymap-parent gnus-article-mode-map widget-keymap)
4341
4342 (gnus-define-keys gnus-article-mode-map
4343   " " gnus-article-goto-next-page
4344   "\177" gnus-article-goto-prev-page
4345   [delete] gnus-article-goto-prev-page
4346   [backspace] gnus-article-goto-prev-page
4347   "\C-c^" gnus-article-refer-article
4348   "h" gnus-article-show-summary
4349   "s" gnus-article-show-summary
4350   "\C-c\C-m" gnus-article-mail
4351   "?" gnus-article-describe-briefly
4352   "<" beginning-of-buffer
4353   ">" end-of-buffer
4354   "\C-c\C-i" gnus-info-find-node
4355   "\C-c\C-b" gnus-bug
4356   "R" gnus-article-reply-with-original
4357   "F" gnus-article-followup-with-original
4358   "\C-hk" gnus-article-describe-key
4359   "\C-hc" gnus-article-describe-key-briefly
4360   "\C-hb" gnus-article-describe-bindings
4361
4362   "e" gnus-article-read-summary-keys
4363   "\C-d" gnus-article-read-summary-keys
4364   "\M-*" gnus-article-read-summary-keys
4365   "\M-#" gnus-article-read-summary-keys
4366   "\M-^" gnus-article-read-summary-keys
4367   "\M-g" gnus-article-read-summary-keys)
4368
4369 (substitute-key-definition
4370  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4371
4372 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4373   "W" gnus-article-wide-reply-with-original)
4374 (if (featurep 'xemacs)
4375     (set-keymap-default-binding gnus-article-send-map
4376                                 'gnus-article-read-summary-send-keys)
4377   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4378
4379 (defun gnus-article-make-menu-bar ()
4380   (unless (boundp 'gnus-article-commands-menu)
4381     (gnus-summary-make-menu-bar))
4382   (gnus-turn-off-edit-menu 'article)
4383   (unless (boundp 'gnus-article-article-menu)
4384     (easy-menu-define
4385      gnus-article-article-menu gnus-article-mode-map ""
4386      '("Article"
4387        ["Scroll forwards" gnus-article-goto-next-page t]
4388        ["Scroll backwards" gnus-article-goto-prev-page t]
4389        ["Show summary" gnus-article-show-summary t]
4390        ["Fetch Message-ID at point" gnus-article-refer-article t]
4391        ["Mail to address at point" gnus-article-mail t]
4392        ["Send a bug report" gnus-bug t]))
4393
4394     (easy-menu-define
4395      gnus-article-treatment-menu gnus-article-mode-map ""
4396      ;; Fixme: this should use :active (and maybe :visible).
4397      '("Treatment"
4398        ["Hide headers" gnus-article-hide-headers t]
4399        ["Hide signature" gnus-article-hide-signature t]
4400        ["Hide citation" gnus-article-hide-citation t]
4401        ["Treat overstrike" gnus-article-treat-overstrike t]
4402        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4403        ["Remove carriage return" gnus-article-remove-cr t]
4404        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4405        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4406        ["Remove base64" gnus-article-de-base64-unreadable t]
4407        ["Treat html" gnus-article-wash-html t]
4408        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4409        ["Decode HZ" gnus-article-decode-HZ t]))
4410
4411     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4412
4413     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4414
4415     (gnus-run-hooks 'gnus-article-menu-hook)))
4416
4417 (defun gnus-article-mode ()
4418   "Major mode for displaying an article.
4419
4420 All normal editing commands are switched off.
4421
4422 The following commands are available in addition to all summary mode
4423 commands:
4424 \\<gnus-article-mode-map>
4425 \\[gnus-article-next-page]\t Scroll the article one page forwards
4426 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4427 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4428 \\[gnus-article-show-summary]\t Display the summary buffer
4429 \\[gnus-article-mail]\t Send a reply to the address near point
4430 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4431 \\[gnus-info-find-node]\t Go to the Gnus info node"
4432   (interactive)
4433   (kill-all-local-variables)
4434   (gnus-simplify-mode-line)
4435   (setq mode-name "Article")
4436   (setq major-mode 'gnus-article-mode)
4437   (make-local-variable 'minor-mode-alist)
4438   (use-local-map gnus-article-mode-map)
4439   (when (gnus-visual-p 'article-menu 'menu)
4440     (gnus-article-make-menu-bar)
4441     (when gnus-summary-tool-bar-map
4442       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4443   (gnus-update-format-specifications nil 'article-mode)
4444   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4445   (set (make-local-variable 'gnus-page-broken) nil)
4446   (make-local-variable 'gnus-button-marker-list)
4447   (make-local-variable 'gnus-article-current-summary)
4448   (make-local-variable 'gnus-article-mime-handles)
4449   (make-local-variable 'gnus-article-decoded-p)
4450   (make-local-variable 'gnus-article-mime-handle-alist)
4451   (make-local-variable 'gnus-article-wash-types)
4452   (make-local-variable 'gnus-article-image-alist)
4453   (make-local-variable 'gnus-article-charset)
4454   (make-local-variable 'gnus-article-ignored-charsets)
4455   (set (make-local-variable 'bookmark-make-record-function)
4456        'gnus-summary-bookmark-make-record)
4457   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4458   ;; face.
4459   (set (make-local-variable 'nobreak-char-display) nil)
4460   (setq cursor-in-non-selected-windows nil)
4461   (setq truncate-lines gnus-article-truncate-lines)
4462   (gnus-set-default-directory)
4463   (buffer-disable-undo)
4464   (setq buffer-read-only t
4465         show-trailing-whitespace nil)
4466   (set-syntax-table gnus-article-mode-syntax-table)
4467   (mm-enable-multibyte)
4468   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4469
4470 (defvar gnus-button-marker-list nil
4471   "Regexp matching any of the regexps from `gnus-button-alist'.
4472 Internal variable.")
4473
4474 (defun gnus-article-setup-buffer ()
4475   "Initialize the article buffer."
4476   (let* ((name (if gnus-single-article-buffer "*Article*"
4477                  (concat "*Article " gnus-newsgroup-name "*")))
4478          (original
4479           (progn (string-match "\\*Article" name)
4480                  (concat " *Original Article"
4481                          (substring name (match-end 0))))))
4482     (setq gnus-article-buffer name)
4483     (setq gnus-original-article-buffer original)
4484     (setq gnus-article-mime-handle-alist nil)
4485     (with-current-buffer gnus-summary-buffer
4486       ;; This might be a variable local to the summary buffer.
4487       (unless gnus-single-article-buffer
4488         (setq gnus-article-buffer name)
4489         (setq gnus-original-article-buffer original)
4490         (gnus-set-global-variables)))
4491     (gnus-article-setup-highlight-words)
4492     ;; Init original article buffer.
4493     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4494       (mm-enable-multibyte)
4495       (setq major-mode 'gnus-original-article-mode)
4496       (make-local-variable 'gnus-original-article))
4497     (if (and (get-buffer name)
4498              (with-current-buffer name
4499                (if gnus-article-edit-mode
4500                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4501                        (progn
4502                          (set-buffer-modified-p nil)
4503                          (gnus-kill-buffer name)
4504                          (message "")
4505                          nil)
4506                      (error "Action aborted"))
4507                  t)))
4508         (with-current-buffer name
4509           (set (make-local-variable 'gnus-article-edit-mode) nil)
4510           (when gnus-article-mime-handles
4511             (mm-destroy-parts gnus-article-mime-handles)
4512             (setq gnus-article-mime-handles nil))
4513           ;; Set it to nil in article-buffer!
4514           (setq gnus-article-mime-handle-alist nil)
4515           (buffer-disable-undo)
4516           (setq buffer-read-only t)
4517           ;; This list just keeps growing if we don't reset it.
4518           (setq gnus-button-marker-list nil)
4519           (unless (eq major-mode 'gnus-article-mode)
4520             (gnus-article-mode))
4521           (current-buffer))
4522       (with-current-buffer (gnus-get-buffer-create name)
4523         (gnus-article-mode)
4524         (make-local-variable 'gnus-summary-buffer)
4525         (setq gnus-summary-buffer
4526               (gnus-summary-buffer-name gnus-newsgroup-name))
4527         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4528         (current-buffer)))))
4529
4530 ;; Set article window start at LINE, where LINE is the number of lines
4531 ;; from the head of the article.
4532 (defun gnus-article-set-window-start (&optional line)
4533   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4534     (when article-window
4535       (set-window-start
4536        article-window
4537        (with-current-buffer gnus-article-buffer
4538          (goto-char (point-min))
4539          (if (not line)
4540              (point-min)
4541            (gnus-message 6 "Moved to bookmark")
4542            (search-forward "\n\n" nil t)
4543            (forward-line line)
4544            (point)))))))
4545
4546 (defun gnus-article-prepare (article &optional all-headers header)
4547   "Prepare ARTICLE in article mode buffer.
4548 ARTICLE should either be an article number or a Message-ID.
4549 If ARTICLE is an id, HEADER should be the article headers.
4550 If ALL-HEADERS is non-nil, no headers are hidden."
4551   (save-excursion
4552     ;; Make sure we start in a summary buffer.
4553     (unless (eq major-mode 'gnus-summary-mode)
4554       (set-buffer gnus-summary-buffer))
4555     (setq gnus-summary-buffer (current-buffer))
4556     (let* ((gnus-article (if header (mail-header-number header) article))
4557            (summary-buffer (current-buffer))
4558            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4559            (group gnus-newsgroup-name)
4560            result)
4561       (save-excursion
4562         (gnus-article-setup-buffer)
4563         (set-buffer gnus-article-buffer)
4564         ;; Deactivate active regions.
4565         (when (and (boundp 'transient-mark-mode)
4566                    transient-mark-mode)
4567           (setq mark-active nil))
4568         (if (not (setq result (let ((inhibit-read-only t))
4569                                 (gnus-request-article-this-buffer
4570                                  article group))))
4571             ;; There is no such article.
4572             (save-excursion
4573               (when (and (numberp article)
4574                          (not (memq article gnus-newsgroup-sparse)))
4575                 (setq gnus-article-current
4576                       (cons gnus-newsgroup-name article))
4577                 (set-buffer gnus-summary-buffer)
4578                 (setq gnus-current-article article)
4579                 (if (and (memq article gnus-newsgroup-undownloaded)
4580                          (not (gnus-online (gnus-find-method-for-group
4581                                             gnus-newsgroup-name))))
4582                     (progn
4583                       (gnus-summary-set-agent-mark article)
4584                       (message "Message marked for downloading"))
4585                   (gnus-summary-mark-article article gnus-canceled-mark)
4586                   (unless (memq article gnus-newsgroup-sparse)
4587                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4588           (if (or (eq result 'pseudo)
4589                   (eq result 'nneething))
4590               (progn
4591                 (with-current-buffer summary-buffer
4592                   (push article gnus-newsgroup-history)
4593                   (setq gnus-last-article gnus-current-article
4594                         gnus-current-article 0
4595                         gnus-current-headers nil
4596                         gnus-article-current nil)
4597                   (if (eq result 'nneething)
4598                       (gnus-configure-windows 'summary)
4599                     (gnus-configure-windows 'article))
4600                   (gnus-set-global-variables))
4601                 (let ((gnus-article-mime-handle-alist-1
4602                        gnus-article-mime-handle-alist))
4603                   (gnus-set-mode-line 'article)))
4604             ;; The result from the `request' was an actual article -
4605             ;; or at least some text that is now displayed in the
4606             ;; article buffer.
4607             (when (and (numberp article)
4608                        (not (eq article gnus-current-article)))
4609               ;; Seems like a new article has been selected.
4610               ;; `gnus-current-article' must be an article number.
4611               (with-current-buffer summary-buffer
4612                 (push article gnus-newsgroup-history)
4613                 (setq gnus-last-article gnus-current-article
4614                       gnus-current-article article
4615                       gnus-current-headers
4616                       (gnus-summary-article-header gnus-current-article)
4617                       gnus-article-current
4618                       (cons gnus-newsgroup-name gnus-current-article))
4619                 (unless (vectorp gnus-current-headers)
4620                   (setq gnus-current-headers nil))
4621                 (gnus-summary-goto-subject gnus-current-article)
4622                 (when (gnus-summary-show-thread)
4623                   ;; If the summary buffer really was folded, the
4624                   ;; previous goto may not actually have gone to
4625                   ;; the right article, but the thread root instead.
4626                   ;; So we go again.
4627                   (gnus-summary-goto-subject gnus-current-article))
4628                 (gnus-run-hooks 'gnus-mark-article-hook)
4629                 (gnus-set-mode-line 'summary)
4630                 (when (gnus-visual-p 'article-highlight 'highlight)
4631                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4632                 ;; Set the global newsgroup variables here.
4633                 (gnus-set-global-variables)
4634                 (setq gnus-have-all-headers
4635                       (or all-headers gnus-show-all-headers))))
4636             (save-excursion
4637               (gnus-configure-windows 'article))
4638             (when (or (numberp article)
4639                       (stringp article))
4640               (gnus-article-prepare-display)
4641               ;; Do page break.
4642               (goto-char (point-min))
4643               (when gnus-break-pages
4644                 (gnus-narrow-to-page)))
4645             (let ((gnus-article-mime-handle-alist-1
4646                    gnus-article-mime-handle-alist))
4647               (gnus-set-mode-line 'article))
4648             (article-goto-body)
4649             (unless (bobp)
4650               (forward-line -1))
4651             (set-window-point (get-buffer-window (current-buffer)) (point))
4652             (gnus-configure-windows 'article)
4653             t))))))
4654
4655 ;;;###autoload
4656 (defun gnus-article-prepare-display ()
4657   "Make the current buffer look like a nice article."
4658   ;; Hooks for getting information from the article.
4659   ;; This hook must be called before being narrowed.
4660   (let ((gnus-article-buffer (current-buffer))
4661         buffer-read-only
4662         (inhibit-read-only t))
4663     (unless (eq major-mode 'gnus-article-mode)
4664       (gnus-article-mode))
4665     (setq buffer-read-only nil
4666           gnus-article-wash-types nil
4667           gnus-article-image-alist nil)
4668     (gnus-run-hooks 'gnus-tmp-internal-hook)
4669     (when gnus-display-mime-function
4670       (funcall gnus-display-mime-function))
4671     (gnus-run-hooks 'gnus-article-prepare-hook)))
4672
4673 ;;;
4674 ;;; Gnus Sticky Article Mode
4675 ;;;
4676
4677 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4678   "Mode for sticky articles."
4679   ;; Release bindings that won't work.
4680   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4681                              gnus-sticky-article-mode-map)
4682   (substitute-key-definition 'gnus-article-refer-article 'undefined
4683                              gnus-sticky-article-mode-map)
4684   (dolist (k '("e" "h" "s" "F" "R"))
4685     (define-key gnus-sticky-article-mode-map k nil))
4686   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4687   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4688   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4689   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4690
4691 (defun gnus-sticky-article (arg)
4692   "Make the current article sticky.
4693 If a prefix ARG is given, ask for a name for this sticky article buffer."
4694   (interactive "P")
4695   (gnus-summary-show-thread)
4696   (gnus-summary-select-article nil nil 'pseudo)
4697   (let (new-art-buf-name)
4698     (gnus-eval-in-buffer-window gnus-article-buffer
4699       (setq new-art-buf-name
4700             (concat
4701              "*Sticky Article: "
4702              (if arg
4703                  (read-from-minibuffer "Sticky article buffer name: ")
4704                (gnus-with-article-headers
4705                  (gnus-article-goto-header "subject")
4706                  (setq new-art-buf-name
4707                        (buffer-substring-no-properties
4708                         (line-beginning-position) (line-end-position)))
4709                  (goto-char (point-min))
4710                  (gnus-article-goto-header "from")
4711                  (setq new-art-buf-name
4712                        (concat
4713                         new-art-buf-name ", "
4714                         (buffer-substring-no-properties
4715                          (line-beginning-position) (line-end-position))))
4716                  (goto-char (point-min))
4717                  (gnus-article-goto-header "date")
4718                  (setq new-art-buf-name
4719                        (concat
4720                         new-art-buf-name ", "
4721                         (buffer-substring-no-properties
4722                          (line-beginning-position) (line-end-position))))))
4723              "*"))
4724       (if (and (gnus-buffer-live-p new-art-buf-name)
4725                (with-current-buffer new-art-buf-name
4726                  (eq major-mode 'gnus-sticky-article-mode)))
4727           (switch-to-buffer new-art-buf-name)
4728         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4729       (gnus-sticky-article-mode))
4730     (setq gnus-article-buffer new-art-buf-name))
4731   (gnus-summary-recenter)
4732   (gnus-summary-position-point))
4733
4734 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4735   "Kill the given sticky article BUFFER.
4736 If none is given, assume the current buffer and kill it if it has
4737 `gnus-sticky-article-mode'."
4738   (interactive)
4739   (unless buffer
4740     (setq buffer (current-buffer)))
4741   (with-current-buffer buffer
4742     (when (eq major-mode 'gnus-sticky-article-mode)
4743       (gnus-kill-buffer buffer))))
4744
4745 (defun gnus-kill-sticky-article-buffers (arg)
4746   "Kill all sticky article buffers.
4747 If a prefix ARG is given, ask for confirmation."
4748   (interactive "P")
4749   (dolist (buf (gnus-buffers))
4750     (with-current-buffer buf
4751       (when (eq major-mode 'gnus-sticky-article-mode)
4752         (if (not arg)
4753             (gnus-kill-buffer buf)
4754           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4755             (gnus-kill-buffer buf)))))))
4756
4757 ;;;
4758 ;;; Gnus MIME viewing functions
4759 ;;;
4760
4761 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4762   "Format of the MIME buttons.
4763
4764 Valid specifiers include:
4765 %t  The MIME type
4766 %T  MIME type, along with additional info
4767 %n  The `name' parameter
4768 %d  The description, if any
4769 %l  The length of the encoded part
4770 %p  The part identifier number
4771 %e  Dots if the part isn't displayed
4772
4773 General format specifiers can also be used.  See Info node
4774 `(gnus)Formatting Variables'.")
4775
4776 (defvar gnus-mime-button-line-format-alist
4777   '((?t gnus-tmp-type ?s)
4778     (?T gnus-tmp-type-long ?s)
4779     (?n gnus-tmp-name ?s)
4780     (?d gnus-tmp-description ?s)
4781     (?p gnus-tmp-id ?s)
4782     (?l gnus-tmp-length ?d)
4783     (?e gnus-tmp-dots ?s)))
4784
4785 (defvar gnus-mime-button-commands
4786   '((gnus-article-press-button "\r" "Toggle Display")
4787     (gnus-mime-view-part "v" "View Interactively...")
4788     (gnus-mime-view-part-as-type "t" "View As Type...")
4789     (gnus-mime-view-part-as-charset "C" "View As charset...")
4790     (gnus-mime-save-part "o" "Save...")
4791     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4792     (gnus-mime-replace-part "r" "Replace part")
4793     (gnus-mime-delete-part "d" "Delete part")
4794     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4795     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4796     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4797     (gnus-mime-view-part-externally "e" "View Externally")
4798     (gnus-mime-print-part "p" "Print")
4799     (gnus-mime-pipe-part "|" "Pipe To Command...")
4800     (gnus-mime-action-on-part "." "Take action on the part...")))
4801
4802 (defun gnus-article-mime-part-status ()
4803   (if gnus-article-mime-handle-alist-1
4804       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4805           " (1 part)"
4806         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4807     ""))
4808
4809 (defvar gnus-mime-button-map
4810   (let ((map (make-sparse-keymap)))
4811     (define-key map gnus-mouse-2 'gnus-article-push-button)
4812     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4813     (dolist (c gnus-mime-button-commands)
4814       (define-key map (cadr c) (car c)))
4815     map))
4816
4817 (easy-menu-define
4818   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4819   `("MIME Part"
4820     ,@(mapcar (lambda (c)
4821                 (vector (caddr c) (car c) :active t))
4822               gnus-mime-button-commands)))
4823
4824 (defmacro gnus-bind-safe-url-regexp (&rest body)
4825   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4826   `(let ((mm-w3m-safe-url-regexp
4827           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4828                                 (gnus-buffer-live-p
4829                                  gnus-article-current-summary))
4830                            (with-current-buffer gnus-article-current-summary
4831                              gnus-newsgroup-name)
4832                          gnus-newsgroup-name)))
4833             (if (cond ((not group)
4834                        ;; Maybe we're in a mml-preview buffer
4835                        ;; and no group is selected.
4836                        t)
4837                       ((stringp gnus-safe-html-newsgroups)
4838                        (string-match gnus-safe-html-newsgroups group))
4839                       ((consp gnus-safe-html-newsgroups)
4840                        (member group gnus-safe-html-newsgroups)))
4841                 nil
4842               mm-w3m-safe-url-regexp))))
4843      ,@body))
4844
4845 (defun gnus-mime-button-menu (event prefix)
4846  "Construct a context-sensitive menu of MIME commands."
4847  (interactive "e\nP")
4848  (save-window-excursion
4849    (let ((pos (event-start event)))
4850      (select-window (posn-window pos))
4851      (goto-char (posn-point pos))
4852      (gnus-article-check-buffer)
4853      (popup-menu gnus-mime-button-menu nil prefix))))
4854
4855 (defun gnus-mime-view-all-parts (&optional handles)
4856   "View all the MIME parts."
4857   (interactive)
4858   (with-current-buffer gnus-article-buffer
4859     (let ((handles (or handles gnus-article-mime-handles))
4860           (mail-parse-charset gnus-newsgroup-charset)
4861           (mail-parse-ignored-charsets
4862            (with-current-buffer gnus-summary-buffer
4863              gnus-newsgroup-ignored-charsets)))
4864       (when handles
4865         (mm-remove-parts handles)
4866         (goto-char (point-min))
4867         (or (search-forward "\n\n") (goto-char (point-max)))
4868         (let ((inhibit-read-only t))
4869           (delete-region (point) (point-max))
4870           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4871
4872 (defun gnus-article-jump-to-part (n)
4873   "Jump to MIME part N."
4874   (interactive "P")
4875   (pop-to-buffer gnus-article-buffer)
4876   ;; FIXME: why is it necessary?
4877   (sit-for 0)
4878   (let ((parts (length gnus-article-mime-handle-alist)))
4879     (or n (setq n
4880                 (string-to-number
4881                  (read-string ;; Emacs 21 doesn't have `read-number'.
4882                   (format "Jump to part (2..%s): " parts)))))
4883     (unless (and (integerp n) (<= n parts) (>= n 1))
4884       (setq n
4885             (progn
4886               (gnus-message 7 "Invalid part `%s', using %s instead."
4887                             n parts)
4888               parts)))
4889     (gnus-message 9 "Jumping to part %s." n)
4890     (cond ((>= gnus-auto-select-part 1)
4891            (while (and (<= n parts)
4892                        (not (gnus-article-goto-part n)))
4893              (setq n (1+ n))))
4894           ((< gnus-auto-select-part 0)
4895            (while (and (>= n 1)
4896                        (not (gnus-article-goto-part n)))
4897              (setq n (1- n))))
4898           (t
4899            (gnus-article-goto-part n)))))
4900
4901 (defvar gnus-mime-buttonized-part-id nil
4902   "ID of a mime part that should be buttonized.
4903 `gnus-mime-save-part-and-strip' and `gnus-mime-delete-part' bind it.")
4904
4905 (eval-when-compile
4906   (defsubst gnus-article-edit-part (handles &optional current-id)
4907     "Edit an article in order to delete a mime part.
4908 This function is exclusively used by `gnus-mime-save-part-and-strip'
4909 and `gnus-mime-delete-part', and not provided at run-time normally."
4910     (gnus-article-edit-article
4911      `(lambda ()
4912         (buffer-disable-undo)
4913         (erase-buffer)
4914         (let ((mail-parse-charset (or gnus-article-charset
4915                                       ',gnus-newsgroup-charset))
4916               (mail-parse-ignored-charsets
4917                (or gnus-article-ignored-charsets
4918                    ',gnus-newsgroup-ignored-charsets))
4919               (mbl mml-buffer-list))
4920           (setq mml-buffer-list nil)
4921           (insert-buffer-substring gnus-original-article-buffer)
4922           (mime-to-mml ',handles)
4923           (setq gnus-article-mime-handles nil)
4924           (let ((mbl1 mml-buffer-list))
4925             (setq mml-buffer-list mbl)
4926             (set (make-local-variable 'mml-buffer-list) mbl1))
4927           (gnus-make-local-hook 'kill-buffer-hook)
4928           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4929      `(lambda (no-highlight)
4930         (let ((mail-parse-charset (or gnus-article-charset
4931                                       ',gnus-newsgroup-charset))
4932               (message-options message-options)
4933               (message-options-set-recipient)
4934               (mail-parse-ignored-charsets
4935                (or gnus-article-ignored-charsets
4936                    ',gnus-newsgroup-ignored-charsets)))
4937           (mml-to-mime)
4938           (mml-destroy-buffers)
4939           (remove-hook 'kill-buffer-hook
4940                        'mml-destroy-buffers t)
4941           (kill-local-variable 'mml-buffer-list))
4942         (gnus-summary-edit-article-done
4943          ,(or (mail-header-references gnus-current-headers) "")
4944          ,(gnus-group-read-only-p)
4945          ,gnus-summary-buffer no-highlight))
4946      t)
4947     ;; Force buttonizing this part.
4948     (let ((gnus-mime-buttonized-part-id current-id))
4949       (gnus-article-edit-done))
4950     (gnus-configure-windows 'article)
4951     (when (and current-id (integerp gnus-auto-select-part))
4952       (gnus-article-jump-to-part
4953        (min (max (+ current-id gnus-auto-select-part) 1)
4954             (with-current-buffer gnus-article-buffer
4955               (length gnus-article-mime-handle-alist)))))))
4956
4957 (defun gnus-mime-replace-part (file)
4958   "Replace MIME part under point with an external body."
4959   ;; Useful if file has already been saved to disk
4960   (interactive
4961    (list
4962     (read-file-name "Replace MIME part with file: "
4963                     (or mm-default-directory default-directory)
4964                     nil nil)))
4965   (gnus-mime-save-part-and-strip file))
4966
4967 (defun gnus-mime-save-part-and-strip (&optional file)
4968   "Save the MIME part under point then replace it with an external body.
4969 If FILE is given, use it for the external part."
4970   (interactive)
4971   (gnus-article-check-buffer)
4972   (when (gnus-group-read-only-p)
4973     (error "The current group does not support deleting of parts"))
4974   (when (mm-complicated-handles gnus-article-mime-handles)
4975     (error "\
4976 The current article has a complicated MIME structure, giving up..."))
4977   (let* ((data (get-text-property (point) 'gnus-data))
4978          (id (get-text-property (point) 'gnus-part))
4979          param
4980          (handles gnus-article-mime-handles))
4981     (unless file
4982       (setq file
4983             (and data (mm-save-part data "Delete MIME part and save to: "))))
4984     (when file
4985       (with-current-buffer (mm-handle-buffer data)
4986         (erase-buffer)
4987         (insert "Content-Type: " (mm-handle-media-type data))
4988         (mml-insert-parameter-string (cdr (mm-handle-type data))
4989                                      '(charset))
4990         ;; Add a filename for the sake of saving the part again.
4991         (mml-insert-parameter
4992          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4993         (insert "\n")
4994         (insert "Content-ID: " (message-make-message-id) "\n")
4995         (insert "Content-Transfer-Encoding: binary\n")
4996         (insert "\n"))
4997       (setcdr data
4998               (cdr (mm-make-handle nil
4999                                    `("message/external-body"
5000                                      (access-type . "LOCAL-FILE")
5001                                      (name . ,file)))))
5002       ;; (set-buffer gnus-summary-buffer)
5003       (gnus-article-edit-part handles id))))
5004
5005 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
5006 ;; parts...>') but with stripping would be nice.
5007
5008 (defun gnus-mime-delete-part ()
5009   "Delete the MIME part under point.
5010 Replace it with some information about the removed part."
5011   (interactive)
5012   (gnus-article-check-buffer)
5013   (when (gnus-group-read-only-p)
5014     (error "The current group does not support deleting of parts"))
5015   (when (mm-complicated-handles gnus-article-mime-handles)
5016     (error "\
5017 The current article has a complicated MIME structure, giving up..."))
5018   (when (or gnus-expert-user
5019             (gnus-yes-or-no-p "\
5020 Deleting parts may malfunction or destroy the article; continue? "))
5021     (let* ((data (get-text-property (point) 'gnus-data))
5022            (id (get-text-property (point) 'gnus-part))
5023            (handles gnus-article-mime-handles)
5024            (none "(none)")
5025            (description
5026             (let ((desc (mm-handle-description data)))
5027               (when desc
5028                 (mail-decode-encoded-word-string desc))))
5029            (filename
5030             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
5031                 none))
5032            (type (mm-handle-media-type data)))
5033       (unless data
5034         (error "No MIME part under point"))
5035       (with-current-buffer (mm-handle-buffer data)
5036         (let ((bsize (format "%s" (buffer-size))))
5037           (erase-buffer)
5038           (insert
5039            (concat
5040             ",----\n"
5041             "| The following attachment has been deleted:\n"
5042             "|\n"
5043             "| Type:           " type "\n"
5044             "| Filename:       " filename "\n"
5045             "| Size (encoded): " bsize " Byte\n"
5046             (when description
5047               (concat    "| Description:    " description "\n"))
5048             "`----\n"))
5049           (setcdr data
5050                   (cdr (mm-make-handle
5051                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5052                         (list "attachment")
5053                         (format "Deleted attachment (%s bytes)" bsize))))))
5054       ;; (set-buffer gnus-summary-buffer)
5055       (gnus-article-edit-part handles id))))
5056
5057 (defun gnus-mime-save-part ()
5058   "Save the MIME part under point."
5059   (interactive)
5060   (gnus-article-check-buffer)
5061   (let ((data (get-text-property (point) 'gnus-data)))
5062     (when data
5063       (mm-save-part data))))
5064
5065 (defun gnus-mime-pipe-part (&optional cmd)
5066   "Pipe the MIME part under point to a process.
5067 Use CMD as the process."
5068   (interactive)
5069   (gnus-article-check-buffer)
5070   (let ((data (get-text-property (point) 'gnus-data)))
5071     (when data
5072       (mm-pipe-part data cmd))))
5073
5074 (defun gnus-mime-view-part ()
5075   "Interactively choose a viewing method for the MIME part under point."
5076   (interactive)
5077   (gnus-article-check-buffer)
5078   (let ((data (get-text-property (point) 'gnus-data)))
5079     (when data
5080       (setq gnus-article-mime-handles
5081             (mm-merge-handles
5082              gnus-article-mime-handles (setq data (copy-sequence data))))
5083       (mm-interactively-view-part data))))
5084
5085 (defun gnus-mime-view-part-as-type-internal ()
5086   (gnus-article-check-buffer)
5087   (let* ((handle (get-text-property (point) 'gnus-data))
5088          (name (or
5089                 ;; Content-Type: foo/bar; name=...
5090                 (mail-content-type-get (mm-handle-type handle) 'name)
5091                 ;; Content-Disposition: attachment; filename=...
5092                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5093          (def-type (and name (mm-default-file-encoding name))))
5094     (or (and def-type (cons def-type 0))
5095         (and handle
5096              (equal (mm-handle-media-supertype handle) "text")
5097              '("text/plain" . 0))
5098         '("application/octet-stream" . 0))))
5099
5100 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5101   "Choose a MIME media type, and view the part as such.
5102 If non-nil, PRED is a predicate to use during completion to limit the
5103 available media-types."
5104   (interactive)
5105   (unless mime-type
5106     (setq mime-type
5107           (let ((default (gnus-mime-view-part-as-type-internal)))
5108             (completing-read
5109              (format "View as MIME type (default %s): "
5110                      (car default))
5111              (mapcar #'list (mailcap-mime-types))
5112              pred nil nil nil
5113              (car default)))))
5114   (gnus-article-check-buffer)
5115   (let ((handle (get-text-property (point) 'gnus-data)))
5116     (when handle
5117       (when (equal (mm-handle-media-type handle) "message/external-body")
5118         (unless (mm-handle-cache handle)
5119           (mm-extern-cache-contents handle))
5120         (setq handle (mm-handle-cache handle)))
5121       (setq handle
5122             (mm-make-handle (mm-handle-buffer handle)
5123                             (cons mime-type (cdr (mm-handle-type handle)))
5124                             (mm-handle-encoding handle)
5125                             (mm-handle-undisplayer handle)
5126                             (mm-handle-disposition handle)
5127                             (mm-handle-description handle)
5128                             nil
5129                             (mm-handle-id handle)))
5130       (setq gnus-article-mime-handles
5131             (mm-merge-handles gnus-article-mime-handles handle))
5132       (when (mm-handle-displayed-p handle)
5133         (mm-remove-part handle))
5134       (gnus-mm-display-part handle))))
5135
5136 (defun gnus-mime-copy-part (&optional handle arg)
5137   "Put the MIME part under point into a new buffer.
5138 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5139 are decompressed."
5140   (interactive (list nil current-prefix-arg))
5141   (gnus-article-check-buffer)
5142   (unless handle
5143     (setq handle (get-text-property (point) 'gnus-data)))
5144   (when handle
5145     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5146                                                'name)
5147                         (mail-content-type-get (mm-handle-disposition handle)
5148                                                'filename)))
5149           contents dont-decode charset coding-system)
5150       (mm-with-unibyte-buffer
5151         (mm-insert-part handle)
5152         (setq contents (or (condition-case nil
5153                                (mm-decompress-buffer filename nil 'sig)
5154                              (error
5155                               (setq dont-decode t)
5156                               nil))
5157                            (buffer-string))))
5158       (setq filename (cond (filename (file-name-nondirectory filename))
5159                            (dont-decode "*raw data*")
5160                            (t "*decoded*")))
5161       (cond
5162        (dont-decode)
5163        ((not arg)
5164         (unless (setq charset (mail-content-type-get
5165                                (mm-handle-type handle) 'charset))
5166           (unless (setq coding-system (mm-with-unibyte-buffer
5167                                         (insert contents)
5168                                         (mm-find-buffer-file-coding-system)))
5169             (setq charset gnus-newsgroup-charset))))
5170        ((numberp arg)
5171         (setq charset (or (cdr (assq arg
5172                                      gnus-summary-show-article-charset-alist))
5173                           (mm-read-coding-system "Charset: ")))))
5174       (switch-to-buffer (generate-new-buffer filename))
5175       (if (or coding-system
5176               (and charset
5177                    (setq coding-system (mm-charset-to-coding-system charset))
5178                    (not (eq charset 'ascii))))
5179           (progn
5180             (mm-enable-multibyte)
5181             (insert (mm-decode-coding-string contents coding-system))
5182             (setq buffer-file-coding-system
5183                   (if (boundp 'last-coding-system-used)
5184                       (symbol-value 'last-coding-system-used)
5185                     coding-system)))
5186         (mm-disable-multibyte)
5187         (insert contents)
5188         (setq buffer-file-coding-system mm-binary-coding-system))
5189       ;; We do it this way to make `normal-mode' set the appropriate mode.
5190       (unwind-protect
5191           (progn
5192             (setq buffer-file-name (expand-file-name filename))
5193             (normal-mode))
5194         (setq buffer-file-name nil))
5195       (goto-char (point-min)))))
5196
5197 (defun gnus-mime-print-part (&optional handle filename)
5198   "Print the MIME part under point."
5199   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5200   (gnus-article-check-buffer)
5201   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5202          (contents (and handle (mm-get-part handle)))
5203          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5204          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5205     (when contents
5206         (if printer
5207             (unwind-protect
5208                 (progn
5209                   (mm-save-part-to-file handle file)
5210                   (call-process shell-file-name nil
5211                                 (generate-new-buffer " *mm*")
5212                                 nil
5213                                 shell-command-switch
5214                                 (mm-mailcap-command
5215                                  printer file (mm-handle-type handle))))
5216               (delete-file file))
5217           (with-temp-buffer
5218             (insert contents)
5219             (gnus-print-buffer))
5220           (ps-despool filename)))))
5221
5222 (defun gnus-mime-inline-part (&optional handle arg)
5223   "Insert the MIME part under point into the current buffer.
5224 Compressed files like .gz and .bz2 are decompressed."
5225   (interactive (list nil current-prefix-arg))
5226   (gnus-article-check-buffer)
5227   (unless handle
5228     (setq handle (get-text-property (point) 'gnus-data)))
5229   (when handle
5230     (let ((b (point))
5231           (inhibit-read-only t)
5232           contents charset coding-system)
5233       (if (and (not arg) (mm-handle-undisplayer handle))
5234           (mm-remove-part handle)
5235         (mm-with-unibyte-buffer
5236           (mm-insert-part handle)
5237           (setq contents
5238                 (or (mm-decompress-buffer
5239                      (or (mail-content-type-get (mm-handle-type handle)
5240                                                 'name)
5241                          (mail-content-type-get (mm-handle-disposition handle)
5242                                                 'filename))
5243                      nil t)
5244                     (buffer-string))))
5245         (cond
5246          ((not arg)
5247           (unless (setq charset (mail-content-type-get
5248                                  (mm-handle-type handle) 'charset))
5249             (unless (setq coding-system
5250                           (mm-with-unibyte-buffer
5251                             (insert contents)
5252                             (mm-find-buffer-file-coding-system)))
5253               (setq charset gnus-newsgroup-charset))))
5254          ((numberp arg)
5255           (if (mm-handle-undisplayer handle)
5256               (mm-remove-part handle))
5257           (setq charset
5258                 (or (cdr (assq arg
5259                                gnus-summary-show-article-charset-alist))
5260                     (mm-read-coding-system "Charset: "))))
5261          (t
5262           (if (mm-handle-undisplayer handle)
5263               (mm-remove-part handle))))
5264         (forward-line 2)
5265         (mm-insert-inline
5266          handle
5267          (if (or coding-system
5268                  (and charset
5269                       (setq coding-system
5270                             (mm-charset-to-coding-system charset))
5271                       (not (eq coding-system 'ascii))))
5272              (mm-decode-coding-string contents coding-system)
5273            (mm-string-to-multibyte contents)))
5274         (goto-char b)))))
5275
5276 (defun gnus-mime-set-charset-parameters (handle charset)
5277   "Set CHARSET to parameters in HANDLE.
5278 CHARSET may either be a string or a symbol."
5279   (unless (stringp charset)
5280     (setq charset (symbol-name charset)))
5281   (if (stringp (car handle))
5282       (dolist (h (cdr handle))
5283         (gnus-mime-set-charset-parameters h charset))
5284     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5285                                             "message/external-body")
5286                                      (progn
5287                                        (unless (mm-handle-cache handle)
5288                                          (mm-extern-cache-contents handle))
5289                                        (mm-handle-cache handle))
5290                                    handle)))
5291            (param (assq 'charset (cdr type))))
5292       (if param
5293           (setcdr param charset)
5294         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5295
5296 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5297   "Insert the MIME part under point into the current buffer using the
5298 specified charset."
5299   (interactive (list nil current-prefix-arg))
5300   (gnus-article-check-buffer)
5301   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5302         (fun (get-text-property (point) 'gnus-callback))
5303         (gnus-newsgroup-ignored-charsets 'gnus-all)
5304         charset form preferred parts)
5305     (when handle
5306       (when (prog1
5307                 (and fun
5308                      (setq charset
5309                            (or (cdr (assq
5310                                      arg
5311                                      gnus-summary-show-article-charset-alist))
5312                                (mm-read-coding-system "Charset: "))))
5313               (if (mm-handle-undisplayer handle)
5314                   (mm-remove-part handle)))
5315         (gnus-mime-set-charset-parameters handle charset)
5316         (when (and (consp (setq form (cdr-safe fun)))
5317                    (setq form (ignore-errors
5318                                 (assq 'gnus-mime-display-alternative form)))
5319                    (setq preferred (caddr form))
5320                    (progn
5321                      (when (eq (car preferred) 'quote)
5322                        (setq preferred (cadr preferred)))
5323                      (not (equal preferred
5324                                  (get-text-property (point) 'gnus-data))))
5325                    (setq parts (get-text-property (point) 'gnus-part))
5326                    (setq parts (cdr (assq parts
5327                                           gnus-article-mime-handle-alist)))
5328                    (equal (mm-handle-media-type parts) "multipart/alternative")
5329                    (setq parts (reverse (cdr parts))))
5330           (setcar (cddr form)
5331                   (list 'quote (or (cadr (member preferred parts))
5332                                    (car parts)))))
5333         (funcall fun handle)))))
5334
5335 (defun gnus-mime-view-part-externally (&optional handle)
5336   "View the MIME part under point with an external viewer."
5337   (interactive)
5338   (gnus-article-check-buffer)
5339   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5340          (mm-user-display-methods nil)
5341          (mm-inlined-types nil)
5342          (mail-parse-charset gnus-newsgroup-charset)
5343          (mail-parse-ignored-charsets
5344           (with-current-buffer gnus-summary-buffer
5345             gnus-newsgroup-ignored-charsets))
5346          (type (mm-handle-media-type handle))
5347          (method (mailcap-mime-info type))
5348          (mm-enable-external t))
5349     (if (not (stringp method))
5350         (gnus-mime-view-part-as-type
5351          nil (lambda (types) (stringp (mailcap-mime-info (car types)))))
5352       (when handle
5353         (if (mm-handle-undisplayer handle)
5354             (mm-remove-part handle)
5355           (mm-display-part handle))))))
5356
5357 (defun gnus-mime-view-part-internally (&optional handle)
5358   "View the MIME part under point with an internal viewer.
5359 If no internal viewer is available, use an external viewer."
5360   (interactive)
5361   (gnus-article-check-buffer)
5362   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5363          (mm-inlined-types '(".*"))
5364          (mm-inline-large-images t)
5365          (mail-parse-charset gnus-newsgroup-charset)
5366          (mail-parse-ignored-charsets
5367           (with-current-buffer gnus-summary-buffer
5368             gnus-newsgroup-ignored-charsets))
5369          (inhibit-read-only t))
5370     (if (not (mm-inlinable-p handle))
5371         (gnus-mime-view-part-as-type
5372          nil (lambda (types) (mm-inlinable-p handle (car types))))
5373       (when handle
5374         (if (mm-handle-undisplayer handle)
5375             (mm-remove-part handle)
5376           (gnus-bind-safe-url-regexp (mm-display-part handle)))))))
5377
5378 (defun gnus-mime-action-on-part (&optional action)
5379   "Do something with the MIME attachment at \(point\)."
5380   (interactive
5381    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
5382   (gnus-article-check-buffer)
5383   (let ((action-pair (assoc action gnus-mime-action-alist)))
5384     (if action-pair
5385         (funcall (cdr action-pair)))))
5386
5387 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5388   "Call FUNCTION on MIME part N.
5389 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5390 If INTERACTIVE, call FUNCTION interactivly."
5391   (let (window frame)
5392     ;; Check whether the article is displayed.
5393     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5394                  (setq window (get-buffer-window gnus-article-buffer t))
5395                  (frame-visible-p (setq frame (window-frame window))))
5396       (error "No article is displayed"))
5397     (with-current-buffer gnus-article-buffer
5398       ;; Check whether the article displays the right contents.
5399       (unless (with-current-buffer gnus-summary-buffer
5400                 (eq gnus-current-article (gnus-summary-article-number)))
5401         (error "You should select the right article first"))
5402       (if n
5403           (setq n (prefix-numeric-value n))
5404         (let ((pt (point)))
5405           (setq n (or (get-text-property pt 'gnus-part)
5406                       (and (not (bobp))
5407                            (get-text-property (1- pt) 'gnus-part))
5408                       (get-text-property (prog2
5409                                              (forward-line 1)
5410                                              (point)
5411                                            (goto-char pt))
5412                                          'gnus-part)
5413                       (get-text-property
5414                        (or (and (setq pt (previous-single-property-change
5415                                           pt 'gnus-part))
5416                                 (1- pt))
5417                            (next-single-property-change (point) 'gnus-part)
5418                            (point))
5419                        'gnus-part)
5420                       1))))
5421       ;; Check whether the specified part exists.
5422       (when (> n (length gnus-article-mime-handle-alist))
5423         (error "No such part")))
5424     (unless
5425         (progn
5426           ;; To select the window is needed so that the cursor
5427           ;; might be visible on the MIME button.
5428           (select-window (prog1
5429                              window
5430                            (setq window (selected-window))
5431                            ;; Article may be displayed in the other frame.
5432                            (gnus-select-frame-set-input-focus
5433                             (prog1
5434                                 frame
5435                               (setq frame (selected-frame))))))
5436           (when (gnus-article-goto-part n)
5437             ;; We point the cursor and the arrow at the MIME button
5438             ;; when the `function' prompt the user for something.
5439             (let ((cursor-in-non-selected-windows t)
5440                   (overlay-arrow-string "=>")
5441                   (overlay-arrow-position (point-marker)))
5442               (unwind-protect
5443                   (cond
5444                    ((and no-handle interactive)
5445                     (call-interactively function))
5446                    (no-handle
5447                     (funcall function))
5448                    (interactive
5449                     (call-interactively
5450                      function
5451                      (cdr (assq n gnus-article-mime-handle-alist))))
5452                    (t
5453                     (funcall function
5454                              (cdr (assq n gnus-article-mime-handle-alist)))))
5455                 (set-marker overlay-arrow-position nil)
5456                 (unless gnus-auto-select-part
5457                   (gnus-select-frame-set-input-focus frame)
5458                   (select-window window))))
5459             t))
5460       (if gnus-inhibit-mime-unbuttonizing
5461           ;; This is the default though the program shouldn't reach here.
5462           (error "No such part")
5463         ;; The part which doesn't have the MIME button is selected.
5464         ;; So, we display all the buttons and redo it.
5465         (let ((gnus-inhibit-mime-unbuttonizing t))
5466           (gnus-summary-show-article)
5467           (gnus-article-part-wrapper n function no-handle))))))
5468
5469 (defun gnus-article-pipe-part (n)
5470   "Pipe MIME part N, which is the numerical prefix."
5471   (interactive "P")
5472   (gnus-article-part-wrapper n 'mm-pipe-part))
5473
5474 (defun gnus-article-save-part (n)
5475   "Save MIME part N, which is the numerical prefix."
5476   (interactive "P")
5477   (gnus-article-part-wrapper n 'mm-save-part))
5478
5479 (defun gnus-article-interactively-view-part (n)
5480   "View MIME part N interactively, which is the numerical prefix."
5481   (interactive "P")
5482   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5483
5484 (defun gnus-article-copy-part (n)
5485   "Copy MIME part N, which is the numerical prefix."
5486   (interactive "P")
5487   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5488
5489 (defun gnus-article-view-part-as-charset (n)
5490   "View MIME part N using a specified charset.
5491 N is the numerical prefix."
5492   (interactive "P")
5493   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5494
5495 (defun gnus-article-view-part-externally (n)
5496   "View MIME part N externally, which is the numerical prefix."
5497   (interactive "P")
5498   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5499
5500 (defun gnus-article-inline-part (n)
5501   "Inline MIME part N, which is the numerical prefix."
5502   (interactive "P")
5503   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5504
5505 (defun gnus-article-save-part-and-strip (n)
5506   "Save MIME part N and replace it with an external body.
5507 N is the numerical prefix."
5508   (interactive "P")
5509   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5510
5511 (defun gnus-article-replace-part (n)
5512   "Replace MIME part N with an external body.
5513 N is the numerical prefix."
5514   (interactive "P")
5515   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5516
5517 (defun gnus-article-delete-part (n)
5518   "Delete MIME part N and add some information about the removed part.
5519 N is the numerical prefix."
5520   (interactive "P")
5521   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5522
5523 (defun gnus-article-view-part-as-type (n)
5524   "Choose a MIME media type, and view part N as such.
5525 N is the numerical prefix."
5526   (interactive "P")
5527   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5528
5529 (defun gnus-article-mime-match-handle-first (condition)
5530   (if condition
5531       (let (n)
5532         (dolist (ihandle gnus-article-mime-handle-alist)
5533           (if (and (cond
5534                     ((functionp condition)
5535                      (funcall condition (cdr ihandle)))
5536                     ((eq condition 'undisplayed)
5537                      (not (or (mm-handle-undisplayer (cdr ihandle))
5538                               (equal (mm-handle-media-type (cdr ihandle))
5539                                      "multipart/alternative"))))
5540                     ((eq condition 'undisplayed-alternative)
5541                      (not (mm-handle-undisplayer (cdr ihandle))))
5542                     (t t))
5543                    (gnus-article-goto-part (car ihandle))
5544                    (or (not n) (< (car ihandle) n)))
5545               (setq n (car ihandle))))
5546         (or n 1))
5547     1))
5548
5549 (defun gnus-article-view-part (&optional n)
5550   "View MIME part N, which is the numerical prefix."
5551   (interactive "P")
5552   (with-current-buffer gnus-article-buffer
5553     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5554                              gnus-article-mime-match-handle-function)))
5555     (when (> n (length gnus-article-mime-handle-alist))
5556       (error "No such part"))
5557     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5558       (when (gnus-article-goto-part n)
5559         (if (equal (car handle) "multipart/alternative")
5560             (gnus-article-press-button)
5561           (when (eq (gnus-mm-display-part handle) 'internal)
5562             (gnus-set-window-start)))))))
5563
5564 (defsubst gnus-article-mime-total-parts ()
5565   (if (bufferp (car gnus-article-mime-handles))
5566       1 ;; single part
5567     (1- (length gnus-article-mime-handles))))
5568
5569 (defun gnus-mm-display-part (handle)
5570   "Display HANDLE and fix MIME button."
5571   (let ((id (get-text-property (point) 'gnus-part))
5572         (point (point))
5573         (inhibit-read-only t))
5574     (forward-line 1)
5575     (prog1
5576         (let ((window (selected-window))
5577               (mail-parse-charset gnus-newsgroup-charset)
5578               (mail-parse-ignored-charsets
5579                (if (gnus-buffer-live-p gnus-summary-buffer)
5580                    (with-current-buffer gnus-summary-buffer
5581                      gnus-newsgroup-ignored-charsets)
5582                  nil)))
5583           (save-excursion
5584             (unwind-protect
5585                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5586                       (beg (point)))
5587                   (when win
5588                     (select-window win))
5589                   (goto-char point)
5590                   (forward-line)
5591                   (if (mm-handle-displayed-p handle)
5592                       ;; This will remove the part.
5593                       (mm-display-part handle)
5594                     (save-restriction
5595                       (narrow-to-region (point)
5596                                         (if (eobp) (point) (1+ (point))))
5597                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5598                       ;; We narrow to the part itself and
5599                       ;; then call the treatment functions.
5600                       (goto-char (point-min))
5601                       (forward-line 1)
5602                       (narrow-to-region (point) (point-max))
5603                       (gnus-treat-article
5604                        nil id
5605                        (gnus-article-mime-total-parts)
5606                        (mm-handle-media-type handle)))))
5607               (if (window-live-p window)
5608                   (select-window window)))))
5609       (goto-char point)
5610       (gnus-delete-line)
5611       (gnus-insert-mime-button
5612        handle id (list (mm-handle-displayed-p handle)))
5613       (goto-char point))))
5614
5615 (defun gnus-article-goto-part (n)
5616   "Go to MIME part N."
5617   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5618
5619 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5620   (let ((gnus-tmp-name
5621          (or (mail-content-type-get (mm-handle-type handle) 'name)
5622              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5623              (mail-content-type-get (mm-handle-type handle) 'url)
5624              ""))
5625         (gnus-tmp-type (mm-handle-media-type handle))
5626         (gnus-tmp-description (or (mm-handle-description handle) ""))
5627         (gnus-tmp-dots
5628          (if (if displayed (car displayed)
5629                (mm-handle-displayed-p handle))
5630              "" "..."))
5631         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5632                            (buffer-size)))
5633         gnus-tmp-type-long b e)
5634     (when (string-match ".*/" gnus-tmp-name)
5635       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5636     (setq gnus-tmp-type-long (concat gnus-tmp-type
5637                                      (and (not (equal gnus-tmp-name ""))
5638                                           (concat "; " gnus-tmp-name))))
5639     (unless (equal gnus-tmp-description "")
5640       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5641     (unless (bolp)
5642       (insert "\n"))
5643     (setq b (point))
5644     (gnus-eval-format
5645      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5646      `(keymap ,gnus-mime-button-map
5647               gnus-callback gnus-mm-display-part
5648               gnus-part ,gnus-tmp-id
5649               article-type annotation
5650               gnus-data ,handle))
5651     (setq e (if (bolp)
5652                 ;; Exclude a newline.
5653                 (1- (point))
5654               (point)))
5655     (when gnus-article-button-face
5656       (gnus-overlay-put (gnus-make-overlay b e nil t)
5657                         'face gnus-article-button-face))
5658     (widget-convert-button
5659      'link b e
5660      :mime-handle handle
5661      :action 'gnus-widget-press-button
5662      :button-keymap gnus-mime-button-map
5663      :help-echo
5664      (lambda (widget/window &optional overlay pos)
5665        ;; Needed to properly clear the message due to a bug in
5666        ;; wid-edit (XEmacs only).
5667        (if (boundp 'help-echo-owns-message)
5668            (setq help-echo-owns-message t))
5669        (format
5670         "%S: %s the MIME part; %S: more options"
5671         (aref gnus-mouse-2 0)
5672         ;; XEmacs will get a single widget arg; Emacs 21 will get
5673         ;; window, overlay, position.
5674         (if (mm-handle-displayed-p
5675              (if overlay
5676                  (with-current-buffer (gnus-overlay-buffer overlay)
5677                    (widget-get (widget-at (gnus-overlay-start overlay))
5678                                :mime-handle))
5679                (widget-get widget/window :mime-handle)))
5680             "hide" "show")
5681         (aref gnus-down-mouse-3 0))))))
5682
5683 (defun gnus-widget-press-button (elems el)
5684   (goto-char (widget-get elems :from))
5685   (gnus-article-press-button))
5686
5687 (defvar gnus-displaying-mime nil)
5688
5689 (defun gnus-display-mime (&optional ihandles)
5690   "Display the MIME parts."
5691   (save-excursion
5692     (save-selected-window
5693       (let ((window (get-buffer-window gnus-article-buffer))
5694             (point (point)))
5695         (when window
5696           (select-window window)
5697           ;; We have to do this since selecting the window
5698           ;; may change the point.  So we set the window point.
5699           (set-window-point window point)))
5700       (let ((handles ihandles)
5701             (inhibit-read-only t)
5702             handle)
5703         (cond (handles)
5704               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5705                (when gnus-article-emulate-mime
5706                  (mm-uu-dissect-text-parts handles)))
5707               (gnus-article-emulate-mime
5708                (setq handles (mm-uu-dissect))))
5709         (when (and (not ihandles)
5710                    (not gnus-displaying-mime))
5711           ;; Top-level call; we clean up.
5712           (when gnus-article-mime-handles
5713             (mm-destroy-parts gnus-article-mime-handles)
5714             (setq gnus-article-mime-handle-alist nil));; A trick.
5715           (setq gnus-article-mime-handles handles)
5716           ;; We allow users to glean info from the handles.
5717           (when gnus-article-mime-part-function
5718             (gnus-mime-part-function handles)))
5719         (if (and handles
5720                  (or (not (stringp (car handles)))
5721                      (cdr handles)))
5722             (progn
5723               (when (and (not ihandles)
5724                          (not gnus-displaying-mime))
5725                 ;; Clean up for mime parts.
5726                 (article-goto-body)
5727                 (delete-region (point) (point-max)))
5728               (let ((gnus-displaying-mime t))
5729                 (gnus-mime-display-part handles)))
5730           (save-restriction
5731             (article-goto-body)
5732             (narrow-to-region (point) (point-max))
5733             (gnus-treat-article nil 1 1)
5734             (widen)))
5735         (unless ihandles
5736           ;; Highlight the headers.
5737           (save-excursion
5738             (save-restriction
5739               (article-goto-body)
5740               (narrow-to-region (point-min) (point))
5741               (gnus-article-save-original-date
5742                (gnus-treat-article 'head)))))))
5743     ;; Cope with broken MIME messages.
5744     (goto-char (point-max))
5745     (unless (bolp)
5746       (insert "\n"))))
5747
5748 (defcustom gnus-mime-display-multipart-as-mixed nil
5749   "Display \"multipart\" parts as  \"multipart/mixed\".
5750
5751 If t, it overrides nil values of
5752 `gnus-mime-display-multipart-alternative-as-mixed' and
5753 `gnus-mime-display-multipart-related-as-mixed'."
5754   :group 'gnus-article-mime
5755   :type 'boolean)
5756
5757 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5758   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5759   :version "22.1"
5760   :group 'gnus-article-mime
5761   :type 'boolean)
5762
5763 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5764   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5765
5766 If displaying \"text/html\" is discouraged \(see
5767 `mm-discouraged-alternatives'\) images or other material inside a
5768 \"multipart/related\" part might be overlooked when this variable is nil."
5769   :version "22.1"
5770   :group 'gnus-article-mime
5771   :type 'boolean)
5772
5773 (defun gnus-mime-display-part (handle)
5774   (cond
5775    ;; Maybe a broken MIME message.
5776    ((null handle))
5777    ;; Single part.
5778    ((not (stringp (car handle)))
5779     (gnus-mime-display-single handle))
5780    ;; User-defined multipart
5781    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5782     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5783              handle))
5784    ;; multipart/alternative
5785    ((and (equal (car handle) "multipart/alternative")
5786          (not (or gnus-mime-display-multipart-as-mixed
5787                   gnus-mime-display-multipart-alternative-as-mixed)))
5788     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5789       (push (cons id handle) gnus-article-mime-handle-alist)
5790       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5791    ;; multipart/related
5792    ((and (equal (car handle) "multipart/related")
5793          (not (or gnus-mime-display-multipart-as-mixed
5794                   gnus-mime-display-multipart-related-as-mixed)))
5795     ;;;!!!We should find the start part, but we just default
5796     ;;;!!!to the first part.
5797     ;;(gnus-mime-display-part (cadr handle))
5798     ;;;!!! Most multipart/related is an HTML message plus images.
5799     ;;;!!! Unfortunately we are unable to let W3 display those
5800     ;;;!!! included images, so we just display it as a mixed multipart.
5801     ;;(gnus-mime-display-mixed (cdr handle))
5802     ;;;!!! No, w3 can display everything just fine.
5803     (gnus-mime-display-part (cadr handle)))
5804    ((equal (car handle) "multipart/signed")
5805     (gnus-add-wash-type 'signed)
5806     (gnus-mime-display-security handle))
5807    ((equal (car handle) "multipart/encrypted")
5808     (gnus-add-wash-type 'encrypted)
5809     (gnus-mime-display-security handle))
5810    ;; Other multiparts are handled like multipart/mixed.
5811    (t
5812     (gnus-mime-display-mixed (cdr handle)))))
5813
5814 (defun gnus-mime-part-function (handles)
5815   (if (stringp (car handles))
5816       (mapcar 'gnus-mime-part-function (cdr handles))
5817     (funcall gnus-article-mime-part-function handles)))
5818
5819 (defun gnus-mime-display-mixed (handles)
5820   (mapcar 'gnus-mime-display-part handles))
5821
5822 (defun gnus-mime-display-single (handle)
5823   (let ((type (mm-handle-media-type handle))
5824         (ignored gnus-ignored-mime-types)
5825         (not-attachment t)
5826         (move nil)
5827         display text)
5828     (catch 'ignored
5829       (progn
5830         (while ignored
5831           (when (string-match (pop ignored) type)
5832             (throw 'ignored nil)))
5833         (if (and (setq not-attachment
5834                        (and (not (mm-inline-override-p handle))
5835                             (or (not (mm-handle-disposition handle))
5836                                 (equal (car (mm-handle-disposition handle))
5837                                        "inline")
5838                                 (mm-attachment-override-p handle))))
5839                  (mm-automatic-display-p handle)
5840                  (or (and
5841                       (mm-inlinable-p handle)
5842                       (mm-inlined-p handle))
5843                      (mm-automatic-external-display-p type)))
5844             (setq display t)
5845           (when (equal (mm-handle-media-supertype handle) "text")
5846             (setq text t)))
5847         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5848               beg)
5849           (push (cons id handle) gnus-article-mime-handle-alist)
5850           (when (and display
5851                      (equal (mm-handle-media-supertype handle) "message"))
5852             (insert-char
5853              ?\n
5854              (cond ((not (bolp)) 2)
5855                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5856                    (t 1))))
5857           (when (or (not display)
5858                     (not (gnus-unbuttonized-mime-type-p type))
5859                     (eq id gnus-mime-buttonized-part-id))
5860             (gnus-insert-mime-button
5861              handle id (list (or display (and not-attachment text))))
5862             (gnus-article-insert-newline)
5863             ;; Remember modify the number of forward lines.
5864             (setq move t))
5865           (setq beg (point))
5866           (cond
5867            (display
5868             (when move
5869               (forward-line -1)
5870               (setq beg (point)))
5871             (let ((mail-parse-charset gnus-newsgroup-charset)
5872                   (mail-parse-ignored-charsets
5873                    (save-excursion (condition-case ()
5874                                        (set-buffer gnus-summary-buffer)
5875                                      (error))
5876                                    gnus-newsgroup-ignored-charsets)))
5877               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5878             (goto-char (point-max)))
5879            ((and text not-attachment)
5880             (when move
5881               (forward-line -1)
5882               (setq beg (point)))
5883             (gnus-article-insert-newline)
5884             (mm-insert-inline
5885              handle
5886              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5887                                                        'charset)
5888                                 (and (equal type "text/calendar") 'utf-8))))
5889                (cond ((not charset)
5890                       (mm-string-as-multibyte (mm-get-part handle)))
5891                      ((eq charset 'gnus-decoded)
5892                       (with-current-buffer (mm-handle-buffer handle)
5893                         (buffer-string)))
5894                      (t
5895                       (mm-decode-string (mm-get-part handle) charset)))))
5896             (goto-char (point-max))))
5897           ;; Do highlighting.
5898           (save-excursion
5899             (save-restriction
5900               (narrow-to-region beg (point))
5901               (if (eq handle gnus-article-mime-handles)
5902                   ;; The format=flowed case.
5903                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5904                 ;; Don't count signature parts that are never displayed.
5905                 ;; The part number should be re-calculated supposing this
5906                 ;; might be a message/rfc822 part.
5907                 (let (handles)
5908                   (dolist (part gnus-article-mime-handles)
5909                     (unless (or (stringp part)
5910                                 (equal (car (mm-handle-type part))
5911                                        "application/pgp-signature"))
5912                       (push part handles)))
5913                   (gnus-treat-article
5914                    nil (length (memq handle handles)) (length handles)
5915                    (mm-handle-media-type handle)))))))))))
5916
5917 (defun gnus-unbuttonized-mime-type-p (type)
5918   "Say whether TYPE is to be unbuttonized."
5919   (unless gnus-inhibit-mime-unbuttonizing
5920     (when (catch 'found
5921             (let ((types gnus-unbuttonized-mime-types))
5922               (while types
5923                 (when (string-match (pop types) type)
5924                   (throw 'found t)))))
5925       (not (catch 'found
5926              (let ((types gnus-buttonized-mime-types))
5927                (while types
5928                  (when (string-match (pop types) type)
5929                    (throw 'found t)))))))))
5930
5931 (defun gnus-article-insert-newline ()
5932   "Insert a newline, but mark it as undeletable."
5933   (gnus-put-text-property
5934    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5935
5936 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5937   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5938          (ihandles handles)
5939          (point (point))
5940          handle (inhibit-read-only t) from props begend not-pref)
5941     (save-window-excursion
5942       (save-restriction
5943         (when ibegend
5944           (narrow-to-region (car ibegend)
5945                             (or (cdr ibegend)
5946                                 (progn
5947                                   (goto-char (car ibegend))
5948                                   (forward-line 2)
5949                                   (point))))
5950           (delete-region (point-min) (point-max))
5951           (mm-remove-parts handles))
5952         (setq begend (list (point-marker)))
5953         ;; Do the toggle.
5954         (unless (setq not-pref (cadr (member preferred ihandles)))
5955           (setq not-pref (car ihandles)))
5956         (when (or ibegend
5957                   (not preferred)
5958                   (not (gnus-unbuttonized-mime-type-p
5959                         "multipart/alternative")))
5960           (gnus-add-text-properties
5961            (setq from (point))
5962            (progn
5963              (insert (format "%d.  " id))
5964              (point))
5965            `(gnus-callback
5966              (lambda (handles)
5967                (unless ,(not ibegend)
5968                  (setq gnus-article-mime-handle-alist
5969                        ',gnus-article-mime-handle-alist))
5970                (gnus-mime-display-alternative
5971                 ',ihandles ',not-pref ',begend ,id))
5972              keymap ,gnus-mime-button-map
5973              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5974              face ,gnus-article-button-face
5975              gnus-part ,id
5976              article-type multipart))
5977           (widget-convert-button 'link from (point)
5978                                  :action 'gnus-widget-press-button
5979                                  :button-keymap gnus-widget-button-keymap)
5980           ;; Do the handles
5981           (while (setq handle (pop handles))
5982             (gnus-add-text-properties
5983              (setq from (point))
5984              (progn
5985                (insert (format "(%c) %-18s"
5986                                (if (equal handle preferred) ?* ? )
5987                                (mm-handle-media-type handle)))
5988                (point))
5989              `(gnus-callback
5990                (lambda (handles)
5991                  (unless ,(not ibegend)
5992                    (setq gnus-article-mime-handle-alist
5993                          ',gnus-article-mime-handle-alist))
5994                  (gnus-mime-display-alternative
5995                   ',ihandles ',handle ',begend ,id))
5996                keymap ,gnus-mime-button-map
5997                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5998                face ,gnus-article-button-face
5999                gnus-part ,id
6000                gnus-data ,handle))
6001             (widget-convert-button 'link from (point)
6002                                    :action 'gnus-widget-press-button
6003                                    :button-keymap gnus-widget-button-keymap)
6004             (insert "  "))
6005           (insert "\n\n"))
6006         (when preferred
6007           (if (stringp (car preferred))
6008               (gnus-display-mime preferred)
6009             (let ((mail-parse-charset gnus-newsgroup-charset)
6010                   (mail-parse-ignored-charsets
6011                    (with-current-buffer gnus-summary-buffer
6012                      gnus-newsgroup-ignored-charsets)))
6013               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6014               ;; Do highlighting.
6015               (save-excursion
6016                 (save-restriction
6017                   (narrow-to-region (car begend) (point-max))
6018                   (gnus-treat-article
6019                    nil (length gnus-article-mime-handle-alist)
6020                    (gnus-article-mime-total-parts)
6021                    (mm-handle-media-type handle))))))
6022           (goto-char (point-max))
6023           (setcdr begend (point-marker)))))
6024     (when ibegend
6025       (goto-char point))))
6026
6027 (defconst gnus-article-wash-status-strings
6028   (let ((alist '((cite "c" "Possible hidden citation text"
6029                        " " "All citation text visible")
6030                  (headers "h" "Hidden headers"
6031                           " " "All headers visible.")
6032                  (pgp "p" "Encrypted or signed message status hidden"
6033                       " " "No hidden encryption nor digital signature status")
6034                  (signature "s" "Signature has been hidden"
6035                             " " "Signature is visible")
6036                  (overstrike "o" "Overstrike (^H) characters applied"
6037                              " " "No overstrike characters applied")
6038                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6039                            " " "No /*_emphasis_*/ characters applied")))
6040         result)
6041     (dolist (entry alist result)
6042       (let ((key (nth 0 entry))
6043             (on (copy-sequence (nth 1 entry)))
6044             (on-help (nth 2 entry))
6045             (off (copy-sequence (nth 3 entry)))
6046             (off-help (nth 4 entry)))
6047         (put-text-property 0 1 'help-echo on-help on)
6048         (put-text-property 0 1 'help-echo off-help off)
6049         (push (list key on off) result))))
6050   "Alist of strings describing wash status in the mode line.
6051 Each entry has the form (KEY ON OF), where the KEY is a symbol
6052 representing the particular washing function, ON is the string to use
6053 in the article mode line when the washing function is active, and OFF
6054 is the string to use when it is inactive.")
6055
6056 (defun gnus-article-wash-status-entry (key value)
6057   (let ((entry (assoc key gnus-article-wash-status-strings)))
6058     (if value (nth 1 entry) (nth 2 entry))))
6059
6060 (defun gnus-article-wash-status ()
6061   "Return a string which display status of article washing."
6062   (with-current-buffer gnus-article-buffer
6063     (let ((cite (memq 'cite gnus-article-wash-types))
6064           (headers (memq 'headers gnus-article-wash-types))
6065           (boring (memq 'boring-headers gnus-article-wash-types))
6066           (pgp (memq 'pgp gnus-article-wash-types))
6067           (pem (memq 'pem gnus-article-wash-types))
6068           (signed (memq 'signed gnus-article-wash-types))
6069           (encrypted (memq 'encrypted gnus-article-wash-types))
6070           (signature (memq 'signature gnus-article-wash-types))
6071           (overstrike (memq 'overstrike gnus-article-wash-types))
6072           (emphasis (memq 'emphasis gnus-article-wash-types)))
6073       (concat
6074        (gnus-article-wash-status-entry 'cite cite)
6075        (gnus-article-wash-status-entry 'headers (or headers boring))
6076        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6077        (gnus-article-wash-status-entry 'signature signature)
6078        (gnus-article-wash-status-entry 'overstrike overstrike)
6079        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6080
6081 (defun gnus-add-wash-type (type)
6082   "Add a washing of TYPE to the current status."
6083   (add-to-list 'gnus-article-wash-types type))
6084
6085 (defun gnus-delete-wash-type (type)
6086   "Add a washing of TYPE to the current status."
6087   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6088
6089 (defun gnus-add-image (category image)
6090   "Add IMAGE of CATEGORY to the list of displayed images."
6091   (let ((entry (assq category gnus-article-image-alist)))
6092     (unless entry
6093       (setq entry (list category))
6094       (push entry gnus-article-image-alist))
6095     (nconc entry (list image))))
6096
6097 (defun gnus-delete-images (category)
6098   "Delete all images in CATEGORY."
6099   (let ((entry (assq category gnus-article-image-alist)))
6100     (dolist (image (cdr entry))
6101       (gnus-remove-image image category))
6102     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6103     (gnus-delete-wash-type category)))
6104
6105 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6106
6107 (defun gnus-article-maybe-hide-headers ()
6108   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6109 Provided for backwards compatibility."
6110   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6111                  (not (with-current-buffer gnus-summary-buffer
6112                         gnus-have-all-headers)))
6113              (not gnus-inhibit-hiding))
6114     (gnus-article-hide-headers)))
6115
6116 ;;; Article savers.
6117
6118 (defun gnus-output-to-file (file-name)
6119   "Append the current article to a file named FILE-NAME.
6120 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6121 text and used as the value of the coding cookie which is added to the
6122 top of a file.  Otherwise, this function saves a raw article without
6123 the coding cookie."
6124   (let* ((artbuf (current-buffer))
6125          (file-name-coding-system nnmail-pathname-coding-system)
6126          (coding gnus-article-save-coding-system)
6127          (coding-system-for-read (if coding
6128                                      nil ;; Rely on the coding cookie.
6129                                    mm-text-coding-system))
6130          (coding-system-for-write (or coding
6131                                       mm-text-coding-system-for-write
6132                                       mm-text-coding-system))
6133          (exists (file-exists-p file-name)))
6134     (with-temp-buffer
6135       (when exists
6136         (insert-file-contents file-name)
6137         (goto-char (point-min))
6138         ;; Remove the existing coding cookie.
6139         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6140           (delete-region (match-beginning 0) (match-end 0))))
6141       (goto-char (point-max))
6142       (insert-buffer-substring artbuf)
6143       ;; Append newline at end of the buffer as separator, and then
6144       ;; save it to file.
6145       (goto-char (point-max))
6146       (insert "\n")
6147       (when coding
6148         ;; If the coding system is not suitable to encode the text,
6149         ;; ask a user for a proper one.
6150         (when (fboundp 'select-safe-coding-system)
6151           (setq coding (coding-system-base
6152                         (save-window-excursion
6153                           (select-safe-coding-system (point-min) (point-max)
6154                                                      coding))))
6155           (setq coding-system-for-write
6156                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6157                     coding)))
6158         (goto-char (point-min))
6159         ;; Add the coding cookie.
6160         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6161                         coding-system-for-write)))
6162       (if exists
6163           (progn
6164             (write-region (point-min) (point-max) file-name nil 'no-message)
6165             (message "Appended to %s" file-name))
6166         (write-region (point-min) (point-max) file-name))))
6167   t)
6168
6169 (defun gnus-narrow-to-page (&optional arg)
6170   "Narrow the article buffer to a page.
6171 If given a numerical ARG, move forward ARG pages."
6172   (interactive "P")
6173   (setq arg (if arg (prefix-numeric-value arg) 0))
6174   (with-current-buffer gnus-article-buffer
6175     (widen)
6176     ;; Remove any old next/prev buttons.
6177     (when (gnus-visual-p 'page-marker)
6178       (let ((inhibit-read-only t))
6179         (gnus-remove-text-with-property 'gnus-prev)
6180         (gnus-remove-text-with-property 'gnus-next)))
6181     (let (st nd pt)
6182       (when (save-excursion
6183               (cond ((< arg 0)
6184                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6185                          (prog1
6186                              (setq nd (match-beginning 0)
6187                                    pt nd)
6188                            (when (re-search-backward page-delimiter nil t)
6189                              (setq st (match-end 0))))
6190                        (when (re-search-forward page-delimiter nil t)
6191                          (setq nd (match-beginning 0)
6192                                pt (point-min)))))
6193                     ((> arg 0)
6194                      (if (re-search-forward page-delimiter nil 'move arg)
6195                          (prog1
6196                              (setq st (match-end 0)
6197                                    pt st)
6198                            (when (re-search-forward page-delimiter nil t)
6199                              (setq nd (match-beginning 0))))
6200                        (when (re-search-backward page-delimiter nil t)
6201                          (setq st (match-end 0)
6202                                pt (point-max)))))
6203                     (t
6204                      (when (re-search-backward page-delimiter nil t)
6205                        (goto-char (setq st (match-end 0))))
6206                      (when (re-search-forward page-delimiter nil t)
6207                        (setq nd (match-beginning 0)))
6208                      (or st nd))))
6209         (setq gnus-page-broken t)
6210         (when pt (goto-char pt))
6211         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6212         (when (gnus-visual-p 'page-marker)
6213           (save-excursion
6214             (when nd
6215               (goto-char nd)
6216               (gnus-insert-next-page-button))
6217             (when st
6218               (goto-char st)
6219               (gnus-insert-prev-page-button))))))))
6220
6221 ;; Article mode commands
6222
6223 (defun gnus-article-goto-next-page ()
6224   "Show the next page of the article."
6225   (interactive)
6226   (when (gnus-article-next-page)
6227     (goto-char (point-min))
6228     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6229
6230
6231 (defun gnus-article-goto-prev-page ()
6232   "Show the previous page of the article."
6233   (interactive)
6234   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6235       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6236     (gnus-article-prev-page nil)))
6237
6238 ;; This is cleaner but currently breaks `gnus-pick-mode':
6239 ;;
6240 ;; (defun gnus-article-goto-next-page ()
6241 ;;   "Show the next page of the article."
6242 ;;   (interactive)
6243 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6244 ;;     (gnus-summary-next-page)))
6245 ;;
6246 ;; (defun gnus-article-goto-prev-page ()
6247 ;;   "Show the next page of the article."
6248 ;;   (interactive)
6249 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6250 ;;     (gnus-summary-prev-page)))
6251
6252 (defun gnus-article-next-page (&optional lines)
6253   "Show the next page of the current article.
6254 If end of article, return non-nil.  Otherwise return nil.
6255 Argument LINES specifies lines to be scrolled up."
6256   (interactive "p")
6257   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6258   (if (and (not (and gnus-article-over-scroll
6259                      (> (count-lines (window-start) (point-max))
6260                         (if (featurep 'xemacs)
6261                             (or lines (1- (window-height)))
6262                           (+ (or lines (1- (window-height))) scroll-margin)))))
6263            (save-excursion
6264              (end-of-line)
6265              (and (pos-visible-in-window-p)     ;Not continuation line.
6266                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6267       ;; Nothing in this page.
6268       (if (or (not gnus-page-broken)
6269               (save-excursion
6270                 (save-restriction
6271                   (widen)
6272                   (forward-line)
6273                   (eobp)))) ;Real end-of-buffer?
6274           (progn
6275             (when gnus-article-over-scroll
6276               (gnus-article-next-page-1 lines))
6277             t)                  ;Nothing more.
6278         (gnus-narrow-to-page 1)         ;Go to next page.
6279         nil)
6280     ;; More in this page.
6281     (gnus-article-next-page-1 lines)
6282     nil))
6283
6284 (defmacro gnus-article-beginning-of-window ()
6285   "Move point to the beginning of the window.
6286 In Emacs, the point is placed at the line number which `scroll-margin'
6287 specifies."
6288   (if (featurep 'xemacs)
6289       '(move-to-window-line 0)
6290     '(move-to-window-line
6291       (min (max 0 scroll-margin)
6292            (max 1 (- (window-height)
6293                      (if mode-line-format 1 0)
6294                      (if header-line-format 1 0)
6295                      2))))))
6296
6297 (defun gnus-article-next-page-1 (lines)
6298   (unless (featurep 'xemacs)
6299     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
6300     ;; too many number of lines if `scroll-margin' is set as two or greater.
6301     (when (and (numberp lines)
6302                (> lines 0)
6303                (> scroll-margin 0))
6304       (setq lines (min lines
6305                        (max 0 (- (count-lines (window-start) (point-max))
6306                                  scroll-margin))))))
6307   (condition-case ()
6308       (let ((scroll-in-place nil))
6309         (scroll-up lines))
6310     (end-of-buffer
6311      ;; Long lines may cause an end-of-buffer error.
6312      (goto-char (point-max))))
6313   (gnus-article-beginning-of-window))
6314
6315 (defun gnus-article-prev-page (&optional lines)
6316   "Show previous page of current article.
6317 Argument LINES specifies lines to be scrolled down."
6318   (interactive "p")
6319   (move-to-window-line 0)
6320   (if (and gnus-page-broken
6321            (bobp)
6322            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6323       (progn
6324         (gnus-narrow-to-page -1)        ;Go to previous page.
6325         (goto-char (point-max))
6326         (recenter (if gnus-article-over-scroll
6327                       (if lines
6328                           (max (if (featurep 'xemacs)
6329                                    lines
6330                                  (+ lines scroll-margin))
6331                                3)
6332                         (- (window-height) 2))
6333                     -1)))
6334     (prog1
6335         (condition-case ()
6336             (let ((scroll-in-place nil))
6337               (scroll-down lines))
6338           (beginning-of-buffer
6339            (goto-char (point-min))))
6340       (gnus-article-beginning-of-window))))
6341
6342 (defun gnus-article-only-boring-p ()
6343   "Decide whether there is only boring text remaining in the article.
6344 Something \"interesting\" is a word of at least two letters that does
6345 not have a face in `gnus-article-boring-faces'."
6346   (when (and gnus-article-skip-boring
6347              (boundp 'gnus-article-boring-faces)
6348              (symbol-value 'gnus-article-boring-faces))
6349     (save-excursion
6350       (let ((inhibit-point-motion-hooks t))
6351         (catch 'only-boring
6352           (while (re-search-forward "\\b\\w\\w" nil t)
6353             (forward-char -1)
6354             (when (not (gnus-intersection
6355                         (gnus-faces-at (point))
6356                         (symbol-value 'gnus-article-boring-faces)))
6357               (throw 'only-boring nil)))
6358           (throw 'only-boring t))))))
6359
6360 (defun gnus-article-refer-article ()
6361   "Read article specified by message-id around point."
6362   (interactive)
6363   (save-excursion
6364     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6365     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6366     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6367         (let ((msg-id (concat "<" (match-string 0) ">")))
6368           (set-buffer gnus-summary-buffer)
6369           (gnus-summary-refer-article msg-id))
6370       (error "No references around point"))))
6371
6372 (defun gnus-article-show-summary ()
6373   "Reconfigure windows to show summary buffer."
6374   (interactive)
6375   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6376       (error "There is no summary buffer for this article buffer")
6377     (gnus-article-set-globals)
6378     (gnus-configure-windows 'article)
6379     (gnus-summary-goto-subject gnus-current-article)
6380     (gnus-summary-position-point)))
6381
6382 (defun gnus-article-describe-briefly ()
6383   "Describe article mode commands briefly."
6384   (interactive)
6385   (gnus-message 6 (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page   \\[gnus-article-goto-prev-page]:Prev page  \\[gnus-article-show-summary]:Show summary  \\[gnus-info-find-node]:Run Info  \\[gnus-article-describe-briefly]:This help")))
6386
6387 (defun gnus-article-check-buffer ()
6388   "Beep if not in an article buffer."
6389   (unless (equal major-mode 'gnus-article-mode)
6390     (error "Command invoked outside of a Gnus article buffer")))
6391
6392 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6393   "Read a summary buffer key sequence and execute it from the article buffer."
6394   (interactive "P")
6395   (gnus-article-check-buffer)
6396   (let ((nosaves
6397          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6398            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6399            "=" "^" "\M-^" "|"))
6400         (nosave-but-article
6401          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6402            "An" "Ap" [?A (meta return)] [?A delete]))
6403         (nosave-in-article
6404          '("AS" "\C-d"))
6405         (up-to-top
6406          '("n" "Gn" "p" "Gp"))
6407         keys new-sum-point)
6408     (with-current-buffer gnus-article-current-summary
6409       (let (gnus-pick-mode)
6410         (setq unread-command-events (nconc unread-command-events
6411                                            (list (or key last-command-event)))
6412               keys (if (featurep 'xemacs)
6413                        (events-to-keys (read-key-sequence nil t))
6414                      (read-key-sequence nil t)))))
6415
6416     (message "")
6417
6418     (cond
6419      ((eq (aref keys (1- (length keys))) ?\C-h)
6420       (gnus-article-describe-bindings (substring keys 0 -1)))
6421      ((or (member keys nosaves)
6422           (member keys nosave-but-article)
6423           (member keys nosave-in-article))
6424       (let (func)
6425         (save-window-excursion
6426           (pop-to-buffer gnus-article-current-summary)
6427           ;; We disable the pick minor mode commands.
6428           (let (gnus-pick-mode)
6429             (setq func (key-binding keys t))))
6430         (if (or (not func)
6431                 (numberp func))
6432             (ding)
6433           (unless (member keys nosave-in-article)
6434             (set-buffer gnus-article-current-summary))
6435           (call-interactively func)
6436           (setq new-sum-point (point)))
6437         (when (member keys nosave-but-article)
6438           (pop-to-buffer gnus-article-buffer))))
6439      (t
6440       ;; These commands should restore window configuration.
6441       (let ((obuf (current-buffer))
6442             (owin (current-window-configuration))
6443             win func in-buffer selected new-sum-start new-sum-hscroll err)
6444         (cond (not-restore-window
6445                (pop-to-buffer gnus-article-current-summary)
6446                (setq win (selected-window)))
6447               ((setq win (get-buffer-window gnus-article-current-summary))
6448                (select-window win))
6449               (t
6450                (let ((summary-buffer gnus-article-current-summary))
6451                  (gnus-configure-windows 'article)
6452                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6453                    (let ((gnus-buffer-configuration
6454                           '((article ((vertical 1.0
6455                                                 (summary 0.25 point)
6456                                                 (article 1.0)))))))
6457                      (gnus-configure-windows 'article))
6458                    (setq win (get-buffer-window summary-buffer 'visible)))
6459                  (gnus-select-frame-set-input-focus (window-frame win))
6460                  (select-window win))))
6461         (setq in-buffer (current-buffer))
6462         ;; We disable the pick minor mode commands.
6463         (if (and (setq func (let (gnus-pick-mode)
6464                               (key-binding keys t)))
6465                  (functionp func)
6466                  (condition-case code
6467                      (progn
6468                        (call-interactively func)
6469                        t)
6470                    (error
6471                     (setq err code)
6472                     nil)))
6473             (progn
6474               (when (eq win (selected-window))
6475                 (setq new-sum-point (point)
6476                       new-sum-start (window-start win)
6477                       new-sum-hscroll (window-hscroll win)))
6478               (when (or (eq in-buffer (current-buffer))
6479                         (when (eq obuf (current-buffer))
6480                           (set-buffer in-buffer)
6481                           t))
6482                 (setq selected (gnus-summary-select-article))
6483                 (set-buffer obuf)
6484                 (unless not-restore-window
6485                   (set-window-configuration owin))
6486                 (when (and (eq selected 'old)
6487                            new-sum-point)
6488                   (set-window-start (get-buffer-window (current-buffer))
6489                                     1)
6490                   (set-window-point (get-buffer-window (current-buffer))
6491                                     (if (article-goto-body)
6492                                         (1- (point))
6493                                       (point))))
6494                 (when (and (not not-restore-window)
6495                            new-sum-point
6496                            (window-live-p win)
6497                            (with-current-buffer (window-buffer win)
6498                              (eq major-mode 'gnus-summary-mode)))
6499                   (set-window-point win new-sum-point)
6500                   (set-window-start win new-sum-start)
6501                   (set-window-hscroll win new-sum-hscroll))))
6502           (set-window-configuration owin)
6503           (if err
6504               (signal (car err) (cdr err))
6505             (ding))))))))
6506
6507 (defun gnus-article-read-summary-send-keys ()
6508   (interactive)
6509   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6510     (gnus-article-read-summary-keys)))
6511
6512 (defun gnus-article-describe-key (key)
6513   "Display documentation of the function invoked by KEY.
6514 KEY is a string or a vector."
6515   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6516                        (read-key-sequence "Describe key: "))))
6517   (gnus-article-check-buffer)
6518   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6519                                   gnus-article-read-summary-send-keys))
6520       (with-current-buffer gnus-article-current-summary
6521         (setq unread-command-events
6522               (if (featurep 'xemacs)
6523                   (append key nil)
6524                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6525                                         (list 'meta (- x 128))
6526                                       x))
6527                         key)))
6528         (let ((cursor-in-echo-area t)
6529               gnus-pick-mode)
6530           (describe-key (read-key-sequence nil t))))
6531     (describe-key key)))
6532
6533 (defun gnus-article-describe-key-briefly (key &optional insert)
6534   "Display documentation of the function invoked by KEY.
6535 KEY is a string or a vector."
6536   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6537                        (read-key-sequence "Describe key: "))
6538                      current-prefix-arg))
6539   (gnus-article-check-buffer)
6540   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6541                                   gnus-article-read-summary-send-keys))
6542       (with-current-buffer gnus-article-current-summary
6543         (setq unread-command-events
6544               (if (featurep 'xemacs)
6545                   (append key nil)
6546                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6547                                         (list 'meta (- x 128))
6548                                       x))
6549                         key)))
6550         (let ((cursor-in-echo-area t)
6551               gnus-pick-mode)
6552           (describe-key-briefly (read-key-sequence nil t) insert)))
6553     (describe-key-briefly key insert)))
6554
6555 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6556 (defvar gnus-agent-summary-mode)
6557 (defvar gnus-draft-mode)
6558 ;; Calling help-buffer will autoload help-mode.
6559 (defvar help-xref-stack-item)
6560
6561 (defun gnus-article-describe-bindings (&optional prefix)
6562   "Show a list of all defined keys, and their definitions.
6563 The optional argument PREFIX, if non-nil, should be a key sequence;
6564 then we display only bindings that start with that prefix."
6565   (interactive)
6566   (gnus-article-check-buffer)
6567   (let ((keymap (copy-keymap gnus-article-mode-map))
6568         (map (copy-keymap gnus-article-send-map))
6569         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6570         parent agent draft)
6571     (define-key keymap "S" map)
6572     (define-key map [t] nil)
6573     (with-current-buffer gnus-article-current-summary
6574       (set-keymap-parent
6575        keymap
6576        (if (setq parent (keymap-parent gnus-article-mode-map))
6577            (prog1
6578                (setq parent (copy-keymap parent))
6579              (set-keymap-parent parent (current-local-map)))
6580          (current-local-map)))
6581       (set-keymap-parent map (key-binding "S"))
6582       (let (key def gnus-pick-mode)
6583         (while sumkeys
6584           (setq key (pop sumkeys))
6585           (cond ((and (vectorp key) (= (length key) 1)
6586                       (consp (setq def (aref key 0)))
6587                       (numberp (car def)) (numberp (cdr def)))
6588                  (when (< (max (car def) (cdr def)) 128)
6589                    (setq sumkeys
6590                          (append (mapcar
6591                                   #'vector
6592                                   (nreverse (gnus-uncompress-range def)))
6593                                  sumkeys))))
6594                 ((setq def (key-binding key))
6595                  (unless (eq def 'undefined)
6596                    (define-key keymap key def))))))
6597       (when (boundp 'gnus-agent-summary-mode)
6598         (setq agent gnus-agent-summary-mode))
6599       (when (boundp 'gnus-draft-mode)
6600         (setq draft gnus-draft-mode)))
6601     (with-temp-buffer
6602       (use-local-map keymap)
6603       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6604       (set (make-local-variable 'gnus-draft-mode) draft)
6605       (describe-bindings prefix))
6606     (let ((item `((lambda (prefix)
6607                     (with-current-buffer ,(current-buffer)
6608                       (gnus-article-describe-bindings prefix)))
6609                   ,prefix)))
6610       (with-current-buffer (if (fboundp 'help-buffer)
6611                                (let (help-xref-following) (help-buffer))
6612                              "*Help*") ;; Emacs 21
6613         (setq help-xref-stack-item item)))))
6614
6615 (defun gnus-article-reply-with-original (&optional wide)
6616   "Start composing a reply mail to the current message.
6617 The text in the region will be yanked.  If the region isn't active,
6618 the entire article will be yanked."
6619   (interactive)
6620   (let ((article (cdr gnus-article-current))
6621         contents)
6622     (if (not (gnus-region-active-p))
6623         (with-current-buffer gnus-summary-buffer
6624           (gnus-summary-reply (list (list article)) wide))
6625       (setq contents (buffer-substring (point) (mark t)))
6626       ;; Deactivate active regions.
6627       (when (and (boundp 'transient-mark-mode)
6628                  transient-mark-mode)
6629         (setq mark-active nil))
6630       (with-current-buffer gnus-summary-buffer
6631         (gnus-summary-reply
6632          (list (list article contents)) wide)))))
6633
6634 (defun gnus-article-wide-reply-with-original ()
6635   "Start composing a wide reply mail to the current message.
6636 The text in the region will be yanked.  If the region isn't active,
6637 the entire article will be yanked."
6638   (interactive)
6639   (gnus-article-reply-with-original t))
6640
6641 (defun gnus-article-followup-with-original ()
6642   "Compose a followup to the current article.
6643 The text in the region will be yanked.  If the region isn't active,
6644 the entire article will be yanked."
6645   (interactive)
6646   (let ((article (cdr gnus-article-current))
6647         contents)
6648       (if (not (gnus-region-active-p))
6649           (with-current-buffer gnus-summary-buffer
6650             (gnus-summary-followup (list (list article))))
6651         (setq contents (buffer-substring (point) (mark t)))
6652         ;; Deactivate active regions.
6653         (when (and (boundp 'transient-mark-mode)
6654                    transient-mark-mode)
6655           (setq mark-active nil))
6656         (with-current-buffer gnus-summary-buffer
6657           (gnus-summary-followup
6658            (list (list article contents)))))))
6659
6660 (defun gnus-article-hide (&optional arg force)
6661   "Hide all the gruft in the current article.
6662 This means that signatures, cited text and (some) headers will be
6663 hidden.
6664 If given a prefix, show the hidden text instead."
6665   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6666   (gnus-article-hide-headers arg)
6667   (gnus-article-hide-list-identifiers arg)
6668   (gnus-article-hide-citation-maybe arg force)
6669   (gnus-article-hide-signature arg))
6670
6671 (defun gnus-article-maybe-highlight ()
6672   "Do some article highlighting if article highlighting is requested."
6673   (when (gnus-visual-p 'article-highlight 'highlight)
6674     (gnus-article-highlight-some)))
6675
6676 (defun gnus-check-group-server ()
6677   ;; Make sure the connection to the server is alive.
6678   (unless (gnus-server-opened
6679            (gnus-find-method-for-group gnus-newsgroup-name))
6680     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6681     (gnus-request-group gnus-newsgroup-name t)))
6682
6683 (eval-when-compile
6684   (autoload 'nneething-get-file-name "nneething"))
6685
6686 (defun gnus-request-article-this-buffer (article group)
6687   "Get an article and insert it into this buffer."
6688   (let (do-update-line sparse-header)
6689     (prog1
6690         (save-excursion
6691           (erase-buffer)
6692           (gnus-kill-all-overlays)
6693           (setq group (or group gnus-newsgroup-name))
6694
6695           ;; Using `gnus-request-article' directly will insert the article into
6696           ;; `nntp-server-buffer' - so we'll save some time by not having to
6697           ;; copy it from the server buffer into the article buffer.
6698
6699           ;; We only request an article by message-id when we do not have the
6700           ;; headers for it, so we'll have to get those.
6701           (when (stringp article)
6702             (gnus-read-header article))
6703
6704           ;; If the article number is negative, that means that this article
6705           ;; doesn't belong in this newsgroup (possibly), so we find its
6706           ;; message-id and request it by id instead of number.
6707           (when (and (numberp article)
6708                      gnus-summary-buffer
6709                      (get-buffer gnus-summary-buffer)
6710                      (gnus-buffer-exists-p gnus-summary-buffer))
6711             (with-current-buffer gnus-summary-buffer
6712               (let ((header (gnus-summary-article-header article)))
6713                 (when (< article 0)
6714                   (cond
6715                    ((memq article gnus-newsgroup-sparse)
6716                     ;; This is a sparse gap article.
6717                     (setq do-update-line article)
6718                     (setq article (mail-header-id header))
6719                     (setq sparse-header (gnus-read-header article))
6720                     (setq gnus-newsgroup-sparse
6721                           (delq article gnus-newsgroup-sparse)))
6722                    ((vectorp header)
6723                     ;; It's a real article.
6724                     (setq article (mail-header-id header)))
6725                    (t
6726                     ;; It is an extracted pseudo-article.
6727                     (setq article 'pseudo)
6728                     (gnus-request-pseudo-article header))))
6729
6730                 (let ((method (gnus-find-method-for-group
6731                                gnus-newsgroup-name)))
6732                   (when (and (eq (car method) 'nneething)
6733                              (vectorp header))
6734                     (let ((dir (nneething-get-file-name
6735                                 (mail-header-id header))))
6736                       (when (and (stringp dir)
6737                                  (file-directory-p dir))
6738                         (setq article 'nneething)
6739                         (gnus-group-enter-directory dir))))))))
6740
6741           (cond
6742            ;; Refuse to select canceled articles.
6743            ((and (numberp article)
6744                  gnus-summary-buffer
6745                  (get-buffer gnus-summary-buffer)
6746                  (gnus-buffer-exists-p gnus-summary-buffer)
6747                  (eq (cdr (with-current-buffer gnus-summary-buffer
6748                             (assq article gnus-newsgroup-reads)))
6749                      gnus-canceled-mark))
6750             nil)
6751            ;; We first check `gnus-original-article-buffer'.
6752            ((and (get-buffer gnus-original-article-buffer)
6753                  (numberp article)
6754                  (with-current-buffer gnus-original-article-buffer
6755                    (and (equal (car gnus-original-article) group)
6756                         (eq (cdr gnus-original-article) article))))
6757             ;; `insert-buffer-substring' would incorrectly use the
6758             ;; equivalent of string-make-multibyte which amount to decoding
6759             ;; with locale-coding-system, causing failure of
6760             ;; subsequent decoding.
6761             (insert (mm-string-to-multibyte
6762                      (with-current-buffer gnus-original-article-buffer
6763                        (buffer-substring (point-min) (point-max)))))
6764             'article)
6765            ;; Check the backlog.
6766            ((and gnus-keep-backlog
6767                  (gnus-backlog-request-article group article (current-buffer)))
6768             'article)
6769            ;; Check asynchronous pre-fetch.
6770            ((gnus-async-request-fetched-article group article (current-buffer))
6771             (gnus-async-prefetch-next group article gnus-summary-buffer)
6772             (when (and (numberp article) gnus-keep-backlog)
6773               (gnus-backlog-enter-article group article (current-buffer)))
6774             'article)
6775            ;; Check the cache.
6776            ((and gnus-use-cache
6777                  (numberp article)
6778                  (gnus-cache-request-article article group))
6779             'article)
6780            ;; Check the agent cache.
6781            ((gnus-agent-request-article article group)
6782             'article)
6783            ;; Get the article and put into the article buffer.
6784            ((or (stringp article)
6785                 (numberp article))
6786             (let ((gnus-override-method gnus-override-method)
6787                   (methods (and (stringp article)
6788                                 gnus-refer-article-method))
6789                   (backend (car (gnus-find-method-for-group
6790                                  gnus-newsgroup-name)))
6791                   result
6792                   (inhibit-read-only t))
6793               (if (or (not (listp methods))
6794                       (and (symbolp (car methods))
6795                            (assq (car methods) nnoo-definition-alist)))
6796                   (setq methods (list methods)))
6797               (when (and (null gnus-override-method)
6798                          methods)
6799                 (setq gnus-override-method (pop methods)))
6800               (while (not result)
6801                 (when (eq gnus-override-method 'current)
6802                   (setq gnus-override-method
6803                         (with-current-buffer gnus-summary-buffer
6804                           gnus-current-select-method)))
6805                 (erase-buffer)
6806                 (gnus-kill-all-overlays)
6807                 (let ((gnus-newsgroup-name group))
6808                   (gnus-check-group-server))
6809                 (cond
6810                  ((gnus-request-article article group (current-buffer))
6811                   (when (numberp article)
6812                     (gnus-async-prefetch-next group article
6813                                               gnus-summary-buffer)
6814                     (when gnus-keep-backlog
6815                       (gnus-backlog-enter-article
6816                        group article (current-buffer))))
6817                   (setq result 'article))
6818                  (methods
6819                   (setq gnus-override-method (pop methods)))
6820                  ((not (string-match "^400 "
6821                                      (nnheader-get-report backend)))
6822                   ;; If we get 400 server disconnect, reconnect and
6823                   ;; retry; otherwise, assume the article has expired.
6824                   (setq result 'done))))
6825               (and (eq result 'article) 'article)))
6826            ;; It was a pseudo.
6827            (t article)))
6828
6829       ;; Associate this article with the current summary buffer.
6830       (setq gnus-article-current-summary gnus-summary-buffer)
6831
6832       ;; Take the article from the original article buffer
6833       ;; and place it in the buffer it's supposed to be in.
6834       (when (and (get-buffer gnus-article-buffer)
6835                  (equal (buffer-name (current-buffer))
6836                         (buffer-name (get-buffer gnus-article-buffer))))
6837         (save-excursion
6838           (if (get-buffer gnus-original-article-buffer)
6839               (set-buffer gnus-original-article-buffer)
6840             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6841             (buffer-disable-undo)
6842             (setq major-mode 'gnus-original-article-mode)
6843             (setq buffer-read-only t))
6844           (let ((inhibit-read-only t))
6845             (erase-buffer)
6846             (insert-buffer-substring gnus-article-buffer))
6847           (setq gnus-original-article (cons group article)))
6848
6849         ;; Decode charsets.
6850         (run-hooks 'gnus-article-decode-hook)
6851         ;; Mark article as decoded or not.
6852         (setq gnus-article-decoded-p gnus-article-decode-hook))
6853
6854       ;; Update sparse articles.
6855       (when (and do-update-line
6856                  (or (numberp article)
6857                      (stringp article)))
6858         (let ((buf (current-buffer)))
6859           (set-buffer gnus-summary-buffer)
6860           (gnus-summary-update-article do-update-line sparse-header)
6861           (gnus-summary-goto-subject do-update-line nil t)
6862           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6863                             (point))
6864           (set-buffer buf))))))
6865
6866 ;;;
6867 ;;; Article editing
6868 ;;;
6869
6870 (defcustom gnus-article-edit-mode-hook nil
6871   "Hook run in article edit mode buffers."
6872   :group 'gnus-article-various
6873   :type 'hook)
6874
6875 (defvar gnus-article-edit-done-function nil)
6876
6877 (defvar gnus-article-edit-mode-map nil)
6878
6879 ;; Should we be using derived.el for this?
6880 (unless gnus-article-edit-mode-map
6881   (setq gnus-article-edit-mode-map (make-keymap))
6882   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6883
6884   (gnus-define-keys gnus-article-edit-mode-map
6885     "\C-c?"    describe-mode
6886     "\C-c\C-c" gnus-article-edit-done
6887     "\C-c\C-k" gnus-article-edit-exit
6888     "\C-c\C-f\C-t" message-goto-to
6889     "\C-c\C-f\C-o" message-goto-from
6890     "\C-c\C-f\C-b" message-goto-bcc
6891     ;;"\C-c\C-f\C-w" message-goto-fcc
6892     "\C-c\C-f\C-c" message-goto-cc
6893     "\C-c\C-f\C-s" message-goto-subject
6894     "\C-c\C-f\C-r" message-goto-reply-to
6895     "\C-c\C-f\C-n" message-goto-newsgroups
6896     "\C-c\C-f\C-d" message-goto-distribution
6897     "\C-c\C-f\C-f" message-goto-followup-to
6898     "\C-c\C-f\C-m" message-goto-mail-followup-to
6899     "\C-c\C-f\C-k" message-goto-keywords
6900     "\C-c\C-f\C-u" message-goto-summary
6901     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6902     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6903     "\C-c\C-b" message-goto-body
6904     "\C-c\C-i" message-goto-signature
6905
6906     "\C-c\C-t" message-insert-to
6907     "\C-c\C-n" message-insert-newsgroups
6908     "\C-c\C-o" message-sort-headers
6909     "\C-c\C-e" message-elide-region
6910     "\C-c\C-v" message-delete-not-region
6911     "\C-c\C-z" message-kill-to-signature
6912     "\M-\r" message-newline-and-reformat
6913     "\C-c\C-a" mml-attach-file
6914     "\C-a" message-beginning-of-line
6915     "\t" message-tab
6916     "\M-;" comment-region)
6917
6918   (gnus-define-keys (gnus-article-edit-wash-map
6919                      "\C-c\C-w" gnus-article-edit-mode-map)
6920     "f" gnus-article-edit-full-stops))
6921
6922 (easy-menu-define
6923   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6924   '("Field"
6925     ["Fetch To" message-insert-to t]
6926     ["Fetch Newsgroups" message-insert-newsgroups t]
6927     "----"
6928     ["To" message-goto-to t]
6929     ["From" message-goto-from t]
6930     ["Subject" message-goto-subject t]
6931     ["Cc" message-goto-cc t]
6932     ["Reply-To" message-goto-reply-to t]
6933     ["Summary" message-goto-summary t]
6934     ["Keywords" message-goto-keywords t]
6935     ["Newsgroups" message-goto-newsgroups t]
6936     ["Followup-To" message-goto-followup-to t]
6937     ["Mail-Followup-To" message-goto-mail-followup-to t]
6938     ["Distribution" message-goto-distribution t]
6939     ["Body" message-goto-body t]
6940     ["Signature" message-goto-signature t]))
6941
6942 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6943   "Major mode for editing articles.
6944 This is an extended text-mode.
6945
6946 \\{gnus-article-edit-mode-map}"
6947   (make-local-variable 'gnus-article-edit-done-function)
6948   (make-local-variable 'gnus-prev-winconf)
6949   (set (make-local-variable 'font-lock-defaults)
6950        '(message-font-lock-keywords t))
6951   (set (make-local-variable 'mail-header-separator) "")
6952   (set (make-local-variable 'gnus-article-edit-mode) t)
6953   (easy-menu-add message-mode-field-menu message-mode-map)
6954   (mml-mode)
6955   (setq buffer-read-only nil)
6956   (buffer-enable-undo)
6957   (widen))
6958
6959 (defun gnus-article-edit (&optional force)
6960   "Edit the current article.
6961 This will have permanent effect only in mail groups.
6962 If FORCE is non-nil, allow editing of articles even in read-only
6963 groups."
6964   (interactive "P")
6965   (when (and (not force)
6966              (gnus-group-read-only-p))
6967     (error "The current newsgroup does not support article editing"))
6968   (gnus-article-date-original)
6969   (gnus-article-edit-article
6970    'ignore
6971    `(lambda (no-highlight)
6972       'ignore
6973       (gnus-summary-edit-article-done
6974        ,(or (mail-header-references gnus-current-headers) "")
6975        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6976
6977 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6978   "Start editing the contents of the current article buffer."
6979   (let ((winconf (current-window-configuration)))
6980     (set-buffer gnus-article-buffer)
6981     (let ((message-auto-save-directory
6982            ;; Don't associate the article buffer with a draft file.
6983            nil))
6984       (gnus-article-edit-mode))
6985     (funcall start-func)
6986     (set-buffer-modified-p nil)
6987     (gnus-configure-windows 'edit-article)
6988     (setq gnus-article-edit-done-function exit-func)
6989     (setq gnus-prev-winconf winconf)
6990     (unless quiet
6991       (gnus-message 6 "C-c C-c to end edits"))))
6992
6993 (defun gnus-article-edit-done (&optional arg)
6994   "Update the article edits and exit."
6995   (interactive "P")
6996   (let ((func gnus-article-edit-done-function)
6997         (buf (current-buffer))
6998         (start (window-start))
6999         (p (point))
7000         (winconf gnus-prev-winconf))
7001     (widen) ;; Widen it in case that users narrowed the buffer.
7002     (funcall func arg)
7003     (set-buffer buf)
7004     ;; The cache and backlog have to be flushed somewhat.
7005     (when gnus-keep-backlog
7006       (gnus-backlog-remove-article
7007        (car gnus-article-current) (cdr gnus-article-current)))
7008     ;; Flush original article as well.
7009     (when (get-buffer gnus-original-article-buffer)
7010       (with-current-buffer gnus-original-article-buffer
7011         (setq gnus-original-article nil)))
7012     (when gnus-use-cache
7013       (gnus-cache-update-article
7014        (car gnus-article-current) (cdr gnus-article-current)))
7015     ;; We remove all text props from the article buffer.
7016     (kill-all-local-variables)
7017     (set-text-properties (point-min) (point-max) nil)
7018     (gnus-article-mode)
7019     (set-window-configuration winconf)
7020     (set-buffer buf)
7021     (set-window-start (get-buffer-window buf) start)
7022     (set-window-point (get-buffer-window buf) (point)))
7023   (gnus-summary-show-article))
7024
7025 (defun gnus-article-edit-exit ()
7026   "Exit the article editing without updating."
7027   (interactive)
7028   (when (or (not (buffer-modified-p))
7029             (yes-or-no-p "Article modified; kill anyway? "))
7030     (let ((curbuf (current-buffer))
7031           (p (point))
7032           (window-start (window-start)))
7033       (erase-buffer)
7034       (if (gnus-buffer-live-p gnus-original-article-buffer)
7035           (insert-buffer-substring gnus-original-article-buffer))
7036       (let ((winconf gnus-prev-winconf))
7037         (kill-all-local-variables)
7038         (gnus-article-mode)
7039         (set-window-configuration winconf)
7040         ;; Tippy-toe some to make sure that point remains where it was.
7041         (save-current-buffer
7042           (set-buffer curbuf)
7043           (set-window-start (get-buffer-window (current-buffer)) window-start)
7044           (goto-char p))))
7045     (gnus-summary-show-article)))
7046
7047 (defun gnus-article-edit-full-stops ()
7048   "Interactively repair spacing at end of sentences."
7049   (interactive)
7050   (save-excursion
7051     (goto-char (point-min))
7052     (search-forward-regexp "^$" nil t)
7053     (let ((case-fold-search nil))
7054       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7055
7056 ;;;
7057 ;;; Article highlights
7058 ;;;
7059
7060 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7061
7062 ;;; Internal Variables:
7063
7064 (defcustom gnus-button-url-regexp
7065   (concat
7066    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7067    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7068    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7069    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7070        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7071              (punct "!?:;.,"))
7072          (concat
7073           "\\(?:"
7074           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7075           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7076           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7077           "\\|"
7078           "[" chars punct     "]+" "[" chars "]"
7079           "\\)"))
7080      (concat ;; XEmacs 21.4 doesn't support POSIX.
7081       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7082       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7083    "\\)")
7084   "Regular expression that matches URLs."
7085   :group 'gnus-article-buttons
7086   :type 'regexp)
7087
7088 (defcustom gnus-button-valid-fqdn-regexp
7089   message-valid-fqdn-regexp
7090   "Regular expression that matches a valid FQDN."
7091   :version "22.1"
7092   :group 'gnus-article-buttons
7093   :type 'regexp)
7094
7095 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7096 (defcustom gnus-button-valid-localpart-regexp
7097   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7098   "Regular expression that matches a localpart of mail addresses or MIDs."
7099   :version "22.1"
7100   :group 'gnus-article-buttons
7101   :type 'regexp)
7102
7103 (defcustom gnus-button-man-handler 'manual-entry
7104   "Function to use for displaying man pages.
7105 The function must take at least one argument with a string naming the
7106 man page."
7107   :version "22.1"
7108   :type '(choice (function-item :tag "Man" manual-entry)
7109                  (function-item :tag "Woman" woman)
7110                  (function :tag "Other"))
7111   :group 'gnus-article-buttons)
7112
7113 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
7114   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
7115 If the default site is too slow, try to find a CTAN mirror, see
7116 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
7117 the variable `gnus-button-handle-ctan'."
7118   :version "22.1"
7119   :group 'gnus-article-buttons
7120   :link '(custom-manual "(gnus)Group Parameters")
7121   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
7122                  (const "http://tug.ctan.org/tex-archive/")
7123                  (const "http://www.dante.de/CTAN/")
7124                  (string :tag "Other")))
7125
7126 (defcustom gnus-button-ctan-handler 'browse-url
7127   "Function to use for displaying CTAN links.
7128 The function must take one argument, the string naming the URL."
7129   :version "22.1"
7130   :type '(choice (function-item :tag "Browse Url" browse-url)
7131                  (function :tag "Other"))
7132   :group 'gnus-article-buttons)
7133
7134 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
7135   "Bogus strings removed from CTAN URLs."
7136   :version "22.1"
7137   :group 'gnus-article-buttons
7138   :type '(choice (const "^/?tex-archive/\\|/")
7139                  (regexp :tag "Other")))
7140
7141 (defcustom gnus-button-ctan-directory-regexp
7142   (regexp-opt
7143    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
7144          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
7145          "languages" "macros" "nonfree" "obsolete" "support" "systems"
7146          "tds" "tools" "usergrps" "web") t)
7147   "Regular expression for ctan directories.
7148 It should match all directories in the top level of `gnus-ctan-url'."
7149   :version "22.1"
7150   :group 'gnus-article-buttons
7151   :type 'regexp)
7152
7153 (defcustom gnus-button-mid-or-mail-regexp
7154   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7155           gnus-button-valid-fqdn-regexp
7156           ">?\\)\\b")
7157   "Regular expression that matches a message ID or a mail address."
7158   :version "22.1"
7159   :group 'gnus-article-buttons
7160   :type 'regexp)
7161
7162 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7163   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7164 Strings like this can be either a message ID or a mail address.  If it is one
7165 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7166 message ID or a mail address, respectively.  If this variable is set to the
7167 symbol `ask', always query the user what do do.  If it is a function, this
7168 function will be called with the string as its only argument.  The function
7169 must return `mid', `mail', `invalid' or `ask'."
7170   :version "22.1"
7171   :group 'gnus-article-buttons
7172   :type '(choice (function-item :tag "Heuristic function"
7173                                 gnus-button-mid-or-mail-heuristic)
7174                  (const ask)
7175                  (const mid)
7176                  (const mail)))
7177
7178 (defcustom gnus-button-mid-or-mail-heuristic-alist
7179   '((-10.0 . ".+\\$.+@")
7180     (-10.0 . "#")
7181     (-10.0 . "\\*")
7182     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7183     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7184     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7185     (-1.0  . "^[^a-z]+@")
7186     ;;
7187     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7188     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7189     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7190     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7191     ;;
7192     (-2.0  . "^[0-9]")
7193     (-1.0  . "^[0-9][0-9]")
7194     ;;
7195     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7196     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7197     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7198     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7199     ;;
7200     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7201     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7202     ;;       "[0-9]{8,}.*\@"
7203     (-3.0
7204      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7205     ;; "[0-9]{12,}.*\@"
7206     ;; compensation for TDMA dated mail addresses:
7207     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7208     ;;
7209     (-20.0 . "\\.fsf@") ;; Gnus
7210     (-20.0 . "^slrn")
7211     (-20.0 . "^Pine")
7212     (-20.0 . "^alpine\\.")
7213     (-20.0 . "_-_") ;; Subject change in thread
7214     ;;
7215     (-20.0 . "\\.ln@") ;; leafnode
7216     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7217     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7218     ;;
7219     ;; (5.0 . "") ;; $local_part_len <= 7
7220     (10.0  . "^[^0-9]+@")
7221     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7222     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7223     (3.0   . "\@stud")
7224     ;;
7225     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7226     ;;
7227     (0.5   . "^[A-Z][a-z]")
7228     (0.5   . "^[A-Z][a-z][a-z]")
7229     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7230     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7231   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7232
7233 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7234 address.  The REGEXP is processed with `case-fold-search' set to nil."
7235   :version "22.1"
7236   :group 'gnus-article-buttons
7237   :type '(repeat (cons (number :tag "Rate")
7238                        (regexp :tag "Regexp"))))
7239
7240 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7241   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7242 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7243 address, `ask' if unsure and `invalid' if the string is invalid."
7244   (let ((case-fold-search nil)
7245         (list gnus-button-mid-or-mail-heuristic-alist)
7246         (result 0) rate regexp lpartlen elem)
7247     (setq lpartlen
7248           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7249     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7250     ;; Certain special cases...
7251     (when (string-match
7252            (concat
7253             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7254             "^[0-9]+\\.[0-9]+@compuserve\\|"
7255             "@public\\.gmane\\.org")
7256            mid-or-mail)
7257       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7258       (setq result 'mail))
7259     (when (string-match "@.*@\\| " mid-or-mail)
7260       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7261       (setq result 'invalid))
7262     ;; Nothing more to do, if result is not a number here...
7263     (when (numberp result)
7264       (while list
7265         (setq elem (car list)
7266               rate (car elem)
7267               regexp (cdr elem)
7268               list (cdr list))
7269         (when (string-match regexp mid-or-mail)
7270           (setq result (+ result rate))
7271           (gnus-message
7272            9 "`%s' matched `%s', rate `%s', result `%s'."
7273            mid-or-mail regexp rate result)))
7274       (when (<= lpartlen 7)
7275         (setq result (+ result 5.0))
7276         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7277                       mid-or-mail result))
7278       (when (>= lpartlen 12)
7279         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7280         (cond
7281          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7282           ;; Long local part should contain realname if e-mail address,
7283           ;; too many digits: message-id.
7284           ;; $score -= 5.0 + 0.1 * $local_part_len;
7285           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7286           (setq result (+ result rate))
7287           (gnus-message
7288            9 "Many digits in `%s', rate `%s', result `%s'."
7289            mid-or-mail rate result))
7290          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7291                         mid-or-mail)
7292           ;; Too few vowels [^aeiouy]{4,}.*\@
7293           (setq result (+ result -5.0))
7294           (gnus-message
7295            9 "Few vowels in `%s', rate `%s', result `%s'."
7296            mid-or-mail -5.0 result))
7297          (t
7298           (setq result (+ result 5.0))
7299           (gnus-message
7300            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7301     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7302     ;; Maybe we should make this a customizable alist: (condition . 'result)
7303     (cond
7304      ((symbolp result) result)
7305      ;; Now convert number into proper results:
7306      ((< result -10.0) 'mid)
7307      ((> result  10.0) 'mail)
7308      (t 'ask))))
7309
7310 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7311   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7312          (url-mid (concat "news" ":" mid-or-mail))
7313          (url-mailto (concat "mailto" ":" mid-or-mail)))
7314     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7315     (when (fboundp pref)
7316       (setq guessed
7317             ;; get rid of surrounding angles...
7318             (funcall pref
7319                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7320       (if (or (eq 'mid guessed) (eq 'mail guessed))
7321           (setq pref guessed)
7322         (setq pref 'ask)))
7323     (if (eq pref 'ask)
7324         (save-window-excursion
7325           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7326               (setq pref 'mail)
7327             (setq pref 'mid))))
7328     (cond ((eq pref 'mid)
7329            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7330            (gnus-button-handle-news url-mid))
7331           ((eq pref 'mail)
7332            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7333            (gnus-url-mailto url-mailto))
7334           (t (gnus-message 3 "Invalid string.")))))
7335
7336 (defun gnus-button-handle-custom (fun arg)
7337   "Call function FUN on argument ARG.
7338 Both FUN and ARG are supposed to be strings.  ARG will be passed
7339 as a symbol to FUN."
7340   (funcall (intern fun)
7341            (if (string-match "^customize-apropos" fun)
7342                arg
7343              (intern arg))))
7344
7345 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7346
7347 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7348 ;; stuff?
7349
7350 (defun gnus-button-handle-describe-function (url)
7351   "Call `describe-function' when pushing the corresponding URL button."
7352   (describe-function
7353    (intern
7354     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7355
7356 (defun gnus-button-handle-describe-variable (url)
7357   "Call `describe-variable' when pushing the corresponding URL button."
7358   (describe-variable
7359    (intern
7360     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7361
7362 (defun gnus-button-handle-symbol (url)
7363 "Display help on variable or function.
7364 Calls `describe-variable' or `describe-function'."
7365   (let ((sym (intern url)))
7366     (cond
7367      ((fboundp sym) (describe-function sym))
7368      ((boundp sym) (describe-variable sym))
7369      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7370
7371 (defun gnus-button-handle-describe-key (url)
7372   "Call `describe-key' when pushing the corresponding URL button."
7373   (let* ((key-string
7374           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7375          (keys (ignore-errors (eval `(kbd ,key-string)))))
7376     (if keys
7377         (describe-key keys)
7378       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7379
7380 (defun gnus-button-handle-apropos (url)
7381   "Call `apropos' when pushing the corresponding URL button."
7382   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7383
7384 (defun gnus-button-handle-apropos-command (url)
7385   "Call `apropos' when pushing the corresponding URL button."
7386   (apropos-command
7387    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7388
7389 (defun gnus-button-handle-apropos-variable (url)
7390   "Call `apropos' when pushing the corresponding URL button."
7391   (funcall
7392    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7393    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7394
7395 (defun gnus-button-handle-apropos-documentation (url)
7396   "Call `apropos' when pushing the corresponding URL button."
7397   (funcall
7398    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7399    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7400
7401 (defun gnus-button-handle-library (url)
7402   "Call `locate-library' when pushing the corresponding URL button."
7403   (gnus-message 9 "url=`%s'" url)
7404   (let* ((lib (locate-library url))
7405          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7406     (if (not lib)
7407         (gnus-message 1 "Cannot locale library `%s'." url)
7408       (find-file-read-only file))))
7409
7410 (defun gnus-button-handle-ctan (url)
7411   "Call `browse-url' when pushing a CTAN URL button."
7412   (funcall
7413    gnus-button-ctan-handler
7414    (concat
7415     gnus-ctan-url
7416     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
7417
7418 (defcustom gnus-button-tex-level 5
7419   "*Integer that says how many TeX-related buttons Gnus will show.
7420 The higher the number, the more buttons will appear and the more false
7421 positives are possible.  Note that you can set this variable local to
7422 specific groups.  Setting it higher in TeX groups is probably a good idea.
7423 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7424 how to set variables in specific groups."
7425   :version "22.1"
7426   :group 'gnus-article-buttons
7427   :link '(custom-manual "(gnus)Group Parameters")
7428   :type 'integer)
7429
7430 (defcustom gnus-button-man-level 5
7431   "*Integer that says how many man-related buttons Gnus will show.
7432 The higher the number, the more buttons will appear and the more false
7433 positives are possible.  Note that you can set this variable local to
7434 specific groups.  Setting it higher in Unix groups is probably a good idea.
7435 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7436 how to set variables in specific groups."
7437   :version "22.1"
7438   :group 'gnus-article-buttons
7439   :link '(custom-manual "(gnus)Group Parameters")
7440   :type 'integer)
7441
7442 (defcustom gnus-button-emacs-level 5
7443   "*Integer that says how many emacs-related buttons Gnus will show.
7444 The higher the number, the more buttons will appear and the more false
7445 positives are possible.  Note that you can set this variable local to
7446 specific groups.  Setting it higher in Emacs or Gnus related groups is
7447 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7448 `gnus-parameters' on how to set variables in specific groups."
7449   :version "22.1"
7450   :group 'gnus-article-buttons
7451   :link '(custom-manual "(gnus)Group Parameters")
7452   :type 'integer)
7453
7454 (defcustom gnus-button-message-level 5
7455   "*Integer that says how many buttons for news or mail messages will appear.
7456 The higher the number, the more buttons will appear and the more false
7457 positives are possible."
7458   ;; mail addresses, MIDs, URLs for news, ...
7459   :version "22.1"
7460   :group 'gnus-article-buttons
7461   :type 'integer)
7462
7463 (defcustom gnus-button-browse-level 5
7464   "*Integer that says how many buttons for browsing will appear.
7465 The higher the number, the more buttons will appear and the more false
7466 positives are possible."
7467   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7468   :version "22.1"
7469   :group 'gnus-article-buttons
7470   :type 'integer)
7471
7472 (defcustom gnus-button-alist
7473   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7474      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7475     ((concat "\\b\\(nntp\\|news\\):\\("
7476              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7477      0 t gnus-button-handle-news 2)
7478     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7479      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7480     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7481      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7482     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7483     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7484      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7485     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7486      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7487     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7488      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7489     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7490      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7491     ;; RFC 2368 (The mailto URL scheme)
7492     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7493      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7494     ("\\bmailto:\\([^ \n\t]+\\)"
7495      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7496     ;; CTAN
7497     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
7498              gnus-button-ctan-directory-regexp
7499              "[^][>)!;:,'\n\t ]+\\)")
7500      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
7501     ((concat "\\btex-archive/\\("
7502              gnus-button-ctan-directory-regexp
7503              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
7504      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
7505     ((concat
7506       "\\b\\("
7507       gnus-button-ctan-directory-regexp
7508       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
7509      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
7510     ;; Info Konqueror style <info:/foo/bar baz>.
7511     ;; Must come before " Gnus home-grown style".
7512     ("\\binfo://?\\([^'\">\n\t]+\\)"
7513      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7514    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7515     ("\\binfo://\\([^'\">\n\t ]+\\)"
7516      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7517     ;; Info GNOME style <info:foo#bar_baz>
7518     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7519      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7520     ;; Info KDE style <info:(foo)bar baz>
7521     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7522      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7523     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7524      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7525     ("\\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,]*\\)\\)?"
7526      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7527      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7528     ;; This is custom
7529     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7530      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7531     ;; Emacs help commands
7532     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7533      ;; regexp doesn't match arguments containing ` '.
7534      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7535     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7536      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7537     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7538      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7539     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7540      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7541     ;; The following entries may lead to many false positives so don't enable
7542     ;; them by default (use a high button level).
7543     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7544      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7545      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7546     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7547      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7548     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7549      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7550     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7551      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7552     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7553      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7554     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7555      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7556     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7557      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7558     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7559      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7560     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7561      ;; Unlike the other regexps we really have to require quoting
7562      ;; here to determine where it ends.
7563      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7564     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7565     ("<URL: *\\([^\n<>]*\\)>"
7566      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7567     ;; RFC 2396 (2.4.3., delims) ...
7568     ("\"URL: *\\([^\n\"]*\\)\""
7569      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7570     ;; Raw URLs.
7571     (gnus-button-url-regexp
7572      0 (>= gnus-button-browse-level 0) browse-url 0)
7573     ;; man pages
7574     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7575      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7576      gnus-button-handle-man 1)
7577     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7578     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7579      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7580      gnus-button-handle-man 1)
7581     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7582     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7583     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7584      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7585     ;; Recognizing patches to .el files.  This is somewhat obscure,
7586     ;; but considering the percentage of Gnus users who hack Emacs
7587     ;; Lisp files...
7588     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7589      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7590     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7591      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7592     ;; MID or mail: To avoid too many false positives we don't try to catch
7593     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7594     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7595     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7596     ;; so that non-ambiguous entries (see above) match first.
7597     (gnus-button-mid-or-mail-regexp
7598      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7599   "*Alist of regexps matching buttons in article bodies.
7600
7601 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7602 REGEXP: is the string (case insensitive) matching text around the button (can
7603 also be Lisp expression evaluating to a string),
7604 BUTTON: is the number of the regexp grouping actually matching the button,
7605 FORM: is a Lisp expression which must eval to true for the button to
7606 be added,
7607 CALLBACK: is the function to call when the user push this button, and each
7608 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7609
7610 CALLBACK can also be a variable, in that case the value of that
7611 variable it the real callback function."
7612   :group 'gnus-article-buttons
7613   :type '(repeat (list (choice regexp variable sexp)
7614                        (integer :tag "Button")
7615                        (sexp :tag "Form")
7616                        (function :tag "Callback")
7617                        (repeat :tag "Par"
7618                                :inline t
7619                                (integer :tag "Regexp group")))))
7620 (put 'gnus-button-alist 'risky-local-variable t)
7621
7622 (defcustom gnus-header-button-alist
7623   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7624      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7625     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7626      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7627     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7628      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7629     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7630      0 (>= gnus-button-browse-level 0) browse-url 0)
7631     ("^Subject:" gnus-button-url-regexp
7632      0 (>= gnus-button-browse-level 0) browse-url 0)
7633     ("^[^:]+:" gnus-button-url-regexp
7634      0 (>= gnus-button-browse-level 0) browse-url 0)
7635     ("^OpenPGP:.*url=" gnus-button-url-regexp
7636      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7637     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7638      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7639     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7640      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7641   "*Alist of headers and regexps to match buttons in article heads.
7642
7643 This alist is very similar to `gnus-button-alist', except that each
7644 alist has an additional HEADER element first in each entry:
7645
7646 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7647
7648 HEADER is a regexp to match a header.  For a fuller explanation, see
7649 `gnus-button-alist'."
7650   :group 'gnus-article-buttons
7651   :group 'gnus-article-headers
7652   :type '(repeat (list (regexp :tag "Header")
7653                        (choice regexp variable)
7654                        (integer :tag "Button")
7655                        (sexp :tag "Form")
7656                        (function :tag "Callback")
7657                        (repeat :tag "Par"
7658                                :inline t
7659                                (integer :tag "Regexp group")))))
7660 (put 'gnus-header-button-alist 'risky-local-variable t)
7661
7662 ;;; Commands:
7663
7664 (defun gnus-article-push-button (event)
7665   "Check text under the mouse pointer for a callback function.
7666 If the text under the mouse pointer has a `gnus-callback' property,
7667 call it with the value of the `gnus-data' text property."
7668   (interactive "e")
7669   (set-buffer (window-buffer (posn-window (event-start event))))
7670   (let* ((pos (posn-point (event-start event)))
7671          (data (get-text-property pos 'gnus-data))
7672          (fun (get-text-property pos 'gnus-callback)))
7673     (goto-char pos)
7674     (when fun
7675       (funcall fun data))))
7676
7677 (defun gnus-article-press-button ()
7678   "Check text at point for a callback function.
7679 If the text at point has a `gnus-callback' property,
7680 call it with the value of the `gnus-data' text property."
7681   (interactive)
7682   (let ((data (get-text-property (point) 'gnus-data))
7683         (fun (get-text-property (point) 'gnus-callback)))
7684     (when fun
7685       (funcall fun data))))
7686
7687 (defun gnus-article-highlight (&optional force)
7688   "Highlight current article.
7689 This function calls `gnus-article-highlight-headers',
7690 `gnus-article-highlight-citation',
7691 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7692 do the highlighting.  See the documentation for those functions."
7693   (interactive (list 'force))
7694   (gnus-article-highlight-headers)
7695   (gnus-article-highlight-citation force)
7696   (gnus-article-highlight-signature)
7697   (gnus-article-add-buttons force)
7698   (gnus-article-add-buttons-to-head))
7699
7700 (defun gnus-article-highlight-some (&optional force)
7701   "Highlight current article.
7702 This function calls `gnus-article-highlight-headers',
7703 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7704 do the highlighting.  See the documentation for those functions."
7705   (interactive (list 'force))
7706   (gnus-article-highlight-headers)
7707   (gnus-article-highlight-signature)
7708   (gnus-article-add-buttons))
7709
7710 (defun gnus-article-highlight-headers ()
7711   "Highlight article headers as specified by `gnus-header-face-alist'."
7712   (interactive)
7713   (gnus-with-article-headers
7714     (let (regexp header-face field-face from hpoints fpoints)
7715       (dolist (entry gnus-header-face-alist)
7716         (goto-char (point-min))
7717         (setq regexp (concat "^\\("
7718                              (if (string-equal "" (nth 0 entry))
7719                                  "[^\t ]"
7720                                (nth 0 entry))
7721                              "\\)")
7722               header-face (nth 1 entry)
7723               field-face (nth 2 entry))
7724         (while (and (re-search-forward regexp nil t)
7725                     (not (eobp)))
7726           (beginning-of-line)
7727           (setq from (point))
7728           (unless (search-forward ":" nil t)
7729             (forward-char 1))
7730           (when (and header-face
7731                      (not (memq (point) hpoints)))
7732             (push (point) hpoints)
7733             (gnus-put-text-property from (point) 'face header-face))
7734           (when (and field-face
7735                      (not (memq (setq from (point)) fpoints)))
7736             (push from fpoints)
7737             (if (re-search-forward "^[^ \t]" nil t)
7738                 (forward-char -2)
7739               (goto-char (point-max)))
7740             (gnus-put-text-property from (point) 'face field-face)))))))
7741
7742 (defun gnus-article-highlight-signature ()
7743   "Highlight the signature in an article.
7744 It does this by highlighting everything after
7745 `gnus-signature-separator' using the face `gnus-signature'."
7746   (interactive)
7747   (gnus-with-article-buffer
7748     (let ((inhibit-point-motion-hooks t))
7749       (save-restriction
7750         (when (and gnus-signature-face
7751                    (gnus-article-narrow-to-signature))
7752           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7753                             'face gnus-signature-face)
7754           (widen)
7755           (gnus-article-search-signature)
7756           (let ((start (match-beginning 0))
7757                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7758             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7759                                      end)))))))
7760
7761 (defun gnus-button-in-region-p (b e prop)
7762   "Say whether PROP exists in the region."
7763   (text-property-not-all b e prop nil))
7764
7765 (defun gnus-article-add-buttons (&optional force)
7766   "Find external references in the article and make buttons of them.
7767 \"External references\" are things like Message-IDs and URLs, as
7768 specified by `gnus-button-alist'."
7769   (interactive (list 'force))
7770   (gnus-with-article-buffer
7771     (let ((inhibit-point-motion-hooks t)
7772           (case-fold-search t)
7773           (alist gnus-button-alist)
7774           beg entry regexp)
7775       ;; Remove all old markers.
7776       (let (marker entry new-list)
7777         (while (setq marker (pop gnus-button-marker-list))
7778           (if (or (< marker (point-min)) (>= marker (point-max)))
7779               (push marker new-list)
7780             (goto-char marker)
7781             (when (setq entry (gnus-button-entry))
7782               (put-text-property (match-beginning (nth 1 entry))
7783                                  (match-end (nth 1 entry))
7784                                  'gnus-callback nil))
7785             (set-marker marker nil)))
7786         (setq gnus-button-marker-list new-list))
7787       ;; We skip the headers.
7788       (article-goto-body)
7789       (setq beg (point))
7790       (while (setq entry (pop alist))
7791         (setq regexp (eval (car entry)))
7792         (goto-char beg)
7793         (while (re-search-forward regexp nil t)
7794           (let ((start (match-beginning (nth 1 entry)))
7795                 (end (match-end (nth 1 entry)))
7796                 (from (match-beginning 0)))
7797             (when (and (or (eq t (nth 2 entry))
7798                            (eval (nth 2 entry)))
7799                        (not (gnus-button-in-region-p
7800                              start end 'gnus-callback)))
7801               ;; That optional form returned non-nil, so we add the
7802               ;; button.
7803               (setq from (set-marker (make-marker) from))
7804               (push from gnus-button-marker-list)
7805               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7806                            (gnus-article-extend-url-button from start end))
7807                 (gnus-article-add-button start end
7808                                          'gnus-button-push from)))))))))
7809
7810 (defun gnus-article-extend-url-button (beg start end)
7811   "Extend url button if url is folded into two or more lines.
7812 Return non-nil if button is extended.  BEG is a marker that points to
7813 the beginning position of a text containing url.  START and END are
7814 the endpoints of a url button before it is extended.  The concatenated
7815 url is put as the `gnus-button-url' overlay property on the button."
7816   (let ((opoint (point))
7817         (points (list start end))
7818         url delim regexp)
7819     (prog1
7820         (when (and (progn
7821                      (goto-char end)
7822                      (not (looking-at "[\t ]*[\">]")))
7823                    (progn
7824                      (goto-char start)
7825                      (string-match
7826                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7827                       (buffer-substring (point-at-bol) start)))
7828                    (progn
7829                      (setq url (list (buffer-substring start end))
7830                            delim (if (match-beginning 1) ">" "\""))
7831                      (beginning-of-line)
7832                      (setq regexp (concat
7833                                    (when (and (looking-at
7834                                                message-cite-prefix-regexp)
7835                                               (< (match-end 0) start))
7836                                      (regexp-quote (match-string 0)))
7837                                    "\
7838 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7839                                    delim "\\)"))
7840                      (while (progn
7841                               (forward-line 1)
7842                               (and (looking-at regexp)
7843                                    (prog1
7844                                        (match-beginning 1)
7845                                      (push (or (match-string 2)
7846                                                (match-string 1))
7847                                            url)
7848                                      (push (setq end (or (match-end 2)
7849                                                          (match-end 1)))
7850                                            points)
7851                                      (push (or (match-beginning 2)
7852                                                (match-beginning 1))
7853                                            points)))))
7854                      (match-beginning 2)))
7855           (let (gnus-article-mouse-face widget-mouse-face)
7856             (while points
7857               (gnus-article-add-button (pop points) (pop points)
7858                                        'gnus-button-push beg)))
7859           (let ((overlay (gnus-make-overlay start end)))
7860             (gnus-overlay-put overlay 'evaporate t)
7861             (gnus-overlay-put overlay 'gnus-button-url
7862                               (list (mapconcat 'identity (nreverse url) "")))
7863             (when gnus-article-mouse-face
7864               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7865           t)
7866       (goto-char opoint))))
7867
7868 ;; Add buttons to the head of an article.
7869 (defun gnus-article-add-buttons-to-head ()
7870   "Add buttons to the head of the article."
7871   (interactive)
7872   (gnus-with-article-headers
7873     (let (beg end)
7874       (dolist (entry gnus-header-button-alist)
7875         ;; Each alist entry.
7876         (goto-char (point-min))
7877         (while (re-search-forward (car entry) nil t)
7878           ;; Each header matching the entry.
7879           (setq beg (match-beginning 0))
7880           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7881                              (match-beginning 0))
7882                         (point-max)))
7883           (goto-char beg)
7884           (while (re-search-forward (eval (nth 1 entry)) end t)
7885             ;; Each match within a header.
7886             (let* ((entry (cdr entry))
7887                    (start (match-beginning (nth 1 entry)))
7888                    (end (match-end (nth 1 entry)))
7889                    (form (nth 2 entry)))
7890               (goto-char (match-end 0))
7891               (when (eval form)
7892                 (gnus-article-add-button
7893                  start end (nth 3 entry)
7894                  (buffer-substring (match-beginning (nth 4 entry))
7895                                    (match-end (nth 4 entry)))))))
7896           (goto-char end))))))
7897
7898 ;;; External functions:
7899
7900 (defun gnus-article-add-button (from to fun &optional data)
7901   "Create a button between FROM and TO with callback FUN and data DATA."
7902   (when gnus-article-button-face
7903     (gnus-overlay-put (gnus-make-overlay from to nil t)
7904                       'face gnus-article-button-face))
7905   (gnus-add-text-properties
7906    from to
7907    (nconc (and gnus-article-mouse-face
7908                (list gnus-mouse-face-prop gnus-article-mouse-face))
7909           (list 'gnus-callback fun)
7910           (and data (list 'gnus-data data))))
7911   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7912                          :button-keymap gnus-widget-button-keymap))
7913
7914 ;;; Internal functions:
7915
7916 (defun gnus-article-set-globals ()
7917   (with-current-buffer gnus-summary-buffer
7918     (gnus-set-global-variables)))
7919
7920 (defun gnus-signature-toggle (end)
7921   (gnus-with-article-buffer
7922     (let ((inhibit-point-motion-hooks t))
7923       (if (text-property-any end (point-max) 'article-type 'signature)
7924           (progn
7925             (gnus-delete-wash-type 'signature)
7926             (gnus-remove-text-properties-when
7927              'article-type 'signature end (point-max)
7928              (cons 'article-type (cons 'signature
7929                                        gnus-hidden-properties))))
7930         (gnus-add-wash-type 'signature)
7931         (gnus-add-text-properties-when
7932          'article-type nil end (point-max)
7933          (cons 'article-type (cons 'signature
7934                                    gnus-hidden-properties)))))
7935     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7936       (gnus-set-mode-line 'article))))
7937
7938 (defun gnus-button-entry ()
7939   ;; Return the first entry in `gnus-button-alist' matching this place.
7940   (let ((alist gnus-button-alist)
7941         (entry nil))
7942     (while alist
7943       (setq entry (pop alist))
7944       (if (looking-at (eval (car entry)))
7945           (setq alist nil)
7946         (setq entry nil)))
7947     entry))
7948
7949 (defun gnus-button-push (marker)
7950   ;; Push button starting at MARKER.
7951   (save-excursion
7952     (goto-char marker)
7953     (let* ((entry (gnus-button-entry))
7954            (inhibit-point-motion-hooks t)
7955            (fun (nth 3 entry))
7956            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7957                           (get-char-property marker 'gnus-button-url))
7958                      (mapcar (lambda (group)
7959                                (let ((string (match-string group)))
7960                                  (set-text-properties
7961                                   0 (length string) nil string)
7962                                  string))
7963                              (nthcdr 4 entry)))))
7964       (cond
7965        ((fboundp fun)
7966         (apply fun args))
7967        ((and (boundp fun)
7968              (fboundp (symbol-value fun)))
7969         (apply (symbol-value fun) args))
7970        (t
7971         (gnus-message 1 "You must define `%S' to use this button"
7972                       (cons fun args)))))))
7973
7974 (defun gnus-parse-news-url (url)
7975   (let (scheme server port group message-id articles)
7976     (with-temp-buffer
7977       (insert url)
7978       (goto-char (point-min))
7979       (when (looking-at "\\([A-Za-z]+\\):")
7980         (setq scheme (match-string 1))
7981         (goto-char (match-end 0)))
7982       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7983         (setq server (match-string 1))
7984         (setq port (if (stringp (match-string 3))
7985                        (string-to-number (match-string 3))
7986                      (match-string 3)))
7987         (goto-char (match-end 0)))
7988
7989       (cond
7990        ((looking-at "\\(.*@.*\\)")
7991         (setq message-id (match-string 1)))
7992        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7993         (setq group (match-string 1)
7994               articles (split-string (match-string 2) "-")))
7995        ((looking-at "\\([^/]+\\)/?")
7996         (setq group (match-string 1)))
7997        (t
7998         (error "Unknown news URL syntax"))))
7999     (list scheme server port group message-id articles)))
8000
8001 (defun gnus-button-handle-news (url)
8002   "Fetch a news URL."
8003   (destructuring-bind (scheme server port group message-id articles)
8004       (gnus-parse-news-url url)
8005     (cond
8006      (message-id
8007       (with-current-buffer gnus-summary-buffer
8008         (if server
8009             (let ((gnus-refer-article-method
8010                    (nconc (list (list 'nntp server))
8011                           gnus-refer-article-method))
8012                   (nntp-port-number (or port "nntp")))
8013               (gnus-message 7 "Fetching %s with %s"
8014                             message-id gnus-refer-article-method)
8015               (gnus-summary-refer-article message-id))
8016           (gnus-summary-refer-article message-id))))
8017      (group
8018       (gnus-button-fetch-group url)))))
8019
8020 (defun gnus-button-patch (library line)
8021   "Visit an Emacs Lisp library LIBRARY on line LINE."
8022   (interactive)
8023   (let ((file (locate-library (file-name-nondirectory library))))
8024     (unless file
8025       (error "Couldn't find library %s" library))
8026     (find-file file)
8027     (goto-char (point-min))
8028     (forward-line (1- (string-to-number line)))))
8029
8030 (defun gnus-button-handle-man (url)
8031   "Fetch a man page."
8032   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8033   (when (eq gnus-button-man-handler 'woman)
8034     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
8035   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8036   (funcall gnus-button-man-handler url))
8037
8038 (defun gnus-button-handle-info-url (url)
8039   "Fetch an info URL."
8040   (setq url (mm-subst-char-in-string ?+ ?\  url))
8041   (cond
8042    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
8043     (gnus-info-find-node
8044      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
8045                      "Gnus")
8046              ")" (gnus-url-unhex-string (match-string 2 url)))))
8047    ((string-match "([^)\"]+)[^\"]+" url)
8048     (setq url
8049           (gnus-replace-in-string
8050            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8051     (gnus-info-find-node url))
8052    (t (error "Can't parse %s" url))))
8053
8054 (defun gnus-button-handle-info-url-gnome (url)
8055   "Fetch GNOME style info URL."
8056   (setq url (mm-subst-char-in-string ?_ ?\  url))
8057   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8058       (gnus-info-find-node
8059        (concat "("
8060                (gnus-url-unhex-string
8061                  (match-string 1 url))
8062                ")"
8063                (or (gnus-url-unhex-string
8064                     (match-string 2 url))
8065                    "Top")))
8066     (error "Can't parse %s" url)))
8067
8068 (defun gnus-button-handle-info-url-kde (url)
8069   "Fetch KDE style info URL."
8070   (gnus-info-find-node (gnus-url-unhex-string url)))
8071
8072 ;; (info) will autoload info.el
8073 (declare-function Info-menu "info" (menu-item &optional fork))
8074 (declare-function Info-index-next "info" (num))
8075
8076 (defun gnus-button-handle-info-keystrokes (url)
8077   "Call `info' when pushing the corresponding URL button."
8078   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8079   (let (node indx comma)
8080     (if (string-match
8081          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8082                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8083                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
8084                  "\\(?:[ \t\n,]*\\)\\)?")
8085          url)
8086         (setq node (match-string 2 url)
8087               indx (match-string 3 url))
8088       (error "Can't parse %s" url))
8089     (info)
8090     (Info-directory)
8091     (Info-menu node)
8092     (when (> (length indx) 0)
8093       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8094                             "\\([ \t\n,]*\\)")
8095                     indx)
8096       (setq comma (match-string 2 indx))
8097       (setq indx  (match-string 1 indx))
8098       (Info-index indx)
8099       (when comma
8100         (dotimes (i (with-temp-buffer
8101                       (insert comma)
8102                       ;; Note: the XEmacs version of `how-many' takes
8103                       ;; no optional argument.
8104                       (goto-char (point-min))
8105                       (how-many ",")))
8106           (Info-index-next 1)))
8107       nil)))
8108
8109 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8110 (declare-function pgg-display-output-buffer "pgg" (start end status))
8111
8112 (defun gnus-button-openpgp (url)
8113   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8114   (with-temp-buffer
8115     (mm-url-insert-file-contents-external url)
8116     (pgg-snarf-keys-region (point-min) (point-max))
8117     (pgg-display-output-buffer nil nil nil)))
8118
8119 (defun gnus-button-message-id (message-id)
8120   "Fetch MESSAGE-ID."
8121   (with-current-buffer gnus-summary-buffer
8122     (gnus-summary-refer-article message-id)))
8123
8124 (defun gnus-button-fetch-group (address &rest ignore)
8125   "Fetch GROUP specified by ADDRESS."
8126   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8127                       address)
8128     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8129     ;; for nntp:// and news://
8130     (setq address (match-string 3 address)))
8131   (if (not (string-match "[:/]" address))
8132       ;; This is just a simple group url.
8133       (gnus-group-read-ephemeral-group address gnus-select-method)
8134     (if (not
8135          (string-match
8136           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8137           address))
8138         (error "Can't parse %s" address)
8139       (gnus-group-read-ephemeral-group
8140        (match-string 4 address)
8141        `(nntp ,(match-string 1 address)
8142               (nntp-address ,(match-string 1 address))
8143               (nntp-port-number ,(if (match-end 3)
8144                                      (match-string 3 address)
8145                                    "nntp")))
8146        nil nil nil
8147        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8148
8149 (defun gnus-url-parse-query-string (query &optional downcase)
8150   (let (retval pairs cur key val)
8151     (setq pairs (split-string query "&"))
8152     (while pairs
8153       (setq cur (car pairs)
8154             pairs (cdr pairs))
8155       (if (not (string-match "=" cur))
8156           nil                           ; Grace
8157         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8158               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8159         (if downcase
8160             (setq key (downcase key)))
8161         (setq cur (assoc key retval))
8162         (if cur
8163             (setcdr cur (cons val (cdr cur)))
8164           (setq retval (cons (list key val) retval)))))
8165     retval))
8166
8167 (defun gnus-url-mailto (url)
8168   ;; Send mail to someone
8169   (when (string-match "mailto:/*\\(.*\\)" url)
8170     (setq url (substring url (match-beginning 1) nil)))
8171   (let (to args subject func)
8172     (setq args (gnus-url-parse-query-string
8173                 (if (string-match "^\\?" url)
8174                     (substring url 1)
8175                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8176                       (concat "to=" (match-string 1 url) "&"
8177                               (match-string 2 url))
8178                     (concat "to=" url)))
8179                 t)
8180           subject (cdr-safe (assoc "subject" args)))
8181     (gnus-msg-mail)
8182     (while args
8183       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8184       (if (fboundp func)
8185           (funcall func)
8186         (message-position-on-field (caar args)))
8187       (insert (gnus-replace-in-string
8188                (mapconcat 'identity (reverse (cdar args)) ", ")
8189                "\r\n" "\n" t))
8190       (setq args (cdr args)))
8191     (if subject
8192         (message-goto-body)
8193       (message-goto-subject))))
8194
8195 (defun gnus-button-embedded-url (address)
8196   "Activate ADDRESS with `browse-url'."
8197   (browse-url (gnus-strip-whitespace address)))
8198
8199 ;;; Next/prev buttons in the article buffer.
8200
8201 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8202 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8203
8204 (defvar gnus-prev-page-map
8205   (let ((map (make-sparse-keymap)))
8206     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8207     (define-key map "\r" 'gnus-button-prev-page)
8208     map))
8209
8210 (defvar gnus-next-page-map
8211   (let ((map (make-sparse-keymap)))
8212     (unless (>= emacs-major-version 21)
8213       ;; XEmacs doesn't care.
8214       (set-keymap-parent map gnus-article-mode-map))
8215     (define-key map gnus-mouse-2 'gnus-button-next-page)
8216     (define-key map "\r" 'gnus-button-next-page)
8217     map))
8218
8219 (defun gnus-insert-prev-page-button ()
8220   (let ((b (point)) e
8221         (inhibit-read-only t))
8222     (gnus-eval-format
8223      gnus-prev-page-line-format nil
8224      `(keymap ,gnus-prev-page-map
8225               gnus-prev t
8226               gnus-callback gnus-article-button-prev-page
8227               article-type annotation))
8228     (setq e (if (bolp)
8229                 ;; Exclude a newline.
8230                 (1- (point))
8231               (point)))
8232     (when gnus-article-button-face
8233       (gnus-overlay-put (gnus-make-overlay b e nil t)
8234                         'face gnus-article-button-face))
8235     (widget-convert-button
8236      'link b e
8237      :action 'gnus-button-prev-page
8238      :button-keymap gnus-prev-page-map)))
8239
8240 (defun gnus-button-next-page (&optional args more-args)
8241   "Go to the next page."
8242   (interactive)
8243   (let ((win (selected-window)))
8244     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8245     (gnus-article-next-page)
8246     (select-window win)))
8247
8248 (defun gnus-button-prev-page (&optional args more-args)
8249   "Go to the prev page."
8250   (interactive)
8251   (let ((win (selected-window)))
8252     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8253     (gnus-article-prev-page)
8254     (select-window win)))
8255
8256 (defun gnus-insert-next-page-button ()
8257   (let ((b (point)) e
8258         (inhibit-read-only t))
8259     (gnus-eval-format gnus-next-page-line-format nil
8260                       `(keymap ,gnus-next-page-map
8261                                gnus-next t
8262                                gnus-callback gnus-article-button-next-page
8263                                article-type annotation))
8264     (setq e (if (bolp)
8265                 ;; Exclude a newline.
8266                 (1- (point))
8267               (point)))
8268     (when gnus-article-button-face
8269       (gnus-overlay-put (gnus-make-overlay b e nil t)
8270                         'face gnus-article-button-face))
8271     (widget-convert-button
8272      'link b e
8273      :action 'gnus-button-next-page
8274      :button-keymap gnus-next-page-map)))
8275
8276 (defun gnus-article-button-next-page (arg)
8277   "Go to the next page."
8278   (interactive "P")
8279   (let ((win (selected-window)))
8280     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8281     (gnus-article-next-page)
8282     (select-window win)))
8283
8284 (defun gnus-article-button-prev-page (arg)
8285   "Go to the prev page."
8286   (interactive "P")
8287   (let ((win (selected-window)))
8288     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8289     (gnus-article-prev-page)
8290     (select-window win)))
8291
8292 (defvar gnus-decode-header-methods
8293   '(mail-decode-encoded-word-region)
8294   "List of methods used to decode headers.
8295
8296 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8297 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8298 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8299 whose names match REGEXP.
8300
8301 For example:
8302 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8303  mail-decode-encoded-word-region
8304  (\"chinese\" . rfc1843-decode-region))
8305 ")
8306
8307 (defvar gnus-decode-header-methods-cache nil)
8308
8309 (defun gnus-multi-decode-header (start end)
8310   "Apply the functions from `gnus-encoded-word-methods' that match."
8311   (unless (and gnus-decode-header-methods-cache
8312                (eq gnus-newsgroup-name
8313                    (car gnus-decode-header-methods-cache)))
8314     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8315     (dolist (x gnus-decode-header-methods)
8316       (if (symbolp x)
8317           (nconc gnus-decode-header-methods-cache (list x))
8318         (if (and gnus-newsgroup-name
8319                  (string-match (car x) gnus-newsgroup-name))
8320             (nconc gnus-decode-header-methods-cache
8321                    (list (cdr x)))))))
8322   (let ((xlist gnus-decode-header-methods-cache))
8323     (pop xlist)
8324     (save-restriction
8325       (narrow-to-region start end)
8326       (while xlist
8327         (funcall (pop xlist) (point-min) (point-max))))))
8328
8329 ;;;
8330 ;;; Treatment top-level handling.
8331 ;;;
8332
8333 (defun gnus-treat-article (condition &optional part-number total-parts type)
8334   (let ((length (- (point-max) (point-min)))
8335         (alist gnus-treatment-function-alist)
8336         (article-goto-body-goes-to-point-min-p t)
8337         (treated-type
8338          (or (not type)
8339              (catch 'found
8340                (let ((list gnus-article-treat-types))
8341                  (while list
8342                    (when (string-match (pop list) type)
8343                      (throw 'found t)))))))
8344         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8345         val elem)
8346     (gnus-run-hooks 'gnus-part-display-hook)
8347     (dolist (elem alist)
8348       (setq val
8349             (save-excursion
8350               (when (gnus-buffer-live-p gnus-summary-buffer)
8351                 (set-buffer gnus-summary-buffer))
8352               (symbol-value (car elem))))
8353       (when (and (or (consp val)
8354                      treated-type)
8355                  (gnus-treat-predicate val)
8356                  (or (not (get (car elem) 'highlight))
8357                      highlightp))
8358         (save-restriction
8359           (funcall (cadr elem)))))))
8360
8361 ;; Dynamic variables.
8362 (defvar part-number)
8363 (defvar total-parts)
8364 (defvar type)
8365 (defvar condition)
8366 (defvar length)
8367
8368 (defun gnus-treat-predicate (val)
8369   (cond
8370    ((null val)
8371     nil)
8372    (condition
8373     (eq condition val))
8374    ((and (listp val)
8375          (stringp (car val)))
8376     (apply 'gnus-or (mapcar `(lambda (s)
8377                                (string-match s ,(or gnus-newsgroup-name "")))
8378                             val)))
8379    ((listp val)
8380     (let ((pred (pop val)))
8381       (cond
8382        ((eq pred 'or)
8383         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8384        ((eq pred 'and)
8385         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8386        ((eq pred 'not)
8387         (not (gnus-treat-predicate (car val))))
8388        ((eq pred 'typep)
8389         (equal (car val) type))
8390        (t
8391         (error "%S is not a valid predicate" pred)))))
8392    ((eq val t)
8393     t)
8394    ((eq val 'head)
8395     nil)
8396    ((eq val 'first)
8397     (eq part-number 1))
8398    ((eq val 'last)
8399     (eq part-number total-parts))
8400    ((numberp val)
8401     (< length val))
8402    (t
8403     (error "%S is not a valid value" val))))
8404
8405 (defun gnus-article-encrypt-body (protocol &optional n)
8406   "Encrypt the article body."
8407   (interactive
8408    (list
8409     (or gnus-article-encrypt-protocol
8410         (completing-read "Encrypt protocol: "
8411                          gnus-article-encrypt-protocol-alist
8412                          nil t))
8413     current-prefix-arg))
8414   ;; User might hit `K E' instead of `K e', so prompt once.
8415   (when (and gnus-article-encrypt-protocol
8416              gnus-novice-user)
8417     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8418       (error "Encrypt aborted")))
8419   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8420     (unless func
8421       (error "Can't find the encrypt protocol %s" protocol))
8422     (if (member gnus-newsgroup-name '("nndraft:delayed"
8423                                       "nndraft:drafts"
8424                                       "nndraft:queue"))
8425         (error "Can't encrypt the article in group %s"
8426                gnus-newsgroup-name))
8427     (gnus-summary-iterate n
8428       (with-current-buffer gnus-summary-buffer
8429         (let ((mail-parse-charset gnus-newsgroup-charset)
8430               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8431               (summary-buffer gnus-summary-buffer)
8432               references point)
8433           (gnus-set-global-variables)
8434           (when (gnus-group-read-only-p)
8435             (error "The current newsgroup does not support article encrypt"))
8436           (gnus-summary-show-article t)
8437           (setq references
8438               (or (mail-header-references gnus-current-headers) ""))
8439           (set-buffer gnus-article-buffer)
8440           (let* ((inhibit-read-only t)
8441                  (headers
8442                   (mapcar (lambda (field)
8443                             (and (save-restriction
8444                                    (message-narrow-to-head)
8445                                    (goto-char (point-min))
8446                                    (search-forward field nil t))
8447                                  (prog2
8448                                      (message-narrow-to-field)
8449                                      (buffer-string)
8450                                    (delete-region (point-min) (point-max))
8451                                    (widen))))
8452                           '("Content-Type:" "Content-Transfer-Encoding:"
8453                             "Content-Disposition:"))))
8454             (message-narrow-to-head)
8455             (message-remove-header "MIME-Version")
8456             (goto-char (point-max))
8457             (setq point (point))
8458             (insert (apply 'concat headers))
8459             (widen)
8460             (narrow-to-region point (point-max))
8461             (let ((message-options message-options))
8462               (message-options-set 'message-sender user-mail-address)
8463               (message-options-set 'message-recipients user-mail-address)
8464               (message-options-set 'message-sign-encrypt 'not)
8465               (funcall func))
8466             (goto-char (point-min))
8467             (insert "MIME-Version: 1.0\n")
8468             (widen)
8469             (gnus-summary-edit-article-done
8470              references nil summary-buffer t))
8471           (when gnus-keep-backlog
8472             (gnus-backlog-remove-article
8473              (car gnus-article-current) (cdr gnus-article-current)))
8474           (when (get-buffer gnus-original-article-buffer)
8475             (with-current-buffer gnus-original-article-buffer
8476               (setq gnus-original-article nil)))
8477           (when gnus-use-cache
8478             (gnus-cache-update-article
8479              (car gnus-article-current) (cdr gnus-article-current))))))))
8480
8481 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8482   "The following specs can be used:
8483 %t  The security MIME type
8484 %i  Additional info
8485 %d  Details
8486 %D  Details if button is pressed")
8487
8488 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8489   "The following specs can be used:
8490 %t  The security MIME type
8491 %i  Additional info
8492 %d  Details
8493 %D  Details if button is pressed")
8494
8495 (defvar gnus-mime-security-button-line-format-alist
8496   '((?t gnus-tmp-type ?s)
8497     (?i gnus-tmp-info ?s)
8498     (?d gnus-tmp-details ?s)
8499     (?D gnus-tmp-pressed-details ?s)))
8500
8501 (defvar gnus-mime-security-button-commands
8502   '((gnus-article-press-button "\r" "Show Detail")
8503     (undefined "v")
8504     (undefined "t")
8505     (undefined "C")
8506     (gnus-mime-security-save-part "o" "Save...")
8507     (undefined "\C-o")
8508     (undefined "r")
8509     (undefined "d")
8510     (undefined "c")
8511     (undefined "i")
8512     (undefined "E")
8513     (undefined "e")
8514     (undefined "p")
8515     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8516     (undefined ".")))
8517
8518 (defvar gnus-mime-security-button-map
8519   (let ((map (make-sparse-keymap)))
8520     (define-key map gnus-mouse-2 'gnus-article-push-button)
8521     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8522     (dolist (c gnus-mime-security-button-commands)
8523       (define-key map (cadr c) (car c)))
8524     map))
8525
8526 (easy-menu-define
8527   gnus-mime-security-button-menu gnus-mime-security-button-map
8528   "Security button menu."
8529   `("Security Part"
8530     ,@(delq nil
8531             (mapcar (lambda (c)
8532                       (unless (eq (car c) 'undefined)
8533                         (vector (caddr c) (car c) :active t)))
8534                     gnus-mime-security-button-commands))))
8535
8536 (defun gnus-mime-security-button-menu (event prefix)
8537   "Construct a context-sensitive menu of security commands."
8538   (interactive "e\nP")
8539   (save-window-excursion
8540     (let ((pos (event-start event)))
8541       (select-window (posn-window pos))
8542       (goto-char (posn-point pos))
8543       (gnus-article-check-buffer)
8544       (popup-menu gnus-mime-security-button-menu nil prefix))))
8545
8546 (defvar gnus-mime-security-details-buffer nil)
8547
8548 (defvar gnus-mime-security-button-pressed nil)
8549
8550 (defvar gnus-mime-security-show-details-inline t
8551   "If non-nil, show details in the article buffer.")
8552
8553 (defun gnus-mime-security-verify-or-decrypt (handle)
8554   (mm-remove-parts (cdr handle))
8555   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8556         point (inhibit-read-only t))
8557     (if region
8558         (goto-char (car region)))
8559     (setq point (point))
8560     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8561       (let* ((mm-verify-option 'known)
8562              (mm-decrypt-option 'known)
8563              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8564         (unless (eq nparts (cdr handle))
8565           (mm-destroy-parts (cdr handle))
8566           (setcdr handle nparts))))
8567     (gnus-mime-display-security handle)
8568     (when region
8569       (delete-region (point) (cdr region))
8570       (set-marker (car region) nil)
8571       (set-marker (cdr region) nil))
8572     (goto-char point)))
8573
8574 (defun gnus-mime-security-show-details (handle)
8575   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8576     (if (not details)
8577         (gnus-message 5 "No details.")
8578       (if gnus-mime-security-show-details-inline
8579           (let ((gnus-mime-security-button-pressed
8580                  (not (get-text-property (point) 'gnus-mime-details)))
8581                 (gnus-mime-security-button-line-format
8582                  (get-text-property (point) 'gnus-line-format))
8583                 (inhibit-read-only t))
8584             (forward-char -1)
8585             (while (eq (get-text-property (point) 'gnus-line-format)
8586                        gnus-mime-security-button-line-format)
8587               (forward-char -1))
8588             (forward-char)
8589             (save-restriction
8590               (narrow-to-region (point) (point))
8591               (gnus-insert-mime-security-button handle))
8592             (delete-region (point)
8593                            (or (text-property-not-all
8594                                 (point) (point-max)
8595                                 'gnus-line-format
8596                                 gnus-mime-security-button-line-format)
8597                                (point-max))))
8598         ;; Not inlined.
8599         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8600             (with-current-buffer gnus-mime-security-details-buffer
8601               (erase-buffer)
8602               t)
8603           (setq gnus-mime-security-details-buffer
8604                 (gnus-get-buffer-create "*MIME Security Details*")))
8605         (with-current-buffer gnus-mime-security-details-buffer
8606           (insert details)
8607           (goto-char (point-min)))
8608         (pop-to-buffer gnus-mime-security-details-buffer)))))
8609
8610 (defun gnus-mime-security-press-button (handle)
8611   (save-excursion
8612     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8613         (gnus-mime-security-show-details handle)
8614       (gnus-mime-security-verify-or-decrypt handle))))
8615
8616 (defun gnus-insert-mime-security-button (handle &optional displayed)
8617   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8618          (gnus-tmp-type
8619           (concat
8620            (or (nth 2 (assoc protocol mm-verify-function-alist))
8621                (nth 2 (assoc protocol mm-decrypt-function-alist))
8622                "Unknown")
8623            (if (equal (car handle) "multipart/signed")
8624                " Signed" " Encrypted")
8625            " Part"))
8626          (gnus-tmp-info
8627           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8628               "Undecided"))
8629          (gnus-tmp-details
8630           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8631          gnus-tmp-pressed-details
8632          b e)
8633     (setq gnus-tmp-details
8634           (if gnus-tmp-details
8635               (concat "\n" gnus-tmp-details)
8636             ""))
8637     (setq gnus-tmp-pressed-details
8638           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8639     (unless (bolp)
8640       (insert "\n"))
8641     (setq b (point))
8642     (gnus-eval-format
8643      gnus-mime-security-button-line-format
8644      gnus-mime-security-button-line-format-alist
8645      `(keymap ,gnus-mime-security-button-map
8646          gnus-callback gnus-mime-security-press-button
8647          gnus-line-format ,gnus-mime-security-button-line-format
8648          gnus-mime-details ,gnus-mime-security-button-pressed
8649          article-type annotation
8650          gnus-data ,handle))
8651     (setq e (if (bolp)
8652                 ;; Exclude a newline.
8653                 (1- (point))
8654               (point)))
8655     (when gnus-article-button-face
8656       (gnus-overlay-put (gnus-make-overlay b e nil t)
8657                         'face gnus-article-button-face))
8658     (widget-convert-button
8659      'link b e
8660      :mime-handle handle
8661      :action 'gnus-widget-press-button
8662      :button-keymap gnus-mime-security-button-map
8663      :help-echo
8664      (lambda (widget/window &optional overlay pos)
8665        ;; Needed to properly clear the message due to a bug in
8666        ;; wid-edit (XEmacs only).
8667        (when (boundp 'help-echo-owns-message)
8668          (setq help-echo-owns-message t))
8669        (format
8670         "%S: show detail; %S: more options"
8671         (aref gnus-mouse-2 0)
8672         (aref gnus-down-mouse-3 0))))))
8673
8674 (defun gnus-mime-display-security (handle)
8675   (save-restriction
8676     (narrow-to-region (point) (point))
8677     (unless (gnus-unbuttonized-mime-type-p (car handle))
8678       (gnus-insert-mime-security-button handle))
8679     (gnus-mime-display-part (cadr handle))
8680     (unless (bolp)
8681       (insert "\n"))
8682     (unless (gnus-unbuttonized-mime-type-p (car handle))
8683       (let ((gnus-mime-security-button-line-format
8684              gnus-mime-security-button-end-line-format))
8685         (gnus-insert-mime-security-button handle)))
8686     (mm-set-handle-multipart-parameter
8687      handle 'gnus-region
8688      (cons (set-marker (make-marker) (point-min))
8689            (set-marker (make-marker) (point-max))))
8690     (goto-char (point-max))))
8691
8692 (defun gnus-mime-security-run-function (function)
8693   "Run FUNCTION with the security part under point."
8694   (gnus-article-check-buffer)
8695   (let ((data (get-text-property (point) 'gnus-data))
8696         buffer handle)
8697     (when (and (stringp (car-safe data))
8698                (setq buffer (mm-handle-multipart-original-buffer data))
8699                (setq handle (cadr data)))
8700       (if (bufferp (mm-handle-buffer handle))
8701           (progn
8702             (setq handle (cons buffer (copy-sequence (cdr handle))))
8703             (mm-handle-set-undisplayer handle nil))
8704         (setq handle (mm-make-handle
8705                       buffer
8706                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8707                       nil nil nil nil nil nil)))
8708       (funcall function handle))))
8709
8710 (defun gnus-mime-security-save-part ()
8711   "Save the security part under point."
8712   (interactive)
8713   (gnus-mime-security-run-function 'mm-save-part))
8714
8715 (defun gnus-mime-security-pipe-part ()
8716   "Pipe the security part under point to a process."
8717   (interactive)
8718   (gnus-mime-security-run-function 'mm-pipe-part))
8719
8720 (gnus-ems-redefine)
8721
8722 (provide 'gnus-art)
8723
8724 (run-hooks 'gnus-art-load-hook)
8725
8726 ;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
8727 ;;; gnus-art.el ends here