(gnus-article-browse-delete-temp-files): Don't make query
[gnus] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 ;; For Emacs < 22.2.
29 (eval-and-compile
30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
31 (eval-when-compile
32   (require 'cl))
33 (defvar tool-bar-map)
34 (defvar w3m-minor-mode-map)
35
36 (require 'gnus)
37 ;; Avoid the "Recursive load suspected" error in Emacs 21.1.
38 (eval-and-compile
39   (let ((recursive-load-depth-limit 100))
40     (require 'gnus-sum)))
41 (require 'gnus-spec)
42 (require 'gnus-int)
43 (require 'gnus-win)
44 (require 'mm-bodies)
45 (require 'mail-parse)
46 (require 'mm-decode)
47 (require 'mm-view)
48 (require 'wid-edit)
49 (require 'mm-uu)
50 (require 'message)
51
52 (autoload 'gnus-msg-mail "gnus-msg" nil t)
53 (autoload 'gnus-button-mailto "gnus-msg")
54 (autoload 'gnus-button-reply "gnus-msg" nil t)
55 (autoload 'parse-time-string "parse-time" nil nil)
56 (autoload 'ansi-color-apply-on-region "ansi-color")
57 (autoload 'mm-url-insert-file-contents-external "mm-url")
58 (autoload 'mm-extern-cache-contents "mm-extern")
59
60 (defgroup gnus-article nil
61   "Article display."
62   :link '(custom-manual "(gnus)Article Buffer")
63   :group 'gnus)
64
65 (defgroup gnus-article-treat nil
66   "Treating article parts."
67   :link '(custom-manual "(gnus)Article Hiding")
68   :group 'gnus-article)
69
70 (defgroup gnus-article-hiding nil
71   "Hiding article parts."
72   :link '(custom-manual "(gnus)Article Hiding")
73   :group 'gnus-article)
74
75 (defgroup gnus-article-highlight nil
76   "Article highlighting."
77   :link '(custom-manual "(gnus)Article Highlighting")
78   :group 'gnus-article
79   :group 'gnus-visual)
80
81 (defgroup gnus-article-signature nil
82   "Article signatures."
83   :link '(custom-manual "(gnus)Article Signature")
84   :group 'gnus-article)
85
86 (defgroup gnus-article-headers nil
87   "Article headers."
88   :link '(custom-manual "(gnus)Hiding Headers")
89   :group 'gnus-article)
90
91 (defgroup gnus-article-washing nil
92   "Special commands on articles."
93   :link '(custom-manual "(gnus)Article Washing")
94   :group 'gnus-article)
95
96 (defgroup gnus-article-emphasis nil
97   "Fontisizing articles."
98   :link '(custom-manual "(gnus)Article Fontisizing")
99   :group 'gnus-article)
100
101 (defgroup gnus-article-saving nil
102   "Saving articles."
103   :link '(custom-manual "(gnus)Saving Articles")
104   :group 'gnus-article)
105
106 (defgroup gnus-article-mime nil
107   "Worshiping the MIME wonder."
108   :link '(custom-manual "(gnus)Using MIME")
109   :group 'gnus-article)
110
111 (defgroup gnus-article-buttons nil
112   "Pushable buttons in the article buffer."
113   :link '(custom-manual "(gnus)Article Buttons")
114   :group 'gnus-article)
115
116 (defgroup gnus-article-various nil
117   "Other article options."
118   :link '(custom-manual "(gnus)Misc Article")
119   :group 'gnus-article)
120
121 (defcustom gnus-ignored-headers
122   (mapcar
123    (lambda (header)
124      (concat "^" header ":"))
125    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
126      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
127      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
128      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
129      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
130      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
131      "X-Attribution" "X-Originating-IP" "Delivered-To"
132      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
133      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
134      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
135      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
136      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
137      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
138      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
139      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
140      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
141      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
142      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
143      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
144      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
145      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
146      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
147      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
148      "List-[A-Za-z]+" "X-Listprocessor-Version"
149      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
150      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
151      "X-Received" "Content-length" "X-precedence"
152      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
153      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
154      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
155      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
156      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
157      "X-Content-length" "X-Posting-Agent" "Original-Received"
158      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
159      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
160      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
161      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
162      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
163      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
164      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
165      "Envelope-Sender" "Envelope-Recipients"))
166   "*All headers that start with this regexp will be hidden.
167 This variable can also be a list of regexps of headers to be ignored.
168 If `gnus-visible-headers' is non-nil, this variable will be ignored."
169   :type '(choice :custom-show nil
170                  regexp
171                  (repeat regexp))
172   :group 'gnus-article-hiding)
173
174 (defcustom gnus-visible-headers
175   "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Mail-Followup-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
176   "*All headers that do not match this regexp will be hidden.
177 This variable can also be a list of regexp of headers to remain visible.
178 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
179   :type '(choice
180           (repeat :value-to-internal (lambda (widget value)
181                                        (custom-split-regexp-maybe value))
182                   :match (lambda (widget value)
183                            (or (stringp value)
184                                (widget-editable-list-match widget value)))
185                   regexp)
186           (const :tag "Use gnus-ignored-headers" nil)
187           regexp)
188   :group 'gnus-article-hiding)
189
190 (defcustom gnus-sorted-header-list
191   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
192     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
193   "*This variable is a list of regular expressions.
194 If it is non-nil, headers that match the regular expressions will
195 be placed first in the article buffer in the sequence specified by
196 this list."
197   :type '(repeat regexp)
198   :group 'gnus-article-hiding)
199
200 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
201   "Headers that are only to be displayed if they have interesting data.
202 Possible values in this list are:
203
204   'empty       Headers with no content.
205   'newsgroups  Newsgroup identical to Gnus group.
206   'to-address  To identical to To-address.
207   'to-list     To identical to To-list.
208   'cc-list     CC identical to To-list.
209   'followup-to Followup-to identical to Newsgroups.
210   'reply-to    Reply-to identical to From.
211   'date        Date less than four days old.
212   'long-to     To and/or Cc longer than 1024 characters.
213   'many-to     Multiple To and/or Cc."
214   :type '(set (const :tag "Headers with no content." empty)
215               (const :tag "Newsgroups identical to Gnus group." newsgroups)
216               (const :tag "To identical to To-address." to-address)
217               (const :tag "To identical to To-list." to-list)
218               (const :tag "CC identical to To-list." cc-list)
219               (const :tag "Followup-to identical to Newsgroups." followup-to)
220               (const :tag "Reply-to identical to From." reply-to)
221               (const :tag "Date less than four days old." date)
222               (const :tag "To and/or Cc longer than 1024 characters." long-to)
223               (const :tag "Multiple To and/or Cc headers." many-to))
224   :group 'gnus-article-hiding)
225
226 (defcustom gnus-article-skip-boring nil
227   "Skip over text that is not worth reading.
228 By default, if you set this t, then Gnus will display citations and
229 signatures, but will never scroll down to show you a page consisting
230 only of boring text.  Boring text is controlled by
231 `gnus-article-boring-faces'."
232   :version "22.1"
233   :type 'boolean
234   :group 'gnus-article-hiding)
235
236 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
237   "Regexp matching signature separator.
238 This can also be a list of regexps.  In that case, it will be checked
239 from head to tail looking for a separator.  Searches will be done from
240 the end of the buffer."
241   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
242                  (regexp)
243                  (repeat :tag "List of regexp" regexp))
244   :group 'gnus-article-signature)
245
246 (defcustom gnus-signature-limit nil
247   "Provide a limit to what is considered a signature.
248 If it is a number, no signature may not be longer (in characters) than
249 that number.  If it is a floating point number, no signature may be
250 longer (in lines) than that number.  If it is a function, the function
251 will be called without any parameters, and if it returns nil, there is
252 no signature in the buffer.  If it is a string, it will be used as a
253 regexp.  If it matches, the text in question is not a signature.
254
255 This can also be a list of the above values."
256   :type '(choice (const nil)
257                  (integer :value 200)
258                  (number :value 4.0)
259                  function
260                  (regexp :value ".*"))
261   :group 'gnus-article-signature)
262
263 (defcustom gnus-hidden-properties '(invisible t intangible t)
264   "Property list to use for hiding text."
265   :type 'sexp
266   :group 'gnus-article-hiding)
267
268 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
269 ;; frames in a session.
270 (defcustom gnus-article-x-face-command
271   (if (featurep 'xemacs)
272       (if (or (gnus-image-type-available-p 'xface)
273               (gnus-image-type-available-p 'pbm))
274           'gnus-display-x-face-in-from
275         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
276     (if (gnus-image-type-available-p 'pbm)
277         'gnus-display-x-face-in-from
278       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
279 display -"))
280   "*String or function to be executed to display an X-Face header.
281 If it is a string, the command will be executed in a sub-shell
282 asynchronously.  The compressed face will be piped to this command."
283   :type `(choice string
284                  (function-item gnus-display-x-face-in-from)
285                  function)
286   :version "21.1"
287   :group 'gnus-picon
288   :group 'gnus-article-washing)
289
290 (defcustom gnus-article-x-face-too-ugly nil
291   "Regexp matching posters whose face shouldn't be shown automatically."
292   :type '(choice regexp (const nil))
293   :group 'gnus-article-washing)
294
295 (defcustom gnus-article-banner-alist nil
296   "Banner alist for stripping.
297 For example,
298      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
299   :version "21.1"
300   :type '(repeat (cons symbol regexp))
301   :group 'gnus-article-washing)
302
303 (gnus-define-group-parameter
304  banner
305  :variable-document
306  "Alist of regexps (to match group names) and banner."
307  :variable-group gnus-article-washing
308  :parameter-type
309  '(choice :tag "Banner"
310           :value nil
311           (const :tag "Remove signature" signature)
312           (symbol :tag "Item in `gnus-article-banner-alist'" none)
313           regexp
314           (const :tag "None" nil))
315  :parameter-document
316  "If non-nil, specify how to remove `banners' from articles.
317
318 Symbol `signature' means to remove signatures delimited by
319 `gnus-signature-separator'.  Any other symbol is used to look up a
320 regular expression to match the banner in `gnus-article-banner-alist'.
321 A string is used as a regular expression to match the banner
322 directly.")
323
324 (defcustom gnus-article-address-banner-alist nil
325   "Alist of mail addresses and banners.
326 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
327 to match a mail address in the From: header, BANNER is one of a symbol
328 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
329 If ADDRESS matches author's mail address, it will remove things like
330 advertisements.  For example:
331
332 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
333 "
334   :type '(repeat
335           (cons
336            (regexp :tag "Address")
337            (choice :tag "Banner" :value nil
338                    (const :tag "Remove signature" signature)
339                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
340                    regexp
341                    (const :tag "None" nil))))
342   :version "22.1"
343   :group 'gnus-article-washing)
344
345 (defmacro gnus-emphasis-custom-with-format (&rest body)
346   `(let ((format "\
347 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
348 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
349      ,@body))
350
351 (defun gnus-emphasis-custom-value-to-external (value)
352   (gnus-emphasis-custom-with-format
353    (if (consp (car value))
354        (list (format format (car (car value)) (cdr (car value)))
355              2
356              (if (nth 1 value) 2 3)
357              (nth 2 value))
358      value)))
359
360 (defun gnus-emphasis-custom-value-to-internal (value)
361   (gnus-emphasis-custom-with-format
362    (let ((regexp (concat "\\`"
363                          (format (regexp-quote format)
364                                  "\\([^()]+\\)" "\\([^()]+\\)")
365                          "\\'"))
366          pattern)
367      (if (string-match regexp (setq pattern (car value)))
368          (list (cons (match-string 1 pattern) (match-string 2 pattern))
369                (= (nth 2 value) 2)
370                (nth 3 value))
371        value))))
372
373 (defcustom gnus-emphasis-alist
374   (let ((types
375          '(("\\*" "\\*" bold nil 2)
376            ("_" "_" underline)
377            ("/" "/" italic)
378            ("_/" "/_" underline-italic)
379            ("_\\*" "\\*_" underline-bold)
380            ("\\*/" "/\\*" bold-italic)
381            ("_\\*/" "/\\*_" underline-bold-italic))))
382     (nconc
383      (gnus-emphasis-custom-with-format
384       (mapcar (lambda (spec)
385                 (list (format format (car spec) (cadr spec))
386                       (or (nth 3 spec) 2)
387                       (or (nth 4 spec) 3)
388                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
389               types))
390      '(;; I've never seen anyone use this strikethru convention whereas I've
391        ;; several times seen it triggered by normal text.  --Stef
392        ;; Miles suggests that this form is sometimes used but for italics,
393        ;; so maybe we should map it to `italic'.
394        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
395        ;; 2 3 gnus-emphasis-strikethru)
396        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
397         2 3 gnus-emphasis-underline))))
398   "*Alist that says how to fontify certain phrases.
399 Each item looks like this:
400
401   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
402
403 The first element is a regular expression to be matched.  The second
404 is a number that says what regular expression grouping used to find
405 the entire emphasized word.  The third is a number that says what
406 regexp grouping should be displayed and highlighted.  The fourth
407 is the face used for highlighting."
408   :type
409   '(repeat
410     (menu-choice
411      :format "%[Customizing Style%]\n%v"
412      :indent 2
413      (group :tag "Default"
414             :value ("" 0 0 default)
415             :value-create
416             (lambda (widget)
417               (let ((value (widget-get
418                             (cadr (widget-get (widget-get widget :parent)
419                                               :args))
420                             :value)))
421                 (if (not (eq (nth 2 value) 'default))
422                     (widget-put
423                      widget
424                      :value
425                      (gnus-emphasis-custom-value-to-external value))))
426               (widget-group-value-create widget))
427             regexp
428             (integer :format "Match group: %v")
429             (integer :format "Emphasize group: %v")
430             face)
431      (group :tag "Simple"
432             :value (("_" . "_") nil default)
433             (cons :format "%v"
434                   (regexp :format "Start regexp: %v")
435                   (regexp :format "End regexp: %v"))
436             (boolean :format "Show start and end patterns: %[%v%]\n"
437                      :on " On " :off " Off ")
438             face)))
439   :get (lambda (symbol)
440          (mapcar 'gnus-emphasis-custom-value-to-internal
441                  (default-value symbol)))
442   :set (lambda (symbol value)
443          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
444                                      value)))
445   :group 'gnus-article-emphasis)
446
447 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
448   "A regexp to describe whitespace which should not be emphasized.
449 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
450 The former avoids underlining of leading and trailing whitespace,
451 and the latter avoids underlining any whitespace at all."
452   :version "21.1"
453   :group 'gnus-article-emphasis
454   :type 'regexp)
455
456 (defface gnus-emphasis-bold '((t (:bold t)))
457   "Face used for displaying strong emphasized text (*word*)."
458   :group 'gnus-article-emphasis)
459
460 (defface gnus-emphasis-italic '((t (:italic t)))
461   "Face used for displaying italic emphasized text (/word/)."
462   :group 'gnus-article-emphasis)
463
464 (defface gnus-emphasis-underline '((t (:underline t)))
465   "Face used for displaying underlined emphasized text (_word_)."
466   :group 'gnus-article-emphasis)
467
468 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
469   "Face used for displaying underlined bold emphasized text (_*word*_)."
470   :group 'gnus-article-emphasis)
471
472 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
473   "Face used for displaying underlined italic emphasized text (_/word/_)."
474   :group 'gnus-article-emphasis)
475
476 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
477   "Face used for displaying bold italic emphasized text (/*word*/)."
478   :group 'gnus-article-emphasis)
479
480 (defface gnus-emphasis-underline-bold-italic
481   '((t (:bold t :italic t :underline t)))
482   "Face used for displaying underlined bold italic emphasized text.
483 Example: (_/*word*/_)."
484   :group 'gnus-article-emphasis)
485
486 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
487                                       '((t (:strikethru t)))
488                                     '((t (:strike-through t))))
489   "Face used for displaying strike-through text (-word-)."
490   :group 'gnus-article-emphasis)
491
492 (defface gnus-emphasis-highlight-words
493   '((t (:background "black" :foreground "yellow")))
494   "Face used for displaying highlighted words."
495   :group 'gnus-article-emphasis)
496
497 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
498   "Format for display of Date headers in article bodies.
499 See `format-time-string' for the possible values.
500
501 The variable can also be function, which should return a complete Date
502 header.  The function is called with one argument, the time, which can
503 be fed to `format-time-string'."
504   :type '(choice string function)
505   :link '(custom-manual "(gnus)Article Date")
506   :group 'gnus-article-washing)
507
508 (defcustom gnus-save-all-headers t
509   "*If non-nil, don't remove any headers before saving.
510 This will be overridden by the `:headers' property that the symbol of
511 the saver function, which is specified by `gnus-default-article-saver',
512 might have."
513   :group 'gnus-article-saving
514   :type 'boolean)
515
516 (defcustom gnus-prompt-before-saving 'always
517   "*This variable says how much prompting is to be done when saving articles.
518 If it is nil, no prompting will be done, and the articles will be
519 saved to the default files.  If this variable is `always', each and
520 every article that is saved will be preceded by a prompt, even when
521 saving large batches of articles.  If this variable is neither nil not
522 `always', there the user will be prompted once for a file name for
523 each invocation of the saving commands."
524   :group 'gnus-article-saving
525   :type '(choice (item always)
526                  (item :tag "never" nil)
527                  (sexp :tag "once" :format "%t\n" :value t)))
528
529 (defcustom gnus-saved-headers gnus-visible-headers
530   "Headers to keep if `gnus-save-all-headers' is nil.
531 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
532 If that variable is nil, however, all headers that match this regexp
533 will be kept while the rest will be deleted before saving.  This and
534 `gnus-save-all-headers' will be overridden by the `:headers' property
535 that the symbol of the saver function, which is specified by
536 `gnus-default-article-saver', might have."
537   :group 'gnus-article-saving
538   :type 'regexp)
539
540 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
541 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
542   "A function to save articles in your favourite format.
543 The function will be called by way of the `gnus-summary-save-article'
544 command, and friends such as `gnus-summary-save-article-rmail'.
545
546 Gnus provides the following functions:
547
548 * gnus-summary-save-in-rmail (Rmail format)
549 * gnus-summary-save-in-mail (Unix mail format)
550 * gnus-summary-save-in-folder (MH folder)
551 * gnus-summary-save-in-file (article format)
552 * gnus-summary-save-body-in-file (article body)
553 * gnus-summary-save-in-vm (use VM's folder format)
554 * gnus-summary-write-to-file (article format -- overwrite)
555 * gnus-summary-write-body-to-file (article body -- overwrite)
556 * gnus-summary-save-in-pipe (article format)
557
558 The symbol of each function may have the following properties:
559
560 * :decode
561 The value non-nil means save decoded articles.  This is meaningful
562 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
563 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
564 `gnus-summary-save-in-pipe'.
565
566 * :function
567 The value specifies an alternative function which appends, not
568 overwrites, articles to a file.  This implies that when saving many
569 articles at a time, `gnus-prompt-before-saving' is bound to t and all
570 articles are saved in a single file.  This is meaningful only with
571 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
572
573 * :headers
574 The value specifies the symbol of a variable of which the value
575 specifies headers to be saved.  If it is omitted,
576 `gnus-save-all-headers' and `gnus-saved-headers' control what
577 headers should be saved."
578   :group 'gnus-article-saving
579   :type '(radio (function-item gnus-summary-save-in-rmail)
580                 (function-item gnus-summary-save-in-mail)
581                 (function-item gnus-summary-save-in-folder)
582                 (function-item gnus-summary-save-in-file)
583                 (function-item gnus-summary-save-body-in-file)
584                 (function-item gnus-summary-save-in-vm)
585                 (function-item gnus-summary-write-to-file)
586                 (function-item gnus-summary-write-body-to-file)
587                 (function-item gnus-summary-save-in-pipe)
588                 (function)))
589
590 (defcustom gnus-article-save-coding-system
591   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
592       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
593       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
594       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
595   "Coding system used to save decoded articles to a file.
596
597 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
598 which can safely encode any characters in text.  This is used by the
599 commands including:
600
601 * gnus-summary-save-article-file
602 * gnus-summary-save-article-body-file
603 * gnus-summary-write-article-file
604 * gnus-summary-write-article-body-file
605
606 and the functions to which you may set `gnus-default-article-saver':
607
608 * gnus-summary-save-in-file
609 * gnus-summary-save-body-in-file
610 * gnus-summary-write-to-file
611 * gnus-summary-write-body-to-file
612
613 Those commands and functions save just text displayed in the article
614 buffer to a file if the value of this variable is non-nil.  Note that
615 buttonized MIME parts will be lost in a saved file in that case.
616 Otherwise, raw articles will be saved."
617   :group 'gnus-article-saving
618   :type `(choice
619           :format "%{%t%}:\n %[Value Menu%] %v"
620           (const :tag "Save raw articles" nil)
621           ,@(delq nil
622                   (mapcar
623                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
624                    '((const :tag "UTF-8" utf-8)
625                      (const :tag "iso-2022-7bit" iso-2022-7bit)
626                      (const :tag "Emacs internal" emacs-mule)
627                      (const :tag "escape-quoted" escape-quoted))))
628           (symbol :tag "Coding system")))
629
630 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
631   "A function generating a file name to save articles in Rmail format.
632 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
633   :group 'gnus-article-saving
634   :type 'function)
635
636 (defcustom gnus-mail-save-name 'gnus-plain-save-name
637   "A function generating a file name to save articles in Unix mail format.
638 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
639   :group 'gnus-article-saving
640   :type 'function)
641
642 (defcustom gnus-folder-save-name 'gnus-folder-save-name
643   "A function generating a file name to save articles in MH folder.
644 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
645   :group 'gnus-article-saving
646   :type 'function)
647
648 (defcustom gnus-file-save-name 'gnus-numeric-save-name
649   "A function generating a file name to save articles in article format.
650 The function is called with NEWSGROUP, HEADERS, and optional
651 LAST-FILE."
652   :group 'gnus-article-saving
653   :type 'function)
654
655 (defcustom gnus-split-methods
656   '((gnus-article-archive-name)
657     (gnus-article-nndoc-name))
658   "*Variable used to suggest where articles are to be saved.
659 For instance, if you would like to save articles related to Gnus in
660 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
661 you could set this variable to something like:
662
663  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
664    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
665
666 This variable is an alist where the key is the match and the
667 value is a list of possible files to save in if the match is
668 non-nil.
669
670 If the match is a string, it is used as a regexp match on the
671 article.  If the match is a symbol, that symbol will be funcalled
672 from the buffer of the article to be saved with the newsgroup as the
673 parameter.  If it is a list, it will be evaled in the same buffer.
674
675 If this form or function returns a string, this string will be used as a
676 possible file name; and if it returns a non-nil list, that list will be
677 used as possible file names."
678   :group 'gnus-article-saving
679   :type '(repeat (choice (list :value (fun) function)
680                          (cons :value ("" "") regexp (repeat string))
681                          (sexp :value nil))))
682
683 (defcustom gnus-page-delimiter "^\^L"
684   "*Regexp describing what to use as article page delimiters.
685 The default value is \"^\^L\", which is a form linefeed at the
686 beginning of a line."
687   :type 'regexp
688   :group 'gnus-article-various)
689
690 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
691   "*The format specification for the article mode line.
692 See `gnus-summary-mode-line-format' for a closer description.
693
694 The following additional specs are available:
695
696 %w  The article washing status.
697 %m  The number of MIME parts in the article."
698   :type 'string
699   :group 'gnus-article-various)
700
701 (defcustom gnus-article-mode-hook nil
702   "*A hook for Gnus article mode."
703   :type 'hook
704   :group 'gnus-article-various)
705
706 (when (featurep 'xemacs)
707   ;; Extracted from gnus-xmas-define in order to preserve user settings
708   (when (fboundp 'turn-off-scroll-in-place)
709     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
710   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
711   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
712
713 (defcustom gnus-article-menu-hook nil
714   "*Hook run after the creation of the article mode menu."
715   :type 'hook
716   :group 'gnus-article-various)
717
718 (defcustom gnus-article-prepare-hook nil
719   "*A hook called after an article has been prepared in the article buffer."
720   :type 'hook
721   :group 'gnus-article-various)
722
723 (defcustom gnus-copy-article-ignored-headers nil
724   "List of headers to be removed when copying an article.
725 Each element is a regular expression."
726   :version "23.1" ;; No Gnus
727   :type '(repeat regexp)
728   :group 'gnus-article-various)
729
730 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
731                         "Gnus 5.10 (Emacs-22.1)")
732
733 (defface gnus-button
734   '((t (:weight bold)))
735   "Face used for highlighting a button in the article buffer."
736   :group 'gnus-article-buttons)
737
738 (defcustom gnus-article-button-face 'gnus-button
739   "Face used for highlighting buttons in the article buffer.
740
741 An article button is a piece of text that you can activate by pressing
742 `RET' or `mouse-2' above it."
743   :type 'face
744   :group 'gnus-article-buttons)
745
746 (defcustom gnus-article-mouse-face 'highlight
747   "Face used for mouse highlighting in the article buffer.
748
749 Article buttons will be displayed in this face when the cursor is
750 above them."
751   :type 'face
752   :group 'gnus-article-buttons)
753
754 (defcustom gnus-signature-face 'gnus-signature
755   "Face used for highlighting a signature in the article buffer.
756 Obsolete; use the face `gnus-signature' for customizations instead."
757   :type 'face
758   :group 'gnus-article-highlight
759   :group 'gnus-article-signature)
760
761 (defface gnus-signature
762   '((t
763      (:italic t)))
764   "Face used for highlighting a signature in the article buffer."
765   :group 'gnus-article-highlight
766   :group 'gnus-article-signature)
767 ;; backward-compatibility alias
768 (put 'gnus-signature-face 'face-alias 'gnus-signature)
769 (put 'gnus-signature-face 'obsolete-face "22.1")
770
771 (defface gnus-header-from
772   '((((class color)
773       (background dark))
774      (:foreground "PaleGreen1"))
775     (((class color)
776       (background light))
777      (:foreground "red3"))
778     (t
779      (:italic t)))
780   "Face used for displaying from headers."
781   :group 'gnus-article-headers
782   :group 'gnus-article-highlight)
783 ;; backward-compatibility alias
784 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
785 (put 'gnus-header-from-face 'obsolete-face "22.1")
786
787 (defface gnus-header-subject
788   '((((class color)
789       (background dark))
790      (:foreground "SeaGreen1"))
791     (((class color)
792       (background light))
793      (:foreground "red4"))
794     (t
795      (:bold t :italic t)))
796   "Face used for displaying subject headers."
797   :group 'gnus-article-headers
798   :group 'gnus-article-highlight)
799 ;; backward-compatibility alias
800 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
801 (put 'gnus-header-subject-face 'obsolete-face "22.1")
802
803 (defface gnus-header-newsgroups
804   '((((class color)
805       (background dark))
806      (:foreground "yellow" :italic t))
807     (((class color)
808       (background light))
809      (:foreground "MidnightBlue" :italic t))
810     (t
811      (:italic t)))
812   "Face used for displaying newsgroups headers.
813 In the default setup this face is only used for crossposted
814 articles."
815   :group 'gnus-article-headers
816   :group 'gnus-article-highlight)
817 ;; backward-compatibility alias
818 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
819 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
820
821 (defface gnus-header-name
822   '((((class color)
823       (background dark))
824      (:foreground "SpringGreen2"))
825     (((class color)
826       (background light))
827      (:foreground "maroon"))
828     (t
829      (:bold t)))
830   "Face used for displaying header names."
831   :group 'gnus-article-headers
832   :group 'gnus-article-highlight)
833 ;; backward-compatibility alias
834 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
835 (put 'gnus-header-name-face 'obsolete-face "22.1")
836
837 (defface gnus-header-content
838   '((((class color)
839       (background dark))
840      (:foreground "SpringGreen1" :italic t))
841     (((class color)
842       (background light))
843      (:foreground "indianred4" :italic t))
844     (t
845      (:italic t)))  "Face used for displaying header content."
846   :group 'gnus-article-headers
847   :group 'gnus-article-highlight)
848 ;; backward-compatibility alias
849 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
850 (put 'gnus-header-content-face 'obsolete-face "22.1")
851
852 (defcustom gnus-header-face-alist
853   '(("From" nil gnus-header-from)
854     ("Subject" nil gnus-header-subject)
855     ("Newsgroups:.*," nil gnus-header-newsgroups)
856     ("" gnus-header-name gnus-header-content))
857   "*Controls highlighting of article headers.
858
859 An alist of the form (HEADER NAME CONTENT).
860
861 HEADER is a regular expression which should match the name of a
862 header and NAME and CONTENT are either face names or nil.
863
864 The name of each header field will be displayed using the face
865 specified by the first element in the list where HEADER matches
866 the header name and NAME is non-nil.  Similarly, the content will
867 be displayed by the first non-nil matching CONTENT face."
868   :group 'gnus-article-headers
869   :group 'gnus-article-highlight
870   :type '(repeat (list (regexp :tag "Header")
871                        (choice :tag "Name"
872                                (item :tag "skip" nil)
873                                (face :value default))
874                        (choice :tag "Content"
875                                (item :tag "skip" nil)
876                                (face :value default)))))
877
878 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
879                                           '((xface . (:face gnus-x-face)))
880                                         '((pbm . (:face gnus-x-face))
881                                           (png . nil)))
882   "Alist of image types and properties applied to Face and X-Face images.
883 Here are examples:
884
885 ;; Specify the altitude of Face images in the From header.
886 \(setq gnus-face-properties-alist
887       '((pbm . (:face gnus-x-face :ascent 80))
888         (png . (:ascent 80))))
889
890 ;; Show Face images as pressed buttons.
891 \(setq gnus-face-properties-alist
892       '((pbm . (:face gnus-x-face :relief -2))
893         (png . (:relief -2))))
894
895 See the manual for the valid properties for various image types.
896 Currently, `pbm' is used for X-Face images and `png' is used for Face
897 images in Emacs.  Only the `:face' property is effective on the `xface'
898 image type in XEmacs if it is built with the libcompface library."
899   :version "23.1" ;; No Gnus
900   :group 'gnus-article-headers
901   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
902
903 (defcustom gnus-article-decode-hook
904   '(article-decode-charset article-decode-encoded-words
905                            article-decode-group-name article-decode-idna-rhs)
906   "*Hook run to decode charsets in articles."
907   :group 'gnus-article-headers
908   :type 'hook)
909
910 (defcustom gnus-display-mime-function 'gnus-display-mime
911   "Function to display MIME articles."
912   :group 'gnus-article-mime
913   :type 'function)
914
915 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
916   "Function used to decode headers.")
917
918 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
919   "Function used to decode addresses.")
920
921 (defvar gnus-article-dumbquotes-map
922   '(("\200" "EUR")
923     ("\202" ",")
924     ("\203" "f")
925     ("\204" ",,")
926     ("\205" "...")
927     ("\213" "<")
928     ("\214" "OE")
929     ("\221" "`")
930     ("\222" "'")
931     ("\223" "``")
932     ("\224" "\"")
933     ("\225" "*")
934     ("\226" "-")
935     ("\227" "--")
936     ("\230" "~")
937     ("\231" "(TM)")
938     ("\233" ">")
939     ("\234" "oe")
940     ("\264" "'"))
941   "Table for MS-to-Latin1 translation.")
942
943 (defcustom gnus-ignored-mime-types nil
944   "List of MIME types that should be ignored by Gnus."
945   :version "21.1"
946   :group 'gnus-article-mime
947   :type '(repeat regexp))
948
949 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
950   "List of MIME types that should not be given buttons when rendered inline.
951 See also `gnus-buttonized-mime-types' which may override this variable.
952 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
953   :version "21.1"
954   :group 'gnus-article-mime
955   :type '(repeat regexp))
956
957 (defcustom gnus-buttonized-mime-types nil
958   "List of MIME types that should be given buttons when rendered inline.
959 If set, this variable overrides `gnus-unbuttonized-mime-types'.
960 To see e.g. security buttons you could set this to
961 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
962 this list to display radio buttons that allow you to choose one of two
963 media types those mails include.  See also `mm-discouraged-alternatives'.
964 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
965   :version "22.1"
966   :group 'gnus-article-mime
967   :type '(repeat regexp))
968
969 (defcustom gnus-inhibit-mime-unbuttonizing nil
970   "If non-nil, all MIME parts get buttons.
971 When nil (the default value), then some MIME parts do not get buttons,
972 as described by the variables `gnus-buttonized-mime-types' and
973 `gnus-unbuttonized-mime-types'."
974   :version "22.1"
975   :group 'gnus-article-mime
976   :type 'boolean)
977
978 (defcustom gnus-body-boundary-delimiter "_"
979   "String used to delimit header and body.
980 This variable is used by `gnus-article-treat-body-boundary' which can
981 be controlled by `gnus-treat-body-boundary'."
982   :version "22.1"
983   :group 'gnus-article-various
984   :type '(choice (item :tag "None" :value nil)
985                  string))
986
987 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
988                                   "/usr/share/picons")
989   "Defines the location of the faces database.
990 For information on obtaining this database of pretty pictures, please
991 see http://www.cs.indiana.edu/picons/ftp/index.html"
992   :version "22.1"
993   :type '(repeat directory)
994   :link '(url-link :tag "download"
995                    "http://www.cs.indiana.edu/picons/ftp/index.html")
996   :link '(custom-manual "(gnus)Picons")
997   :group 'gnus-picon)
998
999 (defun gnus-picons-installed-p ()
1000   "Say whether picons are installed on your machine."
1001   (let ((installed nil))
1002     (dolist (database gnus-picon-databases)
1003       (when (file-exists-p database)
1004         (setq installed t)))
1005     installed))
1006
1007 (defcustom gnus-article-mime-part-function nil
1008   "Function called with a MIME handle as the argument.
1009 This is meant for people who want to do something automatic based
1010 on parts -- for instance, adding Vcard info to a database."
1011   :group 'gnus-article-mime
1012   :type '(choice (const nil)
1013                  function))
1014
1015 (defcustom gnus-mime-multipart-functions nil
1016   "An alist of MIME types to functions to display them."
1017   :version "21.1"
1018   :group 'gnus-article-mime
1019   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1020
1021 (defcustom gnus-article-date-lapsed-new-header nil
1022   "Whether the X-Sent and Date headers can coexist.
1023 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
1024 either replace the old \"Date:\" header (if this variable is nil), or
1025 be added below it (otherwise)."
1026   :version "21.1"
1027   :group 'gnus-article-headers
1028   :type 'boolean)
1029
1030 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1031   "Function called with a MIME handle as the argument.
1032 This is meant for people who want to view first matched part.
1033 For `undisplayed-alternative' (default), the first undisplayed
1034 part or alternative part is used.  For `undisplayed', the first
1035 undisplayed part is used.  For a function, the first part which
1036 the function return t is used.  For nil, the first part is
1037 used."
1038   :version "21.1"
1039   :group 'gnus-article-mime
1040   :type '(choice
1041           (item :tag "first" :value nil)
1042           (item :tag "undisplayed" :value undisplayed)
1043           (item :tag "undisplayed or alternative"
1044                 :value undisplayed-alternative)
1045           (function)))
1046
1047 (defcustom gnus-mime-action-alist
1048   '(("save to file" . gnus-mime-save-part)
1049     ("save and strip" . gnus-mime-save-part-and-strip)
1050     ("replace with file" . gnus-mime-replace-part)
1051     ("delete part" . gnus-mime-delete-part)
1052     ("display as text" . gnus-mime-inline-part)
1053     ("view the part" . gnus-mime-view-part)
1054     ("pipe to command" . gnus-mime-pipe-part)
1055     ("toggle display" . gnus-article-press-button)
1056     ("toggle display" . gnus-article-view-part-as-charset)
1057     ("view as type" . gnus-mime-view-part-as-type)
1058     ("view internally" . gnus-mime-view-part-internally)
1059     ("view externally" . gnus-mime-view-part-externally))
1060   "An alist of actions that run on the MIME attachment."
1061   :group 'gnus-article-mime
1062   :type '(repeat (cons (string :tag "name")
1063                        (function))))
1064
1065 (defcustom gnus-auto-select-part 1
1066   "Advance to next MIME part when deleting or stripping parts.
1067
1068 When 0, point will be placed on the same part as before.  When
1069 positive (negative), move point forward (backwards) this many
1070 parts.  When nil, redisplay article."
1071   :version "23.1" ;; No Gnus
1072   :group 'gnus-article-mime
1073   :type '(choice (const nil :tag "Redisplay article.")
1074                  (const 1 :tag "Next part.")
1075                  (const 0 :tag "Current part.")
1076                  integer))
1077
1078 ;;;
1079 ;;; The treatment variables
1080 ;;;
1081
1082 (defvar gnus-part-display-hook nil
1083   "Hook called on parts that are to receive treatment.")
1084
1085 (defvar gnus-article-treat-custom
1086   '(choice (const :tag "Off" nil)
1087            (const :tag "On" t)
1088            (const :tag "Header" head)
1089            (const :tag "First" first)
1090            (const :tag "Last" last)
1091            (integer :tag "Less")
1092            (repeat :tag "Groups" regexp)
1093            (sexp :tag "Predicate")))
1094
1095 (defvar gnus-article-treat-head-custom
1096   '(choice (const :tag "Off" nil)
1097            (const :tag "Header" head)))
1098
1099 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1100                                    "text/x-patch")
1101   "Parts to treat.")
1102
1103 (defvar gnus-inhibit-treatment nil
1104   "Whether to inhibit treatment.")
1105
1106 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1107   "Highlight the signature.
1108 Valid values are nil, t, `head', `first', `last', an integer or a
1109 predicate.  See Info node `(gnus)Customizing Articles'."
1110   :group 'gnus-article-treat
1111   :link '(custom-manual "(gnus)Customizing Articles")
1112   :type gnus-article-treat-custom)
1113 (put 'gnus-treat-highlight-signature 'highlight t)
1114
1115 (defcustom gnus-treat-buttonize 100000
1116   "Add buttons.
1117 Valid values are nil, t, `head', `first', `last', an integer or a
1118 predicate.  See Info node `(gnus)Customizing Articles'."
1119   :group 'gnus-article-treat
1120   :link '(custom-manual "(gnus)Customizing Articles")
1121   :type gnus-article-treat-custom)
1122 (put 'gnus-treat-buttonize 'highlight t)
1123
1124 (defcustom gnus-treat-buttonize-head 'head
1125   "Add buttons to the head.
1126 Valid values are nil, t, `head', `first', `last', an integer or a
1127 predicate.  See Info node `(gnus)Customizing Articles'."
1128   :group 'gnus-article-treat
1129   :link '(custom-manual "(gnus)Customizing Articles")
1130   :type gnus-article-treat-head-custom)
1131 (put 'gnus-treat-buttonize-head 'highlight t)
1132
1133 (defcustom gnus-treat-emphasize 50000
1134   "Emphasize text.
1135 Valid values are nil, t, `head', `first', `last', an integer or a
1136 predicate.  See Info node `(gnus)Customizing Articles'."
1137   :group 'gnus-article-treat
1138   :link '(custom-manual "(gnus)Customizing Articles")
1139   :type gnus-article-treat-custom)
1140 (put 'gnus-treat-emphasize 'highlight t)
1141
1142 (defcustom gnus-treat-strip-cr nil
1143   "Remove carriage returns.
1144 Valid values are nil, t, `head', `first', `last', an integer or a
1145 predicate.  See Info node `(gnus)Customizing Articles'."
1146   :version "22.1"
1147   :group 'gnus-article-treat
1148   :link '(custom-manual "(gnus)Customizing Articles")
1149   :type gnus-article-treat-custom)
1150
1151 (defcustom gnus-treat-unsplit-urls nil
1152   "Remove newlines from within URLs.
1153 Valid values are nil, t, `head', `first', `last', an integer or a
1154 predicate.  See Info node `(gnus)Customizing Articles'."
1155   :version "22.1"
1156   :group 'gnus-article-treat
1157   :link '(custom-manual "(gnus)Customizing Articles")
1158   :type gnus-article-treat-custom)
1159
1160 (defcustom gnus-treat-leading-whitespace nil
1161   "Remove leading whitespace in headers.
1162 Valid values are nil, t, `head', `first', `last', an integer or a
1163 predicate.  See Info node `(gnus)Customizing Articles'."
1164   :version "22.1"
1165   :group 'gnus-article-treat
1166   :link '(custom-manual "(gnus)Customizing Articles")
1167   :type gnus-article-treat-custom)
1168
1169 (defcustom gnus-treat-hide-headers 'head
1170   "Hide headers.
1171 Valid values are nil, t, `head', `first', `last', an integer or a
1172 predicate.  See Info node `(gnus)Customizing Articles'."
1173   :group 'gnus-article-treat
1174   :link '(custom-manual "(gnus)Customizing Articles")
1175   :type gnus-article-treat-head-custom)
1176
1177 (defcustom gnus-treat-hide-boring-headers nil
1178   "Hide boring headers.
1179 Valid values are nil, t, `head', `first', `last', an integer or a
1180 predicate.  See Info node `(gnus)Customizing Articles'."
1181   :group 'gnus-article-treat
1182   :link '(custom-manual "(gnus)Customizing Articles")
1183   :type gnus-article-treat-head-custom)
1184
1185 (defcustom gnus-treat-hide-signature nil
1186   "Hide the signature.
1187 Valid values are nil, t, `head', `first', `last', an integer or a
1188 predicate.  See Info node `(gnus)Customizing Articles'."
1189   :group 'gnus-article-treat
1190   :link '(custom-manual "(gnus)Customizing Articles")
1191   :type gnus-article-treat-custom)
1192
1193 (defcustom gnus-treat-fill-article nil
1194   "Fill the article.
1195 Valid values are nil, t, `head', `first', `last', an integer or a
1196 predicate.  See Info node `(gnus)Customizing Articles'."
1197   :group 'gnus-article-treat
1198   :link '(custom-manual "(gnus)Customizing Articles")
1199   :type gnus-article-treat-custom)
1200
1201 (defcustom gnus-treat-hide-citation nil
1202   "Hide cited text.
1203 Valid values are nil, t, `head', `first', `last', an integer or a
1204 predicate.  See Info node `(gnus)Customizing Articles'."
1205   :group 'gnus-article-treat
1206   :link '(custom-manual "(gnus)Customizing Articles")
1207   :type gnus-article-treat-custom)
1208
1209 (defcustom gnus-treat-hide-citation-maybe nil
1210   "Hide cited text.
1211 Valid values are nil, t, `head', `first', `last', an integer or a
1212 predicate.  See Info node `(gnus)Customizing Articles'."
1213   :group 'gnus-article-treat
1214   :link '(custom-manual "(gnus)Customizing Articles")
1215   :type gnus-article-treat-custom)
1216
1217 (defcustom gnus-treat-strip-list-identifiers 'head
1218   "Strip list identifiers from `gnus-list-identifiers`.
1219 Valid values are nil, t, `head', `first', `last', an integer or a
1220 predicate.  See Info node `(gnus)Customizing Articles'."
1221   :version "21.1"
1222   :group 'gnus-article-treat
1223   :link '(custom-manual "(gnus)Customizing Articles")
1224   :type gnus-article-treat-custom)
1225
1226 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1227                         "Gnus 5.10 (Emacs 22.1)")
1228
1229 (defcustom gnus-treat-strip-pem nil
1230   "Strip PEM signatures.
1231 Valid values are nil, t, `head', `first', `last', an integer or a
1232 predicate.  See Info node `(gnus)Customizing Articles'."
1233   :group 'gnus-article-treat
1234   :link '(custom-manual "(gnus)Customizing Articles")
1235   :type gnus-article-treat-custom)
1236
1237 (defcustom gnus-treat-strip-banner t
1238   "Strip banners from articles.
1239 The banner to be stripped is specified in the `banner' group parameter.
1240 Valid values are nil, t, `head', `first', `last', an integer or a
1241 predicate.  See Info node `(gnus)Customizing Articles'."
1242   :group 'gnus-article-treat
1243   :link '(custom-manual "(gnus)Customizing Articles")
1244   :type gnus-article-treat-custom)
1245
1246 (defcustom gnus-treat-highlight-headers 'head
1247   "Highlight the headers.
1248 Valid values are nil, t, `head', `first', `last', an integer or a
1249 predicate.  See Info node `(gnus)Customizing Articles'."
1250   :group 'gnus-article-treat
1251   :link '(custom-manual "(gnus)Customizing Articles")
1252   :type gnus-article-treat-head-custom)
1253 (put 'gnus-treat-highlight-headers 'highlight t)
1254
1255 (defcustom gnus-treat-highlight-citation t
1256   "Highlight cited text.
1257 Valid values are nil, t, `head', `first', `last', an integer or a
1258 predicate.  See Info node `(gnus)Customizing Articles'."
1259   :group 'gnus-article-treat
1260   :link '(custom-manual "(gnus)Customizing Articles")
1261   :type gnus-article-treat-custom)
1262 (put 'gnus-treat-highlight-citation 'highlight t)
1263
1264 (defcustom gnus-treat-date-ut nil
1265   "Display the Date in UT (GMT).
1266 Valid values are nil, t, `head', `first', `last', an integer or a
1267 predicate.  See Info node `(gnus)Customizing Articles'."
1268   :group 'gnus-article-treat
1269   :link '(custom-manual "(gnus)Customizing Articles")
1270   :type gnus-article-treat-head-custom)
1271
1272 (defcustom gnus-treat-date-local nil
1273   "Display the Date in the local timezone.
1274 Valid values are nil, t, `head', `first', `last', an integer or a
1275 predicate.  See Info node `(gnus)Customizing Articles'."
1276   :group 'gnus-article-treat
1277   :link '(custom-manual "(gnus)Customizing Articles")
1278   :type gnus-article-treat-head-custom)
1279
1280 (defcustom gnus-treat-date-english nil
1281   "Display the Date in a format that can be read aloud in English.
1282 Valid values are nil, t, `head', `first', `last', an integer or a
1283 predicate.  See Info node `(gnus)Customizing Articles'."
1284   :version "22.1"
1285   :group 'gnus-article-treat
1286   :link '(custom-manual "(gnus)Customizing Articles")
1287   :type gnus-article-treat-head-custom)
1288
1289 (defcustom gnus-treat-date-lapsed nil
1290   "Display the Date header in a way that says how much time has elapsed.
1291 Valid values are nil, t, `head', `first', `last', an integer or a
1292 predicate.  See Info node `(gnus)Customizing Articles'."
1293   :group 'gnus-article-treat
1294   :link '(custom-manual "(gnus)Customizing Articles")
1295   :type gnus-article-treat-head-custom)
1296
1297 (defcustom gnus-treat-date-original nil
1298   "Display the date in the original timezone.
1299 Valid values are nil, t, `head', `first', `last', an integer or a
1300 predicate.  See Info node `(gnus)Customizing Articles'."
1301   :group 'gnus-article-treat
1302   :link '(custom-manual "(gnus)Customizing Articles")
1303   :type gnus-article-treat-head-custom)
1304
1305 (defcustom gnus-treat-date-iso8601 nil
1306   "Display the date in the ISO8601 format.
1307 Valid values are nil, t, `head', `first', `last', an integer or a
1308 predicate.  See Info node `(gnus)Customizing Articles'."
1309   :version "21.1"
1310   :group 'gnus-article-treat
1311   :link '(custom-manual "(gnus)Customizing Articles")
1312   :type gnus-article-treat-head-custom)
1313
1314 (defcustom gnus-treat-date-user-defined nil
1315   "Display the date in a user-defined format.
1316 The format is defined by the `gnus-article-time-format' variable.
1317 Valid values are nil, t, `head', `first', `last', an integer or a
1318 predicate.  See Info node `(gnus)Customizing Articles'."
1319   :group 'gnus-article-treat
1320   :link '(custom-manual "(gnus)Customizing Articles")
1321   :type gnus-article-treat-head-custom)
1322
1323 (defcustom gnus-treat-strip-headers-in-body t
1324   "Strip the X-No-Archive header line from the beginning of the body.
1325 Valid values are nil, t, `head', `first', `last', an integer or a
1326 predicate.  See Info node `(gnus)Customizing Articles'."
1327   :version "21.1"
1328   :group 'gnus-article-treat
1329   :link '(custom-manual "(gnus)Customizing Articles")
1330   :type gnus-article-treat-custom)
1331
1332 (defcustom gnus-treat-strip-trailing-blank-lines nil
1333   "Strip trailing blank lines.
1334 Valid values are nil, t, `head', `first', `last', an integer or a
1335 predicate.  See Info node `(gnus)Customizing Articles'.
1336
1337 When set to t, it also strips trailing blanks in all MIME parts.
1338 Consider to use `last' instead."
1339   :group 'gnus-article-treat
1340   :link '(custom-manual "(gnus)Customizing Articles")
1341   :type gnus-article-treat-custom)
1342
1343 (defcustom gnus-treat-strip-leading-blank-lines nil
1344   "Strip leading blank lines.
1345 Valid values are nil, t, `head', `first', `last', an integer or a
1346 predicate.  See Info node `(gnus)Customizing Articles'.
1347
1348 When set to t, it also strips trailing blanks in all MIME parts."
1349   :group 'gnus-article-treat
1350   :link '(custom-manual "(gnus)Customizing Articles")
1351   :type gnus-article-treat-custom)
1352
1353 (defcustom gnus-treat-strip-multiple-blank-lines nil
1354   "Strip multiple blank lines.
1355 Valid values are nil, t, `head', `first', `last', an integer or a
1356 predicate.  See Info node `(gnus)Customizing Articles'."
1357   :group 'gnus-article-treat
1358   :link '(custom-manual "(gnus)Customizing Articles")
1359   :type gnus-article-treat-custom)
1360
1361 (defcustom gnus-treat-unfold-headers 'head
1362   "Unfold folded header lines.
1363 Valid values are nil, t, `head', `first', `last', an integer or a
1364 predicate.  See Info node `(gnus)Customizing Articles'."
1365   :version "22.1"
1366   :group 'gnus-article-treat
1367   :link '(custom-manual "(gnus)Customizing Articles")
1368   :type gnus-article-treat-custom)
1369
1370 (defcustom gnus-article-unfold-long-headers nil
1371   "If non-nil, allow unfolding headers even if the header is long.
1372 If it is a regexp, only long headers matching this regexp are unfolded.
1373 If it is t, all long headers are unfolded.
1374
1375 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1376   :version "23.1" ;; No Gnus
1377   :group 'gnus-article-treat
1378   :type '(choice (const nil)
1379                  (const :tag "all" t)
1380                  (regexp)))
1381
1382 (defcustom gnus-treat-fold-headers nil
1383   "Fold headers.
1384 Valid values are nil, t, `head', `first', `last', an integer or a
1385 predicate.  See Info node `(gnus)Customizing Articles'."
1386   :version "22.1"
1387   :group 'gnus-article-treat
1388   :link '(custom-manual "(gnus)Customizing Articles")
1389   :type gnus-article-treat-custom)
1390
1391 (defcustom gnus-treat-fold-newsgroups 'head
1392   "Fold the Newsgroups and Followup-To headers.
1393 Valid values are nil, t, `head', `first', `last', an integer or a
1394 predicate.  See Info node `(gnus)Customizing Articles'."
1395   :version "22.1"
1396   :group 'gnus-article-treat
1397   :link '(custom-manual "(gnus)Customizing Articles")
1398   :type gnus-article-treat-custom)
1399
1400 (defcustom gnus-treat-overstrike t
1401   "Treat overstrike highlighting.
1402 Valid values are nil, t, `head', `first', `last', an integer or a
1403 predicate.  See Info node `(gnus)Customizing Articles'."
1404   :group 'gnus-article-treat
1405   :link '(custom-manual "(gnus)Customizing Articles")
1406   :type gnus-article-treat-custom)
1407 (put 'gnus-treat-overstrike 'highlight t)
1408
1409 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1410   "Treat ANSI SGR control sequences.
1411 Valid values are nil, t, `head', `first', `last', an integer or a
1412 predicate.  See Info node `(gnus)Customizing Articles'."
1413   :group 'gnus-article-treat
1414   :link '(custom-manual "(gnus)Customizing Articles")
1415   :type gnus-article-treat-custom)
1416
1417 (make-obsolete-variable 'gnus-treat-display-xface
1418                         'gnus-treat-display-x-face "22.1")
1419
1420 (defcustom gnus-treat-display-x-face
1421   (and (not noninteractive)
1422        (gnus-image-type-available-p 'xbm)
1423        (if (featurep 'xemacs)
1424            (featurep 'xface)
1425          (condition-case nil
1426              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1427                   (executable-find "icontopbm"))
1428            ;; shell-command-to-string may signal an error, e.g. if
1429            ;; shell-file-name is not found.
1430            (error nil)))
1431        'head)
1432   "Display X-Face headers.
1433 Valid values are nil and `head'.
1434 See Info node `(gnus)Customizing Articles' and Info node
1435 `(gnus)X-Face' for details."
1436   :group 'gnus-article-treat
1437   :version "21.1"
1438   :link '(custom-manual "(gnus)Customizing Articles")
1439   :link '(custom-manual "(gnus)X-Face")
1440   :type gnus-article-treat-head-custom
1441   :set (lambda (symbol value)
1442          (set-default
1443           symbol
1444           (cond ((or (boundp symbol) (get symbol 'saved-value))
1445                  value)
1446                 ((boundp 'gnus-treat-display-xface)
1447                  (message "\
1448 ** gnus-treat-display-xface is an obsolete variable;\
1449  use gnus-treat-display-x-face instead")
1450                  (default-value 'gnus-treat-display-xface))
1451                 ((get 'gnus-treat-display-xface 'saved-value)
1452                  (message "\
1453 ** gnus-treat-display-xface is an obsolete variable;\
1454  use gnus-treat-display-x-face instead")
1455                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1456                 (t
1457                  value)))))
1458 (put 'gnus-treat-display-x-face 'highlight t)
1459
1460 (defcustom gnus-treat-display-face
1461   (and (not noninteractive)
1462        (gnus-image-type-available-p 'png)
1463        'head)
1464   "Display Face headers.
1465 Valid values are nil, t, `head', `first', `last', an integer or a
1466 predicate.  See Info node `(gnus)Customizing Articles' and Info
1467 node `(gnus)Face' for details."
1468   :group 'gnus-article-treat
1469   :version "22.1"
1470   :link '(custom-manual "(gnus)Customizing Articles")
1471   :link '(custom-manual "(gnus)X-Face")
1472   :type gnus-article-treat-head-custom)
1473 (put 'gnus-treat-display-face 'highlight t)
1474
1475 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1476   "Display smileys.
1477 Valid values are nil, t, `head', `first', `last', an integer or a
1478 predicate.  See Info node `(gnus)Customizing Articles' and Info
1479 node `(gnus)Smileys' for details."
1480   :group 'gnus-article-treat
1481   :version "21.1"
1482   :link '(custom-manual "(gnus)Customizing Articles")
1483   :link '(custom-manual "(gnus)Smileys")
1484   :type gnus-article-treat-custom)
1485 (put 'gnus-treat-display-smileys 'highlight t)
1486
1487 (defcustom gnus-treat-from-picon
1488   (if (and (gnus-image-type-available-p 'xpm)
1489            (gnus-picons-installed-p))
1490       'head nil)
1491   "Display picons in the From header.
1492 Valid values are nil, t, `head', `first', `last', an integer or a
1493 predicate.  See Info node `(gnus)Customizing Articles' and Info
1494 node `(gnus)Picons' for details."
1495   :version "22.1"
1496   :group 'gnus-article-treat
1497   :group 'gnus-picon
1498   :link '(custom-manual "(gnus)Customizing Articles")
1499   :link '(custom-manual "(gnus)Picons")
1500   :type gnus-article-treat-head-custom)
1501 (put 'gnus-treat-from-picon 'highlight t)
1502
1503 (defcustom gnus-treat-mail-picon
1504   (if (and (gnus-image-type-available-p 'xpm)
1505            (gnus-picons-installed-p))
1506       'head nil)
1507   "Display picons in To and Cc headers.
1508 Valid values are nil, t, `head', `first', `last', an integer or a
1509 predicate.  See Info node `(gnus)Customizing Articles' and Info
1510 node `(gnus)Picons' for details."
1511   :version "22.1"
1512   :group 'gnus-article-treat
1513   :group 'gnus-picon
1514   :link '(custom-manual "(gnus)Customizing Articles")
1515   :link '(custom-manual "(gnus)Picons")
1516   :type gnus-article-treat-head-custom)
1517 (put 'gnus-treat-mail-picon 'highlight t)
1518
1519 (defcustom gnus-treat-newsgroups-picon
1520   (if (and (gnus-image-type-available-p 'xpm)
1521            (gnus-picons-installed-p))
1522       'head nil)
1523   "Display picons in the Newsgroups and Followup-To headers.
1524 Valid values are nil, t, `head', `first', `last', an integer or a
1525 predicate.  See Info node `(gnus)Customizing Articles' and Info
1526 node `(gnus)Picons' for details."
1527   :version "22.1"
1528   :group 'gnus-article-treat
1529   :group 'gnus-picon
1530   :link '(custom-manual "(gnus)Customizing Articles")
1531   :link '(custom-manual "(gnus)Picons")
1532   :type gnus-article-treat-head-custom)
1533 (put 'gnus-treat-newsgroups-picon 'highlight t)
1534
1535 (defcustom gnus-treat-body-boundary
1536   (if (or gnus-treat-newsgroups-picon
1537           gnus-treat-mail-picon
1538           gnus-treat-from-picon)
1539       ;; If there's much decoration, the user might prefer a boundery.
1540       'head
1541     nil)
1542   "Draw a boundary at the end of the headers.
1543 Valid values are nil and `head'.
1544 See Info node `(gnus)Customizing Articles' for details."
1545   :version "22.1"
1546   :group 'gnus-article-treat
1547   :link '(custom-manual "(gnus)Customizing Articles")
1548   :type gnus-article-treat-head-custom)
1549
1550 (defcustom gnus-treat-capitalize-sentences nil
1551   "Capitalize sentence-starting words.
1552 Valid values are nil, t, `head', `first', `last', an integer or a
1553 predicate.  See Info node `(gnus)Customizing Articles'."
1554   :version "21.1"
1555   :group 'gnus-article-treat
1556   :link '(custom-manual "(gnus)Customizing Articles")
1557   :type gnus-article-treat-custom)
1558
1559 (defcustom gnus-treat-wash-html nil
1560   "Format as HTML.
1561 Valid values are nil, t, `head', `first', `last', an integer or a
1562 predicate.  See Info node `(gnus)Customizing Articles'."
1563   :version "22.1"
1564   :group 'gnus-article-treat
1565   :link '(custom-manual "(gnus)Customizing Articles")
1566   :type gnus-article-treat-custom)
1567
1568 (defcustom gnus-treat-fill-long-lines nil
1569   "Fill long lines.
1570 Valid values are nil, t, `head', `first', `last', an integer or a
1571 predicate.  See Info node `(gnus)Customizing Articles'."
1572   :group 'gnus-article-treat
1573   :link '(custom-manual "(gnus)Customizing Articles")
1574   :type gnus-article-treat-custom)
1575
1576 (defcustom gnus-treat-play-sounds nil
1577   "Play sounds.
1578 Valid values are nil, t, `head', `first', `last', an integer or a
1579 predicate.  See Info node `(gnus)Customizing Articles'."
1580   :version "21.1"
1581   :group 'gnus-article-treat
1582   :link '(custom-manual "(gnus)Customizing Articles")
1583   :type gnus-article-treat-custom)
1584
1585 (defcustom gnus-treat-translate nil
1586   "Translate articles from one language to another.
1587 Valid values are nil, t, `head', `first', `last', an integer or a
1588 predicate.  See Info node `(gnus)Customizing Articles'."
1589   :version "21.1"
1590   :group 'gnus-article-treat
1591   :link '(custom-manual "(gnus)Customizing Articles")
1592   :type gnus-article-treat-custom)
1593
1594 (defcustom gnus-treat-x-pgp-sig nil
1595   "Verify X-PGP-Sig.
1596 To automatically treat X-PGP-Sig, set it to head.
1597 Valid values are nil, t, `head', `first', `last', an integer or a
1598 predicate.  See Info node `(gnus)Customizing Articles'."
1599   :version "22.1"
1600   :group 'gnus-article-treat
1601   :group 'mime-security
1602   :link '(custom-manual "(gnus)Customizing Articles")
1603   :type gnus-article-treat-custom)
1604
1605 (defvar gnus-article-encrypt-protocol-alist
1606   '(("PGP" . mml2015-self-encrypt)))
1607
1608 ;; Set to nil if more than one protocol added to
1609 ;; gnus-article-encrypt-protocol-alist.
1610 (defcustom gnus-article-encrypt-protocol "PGP"
1611   "The protocol used for encrypt articles.
1612 It is a string, such as \"PGP\". If nil, ask user."
1613   :version "22.1"
1614   :type 'string
1615   :group 'mime-security)
1616
1617 (defvar gnus-article-wash-function nil
1618   "Function used for converting HTML into text.")
1619
1620 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1621                               (mm-coding-system-p 'utf-8)
1622                               (executable-find idna-program))
1623   "Whether IDNA decoding of headers is used when viewing messages.
1624 This requires GNU Libidn, and by default only enabled if it is found."
1625   :version "22.1"
1626   :group 'gnus-article-headers
1627   :type 'boolean)
1628
1629 (defcustom gnus-article-over-scroll nil
1630   "If non-nil, allow scrolling the article buffer even when there no more text."
1631   :version "22.1"
1632   :group 'gnus-article
1633   :type 'boolean)
1634
1635 ;;; Internal variables
1636
1637 (defvar gnus-english-month-names
1638   '("January" "February" "March" "April" "May" "June" "July" "August"
1639     "September" "October" "November" "December"))
1640
1641 (defvar article-goto-body-goes-to-point-min-p nil)
1642 (defvar gnus-article-wash-types nil)
1643 (defvar gnus-article-emphasis-alist nil)
1644 (defvar gnus-article-image-alist nil)
1645
1646 (defvar gnus-article-mime-handle-alist-1 nil)
1647 (defvar gnus-treatment-function-alist
1648   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1649     (gnus-treat-strip-banner gnus-article-strip-banner)
1650     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1651     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1652     (gnus-treat-buttonize gnus-article-add-buttons)
1653     (gnus-treat-fill-article gnus-article-fill-cited-article)
1654     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1655     (gnus-treat-strip-cr gnus-article-remove-cr)
1656     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1657     (gnus-treat-date-ut gnus-article-date-ut)
1658     (gnus-treat-date-local gnus-article-date-local)
1659     (gnus-treat-date-english gnus-article-date-english)
1660     (gnus-treat-date-original gnus-article-date-original)
1661     (gnus-treat-date-user-defined gnus-article-date-user)
1662     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1663     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1664     (gnus-treat-display-x-face gnus-article-display-x-face)
1665     (gnus-treat-display-face gnus-article-display-face)
1666     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1667     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1668     (gnus-treat-hide-signature gnus-article-hide-signature)
1669     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1670     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1671     (gnus-treat-strip-pem gnus-article-hide-pem)
1672     (gnus-treat-from-picon gnus-treat-from-picon)
1673     (gnus-treat-mail-picon gnus-treat-mail-picon)
1674     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1675     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1676     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1677     (gnus-treat-strip-trailing-blank-lines
1678      gnus-article-remove-trailing-blank-lines)
1679     (gnus-treat-strip-leading-blank-lines
1680      gnus-article-strip-leading-blank-lines)
1681     (gnus-treat-strip-multiple-blank-lines
1682      gnus-article-strip-multiple-blank-lines)
1683     (gnus-treat-overstrike gnus-article-treat-overstrike)
1684     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1685     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1686     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1687     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1688     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1689     (gnus-treat-display-smileys gnus-treat-smiley)
1690     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1691     (gnus-treat-wash-html gnus-article-wash-html)
1692     (gnus-treat-emphasize gnus-article-emphasize)
1693     (gnus-treat-hide-citation gnus-article-hide-citation)
1694     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1695     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1696     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1697     (gnus-treat-play-sounds gnus-earcon-display)))
1698
1699 (defvar gnus-article-mime-handle-alist nil)
1700 (defvar article-lapsed-timer nil)
1701 (defvar gnus-article-current-summary nil)
1702
1703 (defvar gnus-article-mode-syntax-table
1704   (let ((table (copy-syntax-table text-mode-syntax-table)))
1705     ;; This causes the citation match run O(2^n).
1706     ;; (modify-syntax-entry ?- "w" table)
1707     (modify-syntax-entry ?> ")<" table)
1708     (modify-syntax-entry ?< "(>" table)
1709     ;; make M-. in article buffers work for `foo' strings
1710     (modify-syntax-entry ?' " " table)
1711     (modify-syntax-entry ?` " " table)
1712     table)
1713   "Syntax table used in article mode buffers.
1714 Initialized from `text-mode-syntax-table.")
1715
1716 (defvar gnus-save-article-buffer nil)
1717
1718 (defvar gnus-number-of-articles-to-be-saved nil)
1719
1720 (defvar gnus-inhibit-hiding nil)
1721
1722 (defvar gnus-article-edit-mode nil)
1723
1724 ;;; Macros for dealing with the article buffer.
1725
1726 (defmacro gnus-with-article-headers (&rest forms)
1727   `(with-current-buffer gnus-article-buffer
1728      (save-restriction
1729        (let ((inhibit-read-only t)
1730              (inhibit-point-motion-hooks t)
1731              (case-fold-search t))
1732          (article-narrow-to-head)
1733          ,@forms))))
1734
1735 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1736 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1737
1738 (defmacro gnus-with-article-buffer (&rest forms)
1739   `(with-current-buffer gnus-article-buffer
1740      (let ((inhibit-read-only t))
1741        ,@forms)))
1742
1743 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1744 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1745
1746 (defun gnus-article-goto-header (header)
1747   "Go to HEADER, which is a regular expression."
1748   (re-search-forward (concat "^\\(" header "\\):") nil t))
1749
1750 (defsubst gnus-article-hide-text (b e props)
1751   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1752   (gnus-add-text-properties-when 'article-type nil b e props)
1753   (when (memq 'intangible props)
1754     (put-text-property
1755      (max (1- b) (point-min))
1756      b 'intangible (cddr (memq 'intangible props)))))
1757
1758 (defsubst gnus-article-unhide-text (b e)
1759   "Remove hidden text properties from region between B and E."
1760   (remove-text-properties b e gnus-hidden-properties)
1761   (when (memq 'intangible gnus-hidden-properties)
1762     (put-text-property (max (1- b) (point-min))
1763                        b 'intangible nil)))
1764
1765 (defun gnus-article-hide-text-type (b e type)
1766   "Hide text of TYPE between B and E."
1767   (gnus-add-wash-type type)
1768   (gnus-article-hide-text
1769    b e (cons 'article-type (cons type gnus-hidden-properties))))
1770
1771 (defun gnus-article-unhide-text-type (b e type)
1772   "Unhide text of TYPE between B and E."
1773   (gnus-delete-wash-type type)
1774   (remove-text-properties
1775    b e (cons 'article-type (cons type gnus-hidden-properties)))
1776   (when (memq 'intangible gnus-hidden-properties)
1777     (put-text-property (max (1- b) (point-min))
1778                        b 'intangible nil)))
1779
1780 (defun gnus-article-hide-text-of-type (type)
1781   "Hide text of TYPE in the current buffer."
1782   (save-excursion
1783     (let ((b (point-min))
1784           (e (point-max)))
1785       (while (setq b (text-property-any b e 'article-type type))
1786         (add-text-properties b (incf b) gnus-hidden-properties)))))
1787
1788 (defun gnus-article-delete-text-of-type (type)
1789   "Delete text of TYPE in the current buffer."
1790   (save-excursion
1791     (let ((b (point-min)))
1792       (if (eq type 'multipart)
1793           ;; Remove MIME buttons associated with multipart/alternative parts.
1794           (progn
1795             (goto-char b)
1796             (while (if (get-text-property (point) 'gnus-part)
1797                        (setq b (point))
1798                      (when (setq b (next-single-property-change (point)
1799                                                                 'gnus-part))
1800                        (goto-char b)
1801                        t))
1802               (end-of-line)
1803               (skip-chars-forward "\n")
1804               (when (eq (get-text-property b 'article-type) 'multipart)
1805                 (delete-region b (point)))))
1806         (while (setq b (text-property-any b (point-max) 'article-type type))
1807           (delete-region
1808            b (or (text-property-not-all b (point-max) 'article-type type)
1809                  (point-max))))))))
1810
1811 (defun gnus-article-delete-invisible-text ()
1812   "Delete all invisible text in the current buffer."
1813   (save-excursion
1814     (let ((b (point-min)))
1815       (while (setq b (text-property-any b (point-max) 'invisible t))
1816         (delete-region
1817          b (or (text-property-not-all b (point-max) 'invisible t)
1818                (point-max)))))))
1819
1820 (defun gnus-article-text-type-exists-p (type)
1821   "Say whether any text of type TYPE exists in the buffer."
1822   (text-property-any (point-min) (point-max) 'article-type type))
1823
1824 (defsubst gnus-article-header-rank ()
1825   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1826   (let ((list gnus-sorted-header-list)
1827         (i 1))
1828     (while list
1829       (if (looking-at (car list))
1830           (setq list nil)
1831         (setq list (cdr list))
1832         (incf i)))
1833       i))
1834
1835 (defun article-hide-headers (&optional arg delete)
1836   "Hide unwanted headers and possibly sort them as well."
1837   (interactive)
1838   ;; This function might be inhibited.
1839   (unless gnus-inhibit-hiding
1840     (let ((inhibit-read-only t)
1841           (case-fold-search t)
1842           (max (1+ (length gnus-sorted-header-list)))
1843           (inhibit-point-motion-hooks t)
1844           (cur (current-buffer))
1845           ignored visible beg)
1846       (save-excursion
1847         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1848         ;; group parameters, so we should go to the summary buffer.
1849         (when (prog1
1850                   (condition-case nil
1851                       (progn (set-buffer gnus-summary-buffer) t)
1852                     (error nil))
1853                 (setq ignored (when (not gnus-visible-headers)
1854                                 (cond ((stringp gnus-ignored-headers)
1855                                        gnus-ignored-headers)
1856                                       ((listp gnus-ignored-headers)
1857                                        (mapconcat 'identity
1858                                                   gnus-ignored-headers
1859                                                   "\\|"))))
1860                       visible (cond ((stringp gnus-visible-headers)
1861                                      gnus-visible-headers)
1862                                     ((and gnus-visible-headers
1863                                           (listp gnus-visible-headers))
1864                                      (mapconcat 'identity
1865                                                 gnus-visible-headers
1866                                                 "\\|")))))
1867           (set-buffer cur))
1868         (save-restriction
1869           ;; First we narrow to just the headers.
1870           (article-narrow-to-head)
1871           ;; Hide any "From " lines at the beginning of (mail) articles.
1872           (while (looking-at "From ")
1873             (forward-line 1))
1874           (unless (bobp)
1875             (delete-region (point-min) (point)))
1876           ;; Then treat the rest of the header lines.
1877           ;; Then we use the two regular expressions
1878           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1879           ;; select which header lines is to remain visible in the
1880           ;; article buffer.
1881           (while (re-search-forward "^[^ \t:]*:" nil t)
1882             (beginning-of-line)
1883             ;; Mark the rank of the header.
1884             (put-text-property
1885              (point) (1+ (point)) 'message-rank
1886              (if (or (and visible (looking-at visible))
1887                      (and ignored
1888                           (not (looking-at ignored))))
1889                  (gnus-article-header-rank)
1890                (+ 2 max)))
1891             (forward-line 1))
1892           (message-sort-headers-1)
1893           (when (setq beg (text-property-any
1894                            (point-min) (point-max) 'message-rank (+ 2 max)))
1895             ;; We delete the unwanted headers.
1896             (gnus-add-wash-type 'headers)
1897             (add-text-properties (point-min) (+ 5 (point-min))
1898                                  '(article-type headers dummy-invisible t))
1899             (delete-region beg (point-max))))))))
1900
1901 (defun article-hide-boring-headers (&optional arg)
1902   "Toggle hiding of headers that aren't very interesting.
1903 If given a negative prefix, always show; if given a positive prefix,
1904 always hide."
1905   (interactive (gnus-article-hidden-arg))
1906   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1907              (not gnus-show-all-headers))
1908     (save-excursion
1909       (save-restriction
1910         (let ((inhibit-read-only t)
1911               (inhibit-point-motion-hooks t))
1912           (article-narrow-to-head)
1913           (dolist (elem gnus-boring-article-headers)
1914             (goto-char (point-min))
1915             (cond
1916              ;; Hide empty headers.
1917              ((eq elem 'empty)
1918               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1919                 (forward-line -1)
1920                 (gnus-article-hide-text-type
1921                  (point-at-bol)
1922                  (progn
1923                    (end-of-line)
1924                    (if (re-search-forward "^[^ \t]" nil t)
1925                        (match-beginning 0)
1926                      (point-max)))
1927                  'boring-headers)))
1928              ;; Hide boring Newsgroups header.
1929              ((eq elem 'newsgroups)
1930               (when (gnus-string-equal
1931                      (gnus-fetch-field "newsgroups")
1932                      (gnus-group-real-name
1933                       (if (boundp 'gnus-newsgroup-name)
1934                           gnus-newsgroup-name
1935                         "")))
1936                 (gnus-article-hide-header "newsgroups")))
1937              ((eq elem 'to-address)
1938               (let ((to (message-fetch-field "to"))
1939                     (to-address
1940                      (gnus-parameter-to-address
1941                       (if (boundp 'gnus-newsgroup-name)
1942                           gnus-newsgroup-name ""))))
1943                 (when (and to to-address
1944                            (ignore-errors
1945                              (gnus-string-equal
1946                               ;; only one address in To
1947                               (nth 1 (mail-extract-address-components to))
1948                               to-address)))
1949                   (gnus-article-hide-header "to"))))
1950              ((eq elem 'to-list)
1951               (let ((to (message-fetch-field "to"))
1952                     (to-list
1953                      (gnus-parameter-to-list
1954                       (if (boundp 'gnus-newsgroup-name)
1955                           gnus-newsgroup-name ""))))
1956                 (when (and to to-list
1957                            (ignore-errors
1958                              (gnus-string-equal
1959                               ;; only one address in To
1960                               (nth 1 (mail-extract-address-components to))
1961                               to-list)))
1962                   (gnus-article-hide-header "to"))))
1963              ((eq elem 'cc-list)
1964               (let ((cc (message-fetch-field "cc"))
1965                     (to-list
1966                      (gnus-parameter-to-list
1967                       (if (boundp 'gnus-newsgroup-name)
1968                           gnus-newsgroup-name ""))))
1969                 (when (and cc to-list
1970                            (ignore-errors
1971                              (gnus-string-equal
1972                               ;; only one address in CC
1973                               (nth 1 (mail-extract-address-components cc))
1974                               to-list)))
1975                   (gnus-article-hide-header "cc"))))
1976              ((eq elem 'followup-to)
1977               (when (gnus-string-equal
1978                      (message-fetch-field "followup-to")
1979                      (message-fetch-field "newsgroups"))
1980                 (gnus-article-hide-header "followup-to")))
1981              ((eq elem 'reply-to)
1982               (if (gnus-group-find-parameter
1983                    gnus-newsgroup-name 'broken-reply-to)
1984                   (gnus-article-hide-header "reply-to")
1985                 (let ((from (message-fetch-field "from"))
1986                       (reply-to (message-fetch-field "reply-to")))
1987                   (when
1988                       (and
1989                        from reply-to
1990                        (ignore-errors
1991                          (equal
1992                           (sort (mapcar
1993                                  (lambda (x) (downcase (cadr x)))
1994                                  (mail-extract-address-components from t))
1995                                 'string<)
1996                           (sort (mapcar
1997                                  (lambda (x) (downcase (cadr x)))
1998                                  (mail-extract-address-components reply-to t))
1999                                 'string<))))
2000                     (gnus-article-hide-header "reply-to")))))
2001              ((eq elem 'date)
2002               (let ((date (with-current-buffer gnus-original-article-buffer
2003                             ;; If date in `gnus-article-buffer' is localized
2004                             ;; (`gnus-treat-date-user-defined'),
2005                             ;; `days-between' might fail.
2006                             (message-fetch-field "date"))))
2007                 (when (and date
2008                            (< (days-between (current-time-string) date)
2009                               4))
2010                   (gnus-article-hide-header "date"))))
2011              ((eq elem 'long-to)
2012               (let ((to (message-fetch-field "to"))
2013                     (cc (message-fetch-field "cc")))
2014                 (when (> (length to) 1024)
2015                   (gnus-article-hide-header "to"))
2016                 (when (> (length cc) 1024)
2017                   (gnus-article-hide-header "cc"))))
2018              ((eq elem 'many-to)
2019               (let ((to-count 0)
2020                     (cc-count 0))
2021                 (goto-char (point-min))
2022                 (while (re-search-forward "^to:" nil t)
2023                   (setq to-count (1+ to-count)))
2024                 (when (> to-count 1)
2025                   (while (> to-count 0)
2026                     (goto-char (point-min))
2027                     (save-restriction
2028                       (re-search-forward "^to:" nil nil to-count)
2029                       (forward-line -1)
2030                       (narrow-to-region (point) (point-max))
2031                       (gnus-article-hide-header "to"))
2032                     (setq to-count (1- to-count))))
2033                 (goto-char (point-min))
2034                 (while (re-search-forward "^cc:" nil t)
2035                   (setq cc-count (1+ cc-count)))
2036                 (when (> cc-count 1)
2037                   (while (> cc-count 0)
2038                     (goto-char (point-min))
2039                     (save-restriction
2040                       (re-search-forward "^cc:" nil nil cc-count)
2041                       (forward-line -1)
2042                       (narrow-to-region (point) (point-max))
2043                       (gnus-article-hide-header "cc"))
2044                     (setq cc-count (1- cc-count)))))))))))))
2045
2046 (defun gnus-article-hide-header (header)
2047   (save-excursion
2048     (goto-char (point-min))
2049     (when (re-search-forward (concat "^" header ":") nil t)
2050       (gnus-article-hide-text-type
2051        (point-at-bol)
2052        (progn
2053          (end-of-line)
2054          (if (re-search-forward "^[^ \t]" nil t)
2055              (match-beginning 0)
2056            (point-max)))
2057        'boring-headers))))
2058
2059 (defvar gnus-article-normalized-header-length 40
2060   "Length of normalized headers.")
2061
2062 (defun article-normalize-headers ()
2063   "Make all header lines 40 characters long."
2064   (interactive)
2065   (let ((inhibit-read-only t)
2066         column)
2067     (save-excursion
2068       (save-restriction
2069         (article-narrow-to-head)
2070         (while (not (eobp))
2071           (cond
2072            ((< (setq column (- (point-at-eol) (point)))
2073                gnus-article-normalized-header-length)
2074             (end-of-line)
2075             (insert (make-string
2076                      (- gnus-article-normalized-header-length column)
2077                      ? )))
2078            ((> column gnus-article-normalized-header-length)
2079             (gnus-put-text-property
2080              (progn
2081                (forward-char gnus-article-normalized-header-length)
2082                (point))
2083              (point-at-eol)
2084              'invisible t))
2085            (t
2086             ;; Do nothing.
2087             ))
2088           (forward-line 1))))))
2089
2090 (defun article-treat-dumbquotes ()
2091   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2092 Note that this function guesses whether a character is a sm*rtq**t* or
2093 not, so it should only be used interactively.
2094
2095 Sm*rtq**t*s are M****s***'s unilateral extension to the
2096 iso-8859-1 character map in an attempt to provide more quoting
2097 characters.  If you see something like \\222 or \\264 where
2098 you're expecting some kind of apostrophe or quotation mark, then
2099 try this wash."
2100   (interactive)
2101   (article-translate-strings gnus-article-dumbquotes-map))
2102
2103 (defun article-translate-characters (from to)
2104   "Translate all characters in the body of the article according to FROM and TO.
2105 FROM is a string of characters to translate from; to is a string of
2106 characters to translate to."
2107   (save-excursion
2108     (when (article-goto-body)
2109       (let ((inhibit-read-only t)
2110             (x (make-string 225 ?x))
2111             (i -1))
2112         (while (< (incf i) (length x))
2113           (aset x i i))
2114         (setq i 0)
2115         (while (< i (length from))
2116           (aset x (aref from i) (aref to i))
2117           (incf i))
2118         (translate-region (point) (point-max) x)))))
2119
2120 (defun article-translate-strings (map)
2121   "Translate all string in the body of the article according to MAP.
2122 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2123   (save-excursion
2124     (when (article-goto-body)
2125       (let ((inhibit-read-only t))
2126         (dolist (elem map)
2127           (save-excursion
2128             (while (search-forward (car elem) nil t)
2129               (replace-match (cadr elem)))))))))
2130
2131 (defun article-treat-overstrike ()
2132   "Translate overstrikes into bold text."
2133   (interactive)
2134   (save-excursion
2135     (when (article-goto-body)
2136       (let ((inhibit-read-only t))
2137         (while (search-forward "\b" nil t)
2138           (let ((next (char-after))
2139                 (previous (char-after (- (point) 2))))
2140             ;; We do the boldification/underlining by hiding the
2141             ;; overstrikes and putting the proper text property
2142             ;; on the letters.
2143             (cond
2144              ((eq next previous)
2145               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2146               (put-text-property (point) (1+ (point)) 'face 'bold))
2147              ((eq next ?_)
2148               (gnus-article-hide-text-type
2149                (1- (point)) (1+ (point)) 'overstrike)
2150               (put-text-property
2151                (- (point) 2) (1- (point)) 'face 'underline))
2152              ((eq previous ?_)
2153               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2154               (put-text-property
2155                (point) (1+ (point)) 'face 'underline)))))))))
2156
2157 (defun article-treat-ansi-sequences ()
2158   "Translate ANSI SGR control sequences into overlays or extents."
2159   (interactive)
2160   (save-excursion
2161     (when (article-goto-body)
2162       (let ((inhibit-read-only t))
2163         (ansi-color-apply-on-region (point) (point-max))))))
2164
2165 (defun gnus-article-treat-unfold-headers ()
2166   "Unfold folded message headers.
2167 Only the headers that fit into the current window width will be
2168 unfolded."
2169   (interactive)
2170   (gnus-with-article-headers
2171     (let (length)
2172       (while (not (eobp))
2173         (save-restriction
2174           (mail-header-narrow-to-field)
2175           (let* ((header (buffer-string))
2176                  (unfoldable
2177                   (or (equal gnus-article-unfold-long-headers t)
2178                       (and (stringp gnus-article-unfold-long-headers)
2179                            (string-match gnus-article-unfold-long-headers header)))))
2180             (with-temp-buffer
2181               (insert header)
2182               (goto-char (point-min))
2183               (while (re-search-forward "\n[\t ]" nil t)
2184                 (replace-match " " t t)))
2185             (setq length (- (point-max) (point-min) 1))
2186             (when (or unfoldable
2187                       (< length (window-width)))
2188               (while (re-search-forward "\n[\t ]" nil t)
2189                 (replace-match " " t t))))
2190           (goto-char (point-max)))))))
2191
2192 (defun gnus-article-treat-fold-headers ()
2193   "Fold message headers."
2194   (interactive)
2195   (gnus-with-article-headers
2196     (while (not (eobp))
2197       (save-restriction
2198         (mail-header-narrow-to-field)
2199         (mail-header-fold-field)
2200         (goto-char (point-max))))))
2201
2202 (defun gnus-treat-smiley ()
2203   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2204   (interactive)
2205   (gnus-with-article-buffer
2206     (if (memq 'smiley gnus-article-wash-types)
2207         (gnus-delete-images 'smiley)
2208       (article-goto-body)
2209       (let ((images (smiley-region (point) (point-max))))
2210         (when images
2211           (gnus-add-wash-type 'smiley)
2212           (dolist (image images)
2213             (gnus-add-image 'smiley image)))))))
2214
2215 (defun gnus-article-remove-images ()
2216   "Remove all images from the article buffer."
2217   (interactive)
2218   (gnus-with-article-buffer
2219     (dolist (elem gnus-article-image-alist)
2220       (gnus-delete-images (car elem)))))
2221
2222 (defun gnus-article-treat-fold-newsgroups ()
2223   "Unfold folded message headers.
2224 Only the headers that fit into the current window width will be
2225 unfolded."
2226   (interactive)
2227   (gnus-with-article-headers
2228     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2229       (save-restriction
2230         (mail-header-narrow-to-field)
2231         (while (re-search-forward ", *" nil t)
2232           (replace-match ", " t t))
2233         (mail-header-fold-field)
2234         (goto-char (point-max))))))
2235
2236 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2237   "Value of `truncate-lines' in Gnus Article buffer.
2238 Valid values are nil, t, `head', `first', `last', an integer or a
2239 predicate.  See Info node `(gnus)Customizing Articles'."
2240   :version "23.1" ;; No Gnus
2241   :group 'gnus-article
2242   ;; :link '(custom-manual "(gnus)Customizing Articles")
2243   :type 'boolean)
2244
2245 (defun gnus-article-toggle-truncate-lines (&optional arg)
2246   "Toggle whether to fold or truncate long lines in article the buffer.
2247 If ARG is non-nil and not a number, toggle
2248 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2249 long lines if and only if arg is positive."
2250   (interactive "P")
2251   (cond
2252    ((and (numberp arg) (> arg 0))
2253     (setq gnus-article-truncate-lines t))
2254    ((numberp arg)
2255     (setq gnus-article-truncate-lines nil))
2256    (arg
2257     (setq gnus-article-truncate-lines
2258           (not gnus-article-truncate-lines))))
2259   (gnus-with-article-buffer
2260     (cond
2261      ((and (numberp arg) (> arg 0))
2262       (setq truncate-lines nil))
2263      ((numberp arg)
2264       (setq truncate-lines t)))
2265     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2266     ;; `toggle-truncate-lines' needs an argument.
2267     (toggle-truncate-lines)))
2268
2269 (defun gnus-article-treat-body-boundary ()
2270   "Place a boundary line at the end of the headers."
2271   (interactive)
2272   (when (and gnus-body-boundary-delimiter
2273              (> (length gnus-body-boundary-delimiter) 0))
2274     (gnus-with-article-headers
2275       (goto-char (point-max))
2276       (let ((start (point)))
2277         (insert "X-Boundary: ")
2278         (gnus-add-text-properties start (point) '(invisible t intangible t))
2279         (insert (let (str)
2280                   (while (>= (1- (window-width)) (length str))
2281                     (setq str (concat str gnus-body-boundary-delimiter)))
2282                   (substring str 0 (1- (window-width))))
2283                 "\n")
2284         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2285
2286 (defun article-fill-long-lines ()
2287   "Fill lines that are wider than the window width."
2288   (interactive)
2289   (save-excursion
2290     (let ((inhibit-read-only t)
2291           (width (window-width (get-buffer-window (current-buffer)))))
2292       (save-restriction
2293         (article-goto-body)
2294         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2295           (while (not (eobp))
2296             (end-of-line)
2297             (when (>= (current-column) (min fill-column width))
2298               (narrow-to-region (min (1+ (point)) (point-max))
2299                                 (point-at-bol))
2300               (let ((goback (point-marker)))
2301                 (fill-paragraph nil)
2302                 (goto-char (marker-position goback)))
2303               (widen))
2304             (forward-line 1)))))))
2305
2306 (defun article-capitalize-sentences ()
2307   "Capitalize the first word in each sentence."
2308   (interactive)
2309   (save-excursion
2310     (let ((inhibit-read-only t)
2311           (paragraph-start "^[\n\^L]"))
2312       (article-goto-body)
2313       (while (not (eobp))
2314         (capitalize-word 1)
2315         (forward-sentence)))))
2316
2317 (defun article-remove-cr ()
2318   "Remove trailing CRs and then translate remaining CRs into LFs."
2319   (interactive)
2320   (save-excursion
2321     (let ((inhibit-read-only t))
2322       (goto-char (point-min))
2323       (while (re-search-forward "\r+$" nil t)
2324         (replace-match "" t t))
2325       (goto-char (point-min))
2326       (while (search-forward "\r" nil t)
2327         (replace-match "\n" t t)))))
2328
2329 (defun article-remove-trailing-blank-lines ()
2330   "Remove all trailing blank lines from the article."
2331   (interactive)
2332   (save-excursion
2333     (let ((inhibit-read-only t))
2334       (goto-char (point-max))
2335       (delete-region
2336        (point)
2337        (progn
2338          (while (and (not (bobp))
2339                      (looking-at "^[ \t]*$")
2340                      (not (gnus-annotation-in-region-p
2341                            (point) (point-at-eol))))
2342            (forward-line -1))
2343          (forward-line 1)
2344          (point))))))
2345
2346 (defvar gnus-face-properties-alist)
2347
2348 (defun article-display-face (&optional force)
2349   "Display any Face headers in the header."
2350   (interactive (list 'force))
2351   (let ((wash-face-p buffer-read-only))
2352     (gnus-with-article-headers
2353       ;; When displaying parts, this function can be called several times on
2354       ;; the same article, without any intended toggle semantic (as typing `W
2355       ;; D d' would have). So face deletion must occur only when we come from
2356       ;; an interactive command, that is when the *Article* buffer is
2357       ;; read-only.
2358       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2359           (gnus-delete-images 'face)
2360         (let ((from (message-fetch-field "from"))
2361               face faces)
2362           (save-current-buffer
2363             (when (and wash-face-p
2364                        (gnus-buffer-live-p gnus-original-article-buffer)
2365                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2366               (set-buffer gnus-original-article-buffer))
2367             (save-restriction
2368               (mail-narrow-to-head)
2369               (when (or force
2370                         ;; Check whether this face is censored.
2371                         (not (and gnus-article-x-face-too-ugly
2372                                   (or from
2373                                       (setq from (message-fetch-field "from")))
2374                                   (string-match gnus-article-x-face-too-ugly
2375                                                 from))))
2376                 (while (gnus-article-goto-header "Face")
2377                   (push (mail-header-field-value) faces)))))
2378           (when faces
2379             (goto-char (point-min))
2380             (let (png image)
2381               (unless (setq from (gnus-article-goto-header "from"))
2382                 (insert "From:")
2383                 (setq from (point))
2384                 (insert " [no `from' set]\n"))
2385               (while faces
2386                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2387                   (setq image
2388                         (apply 'gnus-create-image png 'png t
2389                                (cdr (assq 'png gnus-face-properties-alist))))
2390                   (goto-char from)
2391                   (gnus-add-wash-type 'face)
2392                   (gnus-add-image 'face image)
2393                   (gnus-put-image image nil 'face))))))))))
2394
2395 (defun article-display-x-face (&optional force)
2396   "Look for an X-Face header and display it if present."
2397   (interactive (list 'force))
2398   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2399     (gnus-with-article-headers
2400       ;; Delete the old process, if any.
2401       (when (process-status "article-x-face")
2402         (delete-process "article-x-face"))
2403       ;; See the comment in `article-display-face'.
2404       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2405           ;; We have already displayed X-Faces, so we remove them
2406           ;; instead.
2407           (gnus-delete-images 'xface)
2408         ;; Display X-Faces.
2409         (let ((from (message-fetch-field "from"))
2410               x-faces face)
2411           (save-current-buffer
2412             (when (and wash-face-p
2413                        (gnus-buffer-live-p gnus-original-article-buffer)
2414                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2415               ;; If type `W f', use gnus-original-article-buffer,
2416               ;; otherwise use the current buffer because displaying
2417               ;; RFC822 parts calls this function too.
2418               (set-buffer gnus-original-article-buffer))
2419             (save-restriction
2420               (mail-narrow-to-head)
2421               (and gnus-article-x-face-command
2422                    (or force
2423                        ;; Check whether this face is censored.
2424                        (not (and gnus-article-x-face-too-ugly
2425                                  (or from
2426                                      (setq from (message-fetch-field "from")))
2427                                  (string-match gnus-article-x-face-too-ugly
2428                                                from))))
2429                    (while (gnus-article-goto-header "X-Face")
2430                      (push (mail-header-field-value) x-faces)))))
2431           (when x-faces
2432             ;; We display the face.
2433             (cond ((functionp gnus-article-x-face-command)
2434                    ;; The command is a lisp function, so we call it.
2435                    (mapc gnus-article-x-face-command x-faces))
2436                   ((stringp gnus-article-x-face-command)
2437                    ;; The command is a string, so we interpret the command
2438                    ;; as a, well, command, and fork it off.
2439                    (let ((process-connection-type nil))
2440                      (gnus-set-process-query-on-exit-flag
2441                       (start-process
2442                        "article-x-face" nil shell-file-name
2443                        shell-command-switch gnus-article-x-face-command)
2444                       nil)
2445                      ;; Sending multiple EOFs to xv doesn't work,
2446                      ;; so we only do a single external face.
2447                      (with-temp-buffer
2448                        (insert (car x-faces))
2449                        (process-send-region "article-x-face"
2450                                             (point-min) (point-max)))
2451                      (process-send-eof "article-x-face")))
2452                   (t
2453                    (error "`%s' set to `%s' is not a function"
2454                           gnus-article-x-face-command
2455                           'gnus-article-x-face-command)))))))))
2456
2457 (defun article-decode-mime-words ()
2458   "Decode all MIME-encoded words in the article."
2459   (interactive)
2460   (gnus-with-article-buffer
2461     (let ((inhibit-point-motion-hooks t)
2462           (mail-parse-charset gnus-newsgroup-charset)
2463           (mail-parse-ignored-charsets
2464            (with-current-buffer gnus-summary-buffer
2465              gnus-newsgroup-ignored-charsets)))
2466       (mail-decode-encoded-word-region (point-min) (point-max)))))
2467
2468 (defun article-decode-charset (&optional prompt)
2469   "Decode charset-encoded text in the article.
2470 If PROMPT (the prefix), prompt for a coding system to use."
2471   (interactive "P")
2472   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2473         (inhibit-read-only t)
2474         (mail-parse-charset gnus-newsgroup-charset)
2475         (mail-parse-ignored-charsets
2476          (save-excursion (condition-case nil
2477                              (set-buffer gnus-summary-buffer)
2478                            (error))
2479                          gnus-newsgroup-ignored-charsets))
2480         ct cte ctl charset format)
2481     (save-excursion
2482       (save-restriction
2483         (article-narrow-to-head)
2484         (setq ct (message-fetch-field "Content-Type" t)
2485               cte (message-fetch-field "Content-Transfer-Encoding" t)
2486               ctl (and ct (mail-header-parse-content-type ct))
2487               charset (cond
2488                        (prompt
2489                         (mm-read-coding-system "Charset to decode: "))
2490                        (ctl
2491                         (mail-content-type-get ctl 'charset)))
2492               format (and ctl (mail-content-type-get ctl 'format)))
2493         (when cte
2494           (setq cte (mail-header-strip cte)))
2495         (if (and ctl (not (string-match "/" (car ctl))))
2496             (setq ctl nil))
2497         (goto-char (point-max)))
2498       (forward-line 1)
2499       (save-restriction
2500         (narrow-to-region (point) (point-max))
2501         (when (and (eq mail-parse-charset 'gnus-decoded)
2502                    (eq (mm-body-7-or-8) '8bit))
2503           ;; The text code could have been decoded.
2504           (setq charset mail-parse-charset))
2505         (when (and (or (not ctl)
2506                        (equal (car ctl) "text/plain"))
2507                    (not format)) ;; article with format will decode later.
2508           (mm-decode-body
2509            charset (and cte (intern (downcase
2510                                      (gnus-strip-whitespace cte))))
2511            (car ctl)))))))
2512
2513 (defun article-decode-encoded-words ()
2514   "Remove encoded-word encoding from headers."
2515   (let ((inhibit-point-motion-hooks t)
2516         (mail-parse-charset gnus-newsgroup-charset)
2517         (mail-parse-ignored-charsets
2518          (save-excursion (condition-case nil
2519                              (set-buffer gnus-summary-buffer)
2520                            (error))
2521                          gnus-newsgroup-ignored-charsets))
2522         (inhibit-read-only t)
2523         end start)
2524     (goto-char (point-min))
2525     (when (search-forward "\n\n" nil 'move)
2526       (forward-line -1))
2527     (setq end (point))
2528     (while (not (bobp))
2529       (while (progn
2530                (forward-line -1)
2531                (and (not (bobp))
2532                     (memq (char-after) '(?\t ? )))))
2533       (setq start (point))
2534       (if (looking-at "\
2535 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2536 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2537           (funcall gnus-decode-address-function start end)
2538         (funcall gnus-decode-header-function start end))
2539       (goto-char (setq end start)))))
2540
2541 (defun article-decode-group-name ()
2542   "Decode group names in Newsgroups, Followup-To and Xref headers."
2543   (let ((inhibit-point-motion-hooks t)
2544         (inhibit-read-only t)
2545         (method (gnus-find-method-for-group gnus-newsgroup-name))
2546         regexp)
2547     (when (and (or gnus-group-name-charset-method-alist
2548                    gnus-group-name-charset-group-alist)
2549                (gnus-buffer-live-p gnus-original-article-buffer))
2550       (save-restriction
2551         (article-narrow-to-head)
2552         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2553           (with-current-buffer gnus-original-article-buffer
2554             (goto-char (point-min)))
2555           (setq regexp (concat "^" header
2556                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2557           (while (re-search-forward regexp nil t)
2558             (replace-match (save-match-data
2559                              (gnus-decode-newsgroups
2560                               ;; XXX how to use data in article buffer?
2561                               (with-current-buffer gnus-original-article-buffer
2562                                 (re-search-forward regexp nil t)
2563                                 (match-string 1))
2564                               gnus-newsgroup-name method))
2565                            t t nil 1))
2566           (goto-char (point-min)))))))
2567
2568 (autoload 'idna-to-unicode "idna")
2569
2570 (defun article-decode-idna-rhs ()
2571   "Decode IDNA strings in RHS in various headers in current buffer.
2572 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2573 Mail-Reply-To: and Mail-Followup-To:."
2574   (when gnus-use-idna
2575     (save-restriction
2576       (let ((inhibit-point-motion-hooks t)
2577             (inhibit-read-only t))
2578         (article-narrow-to-head)
2579         (goto-char (point-min))
2580         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2581           (let (ace unicode)
2582             (when (save-match-data
2583                     (and (setq ace (match-string 1))
2584                          (save-excursion
2585                            (and (re-search-backward "^[^ \t]" nil t)
2586                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2587                          (setq unicode (idna-to-unicode ace))))
2588               (unless (string= ace unicode)
2589                 (replace-match unicode nil nil nil 1)))))))))
2590
2591 (defun article-de-quoted-unreadable (&optional force read-charset)
2592   "Translate a quoted-printable-encoded article.
2593 If FORCE, decode the article whether it is marked as quoted-printable
2594 or not.
2595 If READ-CHARSET, ask for a coding system."
2596   (interactive (list 'force current-prefix-arg))
2597   (save-excursion
2598     (let ((inhibit-read-only t) type charset)
2599       (if (gnus-buffer-live-p gnus-original-article-buffer)
2600           (with-current-buffer gnus-original-article-buffer
2601             (setq type
2602                   (gnus-fetch-field "content-transfer-encoding"))
2603             (let* ((ct (gnus-fetch-field "content-type"))
2604                    (ctl (and ct (mail-header-parse-content-type ct))))
2605               (setq charset (and ctl
2606                                  (mail-content-type-get ctl 'charset)))
2607               (if (stringp charset)
2608                   (setq charset (intern (downcase charset)))))))
2609       (if read-charset
2610           (setq charset (mm-read-coding-system "Charset: " charset)))
2611       (unless charset
2612         (setq charset gnus-newsgroup-charset))
2613       (when (or force
2614                 (and type (let ((case-fold-search t))
2615                             (string-match "quoted-printable" type))))
2616         (article-goto-body)
2617         (quoted-printable-decode-region
2618          (point) (point-max) (mm-charset-to-coding-system charset))))))
2619
2620 (defun article-de-base64-unreadable (&optional force read-charset)
2621   "Translate a base64 article.
2622 If FORCE, decode the article whether it is marked as base64 not.
2623 If READ-CHARSET, ask for a coding system."
2624   (interactive (list 'force current-prefix-arg))
2625   (save-excursion
2626     (let ((inhibit-read-only t) type charset)
2627       (if (gnus-buffer-live-p gnus-original-article-buffer)
2628           (with-current-buffer gnus-original-article-buffer
2629             (setq type
2630                   (gnus-fetch-field "content-transfer-encoding"))
2631             (let* ((ct (gnus-fetch-field "content-type"))
2632                    (ctl (and ct (mail-header-parse-content-type ct))))
2633               (setq charset (and ctl
2634                                  (mail-content-type-get ctl 'charset)))
2635               (if (stringp charset)
2636                   (setq charset (intern (downcase charset)))))))
2637       (if read-charset
2638           (setq charset (mm-read-coding-system "Charset: " charset)))
2639       (unless charset
2640         (setq charset gnus-newsgroup-charset))
2641       (when (or force
2642                 (and type (let ((case-fold-search t))
2643                             (string-match "base64" type))))
2644         (article-goto-body)
2645         (save-restriction
2646           (narrow-to-region (point) (point-max))
2647           (base64-decode-region (point-min) (point-max))
2648           (mm-decode-coding-region
2649            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2650
2651 (eval-when-compile
2652   (require 'rfc1843))
2653
2654 (defun article-decode-HZ ()
2655   "Translate a HZ-encoded article."
2656   (interactive)
2657   (require 'rfc1843)
2658   (save-excursion
2659     (let ((inhibit-read-only t))
2660       (rfc1843-decode-region (point-min) (point-max)))))
2661
2662 (defun article-unsplit-urls ()
2663   "Remove the newlines that some other mailers insert into URLs."
2664   (interactive)
2665   (save-excursion
2666     (let ((inhibit-read-only t))
2667       (goto-char (point-min))
2668       (while (re-search-forward
2669               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2670         (replace-match "\\1\\3" t)))
2671     (when (interactive-p)
2672       (gnus-treat-article nil))))
2673
2674
2675 (defun article-wash-html (&optional read-charset)
2676   "Format an HTML article.
2677 If READ-CHARSET, ask for a coding system.  If it is a number, the
2678 charset defined in `gnus-summary-show-article-charset-alist' is used."
2679   (interactive "P")
2680   (save-excursion
2681     (let ((inhibit-read-only t)
2682           charset)
2683       (if read-charset
2684           (if (or (and (numberp read-charset)
2685                        (setq charset
2686                              (cdr
2687                               (assq read-charset
2688                                     gnus-summary-show-article-charset-alist))))
2689                   (setq charset (mm-read-coding-system "Charset: ")))
2690               (let ((gnus-summary-show-article-charset-alist
2691                      (list (cons 1 charset))))
2692                 (with-current-buffer gnus-summary-buffer
2693                   (gnus-summary-show-article 1)))
2694             (error "No charset is given"))
2695         (when (gnus-buffer-live-p gnus-original-article-buffer)
2696           (with-current-buffer gnus-original-article-buffer
2697             (let* ((ct (gnus-fetch-field "content-type"))
2698                    (ctl (and ct (mail-header-parse-content-type ct))))
2699               (setq charset (and ctl
2700                                  (mail-content-type-get ctl 'charset)))
2701               (when (stringp charset)
2702                 (setq charset (intern (downcase charset)))))))
2703         (unless charset
2704           (setq charset gnus-newsgroup-charset)))
2705       (article-goto-body)
2706       (save-window-excursion
2707         (save-restriction
2708           (narrow-to-region (point) (point-max))
2709           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2710                  (entry (assq func mm-text-html-washer-alist)))
2711             (when entry
2712               (setq func (cdr entry)))
2713             (cond
2714              ((functionp func)
2715               (funcall func))
2716              (t
2717               (apply (car func) (cdr func))))))))))
2718
2719 ;; External.
2720 (declare-function w3-region "ext:w3-display" (st nd))
2721
2722 (defun gnus-article-wash-html-with-w3 ()
2723   "Wash the current buffer with w3."
2724   (mm-setup-w3)
2725   (let ((w3-strict-width (window-width))
2726         (url-standalone-mode t)
2727         (url-gateway-unplugged t)
2728         (w3-honor-stylesheets nil))
2729     (condition-case ()
2730         (w3-region (point-min) (point-max))
2731       (error))))
2732
2733 ;; External.
2734 (declare-function w3m-region "ext:w3m" (start end &optional url charset))
2735
2736 (defun gnus-article-wash-html-with-w3m ()
2737   "Wash the current buffer with emacs-w3m."
2738   (mm-setup-w3m)
2739   (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2740         w3m-force-redisplay)
2741     (w3m-region (point-min) (point-max)))
2742   ;; Put the mark meaning this part was rendered by emacs-w3m.
2743   (put-text-property (point-min) (point-max) 'mm-inline-text-html-with-w3m t)
2744   (when (and mm-inline-text-html-with-w3m-keymap
2745              (boundp 'w3m-minor-mode-map)
2746              w3m-minor-mode-map)
2747     (if (and (boundp 'w3m-link-map)
2748              w3m-link-map)
2749         (let* ((start (point-min))
2750                (end (point-max))
2751                (on (get-text-property start 'w3m-href-anchor))
2752                (map (copy-keymap w3m-link-map))
2753                next)
2754           (set-keymap-parent map w3m-minor-mode-map)
2755           (while (< start end)
2756             (if on
2757                 (progn
2758                   (setq next (or (text-property-any start end
2759                                                     'w3m-href-anchor nil)
2760                                  end))
2761                   (put-text-property start next 'keymap map))
2762               (setq next (or (text-property-not-all start end
2763                                                     'w3m-href-anchor nil)
2764                              end))
2765               (put-text-property start next 'keymap w3m-minor-mode-map))
2766             (setq start next
2767                   on (not on))))
2768       (put-text-property (point-min) (point-max) 'keymap w3m-minor-mode-map))))
2769
2770 (defvar charset) ;; Bound by `article-wash-html'.
2771
2772 (defun gnus-article-wash-html-with-w3m-standalone ()
2773   "Wash the current buffer with w3m."
2774   (if (mm-w3m-standalone-supports-m17n-p)
2775       (progn
2776         (unless (mm-coding-system-p charset) ;; Bound by `article-wash-html'.
2777           ;; The default.
2778           (setq charset 'iso-8859-1))
2779         (let ((coding-system-for-write charset)
2780               (coding-system-for-read charset))
2781           (call-process-region
2782            (point-min) (point-max)
2783            "w3m" t t nil "-dump" "-T" "text/html"
2784            "-I" (symbol-name charset) "-O" (symbol-name charset))))
2785     (mm-inline-wash-with-stdin nil "w3m" "-dump" "-T" "text/html")))
2786
2787 (defvar gnus-article-browse-html-temp-list nil
2788   "List of temporary files created by `gnus-article-browse-html-parts'.
2789 Internal variable.")
2790
2791 (defcustom gnus-article-browse-delete-temp 'ask
2792   "What to do with temporary files from `gnus-article-browse-html-parts'.
2793 If nil, don't delete temporary files.  If it is t, delete them on
2794 exit from the summary buffer.  If it is the symbol `file', query
2795 on each file, if it is `ask' ask once when exiting from the
2796 summary buffer."
2797   :group 'gnus-article
2798   :version "23.1" ;; No Gnus
2799   :type '(choice (const :tag "Don't delete" nil)
2800                  (const :tag "Don't ask" t)
2801                  (const :tag "Ask" ask)
2802                  (const :tag "Ask for each file" file)))
2803
2804 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2805
2806 (defun gnus-article-browse-delete-temp-files (&optional how)
2807   "Delete temp-files created by `gnus-article-browse-html-parts'."
2808   (when (and gnus-article-browse-html-temp-list
2809              (progn
2810                (or how (setq how gnus-article-browse-delete-temp))
2811                (if (eq how 'ask)
2812                    (let ((files (length gnus-article-browse-html-temp-list)))
2813                      (gnus-y-or-n-p (format
2814                                      "Delete all %s temporary HTML file%s? "
2815                                      files
2816                                      (if (> files 1) "s" ""))))
2817                  how)))
2818     (dolist (file gnus-article-browse-html-temp-list)
2819       (cond ((file-directory-p file)
2820              (when (or (not (eq how 'file))
2821                        (gnus-y-or-n-p
2822                         (format
2823                          "Delete temporary HTML file(s) in directory `%s'? "
2824                          (file-name-as-directory file))))
2825                (gnus-delete-directory file)))
2826             ((file-exists-p file)
2827              (when (or (not (eq how 'file))
2828                        (gnus-y-or-n-p
2829                         (format "Delete temporary HTML file `%s'? " file)))
2830                (delete-file file)))))
2831     ;; Also remove file from the list when not deleted or if file doesn't
2832     ;; exist anymore.
2833     (setq gnus-article-browse-html-temp-list nil))
2834   gnus-article-browse-html-temp-list)
2835
2836 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2837   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2838 Return file name."
2839   (save-match-data
2840     (let (file type)
2841       (catch 'found
2842         (dolist (handle handles)
2843           (cond
2844            ((not (listp handle)))
2845            ((equal (mm-handle-media-supertype handle) "multipart")
2846             (when (setq file (gnus-article-browse-html-save-cid-content
2847                               cid handle directory))
2848               (throw 'found file)))
2849            ((equal (concat "<" cid ">") (mm-handle-id handle))
2850             (setq file
2851                   (expand-file-name
2852                    (or (mail-content-type-get
2853                         (mm-handle-disposition handle) 'filename)
2854                        (mail-content-type-get
2855                         (setq type (mm-handle-type handle)) 'name)
2856                        (concat
2857                         (make-temp-name "cid")
2858                         (car (rassoc (car type) mailcap-mime-extensions))))
2859                    directory))
2860             (mm-save-part-to-file handle file)
2861             (throw 'found file))))))))
2862
2863 (defun gnus-article-browse-html-parts (list &optional header)
2864   "View all \"text/html\" parts from LIST.
2865 Recurse into multiparts.  The optional HEADER that should be a decoded
2866 message header will be added to the bodies of the \"text/html\" parts."
2867   ;; Internal function used by `gnus-article-browse-html-article'.
2868   (let (type file charset content cid-dir tmp-file showed)
2869     ;; Find and show the html-parts.
2870     (dolist (handle list)
2871       ;; If HTML, show it:
2872       (cond ((not (listp handle)))
2873             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2874                  (and (equal (car type) "message/external-body")
2875                       (or header
2876                           (setq file (or (mail-content-type-get type 'name)
2877                                          (mail-content-type-get
2878                                           (mm-handle-disposition handle)
2879                                           'filename))))
2880                       (or (mm-handle-cache handle)
2881                           (condition-case code
2882                               (progn (mm-extern-cache-contents handle) t)
2883                             (error
2884                              (gnus-message 3 "%s" (error-message-string code))
2885                              (when (>= gnus-verbose 3) (sit-for 2))
2886                              nil)))
2887                       (progn
2888                         (setq handle (mm-handle-cache handle)
2889                               type (mm-handle-type handle))
2890                         (equal (car type) "text/html"))))
2891              (setq charset (mail-content-type-get type 'charset)
2892                    content (mm-get-part handle))
2893              (with-temp-buffer
2894                (if (eq charset 'gnus-decoded)
2895                    (mm-enable-multibyte)
2896                  (mm-disable-multibyte))
2897                (insert content)
2898                ;; resolve cid contents
2899                (let ((case-fold-search t)
2900                      cid-file)
2901                  (goto-char (point-min))
2902                  (while (re-search-forward "\
2903 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2904                                            nil t)
2905                    (unless cid-dir
2906                      (setq cid-dir (mm-make-temp-file "cid" t))
2907                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2908                    (setq file nil
2909                          content nil)
2910                    (when (setq cid-file
2911                                (gnus-article-browse-html-save-cid-content
2912                                 (match-string 2)
2913                                 (with-current-buffer gnus-article-buffer
2914                                   gnus-article-mime-handles)
2915                                 cid-dir))
2916                      (replace-match (concat "file://" cid-file)
2917                                     nil nil nil 1))))
2918                (unless content (setq content (buffer-string))))
2919              (when (or charset header (not file))
2920                (setq tmp-file (mm-make-temp-file
2921                                ;; Do we need to care for 8.3 filenames?
2922                                "mm-" nil ".html")))
2923              ;; Add a meta html tag to specify charset and a header.
2924              (cond
2925               (header
2926                (let (title eheader body hcharset coding force-charset)
2927                  (with-temp-buffer
2928                    (mm-enable-multibyte)
2929                    (setq case-fold-search t)
2930                    (insert header "\n")
2931                    (setq title (message-fetch-field "subject"))
2932                    (goto-char (point-min))
2933                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2934                      (replace-match (cond ((match-beginning 1) "&lt;")
2935                                           ((match-beginning 2) "&gt;")
2936                                           (t "&amp;"))))
2937                    (goto-char (point-min))
2938                    (insert "<pre>\n")
2939                    (goto-char (point-max))
2940                    (insert "</pre>\n<hr>\n")
2941                    ;; We have to examine charset one by one since
2942                    ;; charset specified in parts might be different.
2943                    (if (eq charset 'gnus-decoded)
2944                        (setq charset 'utf-8
2945                              eheader (mm-encode-coding-string (buffer-string)
2946                                                               charset)
2947                              title (when title
2948                                      (mm-encode-coding-string title charset))
2949                              body (mm-encode-coding-string content charset)
2950                              force-charset t)
2951                      (setq hcharset (mm-find-mime-charset-region (point-min)
2952                                                                  (point-max)))
2953                      (cond ((= (length hcharset) 1)
2954                             (setq hcharset (car hcharset)
2955                                   coding (mm-charset-to-coding-system
2956                                           hcharset)))
2957                            ((> (length hcharset) 1)
2958                             (setq hcharset 'utf-8
2959                                   coding hcharset)))
2960                      (if coding
2961                          (if charset
2962                              (progn
2963                                (setq body
2964                                      (mm-charset-to-coding-system charset))
2965                                (if (eq coding body)
2966                                    (setq eheader (mm-encode-coding-string
2967                                                   (buffer-string) coding)
2968                                          title (when title
2969                                                  (mm-encode-coding-string
2970                                                   title coding))
2971                                          body content)
2972                                  (setq charset 'utf-8
2973                                        eheader (mm-encode-coding-string
2974                                                 (buffer-string) charset)
2975                                        title (when title
2976                                                (mm-encode-coding-string
2977                                                 title charset))
2978                                        body (mm-encode-coding-string
2979                                              (mm-decode-coding-string
2980                                               content body)
2981                                              charset)
2982                                        force-charset t)))
2983                            (setq charset hcharset
2984                                  eheader (mm-encode-coding-string
2985                                           (buffer-string) coding)
2986                                  title (when title
2987                                          (mm-encode-coding-string
2988                                           title coding))
2989                                  body content))
2990                        (setq eheader (mm-string-as-unibyte (buffer-string))
2991                              body content)))
2992                    (erase-buffer)
2993                    (mm-disable-multibyte)
2994                    (insert body)
2995                    (when charset
2996                      (mm-add-meta-html-tag handle charset force-charset))
2997                    (when title
2998                      (goto-char (point-min))
2999                      (unless (search-forward "<title>" nil t)
3000                        (re-search-forward "<head>\\s-*" nil t)
3001                        (insert "<title>" title "</title>\n")))
3002                    (goto-char (point-min))
3003                    (or (re-search-forward
3004                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
3005                        (re-search-forward
3006                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
3007                    (insert eheader)
3008                    (mm-write-region (point-min) (point-max)
3009                                     tmp-file nil nil nil 'binary t))))
3010               (charset
3011                (mm-with-unibyte-buffer
3012                  (insert (if (eq charset 'gnus-decoded)
3013                              (mm-encode-coding-string content
3014                                                       (setq charset 'utf-8))
3015                            content))
3016                  (if (or (mm-add-meta-html-tag handle charset)
3017                          (not file))
3018                      (mm-write-region (point-min) (point-max)
3019                                       tmp-file nil nil nil 'binary t)
3020                    (setq tmp-file nil))))
3021               (tmp-file
3022                (mm-save-part-to-file handle tmp-file)))
3023              (when tmp-file
3024                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
3025              (add-hook 'gnus-summary-prepare-exit-hook
3026                        'gnus-article-browse-delete-temp-files)
3027              (add-hook 'gnus-exit-gnus-hook
3028                        (lambda  ()
3029                          (gnus-article-browse-delete-temp-files t)))
3030              ;; FIXME: Warn if there's an <img> tag?
3031              (browse-url-of-file (or tmp-file (expand-file-name file)))
3032              (setq showed t))
3033             ;; If multipart, recurse
3034             ((equal (mm-handle-media-supertype handle) "multipart")
3035              (when (gnus-article-browse-html-parts handle header)
3036                (setq showed t)))
3037             ((equal (mm-handle-media-type handle) "message/rfc822")
3038              (mm-with-multibyte-buffer
3039                (mm-insert-part handle)
3040                (setq handle (mm-dissect-buffer t t))
3041                (when (and (bufferp (car handle))
3042                           (stringp (car (mm-handle-type handle))))
3043                  (setq handle (list handle)))
3044                (when header
3045                  (article-decode-encoded-words)
3046                  (let ((gnus-visible-headers
3047                         (or (get 'gnus-visible-headers 'standard-value)
3048                             gnus-visible-headers)))
3049                    (article-hide-headers))
3050                  (goto-char (point-min))
3051                  (search-forward "\n\n" nil 'move)
3052                  (skip-chars-backward "\t\n ")
3053                  (setq header (buffer-substring (point-min) (point)))))
3054              (when (prog1
3055                        (gnus-article-browse-html-parts handle header)
3056                      (mm-destroy-parts handle))
3057                (setq showed t)))))
3058     showed))
3059
3060 (defun gnus-article-browse-html-article (&optional arg)
3061   "View \"text/html\" parts of the current article with a WWW browser.
3062 Inline images embedded in a message using the cid scheme, as they are
3063 generally considered to be safe, will be processed properly.
3064 The message header is added to the beginning of every html part unless
3065 the prefix argument ARG is given.
3066
3067 Warning: Spammers use links to images (using the http scheme) in HTML
3068 articles to verify whether you have read the message.  As
3069 `gnus-article-browse-html-article' passes the HTML content to the
3070 browser without eliminating these \"web bugs\" you should only
3071 use it for mails from trusted senders.
3072
3073 If you always want to display HTML parts in the browser, set
3074 `mm-text-html-renderer' to nil.
3075
3076 This command creates temporary files to pass HTML contents including
3077 images if any to the browser, and deletes them when exiting the group
3078 \(if you want)."
3079   ;; Cf. `mm-w3m-safe-url-regexp'
3080   (interactive "P")
3081   (if arg
3082       (gnus-summary-show-article)
3083     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3084                                     gnus-visible-headers))
3085           ;; As we insert a <hr>, there's no need for the body boundary.
3086           (gnus-treat-body-boundary nil))
3087       (gnus-summary-show-article)))
3088   (with-current-buffer gnus-article-buffer
3089     (let ((header (unless arg
3090                     (save-restriction
3091                       (widen)
3092                       (buffer-substring-no-properties
3093                        (goto-char (point-min))
3094                        (if (search-forward "\n\n" nil t)
3095                            (match-beginning 0)
3096                          (goto-char (point-max))
3097                          (skip-chars-backward "\t\n ")
3098                          (point))))))
3099           parts)
3100       (set-buffer gnus-original-article-buffer)
3101       (setq parts (mm-dissect-buffer t t))
3102       ;; If singlepart, enforce a list.
3103       (when (and (bufferp (car parts))
3104                  (stringp (car (mm-handle-type parts))))
3105         (setq parts (list parts)))
3106       ;; Process the list
3107       (unless (gnus-article-browse-html-parts parts header)
3108         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3109       (mm-destroy-parts parts)
3110       (unless arg
3111         (gnus-summary-show-article)))))
3112
3113 (defun article-hide-list-identifiers ()
3114   "Remove list identifies from the Subject header.
3115 The `gnus-list-identifiers' variable specifies what to do."
3116   (interactive)
3117   (let ((inhibit-point-motion-hooks t)
3118         (regexp (if (consp gnus-list-identifiers)
3119                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3120                   gnus-list-identifiers))
3121         (inhibit-read-only t))
3122     (when regexp
3123       (save-excursion
3124         (save-restriction
3125           (article-narrow-to-head)
3126           (goto-char (point-min))
3127           (while (re-search-forward
3128                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3129                   nil t)
3130             (delete-region (match-beginning 2) (match-end 0))
3131             (beginning-of-line))
3132           (when (re-search-forward
3133                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3134             (delete-region (match-beginning 1) (match-end 1))))))))
3135
3136 (defun article-hide-pem (&optional arg)
3137   "Toggle hiding of any PEM headers and signatures in the current article.
3138 If given a negative prefix, always show; if given a positive prefix,
3139 always hide."
3140   (interactive (gnus-article-hidden-arg))
3141   (unless (gnus-article-check-hidden-text 'pem arg)
3142     (save-excursion
3143       (let ((inhibit-read-only t) end)
3144         (goto-char (point-min))
3145         ;; Hide the horrendously ugly "header".
3146         (when (and (search-forward
3147                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3148                     nil t)
3149                    (setq end (1+ (match-beginning 0))))
3150           (gnus-add-wash-type 'pem)
3151           (gnus-article-hide-text-type
3152            end
3153            (if (search-forward "\n\n" nil t)
3154                (match-end 0)
3155              (point-max))
3156            'pem)
3157           ;; Hide the trailer as well
3158           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3159                                 nil t)
3160             (gnus-article-hide-text-type
3161              (match-beginning 0) (match-end 0) 'pem)))))))
3162
3163 (defun article-strip-banner ()
3164   "Strip the banners specified by the `banner' group parameter and by
3165 `gnus-article-address-banner-alist'."
3166   (interactive)
3167   (save-excursion
3168     (save-restriction
3169       (let ((inhibit-point-motion-hooks t))
3170         (when (gnus-parameter-banner gnus-newsgroup-name)
3171           (article-really-strip-banner
3172            (gnus-parameter-banner gnus-newsgroup-name)))
3173         (when gnus-article-address-banner-alist
3174           ;; Note that the From header is decoded here, so it is
3175           ;; required that the *-extract-address-components function
3176           ;; supports non-ASCII text.
3177           (let ((from (save-restriction
3178                         (widen)
3179                         (article-narrow-to-head)
3180                         (mail-fetch-field "from"))))
3181             (when (and from
3182                        (setq from
3183                              (cadr (funcall gnus-extract-address-components
3184                                             from))))
3185               (catch 'found
3186                 (dolist (pair gnus-article-address-banner-alist)
3187                   (when (string-match (car pair) from)
3188                     (throw 'found
3189                            (article-really-strip-banner (cdr pair)))))))))))))
3190
3191 (defun article-really-strip-banner (banner)
3192   "Strip the banner specified by the argument."
3193   (save-excursion
3194     (save-restriction
3195       (let ((inhibit-point-motion-hooks t)
3196             (gnus-signature-limit nil)
3197             (inhibit-read-only t))
3198         (article-goto-body)
3199         (cond
3200          ((eq banner 'signature)
3201           (when (gnus-article-narrow-to-signature)
3202             (widen)
3203             (forward-line -1)
3204             (delete-region (point) (point-max))))
3205          ((symbolp banner)
3206           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3207               (while (re-search-forward banner nil t)
3208                 (delete-region (match-beginning 0) (match-end 0)))))
3209          ((stringp banner)
3210           (while (re-search-forward banner nil t)
3211             (delete-region (match-beginning 0) (match-end 0)))))))))
3212
3213 (defun article-babel ()
3214   "Translate article using an online translation service."
3215   (interactive)
3216   (require 'babel)
3217   (gnus-with-article-buffer
3218     (when (article-goto-body)
3219       (let* ((start (point))
3220              (end (point-max))
3221              (orig (buffer-substring start end))
3222              (trans (babel-as-string orig)))
3223         (save-restriction
3224           (narrow-to-region start end)
3225           (delete-region start end)
3226           (insert trans))))))
3227
3228 (defun article-hide-signature (&optional arg)
3229   "Hide the signature in the current article.
3230 If given a negative prefix, always show; if given a positive prefix,
3231 always hide."
3232   (interactive (gnus-article-hidden-arg))
3233   (unless (gnus-article-check-hidden-text 'signature arg)
3234     (save-excursion
3235       (save-restriction
3236         (let ((inhibit-read-only t))
3237           (when (gnus-article-narrow-to-signature)
3238             (gnus-article-hide-text-type
3239              (point-min) (point-max) 'signature))))))
3240   (gnus-set-mode-line 'article))
3241
3242 (defun article-strip-headers-in-body ()
3243   "Strip offensive headers from bodies."
3244   (interactive)
3245   (save-excursion
3246     (article-goto-body)
3247     (let ((case-fold-search t))
3248       (when (looking-at "x-no-archive:")
3249         (gnus-delete-line)))))
3250
3251 (defun article-strip-leading-blank-lines ()
3252   "Remove all blank lines from the beginning of the article."
3253   (interactive)
3254   (save-excursion
3255     (let ((inhibit-point-motion-hooks t)
3256           (inhibit-read-only t))
3257       (when (article-goto-body)
3258         (while (and (not (eobp))
3259                     (looking-at "[ \t]*$"))
3260           (gnus-delete-line))))))
3261
3262 (defun article-narrow-to-head ()
3263   "Narrow the buffer to the head of the message.
3264 Point is left at the beginning of the narrowed-to region."
3265   (narrow-to-region
3266    (goto-char (point-min))
3267    (if (search-forward "\n\n" nil 1)
3268        (1- (point))
3269      (point-max)))
3270   (goto-char (point-min)))
3271
3272 (defun article-goto-body ()
3273   "Place point at the start of the body."
3274   (goto-char (point-min))
3275   (cond
3276    ;; This variable is only bound when dealing with separate
3277    ;; MIME body parts.
3278    (article-goto-body-goes-to-point-min-p
3279     t)
3280    ((search-forward "\n\n" nil t)
3281     t)
3282    (t
3283     (goto-char (point-max))
3284     nil)))
3285
3286 (defun article-strip-multiple-blank-lines ()
3287   "Replace consecutive blank lines with one empty line."
3288   (interactive)
3289   (save-excursion
3290     (let ((inhibit-point-motion-hooks t)
3291           (inhibit-read-only t))
3292       ;; First make all blank lines empty.
3293       (article-goto-body)
3294       (while (re-search-forward "^[ \t]+$" nil t)
3295         (unless (gnus-annotation-in-region-p
3296                  (match-beginning 0) (match-end 0))
3297           (replace-match "" nil t)))
3298       ;; Then replace multiple empty lines with a single empty line.
3299       (article-goto-body)
3300       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3301         (unless (gnus-annotation-in-region-p
3302                  (match-beginning 0) (match-end 0))
3303           (delete-region (match-beginning 1) (match-end 1)))))))
3304
3305 (defun article-strip-leading-space ()
3306   "Remove all white space from the beginning of the lines in the article."
3307   (interactive)
3308   (save-excursion
3309     (let ((inhibit-point-motion-hooks t)
3310           (inhibit-read-only t))
3311       (article-goto-body)
3312       (while (re-search-forward "^[ \t]+" nil t)
3313         (replace-match "" t t)))))
3314
3315 (defun article-strip-trailing-space ()
3316   "Remove all white space from the end of the lines in the article."
3317   (interactive)
3318   (save-excursion
3319     (let ((inhibit-point-motion-hooks t)
3320           (inhibit-read-only t))
3321       (article-goto-body)
3322       (while (re-search-forward "[ \t]+$" nil t)
3323         (replace-match "" t t)))))
3324
3325 (defun article-strip-blank-lines ()
3326   "Strip leading, trailing and multiple blank lines."
3327   (interactive)
3328   (article-strip-leading-blank-lines)
3329   (article-remove-trailing-blank-lines)
3330   (article-strip-multiple-blank-lines))
3331
3332 (defun article-strip-all-blank-lines ()
3333   "Strip all blank lines."
3334   (interactive)
3335   (save-excursion
3336     (let ((inhibit-point-motion-hooks t)
3337           (inhibit-read-only t))
3338       (article-goto-body)
3339       (while (re-search-forward "^[ \t]*\n" nil t)
3340         (replace-match "" t t)))))
3341
3342 (defun gnus-article-narrow-to-signature ()
3343   "Narrow to the signature; return t if a signature is found, else nil."
3344   (let ((inhibit-point-motion-hooks t))
3345     (when (gnus-article-search-signature)
3346       (forward-line 1)
3347       ;; Check whether we have some limits to what we consider
3348       ;; to be a signature.
3349       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3350                       (list gnus-signature-limit)))
3351             limit limited)
3352         (while (setq limit (pop limits))
3353           (if (or (and (integerp limit)
3354                        (< (- (point-max) (point)) limit))
3355                   (and (floatp limit)
3356                        (< (count-lines (point) (point-max)) limit))
3357                   (and (functionp limit)
3358                        (funcall limit))
3359                   (and (stringp limit)
3360                        (not (re-search-forward limit nil t))))
3361               ()                        ; This limit did not succeed.
3362             (setq limited t
3363                   limits nil)))
3364         (unless limited
3365           (narrow-to-region (point) (point-max))
3366           t)))))
3367
3368 (defun gnus-article-search-signature ()
3369   "Search the current buffer for the signature separator.
3370 Put point at the beginning of the signature separator."
3371   (let ((cur (point)))
3372     (goto-char (point-max))
3373     (if (if (stringp gnus-signature-separator)
3374             (re-search-backward gnus-signature-separator nil t)
3375           (let ((seps gnus-signature-separator))
3376             (while (and seps
3377                         (not (re-search-backward (car seps) nil t)))
3378               (pop seps))
3379             seps))
3380         t
3381       (goto-char cur)
3382       nil)))
3383
3384 (defun gnus-article-hidden-arg ()
3385   "Return the current prefix arg as a number, or 0 if no prefix."
3386   (list (if current-prefix-arg
3387             (prefix-numeric-value current-prefix-arg)
3388           0)))
3389
3390 (defun gnus-article-check-hidden-text (type arg)
3391   "Return nil if hiding is necessary.
3392 Arg can be nil or a number.  nil and positive means hide, negative
3393 means show, 0 means toggle."
3394   (save-excursion
3395     (save-restriction
3396       (let ((hide (gnus-article-hidden-text-p type)))
3397         (cond
3398          ((or (null arg)
3399               (> arg 0))
3400           nil)
3401          ((< arg 0)
3402           (gnus-article-show-hidden-text type)
3403           t)
3404          (t
3405           (if (eq hide 'hidden)
3406               (progn
3407                 (gnus-article-show-hidden-text type)
3408                 t)
3409             nil)))))))
3410
3411 (defun gnus-article-hidden-text-p (type)
3412   "Say whether the current buffer contains hidden text of type TYPE."
3413   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3414     (while (and pos
3415                 (not (get-text-property pos 'invisible))
3416                 (not (get-text-property pos 'dummy-invisible)))
3417       (setq pos
3418             (text-property-any (1+ pos) (point-max) 'article-type type)))
3419     (if pos
3420         'hidden
3421       nil)))
3422
3423 (defun gnus-article-show-hidden-text (type &optional dummy)
3424   "Show all hidden text of type TYPE.
3425 Originally it is hide instead of DUMMY."
3426   (let ((inhibit-read-only t)
3427         (inhibit-point-motion-hooks t))
3428     (gnus-remove-text-properties-when
3429      'article-type type
3430      (point-min) (point-max)
3431      (cons 'article-type (cons type
3432                                gnus-hidden-properties)))
3433     (gnus-delete-wash-type type)))
3434
3435 (defconst article-time-units
3436   `((year . ,(* 365.25 24 60 60))
3437     (week . ,(* 7 24 60 60))
3438     (day . ,(* 24 60 60))
3439     (hour . ,(* 60 60))
3440     (minute . 60)
3441     (second . 1))
3442   "Mapping from time units to seconds.")
3443
3444 (defun gnus-article-forward-header ()
3445   "Move point to the start of the next header.
3446 If the current header is a continuation header, this can be several
3447 lines forward."
3448   (let ((ended nil))
3449     (while (not ended)
3450       (forward-line 1)
3451       (if (looking-at "[ \t]+[^ \t]")
3452           (forward-line 1)
3453         (setq ended t)))))
3454
3455 (defun article-date-ut (&optional type highlight)
3456   "Convert DATE date to universal time in the current article.
3457 If TYPE is `local', convert to local time; if it is `lapsed', output
3458 how much time has lapsed since DATE.  For `lapsed', the value of
3459 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3460 should replace the \"Date:\" one, or should be added below it."
3461   (interactive (list 'ut t))
3462   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3463          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3464                              tdate-regexp)
3465                             ((eq type 'lapsed)
3466                              "^X-Sent:[ \t]")
3467                             (article-lapsed-timer
3468                              "^Date:[ \t]")
3469                             (t
3470                              tdate-regexp)))
3471          (case-fold-search t)
3472          (inhibit-read-only t)
3473          (inhibit-point-motion-hooks t)
3474          pos date bface eface)
3475     (save-excursion
3476       (save-restriction
3477         (widen)
3478         (goto-char (point-min))
3479         (while (or (setq date (get-text-property (setq pos (point))
3480                                                  'original-date))
3481                    (when (setq pos (next-single-property-change
3482                                     (point) 'original-date))
3483                      (setq date (get-text-property pos 'original-date))
3484                      t))
3485           (narrow-to-region
3486            pos (if (setq pos (text-property-any pos (point-max)
3487                                                 'original-date nil))
3488                    (progn
3489                      (goto-char pos)
3490                      (if (or (bolp) (eobp))
3491                          (point)
3492                        (1+ (point))))
3493                  (point-max)))
3494           (goto-char (point-min))
3495           (when (re-search-forward tdate-regexp nil t)
3496             (setq bface (get-text-property (point-at-bol) 'face)
3497                   eface (get-text-property (1- (point-at-eol)) 'face)))
3498           (goto-char (point-min))
3499           (setq pos nil)
3500           ;; Delete any old Date headers.
3501           (while (re-search-forward date-regexp nil t)
3502             (if pos
3503                 (delete-region (point-at-bol) (progn
3504                                                 (gnus-article-forward-header)
3505                                                 (point)))
3506               (delete-region (point-at-bol) (progn
3507                                               (gnus-article-forward-header)
3508                                               (forward-char -1)
3509                                               (point)))
3510               (setq pos (point))))
3511           (when (and (not pos)
3512                      (re-search-forward tdate-regexp nil t))
3513             (forward-line 1))
3514           (gnus-goto-char pos)
3515           (insert (article-make-date-line date (or type 'ut)))
3516           (unless pos
3517             (insert "\n")
3518             (forward-line -1))
3519           ;; Do highlighting.
3520           (beginning-of-line)
3521           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3522             (put-text-property (match-beginning 1) (1+ (match-end 1))
3523                                'face bface)
3524             (put-text-property (match-beginning 2) (match-end 2)
3525                                'face eface))
3526           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3527           (goto-char (point-max))
3528           (widen))))))
3529
3530 (defun article-make-date-line (date type)
3531   "Return a DATE line of TYPE."
3532   (unless (memq type '(local ut original user iso8601 lapsed english))
3533     (error "Unknown conversion type: %s" type))
3534   (condition-case ()
3535       (let ((time (date-to-time date)))
3536         (cond
3537          ;; Convert to the local timezone.
3538          ((eq type 'local)
3539           (concat "Date: " (message-make-date time)))
3540          ;; Convert to Universal Time.
3541          ((eq type 'ut)
3542           (concat "Date: "
3543                   (substring
3544                    (message-make-date
3545                     (let* ((e (parse-time-string date))
3546                            (tm (apply 'encode-time e))
3547                            (ms (car tm))
3548                            (ls (- (cadr tm) (car (current-time-zone time)))))
3549                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3550                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3551                             (t (list ms ls)))))
3552                    0 -5)
3553                   "UT"))
3554          ;; Get the original date from the article.
3555          ((eq type 'original)
3556           (concat "Date: " (if (string-match "\n+$" date)
3557                                (substring date 0 (match-beginning 0))
3558                              date)))
3559          ;; Let the user define the format.
3560          ((eq type 'user)
3561           (let ((format (or (condition-case nil
3562                                 (with-current-buffer gnus-summary-buffer
3563                                   gnus-article-time-format)
3564                               (error nil))
3565                             gnus-article-time-format)))
3566             (if (functionp format)
3567                 (funcall format time)
3568               (concat "Date: " (format-time-string format time)))))
3569          ;; ISO 8601.
3570          ((eq type 'iso8601)
3571           (let ((tz (car (current-time-zone time))))
3572             (concat
3573              "Date: "
3574              (format-time-string "%Y%m%dT%H%M%S" time)
3575              (format "%s%02d%02d"
3576                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3577                      (/ (% (abs tz) 3600) 60)))))
3578          ;; Do an X-Sent lapsed format.
3579          ((eq type 'lapsed)
3580           ;; If the date is seriously mangled, the timezone functions are
3581           ;; liable to bug out, so we ignore all errors.
3582           (let* ((now (current-time))
3583                  (real-time (subtract-time now time))
3584                  (real-sec (and real-time
3585                                 (+ (* (float (car real-time)) 65536)
3586                                    (cadr real-time))))
3587                  (sec (and real-time (abs real-sec)))
3588                  num prev)
3589             (cond
3590              ((null real-time)
3591               "X-Sent: Unknown")
3592              ((zerop sec)
3593               "X-Sent: Now")
3594              (t
3595               (concat
3596                "X-Sent: "
3597                ;; This is a bit convoluted, but basically we go
3598                ;; through the time units for years, weeks, etc,
3599                ;; and divide things to see whether that results
3600                ;; in positive answers.
3601                (mapconcat
3602                 (lambda (unit)
3603                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3604                       ;; The (remaining) seconds are too few to
3605                       ;; be divided into this time unit.
3606                       ""
3607                     ;; It's big enough, so we output it.
3608                     (setq sec (- sec (* num (cdr unit))))
3609                     (prog1
3610                         (concat (if prev ", " "") (int-to-string
3611                                                    (floor num))
3612                                 " " (symbol-name (car unit))
3613                                 (if (> num 1) "s" ""))
3614                       (setq prev t))))
3615                 article-time-units "")
3616                ;; If dates are odd, then it might appear like the
3617                ;; article was sent in the future.
3618                (if (> real-sec 0)
3619                    " ago"
3620                  " in the future"))))))
3621          ;; Display the date in proper English
3622          ((eq type 'english)
3623           (let ((dtime (decode-time time)))
3624             (concat
3625              "Date: the "
3626              (number-to-string (nth 3 dtime))
3627              (let ((digit (% (nth 3 dtime) 10)))
3628                (cond
3629                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3630                 ((= digit 1) "st")
3631                 ((= digit 2) "nd")
3632                 ((= digit 3) "rd")
3633                 (t "th")))
3634              " of "
3635              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3636              " "
3637              (number-to-string (nth 5 dtime))
3638              " at "
3639              (format "%02d" (nth 2 dtime))
3640              ":"
3641              (format "%02d" (nth 1 dtime)))))))
3642     (error
3643      (format "Date: %s (from Gnus)" date))))
3644
3645 (defun article-date-local (&optional highlight)
3646   "Convert the current article date to the local timezone."
3647   (interactive (list t))
3648   (article-date-ut 'local highlight))
3649
3650 (defun article-date-english (&optional highlight)
3651   "Convert the current article date to something that is proper English."
3652   (interactive (list t))
3653   (article-date-ut 'english highlight))
3654
3655 (defun article-date-original (&optional highlight)
3656   "Convert the current article date to what it was originally.
3657 This is only useful if you have used some other date conversion
3658 function and want to see what the date was before converting."
3659   (interactive (list t))
3660   (article-date-ut 'original highlight))
3661
3662 (defun article-date-lapsed (&optional highlight)
3663   "Convert the current article date to time lapsed since it was sent."
3664   (interactive (list t))
3665   (article-date-ut 'lapsed highlight))
3666
3667 (defun article-update-date-lapsed ()
3668   "Function to be run from a timer to update the lapsed time line."
3669   (save-match-data
3670     (let (deactivate-mark)
3671       (save-excursion
3672         (ignore-errors
3673          (walk-windows
3674           (lambda (w)
3675             (set-buffer (window-buffer w))
3676             (when (eq major-mode 'gnus-article-mode)
3677               (let ((mark (point-marker)))
3678                 (goto-char (point-min))
3679                 (when (re-search-forward "^X-Sent:" nil t)
3680                   (article-date-lapsed t))
3681                 (goto-char (marker-position mark))
3682                 (move-marker mark nil))))
3683           nil 'visible))))))
3684
3685 (defun gnus-start-date-timer (&optional n)
3686   "Start a timer to update the X-Sent header in the article buffers.
3687 The numerical prefix says how frequently (in seconds) the function
3688 is to run."
3689   (interactive "p")
3690   (unless n
3691     (setq n 1))
3692   (gnus-stop-date-timer)
3693   (setq article-lapsed-timer
3694         (run-at-time 1 n 'article-update-date-lapsed)))
3695
3696 (defun gnus-stop-date-timer ()
3697   "Stop the X-Sent timer."
3698   (interactive)
3699   (when article-lapsed-timer
3700     (nnheader-cancel-timer article-lapsed-timer)
3701     (setq article-lapsed-timer nil)))
3702
3703 (defun article-date-user (&optional highlight)
3704   "Convert the current article date to the user-defined format.
3705 This format is defined by the `gnus-article-time-format' variable."
3706   (interactive (list t))
3707   (article-date-ut 'user highlight))
3708
3709 (defun article-date-iso8601 (&optional highlight)
3710   "Convert the current article date to ISO8601."
3711   (interactive (list t))
3712   (article-date-ut 'iso8601 highlight))
3713
3714 (defmacro gnus-article-save-original-date (&rest forms)
3715   "Save the original date as a text property and evaluate FORMS."
3716   `(let* ((case-fold-search t)
3717           (start (progn
3718                    (goto-char (point-min))
3719                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3720                               (not (bolp)))
3721                      (match-end 0))))
3722           (date (when (and start
3723                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3724                                               nil t))
3725                   (buffer-substring-no-properties start
3726                                                   (match-beginning 0)))))
3727      (goto-char (point-max))
3728      (skip-chars-backward "\n")
3729      (put-text-property (point-min) (point) 'original-date date)
3730      ,@forms
3731      (goto-char (point-max))
3732      (skip-chars-backward "\n")
3733      (put-text-property (point-min) (point) 'original-date date)))
3734
3735 ;; (defun article-show-all ()
3736 ;;   "Show all hidden text in the article buffer."
3737 ;;   (interactive)
3738 ;;   (save-excursion
3739 ;;     (let ((inhibit-read-only t))
3740 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3741
3742 (defun article-remove-leading-whitespace ()
3743   "Remove excessive whitespace from all headers."
3744   (interactive)
3745   (save-excursion
3746     (save-restriction
3747       (let ((inhibit-read-only t))
3748         (article-narrow-to-head)
3749         (goto-char (point-min))
3750         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3751           (delete-region (match-beginning 1) (match-end 1)))))))
3752
3753 (defun article-emphasize (&optional arg)
3754   "Emphasize text according to `gnus-emphasis-alist'."
3755   (interactive (gnus-article-hidden-arg))
3756   (unless (gnus-article-check-hidden-text 'emphasis arg)
3757     (save-excursion
3758       (let ((alist (or
3759                     (condition-case nil
3760                         (with-current-buffer gnus-summary-buffer
3761                           gnus-article-emphasis-alist)
3762                       (error))
3763                     gnus-emphasis-alist))
3764             (inhibit-read-only t)
3765             (props (append '(article-type emphasis)
3766                            gnus-hidden-properties))
3767             regexp elem beg invisible visible face)
3768         (article-goto-body)
3769         (setq beg (point))
3770         (while (setq elem (pop alist))
3771           (goto-char beg)
3772           (setq regexp (car elem)
3773                 invisible (nth 1 elem)
3774                 visible (nth 2 elem)
3775                 face (nth 3 elem))
3776           (while (re-search-forward regexp nil t)
3777             (when (and (match-beginning visible) (match-beginning invisible))
3778               (gnus-article-hide-text
3779                (match-beginning invisible) (match-end invisible) props)
3780               (gnus-article-unhide-text-type
3781                (match-beginning visible) (match-end visible) 'emphasis)
3782               (gnus-put-overlay-excluding-newlines
3783                (match-beginning visible) (match-end visible) 'face face)
3784               (gnus-add-wash-type 'emphasis)
3785               (goto-char (match-end invisible)))))))))
3786
3787 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3788   "Setup newsgroup emphasis alist."
3789   (unless gnus-article-emphasis-alist
3790     (let ((name (and gnus-newsgroup-name
3791                      (gnus-group-real-name gnus-newsgroup-name))))
3792       (make-local-variable 'gnus-article-emphasis-alist)
3793       (setq gnus-article-emphasis-alist
3794             (nconc
3795              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3796                (while (setq elem (pop alist))
3797                  (when (and name (string-match (car elem) name))
3798                    (setq alist nil
3799                          highlight (copy-sequence (cdr elem)))))
3800                highlight)
3801              (copy-sequence highlight-words)
3802              (if gnus-newsgroup-name
3803                  (copy-sequence (gnus-group-find-parameter
3804                                  gnus-newsgroup-name 'highlight-words t)))
3805              gnus-emphasis-alist)))))
3806
3807 (defvar gnus-summary-article-menu)
3808 (defvar gnus-summary-post-menu)
3809
3810 ;;; Saving functions.
3811
3812 (defun gnus-article-save (save-buffer file &optional num)
3813   "Save the currently selected article."
3814   (when (or (get gnus-default-article-saver :headers)
3815             (not gnus-save-all-headers))
3816     ;; Remove headers according to `gnus-saved-headers' or the value
3817     ;; of the `:headers' property that the saver function might have.
3818     (let ((gnus-visible-headers
3819            (or (symbol-value (get gnus-default-article-saver :headers))
3820                gnus-saved-headers gnus-visible-headers))
3821           ;; Ignore group parameter.  See `article-hide-headers'.
3822           (gnus-summary-buffer nil))
3823       (with-current-buffer save-buffer
3824         (article-hide-headers 1 t))))
3825   (save-window-excursion
3826     (if (not gnus-default-article-saver)
3827         (error "No default saver is defined")
3828       ;; !!! Magic!  The saving functions all save
3829       ;; `gnus-save-article-buffer' (or so they think), but we
3830       ;; bind that variable to our save-buffer.
3831       (set-buffer gnus-article-buffer)
3832       (let* ((gnus-save-article-buffer save-buffer)
3833              (filename
3834               (cond
3835                ((not gnus-prompt-before-saving) 'default)
3836                ((eq gnus-prompt-before-saving 'always) nil)
3837                (t file)))
3838              (gnus-number-of-articles-to-be-saved
3839               (when (eq gnus-prompt-before-saving t)
3840                 num)))                  ; Magic
3841         (set-buffer gnus-article-current-summary)
3842         (funcall gnus-default-article-saver filename)))))
3843
3844 (defun gnus-read-save-file-name (prompt &optional filename
3845                                         function group headers variable
3846                                         dir-var)
3847   (let ((default-name
3848           (funcall function group headers (symbol-value variable)))
3849         result)
3850     (setq result
3851           (expand-file-name
3852            (cond
3853             ((eq filename 'default)
3854              default-name)
3855             ((eq filename t)
3856              default-name)
3857             (filename filename)
3858             (t
3859              (when (symbol-value dir-var)
3860                (setq default-name (expand-file-name
3861                                    (file-name-nondirectory default-name)
3862                                    (symbol-value dir-var))))
3863              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3864                     (prompt
3865                      (format prompt
3866                              (if (and gnus-number-of-articles-to-be-saved
3867                                       (> gnus-number-of-articles-to-be-saved 1))
3868                                  (format "these %d articles"
3869                                          gnus-number-of-articles-to-be-saved)
3870                                "this article")))
3871                     (file
3872                      ;; Let the split methods have their say.
3873                      (cond
3874                       ;; No split name was found.
3875                       ((null split-name)
3876                        (read-file-name
3877                         (concat prompt " (default "
3878                                 (file-name-nondirectory default-name) "): ")
3879                         (file-name-directory default-name)
3880                         default-name))
3881                       ;; A single group name is returned.
3882                       ((stringp split-name)
3883                        (setq default-name
3884                              (funcall function split-name headers
3885                                       (symbol-value variable)))
3886                        (read-file-name
3887                         (concat prompt " (default "
3888                                 (file-name-nondirectory default-name) "): ")
3889                         (file-name-directory default-name)
3890                         default-name))
3891                       ;; A single split name was found
3892                       ((= 1 (length split-name))
3893                        (let* ((name (expand-file-name
3894                                      (car split-name)
3895                                      gnus-article-save-directory))
3896                               (dir (cond ((file-directory-p name)
3897                                           (file-name-as-directory name))
3898                                          ((file-exists-p name) name)
3899                                          (t gnus-article-save-directory))))
3900                          (read-file-name
3901                           (concat prompt " (default " name "): ")
3902                           dir name)))
3903                       ;; A list of splits was found.
3904                       (t
3905                        (setq split-name (nreverse split-name))
3906                        (let (result)
3907                          (let ((file-name-history
3908                                 (nconc split-name file-name-history)))
3909                            (setq result
3910                                  (expand-file-name
3911                                   (read-file-name
3912                                    (concat prompt " (`M-p' for defaults): ")
3913                                    gnus-article-save-directory
3914                                    (car split-name))
3915                                   gnus-article-save-directory)))
3916                          (car (push result file-name-history)))))))
3917                ;; Create the directory.
3918                (gnus-make-directory (file-name-directory file))
3919                ;; If we have read a directory, we append the default file name.
3920                (when (file-directory-p file)
3921                  (setq file (expand-file-name (file-name-nondirectory
3922                                                default-name)
3923                                               (file-name-as-directory file))))
3924                ;; Possibly translate some characters.
3925                (nnheader-translate-file-chars file))))))
3926     (gnus-make-directory (file-name-directory result))
3927     (when variable
3928       (set variable result))
3929     (when dir-var
3930       (set dir-var (file-name-directory result)))
3931     result))
3932
3933 (defun gnus-article-archive-name (group)
3934   "Return the first instance of an \"Archive-name\" in the current buffer."
3935   (let ((case-fold-search t))
3936     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3937       (nnheader-concat gnus-article-save-directory
3938                        (match-string 1)))))
3939
3940 (defun gnus-article-nndoc-name (group)
3941   "If GROUP is an nndoc group, return the name of the parent group."
3942   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3943     (gnus-group-get-parameter group 'save-article-group)))
3944
3945 (defun gnus-summary-save-in-rmail (&optional filename)
3946   "Append this article to Rmail file.
3947 Optional argument FILENAME specifies file name.
3948 Directory to save to is default to `gnus-article-save-directory'."
3949   (setq filename (gnus-read-save-file-name
3950                   "Save %s in rmail file" filename
3951                   gnus-rmail-save-name gnus-newsgroup-name
3952                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3953   (gnus-eval-in-buffer-window gnus-save-article-buffer
3954     (save-excursion
3955       (save-restriction
3956         (widen)
3957         ;; Note that unlike gnus-summary-save-in-mail, there is no
3958         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3959         ;; not use Babyl.
3960         (gnus-output-to-rmail filename))))
3961   filename)
3962
3963 (defun gnus-summary-save-in-mail (&optional filename)
3964   "Append this article to Unix mail file.
3965 Optional argument FILENAME specifies file name.
3966 Directory to save to is default to `gnus-article-save-directory'."
3967   (setq filename (gnus-read-save-file-name
3968                   "Save %s in Unix mail file" filename
3969                   gnus-mail-save-name gnus-newsgroup-name
3970                   gnus-current-headers 'gnus-newsgroup-last-mail))
3971   (gnus-eval-in-buffer-window gnus-save-article-buffer
3972     (save-excursion
3973       (save-restriction
3974         (widen)
3975         (if (and (file-readable-p filename)
3976                  (file-regular-p filename)
3977                  (mail-file-babyl-p filename))
3978             (gnus-output-to-rmail filename)
3979           (gnus-output-to-mail filename)))))
3980   filename)
3981
3982 (put 'gnus-summary-save-in-file :decode t)
3983 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3984 (defun gnus-summary-save-in-file (&optional filename overwrite)
3985   "Append this article to file.
3986 Optional argument FILENAME specifies file name.
3987 Directory to save to is default to `gnus-article-save-directory'."
3988   (setq filename (gnus-read-save-file-name
3989                   "Save %s in file" filename
3990                   gnus-file-save-name gnus-newsgroup-name
3991                   gnus-current-headers 'gnus-newsgroup-last-file))
3992   (gnus-eval-in-buffer-window gnus-save-article-buffer
3993     (save-excursion
3994       (save-restriction
3995         (widen)
3996         (when (and overwrite
3997                    (file-exists-p filename))
3998           (delete-file filename))
3999         (gnus-output-to-file filename))))
4000   filename)
4001
4002 (put 'gnus-summary-write-to-file :decode t)
4003 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
4004 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
4005 (defun gnus-summary-write-to-file (&optional filename)
4006   "Write this article to a file, overwriting it if the file exists.
4007 Optional argument FILENAME specifies file name.
4008 The directory to save in defaults to `gnus-article-save-directory'."
4009   (setq filename (gnus-read-save-file-name
4010                   "Save %s in file" filename
4011                   gnus-file-save-name gnus-newsgroup-name
4012                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4013   (gnus-summary-save-in-file filename t))
4014
4015 (put 'gnus-summary-save-body-in-file :decode t)
4016 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
4017   "Append this article body to a file.
4018 Optional argument FILENAME specifies file name.
4019 The directory to save in defaults to `gnus-article-save-directory'."
4020   (setq filename (gnus-read-save-file-name
4021                   "Save %s body in file" filename
4022                   gnus-file-save-name gnus-newsgroup-name
4023                   gnus-current-headers 'gnus-newsgroup-last-file))
4024   (gnus-eval-in-buffer-window gnus-save-article-buffer
4025     (save-excursion
4026       (save-restriction
4027         (widen)
4028         (when (article-goto-body)
4029           (narrow-to-region (point) (point-max)))
4030         (when (and overwrite
4031                    (file-exists-p filename))
4032           (delete-file filename))
4033         (gnus-output-to-file filename))))
4034   filename)
4035
4036 (put 'gnus-summary-write-body-to-file :decode t)
4037 (put 'gnus-summary-write-body-to-file
4038      :function 'gnus-summary-save-body-in-file)
4039 (defun gnus-summary-write-body-to-file (&optional filename)
4040   "Write this article body to a file, overwriting it if the file exists.
4041 Optional argument FILENAME specifies file name.
4042 The directory to save in defaults to `gnus-article-save-directory'."
4043   (setq filename (gnus-read-save-file-name
4044                   "Save %s body in file" filename
4045                   gnus-file-save-name gnus-newsgroup-name
4046                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4047   (gnus-summary-save-body-in-file filename t))
4048
4049 (put 'gnus-summary-save-in-pipe :decode t)
4050 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
4051 (defun gnus-summary-save-in-pipe (&optional command raw)
4052   "Pipe this article to subprocess COMMAND.
4053 Valid values for COMMAND include:
4054   a string
4055     The executable command name and possibly arguments.
4056   nil
4057     You will be prompted for the command in the minibuffer.
4058   the symbol `default'
4059     It will be replaced with the command which the variable
4060     `gnus-summary-pipe-output-default-command' holds or the command
4061     last used for saving.
4062 Non-nil value for RAW overrides `:decode' and `:headers' properties
4063 and the raw article including all headers will be piped."
4064   (let ((article (gnus-summary-article-number))
4065         (decode (unless raw
4066                   (get 'gnus-summary-save-in-pipe :decode)))
4067         save-buffer default)
4068     (if article
4069         (if (vectorp (gnus-summary-article-header article))
4070             (save-current-buffer
4071               (gnus-summary-select-article decode decode nil article)
4072               (insert-buffer-substring
4073                (prog1
4074                    (if decode
4075                        gnus-article-buffer
4076                      gnus-original-article-buffer)
4077                  (setq save-buffer
4078                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4079               ;; Remove unwanted headers.
4080               (when (and (not raw)
4081                          (or (get 'gnus-summary-save-in-pipe :headers)
4082                              (not gnus-save-all-headers)))
4083                 (let ((gnus-visible-headers
4084                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4085                                               :headers))
4086                            gnus-saved-headers gnus-visible-headers))
4087                       (gnus-summary-buffer nil))
4088                   (article-hide-headers 1 t))))
4089           (error "%d is not a real article" article))
4090       (error "No article to pipe"))
4091     (setq default (or gnus-summary-pipe-output-default-command
4092                       gnus-last-shell-command))
4093     (unless (stringp command)
4094       (setq command
4095             (if (and (eq command 'default) default)
4096                 default
4097               (gnus-read-shell-command "Shell command on this article: "
4098                                        default))))
4099     (when (string-equal command "")
4100       (if default
4101           (setq command default)
4102         (error "A command is required")))
4103     (gnus-eval-in-buffer-window save-buffer
4104       (save-restriction
4105         (widen)
4106         (shell-command-on-region (point-min) (point-max) command nil)))
4107     (gnus-kill-buffer save-buffer))
4108   (setq gnus-summary-pipe-output-default-command command))
4109
4110 (defun gnus-summary-pipe-to-muttprint (&optional command)
4111   "Pipe this article to muttprint."
4112   (unless (stringp command)
4113     (setq command (read-string
4114                    "Print using command: " gnus-summary-muttprint-program
4115                    nil gnus-summary-muttprint-program)))
4116   (let ((gnus-summary-pipe-output-default-command
4117          gnus-summary-pipe-output-default-command))
4118     (gnus-summary-save-in-pipe command))
4119   (setq gnus-summary-muttprint-program command))
4120
4121 ;;; Article file names when saving.
4122
4123 (defun gnus-capitalize-newsgroup (newsgroup)
4124   "Capitalize NEWSGROUP name."
4125   (when (not (zerop (length newsgroup)))
4126     (concat (char-to-string (upcase (aref newsgroup 0)))
4127             (substring newsgroup 1))))
4128
4129 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4130   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4131 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4132 Otherwise, it is like ~/News/news/group/num."
4133   (let ((default
4134           (expand-file-name
4135            (concat (if (gnus-use-long-file-name 'not-save)
4136                        (gnus-capitalize-newsgroup newsgroup)
4137                      (gnus-newsgroup-directory-form newsgroup))
4138                    "/" (int-to-string (mail-header-number headers)))
4139            gnus-article-save-directory)))
4140     (if (and last-file
4141              (string-equal (file-name-directory default)
4142                            (file-name-directory last-file))
4143              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4144         default
4145       (or last-file default))))
4146
4147 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4148   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4149 If variable `gnus-use-long-file-name' is non-nil, it is
4150 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4151   (let ((default
4152           (expand-file-name
4153            (concat (if (gnus-use-long-file-name 'not-save)
4154                        newsgroup
4155                      (gnus-newsgroup-directory-form newsgroup))
4156                    "/" (int-to-string (mail-header-number headers)))
4157            gnus-article-save-directory)))
4158     (if (and last-file
4159              (string-equal (file-name-directory default)
4160                            (file-name-directory last-file))
4161              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4162         default
4163       (or last-file default))))
4164
4165 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4166   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4167 If variable `gnus-use-long-file-name' is non-nil, it is
4168 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4169   (or last-file
4170       (expand-file-name
4171        (if (gnus-use-long-file-name 'not-save)
4172            newsgroup
4173          (file-relative-name
4174           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4175           default-directory))
4176        gnus-article-save-directory)))
4177
4178 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4179   "Generate file name from sender."
4180   (let ((from (mail-header-from headers)))
4181     (expand-file-name
4182      (if (and from (string-match "\\([^ <]+\\)@" from))
4183          (match-string 1 from)
4184        "nobody")
4185      gnus-article-save-directory)))
4186
4187 (defun article-verify-x-pgp-sig ()
4188   "Verify X-PGP-Sig."
4189   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4190   (interactive)
4191   (if (gnus-buffer-live-p gnus-original-article-buffer)
4192       (let ((sig (with-current-buffer gnus-original-article-buffer
4193                    (gnus-fetch-field "X-PGP-Sig")))
4194             items info headers)
4195         (when (and sig
4196                    mml2015-use
4197                    (mml2015-clear-verify-function))
4198           (with-temp-buffer
4199             (insert-buffer-substring gnus-original-article-buffer)
4200             (setq items (split-string sig))
4201             (message-narrow-to-head)
4202             (let ((inhibit-point-motion-hooks t)
4203                   (case-fold-search t))
4204               ;; Don't verify multiple headers.
4205               (setq headers (mapconcat (lambda (header)
4206                                          (concat header ": "
4207                                                  (mail-fetch-field header)
4208                                                  "\n"))
4209                                        (split-string (nth 1 items) ",") "")))
4210             (delete-region (point-min) (point-max))
4211             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4212             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4213             (insert headers)
4214             (widen)
4215             (forward-line)
4216             (while (not (eobp))
4217               (if (looking-at "^-")
4218                   (insert "- "))
4219               (forward-line))
4220             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4221             (insert "Version: " (car items) "\n\n")
4222             (insert (mapconcat 'identity (cddr items) "\n"))
4223             (insert "\n-----END PGP SIGNATURE-----\n")
4224             (let ((mm-security-handle (list (format "multipart/signed"))))
4225               (mml2015-clean-buffer)
4226               (let ((coding-system-for-write (or gnus-newsgroup-charset
4227                                                  'iso-8859-1)))
4228                 (funcall (mml2015-clear-verify-function)))
4229               (setq info
4230                     (or (mm-handle-multipart-ctl-parameter
4231                          mm-security-handle 'gnus-details)
4232                         (mm-handle-multipart-ctl-parameter
4233                          mm-security-handle 'gnus-info)))))
4234           (when info
4235             (let ((inhibit-read-only t) bface eface)
4236               (save-restriction
4237                 (message-narrow-to-head)
4238                 (goto-char (point-max))
4239                 (forward-line -1)
4240                 (setq bface (get-text-property (point-at-bol) 'face)
4241                       eface (get-text-property (1- (point-at-eol)) 'face))
4242                 (message-remove-header "X-Gnus-PGP-Verify")
4243                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4244                     (forward-line)
4245                   (goto-char (point-max)))
4246                 (narrow-to-region (point) (point))
4247                 (insert "X-Gnus-PGP-Verify: " info "\n")
4248                 (goto-char (point-min))
4249                 (forward-line)
4250                 (while (not (eobp))
4251                   (if (not (looking-at "^[ \t]"))
4252                       (insert " "))
4253                   (forward-line))
4254                 ;; Do highlighting.
4255                 (goto-char (point-min))
4256                 (when (looking-at "\\([^:]+\\): *")
4257                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4258                                      'face bface)
4259                   (put-text-property (match-end 0) (point-max)
4260                                      'face eface)))))))))
4261
4262 (autoload 'canlock-verify "canlock" nil t) ;; for Emacs 21.
4263
4264 (defun article-verify-cancel-lock ()
4265   "Verify Cancel-Lock header."
4266   (interactive)
4267   (if (gnus-buffer-live-p gnus-original-article-buffer)
4268       (canlock-verify gnus-original-article-buffer)))
4269
4270 (eval-and-compile
4271   (mapc
4272    (lambda (func)
4273      (let (afunc gfunc)
4274        (if (consp func)
4275            (setq afunc (car func)
4276                  gfunc (cdr func))
4277          (setq afunc func
4278                gfunc (intern (format "gnus-%s" func))))
4279        (defalias gfunc
4280          (when (fboundp afunc)
4281            `(lambda (&optional interactive &rest args)
4282               ,(documentation afunc t)
4283               (interactive (list t))
4284               (with-current-buffer gnus-article-buffer
4285                 (if interactive
4286                     (call-interactively ',afunc)
4287                   (apply ',afunc args))))))))
4288    '(article-hide-headers
4289      article-verify-x-pgp-sig
4290      article-verify-cancel-lock
4291      article-hide-boring-headers
4292      article-treat-overstrike
4293      article-treat-ansi-sequences
4294      article-fill-long-lines
4295      article-capitalize-sentences
4296      article-remove-cr
4297      article-remove-leading-whitespace
4298      article-display-x-face
4299      article-display-face
4300      article-de-quoted-unreadable
4301      article-de-base64-unreadable
4302      article-decode-HZ
4303      article-wash-html
4304      article-unsplit-urls
4305      article-hide-list-identifiers
4306      article-strip-banner
4307      article-babel
4308      article-hide-pem
4309      article-hide-signature
4310      article-strip-headers-in-body
4311      article-remove-trailing-blank-lines
4312      article-strip-leading-blank-lines
4313      article-strip-multiple-blank-lines
4314      article-strip-leading-space
4315      article-strip-trailing-space
4316      article-strip-blank-lines
4317      article-strip-all-blank-lines
4318      article-date-local
4319      article-date-english
4320      article-date-iso8601
4321      article-date-original
4322      article-date-ut
4323      article-decode-mime-words
4324      article-decode-charset
4325      article-decode-encoded-words
4326      article-date-user
4327      article-date-lapsed
4328      article-emphasize
4329      article-treat-dumbquotes
4330      article-normalize-headers
4331      ;;(article-show-all . gnus-article-show-all-headers)
4332      )))
4333 \f
4334 ;;;
4335 ;;; Gnus article mode
4336 ;;;
4337
4338 (put 'gnus-article-mode 'mode-class 'special)
4339
4340 (set-keymap-parent gnus-article-mode-map widget-keymap)
4341
4342 (gnus-define-keys gnus-article-mode-map
4343   " " gnus-article-goto-next-page
4344   "\177" gnus-article-goto-prev-page
4345   [delete] gnus-article-goto-prev-page
4346   [backspace] gnus-article-goto-prev-page
4347   "\C-c^" gnus-article-refer-article
4348   "h" gnus-article-show-summary
4349   "s" gnus-article-show-summary
4350   "\C-c\C-m" gnus-article-mail
4351   "?" gnus-article-describe-briefly
4352   "<" beginning-of-buffer
4353   ">" end-of-buffer
4354   "\C-c\C-i" gnus-info-find-node
4355   "\C-c\C-b" gnus-bug
4356   "R" gnus-article-reply-with-original
4357   "F" gnus-article-followup-with-original
4358   "\C-hk" gnus-article-describe-key
4359   "\C-hc" gnus-article-describe-key-briefly
4360   "\C-hb" gnus-article-describe-bindings
4361
4362   "e" gnus-article-read-summary-keys
4363   "\C-d" gnus-article-read-summary-keys
4364   "\M-*" gnus-article-read-summary-keys
4365   "\M-#" gnus-article-read-summary-keys
4366   "\M-^" gnus-article-read-summary-keys
4367   "\M-g" gnus-article-read-summary-keys)
4368
4369 (substitute-key-definition
4370  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4371
4372 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4373   "W" gnus-article-wide-reply-with-original)
4374 (if (featurep 'xemacs)
4375     (set-keymap-default-binding gnus-article-send-map
4376                                 'gnus-article-read-summary-send-keys)
4377   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4378
4379 (defun gnus-article-make-menu-bar ()
4380   (unless (boundp 'gnus-article-commands-menu)
4381     (gnus-summary-make-menu-bar))
4382   (gnus-turn-off-edit-menu 'article)
4383   (unless (boundp 'gnus-article-article-menu)
4384     (easy-menu-define
4385      gnus-article-article-menu gnus-article-mode-map ""
4386      '("Article"
4387        ["Scroll forwards" gnus-article-goto-next-page t]
4388        ["Scroll backwards" gnus-article-goto-prev-page t]
4389        ["Show summary" gnus-article-show-summary t]
4390        ["Fetch Message-ID at point" gnus-article-refer-article t]
4391        ["Mail to address at point" gnus-article-mail t]
4392        ["Send a bug report" gnus-bug t]))
4393
4394     (easy-menu-define
4395      gnus-article-treatment-menu gnus-article-mode-map ""
4396      ;; Fixme: this should use :active (and maybe :visible).
4397      '("Treatment"
4398        ["Hide headers" gnus-article-hide-headers t]
4399        ["Hide signature" gnus-article-hide-signature t]
4400        ["Hide citation" gnus-article-hide-citation t]
4401        ["Treat overstrike" gnus-article-treat-overstrike t]
4402        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4403        ["Remove carriage return" gnus-article-remove-cr t]
4404        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4405        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4406        ["Remove base64" gnus-article-de-base64-unreadable t]
4407        ["Treat html" gnus-article-wash-html t]
4408        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4409        ["Decode HZ" gnus-article-decode-HZ t]))
4410
4411     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4412
4413     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4414
4415     (gnus-run-hooks 'gnus-article-menu-hook)))
4416
4417 (defun gnus-article-mode ()
4418   "Major mode for displaying an article.
4419
4420 All normal editing commands are switched off.
4421
4422 The following commands are available in addition to all summary mode
4423 commands:
4424 \\<gnus-article-mode-map>
4425 \\[gnus-article-next-page]\t Scroll the article one page forwards
4426 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4427 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4428 \\[gnus-article-show-summary]\t Display the summary buffer
4429 \\[gnus-article-mail]\t Send a reply to the address near point
4430 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4431 \\[gnus-info-find-node]\t Go to the Gnus info node"
4432   (interactive)
4433   (kill-all-local-variables)
4434   (gnus-simplify-mode-line)
4435   (setq mode-name "Article")
4436   (setq major-mode 'gnus-article-mode)
4437   (make-local-variable 'minor-mode-alist)
4438   (use-local-map gnus-article-mode-map)
4439   (when (gnus-visual-p 'article-menu 'menu)
4440     (gnus-article-make-menu-bar)
4441     (when gnus-summary-tool-bar-map
4442       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4443   (gnus-update-format-specifications nil 'article-mode)
4444   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4445   (set (make-local-variable 'gnus-page-broken) nil)
4446   (make-local-variable 'gnus-button-marker-list)
4447   (make-local-variable 'gnus-article-current-summary)
4448   (make-local-variable 'gnus-article-mime-handles)
4449   (make-local-variable 'gnus-article-decoded-p)
4450   (make-local-variable 'gnus-article-mime-handle-alist)
4451   (make-local-variable 'gnus-article-wash-types)
4452   (make-local-variable 'gnus-article-image-alist)
4453   (make-local-variable 'gnus-article-charset)
4454   (make-local-variable 'gnus-article-ignored-charsets)
4455   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4456   ;; face.
4457   (set (make-local-variable 'nobreak-char-display) nil)
4458   (setq cursor-in-non-selected-windows nil)
4459   (setq truncate-lines gnus-article-truncate-lines)
4460   (gnus-set-default-directory)
4461   (buffer-disable-undo)
4462   (setq buffer-read-only t
4463         show-trailing-whitespace nil)
4464   (set-syntax-table gnus-article-mode-syntax-table)
4465   (mm-enable-multibyte)
4466   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4467
4468 (defvar gnus-button-marker-list nil
4469   "Regexp matching any of the regexps from `gnus-button-alist'.
4470 Internal variable.")
4471
4472 (defun gnus-article-setup-buffer ()
4473   "Initialize the article buffer."
4474   (let* ((name (if gnus-single-article-buffer "*Article*"
4475                  (concat "*Article " gnus-newsgroup-name "*")))
4476          (original
4477           (progn (string-match "\\*Article" name)
4478                  (concat " *Original Article"
4479                          (substring name (match-end 0))))))
4480     (setq gnus-article-buffer name)
4481     (setq gnus-original-article-buffer original)
4482     (setq gnus-article-mime-handle-alist nil)
4483     (with-current-buffer gnus-summary-buffer
4484       ;; This might be a variable local to the summary buffer.
4485       (unless gnus-single-article-buffer
4486         (setq gnus-article-buffer name)
4487         (setq gnus-original-article-buffer original)
4488         (gnus-set-global-variables)))
4489     (gnus-article-setup-highlight-words)
4490     ;; Init original article buffer.
4491     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4492       (mm-enable-multibyte)
4493       (setq major-mode 'gnus-original-article-mode)
4494       (make-local-variable 'gnus-original-article))
4495     (if (and (get-buffer name)
4496              (with-current-buffer name
4497                (if gnus-article-edit-mode
4498                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4499                        (progn
4500                          (set-buffer-modified-p nil)
4501                          (gnus-kill-buffer name)
4502                          (message "")
4503                          nil)
4504                      (error "Action aborted"))
4505                  t)))
4506         (with-current-buffer name
4507           (set (make-local-variable 'gnus-article-edit-mode) nil)
4508           (when gnus-article-mime-handles
4509             (mm-destroy-parts gnus-article-mime-handles)
4510             (setq gnus-article-mime-handles nil))
4511           ;; Set it to nil in article-buffer!
4512           (setq gnus-article-mime-handle-alist nil)
4513           (buffer-disable-undo)
4514           (setq buffer-read-only t)
4515           ;; This list just keeps growing if we don't reset it.
4516           (setq gnus-button-marker-list nil)
4517           (unless (eq major-mode 'gnus-article-mode)
4518             (gnus-article-mode))
4519           (current-buffer))
4520       (with-current-buffer (gnus-get-buffer-create name)
4521         (gnus-article-mode)
4522         (make-local-variable 'gnus-summary-buffer)
4523         (setq gnus-summary-buffer
4524               (gnus-summary-buffer-name gnus-newsgroup-name))
4525         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4526         (current-buffer)))))
4527
4528 ;; Set article window start at LINE, where LINE is the number of lines
4529 ;; from the head of the article.
4530 (defun gnus-article-set-window-start (&optional line)
4531   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4532     (when article-window
4533       (set-window-start
4534        article-window
4535        (with-current-buffer gnus-article-buffer
4536          (goto-char (point-min))
4537          (if (not line)
4538              (point-min)
4539            (gnus-message 6 "Moved to bookmark")
4540            (search-forward "\n\n" nil t)
4541            (forward-line line)
4542            (point)))))))
4543
4544 (defun gnus-article-prepare (article &optional all-headers header)
4545   "Prepare ARTICLE in article mode buffer.
4546 ARTICLE should either be an article number or a Message-ID.
4547 If ARTICLE is an id, HEADER should be the article headers.
4548 If ALL-HEADERS is non-nil, no headers are hidden."
4549   (save-excursion
4550     ;; Make sure we start in a summary buffer.
4551     (unless (eq major-mode 'gnus-summary-mode)
4552       (set-buffer gnus-summary-buffer))
4553     (setq gnus-summary-buffer (current-buffer))
4554     (let* ((gnus-article (if header (mail-header-number header) article))
4555            (summary-buffer (current-buffer))
4556            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4557            (group gnus-newsgroup-name)
4558            result)
4559       (save-excursion
4560         (gnus-article-setup-buffer)
4561         (set-buffer gnus-article-buffer)
4562         ;; Deactivate active regions.
4563         (when (and (boundp 'transient-mark-mode)
4564                    transient-mark-mode)
4565           (setq mark-active nil))
4566         (if (not (setq result (let ((inhibit-read-only t))
4567                                 (gnus-request-article-this-buffer
4568                                  article group))))
4569             ;; There is no such article.
4570             (save-excursion
4571               (when (and (numberp article)
4572                          (not (memq article gnus-newsgroup-sparse)))
4573                 (setq gnus-article-current
4574                       (cons gnus-newsgroup-name article))
4575                 (set-buffer gnus-summary-buffer)
4576                 (setq gnus-current-article article)
4577                 (if (and (memq article gnus-newsgroup-undownloaded)
4578                          (not (gnus-online (gnus-find-method-for-group
4579                                             gnus-newsgroup-name))))
4580                     (progn
4581                       (gnus-summary-set-agent-mark article)
4582                       (message "Message marked for downloading"))
4583                   (gnus-summary-mark-article article gnus-canceled-mark)
4584                   (unless (memq article gnus-newsgroup-sparse)
4585                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4586           (if (or (eq result 'pseudo)
4587                   (eq result 'nneething))
4588               (progn
4589                 (with-current-buffer summary-buffer
4590                   (push article gnus-newsgroup-history)
4591                   (setq gnus-last-article gnus-current-article
4592                         gnus-current-article 0
4593                         gnus-current-headers nil
4594                         gnus-article-current nil)
4595                   (if (eq result 'nneething)
4596                       (gnus-configure-windows 'summary)
4597                     (gnus-configure-windows 'article))
4598                   (gnus-set-global-variables))
4599                 (let ((gnus-article-mime-handle-alist-1
4600                        gnus-article-mime-handle-alist))
4601                   (gnus-set-mode-line 'article)))
4602             ;; The result from the `request' was an actual article -
4603             ;; or at least some text that is now displayed in the
4604             ;; article buffer.
4605             (when (and (numberp article)
4606                        (not (eq article gnus-current-article)))
4607               ;; Seems like a new article has been selected.
4608               ;; `gnus-current-article' must be an article number.
4609               (with-current-buffer summary-buffer
4610                 (push article gnus-newsgroup-history)
4611                 (setq gnus-last-article gnus-current-article
4612                       gnus-current-article article
4613                       gnus-current-headers
4614                       (gnus-summary-article-header gnus-current-article)
4615                       gnus-article-current
4616                       (cons gnus-newsgroup-name gnus-current-article))
4617                 (unless (vectorp gnus-current-headers)
4618                   (setq gnus-current-headers nil))
4619                 (gnus-summary-goto-subject gnus-current-article)
4620                 (when (gnus-summary-show-thread)
4621                   ;; If the summary buffer really was folded, the
4622                   ;; previous goto may not actually have gone to
4623                   ;; the right article, but the thread root instead.
4624                   ;; So we go again.
4625                   (gnus-summary-goto-subject gnus-current-article))
4626                 (gnus-run-hooks 'gnus-mark-article-hook)
4627                 (gnus-set-mode-line 'summary)
4628                 (when (gnus-visual-p 'article-highlight 'highlight)
4629                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4630                 ;; Set the global newsgroup variables here.
4631                 (gnus-set-global-variables)
4632                 (setq gnus-have-all-headers
4633                       (or all-headers gnus-show-all-headers))))
4634             (save-excursion
4635               (gnus-configure-windows 'article))
4636             (when (or (numberp article)
4637                       (stringp article))
4638               (gnus-article-prepare-display)
4639               ;; Do page break.
4640               (goto-char (point-min))
4641               (when gnus-break-pages
4642                 (gnus-narrow-to-page)))
4643             (let ((gnus-article-mime-handle-alist-1
4644                    gnus-article-mime-handle-alist))
4645               (gnus-set-mode-line 'article))
4646             (article-goto-body)
4647             (unless (bobp)
4648               (forward-line -1))
4649             (set-window-point (get-buffer-window (current-buffer)) (point))
4650             (gnus-configure-windows 'article)
4651             t))))))
4652
4653 ;;;###autoload
4654 (defun gnus-article-prepare-display ()
4655   "Make the current buffer look like a nice article."
4656   ;; Hooks for getting information from the article.
4657   ;; This hook must be called before being narrowed.
4658   (let ((gnus-article-buffer (current-buffer))
4659         buffer-read-only
4660         (inhibit-read-only t))
4661     (unless (eq major-mode 'gnus-article-mode)
4662       (gnus-article-mode))
4663     (setq buffer-read-only nil
4664           gnus-article-wash-types nil
4665           gnus-article-image-alist nil)
4666     (gnus-run-hooks 'gnus-tmp-internal-hook)
4667     (when gnus-display-mime-function
4668       (funcall gnus-display-mime-function))
4669     (gnus-run-hooks 'gnus-article-prepare-hook)))
4670
4671 ;;;
4672 ;;; Gnus Sticky Article Mode
4673 ;;;
4674
4675 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4676   "Mode for sticky articles."
4677   ;; Release bindings that won't work.
4678   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4679                              gnus-sticky-article-mode-map)
4680   (substitute-key-definition 'gnus-article-refer-article 'undefined
4681                              gnus-sticky-article-mode-map)
4682   (dolist (k '("e" "h" "s" "F" "R"))
4683     (define-key gnus-sticky-article-mode-map k nil))
4684   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4685   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4686   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4687   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4688
4689 (defun gnus-sticky-article (arg)
4690   "Make the current article sticky.
4691 If a prefix ARG is given, ask for a name for this sticky article buffer."
4692   (interactive "P")
4693   (gnus-summary-show-thread)
4694   (gnus-summary-select-article nil nil 'pseudo)
4695   (let (new-art-buf-name)
4696     (gnus-eval-in-buffer-window gnus-article-buffer
4697       (setq new-art-buf-name
4698             (concat
4699              "*Sticky Article: "
4700              (if arg
4701                  (read-from-minibuffer "Sticky article buffer name: ")
4702                (gnus-with-article-headers
4703                  (gnus-article-goto-header "subject")
4704                  (setq new-art-buf-name
4705                        (buffer-substring-no-properties
4706                         (line-beginning-position) (line-end-position)))
4707                  (goto-char (point-min))
4708                  (gnus-article-goto-header "from")
4709                  (setq new-art-buf-name
4710                        (concat
4711                         new-art-buf-name ", "
4712                         (buffer-substring-no-properties
4713                          (line-beginning-position) (line-end-position))))
4714                  (goto-char (point-min))
4715                  (gnus-article-goto-header "date")
4716                  (setq new-art-buf-name
4717                        (concat
4718                         new-art-buf-name ", "
4719                         (buffer-substring-no-properties
4720                          (line-beginning-position) (line-end-position))))))
4721              "*"))
4722       (if (and (gnus-buffer-live-p new-art-buf-name)
4723                (with-current-buffer new-art-buf-name
4724                  (eq major-mode 'gnus-sticky-article-mode)))
4725           (switch-to-buffer new-art-buf-name)
4726         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4727       (gnus-sticky-article-mode))
4728     (setq gnus-article-buffer new-art-buf-name))
4729   (gnus-summary-recenter)
4730   (gnus-summary-position-point))
4731
4732 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4733   "Kill the given sticky article BUFFER.
4734 If none is given, assume the current buffer and kill it if it has
4735 `gnus-sticky-article-mode'."
4736   (interactive)
4737   (unless buffer
4738     (setq buffer (current-buffer)))
4739   (with-current-buffer buffer
4740     (when (eq major-mode 'gnus-sticky-article-mode)
4741       (gnus-kill-buffer buffer))))
4742
4743 (defun gnus-kill-sticky-article-buffers (arg)
4744   "Kill all sticky article buffers.
4745 If a prefix ARG is given, ask for confirmation."
4746   (interactive "P")
4747   (dolist (buf (gnus-buffers))
4748     (with-current-buffer buf
4749       (when (eq major-mode 'gnus-sticky-article-mode)
4750         (if (not arg)
4751             (gnus-kill-buffer buf)
4752           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4753             (gnus-kill-buffer buf)))))))
4754
4755 ;;;
4756 ;;; Gnus MIME viewing functions
4757 ;;;
4758
4759 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4760   "Format of the MIME buttons.
4761
4762 Valid specifiers include:
4763 %t  The MIME type
4764 %T  MIME type, along with additional info
4765 %n  The `name' parameter
4766 %d  The description, if any
4767 %l  The length of the encoded part
4768 %p  The part identifier number
4769 %e  Dots if the part isn't displayed
4770
4771 General format specifiers can also be used.  See Info node
4772 `(gnus)Formatting Variables'.")
4773
4774 (defvar gnus-mime-button-line-format-alist
4775   '((?t gnus-tmp-type ?s)
4776     (?T gnus-tmp-type-long ?s)
4777     (?n gnus-tmp-name ?s)
4778     (?d gnus-tmp-description ?s)
4779     (?p gnus-tmp-id ?s)
4780     (?l gnus-tmp-length ?d)
4781     (?e gnus-tmp-dots ?s)))
4782
4783 (defvar gnus-mime-button-commands
4784   '((gnus-article-press-button "\r" "Toggle Display")
4785     (gnus-mime-view-part "v" "View Interactively...")
4786     (gnus-mime-view-part-as-type "t" "View As Type...")
4787     (gnus-mime-view-part-as-charset "C" "View As charset...")
4788     (gnus-mime-save-part "o" "Save...")
4789     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4790     (gnus-mime-replace-part "r" "Replace part")
4791     (gnus-mime-delete-part "d" "Delete part")
4792     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4793     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4794     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4795     (gnus-mime-view-part-externally "e" "View Externally")
4796     (gnus-mime-print-part "p" "Print")
4797     (gnus-mime-pipe-part "|" "Pipe To Command...")
4798     (gnus-mime-action-on-part "." "Take action on the part...")))
4799
4800 (defun gnus-article-mime-part-status ()
4801   (if gnus-article-mime-handle-alist-1
4802       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4803           " (1 part)"
4804         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4805     ""))
4806
4807 (defvar gnus-mime-button-map
4808   (let ((map (make-sparse-keymap)))
4809     (define-key map gnus-mouse-2 'gnus-article-push-button)
4810     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4811     (dolist (c gnus-mime-button-commands)
4812       (define-key map (cadr c) (car c)))
4813     map))
4814
4815 (easy-menu-define
4816   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4817   `("MIME Part"
4818     ,@(mapcar (lambda (c)
4819                 (vector (caddr c) (car c) :active t))
4820               gnus-mime-button-commands)))
4821
4822 (defmacro gnus-bind-safe-url-regexp (&rest body)
4823   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4824   `(let ((mm-w3m-safe-url-regexp
4825           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4826                                 (gnus-buffer-live-p
4827                                  gnus-article-current-summary))
4828                            (with-current-buffer gnus-article-current-summary
4829                              gnus-newsgroup-name)
4830                          gnus-newsgroup-name)))
4831             (if (cond ((not group)
4832                        ;; Maybe we're in a mml-preview buffer
4833                        ;; and no group is selected.
4834                        t)
4835                       ((stringp gnus-safe-html-newsgroups)
4836                        (string-match gnus-safe-html-newsgroups group))
4837                       ((consp gnus-safe-html-newsgroups)
4838                        (member group gnus-safe-html-newsgroups)))
4839                 nil
4840               mm-w3m-safe-url-regexp))))
4841      ,@body))
4842
4843 (defun gnus-mime-button-menu (event prefix)
4844  "Construct a context-sensitive menu of MIME commands."
4845  (interactive "e\nP")
4846  (save-window-excursion
4847    (let ((pos (event-start event)))
4848      (select-window (posn-window pos))
4849      (goto-char (posn-point pos))
4850      (gnus-article-check-buffer)
4851      (popup-menu gnus-mime-button-menu nil prefix))))
4852
4853 (defun gnus-mime-view-all-parts (&optional handles)
4854   "View all the MIME parts."
4855   (interactive)
4856   (with-current-buffer gnus-article-buffer
4857     (let ((handles (or handles gnus-article-mime-handles))
4858           (mail-parse-charset gnus-newsgroup-charset)
4859           (mail-parse-ignored-charsets
4860            (with-current-buffer gnus-summary-buffer
4861              gnus-newsgroup-ignored-charsets)))
4862       (when handles
4863         (mm-remove-parts handles)
4864         (goto-char (point-min))
4865         (or (search-forward "\n\n") (goto-char (point-max)))
4866         (let ((inhibit-read-only t))
4867           (delete-region (point) (point-max))
4868           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4869
4870 (defun gnus-article-jump-to-part (n)
4871   "Jump to MIME part N."
4872   (interactive "P")
4873   (pop-to-buffer gnus-article-buffer)
4874   ;; FIXME: why is it necessary?
4875   (sit-for 0)
4876   (let ((parts (length gnus-article-mime-handle-alist)))
4877     (or n (setq n
4878                 (string-to-number
4879                  (read-string ;; Emacs 21 doesn't have `read-number'.
4880                   (format "Jump to part (2..%s): " parts)))))
4881     (unless (and (integerp n) (<= n parts) (>= n 1))
4882       (setq n
4883             (progn
4884               (gnus-message 7 "Invalid part `%s', using %s instead."
4885                             n parts)
4886               parts)))
4887     (gnus-message 9 "Jumping to part %s." n)
4888     (cond ((>= gnus-auto-select-part 1)
4889            (while (and (<= n parts)
4890                        (not (gnus-article-goto-part n)))
4891              (setq n (1+ n))))
4892           ((< gnus-auto-select-part 0)
4893            (while (and (>= n 1)
4894                        (not (gnus-article-goto-part n)))
4895              (setq n (1- n))))
4896           (t
4897            (gnus-article-goto-part n)))))
4898
4899 (eval-when-compile
4900   (defsubst gnus-article-edit-part (handles &optional current-id)
4901     "Edit an article in order to delete a mime part.
4902 This function is exclusively used by `gnus-mime-save-part-and-strip'
4903 and `gnus-mime-delete-part', and not provided at run-time normally."
4904     (gnus-article-edit-article
4905      `(lambda ()
4906         (buffer-disable-undo)
4907         (erase-buffer)
4908         (let ((mail-parse-charset (or gnus-article-charset
4909                                       ',gnus-newsgroup-charset))
4910               (mail-parse-ignored-charsets
4911                (or gnus-article-ignored-charsets
4912                    ',gnus-newsgroup-ignored-charsets))
4913               (mbl mml-buffer-list))
4914           (setq mml-buffer-list nil)
4915           (insert-buffer-substring gnus-original-article-buffer)
4916           (mime-to-mml ',handles)
4917           (setq gnus-article-mime-handles nil)
4918           (let ((mbl1 mml-buffer-list))
4919             (setq mml-buffer-list mbl)
4920             (set (make-local-variable 'mml-buffer-list) mbl1))
4921           (gnus-make-local-hook 'kill-buffer-hook)
4922           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4923      `(lambda (no-highlight)
4924         (let ((mail-parse-charset (or gnus-article-charset
4925                                       ',gnus-newsgroup-charset))
4926               (message-options message-options)
4927               (message-options-set-recipient)
4928               (mail-parse-ignored-charsets
4929                (or gnus-article-ignored-charsets
4930                    ',gnus-newsgroup-ignored-charsets)))
4931           (mml-to-mime)
4932           (mml-destroy-buffers)
4933           (remove-hook 'kill-buffer-hook
4934                        'mml-destroy-buffers t)
4935           (kill-local-variable 'mml-buffer-list))
4936         (gnus-summary-edit-article-done
4937          ,(or (mail-header-references gnus-current-headers) "")
4938          ,(gnus-group-read-only-p)
4939          ,gnus-summary-buffer no-highlight))
4940      t)
4941     (gnus-article-edit-done)
4942     (gnus-configure-windows 'article)
4943     (when (and current-id (integerp gnus-auto-select-part))
4944       (gnus-article-jump-to-part (+ current-id gnus-auto-select-part)))))
4945
4946 (defun gnus-mime-replace-part (file)
4947   "Replace MIME part under point with an external body."
4948   ;; Useful if file has already been saved to disk
4949   (interactive
4950    (list
4951     (read-file-name "Replace MIME part with file: "
4952                     (or mm-default-directory default-directory)
4953                     nil nil)))
4954   (gnus-mime-save-part-and-strip file))
4955
4956 (defun gnus-mime-save-part-and-strip (&optional file)
4957   "Save the MIME part under point then replace it with an external body.
4958 If FILE is given, use it for the external part."
4959   (interactive)
4960   (gnus-article-check-buffer)
4961   (when (gnus-group-read-only-p)
4962     (error "The current group does not support deleting of parts"))
4963   (when (mm-complicated-handles gnus-article-mime-handles)
4964     (error "\
4965 The current article has a complicated MIME structure, giving up..."))
4966   (let* ((data (get-text-property (point) 'gnus-data))
4967          (id (get-text-property (point) 'gnus-part))
4968          param
4969          (handles gnus-article-mime-handles))
4970     (unless file
4971       (setq file
4972             (and data (mm-save-part data "Delete MIME part and save to: "))))
4973     (when file
4974       (with-current-buffer (mm-handle-buffer data)
4975         (erase-buffer)
4976         (insert "Content-Type: " (mm-handle-media-type data))
4977         (mml-insert-parameter-string (cdr (mm-handle-type data))
4978                                      '(charset))
4979         ;; Add a filename for the sake of saving the part again.
4980         (mml-insert-parameter
4981          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4982         (insert "\n")
4983         (insert "Content-ID: " (message-make-message-id) "\n")
4984         (insert "Content-Transfer-Encoding: binary\n")
4985         (insert "\n"))
4986       (setcdr data
4987               (cdr (mm-make-handle nil
4988                                    `("message/external-body"
4989                                      (access-type . "LOCAL-FILE")
4990                                      (name . ,file)))))
4991       ;; (set-buffer gnus-summary-buffer)
4992       (gnus-article-edit-part handles id))))
4993
4994 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4995 ;; parts...>') but with stripping would be nice.
4996
4997 (defun gnus-mime-delete-part ()
4998   "Delete the MIME part under point.
4999 Replace it with some information about the removed part."
5000   (interactive)
5001   (gnus-article-check-buffer)
5002   (when (gnus-group-read-only-p)
5003     (error "The current group does not support deleting of parts"))
5004   (when (mm-complicated-handles gnus-article-mime-handles)
5005     (error "\
5006 The current article has a complicated MIME structure, giving up..."))
5007   (when (or gnus-expert-user
5008             (gnus-yes-or-no-p "\
5009 Deleting parts may malfunction or destroy the article; continue? "))
5010     (let* ((data (get-text-property (point) 'gnus-data))
5011            (id (get-text-property (point) 'gnus-part))
5012            (handles gnus-article-mime-handles)
5013            (none "(none)")
5014            (description
5015             (let ((desc (mm-handle-description data)))
5016               (when desc
5017                 (mail-decode-encoded-word-string desc))))
5018            (filename
5019             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
5020                 none))
5021            (type (mm-handle-media-type data)))
5022       (unless data
5023         (error "No MIME part under point"))
5024       (with-current-buffer (mm-handle-buffer data)
5025         (let ((bsize (format "%s" (buffer-size))))
5026           (erase-buffer)
5027           (insert
5028            (concat
5029             ",----\n"
5030             "| The following attachment has been deleted:\n"
5031             "|\n"
5032             "| Type:           " type "\n"
5033             "| Filename:       " filename "\n"
5034             "| Size (encoded): " bsize " Byte\n"
5035             (when description
5036               (concat    "| Description:    " description "\n"))
5037             "`----\n"))
5038           (setcdr data
5039                   (cdr (mm-make-handle
5040                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5041                         (list "attachment")
5042                         (format "Deleted attachment (%s bytes)" bsize))))))
5043       ;; (set-buffer gnus-summary-buffer)
5044       (gnus-article-edit-part handles id))))
5045
5046 (defun gnus-mime-save-part ()
5047   "Save the MIME part under point."
5048   (interactive)
5049   (gnus-article-check-buffer)
5050   (let ((data (get-text-property (point) 'gnus-data)))
5051     (when data
5052       (mm-save-part data))))
5053
5054 (defun gnus-mime-pipe-part (&optional cmd)
5055   "Pipe the MIME part under point to a process.
5056 Use CMD as the process."
5057   (interactive)
5058   (gnus-article-check-buffer)
5059   (let ((data (get-text-property (point) 'gnus-data)))
5060     (when data
5061       (mm-pipe-part data cmd))))
5062
5063 (defun gnus-mime-view-part ()
5064   "Interactively choose a viewing method for the MIME part under point."
5065   (interactive)
5066   (gnus-article-check-buffer)
5067   (let ((data (get-text-property (point) 'gnus-data)))
5068     (when data
5069       (setq gnus-article-mime-handles
5070             (mm-merge-handles
5071              gnus-article-mime-handles (setq data (copy-sequence data))))
5072       (mm-interactively-view-part data))))
5073
5074 (defun gnus-mime-view-part-as-type-internal ()
5075   (gnus-article-check-buffer)
5076   (let* ((handle (get-text-property (point) 'gnus-data))
5077          (name (or
5078                 ;; Content-Type: foo/bar; name=...
5079                 (mail-content-type-get (mm-handle-type handle) 'name)
5080                 ;; Content-Disposition: attachment; filename=...
5081                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5082          (def-type (and name (mm-default-file-encoding name))))
5083     (or (and def-type (cons def-type 0))
5084         (and handle
5085              (equal (mm-handle-media-supertype handle) "text")
5086              '("text/plain" . 0))
5087         '("application/octet-stream" . 0))))
5088
5089 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5090   "Choose a MIME media type, and view the part as such.
5091 If non-nil, PRED is a predicate to use during completion to limit the
5092 available media-types."
5093   (interactive)
5094   (unless mime-type
5095     (setq mime-type
5096           (let ((default (gnus-mime-view-part-as-type-internal)))
5097             (completing-read
5098              (format "View as MIME type (default %s): "
5099                      (car default))
5100              (mapcar #'list (mailcap-mime-types))
5101              pred nil nil nil
5102              (car default)))))
5103   (gnus-article-check-buffer)
5104   (let ((handle (get-text-property (point) 'gnus-data)))
5105     (when handle
5106       (when (equal (mm-handle-media-type handle) "message/external-body")
5107         (unless (mm-handle-cache handle)
5108           (mm-extern-cache-contents handle))
5109         (setq handle (mm-handle-cache handle)))
5110       (setq handle
5111             (mm-make-handle (mm-handle-buffer handle)
5112                             (cons mime-type (cdr (mm-handle-type handle)))
5113                             (mm-handle-encoding handle)
5114                             (mm-handle-undisplayer handle)
5115                             (mm-handle-disposition handle)
5116                             (mm-handle-description handle)
5117                             nil
5118                             (mm-handle-id handle)))
5119       (setq gnus-article-mime-handles
5120             (mm-merge-handles gnus-article-mime-handles handle))
5121       (when (mm-handle-displayed-p handle)
5122         (mm-remove-part handle))
5123       (gnus-mm-display-part handle))))
5124
5125 (defun gnus-mime-copy-part (&optional handle arg)
5126   "Put the MIME part under point into a new buffer.
5127 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5128 are decompressed."
5129   (interactive (list nil current-prefix-arg))
5130   (gnus-article-check-buffer)
5131   (unless handle
5132     (setq handle (get-text-property (point) 'gnus-data)))
5133   (when handle
5134     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5135                                                'name)
5136                         (mail-content-type-get (mm-handle-disposition handle)
5137                                                'filename)))
5138           contents dont-decode charset coding-system)
5139       (mm-with-unibyte-buffer
5140         (mm-insert-part handle)
5141         (setq contents (or (condition-case nil
5142                                (mm-decompress-buffer filename nil 'sig)
5143                              (error
5144                               (setq dont-decode t)
5145                               nil))
5146                            (buffer-string))))
5147       (setq filename (cond (filename (file-name-nondirectory filename))
5148                            (dont-decode "*raw data*")
5149                            (t "*decoded*")))
5150       (cond
5151        (dont-decode)
5152        ((not arg)
5153         (unless (setq charset (mail-content-type-get
5154                                (mm-handle-type handle) 'charset))
5155           (unless (setq coding-system (mm-with-unibyte-buffer
5156                                         (insert contents)
5157                                         (mm-find-buffer-file-coding-system)))
5158             (setq charset gnus-newsgroup-charset))))
5159        ((numberp arg)
5160         (setq charset (or (cdr (assq arg
5161                                      gnus-summary-show-article-charset-alist))
5162                           (mm-read-coding-system "Charset: ")))))
5163       (switch-to-buffer (generate-new-buffer filename))
5164       (if (or coding-system
5165               (and charset
5166                    (setq coding-system (mm-charset-to-coding-system charset))
5167                    (not (eq charset 'ascii))))
5168           (progn
5169             (mm-enable-multibyte)
5170             (insert (mm-decode-coding-string contents coding-system))
5171             (setq buffer-file-coding-system
5172                   (if (boundp 'last-coding-system-used)
5173                       (symbol-value 'last-coding-system-used)
5174                     coding-system)))
5175         (mm-disable-multibyte)
5176         (insert contents)
5177         (setq buffer-file-coding-system mm-binary-coding-system))
5178       ;; We do it this way to make `normal-mode' set the appropriate mode.
5179       (unwind-protect
5180           (progn
5181             (setq buffer-file-name (expand-file-name filename))
5182             (normal-mode))
5183         (setq buffer-file-name nil))
5184       (goto-char (point-min)))))
5185
5186 (defun gnus-mime-print-part (&optional handle filename)
5187   "Print the MIME part under point."
5188   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5189   (gnus-article-check-buffer)
5190   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5191          (contents (and handle (mm-get-part handle)))
5192          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5193          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5194     (when contents
5195         (if printer
5196             (unwind-protect
5197                 (progn
5198                   (mm-save-part-to-file handle file)
5199                   (call-process shell-file-name nil
5200                                 (generate-new-buffer " *mm*")
5201                                 nil
5202                                 shell-command-switch
5203                                 (mm-mailcap-command
5204                                  printer file (mm-handle-type handle))))
5205               (delete-file file))
5206           (with-temp-buffer
5207             (insert contents)
5208             (gnus-print-buffer))
5209           (ps-despool filename)))))
5210
5211 (defun gnus-mime-inline-part (&optional handle arg)
5212   "Insert the MIME part under point into the current buffer.
5213 Compressed files like .gz and .bz2 are decompressed."
5214   (interactive (list nil current-prefix-arg))
5215   (gnus-article-check-buffer)
5216   (unless handle
5217     (setq handle (get-text-property (point) 'gnus-data)))
5218   (when handle
5219     (let ((b (point))
5220           (inhibit-read-only t)
5221           contents charset coding-system)
5222       (if (and (not arg) (mm-handle-undisplayer handle))
5223           (mm-remove-part handle)
5224         (mm-with-unibyte-buffer
5225           (mm-insert-part handle)
5226           (setq contents
5227                 (or (mm-decompress-buffer
5228                      (or (mail-content-type-get (mm-handle-type handle)
5229                                                 'name)
5230                          (mail-content-type-get (mm-handle-disposition handle)
5231                                                 'filename))
5232                      nil t)
5233                     (buffer-string))))
5234         (cond
5235          ((not arg)
5236           (unless (setq charset (mail-content-type-get
5237                                  (mm-handle-type handle) 'charset))
5238             (unless (setq coding-system
5239                           (mm-with-unibyte-buffer
5240                             (insert contents)
5241                             (mm-find-buffer-file-coding-system)))
5242               (setq charset gnus-newsgroup-charset))))
5243          ((numberp arg)
5244           (if (mm-handle-undisplayer handle)
5245               (mm-remove-part handle))
5246           (setq charset
5247                 (or (cdr (assq arg
5248                                gnus-summary-show-article-charset-alist))
5249                     (mm-read-coding-system "Charset: "))))
5250          (t
5251           (if (mm-handle-undisplayer handle)
5252               (mm-remove-part handle))))
5253         (forward-line 2)
5254         (mm-insert-inline
5255          handle
5256          (if (or coding-system
5257                  (and charset
5258                       (setq coding-system
5259                             (mm-charset-to-coding-system charset))
5260                       (not (eq coding-system 'ascii))))
5261              (mm-decode-coding-string contents coding-system)
5262            (mm-string-to-multibyte contents)))
5263         (goto-char b)))))
5264
5265 (defun gnus-mime-set-charset-parameters (handle charset)
5266   "Set CHARSET to parameters in HANDLE.
5267 CHARSET may either be a string or a symbol."
5268   (unless (stringp charset)
5269     (setq charset (symbol-name charset)))
5270   (if (stringp (car handle))
5271       (dolist (h (cdr handle))
5272         (gnus-mime-set-charset-parameters h charset))
5273     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5274                                             "message/external-body")
5275                                      (progn
5276                                        (unless (mm-handle-cache handle)
5277                                          (mm-extern-cache-contents handle))
5278                                        (mm-handle-cache handle))
5279                                    handle)))
5280            (param (assq 'charset (cdr type))))
5281       (if param
5282           (setcdr param charset)
5283         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5284
5285 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5286   "Insert the MIME part under point into the current buffer using the
5287 specified charset."
5288   (interactive (list nil current-prefix-arg))
5289   (gnus-article-check-buffer)
5290   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5291         (fun (get-text-property (point) 'gnus-callback))
5292         (gnus-newsgroup-ignored-charsets 'gnus-all)
5293         charset form preferred parts)
5294     (when handle
5295       (when (prog1
5296                 (and fun
5297                      (setq charset
5298                            (or (cdr (assq
5299                                      arg
5300                                      gnus-summary-show-article-charset-alist))
5301                                (mm-read-coding-system "Charset: "))))
5302               (if (mm-handle-undisplayer handle)
5303                   (mm-remove-part handle)))
5304         (gnus-mime-set-charset-parameters handle charset)
5305         (when (and (consp (setq form (cdr-safe fun)))
5306                    (setq form (ignore-errors
5307                                 (assq 'gnus-mime-display-alternative form)))
5308                    (setq preferred (caddr form))
5309                    (progn
5310                      (when (eq (car preferred) 'quote)
5311                        (setq preferred (cadr preferred)))
5312                      (not (equal preferred
5313                                  (get-text-property (point) 'gnus-data))))
5314                    (setq parts (get-text-property (point) 'gnus-part))
5315                    (setq parts (cdr (assq parts
5316                                           gnus-article-mime-handle-alist)))
5317                    (equal (mm-handle-media-type parts) "multipart/alternative")
5318                    (setq parts (reverse (cdr parts))))
5319           (setcar (cddr form)
5320                   (list 'quote (or (cadr (member preferred parts))
5321                                    (car parts)))))
5322         (funcall fun handle)))))
5323
5324 (defun gnus-mime-view-part-externally (&optional handle)
5325   "View the MIME part under point with an external viewer."
5326   (interactive)
5327   (gnus-article-check-buffer)
5328   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5329          (mm-user-display-methods nil)
5330          (mm-inlined-types nil)
5331          (mail-parse-charset gnus-newsgroup-charset)
5332          (mail-parse-ignored-charsets
5333           (with-current-buffer gnus-summary-buffer
5334             gnus-newsgroup-ignored-charsets))
5335          (type (mm-handle-media-type handle))
5336          (method (mailcap-mime-info type))
5337          (mm-enable-external t))
5338     (if (not (stringp method))
5339         (gnus-mime-view-part-as-type
5340          nil (lambda (types) (stringp (mailcap-mime-info (car types)))))
5341       (when handle
5342         (if (mm-handle-undisplayer handle)
5343             (mm-remove-part handle)
5344           (mm-display-part handle))))))
5345
5346 (defun gnus-mime-view-part-internally (&optional handle)
5347   "View the MIME part under point with an internal viewer.
5348 If no internal viewer is available, use an external viewer."
5349   (interactive)
5350   (gnus-article-check-buffer)
5351   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5352          (mm-inlined-types '(".*"))
5353          (mm-inline-large-images t)
5354          (mail-parse-charset gnus-newsgroup-charset)
5355          (mail-parse-ignored-charsets
5356           (with-current-buffer gnus-summary-buffer
5357             gnus-newsgroup-ignored-charsets))
5358          (inhibit-read-only t))
5359     (if (not (mm-inlinable-p handle))
5360         (gnus-mime-view-part-as-type
5361          nil (lambda (types) (mm-inlinable-p handle (car types))))
5362       (when handle
5363         (if (mm-handle-undisplayer handle)
5364             (mm-remove-part handle)
5365           (gnus-bind-safe-url-regexp (mm-display-part handle)))))))
5366
5367 (defun gnus-mime-action-on-part (&optional action)
5368   "Do something with the MIME attachment at \(point\)."
5369   (interactive
5370    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
5371   (gnus-article-check-buffer)
5372   (let ((action-pair (assoc action gnus-mime-action-alist)))
5373     (if action-pair
5374         (funcall (cdr action-pair)))))
5375
5376 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5377   "Call FUNCTION on MIME part N.
5378 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5379 If INTERACTIVE, call FUNCTION interactivly."
5380   (let (window frame)
5381     ;; Check whether the article is displayed.
5382     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5383                  (setq window (get-buffer-window gnus-article-buffer t))
5384                  (frame-visible-p (setq frame (window-frame window))))
5385       (error "No article is displayed"))
5386     (with-current-buffer gnus-article-buffer
5387       ;; Check whether the article displays the right contents.
5388       (unless (with-current-buffer gnus-summary-buffer
5389                 (eq gnus-current-article (gnus-summary-article-number)))
5390         (error "You should select the right article first"))
5391       (if n
5392           (setq n (prefix-numeric-value n))
5393         (let ((pt (point)))
5394           (setq n (or (get-text-property pt 'gnus-part)
5395                       (and (not (bobp))
5396                            (get-text-property (1- pt) 'gnus-part))
5397                       (get-text-property (prog2
5398                                              (forward-line 1)
5399                                              (point)
5400                                            (goto-char pt))
5401                                          'gnus-part)
5402                       (get-text-property
5403                        (or (and (setq pt (previous-single-property-change
5404                                           pt 'gnus-part))
5405                                 (1- pt))
5406                            (next-single-property-change (point) 'gnus-part)
5407                            (point))
5408                        'gnus-part)
5409                       1))))
5410       ;; Check whether the specified part exists.
5411       (when (> n (length gnus-article-mime-handle-alist))
5412         (error "No such part")))
5413     (unless
5414         (progn
5415           ;; To select the window is needed so that the cursor
5416           ;; might be visible on the MIME button.
5417           (select-window (prog1
5418                              window
5419                            (setq window (selected-window))
5420                            ;; Article may be displayed in the other frame.
5421                            (gnus-select-frame-set-input-focus
5422                             (prog1
5423                                 frame
5424                               (setq frame (selected-frame))))))
5425           (when (gnus-article-goto-part n)
5426             ;; We point the cursor and the arrow at the MIME button
5427             ;; when the `function' prompt the user for something.
5428             (let ((cursor-in-non-selected-windows t)
5429                   (overlay-arrow-string "=>")
5430                   (overlay-arrow-position (point-marker)))
5431               (unwind-protect
5432                   (cond
5433                    ((and no-handle interactive)
5434                     (call-interactively function))
5435                    (no-handle
5436                     (funcall function))
5437                    (interactive
5438                     (call-interactively
5439                      function
5440                      (cdr (assq n gnus-article-mime-handle-alist))))
5441                    (t
5442                     (funcall function
5443                              (cdr (assq n gnus-article-mime-handle-alist)))))
5444                 (set-marker overlay-arrow-position nil)
5445                 (unless gnus-auto-select-part
5446                   (gnus-select-frame-set-input-focus frame)
5447                   (select-window window))))
5448             t))
5449       (if gnus-inhibit-mime-unbuttonizing
5450           ;; This is the default though the program shouldn't reach here.
5451           (error "No such part")
5452         ;; The part which doesn't have the MIME button is selected.
5453         ;; So, we display all the buttons and redo it.
5454         (let ((gnus-inhibit-mime-unbuttonizing t))
5455           (gnus-summary-show-article)
5456           (gnus-article-part-wrapper n function no-handle))))))
5457
5458 (defun gnus-article-pipe-part (n)
5459   "Pipe MIME part N, which is the numerical prefix."
5460   (interactive "P")
5461   (gnus-article-part-wrapper n 'mm-pipe-part))
5462
5463 (defun gnus-article-save-part (n)
5464   "Save MIME part N, which is the numerical prefix."
5465   (interactive "P")
5466   (gnus-article-part-wrapper n 'mm-save-part))
5467
5468 (defun gnus-article-interactively-view-part (n)
5469   "View MIME part N interactively, which is the numerical prefix."
5470   (interactive "P")
5471   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5472
5473 (defun gnus-article-copy-part (n)
5474   "Copy MIME part N, which is the numerical prefix."
5475   (interactive "P")
5476   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5477
5478 (defun gnus-article-view-part-as-charset (n)
5479   "View MIME part N using a specified charset.
5480 N is the numerical prefix."
5481   (interactive "P")
5482   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5483
5484 (defun gnus-article-view-part-externally (n)
5485   "View MIME part N externally, which is the numerical prefix."
5486   (interactive "P")
5487   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5488
5489 (defun gnus-article-inline-part (n)
5490   "Inline MIME part N, which is the numerical prefix."
5491   (interactive "P")
5492   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5493
5494 (defun gnus-article-save-part-and-strip (n)
5495   "Save MIME part N and replace it with an external body.
5496 N is the numerical prefix."
5497   (interactive "P")
5498   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5499
5500 (defun gnus-article-replace-part (n)
5501   "Replace MIME part N with an external body.
5502 N is the numerical prefix."
5503   (interactive "P")
5504   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5505
5506 (defun gnus-article-delete-part (n)
5507   "Delete MIME part N and add some information about the removed part.
5508 N is the numerical prefix."
5509   (interactive "P")
5510   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5511
5512 (defun gnus-article-view-part-as-type (n)
5513   "Choose a MIME media type, and view part N as such.
5514 N is the numerical prefix."
5515   (interactive "P")
5516   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5517
5518 (defun gnus-article-mime-match-handle-first (condition)
5519   (if condition
5520       (let (n)
5521         (dolist (ihandle gnus-article-mime-handle-alist)
5522           (if (and (cond
5523                     ((functionp condition)
5524                      (funcall condition (cdr ihandle)))
5525                     ((eq condition 'undisplayed)
5526                      (not (or (mm-handle-undisplayer (cdr ihandle))
5527                               (equal (mm-handle-media-type (cdr ihandle))
5528                                      "multipart/alternative"))))
5529                     ((eq condition 'undisplayed-alternative)
5530                      (not (mm-handle-undisplayer (cdr ihandle))))
5531                     (t t))
5532                    (gnus-article-goto-part (car ihandle))
5533                    (or (not n) (< (car ihandle) n)))
5534               (setq n (car ihandle))))
5535         (or n 1))
5536     1))
5537
5538 (defun gnus-article-view-part (&optional n)
5539   "View MIME part N, which is the numerical prefix."
5540   (interactive "P")
5541   (with-current-buffer gnus-article-buffer
5542     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5543                              gnus-article-mime-match-handle-function)))
5544     (when (> n (length gnus-article-mime-handle-alist))
5545       (error "No such part"))
5546     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5547       (when (gnus-article-goto-part n)
5548         (if (equal (car handle) "multipart/alternative")
5549             (gnus-article-press-button)
5550           (when (eq (gnus-mm-display-part handle) 'internal)
5551             (gnus-set-window-start)))))))
5552
5553 (defsubst gnus-article-mime-total-parts ()
5554   (if (bufferp (car gnus-article-mime-handles))
5555       1 ;; single part
5556     (1- (length gnus-article-mime-handles))))
5557
5558 (defun gnus-mm-display-part (handle)
5559   "Display HANDLE and fix MIME button."
5560   (let ((id (get-text-property (point) 'gnus-part))
5561         (point (point))
5562         (inhibit-read-only t))
5563     (forward-line 1)
5564     (prog1
5565         (let ((window (selected-window))
5566               (mail-parse-charset gnus-newsgroup-charset)
5567               (mail-parse-ignored-charsets
5568                (if (gnus-buffer-live-p gnus-summary-buffer)
5569                    (with-current-buffer gnus-summary-buffer
5570                      gnus-newsgroup-ignored-charsets)
5571                  nil)))
5572           (save-excursion
5573             (unwind-protect
5574                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5575                       (beg (point)))
5576                   (when win
5577                     (select-window win))
5578                   (goto-char point)
5579                   (forward-line)
5580                   (if (mm-handle-displayed-p handle)
5581                       ;; This will remove the part.
5582                       (mm-display-part handle)
5583                     (save-restriction
5584                       (narrow-to-region (point)
5585                                         (if (eobp) (point) (1+ (point))))
5586                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5587                       ;; We narrow to the part itself and
5588                       ;; then call the treatment functions.
5589                       (goto-char (point-min))
5590                       (forward-line 1)
5591                       (narrow-to-region (point) (point-max))
5592                       (gnus-treat-article
5593                        nil id
5594                        (gnus-article-mime-total-parts)
5595                        (mm-handle-media-type handle)))))
5596               (if (window-live-p window)
5597                   (select-window window)))))
5598       (goto-char point)
5599       (gnus-delete-line)
5600       (gnus-insert-mime-button
5601        handle id (list (mm-handle-displayed-p handle)))
5602       (goto-char point))))
5603
5604 (defun gnus-article-goto-part (n)
5605   "Go to MIME part N."
5606   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5607
5608 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5609   (let ((gnus-tmp-name
5610          (or (mail-content-type-get (mm-handle-type handle) 'name)
5611              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5612              (mail-content-type-get (mm-handle-type handle) 'url)
5613              ""))
5614         (gnus-tmp-type (mm-handle-media-type handle))
5615         (gnus-tmp-description (or (mm-handle-description handle) ""))
5616         (gnus-tmp-dots
5617          (if (if displayed (car displayed)
5618                (mm-handle-displayed-p handle))
5619              "" "..."))
5620         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5621                            (buffer-size)))
5622         gnus-tmp-type-long b e)
5623     (when (string-match ".*/" gnus-tmp-name)
5624       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5625     (setq gnus-tmp-type-long (concat gnus-tmp-type
5626                                      (and (not (equal gnus-tmp-name ""))
5627                                           (concat "; " gnus-tmp-name))))
5628     (unless (equal gnus-tmp-description "")
5629       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5630     (unless (bolp)
5631       (insert "\n"))
5632     (setq b (point))
5633     (gnus-eval-format
5634      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5635      `(keymap ,gnus-mime-button-map
5636               gnus-callback gnus-mm-display-part
5637               gnus-part ,gnus-tmp-id
5638               article-type annotation
5639               gnus-data ,handle))
5640     (setq e (if (bolp)
5641                 ;; Exclude a newline.
5642                 (1- (point))
5643               (point)))
5644     (when gnus-article-button-face
5645       (gnus-overlay-put (gnus-make-overlay b e nil t)
5646                         'face gnus-article-button-face))
5647     (widget-convert-button
5648      'link b e
5649      :mime-handle handle
5650      :action 'gnus-widget-press-button
5651      :button-keymap gnus-mime-button-map
5652      :help-echo
5653      (lambda (widget/window &optional overlay pos)
5654        ;; Needed to properly clear the message due to a bug in
5655        ;; wid-edit (XEmacs only).
5656        (if (boundp 'help-echo-owns-message)
5657            (setq help-echo-owns-message t))
5658        (format
5659         "%S: %s the MIME part; %S: more options"
5660         (aref gnus-mouse-2 0)
5661         ;; XEmacs will get a single widget arg; Emacs 21 will get
5662         ;; window, overlay, position.
5663         (if (mm-handle-displayed-p
5664              (if overlay
5665                  (with-current-buffer (gnus-overlay-buffer overlay)
5666                    (widget-get (widget-at (gnus-overlay-start overlay))
5667                                :mime-handle))
5668                (widget-get widget/window :mime-handle)))
5669             "hide" "show")
5670         (aref gnus-down-mouse-3 0))))))
5671
5672 (defun gnus-widget-press-button (elems el)
5673   (goto-char (widget-get elems :from))
5674   (gnus-article-press-button))
5675
5676 (defvar gnus-displaying-mime nil)
5677
5678 (defun gnus-display-mime (&optional ihandles)
5679   "Display the MIME parts."
5680   (save-excursion
5681     (save-selected-window
5682       (let ((window (get-buffer-window gnus-article-buffer))
5683             (point (point)))
5684         (when window
5685           (select-window window)
5686           ;; We have to do this since selecting the window
5687           ;; may change the point.  So we set the window point.
5688           (set-window-point window point)))
5689       (let ((handles ihandles)
5690             (inhibit-read-only t)
5691             handle)
5692         (cond (handles)
5693               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5694                (when gnus-article-emulate-mime
5695                  (mm-uu-dissect-text-parts handles)))
5696               (gnus-article-emulate-mime
5697                (setq handles (mm-uu-dissect))))
5698         (when (and (not ihandles)
5699                    (not gnus-displaying-mime))
5700           ;; Top-level call; we clean up.
5701           (when gnus-article-mime-handles
5702             (mm-destroy-parts gnus-article-mime-handles)
5703             (setq gnus-article-mime-handle-alist nil));; A trick.
5704           (setq gnus-article-mime-handles handles)
5705           ;; We allow users to glean info from the handles.
5706           (when gnus-article-mime-part-function
5707             (gnus-mime-part-function handles)))
5708         (if (and handles
5709                  (or (not (stringp (car handles)))
5710                      (cdr handles)))
5711             (progn
5712               (when (and (not ihandles)
5713                          (not gnus-displaying-mime))
5714                 ;; Clean up for mime parts.
5715                 (article-goto-body)
5716                 (delete-region (point) (point-max)))
5717               (let ((gnus-displaying-mime t))
5718                 (gnus-mime-display-part handles)))
5719           (save-restriction
5720             (article-goto-body)
5721             (narrow-to-region (point) (point-max))
5722             (gnus-treat-article nil 1 1)
5723             (widen)))
5724         (unless ihandles
5725           ;; Highlight the headers.
5726           (save-excursion
5727             (save-restriction
5728               (article-goto-body)
5729               (narrow-to-region (point-min) (point))
5730               (gnus-article-save-original-date
5731                (gnus-treat-article 'head)))))))
5732     ;; Cope with broken MIME messages.
5733     (goto-char (point-max))
5734     (unless (bolp)
5735       (insert "\n"))))
5736
5737 (defcustom gnus-mime-display-multipart-as-mixed nil
5738   "Display \"multipart\" parts as  \"multipart/mixed\".
5739
5740 If t, it overrides nil values of
5741 `gnus-mime-display-multipart-alternative-as-mixed' and
5742 `gnus-mime-display-multipart-related-as-mixed'."
5743   :group 'gnus-article-mime
5744   :type 'boolean)
5745
5746 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5747   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5748   :version "22.1"
5749   :group 'gnus-article-mime
5750   :type 'boolean)
5751
5752 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5753   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5754
5755 If displaying \"text/html\" is discouraged \(see
5756 `mm-discouraged-alternatives'\) images or other material inside a
5757 \"multipart/related\" part might be overlooked when this variable is nil."
5758   :version "22.1"
5759   :group 'gnus-article-mime
5760   :type 'boolean)
5761
5762 (defun gnus-mime-display-part (handle)
5763   (cond
5764    ;; Maybe a broken MIME message.
5765    ((null handle))
5766    ;; Single part.
5767    ((not (stringp (car handle)))
5768     (gnus-mime-display-single handle))
5769    ;; User-defined multipart
5770    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5771     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5772              handle))
5773    ;; multipart/alternative
5774    ((and (equal (car handle) "multipart/alternative")
5775          (not (or gnus-mime-display-multipart-as-mixed
5776                   gnus-mime-display-multipart-alternative-as-mixed)))
5777     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5778       (push (cons id handle) gnus-article-mime-handle-alist)
5779       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5780    ;; multipart/related
5781    ((and (equal (car handle) "multipart/related")
5782          (not (or gnus-mime-display-multipart-as-mixed
5783                   gnus-mime-display-multipart-related-as-mixed)))
5784     ;;;!!!We should find the start part, but we just default
5785     ;;;!!!to the first part.
5786     ;;(gnus-mime-display-part (cadr handle))
5787     ;;;!!! Most multipart/related is an HTML message plus images.
5788     ;;;!!! Unfortunately we are unable to let W3 display those
5789     ;;;!!! included images, so we just display it as a mixed multipart.
5790     ;;(gnus-mime-display-mixed (cdr handle))
5791     ;;;!!! No, w3 can display everything just fine.
5792     (gnus-mime-display-part (cadr handle)))
5793    ((equal (car handle) "multipart/signed")
5794     (gnus-add-wash-type 'signed)
5795     (gnus-mime-display-security handle))
5796    ((equal (car handle) "multipart/encrypted")
5797     (gnus-add-wash-type 'encrypted)
5798     (gnus-mime-display-security handle))
5799    ;; Other multiparts are handled like multipart/mixed.
5800    (t
5801     (gnus-mime-display-mixed (cdr handle)))))
5802
5803 (defun gnus-mime-part-function (handles)
5804   (if (stringp (car handles))
5805       (mapcar 'gnus-mime-part-function (cdr handles))
5806     (funcall gnus-article-mime-part-function handles)))
5807
5808 (defun gnus-mime-display-mixed (handles)
5809   (mapcar 'gnus-mime-display-part handles))
5810
5811 (defun gnus-mime-display-single (handle)
5812   (let ((type (mm-handle-media-type handle))
5813         (ignored gnus-ignored-mime-types)
5814         (not-attachment t)
5815         (move nil)
5816         display text)
5817     (catch 'ignored
5818       (progn
5819         (while ignored
5820           (when (string-match (pop ignored) type)
5821             (throw 'ignored nil)))
5822         (if (and (setq not-attachment
5823                        (and (not (mm-inline-override-p handle))
5824                             (or (not (mm-handle-disposition handle))
5825                                 (equal (car (mm-handle-disposition handle))
5826                                        "inline")
5827                                 (mm-attachment-override-p handle))))
5828                  (mm-automatic-display-p handle)
5829                  (or (and
5830                       (mm-inlinable-p handle)
5831                       (mm-inlined-p handle))
5832                      (mm-automatic-external-display-p type)))
5833             (setq display t)
5834           (when (equal (mm-handle-media-supertype handle) "text")
5835             (setq text t)))
5836         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5837               beg)
5838           (push (cons id handle) gnus-article-mime-handle-alist)
5839           (when (and display
5840                      (equal (mm-handle-media-supertype handle) "message"))
5841             (insert-char
5842              ?\n
5843              (cond ((not (bolp)) 2)
5844                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5845                    (t 1))))
5846           (when (or (not display)
5847                     (not (gnus-unbuttonized-mime-type-p type)))
5848             (gnus-insert-mime-button
5849              handle id (list (or display (and not-attachment text))))
5850             (gnus-article-insert-newline)
5851             ;; Remember modify the number of forward lines.
5852             (setq move t))
5853           (setq beg (point))
5854           (cond
5855            (display
5856             (when move
5857               (forward-line -1)
5858               (setq beg (point)))
5859             (let ((mail-parse-charset gnus-newsgroup-charset)
5860                   (mail-parse-ignored-charsets
5861                    (save-excursion (condition-case ()
5862                                        (set-buffer gnus-summary-buffer)
5863                                      (error))
5864                                    gnus-newsgroup-ignored-charsets)))
5865               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5866             (goto-char (point-max)))
5867            ((and text not-attachment)
5868             (when move
5869               (forward-line -1)
5870               (setq beg (point)))
5871             (gnus-article-insert-newline)
5872             (mm-insert-inline
5873              handle
5874              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5875                                                        'charset)
5876                                 (and (equal type "text/calendar") 'utf-8))))
5877                (cond ((not charset)
5878                       (mm-string-as-multibyte (mm-get-part handle)))
5879                      ((eq charset 'gnus-decoded)
5880                       (with-current-buffer (mm-handle-buffer handle)
5881                         (buffer-string)))
5882                      (t
5883                       (mm-decode-string (mm-get-part handle) charset)))))
5884             (goto-char (point-max))))
5885           ;; Do highlighting.
5886           (save-excursion
5887             (save-restriction
5888               (narrow-to-region beg (point))
5889               (if (eq handle gnus-article-mime-handles)
5890                   ;; The format=flowed case.
5891                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5892                 ;; Don't count signature parts that are never displayed.
5893                 ;; The part number should be re-calculated supposing this
5894                 ;; might be a message/rfc822 part.
5895                 (let (handles)
5896                   (dolist (part gnus-article-mime-handles)
5897                     (unless (or (stringp part)
5898                                 (equal (car (mm-handle-type part))
5899                                        "application/pgp-signature"))
5900                       (push part handles)))
5901                   (gnus-treat-article
5902                    nil (length (memq handle handles)) (length handles)
5903                    (mm-handle-media-type handle)))))))))))
5904
5905 (defun gnus-unbuttonized-mime-type-p (type)
5906   "Say whether TYPE is to be unbuttonized."
5907   (unless gnus-inhibit-mime-unbuttonizing
5908     (when (catch 'found
5909             (let ((types gnus-unbuttonized-mime-types))
5910               (while types
5911                 (when (string-match (pop types) type)
5912                   (throw 'found t)))))
5913       (not (catch 'found
5914              (let ((types gnus-buttonized-mime-types))
5915                (while types
5916                  (when (string-match (pop types) type)
5917                    (throw 'found t)))))))))
5918
5919 (defun gnus-article-insert-newline ()
5920   "Insert a newline, but mark it as undeletable."
5921   (gnus-put-text-property
5922    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5923
5924 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5925   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5926          (ihandles handles)
5927          (point (point))
5928          handle (inhibit-read-only t) from props begend not-pref)
5929     (save-window-excursion
5930       (save-restriction
5931         (when ibegend
5932           (narrow-to-region (car ibegend)
5933                             (or (cdr ibegend)
5934                                 (progn
5935                                   (goto-char (car ibegend))
5936                                   (forward-line 2)
5937                                   (point))))
5938           (delete-region (point-min) (point-max))
5939           (mm-remove-parts handles))
5940         (setq begend (list (point-marker)))
5941         ;; Do the toggle.
5942         (unless (setq not-pref (cadr (member preferred ihandles)))
5943           (setq not-pref (car ihandles)))
5944         (when (or ibegend
5945                   (not preferred)
5946                   (not (gnus-unbuttonized-mime-type-p
5947                         "multipart/alternative")))
5948           (gnus-add-text-properties
5949            (setq from (point))
5950            (progn
5951              (insert (format "%d.  " id))
5952              (point))
5953            `(gnus-callback
5954              (lambda (handles)
5955                (unless ,(not ibegend)
5956                  (setq gnus-article-mime-handle-alist
5957                        ',gnus-article-mime-handle-alist))
5958                (gnus-mime-display-alternative
5959                 ',ihandles ',not-pref ',begend ,id))
5960              keymap ,gnus-mime-button-map
5961              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5962              face ,gnus-article-button-face
5963              gnus-part ,id
5964              article-type multipart))
5965           (widget-convert-button 'link from (point)
5966                                  :action 'gnus-widget-press-button
5967                                  :button-keymap gnus-widget-button-keymap)
5968           ;; Do the handles
5969           (while (setq handle (pop handles))
5970             (gnus-add-text-properties
5971              (setq from (point))
5972              (progn
5973                (insert (format "(%c) %-18s"
5974                                (if (equal handle preferred) ?* ? )
5975                                (mm-handle-media-type handle)))
5976                (point))
5977              `(gnus-callback
5978                (lambda (handles)
5979                  (unless ,(not ibegend)
5980                    (setq gnus-article-mime-handle-alist
5981                          ',gnus-article-mime-handle-alist))
5982                  (gnus-mime-display-alternative
5983                   ',ihandles ',handle ',begend ,id))
5984                keymap ,gnus-mime-button-map
5985                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5986                face ,gnus-article-button-face
5987                gnus-part ,id
5988                gnus-data ,handle))
5989             (widget-convert-button 'link from (point)
5990                                    :action 'gnus-widget-press-button
5991                                    :button-keymap gnus-widget-button-keymap)
5992             (insert "  "))
5993           (insert "\n\n"))
5994         (when preferred
5995           (if (stringp (car preferred))
5996               (gnus-display-mime preferred)
5997             (let ((mail-parse-charset gnus-newsgroup-charset)
5998                   (mail-parse-ignored-charsets
5999                    (with-current-buffer gnus-summary-buffer
6000                      gnus-newsgroup-ignored-charsets)))
6001               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6002               ;; Do highlighting.
6003               (save-excursion
6004                 (save-restriction
6005                   (narrow-to-region (car begend) (point-max))
6006                   (gnus-treat-article
6007                    nil (length gnus-article-mime-handle-alist)
6008                    (gnus-article-mime-total-parts)
6009                    (mm-handle-media-type handle))))))
6010           (goto-char (point-max))
6011           (setcdr begend (point-marker)))))
6012     (when ibegend
6013       (goto-char point))))
6014
6015 (defconst gnus-article-wash-status-strings
6016   (let ((alist '((cite "c" "Possible hidden citation text"
6017                        " " "All citation text visible")
6018                  (headers "h" "Hidden headers"
6019                           " " "All headers visible.")
6020                  (pgp "p" "Encrypted or signed message status hidden"
6021                       " " "No hidden encryption nor digital signature status")
6022                  (signature "s" "Signature has been hidden"
6023                             " " "Signature is visible")
6024                  (overstrike "o" "Overstrike (^H) characters applied"
6025                              " " "No overstrike characters applied")
6026                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6027                            " " "No /*_emphasis_*/ characters applied")))
6028         result)
6029     (dolist (entry alist result)
6030       (let ((key (nth 0 entry))
6031             (on (copy-sequence (nth 1 entry)))
6032             (on-help (nth 2 entry))
6033             (off (copy-sequence (nth 3 entry)))
6034             (off-help (nth 4 entry)))
6035         (put-text-property 0 1 'help-echo on-help on)
6036         (put-text-property 0 1 'help-echo off-help off)
6037         (push (list key on off) result))))
6038   "Alist of strings describing wash status in the mode line.
6039 Each entry has the form (KEY ON OF), where the KEY is a symbol
6040 representing the particular washing function, ON is the string to use
6041 in the article mode line when the washing function is active, and OFF
6042 is the string to use when it is inactive.")
6043
6044 (defun gnus-article-wash-status-entry (key value)
6045   (let ((entry (assoc key gnus-article-wash-status-strings)))
6046     (if value (nth 1 entry) (nth 2 entry))))
6047
6048 (defun gnus-article-wash-status ()
6049   "Return a string which display status of article washing."
6050   (with-current-buffer gnus-article-buffer
6051     (let ((cite (memq 'cite gnus-article-wash-types))
6052           (headers (memq 'headers gnus-article-wash-types))
6053           (boring (memq 'boring-headers gnus-article-wash-types))
6054           (pgp (memq 'pgp gnus-article-wash-types))
6055           (pem (memq 'pem gnus-article-wash-types))
6056           (signed (memq 'signed gnus-article-wash-types))
6057           (encrypted (memq 'encrypted gnus-article-wash-types))
6058           (signature (memq 'signature gnus-article-wash-types))
6059           (overstrike (memq 'overstrike gnus-article-wash-types))
6060           (emphasis (memq 'emphasis gnus-article-wash-types)))
6061       (concat
6062        (gnus-article-wash-status-entry 'cite cite)
6063        (gnus-article-wash-status-entry 'headers (or headers boring))
6064        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6065        (gnus-article-wash-status-entry 'signature signature)
6066        (gnus-article-wash-status-entry 'overstrike overstrike)
6067        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6068
6069 (defun gnus-add-wash-type (type)
6070   "Add a washing of TYPE to the current status."
6071   (add-to-list 'gnus-article-wash-types type))
6072
6073 (defun gnus-delete-wash-type (type)
6074   "Add a washing of TYPE to the current status."
6075   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6076
6077 (defun gnus-add-image (category image)
6078   "Add IMAGE of CATEGORY to the list of displayed images."
6079   (let ((entry (assq category gnus-article-image-alist)))
6080     (unless entry
6081       (setq entry (list category))
6082       (push entry gnus-article-image-alist))
6083     (nconc entry (list image))))
6084
6085 (defun gnus-delete-images (category)
6086   "Delete all images in CATEGORY."
6087   (let ((entry (assq category gnus-article-image-alist)))
6088     (dolist (image (cdr entry))
6089       (gnus-remove-image image category))
6090     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6091     (gnus-delete-wash-type category)))
6092
6093 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6094
6095 (defun gnus-article-maybe-hide-headers ()
6096   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6097 Provided for backwards compatibility."
6098   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6099                  (not (with-current-buffer gnus-summary-buffer
6100                         gnus-have-all-headers)))
6101              (not gnus-inhibit-hiding))
6102     (gnus-article-hide-headers)))
6103
6104 ;;; Article savers.
6105
6106 (defun gnus-output-to-file (file-name)
6107   "Append the current article to a file named FILE-NAME.
6108 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6109 text and used as the value of the coding cookie which is added to the
6110 top of a file.  Otherwise, this function saves a raw article without
6111 the coding cookie."
6112   (let* ((artbuf (current-buffer))
6113          (file-name-coding-system nnmail-pathname-coding-system)
6114          (coding gnus-article-save-coding-system)
6115          (coding-system-for-read (if coding
6116                                      nil ;; Rely on the coding cookie.
6117                                    mm-text-coding-system))
6118          (coding-system-for-write (or coding
6119                                       mm-text-coding-system-for-write
6120                                       mm-text-coding-system))
6121          (exists (file-exists-p file-name)))
6122     (with-temp-buffer
6123       (when exists
6124         (insert-file-contents file-name)
6125         (goto-char (point-min))
6126         ;; Remove the existing coding cookie.
6127         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6128           (delete-region (match-beginning 0) (match-end 0))))
6129       (goto-char (point-max))
6130       (insert-buffer-substring artbuf)
6131       ;; Append newline at end of the buffer as separator, and then
6132       ;; save it to file.
6133       (goto-char (point-max))
6134       (insert "\n")
6135       (when coding
6136         ;; If the coding system is not suitable to encode the text,
6137         ;; ask a user for a proper one.
6138         (when (fboundp 'select-safe-coding-system)
6139           (setq coding (coding-system-base
6140                         (save-window-excursion
6141                           (select-safe-coding-system (point-min) (point-max)
6142                                                      coding))))
6143           (setq coding-system-for-write
6144                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6145                     coding)))
6146         (goto-char (point-min))
6147         ;; Add the coding cookie.
6148         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6149                         coding-system-for-write)))
6150       (if exists
6151           (progn
6152             (write-region (point-min) (point-max) file-name nil 'no-message)
6153             (message "Appended to %s" file-name))
6154         (write-region (point-min) (point-max) file-name))))
6155   t)
6156
6157 (defun gnus-narrow-to-page (&optional arg)
6158   "Narrow the article buffer to a page.
6159 If given a numerical ARG, move forward ARG pages."
6160   (interactive "P")
6161   (setq arg (if arg (prefix-numeric-value arg) 0))
6162   (with-current-buffer gnus-article-buffer
6163     (widen)
6164     ;; Remove any old next/prev buttons.
6165     (when (gnus-visual-p 'page-marker)
6166       (let ((inhibit-read-only t))
6167         (gnus-remove-text-with-property 'gnus-prev)
6168         (gnus-remove-text-with-property 'gnus-next)))
6169     (let (st nd pt)
6170       (when (save-excursion
6171               (cond ((< arg 0)
6172                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6173                          (prog1
6174                              (setq nd (match-beginning 0)
6175                                    pt nd)
6176                            (when (re-search-backward page-delimiter nil t)
6177                              (setq st (match-end 0))))
6178                        (when (re-search-forward page-delimiter nil t)
6179                          (setq nd (match-beginning 0)
6180                                pt (point-min)))))
6181                     ((> arg 0)
6182                      (if (re-search-forward page-delimiter nil 'move arg)
6183                          (prog1
6184                              (setq st (match-end 0)
6185                                    pt st)
6186                            (when (re-search-forward page-delimiter nil t)
6187                              (setq nd (match-beginning 0))))
6188                        (when (re-search-backward page-delimiter nil t)
6189                          (setq st (match-end 0)
6190                                pt (point-max)))))
6191                     (t
6192                      (when (re-search-backward page-delimiter nil t)
6193                        (goto-char (setq st (match-end 0))))
6194                      (when (re-search-forward page-delimiter nil t)
6195                        (setq nd (match-beginning 0)))
6196                      (or st nd))))
6197         (setq gnus-page-broken t)
6198         (when pt (goto-char pt))
6199         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6200         (when (gnus-visual-p 'page-marker)
6201           (save-excursion
6202             (when nd
6203               (goto-char nd)
6204               (gnus-insert-next-page-button))
6205             (when st
6206               (goto-char st)
6207               (gnus-insert-prev-page-button))))))))
6208
6209 ;; Article mode commands
6210
6211 (defun gnus-article-goto-next-page ()
6212   "Show the next page of the article."
6213   (interactive)
6214   (when (gnus-article-next-page)
6215     (goto-char (point-min))
6216     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6217
6218
6219 (defun gnus-article-goto-prev-page ()
6220   "Show the previous page of the article."
6221   (interactive)
6222   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6223       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6224     (gnus-article-prev-page nil)))
6225
6226 ;; This is cleaner but currently breaks `gnus-pick-mode':
6227 ;;
6228 ;; (defun gnus-article-goto-next-page ()
6229 ;;   "Show the next page of the article."
6230 ;;   (interactive)
6231 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6232 ;;     (gnus-summary-next-page)))
6233 ;;
6234 ;; (defun gnus-article-goto-prev-page ()
6235 ;;   "Show the next page of the article."
6236 ;;   (interactive)
6237 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6238 ;;     (gnus-summary-prev-page)))
6239
6240 (defun gnus-article-next-page (&optional lines)
6241   "Show the next page of the current article.
6242 If end of article, return non-nil.  Otherwise return nil.
6243 Argument LINES specifies lines to be scrolled up."
6244   (interactive "p")
6245   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6246   (if (and (not (and gnus-article-over-scroll
6247                      (> (count-lines (window-start) (point-max))
6248                         (if (featurep 'xemacs)
6249                             (or lines (1- (window-height)))
6250                           (+ (or lines (1- (window-height))) scroll-margin)))))
6251            (save-excursion
6252              (end-of-line)
6253              (and (pos-visible-in-window-p)     ;Not continuation line.
6254                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6255       ;; Nothing in this page.
6256       (if (or (not gnus-page-broken)
6257               (save-excursion
6258                 (save-restriction
6259                   (widen)
6260                   (forward-line)
6261                   (eobp)))) ;Real end-of-buffer?
6262           (progn
6263             (when gnus-article-over-scroll
6264               (gnus-article-next-page-1 lines))
6265             t)                  ;Nothing more.
6266         (gnus-narrow-to-page 1)         ;Go to next page.
6267         nil)
6268     ;; More in this page.
6269     (gnus-article-next-page-1 lines)
6270     nil))
6271
6272 (defmacro gnus-article-beginning-of-window ()
6273   "Move point to the beginning of the window.
6274 In Emacs, the point is placed at the line number which `scroll-margin'
6275 specifies."
6276   (if (featurep 'xemacs)
6277       '(move-to-window-line 0)
6278     '(move-to-window-line
6279       (min (max 0 scroll-margin)
6280            (max 1 (- (window-height)
6281                      (if mode-line-format 1 0)
6282                      (if header-line-format 1 0)
6283                      2))))))
6284
6285 (defun gnus-article-next-page-1 (lines)
6286   (unless (featurep 'xemacs)
6287     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
6288     ;; too many number of lines if `scroll-margin' is set as two or greater.
6289     (when (and (numberp lines)
6290                (> lines 0)
6291                (> scroll-margin 0))
6292       (setq lines (min lines
6293                        (max 0 (- (count-lines (window-start) (point-max))
6294                                  scroll-margin))))))
6295   (condition-case ()
6296       (let ((scroll-in-place nil))
6297         (scroll-up lines))
6298     (end-of-buffer
6299      ;; Long lines may cause an end-of-buffer error.
6300      (goto-char (point-max))))
6301   (gnus-article-beginning-of-window))
6302
6303 (defun gnus-article-prev-page (&optional lines)
6304   "Show previous page of current article.
6305 Argument LINES specifies lines to be scrolled down."
6306   (interactive "p")
6307   (move-to-window-line 0)
6308   (if (and gnus-page-broken
6309            (bobp)
6310            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6311       (progn
6312         (gnus-narrow-to-page -1)        ;Go to previous page.
6313         (goto-char (point-max))
6314         (recenter (if gnus-article-over-scroll
6315                       (if lines
6316                           (max (if (featurep 'xemacs)
6317                                    lines
6318                                  (+ lines scroll-margin))
6319                                3)
6320                         (- (window-height) 2))
6321                     -1)))
6322     (prog1
6323         (condition-case ()
6324             (let ((scroll-in-place nil))
6325               (scroll-down lines))
6326           (beginning-of-buffer
6327            (goto-char (point-min))))
6328       (gnus-article-beginning-of-window))))
6329
6330 (defun gnus-article-only-boring-p ()
6331   "Decide whether there is only boring text remaining in the article.
6332 Something \"interesting\" is a word of at least two letters that does
6333 not have a face in `gnus-article-boring-faces'."
6334   (when (and gnus-article-skip-boring
6335              (boundp 'gnus-article-boring-faces)
6336              (symbol-value 'gnus-article-boring-faces))
6337     (save-excursion
6338       (let ((inhibit-point-motion-hooks t))
6339         (catch 'only-boring
6340           (while (re-search-forward "\\b\\w\\w" nil t)
6341             (forward-char -1)
6342             (when (not (gnus-intersection
6343                         (gnus-faces-at (point))
6344                         (symbol-value 'gnus-article-boring-faces)))
6345               (throw 'only-boring nil)))
6346           (throw 'only-boring t))))))
6347
6348 (defun gnus-article-refer-article ()
6349   "Read article specified by message-id around point."
6350   (interactive)
6351   (save-excursion
6352     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6353     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6354     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6355         (let ((msg-id (concat "<" (match-string 0) ">")))
6356           (set-buffer gnus-summary-buffer)
6357           (gnus-summary-refer-article msg-id))
6358       (error "No references around point"))))
6359
6360 (defun gnus-article-show-summary ()
6361   "Reconfigure windows to show summary buffer."
6362   (interactive)
6363   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6364       (error "There is no summary buffer for this article buffer")
6365     (gnus-article-set-globals)
6366     (gnus-configure-windows 'article)
6367     (gnus-summary-goto-subject gnus-current-article)
6368     (gnus-summary-position-point)))
6369
6370 (defun gnus-article-describe-briefly ()
6371   "Describe article mode commands briefly."
6372   (interactive)
6373   (gnus-message 6 (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page   \\[gnus-article-goto-prev-page]:Prev page  \\[gnus-article-show-summary]:Show summary  \\[gnus-info-find-node]:Run Info  \\[gnus-article-describe-briefly]:This help")))
6374
6375 (defun gnus-article-check-buffer ()
6376   "Beep if not in an article buffer."
6377   (unless (equal major-mode 'gnus-article-mode)
6378     (error "Command invoked outside of a Gnus article buffer")))
6379
6380 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6381   "Read a summary buffer key sequence and execute it from the article buffer."
6382   (interactive "P")
6383   (gnus-article-check-buffer)
6384   (let ((nosaves
6385          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6386            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6387            "=" "^" "\M-^" "|"))
6388         (nosave-but-article
6389          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6390            "An" "Ap" [?A (meta return)] [?A delete]))
6391         (nosave-in-article
6392          '("AS" "\C-d"))
6393         (up-to-top
6394          '("n" "Gn" "p" "Gp"))
6395         keys new-sum-point)
6396     (with-current-buffer gnus-article-current-summary
6397       (let (gnus-pick-mode)
6398         (setq unread-command-events (nconc unread-command-events
6399                                            (list (or key last-command-event)))
6400               keys (if (featurep 'xemacs)
6401                        (events-to-keys (read-key-sequence nil t))
6402                      (read-key-sequence nil t)))))
6403
6404     (message "")
6405
6406     (cond
6407      ((eq (aref keys (1- (length keys))) ?\C-h)
6408       (gnus-article-describe-bindings (substring keys 0 -1)))
6409      ((or (member keys nosaves)
6410           (member keys nosave-but-article)
6411           (member keys nosave-in-article))
6412       (let (func)
6413         (save-window-excursion
6414           (pop-to-buffer gnus-article-current-summary)
6415           ;; We disable the pick minor mode commands.
6416           (let (gnus-pick-mode)
6417             (setq func (key-binding keys t))))
6418         (if (or (not func)
6419                 (numberp func))
6420             (ding)
6421           (unless (member keys nosave-in-article)
6422             (set-buffer gnus-article-current-summary))
6423           (call-interactively func)
6424           (setq new-sum-point (point)))
6425         (when (member keys nosave-but-article)
6426           (pop-to-buffer gnus-article-buffer))))
6427      (t
6428       ;; These commands should restore window configuration.
6429       (let ((obuf (current-buffer))
6430             (owin (current-window-configuration))
6431             win func in-buffer selected new-sum-start new-sum-hscroll err)
6432         (cond (not-restore-window
6433                (pop-to-buffer gnus-article-current-summary)
6434                (setq win (selected-window)))
6435               ((setq win (get-buffer-window gnus-article-current-summary))
6436                (select-window win))
6437               (t
6438                (let ((summary-buffer gnus-article-current-summary))
6439                  (gnus-configure-windows 'article)
6440                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6441                    (let ((gnus-buffer-configuration
6442                           '((article ((vertical 1.0
6443                                                 (summary 0.25 point)
6444                                                 (article 1.0)))))))
6445                      (gnus-configure-windows 'article))
6446                    (setq win (get-buffer-window summary-buffer 'visible)))
6447                  (gnus-select-frame-set-input-focus (window-frame win))
6448                  (select-window win))))
6449         (setq in-buffer (current-buffer))
6450         ;; We disable the pick minor mode commands.
6451         (if (and (setq func (let (gnus-pick-mode)
6452                               (key-binding keys t)))
6453                  (functionp func)
6454                  (condition-case code
6455                      (progn
6456                        (call-interactively func)
6457                        t)
6458                    (error
6459                     (setq err code)
6460                     nil)))
6461             (progn
6462               (when (eq win (selected-window))
6463                 (setq new-sum-point (point)
6464                       new-sum-start (window-start win)
6465                       new-sum-hscroll (window-hscroll win)))
6466               (when (or (eq in-buffer (current-buffer))
6467                         (when (eq obuf (current-buffer))
6468                           (set-buffer in-buffer)
6469                           t))
6470                 (setq selected (gnus-summary-select-article))
6471                 (set-buffer obuf)
6472                 (unless not-restore-window
6473                   (set-window-configuration owin))
6474                 (when (and (eq selected 'old)
6475                            new-sum-point)
6476                   (set-window-start (get-buffer-window (current-buffer))
6477                                     1)
6478                   (set-window-point (get-buffer-window (current-buffer))
6479                                     (if (article-goto-body)
6480                                         (1- (point))
6481                                       (point))))
6482                 (when (and (not not-restore-window)
6483                            new-sum-point
6484                            (window-live-p win)
6485                            (with-current-buffer (window-buffer win)
6486                              (eq major-mode 'gnus-summary-mode)))
6487                   (set-window-point win new-sum-point)
6488                   (set-window-start win new-sum-start)
6489                   (set-window-hscroll win new-sum-hscroll))))
6490           (set-window-configuration owin)
6491           (if err
6492               (signal (car err) (cdr err))
6493             (ding))))))))
6494
6495 (defun gnus-article-read-summary-send-keys ()
6496   (interactive)
6497   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6498     (gnus-article-read-summary-keys)))
6499
6500 (defun gnus-article-describe-key (key)
6501   "Display documentation of the function invoked by KEY.
6502 KEY is a string or a vector."
6503   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6504                        (read-key-sequence "Describe key: "))))
6505   (gnus-article-check-buffer)
6506   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6507                                   gnus-article-read-summary-send-keys))
6508       (with-current-buffer gnus-article-current-summary
6509         (setq unread-command-events
6510               (if (featurep 'xemacs)
6511                   (append key nil)
6512                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6513                                         (list 'meta (- x 128))
6514                                       x))
6515                         key)))
6516         (let ((cursor-in-echo-area t)
6517               gnus-pick-mode)
6518           (describe-key (read-key-sequence nil t))))
6519     (describe-key key)))
6520
6521 (defun gnus-article-describe-key-briefly (key &optional insert)
6522   "Display documentation of the function invoked by KEY.
6523 KEY is a string or a vector."
6524   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6525                        (read-key-sequence "Describe key: "))
6526                      current-prefix-arg))
6527   (gnus-article-check-buffer)
6528   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6529                                   gnus-article-read-summary-send-keys))
6530       (with-current-buffer gnus-article-current-summary
6531         (setq unread-command-events
6532               (if (featurep 'xemacs)
6533                   (append key nil)
6534                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6535                                         (list 'meta (- x 128))
6536                                       x))
6537                         key)))
6538         (let ((cursor-in-echo-area t)
6539               gnus-pick-mode)
6540           (describe-key-briefly (read-key-sequence nil t) insert)))
6541     (describe-key-briefly key insert)))
6542
6543 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6544 (defvar gnus-agent-summary-mode)
6545 (defvar gnus-draft-mode)
6546 ;; Calling help-buffer will autoload help-mode.
6547 (defvar help-xref-stack-item)
6548
6549 (defun gnus-article-describe-bindings (&optional prefix)
6550   "Show a list of all defined keys, and their definitions.
6551 The optional argument PREFIX, if non-nil, should be a key sequence;
6552 then we display only bindings that start with that prefix."
6553   (interactive)
6554   (gnus-article-check-buffer)
6555   (let ((keymap (copy-keymap gnus-article-mode-map))
6556         (map (copy-keymap gnus-article-send-map))
6557         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6558         parent agent draft)
6559     (define-key keymap "S" map)
6560     (define-key map [t] nil)
6561     (with-current-buffer gnus-article-current-summary
6562       (set-keymap-parent
6563        keymap
6564        (if (setq parent (keymap-parent gnus-article-mode-map))
6565            (prog1
6566                (setq parent (copy-keymap parent))
6567              (set-keymap-parent parent (current-local-map)))
6568          (current-local-map)))
6569       (set-keymap-parent map (key-binding "S"))
6570       (let (key def gnus-pick-mode)
6571         (while sumkeys
6572           (setq key (pop sumkeys))
6573           (cond ((and (vectorp key) (= (length key) 1)
6574                       (consp (setq def (aref key 0)))
6575                       (numberp (car def)) (numberp (cdr def)))
6576                  (when (< (max (car def) (cdr def)) 128)
6577                    (setq sumkeys
6578                          (append (mapcar
6579                                   #'vector
6580                                   (nreverse (gnus-uncompress-range def)))
6581                                  sumkeys))))
6582                 ((setq def (key-binding key))
6583                  (unless (eq def 'undefined)
6584                    (define-key keymap key def))))))
6585       (when (boundp 'gnus-agent-summary-mode)
6586         (setq agent gnus-agent-summary-mode))
6587       (when (boundp 'gnus-draft-mode)
6588         (setq draft gnus-draft-mode)))
6589     (with-temp-buffer
6590       (use-local-map keymap)
6591       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6592       (set (make-local-variable 'gnus-draft-mode) draft)
6593       (describe-bindings prefix))
6594     (let ((item `((lambda (prefix)
6595                     (with-current-buffer ,(current-buffer)
6596                       (gnus-article-describe-bindings prefix)))
6597                   ,prefix)))
6598       (with-current-buffer (if (fboundp 'help-buffer)
6599                                (let (help-xref-following) (help-buffer))
6600                              "*Help*") ;; Emacs 21
6601         (setq help-xref-stack-item item)))))
6602
6603 (defun gnus-article-reply-with-original (&optional wide)
6604   "Start composing a reply mail to the current message.
6605 The text in the region will be yanked.  If the region isn't active,
6606 the entire article will be yanked."
6607   (interactive)
6608   (let ((article (cdr gnus-article-current))
6609         contents)
6610     (if (not (gnus-region-active-p))
6611         (with-current-buffer gnus-summary-buffer
6612           (gnus-summary-reply (list (list article)) wide))
6613       (setq contents (buffer-substring (point) (mark t)))
6614       ;; Deactivate active regions.
6615       (when (and (boundp 'transient-mark-mode)
6616                  transient-mark-mode)
6617         (setq mark-active nil))
6618       (with-current-buffer gnus-summary-buffer
6619         (gnus-summary-reply
6620          (list (list article contents)) wide)))))
6621
6622 (defun gnus-article-wide-reply-with-original ()
6623   "Start composing a wide reply mail to the current message.
6624 The text in the region will be yanked.  If the region isn't active,
6625 the entire article will be yanked."
6626   (interactive)
6627   (gnus-article-reply-with-original t))
6628
6629 (defun gnus-article-followup-with-original ()
6630   "Compose a followup to the current article.
6631 The text in the region will be yanked.  If the region isn't active,
6632 the entire article will be yanked."
6633   (interactive)
6634   (let ((article (cdr gnus-article-current))
6635         contents)
6636       (if (not (gnus-region-active-p))
6637           (with-current-buffer gnus-summary-buffer
6638             (gnus-summary-followup (list (list article))))
6639         (setq contents (buffer-substring (point) (mark t)))
6640         ;; Deactivate active regions.
6641         (when (and (boundp 'transient-mark-mode)
6642                    transient-mark-mode)
6643           (setq mark-active nil))
6644         (with-current-buffer gnus-summary-buffer
6645           (gnus-summary-followup
6646            (list (list article contents)))))))
6647
6648 (defun gnus-article-hide (&optional arg force)
6649   "Hide all the gruft in the current article.
6650 This means that signatures, cited text and (some) headers will be
6651 hidden.
6652 If given a prefix, show the hidden text instead."
6653   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6654   (gnus-article-hide-headers arg)
6655   (gnus-article-hide-list-identifiers arg)
6656   (gnus-article-hide-citation-maybe arg force)
6657   (gnus-article-hide-signature arg))
6658
6659 (defun gnus-article-maybe-highlight ()
6660   "Do some article highlighting if article highlighting is requested."
6661   (when (gnus-visual-p 'article-highlight 'highlight)
6662     (gnus-article-highlight-some)))
6663
6664 (defun gnus-check-group-server ()
6665   ;; Make sure the connection to the server is alive.
6666   (unless (gnus-server-opened
6667            (gnus-find-method-for-group gnus-newsgroup-name))
6668     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6669     (gnus-request-group gnus-newsgroup-name t)))
6670
6671 (eval-when-compile
6672   (autoload 'nneething-get-file-name "nneething"))
6673
6674 (defun gnus-request-article-this-buffer (article group)
6675   "Get an article and insert it into this buffer."
6676   (let (do-update-line sparse-header)
6677     (prog1
6678         (save-excursion
6679           (erase-buffer)
6680           (gnus-kill-all-overlays)
6681           (setq group (or group gnus-newsgroup-name))
6682
6683           ;; Using `gnus-request-article' directly will insert the article into
6684           ;; `nntp-server-buffer' - so we'll save some time by not having to
6685           ;; copy it from the server buffer into the article buffer.
6686
6687           ;; We only request an article by message-id when we do not have the
6688           ;; headers for it, so we'll have to get those.
6689           (when (stringp article)
6690             (gnus-read-header article))
6691
6692           ;; If the article number is negative, that means that this article
6693           ;; doesn't belong in this newsgroup (possibly), so we find its
6694           ;; message-id and request it by id instead of number.
6695           (when (and (numberp article)
6696                      gnus-summary-buffer
6697                      (get-buffer gnus-summary-buffer)
6698                      (gnus-buffer-exists-p gnus-summary-buffer))
6699             (with-current-buffer gnus-summary-buffer
6700               (let ((header (gnus-summary-article-header article)))
6701                 (when (< article 0)
6702                   (cond
6703                    ((memq article gnus-newsgroup-sparse)
6704                     ;; This is a sparse gap article.
6705                     (setq do-update-line article)
6706                     (setq article (mail-header-id header))
6707                     (setq sparse-header (gnus-read-header article))
6708                     (setq gnus-newsgroup-sparse
6709                           (delq article gnus-newsgroup-sparse)))
6710                    ((vectorp header)
6711                     ;; It's a real article.
6712                     (setq article (mail-header-id header)))
6713                    (t
6714                     ;; It is an extracted pseudo-article.
6715                     (setq article 'pseudo)
6716                     (gnus-request-pseudo-article header))))
6717
6718                 (let ((method (gnus-find-method-for-group
6719                                gnus-newsgroup-name)))
6720                   (when (and (eq (car method) 'nneething)
6721                              (vectorp header))
6722                     (let ((dir (nneething-get-file-name
6723                                 (mail-header-id header))))
6724                       (when (and (stringp dir)
6725                                  (file-directory-p dir))
6726                         (setq article 'nneething)
6727                         (gnus-group-enter-directory dir))))))))
6728
6729           (cond
6730            ;; Refuse to select canceled articles.
6731            ((and (numberp article)
6732                  gnus-summary-buffer
6733                  (get-buffer gnus-summary-buffer)
6734                  (gnus-buffer-exists-p gnus-summary-buffer)
6735                  (eq (cdr (with-current-buffer gnus-summary-buffer
6736                             (assq article gnus-newsgroup-reads)))
6737                      gnus-canceled-mark))
6738             nil)
6739            ;; We first check `gnus-original-article-buffer'.
6740            ((and (get-buffer gnus-original-article-buffer)
6741                  (numberp article)
6742                  (with-current-buffer gnus-original-article-buffer
6743                    (and (equal (car gnus-original-article) group)
6744                         (eq (cdr gnus-original-article) article))))
6745             ;; `insert-buffer-substring' would incorrectly use the
6746             ;; equivalent of string-make-multibyte which amount to decoding
6747             ;; with locale-coding-system, causing failure of
6748             ;; subsequent decoding.
6749             (insert (mm-string-to-multibyte
6750                      (with-current-buffer gnus-original-article-buffer
6751                        (buffer-substring (point-min) (point-max)))))
6752             'article)
6753            ;; Check the backlog.
6754            ((and gnus-keep-backlog
6755                  (gnus-backlog-request-article group article (current-buffer)))
6756             'article)
6757            ;; Check asynchronous pre-fetch.
6758            ((gnus-async-request-fetched-article group article (current-buffer))
6759             (gnus-async-prefetch-next group article gnus-summary-buffer)
6760             (when (and (numberp article) gnus-keep-backlog)
6761               (gnus-backlog-enter-article group article (current-buffer)))
6762             'article)
6763            ;; Check the cache.
6764            ((and gnus-use-cache
6765                  (numberp article)
6766                  (gnus-cache-request-article article group))
6767             'article)
6768            ;; Check the agent cache.
6769            ((gnus-agent-request-article article group)
6770             'article)
6771            ;; Get the article and put into the article buffer.
6772            ((or (stringp article)
6773                 (numberp article))
6774             (let ((gnus-override-method gnus-override-method)
6775                   (methods (and (stringp article)
6776                                 gnus-refer-article-method))
6777                   (backend (car (gnus-find-method-for-group
6778                                  gnus-newsgroup-name)))
6779                   result
6780                   (inhibit-read-only t))
6781               (if (or (not (listp methods))
6782                       (and (symbolp (car methods))
6783                            (assq (car methods) nnoo-definition-alist)))
6784                   (setq methods (list methods)))
6785               (when (and (null gnus-override-method)
6786                          methods)
6787                 (setq gnus-override-method (pop methods)))
6788               (while (not result)
6789                 (when (eq gnus-override-method 'current)
6790                   (setq gnus-override-method
6791                         (with-current-buffer gnus-summary-buffer
6792                           gnus-current-select-method)))
6793                 (erase-buffer)
6794                 (gnus-kill-all-overlays)
6795                 (let ((gnus-newsgroup-name group))
6796                   (gnus-check-group-server))
6797                 (cond
6798                  ((gnus-request-article article group (current-buffer))
6799                   (when (numberp article)
6800                     (gnus-async-prefetch-next group article
6801                                               gnus-summary-buffer)
6802                     (when gnus-keep-backlog
6803                       (gnus-backlog-enter-article
6804                        group article (current-buffer))))
6805                   (setq result 'article))
6806                  (methods
6807                   (setq gnus-override-method (pop methods)))
6808                  ((not (string-match "^400 "
6809                                      (nnheader-get-report backend)))
6810                   ;; If we get 400 server disconnect, reconnect and
6811                   ;; retry; otherwise, assume the article has expired.
6812                   (setq result 'done))))
6813               (and (eq result 'article) 'article)))
6814            ;; It was a pseudo.
6815            (t article)))
6816
6817       ;; Associate this article with the current summary buffer.
6818       (setq gnus-article-current-summary gnus-summary-buffer)
6819
6820       ;; Take the article from the original article buffer
6821       ;; and place it in the buffer it's supposed to be in.
6822       (when (and (get-buffer gnus-article-buffer)
6823                  (equal (buffer-name (current-buffer))
6824                         (buffer-name (get-buffer gnus-article-buffer))))
6825         (save-excursion
6826           (if (get-buffer gnus-original-article-buffer)
6827               (set-buffer gnus-original-article-buffer)
6828             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6829             (buffer-disable-undo)
6830             (setq major-mode 'gnus-original-article-mode)
6831             (setq buffer-read-only t))
6832           (let ((inhibit-read-only t))
6833             (erase-buffer)
6834             (insert-buffer-substring gnus-article-buffer))
6835           (setq gnus-original-article (cons group article)))
6836
6837         ;; Decode charsets.
6838         (run-hooks 'gnus-article-decode-hook)
6839         ;; Mark article as decoded or not.
6840         (setq gnus-article-decoded-p gnus-article-decode-hook))
6841
6842       ;; Update sparse articles.
6843       (when (and do-update-line
6844                  (or (numberp article)
6845                      (stringp article)))
6846         (let ((buf (current-buffer)))
6847           (set-buffer gnus-summary-buffer)
6848           (gnus-summary-update-article do-update-line sparse-header)
6849           (gnus-summary-goto-subject do-update-line nil t)
6850           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6851                             (point))
6852           (set-buffer buf))))))
6853
6854 ;;;
6855 ;;; Article editing
6856 ;;;
6857
6858 (defcustom gnus-article-edit-mode-hook nil
6859   "Hook run in article edit mode buffers."
6860   :group 'gnus-article-various
6861   :type 'hook)
6862
6863 (defvar gnus-article-edit-done-function nil)
6864
6865 (defvar gnus-article-edit-mode-map nil)
6866
6867 ;; Should we be using derived.el for this?
6868 (unless gnus-article-edit-mode-map
6869   (setq gnus-article-edit-mode-map (make-keymap))
6870   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6871
6872   (gnus-define-keys gnus-article-edit-mode-map
6873     "\C-c?"    describe-mode
6874     "\C-c\C-c" gnus-article-edit-done
6875     "\C-c\C-k" gnus-article-edit-exit
6876     "\C-c\C-f\C-t" message-goto-to
6877     "\C-c\C-f\C-o" message-goto-from
6878     "\C-c\C-f\C-b" message-goto-bcc
6879     ;;"\C-c\C-f\C-w" message-goto-fcc
6880     "\C-c\C-f\C-c" message-goto-cc
6881     "\C-c\C-f\C-s" message-goto-subject
6882     "\C-c\C-f\C-r" message-goto-reply-to
6883     "\C-c\C-f\C-n" message-goto-newsgroups
6884     "\C-c\C-f\C-d" message-goto-distribution
6885     "\C-c\C-f\C-f" message-goto-followup-to
6886     "\C-c\C-f\C-m" message-goto-mail-followup-to
6887     "\C-c\C-f\C-k" message-goto-keywords
6888     "\C-c\C-f\C-u" message-goto-summary
6889     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6890     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6891     "\C-c\C-b" message-goto-body
6892     "\C-c\C-i" message-goto-signature
6893
6894     "\C-c\C-t" message-insert-to
6895     "\C-c\C-n" message-insert-newsgroups
6896     "\C-c\C-o" message-sort-headers
6897     "\C-c\C-e" message-elide-region
6898     "\C-c\C-v" message-delete-not-region
6899     "\C-c\C-z" message-kill-to-signature
6900     "\M-\r" message-newline-and-reformat
6901     "\C-c\C-a" mml-attach-file
6902     "\C-a" message-beginning-of-line
6903     "\t" message-tab
6904     "\M-;" comment-region)
6905
6906   (gnus-define-keys (gnus-article-edit-wash-map
6907                      "\C-c\C-w" gnus-article-edit-mode-map)
6908     "f" gnus-article-edit-full-stops))
6909
6910 (easy-menu-define
6911   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6912   '("Field"
6913     ["Fetch To" message-insert-to t]
6914     ["Fetch Newsgroups" message-insert-newsgroups t]
6915     "----"
6916     ["To" message-goto-to t]
6917     ["From" message-goto-from t]
6918     ["Subject" message-goto-subject t]
6919     ["Cc" message-goto-cc t]
6920     ["Reply-To" message-goto-reply-to t]
6921     ["Summary" message-goto-summary t]
6922     ["Keywords" message-goto-keywords t]
6923     ["Newsgroups" message-goto-newsgroups t]
6924     ["Followup-To" message-goto-followup-to t]
6925     ["Mail-Followup-To" message-goto-mail-followup-to t]
6926     ["Distribution" message-goto-distribution t]
6927     ["Body" message-goto-body t]
6928     ["Signature" message-goto-signature t]))
6929
6930 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6931   "Major mode for editing articles.
6932 This is an extended text-mode.
6933
6934 \\{gnus-article-edit-mode-map}"
6935   (make-local-variable 'gnus-article-edit-done-function)
6936   (make-local-variable 'gnus-prev-winconf)
6937   (set (make-local-variable 'font-lock-defaults)
6938        '(message-font-lock-keywords t))
6939   (set (make-local-variable 'mail-header-separator) "")
6940   (set (make-local-variable 'gnus-article-edit-mode) t)
6941   (easy-menu-add message-mode-field-menu message-mode-map)
6942   (mml-mode)
6943   (setq buffer-read-only nil)
6944   (buffer-enable-undo)
6945   (widen))
6946
6947 (defun gnus-article-edit (&optional force)
6948   "Edit the current article.
6949 This will have permanent effect only in mail groups.
6950 If FORCE is non-nil, allow editing of articles even in read-only
6951 groups."
6952   (interactive "P")
6953   (when (and (not force)
6954              (gnus-group-read-only-p))
6955     (error "The current newsgroup does not support article editing"))
6956   (gnus-article-date-original)
6957   (gnus-article-edit-article
6958    'ignore
6959    `(lambda (no-highlight)
6960       'ignore
6961       (gnus-summary-edit-article-done
6962        ,(or (mail-header-references gnus-current-headers) "")
6963        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6964
6965 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6966   "Start editing the contents of the current article buffer."
6967   (let ((winconf (current-window-configuration)))
6968     (set-buffer gnus-article-buffer)
6969     (let ((message-auto-save-directory
6970            ;; Don't associate the article buffer with a draft file.
6971            nil))
6972       (gnus-article-edit-mode))
6973     (funcall start-func)
6974     (set-buffer-modified-p nil)
6975     (gnus-configure-windows 'edit-article)
6976     (setq gnus-article-edit-done-function exit-func)
6977     (setq gnus-prev-winconf winconf)
6978     (unless quiet
6979       (gnus-message 6 "C-c C-c to end edits"))))
6980
6981 (defun gnus-article-edit-done (&optional arg)
6982   "Update the article edits and exit."
6983   (interactive "P")
6984   (let ((func gnus-article-edit-done-function)
6985         (buf (current-buffer))
6986         (start (window-start))
6987         (p (point))
6988         (winconf gnus-prev-winconf))
6989     (widen) ;; Widen it in case that users narrowed the buffer.
6990     (funcall func arg)
6991     (set-buffer buf)
6992     ;; The cache and backlog have to be flushed somewhat.
6993     (when gnus-keep-backlog
6994       (gnus-backlog-remove-article
6995        (car gnus-article-current) (cdr gnus-article-current)))
6996     ;; Flush original article as well.
6997     (when (get-buffer gnus-original-article-buffer)
6998       (with-current-buffer gnus-original-article-buffer
6999         (setq gnus-original-article nil)))
7000     (when gnus-use-cache
7001       (gnus-cache-update-article
7002        (car gnus-article-current) (cdr gnus-article-current)))
7003     ;; We remove all text props from the article buffer.
7004     (kill-all-local-variables)
7005     (set-text-properties (point-min) (point-max) nil)
7006     (gnus-article-mode)
7007     (set-window-configuration winconf)
7008     (set-buffer buf)
7009     (set-window-start (get-buffer-window buf) start)
7010     (set-window-point (get-buffer-window buf) (point)))
7011   (gnus-summary-show-article))
7012
7013 (defun gnus-article-edit-exit ()
7014   "Exit the article editing without updating."
7015   (interactive)
7016   (when (or (not (buffer-modified-p))
7017             (yes-or-no-p "Article modified; kill anyway? "))
7018     (let ((curbuf (current-buffer))
7019           (p (point))
7020           (window-start (window-start)))
7021       (erase-buffer)
7022       (if (gnus-buffer-live-p gnus-original-article-buffer)
7023           (insert-buffer-substring gnus-original-article-buffer))
7024       (let ((winconf gnus-prev-winconf))
7025         (kill-all-local-variables)
7026         (gnus-article-mode)
7027         (set-window-configuration winconf)
7028         ;; Tippy-toe some to make sure that point remains where it was.
7029         (save-current-buffer
7030           (set-buffer curbuf)
7031           (set-window-start (get-buffer-window (current-buffer)) window-start)
7032           (goto-char p))))
7033     (gnus-summary-show-article)))
7034
7035 (defun gnus-article-edit-full-stops ()
7036   "Interactively repair spacing at end of sentences."
7037   (interactive)
7038   (save-excursion
7039     (goto-char (point-min))
7040     (search-forward-regexp "^$" nil t)
7041     (let ((case-fold-search nil))
7042       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7043
7044 ;;;
7045 ;;; Article highlights
7046 ;;;
7047
7048 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7049
7050 ;;; Internal Variables:
7051
7052 (defcustom gnus-button-url-regexp
7053   (concat
7054    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7055    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7056    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7057    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7058        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7059              (punct "!?:;.,"))
7060          (concat
7061           "\\(?:"
7062           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7063           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7064           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7065           "\\|"
7066           "[" chars punct     "]+" "[" chars "]"
7067           "\\)"))
7068      (concat ;; XEmacs 21.4 doesn't support POSIX.
7069       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7070       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7071    "\\)")
7072   "Regular expression that matches URLs."
7073   :group 'gnus-article-buttons
7074   :type 'regexp)
7075
7076 (defcustom gnus-button-valid-fqdn-regexp
7077   message-valid-fqdn-regexp
7078   "Regular expression that matches a valid FQDN."
7079   :version "22.1"
7080   :group 'gnus-article-buttons
7081   :type 'regexp)
7082
7083 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7084 (defcustom gnus-button-valid-localpart-regexp
7085   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7086   "Regular expression that matches a localpart of mail addresses or MIDs."
7087   :version "22.1"
7088   :group 'gnus-article-buttons
7089   :type 'regexp)
7090
7091 (defcustom gnus-button-man-handler 'manual-entry
7092   "Function to use for displaying man pages.
7093 The function must take at least one argument with a string naming the
7094 man page."
7095   :version "22.1"
7096   :type '(choice (function-item :tag "Man" manual-entry)
7097                  (function-item :tag "Woman" woman)
7098                  (function :tag "Other"))
7099   :group 'gnus-article-buttons)
7100
7101 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
7102   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
7103 If the default site is too slow, try to find a CTAN mirror, see
7104 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
7105 the variable `gnus-button-handle-ctan'."
7106   :version "22.1"
7107   :group 'gnus-article-buttons
7108   :link '(custom-manual "(gnus)Group Parameters")
7109   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
7110                  (const "http://tug.ctan.org/tex-archive/")
7111                  (const "http://www.dante.de/CTAN/")
7112                  (string :tag "Other")))
7113
7114 (defcustom gnus-button-ctan-handler 'browse-url
7115   "Function to use for displaying CTAN links.
7116 The function must take one argument, the string naming the URL."
7117   :version "22.1"
7118   :type '(choice (function-item :tag "Browse Url" browse-url)
7119                  (function :tag "Other"))
7120   :group 'gnus-article-buttons)
7121
7122 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
7123   "Bogus strings removed from CTAN URLs."
7124   :version "22.1"
7125   :group 'gnus-article-buttons
7126   :type '(choice (const "^/?tex-archive/\\|/")
7127                  (regexp :tag "Other")))
7128
7129 (defcustom gnus-button-ctan-directory-regexp
7130   (regexp-opt
7131    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
7132          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
7133          "languages" "macros" "nonfree" "obsolete" "support" "systems"
7134          "tds" "tools" "usergrps" "web") t)
7135   "Regular expression for ctan directories.
7136 It should match all directories in the top level of `gnus-ctan-url'."
7137   :version "22.1"
7138   :group 'gnus-article-buttons
7139   :type 'regexp)
7140
7141 (defcustom gnus-button-mid-or-mail-regexp
7142   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7143           gnus-button-valid-fqdn-regexp
7144           ">?\\)\\b")
7145   "Regular expression that matches a message ID or a mail address."
7146   :version "22.1"
7147   :group 'gnus-article-buttons
7148   :type 'regexp)
7149
7150 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7151   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7152 Strings like this can be either a message ID or a mail address.  If it is one
7153 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7154 message ID or a mail address, respectively.  If this variable is set to the
7155 symbol `ask', always query the user what do do.  If it is a function, this
7156 function will be called with the string as its only argument.  The function
7157 must return `mid', `mail', `invalid' or `ask'."
7158   :version "22.1"
7159   :group 'gnus-article-buttons
7160   :type '(choice (function-item :tag "Heuristic function"
7161                                 gnus-button-mid-or-mail-heuristic)
7162                  (const ask)
7163                  (const mid)
7164                  (const mail)))
7165
7166 (defcustom gnus-button-mid-or-mail-heuristic-alist
7167   '((-10.0 . ".+\\$.+@")
7168     (-10.0 . "#")
7169     (-10.0 . "\\*")
7170     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7171     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7172     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7173     (-1.0  . "^[^a-z]+@")
7174     ;;
7175     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7176     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7177     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7178     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7179     ;;
7180     (-2.0  . "^[0-9]")
7181     (-1.0  . "^[0-9][0-9]")
7182     ;;
7183     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7184     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7185     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7186     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7187     ;;
7188     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7189     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7190     ;;       "[0-9]{8,}.*\@"
7191     (-3.0
7192      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7193     ;; "[0-9]{12,}.*\@"
7194     ;; compensation for TDMA dated mail addresses:
7195     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7196     ;;
7197     (-20.0 . "\\.fsf@") ;; Gnus
7198     (-20.0 . "^slrn")
7199     (-20.0 . "^Pine")
7200     (-20.0 . "^alpine\\.")
7201     (-20.0 . "_-_") ;; Subject change in thread
7202     ;;
7203     (-20.0 . "\\.ln@") ;; leafnode
7204     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7205     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7206     ;;
7207     ;; (5.0 . "") ;; $local_part_len <= 7
7208     (10.0  . "^[^0-9]+@")
7209     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7210     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7211     (3.0   . "\@stud")
7212     ;;
7213     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7214     ;;
7215     (0.5   . "^[A-Z][a-z]")
7216     (0.5   . "^[A-Z][a-z][a-z]")
7217     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7218     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7219   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7220
7221 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7222 address.  The REGEXP is processed with `case-fold-search' set to nil."
7223   :version "22.1"
7224   :group 'gnus-article-buttons
7225   :type '(repeat (cons (number :tag "Rate")
7226                        (regexp :tag "Regexp"))))
7227
7228 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7229   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7230 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7231 address, `ask' if unsure and `invalid' if the string is invalid."
7232   (let ((case-fold-search nil)
7233         (list gnus-button-mid-or-mail-heuristic-alist)
7234         (result 0) rate regexp lpartlen elem)
7235     (setq lpartlen
7236           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7237     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7238     ;; Certain special cases...
7239     (when (string-match
7240            (concat
7241             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7242             "^[0-9]+\\.[0-9]+@compuserve\\|"
7243             "@public\\.gmane\\.org")
7244            mid-or-mail)
7245       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7246       (setq result 'mail))
7247     (when (string-match "@.*@\\| " mid-or-mail)
7248       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7249       (setq result 'invalid))
7250     ;; Nothing more to do, if result is not a number here...
7251     (when (numberp result)
7252       (while list
7253         (setq elem (car list)
7254               rate (car elem)
7255               regexp (cdr elem)
7256               list (cdr list))
7257         (when (string-match regexp mid-or-mail)
7258           (setq result (+ result rate))
7259           (gnus-message
7260            9 "`%s' matched `%s', rate `%s', result `%s'."
7261            mid-or-mail regexp rate result)))
7262       (when (<= lpartlen 7)
7263         (setq result (+ result 5.0))
7264         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7265                       mid-or-mail result))
7266       (when (>= lpartlen 12)
7267         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7268         (cond
7269          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7270           ;; Long local part should contain realname if e-mail address,
7271           ;; too many digits: message-id.
7272           ;; $score -= 5.0 + 0.1 * $local_part_len;
7273           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7274           (setq result (+ result rate))
7275           (gnus-message
7276            9 "Many digits in `%s', rate `%s', result `%s'."
7277            mid-or-mail rate result))
7278          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7279                         mid-or-mail)
7280           ;; Too few vowels [^aeiouy]{4,}.*\@
7281           (setq result (+ result -5.0))
7282           (gnus-message
7283            9 "Few vowels in `%s', rate `%s', result `%s'."
7284            mid-or-mail -5.0 result))
7285          (t
7286           (setq result (+ result 5.0))
7287           (gnus-message
7288            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7289     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7290     ;; Maybe we should make this a customizable alist: (condition . 'result)
7291     (cond
7292      ((symbolp result) result)
7293      ;; Now convert number into proper results:
7294      ((< result -10.0) 'mid)
7295      ((> result  10.0) 'mail)
7296      (t 'ask))))
7297
7298 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7299   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7300          (url-mid (concat "news" ":" mid-or-mail))
7301          (url-mailto (concat "mailto" ":" mid-or-mail)))
7302     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7303     (when (fboundp pref)
7304       (setq guessed
7305             ;; get rid of surrounding angles...
7306             (funcall pref
7307                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7308       (if (or (eq 'mid guessed) (eq 'mail guessed))
7309           (setq pref guessed)
7310         (setq pref 'ask)))
7311     (if (eq pref 'ask)
7312         (save-window-excursion
7313           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7314               (setq pref 'mail)
7315             (setq pref 'mid))))
7316     (cond ((eq pref 'mid)
7317            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7318            (gnus-button-handle-news url-mid))
7319           ((eq pref 'mail)
7320            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7321            (gnus-url-mailto url-mailto))
7322           (t (gnus-message 3 "Invalid string.")))))
7323
7324 (defun gnus-button-handle-custom (fun arg)
7325   "Call function FUN on argument ARG.
7326 Both FUN and ARG are supposed to be strings.  ARG will be passed
7327 as a symbol to FUN."
7328   (funcall (intern fun)
7329            (if (string-match "^customize-apropos" fun)
7330                arg
7331              (intern arg))))
7332
7333 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7334
7335 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7336 ;; stuff?
7337
7338 (defun gnus-button-handle-describe-function (url)
7339   "Call `describe-function' when pushing the corresponding URL button."
7340   (describe-function
7341    (intern
7342     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7343
7344 (defun gnus-button-handle-describe-variable (url)
7345   "Call `describe-variable' when pushing the corresponding URL button."
7346   (describe-variable
7347    (intern
7348     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7349
7350 (defun gnus-button-handle-symbol (url)
7351 "Display help on variable or function.
7352 Calls `describe-variable' or `describe-function'."
7353   (let ((sym (intern url)))
7354     (cond
7355      ((fboundp sym) (describe-function sym))
7356      ((boundp sym) (describe-variable sym))
7357      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7358
7359 (defun gnus-button-handle-describe-key (url)
7360   "Call `describe-key' when pushing the corresponding URL button."
7361   (let* ((key-string
7362           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7363          (keys (ignore-errors (eval `(kbd ,key-string)))))
7364     (if keys
7365         (describe-key keys)
7366       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7367
7368 (defun gnus-button-handle-apropos (url)
7369   "Call `apropos' when pushing the corresponding URL button."
7370   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7371
7372 (defun gnus-button-handle-apropos-command (url)
7373   "Call `apropos' when pushing the corresponding URL button."
7374   (apropos-command
7375    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7376
7377 (defun gnus-button-handle-apropos-variable (url)
7378   "Call `apropos' when pushing the corresponding URL button."
7379   (funcall
7380    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7381    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7382
7383 (defun gnus-button-handle-apropos-documentation (url)
7384   "Call `apropos' when pushing the corresponding URL button."
7385   (funcall
7386    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7387    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7388
7389 (defun gnus-button-handle-library (url)
7390   "Call `locate-library' when pushing the corresponding URL button."
7391   (gnus-message 9 "url=`%s'" url)
7392   (let* ((lib (locate-library url))
7393          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7394     (if (not lib)
7395         (gnus-message 1 "Cannot locale library `%s'." url)
7396       (find-file-read-only file))))
7397
7398 (defun gnus-button-handle-ctan (url)
7399   "Call `browse-url' when pushing a CTAN URL button."
7400   (funcall
7401    gnus-button-ctan-handler
7402    (concat
7403     gnus-ctan-url
7404     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
7405
7406 (defcustom gnus-button-tex-level 5
7407   "*Integer that says how many TeX-related buttons Gnus will show.
7408 The higher the number, the more buttons will appear and the more false
7409 positives are possible.  Note that you can set this variable local to
7410 specific groups.  Setting it higher in TeX groups is probably a good idea.
7411 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7412 how to set variables in specific groups."
7413   :version "22.1"
7414   :group 'gnus-article-buttons
7415   :link '(custom-manual "(gnus)Group Parameters")
7416   :type 'integer)
7417
7418 (defcustom gnus-button-man-level 5
7419   "*Integer that says how many man-related buttons Gnus will show.
7420 The higher the number, the more buttons will appear and the more false
7421 positives are possible.  Note that you can set this variable local to
7422 specific groups.  Setting it higher in Unix groups is probably a good idea.
7423 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7424 how to set variables in specific groups."
7425   :version "22.1"
7426   :group 'gnus-article-buttons
7427   :link '(custom-manual "(gnus)Group Parameters")
7428   :type 'integer)
7429
7430 (defcustom gnus-button-emacs-level 5
7431   "*Integer that says how many emacs-related buttons Gnus will show.
7432 The higher the number, the more buttons will appear and the more false
7433 positives are possible.  Note that you can set this variable local to
7434 specific groups.  Setting it higher in Emacs or Gnus related groups is
7435 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7436 `gnus-parameters' on how to set variables in specific groups."
7437   :version "22.1"
7438   :group 'gnus-article-buttons
7439   :link '(custom-manual "(gnus)Group Parameters")
7440   :type 'integer)
7441
7442 (defcustom gnus-button-message-level 5
7443   "*Integer that says how many buttons for news or mail messages will appear.
7444 The higher the number, the more buttons will appear and the more false
7445 positives are possible."
7446   ;; mail addresses, MIDs, URLs for news, ...
7447   :version "22.1"
7448   :group 'gnus-article-buttons
7449   :type 'integer)
7450
7451 (defcustom gnus-button-browse-level 5
7452   "*Integer that says how many buttons for browsing will appear.
7453 The higher the number, the more buttons will appear and the more false
7454 positives are possible."
7455   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7456   :version "22.1"
7457   :group 'gnus-article-buttons
7458   :type 'integer)
7459
7460 (defcustom gnus-button-alist
7461   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7462      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7463     ((concat "\\b\\(nntp\\|news\\):\\("
7464              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7465      0 t gnus-button-handle-news 2)
7466     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7467      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7468     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7469      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7470     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7471     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7472      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7473     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7474      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7475     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7476      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7477     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7478      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7479     ;; RFC 2368 (The mailto URL scheme)
7480     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7481      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7482     ("\\bmailto:\\([^ \n\t]+\\)"
7483      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7484     ;; CTAN
7485     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
7486              gnus-button-ctan-directory-regexp
7487              "[^][>)!;:,'\n\t ]+\\)")
7488      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
7489     ((concat "\\btex-archive/\\("
7490              gnus-button-ctan-directory-regexp
7491              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
7492      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
7493     ((concat
7494       "\\b\\("
7495       gnus-button-ctan-directory-regexp
7496       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
7497      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
7498     ;; Info Konqueror style <info:/foo/bar baz>.
7499     ;; Must come before " Gnus home-grown style".
7500     ("\\binfo://?\\([^'\">\n\t]+\\)"
7501      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7502    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7503     ("\\binfo://\\([^'\">\n\t ]+\\)"
7504      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7505     ;; Info GNOME style <info:foo#bar_baz>
7506     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7507      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7508     ;; Info KDE style <info:(foo)bar baz>
7509     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7510      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7511     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7512      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7513     ("\\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,]*\\)\\)?"
7514      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7515      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7516     ;; This is custom
7517     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7518      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7519     ;; Emacs help commands
7520     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7521      ;; regexp doesn't match arguments containing ` '.
7522      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7523     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7524      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7525     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7526      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7527     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7528      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7529     ;; The following entries may lead to many false positives so don't enable
7530     ;; them by default (use a high button level).
7531     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7532      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7533      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7534     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7535      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7536     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7537      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7538     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7539      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7540     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7541      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7542     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7543      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7544     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7545      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7546     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7547      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7548     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7549      ;; Unlike the other regexps we really have to require quoting
7550      ;; here to determine where it ends.
7551      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7552     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7553     ("<URL: *\\([^\n<>]*\\)>"
7554      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7555     ;; RFC 2396 (2.4.3., delims) ...
7556     ("\"URL: *\\([^\n\"]*\\)\""
7557      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7558     ;; Raw URLs.
7559     (gnus-button-url-regexp
7560      0 (>= gnus-button-browse-level 0) browse-url 0)
7561     ;; man pages
7562     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7563      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7564      gnus-button-handle-man 1)
7565     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7566     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7567      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7568      gnus-button-handle-man 1)
7569     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7570     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7571     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7572      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7573     ;; Recognizing patches to .el files.  This is somewhat obscure,
7574     ;; but considering the percentage of Gnus users who hack Emacs
7575     ;; Lisp files...
7576     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7577      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7578     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7579      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7580     ;; MID or mail: To avoid too many false positives we don't try to catch
7581     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7582     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7583     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7584     ;; so that non-ambiguous entries (see above) match first.
7585     (gnus-button-mid-or-mail-regexp
7586      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7587   "*Alist of regexps matching buttons in article bodies.
7588
7589 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7590 REGEXP: is the string (case insensitive) matching text around the button (can
7591 also be Lisp expression evaluating to a string),
7592 BUTTON: is the number of the regexp grouping actually matching the button,
7593 FORM: is a Lisp expression which must eval to true for the button to
7594 be added,
7595 CALLBACK: is the function to call when the user push this button, and each
7596 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7597
7598 CALLBACK can also be a variable, in that case the value of that
7599 variable it the real callback function."
7600   :group 'gnus-article-buttons
7601   :type '(repeat (list (choice regexp variable sexp)
7602                        (integer :tag "Button")
7603                        (sexp :tag "Form")
7604                        (function :tag "Callback")
7605                        (repeat :tag "Par"
7606                                :inline t
7607                                (integer :tag "Regexp group")))))
7608 (put 'gnus-button-alist 'risky-local-variable t)
7609
7610 (defcustom gnus-header-button-alist
7611   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7612      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7613     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7614      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7615     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7616      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7617     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7618      0 (>= gnus-button-browse-level 0) browse-url 0)
7619     ("^Subject:" gnus-button-url-regexp
7620      0 (>= gnus-button-browse-level 0) browse-url 0)
7621     ("^[^:]+:" gnus-button-url-regexp
7622      0 (>= gnus-button-browse-level 0) browse-url 0)
7623     ("^OpenPGP:.*url=" gnus-button-url-regexp
7624      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7625     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7626      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7627     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7628      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7629   "*Alist of headers and regexps to match buttons in article heads.
7630
7631 This alist is very similar to `gnus-button-alist', except that each
7632 alist has an additional HEADER element first in each entry:
7633
7634 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7635
7636 HEADER is a regexp to match a header.  For a fuller explanation, see
7637 `gnus-button-alist'."
7638   :group 'gnus-article-buttons
7639   :group 'gnus-article-headers
7640   :type '(repeat (list (regexp :tag "Header")
7641                        (choice regexp variable)
7642                        (integer :tag "Button")
7643                        (sexp :tag "Form")
7644                        (function :tag "Callback")
7645                        (repeat :tag "Par"
7646                                :inline t
7647                                (integer :tag "Regexp group")))))
7648 (put 'gnus-header-button-alist 'risky-local-variable t)
7649
7650 ;;; Commands:
7651
7652 (defun gnus-article-push-button (event)
7653   "Check text under the mouse pointer for a callback function.
7654 If the text under the mouse pointer has a `gnus-callback' property,
7655 call it with the value of the `gnus-data' text property."
7656   (interactive "e")
7657   (set-buffer (window-buffer (posn-window (event-start event))))
7658   (let* ((pos (posn-point (event-start event)))
7659          (data (get-text-property pos 'gnus-data))
7660          (fun (get-text-property pos 'gnus-callback)))
7661     (goto-char pos)
7662     (when fun
7663       (funcall fun data))))
7664
7665 (defun gnus-article-press-button ()
7666   "Check text at point for a callback function.
7667 If the text at point has a `gnus-callback' property,
7668 call it with the value of the `gnus-data' text property."
7669   (interactive)
7670   (let ((data (get-text-property (point) 'gnus-data))
7671         (fun (get-text-property (point) 'gnus-callback)))
7672     (when fun
7673       (funcall fun data))))
7674
7675 (defun gnus-article-highlight (&optional force)
7676   "Highlight current article.
7677 This function calls `gnus-article-highlight-headers',
7678 `gnus-article-highlight-citation',
7679 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7680 do the highlighting.  See the documentation for those functions."
7681   (interactive (list 'force))
7682   (gnus-article-highlight-headers)
7683   (gnus-article-highlight-citation force)
7684   (gnus-article-highlight-signature)
7685   (gnus-article-add-buttons force)
7686   (gnus-article-add-buttons-to-head))
7687
7688 (defun gnus-article-highlight-some (&optional force)
7689   "Highlight current article.
7690 This function calls `gnus-article-highlight-headers',
7691 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7692 do the highlighting.  See the documentation for those functions."
7693   (interactive (list 'force))
7694   (gnus-article-highlight-headers)
7695   (gnus-article-highlight-signature)
7696   (gnus-article-add-buttons))
7697
7698 (defun gnus-article-highlight-headers ()
7699   "Highlight article headers as specified by `gnus-header-face-alist'."
7700   (interactive)
7701   (gnus-with-article-headers
7702     (let (regexp header-face field-face from hpoints fpoints)
7703       (dolist (entry gnus-header-face-alist)
7704         (goto-char (point-min))
7705         (setq regexp (concat "^\\("
7706                              (if (string-equal "" (nth 0 entry))
7707                                  "[^\t ]"
7708                                (nth 0 entry))
7709                              "\\)")
7710               header-face (nth 1 entry)
7711               field-face (nth 2 entry))
7712         (while (and (re-search-forward regexp nil t)
7713                     (not (eobp)))
7714           (beginning-of-line)
7715           (setq from (point))
7716           (unless (search-forward ":" nil t)
7717             (forward-char 1))
7718           (when (and header-face
7719                      (not (memq (point) hpoints)))
7720             (push (point) hpoints)
7721             (gnus-put-text-property from (point) 'face header-face))
7722           (when (and field-face
7723                      (not (memq (setq from (point)) fpoints)))
7724             (push from fpoints)
7725             (if (re-search-forward "^[^ \t]" nil t)
7726                 (forward-char -2)
7727               (goto-char (point-max)))
7728             (gnus-put-text-property from (point) 'face field-face)))))))
7729
7730 (defun gnus-article-highlight-signature ()
7731   "Highlight the signature in an article.
7732 It does this by highlighting everything after
7733 `gnus-signature-separator' using the face `gnus-signature'."
7734   (interactive)
7735   (gnus-with-article-buffer
7736     (let ((inhibit-point-motion-hooks t))
7737       (save-restriction
7738         (when (and gnus-signature-face
7739                    (gnus-article-narrow-to-signature))
7740           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7741                             'face gnus-signature-face)
7742           (widen)
7743           (gnus-article-search-signature)
7744           (let ((start (match-beginning 0))
7745                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7746             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7747                                      end)))))))
7748
7749 (defun gnus-button-in-region-p (b e prop)
7750   "Say whether PROP exists in the region."
7751   (text-property-not-all b e prop nil))
7752
7753 (defun gnus-article-add-buttons (&optional force)
7754   "Find external references in the article and make buttons of them.
7755 \"External references\" are things like Message-IDs and URLs, as
7756 specified by `gnus-button-alist'."
7757   (interactive (list 'force))
7758   (gnus-with-article-buffer
7759     (let ((inhibit-point-motion-hooks t)
7760           (case-fold-search t)
7761           (alist gnus-button-alist)
7762           beg entry regexp)
7763       ;; Remove all old markers.
7764       (let (marker entry new-list)
7765         (while (setq marker (pop gnus-button-marker-list))
7766           (if (or (< marker (point-min)) (>= marker (point-max)))
7767               (push marker new-list)
7768             (goto-char marker)
7769             (when (setq entry (gnus-button-entry))
7770               (put-text-property (match-beginning (nth 1 entry))
7771                                  (match-end (nth 1 entry))
7772                                  'gnus-callback nil))
7773             (set-marker marker nil)))
7774         (setq gnus-button-marker-list new-list))
7775       ;; We skip the headers.
7776       (article-goto-body)
7777       (setq beg (point))
7778       (while (setq entry (pop alist))
7779         (setq regexp (eval (car entry)))
7780         (goto-char beg)
7781         (while (re-search-forward regexp nil t)
7782           (let ((start (match-beginning (nth 1 entry)))
7783                 (end (match-end (nth 1 entry)))
7784                 (from (match-beginning 0)))
7785             (when (and (or (eq t (nth 2 entry))
7786                            (eval (nth 2 entry)))
7787                        (not (gnus-button-in-region-p
7788                              start end 'gnus-callback)))
7789               ;; That optional form returned non-nil, so we add the
7790               ;; button.
7791               (setq from (set-marker (make-marker) from))
7792               (push from gnus-button-marker-list)
7793               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7794                            (gnus-article-extend-url-button from start end))
7795                 (gnus-article-add-button start end
7796                                          'gnus-button-push from)))))))))
7797
7798 (defun gnus-article-extend-url-button (beg start end)
7799   "Extend url button if url is folded into two or more lines.
7800 Return non-nil if button is extended.  BEG is a marker that points to
7801 the beginning position of a text containing url.  START and END are
7802 the endpoints of a url button before it is extended.  The concatenated
7803 url is put as the `gnus-button-url' overlay property on the button."
7804   (let ((opoint (point))
7805         (points (list start end))
7806         url delim regexp)
7807     (prog1
7808         (when (and (progn
7809                      (goto-char end)
7810                      (not (looking-at "[\t ]*[\">]")))
7811                    (progn
7812                      (goto-char start)
7813                      (string-match
7814                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7815                       (buffer-substring (point-at-bol) start)))
7816                    (progn
7817                      (setq url (list (buffer-substring start end))
7818                            delim (if (match-beginning 1) ">" "\""))
7819                      (beginning-of-line)
7820                      (setq regexp (concat
7821                                    (when (and (looking-at
7822                                                message-cite-prefix-regexp)
7823                                               (< (match-end 0) start))
7824                                      (regexp-quote (match-string 0)))
7825                                    "\
7826 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7827                                    delim "\\)"))
7828                      (while (progn
7829                               (forward-line 1)
7830                               (and (looking-at regexp)
7831                                    (prog1
7832                                        (match-beginning 1)
7833                                      (push (or (match-string 2)
7834                                                (match-string 1))
7835                                            url)
7836                                      (push (setq end (or (match-end 2)
7837                                                          (match-end 1)))
7838                                            points)
7839                                      (push (or (match-beginning 2)
7840                                                (match-beginning 1))
7841                                            points)))))
7842                      (match-beginning 2)))
7843           (let (gnus-article-mouse-face widget-mouse-face)
7844             (while points
7845               (gnus-article-add-button (pop points) (pop points)
7846                                        'gnus-button-push beg)))
7847           (let ((overlay (gnus-make-overlay start end)))
7848             (gnus-overlay-put overlay 'evaporate t)
7849             (gnus-overlay-put overlay 'gnus-button-url
7850                               (list (mapconcat 'identity (nreverse url) "")))
7851             (when gnus-article-mouse-face
7852               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7853           t)
7854       (goto-char opoint))))
7855
7856 ;; Add buttons to the head of an article.
7857 (defun gnus-article-add-buttons-to-head ()
7858   "Add buttons to the head of the article."
7859   (interactive)
7860   (gnus-with-article-headers
7861     (let (beg end)
7862       (dolist (entry gnus-header-button-alist)
7863         ;; Each alist entry.
7864         (goto-char (point-min))
7865         (while (re-search-forward (car entry) nil t)
7866           ;; Each header matching the entry.
7867           (setq beg (match-beginning 0))
7868           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7869                              (match-beginning 0))
7870                         (point-max)))
7871           (goto-char beg)
7872           (while (re-search-forward (eval (nth 1 entry)) end t)
7873             ;; Each match within a header.
7874             (let* ((entry (cdr entry))
7875                    (start (match-beginning (nth 1 entry)))
7876                    (end (match-end (nth 1 entry)))
7877                    (form (nth 2 entry)))
7878               (goto-char (match-end 0))
7879               (when (eval form)
7880                 (gnus-article-add-button
7881                  start end (nth 3 entry)
7882                  (buffer-substring (match-beginning (nth 4 entry))
7883                                    (match-end (nth 4 entry)))))))
7884           (goto-char end))))))
7885
7886 ;;; External functions:
7887
7888 (defun gnus-article-add-button (from to fun &optional data)
7889   "Create a button between FROM and TO with callback FUN and data DATA."
7890   (when gnus-article-button-face
7891     (gnus-overlay-put (gnus-make-overlay from to nil t)
7892                       'face gnus-article-button-face))
7893   (gnus-add-text-properties
7894    from to
7895    (nconc (and gnus-article-mouse-face
7896                (list gnus-mouse-face-prop gnus-article-mouse-face))
7897           (list 'gnus-callback fun)
7898           (and data (list 'gnus-data data))))
7899   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7900                          :button-keymap gnus-widget-button-keymap))
7901
7902 ;;; Internal functions:
7903
7904 (defun gnus-article-set-globals ()
7905   (with-current-buffer gnus-summary-buffer
7906     (gnus-set-global-variables)))
7907
7908 (defun gnus-signature-toggle (end)
7909   (gnus-with-article-buffer
7910     (let ((inhibit-point-motion-hooks t))
7911       (if (text-property-any end (point-max) 'article-type 'signature)
7912           (progn
7913             (gnus-delete-wash-type 'signature)
7914             (gnus-remove-text-properties-when
7915              'article-type 'signature end (point-max)
7916              (cons 'article-type (cons 'signature
7917                                        gnus-hidden-properties))))
7918         (gnus-add-wash-type 'signature)
7919         (gnus-add-text-properties-when
7920          'article-type nil end (point-max)
7921          (cons 'article-type (cons 'signature
7922                                    gnus-hidden-properties)))))
7923     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7924       (gnus-set-mode-line 'article))))
7925
7926 (defun gnus-button-entry ()
7927   ;; Return the first entry in `gnus-button-alist' matching this place.
7928   (let ((alist gnus-button-alist)
7929         (entry nil))
7930     (while alist
7931       (setq entry (pop alist))
7932       (if (looking-at (eval (car entry)))
7933           (setq alist nil)
7934         (setq entry nil)))
7935     entry))
7936
7937 (defun gnus-button-push (marker)
7938   ;; Push button starting at MARKER.
7939   (save-excursion
7940     (goto-char marker)
7941     (let* ((entry (gnus-button-entry))
7942            (inhibit-point-motion-hooks t)
7943            (fun (nth 3 entry))
7944            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7945                           (get-char-property marker 'gnus-button-url))
7946                      (mapcar (lambda (group)
7947                                (let ((string (match-string group)))
7948                                  (set-text-properties
7949                                   0 (length string) nil string)
7950                                  string))
7951                              (nthcdr 4 entry)))))
7952       (cond
7953        ((fboundp fun)
7954         (apply fun args))
7955        ((and (boundp fun)
7956              (fboundp (symbol-value fun)))
7957         (apply (symbol-value fun) args))
7958        (t
7959         (gnus-message 1 "You must define `%S' to use this button"
7960                       (cons fun args)))))))
7961
7962 (defun gnus-parse-news-url (url)
7963   (let (scheme server port group message-id articles)
7964     (with-temp-buffer
7965       (insert url)
7966       (goto-char (point-min))
7967       (when (looking-at "\\([A-Za-z]+\\):")
7968         (setq scheme (match-string 1))
7969         (goto-char (match-end 0)))
7970       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7971         (setq server (match-string 1))
7972         (setq port (if (stringp (match-string 3))
7973                        (string-to-number (match-string 3))
7974                      (match-string 3)))
7975         (goto-char (match-end 0)))
7976
7977       (cond
7978        ((looking-at "\\(.*@.*\\)")
7979         (setq message-id (match-string 1)))
7980        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7981         (setq group (match-string 1)
7982               articles (split-string (match-string 2) "-")))
7983        ((looking-at "\\([^/]+\\)/?")
7984         (setq group (match-string 1)))
7985        (t
7986         (error "Unknown news URL syntax"))))
7987     (list scheme server port group message-id articles)))
7988
7989 (defun gnus-button-handle-news (url)
7990   "Fetch a news URL."
7991   (destructuring-bind (scheme server port group message-id articles)
7992       (gnus-parse-news-url url)
7993     (cond
7994      (message-id
7995       (with-current-buffer gnus-summary-buffer
7996         (if server
7997             (let ((gnus-refer-article-method
7998                    (nconc (list (list 'nntp server))
7999                           gnus-refer-article-method))
8000                   (nntp-port-number (or port "nntp")))
8001               (gnus-message 7 "Fetching %s with %s"
8002                             message-id gnus-refer-article-method)
8003               (gnus-summary-refer-article message-id))
8004           (gnus-summary-refer-article message-id))))
8005      (group
8006       (gnus-button-fetch-group url)))))
8007
8008 (defun gnus-button-patch (library line)
8009   "Visit an Emacs Lisp library LIBRARY on line LINE."
8010   (interactive)
8011   (let ((file (locate-library (file-name-nondirectory library))))
8012     (unless file
8013       (error "Couldn't find library %s" library))
8014     (find-file file)
8015     (goto-char (point-min))
8016     (forward-line (1- (string-to-number line)))))
8017
8018 (defun gnus-button-handle-man (url)
8019   "Fetch a man page."
8020   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8021   (when (eq gnus-button-man-handler 'woman)
8022     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
8023   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8024   (funcall gnus-button-man-handler url))
8025
8026 (defun gnus-button-handle-info-url (url)
8027   "Fetch an info URL."
8028   (setq url (mm-subst-char-in-string ?+ ?\  url))
8029   (cond
8030    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
8031     (gnus-info-find-node
8032      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
8033                      "Gnus")
8034              ")" (gnus-url-unhex-string (match-string 2 url)))))
8035    ((string-match "([^)\"]+)[^\"]+" url)
8036     (setq url
8037           (gnus-replace-in-string
8038            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8039     (gnus-info-find-node url))
8040    (t (error "Can't parse %s" url))))
8041
8042 (defun gnus-button-handle-info-url-gnome (url)
8043   "Fetch GNOME style info URL."
8044   (setq url (mm-subst-char-in-string ?_ ?\  url))
8045   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8046       (gnus-info-find-node
8047        (concat "("
8048                (gnus-url-unhex-string
8049                  (match-string 1 url))
8050                ")"
8051                (or (gnus-url-unhex-string
8052                     (match-string 2 url))
8053                    "Top")))
8054     (error "Can't parse %s" url)))
8055
8056 (defun gnus-button-handle-info-url-kde (url)
8057   "Fetch KDE style info URL."
8058   (gnus-info-find-node (gnus-url-unhex-string url)))
8059
8060 ;; (info) will autoload info.el
8061 (declare-function Info-menu "info" (menu-item &optional fork))
8062 (declare-function Info-index-next "info" (num))
8063
8064 (defun gnus-button-handle-info-keystrokes (url)
8065   "Call `info' when pushing the corresponding URL button."
8066   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8067   (let (node indx comma)
8068     (if (string-match
8069          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8070                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8071                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
8072                  "\\(?:[ \t\n,]*\\)\\)?")
8073          url)
8074         (setq node (match-string 2 url)
8075               indx (match-string 3 url))
8076       (error "Can't parse %s" url))
8077     (info)
8078     (Info-directory)
8079     (Info-menu node)
8080     (when (> (length indx) 0)
8081       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8082                             "\\([ \t\n,]*\\)")
8083                     indx)
8084       (setq comma (match-string 2 indx))
8085       (setq indx  (match-string 1 indx))
8086       (Info-index indx)
8087       (when comma
8088         (dotimes (i (with-temp-buffer
8089                       (insert comma)
8090                       ;; Note: the XEmacs version of `how-many' takes
8091                       ;; no optional argument.
8092                       (goto-char (point-min))
8093                       (how-many ",")))
8094           (Info-index-next 1)))
8095       nil)))
8096
8097 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8098 (declare-function pgg-display-output-buffer "pgg" (start end status))
8099
8100 (defun gnus-button-openpgp (url)
8101   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8102   (with-temp-buffer
8103     (mm-url-insert-file-contents-external url)
8104     (pgg-snarf-keys-region (point-min) (point-max))
8105     (pgg-display-output-buffer nil nil nil)))
8106
8107 (defun gnus-button-message-id (message-id)
8108   "Fetch MESSAGE-ID."
8109   (with-current-buffer gnus-summary-buffer
8110     (gnus-summary-refer-article message-id)))
8111
8112 (defun gnus-button-fetch-group (address &rest ignore)
8113   "Fetch GROUP specified by ADDRESS."
8114   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8115                       address)
8116     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8117     ;; for nntp:// and news://
8118     (setq address (match-string 3 address)))
8119   (if (not (string-match "[:/]" address))
8120       ;; This is just a simple group url.
8121       (gnus-group-read-ephemeral-group address gnus-select-method)
8122     (if (not
8123          (string-match
8124           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8125           address))
8126         (error "Can't parse %s" address)
8127       (gnus-group-read-ephemeral-group
8128        (match-string 4 address)
8129        `(nntp ,(match-string 1 address)
8130               (nntp-address ,(match-string 1 address))
8131               (nntp-port-number ,(if (match-end 3)
8132                                      (match-string 3 address)
8133                                    "nntp")))
8134        nil nil nil
8135        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8136
8137 (defun gnus-url-parse-query-string (query &optional downcase)
8138   (let (retval pairs cur key val)
8139     (setq pairs (split-string query "&"))
8140     (while pairs
8141       (setq cur (car pairs)
8142             pairs (cdr pairs))
8143       (if (not (string-match "=" cur))
8144           nil                           ; Grace
8145         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8146               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8147         (if downcase
8148             (setq key (downcase key)))
8149         (setq cur (assoc key retval))
8150         (if cur
8151             (setcdr cur (cons val (cdr cur)))
8152           (setq retval (cons (list key val) retval)))))
8153     retval))
8154
8155 (defun gnus-url-mailto (url)
8156   ;; Send mail to someone
8157   (when (string-match "mailto:/*\\(.*\\)" url)
8158     (setq url (substring url (match-beginning 1) nil)))
8159   (let (to args subject func)
8160     (setq args (gnus-url-parse-query-string
8161                 (if (string-match "^\\?" url)
8162                     (substring url 1)
8163                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8164                       (concat "to=" (match-string 1 url) "&"
8165                               (match-string 2 url))
8166                     (concat "to=" url)))
8167                 t)
8168           subject (cdr-safe (assoc "subject" args)))
8169     (gnus-msg-mail)
8170     (while args
8171       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8172       (if (fboundp func)
8173           (funcall func)
8174         (message-position-on-field (caar args)))
8175       (insert (gnus-replace-in-string
8176                (mapconcat 'identity (reverse (cdar args)) ", ")
8177                "\r\n" "\n" t))
8178       (setq args (cdr args)))
8179     (if subject
8180         (message-goto-body)
8181       (message-goto-subject))))
8182
8183 (defun gnus-button-embedded-url (address)
8184   "Activate ADDRESS with `browse-url'."
8185   (browse-url (gnus-strip-whitespace address)))
8186
8187 ;;; Next/prev buttons in the article buffer.
8188
8189 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8190 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8191
8192 (defvar gnus-prev-page-map
8193   (let ((map (make-sparse-keymap)))
8194     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8195     (define-key map "\r" 'gnus-button-prev-page)
8196     map))
8197
8198 (defvar gnus-next-page-map
8199   (let ((map (make-sparse-keymap)))
8200     (unless (>= emacs-major-version 21)
8201       ;; XEmacs doesn't care.
8202       (set-keymap-parent map gnus-article-mode-map))
8203     (define-key map gnus-mouse-2 'gnus-button-next-page)
8204     (define-key map "\r" 'gnus-button-next-page)
8205     map))
8206
8207 (defun gnus-insert-prev-page-button ()
8208   (let ((b (point)) e
8209         (inhibit-read-only t))
8210     (gnus-eval-format
8211      gnus-prev-page-line-format nil
8212      `(keymap ,gnus-prev-page-map
8213               gnus-prev t
8214               gnus-callback gnus-article-button-prev-page
8215               article-type annotation))
8216     (setq e (if (bolp)
8217                 ;; Exclude a newline.
8218                 (1- (point))
8219               (point)))
8220     (when gnus-article-button-face
8221       (gnus-overlay-put (gnus-make-overlay b e nil t)
8222                         'face gnus-article-button-face))
8223     (widget-convert-button
8224      'link b e
8225      :action 'gnus-button-prev-page
8226      :button-keymap gnus-prev-page-map)))
8227
8228 (defun gnus-button-next-page (&optional args more-args)
8229   "Go to the next page."
8230   (interactive)
8231   (let ((win (selected-window)))
8232     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8233     (gnus-article-next-page)
8234     (select-window win)))
8235
8236 (defun gnus-button-prev-page (&optional args more-args)
8237   "Go to the prev page."
8238   (interactive)
8239   (let ((win (selected-window)))
8240     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8241     (gnus-article-prev-page)
8242     (select-window win)))
8243
8244 (defun gnus-insert-next-page-button ()
8245   (let ((b (point)) e
8246         (inhibit-read-only t))
8247     (gnus-eval-format gnus-next-page-line-format nil
8248                       `(keymap ,gnus-next-page-map
8249                                gnus-next t
8250                                gnus-callback gnus-article-button-next-page
8251                                article-type annotation))
8252     (setq e (if (bolp)
8253                 ;; Exclude a newline.
8254                 (1- (point))
8255               (point)))
8256     (when gnus-article-button-face
8257       (gnus-overlay-put (gnus-make-overlay b e nil t)
8258                         'face gnus-article-button-face))
8259     (widget-convert-button
8260      'link b e
8261      :action 'gnus-button-next-page
8262      :button-keymap gnus-next-page-map)))
8263
8264 (defun gnus-article-button-next-page (arg)
8265   "Go to the next page."
8266   (interactive "P")
8267   (let ((win (selected-window)))
8268     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8269     (gnus-article-next-page)
8270     (select-window win)))
8271
8272 (defun gnus-article-button-prev-page (arg)
8273   "Go to the prev page."
8274   (interactive "P")
8275   (let ((win (selected-window)))
8276     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8277     (gnus-article-prev-page)
8278     (select-window win)))
8279
8280 (defvar gnus-decode-header-methods
8281   '(mail-decode-encoded-word-region)
8282   "List of methods used to decode headers.
8283
8284 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8285 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8286 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8287 whose names match REGEXP.
8288
8289 For example:
8290 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8291  mail-decode-encoded-word-region
8292  (\"chinese\" . rfc1843-decode-region))
8293 ")
8294
8295 (defvar gnus-decode-header-methods-cache nil)
8296
8297 (defun gnus-multi-decode-header (start end)
8298   "Apply the functions from `gnus-encoded-word-methods' that match."
8299   (unless (and gnus-decode-header-methods-cache
8300                (eq gnus-newsgroup-name
8301                    (car gnus-decode-header-methods-cache)))
8302     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8303     (dolist (x gnus-decode-header-methods)
8304       (if (symbolp x)
8305           (nconc gnus-decode-header-methods-cache (list x))
8306         (if (and gnus-newsgroup-name
8307                  (string-match (car x) gnus-newsgroup-name))
8308             (nconc gnus-decode-header-methods-cache
8309                    (list (cdr x)))))))
8310   (let ((xlist gnus-decode-header-methods-cache))
8311     (pop xlist)
8312     (save-restriction
8313       (narrow-to-region start end)
8314       (while xlist
8315         (funcall (pop xlist) (point-min) (point-max))))))
8316
8317 ;;;
8318 ;;; Treatment top-level handling.
8319 ;;;
8320
8321 (defun gnus-treat-article (condition &optional part-number total-parts type)
8322   (let ((length (- (point-max) (point-min)))
8323         (alist gnus-treatment-function-alist)
8324         (article-goto-body-goes-to-point-min-p t)
8325         (treated-type
8326          (or (not type)
8327              (catch 'found
8328                (let ((list gnus-article-treat-types))
8329                  (while list
8330                    (when (string-match (pop list) type)
8331                      (throw 'found t)))))))
8332         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8333         val elem)
8334     (gnus-run-hooks 'gnus-part-display-hook)
8335     (dolist (elem alist)
8336       (setq val
8337             (save-excursion
8338               (when (gnus-buffer-live-p gnus-summary-buffer)
8339                 (set-buffer gnus-summary-buffer))
8340               (symbol-value (car elem))))
8341       (when (and (or (consp val)
8342                      treated-type)
8343                  (gnus-treat-predicate val)
8344                  (or (not (get (car elem) 'highlight))
8345                      highlightp))
8346         (save-restriction
8347           (funcall (cadr elem)))))))
8348
8349 ;; Dynamic variables.
8350 (defvar part-number)
8351 (defvar total-parts)
8352 (defvar type)
8353 (defvar condition)
8354 (defvar length)
8355
8356 (defun gnus-treat-predicate (val)
8357   (cond
8358    ((null val)
8359     nil)
8360    (condition
8361     (eq condition val))
8362    ((and (listp val)
8363          (stringp (car val)))
8364     (apply 'gnus-or (mapcar `(lambda (s)
8365                                (string-match s ,(or gnus-newsgroup-name "")))
8366                             val)))
8367    ((listp val)
8368     (let ((pred (pop val)))
8369       (cond
8370        ((eq pred 'or)
8371         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8372        ((eq pred 'and)
8373         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8374        ((eq pred 'not)
8375         (not (gnus-treat-predicate (car val))))
8376        ((eq pred 'typep)
8377         (equal (car val) type))
8378        (t
8379         (error "%S is not a valid predicate" pred)))))
8380    ((eq val t)
8381     t)
8382    ((eq val 'head)
8383     nil)
8384    ((eq val 'first)
8385     (eq part-number 1))
8386    ((eq val 'last)
8387     (eq part-number total-parts))
8388    ((numberp val)
8389     (< length val))
8390    (t
8391     (error "%S is not a valid value" val))))
8392
8393 (defun gnus-article-encrypt-body (protocol &optional n)
8394   "Encrypt the article body."
8395   (interactive
8396    (list
8397     (or gnus-article-encrypt-protocol
8398         (completing-read "Encrypt protocol: "
8399                          gnus-article-encrypt-protocol-alist
8400                          nil t))
8401     current-prefix-arg))
8402   ;; User might hit `K E' instead of `K e', so prompt once.
8403   (when (and gnus-article-encrypt-protocol
8404              gnus-novice-user)
8405     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8406       (error "Encrypt aborted")))
8407   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8408     (unless func
8409       (error "Can't find the encrypt protocol %s" protocol))
8410     (if (member gnus-newsgroup-name '("nndraft:delayed"
8411                                       "nndraft:drafts"
8412                                       "nndraft:queue"))
8413         (error "Can't encrypt the article in group %s"
8414                gnus-newsgroup-name))
8415     (gnus-summary-iterate n
8416       (with-current-buffer gnus-summary-buffer
8417         (let ((mail-parse-charset gnus-newsgroup-charset)
8418               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8419               (summary-buffer gnus-summary-buffer)
8420               references point)
8421           (gnus-set-global-variables)
8422           (when (gnus-group-read-only-p)
8423             (error "The current newsgroup does not support article encrypt"))
8424           (gnus-summary-show-article t)
8425           (setq references
8426               (or (mail-header-references gnus-current-headers) ""))
8427           (set-buffer gnus-article-buffer)
8428           (let* ((inhibit-read-only t)
8429                  (headers
8430                   (mapcar (lambda (field)
8431                             (and (save-restriction
8432                                    (message-narrow-to-head)
8433                                    (goto-char (point-min))
8434                                    (search-forward field nil t))
8435                                  (prog2
8436                                      (message-narrow-to-field)
8437                                      (buffer-string)
8438                                    (delete-region (point-min) (point-max))
8439                                    (widen))))
8440                           '("Content-Type:" "Content-Transfer-Encoding:"
8441                             "Content-Disposition:"))))
8442             (message-narrow-to-head)
8443             (message-remove-header "MIME-Version")
8444             (goto-char (point-max))
8445             (setq point (point))
8446             (insert (apply 'concat headers))
8447             (widen)
8448             (narrow-to-region point (point-max))
8449             (let ((message-options message-options))
8450               (message-options-set 'message-sender user-mail-address)
8451               (message-options-set 'message-recipients user-mail-address)
8452               (message-options-set 'message-sign-encrypt 'not)
8453               (funcall func))
8454             (goto-char (point-min))
8455             (insert "MIME-Version: 1.0\n")
8456             (widen)
8457             (gnus-summary-edit-article-done
8458              references nil summary-buffer t))
8459           (when gnus-keep-backlog
8460             (gnus-backlog-remove-article
8461              (car gnus-article-current) (cdr gnus-article-current)))
8462           (when (get-buffer gnus-original-article-buffer)
8463             (with-current-buffer gnus-original-article-buffer
8464               (setq gnus-original-article nil)))
8465           (when gnus-use-cache
8466             (gnus-cache-update-article
8467              (car gnus-article-current) (cdr gnus-article-current))))))))
8468
8469 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8470   "The following specs can be used:
8471 %t  The security MIME type
8472 %i  Additional info
8473 %d  Details
8474 %D  Details if button is pressed")
8475
8476 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8477   "The following specs can be used:
8478 %t  The security MIME type
8479 %i  Additional info
8480 %d  Details
8481 %D  Details if button is pressed")
8482
8483 (defvar gnus-mime-security-button-line-format-alist
8484   '((?t gnus-tmp-type ?s)
8485     (?i gnus-tmp-info ?s)
8486     (?d gnus-tmp-details ?s)
8487     (?D gnus-tmp-pressed-details ?s)))
8488
8489 (defvar gnus-mime-security-button-commands
8490   '((gnus-article-press-button "\r" "Show Detail")
8491     (undefined "v")
8492     (undefined "t")
8493     (undefined "C")
8494     (gnus-mime-security-save-part "o" "Save...")
8495     (undefined "\C-o")
8496     (undefined "r")
8497     (undefined "d")
8498     (undefined "c")
8499     (undefined "i")
8500     (undefined "E")
8501     (undefined "e")
8502     (undefined "p")
8503     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8504     (undefined ".")))
8505
8506 (defvar gnus-mime-security-button-map
8507   (let ((map (make-sparse-keymap)))
8508     (define-key map gnus-mouse-2 'gnus-article-push-button)
8509     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8510     (dolist (c gnus-mime-security-button-commands)
8511       (define-key map (cadr c) (car c)))
8512     map))
8513
8514 (easy-menu-define
8515   gnus-mime-security-button-menu gnus-mime-security-button-map
8516   "Security button menu."
8517   `("Security Part"
8518     ,@(delq nil
8519             (mapcar (lambda (c)
8520                       (unless (eq (car c) 'undefined)
8521                         (vector (caddr c) (car c) :active t)))
8522                     gnus-mime-security-button-commands))))
8523
8524 (defun gnus-mime-security-button-menu (event prefix)
8525   "Construct a context-sensitive menu of security commands."
8526   (interactive "e\nP")
8527   (save-window-excursion
8528     (let ((pos (event-start event)))
8529       (select-window (posn-window pos))
8530       (goto-char (posn-point pos))
8531       (gnus-article-check-buffer)
8532       (popup-menu gnus-mime-security-button-menu nil prefix))))
8533
8534 (defvar gnus-mime-security-details-buffer nil)
8535
8536 (defvar gnus-mime-security-button-pressed nil)
8537
8538 (defvar gnus-mime-security-show-details-inline t
8539   "If non-nil, show details in the article buffer.")
8540
8541 (defun gnus-mime-security-verify-or-decrypt (handle)
8542   (mm-remove-parts (cdr handle))
8543   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8544         point (inhibit-read-only t))
8545     (if region
8546         (goto-char (car region)))
8547     (setq point (point))
8548     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8549       (let* ((mm-verify-option 'known)
8550              (mm-decrypt-option 'known)
8551              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8552         (unless (eq nparts (cdr handle))
8553           (mm-destroy-parts (cdr handle))
8554           (setcdr handle nparts))))
8555     (gnus-mime-display-security handle)
8556     (when region
8557       (delete-region (point) (cdr region))
8558       (set-marker (car region) nil)
8559       (set-marker (cdr region) nil))
8560     (goto-char point)))
8561
8562 (defun gnus-mime-security-show-details (handle)
8563   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8564     (if (not details)
8565         (gnus-message 5 "No details.")
8566       (if gnus-mime-security-show-details-inline
8567           (let ((gnus-mime-security-button-pressed
8568                  (not (get-text-property (point) 'gnus-mime-details)))
8569                 (gnus-mime-security-button-line-format
8570                  (get-text-property (point) 'gnus-line-format))
8571                 (inhibit-read-only t))
8572             (forward-char -1)
8573             (while (eq (get-text-property (point) 'gnus-line-format)
8574                        gnus-mime-security-button-line-format)
8575               (forward-char -1))
8576             (forward-char)
8577             (save-restriction
8578               (narrow-to-region (point) (point))
8579               (gnus-insert-mime-security-button handle))
8580             (delete-region (point)
8581                            (or (text-property-not-all
8582                                 (point) (point-max)
8583                                 'gnus-line-format
8584                                 gnus-mime-security-button-line-format)
8585                                (point-max))))
8586         ;; Not inlined.
8587         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8588             (with-current-buffer gnus-mime-security-details-buffer
8589               (erase-buffer)
8590               t)
8591           (setq gnus-mime-security-details-buffer
8592                 (gnus-get-buffer-create "*MIME Security Details*")))
8593         (with-current-buffer gnus-mime-security-details-buffer
8594           (insert details)
8595           (goto-char (point-min)))
8596         (pop-to-buffer gnus-mime-security-details-buffer)))))
8597
8598 (defun gnus-mime-security-press-button (handle)
8599   (save-excursion
8600     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8601         (gnus-mime-security-show-details handle)
8602       (gnus-mime-security-verify-or-decrypt handle))))
8603
8604 (defun gnus-insert-mime-security-button (handle &optional displayed)
8605   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8606          (gnus-tmp-type
8607           (concat
8608            (or (nth 2 (assoc protocol mm-verify-function-alist))
8609                (nth 2 (assoc protocol mm-decrypt-function-alist))
8610                "Unknown")
8611            (if (equal (car handle) "multipart/signed")
8612                " Signed" " Encrypted")
8613            " Part"))
8614          (gnus-tmp-info
8615           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8616               "Undecided"))
8617          (gnus-tmp-details
8618           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8619          gnus-tmp-pressed-details
8620          b e)
8621     (setq gnus-tmp-details
8622           (if gnus-tmp-details
8623               (concat "\n" gnus-tmp-details)
8624             ""))
8625     (setq gnus-tmp-pressed-details
8626           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8627     (unless (bolp)
8628       (insert "\n"))
8629     (setq b (point))
8630     (gnus-eval-format
8631      gnus-mime-security-button-line-format
8632      gnus-mime-security-button-line-format-alist
8633      `(keymap ,gnus-mime-security-button-map
8634          gnus-callback gnus-mime-security-press-button
8635          gnus-line-format ,gnus-mime-security-button-line-format
8636          gnus-mime-details ,gnus-mime-security-button-pressed
8637          article-type annotation
8638          gnus-data ,handle))
8639     (setq e (if (bolp)
8640                 ;; Exclude a newline.
8641                 (1- (point))
8642               (point)))
8643     (when gnus-article-button-face
8644       (gnus-overlay-put (gnus-make-overlay b e nil t)
8645                         'face gnus-article-button-face))
8646     (widget-convert-button
8647      'link b e
8648      :mime-handle handle
8649      :action 'gnus-widget-press-button
8650      :button-keymap gnus-mime-security-button-map
8651      :help-echo
8652      (lambda (widget/window &optional overlay pos)
8653        ;; Needed to properly clear the message due to a bug in
8654        ;; wid-edit (XEmacs only).
8655        (when (boundp 'help-echo-owns-message)
8656          (setq help-echo-owns-message t))
8657        (format
8658         "%S: show detail; %S: more options"
8659         (aref gnus-mouse-2 0)
8660         (aref gnus-down-mouse-3 0))))))
8661
8662 (defun gnus-mime-display-security (handle)
8663   (save-restriction
8664     (narrow-to-region (point) (point))
8665     (unless (gnus-unbuttonized-mime-type-p (car handle))
8666       (gnus-insert-mime-security-button handle))
8667     (gnus-mime-display-part (cadr handle))
8668     (unless (bolp)
8669       (insert "\n"))
8670     (unless (gnus-unbuttonized-mime-type-p (car handle))
8671       (let ((gnus-mime-security-button-line-format
8672              gnus-mime-security-button-end-line-format))
8673         (gnus-insert-mime-security-button handle)))
8674     (mm-set-handle-multipart-parameter
8675      handle 'gnus-region
8676      (cons (set-marker (make-marker) (point-min))
8677            (set-marker (make-marker) (point-max))))
8678     (goto-char (point-max))))
8679
8680 (defun gnus-mime-security-run-function (function)
8681   "Run FUNCTION with the security part under point."
8682   (gnus-article-check-buffer)
8683   (let ((data (get-text-property (point) 'gnus-data))
8684         buffer handle)
8685     (when (and (stringp (car-safe data))
8686                (setq buffer (mm-handle-multipart-original-buffer data))
8687                (setq handle (cadr data)))
8688       (if (bufferp (mm-handle-buffer handle))
8689           (progn
8690             (setq handle (cons buffer (copy-sequence (cdr handle))))
8691             (mm-handle-set-undisplayer handle nil))
8692         (setq handle (mm-make-handle
8693                       buffer
8694                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8695                       nil nil nil nil nil nil)))
8696       (funcall function handle))))
8697
8698 (defun gnus-mime-security-save-part ()
8699   "Save the security part under point."
8700   (interactive)
8701   (gnus-mime-security-run-function 'mm-save-part))
8702
8703 (defun gnus-mime-security-pipe-part ()
8704   "Pipe the security part under point to a process."
8705   (interactive)
8706   (gnus-mime-security-run-function 'mm-pipe-part))
8707
8708 (gnus-ems-redefine)
8709
8710 (provide 'gnus-art)
8711
8712 (run-hooks 'gnus-art-load-hook)
8713
8714 ;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
8715 ;;; gnus-art.el ends here