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