Merge from gnus--rel--5.10
[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 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, or (at your option)
14 ;; 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; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval-when-compile
31   (require 'cl)
32   (defvar tool-bar-map)
33   (defvar w3m-minor-mode-map))
34
35 (require 'gnus)
36 ;; Avoid the "Recursive load suspected" error in Emacs 21.1.
37 (eval-and-compile
38   (let ((recursive-load-depth-limit 100))
39     (require 'gnus-sum)))
40 (require 'gnus-spec)
41 (require 'gnus-int)
42 (require 'gnus-win)
43 (require 'mm-bodies)
44 (require 'mail-parse)
45 (require 'mm-decode)
46 (require 'mm-view)
47 (require 'wid-edit)
48 (require 'mm-uu)
49 (require 'message)
50
51 (autoload 'gnus-msg-mail "gnus-msg" nil t)
52 (autoload 'gnus-button-mailto "gnus-msg")
53 (autoload 'gnus-button-reply "gnus-msg" nil t)
54 (autoload 'parse-time-string "parse-time" nil nil)
55 (autoload 'ansi-color-apply-on-region "ansi-color")
56 (autoload 'mm-url-insert-file-contents-external "mm-url")
57 (autoload 'mm-extern-cache-contents "mm-extern")
58
59 (defgroup gnus-article nil
60   "Article display."
61   :link '(custom-manual "(gnus)Article Buffer")
62   :group 'gnus)
63
64 (defgroup gnus-article-treat nil
65   "Treating article parts."
66   :link '(custom-manual "(gnus)Article Hiding")
67   :group 'gnus-article)
68
69 (defgroup gnus-article-hiding nil
70   "Hiding article parts."
71   :link '(custom-manual "(gnus)Article Hiding")
72   :group 'gnus-article)
73
74 (defgroup gnus-article-highlight nil
75   "Article highlighting."
76   :link '(custom-manual "(gnus)Article Highlighting")
77   :group 'gnus-article
78   :group 'gnus-visual)
79
80 (defgroup gnus-article-signature nil
81   "Article signatures."
82   :link '(custom-manual "(gnus)Article Signature")
83   :group 'gnus-article)
84
85 (defgroup gnus-article-headers nil
86   "Article headers."
87   :link '(custom-manual "(gnus)Hiding Headers")
88   :group 'gnus-article)
89
90 (defgroup gnus-article-washing nil
91   "Special commands on articles."
92   :link '(custom-manual "(gnus)Article Washing")
93   :group 'gnus-article)
94
95 (defgroup gnus-article-emphasis nil
96   "Fontisizing articles."
97   :link '(custom-manual "(gnus)Article Fontisizing")
98   :group 'gnus-article)
99
100 (defgroup gnus-article-saving nil
101   "Saving articles."
102   :link '(custom-manual "(gnus)Saving Articles")
103   :group 'gnus-article)
104
105 (defgroup gnus-article-mime nil
106   "Worshiping the MIME wonder."
107   :link '(custom-manual "(gnus)Using MIME")
108   :group 'gnus-article)
109
110 (defgroup gnus-article-buttons nil
111   "Pushable buttons in the article buffer."
112   :link '(custom-manual "(gnus)Article Buttons")
113   :group 'gnus-article)
114
115 (defgroup gnus-article-various nil
116   "Other article options."
117   :link '(custom-manual "(gnus)Misc Article")
118   :group 'gnus-article)
119
120 (defcustom gnus-ignored-headers
121   (mapcar
122    (lambda (header)
123      (concat "^" header ":"))
124    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
125      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
126      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
127      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
128      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
129      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
130      "X-Attribution" "X-Originating-IP" "Delivered-To"
131      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
132      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
133      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
134      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
135      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
136      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
137      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
138      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
139      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
140      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
141      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
142      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
143      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
144      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
145      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
146      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
147      "List-[A-Za-z]+" "X-Listprocessor-Version"
148      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
149      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
150      "X-Received" "Content-length" "X-precedence"
151      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
152      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
153      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
154      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
155      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
156      "X-Content-length" "X-Posting-Agent" "Original-Received"
157      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
158      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
159      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
160      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
161      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
162      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
163      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
164      "Envelope-Sender" "Envelope-Recipients"))
165   "*All headers that start with this regexp will be hidden.
166 This variable can also be a list of regexps of headers to be ignored.
167 If `gnus-visible-headers' is non-nil, this variable will be ignored."
168   :type '(choice :custom-show nil
169                  regexp
170                  (repeat regexp))
171   :group 'gnus-article-hiding)
172
173 (defcustom gnus-visible-headers
174   "^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:"
175   "*All headers that do not match this regexp will be hidden.
176 This variable can also be a list of regexp of headers to remain visible.
177 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
178   :type '(repeat :value-to-internal (lambda (widget value)
179                                       (custom-split-regexp-maybe value))
180                  :match (lambda (widget value)
181                           (or (stringp value)
182                               (widget-editable-list-match widget value)))
183                  regexp)
184   :group 'gnus-article-hiding)
185
186 (defcustom gnus-sorted-header-list
187   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
188     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
189   "*This variable is a list of regular expressions.
190 If it is non-nil, headers that match the regular expressions will
191 be placed first in the article buffer in the sequence specified by
192 this list."
193   :type '(repeat regexp)
194   :group 'gnus-article-hiding)
195
196 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
197   "Headers that are only to be displayed if they have interesting data.
198 Possible values in this list are:
199
200   'empty       Headers with no content.
201   'newsgroups  Newsgroup identical to Gnus group.
202   'to-address  To identical to To-address.
203   'to-list     To identical to To-list.
204   'cc-list     CC identical to To-list.
205   'followup-to Followup-to identical to Newsgroups.
206   'reply-to    Reply-to identical to From.
207   'date        Date less than four days old.
208   'long-to     To and/or Cc longer than 1024 characters.
209   'many-to     Multiple To and/or Cc."
210   :type '(set (const :tag "Headers with no content." empty)
211               (const :tag "Newsgroups identical to Gnus group." newsgroups)
212               (const :tag "To identical to To-address." to-address)
213               (const :tag "To identical to To-list." to-list)
214               (const :tag "CC identical to To-list." cc-list)
215               (const :tag "Followup-to identical to Newsgroups." followup-to)
216               (const :tag "Reply-to identical to From." reply-to)
217               (const :tag "Date less than four days old." date)
218               (const :tag "To and/or Cc longer than 1024 characters." long-to)
219               (const :tag "Multiple To and/or Cc headers." many-to))
220   :group 'gnus-article-hiding)
221
222 (defcustom gnus-article-skip-boring nil
223   "Skip over text that is not worth reading.
224 By default, if you set this t, then Gnus will display citations and
225 signatures, but will never scroll down to show you a page consisting
226 only of boring text.  Boring text is controlled by
227 `gnus-article-boring-faces'."
228   :version "22.1"
229   :type 'boolean
230   :group 'gnus-article-hiding)
231
232 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
233   "Regexp matching signature separator.
234 This can also be a list of regexps.  In that case, it will be checked
235 from head to tail looking for a separator.  Searches will be done from
236 the end of the buffer."
237   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
238                  (regexp)
239                  (repeat :tag "List of regexp" regexp))
240   :group 'gnus-article-signature)
241
242 (defcustom gnus-signature-limit nil
243   "Provide a limit to what is considered a signature.
244 If it is a number, no signature may not be longer (in characters) than
245 that number.  If it is a floating point number, no signature may be
246 longer (in lines) than that number.  If it is a function, the function
247 will be called without any parameters, and if it returns nil, there is
248 no signature in the buffer.  If it is a string, it will be used as a
249 regexp.  If it matches, the text in question is not a signature.
250
251 This can also be a list of the above values."
252   :type '(choice (const nil)
253                  (integer :value 200)
254                  (number :value 4.0)
255                  function
256                  (regexp :value ".*"))
257   :group 'gnus-article-signature)
258
259 (defcustom gnus-hidden-properties '(invisible t intangible t)
260   "Property list to use for hiding text."
261   :type 'sexp
262   :group 'gnus-article-hiding)
263
264 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
265 ;; frames in a session.
266 (defcustom gnus-article-x-face-command
267   (if (featurep 'xemacs)
268       (if (or (gnus-image-type-available-p 'xface)
269               (gnus-image-type-available-p 'pbm))
270           'gnus-display-x-face-in-from
271         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
272     (if (gnus-image-type-available-p 'pbm)
273         'gnus-display-x-face-in-from
274       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
275 display -"))
276   "*String or function to be executed to display an X-Face header.
277 If it is a string, the command will be executed in a sub-shell
278 asynchronously.  The compressed face will be piped to this command."
279   :type `(choice string
280                  (function-item gnus-display-x-face-in-from)
281                  function)
282   :version "21.1"
283   :group 'gnus-picon
284   :group 'gnus-article-washing)
285
286 (defcustom gnus-article-x-face-too-ugly nil
287   "Regexp matching posters whose face shouldn't be shown automatically."
288   :type '(choice regexp (const nil))
289   :group 'gnus-article-washing)
290
291 (defcustom gnus-article-banner-alist nil
292   "Banner alist for stripping.
293 For example,
294      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
295   :version "21.1"
296   :type '(repeat (cons symbol regexp))
297   :group 'gnus-article-washing)
298
299 (gnus-define-group-parameter
300  banner
301  :variable-document
302  "Alist of regexps (to match group names) and banner."
303  :variable-group gnus-article-washing
304  :parameter-type
305  '(choice :tag "Banner"
306           :value nil
307           (const :tag "Remove signature" signature)
308           (symbol :tag "Item in `gnus-article-banner-alist'" none)
309           regexp
310           (const :tag "None" nil))
311  :parameter-document
312  "If non-nil, specify how to remove `banners' from articles.
313
314 Symbol `signature' means to remove signatures delimited by
315 `gnus-signature-separator'.  Any other symbol is used to look up a
316 regular expression to match the banner in `gnus-article-banner-alist'.
317 A string is used as a regular expression to match the banner
318 directly.")
319
320 (defcustom gnus-article-address-banner-alist nil
321   "Alist of mail addresses and banners.
322 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
323 to match a mail address in the From: header, BANNER is one of a symbol
324 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
325 If ADDRESS matches author's mail address, it will remove things like
326 advertisements.  For example:
327
328 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
329 "
330   :type '(repeat
331           (cons
332            (regexp :tag "Address")
333            (choice :tag "Banner" :value nil
334                    (const :tag "Remove signature" signature)
335                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
336                    regexp
337                    (const :tag "None" nil))))
338   :version "22.1"
339   :group 'gnus-article-washing)
340
341 (defmacro gnus-emphasis-custom-with-format (&rest body)
342   `(let ((format "\
343 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
344 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
345      ,@body))
346
347 (defun gnus-emphasis-custom-value-to-external (value)
348   (gnus-emphasis-custom-with-format
349    (if (consp (car value))
350        (list (format format (car (car value)) (cdr (car value)))
351              2
352              (if (nth 1 value) 2 3)
353              (nth 2 value))
354      value)))
355
356 (defun gnus-emphasis-custom-value-to-internal (value)
357   (gnus-emphasis-custom-with-format
358    (let ((regexp (concat "\\`"
359                          (format (regexp-quote format)
360                                  "\\([^()]+\\)" "\\([^()]+\\)")
361                          "\\'"))
362          pattern)
363      (if (string-match regexp (setq pattern (car value)))
364          (list (cons (match-string 1 pattern) (match-string 2 pattern))
365                (= (nth 2 value) 2)
366                (nth 3 value))
367        value))))
368
369 (defcustom gnus-emphasis-alist
370   (let ((types
371          '(("\\*" "\\*" bold nil 2)
372            ("_" "_" underline)
373            ("/" "/" italic)
374            ("_/" "/_" underline-italic)
375            ("_\\*" "\\*_" underline-bold)
376            ("\\*/" "/\\*" bold-italic)
377            ("_\\*/" "/\\*_" underline-bold-italic))))
378     (nconc
379      (gnus-emphasis-custom-with-format
380       (mapcar (lambda (spec)
381                 (list (format format (car spec) (cadr spec))
382                       (or (nth 3 spec) 2)
383                       (or (nth 4 spec) 3)
384                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
385               types))
386      '(;; I've never seen anyone use this strikethru convention whereas I've
387        ;; several times seen it triggered by normal text.  --Stef
388        ;; Miles suggests that this form is sometimes used but for italics,
389        ;; so maybe we should map it to `italic'.
390        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
391        ;; 2 3 gnus-emphasis-strikethru)
392        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
393         2 3 gnus-emphasis-underline))))
394   "*Alist that says how to fontify certain phrases.
395 Each item looks like this:
396
397   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
398
399 The first element is a regular expression to be matched.  The second
400 is a number that says what regular expression grouping used to find
401 the entire emphasized word.  The third is a number that says what
402 regexp grouping should be displayed and highlighted.  The fourth
403 is the face used for highlighting."
404   :type
405   '(repeat
406     (menu-choice
407      :format "%[Customizing Style%]\n%v"
408      :indent 2
409      (group :tag "Default"
410             :value ("" 0 0 default)
411             :value-create
412             (lambda (widget)
413               (let ((value (widget-get
414                             (cadr (widget-get (widget-get widget :parent)
415                                               :args))
416                             :value)))
417                 (if (not (eq (nth 2 value) 'default))
418                     (widget-put
419                      widget
420                      :value
421                      (gnus-emphasis-custom-value-to-external value))))
422               (widget-group-value-create widget))
423             regexp
424             (integer :format "Match group: %v")
425             (integer :format "Emphasize group: %v")
426             face)
427      (group :tag "Simple"
428             :value (("_" . "_") nil default)
429             (cons :format "%v"
430                   (regexp :format "Start regexp: %v")
431                   (regexp :format "End regexp: %v"))
432             (boolean :format "Show start and end patterns: %[%v%]\n"
433                      :on " On " :off " Off ")
434             face)))
435   :get (lambda (symbol)
436          (mapcar 'gnus-emphasis-custom-value-to-internal
437                  (default-value symbol)))
438   :set (lambda (symbol value)
439          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
440                                      value)))
441   :group 'gnus-article-emphasis)
442
443 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
444   "A regexp to describe whitespace which should not be emphasized.
445 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
446 The former avoids underlining of leading and trailing whitespace,
447 and the latter avoids underlining any whitespace at all."
448   :version "21.1"
449   :group 'gnus-article-emphasis
450   :type 'regexp)
451
452 (defface gnus-emphasis-bold '((t (:bold t)))
453   "Face used for displaying strong emphasized text (*word*)."
454   :group 'gnus-article-emphasis)
455
456 (defface gnus-emphasis-italic '((t (:italic t)))
457   "Face used for displaying italic emphasized text (/word/)."
458   :group 'gnus-article-emphasis)
459
460 (defface gnus-emphasis-underline '((t (:underline t)))
461   "Face used for displaying underlined emphasized text (_word_)."
462   :group 'gnus-article-emphasis)
463
464 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
465   "Face used for displaying underlined bold emphasized text (_*word*_)."
466   :group 'gnus-article-emphasis)
467
468 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
469   "Face used for displaying underlined italic emphasized text (_/word/_)."
470   :group 'gnus-article-emphasis)
471
472 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
473   "Face used for displaying bold italic emphasized text (/*word*/)."
474   :group 'gnus-article-emphasis)
475
476 (defface gnus-emphasis-underline-bold-italic
477   '((t (:bold t :italic t :underline t)))
478   "Face used for displaying underlined bold italic emphasized text.
479 Example: (_/*word*/_)."
480   :group 'gnus-article-emphasis)
481
482 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
483                                       '((t (:strikethru t)))
484                                     '((t (:strike-through t))))
485   "Face used for displaying strike-through text (-word-)."
486   :group 'gnus-article-emphasis)
487
488 (defface gnus-emphasis-highlight-words
489   '((t (:background "black" :foreground "yellow")))
490   "Face used for displaying highlighted words."
491   :group 'gnus-article-emphasis)
492
493 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
494   "Format for display of Date headers in article bodies.
495 See `format-time-string' for the possible values.
496
497 The variable can also be function, which should return a complete Date
498 header.  The function is called with one argument, the time, which can
499 be fed to `format-time-string'."
500   :type '(choice string function)
501   :link '(custom-manual "(gnus)Article Date")
502   :group 'gnus-article-washing)
503
504 (defcustom gnus-save-all-headers t
505   "*If non-nil, don't remove any headers before saving.
506 This will be overridden by the `:headers' property that the symbol of
507 the saver function, which is specified by `gnus-default-article-saver',
508 might have."
509   :group 'gnus-article-saving
510   :type 'boolean)
511
512 (defcustom gnus-prompt-before-saving 'always
513   "*This variable says how much prompting is to be done when saving articles.
514 If it is nil, no prompting will be done, and the articles will be
515 saved to the default files.  If this variable is `always', each and
516 every article that is saved will be preceded by a prompt, even when
517 saving large batches of articles.  If this variable is neither nil not
518 `always', there the user will be prompted once for a file name for
519 each invocation of the saving commands."
520   :group 'gnus-article-saving
521   :type '(choice (item always)
522                  (item :tag "never" nil)
523                  (sexp :tag "once" :format "%t\n" :value t)))
524
525 (defcustom gnus-saved-headers gnus-visible-headers
526   "Headers to keep if `gnus-save-all-headers' is nil.
527 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
528 If that variable is nil, however, all headers that match this regexp
529 will be kept while the rest will be deleted before saving.  This and
530 `gnus-save-all-headers' will be overridden by the `:headers' property
531 that the symbol of the saver function, which is specified by
532 `gnus-default-article-saver', might have."
533   :group 'gnus-article-saving
534   :type 'regexp)
535
536 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
537   "A function to save articles in your favourite format.
538 The function will be called by way of the `gnus-summary-save-article'
539 command, and friends such as `gnus-summary-save-article-rmail'.
540
541 Gnus provides the following functions:
542
543 * gnus-summary-save-in-rmail (Rmail format)
544 * gnus-summary-save-in-mail (Unix mail format)
545 * gnus-summary-save-in-folder (MH folder)
546 * gnus-summary-save-in-file (article format)
547 * gnus-summary-save-body-in-file (article body)
548 * gnus-summary-save-in-vm (use VM's folder format)
549 * gnus-summary-write-to-file (article format -- overwrite)
550 * gnus-summary-write-body-to-file (article body -- overwrite)
551
552 The symbol of each function may have the following properties:
553
554 * :decode
555 The value non-nil means save decoded articles.  This is meaningful
556 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
557 `gnus-summary-write-to-file', and `gnus-summary-write-body-to-file'.
558
559 * :function
560 The value specifies an alternative function which appends, not
561 overwrites, articles to a file.  This implies that when saving many
562 articles at a time, `gnus-prompt-before-saving' is bound to t and all
563 articles are saved in a single file.  This is meaningful only with
564 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
565
566 * :headers
567 The value specifies the symbol of a variable of which the value
568 specifies headers to be saved.  If it is omitted,
569 `gnus-save-all-headers' and `gnus-saved-headers' control what
570 headers should be saved."
571   :group 'gnus-article-saving
572   :type '(radio (function-item gnus-summary-save-in-rmail)
573                 (function-item gnus-summary-save-in-mail)
574                 (function-item gnus-summary-save-in-folder)
575                 (function-item gnus-summary-save-in-file)
576                 (function-item gnus-summary-save-body-in-file)
577                 (function-item gnus-summary-save-in-vm)
578                 (function-item gnus-summary-write-to-file)
579                 (function-item gnus-summary-write-body-to-file)
580                 (function)))
581
582 (defcustom gnus-article-save-coding-system
583   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
584       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
585       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
586       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
587   "Coding system used to save decoded articles to a file.
588
589 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
590 which can safely encode any characters in text.  This is used by the
591 commands including:
592
593 * gnus-summary-save-article-file
594 * gnus-summary-save-article-body-file
595 * gnus-summary-write-article-file
596 * gnus-summary-write-article-body-file
597
598 and the functions to which you may set `gnus-default-article-saver':
599
600 * gnus-summary-save-in-file
601 * gnus-summary-save-body-in-file
602 * gnus-summary-write-to-file
603 * gnus-summary-write-body-to-file
604
605 Those commands and functions save just text displayed in the article
606 buffer to a file if the value of this variable is non-nil.  Note that
607 buttonized MIME parts will be lost in a saved file in that case.
608 Otherwise, raw articles will be saved."
609   :group 'gnus-article-saving
610   :type `(choice
611           :format "%{%t%}:\n %[Value Menu%] %v"
612           (const :tag "Save raw articles" nil)
613           ,@(delq nil
614                   (mapcar
615                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
616                    '((const :tag "UTF-8" utf-8)
617                      (const :tag "iso-2022-7bit" iso-2022-7bit)
618                      (const :tag "Emacs internal" emacs-mule)
619                      (const :tag "escape-quoted" escape-quoted))))
620           (symbol :tag "Coding system")))
621
622 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
623   "A function generating a file name to save articles in Rmail format.
624 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
625   :group 'gnus-article-saving
626   :type 'function)
627
628 (defcustom gnus-mail-save-name 'gnus-plain-save-name
629   "A function generating a file name to save articles in Unix mail format.
630 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
631   :group 'gnus-article-saving
632   :type 'function)
633
634 (defcustom gnus-folder-save-name 'gnus-folder-save-name
635   "A function generating a file name to save articles in MH folder.
636 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
637   :group 'gnus-article-saving
638   :type 'function)
639
640 (defcustom gnus-file-save-name 'gnus-numeric-save-name
641   "A function generating a file name to save articles in article format.
642 The function is called with NEWSGROUP, HEADERS, and optional
643 LAST-FILE."
644   :group 'gnus-article-saving
645   :type 'function)
646
647 (defcustom gnus-split-methods
648   '((gnus-article-archive-name)
649     (gnus-article-nndoc-name))
650   "*Variable used to suggest where articles are to be saved.
651 For instance, if you would like to save articles related to Gnus in
652 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
653 you could set this variable to something like:
654
655  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
656    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
657
658 This variable is an alist where the key is the match and the
659 value is a list of possible files to save in if the match is
660 non-nil.
661
662 If the match is a string, it is used as a regexp match on the
663 article.  If the match is a symbol, that symbol will be funcalled
664 from the buffer of the article to be saved with the newsgroup as the
665 parameter.  If it is a list, it will be evaled in the same buffer.
666
667 If this form or function returns a string, this string will be used as a
668 possible file name; and if it returns a non-nil list, that list will be
669 used as possible file names."
670   :group 'gnus-article-saving
671   :type '(repeat (choice (list :value (fun) function)
672                          (cons :value ("" "") regexp (repeat string))
673                          (sexp :value nil))))
674
675 (defcustom gnus-page-delimiter "^\^L"
676   "*Regexp describing what to use as article page delimiters.
677 The default value is \"^\^L\", which is a form linefeed at the
678 beginning of a line."
679   :type 'regexp
680   :group 'gnus-article-various)
681
682 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
683   "*The format specification for the article mode line.
684 See `gnus-summary-mode-line-format' for a closer description.
685
686 The following additional specs are available:
687
688 %w  The article washing status.
689 %m  The number of MIME parts in the article."
690   :type 'string
691   :group 'gnus-article-various)
692
693 (defcustom gnus-article-mode-hook nil
694   "*A hook for Gnus article mode."
695   :type 'hook
696   :group 'gnus-article-various)
697
698 (when (featurep 'xemacs)
699   ;; Extracted from gnus-xmas-define in order to preserve user settings
700   (when (fboundp 'turn-off-scroll-in-place)
701     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
702   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
703   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
704
705 (defcustom gnus-article-menu-hook nil
706   "*Hook run after the creation of the article mode menu."
707   :type 'hook
708   :group 'gnus-article-various)
709
710 (defcustom gnus-article-prepare-hook nil
711   "*A hook called after an article has been prepared in the article buffer."
712   :type 'hook
713   :group 'gnus-article-various)
714
715 (defcustom gnus-copy-article-ignored-headers nil
716   "List of headers to be removed when copying an article.
717 Each element is a regular expression."
718   :version "23.0" ;; No Gnus
719   :type '(repeat regexp)
720   :group 'gnus-article-various)
721
722 (make-obsolete-variable 'gnus-article-hide-pgp-hook
723                         "This variable is obsolete in Gnus 5.10.")
724
725 (defface gnus-button
726   '((t (:weight bold)))
727   "Face used for highlighting a button in the article buffer."
728   :group 'gnus-article-buttons)
729
730 (defcustom gnus-article-button-face 'gnus-button
731   "Face used for highlighting buttons in the article buffer.
732
733 An article button is a piece of text that you can activate by pressing
734 `RET' or `mouse-2' above it."
735   :type 'face
736   :group 'gnus-article-buttons)
737
738 (defcustom gnus-article-mouse-face 'highlight
739   "Face used for mouse highlighting in the article buffer.
740
741 Article buttons will be displayed in this face when the cursor is
742 above them."
743   :type 'face
744   :group 'gnus-article-buttons)
745
746 (defcustom gnus-signature-face 'gnus-signature
747   "Face used for highlighting a signature in the article buffer.
748 Obsolete; use the face `gnus-signature' for customizations instead."
749   :type 'face
750   :group 'gnus-article-highlight
751   :group 'gnus-article-signature)
752
753 (defface gnus-signature
754   '((t
755      (:italic t)))
756   "Face used for highlighting a signature in the article buffer."
757   :group 'gnus-article-highlight
758   :group 'gnus-article-signature)
759 ;; backward-compatibility alias
760 (put 'gnus-signature-face 'face-alias 'gnus-signature)
761
762 (defface gnus-header-from
763   '((((class color)
764       (background dark))
765      (:foreground "PaleGreen1"))
766     (((class color)
767       (background light))
768      (:foreground "red3"))
769     (t
770      (:italic t)))
771   "Face used for displaying from headers."
772   :group 'gnus-article-headers
773   :group 'gnus-article-highlight)
774 ;; backward-compatibility alias
775 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
776
777 (defface gnus-header-subject
778   '((((class color)
779       (background dark))
780      (:foreground "SeaGreen1"))
781     (((class color)
782       (background light))
783      (:foreground "red4"))
784     (t
785      (:bold t :italic t)))
786   "Face used for displaying subject headers."
787   :group 'gnus-article-headers
788   :group 'gnus-article-highlight)
789 ;; backward-compatibility alias
790 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
791
792 (defface gnus-header-newsgroups
793   '((((class color)
794       (background dark))
795      (:foreground "yellow" :italic t))
796     (((class color)
797       (background light))
798      (:foreground "MidnightBlue" :italic t))
799     (t
800      (:italic t)))
801   "Face used for displaying newsgroups headers.
802 In the default setup this face is only used for crossposted
803 articles."
804   :group 'gnus-article-headers
805   :group 'gnus-article-highlight)
806 ;; backward-compatibility alias
807 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
808
809 (defface gnus-header-name
810   '((((class color)
811       (background dark))
812      (:foreground "SpringGreen2"))
813     (((class color)
814       (background light))
815      (:foreground "maroon"))
816     (t
817      (:bold t)))
818   "Face used for displaying header names."
819   :group 'gnus-article-headers
820   :group 'gnus-article-highlight)
821 ;; backward-compatibility alias
822 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
823
824 (defface gnus-header-content
825   '((((class color)
826       (background dark))
827      (:foreground "SpringGreen1" :italic t))
828     (((class color)
829       (background light))
830      (:foreground "indianred4" :italic t))
831     (t
832      (:italic t)))  "Face used for displaying header content."
833   :group 'gnus-article-headers
834   :group 'gnus-article-highlight)
835 ;; backward-compatibility alias
836 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
837
838 (defcustom gnus-header-face-alist
839   '(("From" nil gnus-header-from)
840     ("Subject" nil gnus-header-subject)
841     ("Newsgroups:.*," nil gnus-header-newsgroups)
842     ("" gnus-header-name gnus-header-content))
843   "*Controls highlighting of article headers.
844
845 An alist of the form (HEADER NAME CONTENT).
846
847 HEADER is a regular expression which should match the name of a
848 header and NAME and CONTENT are either face names or nil.
849
850 The name of each header field will be displayed using the face
851 specified by the first element in the list where HEADER matches
852 the header name and NAME is non-nil.  Similarly, the content will
853 be displayed by the first non-nil matching CONTENT face."
854   :group 'gnus-article-headers
855   :group 'gnus-article-highlight
856   :type '(repeat (list (regexp :tag "Header")
857                        (choice :tag "Name"
858                                (item :tag "skip" nil)
859                                (face :value default))
860                        (choice :tag "Content"
861                                (item :tag "skip" nil)
862                                (face :value default)))))
863
864 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
865                                           '((xface . (:face gnus-x-face)))
866                                         '((pbm . (:face gnus-x-face))
867                                           (png . nil)))
868   "Alist of image types and properties applied to Face and X-Face images.
869 Here are examples:
870
871 ;; Specify the altitude of Face images in the From header.
872 \(setq gnus-face-properties-alist
873       '((pbm . (:face gnus-x-face :ascent 80))
874         (png . (:ascent 80))))
875
876 ;; Show Face images as pressed buttons.
877 \(setq gnus-face-properties-alist
878       '((pbm . (:face gnus-x-face :relief -2))
879         (png . (:relief -2))))
880
881 See the manual for the valid properties for various image types.
882 Currently, `pbm' is used for X-Face images and `png' is used for Face
883 images in Emacs.  Only the `:face' property is effective on the `xface'
884 image type in XEmacs if it is built with the libcompface library."
885   :version "23.0" ;; No Gnus
886   :group 'gnus-article-headers
887   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
888
889 (defcustom gnus-article-decode-hook
890   '(article-decode-charset article-decode-encoded-words
891                            article-decode-group-name article-decode-idna-rhs)
892   "*Hook run to decode charsets in articles."
893   :group 'gnus-article-headers
894   :type 'hook)
895
896 (defcustom gnus-display-mime-function 'gnus-display-mime
897   "Function to display MIME articles."
898   :group 'gnus-article-mime
899   :type 'function)
900
901 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
902   "Function used to decode headers.")
903
904 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
905   "Function used to decode addresses.")
906
907 (defvar gnus-article-dumbquotes-map
908   '(("\200" "EUR")
909     ("\202" ",")
910     ("\203" "f")
911     ("\204" ",,")
912     ("\205" "...")
913     ("\213" "<")
914     ("\214" "OE")
915     ("\221" "`")
916     ("\222" "'")
917     ("\223" "``")
918     ("\224" "\"")
919     ("\225" "*")
920     ("\226" "-")
921     ("\227" "--")
922     ("\230" "~")
923     ("\231" "(TM)")
924     ("\233" ">")
925     ("\234" "oe")
926     ("\264" "'"))
927   "Table for MS-to-Latin1 translation.")
928
929 (defcustom gnus-ignored-mime-types nil
930   "List of MIME types that should be ignored by Gnus."
931   :version "21.1"
932   :group 'gnus-article-mime
933   :type '(repeat regexp))
934
935 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
936   "List of MIME types that should not be given buttons when rendered inline.
937 See also `gnus-buttonized-mime-types' which may override this variable.
938 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
939   :version "21.1"
940   :group 'gnus-article-mime
941   :type '(repeat regexp))
942
943 (defcustom gnus-buttonized-mime-types nil
944   "List of MIME types that should be given buttons when rendered inline.
945 If set, this variable overrides `gnus-unbuttonized-mime-types'.
946 To see e.g. security buttons you could set this to
947 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
948 this list to display radio buttons that allow you to choose one of two
949 media types those mails include.  See also `mm-discouraged-alternatives'.
950 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
951   :version "22.1"
952   :group 'gnus-article-mime
953   :type '(repeat regexp))
954
955 (defcustom gnus-inhibit-mime-unbuttonizing nil
956   "If non-nil, all MIME parts get buttons.
957 When nil (the default value), then some MIME parts do not get buttons,
958 as described by the variables `gnus-buttonized-mime-types' and
959 `gnus-unbuttonized-mime-types'."
960   :version "22.1"
961   :group 'gnus-article-mime
962   :type 'boolean)
963
964 (defcustom gnus-body-boundary-delimiter "_"
965   "String used to delimit header and body.
966 This variable is used by `gnus-article-treat-body-boundary' which can
967 be controlled by `gnus-treat-body-boundary'."
968   :version "22.1"
969   :group 'gnus-article-various
970   :type '(choice (item :tag "None" :value nil)
971                  string))
972
973 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
974                                   "/usr/share/picons")
975   "Defines the location of the faces database.
976 For information on obtaining this database of pretty pictures, please
977 see http://www.cs.indiana.edu/picons/ftp/index.html"
978   :version "22.1"
979   :type '(repeat directory)
980   :link '(url-link :tag "download"
981                    "http://www.cs.indiana.edu/picons/ftp/index.html")
982   :link '(custom-manual "(gnus)Picons")
983   :group 'gnus-picon)
984
985 (defun gnus-picons-installed-p ()
986   "Say whether picons are installed on your machine."
987   (let ((installed nil))
988     (dolist (database gnus-picon-databases)
989       (when (file-exists-p database)
990         (setq installed t)))
991     installed))
992
993 (defcustom gnus-article-mime-part-function nil
994   "Function called with a MIME handle as the argument.
995 This is meant for people who want to do something automatic based
996 on parts -- for instance, adding Vcard info to a database."
997   :group 'gnus-article-mime
998   :type '(choice (const nil)
999                  function))
1000
1001 (defcustom gnus-mime-multipart-functions nil
1002   "An alist of MIME types to functions to display them."
1003   :version "21.1"
1004   :group 'gnus-article-mime
1005   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1006
1007 (defcustom gnus-article-date-lapsed-new-header nil
1008   "Whether the X-Sent and Date headers can coexist.
1009 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
1010 either replace the old \"Date:\" header (if this variable is nil), or
1011 be added below it (otherwise)."
1012   :version "21.1"
1013   :group 'gnus-article-headers
1014   :type 'boolean)
1015
1016 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1017   "Function called with a MIME handle as the argument.
1018 This is meant for people who want to view first matched part.
1019 For `undisplayed-alternative' (default), the first undisplayed
1020 part or alternative part is used.  For `undisplayed', the first
1021 undisplayed part is used.  For a function, the first part which
1022 the function return t is used.  For nil, the first part is
1023 used."
1024   :version "21.1"
1025   :group 'gnus-article-mime
1026   :type '(choice
1027           (item :tag "first" :value nil)
1028           (item :tag "undisplayed" :value undisplayed)
1029           (item :tag "undisplayed or alternative"
1030                 :value undisplayed-alternative)
1031           (function)))
1032
1033 (defcustom gnus-mime-action-alist
1034   '(("save to file" . gnus-mime-save-part)
1035     ("save and strip" . gnus-mime-save-part-and-strip)
1036     ("replace with file" . gnus-mime-replace-part)
1037     ("delete part" . gnus-mime-delete-part)
1038     ("display as text" . gnus-mime-inline-part)
1039     ("view the part" . gnus-mime-view-part)
1040     ("pipe to command" . gnus-mime-pipe-part)
1041     ("toggle display" . gnus-article-press-button)
1042     ("toggle display" . gnus-article-view-part-as-charset)
1043     ("view as type" . gnus-mime-view-part-as-type)
1044     ("view internally" . gnus-mime-view-part-internally)
1045     ("view externally" . gnus-mime-view-part-externally))
1046   "An alist of actions that run on the MIME attachment."
1047   :group 'gnus-article-mime
1048   :type '(repeat (cons (string :tag "name")
1049                        (function))))
1050
1051 (defcustom gnus-auto-select-part 1
1052   "Advance to next MIME part when deleting or stripping parts.
1053
1054 When 0, point will be placed on the same part as before.  When
1055 positive (negative), move point forward (backwards) this many
1056 parts.  When nil, redisplay article."
1057   :version "23.0" ;; No Gnus
1058   :group 'gnus-article-mime
1059   :type '(choice (const nil :tag "Redisplay article.")
1060                  (const 1 :tag "Next part.")
1061                  (const 0 :tag "Current part.")
1062                  integer))
1063
1064 ;;;
1065 ;;; The treatment variables
1066 ;;;
1067
1068 (defvar gnus-part-display-hook nil
1069   "Hook called on parts that are to receive treatment.")
1070
1071 (defvar gnus-article-treat-custom
1072   '(choice (const :tag "Off" nil)
1073            (const :tag "On" t)
1074            (const :tag "Header" head)
1075            (const :tag "First" first)
1076            (const :tag "Last" last)
1077            (integer :tag "Less")
1078            (repeat :tag "Groups" regexp)
1079            (sexp :tag "Predicate")))
1080
1081 (defvar gnus-article-treat-head-custom
1082   '(choice (const :tag "Off" nil)
1083            (const :tag "Header" head)))
1084
1085 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1086                                    "text/x-patch")
1087   "Parts to treat.")
1088
1089 (defvar gnus-inhibit-treatment nil
1090   "Whether to inhibit treatment.")
1091
1092 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1093   "Highlight the signature.
1094 Valid values are nil, t, `head', `first', `last', an integer or a
1095 predicate.  See Info node `(gnus)Customizing Articles'."
1096   :group 'gnus-article-treat
1097   :link '(custom-manual "(gnus)Customizing Articles")
1098   :type gnus-article-treat-custom)
1099 (put 'gnus-treat-highlight-signature 'highlight t)
1100
1101 (defcustom gnus-treat-buttonize 100000
1102   "Add buttons.
1103 Valid values are nil, t, `head', `first', `last', an integer or a
1104 predicate.  See Info node `(gnus)Customizing Articles'."
1105   :group 'gnus-article-treat
1106   :link '(custom-manual "(gnus)Customizing Articles")
1107   :type gnus-article-treat-custom)
1108 (put 'gnus-treat-buttonize 'highlight t)
1109
1110 (defcustom gnus-treat-buttonize-head 'head
1111   "Add buttons to the head.
1112 Valid values are nil, t, `head', `first', `last', an integer or a
1113 predicate.  See Info node `(gnus)Customizing Articles'."
1114   :group 'gnus-article-treat
1115   :link '(custom-manual "(gnus)Customizing Articles")
1116   :type gnus-article-treat-head-custom)
1117 (put 'gnus-treat-buttonize-head 'highlight t)
1118
1119 (defcustom gnus-treat-emphasize 50000
1120   "Emphasize text.
1121 Valid values are nil, t, `head', `first', `last', an integer or a
1122 predicate.  See Info node `(gnus)Customizing Articles'."
1123   :group 'gnus-article-treat
1124   :link '(custom-manual "(gnus)Customizing Articles")
1125   :type gnus-article-treat-custom)
1126 (put 'gnus-treat-emphasize 'highlight t)
1127
1128 (defcustom gnus-treat-strip-cr nil
1129   "Remove carriage returns.
1130 Valid values are nil, t, `head', `first', `last', an integer or a
1131 predicate.  See Info node `(gnus)Customizing Articles'."
1132   :version "22.1"
1133   :group 'gnus-article-treat
1134   :link '(custom-manual "(gnus)Customizing Articles")
1135   :type gnus-article-treat-custom)
1136
1137 (defcustom gnus-treat-unsplit-urls nil
1138   "Remove newlines from within URLs.
1139 Valid values are nil, t, `head', `first', `last', an integer or a
1140 predicate.  See Info node `(gnus)Customizing Articles'."
1141   :version "22.1"
1142   :group 'gnus-article-treat
1143   :link '(custom-manual "(gnus)Customizing Articles")
1144   :type gnus-article-treat-custom)
1145
1146 (defcustom gnus-treat-leading-whitespace nil
1147   "Remove leading whitespace in headers.
1148 Valid values are nil, t, `head', `first', `last', an integer or a
1149 predicate.  See Info node `(gnus)Customizing Articles'."
1150   :version "22.1"
1151   :group 'gnus-article-treat
1152   :link '(custom-manual "(gnus)Customizing Articles")
1153   :type gnus-article-treat-custom)
1154
1155 (defcustom gnus-treat-hide-headers 'head
1156   "Hide headers.
1157 Valid values are nil, t, `head', `first', `last', an integer or a
1158 predicate.  See Info node `(gnus)Customizing Articles'."
1159   :group 'gnus-article-treat
1160   :link '(custom-manual "(gnus)Customizing Articles")
1161   :type gnus-article-treat-head-custom)
1162
1163 (defcustom gnus-treat-hide-boring-headers nil
1164   "Hide boring headers.
1165 Valid values are nil, t, `head', `first', `last', an integer or a
1166 predicate.  See Info node `(gnus)Customizing Articles'."
1167   :group 'gnus-article-treat
1168   :link '(custom-manual "(gnus)Customizing Articles")
1169   :type gnus-article-treat-head-custom)
1170
1171 (defcustom gnus-treat-hide-signature nil
1172   "Hide the signature.
1173 Valid values are nil, t, `head', `first', `last', an integer or a
1174 predicate.  See Info node `(gnus)Customizing Articles'."
1175   :group 'gnus-article-treat
1176   :link '(custom-manual "(gnus)Customizing Articles")
1177   :type gnus-article-treat-custom)
1178
1179 (defcustom gnus-treat-fill-article nil
1180   "Fill the article.
1181 Valid values are nil, t, `head', `first', `last', an integer or a
1182 predicate.  See Info node `(gnus)Customizing Articles'."
1183   :group 'gnus-article-treat
1184   :link '(custom-manual "(gnus)Customizing Articles")
1185   :type gnus-article-treat-custom)
1186
1187 (defcustom gnus-treat-hide-citation nil
1188   "Hide cited text.
1189 Valid values are nil, t, `head', `first', `last', an integer or a
1190 predicate.  See Info node `(gnus)Customizing Articles'."
1191   :group 'gnus-article-treat
1192   :link '(custom-manual "(gnus)Customizing Articles")
1193   :type gnus-article-treat-custom)
1194
1195 (defcustom gnus-treat-hide-citation-maybe nil
1196   "Hide cited text.
1197 Valid values are nil, t, `head', `first', `last', an integer or a
1198 predicate.  See Info node `(gnus)Customizing Articles'."
1199   :group 'gnus-article-treat
1200   :link '(custom-manual "(gnus)Customizing Articles")
1201   :type gnus-article-treat-custom)
1202
1203 (defcustom gnus-treat-strip-list-identifiers 'head
1204   "Strip list identifiers from `gnus-list-identifiers`.
1205 Valid values are nil, t, `head', `first', `last', an integer or a
1206 predicate.  See Info node `(gnus)Customizing Articles'."
1207   :version "21.1"
1208   :group 'gnus-article-treat
1209   :link '(custom-manual "(gnus)Customizing Articles")
1210   :type gnus-article-treat-custom)
1211
1212 (make-obsolete-variable 'gnus-treat-strip-pgp
1213                         "This option is obsolete in Gnus 5.10.")
1214
1215 (defcustom gnus-treat-strip-pem nil
1216   "Strip PEM signatures.
1217 Valid values are nil, t, `head', `first', `last', an integer or a
1218 predicate.  See Info node `(gnus)Customizing Articles'."
1219   :group 'gnus-article-treat
1220   :link '(custom-manual "(gnus)Customizing Articles")
1221   :type gnus-article-treat-custom)
1222
1223 (defcustom gnus-treat-strip-banner t
1224   "Strip banners from articles.
1225 The banner to be stripped is specified in the `banner' group parameter.
1226 Valid values are nil, t, `head', `first', `last', an integer or a
1227 predicate.  See Info node `(gnus)Customizing Articles'."
1228   :group 'gnus-article-treat
1229   :link '(custom-manual "(gnus)Customizing Articles")
1230   :type gnus-article-treat-custom)
1231
1232 (defcustom gnus-treat-highlight-headers 'head
1233   "Highlight the headers.
1234 Valid values are nil, t, `head', `first', `last', an integer or a
1235 predicate.  See Info node `(gnus)Customizing Articles'."
1236   :group 'gnus-article-treat
1237   :link '(custom-manual "(gnus)Customizing Articles")
1238   :type gnus-article-treat-head-custom)
1239 (put 'gnus-treat-highlight-headers 'highlight t)
1240
1241 (defcustom gnus-treat-highlight-citation t
1242   "Highlight cited text.
1243 Valid values are nil, t, `head', `first', `last', an integer or a
1244 predicate.  See Info node `(gnus)Customizing Articles'."
1245   :group 'gnus-article-treat
1246   :link '(custom-manual "(gnus)Customizing Articles")
1247   :type gnus-article-treat-custom)
1248 (put 'gnus-treat-highlight-citation 'highlight t)
1249
1250 (defcustom gnus-treat-date-ut nil
1251   "Display the Date in UT (GMT).
1252 Valid values are nil, t, `head', `first', `last', an integer or a
1253 predicate.  See Info node `(gnus)Customizing Articles'."
1254   :group 'gnus-article-treat
1255   :link '(custom-manual "(gnus)Customizing Articles")
1256   :type gnus-article-treat-head-custom)
1257
1258 (defcustom gnus-treat-date-local nil
1259   "Display the Date in the local timezone.
1260 Valid values are nil, t, `head', `first', `last', an integer or a
1261 predicate.  See Info node `(gnus)Customizing Articles'."
1262   :group 'gnus-article-treat
1263   :link '(custom-manual "(gnus)Customizing Articles")
1264   :type gnus-article-treat-head-custom)
1265
1266 (defcustom gnus-treat-date-english nil
1267   "Display the Date in a format that can be read aloud in English.
1268 Valid values are nil, t, `head', `first', `last', an integer or a
1269 predicate.  See Info node `(gnus)Customizing Articles'."
1270   :version "22.1"
1271   :group 'gnus-article-treat
1272   :link '(custom-manual "(gnus)Customizing Articles")
1273   :type gnus-article-treat-head-custom)
1274
1275 (defcustom gnus-treat-date-lapsed nil
1276   "Display the Date header in a way that says how much time has elapsed.
1277 Valid values are nil, t, `head', `first', `last', an integer or a
1278 predicate.  See Info node `(gnus)Customizing Articles'."
1279   :group 'gnus-article-treat
1280   :link '(custom-manual "(gnus)Customizing Articles")
1281   :type gnus-article-treat-head-custom)
1282
1283 (defcustom gnus-treat-date-original nil
1284   "Display the date in the original timezone.
1285 Valid values are nil, t, `head', `first', `last', an integer or a
1286 predicate.  See Info node `(gnus)Customizing Articles'."
1287   :group 'gnus-article-treat
1288   :link '(custom-manual "(gnus)Customizing Articles")
1289   :type gnus-article-treat-head-custom)
1290
1291 (defcustom gnus-treat-date-iso8601 nil
1292   "Display the date in the ISO8601 format.
1293 Valid values are nil, t, `head', `first', `last', an integer or a
1294 predicate.  See Info node `(gnus)Customizing Articles'."
1295   :version "21.1"
1296   :group 'gnus-article-treat
1297   :link '(custom-manual "(gnus)Customizing Articles")
1298   :type gnus-article-treat-head-custom)
1299
1300 (defcustom gnus-treat-date-user-defined nil
1301   "Display the date in a user-defined format.
1302 The format is defined by the `gnus-article-time-format' variable.
1303 Valid values are nil, t, `head', `first', `last', an integer or a
1304 predicate.  See Info node `(gnus)Customizing Articles'."
1305   :group 'gnus-article-treat
1306   :link '(custom-manual "(gnus)Customizing Articles")
1307   :type gnus-article-treat-head-custom)
1308
1309 (defcustom gnus-treat-strip-headers-in-body t
1310   "Strip the X-No-Archive header line from the beginning of the body.
1311 Valid values are nil, t, `head', `first', `last', an integer or a
1312 predicate.  See Info node `(gnus)Customizing Articles'."
1313   :version "21.1"
1314   :group 'gnus-article-treat
1315   :link '(custom-manual "(gnus)Customizing Articles")
1316   :type gnus-article-treat-custom)
1317
1318 (defcustom gnus-treat-strip-trailing-blank-lines nil
1319   "Strip trailing blank lines.
1320 Valid values are nil, t, `head', `first', `last', an integer or a
1321 predicate.  See Info node `(gnus)Customizing Articles'.
1322
1323 When set to t, it also strips trailing blanks in all MIME parts.
1324 Consider to use `last' instead."
1325   :group 'gnus-article-treat
1326   :link '(custom-manual "(gnus)Customizing Articles")
1327   :type gnus-article-treat-custom)
1328
1329 (defcustom gnus-treat-strip-leading-blank-lines nil
1330   "Strip leading blank lines.
1331 Valid values are nil, t, `head', `first', `last', an integer or a
1332 predicate.  See Info node `(gnus)Customizing Articles'.
1333
1334 When set to t, it also strips trailing blanks in all MIME parts."
1335   :group 'gnus-article-treat
1336   :link '(custom-manual "(gnus)Customizing Articles")
1337   :type gnus-article-treat-custom)
1338
1339 (defcustom gnus-treat-strip-multiple-blank-lines nil
1340   "Strip multiple blank lines.
1341 Valid values are nil, t, `head', `first', `last', an integer or a
1342 predicate.  See Info node `(gnus)Customizing Articles'."
1343   :group 'gnus-article-treat
1344   :link '(custom-manual "(gnus)Customizing Articles")
1345   :type gnus-article-treat-custom)
1346
1347 (defcustom gnus-treat-unfold-headers 'head
1348   "Unfold folded header lines.
1349 Valid values are nil, t, `head', `first', `last', an integer or a
1350 predicate.  See Info node `(gnus)Customizing Articles'."
1351   :version "22.1"
1352   :group 'gnus-article-treat
1353   :link '(custom-manual "(gnus)Customizing Articles")
1354   :type gnus-article-treat-custom)
1355
1356 (defcustom gnus-article-unfold-long-headers nil
1357   "If non-nil, allow unfolding headers even if the header is long.
1358 If it is a regexp, only long headers matching this regexp are unfolded.
1359 If it is t, all long headers are unfolded.
1360
1361 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1362   :version "23.0" ;; No Gnus
1363   :group 'gnus-article-treat
1364   :type '(choice (const nil)
1365                  (const :tag "all" t)
1366                  (regexp)))
1367
1368 (defcustom gnus-treat-fold-headers nil
1369   "Fold headers.
1370 Valid values are nil, t, `head', `first', `last', an integer or a
1371 predicate.  See Info node `(gnus)Customizing Articles'."
1372   :version "22.1"
1373   :group 'gnus-article-treat
1374   :link '(custom-manual "(gnus)Customizing Articles")
1375   :type gnus-article-treat-custom)
1376
1377 (defcustom gnus-treat-fold-newsgroups 'head
1378   "Fold the Newsgroups and Followup-To headers.
1379 Valid values are nil, t, `head', `first', `last', an integer or a
1380 predicate.  See Info node `(gnus)Customizing Articles'."
1381   :version "22.1"
1382   :group 'gnus-article-treat
1383   :link '(custom-manual "(gnus)Customizing Articles")
1384   :type gnus-article-treat-custom)
1385
1386 (defcustom gnus-treat-overstrike t
1387   "Treat overstrike highlighting.
1388 Valid values are nil, t, `head', `first', `last', an integer or a
1389 predicate.  See Info node `(gnus)Customizing Articles'."
1390   :group 'gnus-article-treat
1391   :link '(custom-manual "(gnus)Customizing Articles")
1392   :type gnus-article-treat-custom)
1393 (put 'gnus-treat-overstrike 'highlight t)
1394
1395 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1396   "Treat ANSI SGR control sequences.
1397 Valid values are nil, t, `head', `first', `last', an integer or a
1398 predicate.  See Info node `(gnus)Customizing Articles'."
1399   :group 'gnus-article-treat
1400   :link '(custom-manual "(gnus)Customizing Articles")
1401   :type gnus-article-treat-custom)
1402
1403 (make-obsolete-variable 'gnus-treat-display-xface
1404                         'gnus-treat-display-x-face)
1405
1406 (defcustom gnus-treat-display-x-face
1407   (and (not noninteractive)
1408        (gnus-image-type-available-p 'xbm)
1409        (if (featurep 'xemacs)
1410            (featurep 'xface)
1411          (and (string-match "^0x" (shell-command-to-string "uncompface"))
1412               (executable-find "icontopbm")))
1413        'head)
1414   "Display X-Face headers.
1415 Valid values are nil and `head'.
1416 See Info node `(gnus)Customizing Articles' and Info node
1417 `(gnus)X-Face' for details."
1418   :group 'gnus-article-treat
1419   :version "21.1"
1420   :link '(custom-manual "(gnus)Customizing Articles")
1421   :link '(custom-manual "(gnus)X-Face")
1422   :type gnus-article-treat-head-custom
1423   :set (lambda (symbol value)
1424          (set-default
1425           symbol
1426           (cond ((or (boundp symbol) (get symbol 'saved-value))
1427                  value)
1428                 ((boundp 'gnus-treat-display-xface)
1429                  (message "\
1430 ** gnus-treat-display-xface is an obsolete variable;\
1431  use gnus-treat-display-x-face instead")
1432                  (default-value 'gnus-treat-display-xface))
1433                 ((get 'gnus-treat-display-xface 'saved-value)
1434                  (message "\
1435 ** gnus-treat-display-xface is an obsolete variable;\
1436  use gnus-treat-display-x-face instead")
1437                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1438                 (t
1439                  value)))))
1440 (put 'gnus-treat-display-x-face 'highlight t)
1441
1442 (defcustom gnus-treat-display-face
1443   (and (not noninteractive)
1444        (gnus-image-type-available-p 'png)
1445        'head)
1446   "Display Face headers.
1447 Valid values are nil, t, `head', `first', `last', an integer or a
1448 predicate.  See Info node `(gnus)Customizing Articles' and Info
1449 node `(gnus)X-Face' for details."
1450   :group 'gnus-article-treat
1451   :version "22.1"
1452   :link '(custom-manual "(gnus)Customizing Articles")
1453   :link '(custom-manual "(gnus)X-Face")
1454   :type gnus-article-treat-head-custom)
1455 (put 'gnus-treat-display-face 'highlight t)
1456
1457 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1458   "Display smileys.
1459 Valid values are nil, t, `head', `first', `last', an integer or a
1460 predicate.  See Info node `(gnus)Customizing Articles' and Info
1461 node `(gnus)Smileys' for details."
1462   :group 'gnus-article-treat
1463   :version "21.1"
1464   :link '(custom-manual "(gnus)Customizing Articles")
1465   :link '(custom-manual "(gnus)Smileys")
1466   :type gnus-article-treat-custom)
1467 (put 'gnus-treat-display-smileys 'highlight t)
1468
1469 (defcustom gnus-treat-from-picon
1470   (if (and (gnus-image-type-available-p 'xpm)
1471            (gnus-picons-installed-p))
1472       'head nil)
1473   "Display picons in the From header.
1474 Valid values are nil, t, `head', `first', `last', an integer or a
1475 predicate.  See Info node `(gnus)Customizing Articles' and Info
1476 node `(gnus)Picons' for details."
1477   :version "22.1"
1478   :group 'gnus-article-treat
1479   :group 'gnus-picon
1480   :link '(custom-manual "(gnus)Customizing Articles")
1481   :link '(custom-manual "(gnus)Picons")
1482   :type gnus-article-treat-head-custom)
1483 (put 'gnus-treat-from-picon 'highlight t)
1484
1485 (defcustom gnus-treat-mail-picon
1486   (if (and (gnus-image-type-available-p 'xpm)
1487            (gnus-picons-installed-p))
1488       'head nil)
1489   "Display picons in To and Cc headers.
1490 Valid values are nil, t, `head', `first', `last', an integer or a
1491 predicate.  See Info node `(gnus)Customizing Articles' and Info
1492 node `(gnus)Picons' for details."
1493   :version "22.1"
1494   :group 'gnus-article-treat
1495   :group 'gnus-picon
1496   :link '(custom-manual "(gnus)Customizing Articles")
1497   :link '(custom-manual "(gnus)Picons")
1498   :type gnus-article-treat-head-custom)
1499 (put 'gnus-treat-mail-picon 'highlight t)
1500
1501 (defcustom gnus-treat-newsgroups-picon
1502   (if (and (gnus-image-type-available-p 'xpm)
1503            (gnus-picons-installed-p))
1504       'head nil)
1505   "Display picons in the Newsgroups and Followup-To headers.
1506 Valid values are nil, t, `head', `first', `last', an integer or a
1507 predicate.  See Info node `(gnus)Customizing Articles' and Info
1508 node `(gnus)Picons' for details."
1509   :version "22.1"
1510   :group 'gnus-article-treat
1511   :group 'gnus-picon
1512   :link '(custom-manual "(gnus)Customizing Articles")
1513   :link '(custom-manual "(gnus)Picons")
1514   :type gnus-article-treat-head-custom)
1515 (put 'gnus-treat-newsgroups-picon 'highlight t)
1516
1517 (defcustom gnus-treat-body-boundary
1518   (if (or gnus-treat-newsgroups-picon
1519           gnus-treat-mail-picon
1520           gnus-treat-from-picon)
1521       ;; If there's much decoration, the user might prefer a boundery.
1522       'head
1523     nil)
1524   "Draw a boundary at the end of the headers.
1525 Valid values are nil and `head'.
1526 See Info node `(gnus)Customizing Articles' for details."
1527   :version "22.1"
1528   :group 'gnus-article-treat
1529   :link '(custom-manual "(gnus)Customizing Articles")
1530   :type gnus-article-treat-head-custom)
1531
1532 (defcustom gnus-treat-capitalize-sentences nil
1533   "Capitalize sentence-starting words.
1534 Valid values are nil, t, `head', `first', `last', an integer or a
1535 predicate.  See Info node `(gnus)Customizing Articles'."
1536   :version "21.1"
1537   :group 'gnus-article-treat
1538   :link '(custom-manual "(gnus)Customizing Articles")
1539   :type gnus-article-treat-custom)
1540
1541 (defcustom gnus-treat-wash-html nil
1542   "Format as HTML.
1543 Valid values are nil, t, `head', `first', `last', an integer or a
1544 predicate.  See Info node `(gnus)Customizing Articles'."
1545   :version "22.1"
1546   :group 'gnus-article-treat
1547   :link '(custom-manual "(gnus)Customizing Articles")
1548   :type gnus-article-treat-custom)
1549
1550 (defcustom gnus-treat-fill-long-lines nil
1551   "Fill long lines.
1552 Valid values are nil, t, `head', `first', `last', an integer or a
1553 predicate.  See Info node `(gnus)Customizing Articles'."
1554   :group 'gnus-article-treat
1555   :link '(custom-manual "(gnus)Customizing Articles")
1556   :type gnus-article-treat-custom)
1557
1558 (defcustom gnus-treat-play-sounds nil
1559   "Play sounds.
1560 Valid values are nil, t, `head', `first', `last', an integer or a
1561 predicate.  See Info node `(gnus)Customizing Articles'."
1562   :version "21.1"
1563   :group 'gnus-article-treat
1564   :link '(custom-manual "(gnus)Customizing Articles")
1565   :type gnus-article-treat-custom)
1566
1567 (defcustom gnus-treat-translate nil
1568   "Translate articles from one language to another.
1569 Valid values are nil, t, `head', `first', `last', an integer or a
1570 predicate.  See Info node `(gnus)Customizing Articles'."
1571   :version "21.1"
1572   :group 'gnus-article-treat
1573   :link '(custom-manual "(gnus)Customizing Articles")
1574   :type gnus-article-treat-custom)
1575
1576 (defcustom gnus-treat-x-pgp-sig nil
1577   "Verify X-PGP-Sig.
1578 To automatically treat X-PGP-Sig, set it to head.
1579 Valid values are nil, t, `head', `first', `last', an integer or a
1580 predicate.  See Info node `(gnus)Customizing Articles'."
1581   :version "22.1"
1582   :group 'gnus-article-treat
1583   :group 'mime-security
1584   :link '(custom-manual "(gnus)Customizing Articles")
1585   :type gnus-article-treat-custom)
1586
1587 (defvar gnus-article-encrypt-protocol-alist
1588   '(("PGP" . mml2015-self-encrypt)))
1589
1590 ;; Set to nil if more than one protocol added to
1591 ;; gnus-article-encrypt-protocol-alist.
1592 (defcustom gnus-article-encrypt-protocol "PGP"
1593   "The protocol used for encrypt articles.
1594 It is a string, such as \"PGP\". If nil, ask user."
1595   :version "22.1"
1596   :type 'string
1597   :group 'mime-security)
1598
1599 (defvar gnus-article-wash-function nil
1600   "Function used for converting HTML into text.")
1601
1602 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1603                               (mm-coding-system-p 'utf-8)
1604                               (executable-find idna-program))
1605   "Whether IDNA decoding of headers is used when viewing messages.
1606 This requires GNU Libidn, and by default only enabled if it is found."
1607   :version "22.1"
1608   :group 'gnus-article-headers
1609   :type 'boolean)
1610
1611 (defcustom gnus-article-over-scroll nil
1612   "If non-nil, allow scrolling the article buffer even when there no more text."
1613   :version "22.1"
1614   :group 'gnus-article
1615   :type 'boolean)
1616
1617 ;;; Internal variables
1618
1619 (defvar gnus-english-month-names
1620   '("January" "February" "March" "April" "May" "June" "July" "August"
1621     "September" "October" "November" "December"))
1622
1623 (defvar article-goto-body-goes-to-point-min-p nil)
1624 (defvar gnus-article-wash-types nil)
1625 (defvar gnus-article-emphasis-alist nil)
1626 (defvar gnus-article-image-alist nil)
1627
1628 (defvar gnus-article-mime-handle-alist-1 nil)
1629 (defvar gnus-treatment-function-alist
1630   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1631     (gnus-treat-strip-banner gnus-article-strip-banner)
1632     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1633     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1634     (gnus-treat-buttonize gnus-article-add-buttons)
1635     (gnus-treat-fill-article gnus-article-fill-cited-article)
1636     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1637     (gnus-treat-strip-cr gnus-article-remove-cr)
1638     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1639     (gnus-treat-date-ut gnus-article-date-ut)
1640     (gnus-treat-date-local gnus-article-date-local)
1641     (gnus-treat-date-english gnus-article-date-english)
1642     (gnus-treat-date-original gnus-article-date-original)
1643     (gnus-treat-date-user-defined gnus-article-date-user)
1644     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1645     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1646     (gnus-treat-display-x-face gnus-article-display-x-face)
1647     (gnus-treat-display-face gnus-article-display-face)
1648     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1649     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1650     (gnus-treat-hide-signature gnus-article-hide-signature)
1651     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1652     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1653     (gnus-treat-strip-pem gnus-article-hide-pem)
1654     (gnus-treat-from-picon gnus-treat-from-picon)
1655     (gnus-treat-mail-picon gnus-treat-mail-picon)
1656     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1657     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1658     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1659     (gnus-treat-strip-trailing-blank-lines
1660      gnus-article-remove-trailing-blank-lines)
1661     (gnus-treat-strip-leading-blank-lines
1662      gnus-article-strip-leading-blank-lines)
1663     (gnus-treat-strip-multiple-blank-lines
1664      gnus-article-strip-multiple-blank-lines)
1665     (gnus-treat-overstrike gnus-article-treat-overstrike)
1666     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1667     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1668     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1669     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1670     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1671     (gnus-treat-display-smileys gnus-treat-smiley)
1672     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1673     (gnus-treat-wash-html gnus-article-wash-html)
1674     (gnus-treat-emphasize gnus-article-emphasize)
1675     (gnus-treat-hide-citation gnus-article-hide-citation)
1676     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1677     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1678     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1679     (gnus-treat-play-sounds gnus-earcon-display)))
1680
1681 (defvar gnus-article-mime-handle-alist nil)
1682 (defvar article-lapsed-timer nil)
1683 (defvar gnus-article-current-summary nil)
1684
1685 (defvar gnus-article-mode-syntax-table
1686   (let ((table (copy-syntax-table text-mode-syntax-table)))
1687     ;; This causes the citation match run O(2^n).
1688     ;; (modify-syntax-entry ?- "w" table)
1689     (modify-syntax-entry ?> ")<" table)
1690     (modify-syntax-entry ?< "(>" table)
1691     ;; make M-. in article buffers work for `foo' strings
1692     (modify-syntax-entry ?' " " table)
1693     (modify-syntax-entry ?` " " table)
1694     table)
1695   "Syntax table used in article mode buffers.
1696 Initialized from `text-mode-syntax-table.")
1697
1698 (defvar gnus-save-article-buffer nil)
1699
1700 (defvar gnus-article-mode-line-format-alist
1701   (nconc '((?w (gnus-article-wash-status) ?s)
1702            (?m (gnus-article-mime-part-status) ?s))
1703          gnus-summary-mode-line-format-alist))
1704
1705 (defvar gnus-number-of-articles-to-be-saved nil)
1706
1707 (defvar gnus-inhibit-hiding nil)
1708
1709 (defvar gnus-article-edit-mode nil)
1710
1711 ;;; Macros for dealing with the article buffer.
1712
1713 (defmacro gnus-with-article-headers (&rest forms)
1714   `(save-excursion
1715      (set-buffer gnus-article-buffer)
1716      (save-restriction
1717        (let ((inhibit-read-only t)
1718              (inhibit-point-motion-hooks t)
1719              (case-fold-search t))
1720          (article-narrow-to-head)
1721          ,@forms))))
1722
1723 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1724 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1725
1726 (defmacro gnus-with-article-buffer (&rest forms)
1727   `(save-excursion
1728      (set-buffer gnus-article-buffer)
1729      (let ((inhibit-read-only t))
1730        ,@forms)))
1731
1732 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1733 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1734
1735 (defun gnus-article-goto-header (header)
1736   "Go to HEADER, which is a regular expression."
1737   (re-search-forward (concat "^\\(" header "\\):") nil t))
1738
1739 (defsubst gnus-article-hide-text (b e props)
1740   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1741   (gnus-add-text-properties-when 'article-type nil b e props)
1742   (when (memq 'intangible props)
1743     (put-text-property
1744      (max (1- b) (point-min))
1745      b 'intangible (cddr (memq 'intangible props)))))
1746
1747 (defsubst gnus-article-unhide-text (b e)
1748   "Remove hidden text properties from region between B and E."
1749   (remove-text-properties b e gnus-hidden-properties)
1750   (when (memq 'intangible gnus-hidden-properties)
1751     (put-text-property (max (1- b) (point-min))
1752                        b 'intangible nil)))
1753
1754 (defun gnus-article-hide-text-type (b e type)
1755   "Hide text of TYPE between B and E."
1756   (gnus-add-wash-type type)
1757   (gnus-article-hide-text
1758    b e (cons 'article-type (cons type gnus-hidden-properties))))
1759
1760 (defun gnus-article-unhide-text-type (b e type)
1761   "Unhide text of TYPE between B and E."
1762   (gnus-delete-wash-type type)
1763   (remove-text-properties
1764    b e (cons 'article-type (cons type gnus-hidden-properties)))
1765   (when (memq 'intangible gnus-hidden-properties)
1766     (put-text-property (max (1- b) (point-min))
1767                        b 'intangible nil)))
1768
1769 (defun gnus-article-hide-text-of-type (type)
1770   "Hide text of TYPE in the current buffer."
1771   (save-excursion
1772     (let ((b (point-min))
1773           (e (point-max)))
1774       (while (setq b (text-property-any b e 'article-type type))
1775         (add-text-properties b (incf b) gnus-hidden-properties)))))
1776
1777 (defun gnus-article-delete-text-of-type (type)
1778   "Delete text of TYPE in the current buffer."
1779   (save-excursion
1780     (let ((b (point-min)))
1781       (if (eq type 'multipart)
1782           ;; Remove MIME buttons associated with multipart/alternative parts.
1783           (progn
1784             (goto-char b)
1785             (while (if (get-text-property (point) 'gnus-part)
1786                        (setq b (point))
1787                      (when (setq b (next-single-property-change (point)
1788                                                                 'gnus-part))
1789                        (goto-char b)
1790                        t))
1791               (end-of-line)
1792               (skip-chars-forward "\n")
1793               (when (eq (get-text-property b 'article-type) 'multipart)
1794                 (delete-region b (point)))))
1795         (while (setq b (text-property-any b (point-max) 'article-type type))
1796           (delete-region
1797            b (or (text-property-not-all b (point-max) 'article-type type)
1798                  (point-max))))))))
1799
1800 (defun gnus-article-delete-invisible-text ()
1801   "Delete all invisible text in the current buffer."
1802   (save-excursion
1803     (let ((b (point-min)))
1804       (while (setq b (text-property-any b (point-max) 'invisible t))
1805         (delete-region
1806          b (or (text-property-not-all b (point-max) 'invisible t)
1807                (point-max)))))))
1808
1809 (defun gnus-article-text-type-exists-p (type)
1810   "Say whether any text of type TYPE exists in the buffer."
1811   (text-property-any (point-min) (point-max) 'article-type type))
1812
1813 (defsubst gnus-article-header-rank ()
1814   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1815   (let ((list gnus-sorted-header-list)
1816         (i 1))
1817     (while list
1818       (if (looking-at (car list))
1819           (setq list nil)
1820         (setq list (cdr list))
1821         (incf i)))
1822       i))
1823
1824 (defun article-hide-headers (&optional arg delete)
1825   "Hide unwanted headers and possibly sort them as well."
1826   (interactive)
1827   ;; This function might be inhibited.
1828   (unless gnus-inhibit-hiding
1829     (let ((inhibit-read-only t)
1830           (case-fold-search t)
1831           (max (1+ (length gnus-sorted-header-list)))
1832           (inhibit-point-motion-hooks t)
1833           (cur (current-buffer))
1834           ignored visible beg)
1835       (save-excursion
1836         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1837         ;; group parameters, so we should go to the summary buffer.
1838         (when (prog1
1839                   (condition-case nil
1840                       (progn (set-buffer gnus-summary-buffer) t)
1841                     (error nil))
1842                 (setq ignored (when (not gnus-visible-headers)
1843                                 (cond ((stringp gnus-ignored-headers)
1844                                        gnus-ignored-headers)
1845                                       ((listp gnus-ignored-headers)
1846                                        (mapconcat 'identity
1847                                                   gnus-ignored-headers
1848                                                   "\\|"))))
1849                       visible (cond ((stringp gnus-visible-headers)
1850                                      gnus-visible-headers)
1851                                     ((and gnus-visible-headers
1852                                           (listp gnus-visible-headers))
1853                                      (mapconcat 'identity
1854                                                 gnus-visible-headers
1855                                                 "\\|")))))
1856           (set-buffer cur))
1857         (save-restriction
1858           ;; First we narrow to just the headers.
1859           (article-narrow-to-head)
1860           ;; Hide any "From " lines at the beginning of (mail) articles.
1861           (while (looking-at "From ")
1862             (forward-line 1))
1863           (unless (bobp)
1864             (delete-region (point-min) (point)))
1865           ;; Then treat the rest of the header lines.
1866           ;; Then we use the two regular expressions
1867           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1868           ;; select which header lines is to remain visible in the
1869           ;; article buffer.
1870           (while (re-search-forward "^[^ \t:]*:" nil t)
1871             (beginning-of-line)
1872             ;; Mark the rank of the header.
1873             (put-text-property
1874              (point) (1+ (point)) 'message-rank
1875              (if (or (and visible (looking-at visible))
1876                      (and ignored
1877                           (not (looking-at ignored))))
1878                  (gnus-article-header-rank)
1879                (+ 2 max)))
1880             (forward-line 1))
1881           (message-sort-headers-1)
1882           (when (setq beg (text-property-any
1883                            (point-min) (point-max) 'message-rank (+ 2 max)))
1884             ;; We delete the unwanted headers.
1885             (gnus-add-wash-type 'headers)
1886             (add-text-properties (point-min) (+ 5 (point-min))
1887                                  '(article-type headers dummy-invisible t))
1888             (delete-region beg (point-max))))))))
1889
1890 (defun article-hide-boring-headers (&optional arg)
1891   "Toggle hiding of headers that aren't very interesting.
1892 If given a negative prefix, always show; if given a positive prefix,
1893 always hide."
1894   (interactive (gnus-article-hidden-arg))
1895   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1896              (not gnus-show-all-headers))
1897     (save-excursion
1898       (save-restriction
1899         (let ((inhibit-read-only t)
1900               (inhibit-point-motion-hooks t))
1901           (article-narrow-to-head)
1902           (dolist (elem gnus-boring-article-headers)
1903             (goto-char (point-min))
1904             (cond
1905              ;; Hide empty headers.
1906              ((eq elem 'empty)
1907               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1908                 (forward-line -1)
1909                 (gnus-article-hide-text-type
1910                  (point-at-bol)
1911                  (progn
1912                    (end-of-line)
1913                    (if (re-search-forward "^[^ \t]" nil t)
1914                        (match-beginning 0)
1915                      (point-max)))
1916                  'boring-headers)))
1917              ;; Hide boring Newsgroups header.
1918              ((eq elem 'newsgroups)
1919               (when (gnus-string-equal
1920                      (gnus-fetch-field "newsgroups")
1921                      (gnus-group-real-name
1922                       (if (boundp 'gnus-newsgroup-name)
1923                           gnus-newsgroup-name
1924                         "")))
1925                 (gnus-article-hide-header "newsgroups")))
1926              ((eq elem 'to-address)
1927               (let ((to (message-fetch-field "to"))
1928                     (to-address
1929                      (gnus-parameter-to-address
1930                       (if (boundp 'gnus-newsgroup-name)
1931                           gnus-newsgroup-name ""))))
1932                 (when (and to to-address
1933                            (ignore-errors
1934                              (gnus-string-equal
1935                               ;; only one address in To
1936                               (nth 1 (mail-extract-address-components to))
1937                               to-address)))
1938                   (gnus-article-hide-header "to"))))
1939              ((eq elem 'to-list)
1940               (let ((to (message-fetch-field "to"))
1941                     (to-list
1942                      (gnus-parameter-to-list
1943                       (if (boundp 'gnus-newsgroup-name)
1944                           gnus-newsgroup-name ""))))
1945                 (when (and to to-list
1946                            (ignore-errors
1947                              (gnus-string-equal
1948                               ;; only one address in To
1949                               (nth 1 (mail-extract-address-components to))
1950                               to-list)))
1951                   (gnus-article-hide-header "to"))))
1952              ((eq elem 'cc-list)
1953               (let ((cc (message-fetch-field "cc"))
1954                     (to-list
1955                      (gnus-parameter-to-list
1956                       (if (boundp 'gnus-newsgroup-name)
1957                           gnus-newsgroup-name ""))))
1958                 (when (and cc to-list
1959                            (ignore-errors
1960                              (gnus-string-equal
1961                               ;; only one address in CC
1962                               (nth 1 (mail-extract-address-components cc))
1963                               to-list)))
1964                   (gnus-article-hide-header "cc"))))
1965              ((eq elem 'followup-to)
1966               (when (gnus-string-equal
1967                      (message-fetch-field "followup-to")
1968                      (message-fetch-field "newsgroups"))
1969                 (gnus-article-hide-header "followup-to")))
1970              ((eq elem 'reply-to)
1971               (if (gnus-group-find-parameter
1972                    gnus-newsgroup-name 'broken-reply-to)
1973                   (gnus-article-hide-header "reply-to")
1974                 (let ((from (message-fetch-field "from"))
1975                       (reply-to (message-fetch-field "reply-to")))
1976                   (when
1977                       (and
1978                        from reply-to
1979                        (ignore-errors
1980                          (equal
1981                           (sort (mapcar
1982                                  (lambda (x) (downcase (cadr x)))
1983                                  (mail-extract-address-components from t))
1984                                 'string<)
1985                           (sort (mapcar
1986                                  (lambda (x) (downcase (cadr x)))
1987                                  (mail-extract-address-components reply-to t))
1988                                 'string<))))
1989                     (gnus-article-hide-header "reply-to")))))
1990              ((eq elem 'date)
1991               (let ((date (with-current-buffer gnus-original-article-buffer
1992                             ;; If date in `gnus-article-buffer' is localized
1993                             ;; (`gnus-treat-date-user-defined'),
1994                             ;; `days-between' might fail.
1995                             (message-fetch-field "date"))))
1996                 (when (and date
1997                            (< (days-between (current-time-string) date)
1998                               4))
1999                   (gnus-article-hide-header "date"))))
2000              ((eq elem 'long-to)
2001               (let ((to (message-fetch-field "to"))
2002                     (cc (message-fetch-field "cc")))
2003                 (when (> (length to) 1024)
2004                   (gnus-article-hide-header "to"))
2005                 (when (> (length cc) 1024)
2006                   (gnus-article-hide-header "cc"))))
2007              ((eq elem 'many-to)
2008               (let ((to-count 0)
2009                     (cc-count 0))
2010                 (goto-char (point-min))
2011                 (while (re-search-forward "^to:" nil t)
2012                   (setq to-count (1+ to-count)))
2013                 (when (> to-count 1)
2014                   (while (> to-count 0)
2015                     (goto-char (point-min))
2016                     (save-restriction
2017                       (re-search-forward "^to:" nil nil to-count)
2018                       (forward-line -1)
2019                       (narrow-to-region (point) (point-max))
2020                       (gnus-article-hide-header "to"))
2021                     (setq to-count (1- to-count))))
2022                 (goto-char (point-min))
2023                 (while (re-search-forward "^cc:" nil t)
2024                   (setq cc-count (1+ cc-count)))
2025                 (when (> cc-count 1)
2026                   (while (> cc-count 0)
2027                     (goto-char (point-min))
2028                     (save-restriction
2029                       (re-search-forward "^cc:" nil nil cc-count)
2030                       (forward-line -1)
2031                       (narrow-to-region (point) (point-max))
2032                       (gnus-article-hide-header "cc"))
2033                     (setq cc-count (1- cc-count)))))))))))))
2034
2035 (defun gnus-article-hide-header (header)
2036   (save-excursion
2037     (goto-char (point-min))
2038     (when (re-search-forward (concat "^" header ":") nil t)
2039       (gnus-article-hide-text-type
2040        (point-at-bol)
2041        (progn
2042          (end-of-line)
2043          (if (re-search-forward "^[^ \t]" nil t)
2044              (match-beginning 0)
2045            (point-max)))
2046        'boring-headers))))
2047
2048 (defvar gnus-article-normalized-header-length 40
2049   "Length of normalized headers.")
2050
2051 (defun article-normalize-headers ()
2052   "Make all header lines 40 characters long."
2053   (interactive)
2054   (let ((inhibit-read-only t)
2055         column)
2056     (save-excursion
2057       (save-restriction
2058         (article-narrow-to-head)
2059         (while (not (eobp))
2060           (cond
2061            ((< (setq column (- (point-at-eol) (point)))
2062                gnus-article-normalized-header-length)
2063             (end-of-line)
2064             (insert (make-string
2065                      (- gnus-article-normalized-header-length column)
2066                      ? )))
2067            ((> column gnus-article-normalized-header-length)
2068             (gnus-put-text-property
2069              (progn
2070                (forward-char gnus-article-normalized-header-length)
2071                (point))
2072              (point-at-eol)
2073              'invisible t))
2074            (t
2075             ;; Do nothing.
2076             ))
2077           (forward-line 1))))))
2078
2079 (defun article-treat-dumbquotes ()
2080   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2081 Note that this function guesses whether a character is a sm*rtq**t* or
2082 not, so it should only be used interactively.
2083
2084 Sm*rtq**t*s are M****s***'s unilateral extension to the
2085 iso-8859-1 character map in an attempt to provide more quoting
2086 characters.  If you see something like \\222 or \\264 where
2087 you're expecting some kind of apostrophe or quotation mark, then
2088 try this wash."
2089   (interactive)
2090   (article-translate-strings gnus-article-dumbquotes-map))
2091
2092 (defun article-translate-characters (from to)
2093   "Translate all characters in the body of the article according to FROM and TO.
2094 FROM is a string of characters to translate from; to is a string of
2095 characters to translate to."
2096   (save-excursion
2097     (when (article-goto-body)
2098       (let ((inhibit-read-only t)
2099             (x (make-string 225 ?x))
2100             (i -1))
2101         (while (< (incf i) (length x))
2102           (aset x i i))
2103         (setq i 0)
2104         (while (< i (length from))
2105           (aset x (aref from i) (aref to i))
2106           (incf i))
2107         (translate-region (point) (point-max) x)))))
2108
2109 (defun article-translate-strings (map)
2110   "Translate all string in the body of the article according to MAP.
2111 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2112   (save-excursion
2113     (when (article-goto-body)
2114       (let ((inhibit-read-only t))
2115         (dolist (elem map)
2116           (save-excursion
2117             (while (search-forward (car elem) nil t)
2118               (replace-match (cadr elem)))))))))
2119
2120 (defun article-treat-overstrike ()
2121   "Translate overstrikes into bold text."
2122   (interactive)
2123   (save-excursion
2124     (when (article-goto-body)
2125       (let ((inhibit-read-only t))
2126         (while (search-forward "\b" nil t)
2127           (let ((next (char-after))
2128                 (previous (char-after (- (point) 2))))
2129             ;; We do the boldification/underlining by hiding the
2130             ;; overstrikes and putting the proper text property
2131             ;; on the letters.
2132             (cond
2133              ((eq next previous)
2134               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2135               (put-text-property (point) (1+ (point)) 'face 'bold))
2136              ((eq next ?_)
2137               (gnus-article-hide-text-type
2138                (1- (point)) (1+ (point)) 'overstrike)
2139               (put-text-property
2140                (- (point) 2) (1- (point)) 'face 'underline))
2141              ((eq previous ?_)
2142               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2143               (put-text-property
2144                (point) (1+ (point)) 'face 'underline)))))))))
2145
2146 (defun article-treat-ansi-sequences ()
2147   "Translate ANSI SGR control sequences into overlays or extents."
2148   (interactive)
2149   (save-excursion
2150     (when (article-goto-body)
2151       (let ((inhibit-read-only t))
2152         (ansi-color-apply-on-region (point) (point-max))))))
2153
2154 (defun gnus-article-treat-unfold-headers ()
2155   "Unfold folded message headers.
2156 Only the headers that fit into the current window width will be
2157 unfolded."
2158   (interactive)
2159   (gnus-with-article-headers
2160     (let (length)
2161       (while (not (eobp))
2162         (save-restriction
2163           (mail-header-narrow-to-field)
2164           (let* ((header (buffer-string))
2165                  (unfoldable
2166                   (or (equal gnus-article-unfold-long-headers t)
2167                       (and (stringp gnus-article-unfold-long-headers)
2168                            (string-match gnus-article-unfold-long-headers header)))))
2169             (with-temp-buffer
2170               (insert header)
2171               (goto-char (point-min))
2172               (while (re-search-forward "\n[\t ]" nil t)
2173                 (replace-match " " t t)))
2174             (setq length (- (point-max) (point-min) 1))
2175             (when (or unfoldable
2176                       (< length (window-width)))
2177               (while (re-search-forward "\n[\t ]" nil t)
2178                 (replace-match " " t t))))
2179           (goto-char (point-max)))))))
2180
2181 (defun gnus-article-treat-fold-headers ()
2182   "Fold message headers."
2183   (interactive)
2184   (gnus-with-article-headers
2185     (while (not (eobp))
2186       (save-restriction
2187         (mail-header-narrow-to-field)
2188         (mail-header-fold-field)
2189         (goto-char (point-max))))))
2190
2191 (defun gnus-treat-smiley ()
2192   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2193   (interactive)
2194   (gnus-with-article-buffer
2195     (if (memq 'smiley gnus-article-wash-types)
2196         (gnus-delete-images 'smiley)
2197       (article-goto-body)
2198       (let ((images (smiley-region (point) (point-max))))
2199         (when images
2200           (gnus-add-wash-type 'smiley)
2201           (dolist (image images)
2202             (gnus-add-image 'smiley image)))))))
2203
2204 (defun gnus-article-remove-images ()
2205   "Remove all images from the article buffer."
2206   (interactive)
2207   (gnus-with-article-buffer
2208     (dolist (elem gnus-article-image-alist)
2209       (gnus-delete-images (car elem)))))
2210
2211 (defun gnus-article-treat-fold-newsgroups ()
2212   "Unfold folded message headers.
2213 Only the headers that fit into the current window width will be
2214 unfolded."
2215   (interactive)
2216   (gnus-with-article-headers
2217     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2218       (save-restriction
2219         (mail-header-narrow-to-field)
2220         (while (re-search-forward ", *" nil t)
2221           (replace-match ", " t t))
2222         (mail-header-fold-field)
2223         (goto-char (point-max))))))
2224
2225 (defcustom gnus-article-truncate-lines default-truncate-lines
2226   "Value of `truncate-lines' in Gnus Article buffer.
2227 Valid values are nil, t, `head', `first', `last', an integer or a
2228 predicate.  See Info node `(gnus)Customizing Articles'."
2229   :version "23.0" ;; No Gnus
2230   :group 'gnus-article
2231   ;; :link '(custom-manual "(gnus)Customizing Articles")
2232   :type 'boolean)
2233
2234 (defun gnus-article-toggle-truncate-lines (&optional arg)
2235   "Toggle whether to fold or truncate long lines in article the buffer.
2236 If ARG is non-nil and not a number, toggle
2237 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2238 long lines iff arg is positive."
2239   (interactive "P")
2240   (cond
2241    ((and (numberp arg) (> arg 0))
2242     (setq gnus-article-truncate-lines t))
2243    ((numberp arg)
2244     (setq gnus-article-truncate-lines nil))
2245    (arg
2246     (setq gnus-article-truncate-lines
2247           (not gnus-article-truncate-lines))))
2248   (gnus-with-article-buffer
2249     (cond
2250      ((and (numberp arg) (> arg 0))
2251       (setq truncate-lines nil))
2252      ((numberp arg)
2253       (setq truncate-lines t)))
2254     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2255     ;; `toggle-truncate-lines' needs an argument.
2256     (toggle-truncate-lines)))
2257
2258 (defun gnus-article-treat-body-boundary ()
2259   "Place a boundary line at the end of the headers."
2260   (interactive)
2261   (when (and gnus-body-boundary-delimiter
2262              (> (length gnus-body-boundary-delimiter) 0))
2263     (gnus-with-article-headers
2264       (goto-char (point-max))
2265       (let ((start (point)))
2266         (insert "X-Boundary: ")
2267         (gnus-add-text-properties start (point) '(invisible t intangible t))
2268         (insert (let (str)
2269                   (while (>= (1- (window-width)) (length str))
2270                     (setq str (concat str gnus-body-boundary-delimiter)))
2271                   (substring str 0 (1- (window-width))))
2272                 "\n")
2273         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2274
2275 (defun article-fill-long-lines ()
2276   "Fill lines that are wider than the window width."
2277   (interactive)
2278   (save-excursion
2279     (let ((inhibit-read-only t)
2280           (width (window-width (get-buffer-window (current-buffer)))))
2281       (save-restriction
2282         (article-goto-body)
2283         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2284           (while (not (eobp))
2285             (end-of-line)
2286             (when (>= (current-column) (min fill-column width))
2287               (narrow-to-region (min (1+ (point)) (point-max))
2288                                 (point-at-bol))
2289               (let ((goback (point-marker)))
2290                 (fill-paragraph nil)
2291                 (goto-char (marker-position goback)))
2292               (widen))
2293             (forward-line 1)))))))
2294
2295 (defun article-capitalize-sentences ()
2296   "Capitalize the first word in each sentence."
2297   (interactive)
2298   (save-excursion
2299     (let ((inhibit-read-only t)
2300           (paragraph-start "^[\n\^L]"))
2301       (article-goto-body)
2302       (while (not (eobp))
2303         (capitalize-word 1)
2304         (forward-sentence)))))
2305
2306 (defun article-remove-cr ()
2307   "Remove trailing CRs and then translate remaining CRs into LFs."
2308   (interactive)
2309   (save-excursion
2310     (let ((inhibit-read-only t))
2311       (goto-char (point-min))
2312       (while (re-search-forward "\r+$" nil t)
2313         (replace-match "" t t))
2314       (goto-char (point-min))
2315       (while (search-forward "\r" nil t)
2316         (replace-match "\n" t t)))))
2317
2318 (defun article-remove-trailing-blank-lines ()
2319   "Remove all trailing blank lines from the article."
2320   (interactive)
2321   (save-excursion
2322     (let ((inhibit-read-only t))
2323       (goto-char (point-max))
2324       (delete-region
2325        (point)
2326        (progn
2327          (while (and (not (bobp))
2328                      (looking-at "^[ \t]*$")
2329                      (not (gnus-annotation-in-region-p
2330                            (point) (point-at-eol))))
2331            (forward-line -1))
2332          (forward-line 1)
2333          (point))))))
2334
2335 (eval-when-compile
2336   (defvar gnus-face-properties-alist))
2337
2338 (defun article-display-face ()
2339   "Display any Face headers in the header."
2340   (interactive)
2341   (let ((wash-face-p buffer-read-only))
2342     (gnus-with-article-headers
2343       ;; When displaying parts, this function can be called several times on
2344       ;; the same article, without any intended toggle semantic (as typing `W
2345       ;; D d' would have). So face deletion must occur only when we come from
2346       ;; an interactive command, that is when the *Article* buffer is
2347       ;; read-only.
2348       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2349           (gnus-delete-images 'face)
2350         (let (face faces from)
2351           (save-current-buffer
2352             (when (and wash-face-p
2353                        (gnus-buffer-live-p gnus-original-article-buffer)
2354                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2355               (set-buffer gnus-original-article-buffer))
2356             (save-restriction
2357               (mail-narrow-to-head)
2358               (while (gnus-article-goto-header "Face")
2359                 (push (mail-header-field-value) faces))))
2360           (when faces
2361             (goto-char (point-min))
2362             (let ((from (gnus-article-goto-header "from"))
2363                   png image)
2364               (unless from
2365                 (insert "From:")
2366                 (setq from (point))
2367                 (insert "[no `from' set]\n"))
2368               (while faces
2369                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2370                   (setq image
2371                         (apply 'gnus-create-image png 'png t
2372                                (cdr (assq 'png gnus-face-properties-alist))))
2373                   (goto-char from)
2374                   (gnus-add-wash-type 'face)
2375                   (gnus-add-image 'face image)
2376                   (gnus-put-image image nil 'face))))))))))
2377
2378 (defun article-display-x-face (&optional force)
2379   "Look for an X-Face header and display it if present."
2380   (interactive (list 'force))
2381   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2382     (gnus-with-article-headers
2383       ;; Delete the old process, if any.
2384       (when (process-status "article-x-face")
2385         (delete-process "article-x-face"))
2386       ;; See the comment in `article-display-face'.
2387       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2388           ;; We have already displayed X-Faces, so we remove them
2389           ;; instead.
2390           (gnus-delete-images 'xface)
2391         ;; Display X-Faces.
2392         (let (x-faces from face)
2393           (save-current-buffer
2394             (when (and wash-face-p
2395                        (gnus-buffer-live-p gnus-original-article-buffer)
2396                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2397               ;; If type `W f', use gnus-original-article-buffer,
2398               ;; otherwise use the current buffer because displaying
2399               ;; RFC822 parts calls this function too.
2400               (set-buffer gnus-original-article-buffer))
2401             (save-restriction
2402               (mail-narrow-to-head)
2403               (while (gnus-article-goto-header "X-Face")
2404                 (push (mail-header-field-value) x-faces))
2405               (setq from (message-fetch-field "from"))))
2406           ;; Sending multiple EOFs to xv doesn't work, so we only do a
2407           ;; single external face.
2408           (when (stringp gnus-article-x-face-command)
2409             (setq x-faces (list (car x-faces))))
2410           (when (and x-faces
2411                      gnus-article-x-face-command
2412                      (or force
2413                          ;; Check whether this face is censored.
2414                          (not gnus-article-x-face-too-ugly)
2415                          (and from
2416                               (not (string-match gnus-article-x-face-too-ugly
2417                                                  from)))))
2418             (while (setq face (pop x-faces))
2419               ;; We display the face.
2420               (cond ((stringp gnus-article-x-face-command)
2421                      ;; The command is a string, so we interpret the command
2422                      ;; as a, well, command, and fork it off.
2423                      (let ((process-connection-type nil))
2424                        (gnus-set-process-query-on-exit-flag
2425                         (start-process
2426                          "article-x-face" nil shell-file-name
2427                          shell-command-switch gnus-article-x-face-command)
2428                         nil)
2429                        (with-temp-buffer
2430                          (insert face)
2431                          (process-send-region "article-x-face"
2432                                               (point-min) (point-max)))
2433                        (process-send-eof "article-x-face")))
2434                     ((functionp gnus-article-x-face-command)
2435                      ;; The command is a lisp function, so we call it.
2436                      (funcall gnus-article-x-face-command face))
2437                     (t
2438                      (error "%s is not a function"
2439                             gnus-article-x-face-command))))))))))
2440
2441 (defun article-decode-mime-words ()
2442   "Decode all MIME-encoded words in the article."
2443   (interactive)
2444   (gnus-with-article-buffer
2445     (let ((inhibit-point-motion-hooks t)
2446           (mail-parse-charset gnus-newsgroup-charset)
2447           (mail-parse-ignored-charsets
2448            (with-current-buffer gnus-summary-buffer
2449              gnus-newsgroup-ignored-charsets)))
2450       (mail-decode-encoded-word-region (point-min) (point-max)))))
2451
2452 (defun article-decode-charset (&optional prompt)
2453   "Decode charset-encoded text in the article.
2454 If PROMPT (the prefix), prompt for a coding system to use."
2455   (interactive "P")
2456   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2457         (inhibit-read-only t)
2458         (mail-parse-charset gnus-newsgroup-charset)
2459         (mail-parse-ignored-charsets
2460          (save-excursion (condition-case nil
2461                              (set-buffer gnus-summary-buffer)
2462                            (error))
2463                          gnus-newsgroup-ignored-charsets))
2464         ct cte ctl charset format)
2465     (save-excursion
2466       (save-restriction
2467         (article-narrow-to-head)
2468         (setq ct (message-fetch-field "Content-Type" t)
2469               cte (message-fetch-field "Content-Transfer-Encoding" t)
2470               ctl (and ct (mail-header-parse-content-type ct))
2471               charset (cond
2472                        (prompt
2473                         (mm-read-coding-system "Charset to decode: "))
2474                        (ctl
2475                         (mail-content-type-get ctl 'charset)))
2476               format (and ctl (mail-content-type-get ctl 'format)))
2477         (when cte
2478           (setq cte (mail-header-strip cte)))
2479         (if (and ctl (not (string-match "/" (car ctl))))
2480             (setq ctl nil))
2481         (goto-char (point-max)))
2482       (forward-line 1)
2483       (save-restriction
2484         (narrow-to-region (point) (point-max))
2485         (when (and (eq mail-parse-charset 'gnus-decoded)
2486                    (eq (mm-body-7-or-8) '8bit))
2487           ;; The text code could have been decoded.
2488           (setq charset mail-parse-charset))
2489         (when (and (or (not ctl)
2490                        (equal (car ctl) "text/plain"))
2491                    (not format)) ;; article with format will decode later.
2492           (mm-decode-body
2493            charset (and cte (intern (downcase
2494                                      (gnus-strip-whitespace cte))))
2495            (car ctl)))))))
2496
2497 (defun article-decode-encoded-words ()
2498   "Remove encoded-word encoding from headers."
2499   (let ((inhibit-point-motion-hooks t)
2500         (mail-parse-charset gnus-newsgroup-charset)
2501         (mail-parse-ignored-charsets
2502          (save-excursion (condition-case nil
2503                              (set-buffer gnus-summary-buffer)
2504                            (error))
2505                          gnus-newsgroup-ignored-charsets))
2506         (inhibit-read-only t)
2507         end start)
2508     (goto-char (point-min))
2509     (when (search-forward "\n\n" nil 'move)
2510       (forward-line -1))
2511     (setq end (point))
2512     (while (not (bobp))
2513       (while (progn
2514                (forward-line -1)
2515                (and (not (bobp))
2516                     (memq (char-after) '(?\t ? )))))
2517       (setq start (point))
2518       (if (looking-at "\
2519 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2520 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2521           (funcall gnus-decode-address-function start end)
2522         (funcall gnus-decode-header-function start end))
2523       (goto-char (setq end start)))))
2524
2525 (defun article-decode-group-name ()
2526   "Decode group names in Newsgroups, Followup-To and Xref headers."
2527   (let ((inhibit-point-motion-hooks t)
2528         (inhibit-read-only t)
2529         (method (gnus-find-method-for-group gnus-newsgroup-name))
2530         regexp)
2531     (when (and (or gnus-group-name-charset-method-alist
2532                    gnus-group-name-charset-group-alist)
2533                (gnus-buffer-live-p gnus-original-article-buffer))
2534       (save-restriction
2535         (article-narrow-to-head)
2536         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2537           (with-current-buffer gnus-original-article-buffer
2538             (goto-char (point-min)))
2539           (setq regexp (concat "^" header
2540                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2541           (while (re-search-forward regexp nil t)
2542             (replace-match (save-match-data
2543                              (gnus-decode-newsgroups
2544                               ;; XXX how to use data in article buffer?
2545                               (with-current-buffer gnus-original-article-buffer
2546                                 (re-search-forward regexp nil t)
2547                                 (match-string 1))
2548                               gnus-newsgroup-name method))
2549                            t t nil 1))
2550           (goto-char (point-min)))))))
2551
2552 (autoload 'idna-to-unicode "idna")
2553
2554 (defun article-decode-idna-rhs ()
2555   "Decode IDNA strings in RHS in various headers in current buffer.
2556 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2557 Mail-Reply-To: and Mail-Followup-To:."
2558   (when gnus-use-idna
2559     (save-restriction
2560       (let ((inhibit-point-motion-hooks t)
2561             (inhibit-read-only t))
2562         (article-narrow-to-head)
2563         (goto-char (point-min))
2564         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2565           (let (ace unicode)
2566             (when (save-match-data
2567                     (and (setq ace (match-string 1))
2568                          (save-excursion
2569                            (and (re-search-backward "^[^ \t]" nil t)
2570                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2571                          (setq unicode (idna-to-unicode ace))))
2572               (unless (string= ace unicode)
2573                 (replace-match unicode nil nil nil 1)))))))))
2574
2575 (defun article-de-quoted-unreadable (&optional force read-charset)
2576   "Translate a quoted-printable-encoded article.
2577 If FORCE, decode the article whether it is marked as quoted-printable
2578 or not.
2579 If READ-CHARSET, ask for a coding system."
2580   (interactive (list 'force current-prefix-arg))
2581   (save-excursion
2582     (let ((inhibit-read-only t) type charset)
2583       (if (gnus-buffer-live-p gnus-original-article-buffer)
2584           (with-current-buffer gnus-original-article-buffer
2585             (setq type
2586                   (gnus-fetch-field "content-transfer-encoding"))
2587             (let* ((ct (gnus-fetch-field "content-type"))
2588                    (ctl (and ct (mail-header-parse-content-type ct))))
2589               (setq charset (and ctl
2590                                  (mail-content-type-get ctl 'charset)))
2591               (if (stringp charset)
2592                   (setq charset (intern (downcase charset)))))))
2593       (if read-charset
2594           (setq charset (mm-read-coding-system "Charset: " charset)))
2595       (unless charset
2596         (setq charset gnus-newsgroup-charset))
2597       (when (or force
2598                 (and type (let ((case-fold-search t))
2599                             (string-match "quoted-printable" type))))
2600         (article-goto-body)
2601         (quoted-printable-decode-region
2602          (point) (point-max) (mm-charset-to-coding-system charset))))))
2603
2604 (defun article-de-base64-unreadable (&optional force read-charset)
2605   "Translate a base64 article.
2606 If FORCE, decode the article whether it is marked as base64 not.
2607 If READ-CHARSET, ask for a coding system."
2608   (interactive (list 'force current-prefix-arg))
2609   (save-excursion
2610     (let ((inhibit-read-only t) type charset)
2611       (if (gnus-buffer-live-p gnus-original-article-buffer)
2612           (with-current-buffer gnus-original-article-buffer
2613             (setq type
2614                   (gnus-fetch-field "content-transfer-encoding"))
2615             (let* ((ct (gnus-fetch-field "content-type"))
2616                    (ctl (and ct (mail-header-parse-content-type ct))))
2617               (setq charset (and ctl
2618                                  (mail-content-type-get ctl 'charset)))
2619               (if (stringp charset)
2620                   (setq charset (intern (downcase charset)))))))
2621       (if read-charset
2622           (setq charset (mm-read-coding-system "Charset: " charset)))
2623       (unless charset
2624         (setq charset gnus-newsgroup-charset))
2625       (when (or force
2626                 (and type (let ((case-fold-search t))
2627                             (string-match "base64" type))))
2628         (article-goto-body)
2629         (save-restriction
2630           (narrow-to-region (point) (point-max))
2631           (base64-decode-region (point-min) (point-max))
2632           (mm-decode-coding-region
2633            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2634
2635 (eval-when-compile
2636   (require 'rfc1843))
2637
2638 (defun article-decode-HZ ()
2639   "Translate a HZ-encoded article."
2640   (interactive)
2641   (require 'rfc1843)
2642   (save-excursion
2643     (let ((inhibit-read-only t))
2644       (rfc1843-decode-region (point-min) (point-max)))))
2645
2646 (defun article-unsplit-urls ()
2647   "Remove the newlines that some other mailers insert into URLs."
2648   (interactive)
2649   (save-excursion
2650     (let ((inhibit-read-only t))
2651       (goto-char (point-min))
2652       (while (re-search-forward
2653               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2654         (replace-match "\\1\\3" t)))
2655     (when (interactive-p)
2656       (gnus-treat-article nil))))
2657
2658
2659 (defun article-wash-html (&optional read-charset)
2660   "Format an HTML article.
2661 If READ-CHARSET, ask for a coding system.  If it is a number, the
2662 charset defined in `gnus-summary-show-article-charset-alist' is used."
2663   (interactive "P")
2664   (save-excursion
2665     (let ((inhibit-read-only t)
2666           charset)
2667       (if read-charset
2668           (if (or (and (numberp read-charset)
2669                        (setq charset
2670                              (cdr
2671                               (assq read-charset
2672                                     gnus-summary-show-article-charset-alist))))
2673                   (setq charset (mm-read-coding-system "Charset: ")))
2674               (let ((gnus-summary-show-article-charset-alist
2675                      (list (cons 1 charset))))
2676                 (with-current-buffer gnus-summary-buffer
2677                   (gnus-summary-show-article 1)))
2678             (error "No charset is given"))
2679         (when (gnus-buffer-live-p gnus-original-article-buffer)
2680           (with-current-buffer gnus-original-article-buffer
2681             (let* ((ct (gnus-fetch-field "content-type"))
2682                    (ctl (and ct (mail-header-parse-content-type ct))))
2683               (setq charset (and ctl
2684                                  (mail-content-type-get ctl 'charset)))
2685               (when (stringp charset)
2686                 (setq charset (intern (downcase charset)))))))
2687         (unless charset
2688           (setq charset gnus-newsgroup-charset)))
2689       (article-goto-body)
2690       (save-window-excursion
2691         (save-restriction
2692           (narrow-to-region (point) (point-max))
2693           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2694                  (entry (assq func mm-text-html-washer-alist)))
2695             (when entry
2696               (setq func (cdr entry)))
2697             (cond
2698              ((functionp func)
2699               (funcall func))
2700              (t
2701               (apply (car func) (cdr func))))))))))
2702
2703 (defun gnus-article-wash-html-with-w3 ()
2704   "Wash the current buffer with w3."
2705   (mm-setup-w3)
2706   (let ((w3-strict-width (window-width))
2707         (url-standalone-mode t)
2708         (url-gateway-unplugged t)
2709         (w3-honor-stylesheets nil))
2710     (condition-case ()
2711         (w3-region (point-min) (point-max))
2712       (error))))
2713
2714 (defun gnus-article-wash-html-with-w3m ()
2715   "Wash the current buffer with emacs-w3m."
2716   (mm-setup-w3m)
2717   (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2718         w3m-force-redisplay)
2719     (w3m-region (point-min) (point-max)))
2720   (when (and mm-inline-text-html-with-w3m-keymap
2721              (boundp 'w3m-minor-mode-map)
2722              w3m-minor-mode-map)
2723     (add-text-properties
2724      (point-min) (point-max)
2725      (list 'keymap w3m-minor-mode-map
2726            ;; Put the mark meaning this part was rendered by emacs-w3m.
2727            'mm-inline-text-html-with-w3m t))))
2728
2729 (eval-when-compile (defvar charset)) ;; Bound by `article-wash-html'.
2730
2731 (defun gnus-article-wash-html-with-w3m-standalone ()
2732   "Wash the current buffer with w3m."
2733   (if (mm-w3m-standalone-supports-m17n-p)
2734       (progn
2735         (unless (mm-coding-system-p charset) ;; Bound by `article-wash-html'.
2736           ;; The default.
2737           (setq charset 'iso-8859-1))
2738         (let ((coding-system-for-write charset)
2739               (coding-system-for-read charset))
2740           (call-process-region
2741            (point-min) (point-max)
2742            "w3m" t t nil "-dump" "-T" "text/html"
2743            "-I" (symbol-name charset) "-O" (symbol-name charset))))
2744     (mm-inline-wash-with-stdin nil "w3m" "-dump" "-T" "text/html")))
2745
2746 (defvar gnus-article-browse-html-temp-list nil
2747   "List of temporary files created by `gnus-article-browse-html-parts'.
2748 Internal variable.")
2749
2750 (defcustom gnus-article-browse-delete-temp 'ask
2751   "What to do with temporary files from `gnus-article-browse-html-parts'.
2752 If nil, don't delete temporary files.  If it is t, delete them on
2753 exit from the summary buffer.  If it is the symbol `file', query
2754 on each file, if it is `ask' ask once when exiting from the
2755 summary buffer."
2756   :group 'gnus-article
2757   :version "23.0" ;; No Gnus
2758   :type '(choice (const :tag "Don't delete" nil)
2759                  (const :tag "Don't ask" t)
2760                  (const :tag "Ask" ask)
2761                  (const :tag "Ask for each file" file)))
2762
2763 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2764
2765 (defun gnus-article-browse-delete-temp-files (&optional how)
2766   "Delete temp-files created by `gnus-article-browse-html-parts'."
2767   (when (and gnus-article-browse-html-temp-list
2768              (or how
2769                  (setq how gnus-article-browse-delete-temp)))
2770     (when (and (eq how 'ask)
2771                (y-or-n-p (format
2772                           "Delete all %s temporary HTML file(s)? "
2773                           (length gnus-article-browse-html-temp-list)))
2774                (setq how t)))
2775     (dolist (file gnus-article-browse-html-temp-list)
2776       (when (and (file-exists-p file)
2777                  (or (eq how t)
2778                      ;; `how' is neither `nil', `ask' nor `t' (i.e. `file'):
2779                      (gnus-y-or-n-p
2780                       (format "Delete temporary HTML file `%s'? " file))))
2781         (delete-file file)))
2782     ;; Also remove file from the list when not deleted or if file doesn't
2783     ;; exist anymore.
2784     (setq gnus-article-browse-html-temp-list nil))
2785   gnus-article-browse-html-temp-list)
2786
2787 (defun gnus-article-browse-html-parts (list)
2788   "View all \"text/html\" parts from LIST.
2789 Recurse into multiparts."
2790   ;; Internal function used by `gnus-article-browse-html-article'.
2791   (let ((showed))
2792     ;; Find and show the html-parts.
2793     (dolist (handle list)
2794       ;; If HTML, show it:
2795       (when (listp handle)
2796         (cond ((and (bufferp (car handle))
2797                     (string-match "text/html" (car (mm-handle-type handle))))
2798                (let ((tmp-file (mm-make-temp-file
2799                                 ;; Do we need to care for 8.3 filenames?
2800                                 "mm-" nil ".html")))
2801                  (mm-save-part-to-file handle tmp-file)
2802                  (add-to-list 'gnus-article-browse-html-temp-list tmp-file)
2803                  (add-hook 'gnus-summary-prepare-exit-hook
2804                            'gnus-article-browse-delete-temp-files)
2805                  (add-hook 'gnus-exit-gnus-hook
2806                            (lambda  ()
2807                              (gnus-article-browse-delete-temp-files t)))
2808                  ;; FIXME: Warn if there's an <img> tag?
2809                  (browse-url-of-file tmp-file)
2810                  (setq showed t)))
2811               ;; If multipart, recurse
2812               ((and (stringp (car handle))
2813                     (string-match "^multipart/" (car handle))
2814                     (setq showed
2815                           (or showed
2816                               (gnus-article-browse-html-parts handle))))))))
2817     showed))
2818
2819 ;; FIXME: Documentation in texi/gnus.texi missing.
2820 (defun gnus-article-browse-html-article ()
2821   "View \"text/html\" parts of the current article with a WWW browser.
2822
2823 Warning: Spammers use links to images in HTML articles to verify
2824 whether you have read the message.  As
2825 `gnus-article-browse-html-article' passes the unmodified HTML
2826 content to the browser without eliminating these \"web bugs\" you
2827 should only use it for mails from trusted senders."
2828   ;; Cf. `mm-w3m-safe-url-regexp'
2829   (interactive)
2830   (save-window-excursion
2831     ;; Open raw article and select the buffer
2832     (gnus-summary-show-article t)
2833     (gnus-summary-select-article-buffer)
2834     (let ((parts (mm-dissect-buffer t t)))
2835       ;; If singlepart, enforce a list.
2836       (when (and (bufferp (car parts))
2837                  (stringp (car (mm-handle-type parts))))
2838         (setq parts (list parts)))
2839       ;; Process the list
2840       (unless (gnus-article-browse-html-parts parts)
2841         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
2842       (gnus-summary-show-article))))
2843
2844 (defun article-hide-list-identifiers ()
2845   "Remove list identifies from the Subject header.
2846 The `gnus-list-identifiers' variable specifies what to do."
2847   (interactive)
2848   (let ((inhibit-point-motion-hooks t)
2849         (regexp (if (consp gnus-list-identifiers)
2850                     (mapconcat 'identity gnus-list-identifiers " *\\|")
2851                   gnus-list-identifiers))
2852         (inhibit-read-only t))
2853     (when regexp
2854       (save-excursion
2855         (save-restriction
2856           (article-narrow-to-head)
2857           (goto-char (point-min))
2858           (while (re-search-forward
2859                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
2860                   nil t)
2861             (delete-region (match-beginning 2) (match-end 0))
2862             (beginning-of-line))
2863           (when (re-search-forward
2864                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
2865             (delete-region (match-beginning 1) (match-end 1))))))))
2866
2867 (defun article-hide-pem (&optional arg)
2868   "Toggle hiding of any PEM headers and signatures in the current article.
2869 If given a negative prefix, always show; if given a positive prefix,
2870 always hide."
2871   (interactive (gnus-article-hidden-arg))
2872   (unless (gnus-article-check-hidden-text 'pem arg)
2873     (save-excursion
2874       (let ((inhibit-read-only t) end)
2875         (goto-char (point-min))
2876         ;; Hide the horrendously ugly "header".
2877         (when (and (search-forward
2878                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
2879                     nil t)
2880                    (setq end (1+ (match-beginning 0))))
2881           (gnus-add-wash-type 'pem)
2882           (gnus-article-hide-text-type
2883            end
2884            (if (search-forward "\n\n" nil t)
2885                (match-end 0)
2886              (point-max))
2887            'pem)
2888           ;; Hide the trailer as well
2889           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
2890                                 nil t)
2891             (gnus-article-hide-text-type
2892              (match-beginning 0) (match-end 0) 'pem)))))))
2893
2894 (defun article-strip-banner ()
2895   "Strip the banners specified by the `banner' group parameter and by
2896 `gnus-article-address-banner-alist'."
2897   (interactive)
2898   (save-excursion
2899     (save-restriction
2900       (let ((inhibit-point-motion-hooks t))
2901         (when (gnus-parameter-banner gnus-newsgroup-name)
2902           (article-really-strip-banner
2903            (gnus-parameter-banner gnus-newsgroup-name)))
2904         (when gnus-article-address-banner-alist
2905           ;; Note that the From header is decoded here, so it is
2906           ;; required that the *-extract-address-components function
2907           ;; supports non-ASCII text.
2908           (let ((from (save-restriction
2909                         (widen)
2910                         (article-narrow-to-head)
2911                         (mail-fetch-field "from"))))
2912             (when (and from
2913                        (setq from
2914                              (cadr (funcall gnus-extract-address-components
2915                                             from))))
2916               (catch 'found
2917                 (dolist (pair gnus-article-address-banner-alist)
2918                   (when (string-match (car pair) from)
2919                     (throw 'found
2920                            (article-really-strip-banner (cdr pair)))))))))))))
2921
2922 (defun article-really-strip-banner (banner)
2923   "Strip the banner specified by the argument."
2924   (save-excursion
2925     (save-restriction
2926       (let ((inhibit-point-motion-hooks t)
2927             (gnus-signature-limit nil)
2928             (inhibit-read-only t))
2929         (article-goto-body)
2930         (cond
2931          ((eq banner 'signature)
2932           (when (gnus-article-narrow-to-signature)
2933             (widen)
2934             (forward-line -1)
2935             (delete-region (point) (point-max))))
2936          ((symbolp banner)
2937           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
2938               (while (re-search-forward banner nil t)
2939                 (delete-region (match-beginning 0) (match-end 0)))))
2940          ((stringp banner)
2941           (while (re-search-forward banner nil t)
2942             (delete-region (match-beginning 0) (match-end 0)))))))))
2943
2944 (defun article-babel ()
2945   "Translate article using an online translation service."
2946   (interactive)
2947   (require 'babel)
2948   (gnus-with-article-buffer
2949     (when (article-goto-body)
2950       (let* ((start (point))
2951              (end (point-max))
2952              (orig (buffer-substring start end))
2953              (trans (babel-as-string orig)))
2954         (save-restriction
2955           (narrow-to-region start end)
2956           (delete-region start end)
2957           (insert trans))))))
2958
2959 (defun article-hide-signature (&optional arg)
2960   "Hide the signature in the current article.
2961 If given a negative prefix, always show; if given a positive prefix,
2962 always hide."
2963   (interactive (gnus-article-hidden-arg))
2964   (unless (gnus-article-check-hidden-text 'signature arg)
2965     (save-excursion
2966       (save-restriction
2967         (let ((inhibit-read-only t))
2968           (when (gnus-article-narrow-to-signature)
2969             (gnus-article-hide-text-type
2970              (point-min) (point-max) 'signature))))))
2971   (gnus-set-mode-line 'article))
2972
2973 (defun article-strip-headers-in-body ()
2974   "Strip offensive headers from bodies."
2975   (interactive)
2976   (save-excursion
2977     (article-goto-body)
2978     (let ((case-fold-search t))
2979       (when (looking-at "x-no-archive:")
2980         (gnus-delete-line)))))
2981
2982 (defun article-strip-leading-blank-lines ()
2983   "Remove all blank lines from the beginning of the article."
2984   (interactive)
2985   (save-excursion
2986     (let ((inhibit-point-motion-hooks t)
2987           (inhibit-read-only t))
2988       (when (article-goto-body)
2989         (while (and (not (eobp))
2990                     (looking-at "[ \t]*$"))
2991           (gnus-delete-line))))))
2992
2993 (defun article-narrow-to-head ()
2994   "Narrow the buffer to the head of the message.
2995 Point is left at the beginning of the narrowed-to region."
2996   (narrow-to-region
2997    (goto-char (point-min))
2998    (if (search-forward "\n\n" nil 1)
2999        (1- (point))
3000      (point-max)))
3001   (goto-char (point-min)))
3002
3003 (defun article-goto-body ()
3004   "Place point at the start of the body."
3005   (goto-char (point-min))
3006   (cond
3007    ;; This variable is only bound when dealing with separate
3008    ;; MIME body parts.
3009    (article-goto-body-goes-to-point-min-p
3010     t)
3011    ((search-forward "\n\n" nil t)
3012     t)
3013    (t
3014     (goto-char (point-max))
3015     nil)))
3016
3017 (defun article-strip-multiple-blank-lines ()
3018   "Replace consecutive blank lines with one empty line."
3019   (interactive)
3020   (save-excursion
3021     (let ((inhibit-point-motion-hooks t)
3022           (inhibit-read-only t))
3023       ;; First make all blank lines empty.
3024       (article-goto-body)
3025       (while (re-search-forward "^[ \t]+$" nil t)
3026         (unless (gnus-annotation-in-region-p
3027                  (match-beginning 0) (match-end 0))
3028           (replace-match "" nil t)))
3029       ;; Then replace multiple empty lines with a single empty line.
3030       (article-goto-body)
3031       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3032         (unless (gnus-annotation-in-region-p
3033                  (match-beginning 0) (match-end 0))
3034           (delete-region (match-beginning 1) (match-end 1)))))))
3035
3036 (defun article-strip-leading-space ()
3037   "Remove all white space from the beginning of the lines in the article."
3038   (interactive)
3039   (save-excursion
3040     (let ((inhibit-point-motion-hooks t)
3041           (inhibit-read-only t))
3042       (article-goto-body)
3043       (while (re-search-forward "^[ \t]+" nil t)
3044         (replace-match "" t t)))))
3045
3046 (defun article-strip-trailing-space ()
3047   "Remove all white space from the end of the lines in the article."
3048   (interactive)
3049   (save-excursion
3050     (let ((inhibit-point-motion-hooks t)
3051           (inhibit-read-only t))
3052       (article-goto-body)
3053       (while (re-search-forward "[ \t]+$" nil t)
3054         (replace-match "" t t)))))
3055
3056 (defun article-strip-blank-lines ()
3057   "Strip leading, trailing and multiple blank lines."
3058   (interactive)
3059   (article-strip-leading-blank-lines)
3060   (article-remove-trailing-blank-lines)
3061   (article-strip-multiple-blank-lines))
3062
3063 (defun article-strip-all-blank-lines ()
3064   "Strip all blank lines."
3065   (interactive)
3066   (save-excursion
3067     (let ((inhibit-point-motion-hooks t)
3068           (inhibit-read-only t))
3069       (article-goto-body)
3070       (while (re-search-forward "^[ \t]*\n" nil t)
3071         (replace-match "" t t)))))
3072
3073 (defun gnus-article-narrow-to-signature ()
3074   "Narrow to the signature; return t if a signature is found, else nil."
3075   (let ((inhibit-point-motion-hooks t))
3076     (when (gnus-article-search-signature)
3077       (forward-line 1)
3078       ;; Check whether we have some limits to what we consider
3079       ;; to be a signature.
3080       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3081                       (list gnus-signature-limit)))
3082             limit limited)
3083         (while (setq limit (pop limits))
3084           (if (or (and (integerp limit)
3085                        (< (- (point-max) (point)) limit))
3086                   (and (floatp limit)
3087                        (< (count-lines (point) (point-max)) limit))
3088                   (and (functionp limit)
3089                        (funcall limit))
3090                   (and (stringp limit)
3091                        (not (re-search-forward limit nil t))))
3092               ()                        ; This limit did not succeed.
3093             (setq limited t
3094                   limits nil)))
3095         (unless limited
3096           (narrow-to-region (point) (point-max))
3097           t)))))
3098
3099 (defun gnus-article-search-signature ()
3100   "Search the current buffer for the signature separator.
3101 Put point at the beginning of the signature separator."
3102   (let ((cur (point)))
3103     (goto-char (point-max))
3104     (if (if (stringp gnus-signature-separator)
3105             (re-search-backward gnus-signature-separator nil t)
3106           (let ((seps gnus-signature-separator))
3107             (while (and seps
3108                         (not (re-search-backward (car seps) nil t)))
3109               (pop seps))
3110             seps))
3111         t
3112       (goto-char cur)
3113       nil)))
3114
3115 (defun gnus-article-hidden-arg ()
3116   "Return the current prefix arg as a number, or 0 if no prefix."
3117   (list (if current-prefix-arg
3118             (prefix-numeric-value current-prefix-arg)
3119           0)))
3120
3121 (defun gnus-article-check-hidden-text (type arg)
3122   "Return nil if hiding is necessary.
3123 Arg can be nil or a number.  nil and positive means hide, negative
3124 means show, 0 means toggle."
3125   (save-excursion
3126     (save-restriction
3127       (let ((hide (gnus-article-hidden-text-p type)))
3128         (cond
3129          ((or (null arg)
3130               (> arg 0))
3131           nil)
3132          ((< arg 0)
3133           (gnus-article-show-hidden-text type)
3134           t)
3135          (t
3136           (if (eq hide 'hidden)
3137               (progn
3138                 (gnus-article-show-hidden-text type)
3139                 t)
3140             nil)))))))
3141
3142 (defun gnus-article-hidden-text-p (type)
3143   "Say whether the current buffer contains hidden text of type TYPE."
3144   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3145     (while (and pos
3146                 (not (get-text-property pos 'invisible))
3147                 (not (get-text-property pos 'dummy-invisible)))
3148       (setq pos
3149             (text-property-any (1+ pos) (point-max) 'article-type type)))
3150     (if pos
3151         'hidden
3152       nil)))
3153
3154 (defun gnus-article-show-hidden-text (type &optional dummy)
3155   "Show all hidden text of type TYPE.
3156 Originally it is hide instead of DUMMY."
3157   (let ((inhibit-read-only t)
3158         (inhibit-point-motion-hooks t))
3159     (gnus-remove-text-properties-when
3160      'article-type type
3161      (point-min) (point-max)
3162      (cons 'article-type (cons type
3163                                gnus-hidden-properties)))
3164     (gnus-delete-wash-type type)))
3165
3166 (defconst article-time-units
3167   `((year . ,(* 365.25 24 60 60))
3168     (week . ,(* 7 24 60 60))
3169     (day . ,(* 24 60 60))
3170     (hour . ,(* 60 60))
3171     (minute . 60)
3172     (second . 1))
3173   "Mapping from time units to seconds.")
3174
3175 (defun gnus-article-forward-header ()
3176   "Move point to the start of the next header.
3177 If the current header is a continuation header, this can be several
3178 lines forward."
3179   (let ((ended nil))
3180     (while (not ended)
3181       (forward-line 1)
3182       (if (looking-at "[ \t]+[^ \t]")
3183           (forward-line 1)
3184         (setq ended t)))))
3185
3186 (defun article-date-ut (&optional type highlight)
3187   "Convert DATE date to universal time in the current article.
3188 If TYPE is `local', convert to local time; if it is `lapsed', output
3189 how much time has lapsed since DATE.  For `lapsed', the value of
3190 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3191 should replace the \"Date:\" one, or should be added below it."
3192   (interactive (list 'ut t))
3193   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3194          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3195                              tdate-regexp)
3196                             ((eq type 'lapsed)
3197                              "^X-Sent:[ \t]")
3198                             (article-lapsed-timer
3199                              "^Date:[ \t]")
3200                             (t
3201                              tdate-regexp)))
3202          (case-fold-search t)
3203          (inhibit-read-only t)
3204          (inhibit-point-motion-hooks t)
3205          pos date bface eface)
3206     (save-excursion
3207       (save-restriction
3208         (widen)
3209         (goto-char (point-min))
3210         (while (or (setq date (get-text-property (setq pos (point))
3211                                                  'original-date))
3212                    (when (setq pos (next-single-property-change
3213                                     (point) 'original-date))
3214                      (setq date (get-text-property pos 'original-date))
3215                      t))
3216           (narrow-to-region pos (or (text-property-any pos (point-max)
3217                                                        'original-date nil)
3218                                     (point-max)))
3219           (goto-char (point-min))
3220           (when (re-search-forward tdate-regexp nil t)
3221             (setq bface (get-text-property (point-at-bol) 'face)
3222                   eface (get-text-property (1- (point-at-eol)) 'face)))
3223           (goto-char (point-min))
3224           (setq pos nil)
3225           ;; Delete any old Date headers.
3226           (while (re-search-forward date-regexp nil t)
3227             (if pos
3228                 (delete-region (point-at-bol) (progn
3229                                                 (gnus-article-forward-header)
3230                                                 (point)))
3231               (delete-region (point-at-bol) (progn
3232                                               (gnus-article-forward-header)
3233                                               (forward-char -1)
3234                                               (point)))
3235               (setq pos (point))))
3236           (when (and (not pos)
3237                      (re-search-forward tdate-regexp nil t))
3238             (forward-line 1))
3239           (gnus-goto-char pos)
3240           (insert (article-make-date-line date (or type 'ut)))
3241           (unless pos
3242             (insert "\n")
3243             (forward-line -1))
3244           ;; Do highlighting.
3245           (beginning-of-line)
3246           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3247             (put-text-property (match-beginning 1) (1+ (match-end 1))
3248                                'face bface)
3249             (put-text-property (match-beginning 2) (match-end 2)
3250                                'face eface))
3251           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3252           (goto-char (point-max))
3253           (widen))))))
3254
3255 (defun article-make-date-line (date type)
3256   "Return a DATE line of TYPE."
3257   (unless (memq type '(local ut original user iso8601 lapsed english))
3258     (error "Unknown conversion type: %s" type))
3259   (condition-case ()
3260       (let ((time (date-to-time date)))
3261         (cond
3262          ;; Convert to the local timezone.
3263          ((eq type 'local)
3264           (concat "Date: " (message-make-date time)))
3265          ;; Convert to Universal Time.
3266          ((eq type 'ut)
3267           (concat "Date: "
3268                   (substring
3269                    (message-make-date
3270                     (let* ((e (parse-time-string date))
3271                            (tm (apply 'encode-time e))
3272                            (ms (car tm))
3273                            (ls (- (cadr tm) (car (current-time-zone time)))))
3274                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3275                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3276                             (t (list ms ls)))))
3277                    0 -5)
3278                   "UT"))
3279          ;; Get the original date from the article.
3280          ((eq type 'original)
3281           (concat "Date: " (if (string-match "\n+$" date)
3282                                (substring date 0 (match-beginning 0))
3283                              date)))
3284          ;; Let the user define the format.
3285          ((eq type 'user)
3286           (let ((format (or (condition-case nil
3287                                 (with-current-buffer gnus-summary-buffer
3288                                   gnus-article-time-format)
3289                               (error nil))
3290                             gnus-article-time-format)))
3291             (if (functionp format)
3292                 (funcall format time)
3293               (concat "Date: " (format-time-string format time)))))
3294          ;; ISO 8601.
3295          ((eq type 'iso8601)
3296           (let ((tz (car (current-time-zone time))))
3297             (concat
3298              "Date: "
3299              (format-time-string "%Y%m%dT%H%M%S" time)
3300              (format "%s%02d%02d"
3301                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3302                      (/ (% (abs tz) 3600) 60)))))
3303          ;; Do an X-Sent lapsed format.
3304          ((eq type 'lapsed)
3305           ;; If the date is seriously mangled, the timezone functions are
3306           ;; liable to bug out, so we ignore all errors.
3307           (let* ((now (current-time))
3308                  (real-time (subtract-time now time))
3309                  (real-sec (and real-time
3310                                 (+ (* (float (car real-time)) 65536)
3311                                    (cadr real-time))))
3312                  (sec (and real-time (abs real-sec)))
3313                  num prev)
3314             (cond
3315              ((null real-time)
3316               "X-Sent: Unknown")
3317              ((zerop sec)
3318               "X-Sent: Now")
3319              (t
3320               (concat
3321                "X-Sent: "
3322                ;; This is a bit convoluted, but basically we go
3323                ;; through the time units for years, weeks, etc,
3324                ;; and divide things to see whether that results
3325                ;; in positive answers.
3326                (mapconcat
3327                 (lambda (unit)
3328                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3329                       ;; The (remaining) seconds are too few to
3330                       ;; be divided into this time unit.
3331                       ""
3332                     ;; It's big enough, so we output it.
3333                     (setq sec (- sec (* num (cdr unit))))
3334                     (prog1
3335                         (concat (if prev ", " "") (int-to-string
3336                                                    (floor num))
3337                                 " " (symbol-name (car unit))
3338                                 (if (> num 1) "s" ""))
3339                       (setq prev t))))
3340                 article-time-units "")
3341                ;; If dates are odd, then it might appear like the
3342                ;; article was sent in the future.
3343                (if (> real-sec 0)
3344                    " ago"
3345                  " in the future"))))))
3346          ;; Display the date in proper English
3347          ((eq type 'english)
3348           (let ((dtime (decode-time time)))
3349             (concat
3350              "Date: the "
3351              (number-to-string (nth 3 dtime))
3352              (let ((digit (% (nth 3 dtime) 10)))
3353                (cond
3354                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3355                 ((= digit 1) "st")
3356                 ((= digit 2) "nd")
3357                 ((= digit 3) "rd")
3358                 (t "th")))
3359              " of "
3360              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3361              " "
3362              (number-to-string (nth 5 dtime))
3363              " at "
3364              (format "%02d" (nth 2 dtime))
3365              ":"
3366              (format "%02d" (nth 1 dtime)))))))
3367     (error
3368      (format "Date: %s (from Gnus)" date))))
3369
3370 (defun article-date-local (&optional highlight)
3371   "Convert the current article date to the local timezone."
3372   (interactive (list t))
3373   (article-date-ut 'local highlight))
3374
3375 (defun article-date-english (&optional highlight)
3376   "Convert the current article date to something that is proper English."
3377   (interactive (list t))
3378   (article-date-ut 'english highlight))
3379
3380 (defun article-date-original (&optional highlight)
3381   "Convert the current article date to what it was originally.
3382 This is only useful if you have used some other date conversion
3383 function and want to see what the date was before converting."
3384   (interactive (list t))
3385   (article-date-ut 'original highlight))
3386
3387 (defun article-date-lapsed (&optional highlight)
3388   "Convert the current article date to time lapsed since it was sent."
3389   (interactive (list t))
3390   (article-date-ut 'lapsed highlight))
3391
3392 (defun article-update-date-lapsed ()
3393   "Function to be run from a timer to update the lapsed time line."
3394   (save-match-data
3395     (let (deactivate-mark)
3396       (save-excursion
3397         (ignore-errors
3398          (walk-windows
3399           (lambda (w)
3400             (set-buffer (window-buffer w))
3401             (when (eq major-mode 'gnus-article-mode)
3402               (let ((mark (point-marker)))
3403                 (goto-char (point-min))
3404                 (when (re-search-forward "^X-Sent:" nil t)
3405                   (article-date-lapsed t))
3406                 (goto-char (marker-position mark))
3407                 (move-marker mark nil))))
3408           nil 'visible))))))
3409
3410 (defun gnus-start-date-timer (&optional n)
3411   "Start a timer to update the X-Sent header in the article buffers.
3412 The numerical prefix says how frequently (in seconds) the function
3413 is to run."
3414   (interactive "p")
3415   (unless n
3416     (setq n 1))
3417   (gnus-stop-date-timer)
3418   (setq article-lapsed-timer
3419         (run-at-time 1 n 'article-update-date-lapsed)))
3420
3421 (defun gnus-stop-date-timer ()
3422   "Stop the X-Sent timer."
3423   (interactive)
3424   (when article-lapsed-timer
3425     (nnheader-cancel-timer article-lapsed-timer)
3426     (setq article-lapsed-timer nil)))
3427
3428 (defun article-date-user (&optional highlight)
3429   "Convert the current article date to the user-defined format.
3430 This format is defined by the `gnus-article-time-format' variable."
3431   (interactive (list t))
3432   (article-date-ut 'user highlight))
3433
3434 (defun article-date-iso8601 (&optional highlight)
3435   "Convert the current article date to ISO8601."
3436   (interactive (list t))
3437   (article-date-ut 'iso8601 highlight))
3438
3439 (defmacro gnus-article-save-original-date (&rest forms)
3440   "Save the original date as a text property and evaluate FORMS."
3441   `(let* ((case-fold-search t)
3442           (start (progn
3443                    (goto-char (point-min))
3444                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3445                               (not (bolp)))
3446                      (match-end 0))))
3447           (date (when (and start
3448                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3449                                               nil t))
3450                   (buffer-substring-no-properties start
3451                                                   (match-beginning 0)))))
3452      (goto-char (point-max))
3453      (skip-chars-backward "\n")
3454      (put-text-property (point-min) (point) 'original-date date)
3455      ,@forms
3456      (goto-char (point-max))
3457      (skip-chars-backward "\n")
3458      (put-text-property (point-min) (point) 'original-date date)))
3459
3460 ;; (defun article-show-all ()
3461 ;;   "Show all hidden text in the article buffer."
3462 ;;   (interactive)
3463 ;;   (save-excursion
3464 ;;     (let ((inhibit-read-only t))
3465 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3466
3467 (defun article-remove-leading-whitespace ()
3468   "Remove excessive whitespace from all headers."
3469   (interactive)
3470   (save-excursion
3471     (save-restriction
3472       (let ((inhibit-read-only t))
3473         (article-narrow-to-head)
3474         (goto-char (point-min))
3475         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3476           (delete-region (match-beginning 1) (match-end 1)))))))
3477
3478 (defun article-emphasize (&optional arg)
3479   "Emphasize text according to `gnus-emphasis-alist'."
3480   (interactive (gnus-article-hidden-arg))
3481   (unless (gnus-article-check-hidden-text 'emphasis arg)
3482     (save-excursion
3483       (let ((alist (or
3484                     (condition-case nil
3485                         (with-current-buffer gnus-summary-buffer
3486                           gnus-article-emphasis-alist)
3487                       (error))
3488                     gnus-emphasis-alist))
3489             (inhibit-read-only t)
3490             (props (append '(article-type emphasis)
3491                            gnus-hidden-properties))
3492             regexp elem beg invisible visible face)
3493         (article-goto-body)
3494         (setq beg (point))
3495         (while (setq elem (pop alist))
3496           (goto-char beg)
3497           (setq regexp (car elem)
3498                 invisible (nth 1 elem)
3499                 visible (nth 2 elem)
3500                 face (nth 3 elem))
3501           (while (re-search-forward regexp nil t)
3502             (when (and (match-beginning visible) (match-beginning invisible))
3503               (gnus-article-hide-text
3504                (match-beginning invisible) (match-end invisible) props)
3505               (gnus-article-unhide-text-type
3506                (match-beginning visible) (match-end visible) 'emphasis)
3507               (gnus-put-overlay-excluding-newlines
3508                (match-beginning visible) (match-end visible) 'face face)
3509               (gnus-add-wash-type 'emphasis)
3510               (goto-char (match-end invisible)))))))))
3511
3512 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3513   "Setup newsgroup emphasis alist."
3514   (unless gnus-article-emphasis-alist
3515     (let ((name (and gnus-newsgroup-name
3516                      (gnus-group-real-name gnus-newsgroup-name))))
3517       (make-local-variable 'gnus-article-emphasis-alist)
3518       (setq gnus-article-emphasis-alist
3519             (nconc
3520              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3521                (while (setq elem (pop alist))
3522                  (when (and name (string-match (car elem) name))
3523                    (setq alist nil
3524                          highlight (copy-sequence (cdr elem)))))
3525                highlight)
3526              (copy-sequence highlight-words)
3527              (if gnus-newsgroup-name
3528                  (copy-sequence (gnus-group-find-parameter
3529                                  gnus-newsgroup-name 'highlight-words t)))
3530              gnus-emphasis-alist)))))
3531
3532 (eval-when-compile
3533   (defvar gnus-summary-article-menu)
3534   (defvar gnus-summary-post-menu))
3535
3536 ;;; Saving functions.
3537
3538 (defun gnus-article-save (save-buffer file &optional num)
3539   "Save the currently selected article."
3540   (when (or (get gnus-default-article-saver :headers)
3541             (not gnus-save-all-headers))
3542     ;; Remove headers according to `gnus-saved-headers' or the value
3543     ;; of the `:headers' property that the saver function might have.
3544     (let ((gnus-visible-headers
3545            (or (symbol-value (get gnus-default-article-saver :headers))
3546                gnus-saved-headers gnus-visible-headers))
3547           (gnus-article-buffer save-buffer))
3548       (save-excursion
3549         (set-buffer save-buffer)
3550         (article-hide-headers 1 t))))
3551   (save-window-excursion
3552     (if (not gnus-default-article-saver)
3553         (error "No default saver is defined")
3554       ;; !!! Magic!  The saving functions all save
3555       ;; `gnus-save-article-buffer' (or so they think), but we
3556       ;; bind that variable to our save-buffer.
3557       (set-buffer gnus-article-buffer)
3558       (let* ((gnus-save-article-buffer save-buffer)
3559              (filename
3560               (cond
3561                ((not gnus-prompt-before-saving) 'default)
3562                ((eq gnus-prompt-before-saving 'always) nil)
3563                (t file)))
3564              (gnus-number-of-articles-to-be-saved
3565               (when (eq gnus-prompt-before-saving t)
3566                 num)))                  ; Magic
3567         (set-buffer gnus-article-current-summary)
3568         (funcall gnus-default-article-saver filename)))))
3569
3570 (defun gnus-read-save-file-name (prompt &optional filename
3571                                         function group headers variable
3572                                         dir-var)
3573   (let ((default-name
3574           (funcall function group headers (symbol-value variable)))
3575         result)
3576     (setq result
3577           (expand-file-name
3578            (cond
3579             ((eq filename 'default)
3580              default-name)
3581             ((eq filename t)
3582              default-name)
3583             (filename filename)
3584             (t
3585              (when (symbol-value dir-var)
3586                (setq default-name (expand-file-name
3587                                    (file-name-nondirectory default-name)
3588                                    (symbol-value dir-var))))
3589              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3590                     (prompt
3591                      (format prompt
3592                              (if (and gnus-number-of-articles-to-be-saved
3593                                       (> gnus-number-of-articles-to-be-saved 1))
3594                                  (format "these %d articles"
3595                                          gnus-number-of-articles-to-be-saved)
3596                                "this article")))
3597                     (file
3598                      ;; Let the split methods have their say.
3599                      (cond
3600                       ;; No split name was found.
3601                       ((null split-name)
3602                        (read-file-name
3603                         (concat prompt " (default "
3604                                 (file-name-nondirectory default-name) "): ")
3605                         (file-name-directory default-name)
3606                         default-name))
3607                       ;; A single group name is returned.
3608                       ((stringp split-name)
3609                        (setq default-name
3610                              (funcall function split-name headers
3611                                       (symbol-value variable)))
3612                        (read-file-name
3613                         (concat prompt " (default "
3614                                 (file-name-nondirectory default-name) "): ")
3615                         (file-name-directory default-name)
3616                         default-name))
3617                       ;; A single split name was found
3618                       ((= 1 (length split-name))
3619                        (let* ((name (expand-file-name
3620                                      (car split-name)
3621                                      gnus-article-save-directory))
3622                               (dir (cond ((file-directory-p name)
3623                                           (file-name-as-directory name))
3624                                          ((file-exists-p name) name)
3625                                          (t gnus-article-save-directory))))
3626                          (read-file-name
3627                           (concat prompt " (default " name "): ")
3628                           dir name)))
3629                       ;; A list of splits was found.
3630                       (t
3631                        (setq split-name (nreverse split-name))
3632                        (let (result)
3633                          (let ((file-name-history
3634                                 (nconc split-name file-name-history)))
3635                            (setq result
3636                                  (expand-file-name
3637                                   (read-file-name
3638                                    (concat prompt " (`M-p' for defaults): ")
3639                                    gnus-article-save-directory
3640                                    (car split-name))
3641                                   gnus-article-save-directory)))
3642                          (car (push result file-name-history)))))))
3643                ;; Create the directory.
3644                (gnus-make-directory (file-name-directory file))
3645                ;; If we have read a directory, we append the default file name.
3646                (when (file-directory-p file)
3647                  (setq file (expand-file-name (file-name-nondirectory
3648                                                default-name)
3649                                               (file-name-as-directory file))))
3650                ;; Possibly translate some characters.
3651                (nnheader-translate-file-chars file))))))
3652     (gnus-make-directory (file-name-directory result))
3653     (when variable
3654       (set variable result))
3655     (when dir-var
3656       (set dir-var (file-name-directory result)))
3657     result))
3658
3659 (defun gnus-article-archive-name (group)
3660   "Return the first instance of an \"Archive-name\" in the current buffer."
3661   (let ((case-fold-search t))
3662     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3663       (nnheader-concat gnus-article-save-directory
3664                        (match-string 1)))))
3665
3666 (defun gnus-article-nndoc-name (group)
3667   "If GROUP is an nndoc group, return the name of the parent group."
3668   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3669     (gnus-group-get-parameter group 'save-article-group)))
3670
3671 (defun gnus-summary-save-in-rmail (&optional filename)
3672   "Append this article to Rmail file.
3673 Optional argument FILENAME specifies file name.
3674 Directory to save to is default to `gnus-article-save-directory'."
3675   (setq filename (gnus-read-save-file-name
3676                   "Save %s in rmail file" filename
3677                   gnus-rmail-save-name gnus-newsgroup-name
3678                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3679   (gnus-eval-in-buffer-window gnus-save-article-buffer
3680     (save-excursion
3681       (save-restriction
3682         (widen)
3683         (gnus-output-to-rmail filename))))
3684   filename)
3685
3686 (defun gnus-summary-save-in-mail (&optional filename)
3687   "Append this article to Unix mail file.
3688 Optional argument FILENAME specifies file name.
3689 Directory to save to is default to `gnus-article-save-directory'."
3690   (setq filename (gnus-read-save-file-name
3691                   "Save %s in Unix mail file" filename
3692                   gnus-mail-save-name gnus-newsgroup-name
3693                   gnus-current-headers 'gnus-newsgroup-last-mail))
3694   (gnus-eval-in-buffer-window gnus-save-article-buffer
3695     (save-excursion
3696       (save-restriction
3697         (widen)
3698         (if (and (file-readable-p filename)
3699                  (file-regular-p filename)
3700                  (mail-file-babyl-p filename))
3701             (rmail-output-to-rmail-file filename t)
3702           (gnus-output-to-mail filename)))))
3703   filename)
3704
3705 (put 'gnus-summary-save-in-file :decode t)
3706 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3707 (defun gnus-summary-save-in-file (&optional filename overwrite)
3708   "Append this article to file.
3709 Optional argument FILENAME specifies file name.
3710 Directory to save to is default to `gnus-article-save-directory'."
3711   (setq filename (gnus-read-save-file-name
3712                   "Save %s in file" filename
3713                   gnus-file-save-name gnus-newsgroup-name
3714                   gnus-current-headers 'gnus-newsgroup-last-file))
3715   (gnus-eval-in-buffer-window gnus-save-article-buffer
3716     (save-excursion
3717       (save-restriction
3718         (widen)
3719         (when (and overwrite
3720                    (file-exists-p filename))
3721           (delete-file filename))
3722         (gnus-output-to-file filename))))
3723   filename)
3724
3725 (put 'gnus-summary-write-to-file :decode t)
3726 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
3727 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
3728 (defun gnus-summary-write-to-file (&optional filename)
3729   "Write this article to a file, overwriting it if the file exists.
3730 Optional argument FILENAME specifies file name.
3731 The directory to save in defaults to `gnus-article-save-directory'."
3732   (setq filename (gnus-read-save-file-name
3733                   "Save %s in file" filename
3734                   gnus-file-save-name gnus-newsgroup-name
3735                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3736   (gnus-summary-save-in-file filename t))
3737
3738 (put 'gnus-summary-save-body-in-file :decode t)
3739 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
3740   "Append this article body to a file.
3741 Optional argument FILENAME specifies file name.
3742 The directory to save in defaults to `gnus-article-save-directory'."
3743   (setq filename (gnus-read-save-file-name
3744                   "Save %s body in file" filename
3745                   gnus-file-save-name gnus-newsgroup-name
3746                   gnus-current-headers 'gnus-newsgroup-last-file))
3747   (gnus-eval-in-buffer-window gnus-save-article-buffer
3748     (save-excursion
3749       (save-restriction
3750         (widen)
3751         (when (article-goto-body)
3752           (narrow-to-region (point) (point-max)))
3753         (when (and overwrite
3754                    (file-exists-p filename))
3755           (delete-file filename))
3756         (gnus-output-to-file filename))))
3757   filename)
3758
3759 (put 'gnus-summary-write-body-to-file :decode t)
3760 (put 'gnus-summary-write-body-to-file
3761      :function 'gnus-summary-save-body-in-file)
3762 (defun gnus-summary-write-body-to-file (&optional filename)
3763   "Write this article body to a file, overwriting it if the file exists.
3764 Optional argument FILENAME specifies file name.
3765 The directory to save in defaults to `gnus-article-save-directory'."
3766   (setq filename (gnus-read-save-file-name
3767                   "Save %s body in file" filename
3768                   gnus-file-save-name gnus-newsgroup-name
3769                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3770   (gnus-summary-save-body-in-file filename t))
3771
3772 (defun gnus-summary-save-in-pipe (&optional command)
3773   "Pipe this article to subprocess."
3774   (setq command
3775         (cond ((and (eq command 'default)
3776                     gnus-last-shell-command)
3777                gnus-last-shell-command)
3778               ((stringp command)
3779                command)
3780               (t (read-string
3781                   (format
3782                    "Shell command on %s: "
3783                    (if (and gnus-number-of-articles-to-be-saved
3784                             (> gnus-number-of-articles-to-be-saved 1))
3785                        (format "these %d articles"
3786                                gnus-number-of-articles-to-be-saved)
3787                      "this article"))
3788                   gnus-last-shell-command))))
3789   (when (string-equal command "")
3790     (if gnus-last-shell-command
3791         (setq command gnus-last-shell-command)
3792       (error "A command is required")))
3793   (gnus-eval-in-buffer-window gnus-article-buffer
3794     (save-restriction
3795       (widen)
3796       (shell-command-on-region (point-min) (point-max) command nil)))
3797   (setq gnus-last-shell-command command))
3798
3799 (defun gnus-summary-pipe-to-muttprint (&optional command)
3800   "Pipe this article to muttprint."
3801   (setq command (read-string
3802                  "Print using command: " gnus-summary-muttprint-program
3803                  nil gnus-summary-muttprint-program))
3804   (gnus-summary-save-in-pipe command))
3805
3806 ;;; Article file names when saving.
3807
3808 (defun gnus-capitalize-newsgroup (newsgroup)
3809   "Capitalize NEWSGROUP name."
3810   (when (not (zerop (length newsgroup)))
3811     (concat (char-to-string (upcase (aref newsgroup 0)))
3812             (substring newsgroup 1))))
3813
3814 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3815   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3816 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3817 Otherwise, it is like ~/News/news/group/num."
3818   (let ((default
3819           (expand-file-name
3820            (concat (if (gnus-use-long-file-name 'not-save)
3821                        (gnus-capitalize-newsgroup newsgroup)
3822                      (gnus-newsgroup-directory-form newsgroup))
3823                    "/" (int-to-string (mail-header-number headers)))
3824            gnus-article-save-directory)))
3825     (if (and last-file
3826              (string-equal (file-name-directory default)
3827                            (file-name-directory last-file))
3828              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3829         default
3830       (or last-file default))))
3831
3832 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
3833   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3834 If variable `gnus-use-long-file-name' is non-nil, it is
3835 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
3836   (let ((default
3837           (expand-file-name
3838            (concat (if (gnus-use-long-file-name 'not-save)
3839                        newsgroup
3840                      (gnus-newsgroup-directory-form newsgroup))
3841                    "/" (int-to-string (mail-header-number headers)))
3842            gnus-article-save-directory)))
3843     (if (and last-file
3844              (string-equal (file-name-directory default)
3845                            (file-name-directory last-file))
3846              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
3847         default
3848       (or last-file default))))
3849
3850 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
3851   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3852 If variable `gnus-use-long-file-name' is non-nil, it is
3853 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
3854   (or last-file
3855       (expand-file-name
3856        (if (gnus-use-long-file-name 'not-save)
3857            newsgroup
3858          (file-relative-name
3859           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
3860           default-directory))
3861        gnus-article-save-directory)))
3862
3863 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
3864   "Generate file name from sender."
3865   (let ((from (mail-header-from headers)))
3866     (expand-file-name
3867      (if (and from (string-match "\\([^ <]+\\)@" from))
3868          (match-string 1 from)
3869        "nobody")
3870      gnus-article-save-directory)))
3871
3872 (defun article-verify-x-pgp-sig ()
3873   "Verify X-PGP-Sig."
3874   (interactive)
3875   (if (gnus-buffer-live-p gnus-original-article-buffer)
3876       (let ((sig (with-current-buffer gnus-original-article-buffer
3877                    (gnus-fetch-field "X-PGP-Sig")))
3878             items info headers)
3879         (when (and sig
3880                    mml2015-use
3881                    (mml2015-clear-verify-function))
3882           (with-temp-buffer
3883             (insert-buffer-substring gnus-original-article-buffer)
3884             (setq items (split-string sig))
3885             (message-narrow-to-head)
3886             (let ((inhibit-point-motion-hooks t)
3887                   (case-fold-search t))
3888               ;; Don't verify multiple headers.
3889               (setq headers (mapconcat (lambda (header)
3890                                          (concat header ": "
3891                                                  (mail-fetch-field header)
3892                                                  "\n"))
3893                                        (split-string (nth 1 items) ",") "")))
3894             (delete-region (point-min) (point-max))
3895             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
3896             (insert "X-Signed-Headers: " (nth 1 items) "\n")
3897             (insert headers)
3898             (widen)
3899             (forward-line)
3900             (while (not (eobp))
3901               (if (looking-at "^-")
3902                   (insert "- "))
3903               (forward-line))
3904             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
3905             (insert "Version: " (car items) "\n\n")
3906             (insert (mapconcat 'identity (cddr items) "\n"))
3907             (insert "\n-----END PGP SIGNATURE-----\n")
3908             (let ((mm-security-handle (list (format "multipart/signed"))))
3909               (mml2015-clean-buffer)
3910               (let ((coding-system-for-write (or gnus-newsgroup-charset
3911                                                  'iso-8859-1)))
3912                 (funcall (mml2015-clear-verify-function)))
3913               (setq info
3914                     (or (mm-handle-multipart-ctl-parameter
3915                          mm-security-handle 'gnus-details)
3916                         (mm-handle-multipart-ctl-parameter
3917                          mm-security-handle 'gnus-info)))))
3918           (when info
3919             (let ((inhibit-read-only t) bface eface)
3920               (save-restriction
3921                 (message-narrow-to-head)
3922                 (goto-char (point-max))
3923                 (forward-line -1)
3924                 (setq bface (get-text-property (point-at-bol) 'face)
3925                       eface (get-text-property (1- (point-at-eol)) 'face))
3926                 (message-remove-header "X-Gnus-PGP-Verify")
3927                 (if (re-search-forward "^X-PGP-Sig:" nil t)
3928                     (forward-line)
3929                   (goto-char (point-max)))
3930                 (narrow-to-region (point) (point))
3931                 (insert "X-Gnus-PGP-Verify: " info "\n")
3932                 (goto-char (point-min))
3933                 (forward-line)
3934                 (while (not (eobp))
3935                   (if (not (looking-at "^[ \t]"))
3936                       (insert " "))
3937                   (forward-line))
3938                 ;; Do highlighting.
3939                 (goto-char (point-min))
3940                 (when (looking-at "\\([^:]+\\): *")
3941                   (put-text-property (match-beginning 1) (1+ (match-end 1))
3942                                      'face bface)
3943                   (put-text-property (match-end 0) (point-max)
3944                                      'face eface)))))))))
3945
3946 (defun article-verify-cancel-lock ()
3947   "Verify Cancel-Lock header."
3948   (interactive)
3949   (if (gnus-buffer-live-p gnus-original-article-buffer)
3950       (canlock-verify gnus-original-article-buffer)))
3951
3952 (eval-and-compile
3953   (mapc
3954    (lambda (func)
3955      (let (afunc gfunc)
3956        (if (consp func)
3957            (setq afunc (car func)
3958                  gfunc (cdr func))
3959          (setq afunc func
3960                gfunc (intern (format "gnus-%s" func))))
3961        (defalias gfunc
3962          (when (fboundp afunc)
3963            `(lambda (&optional interactive &rest args)
3964               ,(documentation afunc t)
3965               (interactive (list t))
3966               (save-excursion
3967                 (set-buffer gnus-article-buffer)
3968                 (if interactive
3969                     (call-interactively ',afunc)
3970                   (apply ',afunc args))))))))
3971    '(article-hide-headers
3972      article-verify-x-pgp-sig
3973      article-verify-cancel-lock
3974      article-hide-boring-headers
3975      article-treat-overstrike
3976      article-treat-ansi-sequences
3977      article-fill-long-lines
3978      article-capitalize-sentences
3979      article-remove-cr
3980      article-remove-leading-whitespace
3981      article-display-x-face
3982      article-display-face
3983      article-de-quoted-unreadable
3984      article-de-base64-unreadable
3985      article-decode-HZ
3986      article-wash-html
3987      article-unsplit-urls
3988      article-hide-list-identifiers
3989      article-strip-banner
3990      article-babel
3991      article-hide-pem
3992      article-hide-signature
3993      article-strip-headers-in-body
3994      article-remove-trailing-blank-lines
3995      article-strip-leading-blank-lines
3996      article-strip-multiple-blank-lines
3997      article-strip-leading-space
3998      article-strip-trailing-space
3999      article-strip-blank-lines
4000      article-strip-all-blank-lines
4001      article-date-local
4002      article-date-english
4003      article-date-iso8601
4004      article-date-original
4005      article-date-ut
4006      article-decode-mime-words
4007      article-decode-charset
4008      article-decode-encoded-words
4009      article-date-user
4010      article-date-lapsed
4011      article-emphasize
4012      article-treat-dumbquotes
4013      article-normalize-headers
4014      ;;(article-show-all . gnus-article-show-all-headers)
4015      )))
4016 \f
4017 ;;;
4018 ;;; Gnus article mode
4019 ;;;
4020
4021 (put 'gnus-article-mode 'mode-class 'special)
4022
4023 (set-keymap-parent gnus-article-mode-map widget-keymap)
4024
4025 (gnus-define-keys gnus-article-mode-map
4026   " " gnus-article-goto-next-page
4027   "\177" gnus-article-goto-prev-page
4028   [delete] gnus-article-goto-prev-page
4029   [backspace] gnus-article-goto-prev-page
4030   "\C-c^" gnus-article-refer-article
4031   "h" gnus-article-show-summary
4032   "s" gnus-article-show-summary
4033   "\C-c\C-m" gnus-article-mail
4034   "?" gnus-article-describe-briefly
4035   "e" gnus-summary-edit-article
4036   "<" beginning-of-buffer
4037   ">" end-of-buffer
4038   "\C-c\C-i" gnus-info-find-node
4039   "\C-c\C-b" gnus-bug
4040   "R" gnus-article-reply-with-original
4041   "F" gnus-article-followup-with-original
4042   "\C-hk" gnus-article-describe-key
4043   "\C-hc" gnus-article-describe-key-briefly
4044
4045   "\C-d" gnus-article-read-summary-keys
4046   "\M-*" gnus-article-read-summary-keys
4047   "\M-#" gnus-article-read-summary-keys
4048   "\M-^" gnus-article-read-summary-keys
4049   "\M-g" gnus-article-read-summary-keys)
4050
4051 (substitute-key-definition
4052  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4053
4054 (defun gnus-article-make-menu-bar ()
4055   (unless (boundp 'gnus-article-commands-menu)
4056     (gnus-summary-make-menu-bar))
4057   (gnus-turn-off-edit-menu 'article)
4058   (unless (boundp 'gnus-article-article-menu)
4059     (easy-menu-define
4060      gnus-article-article-menu gnus-article-mode-map ""
4061      '("Article"
4062        ["Scroll forwards" gnus-article-goto-next-page t]
4063        ["Scroll backwards" gnus-article-goto-prev-page t]
4064        ["Show summary" gnus-article-show-summary t]
4065        ["Fetch Message-ID at point" gnus-article-refer-article t]
4066        ["Mail to address at point" gnus-article-mail t]
4067        ["Send a bug report" gnus-bug t]))
4068
4069     (easy-menu-define
4070      gnus-article-treatment-menu gnus-article-mode-map ""
4071      ;; Fixme: this should use :active (and maybe :visible).
4072      '("Treatment"
4073        ["Hide headers" gnus-article-hide-headers t]
4074        ["Hide signature" gnus-article-hide-signature t]
4075        ["Hide citation" gnus-article-hide-citation t]
4076        ["Treat overstrike" gnus-article-treat-overstrike t]
4077        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4078        ["Remove carriage return" gnus-article-remove-cr t]
4079        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4080        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4081        ["Remove base64" gnus-article-de-base64-unreadable t]
4082        ["Treat html" gnus-article-wash-html t]
4083        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4084        ["Decode HZ" gnus-article-decode-HZ t]))
4085
4086     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4087
4088     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4089
4090     (gnus-run-hooks 'gnus-article-menu-hook)))
4091
4092 (defun gnus-article-mode ()
4093   "Major mode for displaying an article.
4094
4095 All normal editing commands are switched off.
4096
4097 The following commands are available in addition to all summary mode
4098 commands:
4099 \\<gnus-article-mode-map>
4100 \\[gnus-article-next-page]\t Scroll the article one page forwards
4101 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4102 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4103 \\[gnus-article-show-summary]\t Display the summary buffer
4104 \\[gnus-article-mail]\t Send a reply to the address near point
4105 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4106 \\[gnus-info-find-node]\t Go to the Gnus info node"
4107   (interactive)
4108   (kill-all-local-variables)
4109   (gnus-simplify-mode-line)
4110   (setq mode-name "Article")
4111   (setq major-mode 'gnus-article-mode)
4112   (make-local-variable 'minor-mode-alist)
4113   (use-local-map gnus-article-mode-map)
4114   (when (gnus-visual-p 'article-menu 'menu)
4115     (gnus-article-make-menu-bar)
4116     (when gnus-summary-tool-bar-map
4117       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4118   (gnus-update-format-specifications nil 'article-mode)
4119   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4120   (set (make-local-variable 'gnus-page-broken) nil)
4121   (make-local-variable 'gnus-button-marker-list)
4122   (make-local-variable 'gnus-article-current-summary)
4123   (make-local-variable 'gnus-article-mime-handles)
4124   (make-local-variable 'gnus-article-decoded-p)
4125   (make-local-variable 'gnus-article-mime-handle-alist)
4126   (make-local-variable 'gnus-article-wash-types)
4127   (make-local-variable 'gnus-article-image-alist)
4128   (make-local-variable 'gnus-article-charset)
4129   (make-local-variable 'gnus-article-ignored-charsets)
4130   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4131   ;; face.
4132   (set (make-local-variable 'nobreak-char-display) nil)
4133   (setq cursor-in-non-selected-windows nil)
4134   (setq truncate-lines gnus-article-truncate-lines)
4135   (gnus-set-default-directory)
4136   (buffer-disable-undo)
4137   (setq buffer-read-only t
4138         show-trailing-whitespace nil)
4139   (set-syntax-table gnus-article-mode-syntax-table)
4140   (mm-enable-multibyte)
4141   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4142
4143 (defvar gnus-button-marker-list nil
4144   "Regexp matching any of the regexps from `gnus-button-alist'.
4145 Internal variable.")
4146
4147 (defun gnus-article-setup-buffer ()
4148   "Initialize the article buffer."
4149   (let* ((name (if gnus-single-article-buffer "*Article*"
4150                  (concat "*Article " gnus-newsgroup-name "*")))
4151          (original
4152           (progn (string-match "\\*Article" name)
4153                  (concat " *Original Article"
4154                          (substring name (match-end 0))))))
4155     (setq gnus-article-buffer name)
4156     (setq gnus-original-article-buffer original)
4157     (setq gnus-article-mime-handle-alist nil)
4158     (with-current-buffer gnus-summary-buffer
4159       ;; This might be a variable local to the summary buffer.
4160       (unless gnus-single-article-buffer
4161         (setq gnus-article-buffer name)
4162         (setq gnus-original-article-buffer original)
4163         (gnus-set-global-variables)))
4164     (gnus-article-setup-highlight-words)
4165     ;; Init original article buffer.
4166     (save-excursion
4167       (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4168       (mm-enable-multibyte)
4169       (setq major-mode 'gnus-original-article-mode)
4170       (make-local-variable 'gnus-original-article))
4171     (if (and (get-buffer name)
4172              (with-current-buffer name
4173                (if gnus-article-edit-mode
4174                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4175                        (progn
4176                          (set-buffer-modified-p nil)
4177                          (gnus-kill-buffer name)
4178                          (message "")
4179                          nil)
4180                      (error "Action aborted"))
4181                  t)))
4182         (save-excursion
4183           (set-buffer name)
4184           (set (make-local-variable 'gnus-article-edit-mode) nil)
4185           (when gnus-article-mime-handles
4186             (mm-destroy-parts gnus-article-mime-handles)
4187             (setq gnus-article-mime-handles nil))
4188           ;; Set it to nil in article-buffer!
4189           (setq gnus-article-mime-handle-alist nil)
4190           (buffer-disable-undo)
4191           (setq buffer-read-only t)
4192           ;; This list just keeps growing if we don't reset it.
4193           (setq gnus-button-marker-list nil)
4194           (unless (eq major-mode 'gnus-article-mode)
4195             (gnus-article-mode))
4196           (current-buffer))
4197       (save-excursion
4198         (set-buffer (gnus-get-buffer-create name))
4199         (gnus-article-mode)
4200         (make-local-variable 'gnus-summary-buffer)
4201         (setq gnus-summary-buffer
4202               (gnus-summary-buffer-name gnus-newsgroup-name))
4203         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4204         (current-buffer)))))
4205
4206 ;; Set article window start at LINE, where LINE is the number of lines
4207 ;; from the head of the article.
4208 (defun gnus-article-set-window-start (&optional line)
4209   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4210     (when article-window
4211       (set-window-start
4212        article-window
4213        (save-excursion
4214          (set-buffer gnus-article-buffer)
4215          (goto-char (point-min))
4216          (if (not line)
4217              (point-min)
4218            (gnus-message 6 "Moved to bookmark")
4219            (search-forward "\n\n" nil t)
4220            (forward-line line)
4221            (point)))))))
4222
4223 (defun gnus-article-prepare (article &optional all-headers header)
4224   "Prepare ARTICLE in article mode buffer.
4225 ARTICLE should either be an article number or a Message-ID.
4226 If ARTICLE is an id, HEADER should be the article headers.
4227 If ALL-HEADERS is non-nil, no headers are hidden."
4228   (save-excursion
4229     ;; Make sure we start in a summary buffer.
4230     (unless (eq major-mode 'gnus-summary-mode)
4231       (set-buffer gnus-summary-buffer))
4232     (setq gnus-summary-buffer (current-buffer))
4233     (let* ((gnus-article (if header (mail-header-number header) article))
4234            (summary-buffer (current-buffer))
4235            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4236            (group gnus-newsgroup-name)
4237            result)
4238       (save-excursion
4239         (gnus-article-setup-buffer)
4240         (set-buffer gnus-article-buffer)
4241         ;; Deactivate active regions.
4242         (when (and (boundp 'transient-mark-mode)
4243                    transient-mark-mode)
4244           (setq mark-active nil))
4245         (if (not (setq result (let ((inhibit-read-only t))
4246                                 (gnus-request-article-this-buffer
4247                                  article group))))
4248             ;; There is no such article.
4249             (save-excursion
4250               (when (and (numberp article)
4251                          (not (memq article gnus-newsgroup-sparse)))
4252                 (setq gnus-article-current
4253                       (cons gnus-newsgroup-name article))
4254                 (set-buffer gnus-summary-buffer)
4255                 (setq gnus-current-article article)
4256                 (if (and (memq article gnus-newsgroup-undownloaded)
4257                          (not (gnus-online (gnus-find-method-for-group
4258                                             gnus-newsgroup-name))))
4259                     (progn
4260                       (gnus-summary-set-agent-mark article)
4261                       (message "Message marked for downloading"))
4262                   (gnus-summary-mark-article article gnus-canceled-mark)
4263                   (unless (memq article gnus-newsgroup-sparse)
4264                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4265           (if (or (eq result 'pseudo)
4266                   (eq result 'nneething))
4267               (progn
4268                 (save-excursion
4269                   (set-buffer summary-buffer)
4270                   (push article gnus-newsgroup-history)
4271                   (setq gnus-last-article gnus-current-article
4272                         gnus-current-article 0
4273                         gnus-current-headers nil
4274                         gnus-article-current nil)
4275                   (if (eq result 'nneething)
4276                       (gnus-configure-windows 'summary)
4277                     (gnus-configure-windows 'article))
4278                   (gnus-set-global-variables))
4279                 (let ((gnus-article-mime-handle-alist-1
4280                        gnus-article-mime-handle-alist))
4281                   (gnus-set-mode-line 'article)))
4282             ;; The result from the `request' was an actual article -
4283             ;; or at least some text that is now displayed in the
4284             ;; article buffer.
4285             (when (and (numberp article)
4286                        (not (eq article gnus-current-article)))
4287               ;; Seems like a new article has been selected.
4288               ;; `gnus-current-article' must be an article number.
4289               (save-excursion
4290                 (set-buffer summary-buffer)
4291                 (push article gnus-newsgroup-history)
4292                 (setq gnus-last-article gnus-current-article
4293                       gnus-current-article article
4294                       gnus-current-headers
4295                       (gnus-summary-article-header gnus-current-article)
4296                       gnus-article-current
4297                       (cons gnus-newsgroup-name gnus-current-article))
4298                 (unless (vectorp gnus-current-headers)
4299                   (setq gnus-current-headers nil))
4300                 (gnus-summary-goto-subject gnus-current-article)
4301                 (when (gnus-summary-show-thread)
4302                   ;; If the summary buffer really was folded, the
4303                   ;; previous goto may not actually have gone to
4304                   ;; the right article, but the thread root instead.
4305                   ;; So we go again.
4306                   (gnus-summary-goto-subject gnus-current-article))
4307                 (gnus-run-hooks 'gnus-mark-article-hook)
4308                 (gnus-set-mode-line 'summary)
4309                 (when (gnus-visual-p 'article-highlight 'highlight)
4310                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4311                 ;; Set the global newsgroup variables here.
4312                 (gnus-set-global-variables)
4313                 (setq gnus-have-all-headers
4314                       (or all-headers gnus-show-all-headers))))
4315             (save-excursion
4316               (gnus-configure-windows 'article))
4317             (when (or (numberp article)
4318                       (stringp article))
4319               (gnus-article-prepare-display)
4320               ;; Do page break.
4321               (goto-char (point-min))
4322               (when gnus-break-pages
4323                 (gnus-narrow-to-page)))
4324             (let ((gnus-article-mime-handle-alist-1
4325                    gnus-article-mime-handle-alist))
4326               (gnus-set-mode-line 'article))
4327             (article-goto-body)
4328             (unless (bobp)
4329               (forward-line -1))
4330             (set-window-point (get-buffer-window (current-buffer)) (point))
4331             (gnus-configure-windows 'article)
4332             t))))))
4333
4334 ;;;###autoload
4335 (defun gnus-article-prepare-display ()
4336   "Make the current buffer look like a nice article."
4337   ;; Hooks for getting information from the article.
4338   ;; This hook must be called before being narrowed.
4339   (let ((gnus-article-buffer (current-buffer))
4340         buffer-read-only
4341         (inhibit-read-only t))
4342     (unless (eq major-mode 'gnus-article-mode)
4343       (gnus-article-mode))
4344     (setq buffer-read-only nil
4345           gnus-article-wash-types nil
4346           gnus-article-image-alist nil)
4347     (gnus-run-hooks 'gnus-tmp-internal-hook)
4348     (when gnus-display-mime-function
4349       (funcall gnus-display-mime-function))
4350     (gnus-run-hooks 'gnus-article-prepare-hook)))
4351
4352 ;;;
4353 ;;; Gnus Sticky Article Mode
4354 ;;;
4355
4356 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4357   "Mode for sticky articles."
4358   ;; Release bindings that won't work.
4359   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4360                              gnus-sticky-article-mode-map)
4361   (substitute-key-definition 'gnus-article-refer-article 'undefined
4362                              gnus-sticky-article-mode-map)
4363   (dolist (k '("e" "h" "s" "F" "R"))
4364     (define-key gnus-sticky-article-mode-map k nil))
4365   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4366   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4367   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4368   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4369
4370 (defun gnus-sticky-article (arg)
4371   "Make the current article sticky.
4372 If a prefix ARG is given, ask for a name for this sticky article buffer."
4373   (interactive "P")
4374   (gnus-summary-show-thread)
4375   (gnus-summary-select-article nil nil 'pseudo)
4376   (let (new-art-buf-name)
4377     (gnus-eval-in-buffer-window gnus-article-buffer
4378       (setq new-art-buf-name
4379             (concat
4380              "*Sticky Article: "
4381              (if arg
4382                  (read-from-minibuffer "Sticky article buffer name: ")
4383                (gnus-with-article-headers
4384                  (gnus-article-goto-header "subject")
4385                  (setq new-art-buf-name
4386                        (buffer-substring-no-properties
4387                         (line-beginning-position) (line-end-position)))
4388                  (goto-char (point-min))
4389                  (gnus-article-goto-header "from")
4390                  (setq new-art-buf-name
4391                        (concat
4392                         new-art-buf-name ", "
4393                         (buffer-substring-no-properties
4394                          (line-beginning-position) (line-end-position))))
4395                  (goto-char (point-min))
4396                  (gnus-article-goto-header "date")
4397                  (setq new-art-buf-name
4398                        (concat
4399                         new-art-buf-name ", "
4400                         (buffer-substring-no-properties
4401                          (line-beginning-position) (line-end-position))))))
4402              "*"))
4403       (if (and (gnus-buffer-live-p new-art-buf-name)
4404                (with-current-buffer new-art-buf-name
4405                  (eq major-mode 'gnus-sticky-article-mode)))
4406           (switch-to-buffer new-art-buf-name)
4407         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4408       (gnus-sticky-article-mode))
4409     (setq gnus-article-buffer new-art-buf-name))
4410   (gnus-summary-recenter)
4411   (gnus-summary-position-point))
4412
4413 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4414   "Kill the given sticky article BUFFER.
4415 If none is given, assume the current buffer and kill it if it has
4416 `gnus-sticky-article-mode'."
4417   (interactive)
4418   (unless buffer
4419     (setq buffer (current-buffer)))
4420   (with-current-buffer buffer
4421     (when (eq major-mode 'gnus-sticky-article-mode)
4422       (gnus-kill-buffer buffer))))
4423
4424 (defun gnus-kill-sticky-article-buffers (arg)
4425   "Kill all sticky article buffers.
4426 If a prefix ARG is given, ask for confirmation."
4427   (interactive "P")
4428   (dolist (buf (gnus-buffers))
4429     (with-current-buffer buf
4430       (when (eq major-mode 'gnus-sticky-article-mode)
4431         (if (not arg)
4432             (gnus-kill-buffer buf)
4433           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4434             (gnus-kill-buffer buf)))))))
4435
4436 ;;;
4437 ;;; Gnus MIME viewing functions
4438 ;;;
4439
4440 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4441   "Format of the MIME buttons.
4442
4443 Valid specifiers include:
4444 %t  The MIME type
4445 %T  MIME type, along with additional info
4446 %n  The `name' parameter
4447 %d  The description, if any
4448 %l  The length of the encoded part
4449 %p  The part identifier number
4450 %e  Dots if the part isn't displayed
4451
4452 General format specifiers can also be used.  See Info node
4453 `(gnus)Formatting Variables'.")
4454
4455 (defvar gnus-mime-button-line-format-alist
4456   '((?t gnus-tmp-type ?s)
4457     (?T gnus-tmp-type-long ?s)
4458     (?n gnus-tmp-name ?s)
4459     (?d gnus-tmp-description ?s)
4460     (?p gnus-tmp-id ?s)
4461     (?l gnus-tmp-length ?d)
4462     (?e gnus-tmp-dots ?s)))
4463
4464 (defvar gnus-mime-button-commands
4465   '((gnus-article-press-button "\r" "Toggle Display")
4466     (gnus-mime-view-part "v" "View Interactively...")
4467     (gnus-mime-view-part-as-type "t" "View As Type...")
4468     (gnus-mime-view-part-as-charset "C" "View As charset...")
4469     (gnus-mime-save-part "o" "Save...")
4470     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4471     (gnus-mime-replace-part "r" "Replace part")
4472     (gnus-mime-delete-part "d" "Delete part")
4473     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4474     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4475     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4476     (gnus-mime-view-part-externally "e" "View Externally")
4477     (gnus-mime-print-part "p" "Print")
4478     (gnus-mime-pipe-part "|" "Pipe To Command...")
4479     (gnus-mime-action-on-part "." "Take action on the part...")))
4480
4481 (defun gnus-article-mime-part-status ()
4482   (if gnus-article-mime-handle-alist-1
4483       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4484           " (1 part)"
4485         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4486     ""))
4487
4488 (defvar gnus-mime-button-map
4489   (let ((map (make-sparse-keymap)))
4490     (define-key map gnus-mouse-2 'gnus-article-push-button)
4491     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4492     (dolist (c gnus-mime-button-commands)
4493       (define-key map (cadr c) (car c)))
4494     map))
4495
4496 (easy-menu-define
4497   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4498   `("MIME Part"
4499     ,@(mapcar (lambda (c)
4500                 (vector (caddr c) (car c) :active t))
4501               gnus-mime-button-commands)))
4502
4503 (defun gnus-mime-button-menu (event prefix)
4504  "Construct a context-sensitive menu of MIME commands."
4505  (interactive "e\nP")
4506  (save-window-excursion
4507    (let ((pos (event-start event)))
4508      (select-window (posn-window pos))
4509      (goto-char (posn-point pos))
4510      (gnus-article-check-buffer)
4511      (popup-menu gnus-mime-button-menu nil prefix))))
4512
4513 (defun gnus-mime-view-all-parts (&optional handles)
4514   "View all the MIME parts."
4515   (interactive)
4516   (with-current-buffer gnus-article-buffer
4517     (let ((handles (or handles gnus-article-mime-handles))
4518           (mail-parse-charset gnus-newsgroup-charset)
4519           (mail-parse-ignored-charsets
4520            (with-current-buffer gnus-summary-buffer
4521              gnus-newsgroup-ignored-charsets)))
4522       (when handles
4523         (mm-remove-parts handles)
4524         (goto-char (point-min))
4525         (or (search-forward "\n\n") (goto-char (point-max)))
4526         (let ((inhibit-read-only t))
4527           (delete-region (point) (point-max))
4528           (mm-display-parts handles))))))
4529
4530 (defun gnus-article-jump-to-part (n)
4531   "Jump to MIME part N."
4532   (interactive "P")
4533   (pop-to-buffer gnus-article-buffer)
4534   ;; FIXME: why is it necessary?
4535   (sit-for 0)
4536   (let ((parts (length gnus-article-mime-handle-alist)))
4537     (or n (setq n
4538                 (string-to-number
4539                  (read-string ;; Emacs 21 doesn't have `read-number'.
4540                   (format "Jump to part (2..%s): " parts)))))
4541     (unless (and (integerp n) (<= n parts) (>= n 1))
4542       (setq n
4543             (progn
4544               (gnus-message 7 "Invalid part `%s', using %s instead."
4545                             n parts)
4546               parts)))
4547     (gnus-message 9 "Jumping to part %s." n)
4548     (cond ((>= gnus-auto-select-part 1)
4549            (while (and (<= n parts)
4550                        (not (gnus-article-goto-part n)))
4551              (setq n (1+ n))))
4552           ((< gnus-auto-select-part 0)
4553            (while (and (>= n 1)
4554                        (not (gnus-article-goto-part n)))
4555              (setq n (1- n))))
4556           (t
4557            (gnus-article-goto-part n)))))
4558
4559 (eval-when-compile
4560   (defsubst gnus-article-edit-part (handles &optional current-id)
4561     "Edit an article in order to delete a mime part.
4562 This function is exclusively used by `gnus-mime-save-part-and-strip'
4563 and `gnus-mime-delete-part', and not provided at run-time normally."
4564     (gnus-article-edit-article
4565      `(lambda ()
4566         (buffer-disable-undo)
4567         (erase-buffer)
4568         (let ((mail-parse-charset (or gnus-article-charset
4569                                       ',gnus-newsgroup-charset))
4570               (mail-parse-ignored-charsets
4571                (or gnus-article-ignored-charsets
4572                    ',gnus-newsgroup-ignored-charsets))
4573               (mbl mml-buffer-list))
4574           (setq mml-buffer-list nil)
4575           (insert-buffer-substring gnus-original-article-buffer)
4576           (mime-to-mml ',handles)
4577           (setq gnus-article-mime-handles nil)
4578           (let ((mbl1 mml-buffer-list))
4579             (setq mml-buffer-list mbl)
4580             (set (make-local-variable 'mml-buffer-list) mbl1))
4581           (gnus-make-local-hook 'kill-buffer-hook)
4582           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4583      `(lambda (no-highlight)
4584         (let ((mail-parse-charset (or gnus-article-charset
4585                                       ',gnus-newsgroup-charset))
4586               (message-options message-options)
4587               (message-options-set-recipient)
4588               (mail-parse-ignored-charsets
4589                (or gnus-article-ignored-charsets
4590                    ',gnus-newsgroup-ignored-charsets)))
4591           (mml-to-mime)
4592           (mml-destroy-buffers)
4593           (remove-hook 'kill-buffer-hook
4594                        'mml-destroy-buffers t)
4595           (kill-local-variable 'mml-buffer-list))
4596         (gnus-summary-edit-article-done
4597          ,(or (mail-header-references gnus-current-headers) "")
4598          ,(gnus-group-read-only-p)
4599          ,gnus-summary-buffer no-highlight))
4600      t)
4601     (gnus-article-edit-done)
4602     (gnus-summary-expand-window)
4603     (gnus-summary-show-article)
4604     (when (and current-id (integerp gnus-auto-select-part))
4605       (gnus-article-jump-to-part
4606        (if (text-property-any (point-min) (point-max)
4607                               'gnus-part (+ current-id gnus-auto-select-part))
4608            (+ current-id gnus-auto-select-part)
4609          (with-current-buffer gnus-article-buffer
4610            (length gnus-article-mime-handle-alist)))))))
4611
4612 (defun gnus-mime-replace-part (file)
4613   "Replace MIME part under point with an external body."
4614   ;; Useful if file has already been saved to disk
4615   (interactive
4616    (list
4617     (mm-with-multibyte
4618       (read-file-name "Replace MIME part with file: "
4619                       (or mm-default-directory default-directory)
4620                       nil nil))))
4621   (gnus-mime-save-part-and-strip file))
4622
4623 (defun gnus-mime-save-part-and-strip (&optional file)
4624   "Save the MIME part under point then replace it with an external body.
4625 If FILE is given, use it for the external part."
4626   (interactive)
4627   (gnus-article-check-buffer)
4628   (when (gnus-group-read-only-p)
4629     (error "The current group does not support deleting of parts"))
4630   (when (mm-complicated-handles gnus-article-mime-handles)
4631     (error "\
4632 The current article has a complicated MIME structure, giving up..."))
4633   (let* ((data (get-text-property (point) 'gnus-data))
4634          (id (get-text-property (point) 'gnus-part))
4635          param
4636          (handles gnus-article-mime-handles))
4637     (unless file
4638       (setq file
4639             (and data (mm-save-part data "Delete MIME part and save to: "))))
4640     (when file
4641       (with-current-buffer (mm-handle-buffer data)
4642         (erase-buffer)
4643         (insert "Content-Type: " (mm-handle-media-type data))
4644         (mml-insert-parameter-string (cdr (mm-handle-type data))
4645                                      '(charset))
4646         ;; Add a filename for the sake of saving the part again.
4647         (mml-insert-parameter
4648          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4649         (insert "\n")
4650         (insert "Content-ID: " (message-make-message-id) "\n")
4651         (insert "Content-Transfer-Encoding: binary\n")
4652         (insert "\n"))
4653       (setcdr data
4654               (cdr (mm-make-handle nil
4655                                    `("message/external-body"
4656                                      (access-type . "LOCAL-FILE")
4657                                      (name . ,file)))))
4658       ;; (set-buffer gnus-summary-buffer)
4659       (gnus-article-edit-part handles id))))
4660
4661 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4662 ;; parts...>') but with stripping would be nice.
4663
4664 (defun gnus-mime-delete-part ()
4665   "Delete the MIME part under point.
4666 Replace it with some information about the removed part."
4667   (interactive)
4668   (gnus-article-check-buffer)
4669   (when (gnus-group-read-only-p)
4670     (error "The current group does not support deleting of parts"))
4671   (when (mm-complicated-handles gnus-article-mime-handles)
4672     (error "\
4673 The current article has a complicated MIME structure, giving up..."))
4674   (when (or gnus-expert-user
4675             (gnus-yes-or-no-p "\
4676 Deleting parts may malfunction or destroy the article; continue? "))
4677     (let* ((data (get-text-property (point) 'gnus-data))
4678            (id (get-text-property (point) 'gnus-part))
4679            (handles gnus-article-mime-handles)
4680            (none "(none)")
4681            (description
4682             (mail-decode-encoded-word-string (or (mm-handle-description data)
4683                                                  none)))
4684            (filename
4685             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4686                 none))
4687            (type (mm-handle-media-type data)))
4688       (unless data
4689         (error "No MIME part under point"))
4690       (with-current-buffer (mm-handle-buffer data)
4691         (let ((bsize (format "%s" (buffer-size))))
4692           (erase-buffer)
4693           (insert
4694            (concat
4695             ",----\n"
4696             "| The following attachment has been deleted:\n"
4697             "|\n"
4698             "| Type:           " type "\n"
4699             "| Filename:       " filename "\n"
4700             "| Size (encoded): " bsize " Byte\n"
4701             "| Description:    " description "\n"
4702             "`----\n"))
4703           (setcdr data
4704                   (cdr (mm-make-handle
4705                         nil `("text/plain") nil nil
4706                         (list "attachment")
4707                         (format "Deleted attachment (%s bytes)" bsize))))))
4708       ;; (set-buffer gnus-summary-buffer)
4709       (gnus-article-edit-part handles id))))
4710
4711 (defun gnus-mime-save-part ()
4712   "Save the MIME part under point."
4713   (interactive)
4714   (gnus-article-check-buffer)
4715   (let ((data (get-text-property (point) 'gnus-data)))
4716     (when data
4717       (mm-save-part data))))
4718
4719 (defun gnus-mime-pipe-part ()
4720   "Pipe the MIME part under point to a process."
4721   (interactive)
4722   (gnus-article-check-buffer)
4723   (let ((data (get-text-property (point) 'gnus-data)))
4724     (when data
4725       (mm-pipe-part data))))
4726
4727 (defun gnus-mime-view-part ()
4728   "Interactively choose a viewing method for the MIME part under point."
4729   (interactive)
4730   (gnus-article-check-buffer)
4731   (let ((data (get-text-property (point) 'gnus-data)))
4732     (when data
4733       (setq gnus-article-mime-handles
4734             (mm-merge-handles
4735              gnus-article-mime-handles (setq data (copy-sequence data))))
4736       (mm-interactively-view-part data))))
4737
4738 (defun gnus-mime-view-part-as-type-internal ()
4739   (gnus-article-check-buffer)
4740   (let* ((handle (get-text-property (point) 'gnus-data))
4741          (name (or
4742                 ;; Content-Type: foo/bar; name=...
4743                 (mail-content-type-get (mm-handle-type handle) 'name)
4744                 ;; Content-Disposition: attachment; filename=...
4745                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
4746          (def-type (and name (mm-default-file-encoding name))))
4747     (or (and def-type (cons def-type 0))
4748         (and handle
4749              (equal (mm-handle-media-supertype handle) "text")
4750              '("text/plain" . 0))
4751         '("application/octet-stream" . 0))))
4752
4753 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
4754   "Choose a MIME media type, and view the part as such.
4755 If non-nil, PRED is a predicate to use during completion to limit the
4756 available media-types."
4757   (interactive)
4758   (unless mime-type
4759     (setq mime-type
4760           (let ((default (gnus-mime-view-part-as-type-internal)))
4761             (completing-read
4762              (format "View as MIME type (default %s): "
4763                      (car default))
4764              (mapcar #'list (mailcap-mime-types))
4765              pred nil nil nil
4766              (car default)))))
4767   (gnus-article-check-buffer)
4768   (let ((handle (get-text-property (point) 'gnus-data)))
4769     (when handle
4770       (when (equal (mm-handle-media-type handle) "message/external-body")
4771         (unless (mm-handle-cache handle)
4772           (mm-extern-cache-contents handle))
4773         (setq handle (mm-handle-cache handle)))
4774       (setq handle
4775             (mm-make-handle (mm-handle-buffer handle)
4776                             (cons mime-type (cdr (mm-handle-type handle)))
4777                             (mm-handle-encoding handle)
4778                             (mm-handle-undisplayer handle)
4779                             (mm-handle-disposition handle)
4780                             (mm-handle-description handle)
4781                             nil
4782                             (mm-handle-id handle)))
4783       (setq gnus-article-mime-handles
4784             (mm-merge-handles gnus-article-mime-handles handle))
4785       (when (mm-handle-displayed-p handle)
4786         (mm-remove-part handle))
4787       (gnus-mm-display-part handle))))
4788
4789 (defun gnus-mime-copy-part (&optional handle arg)
4790   "Put the MIME part under point into a new buffer.
4791 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4792 are decompressed."
4793   (interactive (list nil current-prefix-arg))
4794   (gnus-article-check-buffer)
4795   (unless handle
4796     (setq handle (get-text-property (point) 'gnus-data)))
4797   (when handle
4798     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
4799                                                'name)
4800                         (mail-content-type-get (mm-handle-disposition handle)
4801                                                'filename)))
4802           contents dont-decode charset coding-system)
4803       (mm-with-unibyte-buffer
4804         (mm-insert-part handle)
4805         (setq contents (or (condition-case nil
4806                                (mm-decompress-buffer filename nil 'sig)
4807                              (error
4808                               (setq dont-decode t)
4809                               nil))
4810                            (buffer-string))))
4811       (setq filename (cond (filename (file-name-nondirectory filename))
4812                            (dont-decode "*raw data*")
4813                            (t "*decoded*")))
4814       (cond
4815        (dont-decode)
4816        ((not arg)
4817         (unless (setq charset (mail-content-type-get
4818                                (mm-handle-type handle) 'charset))
4819           (unless (setq coding-system (mm-with-unibyte-buffer
4820                                         (insert contents)
4821                                         (mm-find-buffer-file-coding-system)))
4822             (setq charset gnus-newsgroup-charset))))
4823        ((numberp arg)
4824         (setq charset (or (cdr (assq arg
4825                                      gnus-summary-show-article-charset-alist))
4826                           (mm-read-coding-system "Charset: ")))))
4827       (switch-to-buffer (generate-new-buffer filename))
4828       (if (or coding-system
4829               (and charset
4830                    (setq coding-system (mm-charset-to-coding-system charset))
4831                    (not (eq charset 'ascii))))
4832           (progn
4833             (mm-enable-multibyte)
4834             (insert (mm-decode-coding-string contents coding-system))
4835             (setq buffer-file-coding-system
4836                   (if (boundp 'last-coding-system-used)
4837                       (symbol-value 'last-coding-system-used)
4838                     coding-system)))
4839         (mm-disable-multibyte)
4840         (insert contents)
4841         (setq buffer-file-coding-system mm-binary-coding-system))
4842       ;; We do it this way to make `normal-mode' set the appropriate mode.
4843       (unwind-protect
4844           (progn
4845             (setq buffer-file-name (expand-file-name filename))
4846             (normal-mode))
4847         (setq buffer-file-name nil))
4848       (goto-char (point-min)))))
4849
4850 (defun gnus-mime-print-part (&optional handle filename)
4851   "Print the MIME part under point."
4852   (interactive (list nil (ps-print-preprint current-prefix-arg)))
4853   (gnus-article-check-buffer)
4854   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4855          (contents (and handle (mm-get-part handle)))
4856          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
4857          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
4858     (when contents
4859         (if printer
4860             (unwind-protect
4861                 (progn
4862                   (mm-save-part-to-file handle file)
4863                   (call-process shell-file-name nil
4864                                 (generate-new-buffer " *mm*")
4865                                 nil
4866                                 shell-command-switch
4867                                 (mm-mailcap-command
4868                                  printer file (mm-handle-type handle))))
4869               (delete-file file))
4870           (with-temp-buffer
4871             (insert contents)
4872             (gnus-print-buffer))
4873           (ps-despool filename)))))
4874
4875 (defun gnus-mime-inline-part (&optional handle arg)
4876   "Insert the MIME part under point into the current buffer.
4877 Compressed files like .gz and .bz2 are decompressed."
4878   (interactive (list nil current-prefix-arg))
4879   (gnus-article-check-buffer)
4880   (unless handle
4881     (setq handle (get-text-property (point) 'gnus-data)))
4882   (when handle
4883     (let ((b (point))
4884           (inhibit-read-only t)
4885           contents charset coding-system)
4886       (if (and (not arg) (mm-handle-undisplayer handle))
4887           (mm-remove-part handle)
4888         (mm-with-unibyte-buffer
4889           (mm-insert-part handle)
4890           (setq contents
4891                 (or (mm-decompress-buffer
4892                      (or (mail-content-type-get (mm-handle-type handle)
4893                                                 'name)
4894                          (mail-content-type-get (mm-handle-disposition handle)
4895                                                 'filename))
4896                      nil t)
4897                     (buffer-string))))
4898         (cond
4899          ((not arg)
4900           (unless (setq charset (mail-content-type-get
4901                                  (mm-handle-type handle) 'charset))
4902             (unless (setq coding-system
4903                           (mm-with-unibyte-buffer
4904                             (insert contents)
4905                             (mm-find-buffer-file-coding-system)))
4906               (setq charset gnus-newsgroup-charset))))
4907          ((numberp arg)
4908           (if (mm-handle-undisplayer handle)
4909               (mm-remove-part handle))
4910           (setq charset
4911                 (or (cdr (assq arg
4912                                gnus-summary-show-article-charset-alist))
4913                     (mm-read-coding-system "Charset: "))))
4914          (t
4915           (if (mm-handle-undisplayer handle)
4916               (mm-remove-part handle))))
4917         (forward-line 2)
4918         (mm-insert-inline
4919          handle
4920          (if (or coding-system
4921                  (and charset
4922                       (setq coding-system
4923                             (mm-charset-to-coding-system charset))
4924                       (not (eq coding-system 'ascii))))
4925              (mm-decode-coding-string contents coding-system)
4926            (mm-string-to-multibyte contents)))
4927         (goto-char b)))))
4928
4929 (defun gnus-mime-strip-charset-parameters (handle)
4930   "Strip charset parameters from HANDLE."
4931   (if (stringp (car handle))
4932       (mapc #'gnus-mime-strip-charset-parameters (cdr handle))
4933     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
4934                                             "message/external-body")
4935                                      (progn
4936                                        (unless (mm-handle-cache handle)
4937                                          (mm-extern-cache-contents handle))
4938                                        (mm-handle-cache handle))
4939                                    handle)))
4940            (charset (assq 'charset (cdr type))))
4941       (when charset
4942         (delq charset type)))))
4943
4944 (defun gnus-mime-view-part-as-charset (&optional handle arg)
4945   "Insert the MIME part under point into the current buffer using the
4946 specified charset."
4947   (interactive (list nil current-prefix-arg))
4948   (gnus-article-check-buffer)
4949   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
4950         (fun (get-text-property (point) 'gnus-callback))
4951         (gnus-newsgroup-ignored-charsets 'gnus-all)
4952         gnus-newsgroup-charset form preferred parts)
4953     (when handle
4954       (when (prog1
4955                 (and fun
4956                      (setq gnus-newsgroup-charset
4957                            (or (cdr (assq
4958                                      arg
4959                                      gnus-summary-show-article-charset-alist))
4960                                (mm-read-coding-system "Charset: "))))
4961               (if (mm-handle-undisplayer handle)
4962                   (mm-remove-part handle)))
4963         (gnus-mime-strip-charset-parameters handle)
4964         (when (and (consp (setq form (cdr-safe fun)))
4965                    (setq form (ignore-errors
4966                                 (assq 'gnus-mime-display-alternative form)))
4967                    (setq preferred (caddr form))
4968                    (progn
4969                      (when (eq (car preferred) 'quote)
4970                        (setq preferred (cadr preferred)))
4971                      (not (equal preferred
4972                                  (get-text-property (point) 'gnus-data))))
4973                    (setq parts (get-text-property (point) 'gnus-part))
4974                    (setq parts (cdr (assq parts
4975                                           gnus-article-mime-handle-alist)))
4976                    (equal (mm-handle-media-type parts) "multipart/alternative")
4977                    (setq parts (reverse (cdr parts))))
4978           (setcar (cddr form)
4979                   (list 'quote (or (cadr (member preferred parts))
4980                                    (car parts)))))
4981         (funcall fun handle)))))
4982
4983 (defun gnus-mime-view-part-externally (&optional handle)
4984   "View the MIME part under point with an external viewer."
4985   (interactive)
4986   (gnus-article-check-buffer)
4987   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
4988          (mm-user-display-methods nil)
4989          (mm-inlined-types nil)
4990          (mail-parse-charset gnus-newsgroup-charset)
4991          (mail-parse-ignored-charsets
4992           (with-current-buffer gnus-summary-buffer
4993             gnus-newsgroup-ignored-charsets))
4994          (type (mm-handle-media-type handle))
4995          (method (mailcap-mime-info type))
4996          (mm-enable-external t))
4997     (if (not (stringp method))
4998         (gnus-mime-view-part-as-type
4999          nil (lambda (types) (stringp (mailcap-mime-info (car types)))))
5000       (when handle
5001         (if (mm-handle-undisplayer handle)
5002             (mm-remove-part handle)
5003           (mm-display-part handle))))))
5004
5005 (defun gnus-mime-view-part-internally (&optional handle)
5006   "View the MIME part under point with an internal viewer.
5007 If no internal viewer is available, use an external viewer."
5008   (interactive)
5009   (gnus-article-check-buffer)
5010   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5011          (mm-inlined-types '(".*"))
5012          (mm-inline-large-images t)
5013          (mail-parse-charset gnus-newsgroup-charset)
5014          (mail-parse-ignored-charsets
5015           (with-current-buffer gnus-summary-buffer
5016             gnus-newsgroup-ignored-charsets))
5017          (inhibit-read-only t))
5018     (if (not (mm-inlinable-p handle))
5019         (gnus-mime-view-part-as-type
5020          nil (lambda (types) (mm-inlinable-p handle (car types))))
5021       (when handle
5022         (if (mm-handle-undisplayer handle)
5023             (mm-remove-part handle)
5024           (mm-display-part handle))))))
5025
5026 (defun gnus-mime-action-on-part (&optional action)
5027   "Do something with the MIME attachment at \(point\)."
5028   (interactive
5029    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
5030   (gnus-article-check-buffer)
5031   (let ((action-pair (assoc action gnus-mime-action-alist)))
5032     (if action-pair
5033         (funcall (cdr action-pair)))))
5034
5035 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5036   "Call FUNCTION on MIME part N.
5037 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5038 If INTERACTIVE, call FUNCTION interactivly."
5039   (let (window frame)
5040     ;; Check whether the article is displayed.
5041     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5042                  (setq window (get-buffer-window gnus-article-buffer t))
5043                  (frame-visible-p (setq frame (window-frame window))))
5044       (error "No article is displayed"))
5045     (with-current-buffer gnus-article-buffer
5046       ;; Check whether the article displays the right contents.
5047       (unless (with-current-buffer gnus-summary-buffer
5048                 (eq gnus-current-article (gnus-summary-article-number)))
5049         (error "You should select the right article first"))
5050       (if n
5051           (setq n (prefix-numeric-value n))
5052         (let ((pt (point)))
5053           (setq n (or (get-text-property pt 'gnus-part)
5054                       (and (not (bobp))
5055                            (get-text-property (1- pt) 'gnus-part))
5056                       (get-text-property (prog2
5057                                              (forward-line 1)
5058                                              (point)
5059                                            (goto-char pt))
5060                                          'gnus-part)
5061                       (get-text-property
5062                        (or (and (setq pt (previous-single-property-change
5063                                           pt 'gnus-part))
5064                                 (1- pt))
5065                            (next-single-property-change (point) 'gnus-part)
5066                            (point))
5067                        'gnus-part)
5068                       1))))
5069       ;; Check whether the specified part exists.
5070       (when (> n (length gnus-article-mime-handle-alist))
5071         (error "No such part")))
5072     (unless
5073         (progn
5074           ;; To select the window is needed so that the cursor
5075           ;; might be visible on the MIME button.
5076           (select-window (prog1
5077                              window
5078                            (setq window (selected-window))
5079                            ;; Article may be displayed in the other frame.
5080                            (gnus-select-frame-set-input-focus
5081                             (prog1
5082                                 frame
5083                               (setq frame (selected-frame))))))
5084           (when (gnus-article-goto-part n)
5085             ;; We point the cursor and the arrow at the MIME button
5086             ;; when the `function' prompt the user for something.
5087             (let ((cursor-in-non-selected-windows t)
5088                   (overlay-arrow-string "=>")
5089                   (overlay-arrow-position (point-marker)))
5090               (unwind-protect
5091                   (cond
5092                    ((and no-handle interactive)
5093                     (call-interactively function))
5094                    (no-handle
5095                     (funcall function))
5096                    (interactive
5097                     (call-interactively
5098                      function
5099                      (cdr (assq n gnus-article-mime-handle-alist))))
5100                    (t
5101                     (funcall function
5102                              (cdr (assq n gnus-article-mime-handle-alist)))))
5103                 (set-marker overlay-arrow-position nil)
5104                 (unless gnus-auto-select-part
5105                   (gnus-select-frame-set-input-focus frame)
5106                   (select-window window))))
5107             t))
5108       (if gnus-inhibit-mime-unbuttonizing
5109           ;; This is the default though the program shouldn't reach here.
5110           (error "No such part")
5111         ;; The part which doesn't have the MIME button is selected.
5112         ;; So, we display all the buttons and redo it.
5113         (let ((gnus-inhibit-mime-unbuttonizing t))
5114           (gnus-summary-show-article)
5115           (gnus-article-part-wrapper n function no-handle))))))
5116
5117 (defun gnus-article-pipe-part (n)
5118   "Pipe MIME part N, which is the numerical prefix."
5119   (interactive "P")
5120   (gnus-article-part-wrapper n 'mm-pipe-part))
5121
5122 (defun gnus-article-save-part (n)
5123   "Save MIME part N, which is the numerical prefix."
5124   (interactive "P")
5125   (gnus-article-part-wrapper n 'mm-save-part))
5126
5127 (defun gnus-article-interactively-view-part (n)
5128   "View MIME part N interactively, which is the numerical prefix."
5129   (interactive "P")
5130   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5131
5132 (defun gnus-article-copy-part (n)
5133   "Copy MIME part N, which is the numerical prefix."
5134   (interactive "P")
5135   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5136
5137 (defun gnus-article-view-part-as-charset (n)
5138   "View MIME part N using a specified charset.
5139 N is the numerical prefix."
5140   (interactive "P")
5141   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5142
5143 (defun gnus-article-view-part-externally (n)
5144   "View MIME part N externally, which is the numerical prefix."
5145   (interactive "P")
5146   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5147
5148 (defun gnus-article-inline-part (n)
5149   "Inline MIME part N, which is the numerical prefix."
5150   (interactive "P")
5151   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5152
5153 (defun gnus-article-save-part-and-strip (n)
5154   "Save MIME part N and replace it with an external body.
5155 N is the numerical prefix."
5156   (interactive "P")
5157   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5158
5159 (defun gnus-article-replace-part (n)
5160   "Replace MIME part N with an external body.
5161 N is the numerical prefix."
5162   (interactive "P")
5163   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5164
5165 (defun gnus-article-delete-part (n)
5166   "Delete MIME part N and add some information about the removed part.
5167 N is the numerical prefix."
5168   (interactive "P")
5169   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5170
5171 (defun gnus-article-view-part-as-type (n)
5172   "Choose a MIME media type, and view part N as such.
5173 N is the numerical prefix."
5174   (interactive "P")
5175   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5176
5177 (defun gnus-article-mime-match-handle-first (condition)
5178   (if condition
5179       (let (n)
5180         (dolist (ihandle gnus-article-mime-handle-alist)
5181           (if (and (cond
5182                     ((functionp condition)
5183                      (funcall condition (cdr ihandle)))
5184                     ((eq condition 'undisplayed)
5185                      (not (or (mm-handle-undisplayer (cdr ihandle))
5186                               (equal (mm-handle-media-type (cdr ihandle))
5187                                      "multipart/alternative"))))
5188                     ((eq condition 'undisplayed-alternative)
5189                      (not (mm-handle-undisplayer (cdr ihandle))))
5190                     (t t))
5191                    (gnus-article-goto-part (car ihandle))
5192                    (or (not n) (< (car ihandle) n)))
5193               (setq n (car ihandle))))
5194         (or n 1))
5195     1))
5196
5197 (defun gnus-article-view-part (&optional n)
5198   "View MIME part N, which is the numerical prefix."
5199   (interactive "P")
5200   (with-current-buffer gnus-article-buffer
5201     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5202                              gnus-article-mime-match-handle-function)))
5203     (when (> n (length gnus-article-mime-handle-alist))
5204       (error "No such part"))
5205     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5206       (when (gnus-article-goto-part n)
5207         (if (equal (car handle) "multipart/alternative")
5208             (gnus-article-press-button)
5209           (when (eq (gnus-mm-display-part handle) 'internal)
5210             (gnus-set-window-start)))))))
5211
5212 (defsubst gnus-article-mime-total-parts ()
5213   (if (bufferp (car gnus-article-mime-handles))
5214       1 ;; single part
5215     (1- (length gnus-article-mime-handles))))
5216
5217 (defun gnus-mm-display-part (handle)
5218   "Display HANDLE and fix MIME button."
5219   (let ((id (get-text-property (point) 'gnus-part))
5220         (point (point))
5221         (inhibit-read-only t))
5222     (forward-line 1)
5223     (prog1
5224         (let ((window (selected-window))
5225               (mail-parse-charset gnus-newsgroup-charset)
5226               (mail-parse-ignored-charsets
5227                (if (gnus-buffer-live-p gnus-summary-buffer)
5228                    (with-current-buffer gnus-summary-buffer
5229                      gnus-newsgroup-ignored-charsets)
5230                  nil)))
5231           (save-excursion
5232             (unwind-protect
5233                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5234                       (beg (point)))
5235                   (when win
5236                     (select-window win))
5237                   (goto-char point)
5238                   (forward-line)
5239                   (if (mm-handle-displayed-p handle)
5240                       ;; This will remove the part.
5241                       (mm-display-part handle)
5242                     (save-restriction
5243                       (narrow-to-region (point)
5244                                         (if (eobp) (point) (1+ (point))))
5245                       (mm-display-part handle)
5246                       ;; We narrow to the part itself and
5247                       ;; then call the treatment functions.
5248                       (goto-char (point-min))
5249                       (forward-line 1)
5250                       (narrow-to-region (point) (point-max))
5251                       (gnus-treat-article
5252                        nil id
5253                        (gnus-article-mime-total-parts)
5254                        (mm-handle-media-type handle)))))
5255               (if (window-live-p window)
5256                   (select-window window)))))
5257       (goto-char point)
5258       (gnus-delete-line)
5259       (gnus-insert-mime-button
5260        handle id (list (mm-handle-displayed-p handle)))
5261       (goto-char point))))
5262
5263 (defun gnus-article-goto-part (n)
5264   "Go to MIME part N."
5265   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5266
5267 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5268   (let ((gnus-tmp-name
5269          (or (mail-content-type-get (mm-handle-type handle) 'name)
5270              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5271              (mail-content-type-get (mm-handle-type handle) 'url)
5272              ""))
5273         (gnus-tmp-type (mm-handle-media-type handle))
5274         (gnus-tmp-description
5275          (mail-decode-encoded-word-string (or (mm-handle-description handle)
5276                                               "")))
5277         (gnus-tmp-dots
5278          (if (if displayed (car displayed)
5279                (mm-handle-displayed-p handle))
5280              "" "..."))
5281         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5282                            (buffer-size)))
5283         gnus-tmp-type-long b e)
5284     (when (string-match ".*/" gnus-tmp-name)
5285       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5286     (setq gnus-tmp-type-long (concat gnus-tmp-type
5287                                      (and (not (equal gnus-tmp-name ""))
5288                                           (concat "; " gnus-tmp-name))))
5289     (unless (equal gnus-tmp-description "")
5290       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5291     (unless (bolp)
5292       (insert "\n"))
5293     (setq b (point))
5294     (gnus-eval-format
5295      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5296      `(keymap ,gnus-mime-button-map
5297               gnus-callback gnus-mm-display-part
5298               gnus-part ,gnus-tmp-id
5299               article-type annotation
5300               gnus-data ,handle))
5301     (setq e (if (bolp)
5302                 ;; Exclude a newline.
5303                 (1- (point))
5304               (point)))
5305     (when gnus-article-button-face
5306       (gnus-overlay-put (gnus-make-overlay b e nil t)
5307                         'face gnus-article-button-face))
5308     (widget-convert-button
5309      'link b e
5310      :mime-handle handle
5311      :action 'gnus-widget-press-button
5312      :button-keymap gnus-mime-button-map
5313      :help-echo
5314      (lambda (widget/window &optional overlay pos)
5315        ;; Needed to properly clear the message due to a bug in
5316        ;; wid-edit (XEmacs only).
5317        (if (boundp 'help-echo-owns-message)
5318            (setq help-echo-owns-message t))
5319        (format
5320         "%S: %s the MIME part; %S: more options"
5321         (aref gnus-mouse-2 0)
5322         ;; XEmacs will get a single widget arg; Emacs 21 will get
5323         ;; window, overlay, position.
5324         (if (mm-handle-displayed-p
5325              (if overlay
5326                  (with-current-buffer (gnus-overlay-buffer overlay)
5327                    (widget-get (widget-at (gnus-overlay-start overlay))
5328                                :mime-handle))
5329                (widget-get widget/window :mime-handle)))
5330             "hide" "show")
5331         (aref gnus-down-mouse-3 0))))))
5332
5333 (defun gnus-widget-press-button (elems el)
5334   (goto-char (widget-get elems :from))
5335   (gnus-article-press-button))
5336
5337 (defvar gnus-displaying-mime nil)
5338
5339 (defun gnus-display-mime (&optional ihandles)
5340   "Display the MIME parts."
5341   (save-excursion
5342     (save-selected-window
5343       (let ((window (get-buffer-window gnus-article-buffer))
5344             (point (point)))
5345         (when window
5346           (select-window window)
5347           ;; We have to do this since selecting the window
5348           ;; may change the point.  So we set the window point.
5349           (set-window-point window point)))
5350       (let ((handles ihandles)
5351             (inhibit-read-only t)
5352             handle)
5353         (cond (handles)
5354               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5355                (when gnus-article-emulate-mime
5356                  (mm-uu-dissect-text-parts handles)))
5357               (gnus-article-emulate-mime
5358                (setq handles (mm-uu-dissect))))
5359         (when (and (not ihandles)
5360                    (not gnus-displaying-mime))
5361           ;; Top-level call; we clean up.
5362           (when gnus-article-mime-handles
5363             (mm-destroy-parts gnus-article-mime-handles)
5364             (setq gnus-article-mime-handle-alist nil));; A trick.
5365           (setq gnus-article-mime-handles handles)
5366           ;; We allow users to glean info from the handles.
5367           (when gnus-article-mime-part-function
5368             (gnus-mime-part-function handles)))
5369         (if (and handles
5370                  (or (not (stringp (car handles)))
5371                      (cdr handles)))
5372             (progn
5373               (when (and (not ihandles)
5374                          (not gnus-displaying-mime))
5375                 ;; Clean up for mime parts.
5376                 (article-goto-body)
5377                 (delete-region (point) (point-max)))
5378               (let ((gnus-displaying-mime t))
5379                 (gnus-mime-display-part handles)))
5380           (save-restriction
5381             (article-goto-body)
5382             (narrow-to-region (point) (point-max))
5383             (gnus-treat-article nil 1 1)
5384             (widen)))
5385         (unless ihandles
5386           ;; Highlight the headers.
5387           (save-excursion
5388             (save-restriction
5389               (article-goto-body)
5390               (narrow-to-region (point-min) (point))
5391               (gnus-article-save-original-date
5392                (gnus-treat-article 'head)))))))
5393     ;; Cope with broken MIME messages.
5394     (goto-char (point-max))
5395     (unless (bolp)
5396       (insert "\n"))))
5397
5398 (defcustom gnus-mime-display-multipart-as-mixed nil
5399   "Display \"multipart\" parts as  \"multipart/mixed\".
5400
5401 If t, it overrides nil values of
5402 `gnus-mime-display-multipart-alternative-as-mixed' and
5403 `gnus-mime-display-multipart-related-as-mixed'."
5404   :group 'gnus-article-mime
5405   :type 'boolean)
5406
5407 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5408   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5409   :version "22.1"
5410   :group 'gnus-article-mime
5411   :type 'boolean)
5412
5413 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5414   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5415
5416 If displaying \"text/html\" is discouraged \(see
5417 `mm-discouraged-alternatives'\) images or other material inside a
5418 \"multipart/related\" part might be overlooked when this variable is nil."
5419   :version "22.1"
5420   :group 'gnus-article-mime
5421   :type 'boolean)
5422
5423 (defun gnus-mime-display-part (handle)
5424   (cond
5425    ;; Maybe a broken MIME message.
5426    ((null handle))
5427    ;; Single part.
5428    ((not (stringp (car handle)))
5429     (gnus-mime-display-single handle))
5430    ;; User-defined multipart
5431    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5432     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5433              handle))
5434    ;; multipart/alternative
5435    ((and (equal (car handle) "multipart/alternative")
5436          (not (or gnus-mime-display-multipart-as-mixed
5437                   gnus-mime-display-multipart-alternative-as-mixed)))
5438     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5439       (push (cons id handle) gnus-article-mime-handle-alist)
5440       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5441    ;; multipart/related
5442    ((and (equal (car handle) "multipart/related")
5443          (not (or gnus-mime-display-multipart-as-mixed
5444                   gnus-mime-display-multipart-related-as-mixed)))
5445     ;;;!!!We should find the start part, but we just default
5446     ;;;!!!to the first part.
5447     ;;(gnus-mime-display-part (cadr handle))
5448     ;;;!!! Most multipart/related is an HTML message plus images.
5449     ;;;!!! Unfortunately we are unable to let W3 display those
5450     ;;;!!! included images, so we just display it as a mixed multipart.
5451     ;;(gnus-mime-display-mixed (cdr handle))
5452     ;;;!!! No, w3 can display everything just fine.
5453     (gnus-mime-display-part (cadr handle)))
5454    ((equal (car handle) "multipart/signed")
5455     (gnus-add-wash-type 'signed)
5456     (gnus-mime-display-security handle))
5457    ((equal (car handle) "multipart/encrypted")
5458     (gnus-add-wash-type 'encrypted)
5459     (gnus-mime-display-security handle))
5460    ;; Other multiparts are handled like multipart/mixed.
5461    (t
5462     (gnus-mime-display-mixed (cdr handle)))))
5463
5464 (defun gnus-mime-part-function (handles)
5465   (if (stringp (car handles))
5466       (mapcar 'gnus-mime-part-function (cdr handles))
5467     (funcall gnus-article-mime-part-function handles)))
5468
5469 (defun gnus-mime-display-mixed (handles)
5470   (mapcar 'gnus-mime-display-part handles))
5471
5472 (defun gnus-mime-display-single (handle)
5473   (let ((type (mm-handle-media-type handle))
5474         (ignored gnus-ignored-mime-types)
5475         (not-attachment t)
5476         (move nil)
5477         display text)
5478     (catch 'ignored
5479       (progn
5480         (while ignored
5481           (when (string-match (pop ignored) type)
5482             (throw 'ignored nil)))
5483         (if (and (setq not-attachment
5484                        (and (not (mm-inline-override-p handle))
5485                             (or (not (mm-handle-disposition handle))
5486                                 (equal (car (mm-handle-disposition handle))
5487                                        "inline")
5488                                 (mm-attachment-override-p handle))))
5489                  (mm-automatic-display-p handle)
5490                  (or (and
5491                       (mm-inlinable-p handle)
5492                       (mm-inlined-p handle))
5493                      (mm-automatic-external-display-p type)))
5494             (setq display t)
5495           (when (equal (mm-handle-media-supertype handle) "text")
5496             (setq text t)))
5497         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5498               beg)
5499           (push (cons id handle) gnus-article-mime-handle-alist)
5500           (when (and display
5501                      (equal (mm-handle-media-supertype handle) "message"))
5502             (insert-char
5503              ?\n
5504              (cond ((not (bolp)) 2)
5505                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5506                    (t 1))))
5507           (when (or (not display)
5508                     (not (gnus-unbuttonized-mime-type-p type)))
5509             (gnus-insert-mime-button
5510              handle id (list (or display (and not-attachment text))))
5511             (gnus-article-insert-newline)
5512             ;; Remember modify the number of forward lines.
5513             (setq move t))
5514           (setq beg (point))
5515           (cond
5516            (display
5517             (when move
5518               (forward-line -1)
5519               (setq beg (point)))
5520             (let ((mail-parse-charset gnus-newsgroup-charset)
5521                   (mail-parse-ignored-charsets
5522                    (save-excursion (condition-case ()
5523                                        (set-buffer gnus-summary-buffer)
5524                                      (error))
5525                                    gnus-newsgroup-ignored-charsets)))
5526               (mm-display-part handle t))
5527             (goto-char (point-max)))
5528            ((and text not-attachment)
5529             (when move
5530               (forward-line -1)
5531               (setq beg (point)))
5532             (gnus-article-insert-newline)
5533             (mm-insert-inline
5534              handle
5535              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5536                                                        'charset)
5537                                 (and (equal type "text/calendar") 'utf-8))))
5538                (cond ((not charset)
5539                       (mm-string-as-multibyte (mm-get-part handle)))
5540                      ((eq charset 'gnus-decoded)
5541                       (with-current-buffer (mm-handle-buffer handle)
5542                         (buffer-string)))
5543                      (t
5544                       (mm-decode-string (mm-get-part handle) charset)))))
5545             (goto-char (point-max))))
5546           ;; Do highlighting.
5547           (save-excursion
5548             (save-restriction
5549               (narrow-to-region beg (point))
5550               (if (eq handle gnus-article-mime-handles)
5551                   ;; The format=flowed case.
5552                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5553                 ;; Don't count signature parts that are never displayed.
5554                 ;; The part number should be re-calculated supposing this
5555                 ;; might be a message/rfc822 part.
5556                 (let (handles)
5557                   (dolist (part gnus-article-mime-handles)
5558                     (unless (or (stringp part)
5559                                 (equal (car (mm-handle-type part))
5560                                        "application/pgp-signature"))
5561                       (push part handles)))
5562                   (gnus-treat-article
5563                    nil (length (memq handle handles)) (length handles)
5564                    (mm-handle-media-type handle)))))))))))
5565
5566 (defun gnus-unbuttonized-mime-type-p (type)
5567   "Say whether TYPE is to be unbuttonized."
5568   (unless gnus-inhibit-mime-unbuttonizing
5569     (when (catch 'found
5570             (let ((types gnus-unbuttonized-mime-types))
5571               (while types
5572                 (when (string-match (pop types) type)
5573                   (throw 'found t)))))
5574       (not (catch 'found
5575              (let ((types gnus-buttonized-mime-types))
5576                (while types
5577                  (when (string-match (pop types) type)
5578                    (throw 'found t)))))))))
5579
5580 (defun gnus-article-insert-newline ()
5581   "Insert a newline, but mark it as undeletable."
5582   (gnus-put-text-property
5583    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5584
5585 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5586   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5587          (ihandles handles)
5588          (point (point))
5589          handle (inhibit-read-only t) from props begend not-pref)
5590     (save-window-excursion
5591       (save-restriction
5592         (when ibegend
5593           (narrow-to-region (car ibegend)
5594                             (or (cdr ibegend)
5595                                 (progn
5596                                   (goto-char (car ibegend))
5597                                   (forward-line 2)
5598                                   (point))))
5599           (delete-region (point-min) (point-max))
5600           (mm-remove-parts handles))
5601         (setq begend (list (point-marker)))
5602         ;; Do the toggle.
5603         (unless (setq not-pref (cadr (member preferred ihandles)))
5604           (setq not-pref (car ihandles)))
5605         (when (or ibegend
5606                   (not preferred)
5607                   (not (gnus-unbuttonized-mime-type-p
5608                         "multipart/alternative")))
5609           (gnus-add-text-properties
5610            (setq from (point))
5611            (progn
5612              (insert (format "%d.  " id))
5613              (point))
5614            `(gnus-callback
5615              (lambda (handles)
5616                (unless ,(not ibegend)
5617                  (setq gnus-article-mime-handle-alist
5618                        ',gnus-article-mime-handle-alist))
5619                (gnus-mime-display-alternative
5620                 ',ihandles ',not-pref ',begend ,id))
5621              keymap ,gnus-mime-button-map
5622              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5623              face ,gnus-article-button-face
5624              gnus-part ,id
5625              article-type multipart))
5626           (widget-convert-button 'link from (point)
5627                                  :action 'gnus-widget-press-button
5628                                  :button-keymap gnus-widget-button-keymap)
5629           ;; Do the handles
5630           (while (setq handle (pop handles))
5631             (gnus-add-text-properties
5632              (setq from (point))
5633              (progn
5634                (insert (format "(%c) %-18s"
5635                                (if (equal handle preferred) ?* ? )
5636                                (mm-handle-media-type handle)))
5637                (point))
5638              `(gnus-callback
5639                (lambda (handles)
5640                  (unless ,(not ibegend)
5641                    (setq gnus-article-mime-handle-alist
5642                          ',gnus-article-mime-handle-alist))
5643                  (gnus-mime-display-alternative
5644                   ',ihandles ',handle ',begend ,id))
5645                keymap ,gnus-mime-button-map
5646                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5647                face ,gnus-article-button-face
5648                gnus-part ,id
5649                gnus-data ,handle))
5650             (widget-convert-button 'link from (point)
5651                                    :action 'gnus-widget-press-button
5652                                    :button-keymap gnus-widget-button-keymap)
5653             (insert "  "))
5654           (insert "\n\n"))
5655         (when preferred
5656           (if (stringp (car preferred))
5657               (gnus-display-mime preferred)
5658             (let ((mail-parse-charset gnus-newsgroup-charset)
5659                   (mail-parse-ignored-charsets
5660                    (with-current-buffer gnus-summary-buffer
5661                      gnus-newsgroup-ignored-charsets)))
5662               (mm-display-part preferred)
5663               ;; Do highlighting.
5664               (save-excursion
5665                 (save-restriction
5666                   (narrow-to-region (car begend) (point-max))
5667                   (gnus-treat-article
5668                    nil (length gnus-article-mime-handle-alist)
5669                    (gnus-article-mime-total-parts)
5670                    (mm-handle-media-type handle))))))
5671           (goto-char (point-max))
5672           (setcdr begend (point-marker)))))
5673     (when ibegend
5674       (goto-char point))))
5675
5676 (defconst gnus-article-wash-status-strings
5677   (let ((alist '((cite "c" "Possible hidden citation text"
5678                        " " "All citation text visible")
5679                  (headers "h" "Hidden headers"
5680                           " " "All headers visible.")
5681                  (pgp "p" "Encrypted or signed message status hidden"
5682                       " " "No hidden encryption nor digital signature status")
5683                  (signature "s" "Signature has been hidden"
5684                             " " "Signature is visible")
5685                  (overstrike "o" "Overstrike (^H) characters applied"
5686                              " " "No overstrike characters applied")
5687                  (emphasis "e" "/*_Emphasis_*/ characters applied"
5688                            " " "No /*_emphasis_*/ characters applied")))
5689         result)
5690     (dolist (entry alist result)
5691       (let ((key (nth 0 entry))
5692             (on (copy-sequence (nth 1 entry)))
5693             (on-help (nth 2 entry))
5694             (off (copy-sequence (nth 3 entry)))
5695             (off-help (nth 4 entry)))
5696         (put-text-property 0 1 'help-echo on-help on)
5697         (put-text-property 0 1 'help-echo off-help off)
5698         (push (list key on off) result))))
5699   "Alist of strings describing wash status in the mode line.
5700 Each entry has the form (KEY ON OF), where the KEY is a symbol
5701 representing the particular washing function, ON is the string to use
5702 in the article mode line when the washing function is active, and OFF
5703 is the string to use when it is inactive.")
5704
5705 (defun gnus-article-wash-status-entry (key value)
5706   (let ((entry (assoc key gnus-article-wash-status-strings)))
5707     (if value (nth 1 entry) (nth 2 entry))))
5708
5709 (defun gnus-article-wash-status ()
5710   "Return a string which display status of article washing."
5711   (with-current-buffer gnus-article-buffer
5712     (let ((cite (memq 'cite gnus-article-wash-types))
5713           (headers (memq 'headers gnus-article-wash-types))
5714           (boring (memq 'boring-headers gnus-article-wash-types))
5715           (pgp (memq 'pgp gnus-article-wash-types))
5716           (pem (memq 'pem gnus-article-wash-types))
5717           (signed (memq 'signed gnus-article-wash-types))
5718           (encrypted (memq 'encrypted gnus-article-wash-types))
5719           (signature (memq 'signature gnus-article-wash-types))
5720           (overstrike (memq 'overstrike gnus-article-wash-types))
5721           (emphasis (memq 'emphasis gnus-article-wash-types)))
5722       (concat
5723        (gnus-article-wash-status-entry 'cite cite)
5724        (gnus-article-wash-status-entry 'headers (or headers boring))
5725        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
5726        (gnus-article-wash-status-entry 'signature signature)
5727        (gnus-article-wash-status-entry 'overstrike overstrike)
5728        (gnus-article-wash-status-entry 'emphasis emphasis)))))
5729
5730 (defun gnus-add-wash-type (type)
5731   "Add a washing of TYPE to the current status."
5732   (add-to-list 'gnus-article-wash-types type))
5733
5734 (defun gnus-delete-wash-type (type)
5735   "Add a washing of TYPE to the current status."
5736   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
5737
5738 (defun gnus-add-image (category image)
5739   "Add IMAGE of CATEGORY to the list of displayed images."
5740   (let ((entry (assq category gnus-article-image-alist)))
5741     (unless entry
5742       (setq entry (list category))
5743       (push entry gnus-article-image-alist))
5744     (nconc entry (list image))))
5745
5746 (defun gnus-delete-images (category)
5747   "Delete all images in CATEGORY."
5748   (let ((entry (assq category gnus-article-image-alist)))
5749     (dolist (image (cdr entry))
5750       (gnus-remove-image image category))
5751     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
5752     (gnus-delete-wash-type category)))
5753
5754 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
5755
5756 (defun gnus-article-maybe-hide-headers ()
5757   "Hide unwanted headers if `gnus-have-all-headers' is nil.
5758 Provided for backwards compatibility."
5759   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
5760                  (not (with-current-buffer gnus-summary-buffer
5761                         gnus-have-all-headers)))
5762              (not gnus-inhibit-hiding))
5763     (gnus-article-hide-headers)))
5764
5765 ;;; Article savers.
5766
5767 (defun gnus-output-to-file (file-name)
5768   "Append the current article to a file named FILE-NAME.
5769 If `gnus-article-save-coding-system' is non-nil, it is used to encode
5770 text and used as the value of the coding cookie which is added to the
5771 top of a file.  Otherwise, this function saves a raw article without
5772 the coding cookie."
5773   (let* ((artbuf (current-buffer))
5774          (file-name-coding-system nnmail-pathname-coding-system)
5775          (coding gnus-article-save-coding-system)
5776          (coding-system-for-read (if coding
5777                                      nil ;; Rely on the coding cookie.
5778                                    mm-text-coding-system))
5779          (coding-system-for-write (or coding
5780                                       mm-text-coding-system-for-write
5781                                       mm-text-coding-system))
5782          (exists (file-exists-p file-name)))
5783     (with-temp-buffer
5784       (when exists
5785         (insert-file-contents file-name)
5786         (goto-char (point-min))
5787         ;; Remove the existing coding cookie.
5788         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
5789           (delete-region (match-beginning 0) (match-end 0))))
5790       (goto-char (point-max))
5791       (insert-buffer-substring artbuf)
5792       ;; Append newline at end of the buffer as separator, and then
5793       ;; save it to file.
5794       (goto-char (point-max))
5795       (insert "\n")
5796       (when coding
5797         ;; If the coding system is not suitable to encode the text,
5798         ;; ask a user for a proper one.
5799         (when (fboundp 'select-safe-coding-system)
5800           (setq coding (coding-system-base
5801                         (save-window-excursion
5802                           (select-safe-coding-system (point-min) (point-max)
5803                                                      coding))))
5804           (setq coding-system-for-write
5805                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
5806                     coding)))
5807         (goto-char (point-min))
5808         ;; Add the coding cookie.
5809         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
5810                         coding-system-for-write)))
5811       (if exists
5812           (progn
5813             (write-region (point-min) (point-max) file-name nil 'no-message)
5814             (message "Appended to %s" file-name))
5815         (write-region (point-min) (point-max) file-name))))
5816   t)
5817
5818 (defun gnus-narrow-to-page (&optional arg)
5819   "Narrow the article buffer to a page.
5820 If given a numerical ARG, move forward ARG pages."
5821   (interactive "P")
5822   (setq arg (if arg (prefix-numeric-value arg) 0))
5823   (save-excursion
5824     (set-buffer gnus-article-buffer)
5825     (goto-char (point-min))
5826     (widen)
5827     ;; Remove any old next/prev buttons.
5828     (when (gnus-visual-p 'page-marker)
5829       (let ((inhibit-read-only t))
5830         (gnus-remove-text-with-property 'gnus-prev)
5831         (gnus-remove-text-with-property 'gnus-next)))
5832     (if
5833         (cond ((< arg 0)
5834                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
5835               ((> arg 0)
5836                (re-search-forward page-delimiter nil 'move arg)))
5837         (goto-char (match-end 0))
5838       (save-excursion
5839         (goto-char (point-min))
5840         (setq gnus-page-broken
5841               (and (re-search-forward page-delimiter nil t) t))))
5842     (when gnus-page-broken
5843       (narrow-to-region
5844        (point)
5845        (if (re-search-forward page-delimiter nil 'move)
5846            (match-beginning 0)
5847          (point)))
5848       (when (and (gnus-visual-p 'page-marker)
5849                  (> (point-min) (save-restriction (widen) (point-min))))
5850         (save-excursion
5851           (goto-char (point-min))
5852           (gnus-insert-prev-page-button)))
5853       (when (and (gnus-visual-p 'page-marker)
5854                  (< (point-max) (save-restriction (widen) (point-max))))
5855         (save-excursion
5856           (goto-char (point-max))
5857           (gnus-insert-next-page-button))))))
5858
5859 ;; Article mode commands
5860
5861 (defun gnus-article-goto-next-page ()
5862   "Show the next page of the article."
5863   (interactive)
5864   (when (gnus-article-next-page)
5865     (goto-char (point-min))
5866     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
5867
5868
5869 (defun gnus-article-goto-prev-page ()
5870   "Show the previous page of the article."
5871   (interactive)
5872   (if (bobp)
5873       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
5874     (gnus-article-prev-page nil)))
5875
5876 ;; This is cleaner but currently breaks `gnus-pick-mode':
5877 ;;
5878 ;; (defun gnus-article-goto-next-page ()
5879 ;;   "Show the next page of the article."
5880 ;;   (interactive)
5881 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5882 ;;     (gnus-summary-next-page)))
5883 ;;
5884 ;; (defun gnus-article-goto-prev-page ()
5885 ;;   "Show the next page of the article."
5886 ;;   (interactive)
5887 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
5888 ;;     (gnus-summary-prev-page)))
5889
5890 (defun gnus-article-next-page (&optional lines)
5891   "Show the next page of the current article.
5892 If end of article, return non-nil.  Otherwise return nil.
5893 Argument LINES specifies lines to be scrolled up."
5894   (interactive "p")
5895   (move-to-window-line -1)
5896   (if (and (not (and gnus-article-over-scroll
5897                      (> (count-lines (window-start) (point-max))
5898                         (+ (or lines (1- (window-height)))
5899                            (or (and (boundp 'scroll-margin)
5900                                     (symbol-value 'scroll-margin))
5901                                0)))))
5902            (save-excursion
5903              (end-of-line)
5904              (and (pos-visible-in-window-p)     ;Not continuation line.
5905                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
5906       ;; Nothing in this page.
5907       (if (or (not gnus-page-broken)
5908               (save-excursion
5909                 (save-restriction
5910                   (widen)
5911                   (forward-line)
5912                   (eobp)))) ;Real end-of-buffer?
5913           (progn
5914             (when gnus-article-over-scroll
5915               (gnus-article-next-page-1 lines))
5916             t)                  ;Nothing more.
5917         (gnus-narrow-to-page 1)         ;Go to next page.
5918         nil)
5919     ;; More in this page.
5920     (gnus-article-next-page-1 lines)
5921     nil))
5922
5923 (defmacro gnus-article-beginning-of-window ()
5924   "Move point to the beginning of the window.
5925 In Emacs, the point is placed at the line number which `scroll-margin'
5926 specifies."
5927   (if (featurep 'xemacs)
5928       '(move-to-window-line 0)
5929     '(move-to-window-line
5930       (min (max 0 scroll-margin)
5931            (max 1 (- (window-height)
5932                      (if mode-line-format 1 0)
5933                      (if header-line-format 1 0)))))))
5934
5935 (defun gnus-article-next-page-1 (lines)
5936   (when (and (not (featurep 'xemacs))
5937              (numberp lines)
5938              (> lines 0)
5939              (numberp (symbol-value 'scroll-margin))
5940              (> (symbol-value 'scroll-margin) 0))
5941     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
5942     ;; too many number of lines if `scroll-margin' is set as two or greater.
5943     (setq lines (min lines
5944                      (max 0 (- (count-lines (window-start) (point-max))
5945                                (symbol-value 'scroll-margin))))))
5946   (condition-case ()
5947       (let ((scroll-in-place nil))
5948         (scroll-up lines))
5949     (end-of-buffer
5950      ;; Long lines may cause an end-of-buffer error.
5951      (goto-char (point-max))))
5952   (gnus-article-beginning-of-window))
5953
5954 (defun gnus-article-prev-page (&optional lines)
5955   "Show previous page of current article.
5956 Argument LINES specifies lines to be scrolled down."
5957   (interactive "p")
5958   (move-to-window-line 0)
5959   (if (and gnus-page-broken
5960            (bobp)
5961            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
5962       (progn
5963         (gnus-narrow-to-page -1)        ;Go to previous page.
5964         (goto-char (point-max))
5965         (recenter (if gnus-article-over-scroll
5966                       (if lines
5967                           (max (+ lines (or (and (boundp 'scroll-margin)
5968                                                  (symbol-value 'scroll-margin))
5969                                             0))
5970                                3)
5971                         (- (window-height) 2))
5972                     -1)))
5973     (prog1
5974         (condition-case ()
5975             (let ((scroll-in-place nil))
5976               (scroll-down lines))
5977           (beginning-of-buffer
5978            (goto-char (point-min))))
5979       (gnus-article-beginning-of-window))))
5980
5981 (defun gnus-article-only-boring-p ()
5982   "Decide whether there is only boring text remaining in the article.
5983 Something \"interesting\" is a word of at least two letters that does
5984 not have a face in `gnus-article-boring-faces'."
5985   (when (and gnus-article-skip-boring
5986              (boundp 'gnus-article-boring-faces)
5987              (symbol-value 'gnus-article-boring-faces))
5988     (save-excursion
5989       (let ((inhibit-point-motion-hooks t))
5990         (catch 'only-boring
5991           (while (re-search-forward "\\b\\w\\w" nil t)
5992             (forward-char -1)
5993             (when (not (gnus-intersection
5994                         (gnus-faces-at (point))
5995                         (symbol-value 'gnus-article-boring-faces)))
5996               (throw 'only-boring nil)))
5997           (throw 'only-boring t))))))
5998
5999 (defun gnus-article-refer-article ()
6000   "Read article specified by message-id around point."
6001   (interactive)
6002   (save-excursion
6003     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6004     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6005     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6006         (let ((msg-id (concat "<" (match-string 0) ">")))
6007           (set-buffer gnus-summary-buffer)
6008           (gnus-summary-refer-article msg-id))
6009       (error "No references around point"))))
6010
6011 (defun gnus-article-show-summary ()
6012   "Reconfigure windows to show summary buffer."
6013   (interactive)
6014   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6015       (error "There is no summary buffer for this article buffer")
6016     (gnus-article-set-globals)
6017     (gnus-configure-windows 'article)
6018     (gnus-summary-goto-subject gnus-current-article)
6019     (gnus-summary-position-point)))
6020
6021 (defun gnus-article-describe-briefly ()
6022   "Describe article mode commands briefly."
6023   (interactive)
6024   (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")))
6025
6026 (defun gnus-article-summary-command ()
6027   "Execute the last keystroke in the summary buffer."
6028   (interactive)
6029   (let ((obuf (current-buffer))
6030         (owin (current-window-configuration))
6031         func)
6032     (switch-to-buffer gnus-article-current-summary 'norecord)
6033     (setq func (lookup-key (current-local-map) (this-command-keys)))
6034     (call-interactively func)
6035     (set-buffer obuf)
6036     (set-window-configuration owin)
6037     (set-window-point (get-buffer-window (current-buffer)) (point))))
6038
6039 (defun gnus-article-summary-command-nosave ()
6040   "Execute the last keystroke in the summary buffer."
6041   (interactive)
6042   (let (func)
6043     (pop-to-buffer gnus-article-current-summary)
6044     (setq func (lookup-key (current-local-map) (this-command-keys)))
6045     (call-interactively func)))
6046
6047 (defun gnus-article-check-buffer ()
6048   "Beep if not in an article buffer."
6049   (unless (equal major-mode 'gnus-article-mode)
6050     (error "Command invoked outside of a Gnus article buffer")))
6051
6052 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6053   "Read a summary buffer key sequence and execute it from the article buffer."
6054   (interactive "P")
6055   (gnus-article-check-buffer)
6056   (let ((nosaves
6057          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6058            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6059            "=" "^" "\M-^" "|"))
6060         (nosave-but-article
6061          '("A\r"))
6062         (nosave-in-article
6063          '("\C-d"))
6064         (up-to-top
6065          '("n" "Gn" "p" "Gp"))
6066         keys new-sum-point)
6067     (save-excursion
6068       (set-buffer gnus-article-current-summary)
6069       (let (gnus-pick-mode)
6070         (push (or key last-command-event) unread-command-events)
6071         (setq keys (if (featurep 'xemacs)
6072                        (events-to-keys (read-key-sequence nil))
6073                      (read-key-sequence nil)))))
6074
6075     (message "")
6076
6077     (cond
6078      ((eq (aref keys (1- (length keys))) ?\C-h)
6079       (with-current-buffer gnus-article-current-summary
6080         (describe-bindings (substring keys 0 -1))))
6081      ((or (member keys nosaves)
6082           (member keys nosave-but-article)
6083           (member keys nosave-in-article))
6084       (let (func)
6085         (save-window-excursion
6086           (pop-to-buffer gnus-article-current-summary)
6087           ;; We disable the pick minor mode commands.
6088           (let (gnus-pick-mode)
6089             (setq func (lookup-key (current-local-map) keys))))
6090         (if (or (not func)
6091                 (numberp func))
6092             (ding)
6093           (unless (member keys nosave-in-article)
6094             (set-buffer gnus-article-current-summary))
6095           (call-interactively func)
6096           (setq new-sum-point (point)))
6097         (when (member keys nosave-but-article)
6098           (pop-to-buffer gnus-article-buffer))))
6099      (t
6100       ;; These commands should restore window configuration.
6101       (let ((obuf (current-buffer))
6102             (owin (current-window-configuration))
6103             win func in-buffer selected new-sum-start new-sum-hscroll err)
6104         (cond (not-restore-window
6105                (pop-to-buffer gnus-article-current-summary)
6106                (setq win (selected-window)))
6107               ((setq win (get-buffer-window gnus-article-current-summary))
6108                (select-window win))
6109               (t
6110                (let ((summary-buffer gnus-article-current-summary))
6111                  (gnus-configure-windows 'article)
6112                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6113                    (let ((gnus-buffer-configuration
6114                           '(article ((vertical 1.0
6115                                                (summary 0.25 point)
6116                                                (article 1.0))))))
6117                      (gnus-configure-windows 'article))
6118                    (setq win (get-buffer-window summary-buffer 'visible)))
6119                  (gnus-select-frame-set-input-focus (window-frame win))
6120                  (select-window win))))
6121         (setq in-buffer (current-buffer))
6122         ;; We disable the pick minor mode commands.
6123         (if (and (setq func (let (gnus-pick-mode)
6124                               (lookup-key (current-local-map) keys)))
6125                  (functionp func)
6126                  (condition-case code
6127                      (progn
6128                        (call-interactively func)
6129                        t)
6130                    (error
6131                     (setq err code)
6132                     nil)))
6133             (progn
6134               (when (eq win (selected-window))
6135                 (setq new-sum-point (point)
6136                       new-sum-start (window-start win)
6137                       new-sum-hscroll (window-hscroll win)))
6138               (when (or (eq in-buffer (current-buffer))
6139                         (when (eq obuf (current-buffer))
6140                           (set-buffer in-buffer)
6141                           t))
6142                 (setq selected (gnus-summary-select-article))
6143                 (set-buffer obuf)
6144                 (unless not-restore-window
6145                   (set-window-configuration owin))
6146                 (when (and (eq selected 'old)
6147                            new-sum-point)
6148                   (set-window-start (get-buffer-window (current-buffer))
6149                                     1)
6150                   (set-window-point (get-buffer-window (current-buffer))
6151                                     (if (article-goto-body)
6152                                         (1- (point))
6153                                       (point))))
6154                 (when (and (not not-restore-window)
6155                            new-sum-point
6156                            (with-current-buffer (window-buffer win)
6157                              (eq major-mode 'gnus-summary-mode)))
6158                   (set-window-point win new-sum-point)
6159                   (set-window-start win new-sum-start)
6160                   (set-window-hscroll win new-sum-hscroll))))
6161           (set-window-configuration owin)
6162           (if err
6163               (signal (car err) (cdr err))
6164             (ding))))))))
6165
6166 (defun gnus-article-describe-key (key)
6167   "Display documentation of the function invoked by KEY.  KEY is a string."
6168   (interactive "kDescribe key: ")
6169   (gnus-article-check-buffer)
6170   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
6171       (save-excursion
6172         (set-buffer gnus-article-current-summary)
6173         (let (gnus-pick-mode)
6174           (if (featurep 'xemacs)
6175               (progn
6176                 (push (elt key 0) unread-command-events)
6177                 (setq key (events-to-keys
6178                            (read-key-sequence "Describe key: "))))
6179             (setq unread-command-events
6180                   (mapcar
6181                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
6182                    (string-to-list key)))
6183             (setq key (read-key-sequence "Describe key: "))))
6184         (describe-key key))
6185     (describe-key key)))
6186
6187 (defun gnus-article-describe-key-briefly (key &optional insert)
6188   "Display documentation of the function invoked by KEY.  KEY is a string."
6189   (interactive "kDescribe key: \nP")
6190   (gnus-article-check-buffer)
6191   (if (eq (key-binding key) 'gnus-article-read-summary-keys)
6192       (save-excursion
6193         (set-buffer gnus-article-current-summary)
6194         (let (gnus-pick-mode)
6195           (if (featurep 'xemacs)
6196               (progn
6197                 (push (elt key 0) unread-command-events)
6198                 (setq key (events-to-keys
6199                            (read-key-sequence "Describe key: "))))
6200             (setq unread-command-events
6201                   (mapcar
6202                    (lambda (x) (if (>= x 128) (list 'meta (- x 128)) x))
6203                    (string-to-list key)))
6204             (setq key (read-key-sequence "Describe key: "))))
6205         (describe-key-briefly key insert))
6206     (describe-key-briefly key insert)))
6207
6208 (defun gnus-article-reply-with-original (&optional wide)
6209   "Start composing a reply mail to the current message.
6210 The text in the region will be yanked.  If the region isn't active,
6211 the entire article will be yanked."
6212   (interactive "P")
6213   (let ((article (cdr gnus-article-current))
6214         contents)
6215     (if (not (gnus-region-active-p))
6216         (with-current-buffer gnus-summary-buffer
6217           (gnus-summary-reply (list (list article)) wide))
6218       (setq contents (buffer-substring (point) (mark t)))
6219       ;; Deactivate active regions.
6220       (when (and (boundp 'transient-mark-mode)
6221                  transient-mark-mode)
6222         (setq mark-active nil))
6223       (with-current-buffer gnus-summary-buffer
6224         (gnus-summary-reply
6225          (list (list article contents)) wide)))))
6226
6227 (defun gnus-article-followup-with-original ()
6228   "Compose a followup to the current article.
6229 The text in the region will be yanked.  If the region isn't active,
6230 the entire article will be yanked."
6231   (interactive)
6232   (let ((article (cdr gnus-article-current))
6233         contents)
6234       (if (not (gnus-region-active-p))
6235           (with-current-buffer gnus-summary-buffer
6236             (gnus-summary-followup (list (list article))))
6237         (setq contents (buffer-substring (point) (mark t)))
6238         ;; Deactivate active regions.
6239         (when (and (boundp 'transient-mark-mode)
6240                    transient-mark-mode)
6241           (setq mark-active nil))
6242         (with-current-buffer gnus-summary-buffer
6243           (gnus-summary-followup
6244            (list (list article contents)))))))
6245
6246 (defun gnus-article-hide (&optional arg force)
6247   "Hide all the gruft in the current article.
6248 This means that signatures, cited text and (some) headers will be
6249 hidden.
6250 If given a prefix, show the hidden text instead."
6251   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6252   (gnus-article-hide-headers arg)
6253   (gnus-article-hide-list-identifiers arg)
6254   (gnus-article-hide-citation-maybe arg force)
6255   (gnus-article-hide-signature arg))
6256
6257 (defun gnus-article-maybe-highlight ()
6258   "Do some article highlighting if article highlighting is requested."
6259   (when (gnus-visual-p 'article-highlight 'highlight)
6260     (gnus-article-highlight-some)))
6261
6262 (defun gnus-check-group-server ()
6263   ;; Make sure the connection to the server is alive.
6264   (unless (gnus-server-opened
6265            (gnus-find-method-for-group gnus-newsgroup-name))
6266     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6267     (gnus-request-group gnus-newsgroup-name t)))
6268
6269 (eval-when-compile
6270   (autoload 'nneething-get-file-name "nneething"))
6271
6272 (defun gnus-request-article-this-buffer (article group)
6273   "Get an article and insert it into this buffer."
6274   (let (do-update-line sparse-header)
6275     (prog1
6276         (save-excursion
6277           (erase-buffer)
6278           (gnus-kill-all-overlays)
6279           (setq group (or group gnus-newsgroup-name))
6280
6281           ;; Using `gnus-request-article' directly will insert the article into
6282           ;; `nntp-server-buffer' - so we'll save some time by not having to
6283           ;; copy it from the server buffer into the article buffer.
6284
6285           ;; We only request an article by message-id when we do not have the
6286           ;; headers for it, so we'll have to get those.
6287           (when (stringp article)
6288             (gnus-read-header article))
6289
6290           ;; If the article number is negative, that means that this article
6291           ;; doesn't belong in this newsgroup (possibly), so we find its
6292           ;; message-id and request it by id instead of number.
6293           (when (and (numberp article)
6294                      gnus-summary-buffer
6295                      (get-buffer gnus-summary-buffer)
6296                      (gnus-buffer-exists-p gnus-summary-buffer))
6297             (save-excursion
6298               (set-buffer gnus-summary-buffer)
6299               (let ((header (gnus-summary-article-header article)))
6300                 (when (< article 0)
6301                   (cond
6302                    ((memq article gnus-newsgroup-sparse)
6303                     ;; This is a sparse gap article.
6304                     (setq do-update-line article)
6305                     (setq article (mail-header-id header))
6306                     (setq sparse-header (gnus-read-header article))
6307                     (setq gnus-newsgroup-sparse
6308                           (delq article gnus-newsgroup-sparse)))
6309                    ((vectorp header)
6310                     ;; It's a real article.
6311                     (setq article (mail-header-id header)))
6312                    (t
6313                     ;; It is an extracted pseudo-article.
6314                     (setq article 'pseudo)
6315                     (gnus-request-pseudo-article header))))
6316
6317                 (let ((method (gnus-find-method-for-group
6318                                gnus-newsgroup-name)))
6319                   (when (and (eq (car method) 'nneething)
6320                              (vectorp header))
6321                     (let ((dir (nneething-get-file-name
6322                                 (mail-header-id header))))
6323                       (when (and (stringp dir)
6324                                  (file-directory-p dir))
6325                         (setq article 'nneething)
6326                         (gnus-group-enter-directory dir))))))))
6327
6328           (cond
6329            ;; Refuse to select canceled articles.
6330            ((and (numberp article)
6331                  gnus-summary-buffer
6332                  (get-buffer gnus-summary-buffer)
6333                  (gnus-buffer-exists-p gnus-summary-buffer)
6334                  (eq (cdr (with-current-buffer gnus-summary-buffer
6335                             (assq article gnus-newsgroup-reads)))
6336                      gnus-canceled-mark))
6337             nil)
6338            ;; We first check `gnus-original-article-buffer'.
6339            ((and (get-buffer gnus-original-article-buffer)
6340                  (numberp article)
6341                  (with-current-buffer gnus-original-article-buffer
6342                    (and (equal (car gnus-original-article) group)
6343                         (eq (cdr gnus-original-article) article))))
6344             (insert-buffer-substring gnus-original-article-buffer)
6345             'article)
6346            ;; Check the backlog.
6347            ((and gnus-keep-backlog
6348                  (gnus-backlog-request-article group article (current-buffer)))
6349             'article)
6350            ;; Check asynchronous pre-fetch.
6351            ((gnus-async-request-fetched-article group article (current-buffer))
6352             (gnus-async-prefetch-next group article gnus-summary-buffer)
6353             (when (and (numberp article) gnus-keep-backlog)
6354               (gnus-backlog-enter-article group article (current-buffer)))
6355             'article)
6356            ;; Check the cache.
6357            ((and gnus-use-cache
6358                  (numberp article)
6359                  (gnus-cache-request-article article group))
6360             'article)
6361            ;; Check the agent cache.
6362            ((gnus-agent-request-article article group)
6363             'article)
6364            ;; Get the article and put into the article buffer.
6365            ((or (stringp article)
6366                 (numberp article))
6367             (let ((gnus-override-method gnus-override-method)
6368                   (methods (and (stringp article)
6369                                 gnus-refer-article-method))
6370                   (backend (car (gnus-find-method-for-group
6371                                  gnus-newsgroup-name)))
6372                   result
6373                   (inhibit-read-only t))
6374               (if (or (not (listp methods))
6375                       (and (symbolp (car methods))
6376                            (assq (car methods) nnoo-definition-alist)))
6377                   (setq methods (list methods)))
6378               (when (and (null gnus-override-method)
6379                          methods)
6380                 (setq gnus-override-method (pop methods)))
6381               (while (not result)
6382                 (when (eq gnus-override-method 'current)
6383                   (setq gnus-override-method
6384                         (with-current-buffer gnus-summary-buffer
6385                           gnus-current-select-method)))
6386                 (erase-buffer)
6387                 (gnus-kill-all-overlays)
6388                 (let ((gnus-newsgroup-name group))
6389                   (gnus-check-group-server))
6390                 (cond
6391                  ((gnus-request-article article group (current-buffer))
6392                   (when (numberp article)
6393                     (gnus-async-prefetch-next group article
6394                                               gnus-summary-buffer)
6395                     (when gnus-keep-backlog
6396                       (gnus-backlog-enter-article
6397                        group article (current-buffer))))
6398                   (setq result 'article))
6399                  (methods
6400                   (setq gnus-override-method (pop methods)))
6401                  ((not (string-match "^400 "
6402                                      (nnheader-get-report backend)))
6403                   ;; If we get 400 server disconnect, reconnect and
6404                   ;; retry; otherwise, assume the article has expired.
6405                   (setq result 'done))))
6406               (and (eq result 'article) 'article)))
6407            ;; It was a pseudo.
6408            (t article)))
6409
6410       ;; Associate this article with the current summary buffer.
6411       (setq gnus-article-current-summary gnus-summary-buffer)
6412
6413       ;; Take the article from the original article buffer
6414       ;; and place it in the buffer it's supposed to be in.
6415       (when (and (get-buffer gnus-article-buffer)
6416                  (equal (buffer-name (current-buffer))
6417                         (buffer-name (get-buffer gnus-article-buffer))))
6418         (save-excursion
6419           (if (get-buffer gnus-original-article-buffer)
6420               (set-buffer gnus-original-article-buffer)
6421             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6422             (buffer-disable-undo)
6423             (setq major-mode 'gnus-original-article-mode)
6424             (setq buffer-read-only t))
6425           (let ((inhibit-read-only t))
6426             (erase-buffer)
6427             (insert-buffer-substring gnus-article-buffer))
6428           (setq gnus-original-article (cons group article)))
6429
6430         ;; Decode charsets.
6431         (run-hooks 'gnus-article-decode-hook)
6432         ;; Mark article as decoded or not.
6433         (setq gnus-article-decoded-p gnus-article-decode-hook))
6434
6435       ;; Update sparse articles.
6436       (when (and do-update-line
6437                  (or (numberp article)
6438                      (stringp article)))
6439         (let ((buf (current-buffer)))
6440           (set-buffer gnus-summary-buffer)
6441           (gnus-summary-update-article do-update-line sparse-header)
6442           (gnus-summary-goto-subject do-update-line nil t)
6443           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6444                             (point))
6445           (set-buffer buf))))))
6446
6447 ;;;
6448 ;;; Article editing
6449 ;;;
6450
6451 (defcustom gnus-article-edit-mode-hook nil
6452   "Hook run in article edit mode buffers."
6453   :group 'gnus-article-various
6454   :type 'hook)
6455
6456 (defvar gnus-article-edit-done-function nil)
6457
6458 (defvar gnus-article-edit-mode-map nil)
6459
6460 ;; Should we be using derived.el for this?
6461 (unless gnus-article-edit-mode-map
6462   (setq gnus-article-edit-mode-map (make-keymap))
6463   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6464
6465   (gnus-define-keys gnus-article-edit-mode-map
6466     "\C-c?"    describe-mode
6467     "\C-c\C-c" gnus-article-edit-done
6468     "\C-c\C-k" gnus-article-edit-exit
6469     "\C-c\C-f\C-t" message-goto-to
6470     "\C-c\C-f\C-o" message-goto-from
6471     "\C-c\C-f\C-b" message-goto-bcc
6472     ;;"\C-c\C-f\C-w" message-goto-fcc
6473     "\C-c\C-f\C-c" message-goto-cc
6474     "\C-c\C-f\C-s" message-goto-subject
6475     "\C-c\C-f\C-r" message-goto-reply-to
6476     "\C-c\C-f\C-n" message-goto-newsgroups
6477     "\C-c\C-f\C-d" message-goto-distribution
6478     "\C-c\C-f\C-f" message-goto-followup-to
6479     "\C-c\C-f\C-m" message-goto-mail-followup-to
6480     "\C-c\C-f\C-k" message-goto-keywords
6481     "\C-c\C-f\C-u" message-goto-summary
6482     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6483     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6484     "\C-c\C-b" message-goto-body
6485     "\C-c\C-i" message-goto-signature
6486
6487     "\C-c\C-t" message-insert-to
6488     "\C-c\C-n" message-insert-newsgroups
6489     "\C-c\C-o" message-sort-headers
6490     "\C-c\C-e" message-elide-region
6491     "\C-c\C-v" message-delete-not-region
6492     "\C-c\C-z" message-kill-to-signature
6493     "\M-\r" message-newline-and-reformat
6494     "\C-c\C-a" mml-attach-file
6495     "\C-a" message-beginning-of-line
6496     "\t" message-tab
6497     "\M-;" comment-region)
6498
6499   (gnus-define-keys (gnus-article-edit-wash-map
6500                      "\C-c\C-w" gnus-article-edit-mode-map)
6501     "f" gnus-article-edit-full-stops))
6502
6503 (easy-menu-define
6504   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6505   '("Field"
6506     ["Fetch To" message-insert-to t]
6507     ["Fetch Newsgroups" message-insert-newsgroups t]
6508     "----"
6509     ["To" message-goto-to t]
6510     ["From" message-goto-from t]
6511     ["Subject" message-goto-subject t]
6512     ["Cc" message-goto-cc t]
6513     ["Reply-To" message-goto-reply-to t]
6514     ["Summary" message-goto-summary t]
6515     ["Keywords" message-goto-keywords t]
6516     ["Newsgroups" message-goto-newsgroups t]
6517     ["Followup-To" message-goto-followup-to t]
6518     ["Mail-Followup-To" message-goto-mail-followup-to t]
6519     ["Distribution" message-goto-distribution t]
6520     ["Body" message-goto-body t]
6521     ["Signature" message-goto-signature t]))
6522
6523 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6524   "Major mode for editing articles.
6525 This is an extended text-mode.
6526
6527 \\{gnus-article-edit-mode-map}"
6528   (make-local-variable 'gnus-article-edit-done-function)
6529   (make-local-variable 'gnus-prev-winconf)
6530   (set (make-local-variable 'font-lock-defaults)
6531        '(message-font-lock-keywords t))
6532   (set (make-local-variable 'mail-header-separator) "")
6533   (set (make-local-variable 'gnus-article-edit-mode) t)
6534   (easy-menu-add message-mode-field-menu message-mode-map)
6535   (mml-mode)
6536   (setq buffer-read-only nil)
6537   (buffer-enable-undo)
6538   (widen))
6539
6540 (defun gnus-article-edit (&optional force)
6541   "Edit the current article.
6542 This will have permanent effect only in mail groups.
6543 If FORCE is non-nil, allow editing of articles even in read-only
6544 groups."
6545   (interactive "P")
6546   (when (and (not force)
6547              (gnus-group-read-only-p))
6548     (error "The current newsgroup does not support article editing"))
6549   (gnus-article-date-original)
6550   (gnus-article-edit-article
6551    'ignore
6552    `(lambda (no-highlight)
6553       'ignore
6554       (gnus-summary-edit-article-done
6555        ,(or (mail-header-references gnus-current-headers) "")
6556        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6557
6558 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6559   "Start editing the contents of the current article buffer."
6560   (let ((winconf (current-window-configuration)))
6561     (set-buffer gnus-article-buffer)
6562     (let ((message-auto-save-directory
6563            ;; Don't associate the article buffer with a draft file.
6564            nil))
6565       (gnus-article-edit-mode))
6566     (funcall start-func)
6567     (set-buffer-modified-p nil)
6568     (gnus-configure-windows 'edit-article)
6569     (setq gnus-article-edit-done-function exit-func)
6570     (setq gnus-prev-winconf winconf)
6571     (unless quiet
6572       (gnus-message 6 "C-c C-c to end edits"))))
6573
6574 (defun gnus-article-edit-done (&optional arg)
6575   "Update the article edits and exit."
6576   (interactive "P")
6577   (let ((func gnus-article-edit-done-function)
6578         (buf (current-buffer))
6579         (start (window-start))
6580         (p (point))
6581         (winconf gnus-prev-winconf))
6582     (widen) ;; Widen it in case that users narrowed the buffer.
6583     (funcall func arg)
6584     (set-buffer buf)
6585     ;; The cache and backlog have to be flushed somewhat.
6586     (when gnus-keep-backlog
6587       (gnus-backlog-remove-article
6588        (car gnus-article-current) (cdr gnus-article-current)))
6589     ;; Flush original article as well.
6590     (save-excursion
6591       (when (get-buffer gnus-original-article-buffer)
6592         (set-buffer gnus-original-article-buffer)
6593         (setq gnus-original-article nil)))
6594     (when gnus-use-cache
6595       (gnus-cache-update-article
6596        (car gnus-article-current) (cdr gnus-article-current)))
6597     ;; We remove all text props from the article buffer.
6598     (kill-all-local-variables)
6599     (set-text-properties (point-min) (point-max) nil)
6600     (gnus-article-mode)
6601     (set-window-configuration winconf)
6602     (set-buffer buf)
6603     (set-window-start (get-buffer-window buf) start)
6604     (set-window-point (get-buffer-window buf) (point)))
6605   (gnus-summary-show-article))
6606
6607 (defun gnus-article-edit-exit ()
6608   "Exit the article editing without updating."
6609   (interactive)
6610   (when (or (not (buffer-modified-p))
6611             (yes-or-no-p "Article modified; kill anyway? "))
6612     (let ((curbuf (current-buffer))
6613           (p (point))
6614           (window-start (window-start)))
6615       (erase-buffer)
6616       (if (gnus-buffer-live-p gnus-original-article-buffer)
6617           (insert-buffer-substring gnus-original-article-buffer))
6618       (let ((winconf gnus-prev-winconf))
6619         (kill-all-local-variables)
6620         (gnus-article-mode)
6621         (set-window-configuration winconf)
6622         ;; Tippy-toe some to make sure that point remains where it was.
6623         (save-current-buffer
6624           (set-buffer curbuf)
6625           (set-window-start (get-buffer-window (current-buffer)) window-start)
6626           (goto-char p))))
6627     (gnus-summary-show-article)))
6628
6629 (defun gnus-article-edit-full-stops ()
6630   "Interactively repair spacing at end of sentences."
6631   (interactive)
6632   (save-excursion
6633     (goto-char (point-min))
6634     (search-forward-regexp "^$" nil t)
6635     (let ((case-fold-search nil))
6636       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
6637
6638 ;;;
6639 ;;; Article highlights
6640 ;;;
6641
6642 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
6643
6644 ;;; Internal Variables:
6645
6646 (defcustom gnus-button-url-regexp
6647   (concat
6648    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
6649    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
6650    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
6651    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
6652        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
6653              (punct "!?:;.,"))
6654          (concat
6655           "\\(?:"
6656           ;; Match paired parentheses, e.g. in Wikipedia URLs:
6657           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]"
6658           "\\|"
6659           "[" chars punct     "]+" "[" chars "]"
6660           "\\)"))
6661      (concat ;; XEmacs 21.4 doesn't support POSIX.
6662       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
6663       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
6664    "\\)")
6665   "Regular expression that matches URLs."
6666   :group 'gnus-article-buttons
6667   :type 'regexp)
6668
6669 (defcustom gnus-button-valid-fqdn-regexp
6670   message-valid-fqdn-regexp
6671   "Regular expression that matches a valid FQDN."
6672   :version "22.1"
6673   :group 'gnus-article-buttons
6674   :type 'regexp)
6675
6676 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
6677 (defcustom gnus-button-valid-localpart-regexp
6678   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
6679   "Regular expression that matches a localpart of mail addresses or MIDs."
6680   :version "22.1"
6681   :group 'gnus-article-buttons
6682   :type 'regexp)
6683
6684 (defcustom gnus-button-man-handler 'manual-entry
6685   "Function to use for displaying man pages.
6686 The function must take at least one argument with a string naming the
6687 man page."
6688   :version "22.1"
6689   :type '(choice (function-item :tag "Man" manual-entry)
6690                  (function-item :tag "Woman" woman)
6691                  (function :tag "Other"))
6692   :group 'gnus-article-buttons)
6693
6694 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
6695   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
6696 If the default site is too slow, try to find a CTAN mirror, see
6697 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
6698 the variable `gnus-button-handle-ctan'."
6699   :version "22.1"
6700   :group 'gnus-article-buttons
6701   :link '(custom-manual "(gnus)Group Parameters")
6702   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
6703                  (const "http://tug.ctan.org/tex-archive/")
6704                  (const "http://www.dante.de/CTAN/")
6705                  (string :tag "Other")))
6706
6707 (defcustom gnus-button-ctan-handler 'browse-url
6708   "Function to use for displaying CTAN links.
6709 The function must take one argument, the string naming the URL."
6710   :version "22.1"
6711   :type '(choice (function-item :tag "Browse Url" browse-url)
6712                  (function :tag "Other"))
6713   :group 'gnus-article-buttons)
6714
6715 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
6716   "Bogus strings removed from CTAN URLs."
6717   :version "22.1"
6718   :group 'gnus-article-buttons
6719   :type '(choice (const "^/?tex-archive/\\|/")
6720                  (regexp :tag "Other")))
6721
6722 (defcustom gnus-button-ctan-directory-regexp
6723   (regexp-opt
6724    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
6725          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
6726          "languages" "macros" "nonfree" "obsolete" "support" "systems"
6727          "tds" "tools" "usergrps" "web") t)
6728   "Regular expression for ctan directories.
6729 It should match all directories in the top level of `gnus-ctan-url'."
6730   :version "22.1"
6731   :group 'gnus-article-buttons
6732   :type 'regexp)
6733
6734 (defcustom gnus-button-mid-or-mail-regexp
6735   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
6736           gnus-button-valid-fqdn-regexp
6737           ">?\\)\\b")
6738   "Regular expression that matches a message ID or a mail address."
6739   :version "22.1"
6740   :group 'gnus-article-buttons
6741   :type 'regexp)
6742
6743 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
6744   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
6745 Strings like this can be either a message ID or a mail address.  If it is one
6746 of the symbols `mid' or `mail', Gnus will always assume that the string is a
6747 message ID or a mail address, respectively.  If this variable is set to the
6748 symbol `ask', always query the user what do do.  If it is a function, this
6749 function will be called with the string as its only argument.  The function
6750 must return `mid', `mail', `invalid' or `ask'."
6751   :version "22.1"
6752   :group 'gnus-article-buttons
6753   :type '(choice (function-item :tag "Heuristic function"
6754                                 gnus-button-mid-or-mail-heuristic)
6755                  (const ask)
6756                  (const mid)
6757                  (const mail)))
6758
6759 (defcustom gnus-button-mid-or-mail-heuristic-alist
6760   '((-10.0 . ".+\\$.+@")
6761     (-10.0 . "#")
6762     (-10.0 . "\\*")
6763     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
6764     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
6765     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
6766     (-1.0  . "^[^a-z]+@")
6767     ;;
6768     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
6769     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
6770     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
6771     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
6772     ;;
6773     (-2.0  . "^[0-9]")
6774     (-1.0  . "^[0-9][0-9]")
6775     ;;
6776     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
6777     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6778     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
6779     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
6780     ;;
6781     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
6782     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
6783     ;;       "[0-9]{8,}.*\@"
6784     (-3.0
6785      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
6786     ;; "[0-9]{12,}.*\@"
6787     ;; compensation for TDMA dated mail addresses:
6788     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
6789     ;;
6790     (-20.0 . "\\.fsf@") ;; Gnus
6791     (-20.0 . "^slrn")
6792     (-20.0 . "^Pine")
6793     (-20.0 . "^alpine\\.")
6794     (-20.0 . "_-_") ;; Subject change in thread
6795     ;;
6796     (-20.0 . "\\.ln@") ;; leafnode
6797     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
6798     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
6799     ;;
6800     ;; (5.0 . "") ;; $local_part_len <= 7
6801     (10.0  . "^[^0-9]+@")
6802     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
6803     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
6804     (3.0   . "\@stud")
6805     ;;
6806     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
6807     ;;
6808     (0.5   . "^[A-Z][a-z]")
6809     (0.5   . "^[A-Z][a-z][a-z]")
6810     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
6811     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
6812   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
6813
6814 A negative RATE indicates a message IDs, whereas a positive indicates a mail
6815 address.  The REGEXP is processed with `case-fold-search' set to nil."
6816   :version "22.1"
6817   :group 'gnus-article-buttons
6818   :type '(repeat (cons (number :tag "Rate")
6819                        (regexp :tag "Regexp"))))
6820
6821 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
6822   "Guess whether MID-OR-MAIL is a message ID or a mail address.
6823 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
6824 address, `ask' if unsure and `invalid' if the string is invalid."
6825   (let ((case-fold-search nil)
6826         (list gnus-button-mid-or-mail-heuristic-alist)
6827         (result 0) rate regexp lpartlen elem)
6828     (setq lpartlen
6829           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
6830     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
6831     ;; Certain special cases...
6832     (when (string-match
6833            (concat
6834             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
6835             "^[0-9]+\\.[0-9]+@compuserve\\|"
6836             "@public\\.gmane\\.org")
6837            mid-or-mail)
6838       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
6839       (setq result 'mail))
6840     (when (string-match "@.*@\\| " mid-or-mail)
6841       (gnus-message 8 "`%s' is invalid." mid-or-mail)
6842       (setq result 'invalid))
6843     ;; Nothing more to do, if result is not a number here...
6844     (when (numberp result)
6845       (while list
6846         (setq elem (car list)
6847               rate (car elem)
6848               regexp (cdr elem)
6849               list (cdr list))
6850         (when (string-match regexp mid-or-mail)
6851           (setq result (+ result rate))
6852           (gnus-message
6853            9 "`%s' matched `%s', rate `%s', result `%s'."
6854            mid-or-mail regexp rate result)))
6855       (when (<= lpartlen 7)
6856         (setq result (+ result 5.0))
6857         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
6858                       mid-or-mail result))
6859       (when (>= lpartlen 12)
6860         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
6861         (cond
6862          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
6863           ;; Long local part should contain realname if e-mail address,
6864           ;; too many digits: message-id.
6865           ;; $score -= 5.0 + 0.1 * $local_part_len;
6866           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
6867           (setq result (+ result rate))
6868           (gnus-message
6869            9 "Many digits in `%s', rate `%s', result `%s'."
6870            mid-or-mail rate result))
6871          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
6872                         mid-or-mail)
6873           ;; Too few vowels [^aeiouy]{4,}.*\@
6874           (setq result (+ result -5.0))
6875           (gnus-message
6876            9 "Few vowels in `%s', rate `%s', result `%s'."
6877            mid-or-mail -5.0 result))
6878          (t
6879           (setq result (+ result 5.0))
6880           (gnus-message
6881            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
6882     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
6883     ;; Maybe we should make this a customizable alist: (condition . 'result)
6884     (cond
6885      ((symbolp result) result)
6886      ;; Now convert number into proper results:
6887      ((< result -10.0) 'mid)
6888      ((> result  10.0) 'mail)
6889      (t 'ask))))
6890
6891 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
6892   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
6893          (url-mid (concat "news" ":" mid-or-mail))
6894          (url-mailto (concat "mailto" ":" mid-or-mail)))
6895     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
6896     (when (fboundp pref)
6897       (setq guessed
6898             ;; get rid of surrounding angles...
6899             (funcall pref
6900                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
6901       (if (or (eq 'mid guessed) (eq 'mail guessed))
6902           (setq pref guessed)
6903         (setq pref 'ask)))
6904     (if (eq pref 'ask)
6905         (save-window-excursion
6906           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
6907               (setq pref 'mail)
6908             (setq pref 'mid))))
6909     (cond ((eq pref 'mid)
6910            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
6911            (gnus-button-handle-news url-mid))
6912           ((eq pref 'mail)
6913            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
6914            (gnus-url-mailto url-mailto))
6915           (t (gnus-message 3 "Invalid string.")))))
6916
6917 (defun gnus-button-handle-custom (fun arg)
6918   "Call function FUN on argument ARG.
6919 Both FUN and ARG are supposed to be strings.  ARG will be passed
6920 as a symbol to FUN."
6921   (funcall (intern fun)
6922            (if (string-match "^customize-apropos" fun)
6923                arg
6924              (intern arg))))
6925
6926 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
6927
6928 ;; FIXME: Maybe we should merge some of the functions that do quite similar
6929 ;; stuff?
6930
6931 (defun gnus-button-handle-describe-function (url)
6932   "Call `describe-function' when pushing the corresponding URL button."
6933   (describe-function
6934    (intern
6935     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6936
6937 (defun gnus-button-handle-describe-variable (url)
6938   "Call `describe-variable' when pushing the corresponding URL button."
6939   (describe-variable
6940    (intern
6941     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
6942
6943 (defun gnus-button-handle-symbol (url)
6944 "Display help on variable or function.
6945 Calls `describe-variable' or `describe-function'."
6946   (let ((sym (intern url)))
6947     (cond
6948      ((fboundp sym) (describe-function sym))
6949      ((boundp sym) (describe-variable sym))
6950      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
6951
6952 (defun gnus-button-handle-describe-key (url)
6953   "Call `describe-key' when pushing the corresponding URL button."
6954   (let* ((key-string
6955           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
6956          (keys (ignore-errors (eval `(kbd ,key-string)))))
6957     (if keys
6958         (describe-key keys)
6959       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
6960
6961 (defun gnus-button-handle-apropos (url)
6962   "Call `apropos' when pushing the corresponding URL button."
6963   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6964
6965 (defun gnus-button-handle-apropos-command (url)
6966   "Call `apropos' when pushing the corresponding URL button."
6967   (apropos-command
6968    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6969
6970 (defun gnus-button-handle-apropos-variable (url)
6971   "Call `apropos' when pushing the corresponding URL button."
6972   (funcall
6973    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
6974    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6975
6976 (defun gnus-button-handle-apropos-documentation (url)
6977   "Call `apropos' when pushing the corresponding URL button."
6978   (funcall
6979    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
6980    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
6981
6982 (defun gnus-button-handle-library (url)
6983   "Call `locate-library' when pushing the corresponding URL button."
6984   (gnus-message 9 "url=`%s'" url)
6985   (let* ((lib (locate-library url))
6986          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
6987     (if (not lib)
6988         (gnus-message 1 "Cannot locale library `%s'." url)
6989       (find-file-read-only file))))
6990
6991 (defun gnus-button-handle-ctan (url)
6992   "Call `browse-url' when pushing a CTAN URL button."
6993   (funcall
6994    gnus-button-ctan-handler
6995    (concat
6996     gnus-ctan-url
6997     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
6998
6999 (defcustom gnus-button-tex-level 5
7000   "*Integer that says how many TeX-related buttons Gnus will show.
7001 The higher the number, the more buttons will appear and the more false
7002 positives are possible.  Note that you can set this variable local to
7003 specific groups.  Setting it higher in TeX groups is probably a good idea.
7004 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7005 how to set variables in specific groups."
7006   :version "22.1"
7007   :group 'gnus-article-buttons
7008   :link '(custom-manual "(gnus)Group Parameters")
7009   :type 'integer)
7010
7011 (defcustom gnus-button-man-level 5
7012   "*Integer that says how many man-related buttons Gnus will show.
7013 The higher the number, the more buttons will appear and the more false
7014 positives are possible.  Note that you can set this variable local to
7015 specific groups.  Setting it higher in Unix groups is probably a good idea.
7016 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7017 how to set variables in specific groups."
7018   :version "22.1"
7019   :group 'gnus-article-buttons
7020   :link '(custom-manual "(gnus)Group Parameters")
7021   :type 'integer)
7022
7023 (defcustom gnus-button-emacs-level 5
7024   "*Integer that says how many emacs-related buttons Gnus will show.
7025 The higher the number, the more buttons will appear and the more false
7026 positives are possible.  Note that you can set this variable local to
7027 specific groups.  Setting it higher in Emacs or Gnus related groups is
7028 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7029 `gnus-parameters' on how to set variables in specific groups."
7030   :version "22.1"
7031   :group 'gnus-article-buttons
7032   :link '(custom-manual "(gnus)Group Parameters")
7033   :type 'integer)
7034
7035 (defcustom gnus-button-message-level 5
7036   "*Integer that says how many buttons for news or mail messages will appear.
7037 The higher the number, the more buttons will appear and the more false
7038 positives are possible."
7039   ;; mail addresses, MIDs, URLs for news, ...
7040   :version "22.1"
7041   :group 'gnus-article-buttons
7042   :type 'integer)
7043
7044 (defcustom gnus-button-browse-level 5
7045   "*Integer that says how many buttons for browsing will appear.
7046 The higher the number, the more buttons will appear and the more false
7047 positives are possible."
7048   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7049   :version "22.1"
7050   :group 'gnus-article-buttons
7051   :type 'integer)
7052
7053 (defcustom gnus-button-alist
7054   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7055      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7056     ((concat "\\b\\(nntp\\|news\\):\\("
7057              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7058      0 t gnus-button-handle-news 2)
7059     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7060      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7061     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7062      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7063     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7064     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7065      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7066     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7067      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7068     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7069      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7070     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7071      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7072     ;; RFC 2368 (The mailto URL scheme)
7073     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7074      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7075     ("\\bmailto:\\([^ \n\t]+\\)"
7076      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7077     ;; CTAN
7078     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
7079              gnus-button-ctan-directory-regexp
7080              "[^][>)!;:,'\n\t ]+\\)")
7081      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
7082     ((concat "\\btex-archive/\\("
7083              gnus-button-ctan-directory-regexp
7084              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
7085      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
7086     ((concat
7087       "\\b\\("
7088       gnus-button-ctan-directory-regexp
7089       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
7090      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
7091     ;; This is info (home-grown style) <info://foo/bar+baz>
7092     ("\\binfo://\\([^'\">\n\t ]+\\)"
7093      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7094     ;; Info GNOME style <info:foo#bar_baz>
7095     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7096      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7097     ;; Info KDE style <info:(foo)bar baz>
7098     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7099      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7100     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7101      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7102     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
7103      ;; Info links like `C-h i d m CC Mode RET'
7104      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 2)
7105     ;; This is custom
7106     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7107      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7108     ;; Emacs help commands
7109     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7110      ;; regexp doesn't match arguments containing ` '.
7111      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7112     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7113      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7114     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7115      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7116     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7117      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7118     ;; The following entries may lead to many false positives so don't enable
7119     ;; them by default (use a high button level).
7120     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7121      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7122      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7123     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7124      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7125     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7126      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7127     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7128      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7129     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7130      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7131     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7132      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7133     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7134      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7135     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7136      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7137     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7138      ;; Unlike the other regexps we really have to require quoting
7139      ;; here to determine where it ends.
7140      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7141     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7142     ("<URL: *\\([^\n<>]*\\)>"
7143      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7144     ;; RFC 2396 (2.4.3., delims) ...
7145     ("\"URL: *\\([^\n\"]*\\)\""
7146      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7147     ;; Raw URLs.
7148     (gnus-button-url-regexp
7149      0 (>= gnus-button-browse-level 0) browse-url 0)
7150     ;; man pages
7151     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7152      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7153      gnus-button-handle-man 1)
7154     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7155     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7156      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7157      gnus-button-handle-man 1)
7158     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7159     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7160     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7161      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7162     ;; Recognizing patches to .el files.  This is somewhat obscure,
7163     ;; but considering the percentage of Gnus users who hack Emacs
7164     ;; Lisp files...
7165     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7166      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7167     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7168      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7169     ;; MID or mail: To avoid too many false positives we don't try to catch
7170     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7171     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7172     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7173     ;; so that non-ambiguous entries (see above) match first.
7174     (gnus-button-mid-or-mail-regexp
7175      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7176   "*Alist of regexps matching buttons in article bodies.
7177
7178 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7179 REGEXP: is the string (case insensitive) matching text around the button (can
7180 also be Lisp expression evaluating to a string),
7181 BUTTON: is the number of the regexp grouping actually matching the button,
7182 FORM: is a Lisp expression which must eval to true for the button to
7183 be added,
7184 CALLBACK: is the function to call when the user push this button, and each
7185 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7186
7187 CALLBACK can also be a variable, in that case the value of that
7188 variable it the real callback function."
7189   :group 'gnus-article-buttons
7190   :type '(repeat (list (choice regexp variable sexp)
7191                        (integer :tag "Button")
7192                        (sexp :tag "Form")
7193                        (function :tag "Callback")
7194                        (repeat :tag "Par"
7195                                :inline t
7196                                (integer :tag "Regexp group")))))
7197 (put 'gnus-button-alist 'risky-local-variable t)
7198
7199 (defcustom gnus-header-button-alist
7200   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7201      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7202     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7203      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7204     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7205      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7206     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7207      0 (>= gnus-button-browse-level 0) browse-url 0)
7208     ("^Subject:" gnus-button-url-regexp
7209      0 (>= gnus-button-browse-level 0) browse-url 0)
7210     ("^[^:]+:" gnus-button-url-regexp
7211      0 (>= gnus-button-browse-level 0) browse-url 0)
7212     ("^OpenPGP:.*url=" gnus-button-url-regexp
7213      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7214     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7215      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7216     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7217      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7218   "*Alist of headers and regexps to match buttons in article heads.
7219
7220 This alist is very similar to `gnus-button-alist', except that each
7221 alist has an additional HEADER element first in each entry:
7222
7223 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7224
7225 HEADER is a regexp to match a header.  For a fuller explanation, see
7226 `gnus-button-alist'."
7227   :group 'gnus-article-buttons
7228   :group 'gnus-article-headers
7229   :type '(repeat (list (regexp :tag "Header")
7230                        (choice regexp variable)
7231                        (integer :tag "Button")
7232                        (sexp :tag "Form")
7233                        (function :tag "Callback")
7234                        (repeat :tag "Par"
7235                                :inline t
7236                                (integer :tag "Regexp group")))))
7237 (put 'gnus-header-button-alist 'risky-local-variable t)
7238
7239 ;;; Commands:
7240
7241 (defun gnus-article-push-button (event)
7242   "Check text under the mouse pointer for a callback function.
7243 If the text under the mouse pointer has a `gnus-callback' property,
7244 call it with the value of the `gnus-data' text property."
7245   (interactive "e")
7246   (set-buffer (window-buffer (posn-window (event-start event))))
7247   (let* ((pos (posn-point (event-start event)))
7248          (data (get-text-property pos 'gnus-data))
7249          (fun (get-text-property pos 'gnus-callback)))
7250     (goto-char pos)
7251     (when fun
7252       (funcall fun data))))
7253
7254 (defun gnus-article-press-button ()
7255   "Check text at point for a callback function.
7256 If the text at point has a `gnus-callback' property,
7257 call it with the value of the `gnus-data' text property."
7258   (interactive)
7259   (let ((data (get-text-property (point) 'gnus-data))
7260         (fun (get-text-property (point) 'gnus-callback)))
7261     (when fun
7262       (funcall fun data))))
7263
7264 (defun gnus-article-highlight (&optional force)
7265   "Highlight current article.
7266 This function calls `gnus-article-highlight-headers',
7267 `gnus-article-highlight-citation',
7268 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7269 do the highlighting.  See the documentation for those functions."
7270   (interactive (list 'force))
7271   (gnus-article-highlight-headers)
7272   (gnus-article-highlight-citation force)
7273   (gnus-article-highlight-signature)
7274   (gnus-article-add-buttons force)
7275   (gnus-article-add-buttons-to-head))
7276
7277 (defun gnus-article-highlight-some (&optional force)
7278   "Highlight current article.
7279 This function calls `gnus-article-highlight-headers',
7280 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7281 do the highlighting.  See the documentation for those functions."
7282   (interactive (list 'force))
7283   (gnus-article-highlight-headers)
7284   (gnus-article-highlight-signature)
7285   (gnus-article-add-buttons))
7286
7287 (defun gnus-article-highlight-headers ()
7288   "Highlight article headers as specified by `gnus-header-face-alist'."
7289   (interactive)
7290   (gnus-with-article-headers
7291     (let (regexp header-face field-face from hpoints fpoints)
7292       (dolist (entry gnus-header-face-alist)
7293         (goto-char (point-min))
7294         (setq regexp (concat "^\\("
7295                              (if (string-equal "" (nth 0 entry))
7296                                  "[^\t ]"
7297                                (nth 0 entry))
7298                              "\\)")
7299               header-face (nth 1 entry)
7300               field-face (nth 2 entry))
7301         (while (and (re-search-forward regexp nil t)
7302                     (not (eobp)))
7303           (beginning-of-line)
7304           (setq from (point))
7305           (unless (search-forward ":" nil t)
7306             (forward-char 1))
7307           (when (and header-face
7308                      (not (memq (point) hpoints)))
7309             (push (point) hpoints)
7310             (gnus-put-text-property from (point) 'face header-face))
7311           (when (and field-face
7312                      (not (memq (setq from (point)) fpoints)))
7313             (push from fpoints)
7314             (if (re-search-forward "^[^ \t]" nil t)
7315                 (forward-char -2)
7316               (goto-char (point-max)))
7317             (gnus-put-text-property from (point) 'face field-face)))))))
7318
7319 (defun gnus-article-highlight-signature ()
7320   "Highlight the signature in an article.
7321 It does this by highlighting everything after
7322 `gnus-signature-separator' using the face `gnus-signature'."
7323   (interactive)
7324   (gnus-with-article-buffer
7325     (let ((inhibit-point-motion-hooks t))
7326       (save-restriction
7327         (when (and gnus-signature-face
7328                    (gnus-article-narrow-to-signature))
7329           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7330                             'face gnus-signature-face)
7331           (widen)
7332           (gnus-article-search-signature)
7333           (let ((start (match-beginning 0))
7334                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7335             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7336                                      end)))))))
7337
7338 (defun gnus-button-in-region-p (b e prop)
7339   "Say whether PROP exists in the region."
7340   (text-property-not-all b e prop nil))
7341
7342 (defun gnus-article-add-buttons (&optional force)
7343   "Find external references in the article and make buttons of them.
7344 \"External references\" are things like Message-IDs and URLs, as
7345 specified by `gnus-button-alist'."
7346   (interactive (list 'force))
7347   (gnus-with-article-buffer
7348     (let ((inhibit-point-motion-hooks t)
7349           (case-fold-search t)
7350           (alist gnus-button-alist)
7351           beg entry regexp)
7352       ;; Remove all old markers.
7353       (let (marker entry new-list)
7354         (while (setq marker (pop gnus-button-marker-list))
7355           (if (or (< marker (point-min)) (>= marker (point-max)))
7356               (push marker new-list)
7357             (goto-char marker)
7358             (when (setq entry (gnus-button-entry))
7359               (put-text-property (match-beginning (nth 1 entry))
7360                                  (match-end (nth 1 entry))
7361                                  'gnus-callback nil))
7362             (set-marker marker nil)))
7363         (setq gnus-button-marker-list new-list))
7364       ;; We skip the headers.
7365       (article-goto-body)
7366       (setq beg (point))
7367       (while (setq entry (pop alist))
7368         (setq regexp (eval (car entry)))
7369         (goto-char beg)
7370         (while (re-search-forward regexp nil t)
7371           (let ((start (match-beginning (nth 1 entry)))
7372                 (end (match-end (nth 1 entry)))
7373                 (from (match-beginning 0)))
7374             (when (and (or (eq t (nth 2 entry))
7375                            (eval (nth 2 entry)))
7376                        (not (gnus-button-in-region-p
7377                              start end 'gnus-callback)))
7378               ;; That optional form returned non-nil, so we add the
7379               ;; button.
7380               (setq from (set-marker (make-marker) from))
7381               (push from gnus-button-marker-list)
7382               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7383                            (gnus-article-extend-url-button from start end))
7384                 (gnus-article-add-button start end
7385                                          'gnus-button-push from)))))))))
7386
7387 (defun gnus-article-extend-url-button (beg start end)
7388   "Extend url button if url is folded into two or more lines.
7389 Return non-nil if button is extended.  BEG is a marker that points to
7390 the beginning position of a text containing url.  START and END are
7391 the endpoints of a url button before it is extended.  The concatenated
7392 url is put as the `gnus-button-url' overlay property on the button."
7393   (let ((opoint (point))
7394         (points (list start end))
7395         url delim regexp)
7396     (prog1
7397         (when (and (progn
7398                      (goto-char end)
7399                      (not (looking-at "[\t ]*[\">]")))
7400                    (progn
7401                      (goto-char start)
7402                      (string-match
7403                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7404                       (buffer-substring (point-at-bol) start)))
7405                    (progn
7406                      (setq url (list (buffer-substring start end))
7407                            delim (if (match-beginning 1) ">" "\""))
7408                      (beginning-of-line)
7409                      (setq regexp (concat
7410                                    (when (and (looking-at
7411                                                message-cite-prefix-regexp)
7412                                               (< (match-end 0) start))
7413                                      (regexp-quote (match-string 0)))
7414                                    "\
7415 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7416                                    delim "\\)"))
7417                      (while (progn
7418                               (forward-line 1)
7419                               (and (looking-at regexp)
7420                                    (prog1
7421                                        (match-beginning 1)
7422                                      (push (or (match-string 2)
7423                                                (match-string 1))
7424                                            url)
7425                                      (push (setq end (or (match-end 2)
7426                                                          (match-end 1)))
7427                                            points)
7428                                      (push (or (match-beginning 2)
7429                                                (match-beginning 1))
7430                                            points)))))
7431                      (match-beginning 2)))
7432           (let (gnus-article-mouse-face widget-mouse-face)
7433             (while points
7434               (gnus-article-add-button (pop points) (pop points)
7435                                        'gnus-button-push beg)))
7436           (let ((overlay (gnus-make-overlay start end)))
7437             (gnus-overlay-put overlay 'evaporate t)
7438             (gnus-overlay-put overlay 'gnus-button-url
7439                               (list (mapconcat 'identity (nreverse url) "")))
7440             (when gnus-article-mouse-face
7441               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7442           t)
7443       (goto-char opoint))))
7444
7445 ;; Add buttons to the head of an article.
7446 (defun gnus-article-add-buttons-to-head ()
7447   "Add buttons to the head of the article."
7448   (interactive)
7449   (gnus-with-article-headers
7450     (let (beg end)
7451       (dolist (entry gnus-header-button-alist)
7452         ;; Each alist entry.
7453         (goto-char (point-min))
7454         (while (re-search-forward (car entry) nil t)
7455           ;; Each header matching the entry.
7456           (setq beg (match-beginning 0))
7457           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7458                              (match-beginning 0))
7459                         (point-max)))
7460           (goto-char beg)
7461           (while (re-search-forward (eval (nth 1 entry)) end t)
7462             ;; Each match within a header.
7463             (let* ((entry (cdr entry))
7464                    (start (match-beginning (nth 1 entry)))
7465                    (end (match-end (nth 1 entry)))
7466                    (form (nth 2 entry)))
7467               (goto-char (match-end 0))
7468               (when (eval form)
7469                 (gnus-article-add-button
7470                  start end (nth 3 entry)
7471                  (buffer-substring (match-beginning (nth 4 entry))
7472                                    (match-end (nth 4 entry)))))))
7473           (goto-char end))))))
7474
7475 ;;; External functions:
7476
7477 (defun gnus-article-add-button (from to fun &optional data)
7478   "Create a button between FROM and TO with callback FUN and data DATA."
7479   (when gnus-article-button-face
7480     (gnus-overlay-put (gnus-make-overlay from to nil t)
7481                       'face gnus-article-button-face))
7482   (gnus-add-text-properties
7483    from to
7484    (nconc (and gnus-article-mouse-face
7485                (list gnus-mouse-face-prop gnus-article-mouse-face))
7486           (list 'gnus-callback fun)
7487           (and data (list 'gnus-data data))))
7488   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7489                          :button-keymap gnus-widget-button-keymap))
7490
7491 ;;; Internal functions:
7492
7493 (defun gnus-article-set-globals ()
7494   (with-current-buffer gnus-summary-buffer
7495     (gnus-set-global-variables)))
7496
7497 (defun gnus-signature-toggle (end)
7498   (gnus-with-article-buffer
7499     (let ((inhibit-point-motion-hooks t))
7500       (if (text-property-any end (point-max) 'article-type 'signature)
7501           (progn
7502             (gnus-delete-wash-type 'signature)
7503             (gnus-remove-text-properties-when
7504              'article-type 'signature end (point-max)
7505              (cons 'article-type (cons 'signature
7506                                        gnus-hidden-properties))))
7507         (gnus-add-wash-type 'signature)
7508         (gnus-add-text-properties-when
7509          'article-type nil end (point-max)
7510          (cons 'article-type (cons 'signature
7511                                    gnus-hidden-properties)))))
7512     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7513       (gnus-set-mode-line 'article))))
7514
7515 (defun gnus-button-entry ()
7516   ;; Return the first entry in `gnus-button-alist' matching this place.
7517   (let ((alist gnus-button-alist)
7518         (entry nil))
7519     (while alist
7520       (setq entry (pop alist))
7521       (if (looking-at (eval (car entry)))
7522           (setq alist nil)
7523         (setq entry nil)))
7524     entry))
7525
7526 (defun gnus-button-push (marker)
7527   ;; Push button starting at MARKER.
7528   (save-excursion
7529     (goto-char marker)
7530     (let* ((entry (gnus-button-entry))
7531            (inhibit-point-motion-hooks t)
7532            (fun (nth 3 entry))
7533            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7534                           (get-char-property marker 'gnus-button-url))
7535                      (mapcar (lambda (group)
7536                                (let ((string (match-string group)))
7537                                  (set-text-properties
7538                                   0 (length string) nil string)
7539                                  string))
7540                              (nthcdr 4 entry)))))
7541       (cond
7542        ((fboundp fun)
7543         (apply fun args))
7544        ((and (boundp fun)
7545              (fboundp (symbol-value fun)))
7546         (apply (symbol-value fun) args))
7547        (t
7548         (gnus-message 1 "You must define `%S' to use this button"
7549                       (cons fun args)))))))
7550
7551 (defun gnus-parse-news-url (url)
7552   (let (scheme server port group message-id articles)
7553     (with-temp-buffer
7554       (insert url)
7555       (goto-char (point-min))
7556       (when (looking-at "\\([A-Za-z]+\\):")
7557         (setq scheme (match-string 1))
7558         (goto-char (match-end 0)))
7559       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7560         (setq server (match-string 1))
7561         (setq port (if (stringp (match-string 3))
7562                        (string-to-number (match-string 3))
7563                      (match-string 3)))
7564         (goto-char (match-end 0)))
7565
7566       (cond
7567        ((looking-at "\\(.*@.*\\)")
7568         (setq message-id (match-string 1)))
7569        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7570         (setq group (match-string 1)
7571               articles (split-string (match-string 2) "-")))
7572        ((looking-at "\\([^/]+\\)/?")
7573         (setq group (match-string 1)))
7574        (t
7575         (error "Unknown news URL syntax"))))
7576     (list scheme server port group message-id articles)))
7577
7578 (defun gnus-button-handle-news (url)
7579   "Fetch a news URL."
7580   (destructuring-bind (scheme server port group message-id articles)
7581       (gnus-parse-news-url url)
7582     (cond
7583      (message-id
7584       (save-excursion
7585         (set-buffer gnus-summary-buffer)
7586         (if server
7587             (let ((gnus-refer-article-method
7588                    (nconc (list (list 'nntp server))
7589                           gnus-refer-article-method))
7590                   (nntp-port-number (or port "nntp")))
7591               (gnus-message 7 "Fetching %s with %s"
7592                             message-id gnus-refer-article-method)
7593               (gnus-summary-refer-article message-id))
7594           (gnus-summary-refer-article message-id))))
7595      (group
7596       (gnus-button-fetch-group url)))))
7597
7598 (defun gnus-button-patch (library line)
7599   "Visit an Emacs Lisp library LIBRARY on line LINE."
7600   (interactive)
7601   (let ((file (locate-library (file-name-nondirectory library))))
7602     (unless file
7603       (error "Couldn't find library %s" library))
7604     (find-file file)
7605     (goto-line (string-to-number line))))
7606
7607 (defun gnus-button-handle-man (url)
7608   "Fetch a man page."
7609   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7610   (when (eq gnus-button-man-handler 'woman)
7611     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7612   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7613   (funcall gnus-button-man-handler url))
7614
7615 (defun gnus-button-handle-info-url (url)
7616   "Fetch an info URL."
7617   (setq url (mm-subst-char-in-string ?+ ?\  url))
7618   (cond
7619    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7620     (gnus-info-find-node
7621      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7622                      "Gnus")
7623              ")" (gnus-url-unhex-string (match-string 2 url)))))
7624    ((string-match "([^)\"]+)[^\"]+" url)
7625     (setq url
7626           (gnus-replace-in-string
7627            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
7628     (gnus-info-find-node url))
7629    (t (error "Can't parse %s" url))))
7630
7631 (defun gnus-button-handle-info-url-gnome (url)
7632   "Fetch GNOME style info URL."
7633   (setq url (mm-subst-char-in-string ?_ ?\  url))
7634   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
7635       (gnus-info-find-node
7636        (concat "("
7637                (gnus-url-unhex-string
7638                  (match-string 1 url))
7639                ")"
7640                (or (gnus-url-unhex-string
7641                     (match-string 2 url))
7642                    "Top")))
7643     (error "Can't parse %s" url)))
7644
7645 (defun gnus-button-handle-info-url-kde (url)
7646   "Fetch KDE style info URL."
7647   (gnus-info-find-node (gnus-url-unhex-string url)))
7648
7649 (defun gnus-button-handle-info-keystrokes (url)
7650   "Call `info' when pushing the corresponding URL button."
7651   ;; For links like `C-h i d m gnus RET', `C-h i d m CC Mode RET'.
7652   (info)
7653   (Info-directory)
7654   (Info-menu url))
7655
7656 (defun gnus-button-openpgp (url)
7657   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
7658   (with-temp-buffer
7659     (mm-url-insert-file-contents-external url)
7660     (pgg-snarf-keys-region (point-min) (point-max))
7661     (pgg-display-output-buffer nil nil nil)))
7662
7663 (defun gnus-button-message-id (message-id)
7664   "Fetch MESSAGE-ID."
7665   (with-current-buffer gnus-summary-buffer
7666     (gnus-summary-refer-article message-id)))
7667
7668 (defun gnus-button-fetch-group (address &rest ignore)
7669   "Fetch GROUP specified by ADDRESS."
7670   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
7671                       address)
7672     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
7673     ;; for nntp:// and news://
7674     (setq address (match-string 3 address)))
7675   (if (not (string-match "[:/]" address))
7676       ;; This is just a simple group url.
7677       (gnus-group-read-ephemeral-group address gnus-select-method)
7678     (if (not
7679          (string-match
7680           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
7681           address))
7682         (error "Can't parse %s" address)
7683       (gnus-group-read-ephemeral-group
7684        (match-string 4 address)
7685        `(nntp ,(match-string 1 address)
7686               (nntp-address ,(match-string 1 address))
7687               (nntp-port-number ,(if (match-end 3)
7688                                      (match-string 3 address)
7689                                    "nntp")))
7690        nil nil nil
7691        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
7692
7693 (defun gnus-url-parse-query-string (query &optional downcase)
7694   (let (retval pairs cur key val)
7695     (setq pairs (split-string query "&"))
7696     (while pairs
7697       (setq cur (car pairs)
7698             pairs (cdr pairs))
7699       (if (not (string-match "=" cur))
7700           nil                           ; Grace
7701         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
7702               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
7703         (if downcase
7704             (setq key (downcase key)))
7705         (setq cur (assoc key retval))
7706         (if cur
7707             (setcdr cur (cons val (cdr cur)))
7708           (setq retval (cons (list key val) retval)))))
7709     retval))
7710
7711 (defun gnus-url-mailto (url)
7712   ;; Send mail to someone
7713   (when (string-match "mailto:/*\\(.*\\)" url)
7714     (setq url (substring url (match-beginning 1) nil)))
7715   (let (to args subject func)
7716     (setq args (gnus-url-parse-query-string
7717                 (if (string-match "^\\?" url)
7718                     (substring url 1)
7719                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
7720                       (concat "to=" (match-string 1 url) "&"
7721                               (match-string 2 url))
7722                     (concat "to=" url)))
7723                 t)
7724           subject (cdr-safe (assoc "subject" args)))
7725     (gnus-msg-mail)
7726     (while args
7727       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
7728       (if (fboundp func)
7729           (funcall func)
7730         (message-position-on-field (caar args)))
7731       (insert (gnus-replace-in-string
7732                (mapconcat 'identity (reverse (cdar args)) ", ")
7733                "\r\n" "\n" t))
7734       (setq args (cdr args)))
7735     (if subject
7736         (message-goto-body)
7737       (message-goto-subject))))
7738
7739 (defun gnus-button-embedded-url (address)
7740   "Activate ADDRESS with `browse-url'."
7741   (browse-url (gnus-strip-whitespace address)))
7742
7743 ;;; Next/prev buttons in the article buffer.
7744
7745 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
7746 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
7747
7748 (defvar gnus-prev-page-map
7749   (let ((map (make-sparse-keymap)))
7750     (define-key map gnus-mouse-2 'gnus-button-prev-page)
7751     (define-key map "\r" 'gnus-button-prev-page)
7752     map))
7753
7754 (defvar gnus-next-page-map
7755   (let ((map (make-sparse-keymap)))
7756     (unless (>= emacs-major-version 21)
7757       ;; XEmacs doesn't care.
7758       (set-keymap-parent map gnus-article-mode-map))
7759     (define-key map gnus-mouse-2 'gnus-button-next-page)
7760     (define-key map "\r" 'gnus-button-next-page)
7761     map))
7762
7763 (defun gnus-insert-prev-page-button ()
7764   (let ((b (point)) e
7765         (inhibit-read-only t))
7766     (gnus-eval-format
7767      gnus-prev-page-line-format nil
7768      `(keymap ,gnus-prev-page-map
7769               gnus-prev t
7770               gnus-callback gnus-article-button-prev-page
7771               article-type annotation))
7772     (setq e (if (bolp)
7773                 ;; Exclude a newline.
7774                 (1- (point))
7775               (point)))
7776     (when gnus-article-button-face
7777       (gnus-overlay-put (gnus-make-overlay b e nil t)
7778                         'face gnus-article-button-face))
7779     (widget-convert-button
7780      'link b e
7781      :action 'gnus-button-prev-page
7782      :button-keymap gnus-prev-page-map)))
7783
7784 (defun gnus-button-next-page (&optional args more-args)
7785   "Go to the next page."
7786   (interactive)
7787   (let ((win (selected-window)))
7788     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7789     (gnus-article-next-page)
7790     (select-window win)))
7791
7792 (defun gnus-button-prev-page (&optional args more-args)
7793   "Go to the prev page."
7794   (interactive)
7795   (let ((win (selected-window)))
7796     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7797     (gnus-article-prev-page)
7798     (select-window win)))
7799
7800 (defun gnus-insert-next-page-button ()
7801   (let ((b (point)) e
7802         (inhibit-read-only t))
7803     (gnus-eval-format gnus-next-page-line-format nil
7804                       `(keymap ,gnus-next-page-map
7805                                gnus-next t
7806                                gnus-callback gnus-article-button-next-page
7807                                article-type annotation))
7808     (setq e (if (bolp)
7809                 ;; Exclude a newline.
7810                 (1- (point))
7811               (point)))
7812     (when gnus-article-button-face
7813       (gnus-overlay-put (gnus-make-overlay b e nil t)
7814                         'face gnus-article-button-face))
7815     (widget-convert-button
7816      'link b e
7817      :action 'gnus-button-next-page
7818      :button-keymap gnus-next-page-map)))
7819
7820 (defun gnus-article-button-next-page (arg)
7821   "Go to the next page."
7822   (interactive "P")
7823   (let ((win (selected-window)))
7824     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7825     (gnus-article-next-page)
7826     (select-window win)))
7827
7828 (defun gnus-article-button-prev-page (arg)
7829   "Go to the prev page."
7830   (interactive "P")
7831   (let ((win (selected-window)))
7832     (select-window (gnus-get-buffer-window gnus-article-buffer t))
7833     (gnus-article-prev-page)
7834     (select-window win)))
7835
7836 (defvar gnus-decode-header-methods
7837   '(mail-decode-encoded-word-region)
7838   "List of methods used to decode headers.
7839
7840 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
7841 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
7842 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
7843 whose names match REGEXP.
7844
7845 For example:
7846 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
7847  mail-decode-encoded-word-region
7848  (\"chinese\" . rfc1843-decode-region))
7849 ")
7850
7851 (defvar gnus-decode-header-methods-cache nil)
7852
7853 (defun gnus-multi-decode-header (start end)
7854   "Apply the functions from `gnus-encoded-word-methods' that match."
7855   (unless (and gnus-decode-header-methods-cache
7856                (eq gnus-newsgroup-name
7857                    (car gnus-decode-header-methods-cache)))
7858     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
7859     (dolist (x gnus-decode-header-methods)
7860       (if (symbolp x)
7861           (nconc gnus-decode-header-methods-cache (list x))
7862         (if (and gnus-newsgroup-name
7863                  (string-match (car x) gnus-newsgroup-name))
7864             (nconc gnus-decode-header-methods-cache
7865                    (list (cdr x)))))))
7866   (let ((xlist gnus-decode-header-methods-cache))
7867     (pop xlist)
7868     (save-restriction
7869       (narrow-to-region start end)
7870       (while xlist
7871         (funcall (pop xlist) (point-min) (point-max))))))
7872
7873 ;;;
7874 ;;; Treatment top-level handling.
7875 ;;;
7876
7877 (defun gnus-treat-article (condition &optional part-number total-parts type)
7878   (let ((length (- (point-max) (point-min)))
7879         (alist gnus-treatment-function-alist)
7880         (article-goto-body-goes-to-point-min-p t)
7881         (treated-type
7882          (or (not type)
7883              (catch 'found
7884                (let ((list gnus-article-treat-types))
7885                  (while list
7886                    (when (string-match (pop list) type)
7887                      (throw 'found t)))))))
7888         (highlightp (gnus-visual-p 'article-highlight 'highlight))
7889         val elem)
7890     (gnus-run-hooks 'gnus-part-display-hook)
7891     (dolist (elem alist)
7892       (setq val
7893             (save-excursion
7894               (when (gnus-buffer-live-p gnus-summary-buffer)
7895                 (set-buffer gnus-summary-buffer))
7896               (symbol-value (car elem))))
7897       (when (and (or (consp val)
7898                      treated-type)
7899                  (gnus-treat-predicate val)
7900                  (or (not (get (car elem) 'highlight))
7901                      highlightp))
7902         (save-restriction
7903           (funcall (cadr elem)))))))
7904
7905 ;; Dynamic variables.
7906 (eval-when-compile
7907   (defvar part-number)
7908   (defvar total-parts)
7909   (defvar type)
7910   (defvar condition)
7911   (defvar length))
7912
7913 (defun gnus-treat-predicate (val)
7914   (cond
7915    ((null val)
7916     nil)
7917    (condition
7918     (eq condition val))
7919    ((and (listp val)
7920          (stringp (car val)))
7921     (apply 'gnus-or (mapcar `(lambda (s)
7922                                (string-match s ,(or gnus-newsgroup-name "")))
7923                             val)))
7924    ((listp val)
7925     (let ((pred (pop val)))
7926       (cond
7927        ((eq pred 'or)
7928         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
7929        ((eq pred 'and)
7930         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
7931        ((eq pred 'not)
7932         (not (gnus-treat-predicate (car val))))
7933        ((eq pred 'typep)
7934         (equal (car val) type))
7935        (t
7936         (error "%S is not a valid predicate" pred)))))
7937    ((eq val t)
7938     t)
7939    ((eq val 'head)
7940     nil)
7941    ((eq val 'first)
7942     (eq part-number 1))
7943    ((eq val 'last)
7944     (eq part-number total-parts))
7945    ((numberp val)
7946     (< length val))
7947    (t
7948     (error "%S is not a valid value" val))))
7949
7950 (defun gnus-article-encrypt-body (protocol &optional n)
7951   "Encrypt the article body."
7952   (interactive
7953    (list
7954     (or gnus-article-encrypt-protocol
7955         (completing-read "Encrypt protocol: "
7956                          gnus-article-encrypt-protocol-alist
7957                          nil t))
7958     current-prefix-arg))
7959   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
7960     (unless func
7961       (error "Can't find the encrypt protocol %s" protocol))
7962     (if (member gnus-newsgroup-name '("nndraft:delayed"
7963                                       "nndraft:drafts"
7964                                       "nndraft:queue"))
7965         (error "Can't encrypt the article in group %s"
7966                gnus-newsgroup-name))
7967     (gnus-summary-iterate n
7968       (save-excursion
7969         (set-buffer gnus-summary-buffer)
7970         (let ((mail-parse-charset gnus-newsgroup-charset)
7971               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
7972               (summary-buffer gnus-summary-buffer)
7973               references point)
7974           (gnus-set-global-variables)
7975           (when (gnus-group-read-only-p)
7976             (error "The current newsgroup does not support article encrypt"))
7977           (gnus-summary-show-article t)
7978           (setq references
7979               (or (mail-header-references gnus-current-headers) ""))
7980           (set-buffer gnus-article-buffer)
7981           (let* ((inhibit-read-only t)
7982                  (headers
7983                   (mapcar (lambda (field)
7984                             (and (save-restriction
7985                                    (message-narrow-to-head)
7986                                    (goto-char (point-min))
7987                                    (search-forward field nil t))
7988                                  (prog2
7989                                      (message-narrow-to-field)
7990                                      (buffer-string)
7991                                    (delete-region (point-min) (point-max))
7992                                    (widen))))
7993                           '("Content-Type:" "Content-Transfer-Encoding:"
7994                             "Content-Disposition:"))))
7995             (message-narrow-to-head)
7996             (message-remove-header "MIME-Version")
7997             (goto-char (point-max))
7998             (setq point (point))
7999             (insert (apply 'concat headers))
8000             (widen)
8001             (narrow-to-region point (point-max))
8002             (let ((message-options message-options))
8003               (message-options-set 'message-sender user-mail-address)
8004               (message-options-set 'message-recipients user-mail-address)
8005               (message-options-set 'message-sign-encrypt 'not)
8006               (funcall func))
8007             (goto-char (point-min))
8008             (insert "MIME-Version: 1.0\n")
8009             (widen)
8010             (gnus-summary-edit-article-done
8011              references nil summary-buffer t))
8012           (when gnus-keep-backlog
8013             (gnus-backlog-remove-article
8014              (car gnus-article-current) (cdr gnus-article-current)))
8015           (save-excursion
8016             (when (get-buffer gnus-original-article-buffer)
8017               (set-buffer gnus-original-article-buffer)
8018               (setq gnus-original-article nil)))
8019           (when gnus-use-cache
8020             (gnus-cache-update-article
8021              (car gnus-article-current) (cdr gnus-article-current))))))))
8022
8023 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8024   "The following specs can be used:
8025 %t  The security MIME type
8026 %i  Additional info
8027 %d  Details
8028 %D  Details if button is pressed")
8029
8030 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8031   "The following specs can be used:
8032 %t  The security MIME type
8033 %i  Additional info
8034 %d  Details
8035 %D  Details if button is pressed")
8036
8037 (defvar gnus-mime-security-button-line-format-alist
8038   '((?t gnus-tmp-type ?s)
8039     (?i gnus-tmp-info ?s)
8040     (?d gnus-tmp-details ?s)
8041     (?D gnus-tmp-pressed-details ?s)))
8042
8043 (defvar gnus-mime-security-button-commands
8044   '((gnus-article-press-button "\r" "Show Detail")
8045     (undefined "v")
8046     (undefined "t")
8047     (undefined "C")
8048     (gnus-mime-security-save-part "o" "Save...")
8049     (undefined "\C-o")
8050     (undefined "r")
8051     (undefined "d")
8052     (undefined "c")
8053     (undefined "i")
8054     (undefined "E")
8055     (undefined "e")
8056     (undefined "p")
8057     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8058     (undefined ".")))
8059
8060 (defvar gnus-mime-security-button-map
8061   (let ((map (make-sparse-keymap)))
8062     (define-key map gnus-mouse-2 'gnus-article-push-button)
8063     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8064     (dolist (c gnus-mime-security-button-commands)
8065       (define-key map (cadr c) (car c)))
8066     map))
8067
8068 (easy-menu-define
8069   gnus-mime-security-button-menu gnus-mime-security-button-map
8070   "Security button menu."
8071   `("Security Part"
8072     ,@(delq nil
8073             (mapcar (lambda (c)
8074                       (unless (eq (car c) 'undefined)
8075                         (vector (caddr c) (car c) :active t)))
8076                     gnus-mime-security-button-commands))))
8077
8078 (defun gnus-mime-security-button-menu (event prefix)
8079   "Construct a context-sensitive menu of security commands."
8080   (interactive "e\nP")
8081   (save-window-excursion
8082     (let ((pos (event-start event)))
8083       (select-window (posn-window pos))
8084       (goto-char (posn-point pos))
8085       (gnus-article-check-buffer)
8086       (popup-menu gnus-mime-security-button-menu nil prefix))))
8087
8088 (defvar gnus-mime-security-details-buffer nil)
8089
8090 (defvar gnus-mime-security-button-pressed nil)
8091
8092 (defvar gnus-mime-security-show-details-inline t
8093   "If non-nil, show details in the article buffer.")
8094
8095 (defun gnus-mime-security-verify-or-decrypt (handle)
8096   (mm-remove-parts (cdr handle))
8097   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8098         point (inhibit-read-only t))
8099     (if region
8100         (goto-char (car region)))
8101     (setq point (point))
8102     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8103       (let* ((mm-verify-option 'known)
8104              (mm-decrypt-option 'known)
8105              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8106         (unless (eq nparts (cdr handle))
8107           (mm-destroy-parts (cdr handle))
8108           (setcdr handle nparts))))
8109     (gnus-mime-display-security handle)
8110     (when region
8111       (delete-region (point) (cdr region))
8112       (set-marker (car region) nil)
8113       (set-marker (cdr region) nil))
8114     (goto-char point)))
8115
8116 (defun gnus-mime-security-show-details (handle)
8117   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8118     (if (not details)
8119         (gnus-message 5 "No details.")
8120       (if gnus-mime-security-show-details-inline
8121           (let ((gnus-mime-security-button-pressed
8122                  (not (get-text-property (point) 'gnus-mime-details)))
8123                 (gnus-mime-security-button-line-format
8124                  (get-text-property (point) 'gnus-line-format))
8125                 (inhibit-read-only t))
8126             (forward-char -1)
8127             (while (eq (get-text-property (point) 'gnus-line-format)
8128                        gnus-mime-security-button-line-format)
8129               (forward-char -1))
8130             (forward-char)
8131             (save-restriction
8132               (narrow-to-region (point) (point))
8133               (gnus-insert-mime-security-button handle))
8134             (delete-region (point)
8135                            (or (text-property-not-all
8136                                 (point) (point-max)
8137                                 'gnus-line-format
8138                                 gnus-mime-security-button-line-format)
8139                                (point-max))))
8140         ;; Not inlined.
8141         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8142             (with-current-buffer gnus-mime-security-details-buffer
8143               (erase-buffer)
8144               t)
8145           (setq gnus-mime-security-details-buffer
8146                 (gnus-get-buffer-create "*MIME Security Details*")))
8147         (with-current-buffer gnus-mime-security-details-buffer
8148           (insert details)
8149           (goto-char (point-min)))
8150         (pop-to-buffer gnus-mime-security-details-buffer)))))
8151
8152 (defun gnus-mime-security-press-button (handle)
8153   (save-excursion
8154     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8155         (gnus-mime-security-show-details handle)
8156       (gnus-mime-security-verify-or-decrypt handle))))
8157
8158 (defun gnus-insert-mime-security-button (handle &optional displayed)
8159   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8160          (gnus-tmp-type
8161           (concat
8162            (or (nth 2 (assoc protocol mm-verify-function-alist))
8163                (nth 2 (assoc protocol mm-decrypt-function-alist))
8164                "Unknown")
8165            (if (equal (car handle) "multipart/signed")
8166                " Signed" " Encrypted")
8167            " Part"))
8168          (gnus-tmp-info
8169           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8170               "Undecided"))
8171          (gnus-tmp-details
8172           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8173          gnus-tmp-pressed-details
8174          b e)
8175     (setq gnus-tmp-details
8176           (if gnus-tmp-details
8177               (concat "\n" gnus-tmp-details)
8178             ""))
8179     (setq gnus-tmp-pressed-details
8180           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8181     (unless (bolp)
8182       (insert "\n"))
8183     (setq b (point))
8184     (gnus-eval-format
8185      gnus-mime-security-button-line-format
8186      gnus-mime-security-button-line-format-alist
8187      `(keymap ,gnus-mime-security-button-map
8188          gnus-callback gnus-mime-security-press-button
8189          gnus-line-format ,gnus-mime-security-button-line-format
8190          gnus-mime-details ,gnus-mime-security-button-pressed
8191          article-type annotation
8192          gnus-data ,handle))
8193     (setq e (if (bolp)
8194                 ;; Exclude a newline.
8195                 (1- (point))
8196               (point)))
8197     (when gnus-article-button-face
8198       (gnus-overlay-put (gnus-make-overlay b e nil t)
8199                         'face gnus-article-button-face))
8200     (widget-convert-button
8201      'link b e
8202      :mime-handle handle
8203      :action 'gnus-widget-press-button
8204      :button-keymap gnus-mime-security-button-map
8205      :help-echo
8206      (lambda (widget/window &optional overlay pos)
8207        ;; Needed to properly clear the message due to a bug in
8208        ;; wid-edit (XEmacs only).
8209        (when (boundp 'help-echo-owns-message)
8210          (setq help-echo-owns-message t))
8211        (format
8212         "%S: show detail; %S: more options"
8213         (aref gnus-mouse-2 0)
8214         (aref gnus-down-mouse-3 0))))))
8215
8216 (defun gnus-mime-display-security (handle)
8217   (save-restriction
8218     (narrow-to-region (point) (point))
8219     (unless (gnus-unbuttonized-mime-type-p (car handle))
8220       (gnus-insert-mime-security-button handle))
8221     (gnus-mime-display-part (cadr handle))
8222     (unless (bolp)
8223       (insert "\n"))
8224     (unless (gnus-unbuttonized-mime-type-p (car handle))
8225       (let ((gnus-mime-security-button-line-format
8226              gnus-mime-security-button-end-line-format))
8227         (gnus-insert-mime-security-button handle)))
8228     (mm-set-handle-multipart-parameter
8229      handle 'gnus-region
8230      (cons (set-marker (make-marker) (point-min))
8231            (set-marker (make-marker) (point-max))))
8232     (goto-char (point-max))))
8233
8234 (defun gnus-mime-security-run-function (function)
8235   "Run FUNCTION with the security part under point."
8236   (gnus-article-check-buffer)
8237   (let ((data (get-text-property (point) 'gnus-data))
8238         buffer handle)
8239     (when (and (stringp (car-safe data))
8240                (setq buffer (mm-handle-multipart-original-buffer data))
8241                (setq handle (cadr data)))
8242       (if (bufferp (mm-handle-buffer handle))
8243           (progn
8244             (setq handle (cons buffer (copy-sequence (cdr handle))))
8245             (mm-handle-set-undisplayer handle nil))
8246         (setq handle (mm-make-handle
8247                       buffer
8248                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8249                       nil nil nil nil nil nil)))
8250       (funcall function handle))))
8251
8252 (defun gnus-mime-security-save-part ()
8253   "Save the security part under point."
8254   (interactive)
8255   (gnus-mime-security-run-function 'mm-save-part))
8256
8257 (defun gnus-mime-security-pipe-part ()
8258   "Pipe the security part under point to a process."
8259   (interactive)
8260   (gnus-mime-security-run-function 'mm-pipe-part))
8261
8262 (gnus-ems-redefine)
8263
8264 (provide 'gnus-art)
8265
8266 (run-hooks 'gnus-art-load-hook)
8267
8268 ;;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
8269 ;;; gnus-art.el ends here