(auth-source-netrc-parse): Accept a number as the port spec, too.
[gnus] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Gnus
2
3 ;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 ;; For Emacs <22.2 and XEmacs.
28 (eval-and-compile
29   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
30 (eval-when-compile
31   (require 'cl))
32 (defvar tool-bar-map)
33 (defvar w3m-minor-mode-map)
34
35 (require 'gnus)
36 (require 'gnus-sum)
37 (require 'gnus-spec)
38 (require 'gnus-int)
39 (require 'gnus-win)
40 (require 'mm-bodies)
41 (require 'mail-parse)
42 (require 'mm-decode)
43 (require 'mm-view)
44 (require 'wid-edit)
45 (require 'mm-uu)
46 (require 'message)
47
48 (autoload 'gnus-msg-mail "gnus-msg" nil t)
49 (autoload 'gnus-button-mailto "gnus-msg")
50 (autoload 'gnus-button-reply "gnus-msg" nil t)
51 (autoload 'parse-time-string "parse-time" nil nil)
52 (autoload 'ansi-color-apply-on-region "ansi-color")
53 (autoload 'mm-url-insert-file-contents-external "mm-url")
54 (autoload 'mm-extern-cache-contents "mm-extern")
55
56 (defgroup gnus-article nil
57   "Article display."
58   :link '(custom-manual "(gnus)Article Buffer")
59   :group 'gnus)
60
61 (defgroup gnus-article-treat nil
62   "Treating article parts."
63   :link '(custom-manual "(gnus)Article Hiding")
64   :group 'gnus-article)
65
66 (defgroup gnus-article-hiding nil
67   "Hiding article parts."
68   :link '(custom-manual "(gnus)Article Hiding")
69   :group 'gnus-article)
70
71 (defgroup gnus-article-highlight nil
72   "Article highlighting."
73   :link '(custom-manual "(gnus)Article Highlighting")
74   :group 'gnus-article
75   :group 'gnus-visual)
76
77 (defgroup gnus-article-signature nil
78   "Article signatures."
79   :link '(custom-manual "(gnus)Article Signature")
80   :group 'gnus-article)
81
82 (defgroup gnus-article-headers nil
83   "Article headers."
84   :link '(custom-manual "(gnus)Hiding Headers")
85   :group 'gnus-article)
86
87 (defgroup gnus-article-washing nil
88   "Special commands on articles."
89   :link '(custom-manual "(gnus)Article Washing")
90   :group 'gnus-article)
91
92 (defgroup gnus-article-emphasis nil
93   "Fontisizing articles."
94   :link '(custom-manual "(gnus)Article Fontisizing")
95   :group 'gnus-article)
96
97 (defgroup gnus-article-saving nil
98   "Saving articles."
99   :link '(custom-manual "(gnus)Saving Articles")
100   :group 'gnus-article)
101
102 (defgroup gnus-article-mime nil
103   "Worshiping the MIME wonder."
104   :link '(custom-manual "(gnus)Using MIME")
105   :group 'gnus-article)
106
107 (defgroup gnus-article-buttons nil
108   "Pushable buttons in the article buffer."
109   :link '(custom-manual "(gnus)Article Buttons")
110   :group 'gnus-article)
111
112 (defgroup gnus-article-various nil
113   "Other article options."
114   :link '(custom-manual "(gnus)Misc Article")
115   :group 'gnus-article)
116
117 (defcustom gnus-ignored-headers
118   (mapcar
119    (lambda (header)
120      (concat "^" header ":"))
121    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
122      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
123      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
124      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
125      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
126      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
127      "X-Attribution" "X-Originating-IP" "Delivered-To"
128      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
129      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
130      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
131      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
132      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
133      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
134      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
135      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
136      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
137      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
138      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
139      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
140      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
141      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
142      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
143      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
144      "List-[A-Za-z]+" "X-Listprocessor-Version"
145      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
146      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
147      "X-Received" "Content-length" "X-precedence"
148      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
149      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
150      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
151      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
152      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
153      "X-Content-length" "X-Posting-Agent" "Original-Received"
154      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
155      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
156      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
157      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
158      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
159      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
160      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
161      "Envelope-Sender" "Envelope-Recipients"))
162   "*All headers that start with this regexp will be hidden.
163 This variable can also be a list of regexps of headers to be ignored.
164 If `gnus-visible-headers' is non-nil, this variable will be ignored."
165   :type '(choice :custom-show nil
166                  regexp
167                  (repeat regexp))
168   :group 'gnus-article-hiding)
169
170 (defcustom gnus-visible-headers
171   "^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:"
172   "*All headers that do not match this regexp will be hidden.
173 This variable can also be a list of regexp of headers to remain visible.
174 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
175   :type '(choice
176           (repeat :value-to-internal (lambda (widget value)
177                                        (custom-split-regexp-maybe value))
178                   :match (lambda (widget value)
179                            (or (stringp value)
180                                (widget-editable-list-match widget value)))
181                   regexp)
182           (const :tag "Use gnus-ignored-headers" nil)
183           regexp)
184   :group 'gnus-article-hiding)
185
186 (defcustom gnus-sorted-header-list
187   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
188     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
189   "*This variable is a list of regular expressions.
190 If it is non-nil, headers that match the regular expressions will
191 be placed first in the article buffer in the sequence specified by
192 this list."
193   :type '(repeat regexp)
194   :group 'gnus-article-hiding)
195
196 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
197   "Headers that are only to be displayed if they have interesting data.
198 Possible values in this list are:
199
200   'empty       Headers with no content.
201   'newsgroups  Newsgroup identical to Gnus group.
202   'to-address  To identical to To-address.
203   'to-list     To identical to To-list.
204   'cc-list     CC identical to To-list.
205   'followup-to Followup-to identical to Newsgroups.
206   'reply-to    Reply-to identical to From.
207   'date        Date less than four days old.
208   'long-to     To and/or Cc longer than 1024 characters.
209   'many-to     Multiple To and/or Cc."
210   :type '(set (const :tag "Headers with no content." empty)
211               (const :tag "Newsgroups identical to Gnus group." newsgroups)
212               (const :tag "To identical to To-address." to-address)
213               (const :tag "To identical to To-list." to-list)
214               (const :tag "CC identical to To-list." cc-list)
215               (const :tag "Followup-to identical to Newsgroups." followup-to)
216               (const :tag "Reply-to identical to From." reply-to)
217               (const :tag "Date less than four days old." date)
218               (const :tag "To and/or Cc longer than 1024 characters." long-to)
219               (const :tag "Multiple To and/or Cc headers." many-to))
220   :group 'gnus-article-hiding)
221
222 (defcustom gnus-article-skip-boring nil
223   "Skip over text that is not worth reading.
224 By default, if you set this t, then Gnus will display citations and
225 signatures, but will never scroll down to show you a page consisting
226 only of boring text.  Boring text is controlled by
227 `gnus-article-boring-faces'."
228   :version "22.1"
229   :type 'boolean
230   :group 'gnus-article-hiding)
231
232 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
233   "Regexp matching signature separator.
234 This can also be a list of regexps.  In that case, it will be checked
235 from head to tail looking for a separator.  Searches will be done from
236 the end of the buffer."
237   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
238                  (regexp)
239                  (repeat :tag "List of regexp" regexp))
240   :group 'gnus-article-signature)
241
242 (defcustom gnus-signature-limit nil
243   "Provide a limit to what is considered a signature.
244 If it is a number, no signature may not be longer (in characters) than
245 that number.  If it is a floating point number, no signature may be
246 longer (in lines) than that number.  If it is a function, the function
247 will be called without any parameters, and if it returns nil, there is
248 no signature in the buffer.  If it is a string, it will be used as a
249 regexp.  If it matches, the text in question is not a signature.
250
251 This can also be a list of the above values."
252   :type '(choice (const nil)
253                  (integer :value 200)
254                  (number :value 4.0)
255                  function
256                  (regexp :value ".*"))
257   :group 'gnus-article-signature)
258
259 (defcustom gnus-hidden-properties '(invisible t intangible t)
260   "Property list to use for hiding text."
261   :type 'sexp
262   :group 'gnus-article-hiding)
263
264 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
265 ;; frames in a session.
266 (defcustom gnus-article-x-face-command
267   (if (featurep 'xemacs)
268       (if (or (gnus-image-type-available-p 'xface)
269               (gnus-image-type-available-p 'pbm))
270           'gnus-display-x-face-in-from
271         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
272     (if (gnus-image-type-available-p 'pbm)
273         'gnus-display-x-face-in-from
274       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
275 display -"))
276   "*String or function to be executed to display an X-Face header.
277 If it is a string, the command will be executed in a sub-shell
278 asynchronously.  The compressed face will be piped to this command."
279   :type `(choice string
280                  (function-item gnus-display-x-face-in-from)
281                  function)
282   :version "21.1"
283   :group 'gnus-picon
284   :group 'gnus-article-washing)
285
286 (defcustom gnus-article-x-face-too-ugly nil
287   "Regexp matching posters whose face shouldn't be shown automatically."
288   :type '(choice regexp (const nil))
289   :group 'gnus-article-washing)
290
291 (defcustom gnus-article-banner-alist nil
292   "Banner alist for stripping.
293 For example,
294      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
295   :version "21.1"
296   :type '(repeat (cons symbol regexp))
297   :group 'gnus-article-washing)
298
299 (gnus-define-group-parameter
300  banner
301  :variable-document
302  "Alist of regexps (to match group names) and banner."
303  :variable-group gnus-article-washing
304  :parameter-type
305  '(choice :tag "Banner"
306           :value nil
307           (const :tag "Remove signature" signature)
308           (symbol :tag "Item in `gnus-article-banner-alist'" none)
309           regexp
310           (const :tag "None" nil))
311  :parameter-document
312  "If non-nil, specify how to remove `banners' from articles.
313
314 Symbol `signature' means to remove signatures delimited by
315 `gnus-signature-separator'.  Any other symbol is used to look up a
316 regular expression to match the banner in `gnus-article-banner-alist'.
317 A string is used as a regular expression to match the banner
318 directly.")
319
320 (defcustom gnus-article-address-banner-alist nil
321   "Alist of mail addresses and banners.
322 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
323 to match a mail address in the From: header, BANNER is one of a symbol
324 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
325 If ADDRESS matches author's mail address, it will remove things like
326 advertisements.  For example:
327
328 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
329 "
330   :type '(repeat
331           (cons
332            (regexp :tag "Address")
333            (choice :tag "Banner" :value nil
334                    (const :tag "Remove signature" signature)
335                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
336                    regexp
337                    (const :tag "None" nil))))
338   :version "22.1"
339   :group 'gnus-article-washing)
340
341 (defmacro gnus-emphasis-custom-with-format (&rest body)
342   `(let ((format "\
343 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
344 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
345      ,@body))
346
347 (defun gnus-emphasis-custom-value-to-external (value)
348   (gnus-emphasis-custom-with-format
349    (if (consp (car value))
350        (list (format format (car (car value)) (cdr (car value)))
351              2
352              (if (nth 1 value) 2 3)
353              (nth 2 value))
354      value)))
355
356 (defun gnus-emphasis-custom-value-to-internal (value)
357   (gnus-emphasis-custom-with-format
358    (let ((regexp (concat "\\`"
359                          (format (regexp-quote format)
360                                  "\\([^()]+\\)" "\\([^()]+\\)")
361                          "\\'"))
362          pattern)
363      (if (string-match regexp (setq pattern (car value)))
364          (list (cons (match-string 1 pattern) (match-string 2 pattern))
365                (= (nth 2 value) 2)
366                (nth 3 value))
367        value))))
368
369 (defcustom gnus-emphasis-alist
370   (let ((types
371          '(("\\*" "\\*" bold nil 2)
372            ("_" "_" underline)
373            ("/" "/" italic)
374            ("_/" "/_" underline-italic)
375            ("_\\*" "\\*_" underline-bold)
376            ("\\*/" "/\\*" bold-italic)
377            ("_\\*/" "/\\*_" underline-bold-italic))))
378     (nconc
379      (gnus-emphasis-custom-with-format
380       (mapcar (lambda (spec)
381                 (list (format format (car spec) (cadr spec))
382                       (or (nth 3 spec) 2)
383                       (or (nth 4 spec) 3)
384                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
385               types))
386      '(;; I've never seen anyone use this strikethru convention whereas I've
387        ;; several times seen it triggered by normal text.  --Stef
388        ;; Miles suggests that this form is sometimes used but for italics,
389        ;; so maybe we should map it to `italic'.
390        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
391        ;; 2 3 gnus-emphasis-strikethru)
392        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
393         2 3 gnus-emphasis-underline))))
394   "*Alist that says how to fontify certain phrases.
395 Each item looks like this:
396
397   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
398
399 The first element is a regular expression to be matched.  The second
400 is a number that says what regular expression grouping used to find
401 the entire emphasized word.  The third is a number that says what
402 regexp grouping should be displayed and highlighted.  The fourth
403 is the face used for highlighting."
404   :type
405   '(repeat
406     (menu-choice
407      :format "%[Customizing Style%]\n%v"
408      :indent 2
409      (group :tag "Default"
410             :value ("" 0 0 default)
411             :value-create
412             (lambda (widget)
413               (let ((value (widget-get
414                             (cadr (widget-get (widget-get widget :parent)
415                                               :args))
416                             :value)))
417                 (if (not (eq (nth 2 value) 'default))
418                     (widget-put
419                      widget
420                      :value
421                      (gnus-emphasis-custom-value-to-external value))))
422               (widget-group-value-create widget))
423             regexp
424             (integer :format "Match group: %v")
425             (integer :format "Emphasize group: %v")
426             face)
427      (group :tag "Simple"
428             :value (("_" . "_") nil default)
429             (cons :format "%v"
430                   (regexp :format "Start regexp: %v")
431                   (regexp :format "End regexp: %v"))
432             (boolean :format "Show start and end patterns: %[%v%]\n"
433                      :on " On " :off " Off ")
434             face)))
435   :get (lambda (symbol)
436          (mapcar 'gnus-emphasis-custom-value-to-internal
437                  (default-value symbol)))
438   :set (lambda (symbol value)
439          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
440                                      value)))
441   :group 'gnus-article-emphasis)
442
443 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
444   "A regexp to describe whitespace which should not be emphasized.
445 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
446 The former avoids underlining of leading and trailing whitespace,
447 and the latter avoids underlining any whitespace at all."
448   :version "21.1"
449   :group 'gnus-article-emphasis
450   :type 'regexp)
451
452 (defface gnus-emphasis-bold '((t (:bold t)))
453   "Face used for displaying strong emphasized text (*word*)."
454   :group 'gnus-article-emphasis)
455
456 (defface gnus-emphasis-italic '((t (:italic t)))
457   "Face used for displaying italic emphasized text (/word/)."
458   :group 'gnus-article-emphasis)
459
460 (defface gnus-emphasis-underline '((t (:underline t)))
461   "Face used for displaying underlined emphasized text (_word_)."
462   :group 'gnus-article-emphasis)
463
464 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
465   "Face used for displaying underlined bold emphasized text (_*word*_)."
466   :group 'gnus-article-emphasis)
467
468 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
469   "Face used for displaying underlined italic emphasized text (_/word/_)."
470   :group 'gnus-article-emphasis)
471
472 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
473   "Face used for displaying bold italic emphasized text (/*word*/)."
474   :group 'gnus-article-emphasis)
475
476 (defface gnus-emphasis-underline-bold-italic
477   '((t (:bold t :italic t :underline t)))
478   "Face used for displaying underlined bold italic emphasized text.
479 Example: (_/*word*/_)."
480   :group 'gnus-article-emphasis)
481
482 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
483                                       '((t (:strikethru t)))
484                                     '((t (:strike-through t))))
485   "Face used for displaying strike-through text (-word-)."
486   :group 'gnus-article-emphasis)
487
488 (defface gnus-emphasis-highlight-words
489   '((t (:background "black" :foreground "yellow")))
490   "Face used for displaying highlighted words."
491   :group 'gnus-article-emphasis)
492
493 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
494   "Format for display of Date headers in article bodies.
495 See `format-time-string' for the possible values.
496
497 The variable can also be function, which should return a complete Date
498 header.  The function is called with one argument, the time, which can
499 be fed to `format-time-string'."
500   :type '(choice string function)
501   :link '(custom-manual "(gnus)Article Date")
502   :group 'gnus-article-washing)
503
504 (defcustom gnus-save-all-headers t
505   "*If non-nil, don't remove any headers before saving.
506 This will be overridden by the `:headers' property that the symbol of
507 the saver function, which is specified by `gnus-default-article-saver',
508 might have."
509   :group 'gnus-article-saving
510   :type 'boolean)
511
512 (defcustom gnus-prompt-before-saving 'always
513   "*This variable says how much prompting is to be done when saving articles.
514 If it is nil, no prompting will be done, and the articles will be
515 saved to the default files.  If this variable is `always', each and
516 every article that is saved will be preceded by a prompt, even when
517 saving large batches of articles.  If this variable is neither nil not
518 `always', there the user will be prompted once for a file name for
519 each invocation of the saving commands."
520   :group 'gnus-article-saving
521   :type '(choice (item always)
522                  (item :tag "never" nil)
523                  (sexp :tag "once" :format "%t\n" :value t)))
524
525 (defcustom gnus-saved-headers gnus-visible-headers
526   "Headers to keep if `gnus-save-all-headers' is nil.
527 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
528 If that variable is nil, however, all headers that match this regexp
529 will be kept while the rest will be deleted before saving.  This and
530 `gnus-save-all-headers' will be overridden by the `:headers' property
531 that the symbol of the saver function, which is specified by
532 `gnus-default-article-saver', might have."
533   :group 'gnus-article-saving
534   :type 'regexp)
535
536 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
537 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
538   "A function to save articles in your favourite format.
539 The function will be called by way of the `gnus-summary-save-article'
540 command, and friends such as `gnus-summary-save-article-rmail'.
541
542 Gnus provides the following functions:
543
544 * gnus-summary-save-in-rmail (Rmail format)
545 * gnus-summary-save-in-mail (Unix mail format)
546 * gnus-summary-save-in-folder (MH folder)
547 * gnus-summary-save-in-file (article format)
548 * gnus-summary-save-body-in-file (article body)
549 * gnus-summary-save-in-vm (use VM's folder format)
550 * gnus-summary-write-to-file (article format -- overwrite)
551 * gnus-summary-write-body-to-file (article body -- overwrite)
552 * gnus-summary-save-in-pipe (article format)
553
554 The symbol of each function may have the following properties:
555
556 * :decode
557 The value non-nil means save decoded articles.  This is meaningful
558 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
559 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
560 `gnus-summary-save-in-pipe'.
561
562 * :function
563 The value specifies an alternative function which appends, not
564 overwrites, articles to a file.  This implies that when saving many
565 articles at a time, `gnus-prompt-before-saving' is bound to t and all
566 articles are saved in a single file.  This is meaningful only with
567 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
568
569 * :headers
570 The value specifies the symbol of a variable of which the value
571 specifies headers to be saved.  If it is omitted,
572 `gnus-save-all-headers' and `gnus-saved-headers' control what
573 headers should be saved."
574   :group 'gnus-article-saving
575   :type '(radio (function-item gnus-summary-save-in-rmail)
576                 (function-item gnus-summary-save-in-mail)
577                 (function-item gnus-summary-save-in-folder)
578                 (function-item gnus-summary-save-in-file)
579                 (function-item gnus-summary-save-body-in-file)
580                 (function-item gnus-summary-save-in-vm)
581                 (function-item gnus-summary-write-to-file)
582                 (function-item gnus-summary-write-body-to-file)
583                 (function-item gnus-summary-save-in-pipe)
584                 (function)))
585
586 (defcustom gnus-article-save-coding-system
587   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
588       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
589       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
590       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
591   "Coding system used to save decoded articles to a file.
592
593 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
594 which can safely encode any characters in text.  This is used by the
595 commands including:
596
597 * gnus-summary-save-article-file
598 * gnus-summary-save-article-body-file
599 * gnus-summary-write-article-file
600 * gnus-summary-write-article-body-file
601
602 and the functions to which you may set `gnus-default-article-saver':
603
604 * gnus-summary-save-in-file
605 * gnus-summary-save-body-in-file
606 * gnus-summary-write-to-file
607 * gnus-summary-write-body-to-file
608
609 Those commands and functions save just text displayed in the article
610 buffer to a file if the value of this variable is non-nil.  Note that
611 buttonized MIME parts will be lost in a saved file in that case.
612 Otherwise, raw articles will be saved."
613   :group 'gnus-article-saving
614   :type `(choice
615           :format "%{%t%}:\n %[Value Menu%] %v"
616           (const :tag "Save raw articles" nil)
617           ,@(delq nil
618                   (mapcar
619                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
620                    '((const :tag "UTF-8" utf-8)
621                      (const :tag "iso-2022-7bit" iso-2022-7bit)
622                      (const :tag "Emacs internal" emacs-mule)
623                      (const :tag "escape-quoted" escape-quoted))))
624           (symbol :tag "Coding system")))
625
626 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
627   "A function generating a file name to save articles in Rmail format.
628 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
629   :group 'gnus-article-saving
630   :type 'function)
631
632 (defcustom gnus-mail-save-name 'gnus-plain-save-name
633   "A function generating a file name to save articles in Unix mail format.
634 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
635   :group 'gnus-article-saving
636   :type 'function)
637
638 (defcustom gnus-folder-save-name 'gnus-folder-save-name
639   "A function generating a file name to save articles in MH folder.
640 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
641   :group 'gnus-article-saving
642   :type 'function)
643
644 (defcustom gnus-file-save-name 'gnus-numeric-save-name
645   "A function generating a file name to save articles in article format.
646 The function is called with NEWSGROUP, HEADERS, and optional
647 LAST-FILE."
648   :group 'gnus-article-saving
649   :type 'function)
650
651 (defcustom gnus-split-methods
652   '((gnus-article-archive-name)
653     (gnus-article-nndoc-name))
654   "*Variable used to suggest where articles are to be saved.
655 For instance, if you would like to save articles related to Gnus in
656 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
657 you could set this variable to something like:
658
659  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
660    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
661
662 This variable is an alist where the key is the match and the
663 value is a list of possible files to save in if the match is
664 non-nil.
665
666 If the match is a string, it is used as a regexp match on the
667 article.  If the match is a symbol, that symbol will be funcalled
668 from the buffer of the article to be saved with the newsgroup as the
669 parameter.  If it is a list, it will be evaled in the same buffer.
670
671 If this form or function returns a string, this string will be used as a
672 possible file name; and if it returns a non-nil list, that list will be
673 used as possible file names."
674   :group 'gnus-article-saving
675   :type '(repeat (choice (list :value (fun) function)
676                          (cons :value ("" "") regexp (repeat string))
677                          (sexp :value nil))))
678
679 (defcustom gnus-page-delimiter "^\^L"
680   "*Regexp describing what to use as article page delimiters.
681 The default value is \"^\^L\", which is a form linefeed at the
682 beginning of a line."
683   :type 'regexp
684   :group 'gnus-article-various)
685
686 (defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
687   "*The format specification for the article mode line.
688 See `gnus-summary-mode-line-format' for a closer description.
689
690 The following additional specs are available:
691
692 %w  The article washing status.
693 %m  The number of MIME parts in the article."
694   :version "24.1"
695   :type 'string
696   :group 'gnus-article-various)
697
698 (defcustom gnus-article-mode-hook nil
699   "*A hook for Gnus article mode."
700   :type 'hook
701   :group 'gnus-article-various)
702
703 (when (featurep 'xemacs)
704   ;; Extracted from gnus-xmas-define in order to preserve user settings
705   (when (fboundp 'turn-off-scroll-in-place)
706     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
707   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
708   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
709
710 (defcustom gnus-article-menu-hook nil
711   "*Hook run after the creation of the article mode menu."
712   :type 'hook
713   :group 'gnus-article-various)
714
715 (defcustom gnus-article-prepare-hook nil
716   "*A hook called after an article has been prepared in the article buffer."
717   :type 'hook
718   :group 'gnus-article-various)
719
720 (defcustom gnus-copy-article-ignored-headers nil
721   "List of headers to be removed when copying an article.
722 Each element is a regular expression."
723   :version "23.1" ;; No Gnus
724   :type '(repeat regexp)
725   :group 'gnus-article-various)
726
727 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
728                         "Gnus 5.10 (Emacs 22.1)")
729
730 (defface gnus-button
731   '((t (:weight bold)))
732   "Face used for highlighting a button in the article buffer."
733   :group 'gnus-article-buttons)
734
735 (defcustom gnus-article-button-face 'gnus-button
736   "Face used for highlighting buttons in the article buffer.
737
738 An article button is a piece of text that you can activate by pressing
739 `RET' or `mouse-2' above it."
740   :type 'face
741   :group 'gnus-article-buttons)
742
743 (defcustom gnus-article-mouse-face 'highlight
744   "Face used for mouse highlighting in the article buffer.
745
746 Article buttons will be displayed in this face when the cursor is
747 above them."
748   :type 'face
749   :group 'gnus-article-buttons)
750
751 (defcustom gnus-signature-face 'gnus-signature
752   "Face used for highlighting a signature in the article buffer.
753 Obsolete; use the face `gnus-signature' for customizations instead."
754   :type 'face
755   :group 'gnus-article-highlight
756   :group 'gnus-article-signature)
757
758 (defface gnus-signature
759   '((t
760      (:italic t)))
761   "Face used for highlighting a signature in the article buffer."
762   :group 'gnus-article-highlight
763   :group 'gnus-article-signature)
764 ;; backward-compatibility alias
765 (put 'gnus-signature-face 'face-alias 'gnus-signature)
766 (put 'gnus-signature-face 'obsolete-face "22.1")
767
768 (defface gnus-header-from
769   '((((class color)
770       (background dark))
771      (:foreground "PaleGreen1"))
772     (((class color)
773       (background light))
774      (:foreground "red3"))
775     (t
776      (:italic t)))
777   "Face used for displaying from headers."
778   :group 'gnus-article-headers
779   :group 'gnus-article-highlight)
780 ;; backward-compatibility alias
781 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
782 (put 'gnus-header-from-face 'obsolete-face "22.1")
783
784 (defface gnus-header-subject
785   '((((class color)
786       (background dark))
787      (:foreground "SeaGreen1"))
788     (((class color)
789       (background light))
790      (:foreground "red4"))
791     (t
792      (:bold t :italic t)))
793   "Face used for displaying subject headers."
794   :group 'gnus-article-headers
795   :group 'gnus-article-highlight)
796 ;; backward-compatibility alias
797 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
798 (put 'gnus-header-subject-face 'obsolete-face "22.1")
799
800 (defface gnus-header-newsgroups
801   '((((class color)
802       (background dark))
803      (:foreground "yellow" :italic t))
804     (((class color)
805       (background light))
806      (:foreground "MidnightBlue" :italic t))
807     (t
808      (:italic t)))
809   "Face used for displaying newsgroups headers.
810 In the default setup this face is only used for crossposted
811 articles."
812   :group 'gnus-article-headers
813   :group 'gnus-article-highlight)
814 ;; backward-compatibility alias
815 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
816 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
817
818 (defface gnus-header-name
819   '((((class color)
820       (background dark))
821      (:foreground "SpringGreen2"))
822     (((class color)
823       (background light))
824      (:foreground "maroon"))
825     (t
826      (:bold t)))
827   "Face used for displaying header names."
828   :group 'gnus-article-headers
829   :group 'gnus-article-highlight)
830 ;; backward-compatibility alias
831 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
832 (put 'gnus-header-name-face 'obsolete-face "22.1")
833
834 (defface gnus-header-content
835   '((((class color)
836       (background dark))
837      (:foreground "SpringGreen1" :italic t))
838     (((class color)
839       (background light))
840      (:foreground "indianred4" :italic t))
841     (t
842      (:italic t)))  "Face used for displaying header content."
843   :group 'gnus-article-headers
844   :group 'gnus-article-highlight)
845 ;; backward-compatibility alias
846 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
847 (put 'gnus-header-content-face 'obsolete-face "22.1")
848
849 (defcustom gnus-header-face-alist
850   '(("From" nil gnus-header-from)
851     ("Subject" nil gnus-header-subject)
852     ("Newsgroups:.*," nil gnus-header-newsgroups)
853     ("" gnus-header-name gnus-header-content))
854   "*Controls highlighting of article headers.
855
856 An alist of the form (HEADER NAME CONTENT).
857
858 HEADER is a regular expression which should match the name of a
859 header and NAME and CONTENT are either face names or nil.
860
861 The name of each header field will be displayed using the face
862 specified by the first element in the list where HEADER matches
863 the header name and NAME is non-nil.  Similarly, the content will
864 be displayed by the first non-nil matching CONTENT face."
865   :group 'gnus-article-headers
866   :group 'gnus-article-highlight
867   :type '(repeat (list (regexp :tag "Header")
868                        (choice :tag "Name"
869                                (item :tag "skip" nil)
870                                (face :value default))
871                        (choice :tag "Content"
872                                (item :tag "skip" nil)
873                                (face :value default)))))
874
875 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
876                                           '((xface . (:face gnus-x-face)))
877                                         '((pbm . (:face gnus-x-face))
878                                           (png . nil)))
879   "Alist of image types and properties applied to Face and X-Face images.
880 Here are examples:
881
882 ;; Specify the altitude of Face images in the From header.
883 \(setq gnus-face-properties-alist
884       '((pbm . (:face gnus-x-face :ascent 80))
885         (png . (:ascent 80))))
886
887 ;; Show Face images as pressed buttons.
888 \(setq gnus-face-properties-alist
889       '((pbm . (:face gnus-x-face :relief -2))
890         (png . (:relief -2))))
891
892 See the manual for the valid properties for various image types.
893 Currently, `pbm' is used for X-Face images and `png' is used for Face
894 images in Emacs.  Only the `:face' property is effective on the `xface'
895 image type in XEmacs if it is built with the libcompface library."
896   :version "23.1" ;; No Gnus
897   :group 'gnus-article-headers
898   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
899
900 (defcustom gnus-article-decode-hook
901   '(article-decode-charset article-decode-encoded-words
902                            article-decode-group-name article-decode-idna-rhs)
903   "*Hook run to decode charsets in articles."
904   :group 'gnus-article-headers
905   :type 'hook)
906
907 (defcustom gnus-display-mime-function 'gnus-display-mime
908   "Function to display MIME articles."
909   :group 'gnus-article-mime
910   :type 'function)
911
912 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
913   "Function used to decode headers.")
914
915 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
916   "Function used to decode addresses.")
917
918 (defvar gnus-article-dumbquotes-map
919   '((?\200 "EUR")
920     (?\202 ",")
921     (?\203 "f")
922     (?\204 ",,")
923     (?\205 "...")
924     (?\213 "<")
925     (?\214 "OE")
926     (?\221 "`")
927     (?\222 "'")
928     (?\223 "``")
929     (?\224 "\"")
930     (?\225 "*")
931     (?\226 "-")
932     (?\227 "--")
933     (?\230 "~")
934     (?\231 "(TM)")
935     (?\233 ">")
936     (?\234 "oe")
937     (?\264 "'"))
938   "Table for MS-to-Latin1 translation.")
939
940 (defcustom gnus-ignored-mime-types nil
941   "List of MIME types that should be ignored by Gnus."
942   :version "21.1"
943   :group 'gnus-article-mime
944   :type '(repeat regexp))
945
946 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
947   "List of MIME types that should not be given buttons when rendered inline.
948 See also `gnus-buttonized-mime-types' which may override this variable.
949 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
950   :version "21.1"
951   :group 'gnus-article-mime
952   :type '(repeat regexp))
953
954 (defcustom gnus-buttonized-mime-types nil
955   "List of MIME types that should be given buttons when rendered inline.
956 If set, this variable overrides `gnus-unbuttonized-mime-types'.
957 To see e.g. security buttons you could set this to
958 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
959 this list to display radio buttons that allow you to choose one of two
960 media types those mails include.  See also `mm-discouraged-alternatives'.
961 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
962   :version "22.1"
963   :group 'gnus-article-mime
964   :type '(repeat regexp))
965
966 (defcustom gnus-inhibit-mime-unbuttonizing nil
967   "If non-nil, all MIME parts get buttons.
968 When nil (the default value), then some MIME parts do not get buttons,
969 as described by the variables `gnus-buttonized-mime-types' and
970 `gnus-unbuttonized-mime-types'."
971   :version "22.1"
972   :group 'gnus-article-mime
973   :type 'boolean)
974
975 (defcustom gnus-body-boundary-delimiter "_"
976   "String used to delimit header and body.
977 This variable is used by `gnus-article-treat-body-boundary' which can
978 be controlled by `gnus-treat-body-boundary'."
979   :version "22.1"
980   :group 'gnus-article-various
981   :type '(choice (item :tag "None" :value nil)
982                  string))
983
984 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
985                                   "/usr/share/picons")
986   "Defines the location of the faces database.
987 For information on obtaining this database of pretty pictures, please
988 see http://www.cs.indiana.edu/picons/ftp/index.html"
989   :version "22.1"
990   :type '(repeat directory)
991   :link '(url-link :tag "download"
992                    "http://www.cs.indiana.edu/picons/ftp/index.html")
993   :link '(custom-manual "(gnus)Picons")
994   :group 'gnus-picon)
995
996 (defun gnus-picons-installed-p ()
997   "Say whether picons are installed on your machine."
998   (let ((installed nil))
999     (dolist (database gnus-picon-databases)
1000       (when (file-exists-p database)
1001         (setq installed t)))
1002     installed))
1003
1004 (defcustom gnus-article-mime-part-function nil
1005   "Function called with a MIME handle as the argument.
1006 This is meant for people who want to do something automatic based
1007 on parts -- for instance, adding Vcard info to a database."
1008   :group 'gnus-article-mime
1009   :type '(choice (const nil)
1010                  function))
1011
1012 (defcustom gnus-mime-multipart-functions nil
1013   "An alist of MIME types to functions to display them."
1014   :version "21.1"
1015   :group 'gnus-article-mime
1016   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1017
1018 (defcustom gnus-article-date-headers '(combined-lapsed)
1019   "A list of Date header formats to display.
1020 Valid formats are `ut' (universal time), `local' (local time
1021 zone), `english' (readable English), `lapsed' (elapsed time),
1022 `combined-lapsed' (both the original date and the elapsed time),
1023 `original' (the original date header), `iso8601' (ISO8601
1024 format), and `user-defined' (a user-defined format defined by the
1025 `gnus-article-time-format' variable).
1026
1027 You have as many date headers as you want in the article buffer.
1028 Some of these headers are updated automatically.  See
1029 `gnus-article-update-date-headers' for details."
1030   :version "24.1"
1031   :group 'gnus-article-headers
1032   :type '(repeat
1033           (item :tag "Universal time (UT)" :value 'ut)
1034           (item :tag "Local time zone" :value 'local)
1035           (item :tag "Readable English" :value 'english)
1036           (item :tag "Elapsed time" :value 'lapsed)
1037           (item :tag "Original and elapsed time" :value 'combined-lapsed)
1038           (item :tag "Original date header" :value 'original)
1039           (item :tag "ISO8601 format" :value 'iso8601)
1040           (item :tag "User-defined" :value 'user-defined)))
1041
1042 (defcustom gnus-article-update-date-headers 1
1043   "A number that says how often to update the date header (in seconds).
1044 If nil, don't update it at all."
1045   :version "24.1"
1046   :group 'gnus-article-headers
1047   :type '(choice
1048           (item :tag "Don't update" :value nil)
1049           integer))
1050
1051 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1052   "Function called with a MIME handle as the argument.
1053 This is meant for people who want to view first matched part.
1054 For `undisplayed-alternative' (default), the first undisplayed
1055 part or alternative part is used.  For `undisplayed', the first
1056 undisplayed part is used.  For a function, the first part which
1057 the function return t is used.  For nil, the first part is
1058 used."
1059   :version "21.1"
1060   :group 'gnus-article-mime
1061   :type '(choice
1062           (item :tag "first" :value nil)
1063           (item :tag "undisplayed" :value undisplayed)
1064           (item :tag "undisplayed or alternative"
1065                 :value undisplayed-alternative)
1066           (function)))
1067
1068 (defcustom gnus-mime-action-alist
1069   '(("save to file" . gnus-mime-save-part)
1070     ("save and strip" . gnus-mime-save-part-and-strip)
1071     ("replace with file" . gnus-mime-replace-part)
1072     ("delete part" . gnus-mime-delete-part)
1073     ("display as text" . gnus-mime-inline-part)
1074     ("view the part" . gnus-mime-view-part)
1075     ("pipe to command" . gnus-mime-pipe-part)
1076     ("toggle display" . gnus-article-press-button)
1077     ("toggle display" . gnus-article-view-part-as-charset)
1078     ("view as type" . gnus-mime-view-part-as-type)
1079     ("view internally" . gnus-mime-view-part-internally)
1080     ("view externally" . gnus-mime-view-part-externally))
1081   "An alist of actions that run on the MIME attachment."
1082   :group 'gnus-article-mime
1083   :type '(repeat (cons (string :tag "name")
1084                        (function))))
1085
1086 (defcustom gnus-auto-select-part 1
1087   "Advance to next MIME part when deleting or stripping parts.
1088
1089 When 0, point will be placed on the same part as before.  When
1090 positive (negative), move point forward (backwards) this many
1091 parts.  When nil, redisplay article."
1092   :version "23.1" ;; No Gnus
1093   :group 'gnus-article-mime
1094   :type '(choice (const nil :tag "Redisplay article.")
1095                  (const 1 :tag "Next part.")
1096                  (const 0 :tag "Current part.")
1097                  integer))
1098
1099 ;;;
1100 ;;; The treatment variables
1101 ;;;
1102
1103 (defvar gnus-part-display-hook nil
1104   "Hook called on parts that are to receive treatment.")
1105
1106 (defvar gnus-article-treat-custom
1107   '(choice (const :tag "Off" nil)
1108            (const :tag "On" t)
1109            (const :tag "Header" head)
1110            (const :tag "First" first)
1111            (const :tag "Last" last)
1112            (integer :tag "Less")
1113            (repeat :tag "Groups" regexp)
1114            (sexp :tag "Predicate")))
1115
1116 (defvar gnus-article-treat-head-custom
1117   '(choice (const :tag "Off" nil)
1118            (const :tag "Header" head)))
1119
1120 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1121                                    "text/x-patch")
1122   "Parts to treat.")
1123
1124 (defvar gnus-inhibit-treatment nil
1125   "Whether to inhibit treatment.")
1126
1127 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1128   "Highlight the signature.
1129 Valid values are nil, t, `head', `first', `last', an integer or a
1130 predicate.  See Info node `(gnus)Customizing Articles'."
1131   :group 'gnus-article-treat
1132   :link '(custom-manual "(gnus)Customizing Articles")
1133   :type gnus-article-treat-custom)
1134 (put 'gnus-treat-highlight-signature 'highlight t)
1135
1136 (defcustom gnus-treat-buttonize 100000
1137   "Add buttons.
1138 Valid values are nil, t, `head', `first', `last', an integer or a
1139 predicate.  See Info node `(gnus)Customizing Articles'."
1140   :group 'gnus-article-treat
1141   :link '(custom-manual "(gnus)Customizing Articles")
1142   :type gnus-article-treat-custom)
1143 (put 'gnus-treat-buttonize 'highlight t)
1144
1145 (defcustom gnus-treat-buttonize-head 'head
1146   "Add buttons to the head.
1147 Valid values are nil, t, `head', `first', `last', an integer or a
1148 predicate.  See Info node `(gnus)Customizing Articles'."
1149   :group 'gnus-article-treat
1150   :link '(custom-manual "(gnus)Customizing Articles")
1151   :type gnus-article-treat-head-custom)
1152 (put 'gnus-treat-buttonize-head 'highlight t)
1153
1154 (defcustom gnus-treat-date 'head
1155   "Display dates according to the `gnus-article-date-headers' variable.
1156 Valid values are nil, t, `head', `first', `last', an integer or a
1157 predicate.  See Info node `(gnus)Customizing Articles'."
1158   :version "24.1"
1159   :group 'gnus-article-treat
1160   :link '(custom-manual "(gnus)Customizing Articles")
1161   :type gnus-article-treat-head-custom)
1162
1163 (defcustom gnus-treat-emphasize 50000
1164   "Emphasize text.
1165 Valid values are nil, t, `head', `first', `last', an integer or a
1166 predicate.  See Info node `(gnus)Customizing Articles'."
1167   :group 'gnus-article-treat
1168   :link '(custom-manual "(gnus)Customizing Articles")
1169   :type gnus-article-treat-custom)
1170 (put 'gnus-treat-emphasize 'highlight t)
1171
1172 (defcustom gnus-treat-strip-cr nil
1173   "Remove carriage returns.
1174 Valid values are nil, t, `head', `first', `last', an integer or a
1175 predicate.  See Info node `(gnus)Customizing Articles'."
1176   :version "22.1"
1177   :group 'gnus-article-treat
1178   :link '(custom-manual "(gnus)Customizing Articles")
1179   :type gnus-article-treat-custom)
1180
1181 (defcustom gnus-treat-unsplit-urls nil
1182   "Remove newlines from within URLs.
1183 Valid values are nil, t, `head', `first', `last', an integer or a
1184 predicate.  See Info node `(gnus)Customizing Articles'."
1185   :version "22.1"
1186   :group 'gnus-article-treat
1187   :link '(custom-manual "(gnus)Customizing Articles")
1188   :type gnus-article-treat-custom)
1189
1190 (defcustom gnus-treat-leading-whitespace nil
1191   "Remove leading whitespace in headers.
1192 Valid values are nil, t, `head', `first', `last', an integer or a
1193 predicate.  See Info node `(gnus)Customizing Articles'."
1194   :version "22.1"
1195   :group 'gnus-article-treat
1196   :link '(custom-manual "(gnus)Customizing Articles")
1197   :type gnus-article-treat-custom)
1198
1199 (defcustom gnus-treat-hide-headers 'head
1200   "Hide headers.
1201 Valid values are nil, t, `head', `first', `last', an integer or a
1202 predicate.  See Info node `(gnus)Customizing Articles'."
1203   :group 'gnus-article-treat
1204   :link '(custom-manual "(gnus)Customizing Articles")
1205   :type gnus-article-treat-head-custom)
1206
1207 (defcustom gnus-treat-hide-boring-headers nil
1208   "Hide boring headers.
1209 Valid values are nil, t, `head', `first', `last', an integer or a
1210 predicate.  See Info node `(gnus)Customizing Articles'."
1211   :group 'gnus-article-treat
1212   :link '(custom-manual "(gnus)Customizing Articles")
1213   :type gnus-article-treat-head-custom)
1214
1215 (defcustom gnus-treat-hide-signature nil
1216   "Hide the signature.
1217 Valid values are nil, t, `head', `first', `last', an integer or a
1218 predicate.  See Info node `(gnus)Customizing Articles'."
1219   :group 'gnus-article-treat
1220   :link '(custom-manual "(gnus)Customizing Articles")
1221   :type gnus-article-treat-custom)
1222
1223 (defcustom gnus-treat-fill-article nil
1224   "Fill the article.
1225 Valid values are nil, t, `head', `first', `last', an integer or a
1226 predicate.  See Info node `(gnus)Customizing Articles'."
1227   :group 'gnus-article-treat
1228   :link '(custom-manual "(gnus)Customizing Articles")
1229   :type gnus-article-treat-custom)
1230
1231 (defcustom gnus-treat-hide-citation nil
1232   "Hide cited text.
1233 Valid values are nil, t, `head', `first', `last', an integer or a
1234 predicate.  See Info node `(gnus)Customizing Articles'."
1235   :group 'gnus-article-treat
1236   :link '(custom-manual "(gnus)Customizing Articles")
1237   :type gnus-article-treat-custom)
1238
1239 (defcustom gnus-treat-hide-citation-maybe nil
1240   "Hide cited text.
1241 Valid values are nil, t, `head', `first', `last', an integer or a
1242 predicate.  See Info node `(gnus)Customizing Articles'."
1243   :group 'gnus-article-treat
1244   :link '(custom-manual "(gnus)Customizing Articles")
1245   :type gnus-article-treat-custom)
1246
1247 (defcustom gnus-treat-strip-list-identifiers 'head
1248   "Strip list identifiers from `gnus-list-identifiers`.
1249 Valid values are nil, t, `head', `first', `last', an integer or a
1250 predicate.  See Info node `(gnus)Customizing Articles'."
1251   :version "21.1"
1252   :group 'gnus-article-treat
1253   :link '(custom-manual "(gnus)Customizing Articles")
1254   :type gnus-article-treat-custom)
1255
1256 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1257                         "Gnus 5.10 (Emacs 22.1)")
1258
1259 (defcustom gnus-treat-strip-pem nil
1260   "Strip PEM signatures.
1261 Valid values are nil, t, `head', `first', `last', an integer or a
1262 predicate.  See Info node `(gnus)Customizing Articles'."
1263   :group 'gnus-article-treat
1264   :link '(custom-manual "(gnus)Customizing Articles")
1265   :type gnus-article-treat-custom)
1266
1267 (defcustom gnus-treat-strip-banner t
1268   "Strip banners from articles.
1269 The banner to be stripped is specified in the `banner' group parameter.
1270 Valid values are nil, t, `head', `first', `last', an integer or a
1271 predicate.  See Info node `(gnus)Customizing Articles'."
1272   :group 'gnus-article-treat
1273   :link '(custom-manual "(gnus)Customizing Articles")
1274   :type gnus-article-treat-custom)
1275
1276 (defcustom gnus-treat-highlight-headers 'head
1277   "Highlight the headers.
1278 Valid values are nil, t, `head', `first', `last', an integer or a
1279 predicate.  See Info node `(gnus)Customizing Articles'."
1280   :group 'gnus-article-treat
1281   :link '(custom-manual "(gnus)Customizing Articles")
1282   :type gnus-article-treat-head-custom)
1283 (put 'gnus-treat-highlight-headers 'highlight t)
1284
1285 (defcustom gnus-treat-highlight-citation t
1286   "Highlight cited text.
1287 Valid values are nil, t, `head', `first', `last', an integer or a
1288 predicate.  See Info node `(gnus)Customizing Articles'."
1289   :group 'gnus-article-treat
1290   :link '(custom-manual "(gnus)Customizing Articles")
1291   :type gnus-article-treat-custom)
1292 (put 'gnus-treat-highlight-citation 'highlight t)
1293
1294 (defcustom gnus-treat-strip-headers-in-body t
1295   "Strip the X-No-Archive header line from the beginning of the body.
1296 Valid values are nil, t, `head', `first', `last', an integer or a
1297 predicate.  See Info node `(gnus)Customizing Articles'."
1298   :version "21.1"
1299   :group 'gnus-article-treat
1300   :link '(custom-manual "(gnus)Customizing Articles")
1301   :type gnus-article-treat-custom)
1302
1303 (defcustom gnus-treat-strip-trailing-blank-lines nil
1304   "Strip trailing blank lines.
1305 Valid values are nil, t, `head', `first', `last', an integer or a
1306 predicate.  See Info node `(gnus)Customizing Articles'.
1307
1308 When set to t, it also strips trailing blanks in all MIME parts.
1309 Consider to use `last' instead."
1310   :group 'gnus-article-treat
1311   :link '(custom-manual "(gnus)Customizing Articles")
1312   :type gnus-article-treat-custom)
1313
1314 (defcustom gnus-treat-strip-leading-blank-lines nil
1315   "Strip leading blank lines.
1316 Valid values are nil, t, `head', `first', `last', an integer or a
1317 predicate.  See Info node `(gnus)Customizing Articles'.
1318
1319 When set to t, it also strips trailing blanks in all MIME parts."
1320   :group 'gnus-article-treat
1321   :link '(custom-manual "(gnus)Customizing Articles")
1322   :type gnus-article-treat-custom)
1323
1324 (defcustom gnus-treat-strip-multiple-blank-lines nil
1325   "Strip multiple blank lines.
1326 Valid values are nil, t, `head', `first', `last', an integer or a
1327 predicate.  See Info node `(gnus)Customizing Articles'."
1328   :group 'gnus-article-treat
1329   :link '(custom-manual "(gnus)Customizing Articles")
1330   :type gnus-article-treat-custom)
1331
1332 (defcustom gnus-treat-unfold-headers 'head
1333   "Unfold folded header lines.
1334 Valid values are nil, t, `head', `first', `last', an integer or a
1335 predicate.  See Info node `(gnus)Customizing Articles'."
1336   :version "22.1"
1337   :group 'gnus-article-treat
1338   :link '(custom-manual "(gnus)Customizing Articles")
1339   :type gnus-article-treat-custom)
1340
1341 (defcustom gnus-article-unfold-long-headers nil
1342   "If non-nil, allow unfolding headers even if the header is long.
1343 If it is a regexp, only long headers matching this regexp are unfolded.
1344 If it is t, all long headers are unfolded.
1345
1346 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1347   :version "23.1" ;; No Gnus
1348   :group 'gnus-article-treat
1349   :type '(choice (const nil)
1350                  (const :tag "all" t)
1351                  (regexp)))
1352
1353 (defcustom gnus-treat-fold-headers nil
1354   "Fold headers.
1355 Valid values are nil, t, `head', `first', `last', an integer or a
1356 predicate.  See Info node `(gnus)Customizing Articles'."
1357   :version "22.1"
1358   :group 'gnus-article-treat
1359   :link '(custom-manual "(gnus)Customizing Articles")
1360   :type gnus-article-treat-custom)
1361
1362 (defcustom gnus-treat-fold-newsgroups 'head
1363   "Fold the Newsgroups and Followup-To headers.
1364 Valid values are nil, t, `head', `first', `last', an integer or a
1365 predicate.  See Info node `(gnus)Customizing Articles'."
1366   :version "22.1"
1367   :group 'gnus-article-treat
1368   :link '(custom-manual "(gnus)Customizing Articles")
1369   :type gnus-article-treat-custom)
1370
1371 (defcustom gnus-treat-overstrike t
1372   "Treat overstrike highlighting.
1373 Valid values are nil, t, `head', `first', `last', an integer or a
1374 predicate.  See Info node `(gnus)Customizing Articles'."
1375   :group 'gnus-article-treat
1376   :link '(custom-manual "(gnus)Customizing Articles")
1377   :type gnus-article-treat-custom)
1378 (put 'gnus-treat-overstrike 'highlight t)
1379
1380 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1381   "Treat ANSI SGR control sequences.
1382 Valid values are nil, t, `head', `first', `last', an integer or a
1383 predicate.  See Info node `(gnus)Customizing Articles'."
1384   :group 'gnus-article-treat
1385   :link '(custom-manual "(gnus)Customizing Articles")
1386   :type gnus-article-treat-custom)
1387
1388 (make-obsolete-variable 'gnus-treat-display-xface
1389                         'gnus-treat-display-x-face "Emacs 22.1")
1390
1391 (defcustom gnus-treat-display-x-face
1392   (and (not noninteractive)
1393        (gnus-image-type-available-p 'xbm)
1394        (if (featurep 'xemacs)
1395            (featurep 'xface)
1396          (condition-case nil
1397              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1398                   (executable-find "icontopbm"))
1399            ;; shell-command-to-string may signal an error, e.g. if
1400            ;; shell-file-name is not found.
1401            (error nil)))
1402        'head)
1403   "Display X-Face headers.
1404 Valid values are nil and `head'.
1405 See Info node `(gnus)Customizing Articles' and Info node
1406 `(gnus)X-Face' for details."
1407   :group 'gnus-article-treat
1408   :version "21.1"
1409   :link '(custom-manual "(gnus)Customizing Articles")
1410   :link '(custom-manual "(gnus)X-Face")
1411   :type gnus-article-treat-head-custom
1412   :set (lambda (symbol value)
1413          (set-default
1414           symbol
1415           (cond ((or (boundp symbol) (get symbol 'saved-value))
1416                  value)
1417                 ((boundp 'gnus-treat-display-xface)
1418                  (message "\
1419 ** gnus-treat-display-xface is an obsolete variable;\
1420  use gnus-treat-display-x-face instead")
1421                  (default-value 'gnus-treat-display-xface))
1422                 ((get 'gnus-treat-display-xface 'saved-value)
1423                  (message "\
1424 ** gnus-treat-display-xface is an obsolete variable;\
1425  use gnus-treat-display-x-face instead")
1426                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1427                 (t
1428                  value)))))
1429 (put 'gnus-treat-display-x-face 'highlight t)
1430
1431 (defcustom gnus-treat-display-face
1432   (and (not noninteractive)
1433        (gnus-image-type-available-p 'png)
1434        'head)
1435   "Display Face headers.
1436 Valid values are nil, t, `head', `first', `last', an integer or a
1437 predicate.  See Info node `(gnus)Customizing Articles' and Info
1438 node `(gnus)Face' for details."
1439   :group 'gnus-article-treat
1440   :version "22.1"
1441   :link '(custom-manual "(gnus)Customizing Articles")
1442   :link '(custom-manual "(gnus)X-Face")
1443   :type gnus-article-treat-head-custom)
1444 (put 'gnus-treat-display-face 'highlight t)
1445
1446 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1447   "Display smileys.
1448 Valid values are nil, t, `head', `first', `last', an integer or a
1449 predicate.  See Info node `(gnus)Customizing Articles' and Info
1450 node `(gnus)Smileys' for details."
1451   :group 'gnus-article-treat
1452   :version "21.1"
1453   :link '(custom-manual "(gnus)Customizing Articles")
1454   :link '(custom-manual "(gnus)Smileys")
1455   :type gnus-article-treat-custom)
1456 (put 'gnus-treat-display-smileys 'highlight t)
1457
1458 (defcustom gnus-treat-from-picon
1459   (if (and (gnus-image-type-available-p 'xpm)
1460            (gnus-picons-installed-p))
1461       'head nil)
1462   "Display picons in the From header.
1463 Valid values are nil, t, `head', `first', `last', an integer or a
1464 predicate.  See Info node `(gnus)Customizing Articles' and Info
1465 node `(gnus)Picons' for details."
1466   :version "22.1"
1467   :group 'gnus-article-treat
1468   :group 'gnus-picon
1469   :link '(custom-manual "(gnus)Customizing Articles")
1470   :link '(custom-manual "(gnus)Picons")
1471   :type gnus-article-treat-head-custom)
1472 (put 'gnus-treat-from-picon 'highlight t)
1473
1474 (defcustom gnus-treat-mail-picon
1475   (if (and (gnus-image-type-available-p 'xpm)
1476            (gnus-picons-installed-p))
1477       'head nil)
1478   "Display picons in To and Cc headers.
1479 Valid values are nil, t, `head', `first', `last', an integer or a
1480 predicate.  See Info node `(gnus)Customizing Articles' and Info
1481 node `(gnus)Picons' for details."
1482   :version "22.1"
1483   :group 'gnus-article-treat
1484   :group 'gnus-picon
1485   :link '(custom-manual "(gnus)Customizing Articles")
1486   :link '(custom-manual "(gnus)Picons")
1487   :type gnus-article-treat-head-custom)
1488 (put 'gnus-treat-mail-picon 'highlight t)
1489
1490 (defcustom gnus-treat-newsgroups-picon
1491   (if (and (gnus-image-type-available-p 'xpm)
1492            (gnus-picons-installed-p))
1493       'head nil)
1494   "Display picons in the Newsgroups and Followup-To headers.
1495 Valid values are nil, t, `head', `first', `last', an integer or a
1496 predicate.  See Info node `(gnus)Customizing Articles' and Info
1497 node `(gnus)Picons' for details."
1498   :version "22.1"
1499   :group 'gnus-article-treat
1500   :group 'gnus-picon
1501   :link '(custom-manual "(gnus)Customizing Articles")
1502   :link '(custom-manual "(gnus)Picons")
1503   :type gnus-article-treat-head-custom)
1504 (put 'gnus-treat-newsgroups-picon 'highlight t)
1505
1506 (defcustom gnus-treat-from-gravatar nil
1507   "Display gravatars in the From header.
1508 Valid values are nil, t, `head', `first', `last', an integer or a
1509 predicate.  See Info node `(gnus)Customizing Articles' and Info
1510 node `(gnus)Gravatars' for details."
1511   :version "24.1"
1512   :group 'gnus-article-treat
1513   :group 'gnus-gravatar
1514   :link '(custom-manual "(gnus)Customizing Articles")
1515   :link '(custom-manual "(gnus)Gravatars")
1516   :type gnus-article-treat-head-custom)
1517 (put 'gnus-treat-from-gravatar 'highlight t)
1518
1519 (defcustom gnus-treat-mail-gravatar nil
1520   "Display gravatars in To and Cc headers.
1521 Valid values are nil, t, `head', `first', `last', an integer or a
1522 predicate.  See Info node `(gnus)Customizing Articles' and Info
1523 node `(gnus)Gravatars' for details."
1524   :version "24.1"
1525   :group 'gnus-article-treat
1526   :group 'gnus-gravatar
1527   :link '(custom-manual "(gnus)Customizing Articles")
1528   :link '(custom-manual "(gnus)Gravatars")
1529   :type gnus-article-treat-head-custom)
1530 (put 'gnus-treat-mail-gravatar 'highlight t)
1531
1532 (defcustom gnus-treat-body-boundary
1533   (if (or gnus-treat-newsgroups-picon
1534           gnus-treat-mail-picon
1535           gnus-treat-from-picon
1536           gnus-treat-from-gravatar
1537           gnus-treat-mail-gravatar)
1538       ;; If there's much decoration, the user might prefer a boundery.
1539       'head
1540     nil)
1541   "Draw a boundary at the end of the headers.
1542 Valid values are nil and `head'.
1543 See Info node `(gnus)Customizing Articles' for details."
1544   :version "22.1"
1545   :group 'gnus-article-treat
1546   :link '(custom-manual "(gnus)Customizing Articles")
1547   :type gnus-article-treat-head-custom)
1548
1549 (defcustom gnus-treat-capitalize-sentences nil
1550   "Capitalize sentence-starting words.
1551 Valid values are nil, t, `head', `first', `last', an integer or a
1552 predicate.  See Info node `(gnus)Customizing Articles'."
1553   :version "21.1"
1554   :group 'gnus-article-treat
1555   :link '(custom-manual "(gnus)Customizing Articles")
1556   :type gnus-article-treat-custom)
1557
1558 (defcustom gnus-treat-wash-html nil
1559   "Format as HTML.
1560 Valid values are nil, t, `head', `first', `last', an integer or a
1561 predicate.  See Info node `(gnus)Customizing Articles'."
1562   :version "22.1"
1563   :group 'gnus-article-treat
1564   :link '(custom-manual "(gnus)Customizing Articles")
1565   :type gnus-article-treat-custom)
1566
1567 (defcustom gnus-treat-fill-long-lines '(typep "text/plain")
1568   "Fill long lines.
1569 Valid values are nil, t, `head', `first', `last', an integer or a
1570 predicate.  See Info node `(gnus)Customizing Articles'."
1571   :version "24.1"
1572   :group 'gnus-article-treat
1573   :link '(custom-manual "(gnus)Customizing Articles")
1574   :type gnus-article-treat-custom)
1575
1576 (defcustom gnus-treat-x-pgp-sig nil
1577   "Verify X-PGP-Sig.
1578 To automatically treat X-PGP-Sig, set it to head.
1579 Valid values are nil, t, `head', `first', `last', an integer or a
1580 predicate.  See Info node `(gnus)Customizing Articles'."
1581   :version "22.1"
1582   :group 'gnus-article-treat
1583   :group 'mime-security
1584   :link '(custom-manual "(gnus)Customizing Articles")
1585   :type gnus-article-treat-custom)
1586
1587 (defvar gnus-article-encrypt-protocol-alist
1588   '(("PGP" . mml2015-self-encrypt)))
1589
1590 ;; Set to nil if more than one protocol added to
1591 ;; gnus-article-encrypt-protocol-alist.
1592 (defcustom gnus-article-encrypt-protocol "PGP"
1593   "The protocol used for encrypt articles.
1594 It is a string, such as \"PGP\". If nil, ask user."
1595   :version "22.1"
1596   :type 'string
1597   :group 'mime-security)
1598
1599 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1600                               (mm-coding-system-p 'utf-8)
1601                               (executable-find idna-program))
1602   "Whether IDNA decoding of headers is used when viewing messages.
1603 This requires GNU Libidn, and by default only enabled if it is found."
1604   :version "22.1"
1605   :group 'gnus-article-headers
1606   :type 'boolean)
1607
1608 (defcustom gnus-article-over-scroll nil
1609   "If non-nil, allow scrolling the article buffer even when there no more text."
1610   :version "22.1"
1611   :group 'gnus-article
1612   :type 'boolean)
1613
1614 (defcustom gnus-inhibit-images nil
1615   "Non-nil means inhibit displaying of images inline in the article body."
1616   :version "24.1"
1617   :group 'gnus-article
1618   :type 'boolean)
1619
1620 (defcustom gnus-blocked-images 'gnus-block-private-groups
1621   "Images that have URLs matching this regexp will be blocked.
1622 This can also be a function to be evaluated.  If so, it will be
1623 called with the group name as the parameter, and should return a
1624 regexp."
1625   :version "24.1"
1626   :group 'gnus-art
1627   :type 'regexp)
1628
1629 ;;; Internal variables
1630
1631 (defvar gnus-english-month-names
1632   '("January" "February" "March" "April" "May" "June" "July" "August"
1633     "September" "October" "November" "December"))
1634
1635 (defvar article-goto-body-goes-to-point-min-p nil)
1636 (defvar gnus-article-wash-types nil)
1637 (defvar gnus-article-emphasis-alist nil)
1638 (defvar gnus-article-image-alist nil)
1639
1640 (defvar gnus-article-mime-handle-alist-1 nil)
1641 (defvar gnus-treatment-function-alist
1642   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1643     (gnus-treat-strip-banner gnus-article-strip-banner)
1644     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1645     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1646     (gnus-treat-buttonize gnus-article-add-buttons)
1647     (gnus-treat-fill-article gnus-article-fill-cited-article)
1648     (gnus-treat-fill-long-lines gnus-article-fill-cited-long-lines)
1649     (gnus-treat-strip-cr gnus-article-remove-cr)
1650     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1651     (gnus-treat-display-x-face gnus-article-display-x-face)
1652     (gnus-treat-display-face gnus-article-display-face)
1653     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1654     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1655     (gnus-treat-hide-signature gnus-article-hide-signature)
1656     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1657     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1658     (gnus-treat-from-picon gnus-treat-from-picon)
1659     (gnus-treat-mail-picon gnus-treat-mail-picon)
1660     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1661     (gnus-treat-strip-pem gnus-article-hide-pem)
1662     (gnus-treat-date gnus-article-treat-date)
1663     (gnus-treat-from-gravatar gnus-treat-from-gravatar)
1664     (gnus-treat-mail-gravatar gnus-treat-mail-gravatar)
1665     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1666     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1667     (gnus-treat-strip-trailing-blank-lines
1668      gnus-article-remove-trailing-blank-lines)
1669     (gnus-treat-strip-leading-blank-lines
1670      gnus-article-strip-leading-blank-lines)
1671     (gnus-treat-strip-multiple-blank-lines
1672      gnus-article-strip-multiple-blank-lines)
1673     (gnus-treat-overstrike gnus-article-treat-overstrike)
1674     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1675     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1676     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1677     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1678     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1679     (gnus-treat-display-smileys gnus-treat-smiley)
1680     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1681     (gnus-treat-wash-html gnus-article-wash-html)
1682     (gnus-treat-emphasize gnus-article-emphasize)
1683     (gnus-treat-hide-citation gnus-article-hide-citation)
1684     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1685     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1686     (gnus-treat-body-boundary gnus-article-treat-body-boundary)))
1687
1688 (defvar gnus-article-mime-handle-alist nil)
1689 (defvar article-lapsed-timer nil)
1690 (defvar gnus-article-current-summary nil)
1691
1692 (defvar gnus-article-mode-syntax-table
1693   (let ((table (copy-syntax-table text-mode-syntax-table)))
1694     ;; This causes the citation match run O(2^n).
1695     ;; (modify-syntax-entry ?- "w" table)
1696     (modify-syntax-entry ?> ")<" table)
1697     (modify-syntax-entry ?< "(>" table)
1698     ;; make M-. in article buffers work for `foo' strings
1699     (modify-syntax-entry ?' " " table)
1700     (modify-syntax-entry ?` " " table)
1701     table)
1702   "Syntax table used in article mode buffers.
1703 Initialized from `text-mode-syntax-table.")
1704
1705 (defvar gnus-save-article-buffer nil)
1706
1707 (defvar gnus-number-of-articles-to-be-saved nil)
1708
1709 (defvar gnus-inhibit-hiding nil)
1710
1711 (defvar gnus-article-edit-mode nil)
1712
1713 ;;; Macros for dealing with the article buffer.
1714
1715 (defmacro gnus-with-article-headers (&rest forms)
1716   `(with-current-buffer gnus-article-buffer
1717      (save-restriction
1718        (let ((inhibit-read-only t)
1719              (inhibit-point-motion-hooks t)
1720              (case-fold-search t))
1721          (article-narrow-to-head)
1722          ,@forms))))
1723
1724 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1725 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1726
1727 (defmacro gnus-with-article-buffer (&rest forms)
1728   `(with-current-buffer gnus-article-buffer
1729      (let ((inhibit-read-only t))
1730        ,@forms)))
1731
1732 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1733 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1734
1735 (defun gnus-article-goto-header (header)
1736   "Go to HEADER, which is a regular expression."
1737   (re-search-forward (concat "^\\(" header "\\):") nil t))
1738
1739 (defsubst gnus-article-hide-text (b e props)
1740   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1741   (gnus-add-text-properties-when 'article-type nil b e props)
1742   (when (memq 'intangible props)
1743     (put-text-property
1744      (max (1- b) (point-min))
1745      b 'intangible (cddr (memq 'intangible props)))))
1746
1747 (defsubst gnus-article-unhide-text (b e)
1748   "Remove hidden text properties from region between B and E."
1749   (remove-text-properties b e gnus-hidden-properties)
1750   (when (memq 'intangible gnus-hidden-properties)
1751     (put-text-property (max (1- b) (point-min))
1752                        b 'intangible nil)))
1753
1754 (defun gnus-article-hide-text-type (b e type)
1755   "Hide text of TYPE between B and E."
1756   (gnus-add-wash-type type)
1757   (gnus-article-hide-text
1758    b e (cons 'article-type (cons type gnus-hidden-properties))))
1759
1760 (defun gnus-article-unhide-text-type (b e type)
1761   "Unhide text of TYPE between B and E."
1762   (gnus-delete-wash-type type)
1763   (remove-text-properties
1764    b e (cons 'article-type (cons type gnus-hidden-properties)))
1765   (when (memq 'intangible gnus-hidden-properties)
1766     (put-text-property (max (1- b) (point-min))
1767                        b 'intangible nil)))
1768
1769 (defun gnus-article-hide-text-of-type (type)
1770   "Hide text of TYPE in the current buffer."
1771   (save-excursion
1772     (let ((b (point-min))
1773           (e (point-max)))
1774       (while (setq b (text-property-any b e 'article-type type))
1775         (add-text-properties b (incf b) gnus-hidden-properties)))))
1776
1777 (defun gnus-article-delete-text-of-type (type)
1778   "Delete text of TYPE in the current buffer."
1779   (save-excursion
1780     (let ((b (point-min)))
1781       (if (eq type 'multipart)
1782           ;; Remove MIME buttons associated with multipart/alternative parts.
1783           (progn
1784             (goto-char b)
1785             (while (if (get-text-property (point) 'gnus-part)
1786                        (setq b (point))
1787                      (when (setq b (next-single-property-change (point)
1788                                                                 'gnus-part))
1789                        (goto-char b)
1790                        t))
1791               (end-of-line)
1792               (skip-chars-forward "\n")
1793               (when (eq (get-text-property b 'article-type) 'multipart)
1794                 (delete-region b (point)))))
1795         (while (setq b (text-property-any b (point-max) 'article-type type))
1796           (delete-region
1797            b (or (text-property-not-all b (point-max) 'article-type type)
1798                  (point-max))))))))
1799
1800 (defun gnus-article-delete-invisible-text ()
1801   "Delete all invisible text in the current buffer."
1802   (save-excursion
1803     (let ((b (point-min)))
1804       (while (setq b (text-property-any b (point-max) 'invisible t))
1805         (delete-region
1806          b (or (text-property-not-all b (point-max) 'invisible t)
1807                (point-max)))))))
1808
1809 (defun gnus-article-text-type-exists-p (type)
1810   "Say whether any text of type TYPE exists in the buffer."
1811   (text-property-any (point-min) (point-max) 'article-type type))
1812
1813 (defsubst gnus-article-header-rank ()
1814   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1815   (let ((list gnus-sorted-header-list)
1816         (i 1))
1817     (while list
1818       (if (looking-at (car list))
1819           (setq list nil)
1820         (setq list (cdr list))
1821         (incf i)))
1822       i))
1823
1824 (defun article-hide-headers (&optional arg delete)
1825   "Hide unwanted headers and possibly sort them as well."
1826   (interactive)
1827   ;; This function might be inhibited.
1828   (unless gnus-inhibit-hiding
1829     (let ((inhibit-read-only t)
1830           (case-fold-search t)
1831           (max (1+ (length gnus-sorted-header-list)))
1832           (inhibit-point-motion-hooks t)
1833           (cur (current-buffer))
1834           ignored visible beg)
1835       (save-excursion
1836         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1837         ;; group parameters, so we should go to the summary buffer.
1838         (when (prog1
1839                   (condition-case nil
1840                       (progn (set-buffer gnus-summary-buffer) t)
1841                     (error nil))
1842                 (setq ignored (when (not gnus-visible-headers)
1843                                 (cond ((stringp gnus-ignored-headers)
1844                                        gnus-ignored-headers)
1845                                       ((listp gnus-ignored-headers)
1846                                        (mapconcat 'identity
1847                                                   gnus-ignored-headers
1848                                                   "\\|"))))
1849                       visible (cond ((stringp gnus-visible-headers)
1850                                      gnus-visible-headers)
1851                                     ((and gnus-visible-headers
1852                                           (listp gnus-visible-headers))
1853                                      (mapconcat 'identity
1854                                                 gnus-visible-headers
1855                                                 "\\|")))))
1856           (set-buffer cur))
1857         (save-restriction
1858           ;; First we narrow to just the headers.
1859           (article-narrow-to-head)
1860           ;; Hide any "From " lines at the beginning of (mail) articles.
1861           (while (looking-at "From ")
1862             (forward-line 1))
1863           (unless (bobp)
1864             (delete-region (point-min) (point)))
1865           ;; Then treat the rest of the header lines.
1866           ;; Then we use the two regular expressions
1867           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1868           ;; select which header lines is to remain visible in the
1869           ;; article buffer.
1870           (while (re-search-forward "^[^ \t:]*:" nil t)
1871             (beginning-of-line)
1872             ;; Mark the rank of the header.
1873             (put-text-property
1874              (point) (1+ (point)) 'message-rank
1875              (if (or (and visible (looking-at visible))
1876                      (and ignored
1877                           (not (looking-at ignored))))
1878                  (gnus-article-header-rank)
1879                (+ 2 max)))
1880             (forward-line 1))
1881           (message-sort-headers-1)
1882           (when (setq beg (text-property-any
1883                            (point-min) (point-max) 'message-rank (+ 2 max)))
1884             ;; We delete the unwanted headers.
1885             (gnus-add-wash-type 'headers)
1886             (add-text-properties (point-min) (+ 5 (point-min))
1887                                  '(article-type headers dummy-invisible t))
1888             (delete-region beg (point-max))))))))
1889
1890 (defun article-hide-boring-headers (&optional arg)
1891   "Toggle hiding of headers that aren't very interesting.
1892 If given a negative prefix, always show; if given a positive prefix,
1893 always hide."
1894   (interactive (gnus-article-hidden-arg))
1895   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1896              (not gnus-show-all-headers))
1897     (save-excursion
1898       (save-restriction
1899         (let ((inhibit-read-only t)
1900               (inhibit-point-motion-hooks t))
1901           (article-narrow-to-head)
1902           (dolist (elem gnus-boring-article-headers)
1903             (goto-char (point-min))
1904             (cond
1905              ;; Hide empty headers.
1906              ((eq elem 'empty)
1907               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1908                 (forward-line -1)
1909                 (gnus-article-hide-text-type
1910                  (point-at-bol)
1911                  (progn
1912                    (end-of-line)
1913                    (if (re-search-forward "^[^ \t]" nil t)
1914                        (match-beginning 0)
1915                      (point-max)))
1916                  'boring-headers)))
1917              ;; Hide boring Newsgroups header.
1918              ((eq elem 'newsgroups)
1919               (when (gnus-string-equal
1920                      (gnus-fetch-field "newsgroups")
1921                      (gnus-group-real-name
1922                       (if (boundp 'gnus-newsgroup-name)
1923                           gnus-newsgroup-name
1924                         "")))
1925                 (gnus-article-hide-header "newsgroups")))
1926              ((eq elem 'to-address)
1927               (let ((to (message-fetch-field "to"))
1928                     (to-address
1929                      (gnus-parameter-to-address
1930                       (if (boundp 'gnus-newsgroup-name)
1931                           gnus-newsgroup-name ""))))
1932                 (when (and to to-address
1933                            (ignore-errors
1934                              (gnus-string-equal
1935                               ;; only one address in To
1936                               (nth 1 (mail-extract-address-components to))
1937                               to-address)))
1938                   (gnus-article-hide-header "to"))))
1939              ((eq elem 'to-list)
1940               (let ((to (message-fetch-field "to"))
1941                     (to-list
1942                      (gnus-parameter-to-list
1943                       (if (boundp 'gnus-newsgroup-name)
1944                           gnus-newsgroup-name ""))))
1945                 (when (and to to-list
1946                            (ignore-errors
1947                              (gnus-string-equal
1948                               ;; only one address in To
1949                               (nth 1 (mail-extract-address-components to))
1950                               to-list)))
1951                   (gnus-article-hide-header "to"))))
1952              ((eq elem 'cc-list)
1953               (let ((cc (message-fetch-field "cc"))
1954                     (to-list
1955                      (gnus-parameter-to-list
1956                       (if (boundp 'gnus-newsgroup-name)
1957                           gnus-newsgroup-name ""))))
1958                 (when (and cc to-list
1959                            (ignore-errors
1960                              (gnus-string-equal
1961                               ;; only one address in CC
1962                               (nth 1 (mail-extract-address-components cc))
1963                               to-list)))
1964                   (gnus-article-hide-header "cc"))))
1965              ((eq elem 'followup-to)
1966               (when (gnus-string-equal
1967                      (message-fetch-field "followup-to")
1968                      (message-fetch-field "newsgroups"))
1969                 (gnus-article-hide-header "followup-to")))
1970              ((eq elem 'reply-to)
1971               (if (gnus-group-find-parameter
1972                    gnus-newsgroup-name 'broken-reply-to)
1973                   (gnus-article-hide-header "reply-to")
1974                 (let ((from (message-fetch-field "from"))
1975                       (reply-to (message-fetch-field "reply-to")))
1976                   (when
1977                       (and
1978                        from reply-to
1979                        (ignore-errors
1980                          (equal
1981                           (sort (mapcar
1982                                  (lambda (x) (downcase (cadr x)))
1983                                  (mail-extract-address-components from t))
1984                                 'string<)
1985                           (sort (mapcar
1986                                  (lambda (x) (downcase (cadr x)))
1987                                  (mail-extract-address-components reply-to t))
1988                                 'string<))))
1989                     (gnus-article-hide-header "reply-to")))))
1990              ((eq elem 'date)
1991               (let ((date (with-current-buffer gnus-original-article-buffer
1992                             ;; If date in `gnus-article-buffer' is localized
1993                             ;; (`gnus-treat-date-user-defined'),
1994                             ;; `days-between' might fail.
1995                             (message-fetch-field "date"))))
1996                 (when (and date
1997                            (< (days-between (current-time-string) date)
1998                               4))
1999                   (gnus-article-hide-header "date"))))
2000              ((eq elem 'long-to)
2001               (let ((to (message-fetch-field "to"))
2002                     (cc (message-fetch-field "cc")))
2003                 (when (> (length to) 1024)
2004                   (gnus-article-hide-header "to"))
2005                 (when (> (length cc) 1024)
2006                   (gnus-article-hide-header "cc"))))
2007              ((eq elem 'many-to)
2008               (let ((to-count 0)
2009                     (cc-count 0))
2010                 (goto-char (point-min))
2011                 (while (re-search-forward "^to:" nil t)
2012                   (setq to-count (1+ to-count)))
2013                 (when (> to-count 1)
2014                   (while (> to-count 0)
2015                     (goto-char (point-min))
2016                     (save-restriction
2017                       (re-search-forward "^to:" nil nil to-count)
2018                       (forward-line -1)
2019                       (narrow-to-region (point) (point-max))
2020                       (gnus-article-hide-header "to"))
2021                     (setq to-count (1- to-count))))
2022                 (goto-char (point-min))
2023                 (while (re-search-forward "^cc:" nil t)
2024                   (setq cc-count (1+ cc-count)))
2025                 (when (> cc-count 1)
2026                   (while (> cc-count 0)
2027                     (goto-char (point-min))
2028                     (save-restriction
2029                       (re-search-forward "^cc:" nil nil cc-count)
2030                       (forward-line -1)
2031                       (narrow-to-region (point) (point-max))
2032                       (gnus-article-hide-header "cc"))
2033                     (setq cc-count (1- cc-count)))))))))))))
2034
2035 (defun gnus-article-hide-header (header)
2036   (save-excursion
2037     (goto-char (point-min))
2038     (when (re-search-forward (concat "^" header ":") nil t)
2039       (gnus-article-hide-text-type
2040        (point-at-bol)
2041        (progn
2042          (end-of-line)
2043          (if (re-search-forward "^[^ \t]" nil t)
2044              (match-beginning 0)
2045            (point-max)))
2046        'boring-headers))))
2047
2048 (defvar gnus-article-normalized-header-length 40
2049   "Length of normalized headers.")
2050
2051 (defun article-normalize-headers ()
2052   "Make all header lines 40 characters long."
2053   (interactive)
2054   (let ((inhibit-read-only t)
2055         column)
2056     (save-excursion
2057       (save-restriction
2058         (article-narrow-to-head)
2059         (while (not (eobp))
2060           (cond
2061            ((< (setq column (- (point-at-eol) (point)))
2062                gnus-article-normalized-header-length)
2063             (end-of-line)
2064             (insert (make-string
2065                      (- gnus-article-normalized-header-length column)
2066                      ? )))
2067            ((> column gnus-article-normalized-header-length)
2068             (gnus-put-text-property
2069              (progn
2070                (forward-char gnus-article-normalized-header-length)
2071                (point))
2072              (point-at-eol)
2073              'invisible t))
2074            (t
2075             ;; Do nothing.
2076             ))
2077           (forward-line 1))))))
2078
2079 (defun article-treat-dumbquotes ()
2080   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2081 Note that this function guesses whether a character is a sm*rtq**t* or
2082 not, so it should only be used interactively.
2083
2084 Sm*rtq**t*s are M****s***'s unilateral extension to the
2085 iso-8859-1 character map in an attempt to provide more quoting
2086 characters.  If you see something like \\222 or \\264 where
2087 you're expecting some kind of apostrophe or quotation mark, then
2088 try this wash."
2089   (interactive)
2090   (article-translate-strings gnus-article-dumbquotes-map))
2091
2092 (defvar org-entities)
2093
2094 (defun article-treat-non-ascii ()
2095   "Translate many Unicode characters into their ASCII equivalents."
2096   (interactive)
2097   (require 'org-entities)
2098   (let ((table (make-char-table (if (featurep 'xemacs) 'generic))))
2099     (dolist (elem org-entities)
2100       (when (and (listp elem)
2101                  (= (length (nth 6 elem)) 1))
2102         (if (featurep 'xemacs)
2103             (put-char-table (aref (nth 6 elem) 0) (nth 4 elem) table)
2104           (set-char-table-range table (aref (nth 6 elem) 0) (nth 4 elem)))))
2105     (save-excursion
2106       (when (article-goto-body)
2107         (let ((inhibit-read-only t)
2108               replace props)
2109           (while (not (eobp))
2110             (if (not (setq replace (if (featurep 'xemacs)
2111                                        (get-char-table (following-char) table)
2112                                      (aref table (following-char)))))
2113                 (forward-char 1)
2114               (if (prog1
2115                       (setq props (text-properties-at (point)))
2116                     (delete-char 1))
2117                   (add-text-properties (point) (progn (insert replace) (point))
2118                                        props)
2119                 (insert replace)))))))))
2120
2121 (defun article-translate-characters (from to)
2122   "Translate all characters in the body of the article according to FROM and TO.
2123 FROM is a string of characters to translate from; to is a string of
2124 characters to translate to."
2125   (save-excursion
2126     (when (article-goto-body)
2127       (let ((inhibit-read-only t)
2128             (x (make-string 225 ?x))
2129             (i -1))
2130         (while (< (incf i) (length x))
2131           (aset x i i))
2132         (setq i 0)
2133         (while (< i (length from))
2134           (aset x (aref from i) (aref to i))
2135           (incf i))
2136         (translate-region (point) (point-max) x)))))
2137
2138 (defun article-translate-strings (map)
2139   "Translate all string in the body of the article according to MAP.
2140 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2141   (save-excursion
2142     (when (article-goto-body)
2143       (let ((inhibit-read-only t))
2144         (dolist (elem map)
2145           (let ((from (car elem))
2146                 (to (cadr elem)))
2147             (save-excursion
2148               (if (stringp from)
2149                   (while (search-forward from nil t)
2150                     (replace-match to))
2151                 (while (not (eobp))
2152                   (if (eq (following-char) from)
2153                       (progn
2154                         (delete-char 1)
2155                         (insert to))
2156                     (forward-char 1)))))))))))
2157
2158 (defun article-treat-overstrike ()
2159   "Translate overstrikes into bold text."
2160   (interactive)
2161   (save-excursion
2162     (when (article-goto-body)
2163       (let ((inhibit-read-only t))
2164         (while (search-forward "\b" nil t)
2165           (let ((next (char-after))
2166                 (previous (char-after (- (point) 2))))
2167             ;; We do the boldification/underlining by hiding the
2168             ;; overstrikes and putting the proper text property
2169             ;; on the letters.
2170             (cond
2171              ((eq next previous)
2172               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2173               (put-text-property (point) (1+ (point)) 'face 'bold))
2174              ((eq next ?_)
2175               (gnus-article-hide-text-type
2176                (1- (point)) (1+ (point)) 'overstrike)
2177               (put-text-property
2178                (- (point) 2) (1- (point)) 'face 'underline))
2179              ((eq previous ?_)
2180               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2181               (put-text-property
2182                (point) (1+ (point)) 'face 'underline)))))))))
2183
2184 (defun article-treat-ansi-sequences ()
2185   "Translate ANSI SGR control sequences into overlays or extents."
2186   (interactive)
2187   (save-excursion
2188     (when (article-goto-body)
2189       (let ((inhibit-read-only t))
2190         (ansi-color-apply-on-region (point) (point-max))))))
2191
2192 (defun gnus-article-treat-unfold-headers ()
2193   "Unfold folded message headers.
2194 Only the headers that fit into the current window width will be
2195 unfolded."
2196   (interactive)
2197   (gnus-with-article-headers
2198     (let (length)
2199       (while (not (eobp))
2200         (save-restriction
2201           (mail-header-narrow-to-field)
2202           (let* ((header (buffer-string))
2203                  (unfoldable
2204                   (or (equal gnus-article-unfold-long-headers t)
2205                       (and (stringp gnus-article-unfold-long-headers)
2206                            (string-match gnus-article-unfold-long-headers header)))))
2207             (with-temp-buffer
2208               (insert header)
2209               (goto-char (point-min))
2210               (while (re-search-forward "\n[\t ]" nil t)
2211                 (replace-match " " t t)))
2212             (setq length (- (point-max) (point-min) 1))
2213             (when (or unfoldable
2214                       (< length (window-width)))
2215               (while (re-search-forward "\n[\t ]" nil t)
2216                 (replace-match " " t t))))
2217           (goto-char (point-max)))))))
2218
2219 (defun gnus-article-treat-fold-headers ()
2220   "Fold message headers."
2221   (interactive)
2222   (gnus-with-article-headers
2223     (while (not (eobp))
2224       (save-restriction
2225         (mail-header-narrow-to-field)
2226         (mail-header-fold-field)
2227         (goto-char (point-max))))))
2228
2229 (defun gnus-treat-smiley ()
2230   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2231   (interactive)
2232   (gnus-with-article-buffer
2233     (if (memq 'smiley gnus-article-wash-types)
2234         (gnus-delete-images 'smiley)
2235       (article-goto-body)
2236       (let ((images (smiley-region (point) (point-max))))
2237         (when images
2238           (gnus-add-wash-type 'smiley)
2239           (dolist (image images)
2240             (gnus-add-image 'smiley image)))))))
2241
2242 (defun gnus-article-remove-images ()
2243   "Remove all images from the article buffer."
2244   (interactive)
2245   (gnus-with-article-buffer
2246     (save-restriction
2247       (widen)
2248       (dolist (elem gnus-article-image-alist)
2249         (gnus-delete-images (car elem))))))
2250
2251 (defun gnus-article-show-images ()
2252   "Show any images that are in the HTML-rendered article buffer.
2253 This only works if the article in question is HTML."
2254   (interactive)
2255   (gnus-with-article-buffer
2256     (save-restriction
2257       (widen)
2258       (dolist (region (gnus-find-text-property-region (point-min) (point-max)
2259                                                       'image-displayer))
2260         (destructuring-bind (start end function) region
2261           (funcall function (get-text-property start 'image-url)
2262                    start end))))))
2263
2264 (defun gnus-article-treat-fold-newsgroups ()
2265   "Unfold folded message headers.
2266 Only the headers that fit into the current window width will be
2267 unfolded."
2268   (interactive)
2269   (gnus-with-article-headers
2270     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2271       (save-restriction
2272         (mail-header-narrow-to-field)
2273         (while (re-search-forward ", *" nil t)
2274           (replace-match ", " t t))
2275         (mail-header-fold-field)
2276         (goto-char (point-max))))))
2277
2278 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2279   "Value of `truncate-lines' in Gnus Article buffer.
2280 Valid values are nil, t, `head', `first', `last', an integer or a
2281 predicate.  See Info node `(gnus)Customizing Articles'."
2282   :version "23.1" ;; No Gnus
2283   :group 'gnus-article
2284   ;; :link '(custom-manual "(gnus)Customizing Articles")
2285   :type 'boolean)
2286
2287 (defun gnus-article-toggle-truncate-lines (&optional arg)
2288   "Toggle whether to fold or truncate long lines in article the buffer.
2289 If ARG is non-nil and not a number, toggle
2290 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2291 long lines if and only if arg is positive."
2292   (interactive "P")
2293   (cond
2294    ((and (numberp arg) (> arg 0))
2295     (setq gnus-article-truncate-lines t))
2296    ((numberp arg)
2297     (setq gnus-article-truncate-lines nil))
2298    (arg
2299     (setq gnus-article-truncate-lines
2300           (not gnus-article-truncate-lines))))
2301   (gnus-with-article-buffer
2302     (cond
2303      ((and (numberp arg) (> arg 0))
2304       (setq truncate-lines nil))
2305      ((numberp arg)
2306       (setq truncate-lines t)))
2307     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2308     ;; `toggle-truncate-lines' needs an argument.
2309     (toggle-truncate-lines)))
2310
2311 (defun gnus-article-treat-body-boundary ()
2312   "Place a boundary line at the end of the headers."
2313   (interactive)
2314   (when (and gnus-body-boundary-delimiter
2315              (> (length gnus-body-boundary-delimiter) 0))
2316     (gnus-with-article-headers
2317       (goto-char (point-max))
2318       (let ((start (point)))
2319         (insert "X-Boundary: ")
2320         (gnus-add-text-properties start (point) '(invisible t intangible t))
2321         (insert (let (str)
2322                   (while (>= (window-width) (length str))
2323                     (setq str (concat str gnus-body-boundary-delimiter)))
2324                   (substring str 0 (window-width)))
2325                 "\n")
2326         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2327
2328 (defun article-fill-long-lines ()
2329   "Fill lines that are wider than the window width."
2330   (interactive)
2331   (save-excursion
2332     (let ((inhibit-read-only t)
2333           (width (window-width (get-buffer-window (current-buffer)))))
2334       (save-restriction
2335         (article-goto-body)
2336         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2337           (while (not (eobp))
2338             (end-of-line)
2339             (when (>= (current-column) (min fill-column width))
2340               (narrow-to-region (min (1+ (point)) (point-max))
2341                                 (point-at-bol))
2342               (let ((goback (point-marker)))
2343                 (fill-paragraph nil)
2344                 (goto-char (marker-position goback)))
2345               (widen))
2346             (forward-line 1)))))))
2347
2348 (defun article-capitalize-sentences ()
2349   "Capitalize the first word in each sentence."
2350   (interactive)
2351   (save-excursion
2352     (let ((inhibit-read-only t)
2353           (paragraph-start "^[\n\^L]"))
2354       (article-goto-body)
2355       (while (not (eobp))
2356         (capitalize-word 1)
2357         (forward-sentence)))))
2358
2359 (defun article-remove-cr ()
2360   "Remove trailing CRs and then translate remaining CRs into LFs."
2361   (interactive)
2362   (save-excursion
2363     (let ((inhibit-read-only t))
2364       (goto-char (point-min))
2365       (while (re-search-forward "\r+$" nil t)
2366         (replace-match "" t t))
2367       (goto-char (point-min))
2368       (while (search-forward "\r" nil t)
2369         (replace-match "\n" t t)))))
2370
2371 (defun article-remove-trailing-blank-lines ()
2372   "Remove all trailing blank lines from the article."
2373   (interactive)
2374   (save-excursion
2375     (let ((inhibit-read-only t))
2376       (goto-char (point-max))
2377       (delete-region
2378        (point)
2379        (progn
2380          (while (and (not (bobp))
2381                      (looking-at "^[ \t]*$")
2382                      (not (gnus-annotation-in-region-p
2383                            (point) (point-at-eol))))
2384            (forward-line -1))
2385          (forward-line 1)
2386          (point))))))
2387
2388 (defvar gnus-face-properties-alist)
2389
2390 (defun article-display-face (&optional force)
2391   "Display any Face headers in the header."
2392   (interactive (list 'force))
2393   (let ((wash-face-p buffer-read-only))
2394     (gnus-with-article-headers
2395       ;; When displaying parts, this function can be called several times on
2396       ;; the same article, without any intended toggle semantic (as typing `W
2397       ;; D d' would have). So face deletion must occur only when we come from
2398       ;; an interactive command, that is when the *Article* buffer is
2399       ;; read-only.
2400       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2401           (gnus-delete-images 'face)
2402         (let ((from (message-fetch-field "from"))
2403               face faces)
2404           (save-current-buffer
2405             (when (and wash-face-p
2406                        (gnus-buffer-live-p gnus-original-article-buffer)
2407                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2408               (set-buffer gnus-original-article-buffer))
2409             (save-restriction
2410               (mail-narrow-to-head)
2411               (when (or force
2412                         ;; Check whether this face is censored.
2413                         (not (and gnus-article-x-face-too-ugly
2414                                   (or from
2415                                       (setq from (message-fetch-field "from")))
2416                                   (string-match gnus-article-x-face-too-ugly
2417                                                 from))))
2418                 (while (gnus-article-goto-header "Face")
2419                   (push (mail-header-field-value) faces)))))
2420           (when faces
2421             (goto-char (point-min))
2422             (let (png image)
2423               (unless (setq from (gnus-article-goto-header "from"))
2424                 (insert "From:")
2425                 (setq from (point))
2426                 (insert " [no `from' set]\n"))
2427               (while faces
2428                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2429                   (setq image
2430                         (apply 'gnus-create-image png 'png t
2431                                (cdr (assq 'png gnus-face-properties-alist))))
2432                   (goto-char from)
2433                   (gnus-add-wash-type 'face)
2434                   (gnus-add-image 'face image)
2435                   (gnus-put-image image nil 'face))))))))))
2436
2437 (defun article-display-x-face (&optional force)
2438   "Look for an X-Face header and display it if present."
2439   (interactive (list 'force))
2440   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2441     (gnus-with-article-headers
2442       ;; Delete the old process, if any.
2443       (when (process-status "article-x-face")
2444         (delete-process "article-x-face"))
2445       ;; See the comment in `article-display-face'.
2446       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2447           ;; We have already displayed X-Faces, so we remove them
2448           ;; instead.
2449           (gnus-delete-images 'xface)
2450         ;; Display X-Faces.
2451         (let ((from (message-fetch-field "from"))
2452               x-faces face)
2453           (save-current-buffer
2454             (when (and wash-face-p
2455                        (gnus-buffer-live-p gnus-original-article-buffer)
2456                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2457               ;; If type `W f', use gnus-original-article-buffer,
2458               ;; otherwise use the current buffer because displaying
2459               ;; RFC822 parts calls this function too.
2460               (set-buffer gnus-original-article-buffer))
2461             (save-restriction
2462               (mail-narrow-to-head)
2463               (and gnus-article-x-face-command
2464                    (or force
2465                        ;; Check whether this face is censored.
2466                        (not (and gnus-article-x-face-too-ugly
2467                                  (or from
2468                                      (setq from (message-fetch-field "from")))
2469                                  (string-match gnus-article-x-face-too-ugly
2470                                                from))))
2471                    (while (gnus-article-goto-header "X-Face")
2472                      (push (mail-header-field-value) x-faces)))))
2473           (when x-faces
2474             ;; We display the face.
2475             (cond ((functionp gnus-article-x-face-command)
2476                    ;; The command is a lisp function, so we call it.
2477                    (mapc gnus-article-x-face-command x-faces))
2478                   ((stringp gnus-article-x-face-command)
2479                    ;; The command is a string, so we interpret the command
2480                    ;; as a, well, command, and fork it off.
2481                    (let ((process-connection-type nil))
2482                      (gnus-set-process-query-on-exit-flag
2483                       (start-process
2484                        "article-x-face" nil shell-file-name
2485                        shell-command-switch gnus-article-x-face-command)
2486                       nil)
2487                      ;; Sending multiple EOFs to xv doesn't work,
2488                      ;; so we only do a single external face.
2489                      (with-temp-buffer
2490                        (insert (car x-faces))
2491                        (process-send-region "article-x-face"
2492                                             (point-min) (point-max)))
2493                      (process-send-eof "article-x-face")))
2494                   (t
2495                    (error "`%s' set to `%s' is not a function"
2496                           gnus-article-x-face-command
2497                           'gnus-article-x-face-command)))))))))
2498
2499 (defun article-decode-mime-words ()
2500   "Decode all MIME-encoded words in the article."
2501   (interactive)
2502   (gnus-with-article-buffer
2503     (let ((inhibit-point-motion-hooks t)
2504           (mail-parse-charset gnus-newsgroup-charset)
2505           (mail-parse-ignored-charsets
2506            (with-current-buffer gnus-summary-buffer
2507              gnus-newsgroup-ignored-charsets)))
2508       (mail-decode-encoded-word-region (point-min) (point-max)))))
2509
2510 (defun article-decode-charset (&optional prompt)
2511   "Decode charset-encoded text in the article.
2512 If PROMPT (the prefix), prompt for a coding system to use."
2513   (interactive "P")
2514   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2515         (inhibit-read-only t)
2516         (mail-parse-charset gnus-newsgroup-charset)
2517         (mail-parse-ignored-charsets
2518          (save-excursion (condition-case nil
2519                              (set-buffer gnus-summary-buffer)
2520                            (error))
2521                          gnus-newsgroup-ignored-charsets))
2522         ct cte ctl charset format)
2523     (save-excursion
2524       (save-restriction
2525         (article-narrow-to-head)
2526         (setq ct (message-fetch-field "Content-Type" t)
2527               cte (message-fetch-field "Content-Transfer-Encoding" t)
2528               ctl (and ct (mail-header-parse-content-type ct))
2529               charset (cond
2530                        (prompt
2531                         (mm-read-coding-system "Charset to decode: "))
2532                        (ctl
2533                         (mail-content-type-get ctl 'charset)))
2534               format (and ctl (mail-content-type-get ctl 'format)))
2535         (when cte
2536           (setq cte (mail-header-strip cte)))
2537         (if (and ctl (not (string-match "/" (car ctl))))
2538             (setq ctl nil))
2539         (goto-char (point-max)))
2540       (forward-line 1)
2541       (save-restriction
2542         (narrow-to-region (point) (point-max))
2543         (when (and (eq mail-parse-charset 'gnus-decoded)
2544                    (eq (mm-body-7-or-8) '8bit))
2545           ;; The text code could have been decoded.
2546           (setq charset mail-parse-charset))
2547         (when (and (or (not ctl)
2548                        (equal (car ctl) "text/plain"))
2549                    (not format)) ;; article with format will decode later.
2550           (mm-decode-body
2551            charset (and cte (intern (downcase
2552                                      (gnus-strip-whitespace cte))))
2553            (car ctl)))))))
2554
2555 (defun article-decode-encoded-words ()
2556   "Remove encoded-word encoding from headers."
2557   (let ((inhibit-point-motion-hooks t)
2558         (mail-parse-charset gnus-newsgroup-charset)
2559         (mail-parse-ignored-charsets
2560          (save-excursion (condition-case nil
2561                              (set-buffer gnus-summary-buffer)
2562                            (error))
2563                          gnus-newsgroup-ignored-charsets))
2564         (inhibit-read-only t)
2565         end start)
2566     (goto-char (point-min))
2567     (when (search-forward "\n\n" nil 'move)
2568       (forward-line -1))
2569     (setq end (point))
2570     (while (not (bobp))
2571       (while (progn
2572                (forward-line -1)
2573                (and (not (bobp))
2574                     (memq (char-after) '(?\t ? )))))
2575       (setq start (point))
2576       (if (looking-at "\
2577 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2578 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2579           (funcall gnus-decode-address-function start end)
2580         (funcall gnus-decode-header-function start end))
2581       (goto-char (setq end start)))))
2582
2583 (defun article-decode-group-name ()
2584   "Decode group names in Newsgroups, Followup-To and Xref headers."
2585   (let ((inhibit-point-motion-hooks t)
2586         (inhibit-read-only t)
2587         (method (gnus-find-method-for-group gnus-newsgroup-name))
2588         regexp)
2589     (when (and (or gnus-group-name-charset-method-alist
2590                    gnus-group-name-charset-group-alist)
2591                (gnus-buffer-live-p gnus-original-article-buffer))
2592       (save-restriction
2593         (article-narrow-to-head)
2594         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2595           (with-current-buffer gnus-original-article-buffer
2596             (goto-char (point-min)))
2597           (setq regexp (concat "^" header
2598                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2599           (while (re-search-forward regexp nil t)
2600             (replace-match (save-match-data
2601                              (gnus-decode-newsgroups
2602                               ;; XXX how to use data in article buffer?
2603                               (with-current-buffer gnus-original-article-buffer
2604                                 (re-search-forward regexp nil t)
2605                                 (match-string 1))
2606                               gnus-newsgroup-name method))
2607                            t t nil 1))
2608           (goto-char (point-min)))))))
2609
2610 (autoload 'idna-to-unicode "idna")
2611
2612 (defun article-decode-idna-rhs ()
2613   "Decode IDNA strings in RHS in various headers in current buffer.
2614 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2615 Mail-Reply-To: and Mail-Followup-To:."
2616   (when gnus-use-idna
2617     (save-restriction
2618       (let ((inhibit-point-motion-hooks t)
2619             (inhibit-read-only t))
2620         (article-narrow-to-head)
2621         (goto-char (point-min))
2622         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2623           (let (ace unicode)
2624             (when (save-match-data
2625                     (and (setq ace (match-string 1))
2626                          (save-excursion
2627                            (and (re-search-backward "^[^ \t]" nil t)
2628                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2629                          (setq unicode (idna-to-unicode ace))))
2630               (unless (string= ace unicode)
2631                 (replace-match unicode nil nil nil 1)))))))))
2632
2633 (defun article-de-quoted-unreadable (&optional force read-charset)
2634   "Translate a quoted-printable-encoded article.
2635 If FORCE, decode the article whether it is marked as quoted-printable
2636 or not.
2637 If READ-CHARSET, ask for a coding system."
2638   (interactive (list 'force current-prefix-arg))
2639   (save-excursion
2640     (let ((inhibit-read-only t) type charset)
2641       (if (gnus-buffer-live-p gnus-original-article-buffer)
2642           (with-current-buffer gnus-original-article-buffer
2643             (setq type
2644                   (gnus-fetch-field "content-transfer-encoding"))
2645             (let* ((ct (gnus-fetch-field "content-type"))
2646                    (ctl (and ct (mail-header-parse-content-type ct))))
2647               (setq charset (and ctl
2648                                  (mail-content-type-get ctl 'charset)))
2649               (if (stringp charset)
2650                   (setq charset (intern (downcase charset)))))))
2651       (if read-charset
2652           (setq charset (mm-read-coding-system "Charset: " charset)))
2653       (unless charset
2654         (setq charset gnus-newsgroup-charset))
2655       (when (or force
2656                 (and type (let ((case-fold-search t))
2657                             (string-match "quoted-printable" type))))
2658         (article-goto-body)
2659         (quoted-printable-decode-region
2660          (point) (point-max) (mm-charset-to-coding-system charset))))))
2661
2662 (defun article-de-base64-unreadable (&optional force read-charset)
2663   "Translate a base64 article.
2664 If FORCE, decode the article whether it is marked as base64 not.
2665 If READ-CHARSET, ask for a coding system."
2666   (interactive (list 'force current-prefix-arg))
2667   (save-excursion
2668     (let ((inhibit-read-only t) type charset)
2669       (if (gnus-buffer-live-p gnus-original-article-buffer)
2670           (with-current-buffer gnus-original-article-buffer
2671             (setq type
2672                   (gnus-fetch-field "content-transfer-encoding"))
2673             (let* ((ct (gnus-fetch-field "content-type"))
2674                    (ctl (and ct (mail-header-parse-content-type ct))))
2675               (setq charset (and ctl
2676                                  (mail-content-type-get ctl 'charset)))
2677               (if (stringp charset)
2678                   (setq charset (intern (downcase charset)))))))
2679       (if read-charset
2680           (setq charset (mm-read-coding-system "Charset: " charset)))
2681       (unless charset
2682         (setq charset gnus-newsgroup-charset))
2683       (when (or force
2684                 (and type (let ((case-fold-search t))
2685                             (string-match "base64" type))))
2686         (article-goto-body)
2687         (save-restriction
2688           (narrow-to-region (point) (point-max))
2689           (base64-decode-region (point-min) (point-max))
2690           (mm-decode-coding-region
2691            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2692
2693 (eval-when-compile
2694   (require 'rfc1843))
2695
2696 (defun article-decode-HZ ()
2697   "Translate a HZ-encoded article."
2698   (interactive)
2699   (require 'rfc1843)
2700   (save-excursion
2701     (let ((inhibit-read-only t))
2702       (rfc1843-decode-region (point-min) (point-max)))))
2703
2704 (defun article-unsplit-urls ()
2705   "Remove the newlines that some other mailers insert into URLs."
2706   (interactive)
2707   (save-excursion
2708     (let ((inhibit-read-only t))
2709       (goto-char (point-min))
2710       (while (re-search-forward
2711               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2712         (replace-match "\\1\\3" t)))
2713     (when (interactive-p)
2714       (gnus-treat-article nil))))
2715
2716 (defun article-wash-html ()
2717   "Format an HTML article."
2718   (interactive)
2719   (let ((handles nil)
2720         (buffer-read-only nil))
2721     (when (gnus-buffer-live-p gnus-original-article-buffer)
2722       (setq handles (mm-dissect-buffer t t)))
2723     (article-goto-body)
2724     (delete-region (point) (point-max))
2725     (mm-inline-text-html handles)))
2726
2727 (defvar gnus-article-browse-html-temp-list nil
2728   "List of temporary files created by `gnus-article-browse-html-parts'.
2729 Internal variable.")
2730
2731 (defcustom gnus-article-browse-delete-temp 'ask
2732   "What to do with temporary files from `gnus-article-browse-html-parts'.
2733 If nil, don't delete temporary files.  If it is t, delete them on
2734 exit from the summary buffer.  If it is the symbol `file', query
2735 on each file, if it is `ask' ask once when exiting from the
2736 summary buffer."
2737   :group 'gnus-article
2738   :version "23.1" ;; No Gnus
2739   :type '(choice (const :tag "Don't delete" nil)
2740                  (const :tag "Don't ask" t)
2741                  (const :tag "Ask" ask)
2742                  (const :tag "Ask for each file" file)))
2743
2744 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2745
2746 (defun gnus-article-browse-delete-temp-files (&optional how)
2747   "Delete temp-files created by `gnus-article-browse-html-parts'."
2748   (when (and gnus-article-browse-html-temp-list
2749              (progn
2750                (or how (setq how gnus-article-browse-delete-temp))
2751                (if (eq how 'ask)
2752                    (let ((files (length gnus-article-browse-html-temp-list)))
2753                      (gnus-y-or-n-p (format
2754                                      "Delete all %s temporary HTML file%s? "
2755                                      files
2756                                      (if (> files 1) "s" ""))))
2757                  how)))
2758     (dolist (file gnus-article-browse-html-temp-list)
2759       (cond ((file-directory-p file)
2760              (when (or (not (eq how 'file))
2761                        (gnus-y-or-n-p
2762                         (format
2763                          "Delete temporary HTML file(s) in directory `%s'? "
2764                          (file-name-as-directory file))))
2765                (gnus-delete-directory file)))
2766             ((file-exists-p file)
2767              (when (or (not (eq how 'file))
2768                        (gnus-y-or-n-p
2769                         (format "Delete temporary HTML file `%s'? " file)))
2770                (delete-file file)))))
2771     ;; Also remove file from the list when not deleted or if file doesn't
2772     ;; exist anymore.
2773     (setq gnus-article-browse-html-temp-list nil))
2774   gnus-article-browse-html-temp-list)
2775
2776 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2777   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2778 Return file name."
2779   (save-match-data
2780     (let (file type)
2781       (catch 'found
2782         (dolist (handle handles)
2783           (cond
2784            ((not (listp handle)))
2785            ((equal (mm-handle-media-supertype handle) "multipart")
2786             (when (setq file (gnus-article-browse-html-save-cid-content
2787                               cid handle directory))
2788               (throw 'found file)))
2789            ((equal (concat "<" cid ">") (mm-handle-id handle))
2790             (setq file
2791                   (expand-file-name
2792                    (or (mail-content-type-get
2793                         (mm-handle-disposition handle) 'filename)
2794                        (mail-content-type-get
2795                         (setq type (mm-handle-type handle)) 'name)
2796                        (concat
2797                         (make-temp-name "cid")
2798                         (car (rassoc (car type) mailcap-mime-extensions))))
2799                    directory))
2800             (mm-save-part-to-file handle file)
2801             (throw 'found file))))))))
2802
2803 (defun gnus-article-browse-html-parts (list &optional header)
2804   "View all \"text/html\" parts from LIST.
2805 Recurse into multiparts.  The optional HEADER that should be a decoded
2806 message header will be added to the bodies of the \"text/html\" parts."
2807   ;; Internal function used by `gnus-article-browse-html-article'.
2808   (let (type file charset content cid-dir tmp-file showed)
2809     ;; Find and show the html-parts.
2810     (dolist (handle list)
2811       ;; If HTML, show it:
2812       (cond ((not (listp handle)))
2813             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2814                  (and (equal (car type) "message/external-body")
2815                       (or header
2816                           (setq file (or (mail-content-type-get type 'name)
2817                                          (mail-content-type-get
2818                                           (mm-handle-disposition handle)
2819                                           'filename))))
2820                       (or (mm-handle-cache handle)
2821                           (condition-case code
2822                               (progn (mm-extern-cache-contents handle) t)
2823                             (error
2824                              (gnus-message 3 "%s" (error-message-string code))
2825                              (when (>= gnus-verbose 3) (sit-for 2))
2826                              nil)))
2827                       (progn
2828                         (setq handle (mm-handle-cache handle)
2829                               type (mm-handle-type handle))
2830                         (equal (car type) "text/html"))))
2831              (setq charset (mail-content-type-get type 'charset)
2832                    content (mm-get-part handle))
2833              (with-temp-buffer
2834                (if (eq charset 'gnus-decoded)
2835                    (mm-enable-multibyte)
2836                  (mm-disable-multibyte))
2837                (insert content)
2838                ;; resolve cid contents
2839                (let ((case-fold-search t)
2840                      cid-file)
2841                  (goto-char (point-min))
2842                  (while (re-search-forward "\
2843 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2844                                            nil t)
2845                    (unless cid-dir
2846                      (setq cid-dir (mm-make-temp-file "cid" t))
2847                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2848                    (setq file nil
2849                          content nil)
2850                    (when (setq cid-file
2851                                (gnus-article-browse-html-save-cid-content
2852                                 (match-string 2)
2853                                 (with-current-buffer gnus-article-buffer
2854                                   gnus-article-mime-handles)
2855                                 cid-dir))
2856                      (replace-match (concat "file://" cid-file)
2857                                     nil nil nil 1))))
2858                (unless content (setq content (buffer-string))))
2859              (when (or charset header (not file))
2860                (setq tmp-file (mm-make-temp-file
2861                                ;; Do we need to care for 8.3 filenames?
2862                                "mm-" nil ".html")))
2863              ;; Add a meta html tag to specify charset and a header.
2864              (cond
2865               (header
2866                (let (title eheader body hcharset coding force-charset)
2867                  (with-temp-buffer
2868                    (mm-enable-multibyte)
2869                    (setq case-fold-search t)
2870                    (insert header "\n")
2871                    (setq title (message-fetch-field "subject"))
2872                    (goto-char (point-min))
2873                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2874                      (replace-match (cond ((match-beginning 1) "&lt;")
2875                                           ((match-beginning 2) "&gt;")
2876                                           (t "&amp;"))))
2877                    (goto-char (point-min))
2878                    (insert "<pre>\n")
2879                    (goto-char (point-max))
2880                    (insert "</pre>\n<hr>\n")
2881                    ;; We have to examine charset one by one since
2882                    ;; charset specified in parts might be different.
2883                    (if (eq charset 'gnus-decoded)
2884                        (setq charset 'utf-8
2885                              eheader (mm-encode-coding-string (buffer-string)
2886                                                               charset)
2887                              title (when title
2888                                      (mm-encode-coding-string title charset))
2889                              body (mm-encode-coding-string content charset)
2890                              force-charset t)
2891                      (setq hcharset (mm-find-mime-charset-region (point-min)
2892                                                                  (point-max)))
2893                      (cond ((= (length hcharset) 1)
2894                             (setq hcharset (car hcharset)
2895                                   coding (mm-charset-to-coding-system
2896                                           hcharset)))
2897                            ((> (length hcharset) 1)
2898                             (setq hcharset 'utf-8
2899                                   coding hcharset)))
2900                      (if coding
2901                          (if charset
2902                              (progn
2903                                (setq body
2904                                      (mm-charset-to-coding-system charset))
2905                                (if (eq coding body)
2906                                    (setq eheader (mm-encode-coding-string
2907                                                   (buffer-string) coding)
2908                                          title (when title
2909                                                  (mm-encode-coding-string
2910                                                   title coding))
2911                                          body content)
2912                                  (setq charset 'utf-8
2913                                        eheader (mm-encode-coding-string
2914                                                 (buffer-string) charset)
2915                                        title (when title
2916                                                (mm-encode-coding-string
2917                                                 title charset))
2918                                        body (mm-encode-coding-string
2919                                              (mm-decode-coding-string
2920                                               content body)
2921                                              charset)
2922                                        force-charset t)))
2923                            (setq charset hcharset
2924                                  eheader (mm-encode-coding-string
2925                                           (buffer-string) coding)
2926                                  title (when title
2927                                          (mm-encode-coding-string
2928                                           title coding))
2929                                  body content))
2930                        (setq eheader (mm-string-as-unibyte (buffer-string))
2931                              body content)))
2932                    (erase-buffer)
2933                    (mm-disable-multibyte)
2934                    (insert body)
2935                    (when charset
2936                      (mm-add-meta-html-tag handle charset force-charset))
2937                    (when title
2938                      (goto-char (point-min))
2939                      (unless (search-forward "<title>" nil t)
2940                        (re-search-forward "<head>\\s-*" nil t)
2941                        (insert "<title>" title "</title>\n")))
2942                    (goto-char (point-min))
2943                    (or (re-search-forward
2944                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
2945                        (re-search-forward
2946                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
2947                    (insert eheader)
2948                    (mm-write-region (point-min) (point-max)
2949                                     tmp-file nil nil nil 'binary t))))
2950               (charset
2951                (mm-with-unibyte-buffer
2952                  (insert (if (eq charset 'gnus-decoded)
2953                              (mm-encode-coding-string content
2954                                                       (setq charset 'utf-8))
2955                            content))
2956                  (if (or (mm-add-meta-html-tag handle charset)
2957                          (not file))
2958                      (mm-write-region (point-min) (point-max)
2959                                       tmp-file nil nil nil 'binary t)
2960                    (setq tmp-file nil))))
2961               (tmp-file
2962                (mm-save-part-to-file handle tmp-file)))
2963              (when tmp-file
2964                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
2965              (add-hook 'gnus-summary-prepare-exit-hook
2966                        'gnus-article-browse-delete-temp-files)
2967              (add-hook 'gnus-exit-gnus-hook
2968                        (lambda  ()
2969                          (gnus-article-browse-delete-temp-files t)))
2970              ;; FIXME: Warn if there's an <img> tag?
2971              (browse-url-of-file (or tmp-file (expand-file-name file)))
2972              (setq showed t))
2973             ;; If multipart, recurse
2974             ((equal (mm-handle-media-supertype handle) "multipart")
2975              (when (gnus-article-browse-html-parts handle header)
2976                (setq showed t)))
2977             ((equal (mm-handle-media-type handle) "message/rfc822")
2978              (mm-with-multibyte-buffer
2979                (mm-insert-part handle)
2980                (setq handle (mm-dissect-buffer t t))
2981                (when (and (bufferp (car handle))
2982                           (stringp (car (mm-handle-type handle))))
2983                  (setq handle (list handle)))
2984                (when header
2985                  (article-decode-encoded-words)
2986                  (let ((gnus-visible-headers
2987                         (or (get 'gnus-visible-headers 'standard-value)
2988                             gnus-visible-headers)))
2989                    (article-hide-headers))
2990                  (goto-char (point-min))
2991                  (search-forward "\n\n" nil 'move)
2992                  (skip-chars-backward "\t\n ")
2993                  (setq header (buffer-substring (point-min) (point)))))
2994              (when (prog1
2995                        (gnus-article-browse-html-parts handle header)
2996                      (mm-destroy-parts handle))
2997                (setq showed t)))))
2998     showed))
2999
3000 (defun gnus-article-browse-html-article (&optional arg)
3001   "View \"text/html\" parts of the current article with a WWW browser.
3002 Inline images embedded in a message using the cid scheme, as they are
3003 generally considered to be safe, will be processed properly.
3004 The message header is added to the beginning of every html part unless
3005 the prefix argument ARG is given.
3006
3007 Warning: Spammers use links to images (using the http scheme) in HTML
3008 articles to verify whether you have read the message.  As
3009 `gnus-article-browse-html-article' passes the HTML content to the
3010 browser without eliminating these \"web bugs\" you should only
3011 use it for mails from trusted senders.
3012
3013 If you always want to display HTML parts in the browser, set
3014 `mm-text-html-renderer' to nil.
3015
3016 This command creates temporary files to pass HTML contents including
3017 images if any to the browser, and deletes them when exiting the group
3018 \(if you want)."
3019   ;; Cf. `mm-w3m-safe-url-regexp'
3020   (interactive "P")
3021   (if arg
3022       (gnus-summary-show-article)
3023     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3024                                     gnus-visible-headers))
3025           ;; As we insert a <hr>, there's no need for the body boundary.
3026           (gnus-treat-body-boundary nil))
3027       (gnus-summary-show-article)))
3028   (with-current-buffer gnus-article-buffer
3029     (let ((header (unless arg
3030                     (save-restriction
3031                       (widen)
3032                       (buffer-substring-no-properties
3033                        (goto-char (point-min))
3034                        (if (search-forward "\n\n" nil t)
3035                            (match-beginning 0)
3036                          (goto-char (point-max))
3037                          (skip-chars-backward "\t\n ")
3038                          (point))))))
3039           parts)
3040       (set-buffer gnus-original-article-buffer)
3041       (setq parts (mm-dissect-buffer t t))
3042       ;; If singlepart, enforce a list.
3043       (when (and (bufferp (car parts))
3044                  (stringp (car (mm-handle-type parts))))
3045         (setq parts (list parts)))
3046       ;; Process the list
3047       (unless (gnus-article-browse-html-parts parts header)
3048         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3049       (mm-destroy-parts parts)
3050       (unless arg
3051         (gnus-summary-show-article)))))
3052
3053 (defun article-hide-list-identifiers ()
3054   "Remove list identifies from the Subject header.
3055 The `gnus-list-identifiers' variable specifies what to do."
3056   (interactive)
3057   (let ((inhibit-point-motion-hooks t)
3058         (regexp (if (consp gnus-list-identifiers)
3059                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3060                   gnus-list-identifiers))
3061         (inhibit-read-only t))
3062     (when regexp
3063       (save-excursion
3064         (save-restriction
3065           (article-narrow-to-head)
3066           (goto-char (point-min))
3067           (while (re-search-forward
3068                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3069                   nil t)
3070             (delete-region (match-beginning 2) (match-end 0))
3071             (beginning-of-line))
3072           (when (re-search-forward
3073                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3074             (delete-region (match-beginning 1) (match-end 1))))))))
3075
3076 (defun article-hide-pem (&optional arg)
3077   "Toggle hiding of any PEM headers and signatures in the current article.
3078 If given a negative prefix, always show; if given a positive prefix,
3079 always hide."
3080   (interactive (gnus-article-hidden-arg))
3081   (unless (gnus-article-check-hidden-text 'pem arg)
3082     (save-excursion
3083       (let ((inhibit-read-only t) end)
3084         (goto-char (point-min))
3085         ;; Hide the horrendously ugly "header".
3086         (when (and (search-forward
3087                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3088                     nil t)
3089                    (setq end (1+ (match-beginning 0))))
3090           (gnus-add-wash-type 'pem)
3091           (gnus-article-hide-text-type
3092            end
3093            (if (search-forward "\n\n" nil t)
3094                (match-end 0)
3095              (point-max))
3096            'pem)
3097           ;; Hide the trailer as well
3098           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3099                                 nil t)
3100             (gnus-article-hide-text-type
3101              (match-beginning 0) (match-end 0) 'pem)))))))
3102
3103 (defun article-strip-banner ()
3104   "Strip the banners specified by the `banner' group parameter and by
3105 `gnus-article-address-banner-alist'."
3106   (interactive)
3107   (save-excursion
3108     (save-restriction
3109       (let ((inhibit-point-motion-hooks t))
3110         (when (gnus-parameter-banner gnus-newsgroup-name)
3111           (article-really-strip-banner
3112            (gnus-parameter-banner gnus-newsgroup-name)))
3113         (when gnus-article-address-banner-alist
3114           ;; Note that the From header is decoded here, so it is
3115           ;; required that the *-extract-address-components function
3116           ;; supports non-ASCII text.
3117           (let ((from (save-restriction
3118                         (widen)
3119                         (article-narrow-to-head)
3120                         (mail-fetch-field "from"))))
3121             (when (and from
3122                        (setq from
3123                              (cadr (funcall gnus-extract-address-components
3124                                             from))))
3125               (catch 'found
3126                 (dolist (pair gnus-article-address-banner-alist)
3127                   (when (string-match (car pair) from)
3128                     (throw 'found
3129                            (article-really-strip-banner (cdr pair)))))))))))))
3130
3131 (defun article-really-strip-banner (banner)
3132   "Strip the banner specified by the argument."
3133   (save-excursion
3134     (save-restriction
3135       (let ((inhibit-point-motion-hooks t)
3136             (gnus-signature-limit nil)
3137             (inhibit-read-only t))
3138         (article-goto-body)
3139         (cond
3140          ((eq banner 'signature)
3141           (when (gnus-article-narrow-to-signature)
3142             (widen)
3143             (forward-line -1)
3144             (delete-region (point) (point-max))))
3145          ((symbolp banner)
3146           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3147               (while (re-search-forward banner nil t)
3148                 (delete-region (match-beginning 0) (match-end 0)))))
3149          ((stringp banner)
3150           (while (re-search-forward banner nil t)
3151             (delete-region (match-beginning 0) (match-end 0)))))))))
3152
3153 (defun article-babel ()
3154   "Translate article using an online translation service."
3155   (interactive)
3156   (require 'babel)
3157   (gnus-with-article-buffer
3158     (when (article-goto-body)
3159       (let* ((start (point))
3160              (end (point-max))
3161              (orig (buffer-substring start end))
3162              (trans (babel-as-string orig)))
3163         (save-restriction
3164           (narrow-to-region start end)
3165           (delete-region start end)
3166           (insert trans))))))
3167
3168 (defun article-hide-signature (&optional arg)
3169   "Hide the signature in the current article.
3170 If given a negative prefix, always show; if given a positive prefix,
3171 always hide."
3172   (interactive (gnus-article-hidden-arg))
3173   (unless (gnus-article-check-hidden-text 'signature arg)
3174     (save-excursion
3175       (save-restriction
3176         (let ((inhibit-read-only t))
3177           (when (gnus-article-narrow-to-signature)
3178             (gnus-article-hide-text-type
3179              (point-min) (point-max) 'signature))))))
3180   (gnus-set-mode-line 'article))
3181
3182 (defun article-strip-headers-in-body ()
3183   "Strip offensive headers from bodies."
3184   (interactive)
3185   (save-excursion
3186     (article-goto-body)
3187     (let ((case-fold-search t))
3188       (when (looking-at "x-no-archive:")
3189         (gnus-delete-line)))))
3190
3191 (defun article-strip-leading-blank-lines ()
3192   "Remove all blank lines from the beginning of the article."
3193   (interactive)
3194   (save-excursion
3195     (let ((inhibit-point-motion-hooks t)
3196           (inhibit-read-only t))
3197       (when (article-goto-body)
3198         (while (and (not (eobp))
3199                     (looking-at "[ \t]*$"))
3200           (gnus-delete-line))))))
3201
3202 (defun article-narrow-to-head ()
3203   "Narrow the buffer to the head of the message.
3204 Point is left at the beginning of the narrowed-to region."
3205   (narrow-to-region
3206    (goto-char (point-min))
3207    (if (search-forward "\n\n" nil 1)
3208        (1- (point))
3209      (point-max)))
3210   (goto-char (point-min)))
3211
3212 (defun article-goto-body ()
3213   "Place point at the start of the body."
3214   (goto-char (point-min))
3215   (cond
3216    ;; This variable is only bound when dealing with separate
3217    ;; MIME body parts.
3218    (article-goto-body-goes-to-point-min-p
3219     t)
3220    ((search-forward "\n\n" nil t)
3221     t)
3222    (t
3223     (goto-char (point-max))
3224     nil)))
3225
3226 (defun article-strip-multiple-blank-lines ()
3227   "Replace consecutive blank lines with one empty line."
3228   (interactive)
3229   (save-excursion
3230     (let ((inhibit-point-motion-hooks t)
3231           (inhibit-read-only t))
3232       ;; First make all blank lines empty.
3233       (article-goto-body)
3234       (while (re-search-forward "^[ \t]+$" nil t)
3235         (unless (gnus-annotation-in-region-p
3236                  (match-beginning 0) (match-end 0))
3237           (replace-match "" nil t)))
3238       ;; Then replace multiple empty lines with a single empty line.
3239       (article-goto-body)
3240       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3241         (unless (gnus-annotation-in-region-p
3242                  (match-beginning 0) (match-end 0))
3243           (delete-region (match-beginning 1) (match-end 1)))))))
3244
3245 (defun article-strip-leading-space ()
3246   "Remove all white space from the beginning of the lines in the article."
3247   (interactive)
3248   (save-excursion
3249     (let ((inhibit-point-motion-hooks t)
3250           (inhibit-read-only t))
3251       (article-goto-body)
3252       (while (re-search-forward "^[ \t]+" nil t)
3253         (replace-match "" t t)))))
3254
3255 (defun article-strip-trailing-space ()
3256   "Remove all white space from the end of the lines in the article."
3257   (interactive)
3258   (save-excursion
3259     (let ((inhibit-point-motion-hooks t)
3260           (inhibit-read-only t))
3261       (article-goto-body)
3262       (while (re-search-forward "[ \t]+$" nil t)
3263         (replace-match "" t t)))))
3264
3265 (defun article-strip-blank-lines ()
3266   "Strip leading, trailing and multiple blank lines."
3267   (interactive)
3268   (article-strip-leading-blank-lines)
3269   (article-remove-trailing-blank-lines)
3270   (article-strip-multiple-blank-lines))
3271
3272 (defun article-strip-all-blank-lines ()
3273   "Strip all blank lines."
3274   (interactive)
3275   (save-excursion
3276     (let ((inhibit-point-motion-hooks t)
3277           (inhibit-read-only t))
3278       (article-goto-body)
3279       (while (re-search-forward "^[ \t]*\n" nil t)
3280         (replace-match "" t t)))))
3281
3282 (defun gnus-article-narrow-to-signature ()
3283   "Narrow to the signature; return t if a signature is found, else nil."
3284   (let ((inhibit-point-motion-hooks t))
3285     (when (gnus-article-search-signature)
3286       (forward-line 1)
3287       ;; Check whether we have some limits to what we consider
3288       ;; to be a signature.
3289       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3290                       (list gnus-signature-limit)))
3291             limit limited)
3292         (while (setq limit (pop limits))
3293           (if (or (and (integerp limit)
3294                        (< (- (point-max) (point)) limit))
3295                   (and (floatp limit)
3296                        (< (count-lines (point) (point-max)) limit))
3297                   (and (functionp limit)
3298                        (funcall limit))
3299                   (and (stringp limit)
3300                        (not (re-search-forward limit nil t))))
3301               ()                        ; This limit did not succeed.
3302             (setq limited t
3303                   limits nil)))
3304         (unless limited
3305           (narrow-to-region (point) (point-max))
3306           t)))))
3307
3308 (defun gnus-article-search-signature ()
3309   "Search the current buffer for the signature separator.
3310 Put point at the beginning of the signature separator."
3311   (let ((cur (point)))
3312     (goto-char (point-max))
3313     (if (if (stringp gnus-signature-separator)
3314             (re-search-backward gnus-signature-separator nil t)
3315           (let ((seps gnus-signature-separator))
3316             (while (and seps
3317                         (not (re-search-backward (car seps) nil t)))
3318               (pop seps))
3319             seps))
3320         t
3321       (goto-char cur)
3322       nil)))
3323
3324 (defun gnus-article-hidden-arg ()
3325   "Return the current prefix arg as a number, or 0 if no prefix."
3326   (list (if current-prefix-arg
3327             (prefix-numeric-value current-prefix-arg)
3328           0)))
3329
3330 (defun gnus-article-check-hidden-text (type arg)
3331   "Return nil if hiding is necessary.
3332 Arg can be nil or a number.  nil and positive means hide, negative
3333 means show, 0 means toggle."
3334   (save-excursion
3335     (save-restriction
3336       (let ((hide (gnus-article-hidden-text-p type)))
3337         (cond
3338          ((or (null arg)
3339               (> arg 0))
3340           nil)
3341          ((< arg 0)
3342           (gnus-article-show-hidden-text type)
3343           t)
3344          (t
3345           (if (eq hide 'hidden)
3346               (progn
3347                 (gnus-article-show-hidden-text type)
3348                 t)
3349             nil)))))))
3350
3351 (defun gnus-article-hidden-text-p (type)
3352   "Say whether the current buffer contains hidden text of type TYPE."
3353   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3354     (while (and pos
3355                 (not (get-text-property pos 'invisible))
3356                 (not (get-text-property pos 'dummy-invisible)))
3357       (setq pos
3358             (text-property-any (1+ pos) (point-max) 'article-type type)))
3359     (if pos
3360         'hidden
3361       nil)))
3362
3363 (defun gnus-article-show-hidden-text (type &optional dummy)
3364   "Show all hidden text of type TYPE.
3365 Originally it is hide instead of DUMMY."
3366   (let ((inhibit-read-only t)
3367         (inhibit-point-motion-hooks t))
3368     (gnus-remove-text-properties-when
3369      'article-type type
3370      (point-min) (point-max)
3371      (cons 'article-type (cons type
3372                                gnus-hidden-properties)))
3373     (gnus-delete-wash-type type)))
3374
3375 (defconst article-time-units
3376   `((year . ,(* 365.25 24 60 60))
3377     (week . ,(* 7 24 60 60))
3378     (day . ,(* 24 60 60))
3379     (hour . ,(* 60 60))
3380     (minute . 60)
3381     (second . 1))
3382   "Mapping from time units to seconds.")
3383
3384 (defun gnus-article-forward-header ()
3385   "Move point to the start of the next header.
3386 If the current header is a continuation header, this can be several
3387 lines forward."
3388   (let ((ended nil))
3389     (while (not ended)
3390       (forward-line 1)
3391       (if (looking-at "[ \t]+[^ \t]")
3392           (forward-line 1)
3393         (setq ended t)))))
3394
3395 (defun article-treat-date ()
3396   (article-date-ut gnus-article-date-headers t))
3397
3398 (defun article-date-ut (&optional type highlight date-position)
3399   "Convert DATE date to TYPE in the current article.
3400 The default type is `ut'.  See `gnus-article-date-headers' for
3401 possible values."
3402   (interactive (list 'ut t))
3403   (let* ((case-fold-search t)
3404          (inhibit-read-only t)
3405          (inhibit-point-motion-hooks t)
3406          (first t)
3407          (visible-date (mail-fetch-field "Date"))
3408          pos date bface eface)
3409     (save-excursion
3410       (save-restriction
3411         (goto-char (point-min))
3412         (when (re-search-forward "^Date:" nil t)
3413           (setq bface (get-text-property (point-at-bol) 'face)
3414                 eface (get-text-property (1- (point-at-eol)) 'face)))
3415         (goto-char (point-min))
3416         ;; Delete any old Date headers.
3417         (if date-position
3418             (progn
3419               (goto-char date-position)
3420               (setq date (get-text-property (point) 'original-date))
3421               (delete-region (point)
3422                              (progn
3423                                (gnus-article-forward-header)
3424                                (point)))
3425               (article-transform-date date type bface eface))
3426           (while (re-search-forward "^Date:" nil t)
3427             (setq date (get-text-property (match-beginning 0) 'original-date))
3428             (delete-region (point-at-bol) (progn
3429                                             (gnus-article-forward-header)
3430                                             (point))))
3431           (when (and (not date)
3432                      visible-date)
3433             (setq date visible-date))
3434           (when date
3435             (article-transform-date date type bface eface)))))))
3436
3437 (defun article-transform-date (date type bface eface)
3438   (dolist (this-type (cond
3439                       ((null type)
3440                        (list 'ut))
3441                       ((atom type)
3442                        (list type))
3443                       (t
3444                        type)))
3445     (insert (article-make-date-line date (or this-type 'ut)) "\n")
3446     (forward-line -1)
3447     (beginning-of-line)
3448     (put-text-property (point) (1+ (point))
3449                        'original-date date)
3450     (put-text-property (point) (1+ (point))
3451                        'gnus-date-type this-type)
3452     ;; Do highlighting.
3453     (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3454       (put-text-property (match-beginning 1) (1+ (match-end 1))
3455                          'face bface)
3456       (put-text-property (match-beginning 2) (match-end 2)
3457                          'face eface))
3458     (forward-line 1)))
3459
3460 (defun article-make-date-line (date type)
3461   "Return a DATE line of TYPE."
3462   (unless (memq type '(local ut original user-defined iso8601 lapsed english
3463                              combined-lapsed))
3464     (error "Unknown conversion type: %s" type))
3465   (condition-case ()
3466       (let ((time (date-to-time date)))
3467         (cond
3468          ;; Convert to the local timezone.
3469          ((eq type 'local)
3470           (concat "Date: " (message-make-date time)))
3471          ;; Convert to Universal Time.
3472          ((eq type 'ut)
3473           (concat "Date: "
3474                   (substring
3475                    (message-make-date
3476                     (let* ((e (parse-time-string date))
3477                            (tm (apply 'encode-time e))
3478                            (ms (car tm))
3479                            (ls (- (cadr tm) (car (current-time-zone time)))))
3480                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3481                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3482                             (t (list ms ls)))))
3483                    0 -5)
3484                   "UT"))
3485          ;; Get the original date from the article.
3486          ((eq type 'original)
3487           (concat "Date: " (if (string-match "\n+$" date)
3488                                (substring date 0 (match-beginning 0))
3489                              date)))
3490          ;; Let the user define the format.
3491          ((eq type 'user-defined)
3492           (let ((format (or (condition-case nil
3493                                 (with-current-buffer gnus-summary-buffer
3494                                   gnus-article-time-format)
3495                               (error nil))
3496                             gnus-article-time-format)))
3497             (if (functionp format)
3498                 (funcall format time)
3499               (concat "Date: " (format-time-string format time)))))
3500          ;; ISO 8601.
3501          ((eq type 'iso8601)
3502           (let ((tz (car (current-time-zone time))))
3503             (concat
3504              "Date: "
3505              (format-time-string "%Y%m%dT%H%M%S" time)
3506              (format "%s%02d%02d"
3507                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3508                      (/ (% (abs tz) 3600) 60)))))
3509          ;; Do a lapsed format.
3510          ((eq type 'lapsed)
3511           (concat "Date: " (article-lapsed-string time)))
3512          ;; A combined date/lapsed format.
3513          ((eq type 'combined-lapsed)
3514           (let ((date-string (article-make-date-line date 'original))
3515                 (segments 3)
3516                 lapsed-string)
3517             (while (and
3518                     (setq lapsed-string
3519                           (concat " (" (article-lapsed-string time segments) ")"))
3520                     (> (+ (length date-string)
3521                           (length lapsed-string))
3522                        (+ fill-column 6))
3523                     (> segments 0))
3524               (setq segments (1- segments)))
3525             (if (> segments 0)
3526                 (concat date-string lapsed-string)
3527               date-string)))
3528          ;; Display the date in proper English
3529          ((eq type 'english)
3530           (let ((dtime (decode-time time)))
3531             (concat
3532              "Date: the "
3533              (number-to-string (nth 3 dtime))
3534              (let ((digit (% (nth 3 dtime) 10)))
3535                (cond
3536                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3537                 ((= digit 1) "st")
3538                 ((= digit 2) "nd")
3539                 ((= digit 3) "rd")
3540                 (t "th")))
3541              " of "
3542              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3543              " "
3544              (number-to-string (nth 5 dtime))
3545              " at "
3546              (format "%02d" (nth 2 dtime))
3547              ":"
3548              (format "%02d" (nth 1 dtime)))))))
3549     (foo
3550      (format "Date: %s (from Gnus)" date))))
3551
3552 (defun article-lapsed-string (time &optional max-segments)
3553   ;; If the date is seriously mangled, the timezone functions are
3554   ;; liable to bug out, so we ignore all errors.
3555   (let* ((now (current-time))
3556          (real-time (subtract-time now time))
3557          (real-sec (and real-time
3558                         (+ (* (float (car real-time)) 65536)
3559                            (cadr real-time))))
3560          (sec (and real-time (abs real-sec)))
3561          (segments 0)
3562          num prev)
3563     (unless max-segments
3564       (setq max-segments (length article-time-units)))
3565     (cond
3566      ((null real-time)
3567       "Unknown")
3568      ((zerop sec)
3569       "Now")
3570      (t
3571       (concat
3572        ;; This is a bit convoluted, but basically we go
3573        ;; through the time units for years, weeks, etc,
3574        ;; and divide things to see whether that results
3575        ;; in positive answers.
3576        (mapconcat
3577         (lambda (unit)
3578           (if (or (zerop (setq num (ffloor (/ sec (cdr unit)))))
3579                   (>= segments max-segments))
3580               ;; The (remaining) seconds are too few to
3581               ;; be divided into this time unit.
3582               ""
3583             ;; It's big enough, so we output it.
3584             (setq sec (- sec (* num (cdr unit))))
3585             (prog1
3586                 (concat (if prev ", " "") (int-to-string
3587                                            (floor num))
3588                         " " (symbol-name (car unit))
3589                         (if (> num 1) "s" ""))
3590               (setq prev t
3591                     segments (1+ segments)))))
3592         article-time-units "")
3593        ;; If dates are odd, then it might appear like the
3594        ;; article was sent in the future.
3595        (if (> real-sec 0)
3596            " ago"
3597          " in the future"))))))
3598
3599 (defun article-date-local (&optional highlight)
3600   "Convert the current article date to the local timezone."
3601   (interactive (list t))
3602   (article-date-ut 'local highlight))
3603
3604 (defun article-date-english (&optional highlight)
3605   "Convert the current article date to something that is proper English."
3606   (interactive (list t))
3607   (article-date-ut 'english highlight))
3608
3609 (defun article-date-original (&optional highlight)
3610   "Convert the current article date to what it was originally.
3611 This is only useful if you have used some other date conversion
3612 function and want to see what the date was before converting."
3613   (interactive (list t))
3614   (article-date-ut 'original highlight))
3615
3616 (defun article-date-lapsed (&optional highlight)
3617   "Convert the current article date to time lapsed since it was sent."
3618   (interactive (list t))
3619   (article-date-ut 'lapsed highlight))
3620
3621 (defun article-date-combined-lapsed (&optional highlight)
3622   "Convert the current article date to time lapsed since it was sent."
3623   (interactive (list t))
3624   (article-date-ut 'combined-lapsed highlight))
3625
3626 (defun article-update-date-lapsed ()
3627   "Function to be run from a timer to update the lapsed time line."
3628   (save-match-data
3629     (let ((buffer (current-buffer)))
3630       (ignore-errors
3631         (walk-windows
3632          (lambda (w)
3633            (set-buffer (window-buffer w))
3634            (when (eq major-mode 'gnus-article-mode)
3635              (let ((old-line (count-lines (point-min) (point)))
3636                    (old-column (- (point) (line-beginning-position)))
3637                    (window-start
3638                     (window-start (get-buffer-window (current-buffer)))))
3639                (goto-char (point-min))
3640                (while (re-search-forward "^Date:" nil t)
3641                  (let ((type (get-text-property (match-beginning 0)
3642                                                 'gnus-date-type)))
3643                    (when (memq type '(lapsed combined-lapsed user-format))
3644                      (when (and window-start
3645                                 (not (= window-start
3646                                         (save-excursion
3647                                           (forward-line 1)
3648                                           (point)))))
3649                        (setq window-start nil))
3650                      (save-excursion
3651                        (article-date-ut type t (match-beginning 0)))
3652                      (forward-line 1)
3653                      (when window-start
3654                        (set-window-start (get-buffer-window (current-buffer))
3655                                          (point))))))
3656                (goto-char (point-min))
3657                (when (> old-column 0)
3658                  (setq old-line (1- old-line)))
3659                (forward-line old-line)
3660                (end-of-line)
3661                (when (> (current-column) old-column)
3662                  (beginning-of-line)
3663                  (forward-char old-column)))))
3664          nil 'visible))
3665       (set-buffer buffer))))
3666
3667 (defun gnus-start-date-timer (&optional n)
3668   "Start a timer to update the Date headers in the article buffers.
3669 The numerical prefix says how frequently (in seconds) the function
3670 is to run."
3671   (interactive "p")
3672   (unless n
3673     (setq n 1))
3674   (gnus-stop-date-timer)
3675   (setq article-lapsed-timer
3676         (run-at-time 1 n 'article-update-date-lapsed)))
3677
3678 (defun gnus-stop-date-timer ()
3679   "Stop the Date timer."
3680   (interactive)
3681   (when article-lapsed-timer
3682     (nnheader-cancel-timer article-lapsed-timer)
3683     (setq article-lapsed-timer nil)))
3684
3685 (defun article-date-user (&optional highlight)
3686   "Convert the current article date to the user-defined format.
3687 This format is defined by the `gnus-article-time-format' variable."
3688   (interactive (list t))
3689   (article-date-ut 'user highlight))
3690
3691 (defun article-date-iso8601 (&optional highlight)
3692   "Convert the current article date to ISO8601."
3693   (interactive (list t))
3694   (article-date-ut 'iso8601 highlight))
3695
3696 (defmacro gnus-article-save-original-date (&rest forms)
3697   "Save the original date as a text property and evaluate FORMS."
3698   `(let* ((case-fold-search t)
3699           (start (progn
3700                    (goto-char (point-min))
3701                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3702                               (not (bolp)))
3703                      (match-end 0))))
3704           (date (when (and start
3705                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3706                                               nil t))
3707                   (buffer-substring-no-properties start
3708                                                   (match-beginning 0)))))
3709      (goto-char (point-max))
3710      (skip-chars-backward "\n")
3711      (put-text-property (point-min) (point) 'original-date date)
3712      ,@forms
3713      (goto-char (point-max))
3714      (skip-chars-backward "\n")
3715      (put-text-property (point-min) (point) 'original-date date)))
3716
3717 ;; (defun article-show-all ()
3718 ;;   "Show all hidden text in the article buffer."
3719 ;;   (interactive)
3720 ;;   (save-excursion
3721 ;;     (let ((inhibit-read-only t))
3722 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3723
3724 (defun article-remove-leading-whitespace ()
3725   "Remove excessive whitespace from all headers."
3726   (interactive)
3727   (save-excursion
3728     (save-restriction
3729       (let ((inhibit-read-only t))
3730         (article-narrow-to-head)
3731         (goto-char (point-min))
3732         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3733           (delete-region (match-beginning 1) (match-end 1)))))))
3734
3735 (defun article-emphasize (&optional arg)
3736   "Emphasize text according to `gnus-emphasis-alist'."
3737   (interactive (gnus-article-hidden-arg))
3738   (unless (gnus-article-check-hidden-text 'emphasis arg)
3739     (save-excursion
3740       (let ((alist (or
3741                     (condition-case nil
3742                         (with-current-buffer gnus-summary-buffer
3743                           gnus-article-emphasis-alist)
3744                       (error))
3745                     gnus-emphasis-alist))
3746             (inhibit-read-only t)
3747             (props (append '(article-type emphasis)
3748                            gnus-hidden-properties))
3749             regexp elem beg invisible visible face)
3750         (article-goto-body)
3751         (setq beg (point))
3752         (while (setq elem (pop alist))
3753           (goto-char beg)
3754           (setq regexp (car elem)
3755                 invisible (nth 1 elem)
3756                 visible (nth 2 elem)
3757                 face (nth 3 elem))
3758           (while (re-search-forward regexp nil t)
3759             (when (and (match-beginning visible) (match-beginning invisible))
3760               (gnus-article-hide-text
3761                (match-beginning invisible) (match-end invisible) props)
3762               (gnus-article-unhide-text-type
3763                (match-beginning visible) (match-end visible) 'emphasis)
3764               (gnus-put-overlay-excluding-newlines
3765                (match-beginning visible) (match-end visible) 'face face)
3766               (gnus-add-wash-type 'emphasis)
3767               (goto-char (match-end invisible)))))))))
3768
3769 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3770   "Setup newsgroup emphasis alist."
3771   (unless gnus-article-emphasis-alist
3772     (let ((name (and gnus-newsgroup-name
3773                      (gnus-group-real-name gnus-newsgroup-name))))
3774       (make-local-variable 'gnus-article-emphasis-alist)
3775       (setq gnus-article-emphasis-alist
3776             (nconc
3777              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3778                (while (setq elem (pop alist))
3779                  (when (and name (string-match (car elem) name))
3780                    (setq alist nil
3781                          highlight (copy-sequence (cdr elem)))))
3782                highlight)
3783              (copy-sequence highlight-words)
3784              (if gnus-newsgroup-name
3785                  (copy-sequence (gnus-group-find-parameter
3786                                  gnus-newsgroup-name 'highlight-words t)))
3787              gnus-emphasis-alist)))))
3788
3789 (defvar gnus-summary-article-menu)
3790 (defvar gnus-summary-post-menu)
3791
3792 ;;; Saving functions.
3793
3794 (defun gnus-article-save (save-buffer file &optional num)
3795   "Save the currently selected article."
3796   (when (or (get gnus-default-article-saver :headers)
3797             (not gnus-save-all-headers))
3798     ;; Remove headers according to `gnus-saved-headers' or the value
3799     ;; of the `:headers' property that the saver function might have.
3800     (let ((gnus-visible-headers
3801            (or (symbol-value (get gnus-default-article-saver :headers))
3802                gnus-saved-headers gnus-visible-headers))
3803           ;; Ignore group parameter.  See `article-hide-headers'.
3804           (gnus-summary-buffer nil))
3805       (with-current-buffer save-buffer
3806         (article-hide-headers 1 t))))
3807   (save-window-excursion
3808     (if (not gnus-default-article-saver)
3809         (error "No default saver is defined")
3810       ;; !!! Magic!  The saving functions all save
3811       ;; `gnus-save-article-buffer' (or so they think), but we
3812       ;; bind that variable to our save-buffer.
3813       (set-buffer gnus-article-buffer)
3814       (let* ((gnus-save-article-buffer save-buffer)
3815              (filename
3816               (cond
3817                ((not gnus-prompt-before-saving) 'default)
3818                ((eq gnus-prompt-before-saving 'always) nil)
3819                (t file)))
3820              (gnus-number-of-articles-to-be-saved
3821               (when (eq gnus-prompt-before-saving t)
3822                 num)))                  ; Magic
3823         (set-buffer gnus-article-current-summary)
3824         (funcall gnus-default-article-saver filename)))))
3825
3826 (defun gnus-read-save-file-name (prompt &optional filename
3827                                         function group headers variable
3828                                         dir-var)
3829   (let ((default-name
3830           (funcall function group headers (symbol-value variable)))
3831         result)
3832     (setq result
3833           (expand-file-name
3834            (cond
3835             ((eq filename 'default)
3836              default-name)
3837             ((eq filename t)
3838              default-name)
3839             (filename filename)
3840             (t
3841              (when (symbol-value dir-var)
3842                (setq default-name (expand-file-name
3843                                    (file-name-nondirectory default-name)
3844                                    (symbol-value dir-var))))
3845              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3846                     (prompt
3847                      (format prompt
3848                              (if (and gnus-number-of-articles-to-be-saved
3849                                       (> gnus-number-of-articles-to-be-saved 1))
3850                                  (format "these %d articles"
3851                                          gnus-number-of-articles-to-be-saved)
3852                                "this article")))
3853                     (file
3854                      ;; Let the split methods have their say.
3855                      (cond
3856                       ;; No split name was found.
3857                       ((null split-name)
3858                        (read-file-name
3859                         (concat prompt " (default "
3860                                 (file-name-nondirectory default-name) "): ")
3861                         (file-name-directory default-name)
3862                         default-name))
3863                       ;; A single group name is returned.
3864                       ((stringp split-name)
3865                        (setq default-name
3866                              (funcall function split-name headers
3867                                       (symbol-value variable)))
3868                        (read-file-name
3869                         (concat prompt " (default "
3870                                 (file-name-nondirectory default-name) "): ")
3871                         (file-name-directory default-name)
3872                         default-name))
3873                       ;; A single split name was found
3874                       ((= 1 (length split-name))
3875                        (let* ((name (expand-file-name
3876                                      (car split-name)
3877                                      gnus-article-save-directory))
3878                               (dir (cond ((file-directory-p name)
3879                                           (file-name-as-directory name))
3880                                          ((file-exists-p name) name)
3881                                          (t gnus-article-save-directory))))
3882                          (read-file-name
3883                           (concat prompt " (default " name "): ")
3884                           dir name)))
3885                       ;; A list of splits was found.
3886                       (t
3887                        (setq split-name (nreverse split-name))
3888                        (let (result)
3889                          (let ((file-name-history
3890                                 (nconc split-name file-name-history)))
3891                            (setq result
3892                                  (expand-file-name
3893                                   (read-file-name
3894                                    (concat prompt " (`M-p' for defaults): ")
3895                                    gnus-article-save-directory
3896                                    (car split-name))
3897                                   gnus-article-save-directory)))
3898                          (car (push result file-name-history)))))))
3899                ;; Create the directory.
3900                (gnus-make-directory (file-name-directory file))
3901                ;; If we have read a directory, we append the default file name.
3902                (when (file-directory-p file)
3903                  (setq file (expand-file-name (file-name-nondirectory
3904                                                default-name)
3905                                               (file-name-as-directory file))))
3906                ;; Possibly translate some characters.
3907                (nnheader-translate-file-chars file))))))
3908     (gnus-make-directory (file-name-directory result))
3909     (when variable
3910       (set variable result))
3911     (when dir-var
3912       (set dir-var (file-name-directory result)))
3913     result))
3914
3915 (defun gnus-article-archive-name (group)
3916   "Return the first instance of an \"Archive-name\" in the current buffer."
3917   (let ((case-fold-search t))
3918     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3919       (nnheader-concat gnus-article-save-directory
3920                        (match-string 1)))))
3921
3922 (defun gnus-article-nndoc-name (group)
3923   "If GROUP is an nndoc group, return the name of the parent group."
3924   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3925     (gnus-group-get-parameter group 'save-article-group)))
3926
3927 (defun gnus-summary-save-in-rmail (&optional filename)
3928   "Append this article to Rmail file.
3929 Optional argument FILENAME specifies file name.
3930 Directory to save to is default to `gnus-article-save-directory'."
3931   (setq filename (gnus-read-save-file-name
3932                   "Save %s in rmail file" filename
3933                   gnus-rmail-save-name gnus-newsgroup-name
3934                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3935   (with-current-buffer gnus-save-article-buffer
3936     (save-excursion
3937       (save-restriction
3938         (widen)
3939         ;; Note that unlike gnus-summary-save-in-mail, there is no
3940         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3941         ;; not use Babyl.
3942         (gnus-output-to-rmail filename))))
3943   filename)
3944
3945 (defun gnus-summary-save-in-mail (&optional filename)
3946   "Append this article to Unix mail file.
3947 Optional argument FILENAME specifies file name.
3948 Directory to save to is default to `gnus-article-save-directory'."
3949   (setq filename (gnus-read-save-file-name
3950                   "Save %s in Unix mail file" filename
3951                   gnus-mail-save-name gnus-newsgroup-name
3952                   gnus-current-headers 'gnus-newsgroup-last-mail))
3953   (with-current-buffer gnus-save-article-buffer
3954     (save-excursion
3955       (save-restriction
3956         (widen)
3957         (if (and (file-readable-p filename)
3958                  (file-regular-p filename)
3959                  (mail-file-babyl-p filename))
3960             (gnus-output-to-rmail filename)
3961           (gnus-output-to-mail filename)))))
3962   filename)
3963
3964 (put 'gnus-summary-save-in-file :decode t)
3965 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3966 (defun gnus-summary-save-in-file (&optional filename overwrite)
3967   "Append this article to file.
3968 Optional argument FILENAME specifies file name.
3969 Directory to save to is default to `gnus-article-save-directory'."
3970   (setq filename (gnus-read-save-file-name
3971                   "Save %s in file" filename
3972                   gnus-file-save-name gnus-newsgroup-name
3973                   gnus-current-headers 'gnus-newsgroup-last-file))
3974   (with-current-buffer gnus-save-article-buffer
3975     (save-excursion
3976       (save-restriction
3977         (widen)
3978         (when (and overwrite
3979                    (file-exists-p filename))
3980           (delete-file filename))
3981         (gnus-output-to-file filename))))
3982   filename)
3983
3984 (put 'gnus-summary-write-to-file :decode t)
3985 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
3986 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
3987 (defun gnus-summary-write-to-file (&optional filename)
3988   "Write this article to a file, overwriting it if the file exists.
3989 Optional argument FILENAME specifies file name.
3990 The directory to save in defaults to `gnus-article-save-directory'."
3991   (setq filename (gnus-read-save-file-name
3992                   "Save %s in file" filename
3993                   gnus-file-save-name gnus-newsgroup-name
3994                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3995   (gnus-summary-save-in-file filename t))
3996
3997 (put 'gnus-summary-save-body-in-file :decode t)
3998 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
3999   "Append this article body to a file.
4000 Optional argument FILENAME specifies file name.
4001 The directory to save in defaults to `gnus-article-save-directory'."
4002   (setq filename (gnus-read-save-file-name
4003                   "Save %s body in file" filename
4004                   gnus-file-save-name gnus-newsgroup-name
4005                   gnus-current-headers 'gnus-newsgroup-last-file))
4006   (with-current-buffer gnus-save-article-buffer
4007     (save-excursion
4008       (save-restriction
4009         (widen)
4010         (when (article-goto-body)
4011           (narrow-to-region (point) (point-max)))
4012         (when (and overwrite
4013                    (file-exists-p filename))
4014           (delete-file filename))
4015         (gnus-output-to-file filename))))
4016   filename)
4017
4018 (put 'gnus-summary-write-body-to-file :decode t)
4019 (put 'gnus-summary-write-body-to-file
4020      :function 'gnus-summary-save-body-in-file)
4021 (defun gnus-summary-write-body-to-file (&optional filename)
4022   "Write this article body to a file, overwriting it if the file exists.
4023 Optional argument FILENAME specifies file name.
4024 The directory to save in defaults to `gnus-article-save-directory'."
4025   (setq filename (gnus-read-save-file-name
4026                   "Save %s body in file" filename
4027                   gnus-file-save-name gnus-newsgroup-name
4028                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4029   (gnus-summary-save-body-in-file filename t))
4030
4031 (put 'gnus-summary-save-in-pipe :decode t)
4032 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
4033 (defun gnus-summary-save-in-pipe (&optional command raw)
4034   "Pipe this article to subprocess COMMAND.
4035 Valid values for COMMAND include:
4036   a string
4037     The executable command name and possibly arguments.
4038   nil
4039     You will be prompted for the command in the minibuffer.
4040   the symbol `default'
4041     It will be replaced with the command which the variable
4042     `gnus-summary-pipe-output-default-command' holds or the command
4043     last used for saving.
4044 Non-nil value for RAW overrides `:decode' and `:headers' properties
4045 and the raw article including all headers will be piped."
4046   (let ((article (gnus-summary-article-number))
4047         (decode (unless raw
4048                   (get 'gnus-summary-save-in-pipe :decode)))
4049         save-buffer default)
4050     (if article
4051         (if (vectorp (gnus-summary-article-header article))
4052             (save-current-buffer
4053               (gnus-summary-select-article decode decode nil article)
4054               (insert-buffer-substring
4055                (prog1
4056                    (if decode
4057                        gnus-article-buffer
4058                      gnus-original-article-buffer)
4059                  (setq save-buffer
4060                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4061               ;; Remove unwanted headers.
4062               (when (and (not raw)
4063                          (or (get 'gnus-summary-save-in-pipe :headers)
4064                              (not gnus-save-all-headers)))
4065                 (let ((gnus-visible-headers
4066                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4067                                               :headers))
4068                            gnus-saved-headers gnus-visible-headers))
4069                       (gnus-summary-buffer nil))
4070                   (article-hide-headers 1 t))))
4071           (error "%d is not a real article" article))
4072       (error "No article to pipe"))
4073     (setq default (or gnus-summary-pipe-output-default-command
4074                       gnus-last-shell-command))
4075     (unless (stringp command)
4076       (setq command
4077             (if (and (eq command 'default) default)
4078                 default
4079               (gnus-read-shell-command "Shell command on this article: "
4080                                        default))))
4081     (when (string-equal command "")
4082       (if default
4083           (setq command default)
4084         (error "A command is required")))
4085     (with-current-buffer save-buffer
4086       (save-restriction
4087         (widen)
4088         (shell-command-on-region (point-min) (point-max) command nil)))
4089     (gnus-kill-buffer save-buffer))
4090   (setq gnus-summary-pipe-output-default-command command))
4091
4092 (defun gnus-summary-pipe-to-muttprint (&optional command)
4093   "Pipe this article to muttprint."
4094   (unless (stringp command)
4095     (setq command (read-string
4096                    "Print using command: " gnus-summary-muttprint-program
4097                    nil gnus-summary-muttprint-program)))
4098   (let ((gnus-summary-pipe-output-default-command
4099          gnus-summary-pipe-output-default-command))
4100     (gnus-summary-save-in-pipe command))
4101   (setq gnus-summary-muttprint-program command))
4102
4103 ;;; Article file names when saving.
4104
4105 (defun gnus-capitalize-newsgroup (newsgroup)
4106   "Capitalize NEWSGROUP name."
4107   (when (not (zerop (length newsgroup)))
4108     (concat (char-to-string (upcase (aref newsgroup 0)))
4109             (substring newsgroup 1))))
4110
4111 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4112   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4113 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4114 Otherwise, it is like ~/News/news/group/num."
4115   (let ((default
4116           (expand-file-name
4117            (concat (if (gnus-use-long-file-name 'not-save)
4118                        (gnus-capitalize-newsgroup newsgroup)
4119                      (gnus-newsgroup-directory-form newsgroup))
4120                    "/" (int-to-string (mail-header-number headers)))
4121            gnus-article-save-directory)))
4122     (if (and last-file
4123              (string-equal (file-name-directory default)
4124                            (file-name-directory last-file))
4125              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4126         default
4127       (or last-file default))))
4128
4129 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4130   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4131 If variable `gnus-use-long-file-name' is non-nil, it is
4132 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4133   (let ((default
4134           (expand-file-name
4135            (concat (if (gnus-use-long-file-name 'not-save)
4136                        newsgroup
4137                      (gnus-newsgroup-directory-form newsgroup))
4138                    "/" (int-to-string (mail-header-number headers)))
4139            gnus-article-save-directory)))
4140     (if (and last-file
4141              (string-equal (file-name-directory default)
4142                            (file-name-directory last-file))
4143              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4144         default
4145       (or last-file default))))
4146
4147 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4148   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4149 If variable `gnus-use-long-file-name' is non-nil, it is
4150 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4151   (or last-file
4152       (expand-file-name
4153        (if (gnus-use-long-file-name 'not-save)
4154            newsgroup
4155          (file-relative-name
4156           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4157           default-directory))
4158        gnus-article-save-directory)))
4159
4160 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4161   "Generate file name from sender."
4162   (let ((from (mail-header-from headers)))
4163     (expand-file-name
4164      (if (and from (string-match "\\([^ <]+\\)@" from))
4165          (match-string 1 from)
4166        "nobody")
4167      gnus-article-save-directory)))
4168
4169 (defun article-verify-x-pgp-sig ()
4170   "Verify X-PGP-Sig."
4171   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4172   (interactive)
4173   (if (gnus-buffer-live-p gnus-original-article-buffer)
4174       (let ((sig (with-current-buffer gnus-original-article-buffer
4175                    (gnus-fetch-field "X-PGP-Sig")))
4176             items info headers)
4177         (when (and sig
4178                    mml2015-use
4179                    (mml2015-clear-verify-function))
4180           (with-temp-buffer
4181             (insert-buffer-substring gnus-original-article-buffer)
4182             (setq items (split-string sig))
4183             (message-narrow-to-head)
4184             (let ((inhibit-point-motion-hooks t)
4185                   (case-fold-search t))
4186               ;; Don't verify multiple headers.
4187               (setq headers (mapconcat (lambda (header)
4188                                          (concat header ": "
4189                                                  (mail-fetch-field header)
4190                                                  "\n"))
4191                                        (split-string (nth 1 items) ",") "")))
4192             (delete-region (point-min) (point-max))
4193             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4194             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4195             (insert headers)
4196             (widen)
4197             (forward-line)
4198             (while (not (eobp))
4199               (if (looking-at "^-")
4200                   (insert "- "))
4201               (forward-line))
4202             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4203             (insert "Version: " (car items) "\n\n")
4204             (insert (mapconcat 'identity (cddr items) "\n"))
4205             (insert "\n-----END PGP SIGNATURE-----\n")
4206             (let ((mm-security-handle (list (format "multipart/signed"))))
4207               (mml2015-clean-buffer)
4208               (let ((coding-system-for-write (or gnus-newsgroup-charset
4209                                                  'iso-8859-1)))
4210                 (funcall (mml2015-clear-verify-function)))
4211               (setq info
4212                     (or (mm-handle-multipart-ctl-parameter
4213                          mm-security-handle 'gnus-details)
4214                         (mm-handle-multipart-ctl-parameter
4215                          mm-security-handle 'gnus-info)))))
4216           (when info
4217             (let ((inhibit-read-only t) bface eface)
4218               (save-restriction
4219                 (message-narrow-to-head)
4220                 (goto-char (point-max))
4221                 (forward-line -1)
4222                 (setq bface (get-text-property (point-at-bol) 'face)
4223                       eface (get-text-property (1- (point-at-eol)) 'face))
4224                 (message-remove-header "X-Gnus-PGP-Verify")
4225                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4226                     (forward-line)
4227                   (goto-char (point-max)))
4228                 (narrow-to-region (point) (point))
4229                 (insert "X-Gnus-PGP-Verify: " info "\n")
4230                 (goto-char (point-min))
4231                 (forward-line)
4232                 (while (not (eobp))
4233                   (if (not (looking-at "^[ \t]"))
4234                       (insert " "))
4235                   (forward-line))
4236                 ;; Do highlighting.
4237                 (goto-char (point-min))
4238                 (when (looking-at "\\([^:]+\\): *")
4239                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4240                                      'face bface)
4241                   (put-text-property (match-end 0) (point-max)
4242                                      'face eface)))))))))
4243
4244 (autoload 'canlock-verify "canlock" nil t) ;; for XEmacs.
4245
4246 (defun article-verify-cancel-lock ()
4247   "Verify Cancel-Lock header."
4248   (interactive)
4249   (if (gnus-buffer-live-p gnus-original-article-buffer)
4250       (canlock-verify gnus-original-article-buffer)))
4251
4252 (eval-and-compile
4253   (mapc
4254    (lambda (func)
4255      (let (afunc gfunc)
4256        (if (consp func)
4257            (setq afunc (car func)
4258                  gfunc (cdr func))
4259          (setq afunc func
4260                gfunc (intern (format "gnus-%s" func))))
4261        (defalias gfunc
4262          (when (fboundp afunc)
4263            `(lambda (&optional interactive &rest args)
4264               ,(documentation afunc t)
4265               (interactive (list t))
4266               (with-current-buffer gnus-article-buffer
4267                 (if interactive
4268                     (call-interactively ',afunc)
4269                   (apply ',afunc args))))))))
4270    '(article-hide-headers
4271      article-verify-x-pgp-sig
4272      article-verify-cancel-lock
4273      article-hide-boring-headers
4274      article-treat-overstrike
4275      article-treat-ansi-sequences
4276      article-fill-long-lines
4277      article-capitalize-sentences
4278      article-remove-cr
4279      article-remove-leading-whitespace
4280      article-display-x-face
4281      article-display-face
4282      article-de-quoted-unreadable
4283      article-de-base64-unreadable
4284      article-decode-HZ
4285      article-wash-html
4286      article-unsplit-urls
4287      article-hide-list-identifiers
4288      article-strip-banner
4289      article-babel
4290      article-hide-pem
4291      article-hide-signature
4292      article-strip-headers-in-body
4293      article-remove-trailing-blank-lines
4294      article-strip-leading-blank-lines
4295      article-strip-multiple-blank-lines
4296      article-strip-leading-space
4297      article-strip-trailing-space
4298      article-strip-blank-lines
4299      article-strip-all-blank-lines
4300      article-date-local
4301      article-date-english
4302      article-date-iso8601
4303      article-date-original
4304      article-treat-date
4305      article-date-ut
4306      article-decode-mime-words
4307      article-decode-charset
4308      article-decode-encoded-words
4309      article-date-user
4310      article-date-lapsed
4311      article-date-combined-lapsed
4312      article-emphasize
4313      article-treat-dumbquotes
4314      article-treat-non-ascii
4315      article-normalize-headers
4316      ;;(article-show-all . gnus-article-show-all-headers)
4317      )))
4318 \f
4319 ;;;
4320 ;;; Gnus article mode
4321 ;;;
4322
4323 (put 'gnus-article-mode 'mode-class 'special)
4324
4325 (set-keymap-parent gnus-article-mode-map widget-keymap)
4326
4327 (gnus-define-keys gnus-article-mode-map
4328   " " gnus-article-goto-next-page
4329   "\177" gnus-article-goto-prev-page
4330   [delete] gnus-article-goto-prev-page
4331   [backspace] gnus-article-goto-prev-page
4332   "\C-c^" gnus-article-refer-article
4333   "h" gnus-article-show-summary
4334   "s" gnus-article-show-summary
4335   "\C-c\C-m" gnus-article-mail
4336   "?" gnus-article-describe-briefly
4337   "<" beginning-of-buffer
4338   ">" end-of-buffer
4339   "\C-c\C-i" gnus-info-find-node
4340   "\C-c\C-b" gnus-bug
4341   "R" gnus-article-reply-with-original
4342   "F" gnus-article-followup-with-original
4343   "\C-hk" gnus-article-describe-key
4344   "\C-hc" gnus-article-describe-key-briefly
4345   "\C-hb" gnus-article-describe-bindings
4346
4347   "e" gnus-article-read-summary-keys
4348   "\C-d" gnus-article-read-summary-keys
4349   "\M-*" gnus-article-read-summary-keys
4350   "\M-#" gnus-article-read-summary-keys
4351   "\M-^" gnus-article-read-summary-keys
4352   "\M-g" gnus-article-read-summary-keys)
4353
4354 (substitute-key-definition
4355  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4356
4357 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4358   "W" gnus-article-wide-reply-with-original)
4359 (if (featurep 'xemacs)
4360     (set-keymap-default-binding gnus-article-send-map
4361                                 'gnus-article-read-summary-send-keys)
4362   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4363
4364 (defun gnus-article-make-menu-bar ()
4365   (unless (boundp 'gnus-article-commands-menu)
4366     (gnus-summary-make-menu-bar))
4367   (unless (boundp 'gnus-article-article-menu)
4368     (easy-menu-define
4369      gnus-article-article-menu gnus-article-mode-map ""
4370      '("Article"
4371        ["Scroll forwards" gnus-article-goto-next-page t]
4372        ["Scroll backwards" gnus-article-goto-prev-page t]
4373        ["Show summary" gnus-article-show-summary t]
4374        ["Fetch Message-ID at point" gnus-article-refer-article t]
4375        ["Mail to address at point" gnus-article-mail t]
4376        ["Send a bug report" gnus-bug t]))
4377
4378     (easy-menu-define
4379      gnus-article-treatment-menu gnus-article-mode-map ""
4380      ;; Fixme: this should use :active (and maybe :visible).
4381      '("Treatment"
4382        ["Hide headers" gnus-article-hide-headers t]
4383        ["Hide signature" gnus-article-hide-signature t]
4384        ["Hide citation" gnus-article-hide-citation t]
4385        ["Treat overstrike" gnus-article-treat-overstrike t]
4386        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4387        ["Remove carriage return" gnus-article-remove-cr t]
4388        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4389        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4390        ["Remove base64" gnus-article-de-base64-unreadable t]
4391        ["Treat html" gnus-article-wash-html t]
4392        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4393        ["Decode HZ" gnus-article-decode-HZ t]))
4394
4395     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4396
4397     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4398
4399     (gnus-run-hooks 'gnus-article-menu-hook)))
4400
4401 (defvar bookmark-make-record-function)
4402
4403 (defun gnus-article-mode ()
4404   "Major mode for displaying an article.
4405
4406 All normal editing commands are switched off.
4407
4408 The following commands are available in addition to all summary mode
4409 commands:
4410 \\<gnus-article-mode-map>
4411 \\[gnus-article-next-page]\t Scroll the article one page forwards
4412 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4413 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4414 \\[gnus-article-show-summary]\t Display the summary buffer
4415 \\[gnus-article-mail]\t Send a reply to the address near point
4416 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4417 \\[gnus-info-find-node]\t Go to the Gnus info node"
4418   (interactive)
4419   (kill-all-local-variables)
4420   (gnus-simplify-mode-line)
4421   (setq mode-name "Article")
4422   (setq major-mode 'gnus-article-mode)
4423   (make-local-variable 'minor-mode-alist)
4424   (use-local-map gnus-article-mode-map)
4425   (when (gnus-visual-p 'article-menu 'menu)
4426     (gnus-article-make-menu-bar)
4427     (when gnus-summary-tool-bar-map
4428       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4429   (gnus-update-format-specifications nil 'article-mode)
4430   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4431   (set (make-local-variable 'gnus-page-broken) nil)
4432   (make-local-variable 'gnus-article-current-summary)
4433   (make-local-variable 'gnus-article-mime-handles)
4434   (make-local-variable 'gnus-article-decoded-p)
4435   (make-local-variable 'gnus-article-mime-handle-alist)
4436   (make-local-variable 'gnus-article-wash-types)
4437   (make-local-variable 'gnus-article-image-alist)
4438   (make-local-variable 'gnus-article-charset)
4439   (make-local-variable 'gnus-article-ignored-charsets)
4440   (set (make-local-variable 'bookmark-make-record-function)
4441        'gnus-summary-bookmark-make-record)
4442   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4443   ;; face.
4444   (set (make-local-variable 'nobreak-char-display) nil)
4445   (setq cursor-in-non-selected-windows nil)
4446   (gnus-set-default-directory)
4447   (buffer-disable-undo)
4448   (setq buffer-read-only t
4449         show-trailing-whitespace nil)
4450   (set-syntax-table gnus-article-mode-syntax-table)
4451   (mm-enable-multibyte)
4452   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4453
4454 (defun gnus-article-setup-buffer ()
4455   "Initialize the article buffer."
4456   (let* ((name (if gnus-single-article-buffer "*Article*"
4457                  (concat "*Article " gnus-newsgroup-name "*")))
4458          (original
4459           (progn (string-match "\\*Article" name)
4460                  (concat " *Original Article"
4461                          (substring name (match-end 0))))))
4462     (setq gnus-article-buffer name)
4463     (setq gnus-original-article-buffer original)
4464     (setq gnus-article-mime-handle-alist nil)
4465     (with-current-buffer gnus-summary-buffer
4466       ;; This might be a variable local to the summary buffer.
4467       (unless gnus-single-article-buffer
4468         (setq gnus-article-buffer name)
4469         (setq gnus-original-article-buffer original)
4470         (gnus-set-global-variables)))
4471     (gnus-article-setup-highlight-words)
4472     ;; Init original article buffer.
4473     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4474       (mm-enable-multibyte)
4475       (setq major-mode 'gnus-original-article-mode)
4476       (make-local-variable 'gnus-original-article))
4477     (if (and (get-buffer name)
4478              (with-current-buffer name
4479                (if gnus-article-edit-mode
4480                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4481                        (progn
4482                          (set-buffer-modified-p nil)
4483                          (gnus-kill-buffer name)
4484                          (message "")
4485                          nil)
4486                      (error "Action aborted"))
4487                  t)))
4488         (with-current-buffer name
4489           (set (make-local-variable 'gnus-article-edit-mode) nil)
4490           (when gnus-article-mime-handles
4491             (mm-destroy-parts gnus-article-mime-handles)
4492             (setq gnus-article-mime-handles nil))
4493           ;; Set it to nil in article-buffer!
4494           (setq gnus-article-mime-handle-alist nil)
4495           (buffer-disable-undo)
4496           (setq buffer-read-only t)
4497           (unless (eq major-mode 'gnus-article-mode)
4498             (gnus-article-mode))
4499           (setq truncate-lines gnus-article-truncate-lines)
4500           (current-buffer))
4501       (with-current-buffer (gnus-get-buffer-create name)
4502         (gnus-article-mode)
4503         (setq truncate-lines gnus-article-truncate-lines)
4504         (make-local-variable 'gnus-summary-buffer)
4505         (setq gnus-summary-buffer
4506               (gnus-summary-buffer-name gnus-newsgroup-name))
4507         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4508         (when article-lapsed-timer
4509           (gnus-stop-date-timer))
4510         (when gnus-article-update-date-headers
4511           (gnus-start-date-timer gnus-article-update-date-headers))
4512         (current-buffer)))))
4513
4514 ;; Set article window start at LINE, where LINE is the number of lines
4515 ;; from the head of the article.
4516 (defun gnus-article-set-window-start (&optional line)
4517   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4518     (when article-window
4519       (set-window-start
4520        article-window
4521        (with-current-buffer gnus-article-buffer
4522          (goto-char (point-min))
4523          (if (not line)
4524              (point-min)
4525            (gnus-message 6 "Moved to bookmark")
4526            (search-forward "\n\n" nil t)
4527            (forward-line line)
4528            (point)))))))
4529
4530 (defun gnus-article-prepare (article &optional all-headers header)
4531   "Prepare ARTICLE in article mode buffer.
4532 ARTICLE should either be an article number or a Message-ID.
4533 If ARTICLE is an id, HEADER should be the article headers.
4534 If ALL-HEADERS is non-nil, no headers are hidden."
4535   (save-excursion
4536     ;; Make sure we start in a summary buffer.
4537     (unless (eq major-mode 'gnus-summary-mode)
4538       (set-buffer gnus-summary-buffer))
4539     (setq gnus-summary-buffer (current-buffer))
4540     (let* ((gnus-article (if header (mail-header-number header) article))
4541            (summary-buffer (current-buffer))
4542            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4543            (group gnus-newsgroup-name)
4544            result)
4545       (save-excursion
4546         (gnus-article-setup-buffer)
4547         (set-buffer gnus-article-buffer)
4548         ;; Deactivate active regions.
4549         (when (and (boundp 'transient-mark-mode)
4550                    transient-mark-mode)
4551           (setq mark-active nil))
4552         (if (not (setq result (let ((inhibit-read-only t))
4553                                 (gnus-request-article-this-buffer
4554                                  article group))))
4555             ;; There is no such article.
4556             (save-excursion
4557               (when (and (numberp article)
4558                          (not (memq article gnus-newsgroup-sparse)))
4559                 (setq gnus-article-current
4560                       (cons gnus-newsgroup-name article))
4561                 (set-buffer gnus-summary-buffer)
4562                 (setq gnus-current-article article)
4563                 (if (and (memq article gnus-newsgroup-undownloaded)
4564                          (not (gnus-online (gnus-find-method-for-group
4565                                             gnus-newsgroup-name))))
4566                     (progn
4567                       (gnus-summary-set-agent-mark article)
4568                       (message "Message marked for downloading"))
4569                   (gnus-summary-mark-article article gnus-canceled-mark)
4570                   (unless (memq article gnus-newsgroup-sparse)
4571                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4572           (if (or (eq result 'pseudo)
4573                   (eq result 'nneething))
4574               (progn
4575                 (with-current-buffer summary-buffer
4576                   (push article gnus-newsgroup-history)
4577                   (setq gnus-last-article gnus-current-article
4578                         gnus-current-article 0
4579                         gnus-current-headers nil
4580                         gnus-article-current nil)
4581                   (if (eq result 'nneething)
4582                       (gnus-configure-windows 'summary)
4583                     (gnus-configure-windows 'article))
4584                   (gnus-set-global-variables))
4585                 (let ((gnus-article-mime-handle-alist-1
4586                        gnus-article-mime-handle-alist))
4587                   (gnus-set-mode-line 'article)))
4588             ;; The result from the `request' was an actual article -
4589             ;; or at least some text that is now displayed in the
4590             ;; article buffer.
4591             (when (and (numberp article)
4592                        (not (eq article gnus-current-article)))
4593               ;; Seems like a new article has been selected.
4594               ;; `gnus-current-article' must be an article number.
4595               (with-current-buffer summary-buffer
4596                 (push article gnus-newsgroup-history)
4597                 (setq gnus-last-article gnus-current-article
4598                       gnus-current-article article
4599                       gnus-current-headers
4600                       (gnus-summary-article-header gnus-current-article)
4601                       gnus-article-current
4602                       (cons gnus-newsgroup-name gnus-current-article))
4603                 (unless (vectorp gnus-current-headers)
4604                   (setq gnus-current-headers nil))
4605                 (gnus-summary-goto-subject gnus-current-article)
4606                 (when (gnus-summary-show-thread)
4607                   ;; If the summary buffer really was folded, the
4608                   ;; previous goto may not actually have gone to
4609                   ;; the right article, but the thread root instead.
4610                   ;; So we go again.
4611                   (gnus-summary-goto-subject gnus-current-article))
4612                 (gnus-run-hooks 'gnus-mark-article-hook)
4613                 (gnus-set-mode-line 'summary)
4614                 (when (gnus-visual-p 'article-highlight 'highlight)
4615                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4616                 ;; Set the global newsgroup variables here.
4617                 (gnus-set-global-variables)
4618                 (setq gnus-have-all-headers
4619                       (or all-headers gnus-show-all-headers))))
4620             (save-excursion
4621               (gnus-configure-windows 'article))
4622             (when (or (numberp article)
4623                       (stringp article))
4624               (gnus-article-prepare-display)
4625               ;; Do page break.
4626               (goto-char (point-min))
4627               (when gnus-break-pages
4628                 (gnus-narrow-to-page)))
4629             (let ((gnus-article-mime-handle-alist-1
4630                    gnus-article-mime-handle-alist))
4631               (gnus-set-mode-line 'article))
4632             (article-goto-body)
4633             (unless (bobp)
4634               (forward-line -1))
4635             (set-window-point (get-buffer-window (current-buffer)) (point))
4636             (gnus-configure-windows 'article)
4637             (gnus-run-hooks 'gnus-article-prepare-hook)
4638             t))))))
4639
4640 ;;;###autoload
4641 (defun gnus-article-prepare-display ()
4642   "Make the current buffer look like a nice article."
4643   ;; Hooks for getting information from the article.
4644   ;; This hook must be called before being narrowed.
4645   (let ((gnus-article-buffer (current-buffer))
4646         buffer-read-only
4647         (inhibit-read-only t))
4648     (unless (eq major-mode 'gnus-article-mode)
4649       (gnus-article-mode))
4650     (setq buffer-read-only nil
4651           gnus-article-wash-types nil
4652           gnus-article-image-alist nil)
4653     (gnus-run-hooks 'gnus-tmp-internal-hook)
4654     (when gnus-display-mime-function
4655       (funcall gnus-display-mime-function))))
4656
4657 ;;;
4658 ;;; Gnus Sticky Article Mode
4659 ;;;
4660
4661 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4662   "Mode for sticky articles."
4663   ;; Release bindings that won't work.
4664   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4665                              gnus-sticky-article-mode-map)
4666   (substitute-key-definition 'gnus-article-refer-article 'undefined
4667                              gnus-sticky-article-mode-map)
4668   (dolist (k '("e" "h" "s" "F" "R"))
4669     (define-key gnus-sticky-article-mode-map k nil))
4670   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4671   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4672   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4673   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4674
4675 (defun gnus-sticky-article (arg)
4676   "Make the current article sticky.
4677 If a prefix ARG is given, ask for a name for this sticky article buffer."
4678   (interactive "P")
4679   (gnus-summary-show-thread)
4680   (gnus-summary-select-article nil nil 'pseudo)
4681   (let (new-art-buf-name)
4682     (gnus-eval-in-buffer-window gnus-article-buffer
4683       (setq new-art-buf-name
4684             (concat
4685              "*Sticky Article: "
4686              (if arg
4687                  (read-from-minibuffer "Sticky article buffer name: ")
4688                (gnus-with-article-headers
4689                  (gnus-article-goto-header "subject")
4690                  (setq new-art-buf-name
4691                        (buffer-substring-no-properties
4692                         (line-beginning-position) (line-end-position)))
4693                  (goto-char (point-min))
4694                  (gnus-article-goto-header "from")
4695                  (setq new-art-buf-name
4696                        (concat
4697                         new-art-buf-name ", "
4698                         (buffer-substring-no-properties
4699                          (line-beginning-position) (line-end-position))))
4700                  (goto-char (point-min))
4701                  (gnus-article-goto-header "date")
4702                  (setq new-art-buf-name
4703                        (concat
4704                         new-art-buf-name ", "
4705                         (buffer-substring-no-properties
4706                          (line-beginning-position) (line-end-position))))))
4707              "*"))
4708       (if (and (gnus-buffer-live-p new-art-buf-name)
4709                (with-current-buffer new-art-buf-name
4710                  (eq major-mode 'gnus-sticky-article-mode)))
4711           (switch-to-buffer new-art-buf-name)
4712         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4713       (gnus-sticky-article-mode))
4714     (setq gnus-article-buffer new-art-buf-name))
4715   (gnus-summary-recenter)
4716   (gnus-summary-position-point))
4717
4718 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4719   "Kill the given sticky article BUFFER.
4720 If none is given, assume the current buffer and kill it if it has
4721 `gnus-sticky-article-mode'."
4722   (interactive)
4723   (unless buffer
4724     (setq buffer (current-buffer)))
4725   (with-current-buffer buffer
4726     (when (eq major-mode 'gnus-sticky-article-mode)
4727       (gnus-kill-buffer buffer))))
4728
4729 (defun gnus-kill-sticky-article-buffers (arg)
4730   "Kill all sticky article buffers.
4731 If a prefix ARG is given, ask for confirmation."
4732   (interactive "P")
4733   (dolist (buf (gnus-buffers))
4734     (with-current-buffer buf
4735       (when (eq major-mode 'gnus-sticky-article-mode)
4736         (if (not arg)
4737             (gnus-kill-buffer buf)
4738           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4739             (gnus-kill-buffer buf)))))))
4740
4741 ;;;
4742 ;;; Gnus MIME viewing functions
4743 ;;;
4744
4745 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4746   "Format of the MIME buttons.
4747
4748 Valid specifiers include:
4749 %t  The MIME type
4750 %T  MIME type, along with additional info
4751 %n  The `name' parameter
4752 %d  The description, if any
4753 %l  The length of the encoded part
4754 %p  The part identifier number
4755 %e  Dots if the part isn't displayed
4756
4757 General format specifiers can also be used.  See Info node
4758 `(gnus)Formatting Variables'.")
4759
4760 (defvar gnus-mime-button-line-format-alist
4761   '((?t gnus-tmp-type ?s)
4762     (?T gnus-tmp-type-long ?s)
4763     (?n gnus-tmp-name ?s)
4764     (?d gnus-tmp-description ?s)
4765     (?p gnus-tmp-id ?s)
4766     (?l gnus-tmp-length ?d)
4767     (?e gnus-tmp-dots ?s)))
4768
4769 (defvar gnus-mime-button-commands
4770   '((gnus-article-press-button "\r" "Toggle Display")
4771     (gnus-mime-view-part "v" "View Interactively...")
4772     (gnus-mime-view-part-as-type "t" "View As Type...")
4773     (gnus-mime-view-part-as-charset "C" "View As charset...")
4774     (gnus-mime-save-part "o" "Save...")
4775     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4776     (gnus-mime-replace-part "r" "Replace part")
4777     (gnus-mime-delete-part "d" "Delete part")
4778     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4779     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4780     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4781     (gnus-mime-view-part-externally "e" "View Externally")
4782     (gnus-mime-print-part "p" "Print")
4783     (gnus-mime-pipe-part "|" "Pipe To Command...")
4784     (gnus-mime-action-on-part "." "Take action on the part...")))
4785
4786 (defun gnus-article-mime-part-status ()
4787   (if gnus-article-mime-handle-alist-1
4788       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4789           " (1 part)"
4790         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4791     ""))
4792
4793 (defvar gnus-mime-button-map
4794   (let ((map (make-sparse-keymap)))
4795     (define-key map gnus-mouse-2 'gnus-article-push-button)
4796     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4797     (dolist (c gnus-mime-button-commands)
4798       (define-key map (cadr c) (car c)))
4799     map))
4800
4801 (easy-menu-define
4802   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4803   `("MIME Part"
4804     ,@(mapcar (lambda (c)
4805                 (vector (caddr c) (car c) :active t))
4806               gnus-mime-button-commands)))
4807
4808 (defvar gnus-url-button-commands
4809   '((gnus-article-copy-string "u" "Copy URL to kill ring")))
4810
4811 (defvar gnus-url-button-map
4812   (let ((map (make-sparse-keymap)))
4813     (dolist (c gnus-url-button-commands)
4814       (define-key map (cadr c) (car c)))
4815     map))
4816
4817 (easy-menu-define
4818   gnus-url-button-menu gnus-url-button-map "URL button menu."
4819   `("Url Button"
4820     ,@(mapcar (lambda (c)
4821                 (vector (caddr c) (car c) :active t))
4822               gnus-url-button-commands)))
4823
4824 (defmacro gnus-bind-safe-url-regexp (&rest body)
4825   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4826   `(let ((mm-w3m-safe-url-regexp
4827           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4828                                 (gnus-buffer-live-p
4829                                  gnus-article-current-summary))
4830                            (with-current-buffer gnus-article-current-summary
4831                              gnus-newsgroup-name)
4832                          gnus-newsgroup-name)))
4833             (if (cond ((not group)
4834                        ;; Maybe we're in a mml-preview buffer
4835                        ;; and no group is selected.
4836                        t)
4837                       ((stringp gnus-safe-html-newsgroups)
4838                        (string-match gnus-safe-html-newsgroups group))
4839                       ((consp gnus-safe-html-newsgroups)
4840                        (member group gnus-safe-html-newsgroups)))
4841                 nil
4842               mm-w3m-safe-url-regexp))))
4843      ,@body))
4844
4845 (defun gnus-mime-button-menu (event prefix)
4846  "Construct a context-sensitive menu of MIME commands."
4847  (interactive "e\nP")
4848  (save-window-excursion
4849    (let ((pos (event-start event)))
4850      (select-window (posn-window pos))
4851      (goto-char (posn-point pos))
4852      (gnus-article-check-buffer)
4853      (popup-menu gnus-mime-button-menu nil prefix))))
4854
4855 (defun gnus-mime-view-all-parts (&optional handles)
4856   "View all the MIME parts."
4857   (interactive)
4858   (with-current-buffer gnus-article-buffer
4859     (let ((handles (or handles gnus-article-mime-handles))
4860           (mail-parse-charset gnus-newsgroup-charset)
4861           (mail-parse-ignored-charsets
4862            (with-current-buffer gnus-summary-buffer
4863              gnus-newsgroup-ignored-charsets)))
4864       (when handles
4865         (mm-remove-parts handles)
4866         (goto-char (point-min))
4867         (or (search-forward "\n\n") (goto-char (point-max)))
4868         (let ((inhibit-read-only t))
4869           (delete-region (point) (point-max))
4870           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4871
4872 (defun gnus-article-jump-to-part (n)
4873   "Jump to MIME part N."
4874   (interactive "P")
4875   (let ((parts (with-current-buffer gnus-article-buffer
4876                  (length gnus-article-mime-handle-alist))))
4877     (when (zerop parts)
4878       (error "No such part"))
4879     (pop-to-buffer gnus-article-buffer)
4880     (or n
4881         (setq n (if (= parts 1)
4882                     1
4883                   (read-number (format "Jump to part (1..%s): " parts)))))
4884     (unless (and (integerp n) (<= n parts) (>= n 1))
4885       (setq n
4886             (progn
4887               (gnus-message 7 "Invalid part `%s', using %s instead."
4888                             n parts)
4889               parts)))
4890     (gnus-message 9 "Jumping to part %s." n)
4891     (cond ((>= gnus-auto-select-part 1)
4892            (while (and (<= n parts)
4893                        (not (gnus-article-goto-part n)))
4894              (setq n (1+ n))))
4895           ((< gnus-auto-select-part 0)
4896            (while (and (>= n 1)
4897                        (not (gnus-article-goto-part n)))
4898              (setq n (1- n))))
4899           (t
4900            (gnus-article-goto-part n)))))
4901
4902 (defvar gnus-mime-buttonized-part-id nil
4903   "ID of a mime part that should be buttonized.
4904 `gnus-mime-save-part-and-strip' and `gnus-mime-delete-part' bind it.")
4905
4906 (eval-when-compile
4907   (defsubst gnus-article-edit-part (handles &optional current-id)
4908     "Edit an article in order to delete a mime part.
4909 This function is exclusively used by `gnus-mime-save-part-and-strip'
4910 and `gnus-mime-delete-part', and not provided at run-time normally."
4911     (gnus-article-edit-article
4912      `(lambda ()
4913         (buffer-disable-undo)
4914         (erase-buffer)
4915         (let ((mail-parse-charset (or gnus-article-charset
4916                                       ',gnus-newsgroup-charset))
4917               (mail-parse-ignored-charsets
4918                (or gnus-article-ignored-charsets
4919                    ',gnus-newsgroup-ignored-charsets))
4920               (mbl mml-buffer-list))
4921           (setq mml-buffer-list nil)
4922           (insert-buffer-substring gnus-original-article-buffer)
4923           (mime-to-mml ',handles)
4924           (setq gnus-article-mime-handles nil)
4925           (let ((mbl1 mml-buffer-list))
4926             (setq mml-buffer-list mbl)
4927             (set (make-local-variable 'mml-buffer-list) mbl1))
4928           (gnus-make-local-hook 'kill-buffer-hook)
4929           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4930      `(lambda (no-highlight)
4931         (let ((mail-parse-charset (or gnus-article-charset
4932                                       ',gnus-newsgroup-charset))
4933               (message-options message-options)
4934               (message-options-set-recipient)
4935               (mail-parse-ignored-charsets
4936                (or gnus-article-ignored-charsets
4937                    ',gnus-newsgroup-ignored-charsets)))
4938           (mml-to-mime)
4939           (mml-destroy-buffers)
4940           (remove-hook 'kill-buffer-hook
4941                        'mml-destroy-buffers t)
4942           (kill-local-variable 'mml-buffer-list))
4943         (gnus-summary-edit-article-done
4944          ,(or (mail-header-references gnus-current-headers) "")
4945          ,(gnus-group-read-only-p)
4946          ,gnus-summary-buffer no-highlight))
4947      t)
4948     ;; Force buttonizing this part.
4949     (let ((gnus-mime-buttonized-part-id current-id))
4950       (gnus-article-edit-done))
4951     (gnus-configure-windows 'article)
4952     (when (and current-id (integerp gnus-auto-select-part))
4953       (gnus-article-jump-to-part
4954        (min (max (+ current-id gnus-auto-select-part) 1)
4955             (with-current-buffer gnus-article-buffer
4956               (length gnus-article-mime-handle-alist)))))))
4957
4958 (defun gnus-mime-replace-part (file)
4959   "Replace MIME part under point with an external body."
4960   ;; Useful if file has already been saved to disk
4961   (interactive
4962    (list
4963     (read-file-name "Replace MIME part with file: "
4964                     (or mm-default-directory default-directory)
4965                     nil nil)))
4966   (gnus-mime-save-part-and-strip file))
4967
4968 (defun gnus-mime-save-part-and-strip (&optional file)
4969   "Save the MIME part under point then replace it with an external body.
4970 If FILE is given, use it for the external part."
4971   (interactive)
4972   (gnus-article-check-buffer)
4973   (when (gnus-group-read-only-p)
4974     (error "The current group does not support deleting of parts"))
4975   (when (mm-complicated-handles gnus-article-mime-handles)
4976     (error "\
4977 The current article has a complicated MIME structure, giving up..."))
4978   (let* ((data (get-text-property (point) 'gnus-data))
4979          (id (get-text-property (point) 'gnus-part))
4980          param
4981          (handles gnus-article-mime-handles))
4982     (unless file
4983       (setq file
4984             (and data (mm-save-part data "Delete MIME part and save to: "))))
4985     (when file
4986       (with-current-buffer (mm-handle-buffer data)
4987         (erase-buffer)
4988         (insert "Content-Type: " (mm-handle-media-type data))
4989         (mml-insert-parameter-string (cdr (mm-handle-type data))
4990                                      '(charset))
4991         ;; Add a filename for the sake of saving the part again.
4992         (mml-insert-parameter
4993          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4994         (insert "\n")
4995         (insert "Content-ID: " (message-make-message-id) "\n")
4996         (insert "Content-Transfer-Encoding: binary\n")
4997         (insert "\n"))
4998       (setcdr data
4999               (cdr (mm-make-handle nil
5000                                    `("message/external-body"
5001                                      (access-type . "LOCAL-FILE")
5002                                      (name . ,file)))))
5003       ;; (set-buffer gnus-summary-buffer)
5004       (gnus-article-edit-part handles id))))
5005
5006 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
5007 ;; parts...>') but with stripping would be nice.
5008
5009 (defun gnus-mime-delete-part ()
5010   "Delete the MIME part under point.
5011 Replace it with some information about the removed part."
5012   (interactive)
5013   (gnus-article-check-buffer)
5014   (when (gnus-group-read-only-p)
5015     (error "The current group does not support deleting of parts"))
5016   (when (mm-complicated-handles gnus-article-mime-handles)
5017     (error "\
5018 The current article has a complicated MIME structure, giving up..."))
5019   (when (or gnus-expert-user
5020             (gnus-yes-or-no-p "\
5021 Deleting parts may malfunction or destroy the article; continue? "))
5022     (let* ((data (get-text-property (point) 'gnus-data))
5023            (id (get-text-property (point) 'gnus-part))
5024            (handles gnus-article-mime-handles)
5025            (none "(none)")
5026            (description
5027             (let ((desc (mm-handle-description data)))
5028               (when desc
5029                 (mail-decode-encoded-word-string desc))))
5030            (filename
5031             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
5032                 none))
5033            (type (mm-handle-media-type data)))
5034       (unless data
5035         (error "No MIME part under point"))
5036       (with-current-buffer (mm-handle-buffer data)
5037         (let ((bsize (buffer-size)))
5038           (erase-buffer)
5039           (insert
5040            (concat
5041             ",----\n"
5042             "| The following attachment has been deleted:\n"
5043             "|\n"
5044             "| Type:           " type "\n"
5045             "| Filename:       " filename "\n"
5046             "| Size (encoded): " (format "%s byte%s\n"
5047                                          bsize (if (= bsize 1)
5048                                                    ""
5049                                                  "s"))
5050             (when description
5051               (concat    "| Description:    " description "\n"))
5052             "`----\n"))
5053           (setcdr data
5054                   (cdr (mm-make-handle
5055                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5056                         (list "attachment")
5057                         (format "Deleted attachment (%s bytes)" bsize))))))
5058       ;; (set-buffer gnus-summary-buffer)
5059       (gnus-article-edit-part handles id))))
5060
5061 (defun gnus-mime-save-part ()
5062   "Save the MIME part under point."
5063   (interactive)
5064   (gnus-article-check-buffer)
5065   (let ((data (get-text-property (point) 'gnus-data)))
5066     (when data
5067       (mm-save-part data))))
5068
5069 (defun gnus-mime-pipe-part (&optional cmd)
5070   "Pipe the MIME part under point to a process.
5071 Use CMD as the process."
5072   (interactive)
5073   (gnus-article-check-buffer)
5074   (let ((data (get-text-property (point) 'gnus-data)))
5075     (when data
5076       (mm-pipe-part data cmd))))
5077
5078 (defun gnus-mime-view-part ()
5079   "Interactively choose a viewing method for the MIME part under point."
5080   (interactive)
5081   (gnus-article-check-buffer)
5082   (let ((data (get-text-property (point) 'gnus-data)))
5083     (when data
5084       (setq gnus-article-mime-handles
5085             (mm-merge-handles
5086              gnus-article-mime-handles (setq data (copy-sequence data))))
5087       (mm-interactively-view-part data))))
5088
5089 (defun gnus-mime-view-part-as-type-internal ()
5090   (gnus-article-check-buffer)
5091   (let* ((handle (get-text-property (point) 'gnus-data))
5092          (name (or
5093                 ;; Content-Type: foo/bar; name=...
5094                 (mail-content-type-get (mm-handle-type handle) 'name)
5095                 ;; Content-Disposition: attachment; filename=...
5096                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5097          (def-type (and name (mm-default-file-encoding name))))
5098     (or (and def-type (cons def-type 0))
5099         (and handle
5100              (equal (mm-handle-media-supertype handle) "text")
5101              '("text/plain" . 0))
5102         '("application/octet-stream" . 0))))
5103
5104 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5105   "Choose a MIME media type, and view the part as such.
5106 If non-nil, PRED is a predicate to use during completion to limit the
5107 available media-types."
5108   (interactive)
5109   (unless mime-type
5110     (setq mime-type
5111           (let ((default (gnus-mime-view-part-as-type-internal)))
5112             (gnus-completing-read
5113              "View as MIME type"
5114              (if pred
5115                  (gnus-remove-if-not pred (mailcap-mime-types))
5116                (mailcap-mime-types))
5117              nil nil nil
5118              (car default)))))
5119   (gnus-article-check-buffer)
5120   (let ((handle (get-text-property (point) 'gnus-data)))
5121     (when handle
5122       (when (equal (mm-handle-media-type handle) "message/external-body")
5123         (unless (mm-handle-cache handle)
5124           (mm-extern-cache-contents handle))
5125         (setq handle (mm-handle-cache handle)))
5126       (setq handle
5127             (mm-make-handle (mm-handle-buffer handle)
5128                             (cons mime-type (cdr (mm-handle-type handle)))
5129                             (mm-handle-encoding handle)
5130                             (mm-handle-undisplayer handle)
5131                             (mm-handle-disposition handle)
5132                             (mm-handle-description handle)
5133                             nil
5134                             (mm-handle-id handle)))
5135       (setq gnus-article-mime-handles
5136             (mm-merge-handles gnus-article-mime-handles handle))
5137       (when (mm-handle-displayed-p handle)
5138         (mm-remove-part handle))
5139       (gnus-mm-display-part handle))))
5140
5141 (defun gnus-mime-copy-part (&optional handle arg)
5142   "Put the MIME part under point into a new buffer.
5143 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5144 are decompressed."
5145   (interactive (list nil current-prefix-arg))
5146   (gnus-article-check-buffer)
5147   (unless handle
5148     (setq handle (get-text-property (point) 'gnus-data)))
5149   (when handle
5150     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5151                                                'name)
5152                         (mail-content-type-get (mm-handle-disposition handle)
5153                                                'filename)))
5154           contents dont-decode charset coding-system)
5155       (mm-with-unibyte-buffer
5156         (mm-insert-part handle)
5157         (setq contents (or (condition-case nil
5158                                (mm-decompress-buffer filename nil 'sig)
5159                              (error
5160                               (setq dont-decode t)
5161                               nil))
5162                            (buffer-string))))
5163       (setq filename (cond (filename (file-name-nondirectory filename))
5164                            (dont-decode "*raw data*")
5165                            (t "*decoded*")))
5166       (cond
5167        (dont-decode)
5168        ((not arg)
5169         (unless (setq charset (mail-content-type-get
5170                                (mm-handle-type handle) 'charset))
5171           (unless (setq coding-system (mm-with-unibyte-buffer
5172                                         (insert contents)
5173                                         (mm-find-buffer-file-coding-system)))
5174             (setq charset gnus-newsgroup-charset))))
5175        ((numberp arg)
5176         (setq charset (or (cdr (assq arg
5177                                      gnus-summary-show-article-charset-alist))
5178                           (mm-read-coding-system "Charset: ")))))
5179       (switch-to-buffer (generate-new-buffer filename))
5180       (if (or coding-system
5181               (and charset
5182                    (setq coding-system (mm-charset-to-coding-system charset))
5183                    (not (eq coding-system 'ascii))))
5184           (progn
5185             (mm-enable-multibyte)
5186             (insert (mm-decode-coding-string contents coding-system))
5187             (setq buffer-file-coding-system
5188                   (if (boundp 'last-coding-system-used)
5189                       (symbol-value 'last-coding-system-used)
5190                     coding-system)))
5191         (mm-disable-multibyte)
5192         (insert contents)
5193         (setq buffer-file-coding-system mm-binary-coding-system))
5194       ;; We do it this way to make `normal-mode' set the appropriate mode.
5195       (unwind-protect
5196           (progn
5197             (setq buffer-file-name (expand-file-name filename))
5198             (normal-mode))
5199         (setq buffer-file-name nil))
5200       (goto-char (point-min)))))
5201
5202 (defun gnus-mime-print-part (&optional handle filename)
5203   "Print the MIME part under point."
5204   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5205   (gnus-article-check-buffer)
5206   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5207          (contents (and handle (mm-get-part handle)))
5208          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5209          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5210     (when contents
5211         (if printer
5212             (unwind-protect
5213                 (progn
5214                   (mm-save-part-to-file handle file)
5215                   (call-process shell-file-name nil
5216                                 (generate-new-buffer " *mm*")
5217                                 nil
5218                                 shell-command-switch
5219                                 (mm-mailcap-command
5220                                  printer file (mm-handle-type handle))))
5221               (delete-file file))
5222           (with-temp-buffer
5223             (insert contents)
5224             (gnus-print-buffer))
5225           (ps-despool filename)))))
5226
5227 (defun gnus-mime-inline-part (&optional handle arg)
5228   "Insert the MIME part under point into the current buffer.
5229 Compressed files like .gz and .bz2 are decompressed."
5230   (interactive (list nil current-prefix-arg))
5231   (gnus-article-check-buffer)
5232   (unless handle
5233     (setq handle (get-text-property (point) 'gnus-data)))
5234   (when handle
5235     (let ((b (point))
5236           (inhibit-read-only t)
5237           contents charset coding-system)
5238       (if (and (not arg) (mm-handle-undisplayer handle))
5239           (mm-remove-part handle)
5240         (mm-with-unibyte-buffer
5241           (mm-insert-part handle)
5242           (setq contents
5243                 (or (mm-decompress-buffer
5244                      (or (mail-content-type-get (mm-handle-type handle)
5245                                                 'name)
5246                          (mail-content-type-get (mm-handle-disposition handle)
5247                                                 'filename))
5248                      nil t)
5249                     (buffer-string))))
5250         (cond
5251          ((not arg)
5252           (unless (setq charset (mail-content-type-get
5253                                  (mm-handle-type handle) 'charset))
5254             (unless (setq coding-system
5255                           (mm-with-unibyte-buffer
5256                             (insert contents)
5257                             (mm-find-buffer-file-coding-system)))
5258               (setq charset gnus-newsgroup-charset))))
5259          ((numberp arg)
5260           (if (mm-handle-undisplayer handle)
5261               (mm-remove-part handle))
5262           (setq charset
5263                 (or (cdr (assq arg
5264                                gnus-summary-show-article-charset-alist))
5265                     (mm-read-coding-system "Charset: "))))
5266          (t
5267           (if (mm-handle-undisplayer handle)
5268               (mm-remove-part handle))))
5269         (forward-line 2)
5270         (mm-display-inline handle)
5271         (goto-char b)))))
5272
5273 (defun gnus-mime-set-charset-parameters (handle charset)
5274   "Set CHARSET to parameters in HANDLE.
5275 CHARSET may either be a string or a symbol."
5276   (unless (stringp charset)
5277     (setq charset (symbol-name charset)))
5278   (if (stringp (car handle))
5279       (dolist (h (cdr handle))
5280         (gnus-mime-set-charset-parameters h charset))
5281     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5282                                             "message/external-body")
5283                                      (progn
5284                                        (unless (mm-handle-cache handle)
5285                                          (mm-extern-cache-contents handle))
5286                                        (mm-handle-cache handle))
5287                                    handle)))
5288            (param (assq 'charset (cdr type))))
5289       (if param
5290           (setcdr param charset)
5291         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5292
5293 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5294   "Insert the MIME part under point into the current buffer using the
5295 specified charset."
5296   (interactive (list nil current-prefix-arg))
5297   (gnus-article-check-buffer)
5298   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5299         (fun (get-text-property (point) 'gnus-callback))
5300         (gnus-newsgroup-ignored-charsets 'gnus-all)
5301         charset form preferred parts)
5302     (when handle
5303       (when (prog1
5304                 (and fun
5305                      (setq charset
5306                            (or (cdr (assq
5307                                      arg
5308                                      gnus-summary-show-article-charset-alist))
5309                                (mm-read-coding-system "Charset: "))))
5310               (if (mm-handle-undisplayer handle)
5311                   (mm-remove-part handle)))
5312         (gnus-mime-set-charset-parameters handle charset)
5313         (when (and (consp (setq form (cdr-safe fun)))
5314                    (setq form (ignore-errors
5315                                 (assq 'gnus-mime-display-alternative form)))
5316                    (setq preferred (caddr form))
5317                    (progn
5318                      (when (eq (car preferred) 'quote)
5319                        (setq preferred (cadr preferred)))
5320                      (not (equal preferred
5321                                  (get-text-property (point) 'gnus-data))))
5322                    (setq parts (get-text-property (point) 'gnus-part))
5323                    (setq parts (cdr (assq parts
5324                                           gnus-article-mime-handle-alist)))
5325                    (equal (mm-handle-media-type parts) "multipart/alternative")
5326                    (setq parts (reverse (cdr parts))))
5327           (setcar (cddr form)
5328                   (list 'quote (or (cadr (member preferred parts))
5329                                    (car parts)))))
5330         (funcall fun handle)))))
5331
5332 (defun gnus-mime-view-part-externally (&optional handle)
5333   "View the MIME part under point with an external viewer."
5334   (interactive)
5335   (gnus-article-check-buffer)
5336   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5337          (mm-user-display-methods nil)
5338          (mm-inlined-types nil)
5339          (mail-parse-charset gnus-newsgroup-charset)
5340          (mail-parse-ignored-charsets
5341           (with-current-buffer gnus-summary-buffer
5342             gnus-newsgroup-ignored-charsets))
5343          (type (mm-handle-media-type handle))
5344          (method (mailcap-mime-info type))
5345          (mm-enable-external t))
5346     (if (not (stringp method))
5347         (gnus-mime-view-part-as-type
5348          nil (lambda (type) (stringp (mailcap-mime-info type))))
5349       (when handle
5350         (mm-display-part handle nil t)))))
5351
5352 (defun gnus-mime-view-part-internally (&optional handle)
5353   "View the MIME part under point with an internal viewer.
5354 If no internal viewer is available, use an external viewer."
5355   (interactive)
5356   (gnus-article-check-buffer)
5357   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5358          (mm-inlined-types '(".*"))
5359          (mm-inline-large-images t)
5360          (mail-parse-charset gnus-newsgroup-charset)
5361          (mail-parse-ignored-charsets
5362           (with-current-buffer gnus-summary-buffer
5363             gnus-newsgroup-ignored-charsets))
5364          (inhibit-read-only t))
5365     (if (not (mm-inlinable-p handle))
5366         (gnus-mime-view-part-as-type
5367          nil (lambda (type) (mm-inlinable-p handle type)))
5368       (when handle
5369         (gnus-bind-safe-url-regexp (mm-display-part handle))))))
5370
5371 (defun gnus-mime-action-on-part (&optional action)
5372   "Do something with the MIME attachment at \(point\)."
5373   (interactive
5374    (list (gnus-completing-read "Action" (mapcar 'car gnus-mime-action-alist) t)))
5375   (gnus-article-check-buffer)
5376   (let ((action-pair (assoc action gnus-mime-action-alist)))
5377     (if action-pair
5378         (funcall (cdr action-pair)))))
5379
5380 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5381   "Call FUNCTION on MIME part N.
5382 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5383 If INTERACTIVE, call FUNCTION interactivly."
5384   (let (window frame)
5385     ;; Check whether the article is displayed.
5386     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5387                  (setq window (get-buffer-window gnus-article-buffer t))
5388                  (frame-visible-p (setq frame (window-frame window))))
5389       (error "No article is displayed"))
5390     (with-current-buffer gnus-article-buffer
5391       ;; Check whether the article displays the right contents.
5392       (unless (with-current-buffer gnus-summary-buffer
5393                 (eq gnus-current-article (gnus-summary-article-number)))
5394         (error "You should select the right article first"))
5395       (if n
5396           (setq n (prefix-numeric-value n))
5397         (let ((pt (point)))
5398           (setq n (or (get-text-property pt 'gnus-part)
5399                       (and (not (bobp))
5400                            (get-text-property (1- pt) 'gnus-part))
5401                       (get-text-property (prog2
5402                                              (forward-line 1)
5403                                              (point)
5404                                            (goto-char pt))
5405                                          'gnus-part)
5406                       (get-text-property
5407                        (or (and (setq pt (previous-single-property-change
5408                                           pt 'gnus-part))
5409                                 (1- pt))
5410                            (next-single-property-change (point) 'gnus-part)
5411                            (point))
5412                        'gnus-part)
5413                       1))))
5414       ;; Check whether the specified part exists.
5415       (when (> n (length gnus-article-mime-handle-alist))
5416         (error "No such part")))
5417     (unless
5418         (progn
5419           ;; To select the window is needed so that the cursor
5420           ;; might be visible on the MIME button.
5421           (select-window (prog1
5422                              window
5423                            (setq window (selected-window))
5424                            ;; Article may be displayed in the other frame.
5425                            (gnus-select-frame-set-input-focus
5426                             (prog1
5427                                 frame
5428                               (setq frame (selected-frame))))))
5429           (when (gnus-article-goto-part n)
5430             ;; We point the cursor and the arrow at the MIME button
5431             ;; when the `function' prompt the user for something.
5432             (unless (and (pos-visible-in-window-p)
5433                          (> (count-lines (point) (window-end))
5434                             (/ (1- (window-height)) 3)))
5435               (recenter (/ (1- (window-height)) 3)))
5436             (let ((cursor-in-non-selected-windows t)
5437                   (overlay-arrow-string "=>")
5438                   (overlay-arrow-position (point-marker)))
5439               (unwind-protect
5440                   (cond
5441                    ((and no-handle interactive)
5442                     (call-interactively function))
5443                    (no-handle
5444                     (funcall function))
5445                    (interactive
5446                     (call-interactively
5447                      function (get-text-property (point) 'gnus-data)))
5448                    (t
5449                     (funcall function
5450                              (get-text-property (point) 'gnus-data))))
5451                 (set-marker overlay-arrow-position nil)
5452                 (unless gnus-auto-select-part
5453                   (gnus-select-frame-set-input-focus frame)
5454                   (select-window window))))
5455             t))
5456       (if gnus-inhibit-mime-unbuttonizing
5457           ;; This is the default though the program shouldn't reach here.
5458           (error "No such part")
5459         ;; The part which doesn't have the MIME button is selected.
5460         ;; So, we display all the buttons and redo it.
5461         (let ((gnus-inhibit-mime-unbuttonizing t))
5462           (gnus-summary-show-article)
5463           (gnus-article-part-wrapper n function no-handle))))))
5464
5465 (defun gnus-article-pipe-part (n)
5466   "Pipe MIME part N, which is the numerical prefix."
5467   (interactive "P")
5468   (gnus-article-part-wrapper n 'mm-pipe-part))
5469
5470 (defun gnus-article-save-part (n)
5471   "Save MIME part N, which is the numerical prefix."
5472   (interactive "P")
5473   (gnus-article-part-wrapper n 'mm-save-part))
5474
5475 (defun gnus-article-interactively-view-part (n)
5476   "View MIME part N interactively, which is the numerical prefix."
5477   (interactive "P")
5478   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5479
5480 (defun gnus-article-copy-part (n)
5481   "Copy MIME part N, which is the numerical prefix."
5482   (interactive "P")
5483   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5484
5485 (defun gnus-article-view-part-as-charset (n)
5486   "View MIME part N using a specified charset.
5487 N is the numerical prefix."
5488   (interactive "P")
5489   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5490
5491 (defun gnus-article-view-part-externally (n)
5492   "View MIME part N externally, which is the numerical prefix."
5493   (interactive "P")
5494   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5495
5496 (defun gnus-article-inline-part (n)
5497   "Inline MIME part N, which is the numerical prefix."
5498   (interactive "P")
5499   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5500
5501 (defun gnus-article-save-part-and-strip (n)
5502   "Save MIME part N and replace it with an external body.
5503 N is the numerical prefix."
5504   (interactive "P")
5505   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5506
5507 (defun gnus-article-replace-part (n)
5508   "Replace MIME part N with an external body.
5509 N is the numerical prefix."
5510   (interactive "P")
5511   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5512
5513 (defun gnus-article-delete-part (n)
5514   "Delete MIME part N and add some information about the removed part.
5515 N is the numerical prefix."
5516   (interactive "P")
5517   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5518
5519 (defun gnus-article-view-part-as-type (n)
5520   "Choose a MIME media type, and view part N as such.
5521 N is the numerical prefix."
5522   (interactive "P")
5523   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5524
5525 (defun gnus-article-mime-match-handle-first (condition)
5526   (if condition
5527       (let (n)
5528         (dolist (ihandle gnus-article-mime-handle-alist)
5529           (if (and (cond
5530                     ((functionp condition)
5531                      (funcall condition (cdr ihandle)))
5532                     ((eq condition 'undisplayed)
5533                      (not (or (mm-handle-undisplayer (cdr ihandle))
5534                               (equal (mm-handle-media-type (cdr ihandle))
5535                                      "multipart/alternative"))))
5536                     ((eq condition 'undisplayed-alternative)
5537                      (not (mm-handle-undisplayer (cdr ihandle))))
5538                     (t t))
5539                    (gnus-article-goto-part (car ihandle))
5540                    (or (not n) (< (car ihandle) n)))
5541               (setq n (car ihandle))))
5542         (or n 1))
5543     1))
5544
5545 (defun gnus-article-view-part (&optional n)
5546   "View MIME part N, which is the numerical prefix.
5547 If the part is already shown, hide the part.  If N is nil, view
5548 all parts."
5549   (interactive "P")
5550   (with-current-buffer gnus-article-buffer
5551     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5552                              gnus-article-mime-match-handle-function)))
5553     (when (> n (length gnus-article-mime-handle-alist))
5554       (error "No such part"))
5555     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5556       (when (gnus-article-goto-part n)
5557         (if (equal (car handle) "multipart/alternative")
5558             (gnus-article-press-button)
5559           (when (eq (gnus-mm-display-part handle) 'internal)
5560             (gnus-set-window-start)))))))
5561
5562 (defsubst gnus-article-mime-total-parts ()
5563   (if (bufferp (car gnus-article-mime-handles))
5564       1 ;; single part
5565     (1- (length gnus-article-mime-handles))))
5566
5567 (defun gnus-mm-display-part (handle)
5568   "Display HANDLE and fix MIME button."
5569   (let ((id (get-text-property (point) 'gnus-part))
5570         (point (point))
5571         (inhibit-read-only t))
5572     (forward-line 1)
5573     (prog1
5574         (let ((window (selected-window))
5575               (mail-parse-charset gnus-newsgroup-charset)
5576               (mail-parse-ignored-charsets
5577                (if (gnus-buffer-live-p gnus-summary-buffer)
5578                    (with-current-buffer gnus-summary-buffer
5579                      gnus-newsgroup-ignored-charsets)
5580                  nil)))
5581           (save-excursion
5582             (unwind-protect
5583                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5584                       (beg (point)))
5585                   (when win
5586                     (select-window win))
5587                   (goto-char point)
5588                   (forward-line)
5589                   (if (mm-handle-displayed-p handle)
5590                       ;; This will remove the part.
5591                       (mm-display-part handle)
5592                     (save-restriction
5593                       (narrow-to-region (point)
5594                                         (if (eobp) (point) (1+ (point))))
5595                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5596                       ;; We narrow to the part itself and
5597                       ;; then call the treatment functions.
5598                       (goto-char (point-min))
5599                       (forward-line 1)
5600                       (narrow-to-region (point) (point-max))
5601                       (gnus-treat-article
5602                        nil id
5603                        (gnus-article-mime-total-parts)
5604                        (mm-handle-media-type handle)))))
5605               (if (window-live-p window)
5606                   (select-window window)))))
5607       (goto-char point)
5608       (gnus-delete-line)
5609       (gnus-insert-mime-button
5610        handle id (list (mm-handle-displayed-p handle)))
5611       (goto-char point))))
5612
5613 (defun gnus-article-goto-part (n)
5614   "Go to MIME part N."
5615   (when gnus-break-pages
5616     (widen))
5617   (prog1
5618       (let ((start (text-property-any (point-min) (point-max) 'gnus-part n))
5619             part handle end next handles)
5620         (when start
5621           (goto-char start)
5622           (if (setq handle (get-text-property start 'gnus-data))
5623               start
5624             ;; Go to the displayed subpart, assuming this is
5625             ;; multipart/alternative.
5626             (setq part start
5627                   end (point-at-eol))
5628             (while (and (not handle)
5629                         part
5630                         (< part end)
5631                         (setq next (text-property-not-all part end
5632                                                           'gnus-data nil)))
5633               (setq part next
5634                     handle (get-text-property part 'gnus-data))
5635               (push (cons handle part) handles)
5636               (unless (mm-handle-displayed-p handle)
5637                 (setq handle nil
5638                       part (text-property-any part end 'gnus-data nil))))
5639             (unless handle
5640               ;; No subpart is displayed, so we find preferred one.
5641               (setq part
5642                     (cdr (assq (mm-preferred-alternative
5643                                 (nreverse (mapcar 'car handles)))
5644                                handles))))
5645             (if part
5646                 (goto-char (1+ part))
5647               start))))
5648     (when gnus-break-pages
5649       (gnus-narrow-to-page))))
5650
5651 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5652   (let ((gnus-tmp-name
5653          (or (mail-content-type-get (mm-handle-type handle) 'name)
5654              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5655              (mail-content-type-get (mm-handle-type handle) 'url)
5656              ""))
5657         (gnus-tmp-type (mm-handle-media-type handle))
5658         (gnus-tmp-description (or (mm-handle-description handle) ""))
5659         (gnus-tmp-dots
5660          (if (if displayed (car displayed)
5661                (mm-handle-displayed-p handle))
5662              "" "..."))
5663         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5664                            (buffer-size)))
5665         gnus-tmp-type-long b e)
5666     (when (string-match ".*/" gnus-tmp-name)
5667       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5668     (setq gnus-tmp-type-long (concat gnus-tmp-type
5669                                      (and (not (equal gnus-tmp-name ""))
5670                                           (concat "; " gnus-tmp-name))))
5671     (unless (equal gnus-tmp-description "")
5672       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5673     (unless (bolp)
5674       (insert "\n"))
5675     (setq b (point))
5676     (gnus-eval-format
5677      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5678      `(keymap ,gnus-mime-button-map
5679               gnus-callback gnus-mm-display-part
5680               gnus-part ,gnus-tmp-id
5681               article-type annotation
5682               gnus-data ,handle))
5683     (setq e (if (bolp)
5684                 ;; Exclude a newline.
5685                 (1- (point))
5686               (point)))
5687     (when gnus-article-button-face
5688       (gnus-overlay-put (gnus-make-overlay b e nil t)
5689                         'face gnus-article-button-face))
5690     (widget-convert-button
5691      'link b e
5692      :mime-handle handle
5693      :action 'gnus-widget-press-button
5694      :button-keymap gnus-mime-button-map
5695      :help-echo
5696      (lambda (widget)
5697        ;; Needed to properly clear the message due to a bug in
5698        ;; wid-edit (XEmacs only).
5699        (if (boundp 'help-echo-owns-message)
5700            (setq help-echo-owns-message t))
5701        (format
5702         "%S: %s the MIME part; %S: more options"
5703         (aref gnus-mouse-2 0)
5704         (if (mm-handle-displayed-p (widget-get widget :mime-handle))
5705             "hide" "show")
5706         (aref gnus-down-mouse-3 0))))))
5707
5708 (defun gnus-widget-press-button (elems el)
5709   (goto-char (widget-get elems :from))
5710   (gnus-article-press-button))
5711
5712 (defvar gnus-displaying-mime nil)
5713
5714 (defun gnus-display-mime (&optional ihandles)
5715   "Display the MIME parts."
5716   (save-excursion
5717     (save-selected-window
5718       (let ((window (get-buffer-window gnus-article-buffer))
5719             (point (point)))
5720         (when window
5721           (select-window window)
5722           ;; We have to do this since selecting the window
5723           ;; may change the point.  So we set the window point.
5724           (set-window-point window point)))
5725       (let ((handles ihandles)
5726             (inhibit-read-only t)
5727             handle)
5728         (cond (handles)
5729               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5730                (when gnus-article-emulate-mime
5731                  (mm-uu-dissect-text-parts handles)))
5732               (gnus-article-emulate-mime
5733                (setq handles (mm-uu-dissect))))
5734         (when (and (not ihandles)
5735                    (not gnus-displaying-mime))
5736           ;; Top-level call; we clean up.
5737           (when gnus-article-mime-handles
5738             (mm-destroy-parts gnus-article-mime-handles)
5739             (setq gnus-article-mime-handle-alist nil));; A trick.
5740           (setq gnus-article-mime-handles handles)
5741           ;; We allow users to glean info from the handles.
5742           (when gnus-article-mime-part-function
5743             (gnus-mime-part-function handles)))
5744         (if (and handles
5745                  (or (not (stringp (car handles)))
5746                      (cdr handles)))
5747             (progn
5748               (when (and (not ihandles)
5749                          (not gnus-displaying-mime))
5750                 ;; Clean up for mime parts.
5751                 (article-goto-body)
5752                 (delete-region (point) (point-max)))
5753               (let ((gnus-displaying-mime t))
5754                 (gnus-mime-display-part handles)))
5755           (save-restriction
5756             (article-goto-body)
5757             (narrow-to-region (point) (point-max))
5758             (gnus-treat-article nil 1 1 "text/plain")
5759             (widen)))
5760         (unless ihandles
5761           ;; Highlight the headers.
5762           (save-excursion
5763             (save-restriction
5764               (article-goto-body)
5765               (narrow-to-region (point-min) (point))
5766               (gnus-article-save-original-date
5767                (gnus-treat-article 'head)))))))
5768     ;; Cope with broken MIME messages.
5769     (goto-char (point-max))
5770     (unless (bolp)
5771       (insert "\n"))))
5772
5773 (defcustom gnus-mime-display-multipart-as-mixed nil
5774   "Display \"multipart\" parts as  \"multipart/mixed\".
5775
5776 If t, it overrides nil values of
5777 `gnus-mime-display-multipart-alternative-as-mixed' and
5778 `gnus-mime-display-multipart-related-as-mixed'."
5779   :group 'gnus-article-mime
5780   :type 'boolean)
5781
5782 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5783   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5784   :version "22.1"
5785   :group 'gnus-article-mime
5786   :type 'boolean)
5787
5788 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5789   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5790
5791 If displaying \"text/html\" is discouraged \(see
5792 `mm-discouraged-alternatives'\) images or other material inside a
5793 \"multipart/related\" part might be overlooked when this variable is nil."
5794   :version "22.1"
5795   :group 'gnus-article-mime
5796   :type 'boolean)
5797
5798 (defun gnus-mime-display-part (handle)
5799   (cond
5800    ;; Maybe a broken MIME message.
5801    ((null handle))
5802    ;; Single part.
5803    ((not (stringp (car handle)))
5804     (gnus-mime-display-single handle))
5805    ;; User-defined multipart
5806    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5807     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5808              handle))
5809    ;; multipart/alternative
5810    ((and (equal (car handle) "multipart/alternative")
5811          (not (or gnus-mime-display-multipart-as-mixed
5812                   gnus-mime-display-multipart-alternative-as-mixed)))
5813     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5814       (push (cons id handle) gnus-article-mime-handle-alist)
5815       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5816    ;; multipart/related
5817    ((and (equal (car handle) "multipart/related")
5818          (not (or gnus-mime-display-multipart-as-mixed
5819                   gnus-mime-display-multipart-related-as-mixed)))
5820     ;;;!!!We should find the start part, but we just default
5821     ;;;!!!to the first part.
5822     ;;(gnus-mime-display-part (cadr handle))
5823     ;;;!!! Most multipart/related is an HTML message plus images.
5824     ;;;!!! Unfortunately we are unable to let W3 display those
5825     ;;;!!! included images, so we just display it as a mixed multipart.
5826     ;;(gnus-mime-display-mixed (cdr handle))
5827     ;;;!!! No, w3 can display everything just fine.
5828     (gnus-mime-display-part (cadr handle)))
5829    ((equal (car handle) "multipart/signed")
5830     (gnus-add-wash-type 'signed)
5831     (gnus-mime-display-security handle))
5832    ((equal (car handle) "multipart/encrypted")
5833     (gnus-add-wash-type 'encrypted)
5834     (gnus-mime-display-security handle))
5835    ;; Other multiparts are handled like multipart/mixed.
5836    (t
5837     (gnus-mime-display-mixed (cdr handle)))))
5838
5839 (defun gnus-mime-part-function (handles)
5840   (if (stringp (car handles))
5841       (mapcar 'gnus-mime-part-function (cdr handles))
5842     (funcall gnus-article-mime-part-function handles)))
5843
5844 (defun gnus-mime-display-mixed (handles)
5845   (mapcar 'gnus-mime-display-part handles))
5846
5847 (defun gnus-mime-display-single (handle)
5848   (let ((type (mm-handle-media-type handle))
5849         (ignored gnus-ignored-mime-types)
5850         (not-attachment t)
5851         (move nil)
5852         display text)
5853     (catch 'ignored
5854       (progn
5855         (while ignored
5856           (when (string-match (pop ignored) type)
5857             (throw 'ignored nil)))
5858         (if (and (not (and (if (gnus-buffer-live-p gnus-summary-buffer)
5859                                (with-current-buffer gnus-summary-buffer
5860                                  gnus-inhibit-images)
5861                              gnus-inhibit-images)
5862                            (string-match "\\`image/" type)))
5863                  (setq not-attachment
5864                        (and (not (mm-inline-override-p handle))
5865                             (or (not (mm-handle-disposition handle))
5866                                 (equal (car (mm-handle-disposition handle))
5867                                        "inline")
5868                                 (mm-attachment-override-p handle))))
5869                  (mm-automatic-display-p handle)
5870                  (or (and
5871                       (mm-inlinable-p handle)
5872                       (mm-inlined-p handle))
5873                      (mm-automatic-external-display-p type)))
5874             (setq display t)
5875           (when (equal (mm-handle-media-supertype handle) "text")
5876             (setq text t)))
5877         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5878               beg)
5879           (push (cons id handle) gnus-article-mime-handle-alist)
5880           (when (and display
5881                      (equal (mm-handle-media-supertype handle) "message"))
5882             (insert-char
5883              ?\n
5884              (cond ((not (bolp)) 2)
5885                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5886                    (t 1))))
5887           (when (or (not display)
5888                     (not (gnus-unbuttonized-mime-type-p type))
5889                     (eq id gnus-mime-buttonized-part-id))
5890             (gnus-insert-mime-button
5891              handle id (list (or display (and not-attachment text))))
5892             (gnus-article-insert-newline)
5893             ;; Remember modify the number of forward lines.
5894             (setq move t))
5895           (setq beg (point))
5896           (cond
5897            (display
5898             (when move
5899               (forward-line -1)
5900               (setq beg (point)))
5901             (let ((mail-parse-charset gnus-newsgroup-charset)
5902                   (mail-parse-ignored-charsets
5903                    (save-excursion (condition-case ()
5904                                        (set-buffer gnus-summary-buffer)
5905                                      (error))
5906                                    gnus-newsgroup-ignored-charsets)))
5907               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5908             (goto-char (point-max)))
5909            ((and text not-attachment)
5910             (when move
5911               (forward-line -1)
5912               (setq beg (point)))
5913             (gnus-article-insert-newline)
5914             (mm-display-inline handle)
5915             (goto-char (point-max))))
5916           ;; Do highlighting.
5917           (save-excursion
5918             (save-restriction
5919               (narrow-to-region beg (point))
5920               (if (eq handle gnus-article-mime-handles)
5921                   ;; The format=flowed case.
5922                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5923                 ;; Don't count signature parts that are never displayed.
5924                 ;; The part number should be re-calculated supposing this
5925                 ;; might be a message/rfc822 part.
5926                 (let (handles)
5927                   (dolist (part gnus-article-mime-handles)
5928                     (unless (or (stringp part)
5929                                 (equal (car (mm-handle-type part))
5930                                        "application/pgp-signature"))
5931                       (push part handles)))
5932                   (gnus-treat-article
5933                    nil (length (memq handle handles)) (length handles)
5934                    (mm-handle-media-type handle)))))))))))
5935
5936 (defun gnus-unbuttonized-mime-type-p (type)
5937   "Say whether TYPE is to be unbuttonized."
5938   (unless gnus-inhibit-mime-unbuttonizing
5939     (when (catch 'found
5940             (let ((types gnus-unbuttonized-mime-types))
5941               (while types
5942                 (when (string-match (pop types) type)
5943                   (throw 'found t)))))
5944       (not (catch 'found
5945              (let ((types gnus-buttonized-mime-types))
5946                (while types
5947                  (when (string-match (pop types) type)
5948                    (throw 'found t)))))))))
5949
5950 (defun gnus-article-insert-newline ()
5951   "Insert a newline, but mark it as undeletable."
5952   (gnus-put-text-property
5953    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5954
5955 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5956   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5957          (ihandles handles)
5958          (point (point))
5959          handle (inhibit-read-only t) from props begend not-pref)
5960     (save-window-excursion
5961       (save-restriction
5962         (when ibegend
5963           (narrow-to-region (car ibegend)
5964                             (or (cdr ibegend)
5965                                 (progn
5966                                   (goto-char (car ibegend))
5967                                   (forward-line 2)
5968                                   (point))))
5969           (delete-region (point-min) (point-max))
5970           (mm-remove-parts handles))
5971         (setq begend (list (point-marker)))
5972         ;; Do the toggle.
5973         (unless (setq not-pref (cadr (member preferred ihandles)))
5974           (setq not-pref (car ihandles)))
5975         (when (or ibegend
5976                   (not preferred)
5977                   (not (gnus-unbuttonized-mime-type-p
5978                         "multipart/alternative")))
5979           (gnus-add-text-properties
5980            (setq from (point))
5981            (progn
5982              (insert (format "%d.  " id))
5983              (point))
5984            `(gnus-callback
5985              (lambda (handles)
5986                (unless ,(not ibegend)
5987                  (setq gnus-article-mime-handle-alist
5988                        ',gnus-article-mime-handle-alist))
5989                (gnus-mime-display-alternative
5990                 ',ihandles ',not-pref ',begend ,id))
5991              keymap ,gnus-mime-button-map
5992              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5993              face ,gnus-article-button-face
5994              gnus-part ,id
5995              article-type multipart))
5996           (widget-convert-button 'link from (point)
5997                                  :action 'gnus-widget-press-button
5998                                  :button-keymap gnus-widget-button-keymap)
5999           ;; Do the handles
6000           (while (setq handle (pop handles))
6001             (gnus-add-text-properties
6002              (setq from (point))
6003              (progn
6004                (insert (format "(%c) %-18s"
6005                                (if (equal handle preferred) ?* ? )
6006                                (mm-handle-media-type handle)))
6007                (point))
6008              `(gnus-callback
6009                (lambda (handles)
6010                  (unless ,(not ibegend)
6011                    (setq gnus-article-mime-handle-alist
6012                          ',gnus-article-mime-handle-alist))
6013                  (gnus-mime-display-alternative
6014                   ',ihandles ',handle ',begend ,id))
6015                keymap ,gnus-mime-button-map
6016                ,gnus-mouse-face-prop ,gnus-article-mouse-face
6017                face ,gnus-article-button-face
6018                gnus-part ,id
6019                gnus-data ,handle))
6020             (widget-convert-button 'link from (point)
6021                                    :action 'gnus-widget-press-button
6022                                    :button-keymap gnus-widget-button-keymap)
6023             (insert "  "))
6024           (insert "\n\n"))
6025         (when preferred
6026           (if (stringp (car preferred))
6027               (gnus-display-mime preferred)
6028             (let ((mail-parse-charset gnus-newsgroup-charset)
6029                   (mail-parse-ignored-charsets
6030                    (with-current-buffer gnus-summary-buffer
6031                      gnus-newsgroup-ignored-charsets)))
6032               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6033               ;; Do highlighting.
6034               (save-excursion
6035                 (save-restriction
6036                   (narrow-to-region (car begend) (point-max))
6037                   (gnus-treat-article
6038                    nil (length gnus-article-mime-handle-alist)
6039                    (gnus-article-mime-total-parts)
6040                    (mm-handle-media-type preferred))))))
6041           (goto-char (point-max))
6042           (setcdr begend (point-marker)))))
6043     (when ibegend
6044       (goto-char point))))
6045
6046 (defconst gnus-article-wash-status-strings
6047   (let ((alist '((cite "c" "Possible hidden citation text"
6048                        " " "All citation text visible")
6049                  (headers "h" "Hidden headers"
6050                           " " "All headers visible.")
6051                  (pgp "p" "Encrypted or signed message status hidden"
6052                       " " "No hidden encryption nor digital signature status")
6053                  (signature "s" "Signature has been hidden"
6054                             " " "Signature is visible")
6055                  (overstrike "o" "Overstrike (^H) characters applied"
6056                              " " "No overstrike characters applied")
6057                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6058                            " " "No /*_emphasis_*/ characters applied")))
6059         result)
6060     (dolist (entry alist result)
6061       (let ((key (nth 0 entry))
6062             (on (copy-sequence (nth 1 entry)))
6063             (on-help (nth 2 entry))
6064             (off (copy-sequence (nth 3 entry)))
6065             (off-help (nth 4 entry)))
6066         (put-text-property 0 1 'help-echo on-help on)
6067         (put-text-property 0 1 'help-echo off-help off)
6068         (push (list key on off) result))))
6069   "Alist of strings describing wash status in the mode line.
6070 Each entry has the form (KEY ON OF), where the KEY is a symbol
6071 representing the particular washing function, ON is the string to use
6072 in the article mode line when the washing function is active, and OFF
6073 is the string to use when it is inactive.")
6074
6075 (defun gnus-article-wash-status-entry (key value)
6076   (let ((entry (assoc key gnus-article-wash-status-strings)))
6077     (if value (nth 1 entry) (nth 2 entry))))
6078
6079 (defun gnus-article-wash-status ()
6080   "Return a string which display status of article washing."
6081   (with-current-buffer gnus-article-buffer
6082     (let ((cite (memq 'cite gnus-article-wash-types))
6083           (headers (memq 'headers gnus-article-wash-types))
6084           (boring (memq 'boring-headers gnus-article-wash-types))
6085           (pgp (memq 'pgp gnus-article-wash-types))
6086           (pem (memq 'pem gnus-article-wash-types))
6087           (signed (memq 'signed gnus-article-wash-types))
6088           (encrypted (memq 'encrypted gnus-article-wash-types))
6089           (signature (memq 'signature gnus-article-wash-types))
6090           (overstrike (memq 'overstrike gnus-article-wash-types))
6091           (emphasis (memq 'emphasis gnus-article-wash-types)))
6092       (concat
6093        (gnus-article-wash-status-entry 'cite cite)
6094        (gnus-article-wash-status-entry 'headers (or headers boring))
6095        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6096        (gnus-article-wash-status-entry 'signature signature)
6097        (gnus-article-wash-status-entry 'overstrike overstrike)
6098        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6099
6100 (defun gnus-add-wash-type (type)
6101   "Add a washing of TYPE to the current status."
6102   (add-to-list 'gnus-article-wash-types type))
6103
6104 (defun gnus-delete-wash-type (type)
6105   "Add a washing of TYPE to the current status."
6106   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6107
6108 (defun gnus-add-image (category image)
6109   "Add IMAGE of CATEGORY to the list of displayed images."
6110   (let ((entry (assq category gnus-article-image-alist)))
6111     (unless entry
6112       (setq entry (list category))
6113       (push entry gnus-article-image-alist))
6114     (nconc entry (list image))))
6115
6116 (defun gnus-delete-images (category)
6117   "Delete all images in CATEGORY."
6118   (let ((entry (assq category gnus-article-image-alist)))
6119     (dolist (image (cdr entry))
6120       (gnus-remove-image image category))
6121     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6122     (gnus-delete-wash-type category)))
6123
6124 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6125
6126 (defun gnus-article-maybe-hide-headers ()
6127   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6128 Provided for backwards compatibility."
6129   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6130                  (not (with-current-buffer gnus-summary-buffer
6131                         gnus-have-all-headers)))
6132              (not gnus-inhibit-hiding))
6133     (gnus-article-hide-headers)))
6134
6135 ;;; Article savers.
6136
6137 (defun gnus-output-to-file (file-name)
6138   "Append the current article to a file named FILE-NAME.
6139 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6140 text and used as the value of the coding cookie which is added to the
6141 top of a file.  Otherwise, this function saves a raw article without
6142 the coding cookie."
6143   (let* ((artbuf (current-buffer))
6144          (file-name-coding-system nnmail-pathname-coding-system)
6145          (coding gnus-article-save-coding-system)
6146          (coding-system-for-read (if coding
6147                                      nil ;; Rely on the coding cookie.
6148                                    mm-text-coding-system))
6149          (coding-system-for-write (or coding
6150                                       mm-text-coding-system-for-write
6151                                       mm-text-coding-system))
6152          (exists (file-exists-p file-name)))
6153     (with-temp-buffer
6154       (when exists
6155         (insert-file-contents file-name)
6156         (goto-char (point-min))
6157         ;; Remove the existing coding cookie.
6158         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6159           (delete-region (match-beginning 0) (match-end 0))))
6160       (goto-char (point-max))
6161       (insert-buffer-substring artbuf)
6162       ;; Append newline at end of the buffer as separator, and then
6163       ;; save it to file.
6164       (goto-char (point-max))
6165       (insert "\n")
6166       (when coding
6167         ;; If the coding system is not suitable to encode the text,
6168         ;; ask a user for a proper one.
6169         (when (fboundp 'select-safe-coding-system)
6170           (setq coding (coding-system-base
6171                         (save-window-excursion
6172                           (select-safe-coding-system (point-min) (point-max)
6173                                                      coding))))
6174           (setq coding-system-for-write
6175                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6176                     coding)))
6177         (goto-char (point-min))
6178         ;; Add the coding cookie.
6179         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6180                         coding-system-for-write)))
6181       (if exists
6182           (progn
6183             (write-region (point-min) (point-max) file-name nil 'no-message)
6184             (message "Appended to %s" file-name))
6185         (write-region (point-min) (point-max) file-name))))
6186   t)
6187
6188 (defun gnus-narrow-to-page (&optional arg)
6189   "Narrow the article buffer to a page.
6190 If given a numerical ARG, move forward ARG pages."
6191   (interactive "P")
6192   (setq arg (if arg (prefix-numeric-value arg) 0))
6193   (with-current-buffer gnus-article-buffer
6194     (widen)
6195     ;; Remove any old next/prev buttons.
6196     (when (gnus-visual-p 'page-marker)
6197       (let ((inhibit-read-only t))
6198         (gnus-remove-text-with-property 'gnus-prev)
6199         (gnus-remove-text-with-property 'gnus-next)))
6200     (let (st nd pt)
6201       (when (save-excursion
6202               (cond ((< arg 0)
6203                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6204                          (prog1
6205                              (setq nd (match-beginning 0)
6206                                    pt nd)
6207                            (when (re-search-backward page-delimiter nil t)
6208                              (setq st (match-end 0))))
6209                        (when (re-search-forward page-delimiter nil t)
6210                          (setq nd (match-beginning 0)
6211                                pt (point-min)))))
6212                     ((> arg 0)
6213                      (if (re-search-forward page-delimiter nil 'move arg)
6214                          (prog1
6215                              (setq st (match-end 0)
6216                                    pt st)
6217                            (when (re-search-forward page-delimiter nil t)
6218                              (setq nd (match-beginning 0))))
6219                        (when (re-search-backward page-delimiter nil t)
6220                          (setq st (match-end 0)
6221                                pt (point-max)))))
6222                     (t
6223                      (when (re-search-backward page-delimiter nil t)
6224                        (goto-char (setq st (match-end 0))))
6225                      (when (re-search-forward page-delimiter nil t)
6226                        (setq nd (match-beginning 0)))
6227                      (or st nd))))
6228         (setq gnus-page-broken t)
6229         (when pt (goto-char pt))
6230         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6231         (when (gnus-visual-p 'page-marker)
6232           (save-excursion
6233             (when nd
6234               (goto-char nd)
6235               (gnus-insert-next-page-button))
6236             (when st
6237               (goto-char st)
6238               (gnus-insert-prev-page-button))))))))
6239
6240 ;; Article mode commands
6241
6242 (defun gnus-article-goto-next-page ()
6243   "Show the next page of the article."
6244   (interactive)
6245   (when (gnus-article-next-page)
6246     (goto-char (point-min))
6247     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6248
6249
6250 (defun gnus-article-goto-prev-page ()
6251   "Show the previous page of the article."
6252   (interactive)
6253   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6254       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6255     (gnus-article-prev-page nil)))
6256
6257 ;; This is cleaner but currently breaks `gnus-pick-mode':
6258 ;;
6259 ;; (defun gnus-article-goto-next-page ()
6260 ;;   "Show the next page of the article."
6261 ;;   (interactive)
6262 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6263 ;;     (gnus-summary-next-page)))
6264 ;;
6265 ;; (defun gnus-article-goto-prev-page ()
6266 ;;   "Show the next page of the article."
6267 ;;   (interactive)
6268 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6269 ;;     (gnus-summary-prev-page)))
6270
6271 (defun gnus-article-next-page (&optional lines)
6272   "Show the next page of the current article.
6273 If end of article, return non-nil.  Otherwise return nil.
6274 Argument LINES specifies lines to be scrolled up."
6275   (interactive "p")
6276   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6277   (if (and (not (and gnus-article-over-scroll
6278                      (> (count-lines (window-start) (point-max))
6279                         (if (featurep 'xemacs)
6280                             (or lines (1- (window-height)))
6281                           (+ (or lines (1- (window-height))) scroll-margin)))))
6282            (save-excursion
6283              (end-of-line)
6284              (and (pos-visible-in-window-p)     ;Not continuation line.
6285                   (>= (point) (point-max)))))
6286       ;; Nothing in this page.
6287       (if (or (not gnus-page-broken)
6288               (save-excursion
6289                 (save-restriction
6290                   (widen)
6291                   (forward-line)
6292                   (eobp)))) ;Real end-of-buffer?
6293           (progn
6294             (when gnus-article-over-scroll
6295               (gnus-article-next-page-1 lines))
6296             t)                  ;Nothing more.
6297         (gnus-narrow-to-page 1)         ;Go to next page.
6298         nil)
6299     ;; More in this page.
6300     (gnus-article-next-page-1 lines)
6301     nil))
6302
6303 (defun gnus-article-beginning-of-window ()
6304   "Move point to the beginning of the window.
6305 In Emacs, the point is placed at the line number which `scroll-margin'
6306 specifies."
6307   (if (featurep 'xemacs)
6308       (move-to-window-line 0)
6309     ;; There is an obscure bug in Emacs that makes it impossible to
6310     ;; scroll past big pictures in the article buffer.  Try to fix
6311     ;; this by adding a sanity check by counting the lines visible.
6312     (when (> (count-lines (window-start) (window-end)) 30)
6313       (move-to-window-line
6314        (min (max 0 scroll-margin)
6315             (max 1 (- (window-height)
6316                       (if mode-line-format 1 0)
6317                       (if header-line-format 1 0)
6318                       2)))))))
6319
6320 (defun gnus-article-next-page-1 (lines)
6321   (condition-case ()
6322       (let ((scroll-in-place nil)
6323             (auto-window-vscroll nil))
6324         (scroll-up lines))
6325     (end-of-buffer
6326      ;; Long lines may cause an end-of-buffer error.
6327      (goto-char (point-max))))
6328   (gnus-article-beginning-of-window))
6329
6330 (defun gnus-article-prev-page (&optional lines)
6331   "Show previous page of current article.
6332 Argument LINES specifies lines to be scrolled down."
6333   (interactive "p")
6334   (move-to-window-line 0)
6335   (if (and gnus-page-broken
6336            (bobp)
6337            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6338       (progn
6339         (gnus-narrow-to-page -1)        ;Go to previous page.
6340         (goto-char (point-max))
6341         (recenter (if gnus-article-over-scroll
6342                       (if lines
6343                           (max (if (featurep 'xemacs)
6344                                    lines
6345                                  (+ lines scroll-margin))
6346                                3)
6347                         (- (window-height) 2))
6348                     -1)))
6349     (prog1
6350         (condition-case ()
6351             (let ((scroll-in-place nil))
6352               (scroll-down lines))
6353           (beginning-of-buffer
6354            (goto-char (point-min))))
6355       (gnus-article-beginning-of-window))))
6356
6357 (defun gnus-article-only-boring-p ()
6358   "Decide whether there is only boring text remaining in the article.
6359 Something \"interesting\" is a word of at least two letters that does
6360 not have a face in `gnus-article-boring-faces'."
6361   (when (and gnus-article-skip-boring
6362              (boundp 'gnus-article-boring-faces)
6363              (symbol-value 'gnus-article-boring-faces))
6364     (save-excursion
6365       (let ((inhibit-point-motion-hooks t))
6366         (catch 'only-boring
6367           (while (re-search-forward "\\b\\w\\w" nil t)
6368             (forward-char -1)
6369             (when (not (gnus-intersection
6370                         (gnus-faces-at (point))
6371                         (symbol-value 'gnus-article-boring-faces)))
6372               (throw 'only-boring nil)))
6373           (throw 'only-boring t))))))
6374
6375 (defun gnus-article-refer-article ()
6376   "Read article specified by message-id around point."
6377   (interactive)
6378   (save-excursion
6379     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6380     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6381     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6382         (let ((msg-id (concat "<" (match-string 0) ">")))
6383           (set-buffer gnus-summary-buffer)
6384           (gnus-summary-refer-article msg-id))
6385       (error "No references around point"))))
6386
6387 (defun gnus-article-show-summary ()
6388   "Reconfigure windows to show summary buffer."
6389   (interactive)
6390   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6391       (error "There is no summary buffer for this article buffer")
6392     (gnus-article-set-globals)
6393     (gnus-configure-windows 'article)
6394     (gnus-summary-goto-subject gnus-current-article)
6395     (gnus-summary-position-point)))
6396
6397 (defun gnus-article-describe-briefly ()
6398   "Describe article mode commands briefly."
6399   (interactive)
6400   (gnus-message 6 "%s" (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page      \\[gnus-article-goto-prev-page]:Prev page  \\[gnus-article-show-summary]:Show summary  \\[gnus-info-find-node]:Run Info  \\[gnus-article-describe-briefly]:This help")))
6401
6402 (defun gnus-article-check-buffer ()
6403   "Beep if not in an article buffer."
6404   (unless (equal major-mode 'gnus-article-mode)
6405     (error "Command invoked outside of a Gnus article buffer")))
6406
6407 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6408   "Read a summary buffer key sequence and execute it from the article buffer."
6409   (interactive "P")
6410   (gnus-article-check-buffer)
6411   (let ((nosaves
6412          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6413            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6414            "=" "^" "\M-^" "|"))
6415         (nosave-but-article
6416          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6417            "An" "Ap" [?A (meta return)] [?A delete]))
6418         (nosave-in-article
6419          '("AS" "\C-d"))
6420         (up-to-top
6421          '("n" "Gn" "p" "Gp"))
6422         keys new-sum-point)
6423     (with-current-buffer gnus-article-current-summary
6424       (let (gnus-pick-mode)
6425         (setq unread-command-events (nconc unread-command-events
6426                                            (list (or key last-command-event)))
6427               keys (if (featurep 'xemacs)
6428                        (events-to-keys (read-key-sequence nil t))
6429                      (read-key-sequence nil t)))))
6430
6431     (message "")
6432
6433     (cond
6434      ((eq (aref keys (1- (length keys))) ?\C-h)
6435       (gnus-article-describe-bindings (substring keys 0 -1)))
6436      ((or (member keys nosaves)
6437           (member keys nosave-but-article)
6438           (member keys nosave-in-article))
6439       (let (func)
6440         (save-window-excursion
6441           (pop-to-buffer gnus-article-current-summary)
6442           ;; We disable the pick minor mode commands.
6443           (let (gnus-pick-mode)
6444             (setq func (key-binding keys t))))
6445         (if (or (not func)
6446                 (numberp func))
6447             (ding)
6448           (unless (member keys nosave-in-article)
6449             (set-buffer gnus-article-current-summary))
6450           (when (get func 'disabled)
6451             (error "Function %s disabled" func))
6452           (call-interactively func)
6453           (setq new-sum-point (point)))
6454         (when (member keys nosave-but-article)
6455           (pop-to-buffer gnus-article-buffer))))
6456      (t
6457       ;; These commands should restore window configuration.
6458       (let ((obuf (current-buffer))
6459             (owin (current-window-configuration))
6460             win func in-buffer selected new-sum-start new-sum-hscroll err)
6461         (cond (not-restore-window
6462                (pop-to-buffer gnus-article-current-summary)
6463                (setq win (selected-window)))
6464               ((setq win (get-buffer-window gnus-article-current-summary))
6465                (select-window win))
6466               (t
6467                (let ((summary-buffer gnus-article-current-summary))
6468                  (gnus-configure-windows 'article)
6469                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6470                    (let ((gnus-buffer-configuration
6471                           '((article ((vertical 1.0
6472                                                 (summary 0.25 point)
6473                                                 (article 1.0)))))))
6474                      (gnus-configure-windows 'article))
6475                    (setq win (get-buffer-window summary-buffer 'visible)))
6476                  (gnus-select-frame-set-input-focus (window-frame win))
6477                  (select-window win))))
6478         (setq in-buffer (current-buffer))
6479         ;; We disable the pick minor mode commands.
6480         (setq func (let (gnus-pick-mode)
6481                      (key-binding keys t)))
6482         (when (get func 'disabled)
6483           (error "Function %s disabled" func))
6484         (if (and func
6485                  (functionp func)
6486                  (condition-case code
6487                      (progn
6488                        (call-interactively func)
6489                        t)
6490                    (error
6491                     (setq err code)
6492                     nil)))
6493             (progn
6494               (when (eq win (selected-window))
6495                 (setq new-sum-point (point)
6496                       new-sum-start (window-start win)
6497                       new-sum-hscroll (window-hscroll win)))
6498               (when (or (eq in-buffer (current-buffer))
6499                         (when (eq obuf (current-buffer))
6500                           (set-buffer in-buffer)
6501                           t))
6502                 (setq selected (gnus-summary-select-article))
6503                 (set-buffer obuf)
6504                 (unless not-restore-window
6505                   (set-window-configuration owin))
6506                 (when (and (eq selected 'old)
6507                            new-sum-point)
6508                   (set-window-start (get-buffer-window (current-buffer))
6509                                     1)
6510                   (set-window-point (get-buffer-window (current-buffer))
6511                                     (if (article-goto-body)
6512                                         (1- (point))
6513                                       (point))))
6514                 (when (and (not not-restore-window)
6515                            new-sum-point
6516                            (window-live-p win)
6517                            (with-current-buffer (window-buffer win)
6518                              (eq major-mode 'gnus-summary-mode)))
6519                   (set-window-point win new-sum-point)
6520                   (set-window-start win new-sum-start)
6521                   (set-window-hscroll win new-sum-hscroll))))
6522           (set-window-configuration owin)
6523           (if err
6524               (signal (car err) (cdr err))
6525             (ding))))))))
6526
6527 (defun gnus-article-read-summary-send-keys ()
6528   (interactive)
6529   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6530     (gnus-article-read-summary-keys)))
6531
6532 (defun gnus-article-describe-key (key)
6533   "Display documentation of the function invoked by KEY.
6534 KEY is a string or a vector."
6535   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6536                        (read-key-sequence "Describe key: "))))
6537   (gnus-article-check-buffer)
6538   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6539                                   gnus-article-read-summary-send-keys))
6540       (with-current-buffer gnus-article-current-summary
6541         (setq unread-command-events
6542               (if (featurep 'xemacs)
6543                   (append key nil)
6544                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6545                                         (list 'meta (- x 128))
6546                                       x))
6547                         key)))
6548         (let ((cursor-in-echo-area t)
6549               gnus-pick-mode)
6550           (describe-key (read-key-sequence nil t))))
6551     (describe-key key)))
6552
6553 (defun gnus-article-describe-key-briefly (key &optional insert)
6554   "Display documentation of the function invoked by KEY.
6555 KEY is a string or a vector."
6556   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6557                        (read-key-sequence "Describe key: "))
6558                      current-prefix-arg))
6559   (gnus-article-check-buffer)
6560   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6561                                   gnus-article-read-summary-send-keys))
6562       (with-current-buffer gnus-article-current-summary
6563         (setq unread-command-events
6564               (if (featurep 'xemacs)
6565                   (append key nil)
6566                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6567                                         (list 'meta (- x 128))
6568                                       x))
6569                         key)))
6570         (let ((cursor-in-echo-area t)
6571               gnus-pick-mode)
6572           (describe-key-briefly (read-key-sequence nil t) insert)))
6573     (describe-key-briefly key insert)))
6574
6575 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6576 (defvar gnus-agent-summary-mode)
6577 (defvar gnus-draft-mode)
6578 ;; Calling help-buffer will autoload help-mode.
6579 (defvar help-xref-stack-item)
6580 ;; Emacs 22 doesn't load it in the batch mode.
6581 (eval-when-compile
6582   (autoload 'help-buffer "help-mode"))
6583
6584 (defun gnus-article-describe-bindings (&optional prefix)
6585   "Show a list of all defined keys, and their definitions.
6586 The optional argument PREFIX, if non-nil, should be a key sequence;
6587 then we display only bindings that start with that prefix."
6588   (interactive)
6589   (gnus-article-check-buffer)
6590   (let ((keymap (copy-keymap gnus-article-mode-map))
6591         (map (copy-keymap gnus-article-send-map))
6592         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6593         parent agent draft)
6594     (define-key keymap "S" map)
6595     (define-key map [t] nil)
6596     (with-current-buffer gnus-article-current-summary
6597       (set-keymap-parent
6598        keymap
6599        (if (setq parent (keymap-parent gnus-article-mode-map))
6600            (prog1
6601                (setq parent (copy-keymap parent))
6602              (set-keymap-parent parent (current-local-map)))
6603          (current-local-map)))
6604       (set-keymap-parent map (key-binding "S"))
6605       (let (key def gnus-pick-mode)
6606         (while sumkeys
6607           (setq key (pop sumkeys))
6608           (cond ((and (vectorp key) (= (length key) 1)
6609                       (consp (setq def (aref key 0)))
6610                       (numberp (car def)) (numberp (cdr def)))
6611                  (when (< (max (car def) (cdr def)) 128)
6612                    (setq sumkeys
6613                          (append (mapcar
6614                                   #'vector
6615                                   (nreverse (gnus-uncompress-range def)))
6616                                  sumkeys))))
6617                 ((setq def (key-binding key))
6618                  (unless (eq def 'undefined)
6619                    (define-key keymap key def))))))
6620       (when (boundp 'gnus-agent-summary-mode)
6621         (setq agent gnus-agent-summary-mode))
6622       (when (boundp 'gnus-draft-mode)
6623         (setq draft gnus-draft-mode)))
6624     (with-temp-buffer
6625       (use-local-map keymap)
6626       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6627       (set (make-local-variable 'gnus-draft-mode) draft)
6628       (describe-bindings prefix))
6629     (let ((item `((lambda (prefix)
6630                     (with-current-buffer ,(current-buffer)
6631                       (gnus-article-describe-bindings prefix)))
6632                   ,prefix)))
6633       (with-current-buffer (let (help-xref-following) (help-buffer))
6634         (setq help-xref-stack-item item)))))
6635
6636 (defun gnus-article-reply-with-original (&optional wide)
6637   "Start composing a reply mail to the current message.
6638 The text in the region will be yanked.  If the region isn't active,
6639 the entire article will be yanked."
6640   (interactive)
6641   (let ((article (cdr gnus-article-current))
6642         contents)
6643     (if (not (gnus-region-active-p))
6644         (with-current-buffer gnus-summary-buffer
6645           (gnus-summary-reply (list (list article)) wide))
6646       (setq contents (buffer-substring (point) (mark t)))
6647       ;; Deactivate active regions.
6648       (when (and (boundp 'transient-mark-mode)
6649                  transient-mark-mode)
6650         (setq mark-active nil))
6651       (with-current-buffer gnus-summary-buffer
6652         (gnus-summary-reply
6653          (list (list article contents)) wide)))))
6654
6655 (defun gnus-article-wide-reply-with-original ()
6656   "Start composing a wide reply mail to the current message.
6657 The text in the region will be yanked.  If the region isn't active,
6658 the entire article will be yanked."
6659   (interactive)
6660   (gnus-article-reply-with-original t))
6661
6662 (defun gnus-article-followup-with-original ()
6663   "Compose a followup to the current article.
6664 The text in the region will be yanked.  If the region isn't active,
6665 the entire article will be yanked."
6666   (interactive)
6667   (let ((article (cdr gnus-article-current))
6668         contents)
6669       (if (not (gnus-region-active-p))
6670           (with-current-buffer gnus-summary-buffer
6671             (gnus-summary-followup (list (list article))))
6672         (setq contents (buffer-substring (point) (mark t)))
6673         ;; Deactivate active regions.
6674         (when (and (boundp 'transient-mark-mode)
6675                    transient-mark-mode)
6676           (setq mark-active nil))
6677         (with-current-buffer gnus-summary-buffer
6678           (gnus-summary-followup
6679            (list (list article contents)))))))
6680
6681 (defun gnus-article-hide (&optional arg force)
6682   "Hide all the gruft in the current article.
6683 This means that signatures, cited text and (some) headers will be
6684 hidden.
6685 If given a prefix, show the hidden text instead."
6686   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6687   (gnus-article-hide-headers arg)
6688   (gnus-article-hide-list-identifiers arg)
6689   (gnus-article-hide-citation-maybe arg force)
6690   (gnus-article-hide-signature arg))
6691
6692 (defun gnus-article-maybe-highlight ()
6693   "Do some article highlighting if article highlighting is requested."
6694   (when (gnus-visual-p 'article-highlight 'highlight)
6695     (gnus-article-highlight-some)))
6696
6697 (defun gnus-check-group-server ()
6698   ;; Make sure the connection to the server is alive.
6699   (unless (gnus-server-opened
6700            (gnus-find-method-for-group gnus-newsgroup-name))
6701     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6702     (gnus-request-group gnus-newsgroup-name t)))
6703
6704 (eval-when-compile
6705   (autoload 'nneething-get-file-name "nneething"))
6706
6707 (defun gnus-request-article-this-buffer (article group)
6708   "Get an article and insert it into this buffer."
6709   (let (do-update-line sparse-header)
6710     (prog1
6711         (save-excursion
6712           (erase-buffer)
6713           (gnus-kill-all-overlays)
6714           (setq group (or group gnus-newsgroup-name))
6715
6716           ;; Using `gnus-request-article' directly will insert the article into
6717           ;; `nntp-server-buffer' - so we'll save some time by not having to
6718           ;; copy it from the server buffer into the article buffer.
6719
6720           ;; We only request an article by message-id when we do not have the
6721           ;; headers for it, so we'll have to get those.
6722           (when (stringp article)
6723             (gnus-read-header article))
6724
6725           ;; If the article number is negative, that means that this article
6726           ;; doesn't belong in this newsgroup (possibly), so we find its
6727           ;; message-id and request it by id instead of number.
6728           (when (and (numberp article)
6729                      gnus-summary-buffer
6730                      (get-buffer gnus-summary-buffer)
6731                      (gnus-buffer-exists-p gnus-summary-buffer))
6732             (with-current-buffer gnus-summary-buffer
6733               (let ((header (gnus-summary-article-header article)))
6734                 (when (< article 0)
6735                   (cond
6736                    ((memq article gnus-newsgroup-sparse)
6737                     ;; This is a sparse gap article.
6738                     (setq do-update-line article)
6739                     (setq article (mail-header-id header))
6740                     (setq sparse-header (gnus-read-header article))
6741                     (setq gnus-newsgroup-sparse
6742                           (delq article gnus-newsgroup-sparse)))
6743                    ((vectorp header)
6744                     ;; It's a real article.
6745                     (setq article (mail-header-id header)))
6746                    (t
6747                     ;; It is an extracted pseudo-article.
6748                     (setq article 'pseudo)
6749                     (gnus-request-pseudo-article header))))
6750
6751                 (let ((method (gnus-find-method-for-group
6752                                gnus-newsgroup-name)))
6753                   (when (and (eq (car method) 'nneething)
6754                              (vectorp header))
6755                     (let ((dir (nneething-get-file-name
6756                                 (mail-header-id header))))
6757                       (when (and (stringp dir)
6758                                  (file-directory-p dir))
6759                         (setq article 'nneething)
6760                         (gnus-group-enter-directory dir))))))))
6761
6762           (cond
6763            ;; Refuse to select canceled articles.
6764            ((and (numberp article)
6765                  gnus-summary-buffer
6766                  (get-buffer gnus-summary-buffer)
6767                  (gnus-buffer-exists-p gnus-summary-buffer)
6768                  (eq (cdr (with-current-buffer gnus-summary-buffer
6769                             (assq article gnus-newsgroup-reads)))
6770                      gnus-canceled-mark))
6771             nil)
6772            ;; We first check `gnus-original-article-buffer'.
6773            ((and (get-buffer gnus-original-article-buffer)
6774                  (numberp article)
6775                  (with-current-buffer gnus-original-article-buffer
6776                    (and (equal (car gnus-original-article) group)
6777                         (eq (cdr gnus-original-article) article))))
6778             ;; `insert-buffer-substring' would incorrectly use the
6779             ;; equivalent of string-make-multibyte which amount to decoding
6780             ;; with locale-coding-system, causing failure of
6781             ;; subsequent decoding.
6782             (insert (mm-string-to-multibyte
6783                      (with-current-buffer gnus-original-article-buffer
6784                        (buffer-substring (point-min) (point-max)))))
6785             'article)
6786            ;; Check the backlog.
6787            ((and gnus-keep-backlog
6788                  (gnus-backlog-request-article group article (current-buffer)))
6789             'article)
6790            ;; Check asynchronous pre-fetch.
6791            ((gnus-async-request-fetched-article group article (current-buffer))
6792             (gnus-async-prefetch-next group article gnus-summary-buffer)
6793             (when (and (numberp article) gnus-keep-backlog)
6794               (gnus-backlog-enter-article group article (current-buffer)))
6795             'article)
6796            ;; Check the cache.
6797            ((and gnus-use-cache
6798                  (numberp article)
6799                  (gnus-cache-request-article article group))
6800             'article)
6801            ;; Check the agent cache.
6802            ((gnus-agent-request-article article group)
6803             'article)
6804            ;; Get the article and put into the article buffer.
6805            ((or (stringp article)
6806                 (numberp article))
6807             (let ((gnus-override-method gnus-override-method)
6808                   (methods (and (stringp article)
6809                                 gnus-refer-article-method))
6810                   (backend (car (gnus-find-method-for-group
6811                                  gnus-newsgroup-name)))
6812                   result
6813                   (inhibit-read-only t))
6814               (if (or (not (listp methods))
6815                       (and (symbolp (car methods))
6816                            (assq (car methods) nnoo-definition-alist)))
6817                   (setq methods (list methods)))
6818               (when (and (null gnus-override-method)
6819                          methods)
6820                 (setq gnus-override-method (pop methods)))
6821               (while (not result)
6822                 (when (eq gnus-override-method 'current)
6823                   (setq gnus-override-method
6824                         (with-current-buffer gnus-summary-buffer
6825                           gnus-current-select-method)))
6826                 (erase-buffer)
6827                 (gnus-kill-all-overlays)
6828                 (let ((gnus-newsgroup-name group))
6829                   (gnus-check-group-server))
6830                 (cond
6831                  ((gnus-request-article article group (current-buffer))
6832                   (when (numberp article)
6833                     (gnus-async-prefetch-next group article
6834                                               gnus-summary-buffer)
6835                     (when gnus-keep-backlog
6836                       (gnus-backlog-enter-article
6837                        group article (current-buffer))))
6838                   (setq result 'article))
6839                  (methods
6840                   (setq gnus-override-method (pop methods)))
6841                  ((not (string-match "^400 "
6842                                      (nnheader-get-report backend)))
6843                   ;; If we get 400 server disconnect, reconnect and
6844                   ;; retry; otherwise, assume the article has expired.
6845                   (setq result 'done))))
6846               (and (eq result 'article) 'article)))
6847            ;; It was a pseudo.
6848            (t article)))
6849
6850       ;; Associate this article with the current summary buffer.
6851       (setq gnus-article-current-summary gnus-summary-buffer)
6852
6853       ;; Take the article from the original article buffer
6854       ;; and place it in the buffer it's supposed to be in.
6855       (when (and (get-buffer gnus-article-buffer)
6856                  (equal (buffer-name (current-buffer))
6857                         (buffer-name (get-buffer gnus-article-buffer))))
6858         (save-excursion
6859           (if (get-buffer gnus-original-article-buffer)
6860               (set-buffer gnus-original-article-buffer)
6861             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6862             (buffer-disable-undo)
6863             (setq major-mode 'gnus-original-article-mode)
6864             (setq buffer-read-only t))
6865           (let ((inhibit-read-only t))
6866             (erase-buffer)
6867             (insert-buffer-substring gnus-article-buffer))
6868           (setq gnus-original-article (cons group article)))
6869
6870         ;; Decode charsets.
6871         (run-hooks 'gnus-article-decode-hook)
6872         ;; Mark article as decoded or not.
6873         (setq gnus-article-decoded-p gnus-article-decode-hook))
6874
6875       ;; Update sparse articles.
6876       (when (and do-update-line
6877                  (or (numberp article)
6878                      (stringp article)))
6879         (let ((buf (current-buffer)))
6880           (set-buffer gnus-summary-buffer)
6881           (gnus-summary-update-article do-update-line sparse-header)
6882           (gnus-summary-goto-subject do-update-line nil t)
6883           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6884                             (point))
6885           (set-buffer buf))))))
6886
6887 (defun gnus-block-private-groups (group)
6888   (if (gnus-news-group-p group)
6889       ;; Block nothing in news groups.
6890       nil
6891     ;; Block everything anywhere else.
6892     "."))
6893
6894 (defun gnus-blocked-images ()
6895   (if (functionp gnus-blocked-images)
6896       (funcall gnus-blocked-images gnus-newsgroup-name)
6897     gnus-blocked-images))
6898
6899 ;;;
6900 ;;; Article editing
6901 ;;;
6902
6903 (defcustom gnus-article-edit-mode-hook nil
6904   "Hook run in article edit mode buffers."
6905   :group 'gnus-article-various
6906   :type 'hook)
6907
6908 (defvar gnus-article-edit-done-function nil)
6909
6910 (defvar gnus-article-edit-mode-map nil)
6911
6912 ;; Should we be using derived.el for this?
6913 (unless gnus-article-edit-mode-map
6914   (setq gnus-article-edit-mode-map (make-keymap))
6915   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6916
6917   (gnus-define-keys gnus-article-edit-mode-map
6918     "\C-c?"    describe-mode
6919     "\C-c\C-c" gnus-article-edit-done
6920     "\C-c\C-k" gnus-article-edit-exit
6921     "\C-c\C-f\C-t" message-goto-to
6922     "\C-c\C-f\C-o" message-goto-from
6923     "\C-c\C-f\C-b" message-goto-bcc
6924     ;;"\C-c\C-f\C-w" message-goto-fcc
6925     "\C-c\C-f\C-c" message-goto-cc
6926     "\C-c\C-f\C-s" message-goto-subject
6927     "\C-c\C-f\C-r" message-goto-reply-to
6928     "\C-c\C-f\C-n" message-goto-newsgroups
6929     "\C-c\C-f\C-d" message-goto-distribution
6930     "\C-c\C-f\C-f" message-goto-followup-to
6931     "\C-c\C-f\C-m" message-goto-mail-followup-to
6932     "\C-c\C-f\C-k" message-goto-keywords
6933     "\C-c\C-f\C-u" message-goto-summary
6934     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6935     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6936     "\C-c\C-b" message-goto-body
6937     "\C-c\C-i" message-goto-signature
6938
6939     "\C-c\C-t" message-insert-to
6940     "\C-c\C-n" message-insert-newsgroups
6941     "\C-c\C-o" message-sort-headers
6942     "\C-c\C-e" message-elide-region
6943     "\C-c\C-v" message-delete-not-region
6944     "\C-c\C-z" message-kill-to-signature
6945     "\M-\r" message-newline-and-reformat
6946     "\C-c\C-a" mml-attach-file
6947     "\C-a" message-beginning-of-line
6948     "\t" message-tab
6949     "\M-;" comment-region)
6950
6951   (gnus-define-keys (gnus-article-edit-wash-map
6952                      "\C-c\C-w" gnus-article-edit-mode-map)
6953     "f" gnus-article-edit-full-stops))
6954
6955 (easy-menu-define
6956   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6957   '("Field"
6958     ["Fetch To" message-insert-to t]
6959     ["Fetch Newsgroups" message-insert-newsgroups t]
6960     "----"
6961     ["To" message-goto-to t]
6962     ["From" message-goto-from t]
6963     ["Subject" message-goto-subject t]
6964     ["Cc" message-goto-cc t]
6965     ["Reply-To" message-goto-reply-to t]
6966     ["Summary" message-goto-summary t]
6967     ["Keywords" message-goto-keywords t]
6968     ["Newsgroups" message-goto-newsgroups t]
6969     ["Followup-To" message-goto-followup-to t]
6970     ["Mail-Followup-To" message-goto-mail-followup-to t]
6971     ["Distribution" message-goto-distribution t]
6972     ["Body" message-goto-body t]
6973     ["Signature" message-goto-signature t]))
6974
6975 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6976   "Major mode for editing articles.
6977 This is an extended text-mode.
6978
6979 \\{gnus-article-edit-mode-map}"
6980   (make-local-variable 'gnus-article-edit-done-function)
6981   (make-local-variable 'gnus-prev-winconf)
6982   (set (make-local-variable 'font-lock-defaults)
6983        '(message-font-lock-keywords t))
6984   (set (make-local-variable 'mail-header-separator) "")
6985   (set (make-local-variable 'gnus-article-edit-mode) t)
6986   (easy-menu-add message-mode-field-menu message-mode-map)
6987   (mml-mode)
6988   (setq buffer-read-only nil)
6989   (buffer-enable-undo)
6990   (widen))
6991
6992 (defun gnus-article-edit (&optional force)
6993   "Edit the current article.
6994 This will have permanent effect only in mail groups.
6995 If FORCE is non-nil, allow editing of articles even in read-only
6996 groups."
6997   (interactive "P")
6998   (when (and (not force)
6999              (gnus-group-read-only-p))
7000     (error "The current newsgroup does not support article editing"))
7001   (gnus-article-date-original)
7002   (gnus-article-edit-article
7003    'ignore
7004    `(lambda (no-highlight)
7005       'ignore
7006       (gnus-summary-edit-article-done
7007        ,(or (mail-header-references gnus-current-headers) "")
7008        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
7009
7010 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
7011   "Start editing the contents of the current article buffer."
7012   (let ((winconf (current-window-configuration)))
7013     (set-buffer gnus-article-buffer)
7014     (let ((message-auto-save-directory
7015            ;; Don't associate the article buffer with a draft file.
7016            nil))
7017       (gnus-article-edit-mode))
7018     (funcall start-func)
7019     (set-buffer-modified-p nil)
7020     (gnus-configure-windows 'edit-article)
7021     (setq gnus-article-edit-done-function exit-func)
7022     (setq gnus-prev-winconf winconf)
7023     (unless quiet
7024       (gnus-message 6 "C-c C-c to end edits"))))
7025
7026 (defun gnus-article-edit-done (&optional arg)
7027   "Update the article edits and exit."
7028   (interactive "P")
7029   (let ((func gnus-article-edit-done-function)
7030         (buf (current-buffer))
7031         (start (window-start))
7032         (p (point))
7033         (winconf gnus-prev-winconf))
7034     (widen) ;; Widen it in case that users narrowed the buffer.
7035     (funcall func arg)
7036     (set-buffer buf)
7037     ;; The cache and backlog have to be flushed somewhat.
7038     (when gnus-keep-backlog
7039       (gnus-backlog-remove-article
7040        (car gnus-article-current) (cdr gnus-article-current)))
7041     ;; Flush original article as well.
7042     (gnus-flush-original-article-buffer)
7043     (when gnus-use-cache
7044       (gnus-cache-update-article
7045        (car gnus-article-current) (cdr gnus-article-current)))
7046     ;; We remove all text props from the article buffer.
7047     (kill-all-local-variables)
7048     (set-text-properties (point-min) (point-max) nil)
7049     (gnus-article-mode)
7050     (set-window-configuration winconf)
7051     (set-buffer buf)
7052     (set-window-start (get-buffer-window buf) start)
7053     (set-window-point (get-buffer-window buf) (point)))
7054   (gnus-summary-show-article))
7055
7056 (defun gnus-flush-original-article-buffer ()
7057   (when (get-buffer gnus-original-article-buffer)
7058     (with-current-buffer gnus-original-article-buffer
7059       (setq gnus-original-article nil))))
7060
7061 (defun gnus-article-edit-exit ()
7062   "Exit the article editing without updating."
7063   (interactive)
7064   (when (or (not (buffer-modified-p))
7065             (yes-or-no-p "Article modified; kill anyway? "))
7066     (let ((curbuf (current-buffer))
7067           (p (point))
7068           (window-start (window-start)))
7069       (erase-buffer)
7070       (if (gnus-buffer-live-p gnus-original-article-buffer)
7071           (insert-buffer-substring gnus-original-article-buffer))
7072       (let ((winconf gnus-prev-winconf))
7073         (kill-all-local-variables)
7074         (gnus-article-mode)
7075         (set-window-configuration winconf)
7076         ;; Tippy-toe some to make sure that point remains where it was.
7077         (save-current-buffer
7078           (set-buffer curbuf)
7079           (set-window-start (get-buffer-window (current-buffer)) window-start)
7080           (goto-char p))))
7081     (gnus-summary-show-article)))
7082
7083 (defun gnus-article-edit-full-stops ()
7084   "Interactively repair spacing at end of sentences."
7085   (interactive)
7086   (save-excursion
7087     (goto-char (point-min))
7088     (search-forward-regexp "^$" nil t)
7089     (let ((case-fold-search nil))
7090       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7091
7092 ;;;
7093 ;;; Article highlights
7094 ;;;
7095
7096 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7097
7098 ;;; Internal Variables:
7099
7100 (defcustom gnus-button-url-regexp
7101   (concat
7102    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7103    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7104    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7105    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7106        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7107              (punct "!?:;.,"))
7108          (concat
7109           "\\(?:"
7110           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7111           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7112           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7113           "\\|"
7114           "[" chars punct     "]+" "[" chars "]"
7115           "\\)"))
7116      (concat ;; XEmacs 21.4 doesn't support POSIX.
7117       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7118       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7119    "\\)")
7120   "Regular expression that matches URLs."
7121   :group 'gnus-article-buttons
7122   :type 'regexp)
7123
7124 (defcustom gnus-button-valid-fqdn-regexp
7125   message-valid-fqdn-regexp
7126   "Regular expression that matches a valid FQDN."
7127   :version "22.1"
7128   :group 'gnus-article-buttons
7129   :type 'regexp)
7130
7131 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7132 (defcustom gnus-button-valid-localpart-regexp
7133   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7134   "Regular expression that matches a localpart of mail addresses or MIDs."
7135   :version "22.1"
7136   :group 'gnus-article-buttons
7137   :type 'regexp)
7138
7139 (defcustom gnus-button-man-handler 'manual-entry
7140   "Function to use for displaying man pages.
7141 The function must take at least one argument with a string naming the
7142 man page."
7143   :version "22.1"
7144   :type '(choice (function-item :tag "Man" manual-entry)
7145                  (function-item :tag "Woman" woman)
7146                  (function :tag "Other"))
7147   :group 'gnus-article-buttons)
7148
7149 (defcustom gnus-button-mid-or-mail-regexp
7150   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7151           gnus-button-valid-fqdn-regexp
7152           ">?\\)\\b")
7153   "Regular expression that matches a message ID or a mail address."
7154   :version "22.1"
7155   :group 'gnus-article-buttons
7156   :type 'regexp)
7157
7158 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7159   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7160 Strings like this can be either a message ID or a mail address.  If it is one
7161 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7162 message ID or a mail address, respectively.  If this variable is set to the
7163 symbol `ask', always query the user what do do.  If it is a function, this
7164 function will be called with the string as its only argument.  The function
7165 must return `mid', `mail', `invalid' or `ask'."
7166   :version "22.1"
7167   :group 'gnus-article-buttons
7168   :type '(choice (function-item :tag "Heuristic function"
7169                                 gnus-button-mid-or-mail-heuristic)
7170                  (const ask)
7171                  (const mid)
7172                  (const mail)))
7173
7174 (defcustom gnus-button-mid-or-mail-heuristic-alist
7175   '((-10.0 . ".+\\$.+@")
7176     (-10.0 . "#")
7177     (-10.0 . "\\*")
7178     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7179     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7180     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7181     (-1.0  . "^[^a-z]+@")
7182     ;;
7183     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7184     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7185     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7186     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7187     ;;
7188     (-2.0  . "^[0-9]")
7189     (-1.0  . "^[0-9][0-9]")
7190     ;;
7191     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7192     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7193     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7194     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7195     ;;
7196     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7197     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7198     ;;       "[0-9]{8,}.*\@"
7199     (-3.0
7200      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7201     ;; "[0-9]{12,}.*\@"
7202     ;; compensation for TDMA dated mail addresses:
7203     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7204     ;;
7205     (-20.0 . "\\.fsf@") ;; Gnus
7206     (-20.0 . "^slrn")
7207     (-20.0 . "^Pine")
7208     (-20.0 . "^alpine\\.")
7209     (-20.0 . "_-_") ;; Subject change in thread
7210     ;;
7211     (-20.0 . "\\.ln@") ;; leafnode
7212     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7213     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7214     ;;
7215     ;; (5.0 . "") ;; $local_part_len <= 7
7216     (10.0  . "^[^0-9]+@")
7217     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7218     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7219     (3.0   . "\@stud")
7220     ;;
7221     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7222     ;;
7223     (0.5   . "^[A-Z][a-z]")
7224     (0.5   . "^[A-Z][a-z][a-z]")
7225     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7226     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7227   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7228
7229 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7230 address.  The REGEXP is processed with `case-fold-search' set to nil."
7231   :version "22.1"
7232   :group 'gnus-article-buttons
7233   :type '(repeat (cons (number :tag "Rate")
7234                        (regexp :tag "Regexp"))))
7235
7236 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7237   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7238 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7239 address, `ask' if unsure and `invalid' if the string is invalid."
7240   (let ((case-fold-search nil)
7241         (list gnus-button-mid-or-mail-heuristic-alist)
7242         (result 0) rate regexp lpartlen elem)
7243     (setq lpartlen
7244           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7245     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7246     ;; Certain special cases...
7247     (when (string-match
7248            (concat
7249             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7250             "^[0-9]+\\.[0-9]+@compuserve\\|"
7251             "@public\\.gmane\\.org")
7252            mid-or-mail)
7253       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7254       (setq result 'mail))
7255     (when (string-match "@.*@\\| " mid-or-mail)
7256       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7257       (setq result 'invalid))
7258     ;; Nothing more to do, if result is not a number here...
7259     (when (numberp result)
7260       (while list
7261         (setq elem (car list)
7262               rate (car elem)
7263               regexp (cdr elem)
7264               list (cdr list))
7265         (when (string-match regexp mid-or-mail)
7266           (setq result (+ result rate))
7267           (gnus-message
7268            9 "`%s' matched `%s', rate `%s', result `%s'."
7269            mid-or-mail regexp rate result)))
7270       (when (<= lpartlen 7)
7271         (setq result (+ result 5.0))
7272         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7273                       mid-or-mail result))
7274       (when (>= lpartlen 12)
7275         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7276         (cond
7277          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7278           ;; Long local part should contain realname if e-mail address,
7279           ;; too many digits: message-id.
7280           ;; $score -= 5.0 + 0.1 * $local_part_len;
7281           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7282           (setq result (+ result rate))
7283           (gnus-message
7284            9 "Many digits in `%s', rate `%s', result `%s'."
7285            mid-or-mail rate result))
7286          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7287                         mid-or-mail)
7288           ;; Too few vowels [^aeiouy]{4,}.*\@
7289           (setq result (+ result -5.0))
7290           (gnus-message
7291            9 "Few vowels in `%s', rate `%s', result `%s'."
7292            mid-or-mail -5.0 result))
7293          (t
7294           (setq result (+ result 5.0))
7295           (gnus-message
7296            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7297     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7298     ;; Maybe we should make this a customizable alist: (condition . 'result)
7299     (cond
7300      ((symbolp result) result)
7301      ;; Now convert number into proper results:
7302      ((< result -10.0) 'mid)
7303      ((> result  10.0) 'mail)
7304      (t 'ask))))
7305
7306 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7307   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7308          (url-mid (concat "news" ":" mid-or-mail))
7309          (url-mailto (concat "mailto" ":" mid-or-mail)))
7310     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7311     (when (fboundp pref)
7312       (setq guessed
7313             ;; get rid of surrounding angles...
7314             (funcall pref
7315                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7316       (if (or (eq 'mid guessed) (eq 'mail guessed))
7317           (setq pref guessed)
7318         (setq pref 'ask)))
7319     (if (eq pref 'ask)
7320         (save-window-excursion
7321           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7322               (setq pref 'mail)
7323             (setq pref 'mid))))
7324     (cond ((eq pref 'mid)
7325            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7326            (gnus-button-handle-news url-mid))
7327           ((eq pref 'mail)
7328            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7329            (gnus-url-mailto url-mailto))
7330           (t (gnus-message 3 "Invalid string.")))))
7331
7332 (defun gnus-button-handle-custom (fun arg)
7333   "Call function FUN on argument ARG.
7334 Both FUN and ARG are supposed to be strings.  ARG will be passed
7335 as a symbol to FUN."
7336   (funcall (intern fun)
7337            (if (string-match "^customize-apropos" fun)
7338                arg
7339              (intern arg))))
7340
7341 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7342
7343 (defun gnus-button-handle-describe-function (url)
7344   "Call `describe-function' when pushing the corresponding URL button."
7345   (describe-function
7346    (intern
7347     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7348
7349 (defun gnus-button-handle-describe-variable (url)
7350   "Call `describe-variable' when pushing the corresponding URL button."
7351   (describe-variable
7352    (intern
7353     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7354
7355 (defun gnus-button-handle-symbol (url)
7356 "Display help on variable or function.
7357 Calls `describe-variable' or `describe-function'."
7358   (let ((sym (intern url)))
7359     (cond
7360      ((fboundp sym) (describe-function sym))
7361      ((boundp sym) (describe-variable sym))
7362      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7363
7364 (defun gnus-button-handle-describe-key (url)
7365   "Call `describe-key' when pushing the corresponding URL button."
7366   (let* ((key-string
7367           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7368          (keys (ignore-errors (eval `(kbd ,key-string)))))
7369     (if keys
7370         (describe-key keys)
7371       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7372
7373 (defun gnus-button-handle-apropos (url)
7374   "Call `apropos' when pushing the corresponding URL button."
7375   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7376
7377 (defun gnus-button-handle-apropos-command (url)
7378   "Call `apropos' when pushing the corresponding URL button."
7379   (apropos-command
7380    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7381
7382 (defun gnus-button-handle-apropos-variable (url)
7383   "Call `apropos' when pushing the corresponding URL button."
7384   (funcall
7385    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7386    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7387
7388 (defun gnus-button-handle-apropos-documentation (url)
7389   "Call `apropos' when pushing the corresponding URL button."
7390   (funcall
7391    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7392    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7393
7394 (defun gnus-button-handle-library (url)
7395   "Call `locate-library' when pushing the corresponding URL button."
7396   (gnus-message 9 "url=`%s'" url)
7397   (let* ((lib (locate-library url))
7398          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7399     (if (not lib)
7400         (gnus-message 1 "Cannot locale library `%s'." url)
7401       (find-file-read-only file))))
7402
7403 (defcustom gnus-button-man-level 5
7404   "*Integer that says how many man-related buttons Gnus will show.
7405 The higher the number, the more buttons will appear and the more false
7406 positives are possible.  Note that you can set this variable local to
7407 specific groups.  Setting it higher in Unix groups is probably a good idea.
7408 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7409 how to set variables in specific groups."
7410   :version "22.1"
7411   :group 'gnus-article-buttons
7412   :link '(custom-manual "(gnus)Group Parameters")
7413   :type 'integer)
7414
7415 (defcustom gnus-button-emacs-level 5
7416   "*Integer that says how many emacs-related buttons Gnus will show.
7417 The higher the number, the more buttons will appear and the more false
7418 positives are possible.  Note that you can set this variable local to
7419 specific groups.  Setting it higher in Emacs or Gnus related groups is
7420 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7421 `gnus-parameters' on how to set variables in specific groups."
7422   :version "22.1"
7423   :group 'gnus-article-buttons
7424   :link '(custom-manual "(gnus)Group Parameters")
7425   :type 'integer)
7426
7427 (defcustom gnus-button-message-level 5
7428   "*Integer that says how many buttons for news or mail messages will appear.
7429 The higher the number, the more buttons will appear and the more false
7430 positives are possible."
7431   ;; mail addresses, MIDs, URLs for news, ...
7432   :version "22.1"
7433   :group 'gnus-article-buttons
7434   :type 'integer)
7435
7436 (defcustom gnus-button-browse-level 5
7437   "*Integer that says how many buttons for browsing will appear.
7438 The higher the number, the more buttons will appear and the more false
7439 positives are possible."
7440   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7441   :version "22.1"
7442   :group 'gnus-article-buttons
7443   :type 'integer)
7444
7445 (defcustom gnus-button-alist
7446   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7447      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7448     ((concat "\\b\\(nntp\\|news\\):\\("
7449              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7450      0 t gnus-button-handle-news 2)
7451     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7452      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7453     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7454      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7455     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7456     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7457      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7458     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7459      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7460     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7461      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7462     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7463      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7464     ;; RFC 2368 (The mailto URL scheme)
7465     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7466      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7467     ("\\bmailto:\\([^ \n\t]+\\)"
7468      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7469     ;; Info Konqueror style <info:/foo/bar baz>.
7470     ;; Must come before " Gnus home-grown style".
7471     ("\\binfo://?\\([^'\">\n\t]+\\)"
7472      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7473    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7474     ("\\binfo://\\([^'\">\n\t ]+\\)"
7475      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7476     ;; Info GNOME style <info:foo#bar_baz>
7477     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7478      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7479     ;; Info KDE style <info:(foo)bar baz>
7480     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7481      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7482     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7483      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7484     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n,]*\\)\\)?"
7485      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7486      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7487     ;; This is custom
7488     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET\\>" 0
7489      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7490     ;; Emacs help commands
7491     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7492      ;; regexp doesn't match arguments containing ` '.
7493      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7494     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7495      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7496     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7497      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7498     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7499      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7500     ;; The following entries may lead to many false positives so don't enable
7501     ;; them by default (use a high button level).
7502     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7503      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7504      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7505     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7506      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7507     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7508      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7509     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7510      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7511     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7512      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7513     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7514      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7515     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7516      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7517     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7518      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7519     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7520      ;; Unlike the other regexps we really have to require quoting
7521      ;; here to determine where it ends.
7522      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7523     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7524     ("<URL: *\\([^\n<>]*\\)>"
7525      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7526     ;; RFC 2396 (2.4.3., delims) ...
7527     ("\"URL: *\\([^\n\"]*\\)\""
7528      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7529     ;; Raw URLs.
7530     (gnus-button-url-regexp
7531      0 (>= gnus-button-browse-level 0) browse-url 0)
7532     ;; man pages
7533     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7534      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7535      gnus-button-handle-man 1)
7536     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7537     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7538      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7539      gnus-button-handle-man 1)
7540     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7541     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7542     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7543      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7544     ;; Recognizing patches to .el files.  This is somewhat obscure,
7545     ;; but considering the percentage of Gnus users who hack Emacs
7546     ;; Lisp files...
7547     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7548      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7549     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7550      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7551     ;; MID or mail: To avoid too many false positives we don't try to catch
7552     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7553     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7554     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7555     ;; so that non-ambiguous entries (see above) match first.
7556     (gnus-button-mid-or-mail-regexp
7557      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7558   "*Alist of regexps matching buttons in article bodies.
7559
7560 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7561 REGEXP: is the string (case insensitive) matching text around the button (can
7562 also be Lisp expression evaluating to a string),
7563 BUTTON: is the number of the regexp grouping actually matching the button,
7564 FORM: is a Lisp expression which must eval to true for the button to
7565 be added,
7566 CALLBACK: is the function to call when the user push this button, and each
7567 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7568
7569 CALLBACK can also be a variable, in that case the value of that
7570 variable it the real callback function."
7571   :group 'gnus-article-buttons
7572   :type '(repeat (list (choice regexp variable sexp)
7573                        (integer :tag "Button")
7574                        (sexp :tag "Form")
7575                        (function :tag "Callback")
7576                        (repeat :tag "Par"
7577                                :inline t
7578                                (integer :tag "Regexp group")))))
7579 (put 'gnus-button-alist 'risky-local-variable t)
7580
7581 (defcustom gnus-header-button-alist
7582   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7583      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7584     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7585      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7586     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7587      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7588     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7589      0 (>= gnus-button-browse-level 0) browse-url 0)
7590     ("^Subject:" gnus-button-url-regexp
7591      0 (>= gnus-button-browse-level 0) browse-url 0)
7592     ("^[^:]+:" gnus-button-url-regexp
7593      0 (>= gnus-button-browse-level 0) browse-url 0)
7594     ("^OpenPGP:.*url=" gnus-button-url-regexp
7595      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7596     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7597      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7598     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7599      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7600   "*Alist of headers and regexps to match buttons in article heads.
7601
7602 This alist is very similar to `gnus-button-alist', except that each
7603 alist has an additional HEADER element first in each entry:
7604
7605 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7606
7607 HEADER is a regexp to match a header.  For a fuller explanation, see
7608 `gnus-button-alist'."
7609   :group 'gnus-article-buttons
7610   :group 'gnus-article-headers
7611   :type '(repeat (list (regexp :tag "Header")
7612                        (choice regexp variable)
7613                        (integer :tag "Button")
7614                        (sexp :tag "Form")
7615                        (function :tag "Callback")
7616                        (repeat :tag "Par"
7617                                :inline t
7618                                (integer :tag "Regexp group")))))
7619 (put 'gnus-header-button-alist 'risky-local-variable t)
7620
7621 ;;; Commands:
7622
7623 (defun gnus-article-push-button (event)
7624   "Check text under the mouse pointer for a callback function.
7625 If the text under the mouse pointer has a `gnus-callback' property,
7626 call it with the value of the `gnus-data' text property."
7627   (interactive "e")
7628   (set-buffer (window-buffer (posn-window (event-start event))))
7629   (let* ((pos (posn-point (event-start event)))
7630          (data (get-text-property pos 'gnus-data))
7631          (fun (get-text-property pos 'gnus-callback)))
7632     (goto-char pos)
7633     (when fun
7634       (funcall fun data))))
7635
7636 (defun gnus-article-press-button ()
7637   "Check text at point for a callback function.
7638 If the text at point has a `gnus-callback' property,
7639 call it with the value of the `gnus-data' text property."
7640   (interactive)
7641   (let ((data (get-text-property (point) 'gnus-data))
7642         (fun (get-text-property (point) 'gnus-callback)))
7643     (when fun
7644       (funcall fun data))))
7645
7646 (defun gnus-article-highlight (&optional force)
7647   "Highlight current article.
7648 This function calls `gnus-article-highlight-headers',
7649 `gnus-article-highlight-citation',
7650 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7651 do the highlighting.  See the documentation for those functions."
7652   (interactive (list 'force))
7653   (gnus-article-highlight-headers)
7654   (gnus-article-highlight-citation force)
7655   (gnus-article-highlight-signature)
7656   (gnus-article-add-buttons)
7657   (gnus-article-add-buttons-to-head))
7658
7659 (defun gnus-article-highlight-some (&optional force)
7660   "Highlight current article.
7661 This function calls `gnus-article-highlight-headers',
7662 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7663 do the highlighting.  See the documentation for those functions."
7664   (interactive (list 'force))
7665   (gnus-article-highlight-headers)
7666   (gnus-article-highlight-signature)
7667   (gnus-article-add-buttons))
7668
7669 (defun gnus-article-highlight-headers ()
7670   "Highlight article headers as specified by `gnus-header-face-alist'."
7671   (interactive)
7672   (gnus-with-article-headers
7673     (let (regexp header-face field-face from hpoints fpoints)
7674       (dolist (entry gnus-header-face-alist)
7675         (goto-char (point-min))
7676         (setq regexp (concat "^\\("
7677                              (if (string-equal "" (nth 0 entry))
7678                                  "[^\t ]"
7679                                (nth 0 entry))
7680                              "\\)")
7681               header-face (nth 1 entry)
7682               field-face (nth 2 entry))
7683         (while (and (re-search-forward regexp nil t)
7684                     (not (eobp)))
7685           (beginning-of-line)
7686           (setq from (point))
7687           (unless (search-forward ":" nil t)
7688             (forward-char 1))
7689           (when (and header-face
7690                      (not (memq (point) hpoints)))
7691             (push (point) hpoints)
7692             (gnus-put-text-property from (point) 'face header-face))
7693           (when (and field-face
7694                      (not (memq (setq from (point)) fpoints)))
7695             (push from fpoints)
7696             (if (re-search-forward "^[^ \t]" nil t)
7697                 (forward-char -2)
7698               (goto-char (point-max)))
7699             (gnus-put-text-property from (point) 'face field-face)))))))
7700
7701 (defun gnus-article-highlight-signature ()
7702   "Highlight the signature in an article.
7703 It does this by highlighting everything after
7704 `gnus-signature-separator' using the face `gnus-signature'."
7705   (interactive)
7706   (gnus-with-article-buffer
7707     (let ((inhibit-point-motion-hooks t))
7708       (save-restriction
7709         (when (and gnus-signature-face
7710                    (gnus-article-narrow-to-signature))
7711           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7712                             'face gnus-signature-face)
7713           (widen)
7714           (gnus-article-search-signature)
7715           (let ((start (match-beginning 0))
7716                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7717             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7718                                      end)))))))
7719
7720 (defun gnus-button-in-region-p (b e prop)
7721   "Say whether PROP exists in the region."
7722   (text-property-not-all b e prop nil))
7723
7724 (defun gnus-article-add-buttons ()
7725   "Find external references in the article and make buttons of them.
7726 \"External references\" are things like Message-IDs and URLs, as
7727 specified by `gnus-button-alist'."
7728   (interactive)
7729   (gnus-with-article-buffer
7730     (let ((inhibit-point-motion-hooks t)
7731           (case-fold-search t)
7732           (alist gnus-button-alist)
7733           beg entry regexp)
7734       ;; We skip the headers.
7735       (article-goto-body)
7736       (setq beg (point))
7737       (while (setq entry (pop alist))
7738         (setq regexp (eval (car entry)))
7739         (goto-char beg)
7740         (while (re-search-forward regexp nil t)
7741           (let ((start (match-beginning (nth 1 entry)))
7742                 (end (match-end (nth 1 entry)))
7743                 (from (match-beginning 0)))
7744             (when (and (eval (nth 2 entry))
7745                        (not (gnus-button-in-region-p
7746                              start end 'gnus-callback)))
7747               ;; That optional form returned non-nil, so we add the
7748               ;; button.
7749               (setq from (set-marker (make-marker) from))
7750               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7751                            (gnus-article-extend-url-button from start end))
7752                 (gnus-article-add-button start end
7753                                          'gnus-button-push (list from entry))
7754                 (gnus-put-text-property
7755                  start end
7756                  'gnus-string (buffer-substring-no-properties
7757                                start end))))))))))
7758
7759 (defun gnus-article-extend-url-button (beg start end)
7760   "Extend url button if url is folded into two or more lines.
7761 Return non-nil if button is extended.  BEG is a marker that points to
7762 the beginning position of a text containing url.  START and END are
7763 the endpoints of a url button before it is extended.  The concatenated
7764 url is put as the `gnus-button-url' overlay property on the button."
7765   (let ((opoint (point))
7766         (points (list start end))
7767         url delim regexp)
7768     (prog1
7769         (when (and (progn
7770                      (goto-char end)
7771                      (not (looking-at "[\t ]*[\">]")))
7772                    (progn
7773                      (goto-char start)
7774                      (string-match
7775                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7776                       (buffer-substring (point-at-bol) start)))
7777                    (progn
7778                      (setq url (list (buffer-substring start end))
7779                            delim (if (match-beginning 1) ">" "\""))
7780                      (beginning-of-line)
7781                      (setq regexp (concat
7782                                    (when (and (looking-at
7783                                                message-cite-prefix-regexp)
7784                                               (< (match-end 0) start))
7785                                      (regexp-quote (match-string 0)))
7786                                    "\
7787 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7788                                    delim "\\)"))
7789                      (while (progn
7790                               (forward-line 1)
7791                               (and (looking-at regexp)
7792                                    (prog1
7793                                        (match-beginning 1)
7794                                      (push (or (match-string 2)
7795                                                (match-string 1))
7796                                            url)
7797                                      (push (setq end (or (match-end 2)
7798                                                          (match-end 1)))
7799                                            points)
7800                                      (push (or (match-beginning 2)
7801                                                (match-beginning 1))
7802                                            points)))))
7803                      (match-beginning 2)))
7804           (let (gnus-article-mouse-face widget-mouse-face)
7805             (while points
7806               (gnus-article-add-button (pop points) (pop points)
7807                                        'gnus-button-push beg)))
7808           (let ((overlay (gnus-make-overlay start end)))
7809             (gnus-overlay-put overlay 'evaporate t)
7810             (gnus-overlay-put overlay 'gnus-button-url
7811                               (list (mapconcat 'identity (nreverse url) "")))
7812             (when gnus-article-mouse-face
7813               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7814           t)
7815       (goto-char opoint))))
7816
7817 ;; Add buttons to the head of an article.
7818 (defun gnus-article-add-buttons-to-head ()
7819   "Add buttons to the head of the article."
7820   (interactive)
7821   (gnus-with-article-headers
7822     (let (beg end)
7823       (dolist (entry gnus-header-button-alist)
7824         ;; Each alist entry.
7825         (goto-char (point-min))
7826         (while (re-search-forward (car entry) nil t)
7827           ;; Each header matching the entry.
7828           (setq beg (match-beginning 0))
7829           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7830                              (match-beginning 0))
7831                         (point-max)))
7832           (goto-char beg)
7833           (while (re-search-forward (eval (nth 1 entry)) end t)
7834             ;; Each match within a header.
7835             (let* ((entry (cdr entry))
7836                    (start (match-beginning (nth 1 entry)))
7837                    (end (match-end (nth 1 entry)))
7838                    (form (nth 2 entry)))
7839               (goto-char (match-end 0))
7840               (when (eval form)
7841                 (gnus-article-add-button
7842                  start end (nth 3 entry)
7843                  (buffer-substring (match-beginning (nth 4 entry))
7844                                    (match-end (nth 4 entry)))))))
7845           (goto-char end))))))
7846
7847 ;;; External functions:
7848
7849 (defun gnus-article-add-button (from to fun &optional data text)
7850   "Create a button between FROM and TO with callback FUN and data DATA."
7851   (when gnus-article-button-face
7852     (gnus-overlay-put (gnus-make-overlay from to nil t)
7853                       'face gnus-article-button-face))
7854   (gnus-add-text-properties
7855    from to
7856    (nconc (and gnus-article-mouse-face
7857                (list gnus-mouse-face-prop gnus-article-mouse-face))
7858           (list 'gnus-callback fun)
7859           (and data (list 'gnus-data data))))
7860   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7861                          :help-echo (or text "Follow the link")
7862                          :keymap gnus-url-button-map
7863                          :button-keymap gnus-widget-button-keymap))
7864
7865 (defun gnus-article-copy-string ()
7866   "Copy the string in the button to the kill ring."
7867   (interactive)
7868   (gnus-article-check-buffer)
7869   (let ((data (get-text-property (point) 'gnus-string)))
7870     (when data
7871       (with-temp-buffer
7872         (insert data)
7873         (copy-region-as-kill (point-min) (point-max))
7874         (message "Copied %s" data)))))
7875
7876 ;;; Internal functions:
7877
7878 (defun gnus-article-set-globals ()
7879   (with-current-buffer gnus-summary-buffer
7880     (gnus-set-global-variables)))
7881
7882 (defun gnus-signature-toggle (end)
7883   (gnus-with-article-buffer
7884     (let ((inhibit-point-motion-hooks t))
7885       (if (text-property-any end (point-max) 'article-type 'signature)
7886           (progn
7887             (gnus-delete-wash-type 'signature)
7888             (gnus-remove-text-properties-when
7889              'article-type 'signature end (point-max)
7890              (cons 'article-type (cons 'signature
7891                                        gnus-hidden-properties))))
7892         (gnus-add-wash-type 'signature)
7893         (gnus-add-text-properties-when
7894          'article-type nil end (point-max)
7895          (cons 'article-type (cons 'signature
7896                                    gnus-hidden-properties)))))
7897     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7898       (gnus-set-mode-line 'article))))
7899
7900 (defun gnus-button-push (marker-and-entry)
7901   ;; Push button starting at MARKER.
7902   (save-excursion
7903     (let* ((marker (car marker-and-entry))
7904            (entry (cadr marker-and-entry))
7905            (regexp (car entry))
7906            (inhibit-point-motion-hooks t))
7907       (goto-char marker)
7908       ;; This is obviously true, or something bad is happening :)
7909       ;; But we need it to have the match-data
7910       (when (looking-at (or (if (symbolp regexp)
7911                                 (symbol-value regexp)
7912                               regexp)))
7913         (let ((fun (nth 3 entry))
7914               (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7915                              (get-char-property marker 'gnus-button-url))
7916                         (mapcar (lambda (group)
7917                                   (let ((string (match-string group)))
7918                                     (set-text-properties
7919                                      0 (length string) nil string)
7920                                     string))
7921                                 (nthcdr 4 entry)))))
7922
7923           (cond
7924            ((fboundp fun)
7925             (apply fun args))
7926            ((and (boundp fun)
7927                  (fboundp (symbol-value fun)))
7928             (apply (symbol-value fun) args))
7929            (t
7930             (gnus-message 1 "You must define `%S' to use this button"
7931                           (cons fun args)))))))))
7932
7933 (defun gnus-parse-news-url (url)
7934   (let (scheme server port group message-id articles)
7935     (with-temp-buffer
7936       (insert url)
7937       (goto-char (point-min))
7938       (when (looking-at "\\([A-Za-z]+\\):")
7939         (setq scheme (match-string 1))
7940         (goto-char (match-end 0)))
7941       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7942         (setq server (match-string 1))
7943         (setq port (if (stringp (match-string 3))
7944                        (string-to-number (match-string 3))
7945                      (match-string 3)))
7946         (goto-char (match-end 0)))
7947
7948       (cond
7949        ((looking-at "\\(.*@.*\\)")
7950         (setq message-id (match-string 1)))
7951        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7952         (setq group (match-string 1)
7953               articles (split-string (match-string 2) "-")))
7954        ((looking-at "\\([^/]+\\)/?")
7955         (setq group (match-string 1)))
7956        (t
7957         (error "Unknown news URL syntax"))))
7958     (list scheme server port group message-id articles)))
7959
7960 (defun gnus-button-handle-news (url)
7961   "Fetch a news URL."
7962   (destructuring-bind (scheme server port group message-id articles)
7963       (gnus-parse-news-url url)
7964     (cond
7965      (message-id
7966       (with-current-buffer gnus-summary-buffer
7967         (if server
7968             (let ((gnus-refer-article-method
7969                    (nconc (list (list 'nntp server))
7970                           gnus-refer-article-method))
7971                   (nntp-port-number (or port "nntp")))
7972               (gnus-message 7 "Fetching %s with %s"
7973                             message-id gnus-refer-article-method)
7974               (gnus-summary-refer-article message-id))
7975           (gnus-summary-refer-article message-id))))
7976      (group
7977       (gnus-button-fetch-group url)))))
7978
7979 (defun gnus-button-patch (library line)
7980   "Visit an Emacs Lisp library LIBRARY on line LINE."
7981   (interactive)
7982   (let ((file (locate-library (file-name-nondirectory library))))
7983     (unless file
7984       (error "Couldn't find library %s" library))
7985     (find-file file)
7986     (goto-char (point-min))
7987     (forward-line (1- (string-to-number line)))))
7988
7989 (defun gnus-button-handle-man (url)
7990   "Fetch a man page."
7991   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7992   (when (eq gnus-button-man-handler 'woman)
7993     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7994   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7995   (funcall gnus-button-man-handler url))
7996
7997 (defun gnus-button-handle-info-url (url)
7998   "Fetch an info URL."
7999   (setq url (mm-subst-char-in-string ?+ ?\  url))
8000   (cond
8001    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
8002     (gnus-info-find-node
8003      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
8004                      "Gnus")
8005              ")" (gnus-url-unhex-string (match-string 2 url)))))
8006    ((string-match "([^)\"]+)[^\"]+" url)
8007     (setq url
8008           (gnus-replace-in-string
8009            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8010     (gnus-info-find-node url))
8011    (t (error "Can't parse %s" url))))
8012
8013 (defun gnus-button-handle-info-url-gnome (url)
8014   "Fetch GNOME style info URL."
8015   (setq url (mm-subst-char-in-string ?_ ?\  url))
8016   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8017       (gnus-info-find-node
8018        (concat "("
8019                (gnus-url-unhex-string
8020                  (match-string 1 url))
8021                ")"
8022                (or (gnus-url-unhex-string
8023                     (match-string 2 url))
8024                    "Top")))
8025     (error "Can't parse %s" url)))
8026
8027 (defun gnus-button-handle-info-url-kde (url)
8028   "Fetch KDE style info URL."
8029   (gnus-info-find-node (gnus-url-unhex-string url)))
8030
8031 ;; (info) will autoload info.el
8032 (declare-function Info-menu "info" (menu-item &optional fork))
8033 (declare-function Info-index-next "info" (num))
8034
8035 (defun gnus-button-handle-info-keystrokes (url)
8036   "Call `info' when pushing the corresponding URL button."
8037   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8038   (let (node indx comma)
8039     (if (string-match
8040          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8041                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8042                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\>"
8043                  "\\(?:[ \t\n,]*\\)\\)?")
8044          url)
8045         (setq node (match-string 2 url)
8046               indx (match-string 3 url))
8047       (error "Can't parse %s" url))
8048     (info)
8049     (Info-directory)
8050     (Info-menu node)
8051     (when (> (length indx) 0)
8052       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET\\>"
8053                             "\\([ \t\n,]*\\)")
8054                     indx)
8055       (setq comma (match-string 2 indx))
8056       (setq indx  (match-string 1 indx))
8057       (Info-index indx)
8058       (when comma
8059         (dotimes (i (with-temp-buffer
8060                       (insert comma)
8061                       ;; Note: the XEmacs version of `how-many' takes
8062                       ;; no optional argument.
8063                       (goto-char (point-min))
8064                       (how-many ",")))
8065           (Info-index-next 1)))
8066       nil)))
8067
8068 (autoload 'pgg-snarf-keys-region "pgg")
8069 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8070 (declare-function pgg-display-output-buffer "pgg" (start end status))
8071
8072 (defun gnus-button-openpgp (url)
8073   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8074   (with-temp-buffer
8075     (mm-url-insert-file-contents-external url)
8076     (pgg-snarf-keys-region (point-min) (point-max))
8077     (pgg-display-output-buffer nil nil nil)))
8078
8079 (defun gnus-button-message-id (message-id)
8080   "Fetch MESSAGE-ID."
8081   (with-current-buffer gnus-summary-buffer
8082     (gnus-summary-refer-article message-id)))
8083
8084 (defun gnus-button-fetch-group (address &rest ignore)
8085   "Fetch GROUP specified by ADDRESS."
8086   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8087                       address)
8088     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8089     ;; for nntp:// and news://
8090     (setq address (match-string 3 address)))
8091   (if (not (string-match "[:/]" address))
8092       ;; This is just a simple group url.
8093       (gnus-group-read-ephemeral-group address gnus-select-method)
8094     (if (not
8095          (string-match
8096           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8097           address))
8098         (error "Can't parse %s" address)
8099       (gnus-group-read-ephemeral-group
8100        (match-string 4 address)
8101        `(nntp ,(match-string 1 address)
8102               (nntp-address ,(match-string 1 address))
8103               (nntp-port-number ,(if (match-end 3)
8104                                      (match-string 3 address)
8105                                    "nntp")))
8106        nil nil nil
8107        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8108
8109 (defun gnus-url-parse-query-string (query &optional downcase)
8110   (let (retval pairs cur key val)
8111     (setq pairs (split-string query "&"))
8112     (while pairs
8113       (setq cur (car pairs)
8114             pairs (cdr pairs))
8115       (if (not (string-match "=" cur))
8116           nil                           ; Grace
8117         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8118               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8119         (if downcase
8120             (setq key (downcase key)))
8121         (setq cur (assoc key retval))
8122         (if cur
8123             (setcdr cur (cons val (cdr cur)))
8124           (setq retval (cons (list key val) retval)))))
8125     retval))
8126
8127 (defun gnus-url-mailto (url)
8128   ;; Send mail to someone
8129   (setq url (replace-regexp-in-string "\n" " " url))
8130   (when (string-match "mailto:/*\\(.*\\)" url)
8131     (setq url (substring url (match-beginning 1) nil)))
8132   (let (to args subject func)
8133     (setq args (gnus-url-parse-query-string
8134                 (if (string-match "^\\?" url)
8135                     (substring url 1)
8136                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8137                       (concat "to=" (match-string 1 url) "&"
8138                               (match-string 2 url))
8139                     (concat "to=" url))))
8140           subject (cdr-safe (assoc "subject" args)))
8141     (gnus-msg-mail)
8142     (while args
8143       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8144       (if (fboundp func)
8145           (funcall func)
8146         (message-position-on-field (caar args)))
8147       (insert (gnus-replace-in-string
8148                (mapconcat 'identity (reverse (cdar args)) ", ")
8149                "\r\n" "\n" t))
8150       (setq args (cdr args)))
8151     (if subject
8152         (message-goto-body)
8153       (message-goto-subject))))
8154
8155 (defun gnus-button-embedded-url (address)
8156   "Activate ADDRESS with `browse-url'."
8157   (browse-url (gnus-strip-whitespace address)))
8158
8159 ;;; Next/prev buttons in the article buffer.
8160
8161 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8162 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8163
8164 (defvar gnus-prev-page-map
8165   (let ((map (make-sparse-keymap)))
8166     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8167     (define-key map "\r" 'gnus-button-prev-page)
8168     map))
8169
8170 (defvar gnus-next-page-map
8171   (let ((map (make-sparse-keymap)))
8172     (define-key map gnus-mouse-2 'gnus-button-next-page)
8173     (define-key map "\r" 'gnus-button-next-page)
8174     map))
8175
8176 (defun gnus-insert-prev-page-button ()
8177   (let ((b (point)) e
8178         (inhibit-read-only t))
8179     (gnus-eval-format
8180      gnus-prev-page-line-format nil
8181      `(keymap ,gnus-prev-page-map
8182               gnus-prev t
8183               gnus-callback gnus-article-button-prev-page
8184               article-type annotation))
8185     (setq e (if (bolp)
8186                 ;; Exclude a newline.
8187                 (1- (point))
8188               (point)))
8189     (when gnus-article-button-face
8190       (gnus-overlay-put (gnus-make-overlay b e nil t)
8191                         'face gnus-article-button-face))
8192     (widget-convert-button
8193      'link b e
8194      :action 'gnus-button-prev-page
8195      :button-keymap gnus-prev-page-map)))
8196
8197 (defun gnus-button-next-page (&optional args more-args)
8198   "Go to the next page."
8199   (interactive)
8200   (let ((win (selected-window)))
8201     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8202     (gnus-article-next-page)
8203     (select-window win)))
8204
8205 (defun gnus-button-prev-page (&optional args more-args)
8206   "Go to the prev page."
8207   (interactive)
8208   (let ((win (selected-window)))
8209     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8210     (gnus-article-prev-page)
8211     (select-window win)))
8212
8213 (defun gnus-insert-next-page-button ()
8214   (let ((b (point)) e
8215         (inhibit-read-only t))
8216     (gnus-eval-format gnus-next-page-line-format nil
8217                       `(keymap ,gnus-next-page-map
8218                                gnus-next t
8219                                gnus-callback gnus-article-button-next-page
8220                                article-type annotation))
8221     (setq e (if (bolp)
8222                 ;; Exclude a newline.
8223                 (1- (point))
8224               (point)))
8225     (when gnus-article-button-face
8226       (gnus-overlay-put (gnus-make-overlay b e nil t)
8227                         'face gnus-article-button-face))
8228     (widget-convert-button
8229      'link b e
8230      :action 'gnus-button-next-page
8231      :button-keymap gnus-next-page-map)))
8232
8233 (defun gnus-article-button-next-page (arg)
8234   "Go to the next page."
8235   (interactive "P")
8236   (let ((win (selected-window)))
8237     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8238     (gnus-article-next-page)
8239     (select-window win)))
8240
8241 (defun gnus-article-button-prev-page (arg)
8242   "Go to the prev page."
8243   (interactive "P")
8244   (let ((win (selected-window)))
8245     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8246     (gnus-article-prev-page)
8247     (select-window win)))
8248
8249 (defvar gnus-decode-header-methods
8250   '(mail-decode-encoded-word-region)
8251   "List of methods used to decode headers.
8252
8253 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8254 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8255 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8256 whose names match REGEXP.
8257
8258 For example:
8259 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8260  mail-decode-encoded-word-region
8261  (\"chinese\" . rfc1843-decode-region))
8262 ")
8263
8264 (defvar gnus-decode-header-methods-cache nil)
8265
8266 (defun gnus-multi-decode-header (start end)
8267   "Apply the functions from `gnus-encoded-word-methods' that match."
8268   (unless (and gnus-decode-header-methods-cache
8269                (eq gnus-newsgroup-name
8270                    (car gnus-decode-header-methods-cache)))
8271     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8272     (dolist (x gnus-decode-header-methods)
8273       (if (symbolp x)
8274           (nconc gnus-decode-header-methods-cache (list x))
8275         (if (and gnus-newsgroup-name
8276                  (string-match (car x) gnus-newsgroup-name))
8277             (nconc gnus-decode-header-methods-cache
8278                    (list (cdr x)))))))
8279   (let ((xlist gnus-decode-header-methods-cache))
8280     (pop xlist)
8281     (save-restriction
8282       (narrow-to-region start end)
8283       (while xlist
8284         (funcall (pop xlist) (point-min) (point-max))))))
8285
8286 ;;;
8287 ;;; Treatment top-level handling.
8288 ;;;
8289
8290 (defvar gnus-inhibit-article-treatments nil)
8291
8292 (defun gnus-treat-article (gnus-treat-condition
8293                            &optional part-number total-parts gnus-treat-type)
8294   (let ((gnus-treat-length (- (point-max) (point-min)))
8295         (alist gnus-treatment-function-alist)
8296         (article-goto-body-goes-to-point-min-p t)
8297         (treated-type
8298          (or (not gnus-treat-type)
8299              (catch 'found
8300                (let ((list gnus-article-treat-types))
8301                  (while list
8302                    (when (string-match (pop list) gnus-treat-type)
8303                      (throw 'found t)))))))
8304         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8305         val elem)
8306     (gnus-run-hooks 'gnus-part-display-hook)
8307     (dolist (elem alist)
8308       (setq val
8309             (save-excursion
8310               (when (gnus-buffer-live-p gnus-summary-buffer)
8311                 (set-buffer gnus-summary-buffer))
8312               (symbol-value (car elem))))
8313       (when (and (or (consp val)
8314                      treated-type)
8315                  (or (not gnus-inhibit-article-treatments)
8316                      (eq gnus-treat-condition 'head))
8317                  (gnus-treat-predicate val)
8318                  (or (not (get (car elem) 'highlight))
8319                      highlightp))
8320         (save-restriction
8321           (funcall (cadr elem)))))))
8322
8323 ;; Dynamic variables.
8324 (defvar part-number)
8325 (defvar total-parts)
8326 (defvar gnus-treat-type)
8327 (defvar gnus-treat-condition)
8328 (defvar gnus-treat-length)
8329
8330 (defun gnus-treat-predicate (val)
8331   (cond
8332    ((null val)
8333     nil)
8334    (gnus-treat-condition
8335     (eq gnus-treat-condition val))
8336    ((and (listp val)
8337          (stringp (car val)))
8338     (apply 'gnus-or (mapcar `(lambda (s)
8339                                (string-match s ,(or gnus-newsgroup-name "")))
8340                             val)))
8341    ((listp val)
8342     (let ((pred (pop val)))
8343       (cond
8344        ((eq pred 'or)
8345         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8346        ((eq pred 'and)
8347         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8348        ((eq pred 'not)
8349         (not (gnus-treat-predicate (car val))))
8350        ((eq pred 'typep)
8351         (equal (car val) gnus-treat-type))
8352        (t
8353         (error "%S is not a valid predicate" pred)))))
8354    ((eq val t)
8355     t)
8356    ((eq val 'head)
8357     nil)
8358    ((eq val 'first)
8359     (eq part-number 1))
8360    ((eq val 'last)
8361     (eq part-number total-parts))
8362    ((numberp val)
8363     (< gnus-treat-length val))
8364    (t
8365     (error "%S is not a valid value" val))))
8366
8367 (defun gnus-article-encrypt-body (protocol &optional n)
8368   "Encrypt the article body."
8369   (interactive
8370    (list
8371     (or gnus-article-encrypt-protocol
8372         (gnus-completing-read "Encrypt protocol"
8373                               (mapcar 'car gnus-article-encrypt-protocol-alist)
8374                               t))
8375     current-prefix-arg))
8376   ;; User might hit `K E' instead of `K e', so prompt once.
8377   (when (and gnus-article-encrypt-protocol
8378              gnus-novice-user)
8379     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8380       (error "Encrypt aborted")))
8381   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8382     (unless func
8383       (error "Can't find the encrypt protocol %s" protocol))
8384     (if (member gnus-newsgroup-name '("nndraft:delayed"
8385                                       "nndraft:drafts"
8386                                       "nndraft:queue"))
8387         (error "Can't encrypt the article in group %s"
8388                gnus-newsgroup-name))
8389     (gnus-summary-iterate n
8390       (with-current-buffer gnus-summary-buffer
8391         (let ((mail-parse-charset gnus-newsgroup-charset)
8392               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8393               (summary-buffer gnus-summary-buffer)
8394               references point)
8395           (gnus-set-global-variables)
8396           (when (gnus-group-read-only-p)
8397             (error "The current newsgroup does not support article encrypt"))
8398           (gnus-summary-show-article t)
8399           (setq references
8400               (or (mail-header-references gnus-current-headers) ""))
8401           (set-buffer gnus-article-buffer)
8402           (let* ((inhibit-read-only t)
8403                  (headers
8404                   (mapcar (lambda (field)
8405                             (and (save-restriction
8406                                    (message-narrow-to-head)
8407                                    (goto-char (point-min))
8408                                    (search-forward field nil t))
8409                                  (prog2
8410                                      (message-narrow-to-field)
8411                                      (buffer-string)
8412                                    (delete-region (point-min) (point-max))
8413                                    (widen))))
8414                           '("Content-Type:" "Content-Transfer-Encoding:"
8415                             "Content-Disposition:"))))
8416             (message-narrow-to-head)
8417             (message-remove-header "MIME-Version")
8418             (goto-char (point-max))
8419             (setq point (point))
8420             (insert (apply 'concat headers))
8421             (widen)
8422             (narrow-to-region point (point-max))
8423             (let ((message-options message-options))
8424               (message-options-set 'message-sender user-mail-address)
8425               (message-options-set 'message-recipients user-mail-address)
8426               (message-options-set 'message-sign-encrypt 'not)
8427               (funcall func))
8428             (goto-char (point-min))
8429             (insert "MIME-Version: 1.0\n")
8430             (widen)
8431             (gnus-summary-edit-article-done
8432              references nil summary-buffer t))
8433           (when gnus-keep-backlog
8434             (gnus-backlog-remove-article
8435              (car gnus-article-current) (cdr gnus-article-current)))
8436           (gnus-flush-original-article-buffer)
8437           (when gnus-use-cache
8438             (gnus-cache-update-article
8439              (car gnus-article-current) (cdr gnus-article-current))))))))
8440
8441 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8442   "The following specs can be used:
8443 %t  The security MIME type
8444 %i  Additional info
8445 %d  Details
8446 %D  Details if button is pressed")
8447
8448 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8449   "The following specs can be used:
8450 %t  The security MIME type
8451 %i  Additional info
8452 %d  Details
8453 %D  Details if button is pressed")
8454
8455 (defvar gnus-mime-security-button-line-format-alist
8456   '((?t gnus-tmp-type ?s)
8457     (?i gnus-tmp-info ?s)
8458     (?d gnus-tmp-details ?s)
8459     (?D gnus-tmp-pressed-details ?s)))
8460
8461 (defvar gnus-mime-security-button-commands
8462   '((gnus-article-press-button "\r" "Show Detail")
8463     (undefined "v")
8464     (undefined "t")
8465     (undefined "C")
8466     (gnus-mime-security-save-part "o" "Save...")
8467     (undefined "\C-o")
8468     (undefined "r")
8469     (undefined "d")
8470     (undefined "c")
8471     (undefined "i")
8472     (undefined "E")
8473     (undefined "e")
8474     (undefined "p")
8475     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8476     (undefined ".")))
8477
8478 (defvar gnus-mime-security-button-map
8479   (let ((map (make-sparse-keymap)))
8480     (define-key map gnus-mouse-2 'gnus-article-push-button)
8481     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8482     (dolist (c gnus-mime-security-button-commands)
8483       (define-key map (cadr c) (car c)))
8484     map))
8485
8486 (easy-menu-define
8487   gnus-mime-security-button-menu gnus-mime-security-button-map
8488   "Security button menu."
8489   `("Security Part"
8490     ,@(delq nil
8491             (mapcar (lambda (c)
8492                       (unless (eq (car c) 'undefined)
8493                         (vector (caddr c) (car c) :active t)))
8494                     gnus-mime-security-button-commands))))
8495
8496 (defun gnus-mime-security-button-menu (event prefix)
8497   "Construct a context-sensitive menu of security commands."
8498   (interactive "e\nP")
8499   (save-window-excursion
8500     (let ((pos (event-start event)))
8501       (select-window (posn-window pos))
8502       (goto-char (posn-point pos))
8503       (gnus-article-check-buffer)
8504       (popup-menu gnus-mime-security-button-menu nil prefix))))
8505
8506 (defvar gnus-mime-security-details-buffer nil)
8507
8508 (defvar gnus-mime-security-button-pressed nil)
8509
8510 (defvar gnus-mime-security-show-details-inline t
8511   "If non-nil, show details in the article buffer.")
8512
8513 (defun gnus-mime-security-verify-or-decrypt (handle)
8514   (mm-remove-parts (cdr handle))
8515   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8516         point (inhibit-read-only t))
8517     (if region
8518         (goto-char (car region)))
8519     (setq point (point))
8520     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8521       (let* ((mm-verify-option 'known)
8522              (mm-decrypt-option 'known)
8523              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8524         (unless (eq nparts (cdr handle))
8525           (mm-destroy-parts (cdr handle))
8526           (setcdr handle nparts))))
8527     (gnus-mime-display-security handle)
8528     (when region
8529       (delete-region (point) (cdr region))
8530       (set-marker (car region) nil)
8531       (set-marker (cdr region) nil))
8532     (goto-char point)))
8533
8534 (defun gnus-mime-security-show-details (handle)
8535   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8536     (if (not details)
8537         (gnus-message 5 "No details.")
8538       (if gnus-mime-security-show-details-inline
8539           (let ((gnus-mime-security-button-pressed
8540                  (not (get-text-property (point) 'gnus-mime-details)))
8541                 (gnus-mime-security-button-line-format
8542                  (get-text-property (point) 'gnus-line-format))
8543                 (inhibit-read-only t))
8544             (forward-char -1)
8545             (while (eq (get-text-property (point) 'gnus-line-format)
8546                        gnus-mime-security-button-line-format)
8547               (forward-char -1))
8548             (forward-char)
8549             (save-restriction
8550               (narrow-to-region (point) (point))
8551               (gnus-insert-mime-security-button handle))
8552             (delete-region (point)
8553                            (or (text-property-not-all
8554                                 (point) (point-max)
8555                                 'gnus-line-format
8556                                 gnus-mime-security-button-line-format)
8557                                (point-max))))
8558         ;; Not inlined.
8559         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8560             (with-current-buffer gnus-mime-security-details-buffer
8561               (erase-buffer)
8562               t)
8563           (setq gnus-mime-security-details-buffer
8564                 (gnus-get-buffer-create "*MIME Security Details*")))
8565         (with-current-buffer gnus-mime-security-details-buffer
8566           (insert details)
8567           (goto-char (point-min)))
8568         (pop-to-buffer gnus-mime-security-details-buffer)))))
8569
8570 (defun gnus-mime-security-press-button (handle)
8571   (save-excursion
8572     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8573         (gnus-mime-security-show-details handle)
8574       (gnus-mime-security-verify-or-decrypt handle))))
8575
8576 (defun gnus-insert-mime-security-button (handle &optional displayed)
8577   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8578          (gnus-tmp-type
8579           (concat
8580            (or (nth 2 (assoc protocol mm-verify-function-alist))
8581                (nth 2 (assoc protocol mm-decrypt-function-alist))
8582                "Unknown")
8583            (if (equal (car handle) "multipart/signed")
8584                " Signed" " Encrypted")
8585            " Part"))
8586          (gnus-tmp-info
8587           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8588               "Undecided"))
8589          (gnus-tmp-details
8590           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8591          gnus-tmp-pressed-details
8592          b e)
8593     (setq gnus-tmp-details
8594           (if gnus-tmp-details
8595               (concat "\n" gnus-tmp-details)
8596             ""))
8597     (setq gnus-tmp-pressed-details
8598           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8599     (unless (bolp)
8600       (insert "\n"))
8601     (setq b (point))
8602     (gnus-eval-format
8603      gnus-mime-security-button-line-format
8604      gnus-mime-security-button-line-format-alist
8605      `(keymap ,gnus-mime-security-button-map
8606          gnus-callback gnus-mime-security-press-button
8607          gnus-line-format ,gnus-mime-security-button-line-format
8608          gnus-mime-details ,gnus-mime-security-button-pressed
8609          article-type annotation
8610          gnus-data ,handle))
8611     (setq e (if (bolp)
8612                 ;; Exclude a newline.
8613                 (1- (point))
8614               (point)))
8615     (when gnus-article-button-face
8616       (gnus-overlay-put (gnus-make-overlay b e nil t)
8617                         'face gnus-article-button-face))
8618     (widget-convert-button
8619      'link b e
8620      :mime-handle handle
8621      :action 'gnus-widget-press-button
8622      :button-keymap gnus-mime-security-button-map
8623      :help-echo
8624      (lambda (widget)
8625        ;; Needed to properly clear the message due to a bug in
8626        ;; wid-edit (XEmacs only).
8627        (when (boundp 'help-echo-owns-message)
8628          (setq help-echo-owns-message t))
8629        (format
8630         "%S: show detail; %S: more options"
8631         (aref gnus-mouse-2 0)
8632         (aref gnus-down-mouse-3 0))))))
8633
8634 (defun gnus-mime-display-security (handle)
8635   (save-restriction
8636     (narrow-to-region (point) (point))
8637     (unless (gnus-unbuttonized-mime-type-p (car handle))
8638       (gnus-insert-mime-security-button handle))
8639     (gnus-mime-display-part (cadr handle))
8640     (unless (bolp)
8641       (insert "\n"))
8642     (unless (gnus-unbuttonized-mime-type-p (car handle))
8643       (let ((gnus-mime-security-button-line-format
8644              gnus-mime-security-button-end-line-format))
8645         (gnus-insert-mime-security-button handle)))
8646     (mm-set-handle-multipart-parameter
8647      handle 'gnus-region
8648      (cons (set-marker (make-marker) (point-min))
8649            (set-marker (make-marker) (point-max))))
8650     (goto-char (point-max))))
8651
8652 (defun gnus-mime-security-run-function (function)
8653   "Run FUNCTION with the security part under point."
8654   (gnus-article-check-buffer)
8655   (let ((data (get-text-property (point) 'gnus-data))
8656         buffer handle)
8657     (when (and (stringp (car-safe data))
8658                (setq buffer (mm-handle-multipart-original-buffer data))
8659                (setq handle (cadr data)))
8660       (if (bufferp (mm-handle-buffer handle))
8661           (progn
8662             (setq handle (cons buffer (copy-sequence (cdr handle))))
8663             (mm-handle-set-undisplayer handle nil))
8664         (setq handle (mm-make-handle
8665                       buffer
8666                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8667                       nil nil nil nil nil nil)))
8668       (funcall function handle))))
8669
8670 (defun gnus-mime-security-save-part ()
8671   "Save the security part under point."
8672   (interactive)
8673   (gnus-mime-security-run-function 'mm-save-part))
8674
8675 (defun gnus-mime-security-pipe-part ()
8676   "Pipe the security part under point to a process."
8677   (interactive)
8678   (gnus-mime-security-run-function 'mm-pipe-part))
8679
8680 (gnus-ems-redefine)
8681
8682 (provide 'gnus-art)
8683
8684 (run-hooks 'gnus-art-load-hook)
8685
8686 ;;; gnus-art.el ends here