gnus-art.el (gnus-article-browse-html-save-cid-content, gnus-article-browse-html...
[gnus] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Gnus
2
3 ;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 (eval-when-compile
28   (require 'cl))
29 (defvar tool-bar-map)
30 (defvar w3m-minor-mode-map)
31
32 (require 'gnus)
33 (require 'gnus-util)
34 (require 'gnus-sum)
35 (require 'gnus-spec)
36 (require 'gnus-int)
37 (require 'gnus-win)
38 (require 'mm-bodies)
39 (require 'mail-parse)
40 (require 'mm-decode)
41 (require 'mm-view)
42 (require 'wid-edit)
43 (require 'mm-uu)
44 (require 'message)
45 (require 'mouse)
46
47 (autoload 'gnus-msg-mail "gnus-msg" nil t)
48 (autoload 'gnus-button-mailto "gnus-msg")
49 (autoload 'gnus-button-reply "gnus-msg" nil t)
50 (autoload 'parse-time-string "parse-time" nil nil)
51 (autoload 'ansi-color-apply-on-region "ansi-color")
52 (autoload 'mm-url-insert-file-contents-external "mm-url")
53 (autoload 'mm-extern-cache-contents "mm-extern")
54
55 (defgroup gnus-article nil
56   "Article display."
57   :link '(custom-manual "(gnus)Article Buffer")
58   :group 'gnus)
59
60 (defgroup gnus-article-treat nil
61   "Treating article parts."
62   :link '(custom-manual "(gnus)Article Hiding")
63   :group 'gnus-article)
64
65 (defgroup gnus-article-hiding nil
66   "Hiding article parts."
67   :link '(custom-manual "(gnus)Article Hiding")
68   :group 'gnus-article)
69
70 (defgroup gnus-article-highlight nil
71   "Article highlighting."
72   :link '(custom-manual "(gnus)Article Highlighting")
73   :group 'gnus-article
74   :group 'gnus-visual)
75
76 (defgroup gnus-article-signature nil
77   "Article signatures."
78   :link '(custom-manual "(gnus)Article Signature")
79   :group 'gnus-article)
80
81 (defgroup gnus-article-headers nil
82   "Article headers."
83   :link '(custom-manual "(gnus)Hiding Headers")
84   :group 'gnus-article)
85
86 (defgroup gnus-article-washing nil
87   "Special commands on articles."
88   :link '(custom-manual "(gnus)Article Washing")
89   :group 'gnus-article)
90
91 (defgroup gnus-article-emphasis nil
92   "Fontisizing articles."
93   :link '(custom-manual "(gnus)Article Fontisizing")
94   :group 'gnus-article)
95
96 (defgroup gnus-article-saving nil
97   "Saving articles."
98   :link '(custom-manual "(gnus)Saving Articles")
99   :group 'gnus-article)
100
101 (defgroup gnus-article-mime nil
102   "Worshiping the MIME wonder."
103   :link '(custom-manual "(gnus)Using MIME")
104   :group 'gnus-article)
105
106 (defgroup gnus-article-buttons nil
107   "Pushable buttons in the article buffer."
108   :link '(custom-manual "(gnus)Article Buttons")
109   :group 'gnus-article)
110
111 (defgroup gnus-article-various nil
112   "Other article options."
113   :link '(custom-manual "(gnus)Misc Article")
114   :group 'gnus-article)
115
116 (defcustom gnus-ignored-headers
117   (mapcar
118    (lambda (header)
119      (concat "^" header ":"))
120    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
121      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
122      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
123      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
124      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
125      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
126      "X-Attribution" "X-Originating-IP" "Delivered-To"
127      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
128      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
129      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
130      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
131      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
132      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
133      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
134      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
135      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
136      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
137      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
138      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
139      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
140      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
141      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
142      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
143      "List-[A-Za-z]+" "X-Listprocessor-Version"
144      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
145      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
146      "X-Received" "Content-length" "X-precedence"
147      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
148      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
149      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
150      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
151      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
152      "X-Content-length" "X-Posting-Agent" "Original-Received"
153      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
154      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
155      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
156      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
157      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
158      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
159      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
160      "Envelope-Sender" "Envelope-Recipients"))
161   "*All headers that start with this regexp will be hidden.
162 This variable can also be a list of regexps of headers to be ignored.
163 If `gnus-visible-headers' is non-nil, this variable will be ignored."
164   :type '(choice regexp
165                  (repeat regexp))
166   :group 'gnus-article-hiding)
167
168 (defcustom gnus-visible-headers
169   "^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:"
170   "*All headers that do not match this regexp will be hidden.
171 This variable can also be a list of regexp of headers to remain visible.
172 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
173   :type '(choice
174           (repeat :value-to-internal (lambda (widget value)
175                                        (custom-split-regexp-maybe value))
176                   :match (lambda (widget value)
177                            (or (stringp value)
178                                (widget-editable-list-match widget value)))
179                   regexp)
180           (const :tag "Use gnus-ignored-headers" nil)
181           regexp)
182   :group 'gnus-article-hiding)
183
184 (defcustom gnus-sorted-header-list
185   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
186     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
187   "*This variable is a list of regular expressions.
188 If it is non-nil, headers that match the regular expressions will
189 be placed first in the article buffer in the sequence specified by
190 this list."
191   :type '(repeat regexp)
192   :group 'gnus-article-hiding)
193
194 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
195   "Headers that are only to be displayed if they have interesting data.
196 Possible values in this list are:
197
198   'empty       Headers with no content.
199   'newsgroups  Newsgroup identical to Gnus group.
200   'to-address  To identical to To-address.
201   'to-list     To identical to To-list.
202   'cc-list     CC identical to To-list.
203   'followup-to Followup-to identical to Newsgroups.
204   'reply-to    Reply-to identical to From.
205   'date        Date less than four days old.
206   'long-to     To and/or Cc longer than 1024 characters.
207   'many-to     Multiple To and/or Cc."
208   :type '(set (const :tag "Headers with no content." empty)
209               (const :tag "Newsgroups identical to Gnus group." newsgroups)
210               (const :tag "To identical to To-address." to-address)
211               (const :tag "To identical to To-list." to-list)
212               (const :tag "CC identical to To-list." cc-list)
213               (const :tag "Followup-to identical to Newsgroups." followup-to)
214               (const :tag "Reply-to identical to From." reply-to)
215               (const :tag "Date less than four days old." date)
216               (const :tag "To and/or Cc longer than 1024 characters." long-to)
217               (const :tag "Multiple To and/or Cc headers." many-to))
218   :group 'gnus-article-hiding)
219
220 (defcustom gnus-article-skip-boring nil
221   "Skip over text that is not worth reading.
222 By default, if you set this t, then Gnus will display citations and
223 signatures, but will never scroll down to show you a page consisting
224 only of boring text.  Boring text is controlled by
225 `gnus-article-boring-faces'."
226   :version "22.1"
227   :type 'boolean
228   :group 'gnus-article-hiding)
229
230 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
231   "Regexp matching signature separator.
232 This can also be a list of regexps.  In that case, it will be checked
233 from head to tail looking for a separator.  Searches will be done from
234 the end of the buffer."
235   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
236                  (regexp)
237                  (repeat :tag "List of regexp" regexp))
238   :group 'gnus-article-signature)
239
240 (defcustom gnus-signature-limit nil
241   "Provide a limit to what is considered a signature.
242 If it is a number, no signature may not be longer (in characters) than
243 that number.  If it is a floating point number, no signature may be
244 longer (in lines) than that number.  If it is a function, the function
245 will be called without any parameters, and if it returns nil, there is
246 no signature in the buffer.  If it is a string, it will be used as a
247 regexp.  If it matches, the text in question is not a signature.
248
249 This can also be a list of the above values."
250   :type '(choice (const nil)
251                  (integer :value 200)
252                  (number :value 4.0)
253                  function
254                  (regexp :value ".*"))
255   :group 'gnus-article-signature)
256
257 (defcustom gnus-hidden-properties
258   (if (featurep 'xemacs)
259       ;; `intangible' is evil, but I keep it here in case it's useful.
260       '(invisible t intangible t)
261     ;; Emacs's command loop moves point out of invisible text anyway, so
262     ;; `intangible' is clearly not needed there.
263     '(invisible t))
264   "Property list to use for hiding text."
265   :type 'sexp
266   :group 'gnus-article-hiding)
267
268 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
269 ;; frames in a session.
270 (defcustom gnus-article-x-face-command
271   (if (featurep 'xemacs)
272       (if (or (gnus-image-type-available-p 'xface)
273               (gnus-image-type-available-p 'pbm))
274           'gnus-display-x-face-in-from
275         "{ echo \
276 '/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
277 ; uncompface; } | icontopbm | ee -")
278     (if (gnus-image-type-available-p 'pbm)
279         'gnus-display-x-face-in-from
280       "{ echo \
281 '/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
282 ; uncompface; } | icontopbm | display -"))
283   "*String or function to be executed to display an X-Face header.
284 If it is a string, the command will be executed in a sub-shell
285 asynchronously.  The compressed face will be piped to this command."
286   :type `(choice string
287                  (function-item gnus-display-x-face-in-from)
288                  function)
289   :version "21.1"
290   :group 'gnus-picon
291   :group 'gnus-article-washing)
292
293 (defcustom gnus-article-x-face-too-ugly nil
294   "Regexp matching posters whose face shouldn't be shown automatically."
295   :type '(choice regexp (const nil))
296   :group 'gnus-article-washing)
297
298 (defcustom gnus-article-banner-alist nil
299   "Banner alist for stripping.
300 For example,
301      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
302   :version "21.1"
303   :type '(repeat (cons symbol regexp))
304   :group 'gnus-article-washing)
305
306 (gnus-define-group-parameter
307  banner
308  :variable-document
309  "Alist of regexps (to match group names) and banner."
310  :variable-group gnus-article-washing
311  :parameter-type
312  '(choice :tag "Banner"
313           :value nil
314           (const :tag "Remove signature" signature)
315           (symbol :tag "Item in `gnus-article-banner-alist'" none)
316           regexp
317           (const :tag "None" nil))
318  :parameter-document
319  "If non-nil, specify how to remove `banners' from articles.
320
321 Symbol `signature' means to remove signatures delimited by
322 `gnus-signature-separator'.  Any other symbol is used to look up a
323 regular expression to match the banner in `gnus-article-banner-alist'.
324 A string is used as a regular expression to match the banner
325 directly.")
326
327 (defcustom gnus-article-address-banner-alist nil
328   "Alist of mail addresses and banners.
329 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
330 to match a mail address in the From: header, BANNER is one of a symbol
331 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
332 If ADDRESS matches author's mail address, it will remove things like
333 advertisements.  For example:
334
335 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
336 "
337   :type '(repeat
338           (cons
339            (regexp :tag "Address")
340            (choice :tag "Banner" :value nil
341                    (const :tag "Remove signature" signature)
342                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
343                    regexp
344                    (const :tag "None" nil))))
345   :version "22.1"
346   :group 'gnus-article-washing)
347
348 (defmacro gnus-emphasis-custom-with-format (&rest body)
349   `(let ((format "\
350 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
351 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
352      ,@body))
353
354 (defun gnus-emphasis-custom-value-to-external (value)
355   (gnus-emphasis-custom-with-format
356    (if (consp (car value))
357        (list (format format (car (car value)) (cdr (car value)))
358              2
359              (if (nth 1 value) 2 3)
360              (nth 2 value))
361      value)))
362
363 (defun gnus-emphasis-custom-value-to-internal (value)
364   (gnus-emphasis-custom-with-format
365    (let ((regexp (concat "\\`"
366                          (format (regexp-quote format)
367                                  "\\([^()]+\\)" "\\([^()]+\\)")
368                          "\\'"))
369          pattern)
370      (if (string-match regexp (setq pattern (car value)))
371          (list (cons (match-string 1 pattern) (match-string 2 pattern))
372                (= (nth 2 value) 2)
373                (nth 3 value))
374        value))))
375
376 (defcustom gnus-emphasis-alist
377   (let ((types
378          '(("\\*" "\\*" bold nil 2)
379            ("_" "_" underline)
380            ("/" "/" italic)
381            ("_/" "/_" underline-italic)
382            ("_\\*" "\\*_" underline-bold)
383            ("\\*/" "/\\*" bold-italic)
384            ("_\\*/" "/\\*_" underline-bold-italic))))
385     (nconc
386      (gnus-emphasis-custom-with-format
387       (mapcar (lambda (spec)
388                 (list (format format (car spec) (cadr spec))
389                       (or (nth 3 spec) 2)
390                       (or (nth 4 spec) 3)
391                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
392               types))
393      '(;; I've never seen anyone use this strikethru convention whereas I've
394        ;; several times seen it triggered by normal text.  --Stef
395        ;; Miles suggests that this form is sometimes used but for italics,
396        ;; so maybe we should map it to `italic'.
397        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
398        ;; 2 3 gnus-emphasis-strikethru)
399        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
400         2 3 gnus-emphasis-underline))))
401   "*Alist that says how to fontify certain phrases.
402 Each item looks like this:
403
404   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
405
406 The first element is a regular expression to be matched.  The second
407 is a number that says what regular expression grouping used to find
408 the entire emphasized word.  The third is a number that says what
409 regexp grouping should be displayed and highlighted.  The fourth
410 is the face used for highlighting."
411   :type
412   '(repeat
413     (menu-choice
414      :format "%[Customizing Style%]\n%v"
415      :indent 2
416      (group :tag "Default"
417             :value ("" 0 0 default)
418             :value-create
419             (lambda (widget)
420               (let ((value (widget-get
421                             (cadr (widget-get (widget-get widget :parent)
422                                               :args))
423                             :value)))
424                 (if (not (eq (nth 2 value) 'default))
425                     (widget-put
426                      widget
427                      :value
428                      (gnus-emphasis-custom-value-to-external value))))
429               (widget-group-value-create widget))
430             regexp
431             (integer :format "Match group: %v")
432             (integer :format "Emphasize group: %v")
433             face)
434      (group :tag "Simple"
435             :value (("_" . "_") nil default)
436             (cons :format "%v"
437                   (regexp :format "Start regexp: %v")
438                   (regexp :format "End regexp: %v"))
439             (boolean :format "Show start and end patterns: %[%v%]\n"
440                      :on " On " :off " Off ")
441             face)))
442   :get (lambda (symbol)
443          (mapcar 'gnus-emphasis-custom-value-to-internal
444                  (default-value symbol)))
445   :set (lambda (symbol value)
446          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
447                                      value)))
448   :group 'gnus-article-emphasis)
449
450 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
451   "A regexp to describe whitespace which should not be emphasized.
452 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
453 The former avoids underlining of leading and trailing whitespace,
454 and the latter avoids underlining any whitespace at all."
455   :version "21.1"
456   :group 'gnus-article-emphasis
457   :type 'regexp)
458
459 (defface gnus-emphasis-bold '((t (:bold t)))
460   "Face used for displaying strong emphasized text (*word*)."
461   :group 'gnus-article-emphasis)
462
463 (defface gnus-emphasis-italic '((t (:italic t)))
464   "Face used for displaying italic emphasized text (/word/)."
465   :group 'gnus-article-emphasis)
466
467 (defface gnus-emphasis-underline '((t (:underline t)))
468   "Face used for displaying underlined emphasized text (_word_)."
469   :group 'gnus-article-emphasis)
470
471 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
472   "Face used for displaying underlined bold emphasized text (_*word*_)."
473   :group 'gnus-article-emphasis)
474
475 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
476   "Face used for displaying underlined italic emphasized text (_/word/_)."
477   :group 'gnus-article-emphasis)
478
479 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
480   "Face used for displaying bold italic emphasized text (/*word*/)."
481   :group 'gnus-article-emphasis)
482
483 (defface gnus-emphasis-underline-bold-italic
484   '((t (:bold t :italic t :underline t)))
485   "Face used for displaying underlined bold italic emphasized text.
486 Example: (_/*word*/_)."
487   :group 'gnus-article-emphasis)
488
489 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
490                                       '((t (:strikethru t)))
491                                     '((t (:strike-through t))))
492   "Face used for displaying strike-through text (-word-)."
493   :group 'gnus-article-emphasis)
494
495 (defface gnus-emphasis-highlight-words
496   '((t (:background "black" :foreground "yellow")))
497   "Face used for displaying highlighted words."
498   :group 'gnus-article-emphasis)
499
500 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
501   "Format for display of Date headers in article bodies.
502 See `format-time-string' for the possible values.
503
504 The variable can also be function, which should return a complete Date
505 header.  The function is called with one argument, the time, which can
506 be fed to `format-time-string'."
507   :type '(choice string function)
508   :link '(custom-manual "(gnus)Article Date")
509   :group 'gnus-article-washing)
510
511 (defcustom gnus-save-all-headers t
512   "*If non-nil, don't remove any headers before saving.
513 This will be overridden by the `:headers' property that the symbol of
514 the saver function, which is specified by `gnus-default-article-saver',
515 might have."
516   :group 'gnus-article-saving
517   :type 'boolean)
518
519 (defcustom gnus-prompt-before-saving 'always
520   "*This variable says how much prompting is to be done when saving articles.
521 If it is nil, no prompting will be done, and the articles will be
522 saved to the default files.  If this variable is `always', each and
523 every article that is saved will be preceded by a prompt, even when
524 saving large batches of articles.  If this variable is neither nil not
525 `always', there the user will be prompted once for a file name for
526 each invocation of the saving commands."
527   :group 'gnus-article-saving
528   :type '(choice (item always)
529                  (item :tag "never" nil)
530                  (sexp :tag "once" :format "%t\n" :value t)))
531
532 (defcustom gnus-saved-headers gnus-visible-headers
533   "Headers to keep if `gnus-save-all-headers' is nil.
534 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
535 If that variable is nil, however, all headers that match this regexp
536 will be kept while the rest will be deleted before saving.  This and
537 `gnus-save-all-headers' will be overridden by the `:headers' property
538 that the symbol of the saver function, which is specified by
539 `gnus-default-article-saver', might have."
540   :group 'gnus-article-saving
541   :type 'regexp)
542
543 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
544 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
545   "A function to save articles in your favorite format.
546 The function will be called by way of the `gnus-summary-save-article'
547 command, and friends such as `gnus-summary-save-article-rmail'.
548
549 Gnus provides the following functions:
550
551 * gnus-summary-save-in-rmail (Rmail format)
552 * gnus-summary-save-in-mail (Unix mail format)
553 * gnus-summary-save-in-folder (MH folder)
554 * gnus-summary-save-in-file (article format)
555 * gnus-summary-save-body-in-file (article body)
556 * gnus-summary-save-in-vm (use VM's folder format)
557 * gnus-summary-write-to-file (article format -- overwrite)
558 * gnus-summary-write-body-to-file (article body -- overwrite)
559 * gnus-summary-save-in-pipe (article format)
560
561 The symbol of each function may have the following properties:
562
563 * :decode
564 The value non-nil means save decoded articles.  This is meaningful
565 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
566 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
567 `gnus-summary-save-in-pipe'.
568
569 * :function
570 The value specifies an alternative function which appends, not
571 overwrites, articles to a file.  This implies that when saving many
572 articles at a time, `gnus-prompt-before-saving' is bound to t and all
573 articles are saved in a single file.  This is meaningful only with
574 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
575
576 * :headers
577 The value specifies the symbol of a variable of which the value
578 specifies headers to be saved.  If it is omitted,
579 `gnus-save-all-headers' and `gnus-saved-headers' control what
580 headers should be saved."
581   :group 'gnus-article-saving
582   :type '(radio (function-item gnus-summary-save-in-rmail)
583                 (function-item gnus-summary-save-in-mail)
584                 (function-item gnus-summary-save-in-folder)
585                 (function-item gnus-summary-save-in-file)
586                 (function-item gnus-summary-save-body-in-file)
587                 (function-item gnus-summary-save-in-vm)
588                 (function-item gnus-summary-write-to-file)
589                 (function-item gnus-summary-write-body-to-file)
590                 (function-item gnus-summary-save-in-pipe)
591                 (function)))
592
593 (defcustom gnus-article-save-coding-system
594   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
595       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
596       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
597       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
598   "Coding system used to save decoded articles to a file.
599
600 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
601 which can safely encode any characters in text.  This is used by the
602 commands including:
603
604 * gnus-summary-save-article-file
605 * gnus-summary-save-article-body-file
606 * gnus-summary-write-article-file
607 * gnus-summary-write-article-body-file
608
609 and the functions to which you may set `gnus-default-article-saver':
610
611 * gnus-summary-save-in-file
612 * gnus-summary-save-body-in-file
613 * gnus-summary-write-to-file
614 * gnus-summary-write-body-to-file
615
616 Those commands and functions save just text displayed in the article
617 buffer to a file if the value of this variable is non-nil.  Note that
618 buttonized MIME parts will be lost in a saved file in that case.
619 Otherwise, raw articles will be saved."
620   :group 'gnus-article-saving
621   :type `(choice
622           :format "%{%t%}:\n %[Value Menu%] %v"
623           (const :tag "Save raw articles" nil)
624           ,@(delq nil
625                   (mapcar
626                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
627                    '((const :tag "UTF-8" utf-8)
628                      (const :tag "iso-2022-7bit" iso-2022-7bit)
629                      (const :tag "Emacs internal" emacs-mule)
630                      (const :tag "escape-quoted" escape-quoted))))
631           (symbol :tag "Coding system")))
632
633 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
634   "A function generating a file name to save articles in Rmail format.
635 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
636   :group 'gnus-article-saving
637   :type 'function)
638
639 (defcustom gnus-mail-save-name 'gnus-plain-save-name
640   "A function generating a file name to save articles in Unix mail format.
641 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
642   :group 'gnus-article-saving
643   :type 'function)
644
645 (defcustom gnus-folder-save-name 'gnus-folder-save-name
646   "A function generating a file name to save articles in MH folder.
647 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
648   :group 'gnus-article-saving
649   :type 'function)
650
651 (defcustom gnus-file-save-name 'gnus-numeric-save-name
652   "A function generating a file name to save articles in article format.
653 The function is called with NEWSGROUP, HEADERS, and optional
654 LAST-FILE."
655   :group 'gnus-article-saving
656   :type 'function)
657
658 (defcustom gnus-split-methods
659   '((gnus-article-archive-name)
660     (gnus-article-nndoc-name))
661   "*Variable used to suggest where articles are to be saved.
662 For instance, if you would like to save articles related to Gnus in
663 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
664 you could set this variable to something like:
665
666  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
667    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
668
669 This variable is an alist where the key is the match and the
670 value is a list of possible files to save in if the match is
671 non-nil.
672
673 If the match is a string, it is used as a regexp match on the
674 article.  If the match is a symbol, that symbol will be funcalled
675 from the buffer of the article to be saved with the newsgroup as the
676 parameter.  If it is a list, it will be evalled in the same buffer.
677
678 If this form or function returns a string, this string will be used as a
679 possible file name; and if it returns a non-nil list, that list will be
680 used as possible file names."
681   :group 'gnus-article-saving
682   :type '(repeat (choice (list :value (fun) function)
683                          (cons :value ("" "") regexp (repeat string))
684                          (sexp :value nil))))
685
686 (defcustom gnus-page-delimiter "^\^L"
687   "*Regexp describing what to use as article page delimiters.
688 The default value is \"^\^L\", which is a form linefeed at the
689 beginning of a line."
690   :type 'regexp
691   :group 'gnus-article-various)
692
693 (defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
694   "*The format specification for the article mode line.
695 See `gnus-summary-mode-line-format' for a closer description.
696
697 The following additional specs are available:
698
699 %w  The article washing status.
700 %m  The number of MIME parts in the article."
701   :version "24.1"
702   :type 'string
703   :group 'gnus-article-various)
704
705 (defcustom gnus-article-mode-hook nil
706   "*A hook for Gnus article mode."
707   :type 'hook
708   :group 'gnus-article-various)
709
710 (when (featurep 'xemacs)
711   ;; Extracted from gnus-xmas-define in order to preserve user settings
712   (when (fboundp 'turn-off-scroll-in-place)
713     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
714   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
715   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
716
717 (defcustom gnus-article-menu-hook nil
718   "*Hook run after the creation of the article mode menu."
719   :type 'hook
720   :group 'gnus-article-various)
721
722 (defcustom gnus-article-prepare-hook nil
723   "*A hook called after an article has been prepared in the article buffer."
724   :type 'hook
725   :group 'gnus-article-various)
726
727 (defcustom gnus-copy-article-ignored-headers nil
728   "List of headers to be removed when copying an article.
729 Each element is a regular expression."
730   :version "23.1" ;; No Gnus
731   :type '(repeat regexp)
732   :group 'gnus-article-various)
733
734 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
735                         "Gnus 5.10 (Emacs 22.1)")
736
737 (defface gnus-button
738   '((t (:weight bold)))
739   "Face used for highlighting a button in the article buffer."
740   :group 'gnus-article-buttons)
741
742 (defcustom gnus-article-button-face 'gnus-button
743   "Face used for highlighting buttons in the article buffer.
744
745 An article button is a piece of text that you can activate by pressing
746 `RET' or `mouse-2' above it."
747   :type 'face
748   :group 'gnus-article-buttons)
749
750 (defcustom gnus-article-mouse-face 'highlight
751   "Face used for mouse highlighting in the article buffer.
752
753 Article buttons will be displayed in this face when the cursor is
754 above them."
755   :type 'face
756   :group 'gnus-article-buttons)
757
758 (defcustom gnus-signature-face 'gnus-signature
759   "Face used for highlighting a signature in the article buffer.
760 Obsolete; use the face `gnus-signature' for customizations instead."
761   :type 'face
762   :group 'gnus-article-highlight
763   :group 'gnus-article-signature)
764
765 (defface gnus-signature
766   '((t
767      (:italic t)))
768   "Face used for highlighting a signature in the article buffer."
769   :group 'gnus-article-highlight
770   :group 'gnus-article-signature)
771 ;; backward-compatibility alias
772 (put 'gnus-signature-face 'face-alias 'gnus-signature)
773 (put 'gnus-signature-face 'obsolete-face "22.1")
774
775 (defface gnus-header-from
776   '((((class color)
777       (background dark))
778      (:foreground "PaleGreen1"))
779     (((class color)
780       (background light))
781      (:foreground "red3"))
782     (t
783      (:italic t)))
784   "Face used for displaying from headers."
785   :group 'gnus-article-headers
786   :group 'gnus-article-highlight)
787 ;; backward-compatibility alias
788 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
789 (put 'gnus-header-from-face 'obsolete-face "22.1")
790
791 (defface gnus-header-subject
792   '((((class color)
793       (background dark))
794      (:foreground "SeaGreen1"))
795     (((class color)
796       (background light))
797      (:foreground "red4"))
798     (t
799      (:bold t :italic t)))
800   "Face used for displaying subject headers."
801   :group 'gnus-article-headers
802   :group 'gnus-article-highlight)
803 ;; backward-compatibility alias
804 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
805 (put 'gnus-header-subject-face 'obsolete-face "22.1")
806
807 (defface gnus-header-newsgroups
808   '((((class color)
809       (background dark))
810      (:foreground "yellow" :italic t))
811     (((class color)
812       (background light))
813      (:foreground "MidnightBlue" :italic t))
814     (t
815      (:italic t)))
816   "Face used for displaying newsgroups headers.
817 In the default setup this face is only used for crossposted
818 articles."
819   :group 'gnus-article-headers
820   :group 'gnus-article-highlight)
821 ;; backward-compatibility alias
822 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
823 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
824
825 (defface gnus-header-name
826   '((((class color)
827       (background dark))
828      (:foreground "SpringGreen2"))
829     (((class color)
830       (background light))
831      (:foreground "maroon"))
832     (t
833      (:bold t)))
834   "Face used for displaying header names."
835   :group 'gnus-article-headers
836   :group 'gnus-article-highlight)
837 ;; backward-compatibility alias
838 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
839 (put 'gnus-header-name-face 'obsolete-face "22.1")
840
841 (defface gnus-header-content
842   '((((class color)
843       (background dark))
844      (:foreground "SpringGreen1" :italic t))
845     (((class color)
846       (background light))
847      (:foreground "indianred4" :italic t))
848     (t
849      (:italic t)))  "Face used for displaying header content."
850   :group 'gnus-article-headers
851   :group 'gnus-article-highlight)
852 ;; backward-compatibility alias
853 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
854 (put 'gnus-header-content-face 'obsolete-face "22.1")
855
856 (defcustom gnus-header-face-alist
857   '(("From" nil gnus-header-from)
858     ("Subject" nil gnus-header-subject)
859     ("Newsgroups:.*," nil gnus-header-newsgroups)
860     ("" gnus-header-name gnus-header-content))
861   "*Controls highlighting of article headers.
862
863 An alist of the form (HEADER NAME CONTENT).
864
865 HEADER is a regular expression which should match the name of a
866 header and NAME and CONTENT are either face names or nil.
867
868 The name of each header field will be displayed using the face
869 specified by the first element in the list where HEADER matches
870 the header name and NAME is non-nil.  Similarly, the content will
871 be displayed by the first non-nil matching CONTENT face."
872   :group 'gnus-article-headers
873   :group 'gnus-article-highlight
874   :type '(repeat (list (regexp :tag "Header")
875                        (choice :tag "Name"
876                                (item :tag "skip" nil)
877                                (face :value default))
878                        (choice :tag "Content"
879                                (item :tag "skip" nil)
880                                (face :value default)))))
881
882 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
883                                           '((xface . (:face gnus-x-face)))
884                                         '((pbm . (:face gnus-x-face))
885                                           (png . nil)))
886   "Alist of image types and properties applied to Face and X-Face images.
887 Here are examples:
888
889 ;; Specify the altitude of Face images in the From header.
890 \(setq gnus-face-properties-alist
891       '((pbm . (:face gnus-x-face :ascent 80))
892         (png . (:ascent 80))))
893
894 ;; Show Face images as pressed buttons.
895 \(setq gnus-face-properties-alist
896       '((pbm . (:face gnus-x-face :relief -2))
897         (png . (:relief -2))))
898
899 See the manual for the valid properties for various image types.
900 Currently, `pbm' is used for X-Face images and `png' is used for Face
901 images in Emacs.  Only the `:face' property is effective on the `xface'
902 image type in XEmacs if it is built with the libcompface library."
903   :version "23.1" ;; No Gnus
904   :group 'gnus-article-headers
905   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
906
907 (defcustom gnus-article-decode-hook
908   '(article-decode-charset article-decode-encoded-words
909                            article-decode-group-name article-decode-idna-rhs)
910   "*Hook run to decode charsets in articles."
911   :group 'gnus-article-headers
912   :type 'hook)
913
914 (defcustom gnus-display-mime-function 'gnus-display-mime
915   "Function to display MIME articles."
916   :group 'gnus-article-mime
917   :type 'function)
918
919 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
920   "Function used to decode headers.")
921
922 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
923   "Function used to decode addresses.")
924
925 (defvar gnus-article-dumbquotes-map
926   '((?\200 "EUR")
927     (?\202 ",")
928     (?\203 "f")
929     (?\204 ",,")
930     (?\205 "...")
931     (?\213 "<")
932     (?\214 "OE")
933     (?\221 "`")
934     (?\222 "'")
935     (?\223 "``")
936     (?\224 "\"")
937     (?\225 "*")
938     (?\226 "-")
939     (?\227 "--")
940     (?\230 "~")
941     (?\231 "(TM)")
942     (?\233 ">")
943     (?\234 "oe")
944     (?\264 "'"))
945   "Table for MS-to-Latin1 translation.")
946
947 (defcustom gnus-ignored-mime-types nil
948   "List of MIME types that should be ignored by Gnus."
949   :version "21.1"
950   :group 'gnus-article-mime
951   :type '(repeat regexp))
952
953 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
954   "List of MIME types that should not be given buttons when rendered inline.
955 See also `gnus-buttonized-mime-types' which may override this variable.
956 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
957   :version "21.1"
958   :group 'gnus-article-mime
959   :type '(repeat regexp))
960
961 (defcustom gnus-buttonized-mime-types nil
962   "List of MIME types that should be given buttons when rendered inline.
963 If set, this variable overrides `gnus-unbuttonized-mime-types'.
964 To see e.g. security buttons you could set this to
965 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
966 this list to display radio buttons that allow you to choose one of two
967 media types those mails include.  See also `mm-discouraged-alternatives'.
968 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
969   :version "22.1"
970   :group 'gnus-article-mime
971   :type '(repeat regexp))
972
973 (defcustom gnus-inhibit-mime-unbuttonizing nil
974   "If non-nil, all MIME parts get buttons.
975 When nil (the default value), then some MIME parts do not get buttons,
976 as described by the variables `gnus-buttonized-mime-types' and
977 `gnus-unbuttonized-mime-types'."
978   :version "22.1"
979   :group 'gnus-article-mime
980   :type 'boolean)
981
982 (defcustom gnus-body-boundary-delimiter "_"
983   "String used to delimit header and body.
984 This variable is used by `gnus-article-treat-body-boundary' which can
985 be controlled by `gnus-treat-body-boundary'."
986   :version "22.1"
987   :group 'gnus-article-various
988   :type '(choice (item :tag "None" :value nil)
989                  string))
990
991 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
992                                   "/usr/share/picons")
993   "Defines the location of the faces database.
994 For information on obtaining this database of pretty pictures, please
995 see http://www.cs.indiana.edu/picons/ftp/index.html"
996   :version "22.1"
997   :type '(repeat directory)
998   :link '(url-link :tag "download"
999                    "http://www.cs.indiana.edu/picons/ftp/index.html")
1000   :link '(custom-manual "(gnus)Picons")
1001   :group 'gnus-picon)
1002
1003 (defun gnus-picons-installed-p ()
1004   "Say whether picons are installed on your machine."
1005   (let ((installed nil))
1006     (dolist (database gnus-picon-databases)
1007       (when (file-exists-p database)
1008         (setq installed t)))
1009     installed))
1010
1011 (defcustom gnus-article-mime-part-function nil
1012   "Function called with a MIME handle as the argument.
1013 This is meant for people who want to do something automatic based
1014 on parts -- for instance, adding Vcard info to a database."
1015   :group 'gnus-article-mime
1016   :type '(choice (const nil)
1017                  function))
1018
1019 (defcustom gnus-mime-multipart-functions nil
1020   "An alist of MIME types to functions to display them."
1021   :version "21.1"
1022   :group 'gnus-article-mime
1023   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1024
1025 (defcustom gnus-article-date-headers '(combined-lapsed)
1026   "A list of Date header formats to display.
1027 Valid formats are `ut' (universal time), `local' (local time
1028 zone), `english' (readable English), `lapsed' (elapsed time),
1029 `combined-lapsed' (both the original date and the elapsed time),
1030 `original' (the original date header), `iso8601' (ISO8601
1031 format), and `user-defined' (a user-defined format defined by the
1032 `gnus-article-time-format' variable).
1033
1034 You have as many date headers as you want in the article buffer.
1035 Some of these headers are updated automatically.  See
1036 `gnus-article-update-date-headers' for details."
1037   :version "24.1"
1038   :group 'gnus-article-headers
1039   :type '(set
1040           (const :tag "Universal time (UT)" ut)
1041           (const :tag "Local time zone" local)
1042           (const :tag "Readable English" english)
1043           (const :tag "Elapsed time" lapsed)
1044           (const :tag "Original and elapsed time" combined-lapsed)
1045           (const :tag "Original date header" original)
1046           (const :tag "ISO8601 format" iso8601)
1047           (const :tag "User-defined" user-defined)))
1048
1049 (defcustom gnus-article-update-date-headers nil
1050   "A number that says how often to update the date header (in seconds).
1051 If nil, don't update it at all."
1052   :version "24.1"
1053   :group 'gnus-article-headers
1054   :type '(choice
1055           (item :tag "Don't update" :value nil)
1056           integer))
1057
1058 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1059   "Function called with a MIME handle as the argument.
1060 This is meant for people who want to view first matched part.
1061 For `undisplayed-alternative' (default), the first undisplayed
1062 part or alternative part is used.  For `undisplayed', the first
1063 undisplayed part is used.  For a function, the first part which
1064 the function return t is used.  For nil, the first part is
1065 used."
1066   :version "21.1"
1067   :group 'gnus-article-mime
1068   :type '(choice
1069           (item :tag "first" :value nil)
1070           (item :tag "undisplayed" :value undisplayed)
1071           (item :tag "undisplayed or alternative"
1072                 :value undisplayed-alternative)
1073           (function)))
1074
1075 (defcustom gnus-mime-action-alist
1076   '(("save to file" . gnus-mime-save-part)
1077     ("save and strip" . gnus-mime-save-part-and-strip)
1078     ("replace with file" . gnus-mime-replace-part)
1079     ("delete part" . gnus-mime-delete-part)
1080     ("display as text" . gnus-mime-inline-part)
1081     ("view the part" . gnus-mime-view-part)
1082     ("pipe to command" . gnus-mime-pipe-part)
1083     ("toggle display" . gnus-article-press-button)
1084     ("toggle display" . gnus-article-view-part-as-charset)
1085     ("view as type" . gnus-mime-view-part-as-type)
1086     ("view internally" . gnus-mime-view-part-internally)
1087     ("view externally" . gnus-mime-view-part-externally))
1088   "An alist of actions that run on the MIME attachment."
1089   :group 'gnus-article-mime
1090   :type '(repeat (cons (string :tag "name")
1091                        (function))))
1092
1093 (defcustom gnus-auto-select-part 1
1094   "Advance to next MIME part when deleting or stripping parts.
1095
1096 When 0, point will be placed on the same part as before.  When
1097 positive (negative), move point forward (backwards) this many
1098 parts.  When nil, redisplay article."
1099   :version "23.1" ;; No Gnus
1100   :group 'gnus-article-mime
1101   :type '(choice (const nil :tag "Redisplay article.")
1102                  (const 1 :tag "Next part.")
1103                  (const 0 :tag "Current part.")
1104                  integer))
1105
1106 ;;;
1107 ;;; The treatment variables
1108 ;;;
1109
1110 (defvar gnus-part-display-hook nil
1111   "Hook called on parts that are to receive treatment.")
1112
1113 (defvar gnus-article-treat-custom
1114   '(choice (const :tag "Off" nil)
1115            (const :tag "On" t)
1116            (const :tag "Header" head)
1117            (const :tag "First" first)
1118            (const :tag "Last" last)
1119            (integer :tag "Less")
1120            (repeat :tag "Groups" regexp)
1121            (sexp :tag "Predicate")))
1122
1123 (defvar gnus-article-treat-head-custom
1124   '(choice (const :tag "Off" nil)
1125            (const :tag "Header" head)))
1126
1127 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1128                                    "text/x-patch" "text/html")
1129   "Part types eligible for treatment.")
1130
1131 (defvar gnus-inhibit-treatment nil
1132   "Whether to inhibit treatment.")
1133
1134 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1135   "Highlight the signature.
1136 Valid values are nil, t, `head', `first', `last', an integer or a
1137 predicate.  See Info node `(gnus)Customizing Articles'."
1138   :group 'gnus-article-treat
1139   :link '(custom-manual "(gnus)Customizing Articles")
1140   :type gnus-article-treat-custom)
1141 (put 'gnus-treat-highlight-signature 'highlight t)
1142
1143 (defcustom gnus-treat-buttonize 100000
1144   "Add buttons.
1145 Valid values are nil, t, `head', `first', `last', an integer or a
1146 predicate.  See Info node `(gnus)Customizing Articles'."
1147   :group 'gnus-article-treat
1148   :link '(custom-manual "(gnus)Customizing Articles")
1149   :type gnus-article-treat-custom)
1150 (put 'gnus-treat-buttonize 'highlight t)
1151
1152 (defcustom gnus-treat-buttonize-head 'head
1153   "Add buttons to the head.
1154 Valid values are nil, t, `head', `first', `last', an integer or a
1155 predicate.  See Info node `(gnus)Customizing Articles'."
1156   :group 'gnus-article-treat
1157   :link '(custom-manual "(gnus)Customizing Articles")
1158   :type gnus-article-treat-head-custom)
1159 (put 'gnus-treat-buttonize-head 'highlight t)
1160
1161 (defcustom gnus-treat-date 'head
1162   "Display dates according to the `gnus-article-date-headers' variable.
1163 Valid values are nil, t, `head', `first', `last', an integer or a
1164 predicate.  See Info node `(gnus)Customizing Articles'."
1165   :version "24.1"
1166   :group 'gnus-article-treat
1167   :link '(custom-manual "(gnus)Customizing Articles")
1168   :type gnus-article-treat-head-custom)
1169
1170 (defcustom gnus-treat-emphasize 50000
1171   "Emphasize text.
1172 Valid values are nil, t, `head', `first', `last', an integer or a
1173 predicate.  See Info node `(gnus)Customizing Articles'."
1174   :group 'gnus-article-treat
1175   :link '(custom-manual "(gnus)Customizing Articles")
1176   :type gnus-article-treat-custom)
1177 (put 'gnus-treat-emphasize 'highlight t)
1178
1179 (defcustom gnus-treat-strip-cr nil
1180   "Remove carriage returns.
1181 Valid values are nil, t, `head', `first', `last', an integer or a
1182 predicate.  See Info node `(gnus)Customizing Articles'."
1183   :version "22.1"
1184   :group 'gnus-article-treat
1185   :link '(custom-manual "(gnus)Customizing Articles")
1186   :type gnus-article-treat-custom)
1187
1188 (defcustom gnus-treat-unsplit-urls nil
1189   "Remove newlines from within URLs.
1190 Valid values are nil, t, `head', `first', `last', an integer or a
1191 predicate.  See Info node `(gnus)Customizing Articles'."
1192   :version "22.1"
1193   :group 'gnus-article-treat
1194   :link '(custom-manual "(gnus)Customizing Articles")
1195   :type gnus-article-treat-custom)
1196
1197 (defcustom gnus-treat-leading-whitespace nil
1198   "Remove leading whitespace in headers.
1199 Valid values are nil, t, `head', `first', `last', an integer or a
1200 predicate.  See Info node `(gnus)Customizing Articles'."
1201   :version "22.1"
1202   :group 'gnus-article-treat
1203   :link '(custom-manual "(gnus)Customizing Articles")
1204   :type gnus-article-treat-custom)
1205
1206 (defcustom gnus-treat-hide-headers 'head
1207   "Hide headers.
1208 Valid values are nil, t, `head', `first', `last', an integer or a
1209 predicate.  See Info node `(gnus)Customizing Articles'."
1210   :group 'gnus-article-treat
1211   :link '(custom-manual "(gnus)Customizing Articles")
1212   :type gnus-article-treat-head-custom)
1213
1214 (defcustom gnus-treat-hide-boring-headers nil
1215   "Hide boring headers.
1216 Valid values are nil, t, `head', `first', `last', an integer or a
1217 predicate.  See Info node `(gnus)Customizing Articles'."
1218   :group 'gnus-article-treat
1219   :link '(custom-manual "(gnus)Customizing Articles")
1220   :type gnus-article-treat-head-custom)
1221
1222 (defcustom gnus-treat-hide-signature nil
1223   "Hide the signature.
1224 Valid values are nil, t, `head', `first', `last', an integer or a
1225 predicate.  See Info node `(gnus)Customizing Articles'."
1226   :group 'gnus-article-treat
1227   :link '(custom-manual "(gnus)Customizing Articles")
1228   :type gnus-article-treat-custom)
1229
1230 (defcustom gnus-treat-fill-article nil
1231   "Fill the article.
1232 Valid values are nil, t, `head', `first', `last', an integer or a
1233 predicate.  See Info node `(gnus)Customizing Articles'."
1234   :group 'gnus-article-treat
1235   :link '(custom-manual "(gnus)Customizing Articles")
1236   :type gnus-article-treat-custom)
1237
1238 (defcustom gnus-treat-hide-citation nil
1239   "Hide cited text.
1240 Valid values are nil, t, `head', `first', `last', an integer or a
1241 predicate.  See Info node `(gnus)Customizing Articles'.
1242
1243 See `gnus-article-highlight-citation' for variables used to
1244 control what it hides."
1245   :group 'gnus-article-treat
1246   :link '(custom-manual "(gnus)Customizing Articles")
1247   :type gnus-article-treat-custom)
1248
1249 (defcustom gnus-treat-hide-citation-maybe nil
1250   "Hide cited text according to certain conditions.
1251 Valid values are nil, t, `head', `first', `last', an integer or a
1252 predicate.  See Info node `(gnus)Customizing Articles'.
1253
1254 See `gnus-cite-hide-percentage' and `gnus-cite-hide-absolute' for
1255 how to control what it hides."
1256   :group 'gnus-article-treat
1257   :link '(custom-manual "(gnus)Customizing Articles")
1258   :type gnus-article-treat-custom)
1259
1260 (defcustom gnus-treat-strip-list-identifiers 'head
1261   "Strip list identifiers from `gnus-list-identifiers`.
1262 Valid values are nil, t, `head', `first', `last', an integer or a
1263 predicate.  See Info node `(gnus)Customizing Articles'."
1264   :version "21.1"
1265   :group 'gnus-article-treat
1266   :link '(custom-manual "(gnus)Customizing Articles")
1267   :type gnus-article-treat-custom)
1268
1269 (gnus-define-group-parameter
1270  list-identifier
1271  :variable-document
1272  "Alist of regexps and correspondent identifiers."
1273  :variable-group gnus-article-washing
1274  :parameter-type
1275  '(choice :tag "Identifier"
1276           :value nil
1277           (symbol :tag "Item in `gnus-list-identifiers'" none)
1278           regexp
1279           (const :tag "None" nil))
1280  :parameter-document
1281  "If non-nil, specify how to remove `identifiers' from articles' subject.
1282
1283 Any symbol is used to look up a regular expression to match the
1284 banner in `gnus-list-identifiers'.  A string is used as a regular
1285 expression to match the identifier directly.")
1286
1287 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1288                         "Gnus 5.10 (Emacs 22.1)")
1289
1290 (defcustom gnus-treat-strip-pem nil
1291   "Strip PEM signatures.
1292 Valid values are nil, t, `head', `first', `last', an integer or a
1293 predicate.  See Info node `(gnus)Customizing Articles'."
1294   :group 'gnus-article-treat
1295   :link '(custom-manual "(gnus)Customizing Articles")
1296   :type gnus-article-treat-custom)
1297
1298 (defcustom gnus-treat-strip-banner t
1299   "Strip banners from articles.
1300 The banner to be stripped is specified in the `banner' group parameter.
1301 Valid values are nil, t, `head', `first', `last', an integer or a
1302 predicate.  See Info node `(gnus)Customizing Articles'."
1303   :group 'gnus-article-treat
1304   :link '(custom-manual "(gnus)Customizing Articles")
1305   :type gnus-article-treat-custom)
1306
1307 (defcustom gnus-treat-highlight-headers 'head
1308   "Highlight the headers.
1309 Valid values are nil, t, `head', `first', `last', an integer or a
1310 predicate.  See Info node `(gnus)Customizing Articles'."
1311   :group 'gnus-article-treat
1312   :link '(custom-manual "(gnus)Customizing Articles")
1313   :type gnus-article-treat-head-custom)
1314 (put 'gnus-treat-highlight-headers 'highlight t)
1315
1316 (defcustom gnus-treat-highlight-citation t
1317   "Highlight cited text.
1318 Valid values are nil, t, `head', `first', `last', an integer or a
1319 predicate.  See Info node `(gnus)Customizing Articles'."
1320   :group 'gnus-article-treat
1321   :link '(custom-manual "(gnus)Customizing Articles")
1322   :type gnus-article-treat-custom)
1323 (put 'gnus-treat-highlight-citation 'highlight t)
1324
1325 (defcustom gnus-treat-strip-headers-in-body t
1326   "Strip the X-No-Archive header line from the beginning of the body.
1327 Valid values are nil, t, `head', `first', `last', an integer or a
1328 predicate.  See Info node `(gnus)Customizing Articles'."
1329   :version "21.1"
1330   :group 'gnus-article-treat
1331   :link '(custom-manual "(gnus)Customizing Articles")
1332   :type gnus-article-treat-custom)
1333
1334 (defcustom gnus-treat-strip-trailing-blank-lines nil
1335   "Strip trailing blank lines.
1336 Valid values are nil, t, `head', `first', `last', an integer or a
1337 predicate.  See Info node `(gnus)Customizing Articles'.
1338
1339 When set to t, it also strips trailing blanks in all MIME parts.
1340 Consider to use `last' instead."
1341   :group 'gnus-article-treat
1342   :link '(custom-manual "(gnus)Customizing Articles")
1343   :type gnus-article-treat-custom)
1344
1345 (defcustom gnus-treat-strip-leading-blank-lines nil
1346   "Strip leading blank lines.
1347 Valid values are nil, t, `head', `first', `last', an integer or a
1348 predicate.  See Info node `(gnus)Customizing Articles'.
1349
1350 When set to t, it also strips trailing blanks in all MIME parts."
1351   :group 'gnus-article-treat
1352   :link '(custom-manual "(gnus)Customizing Articles")
1353   :type gnus-article-treat-custom)
1354
1355 (defcustom gnus-treat-strip-multiple-blank-lines nil
1356   "Strip multiple blank lines.
1357 Valid values are nil, t, `head', `first', `last', an integer or a
1358 predicate.  See Info node `(gnus)Customizing Articles'."
1359   :group 'gnus-article-treat
1360   :link '(custom-manual "(gnus)Customizing Articles")
1361   :type gnus-article-treat-custom)
1362
1363 (defcustom gnus-treat-unfold-headers 'head
1364   "Unfold folded header lines.
1365 Valid values are nil, t, `head', `first', `last', an integer or a
1366 predicate.  See Info node `(gnus)Customizing Articles'."
1367   :version "22.1"
1368   :group 'gnus-article-treat
1369   :link '(custom-manual "(gnus)Customizing Articles")
1370   :type gnus-article-treat-custom)
1371
1372 (defcustom gnus-article-unfold-long-headers nil
1373   "If non-nil, allow unfolding headers even if the header is long.
1374 If it is a regexp, only long headers matching this regexp are unfolded.
1375 If it is t, all long headers are unfolded.
1376
1377 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1378   :version "23.1" ;; No Gnus
1379   :group 'gnus-article-treat
1380   :type '(choice (const nil)
1381                  (const :tag "all" t)
1382                  (regexp)))
1383
1384 (defcustom gnus-treat-fold-headers nil
1385   "Fold headers.
1386 Valid values are nil, t, `head', `first', `last', an integer or a
1387 predicate.  See Info node `(gnus)Customizing Articles'."
1388   :version "22.1"
1389   :group 'gnus-article-treat
1390   :link '(custom-manual "(gnus)Customizing Articles")
1391   :type gnus-article-treat-custom)
1392
1393 (defcustom gnus-treat-fold-newsgroups 'head
1394   "Fold the Newsgroups and Followup-To headers.
1395 Valid values are nil, t, `head', `first', `last', an integer or a
1396 predicate.  See Info node `(gnus)Customizing Articles'."
1397   :version "22.1"
1398   :group 'gnus-article-treat
1399   :link '(custom-manual "(gnus)Customizing Articles")
1400   :type gnus-article-treat-custom)
1401
1402 (defcustom gnus-treat-overstrike t
1403   "Treat overstrike highlighting.
1404 Valid values are nil, t, `head', `first', `last', an integer or a
1405 predicate.  See Info node `(gnus)Customizing Articles'."
1406   :group 'gnus-article-treat
1407   :link '(custom-manual "(gnus)Customizing Articles")
1408   :type gnus-article-treat-custom)
1409 (put 'gnus-treat-overstrike 'highlight t)
1410
1411 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1412   "Treat ANSI SGR control sequences.
1413 Valid values are nil, t, `head', `first', `last', an integer or a
1414 predicate.  See Info node `(gnus)Customizing Articles'."
1415   :group 'gnus-article-treat
1416   :link '(custom-manual "(gnus)Customizing Articles")
1417   :type gnus-article-treat-custom)
1418
1419 (make-obsolete-variable 'gnus-treat-display-xface
1420                         'gnus-treat-display-x-face "Emacs 22.1")
1421
1422 (defcustom gnus-treat-display-x-face
1423   (and (not noninteractive)
1424        (gnus-image-type-available-p 'xbm)
1425        (if (featurep 'xemacs)
1426            (featurep 'xface)
1427          (condition-case nil
1428              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1429                   (executable-find "icontopbm"))
1430            ;; shell-command-to-string may signal an error, e.g. if
1431            ;; shell-file-name is not found.
1432            (error nil)))
1433        'head)
1434   "Display X-Face headers.
1435 Valid values are nil and `head'.
1436 See Info node `(gnus)Customizing Articles' and Info node
1437 `(gnus)X-Face' for details."
1438   :group 'gnus-article-treat
1439   :version "21.1"
1440   :link '(custom-manual "(gnus)Customizing Articles")
1441   :link '(custom-manual "(gnus)X-Face")
1442   :type gnus-article-treat-head-custom
1443   :set (lambda (symbol value)
1444          (set-default
1445           symbol
1446           (cond ((or (boundp symbol) (get symbol 'saved-value))
1447                  value)
1448                 ((boundp 'gnus-treat-display-xface)
1449                  (message "\
1450 ** gnus-treat-display-xface is an obsolete variable;\
1451  use gnus-treat-display-x-face instead")
1452                  (default-value 'gnus-treat-display-xface))
1453                 ((get 'gnus-treat-display-xface 'saved-value)
1454                  (message "\
1455 ** gnus-treat-display-xface is an obsolete variable;\
1456  use gnus-treat-display-x-face instead")
1457                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1458                 (t
1459                  value)))))
1460 (put 'gnus-treat-display-x-face 'highlight t)
1461
1462 (defcustom gnus-treat-display-face
1463   (and (not noninteractive)
1464        (gnus-image-type-available-p 'png)
1465        'head)
1466   "Display Face headers.
1467 Valid values are nil, t, `head', `first', `last', an integer or a
1468 predicate.  See Info node `(gnus)Customizing Articles' and Info
1469 node `(gnus)Face' for details."
1470   :group 'gnus-article-treat
1471   :version "22.1"
1472   :link '(custom-manual "(gnus)Customizing Articles")
1473   :link '(custom-manual "(gnus)X-Face")
1474   :type gnus-article-treat-head-custom)
1475 (put 'gnus-treat-display-face 'highlight t)
1476
1477 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1478   "Display smileys.
1479 Valid values are nil, t, `head', `first', `last', an integer or a
1480 predicate.  See Info node `(gnus)Customizing Articles' and Info
1481 node `(gnus)Smileys' for details."
1482   :group 'gnus-article-treat
1483   :version "21.1"
1484   :link '(custom-manual "(gnus)Customizing Articles")
1485   :link '(custom-manual "(gnus)Smileys")
1486   :type gnus-article-treat-custom)
1487 (put 'gnus-treat-display-smileys 'highlight t)
1488
1489 (defcustom gnus-treat-from-picon
1490   (if (and (gnus-image-type-available-p 'xpm)
1491            (gnus-picons-installed-p))
1492       'head nil)
1493   "Display picons in the From header.
1494 Valid values are nil, t, `head', `first', `last', an integer or a
1495 predicate.  See Info node `(gnus)Customizing Articles' and Info
1496 node `(gnus)Picons' for details."
1497   :version "22.1"
1498   :group 'gnus-article-treat
1499   :group 'gnus-picon
1500   :link '(custom-manual "(gnus)Customizing Articles")
1501   :link '(custom-manual "(gnus)Picons")
1502   :type gnus-article-treat-head-custom)
1503 (put 'gnus-treat-from-picon 'highlight t)
1504
1505 (defcustom gnus-treat-mail-picon
1506   (if (and (gnus-image-type-available-p 'xpm)
1507            (gnus-picons-installed-p))
1508       'head nil)
1509   "Display picons in To and Cc headers.
1510 Valid values are nil, t, `head', `first', `last', an integer or a
1511 predicate.  See Info node `(gnus)Customizing Articles' and Info
1512 node `(gnus)Picons' for details."
1513   :version "22.1"
1514   :group 'gnus-article-treat
1515   :group 'gnus-picon
1516   :link '(custom-manual "(gnus)Customizing Articles")
1517   :link '(custom-manual "(gnus)Picons")
1518   :type gnus-article-treat-head-custom)
1519 (put 'gnus-treat-mail-picon 'highlight t)
1520
1521 (defcustom gnus-treat-newsgroups-picon
1522   (if (and (gnus-image-type-available-p 'xpm)
1523            (gnus-picons-installed-p))
1524       'head nil)
1525   "Display picons in the Newsgroups and Followup-To headers.
1526 Valid values are nil, t, `head', `first', `last', an integer or a
1527 predicate.  See Info node `(gnus)Customizing Articles' and Info
1528 node `(gnus)Picons' for details."
1529   :version "22.1"
1530   :group 'gnus-article-treat
1531   :group 'gnus-picon
1532   :link '(custom-manual "(gnus)Customizing Articles")
1533   :link '(custom-manual "(gnus)Picons")
1534   :type gnus-article-treat-head-custom)
1535 (put 'gnus-treat-newsgroups-picon 'highlight t)
1536
1537 (defcustom gnus-treat-from-gravatar nil
1538   "Display gravatars in the From header.
1539 Valid values are nil, t, `head', `first', `last', an integer or a
1540 predicate.  See Info node `(gnus)Customizing Articles' and Info
1541 node `(gnus)Gravatars' for details."
1542   :version "24.1"
1543   :group 'gnus-article-treat
1544   :group 'gnus-gravatar
1545   :link '(custom-manual "(gnus)Customizing Articles")
1546   :link '(custom-manual "(gnus)Gravatars")
1547   :type gnus-article-treat-head-custom)
1548 (put 'gnus-treat-from-gravatar 'highlight t)
1549
1550 (defcustom gnus-treat-mail-gravatar nil
1551   "Display gravatars in To and Cc headers.
1552 Valid values are nil, t, `head', `first', `last', an integer or a
1553 predicate.  See Info node `(gnus)Customizing Articles' and Info
1554 node `(gnus)Gravatars' for details."
1555   :version "24.1"
1556   :group 'gnus-article-treat
1557   :group 'gnus-gravatar
1558   :link '(custom-manual "(gnus)Customizing Articles")
1559   :link '(custom-manual "(gnus)Gravatars")
1560   :type gnus-article-treat-head-custom)
1561 (put 'gnus-treat-mail-gravatar 'highlight t)
1562
1563 (defcustom gnus-treat-body-boundary
1564   (if (or gnus-treat-newsgroups-picon
1565           gnus-treat-mail-picon
1566           gnus-treat-from-picon
1567           gnus-treat-from-gravatar
1568           gnus-treat-mail-gravatar)
1569       ;; If there's much decoration, the user might prefer a boundary.
1570       'head
1571     nil)
1572   "Draw a boundary at the end of the headers.
1573 Valid values are nil and `head'.
1574 See Info node `(gnus)Customizing Articles' for details."
1575   :version "22.1"
1576   :group 'gnus-article-treat
1577   :link '(custom-manual "(gnus)Customizing Articles")
1578   :type gnus-article-treat-head-custom)
1579
1580 (defcustom gnus-treat-capitalize-sentences nil
1581   "Capitalize sentence-starting words.
1582 Valid values are nil, t, `head', `first', `last', an integer or a
1583 predicate.  See Info node `(gnus)Customizing Articles'."
1584   :version "21.1"
1585   :group 'gnus-article-treat
1586   :link '(custom-manual "(gnus)Customizing Articles")
1587   :type gnus-article-treat-custom)
1588
1589 (defcustom gnus-treat-wash-html nil
1590   "Format as HTML.
1591 Valid values are nil, t, `head', `first', `last', an integer or a
1592 predicate.  See Info node `(gnus)Customizing Articles'."
1593   :version "22.1"
1594   :group 'gnus-article-treat
1595   :link '(custom-manual "(gnus)Customizing Articles")
1596   :type gnus-article-treat-custom)
1597
1598 (defcustom gnus-treat-fill-long-lines '(typep "text/plain")
1599   "Fill long lines.
1600 Valid values are nil, t, `head', `first', `last', an integer or a
1601 predicate.  See Info node `(gnus)Customizing Articles'."
1602   :version "24.1"
1603   :group 'gnus-article-treat
1604   :link '(custom-manual "(gnus)Customizing Articles")
1605   :type gnus-article-treat-custom)
1606
1607 (defcustom gnus-treat-x-pgp-sig nil
1608   "Verify X-PGP-Sig.
1609 To automatically treat X-PGP-Sig, set it to head.
1610 Valid values are nil, t, `head', `first', `last', an integer or a
1611 predicate.  See Info node `(gnus)Customizing Articles'."
1612   :version "22.1"
1613   :group 'gnus-article-treat
1614   :group 'mime-security
1615   :link '(custom-manual "(gnus)Customizing Articles")
1616   :type gnus-article-treat-custom)
1617
1618 (defvar gnus-article-encrypt-protocol-alist
1619   '(("PGP" . mml2015-self-encrypt)))
1620
1621 ;; Set to nil if more than one protocol added to
1622 ;; gnus-article-encrypt-protocol-alist.
1623 (defcustom gnus-article-encrypt-protocol "PGP"
1624   "The protocol used for encrypt articles.
1625 It is a string, such as \"PGP\". If nil, ask user."
1626   :version "22.1"
1627   :type 'string
1628   :group 'mime-security)
1629
1630 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1631                               (mm-coding-system-p 'utf-8)
1632                               (executable-find idna-program))
1633   "Whether IDNA decoding of headers is used when viewing messages.
1634 This requires GNU Libidn, and by default only enabled if it is found."
1635   :version "22.1"
1636   :group 'gnus-article-headers
1637   :type 'boolean)
1638
1639 (defcustom gnus-article-over-scroll nil
1640   "If non-nil, allow scrolling the article buffer even when there no more text."
1641   :version "22.1"
1642   :group 'gnus-article
1643   :type 'boolean)
1644
1645 (defcustom gnus-inhibit-images nil
1646   "Non-nil means inhibit displaying of images inline in the article body."
1647   :version "24.1"
1648   :group 'gnus-article
1649   :type 'boolean)
1650
1651 (defcustom gnus-blocked-images 'gnus-block-private-groups
1652   "Images that have URLs matching this regexp will be blocked.
1653 This can also be a function to be evaluated.  If so, it will be
1654 called with the group name as the parameter, and should return a
1655 regexp."
1656   :version "24.1"
1657   :group 'gnus-art
1658   :type '(choice regexp function))
1659
1660 ;;; Internal variables
1661
1662 (defvar gnus-english-month-names
1663   '("January" "February" "March" "April" "May" "June" "July" "August"
1664     "September" "October" "November" "December"))
1665
1666 (defvar article-goto-body-goes-to-point-min-p nil)
1667 (defvar gnus-article-wash-types nil)
1668 (defvar gnus-article-emphasis-alist nil)
1669 (defvar gnus-article-image-alist nil)
1670
1671 (defvar gnus-article-mime-handle-alist-1 nil)
1672 (defvar gnus-treatment-function-alist
1673   '((gnus-treat-strip-cr gnus-article-remove-cr)
1674     (gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1675     (gnus-treat-strip-banner gnus-article-strip-banner)
1676     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1677     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1678     (gnus-treat-buttonize gnus-article-add-buttons)
1679     (gnus-treat-fill-article gnus-article-fill-cited-article)
1680     (gnus-treat-fill-long-lines gnus-article-fill-cited-long-lines)
1681     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1682     (gnus-treat-display-x-face gnus-article-display-x-face)
1683     (gnus-treat-display-face gnus-article-display-face)
1684     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1685     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1686     (gnus-treat-hide-signature gnus-article-hide-signature)
1687     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1688     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1689     (gnus-treat-from-picon gnus-treat-from-picon)
1690     (gnus-treat-mail-picon gnus-treat-mail-picon)
1691     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1692     (gnus-treat-strip-pem gnus-article-hide-pem)
1693     (gnus-treat-date gnus-article-treat-date)
1694     (gnus-treat-from-gravatar gnus-treat-from-gravatar)
1695     (gnus-treat-mail-gravatar gnus-treat-mail-gravatar)
1696     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1697     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1698     (gnus-treat-strip-trailing-blank-lines
1699      gnus-article-remove-trailing-blank-lines)
1700     (gnus-treat-strip-leading-blank-lines
1701      gnus-article-strip-leading-blank-lines)
1702     (gnus-treat-strip-multiple-blank-lines
1703      gnus-article-strip-multiple-blank-lines)
1704     (gnus-treat-overstrike gnus-article-treat-overstrike)
1705     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1706     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1707     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1708     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1709     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1710     (gnus-treat-display-smileys gnus-treat-smiley)
1711     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1712     (gnus-treat-wash-html gnus-article-wash-html)
1713     (gnus-treat-emphasize gnus-article-emphasize)
1714     (gnus-treat-hide-citation gnus-article-hide-citation)
1715     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1716     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1717     (gnus-treat-body-boundary gnus-article-treat-body-boundary)))
1718
1719 (defvar gnus-article-mime-handle-alist nil)
1720 (defvar article-lapsed-timer nil)
1721 (defvar gnus-article-current-summary nil)
1722
1723 (defvar gnus-article-mode-syntax-table
1724   (let ((table (copy-syntax-table text-mode-syntax-table)))
1725     ;; This causes the citation match run O(2^n).
1726     ;; (modify-syntax-entry ?- "w" table)
1727     (modify-syntax-entry ?> ")<" table)
1728     (modify-syntax-entry ?< "(>" table)
1729     ;; make M-. in article buffers work for `foo' strings
1730     (modify-syntax-entry ?' " " table)
1731     (modify-syntax-entry ?` " " table)
1732     table)
1733   "Syntax table used in article mode buffers.
1734 Initialized from `text-mode-syntax-table.")
1735
1736 (defvar gnus-save-article-buffer nil)
1737
1738 (defvar gnus-number-of-articles-to-be-saved nil)
1739
1740 (defvar gnus-inhibit-hiding nil)
1741
1742 (defvar gnus-article-edit-mode nil)
1743
1744 ;;; Macros for dealing with the article buffer.
1745
1746 (defmacro gnus-with-article-headers (&rest forms)
1747   `(with-current-buffer gnus-article-buffer
1748      (save-restriction
1749        (let ((inhibit-read-only t)
1750              (inhibit-point-motion-hooks t)
1751              (case-fold-search t))
1752          (article-narrow-to-head)
1753          ,@forms))))
1754
1755 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1756 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1757
1758 (defmacro gnus-with-article-buffer (&rest forms)
1759   `(when (buffer-live-p (get-buffer gnus-article-buffer))
1760      (with-current-buffer gnus-article-buffer
1761        (let ((inhibit-read-only t))
1762          ,@forms))))
1763
1764 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1765 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1766
1767 (defun gnus-article-goto-header (header)
1768   "Go to HEADER, which is a regular expression."
1769   (re-search-forward (concat "^\\(" header "\\):") nil t))
1770
1771 (defsubst gnus-article-hide-text (b e props)
1772   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1773   (gnus-add-text-properties-when 'article-type nil b e props)
1774   (when (memq 'intangible props)
1775     (put-text-property
1776      (max (1- b) (point-min))
1777      b 'intangible (cddr (memq 'intangible props)))))
1778
1779 (defsubst gnus-article-unhide-text (b e)
1780   "Remove hidden text properties from region between B and E."
1781   (remove-text-properties b e gnus-hidden-properties)
1782   (when (memq 'intangible gnus-hidden-properties)
1783     (put-text-property (max (1- b) (point-min))
1784                        b 'intangible nil)))
1785
1786 (defun gnus-article-hide-text-type (b e type)
1787   "Hide text of TYPE between B and E."
1788   (gnus-add-wash-type type)
1789   (gnus-article-hide-text
1790    b e (cons 'article-type (cons type gnus-hidden-properties))))
1791
1792 (defun gnus-article-unhide-text-type (b e type)
1793   "Unhide text of TYPE between B and E."
1794   (gnus-delete-wash-type type)
1795   (remove-text-properties
1796    b e (cons 'article-type (cons type gnus-hidden-properties)))
1797   (when (memq 'intangible gnus-hidden-properties)
1798     (put-text-property (max (1- b) (point-min))
1799                        b 'intangible nil)))
1800
1801 (defun gnus-article-delete-text-of-type (type)
1802   "Delete text of TYPE in the current buffer."
1803   (save-excursion
1804     (let ((b (point-min)))
1805       (if (eq type 'multipart)
1806           ;; Remove MIME buttons associated with multipart/alternative parts.
1807           (progn
1808             (goto-char b)
1809             (while (if (get-text-property (point) 'gnus-part)
1810                        (setq b (point))
1811                      (when (setq b (next-single-property-change (point)
1812                                                                 'gnus-part))
1813                        (goto-char b)
1814                        t))
1815               (end-of-line)
1816               (skip-chars-forward "\n")
1817               (when (eq (get-text-property b 'article-type) 'multipart)
1818                 (delete-region b (point)))))
1819         (while (setq b (text-property-any b (point-max) 'article-type type))
1820           (delete-region
1821            b (or (text-property-not-all b (point-max) 'article-type type)
1822                  (point-max))))))))
1823
1824 (defun gnus-article-delete-invisible-text ()
1825   "Delete all invisible text in the current buffer."
1826   (save-excursion
1827     (let ((b (point-min)))
1828       (while (setq b (text-property-any b (point-max) 'invisible t))
1829         (delete-region
1830          b (or (text-property-not-all b (point-max) 'invisible t)
1831                (point-max)))))))
1832
1833 (defsubst gnus-article-header-rank ()
1834   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1835   (let ((list gnus-sorted-header-list)
1836         (i 1))
1837     (while list
1838       (if (looking-at (car list))
1839           (setq list nil)
1840         (setq list (cdr list))
1841         (incf i)))
1842       i))
1843
1844 (defun article-hide-headers (&optional arg delete)
1845   "Hide unwanted headers and possibly sort them as well."
1846   (interactive)
1847   ;; This function might be inhibited.
1848   (unless gnus-inhibit-hiding
1849     (let ((inhibit-read-only t)
1850           (case-fold-search t)
1851           (max (1+ (length gnus-sorted-header-list)))
1852           (inhibit-point-motion-hooks t)
1853           (cur (current-buffer))
1854           ignored visible beg)
1855       (save-excursion
1856         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1857         ;; group parameters, so we should go to the summary buffer.
1858         (when (prog1
1859                   (condition-case nil
1860                       (progn (set-buffer gnus-summary-buffer) t)
1861                     (error nil))
1862                 (setq ignored (when (not gnus-visible-headers)
1863                                 (cond ((stringp gnus-ignored-headers)
1864                                        gnus-ignored-headers)
1865                                       ((listp gnus-ignored-headers)
1866                                        (mapconcat 'identity
1867                                                   gnus-ignored-headers
1868                                                   "\\|"))))
1869                       visible (cond ((stringp gnus-visible-headers)
1870                                      gnus-visible-headers)
1871                                     ((and gnus-visible-headers
1872                                           (listp gnus-visible-headers))
1873                                      (mapconcat 'identity
1874                                                 gnus-visible-headers
1875                                                 "\\|")))))
1876           (set-buffer cur))
1877         (save-restriction
1878           ;; First we narrow to just the headers.
1879           (article-narrow-to-head)
1880           ;; Hide any "From " lines at the beginning of (mail) articles.
1881           (while (looking-at "From ")
1882             (forward-line 1))
1883           (unless (bobp)
1884             (delete-region (point-min) (point)))
1885           ;; Then treat the rest of the header lines.
1886           ;; Then we use the two regular expressions
1887           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1888           ;; select which header lines is to remain visible in the
1889           ;; article buffer.
1890           (while (re-search-forward "^[^ \t:]*:" nil t)
1891             (beginning-of-line)
1892             ;; Mark the rank of the header.
1893             (put-text-property
1894              (point) (1+ (point)) 'message-rank
1895              (if (or (and visible (looking-at visible))
1896                      (and ignored
1897                           (not (looking-at ignored))))
1898                  (gnus-article-header-rank)
1899                (+ 2 max)))
1900             (forward-line 1))
1901           (message-sort-headers-1)
1902           (when (setq beg (text-property-any
1903                            (point-min) (point-max) 'message-rank (+ 2 max)))
1904             ;; We delete the unwanted headers.
1905             (gnus-add-wash-type 'headers)
1906             (add-text-properties (point-min) (+ 5 (point-min))
1907                                  '(article-type headers dummy-invisible t))
1908             (delete-region beg (point-max))))))))
1909
1910 (defun article-hide-boring-headers (&optional arg)
1911   "Toggle hiding of headers that aren't very interesting.
1912 If given a negative prefix, always show; if given a positive prefix,
1913 always hide."
1914   (interactive (gnus-article-hidden-arg))
1915   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1916              (not gnus-show-all-headers))
1917     (save-excursion
1918       (save-restriction
1919         (let ((inhibit-read-only t)
1920               (inhibit-point-motion-hooks t))
1921           (article-narrow-to-head)
1922           (dolist (elem gnus-boring-article-headers)
1923             (goto-char (point-min))
1924             (cond
1925              ;; Hide empty headers.
1926              ((eq elem 'empty)
1927               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1928                 (forward-line -1)
1929                 (gnus-article-hide-text-type
1930                  (point-at-bol)
1931                  (progn
1932                    (end-of-line)
1933                    (if (re-search-forward "^[^ \t]" nil t)
1934                        (match-beginning 0)
1935                      (point-max)))
1936                  'boring-headers)))
1937              ;; Hide boring Newsgroups header.
1938              ((eq elem 'newsgroups)
1939               (when (gnus-string-equal
1940                      (gnus-fetch-field "newsgroups")
1941                      (gnus-group-real-name
1942                       (if (boundp 'gnus-newsgroup-name)
1943                           gnus-newsgroup-name
1944                         "")))
1945                 (gnus-article-hide-header "newsgroups")))
1946              ((eq elem 'to-address)
1947               (let ((to (message-fetch-field "to"))
1948                     (to-address
1949                      (gnus-parameter-to-address
1950                       (if (boundp 'gnus-newsgroup-name)
1951                           gnus-newsgroup-name ""))))
1952                 (when (and to to-address
1953                            (ignore-errors
1954                              (gnus-string-equal
1955                               ;; only one address in To
1956                               (nth 1 (mail-extract-address-components to))
1957                               to-address)))
1958                   (gnus-article-hide-header "to"))))
1959              ((eq elem 'to-list)
1960               (let ((to (message-fetch-field "to"))
1961                     (to-list
1962                      (gnus-parameter-to-list
1963                       (if (boundp 'gnus-newsgroup-name)
1964                           gnus-newsgroup-name ""))))
1965                 (when (and to to-list
1966                            (ignore-errors
1967                              (gnus-string-equal
1968                               ;; only one address in To
1969                               (nth 1 (mail-extract-address-components to))
1970                               to-list)))
1971                   (gnus-article-hide-header "to"))))
1972              ((eq elem 'cc-list)
1973               (let ((cc (message-fetch-field "cc"))
1974                     (to-list
1975                      (gnus-parameter-to-list
1976                       (if (boundp 'gnus-newsgroup-name)
1977                           gnus-newsgroup-name ""))))
1978                 (when (and cc to-list
1979                            (ignore-errors
1980                              (gnus-string-equal
1981                               ;; only one address in CC
1982                               (nth 1 (mail-extract-address-components cc))
1983                               to-list)))
1984                   (gnus-article-hide-header "cc"))))
1985              ((eq elem 'followup-to)
1986               (when (gnus-string-equal
1987                      (message-fetch-field "followup-to")
1988                      (message-fetch-field "newsgroups"))
1989                 (gnus-article-hide-header "followup-to")))
1990              ((eq elem 'reply-to)
1991               (if (gnus-group-find-parameter
1992                    gnus-newsgroup-name 'broken-reply-to)
1993                   (gnus-article-hide-header "reply-to")
1994                 (let ((from (message-fetch-field "from"))
1995                       (reply-to (message-fetch-field "reply-to")))
1996                   (when
1997                       (and
1998                        from reply-to
1999                        (ignore-errors
2000                          (equal
2001                           (sort (mapcar
2002                                  (lambda (x) (downcase (cadr x)))
2003                                  (mail-extract-address-components from t))
2004                                 'string<)
2005                           (sort (mapcar
2006                                  (lambda (x) (downcase (cadr x)))
2007                                  (mail-extract-address-components reply-to t))
2008                                 'string<))))
2009                     (gnus-article-hide-header "reply-to")))))
2010              ((eq elem 'date)
2011               (let ((date (with-current-buffer gnus-original-article-buffer
2012                             ;; If date in `gnus-article-buffer' is localized
2013                             ;; (`gnus-treat-date-user-defined'),
2014                             ;; `days-between' might fail.
2015                             (message-fetch-field "date"))))
2016                 (when (and date
2017                            (< (days-between (current-time-string) date)
2018                               4))
2019                   (gnus-article-hide-header "date"))))
2020              ((eq elem 'long-to)
2021               (let ((to (message-fetch-field "to"))
2022                     (cc (message-fetch-field "cc")))
2023                 (when (> (length to) 1024)
2024                   (gnus-article-hide-header "to"))
2025                 (when (> (length cc) 1024)
2026                   (gnus-article-hide-header "cc"))))
2027              ((eq elem 'many-to)
2028               (let ((to-count 0)
2029                     (cc-count 0))
2030                 (goto-char (point-min))
2031                 (while (re-search-forward "^to:" nil t)
2032                   (setq to-count (1+ to-count)))
2033                 (when (> to-count 1)
2034                   (while (> to-count 0)
2035                     (goto-char (point-min))
2036                     (save-restriction
2037                       (re-search-forward "^to:" nil nil to-count)
2038                       (forward-line -1)
2039                       (narrow-to-region (point) (point-max))
2040                       (gnus-article-hide-header "to"))
2041                     (setq to-count (1- to-count))))
2042                 (goto-char (point-min))
2043                 (while (re-search-forward "^cc:" nil t)
2044                   (setq cc-count (1+ cc-count)))
2045                 (when (> cc-count 1)
2046                   (while (> cc-count 0)
2047                     (goto-char (point-min))
2048                     (save-restriction
2049                       (re-search-forward "^cc:" nil nil cc-count)
2050                       (forward-line -1)
2051                       (narrow-to-region (point) (point-max))
2052                       (gnus-article-hide-header "cc"))
2053                     (setq cc-count (1- cc-count)))))))))))))
2054
2055 (defun gnus-article-hide-header (header)
2056   (save-excursion
2057     (goto-char (point-min))
2058     (when (re-search-forward (concat "^" header ":") nil t)
2059       (gnus-article-hide-text-type
2060        (point-at-bol)
2061        (progn
2062          (end-of-line)
2063          (if (re-search-forward "^[^ \t]" nil t)
2064              (match-beginning 0)
2065            (point-max)))
2066        'boring-headers))))
2067
2068 (defvar gnus-article-normalized-header-length 40
2069   "Length of normalized headers.")
2070
2071 (defun article-normalize-headers ()
2072   "Make all header lines 40 characters long."
2073   (interactive)
2074   (let ((inhibit-read-only t)
2075         column)
2076     (save-excursion
2077       (save-restriction
2078         (article-narrow-to-head)
2079         (while (not (eobp))
2080           (cond
2081            ((< (setq column (- (point-at-eol) (point)))
2082                gnus-article-normalized-header-length)
2083             (end-of-line)
2084             (insert (make-string
2085                      (- gnus-article-normalized-header-length column)
2086                      ? )))
2087            ((> column gnus-article-normalized-header-length)
2088             (gnus-put-text-property
2089              (progn
2090                (forward-char gnus-article-normalized-header-length)
2091                (point))
2092              (point-at-eol)
2093              'invisible t))
2094            (t
2095             ;; Do nothing.
2096             ))
2097           (forward-line 1))))))
2098
2099 (defun article-treat-dumbquotes ()
2100   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2101 Note that this function guesses whether a character is a sm*rtq**t* or
2102 not, so it should only be used interactively.
2103
2104 Sm*rtq**t*s are M****s***'s unilateral extension to the
2105 iso-8859-1 character map in an attempt to provide more quoting
2106 characters.  If you see something like \\222 or \\264 where
2107 you're expecting some kind of apostrophe or quotation mark, then
2108 try this wash."
2109   (interactive)
2110   (article-translate-strings gnus-article-dumbquotes-map))
2111
2112 (defvar org-entities)
2113
2114 (defun article-treat-non-ascii ()
2115   "Translate many Unicode characters into their ASCII equivalents."
2116   (interactive)
2117   (require 'org-entities)
2118   (let ((table (make-char-table (if (featurep 'xemacs) 'generic))))
2119     (dolist (elem org-entities)
2120       (when (and (listp elem)
2121                  (= (length (nth 6 elem)) 1))
2122         (if (featurep 'xemacs)
2123             (put-char-table (aref (nth 6 elem) 0) (nth 4 elem) table)
2124           (set-char-table-range table (aref (nth 6 elem) 0) (nth 4 elem)))))
2125     (save-excursion
2126       (when (article-goto-body)
2127         (let ((inhibit-read-only t)
2128               replace props)
2129           (while (not (eobp))
2130             (if (not (setq replace (if (featurep 'xemacs)
2131                                        (get-char-table (following-char) table)
2132                                      (aref table (following-char)))))
2133                 (forward-char 1)
2134               (if (prog1
2135                       (setq props (text-properties-at (point)))
2136                     (delete-char 1))
2137                   (add-text-properties (point) (progn (insert replace) (point))
2138                                        props)
2139                 (insert replace)))))))))
2140
2141 (defun article-translate-strings (map)
2142   "Translate all string in the body of the article according to MAP.
2143 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2144   (save-excursion
2145     (when (article-goto-body)
2146       (let ((inhibit-read-only t))
2147         (dolist (elem map)
2148           (let ((from (car elem))
2149                 (to (cadr elem)))
2150             (save-excursion
2151               (if (stringp from)
2152                   (while (search-forward from nil t)
2153                     (replace-match to))
2154                 (while (not (eobp))
2155                   (if (eq (following-char) from)
2156                       (progn
2157                         (delete-char 1)
2158                         (insert to))
2159                     (forward-char 1)))))))))))
2160
2161 (defun article-treat-overstrike ()
2162   "Translate overstrikes into bold text."
2163   (interactive)
2164   (save-excursion
2165     (when (article-goto-body)
2166       (let ((inhibit-read-only t))
2167         (while (search-forward "\b" nil t)
2168           (let ((next (char-after))
2169                 (previous (char-after (- (point) 2))))
2170             ;; We do the boldification/underlining by hiding the
2171             ;; overstrikes and putting the proper text property
2172             ;; on the letters.
2173             (cond
2174              ((eq next previous)
2175               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2176               (put-text-property (point) (1+ (point)) 'face 'bold))
2177              ((eq next ?_)
2178               (gnus-article-hide-text-type
2179                (1- (point)) (1+ (point)) 'overstrike)
2180               (put-text-property
2181                (- (point) 2) (1- (point)) 'face 'underline))
2182              ((eq previous ?_)
2183               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2184               (put-text-property
2185                (point) (1+ (point)) 'face 'underline)))))))))
2186
2187 (defun article-treat-ansi-sequences ()
2188   "Translate ANSI SGR control sequences into overlays or extents."
2189   (interactive)
2190   (save-excursion
2191     (when (article-goto-body)
2192       (let ((inhibit-read-only t))
2193         (ansi-color-apply-on-region (point) (point-max))))))
2194
2195 (defun gnus-article-treat-unfold-headers ()
2196   "Unfold folded message headers.
2197 Only the headers that fit into the current window width will be
2198 unfolded."
2199   (interactive)
2200   (gnus-with-article-headers
2201     (let (length)
2202       (while (not (eobp))
2203         (save-restriction
2204           (mail-header-narrow-to-field)
2205           (let* ((header (buffer-string))
2206                  (unfoldable
2207                   (or (equal gnus-article-unfold-long-headers t)
2208                       (and (stringp gnus-article-unfold-long-headers)
2209                            (string-match gnus-article-unfold-long-headers
2210                                          header)))))
2211             (with-temp-buffer
2212               (insert header)
2213               (goto-char (point-min))
2214               (while (re-search-forward "\n[\t ]" nil t)
2215                 (replace-match " " t t)))
2216             (setq length (- (point-max) (point-min) 1))
2217             (when (or unfoldable
2218                       (< length (window-width)))
2219               (while (re-search-forward "\n[\t ]" nil t)
2220                 (replace-match " " t t))))
2221           (goto-char (point-max)))))))
2222
2223 (defun gnus-article-treat-fold-headers ()
2224   "Fold message headers."
2225   (interactive)
2226   (gnus-with-article-headers
2227     (while (not (eobp))
2228       (save-restriction
2229         (mail-header-narrow-to-field)
2230         (mail-header-fold-field)
2231         (goto-char (point-max))))))
2232
2233 (defun gnus-treat-smiley ()
2234   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2235   (interactive)
2236   (gnus-with-article-buffer
2237     (if (memq 'smiley gnus-article-wash-types)
2238         (gnus-delete-images 'smiley)
2239       (article-goto-body)
2240       (let ((images (smiley-region (point) (point-max))))
2241         (when images
2242           (gnus-add-wash-type 'smiley)
2243           (dolist (image images)
2244             (gnus-add-image 'smiley image)))))))
2245
2246 (defun gnus-article-remove-images ()
2247   "Remove all images from the article buffer."
2248   (interactive)
2249   (gnus-with-article-buffer
2250     (save-restriction
2251       (widen)
2252       (dolist (elem gnus-article-image-alist)
2253         (gnus-delete-images (car elem))))))
2254
2255 (autoload 'w3m-toggle-inline-images "w3m")
2256
2257 (defun gnus-article-show-images ()
2258   "Show any images that are in the HTML-rendered article buffer.
2259 This only works if the article in question is HTML."
2260   (interactive)
2261   (gnus-with-article-buffer
2262     (save-restriction
2263       (widen)
2264       (if (eq mm-text-html-renderer 'w3m)
2265           (let ((mm-inline-text-html-with-images nil))
2266             (w3m-toggle-inline-images))
2267         (dolist (region (gnus-find-text-property-region (point-min) (point-max)
2268                                                         'image-displayer))
2269           (destructuring-bind (start end function) region
2270             (funcall function (get-text-property start 'image-url)
2271                      start end)))))))
2272
2273 (defun gnus-article-treat-fold-newsgroups ()
2274   "Unfold folded message headers.
2275 Only the headers that fit into the current window width will be
2276 unfolded."
2277   (interactive)
2278   (gnus-with-article-headers
2279     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2280       (save-restriction
2281         (mail-header-narrow-to-field)
2282         (while (re-search-forward ", *" nil t)
2283           (replace-match ", " t t))
2284         (mail-header-fold-field)
2285         (goto-char (point-max))))))
2286
2287 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2288   "Value of `truncate-lines' in Gnus Article buffer.
2289 Valid values are nil, t, `head', `first', `last', an integer or a
2290 predicate.  See Info node `(gnus)Customizing Articles'."
2291   :version "23.1" ;; No Gnus
2292   :group 'gnus-article
2293   ;; :link '(custom-manual "(gnus)Customizing Articles")
2294   :type 'boolean)
2295
2296 (defun gnus-article-toggle-truncate-lines (&optional arg)
2297   "Toggle whether to fold or truncate long lines in article the buffer.
2298 If ARG is non-nil and not a number, toggle
2299 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2300 long lines if and only if arg is positive."
2301   (interactive "P")
2302   (cond
2303    ((and (numberp arg) (> arg 0))
2304     (setq gnus-article-truncate-lines t))
2305    ((numberp arg)
2306     (setq gnus-article-truncate-lines nil))
2307    (arg
2308     (setq gnus-article-truncate-lines
2309           (not gnus-article-truncate-lines))))
2310   (gnus-with-article-buffer
2311     (cond
2312      ((and (numberp arg) (> arg 0))
2313       (setq truncate-lines nil))
2314      ((numberp arg)
2315       (setq truncate-lines t)))
2316     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2317     ;; `toggle-truncate-lines' needs an argument.
2318     (toggle-truncate-lines)))
2319
2320 (defun gnus-article-treat-body-boundary ()
2321   "Place a boundary line at the end of the headers."
2322   (interactive)
2323   (when (and gnus-body-boundary-delimiter
2324              (> (length gnus-body-boundary-delimiter) 0))
2325     (gnus-with-article-headers
2326       (goto-char (point-max))
2327       (let ((start (point)))
2328         (insert "X-Boundary: ")
2329         (gnus-add-text-properties start (point) '(invisible t intangible t))
2330        (insert (let (str (max (window-width)))
2331                  (if (featurep 'xemacs)
2332                      (setq max (1- max)))
2333                  (while (>= max (length str))
2334                     (setq str (concat str gnus-body-boundary-delimiter)))
2335                  (substring str 0 max))
2336                 "\n")
2337         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2338
2339 (defun article-fill-long-lines ()
2340   "Fill lines that are wider than the window width."
2341   (interactive)
2342   (save-excursion
2343     (let ((inhibit-read-only t)
2344           (width (window-width (get-buffer-window (current-buffer)))))
2345       (save-restriction
2346         (article-goto-body)
2347         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2348           (while (not (eobp))
2349             (end-of-line)
2350             (when (>= (current-column) (min fill-column width))
2351               (narrow-to-region (min (1+ (point)) (point-max))
2352                                 (point-at-bol))
2353               (let ((goback (point-marker)))
2354                 (fill-paragraph nil)
2355                 (goto-char (marker-position goback)))
2356               (widen))
2357             (forward-line 1)))))))
2358
2359 (defun article-capitalize-sentences ()
2360   "Capitalize the first word in each sentence."
2361   (interactive)
2362   (save-excursion
2363     (let ((inhibit-read-only t)
2364           (paragraph-start "^[\n\^L]"))
2365       (article-goto-body)
2366       (while (not (eobp))
2367         (capitalize-word 1)
2368         (forward-sentence)))))
2369
2370 (defun article-remove-cr ()
2371   "Remove trailing CRs and then translate remaining CRs into LFs."
2372   (interactive)
2373   (save-excursion
2374     (let ((inhibit-read-only t))
2375       (goto-char (point-min))
2376       (while (re-search-forward "\r+$" nil t)
2377         (replace-match "" t t))
2378       (goto-char (point-min))
2379       (while (search-forward "\r" nil t)
2380         (replace-match "\n" t t)))))
2381
2382 (defun article-remove-trailing-blank-lines ()
2383   "Remove all trailing blank lines from the article."
2384   (interactive)
2385   (save-excursion
2386     (let ((inhibit-read-only t))
2387       (goto-char (point-max))
2388       (delete-region
2389        (point)
2390        (progn
2391          (while (and (not (bobp))
2392                      (looking-at "^[ \t]*$")
2393                      (not (gnus-annotation-in-region-p
2394                            (point) (point-at-eol))))
2395            (forward-line -1))
2396          (forward-line 1)
2397          (point))))))
2398
2399 (defvar gnus-face-properties-alist)
2400
2401 (defun article-display-face (&optional force)
2402   "Display any Face headers in the header."
2403   (interactive (list 'force))
2404   (let ((wash-face-p buffer-read-only))
2405     (gnus-with-article-headers
2406       ;; When displaying parts, this function can be called several times on
2407       ;; the same article, without any intended toggle semantic (as typing `W
2408       ;; D d' would have). So face deletion must occur only when we come from
2409       ;; an interactive command, that is when the *Article* buffer is
2410       ;; read-only.
2411       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2412           (gnus-delete-images 'face)
2413         (let ((from (message-fetch-field "from"))
2414               face faces)
2415           (save-current-buffer
2416             (when (and wash-face-p
2417                        (gnus-buffer-live-p gnus-original-article-buffer)
2418                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2419               (set-buffer gnus-original-article-buffer))
2420             (save-restriction
2421               (mail-narrow-to-head)
2422               (when (or force
2423                         ;; Check whether this face is censored.
2424                         (not (and gnus-article-x-face-too-ugly
2425                                   (or from
2426                                       (setq from (message-fetch-field "from")))
2427                                   (string-match gnus-article-x-face-too-ugly
2428                                                 from))))
2429                 (while (gnus-article-goto-header "Face")
2430                   (push (mail-header-field-value) faces)))))
2431           (when faces
2432             (goto-char (point-min))
2433             (let (png image)
2434               (unless (setq from (gnus-article-goto-header "from"))
2435                 (insert "From:")
2436                 (setq from (point))
2437                 (insert " [no `from' set]\n"))
2438               (while faces
2439                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2440                   (setq image
2441                         (apply 'gnus-create-image png 'png t
2442                                (cdr (assq 'png gnus-face-properties-alist))))
2443                   (goto-char from)
2444                   (when image
2445                     (gnus-add-wash-type 'face)
2446                     (gnus-add-image 'face image)
2447                     (gnus-put-image image nil 'face)))))))))))
2448
2449 (defun article-display-x-face (&optional force)
2450   "Look for an X-Face header and display it if present."
2451   (interactive (list 'force))
2452   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2453     (gnus-with-article-headers
2454       ;; Delete the old process, if any.
2455       (when (process-status "article-x-face")
2456         (delete-process "article-x-face"))
2457       ;; See the comment in `article-display-face'.
2458       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2459           ;; We have already displayed X-Faces, so we remove them
2460           ;; instead.
2461           (gnus-delete-images 'xface)
2462         ;; Display X-Faces.
2463         (let ((from (message-fetch-field "from"))
2464               x-faces face)
2465           (save-current-buffer
2466             (when (and wash-face-p
2467                        (gnus-buffer-live-p gnus-original-article-buffer)
2468                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2469               ;; If type `W f', use gnus-original-article-buffer,
2470               ;; otherwise use the current buffer because displaying
2471               ;; RFC822 parts calls this function too.
2472               (set-buffer gnus-original-article-buffer))
2473             (save-restriction
2474               (mail-narrow-to-head)
2475               (and gnus-article-x-face-command
2476                    (or force
2477                        ;; Check whether this face is censored.
2478                        (not (and gnus-article-x-face-too-ugly
2479                                  (or from
2480                                      (setq from (message-fetch-field "from")))
2481                                  (string-match gnus-article-x-face-too-ugly
2482                                                from))))
2483                    (while (gnus-article-goto-header "X-Face")
2484                      (push (mail-header-field-value) x-faces)))))
2485           (when x-faces
2486             ;; We display the face.
2487             (cond ((functionp gnus-article-x-face-command)
2488                    ;; The command is a lisp function, so we call it.
2489                    (mapc gnus-article-x-face-command x-faces))
2490                   ((stringp gnus-article-x-face-command)
2491                    ;; The command is a string, so we interpret the command
2492                    ;; as a, well, command, and fork it off.
2493                    (let ((process-connection-type nil))
2494                      (gnus-set-process-query-on-exit-flag
2495                       (start-process
2496                        "article-x-face" nil shell-file-name
2497                        shell-command-switch gnus-article-x-face-command)
2498                       nil)
2499                      ;; Sending multiple EOFs to xv doesn't work,
2500                      ;; so we only do a single external face.
2501                      (with-temp-buffer
2502                        (insert (car x-faces))
2503                        (process-send-region "article-x-face"
2504                                             (point-min) (point-max)))
2505                      (process-send-eof "article-x-face")))
2506                   (t
2507                    (error "`%s' set to `%s' is not a function"
2508                           gnus-article-x-face-command
2509                           'gnus-article-x-face-command)))))))))
2510
2511 (defun article-decode-mime-words ()
2512   "Decode all MIME-encoded words in the article."
2513   (interactive)
2514   (gnus-with-article-buffer
2515     (let ((inhibit-point-motion-hooks t)
2516           (mail-parse-charset gnus-newsgroup-charset)
2517           (mail-parse-ignored-charsets
2518            (with-current-buffer gnus-summary-buffer
2519              gnus-newsgroup-ignored-charsets)))
2520       (mail-decode-encoded-word-region (point-min) (point-max)))))
2521
2522 (defun article-decode-charset (&optional prompt)
2523   "Decode charset-encoded text in the article.
2524 If PROMPT (the prefix), prompt for a coding system to use."
2525   (interactive "P")
2526   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2527         (inhibit-read-only t)
2528         (mail-parse-charset gnus-newsgroup-charset)
2529         (mail-parse-ignored-charsets
2530          (save-excursion (condition-case nil
2531                              (set-buffer gnus-summary-buffer)
2532                            (error))
2533                          gnus-newsgroup-ignored-charsets))
2534         ct cte ctl charset format)
2535     (save-excursion
2536       (save-restriction
2537         (article-narrow-to-head)
2538         (setq ct (message-fetch-field "Content-Type" t)
2539               cte (message-fetch-field "Content-Transfer-Encoding" t)
2540               ctl (and ct (mail-header-parse-content-type ct))
2541               charset (cond
2542                        (prompt
2543                         (mm-read-coding-system "Charset to decode: "))
2544                        (ctl
2545                         (mail-content-type-get ctl 'charset)))
2546               format (and ctl (mail-content-type-get ctl 'format)))
2547         (when cte
2548           (setq cte (mail-header-strip cte)))
2549         (if (and ctl (not (string-match "/" (car ctl))))
2550             (setq ctl nil))
2551         (goto-char (point-max)))
2552       (forward-line 1)
2553       (save-restriction
2554         (narrow-to-region (point) (point-max))
2555         (when (and (eq mail-parse-charset 'gnus-decoded)
2556                    (eq (mm-body-7-or-8) '8bit))
2557           ;; The text code could have been decoded.
2558           (setq charset mail-parse-charset))
2559         (when (and (or (not ctl)
2560                        (equal (car ctl) "text/plain"))
2561                    (not format)) ;; article with format will decode later.
2562           (mm-decode-body
2563            charset (and cte (intern (downcase
2564                                      (gnus-strip-whitespace cte))))
2565            (car ctl)))))))
2566
2567 (defun article-decode-encoded-words ()
2568   "Remove encoded-word encoding from headers."
2569   (let ((inhibit-point-motion-hooks t)
2570         (mail-parse-charset gnus-newsgroup-charset)
2571         (mail-parse-ignored-charsets
2572          (save-excursion (condition-case nil
2573                              (set-buffer gnus-summary-buffer)
2574                            (error))
2575                          gnus-newsgroup-ignored-charsets))
2576         (inhibit-read-only t)
2577         end start)
2578     (goto-char (point-min))
2579     (when (search-forward "\n\n" nil 'move)
2580       (forward-line -1))
2581     (setq end (point))
2582     (while (not (bobp))
2583       (while (progn
2584                (forward-line -1)
2585                (and (not (bobp))
2586                     (memq (char-after) '(?\t ? )))))
2587       (setq start (point))
2588       (if (looking-at "\
2589 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2590 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2591           (funcall gnus-decode-address-function start end)
2592         (funcall gnus-decode-header-function start end))
2593       (goto-char (setq end start)))))
2594
2595 (defun article-decode-group-name ()
2596   "Decode group names in Newsgroups, Followup-To and Xref headers."
2597   (let ((inhibit-point-motion-hooks t)
2598         (inhibit-read-only t)
2599         (method (gnus-find-method-for-group gnus-newsgroup-name))
2600         regexp)
2601     (when (and (or gnus-group-name-charset-method-alist
2602                    gnus-group-name-charset-group-alist)
2603                (gnus-buffer-live-p gnus-original-article-buffer))
2604       (save-restriction
2605         (article-narrow-to-head)
2606         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2607           (with-current-buffer gnus-original-article-buffer
2608             (goto-char (point-min)))
2609           (setq regexp (concat "^" header
2610                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2611           (while (re-search-forward regexp nil t)
2612             (replace-match (save-match-data
2613                              (gnus-decode-newsgroups
2614                               ;; XXX how to use data in article buffer?
2615                               (with-current-buffer gnus-original-article-buffer
2616                                 (re-search-forward regexp nil t)
2617                                 (match-string 1))
2618                               gnus-newsgroup-name method))
2619                            t t nil 1))
2620           (goto-char (point-min)))))))
2621
2622 (autoload 'idna-to-unicode "idna")
2623
2624 (defun article-decode-idna-rhs ()
2625   "Decode IDNA strings in RHS in various headers in current buffer.
2626 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2627 Mail-Reply-To: and Mail-Followup-To:."
2628   (when gnus-use-idna
2629     (save-restriction
2630       (let ((inhibit-point-motion-hooks t)
2631             (inhibit-read-only t))
2632         (article-narrow-to-head)
2633         (goto-char (point-min))
2634         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2635           (let (ace unicode)
2636             (when (save-match-data
2637                     (and (setq ace (match-string 1))
2638                          (save-excursion
2639                            (and (re-search-backward "^[^ \t]" nil t)
2640                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2641                          (setq unicode (idna-to-unicode ace))))
2642               (unless (string= ace unicode)
2643                 (replace-match unicode nil nil nil 1)))))))))
2644
2645 (defun article-de-quoted-unreadable (&optional force read-charset)
2646   "Translate a quoted-printable-encoded article.
2647 If FORCE, decode the article whether it is marked as quoted-printable
2648 or not.
2649 If READ-CHARSET, ask for a coding system."
2650   (interactive (list 'force current-prefix-arg))
2651   (save-excursion
2652     (let ((inhibit-read-only t) type charset)
2653       (if (gnus-buffer-live-p gnus-original-article-buffer)
2654           (with-current-buffer gnus-original-article-buffer
2655             (setq type
2656                   (gnus-fetch-field "content-transfer-encoding"))
2657             (let* ((ct (gnus-fetch-field "content-type"))
2658                    (ctl (and ct (mail-header-parse-content-type ct))))
2659               (setq charset (and ctl
2660                                  (mail-content-type-get ctl 'charset)))
2661               (if (stringp charset)
2662                   (setq charset (intern (downcase charset)))))))
2663       (if read-charset
2664           (setq charset (mm-read-coding-system "Charset: " charset)))
2665       (unless charset
2666         (setq charset gnus-newsgroup-charset))
2667       (when (or force
2668                 (and type (let ((case-fold-search t))
2669                             (string-match "quoted-printable" type))))
2670         (article-goto-body)
2671         (quoted-printable-decode-region
2672          (point) (point-max) (mm-charset-to-coding-system charset nil t))))))
2673
2674 (defun article-de-base64-unreadable (&optional force read-charset)
2675   "Translate a base64 article.
2676 If FORCE, decode the article whether it is marked as base64 not.
2677 If READ-CHARSET, ask for a coding system."
2678   (interactive (list 'force current-prefix-arg))
2679   (save-excursion
2680     (let ((inhibit-read-only t) type charset)
2681       (if (gnus-buffer-live-p gnus-original-article-buffer)
2682           (with-current-buffer gnus-original-article-buffer
2683             (setq type
2684                   (gnus-fetch-field "content-transfer-encoding"))
2685             (let* ((ct (gnus-fetch-field "content-type"))
2686                    (ctl (and ct (mail-header-parse-content-type ct))))
2687               (setq charset (and ctl
2688                                  (mail-content-type-get ctl 'charset)))
2689               (if (stringp charset)
2690                   (setq charset (intern (downcase charset)))))))
2691       (if read-charset
2692           (setq charset (mm-read-coding-system "Charset: " charset)))
2693       (unless charset
2694         (setq charset gnus-newsgroup-charset))
2695       (when (or force
2696                 (and type (let ((case-fold-search t))
2697                             (string-match "base64" type))))
2698         (article-goto-body)
2699         (save-restriction
2700           (narrow-to-region (point) (point-max))
2701           (base64-decode-region (point-min) (point-max))
2702           (mm-decode-coding-region
2703            (point-min) (point-max)
2704            (mm-charset-to-coding-system charset nil t)))))))
2705
2706 (eval-when-compile
2707   (require 'rfc1843))
2708
2709 (defun article-decode-HZ ()
2710   "Translate a HZ-encoded article."
2711   (interactive)
2712   (require 'rfc1843)
2713   (save-excursion
2714     (let ((inhibit-read-only t))
2715       (rfc1843-decode-region (point-min) (point-max)))))
2716
2717 (defun article-unsplit-urls ()
2718   "Remove the newlines that some other mailers insert into URLs."
2719   (interactive)
2720   (save-excursion
2721     (let ((inhibit-read-only t))
2722       (goto-char (point-min))
2723       (while (re-search-forward
2724               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2725         (replace-match "\\1\\3" t)))
2726     (when (gmm-called-interactively-p 'any)
2727       (gnus-treat-article nil))))
2728
2729 (defun article-wash-html ()
2730   "Format an HTML article."
2731   (interactive)
2732   (let ((handles nil)
2733         (buffer-read-only nil))
2734     (when (gnus-buffer-live-p gnus-original-article-buffer)
2735       (with-current-buffer gnus-original-article-buffer
2736         (setq handles (mm-dissect-buffer t t))))
2737     (article-goto-body)
2738     (delete-region (point) (point-max))
2739     (mm-enable-multibyte)
2740     (mm-inline-text-html handles)))
2741
2742 (defvar gnus-article-browse-html-temp-list nil
2743   "List of temporary files created by `gnus-article-browse-html-parts'.
2744 Internal variable.")
2745
2746 (defcustom gnus-article-browse-delete-temp 'ask
2747   "What to do with temporary files from `gnus-article-browse-html-parts'.
2748 If nil, don't delete temporary files.  If it is t, delete them on
2749 exit from the summary buffer.  If it is the symbol `file', query
2750 on each file, if it is `ask' ask once when exiting from the
2751 summary buffer."
2752   :group 'gnus-article
2753   :version "23.1" ;; No Gnus
2754   :type '(choice (const :tag "Don't delete" nil)
2755                  (const :tag "Don't ask" t)
2756                  (const :tag "Ask" ask)
2757                  (const :tag "Ask for each file" file)))
2758
2759 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2760
2761 (defun gnus-article-browse-delete-temp-files (&optional how)
2762   "Delete temp-files created by `gnus-article-browse-html-parts'."
2763   (when (and gnus-article-browse-html-temp-list
2764              (progn
2765                (or how (setq how gnus-article-browse-delete-temp))
2766                (if (eq how 'ask)
2767                    (let ((files (length gnus-article-browse-html-temp-list)))
2768                      (or (gnus-y-or-n-p
2769                           (if (= files 1)
2770                               "Delete the temporary HTML file? "
2771                             (format "Delete all %s temporary HTML files? "
2772                                     files)))
2773                          (setq gnus-article-browse-html-temp-list nil)))
2774                  how)))
2775     (dolist (file gnus-article-browse-html-temp-list)
2776       (cond ((file-directory-p file)
2777              (when (or (not (eq how 'file))
2778                        (gnus-y-or-n-p
2779                         (format
2780                          "Delete temporary HTML file(s) in directory `%s'? "
2781                          (file-name-as-directory file))))
2782                (gnus-delete-directory file)))
2783             ((file-exists-p file)
2784              (when (or (not (eq how 'file))
2785                        (gnus-y-or-n-p
2786                         (format "Delete temporary HTML file `%s'? " file)))
2787                (delete-file file)))))
2788     ;; Also remove file from the list when not deleted or if file doesn't
2789     ;; exist anymore.
2790     (setq gnus-article-browse-html-temp-list nil))
2791   gnus-article-browse-html-temp-list)
2792
2793 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2794   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2795 Return file name."
2796   (save-match-data
2797     (let (file type)
2798       (catch 'found
2799         (dolist (handle handles)
2800           (cond
2801            ((not (listp handle)))
2802            ;; Exclude broken handles that `gnus-summary-enter-digest-group'
2803            ;; may create.
2804            ((not (or (bufferp (car handle)) (stringp (car handle)))))
2805            ((equal (mm-handle-media-supertype handle) "multipart")
2806             (when (setq file (gnus-article-browse-html-save-cid-content
2807                               cid handle directory))
2808               (throw 'found file)))
2809            ((equal (concat "<" cid ">") (mm-handle-id handle))
2810             (setq file
2811                   (expand-file-name
2812                    (or (mm-handle-filename handle)
2813                        (concat
2814                         (make-temp-name "cid")
2815                         (car (rassoc (car (mm-handle-type handle))
2816                                      mailcap-mime-extensions))))
2817                    directory))
2818             (mm-save-part-to-file handle file)
2819             (throw 'found file))))))))
2820
2821 (defun gnus-article-browse-html-parts (list &optional header)
2822   "View all \"text/html\" parts from LIST.
2823 Recurse into multiparts.  The optional HEADER that should be a decoded
2824 message header will be added to the bodies of the \"text/html\" parts."
2825   ;; Internal function used by `gnus-article-browse-html-article'.
2826   (let (type file charset content cid-dir tmp-file showed)
2827     ;; Find and show the html-parts.
2828     (dolist (handle list)
2829       ;; If HTML, show it:
2830       (cond ((not (listp handle)))
2831             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2832                  (and (equal (car type) "message/external-body")
2833                       (or header
2834                           (setq file (mm-handle-filename handle)))
2835                       (or (mm-handle-cache handle)
2836                           (condition-case code
2837                               (progn (mm-extern-cache-contents handle) t)
2838                             (error
2839                              (gnus-message 3 "%s" (error-message-string code))
2840                              (when (>= gnus-verbose 3) (sit-for 2))
2841                              nil)))
2842                       (progn
2843                         (setq handle (mm-handle-cache handle)
2844                               type (mm-handle-type handle))
2845                         (equal (car type) "text/html"))))
2846              (setq charset (mail-content-type-get type 'charset)
2847                    content (mm-get-part handle))
2848              (with-temp-buffer
2849                (if (eq charset 'gnus-decoded)
2850                    (mm-enable-multibyte)
2851                  (mm-disable-multibyte))
2852                (insert content)
2853                ;; resolve cid contents
2854                (let ((case-fold-search t)
2855                      cid-file)
2856                  (goto-char (point-min))
2857                  (while (re-search-forward "\
2858 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2859                                            nil t)
2860                    (unless cid-dir
2861                      (setq cid-dir (mm-make-temp-file "cid" t))
2862                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2863                    (setq file nil
2864                          content nil)
2865                    (when (setq cid-file
2866                                (gnus-article-browse-html-save-cid-content
2867                                 (match-string 2)
2868                                 (with-current-buffer gnus-article-buffer
2869                                   gnus-article-mime-handles)
2870                                 cid-dir))
2871                      (when (eq system-type 'cygwin)
2872                        (setq cid-file
2873                              (concat "/" (substring
2874                                           (with-output-to-string
2875                                             (call-process "cygpath" nil
2876                                                           standard-output
2877                                                           nil "-m" cid-file))
2878                                           0 -1))))
2879                      (replace-match (concat "file://" cid-file)
2880                                     nil nil nil 1))))
2881                (unless content (setq content (buffer-string))))
2882              (when (or charset header (not file))
2883                (setq tmp-file (mm-make-temp-file
2884                                ;; Do we need to care for 8.3 filenames?
2885                                "mm-" nil ".html")))
2886              ;; Add a meta html tag to specify charset and a header.
2887              (cond
2888               (header
2889                (let (title eheader body hcharset coding)
2890                  (with-temp-buffer
2891                    (mm-enable-multibyte)
2892                    (setq case-fold-search t)
2893                    (insert header "\n")
2894                    (setq title (message-fetch-field "subject"))
2895                    (goto-char (point-min))
2896                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|\\(&\\)\\|\n"
2897                                              nil t)
2898                      (replace-match (cond ((match-beginning 1) "&lt;")
2899                                           ((match-beginning 2) "&gt;")
2900                                           ((match-beginning 3) "&amp;")
2901                                           (t "<br>\n"))))
2902                    (goto-char (point-min))
2903                    (while (re-search-forward "^[\t ]+" nil t)
2904                      (dotimes (i (prog1
2905                                      (current-column)
2906                                    (delete-region (match-beginning 0)
2907                                                   (match-end 0))))
2908                        (insert "&nbsp;")))
2909                    (goto-char (point-min))
2910                    (insert "<div align=\"left\">\n")
2911                    (goto-char (point-max))
2912                    (insert "</div>\n<hr>\n")
2913                    ;; We have to examine charset one by one since
2914                    ;; charset specified in parts might be different.
2915                    (if (eq charset 'gnus-decoded)
2916                        (setq charset 'utf-8
2917                              eheader (mm-encode-coding-string (buffer-string)
2918                                                               charset)
2919                              title (when title
2920                                      (mm-encode-coding-string title charset))
2921                              body (mm-encode-coding-string content charset))
2922                      (setq hcharset (mm-find-mime-charset-region (point-min)
2923                                                                  (point-max)))
2924                      (cond ((= (length hcharset) 1)
2925                             (setq hcharset (car hcharset)
2926                                   coding (mm-charset-to-coding-system
2927                                           hcharset nil t)))
2928                            ((> (length hcharset) 1)
2929                             (setq hcharset 'utf-8
2930                                   coding hcharset)))
2931                      (if coding
2932                          (if charset
2933                              (progn
2934                                (setq body
2935                                      (mm-charset-to-coding-system charset
2936                                                                   nil t))
2937                                (if (eq coding body)
2938                                    (setq eheader (mm-encode-coding-string
2939                                                   (buffer-string) coding)
2940                                          title (when title
2941                                                  (mm-encode-coding-string
2942                                                   title coding))
2943                                          body content)
2944                                  (setq charset 'utf-8
2945                                        eheader (mm-encode-coding-string
2946                                                 (buffer-string) charset)
2947                                        title (when title
2948                                                (mm-encode-coding-string
2949                                                 title charset))
2950                                        body (mm-encode-coding-string
2951                                              (mm-decode-coding-string
2952                                               content body)
2953                                              charset))))
2954                            (setq charset hcharset
2955                                  eheader (mm-encode-coding-string
2956                                           (buffer-string) coding)
2957                                  title (when title
2958                                          (mm-encode-coding-string
2959                                           title coding))
2960                                  body content))
2961                        (setq eheader (mm-string-as-unibyte (buffer-string))
2962                              body content)))
2963                    (erase-buffer)
2964                    (mm-disable-multibyte)
2965                    (insert body)
2966                    (when charset
2967                      (mm-add-meta-html-tag handle charset t))
2968                    (when title
2969                      (goto-char (point-min))
2970                      (unless (search-forward "<title>" nil t)
2971                        (re-search-forward "<head>\\s-*" nil t)
2972                        (insert "<title>" title "</title>\n")))
2973                    (goto-char (point-min))
2974                    (or (re-search-forward
2975                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
2976                        (re-search-forward
2977                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
2978                    (insert eheader)
2979                    (mm-write-region (point-min) (point-max)
2980                                     tmp-file nil nil nil 'binary t))))
2981               (charset
2982                (mm-with-unibyte-buffer
2983                  (insert (if (eq charset 'gnus-decoded)
2984                              (mm-encode-coding-string content
2985                                                       (setq charset 'utf-8))
2986                            content))
2987                  (if (or (mm-add-meta-html-tag handle charset)
2988                          (not file))
2989                      (mm-write-region (point-min) (point-max)
2990                                       tmp-file nil nil nil 'binary t)
2991                    (setq tmp-file nil))))
2992               (tmp-file
2993                (mm-save-part-to-file handle tmp-file)))
2994              (when tmp-file
2995                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
2996              (add-hook 'gnus-summary-prepare-exit-hook
2997                        'gnus-article-browse-delete-temp-files)
2998              (add-hook 'gnus-exit-gnus-hook
2999                        (lambda  ()
3000                          (gnus-article-browse-delete-temp-files t)))
3001              ;; FIXME: Warn if there's an <img> tag?
3002              (browse-url-of-file (or tmp-file (expand-file-name file)))
3003              (setq showed t))
3004             ;; If multipart, recurse
3005             ((equal (mm-handle-media-supertype handle) "multipart")
3006              (when (gnus-article-browse-html-parts handle header)
3007                (setq showed t)))
3008             ((equal (mm-handle-media-type handle) "message/rfc822")
3009              (mm-with-multibyte-buffer
3010                (mm-insert-part handle)
3011                (setq handle (mm-dissect-buffer t t))
3012                (when (and (bufferp (car handle))
3013                           (stringp (car (mm-handle-type handle))))
3014                  (setq handle (list handle)))
3015                (when header
3016                  (article-decode-encoded-words)
3017                  (let ((gnus-visible-headers
3018                         (or (get 'gnus-visible-headers 'standard-value)
3019                             gnus-visible-headers)))
3020                    (article-hide-headers))
3021                  (goto-char (point-min))
3022                  (search-forward "\n\n" nil 'move)
3023                  (skip-chars-backward "\t\n ")
3024                  (setq header (buffer-substring (point-min) (point)))))
3025              (when (prog1
3026                        (gnus-article-browse-html-parts handle header)
3027                      (mm-destroy-parts handle))
3028                (setq showed t)))))
3029     showed))
3030
3031 (defun gnus-article-browse-html-article (&optional arg)
3032   "View \"text/html\" parts of the current article with a WWW browser.
3033 Inline images embedded in a message using the cid scheme, as they are
3034 generally considered to be safe, will be processed properly.
3035 The message header is added to the beginning of every html part unless
3036 the prefix argument ARG is given.
3037
3038 Warning: Spammers use links to images (using the http scheme) in HTML
3039 articles to verify whether you have read the message.  As
3040 `gnus-article-browse-html-article' passes the HTML content to the
3041 browser without eliminating these \"web bugs\" you should only
3042 use it for mails from trusted senders.
3043
3044 If you always want to display HTML parts in the browser, set
3045 `mm-text-html-renderer' to nil.
3046
3047 This command creates temporary files to pass HTML contents including
3048 images if any to the browser, and deletes them when exiting the group
3049 \(if you want)."
3050   ;; Cf. `mm-w3m-safe-url-regexp'
3051   (interactive "P")
3052   (if arg
3053       (gnus-summary-show-article)
3054     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3055                                     gnus-visible-headers))
3056           ;; As we insert a <hr>, there's no need for the body boundary.
3057           (gnus-treat-body-boundary nil))
3058       (gnus-summary-show-article)))
3059   (with-current-buffer gnus-article-buffer
3060     (let ((header (unless arg
3061                     (save-restriction
3062                       (widen)
3063                       (buffer-substring-no-properties
3064                        (goto-char (point-min))
3065                        (if (search-forward "\n\n" nil t)
3066                            (match-beginning 0)
3067                          (goto-char (point-max))
3068                          (skip-chars-backward "\t\n ")
3069                          (point))))))
3070           parts)
3071       (set-buffer gnus-original-article-buffer)
3072       (setq parts (mm-dissect-buffer t t))
3073       ;; If singlepart, enforce a list.
3074       (when (and (bufferp (car parts))
3075                  (stringp (car (mm-handle-type parts))))
3076         (setq parts (list parts)))
3077       ;; Process the list
3078       (unless (gnus-article-browse-html-parts parts header)
3079         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3080       (mm-destroy-parts parts)
3081       (unless arg
3082         (gnus-summary-show-article)))))
3083
3084 (defun article-hide-list-identifiers ()
3085   "Remove list identifies from the Subject header.
3086 The `gnus-list-identifiers' variable specifies what to do."
3087   (interactive)
3088   (let ((inhibit-point-motion-hooks t)
3089         (regexp (gnus-group-get-list-identifiers gnus-newsgroup-name))
3090         (inhibit-read-only t))
3091     (when regexp
3092       (save-excursion
3093         (save-restriction
3094           (article-narrow-to-head)
3095           (goto-char (point-min))
3096           (while (re-search-forward
3097                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3098                   nil t)
3099             (delete-region (match-beginning 2) (match-end 0))
3100             (beginning-of-line))
3101           (when (re-search-forward
3102                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3103             (delete-region (match-beginning 1) (match-end 1))))))))
3104
3105 (defun article-hide-pem (&optional arg)
3106   "Toggle hiding of any PEM headers and signatures in the current article.
3107 If given a negative prefix, always show; if given a positive prefix,
3108 always hide."
3109   (interactive (gnus-article-hidden-arg))
3110   (unless (gnus-article-check-hidden-text 'pem arg)
3111     (save-excursion
3112       (let ((inhibit-read-only t) end)
3113         (goto-char (point-min))
3114         ;; Hide the horrendously ugly "header".
3115         (when (and (search-forward
3116                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3117                     nil t)
3118                    (setq end (1+ (match-beginning 0))))
3119           (gnus-add-wash-type 'pem)
3120           (gnus-article-hide-text-type
3121            end
3122            (if (search-forward "\n\n" nil t)
3123                (match-end 0)
3124              (point-max))
3125            'pem)
3126           ;; Hide the trailer as well
3127           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3128                                 nil t)
3129             (gnus-article-hide-text-type
3130              (match-beginning 0) (match-end 0) 'pem)))))))
3131
3132 (defun article-strip-banner ()
3133   "Strip the banners specified by the `banner' group parameter and by
3134 `gnus-article-address-banner-alist'."
3135   (interactive)
3136   (save-excursion
3137     (save-restriction
3138       (let ((inhibit-point-motion-hooks t))
3139         (when (gnus-parameter-banner gnus-newsgroup-name)
3140           (article-really-strip-banner
3141            (gnus-parameter-banner gnus-newsgroup-name)))
3142         (when gnus-article-address-banner-alist
3143           ;; Note that the From header is decoded here, so it is
3144           ;; required that the *-extract-address-components function
3145           ;; supports non-ASCII text.
3146           (let ((from (save-restriction
3147                         (widen)
3148                         (article-narrow-to-head)
3149                         (mail-fetch-field "from"))))
3150             (when (and from
3151                        (setq from
3152                              (cadr (funcall gnus-extract-address-components
3153                                             from))))
3154               (catch 'found
3155                 (dolist (pair gnus-article-address-banner-alist)
3156                   (when (string-match (car pair) from)
3157                     (throw 'found
3158                            (article-really-strip-banner (cdr pair)))))))))))))
3159
3160 (defun article-really-strip-banner (banner)
3161   "Strip the banner specified by the argument."
3162   (save-excursion
3163     (save-restriction
3164       (let ((inhibit-point-motion-hooks t)
3165             (gnus-signature-limit nil)
3166             (inhibit-read-only t))
3167         (article-goto-body)
3168         (cond
3169          ((eq banner 'signature)
3170           (when (gnus-article-narrow-to-signature)
3171             (widen)
3172             (forward-line -1)
3173             (delete-region (point) (point-max))))
3174          ((symbolp banner)
3175           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3176               (while (re-search-forward banner nil t)
3177                 (delete-region (match-beginning 0) (match-end 0)))))
3178          ((stringp banner)
3179           (while (re-search-forward banner nil t)
3180             (delete-region (match-beginning 0) (match-end 0)))))))))
3181
3182 (defun article-babel ()
3183   "Translate article using an online translation service."
3184   (interactive)
3185   (require 'babel)
3186   (gnus-with-article-buffer
3187     (when (article-goto-body)
3188       (let* ((start (point))
3189              (end (point-max))
3190              (orig (buffer-substring start end))
3191              (trans (babel-as-string orig)))
3192         (save-restriction
3193           (narrow-to-region start end)
3194           (delete-region start end)
3195           (insert trans))))))
3196
3197 (defun article-hide-signature (&optional arg)
3198   "Hide the signature in the current article.
3199 If given a negative prefix, always show; if given a positive prefix,
3200 always hide."
3201   (interactive (gnus-article-hidden-arg))
3202   (unless (gnus-article-check-hidden-text 'signature arg)
3203     (save-excursion
3204       (save-restriction
3205         (let ((inhibit-read-only t))
3206           (when (gnus-article-narrow-to-signature)
3207             (gnus-article-hide-text-type
3208              (point-min) (point-max) 'signature))))))
3209   (gnus-set-mode-line 'article))
3210
3211 (defun article-strip-headers-in-body ()
3212   "Strip offensive headers from bodies."
3213   (interactive)
3214   (save-excursion
3215     (article-goto-body)
3216     (let ((case-fold-search t))
3217       (when (looking-at "x-no-archive:")
3218         (gnus-delete-line)))))
3219
3220 (defun article-strip-leading-blank-lines ()
3221   "Remove all blank lines from the beginning of the article."
3222   (interactive)
3223   (save-excursion
3224     (let ((inhibit-point-motion-hooks t)
3225           (inhibit-read-only t))
3226       (when (article-goto-body)
3227         (while (and (not (eobp))
3228                     (looking-at "[ \t]*$"))
3229           (gnus-delete-line))))))
3230
3231 (defun article-narrow-to-head ()
3232   "Narrow the buffer to the head of the message.
3233 Point is left at the beginning of the narrowed-to region."
3234   (narrow-to-region
3235    (goto-char (point-min))
3236    (cond
3237     ;; Absolutely no headers displayed.
3238     ((looking-at "\n")
3239      (point))
3240     ;; Normal headers.
3241     ((search-forward "\n\n" nil 1)
3242      (1- (point)))
3243     ;; Nothing but headers.
3244     (t
3245      (point-max))))
3246   (goto-char (point-min)))
3247
3248 (defun article-goto-body ()
3249   "Place point at the start of the body."
3250   (goto-char (point-min))
3251   (cond
3252    ;; This variable is only bound when dealing with separate
3253    ;; MIME body parts.
3254    (article-goto-body-goes-to-point-min-p
3255     t)
3256    ((search-forward "\n\n" nil t)
3257     t)
3258    (t
3259     (goto-char (point-max))
3260     nil)))
3261
3262 (defun article-strip-multiple-blank-lines ()
3263   "Replace consecutive blank lines with one empty line."
3264   (interactive)
3265   (save-excursion
3266     (let ((inhibit-point-motion-hooks t)
3267           (inhibit-read-only t))
3268       ;; First make all blank lines empty.
3269       (article-goto-body)
3270       (while (re-search-forward "^[ \t]+$" nil t)
3271         (unless (gnus-annotation-in-region-p
3272                  (match-beginning 0) (match-end 0))
3273           (replace-match "" nil t)))
3274       ;; Then replace multiple empty lines with a single empty line.
3275       (article-goto-body)
3276       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3277         (unless (gnus-annotation-in-region-p
3278                  (match-beginning 0) (match-end 0))
3279           (delete-region (match-beginning 1) (match-end 1)))))))
3280
3281 (defun article-strip-leading-space ()
3282   "Remove all white space from the beginning of the lines in the article."
3283   (interactive)
3284   (save-excursion
3285     (let ((inhibit-point-motion-hooks t)
3286           (inhibit-read-only t))
3287       (article-goto-body)
3288       (while (re-search-forward "^[ \t]+" nil t)
3289         (replace-match "" t t)))))
3290
3291 (defun article-strip-trailing-space ()
3292   "Remove all white space from the end of the lines in the article."
3293   (interactive)
3294   (save-excursion
3295     (let ((inhibit-point-motion-hooks t)
3296           (inhibit-read-only t))
3297       (article-goto-body)
3298       (while (re-search-forward "[ \t]+$" nil t)
3299         (replace-match "" t t)))))
3300
3301 (defun article-strip-blank-lines ()
3302   "Strip leading, trailing and multiple blank lines."
3303   (interactive)
3304   (article-strip-leading-blank-lines)
3305   (article-remove-trailing-blank-lines)
3306   (article-strip-multiple-blank-lines))
3307
3308 (defun article-strip-all-blank-lines ()
3309   "Strip all blank lines."
3310   (interactive)
3311   (save-excursion
3312     (let ((inhibit-point-motion-hooks t)
3313           (inhibit-read-only t))
3314       (article-goto-body)
3315       (while (re-search-forward "^[ \t]*\n" nil t)
3316         (replace-match "" t t)))))
3317
3318 (defun gnus-article-narrow-to-signature ()
3319   "Narrow to the signature; return t if a signature is found, else nil."
3320   (let ((inhibit-point-motion-hooks t))
3321     (when (gnus-article-search-signature)
3322       (forward-line 1)
3323       ;; Check whether we have some limits to what we consider
3324       ;; to be a signature.
3325       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3326                       (list gnus-signature-limit)))
3327             limit limited)
3328         (while (setq limit (pop limits))
3329           (if (or (and (integerp limit)
3330                        (< (- (point-max) (point)) limit))
3331                   (and (floatp limit)
3332                        (< (count-lines (point) (point-max)) limit))
3333                   (and (functionp limit)
3334                        (funcall limit))
3335                   (and (stringp limit)
3336                        (not (re-search-forward limit nil t))))
3337               ()                        ; This limit did not succeed.
3338             (setq limited t
3339                   limits nil)))
3340         (unless limited
3341           (narrow-to-region (point) (point-max))
3342           t)))))
3343
3344 (defun gnus-article-search-signature ()
3345   "Search the current buffer for the signature separator.
3346 Put point at the beginning of the signature separator."
3347   (let ((cur (point)))
3348     (goto-char (point-max))
3349     (if (if (stringp gnus-signature-separator)
3350             (re-search-backward gnus-signature-separator nil t)
3351           (let ((seps gnus-signature-separator))
3352             (while (and seps
3353                         (not (re-search-backward (car seps) nil t)))
3354               (pop seps))
3355             seps))
3356         t
3357       (goto-char cur)
3358       nil)))
3359
3360 (defun gnus-article-hidden-arg ()
3361   "Return the current prefix arg as a number, or 0 if no prefix."
3362   (list (if current-prefix-arg
3363             (prefix-numeric-value current-prefix-arg)
3364           0)))
3365
3366 (defun gnus-article-check-hidden-text (type arg)
3367   "Return nil if hiding is necessary.
3368 Arg can be nil or a number.  nil and positive means hide, negative
3369 means show, 0 means toggle."
3370   (save-excursion
3371     (save-restriction
3372       (let ((hide (gnus-article-hidden-text-p type)))
3373         (cond
3374          ((or (null arg)
3375               (> arg 0))
3376           nil)
3377          ((< arg 0)
3378           (gnus-article-show-hidden-text type)
3379           t)
3380          (t
3381           (if (eq hide 'hidden)
3382               (progn
3383                 (gnus-article-show-hidden-text type)
3384                 t)
3385             nil)))))))
3386
3387 (defun gnus-article-hidden-text-p (type)
3388   "Say whether the current buffer contains hidden text of type TYPE."
3389   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3390     (while (and pos
3391                 (not (get-text-property pos 'invisible))
3392                 (not (get-text-property pos 'dummy-invisible)))
3393       (setq pos
3394             (text-property-any (1+ pos) (point-max) 'article-type type)))
3395     (if pos
3396         'hidden
3397       nil)))
3398
3399 (defun gnus-article-show-hidden-text (type &optional dummy)
3400   "Show all hidden text of type TYPE.
3401 Originally it is hide instead of DUMMY."
3402   (let ((inhibit-read-only t)
3403         (inhibit-point-motion-hooks t))
3404     (gnus-remove-text-properties-when
3405      'article-type type
3406      (point-min) (point-max)
3407      (cons 'article-type (cons type
3408                                gnus-hidden-properties)))
3409     (gnus-delete-wash-type type)))
3410
3411 (defconst article-time-units
3412   `((year . ,(* 365.25 24 60 60))
3413     (week . ,(* 7 24 60 60))
3414     (day . ,(* 24 60 60))
3415     (hour . ,(* 60 60))
3416     (minute . 60)
3417     (second . 1))
3418   "Mapping from time units to seconds.")
3419
3420 (defun gnus-article-forward-header ()
3421   "Move point to the start of the next header.
3422 If the current header is a continuation header, this can be several
3423 lines forward."
3424   (let ((ended nil))
3425     (while (not ended)
3426       (forward-line 1)
3427       (if (looking-at "[ \t]+[^ \t]")
3428           (forward-line 1)
3429         (setq ended t)))))
3430
3431 (defun article-treat-date ()
3432   (article-date-ut (if (gnus-buffer-live-p gnus-summary-buffer)
3433                        (with-current-buffer gnus-summary-buffer
3434                          gnus-article-date-headers)
3435                      gnus-article-date-headers)
3436                    t))
3437
3438 (defun article-date-ut (&optional type highlight date-position)
3439   "Convert DATE date to TYPE in the current article.
3440 The default type is `ut'.  See `gnus-article-date-headers' for
3441 possible values."
3442   (interactive (list 'ut t))
3443   (let* ((case-fold-search t)
3444          (inhibit-read-only t)
3445          (inhibit-point-motion-hooks t)
3446          (first t)
3447          (visible-date (mail-fetch-field "Date"))
3448          pos date bface eface)
3449     (save-excursion
3450       (if date-position
3451           (progn
3452             (goto-char date-position)
3453             (setq date (get-text-property (point) 'original-date))
3454             (when (looking-at "[^:]+:[\t ]*")
3455               (setq bface (get-text-property (match-beginning 0) 'face)
3456                     eface (get-text-property (match-end 0) 'face)))
3457             (delete-region (point)
3458                            (progn
3459                              (gnus-article-forward-header)
3460                              (point)))
3461             (article-transform-date date type bface eface))
3462         (save-restriction
3463           (widen)
3464           (goto-char (point-min))
3465           (while (or (get-text-property (setq pos (point)) 'original-date)
3466                      (and (setq pos (next-single-property-change
3467                                      (point) 'original-date))
3468                           (goto-char pos)))
3469             (narrow-to-region pos (if (search-forward "\n\n" nil t)
3470                                       (1+ (match-beginning 0))
3471                                     (point-max)))
3472             (while (setq pos (text-property-not-all pos (point-max)
3473                                                     'gnus-date-type nil))
3474               (setq date (get-text-property pos 'original-date))
3475               (goto-char pos)
3476               (when (looking-at "[^:]+:[\t ]*")
3477                 (setq bface (get-text-property (match-beginning 0) 'face)
3478                       eface (get-text-property (match-end 0) 'face)))
3479               (delete-region pos (or (text-property-any pos (point-max)
3480                                                         'gnus-date-type nil)
3481                                      (point-max))))
3482             (unless date ;; the 1st time
3483               (goto-char (point-min))
3484               (while (re-search-forward "^Date:[\t ]*" nil t)
3485                 (setq date (get-text-property (match-beginning 0)
3486                                               'original-date)
3487                       bface (get-text-property (match-beginning 0) 'face)
3488                       eface (get-text-property (match-end 0) 'face))
3489                 (delete-region (point-at-bol) (progn
3490                                                 (gnus-article-forward-header)
3491                                                 (point)))))
3492             (when (and (not date)
3493                        visible-date)
3494               (setq date visible-date))
3495             (when date
3496               (article-transform-date date type bface eface))
3497             (goto-char (point-max))
3498             (widen)))))))
3499
3500 (defun article-transform-date (date type bface eface)
3501   (dolist (this-type (cond
3502                       ((null type)
3503                        (list 'ut))
3504                       ((atom type)
3505                        (list type))
3506                       (t
3507                        type)))
3508     (goto-char
3509      (prog1
3510          (point)
3511        (add-text-properties
3512         (point)
3513         (progn
3514           (insert (article-make-date-line date (or this-type 'ut)) "\n")
3515           (point))
3516         (list 'original-date date 'gnus-date-type this-type))))
3517     ;; Do highlighting.
3518     (when (looking-at
3519            "\\([^:]+:\\)[\t ]*\\(\\(?:[^\t\n ]+[\t ]+\\)*[^\t\n ]+\\)?")
3520       (put-text-property (match-beginning 1) (match-end 1) 'face bface)
3521       (when (match-beginning 2)
3522         (put-text-property (match-beginning 2) (match-end 2) 'face eface))
3523       (while (and (zerop (forward-line 1))
3524                   (looking-at "[\t ]+\\(\\(?:[^\t\n ]+[\t ]+\\)*[^\t\n ]+\\)?"))
3525         (when (match-beginning 1)
3526           (put-text-property (match-beginning 1) (match-end 1) 'face eface))))))
3527
3528 (defun article-make-date-line (date type)
3529   "Return a DATE line of TYPE."
3530   (unless (memq type '(local ut original user-defined iso8601 lapsed english
3531                              combined-lapsed))
3532     (error "Unknown conversion type: %s" type))
3533   (condition-case ()
3534       (let ((time (ignore-errors (date-to-time date))))
3535         (cond
3536          ;; Convert to the local timezone.
3537          ((eq type 'local)
3538           (concat "Date: " (message-make-date time)))
3539          ;; Convert to Universal Time.
3540          ((eq type 'ut)
3541           (concat "Date: "
3542                   (substring
3543                    (message-make-date
3544                     (let* ((e (parse-time-string date))
3545                            (tm (apply 'encode-time e))
3546                            (ms (car tm))
3547                            (ls (- (cadr tm) (car (current-time-zone time)))))
3548                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3549                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3550                             (t (list ms ls)))))
3551                    0 -5)
3552                   "UT"))
3553          ;; Get the original date from the article.
3554          ((eq type 'original)
3555           (concat "Date: " (if (string-match "\n+$" date)
3556                                (substring date 0 (match-beginning 0))
3557                              date)))
3558          ;; Let the user define the format.
3559          ((eq type 'user-defined)
3560           (let ((format (or (condition-case nil
3561                                 (with-current-buffer gnus-summary-buffer
3562                                   gnus-article-time-format)
3563                               (error nil))
3564                             gnus-article-time-format)))
3565             (if (functionp format)
3566                 (funcall format time)
3567               (concat "Date: " (format-time-string format time)))))
3568          ;; ISO 8601.
3569          ((eq type 'iso8601)
3570           (let ((tz (car (current-time-zone time))))
3571             (concat
3572              "Date: "
3573              (format-time-string "%Y%m%dT%H%M%S" time)
3574              (format "%s%02d%02d"
3575                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3576                      (/ (% (abs tz) 3600) 60)))))
3577          ;; Do a lapsed format.
3578          ((eq type 'lapsed)
3579           (concat "Date: " (article-lapsed-string time)))
3580          ;; A combined date/lapsed format.