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