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