Merge gnus-6_5.
[elisp/gnus.git-] / lisp / gnus-art.el
1 ;;; gnus-art.el --- article mode commands for Semi-gnus
2 ;; Copyright (C) 1996,97,98 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;;         MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Keywords: mail, news, MIME
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'custom)
32 (require 'gnus)
33 (require 'gnus-sum)
34 (require 'gnus-spec)
35 (require 'gnus-int)
36 (require 'browse-url)
37 (require 'alist)
38 (require 'mime-view)
39
40 (defgroup gnus-article nil
41   "Article display."
42   :link '(custom-manual "(gnus)The Article Buffer")
43   :group 'gnus)
44
45 (defgroup gnus-article-hiding nil
46   "Hiding article parts."
47   :link '(custom-manual "(gnus)Article Hiding")
48   :group 'gnus-article)
49
50 (defgroup gnus-article-highlight nil
51   "Article highlighting."
52   :link '(custom-manual "(gnus)Article Highlighting")
53   :group 'gnus-article
54   :group 'gnus-visual)
55
56 (defgroup gnus-article-signature nil
57   "Article signatures."
58   :link '(custom-manual "(gnus)Article Signature")
59   :group 'gnus-article)
60
61 (defgroup gnus-article-headers nil
62   "Article headers."
63   :link '(custom-manual "(gnus)Hiding Headers")
64   :group 'gnus-article)
65
66 (defgroup gnus-article-washing nil
67   "Special commands on articles."
68   :link '(custom-manual "(gnus)Article Washing")
69   :group 'gnus-article)
70
71 (defgroup gnus-article-emphasis nil
72   "Fontisizing articles."
73   :link '(custom-manual "(gnus)Article Fontisizing")
74   :group 'gnus-article)
75
76 (defgroup gnus-article-saving nil
77   "Saving articles."
78   :link '(custom-manual "(gnus)Saving Articles")
79   :group 'gnus-article)
80
81 (defgroup gnus-article-mime nil
82   "Worshiping the MIME wonder."
83   :link '(custom-manual "(gnus)Using MIME")
84   :group 'gnus-article)
85
86 (defgroup gnus-article-buttons nil
87   "Pushable buttons in the article buffer."
88   :link '(custom-manual "(gnus)Article Buttons")
89   :group 'gnus-article)
90
91 (defgroup gnus-article-various nil
92   "Other article options."
93   :link '(custom-manual "(gnus)Misc Article")
94   :group 'gnus-article)
95
96 (defcustom gnus-ignored-headers
97   '("^Path:" "^Posting-Version:" "^Article-I.D.:" "^Expires:"
98     "^Date-Received:" "^References:" "^Control:" "^Xref:" "^Lines:"
99     "^Posted:" "^Relay-Version:" "^Message-ID:" "^Nf-ID:" "^Nf-From:"
100     "^Approved:" "^Sender:" "^Received:" "^Mail-from:")
101   "*All headers that start with this regexp will be hidden.
102 This variable can also be a list of regexps of headers to be ignored.
103 If `gnus-visible-headers' is non-nil, this variable will be ignored."
104   :type '(choice :custom-show nil
105                  regexp
106                  (repeat regexp))
107   :group 'gnus-article-hiding)
108
109 (defcustom gnus-visible-headers
110   "From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|X-Sent:"
111   "*All headers that do not match this regexp will be hidden.
112 This variable can also be a list of regexp of headers to remain visible.
113 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
114   :type '(repeat :value-to-internal (lambda (widget value)
115                                       (custom-split-regexp-maybe value))
116                  :match (lambda (widget value)
117                           (or (stringp value)
118                               (widget-editable-list-match widget value)))
119                  regexp)
120   :group 'gnus-article-hiding)
121
122 (defcustom gnus-sorted-header-list
123   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
124     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
125   "*This variable is a list of regular expressions.
126 If it is non-nil, headers that match the regular expressions will
127 be placed first in the article buffer in the sequence specified by
128 this list."
129   :type '(repeat regexp)
130   :group 'gnus-article-hiding)
131
132 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
133   "Headers that are only to be displayed if they have interesting data.
134 Possible values in this list are `empty', `newsgroups', `followup-to',
135 `reply-to', `date', `long-to', and `many-to'."
136   :type '(set (const :tag "Headers with no content." empty)
137               (const :tag "Newsgroups with only one group." newsgroups)
138               (const :tag "Followup-to identical to newsgroups." followup-to)
139               (const :tag "Reply-to identical to from." reply-to)
140               (const :tag "Date less than four days old." date)
141               (const :tag "Very long To header." long-to)
142               (const :tag "Multiple To headers." many-to))
143   :group 'gnus-article-hiding)
144
145 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
146   "Regexp matching signature separator.
147 This can also be a list of regexps.  In that case, it will be checked
148 from head to tail looking for a separator.  Searches will be done from
149 the end of the buffer."
150   :type '(repeat string)
151   :group 'gnus-article-signature)
152
153 (defcustom gnus-signature-limit nil
154    "Provide a limit to what is considered a signature.
155 If it is a number, no signature may not be longer (in characters) than
156 that number.  If it is a floating point number, no signature may be
157 longer (in lines) than that number.  If it is a function, the function
158 will be called without any parameters, and if it returns nil, there is
159 no signature in the buffer.  If it is a string, it will be used as a
160 regexp.  If it matches, the text in question is not a signature."
161   :type '(choice (integer :value 200)
162                  (number :value 4.0)
163                  (function :value fun)
164                  (regexp :value ".*"))
165   :group 'gnus-article-signature)
166
167 (defcustom gnus-hidden-properties '(invisible t intangible t)
168   "Property list to use for hiding text."
169   :type 'sexp
170   :group 'gnus-article-hiding)
171
172 (defcustom gnus-article-x-face-command
173   "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
174   "*String or function to be executed to display an X-Face header.
175 If it is a string, the command will be executed in a sub-shell
176 asynchronously.  The compressed face will be piped to this command."
177   :type 'string                         ;Leave function case to Lisp.
178   :group 'gnus-article-washing)
179
180 (defcustom gnus-article-x-face-too-ugly nil
181   "Regexp matching posters whose face shouldn't be shown automatically."
182   :type '(choice regexp (const nil))
183   :group 'gnus-article-washing)
184
185 (defcustom gnus-emphasis-alist
186   (let ((format
187          "\\(\\s-\\|^\\|[-\"]\\|\\s(\\|\\s)\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-?!.,;:\"]\\|\\s(\\|\\s)\\)")
188         (types
189          '(("_" "_" underline)
190            ("/" "/" italic)
191            ("\\*" "\\*" bold)
192            ("_/" "/_" underline-italic)
193            ("_\\*" "\\*_" underline-bold)
194            ("\\*/" "/\\*" bold-italic)
195            ("_\\*/" "/\\*_" underline-bold-italic))))
196     `(("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
197        2 3 gnus-emphasis-underline)
198       ,@(mapcar
199          (lambda (spec)
200            (list
201             (format format (car spec) (cadr spec))
202             2 3 (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
203          types)))
204   "*Alist that says how to fontify certain phrases.
205 Each item looks like this:
206
207   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
208
209 The first element is a regular expression to be matched.  The second
210 is a number that says what regular expression grouping used to find
211 the entire emphasized word.  The third is a number that says what
212 regexp grouping should be displayed and highlighted.  The fourth
213 is the face used for highlighting."
214   :type '(repeat (list :value ("" 0 0 default)
215                        regexp
216                        (integer :tag "Match group")
217                        (integer :tag "Emphasize group")
218                        face))
219   :group 'gnus-article-emphasis)
220
221 (defface gnus-emphasis-bold '((t (:bold t)))
222   "Face used for displaying strong emphasized text (*word*)."
223   :group 'gnus-article-emphasis)
224
225 (defface gnus-emphasis-italic '((t (:italic t)))
226   "Face used for displaying italic emphasized text (/word/)."
227   :group 'gnus-article-emphasis)
228
229 (defface gnus-emphasis-underline '((t (:underline t)))
230   "Face used for displaying underlined emphasized text (_word_)."
231   :group 'gnus-article-emphasis)
232
233 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
234   "Face used for displaying underlined bold emphasized text (_*word*_)."
235   :group 'gnus-article-emphasis)
236
237 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
238   "Face used for displaying underlined italic emphasized text (_*word*_)."
239   :group 'gnus-article-emphasis)
240
241 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
242   "Face used for displaying bold italic emphasized text (/*word*/)."
243   :group 'gnus-article-emphasis)
244
245 (defface gnus-emphasis-underline-bold-italic
246   '((t (:bold t :italic t :underline t)))
247   "Face used for displaying underlined bold italic emphasized text.
248 Esample: (_/*word*/_)."
249   :group 'gnus-article-emphasis)
250
251 (defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
252   "Format for display of Date headers in article bodies.
253 See `format-time-string' for the possible values.
254
255 The variable can also be function, which should return a complete Date
256 header.  The function is called with one argument, the time, which can
257 be fed to `format-time-string'."
258   :type '(choice string symbol)
259   :link '(custom-manual "(gnus)Article Date")
260   :group 'gnus-article-washing)
261
262 (eval-and-compile
263   (autoload 'hexl-hex-string-to-integer "hexl")
264   (autoload 'timezone-make-date-arpa-standard "timezone")
265   (autoload 'mail-extract-address-components "mail-extr"))
266
267 (defcustom gnus-save-all-headers t
268   "*If non-nil, don't remove any headers before saving."
269   :group 'gnus-article-saving
270   :type 'boolean)
271
272 (defcustom gnus-prompt-before-saving 'always
273   "*This variable says how much prompting is to be done when saving articles.
274 If it is nil, no prompting will be done, and the articles will be
275 saved to the default files.  If this variable is `always', each and
276 every article that is saved will be preceded by a prompt, even when
277 saving large batches of articles.  If this variable is neither nil not
278 `always', there the user will be prompted once for a file name for
279 each invocation of the saving commands."
280   :group 'gnus-article-saving
281   :type '(choice (item always)
282                  (item :tag "never" nil)
283                  (sexp :tag "once" :format "%t\n" :value t)))
284
285 (defcustom gnus-saved-headers gnus-visible-headers
286   "Headers to keep if `gnus-save-all-headers' is nil.
287 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
288 If that variable is nil, however, all headers that match this regexp
289 will be kept while the rest will be deleted before saving."
290   :group 'gnus-article-saving
291   :type 'regexp)
292
293 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
294   "A function to save articles in your favourite format.
295 The function must be interactively callable (in other words, it must
296 be an Emacs command).
297
298 Gnus provides the following functions:
299
300 * gnus-summary-save-in-rmail (Rmail format)
301 * gnus-summary-save-in-mail (Unix mail format)
302 * gnus-summary-save-in-folder (MH folder)
303 * gnus-summary-save-in-file (article format)
304 * gnus-summary-save-in-vm (use VM's folder format)
305 * gnus-summary-write-to-file (article format -- overwrite)."
306   :group 'gnus-article-saving
307   :type '(radio (function-item gnus-summary-save-in-rmail)
308                 (function-item gnus-summary-save-in-mail)
309                 (function-item gnus-summary-save-in-folder)
310                 (function-item gnus-summary-save-in-file)
311                 (function-item gnus-summary-save-in-vm)
312                 (function-item gnus-summary-write-to-file)))
313
314 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
315   "A function generating a file name to save articles in Rmail format.
316 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
317   :group 'gnus-article-saving
318   :type 'function)
319
320 (defcustom gnus-mail-save-name 'gnus-plain-save-name
321   "A function generating a file name to save articles in Unix mail format.
322 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
323   :group 'gnus-article-saving
324   :type 'function)
325
326 (defcustom gnus-folder-save-name 'gnus-folder-save-name
327   "A function generating a file name to save articles in MH folder.
328 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
329   :group 'gnus-article-saving
330   :type 'function)
331
332 (defcustom gnus-file-save-name 'gnus-numeric-save-name
333   "A function generating a file name to save articles in article format.
334 The function is called with NEWSGROUP, HEADERS, and optional
335 LAST-FILE."
336   :group 'gnus-article-saving
337   :type 'function)
338
339 (defcustom gnus-split-methods
340   '((gnus-article-archive-name)
341     (gnus-article-nndoc-name))
342   "*Variable used to suggest where articles are to be saved.
343 For instance, if you would like to save articles related to Gnus in
344 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
345 you could set this variable to something like:
346
347  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
348    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
349
350 This variable is an alist where the where the key is the match and the
351 value is a list of possible files to save in if the match is non-nil.
352
353 If the match is a string, it is used as a regexp match on the
354 article.  If the match is a symbol, that symbol will be funcalled
355 from the buffer of the article to be saved with the newsgroup as the
356 parameter.  If it is a list, it will be evaled in the same buffer.
357
358 If this form or function returns a string, this string will be used as
359 a possible file name; and if it returns a non-nil list, that list will
360 be used as possible file names."
361   :group 'gnus-article-saving
362   :type '(repeat (choice (list :value (fun) function)
363                          (cons :value ("" "") regexp (repeat string))
364                          (sexp :value nil))))
365
366 (defcustom gnus-strict-mime t
367   "*If nil, MIME-decode even if there is no Mime-Version header."
368   :group 'gnus-article-mime
369   :type 'boolean)
370
371 (defcustom gnus-show-mime-method 'gnus-article-preview-mime-message
372   "Function to process a MIME message.
373 The function is called from the article buffer."
374   :group 'gnus-article-mime
375   :type 'function)
376
377 (defcustom gnus-decode-encoded-word-method 'gnus-article-decode-encoded-word
378   "*Function to decode MIME encoded words.
379 The function is called from the article buffer."
380   :group 'gnus-article-mime
381   :type 'function)
382
383 (defcustom gnus-page-delimiter "^\^L"
384   "*Regexp describing what to use as article page delimiters.
385 The default value is \"^\^L\", which is a form linefeed at the
386 beginning of a line."
387   :type 'regexp
388   :group 'gnus-article-various)
389
390 (defcustom gnus-article-mode-line-format "Gnus: %%b %S"
391   "*The format specification for the article mode line.
392 See `gnus-summary-mode-line-format' for a closer description."
393   :type 'string
394   :group 'gnus-article-various)
395
396 (defcustom gnus-article-mode-hook nil
397   "*A hook for Gnus article mode."
398   :type 'hook
399   :group 'gnus-article-various)
400
401 (defcustom gnus-article-menu-hook nil
402   "*Hook run after the creation of the article mode menu."
403   :type 'hook
404   :group 'gnus-article-various)
405
406 (defcustom gnus-article-prepare-hook nil
407   "*A hook called after an article has been prepared in the article buffer.
408 If you want to run a special decoding program like nkf, use this hook."
409   :type 'hook
410   :group 'gnus-article-various)
411
412 (defcustom gnus-article-hide-pgp-hook nil
413   "*A hook called after successfully hiding a PGP signature."
414   :type 'hook
415   :group 'gnus-article-various)
416
417 (defcustom gnus-article-button-face 'bold
418   "Face used for highlighting buttons in the article buffer.
419
420 An article button is a piece of text that you can activate by pressing
421 `RET' or `mouse-2' above it."
422   :type 'face
423   :group 'gnus-article-buttons)
424
425 (defcustom gnus-article-mouse-face 'highlight
426   "Face used for mouse highlighting in the article buffer.
427
428 Article buttons will be displayed in this face when the cursor is
429 above them."
430   :type 'face
431   :group 'gnus-article-buttons)
432
433 (defcustom gnus-signature-face 'gnus-signature-face
434   "Face used for highlighting a signature in the article buffer.
435 Obsolete; use the face `gnus-signature-face' for customizations instead."
436   :type 'face
437   :group 'gnus-article-highlight
438   :group 'gnus-article-signature)
439
440 (defface gnus-signature-face
441   '((((type x))
442      (:italic t)))
443   "Face used for highlighting a signature in the article buffer."
444   :group 'gnus-article-highlight
445   :group 'gnus-article-signature)
446
447 (defface gnus-header-from-face
448   '((((class color)
449       (background dark))
450      (:foreground "spring green" :bold t))
451     (((class color)
452       (background light))
453      (:foreground "red3" :bold t))
454     (t
455      (:bold t :italic t)))
456   "Face used for displaying from headers."
457   :group 'gnus-article-headers
458   :group 'gnus-article-highlight)
459
460 (defface gnus-header-subject-face
461   '((((class color)
462       (background dark))
463      (:foreground "SeaGreen3" :bold t))
464     (((class color)
465       (background light))
466      (:foreground "red4" :bold t))
467     (t
468      (:bold t :italic t)))
469   "Face used for displaying subject headers."
470   :group 'gnus-article-headers
471   :group 'gnus-article-highlight)
472
473 (defface gnus-header-newsgroups-face
474   '((((class color)
475       (background dark))
476      (:foreground "yellow" :bold t :italic t))
477     (((class color)
478       (background light))
479      (:foreground "MidnightBlue" :bold t :italic t))
480     (t
481      (:bold t :italic t)))
482   "Face used for displaying newsgroups headers."
483   :group 'gnus-article-headers
484   :group 'gnus-article-highlight)
485
486 (defface gnus-header-name-face
487   '((((class color)
488       (background dark))
489      (:foreground "SeaGreen"))
490     (((class color)
491       (background light))
492      (:foreground "maroon"))
493     (t
494      (:bold t)))
495   "Face used for displaying header names."
496   :group 'gnus-article-headers
497   :group 'gnus-article-highlight)
498
499 (defface gnus-header-content-face
500   '((((class color)
501       (background dark))
502      (:foreground "forest green" :italic t))
503     (((class color)
504       (background light))
505      (:foreground "indianred4" :italic t))
506     (t
507      (:italic t)))  "Face used for displaying header content."
508   :group 'gnus-article-headers
509   :group 'gnus-article-highlight)
510
511 (defcustom gnus-header-face-alist
512   '(("From" nil gnus-header-from-face)
513     ("Subject" nil gnus-header-subject-face)
514     ("Newsgroups:.*," nil gnus-header-newsgroups-face)
515     ("" gnus-header-name-face gnus-header-content-face))
516   "*Controls highlighting of article header.
517
518 An alist of the form (HEADER NAME CONTENT).
519
520 HEADER is a regular expression which should match the name of an
521 header header and NAME and CONTENT are either face names or nil.
522
523 The name of each header field will be displayed using the face
524 specified by the first element in the list where HEADER match the
525 header name and NAME is non-nil.  Similarly, the content will be
526 displayed by the first non-nil matching CONTENT face."
527   :group 'gnus-article-headers
528   :group 'gnus-article-highlight
529   :type '(repeat (list (regexp :tag "Header")
530                        (choice :tag "Name"
531                                (item :tag "skip" nil)
532                                (face :value default))
533                        (choice :tag "Content"
534                                (item :tag "skip" nil)
535                                (face :value default)))))
536
537 ;;; Internal variables
538
539 (defvar article-lapsed-timer nil)
540 (defvar gnus-article-current-summary nil)
541
542 (defvar gnus-article-mode-syntax-table
543   (let ((table (copy-syntax-table text-mode-syntax-table)))
544     (modify-syntax-entry ?- "w" table)
545     (modify-syntax-entry ?> ")" table)
546     (modify-syntax-entry ?< "(" table)
547     table)
548   "Syntax table used in article mode buffers.
549 Initialized from `text-mode-syntax-table.")
550
551 (defvar gnus-save-article-buffer nil)
552
553 (defvar gnus-article-mode-line-format-alist
554   (nconc '((?w (gnus-article-wash-status) ?s))
555          gnus-summary-mode-line-format-alist))
556
557 (defvar gnus-number-of-articles-to-be-saved nil)
558
559 (defvar gnus-inhibit-hiding nil)
560
561 (defsubst gnus-article-hide-text (b e props)
562   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
563   (add-text-properties b e props)
564   (when (memq 'intangible props)
565     (put-text-property
566      (max (1- b) (point-min))
567      b 'intangible (cddr (memq 'intangible props)))))
568
569 (defsubst gnus-article-unhide-text (b e)
570   "Remove hidden text properties from region between B and E."
571   (remove-text-properties b e gnus-hidden-properties)
572   (when (memq 'intangible gnus-hidden-properties)
573     (put-text-property (max (1- b) (point-min))
574                        b 'intangible nil)))
575
576 (defun gnus-article-hide-text-type (b e type)
577   "Hide text of TYPE between B and E."
578   (gnus-article-hide-text
579    b e (cons 'article-type (cons type gnus-hidden-properties))))
580
581 (defun gnus-article-unhide-text-type (b e type)
582   "Hide text of TYPE between B and E."
583   (remove-text-properties
584    b e (cons 'article-type (cons type gnus-hidden-properties)))
585   (when (memq 'intangible gnus-hidden-properties)
586     (put-text-property (max (1- b) (point-min))
587                        b 'intangible nil)))
588
589 (defun gnus-article-hide-text-of-type (type)
590   "Hide text of TYPE in the current buffer."
591   (save-excursion
592     (let ((b (point-min))
593           (e (point-max)))
594       (while (setq b (text-property-any b e 'article-type type))
595         (add-text-properties b (incf b) gnus-hidden-properties)))))
596
597 (defun gnus-article-delete-text-of-type (type)
598   "Delete text of TYPE in the current buffer."
599   (save-excursion
600     (let ((b (point-min)))
601       (while (setq b (text-property-any b (point-max) 'article-type type))
602         (delete-region
603          b (or (text-property-not-all b (point-max) 'article-type type)
604                (point-max)))))))
605
606 (defun gnus-article-delete-invisible-text ()
607   "Delete all invisible text in the current buffer."
608   (save-excursion
609     (let ((b (point-min)))
610       (while (setq b (text-property-any b (point-max) 'invisible t))
611         (delete-region
612          b (or (text-property-not-all b (point-max) 'invisible t)
613                (point-max)))))))
614
615 (defun gnus-article-text-type-exists-p (type)
616   "Say whether any text of type TYPE exists in the buffer."
617   (text-property-any (point-min) (point-max) 'article-type type))
618
619 (defsubst gnus-article-header-rank ()
620   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
621   (let ((list gnus-sorted-header-list)
622         (i 0))
623     (while list
624       (when (looking-at (car list))
625         (setq list nil))
626       (setq list (cdr list))
627       (incf i))
628     i))
629
630 (defun article-hide-headers (&optional arg delete)
631   "Toggle whether to hide unwanted headers and possibly sort them as well.
632 If given a negative prefix, always show; if given a positive prefix,
633 always hide."
634   (interactive (gnus-article-hidden-arg))
635   (current-buffer)
636   (if (gnus-article-check-hidden-text 'headers arg)
637       ;; Show boring headers as well.
638       (gnus-article-show-hidden-text 'boring-headers)
639     ;; This function might be inhibited.
640     (unless gnus-inhibit-hiding
641       (save-excursion
642         (save-restriction
643           (let ((buffer-read-only nil)
644                 (case-fold-search t)
645                 (props (nconc (list 'article-type 'headers)
646                               gnus-hidden-properties))
647                 (max (1+ (length gnus-sorted-header-list)))
648                 (ignored (when (not gnus-visible-headers)
649                            (cond ((stringp gnus-ignored-headers)
650                                   gnus-ignored-headers)
651                                  ((listp gnus-ignored-headers)
652                                   (mapconcat 'identity gnus-ignored-headers
653                                              "\\|")))))
654                 (visible
655                  (cond ((stringp gnus-visible-headers)
656                         gnus-visible-headers)
657                        ((and gnus-visible-headers
658                              (listp gnus-visible-headers))
659                         (mapconcat 'identity gnus-visible-headers "\\|"))))
660                 (inhibit-point-motion-hooks t)
661                 want-list beg)
662             ;; First we narrow to just the headers.
663             (widen)
664             (goto-char (point-min))
665             ;; Hide any "From " lines at the beginning of (mail) articles.
666             (while (looking-at "From ")
667               (forward-line 1))
668             (unless (bobp)
669               (if delete
670                   (delete-region (point-min) (point))
671                 (gnus-article-hide-text (point-min) (point) props)))
672             ;; Then treat the rest of the header lines.
673             (narrow-to-region
674              (point)
675              (if (search-forward "\n\n" nil t) ; if there's a body
676                  (progn (forward-line -1) (point))
677                (point-max)))
678             ;; Then we use the two regular expressions
679             ;; `gnus-ignored-headers' and `gnus-visible-headers' to
680             ;; select which header lines is to remain visible in the
681             ;; article buffer.
682             (goto-char (point-min))
683             (while (re-search-forward "^[^ \t]*:" nil t)
684               (beginning-of-line)
685               ;; Mark the rank of the header.
686               (put-text-property
687                (point) (1+ (point)) 'message-rank
688                (if (or (and visible (looking-at visible))
689                        (and ignored
690                             (not (looking-at ignored))))
691                    (gnus-article-header-rank)
692                  (+ 2 max)))
693               (forward-line 1))
694             (message-sort-headers-1)
695             (when (setq beg (text-property-any
696                              (point-min) (point-max) 'message-rank (+ 2 max)))
697               ;; We make the unwanted headers invisible.
698               (if delete
699                   (delete-region beg (point-max))
700                 ;; Suggested by Sudish Joseph <joseph@cis.ohio-state.edu>.
701                 (gnus-article-hide-text-type beg (point-max) 'headers))
702               ;; Work around XEmacs lossage.
703               (put-text-property (point-min) beg 'invisible nil))))))))
704
705 (defun article-hide-boring-headers (&optional arg)
706   "Toggle hiding of headers that aren't very interesting.
707 If given a negative prefix, always show; if given a positive prefix,
708 always hide."
709   (interactive (gnus-article-hidden-arg))
710   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
711              (not gnus-show-all-headers))
712     (save-excursion
713       (save-restriction
714         (let ((buffer-read-only nil)
715               (list gnus-boring-article-headers)
716               (inhibit-point-motion-hooks t)
717               elem)
718           (nnheader-narrow-to-headers)
719           (while list
720             (setq elem (pop list))
721             (goto-char (point-min))
722             (cond
723              ;; Hide empty headers.
724              ((eq elem 'empty)
725               (while (re-search-forward "^[^:]+:[ \t]*\n[^ \t]" nil t)
726                 (forward-line -1)
727                 (gnus-article-hide-text-type
728                  (progn (beginning-of-line) (point))
729                  (progn
730                    (end-of-line)
731                    (if (re-search-forward "^[^ \t]" nil t)
732                        (match-beginning 0)
733                      (point-max)))
734                  'boring-headers)))
735              ;; Hide boring Newsgroups header.
736              ((eq elem 'newsgroups)
737               (when (equal (gnus-fetch-field "newsgroups")
738                            (gnus-group-real-name
739                             (if (boundp 'gnus-newsgroup-name)
740                                 gnus-newsgroup-name
741                               "")))
742                 (gnus-article-hide-header "newsgroups")))
743              ((eq elem 'followup-to)
744               (when (equal (message-fetch-field "followup-to")
745                            (message-fetch-field "newsgroups"))
746                 (gnus-article-hide-header "followup-to")))
747              ((eq elem 'reply-to)
748               (let ((from (message-fetch-field "from"))
749                     (reply-to (message-fetch-field "reply-to")))
750                 (when (and
751                        from reply-to
752                        (ignore-errors
753                          (equal
754                           (nth 1 (mail-extract-address-components from))
755                           (nth 1 (mail-extract-address-components reply-to)))))
756                   (gnus-article-hide-header "reply-to"))))
757              ((eq elem 'date)
758               (let ((date (message-fetch-field "date")))
759                 (when (and date
760                            (< (gnus-days-between (current-time-string) date)
761                               4))
762                   (gnus-article-hide-header "date"))))
763              ((eq elem 'long-to)
764               (let ((to (message-fetch-field "to")))
765                 (when (> (length to) 1024)
766                   (gnus-article-hide-header "to"))))
767              ((eq elem 'many-to)
768               (let ((to-count 0))
769                 (goto-char (point-min))
770                 (while (re-search-forward "^to:" nil t)
771                   (setq to-count (1+ to-count)))
772                 (when (> to-count 1)
773                   (while (> to-count 0)
774                     (goto-char (point-min))
775                     (save-restriction
776                       (re-search-forward "^to:" nil nil to-count)
777                       (forward-line -1)
778                       (narrow-to-region (point) (point-max))
779                       (gnus-article-hide-header "to"))
780                     (setq to-count (1- to-count)))))))))))))
781
782 (defun gnus-article-hide-header (header)
783   (save-excursion
784     (goto-char (point-min))
785     (when (re-search-forward (concat "^" header ":") nil t)
786       (gnus-article-hide-text-type
787        (progn (beginning-of-line) (point))
788        (progn
789          (end-of-line)
790          (if (re-search-forward "^[^ \t]" nil t)
791              (match-beginning 0)
792            (point-max)))
793        'boring-headers))))
794
795 (defun article-treat-dumbquotes ()
796   "Translate M******** sm*rtq**t*s into proper text."
797   (interactive)
798   (article-translate-characters "\221\222\223\223" "`'\"\""))
799
800 (defun article-translate-characters (from to)
801   "Translate all characters in the body of the article according to FROM and TO.
802 FROM is a string of characters to translate from; to is a string of
803 characters to translate to."
804   (save-excursion
805     (goto-char (point-min))
806     (when (search-forward "\n\n" nil t)
807       (let ((buffer-read-only nil)
808             (x (make-string 225 ?x))
809             (i -1))
810         (while (< (incf i) (length x))
811           (aset x i i))
812         (setq i 0)
813         (while (< i (length from))
814           (aset x (aref from i) (aref to i))
815           (incf i))
816         (translate-region (point) (point-max) x)))))
817
818 (defun article-treat-overstrike ()
819   "Translate overstrikes into bold text."
820   (interactive)
821   (save-excursion
822     (goto-char (point-min))
823     (when (search-forward "\n\n" nil t)
824       (let ((buffer-read-only nil))
825         (while (search-forward "\b" nil t)
826           (let ((next (following-char))
827                 (previous (char-after (- (point) 2))))
828             ;; We do the boldification/underlining by hiding the
829             ;; overstrikes and putting the proper text property
830             ;; on the letters.
831             (cond
832              ((eq next previous)
833               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
834               (put-text-property (point) (1+ (point)) 'face 'bold))
835              ((eq next ?_)
836               (gnus-article-hide-text-type
837                (1- (point)) (1+ (point)) 'overstrike)
838               (put-text-property
839                (- (point) 2) (1- (point)) 'face 'underline))
840              ((eq previous ?_)
841               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
842               (put-text-property
843                (point) (1+ (point)) 'face 'underline)))))))))
844
845 (defun article-fill ()
846   "Format too long lines."
847   (interactive)
848   (save-excursion
849     (let ((buffer-read-only nil))
850       (widen)
851       (goto-char (point-min))
852       (search-forward "\n\n" nil t)
853       (end-of-line 1)
854       (let ((paragraph-start "^[>|#:<;* ]*[ \t]*$")
855             (adaptive-fill-regexp "[ \t]*\\([|#:<;>*]+ *\\)?")
856             (adaptive-fill-mode t))
857         (while (not (eobp))
858           (and (>= (current-column) (min fill-column (window-width)))
859                (/= (preceding-char) ?:)
860                (fill-paragraph nil))
861           (end-of-line 2))))))
862
863 (defun article-remove-cr ()
864   "Remove carriage returns from an article."
865   (interactive)
866   (save-excursion
867     (let ((buffer-read-only nil))
868       (goto-char (point-min))
869       (while (search-forward "\r" nil t)
870         (replace-match "" t t)))))
871
872 (defun article-remove-trailing-blank-lines ()
873   "Remove all trailing blank lines from the article."
874   (interactive)
875   (save-excursion
876     (let ((buffer-read-only nil))
877       (goto-char (point-max))
878       (delete-region
879        (point)
880        (progn
881          (while (and (not (bobp))
882                      (looking-at "^[ \t]*$"))
883            (forward-line -1))
884          (forward-line 1)
885          (point))))))
886
887 (defun article-display-x-face (&optional force)
888   "Look for an X-Face header and display it if present."
889   (interactive (list 'force))
890   (save-excursion
891     ;; Delete the old process, if any.
892     (when (process-status "article-x-face")
893       (delete-process "article-x-face"))
894     (let ((inhibit-point-motion-hooks t)
895           (case-fold-search t)
896           from)
897       (save-restriction
898         (nnheader-narrow-to-headers)
899         (setq from (message-fetch-field "from"))
900         (goto-char (point-min))
901         (while (and gnus-article-x-face-command
902                     (or force
903                         ;; Check whether this face is censored.
904                         (not gnus-article-x-face-too-ugly)
905                         (and gnus-article-x-face-too-ugly from
906                              (not (string-match gnus-article-x-face-too-ugly
907                                                 from))))
908                     ;; Has to be present.
909                     (re-search-forward "^X-Face: " nil t))
910           ;; We now have the area of the buffer where the X-Face is stored.
911           (save-excursion
912             (let ((beg (point))
913                   (end (1- (re-search-forward "^\\($\\|[^ \t]\\)" nil t))))
914               ;; We display the face.
915               (if (symbolp gnus-article-x-face-command)
916                   ;; The command is a lisp function, so we call it.
917                   (if (gnus-functionp gnus-article-x-face-command)
918                       (funcall gnus-article-x-face-command beg end)
919                     (error "%s is not a function" gnus-article-x-face-command))
920                 ;; The command is a string, so we interpret the command
921                 ;; as a, well, command, and fork it off.
922                 (let ((process-connection-type nil))
923                   (process-kill-without-query
924                    (start-process
925                     "article-x-face" nil shell-file-name shell-command-switch
926                     gnus-article-x-face-command))
927                   (process-send-region "article-x-face" beg end)
928                   (process-send-eof "article-x-face"))))))))))
929
930 (defun gnus-article-decode-rfc1522 ()
931   "Decode MIME encoded-words in header fields."
932   (let (buffer-read-only)
933     (let ((charset (save-excursion
934                      (set-buffer gnus-summary-buffer)
935                      default-mime-charset)))
936       (eword-decode-header charset)
937       )))
938
939 (defun article-hide-pgp (&optional arg)
940   "Toggle hiding of any PGP headers and signatures in the current article.
941 If given a negative prefix, always show; if given a positive prefix,
942 always hide."
943   (interactive (gnus-article-hidden-arg))
944   (unless (gnus-article-check-hidden-text 'pgp arg)
945     (save-excursion
946       (let ((inhibit-point-motion-hooks t)
947             buffer-read-only beg end)
948         (widen)
949         (goto-char (point-min))
950         ;; Hide the "header".
951         (when (search-forward "\n-----BEGIN PGP SIGNED MESSAGE-----\n" nil t)
952           (gnus-article-hide-text-type (1+ (match-beginning 0))
953                                        (match-end 0) 'pgp)
954           (setq beg (point))
955           ;; Hide the actual signature.
956           (and (search-forward "\n-----BEGIN PGP SIGNATURE-----\n" nil t)
957                (setq end (1+ (match-beginning 0)))
958                (gnus-article-hide-text-type
959                 end
960                 (if (search-forward "\n-----END PGP SIGNATURE-----\n" nil t)
961                     (match-end 0)
962                   ;; Perhaps we shouldn't hide to the end of the buffer
963                   ;; if there is no end to the signature?
964                   (point-max))
965                 'pgp))
966           ;; Hide "- " PGP quotation markers.
967           (when (and beg end)
968             (narrow-to-region beg end)
969             (goto-char (point-min))
970             (while (re-search-forward "^- " nil t)
971               (gnus-article-hide-text-type
972                (match-beginning 0) (match-end 0) 'pgp))
973             (widen))
974           (gnus-run-hooks 'gnus-article-hide-pgp-hook))))))
975
976 (defun article-hide-pem (&optional arg)
977   "Toggle hiding of any PEM headers and signatures in the current article.
978 If given a negative prefix, always show; if given a positive prefix,
979 always hide."
980   (interactive (gnus-article-hidden-arg))
981   (unless (gnus-article-check-hidden-text 'pem arg)
982     (save-excursion
983       (let (buffer-read-only end)
984         (widen)
985         (goto-char (point-min))
986         ;; hide the horrendously ugly "header".
987         (and (search-forward "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
988                              nil
989                              t)
990              (setq end (1+ (match-beginning 0)))
991              (gnus-article-hide-text-type
992               end
993               (if (search-forward "\n\n" nil t)
994                   (match-end 0)
995                 (point-max))
996               'pem))
997         ;; hide the trailer as well
998         (and (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
999                              nil
1000                              t)
1001              (gnus-article-hide-text-type
1002               (match-beginning 0) (match-end 0) 'pem))))))
1003
1004 (defun article-hide-signature (&optional arg)
1005   "Hide the signature in the current article.
1006 If given a negative prefix, always show; if given a positive prefix,
1007 always hide."
1008   (interactive (gnus-article-hidden-arg))
1009   (unless (gnus-article-check-hidden-text 'signature arg)
1010     (save-excursion
1011       (save-restriction
1012         (let ((buffer-read-only nil))
1013           (when (gnus-article-narrow-to-signature)
1014             (gnus-article-hide-text-type
1015              (point-min) (point-max) 'signature)))))))
1016
1017 (defun article-strip-leading-blank-lines ()
1018   "Remove all blank lines from the beginning of the article."
1019   (interactive)
1020   (save-excursion
1021     (let ((inhibit-point-motion-hooks t)
1022           buffer-read-only)
1023       (goto-char (point-min))
1024       (when (search-forward "\n\n" nil t)
1025         (while (and (not (eobp))
1026                     (looking-at "[ \t]*$"))
1027           (gnus-delete-line))))))
1028
1029 (defun article-strip-multiple-blank-lines ()
1030   "Replace consecutive blank lines with one empty line."
1031   (interactive)
1032   (save-excursion
1033     (let ((inhibit-point-motion-hooks t)
1034           buffer-read-only)
1035       ;; First make all blank lines empty.
1036       (goto-char (point-min))
1037       (search-forward "\n\n" nil t)
1038       (while (re-search-forward "^[ \t]+$" nil t)
1039         (replace-match "" nil t))
1040       ;; Then replace multiple empty lines with a single empty line.
1041       (goto-char (point-min))
1042       (search-forward "\n\n" nil t)
1043       (while (re-search-forward "\n\n\n+" nil t)
1044         (replace-match "\n\n" t t)))))
1045
1046 (defun article-strip-leading-space ()
1047   "Remove all white space from the beginning of the lines in the article."
1048   (interactive)
1049   (save-excursion
1050     (let ((inhibit-point-motion-hooks t)
1051           buffer-read-only)
1052       (goto-char (point-min))
1053       (search-forward "\n\n" nil t)
1054       (while (re-search-forward "^[ \t]+" nil t)
1055         (replace-match "" t t)))))
1056
1057 (defun article-strip-blank-lines ()
1058   "Strip leading, trailing and multiple blank lines."
1059   (interactive)
1060   (article-strip-leading-blank-lines)
1061   (article-remove-trailing-blank-lines)
1062   (article-strip-multiple-blank-lines))
1063
1064 (defun article-strip-all-blank-lines ()
1065   "Strip all blank lines."
1066   (interactive)
1067   (save-excursion
1068     (let ((inhibit-point-motion-hooks t)
1069           buffer-read-only)
1070       (goto-char (point-min))
1071       (search-forward "\n\n" nil t)
1072       (while (re-search-forward "^[ \t]*\n" nil t)
1073         (replace-match "" t t)))))
1074
1075 (defvar mime::preview/content-list)
1076 (defvar mime::preview-content-info/point-min)
1077 (defun gnus-article-narrow-to-signature ()
1078   "Narrow to the signature; return t if a signature is found, else nil."
1079   (widen)
1080   (when (and (boundp 'mime::preview/content-list)
1081              mime::preview/content-list)
1082     ;; We have a MIMEish article, so we use the MIME data to narrow.
1083     (let ((pcinfo (car (last mime::preview/content-list))))
1084       (ignore-errors
1085         (narrow-to-region
1086          (funcall (intern "mime::preview-content-info/point-min") pcinfo)
1087          (point-max)))))
1088
1089   (when (gnus-article-search-signature)
1090     (forward-line 1)
1091     ;; Check whether we have some limits to what we consider
1092     ;; to be a signature.
1093     (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
1094                     (list gnus-signature-limit)))
1095           limit limited)
1096       (while (setq limit (pop limits))
1097         (if (or (and (integerp limit)
1098                      (< (- (point-max) (point)) limit))
1099                 (and (floatp limit)
1100                      (< (count-lines (point) (point-max)) limit))
1101                 (and (gnus-functionp limit)
1102                      (funcall limit))
1103                 (and (stringp limit)
1104                      (not (re-search-forward limit nil t))))
1105             ()                          ; This limit did not succeed.
1106           (setq limited t
1107                 limits nil)))
1108       (unless limited
1109         (narrow-to-region (point) (point-max))
1110         t))))
1111
1112 (defun gnus-article-search-signature ()
1113   "Search the current buffer for the signature separator.
1114 Put point at the beginning of the signature separator."
1115   (let ((cur (point)))
1116     (goto-char (point-max))
1117     (if (if (stringp gnus-signature-separator)
1118             (re-search-backward gnus-signature-separator nil t)
1119           (let ((seps gnus-signature-separator))
1120             (while (and seps
1121                         (not (re-search-backward (car seps) nil t)))
1122               (pop seps))
1123             seps))
1124         t
1125       (goto-char cur)
1126       nil)))
1127
1128 (eval-and-compile
1129   (autoload 'w3-display "w3-parse")
1130   (autoload 'w3-do-setup "w3" "" t)
1131   (autoload 'w3-region "w3-display" "" t))
1132
1133 (defun gnus-article-treat-html ()
1134   "Render HTML."
1135   (interactive)
1136   (let ((cbuf (current-buffer)))
1137     (set-buffer gnus-article-buffer)
1138     (let (buf buffer-read-only b e)
1139       (w3-do-setup)
1140       (goto-char (point-min))
1141       (narrow-to-region
1142        (if (search-forward "\n\n" nil t)
1143            (setq b (point))
1144          (point-max))
1145        (setq e (point-max)))
1146       (nnheader-temp-write nil
1147         (insert-buffer-substring gnus-article-buffer b e)
1148         (require 'url)
1149         (save-window-excursion
1150           (w3-region (point-min) (point-max))
1151           (setq buf (buffer-substring-no-properties (point-min) (point-max)))))
1152       (when buf
1153         (delete-region (point-min) (point-max))
1154         (insert buf))
1155       (widen)
1156       (goto-char (point-min))
1157       (set-window-start (get-buffer-window (current-buffer)) (point-min))
1158       (set-buffer cbuf))))
1159
1160 (defun gnus-article-hidden-arg ()
1161   "Return the current prefix arg as a number, or 0 if no prefix."
1162   (list (if current-prefix-arg
1163             (prefix-numeric-value current-prefix-arg)
1164           0)))
1165
1166 (defun gnus-article-check-hidden-text (type arg)
1167   "Return nil if hiding is necessary.
1168 Arg can be nil or a number.  Nil and positive means hide, negative
1169 means show, 0 means toggle."
1170   (save-excursion
1171     (save-restriction
1172       (widen)
1173       (let ((hide (gnus-article-hidden-text-p type)))
1174         (cond
1175          ((or (null arg)
1176               (> arg 0))
1177           nil)
1178          ((< arg 0)
1179           (gnus-article-show-hidden-text type))
1180          (t
1181           (if (eq hide 'hidden)
1182               (gnus-article-show-hidden-text type)
1183             nil)))))))
1184
1185 (defun gnus-article-hidden-text-p (type)
1186   "Say whether the current buffer contains hidden text of type TYPE."
1187   (let ((start (point-min))
1188         (pos (text-property-any (point-min) (point-max) 'article-type type)))
1189     (while (and pos
1190                 (not (get-text-property pos 'invisible)))
1191       (setq pos
1192             (text-property-any (1+ pos) (point-max) 'article-type type)))
1193     (if pos
1194         'hidden
1195       'shown)))
1196
1197 (defun gnus-article-show-hidden-text (type &optional hide)
1198   "Show all hidden text of type TYPE.
1199 If HIDE, hide the text instead."
1200   (save-excursion
1201     (let ((buffer-read-only nil)
1202           (inhibit-point-motion-hooks t)
1203           (end (point-min))
1204           beg)
1205       (while (setq beg (text-property-any end (point-max) 'article-type type))
1206         (goto-char beg)
1207         (setq end (or
1208                    (text-property-not-all beg (point-max) 'article-type type)
1209                    (point-max)))
1210         (if hide
1211             (gnus-article-hide-text beg end gnus-hidden-properties)
1212           (gnus-article-unhide-text beg end))
1213         (goto-char end))
1214       t)))
1215
1216 (defconst article-time-units
1217   `((year . ,(* 365.25 24 60 60))
1218     (week . ,(* 7 24 60 60))
1219     (day . ,(* 24 60 60))
1220     (hour . ,(* 60 60))
1221     (minute . 60)
1222     (second . 1))
1223   "Mapping from time units to seconds.")
1224
1225 (defun article-date-ut (&optional type highlight header)
1226   "Convert DATE date to universal time in the current article.
1227 If TYPE is `local', convert to local time; if it is `lapsed', output
1228 how much time has lapsed since DATE."
1229   (interactive (list 'ut t))
1230   (let* ((header (or header
1231                      (mail-header-date gnus-current-headers)
1232                      (message-fetch-field "date")
1233                      ""))
1234          (date (if (vectorp header) (mail-header-date header)
1235                  header))
1236          (date-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
1237          (inhibit-point-motion-hooks t)
1238          bface eface newline)
1239     (when (and date (not (string= date "")))
1240       (save-excursion
1241         (save-restriction
1242           (nnheader-narrow-to-headers)
1243           (let ((buffer-read-only nil))
1244             ;; Delete any old Date headers.
1245             (if (re-search-forward date-regexp nil t)
1246                 (progn
1247                   (setq bface (get-text-property (gnus-point-at-bol) 'face)
1248                         eface (get-text-property (1- (gnus-point-at-eol))
1249                                                  'face))
1250                   (delete-region (progn (beginning-of-line) (point))
1251                                  (progn (end-of-line) (point)))
1252                   (beginning-of-line))
1253               (goto-char (point-max))
1254               (setq newline t))
1255             (insert (article-make-date-line date type))
1256             ;; Do highlighting.
1257             (beginning-of-line)
1258             (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
1259               (put-text-property (match-beginning 1) (1+ (match-end 1))
1260                                  'face bface)
1261               (put-text-property (match-beginning 2) (match-end 2)
1262                                  'face eface))
1263             (when newline
1264               (end-of-line)
1265               (insert "\n"))))))))
1266
1267 (defun article-make-date-line (date type)
1268   "Return a DATE line of TYPE."
1269   (cond
1270    ;; Convert to the local timezone.  We have to slap a
1271    ;; `condition-case' round the calls to the timezone
1272    ;; functions since they aren't particularly resistant to
1273    ;; buggy dates.
1274    ((eq type 'local)
1275     (concat "Date: " (condition-case ()
1276                          (timezone-make-date-arpa-standard date)
1277                        (error date))))
1278    ;; Convert to Universal Time.
1279    ((eq type 'ut)
1280     (concat "Date: "
1281             (condition-case ()
1282                 (timezone-make-date-arpa-standard date nil "UT")
1283               (error date))))
1284    ;; Get the original date from the article.
1285    ((eq type 'original)
1286     (concat "Date: " date))
1287    ;; Let the user define the format.
1288    ((eq type 'user)
1289     (if (gnus-functionp gnus-article-time-format)
1290         (funcall
1291          gnus-article-time-format
1292          (ignore-errors
1293            (gnus-encode-date
1294             (timezone-make-date-arpa-standard
1295              date nil "UT"))))
1296       (concat
1297        "Date: "
1298        (format-time-string gnus-article-time-format
1299                            (ignore-errors
1300                              (gnus-encode-date
1301                               (timezone-make-date-arpa-standard
1302                                date nil "UT")))))))
1303    ;; ISO 8601.
1304    ((eq type 'iso8601)
1305     (concat
1306      "Date: "
1307      (format-time-string "%Y%M%DT%h%m%s"
1308                          (ignore-errors
1309                            (gnus-encode-date
1310                             (timezone-make-date-arpa-standard
1311                              date nil "UT"))))))
1312    ;; Do an X-Sent lapsed format.
1313    ((eq type 'lapsed)
1314     ;; If the date is seriously mangled, the timezone functions are
1315     ;; liable to bug out, so we ignore all errors.
1316     (let* ((now (current-time))
1317            (real-time
1318             (ignore-errors
1319               (gnus-time-minus
1320                (gnus-encode-date
1321                 (timezone-make-date-arpa-standard
1322                  (current-time-string now)
1323                  (current-time-zone now) "UT"))
1324                (gnus-encode-date
1325                 (timezone-make-date-arpa-standard
1326                  date nil "UT")))))
1327            (real-sec (and real-time
1328                           (+ (* (float (car real-time)) 65536)
1329                              (cadr real-time))))
1330            (sec (and real-time (abs real-sec)))
1331            num prev)
1332       (cond
1333        ((null real-time)
1334         "X-Sent: Unknown")
1335        ((zerop sec)
1336         "X-Sent: Now")
1337        (t
1338         (concat
1339          "X-Sent: "
1340          ;; This is a bit convoluted, but basically we go
1341          ;; through the time units for years, weeks, etc,
1342          ;; and divide things to see whether that results
1343          ;; in positive answers.
1344          (mapconcat
1345           (lambda (unit)
1346             (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
1347                 ;; The (remaining) seconds are too few to
1348                 ;; be divided into this time unit.
1349                 ""
1350               ;; It's big enough, so we output it.
1351               (setq sec (- sec (* num (cdr unit))))
1352               (prog1
1353                   (concat (if prev ", " "") (int-to-string
1354                                              (floor num))
1355                           " " (symbol-name (car unit))
1356                           (if (> num 1) "s" ""))
1357                 (setq prev t))))
1358           article-time-units "")
1359          ;; If dates are odd, then it might appear like the
1360          ;; article was sent in the future.
1361          (if (> real-sec 0)
1362              " ago"
1363            " in the future"))))))
1364    (t
1365     (error "Unknown conversion type: %s" type))))
1366
1367 (defun article-date-local (&optional highlight)
1368   "Convert the current article date to the local timezone."
1369   (interactive (list t))
1370   (article-date-ut 'local highlight))
1371
1372 (defun article-date-original (&optional highlight)
1373   "Convert the current article date to what it was originally.
1374 This is only useful if you have used some other date conversion
1375 function and want to see what the date was before converting."
1376   (interactive (list t))
1377   (article-date-ut 'original highlight))
1378
1379 (defun article-date-lapsed (&optional highlight)
1380   "Convert the current article date to time lapsed since it was sent."
1381   (interactive (list t))
1382   (article-date-ut 'lapsed highlight))
1383
1384 (defun article-update-date-lapsed ()
1385   "Function to be run from a timer to update the lapsed time line."
1386   (let (deactivate-mark)
1387     (save-excursion
1388       (ignore-errors
1389         (when (gnus-buffer-live-p gnus-article-buffer)
1390           (set-buffer gnus-article-buffer)
1391           (goto-char (point-min))
1392           (when (re-search-forward "^X-Sent:" nil t)
1393             (article-date-lapsed t)))))))
1394
1395 (defun gnus-start-date-timer (&optional n)
1396   "Start a timer to update the X-Sent header in the article buffers.
1397 The numerical prefix says how frequently (in seconds) the function
1398 is to run."
1399   (interactive "p")
1400   (unless n
1401     (setq n 1))
1402   (gnus-stop-date-timer)
1403   (setq article-lapsed-timer 
1404         (nnheader-run-at-time 1 n 'article-update-date-lapsed)))
1405
1406 (defun gnus-stop-date-timer ()
1407   "Stop the X-Sent timer."
1408   (interactive)
1409   (when article-lapsed-timer
1410     (nnheader-cancel-timer article-lapsed-timer)
1411     (setq article-lapsed-timer nil)))
1412
1413 (defun article-date-user (&optional highlight)
1414   "Convert the current article date to the user-defined format.
1415 This format is defined by the `gnus-article-time-format' variable."
1416   (interactive (list t))
1417   (article-date-ut 'user highlight))
1418
1419 (defun article-date-iso8601 (&optional highlight)
1420   "Convert the current article date to ISO8601."
1421   (interactive (list t))
1422   (article-date-ut 'iso8601 highlight))
1423
1424 (defun article-show-all ()
1425   "Show all hidden text in the article buffer."
1426   (interactive)
1427   (save-excursion
1428     (let ((buffer-read-only nil))
1429       (gnus-article-unhide-text (point-min) (point-max)))))
1430
1431 (defun article-emphasize (&optional arg)
1432   "Emphasize text according to `gnus-emphasis-alist'."
1433   (interactive (gnus-article-hidden-arg))
1434   (unless (gnus-article-check-hidden-text 'emphasis arg)
1435     (save-excursion
1436       (let ((alist gnus-emphasis-alist)
1437             (buffer-read-only nil)
1438             (props (append '(article-type emphasis)
1439                            gnus-hidden-properties))
1440             regexp elem beg invisible visible face)
1441         (goto-char (point-min))
1442         (search-forward "\n\n" nil t)
1443         (setq beg (point))
1444         (while (setq elem (pop alist))
1445           (goto-char beg)
1446           (setq regexp (car elem)
1447                 invisible (nth 1 elem)
1448                 visible (nth 2 elem)
1449                 face (nth 3 elem))
1450           (while (re-search-forward regexp nil t)
1451             (when (and (match-beginning visible) (match-beginning invisible))
1452               (gnus-article-hide-text
1453                (match-beginning invisible) (match-end invisible) props)
1454               (gnus-article-unhide-text-type
1455                (match-beginning visible) (match-end visible) 'emphasis)
1456               (gnus-put-text-property-excluding-newlines
1457                (match-beginning visible) (match-end visible) 'face face)
1458               (goto-char (match-end invisible)))))))))
1459
1460 (defvar gnus-summary-article-menu)
1461 (defvar gnus-summary-post-menu)
1462
1463 ;;; Saving functions.
1464
1465 (defun gnus-article-save (save-buffer file &optional num)
1466   "Save the currently selected article."
1467   (unless gnus-save-all-headers
1468     ;; Remove headers according to `gnus-saved-headers'.
1469     (let ((gnus-visible-headers
1470            (or gnus-saved-headers gnus-visible-headers))
1471           (gnus-article-buffer save-buffer))
1472       (save-excursion
1473         (set-buffer save-buffer)
1474         (article-hide-headers 1 t))))
1475   (save-window-excursion
1476     (if (not gnus-default-article-saver)
1477         (error "No default saver is defined")
1478       ;; !!! Magic!  The saving functions all save
1479       ;; `gnus-original-article-buffer' (or so they think), but we
1480       ;; bind that variable to our save-buffer.
1481       (set-buffer gnus-article-buffer)
1482       (let* ((gnus-save-article-buffer save-buffer)
1483              (filename
1484               (cond
1485                ((not gnus-prompt-before-saving) 'default)
1486                ((eq gnus-prompt-before-saving 'always) nil)
1487                (t file)))
1488              (gnus-number-of-articles-to-be-saved
1489               (when (eq gnus-prompt-before-saving t)
1490                 num)))                  ; Magic
1491         (set-buffer gnus-article-current-summary)
1492         (funcall gnus-default-article-saver filename)))))
1493
1494 (defun gnus-read-save-file-name (prompt &optional filename
1495                                         function group headers variable)
1496   (let ((default-name
1497           (funcall function group headers (symbol-value variable)))
1498         result)
1499     (setq
1500      result
1501      (cond
1502       ((eq filename 'default)
1503        default-name)
1504       ((eq filename t)
1505        default-name)
1506       (filename filename)
1507       (t
1508        (let* ((split-name (gnus-get-split-value gnus-split-methods))
1509               (prompt
1510                (format prompt
1511                        (if (and gnus-number-of-articles-to-be-saved
1512                                 (> gnus-number-of-articles-to-be-saved 1))
1513                            (format "these %d articles"
1514                                    gnus-number-of-articles-to-be-saved)
1515                          "this article")))
1516               (file
1517                ;; Let the split methods have their say.
1518                (cond
1519                 ;; No split name was found.
1520                 ((null split-name)
1521                  (read-file-name
1522                   (concat prompt " (default "
1523                           (file-name-nondirectory default-name) ") ")
1524                   (file-name-directory default-name)
1525                   default-name))
1526                 ;; A single group name is returned.
1527                 ((stringp split-name)
1528                  (setq default-name
1529                        (funcall function split-name headers
1530                                 (symbol-value variable)))
1531                  (read-file-name
1532                   (concat prompt " (default "
1533                           (file-name-nondirectory default-name) ") ")
1534                   (file-name-directory default-name)
1535                   default-name))
1536                 ;; A single split name was found
1537                 ((= 1 (length split-name))
1538                  (let* ((name (expand-file-name
1539                                (car split-name) gnus-article-save-directory))
1540                         (dir (cond ((file-directory-p name)
1541                                     (file-name-as-directory name))
1542                                    ((file-exists-p name) name)
1543                                    (t gnus-article-save-directory))))
1544                    (read-file-name
1545                     (concat prompt " (default " name ") ")
1546                     dir name)))
1547                 ;; A list of splits was found.
1548                 (t
1549                  (setq split-name (nreverse split-name))
1550                  (let (result)
1551                    (let ((file-name-history
1552                           (nconc split-name file-name-history)))
1553                      (setq result
1554                            (expand-file-name
1555                             (read-file-name
1556                              (concat prompt " (`M-p' for defaults) ")
1557                              gnus-article-save-directory
1558                              (car split-name))
1559                             gnus-article-save-directory)))
1560                    (car (push result file-name-history)))))))
1561          ;; Create the directory.
1562          (gnus-make-directory (file-name-directory file))
1563          ;; If we have read a directory, we append the default file name.
1564          (when (file-directory-p file)
1565            (setq file (concat (file-name-as-directory file)
1566                               (file-name-nondirectory default-name))))
1567          ;; Possibly translate some characters.
1568          (nnheader-translate-file-chars file)))))
1569     (gnus-make-directory (file-name-directory result))
1570     (set variable result)))
1571
1572 (defun gnus-article-archive-name (group)
1573   "Return the first instance of an \"Archive-name\" in the current buffer."
1574   (let ((case-fold-search t))
1575     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
1576       (nnheader-concat gnus-article-save-directory
1577                        (match-string 1)))))
1578
1579 (defun gnus-article-nndoc-name (group)
1580   "If GROUP is an nndoc group, return the name of the parent group."
1581   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
1582     (gnus-group-get-parameter group 'save-article-group)))
1583
1584 (defun gnus-summary-save-in-rmail (&optional filename)
1585   "Append this article to Rmail file.
1586 Optional argument FILENAME specifies file name.
1587 Directory to save to is default to `gnus-article-save-directory'."
1588   (setq filename (gnus-read-save-file-name
1589                   "Save %s in rmail file:" filename
1590                   gnus-rmail-save-name gnus-newsgroup-name
1591                   gnus-current-headers 'gnus-newsgroup-last-rmail))
1592   (gnus-eval-in-buffer-window gnus-save-article-buffer
1593     (save-excursion
1594       (save-restriction
1595         (widen)
1596         (gnus-output-to-rmail filename))))
1597   filename)
1598
1599 (defun gnus-summary-save-in-mail (&optional filename)
1600   "Append this article to Unix mail file.
1601 Optional argument FILENAME specifies file name.
1602 Directory to save to is default to `gnus-article-save-directory'."
1603   (setq filename (gnus-read-save-file-name
1604                   "Save %s in Unix mail file:" filename
1605                   gnus-mail-save-name gnus-newsgroup-name
1606                   gnus-current-headers 'gnus-newsgroup-last-mail))
1607   (gnus-eval-in-buffer-window gnus-save-article-buffer
1608     (save-excursion
1609       (save-restriction
1610         (widen)
1611         (if (and (file-readable-p filename)
1612                  (mail-file-babyl-p filename))
1613             (gnus-output-to-rmail filename t)
1614           (gnus-output-to-mail filename)))))
1615   filename)
1616
1617 (defun gnus-summary-save-in-file (&optional filename overwrite)
1618   "Append this article to file.
1619 Optional argument FILENAME specifies file name.
1620 Directory to save to is default to `gnus-article-save-directory'."
1621   (setq filename (gnus-read-save-file-name
1622                   "Save %s in file:" filename
1623                   gnus-file-save-name gnus-newsgroup-name
1624                   gnus-current-headers 'gnus-newsgroup-last-file))
1625   (gnus-eval-in-buffer-window gnus-save-article-buffer
1626     (save-excursion
1627       (save-restriction
1628         (widen)
1629         (when (and overwrite
1630                    (file-exists-p filename))
1631           (delete-file filename))
1632         (gnus-output-to-file filename))))
1633   filename)
1634
1635 (defun gnus-summary-write-to-file (&optional filename)
1636   "Write this article to a file.
1637 Optional argument FILENAME specifies file name.
1638 The directory to save in defaults to `gnus-article-save-directory'."
1639   (gnus-summary-save-in-file nil t))
1640
1641 (defun gnus-summary-save-body-in-file (&optional filename)
1642   "Append this article body to a file.
1643 Optional argument FILENAME specifies file name.
1644 The directory to save in defaults to `gnus-article-save-directory'."
1645   (setq filename (gnus-read-save-file-name
1646                   "Save %s body in file:" filename
1647                   gnus-file-save-name gnus-newsgroup-name
1648                   gnus-current-headers 'gnus-newsgroup-last-file))
1649   (gnus-eval-in-buffer-window gnus-save-article-buffer
1650     (save-excursion
1651       (save-restriction
1652         (widen)
1653         (goto-char (point-min))
1654         (when (search-forward "\n\n" nil t)
1655           (narrow-to-region (point) (point-max)))
1656         (gnus-output-to-file filename))))
1657   filename)
1658
1659 (defun gnus-summary-save-in-pipe (&optional command)
1660   "Pipe this article to subprocess."
1661   (setq command
1662         (cond ((eq command 'default)
1663                gnus-last-shell-command)
1664               (command command)
1665               (t (read-string
1666                   (format
1667                    "Shell command on %s: "
1668                    (if (and gnus-number-of-articles-to-be-saved
1669                             (> gnus-number-of-articles-to-be-saved 1))
1670                        (format "these %d articles"
1671                                gnus-number-of-articles-to-be-saved)
1672                      "this article"))
1673                   gnus-last-shell-command))))
1674   (when (string-equal command "")
1675     (setq command gnus-last-shell-command))
1676   (gnus-eval-in-buffer-window gnus-article-buffer
1677     (save-restriction
1678       (widen)
1679       (shell-command-on-region (point-min) (point-max) command nil)))
1680   (setq gnus-last-shell-command command))
1681
1682 ;;; Article file names when saving.
1683
1684 (defun gnus-capitalize-newsgroup (newsgroup)
1685   "Capitalize NEWSGROUP name."
1686   (when (not (zerop (length newsgroup)))
1687     (concat (char-to-string (upcase (aref newsgroup 0)))
1688             (substring newsgroup 1))))
1689
1690 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
1691   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1692 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
1693 Otherwise, it is like ~/News/news/group/num."
1694   (let ((default
1695           (expand-file-name
1696            (concat (if (gnus-use-long-file-name 'not-save)
1697                        (gnus-capitalize-newsgroup newsgroup)
1698                      (gnus-newsgroup-directory-form newsgroup))
1699                    "/" (int-to-string (mail-header-number headers)))
1700            gnus-article-save-directory)))
1701     (if (and last-file
1702              (string-equal (file-name-directory default)
1703                            (file-name-directory last-file))
1704              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1705         default
1706       (or last-file default))))
1707
1708 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
1709   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1710 If variable `gnus-use-long-file-name' is non-nil, it is
1711 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
1712   (let ((default
1713           (expand-file-name
1714            (concat (if (gnus-use-long-file-name 'not-save)
1715                        newsgroup
1716                      (gnus-newsgroup-directory-form newsgroup))
1717                    "/" (int-to-string (mail-header-number headers)))
1718            gnus-article-save-directory)))
1719     (if (and last-file
1720              (string-equal (file-name-directory default)
1721                            (file-name-directory last-file))
1722              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
1723         default
1724       (or last-file default))))
1725
1726 (defun gnus-Plain-save-name (newsgroup headers &optional last-file)
1727   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1728 If variable `gnus-use-long-file-name' is non-nil, it is
1729 ~/News/News.group.  Otherwise, it is like ~/News/news/group/news."
1730   (or last-file
1731       (expand-file-name
1732        (if (gnus-use-long-file-name 'not-save)
1733            (gnus-capitalize-newsgroup newsgroup)
1734          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1735        gnus-article-save-directory)))
1736
1737 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
1738   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
1739 If variable `gnus-use-long-file-name' is non-nil, it is
1740 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
1741   (or last-file
1742       (expand-file-name
1743        (if (gnus-use-long-file-name 'not-save)
1744            newsgroup
1745          (concat (gnus-newsgroup-directory-form newsgroup) "/news"))
1746        gnus-article-save-directory)))
1747
1748 (eval-and-compile
1749   (mapcar
1750    (lambda (func)
1751      (let (afunc gfunc)
1752        (if (consp func)
1753            (setq afunc (car func)
1754                  gfunc (cdr func))
1755          (setq afunc func
1756                gfunc (intern (format "gnus-%s" func))))
1757        (fset gfunc
1758              (if (not (fboundp afunc))
1759                  nil
1760                `(lambda (&optional interactive &rest args)
1761                   ,(documentation afunc t)
1762                   (interactive (list t))
1763                   (save-excursion
1764                     (set-buffer gnus-article-buffer)
1765                     (if interactive
1766                         (call-interactively ',afunc)
1767                       (apply ',afunc args))))))))
1768    '(article-hide-headers
1769      article-hide-boring-headers
1770      article-treat-overstrike
1771      (article-fill . gnus-article-word-wrap)
1772      article-remove-cr
1773      article-display-x-face
1774      article-hide-pgp
1775      article-hide-pem
1776      article-hide-signature
1777      article-remove-trailing-blank-lines
1778      article-strip-leading-blank-lines
1779      article-strip-multiple-blank-lines
1780      article-strip-leading-space
1781      article-strip-blank-lines
1782      article-strip-all-blank-lines
1783      article-date-local
1784      article-date-iso8601
1785      article-date-original
1786      article-date-ut
1787      article-date-user
1788      article-date-lapsed
1789      article-emphasize
1790      article-treat-dumbquotes
1791      (article-show-all . gnus-article-show-all-headers))))
1792 \f
1793 ;;;
1794 ;;; Gnus article mode
1795 ;;;
1796
1797 (put 'gnus-article-mode 'mode-class 'special)
1798
1799 (gnus-define-keys gnus-article-mode-map
1800   " " gnus-article-goto-next-page
1801   "\177" gnus-article-goto-prev-page
1802   [delete] gnus-article-goto-prev-page
1803   "\C-c^" gnus-article-refer-article
1804   "h" gnus-article-show-summary
1805   "s" gnus-article-show-summary
1806   "\C-c\C-m" gnus-article-mail
1807   "?" gnus-article-describe-briefly
1808   gnus-mouse-2 gnus-article-push-button
1809   "\r" gnus-article-press-button
1810   "\t" gnus-article-next-button
1811   "\M-\t" gnus-article-prev-button
1812   "e" gnus-article-edit
1813   "<" beginning-of-buffer
1814   ">" end-of-buffer
1815   "\C-c\C-i" gnus-info-find-node
1816   "\C-c\C-b" gnus-bug
1817
1818   "\C-d" gnus-article-read-summary-keys
1819   "\M-*" gnus-article-read-summary-keys
1820   "\M-#" gnus-article-read-summary-keys
1821   "\M-^" gnus-article-read-summary-keys
1822   "\M-g" gnus-article-read-summary-keys)
1823
1824 (substitute-key-definition
1825  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
1826
1827 (defun gnus-article-make-menu-bar ()
1828   (gnus-turn-off-edit-menu 'article)
1829   (unless (boundp 'gnus-article-article-menu)
1830     (easy-menu-define
1831      gnus-article-article-menu gnus-article-mode-map ""
1832      '("Article"
1833        ["Scroll forwards" gnus-article-goto-next-page t]
1834        ["Scroll backwards" gnus-article-goto-prev-page t]
1835        ["Show summary" gnus-article-show-summary t]
1836        ["Fetch Message-ID at point" gnus-article-refer-article t]
1837        ["Mail to address at point" gnus-article-mail t]))
1838
1839     (easy-menu-define
1840      gnus-article-treatment-menu gnus-article-mode-map ""
1841      '("Treatment"
1842        ["Hide headers" gnus-article-hide-headers t]
1843        ["Hide signature" gnus-article-hide-signature t]
1844        ["Hide citation" gnus-article-hide-citation t]
1845        ["Treat overstrike" gnus-article-treat-overstrike t]
1846        ["Remove carriage return" gnus-article-remove-cr t]
1847        ))
1848
1849     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
1850
1851     (when (boundp 'gnus-summary-post-menu)
1852       (define-key gnus-article-mode-map [menu-bar post]
1853         (cons "Post" gnus-summary-post-menu)))
1854
1855     (gnus-run-hooks 'gnus-article-menu-hook)))
1856
1857 (defun gnus-article-mode ()
1858   "Major mode for displaying an article.
1859
1860 All normal editing commands are switched off.
1861
1862 The following commands are available in addition to all summary mode
1863 commands:
1864 \\<gnus-article-mode-map>
1865 \\[gnus-article-next-page]\t Scroll the article one page forwards
1866 \\[gnus-article-prev-page]\t Scroll the article one page backwards
1867 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
1868 \\[gnus-article-show-summary]\t Display the summary buffer
1869 \\[gnus-article-mail]\t Send a reply to the address near point
1870 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
1871 \\[gnus-info-find-node]\t Go to the Gnus info node"
1872   (interactive)
1873   (when (gnus-visual-p 'article-menu 'menu)
1874     (gnus-article-make-menu-bar))
1875   (gnus-simplify-mode-line)
1876   (setq mode-name "Article")
1877   (setq major-mode 'gnus-article-mode)
1878   (make-local-variable 'minor-mode-alist)
1879   (unless (assq 'gnus-show-mime minor-mode-alist)
1880     (push (list 'gnus-show-mime " MIME") minor-mode-alist))
1881   (use-local-map gnus-article-mode-map)
1882   (gnus-update-format-specifications nil 'article-mode)
1883   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
1884   (make-local-variable 'gnus-page-broken) 
1885   (make-local-variable 'gnus-button-marker-list) 
1886   (make-local-variable 'gnus-article-current-summary) 
1887   (gnus-set-default-directory)
1888   (buffer-disable-undo (current-buffer))
1889   (setq buffer-read-only t)
1890   (set-syntax-table gnus-article-mode-syntax-table)
1891   (gnus-run-hooks 'gnus-article-mode-hook))
1892
1893 (defun gnus-article-setup-buffer ()
1894   "Initialize the article buffer."
1895   (let* ((name (if gnus-single-article-buffer "*Article*"
1896                  (concat "*Article " gnus-newsgroup-name "*")))
1897          (original
1898           (progn (string-match "\\*Article" name)
1899                  (concat " *Original Article"
1900                          (substring name (match-end 0))))))
1901     (setq gnus-article-buffer name)
1902     (setq gnus-original-article-buffer original)
1903     ;; This might be a variable local to the summary buffer.
1904     (unless gnus-single-article-buffer
1905       (save-excursion
1906         (set-buffer gnus-summary-buffer)
1907         (setq gnus-article-buffer name)
1908         (setq gnus-original-article-buffer original)
1909         (gnus-set-global-variables)))
1910     ;; Init original article buffer.
1911     (save-excursion
1912       (set-buffer (get-buffer-create gnus-original-article-buffer))
1913       (buffer-disable-undo (current-buffer))
1914       (setq major-mode 'gnus-original-article-mode)
1915       (gnus-add-current-to-buffer-list)
1916       (make-local-variable 'gnus-original-article))
1917     (if (get-buffer name)
1918         (save-excursion
1919           (set-buffer name)
1920           (buffer-disable-undo (current-buffer))
1921           (setq buffer-read-only t)
1922           (gnus-add-current-to-buffer-list)
1923           (unless (eq major-mode 'gnus-article-mode)
1924             (gnus-article-mode))
1925           (current-buffer))
1926       (save-excursion
1927         (set-buffer (get-buffer-create name))
1928         (gnus-add-current-to-buffer-list)
1929         (gnus-article-mode)
1930         (make-local-variable 'gnus-summary-buffer)
1931         (current-buffer)))))
1932
1933 ;; Set article window start at LINE, where LINE is the number of lines
1934 ;; from the head of the article.
1935 (defun gnus-article-set-window-start (&optional line)
1936   (set-window-start
1937    (get-buffer-window gnus-article-buffer t)
1938    (save-excursion
1939      (set-buffer gnus-article-buffer)
1940      (goto-char (point-min))
1941      (if (not line)
1942          (point-min)
1943        (gnus-message 6 "Moved to bookmark")
1944        (search-forward "\n\n" nil t)
1945        (forward-line line)
1946        (point)))))
1947
1948 ;;; @@ article filters
1949 ;;;
1950
1951 (defun gnus-article-preview-mime-message ()
1952   (make-local-variable 'mime-button-mother-dispatcher)
1953   (setq mime-button-mother-dispatcher
1954         (function gnus-article-push-button))
1955   (let ((default-mime-charset
1956           (save-excursion
1957             (set-buffer gnus-summary-buffer)
1958             default-mime-charset))
1959         )
1960     (save-excursion
1961       (mime-view-buffer gnus-original-article-buffer gnus-article-buffer
1962                         nil gnus-article-mode-map)
1963       ))
1964   (run-hooks 'gnus-mime-article-prepare-hook)
1965   )
1966
1967 (defun gnus-article-decode-encoded-word ()
1968   "Header filter for gnus-article-mode."
1969   (let ((charset (save-excursion
1970                    (set-buffer gnus-summary-buffer)
1971                    default-mime-charset)))
1972     (eword-decode-header charset)
1973     (goto-char (point-min))
1974     (if (search-forward "\n\n" nil t)
1975         (decode-mime-charset-region (match-end 0) (point-max) charset))
1976     (mime-maybe-hide-echo-buffer)
1977     )
1978   (gnus-run-hooks 'gnus-mime-article-prepare-hook)
1979   )
1980
1981 (defun gnus-article-prepare (article &optional all-headers header)
1982   "Prepare ARTICLE in article mode buffer.
1983 ARTICLE should either be an article number or a Message-ID.
1984 If ARTICLE is an id, HEADER should be the article headers.
1985 If ALL-HEADERS is non-nil, no headers are hidden."
1986   (save-excursion
1987     ;; Make sure we start in a summary buffer.
1988     (unless (eq major-mode 'gnus-summary-mode)
1989       (set-buffer gnus-summary-buffer))
1990     (setq gnus-summary-buffer (current-buffer))
1991     ;; Make sure the connection to the server is alive.
1992     (unless (gnus-server-opened
1993              (gnus-find-method-for-group gnus-newsgroup-name))
1994       (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
1995       (gnus-request-group gnus-newsgroup-name t))
1996     (let* ((gnus-article (if header (mail-header-number header) article))
1997            (summary-buffer (current-buffer))
1998            (internal-hook gnus-article-internal-prepare-hook)
1999            (group gnus-newsgroup-name)
2000            result)
2001       (save-excursion
2002         (gnus-article-setup-buffer)
2003         (set-buffer gnus-article-buffer)
2004         ;; Deactivate active regions.
2005         (when (and (boundp 'transient-mark-mode)
2006                    transient-mark-mode)
2007           (setq mark-active nil))
2008         (if (not (setq result (let ((buffer-read-only nil))
2009                                 (gnus-request-article-this-buffer
2010                                  article group))))
2011             ;; There is no such article.
2012             (save-excursion
2013               (when (and (numberp article)
2014                          (not (memq article gnus-newsgroup-sparse)))
2015                 (setq gnus-article-current
2016                       (cons gnus-newsgroup-name article))
2017                 (set-buffer gnus-summary-buffer)
2018                 (setq gnus-current-article article)
2019                 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2020                     (progn
2021                       (gnus-summary-set-agent-mark article)
2022                       (message "Message marked for downloading"))
2023                   (gnus-summary-mark-article article gnus-canceled-mark)
2024                   (unless (memq article gnus-newsgroup-sparse)
2025                     (gnus-error 1 
2026                      "No such article (may have expired or been canceled)")))))
2027           (if (or (eq result 'pseudo) (eq result 'nneething))
2028               (progn
2029                 (save-excursion
2030                   (set-buffer summary-buffer)
2031                   (push article gnus-newsgroup-history)
2032                   (setq gnus-last-article gnus-current-article
2033                         gnus-current-article 0
2034                         gnus-current-headers nil
2035                         gnus-article-current nil)
2036                   (if (eq result 'nneething)
2037                       (gnus-configure-windows 'summary)
2038                     (gnus-configure-windows 'article))
2039                   (gnus-set-global-variables))
2040                 (gnus-set-mode-line 'article))
2041             ;; The result from the `request' was an actual article -
2042             ;; or at least some text that is now displayed in the
2043             ;; article buffer.
2044             (when (and (numberp article)
2045                        (not (eq article gnus-current-article)))
2046               ;; Seems like a new article has been selected.
2047               ;; `gnus-current-article' must be an article number.
2048               (save-excursion
2049                 (set-buffer summary-buffer)
2050                 (push article gnus-newsgroup-history)
2051                 (setq gnus-last-article gnus-current-article
2052                       gnus-current-article article
2053                       gnus-current-headers
2054                       (gnus-summary-article-header gnus-current-article)
2055                       gnus-article-current
2056                       (cons gnus-newsgroup-name gnus-current-article))
2057                 (unless (vectorp gnus-current-headers)
2058                   (setq gnus-current-headers nil))
2059                 (gnus-summary-goto-subject gnus-current-article)
2060                 (gnus-summary-show-thread)
2061                 (gnus-run-hooks 'gnus-mark-article-hook)
2062                 (gnus-set-mode-line 'summary)
2063                 (when (gnus-visual-p 'article-highlight 'highlight)
2064                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
2065                 ;; Set the global newsgroup variables here.
2066                 ;; Suggested by Jim Sisolak
2067                 ;; <sisolak@trans4.neep.wisc.edu>.
2068                 (gnus-set-global-variables)
2069                 (setq gnus-have-all-headers
2070                       (or all-headers gnus-show-all-headers))))
2071             (when (or (numberp article)
2072                       (stringp article))
2073               ;; Hooks for getting information from the article.
2074               ;; This hook must be called before being narrowed.
2075               (let (buffer-read-only)
2076                 (gnus-run-hooks 'internal-hook)
2077                 (gnus-run-hooks 'gnus-article-prepare-hook)
2078                 ;; Decode MIME message.
2079                 (when gnus-show-mime
2080                   (if (or (not gnus-strict-mime)
2081                           (gnus-fetch-field "Mime-Version"))
2082                       (funcall gnus-show-mime-method)
2083                     (funcall gnus-decode-encoded-word-method)))
2084                 ;; Perform the article display hooks.
2085                 (gnus-run-hooks 'gnus-article-display-hook))
2086               ;; Do page break.
2087               (goto-char (point-min))
2088               (setq gnus-page-broken
2089                     (when gnus-break-pages
2090                       (gnus-narrow-to-page)
2091                       t)))
2092             (gnus-set-mode-line 'article)
2093             (gnus-configure-windows 'article)
2094             (goto-char (point-min))
2095             t))))))
2096
2097 (defun gnus-article-wash-status ()
2098   "Return a string which display status of article washing."
2099   (save-excursion
2100     (set-buffer gnus-article-buffer)
2101     (let ((cite (gnus-article-hidden-text-p 'cite))
2102           (headers (gnus-article-hidden-text-p 'headers))
2103           (boring (gnus-article-hidden-text-p 'boring-headers))
2104           (pgp (gnus-article-hidden-text-p 'pgp))
2105           (pem (gnus-article-hidden-text-p 'pem))
2106           (signature (gnus-article-hidden-text-p 'signature))
2107           (overstrike (gnus-article-hidden-text-p 'overstrike))
2108           (emphasis (gnus-article-hidden-text-p 'emphasis))
2109           (mime gnus-show-mime))
2110       (format "%c%c%c%c%c%c%c"
2111               (if cite ?c ? )
2112               (if (or headers boring) ?h ? )
2113               (if (or pgp pem) ?p ? )
2114               (if signature ?s ? )
2115               (if overstrike ?o ? )
2116               (if mime ?m ? )
2117               (if emphasis ?e ? )))))
2118
2119 (defun gnus-article-hide-headers-if-wanted ()
2120   "Hide unwanted headers if `gnus-have-all-headers' is nil.
2121 Provided for backwards compatibility."
2122   (or (save-excursion (set-buffer gnus-summary-buffer) gnus-have-all-headers)
2123       gnus-inhibit-hiding
2124       (gnus-article-hide-headers)))
2125
2126 ;;; Article savers.
2127
2128 (defun gnus-output-to-file (file-name)
2129   "Append the current article to a file named FILE-NAME."
2130   (let ((artbuf (current-buffer)))
2131     (nnheader-temp-write nil
2132       (insert-buffer-substring artbuf)
2133       ;; Append newline at end of the buffer as separator, and then
2134       ;; save it to file.
2135       (goto-char (point-max))
2136       (insert "\n")
2137       (append-to-file (point-min) (point-max) file-name)
2138       t)))
2139
2140 (defun gnus-narrow-to-page (&optional arg)
2141   "Narrow the article buffer to a page.
2142 If given a numerical ARG, move forward ARG pages."
2143   (interactive "P")
2144   (setq arg (if arg (prefix-numeric-value arg) 0))
2145   (save-excursion
2146     (set-buffer gnus-article-buffer)
2147     (goto-char (point-min))
2148     (widen)
2149     ;; Remove any old next/prev buttons.
2150     (when (gnus-visual-p 'page-marker)
2151       (let ((buffer-read-only nil))
2152         (gnus-remove-text-with-property 'gnus-prev)
2153         (gnus-remove-text-with-property 'gnus-next)))
2154     (when
2155         (cond ((< arg 0)
2156                (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
2157               ((> arg 0)
2158                (re-search-forward page-delimiter nil 'move arg)))
2159       (goto-char (match-end 0)))
2160     (narrow-to-region
2161      (point)
2162      (if (re-search-forward page-delimiter nil 'move)
2163          (match-beginning 0)
2164        (point)))
2165     (when (and (gnus-visual-p 'page-marker)
2166                (not (= (point-min) 1)))
2167       (save-excursion
2168         (goto-char (point-min))
2169         (gnus-insert-prev-page-button)))
2170     (when (and (gnus-visual-p 'page-marker)
2171                (< (+ (point-max) 2) (buffer-size)))
2172       (save-excursion
2173         (goto-char (point-max))
2174         (gnus-insert-next-page-button)))))
2175
2176 ;; Article mode commands
2177
2178 (defun gnus-article-goto-next-page ()
2179   "Show the next page of the article."
2180   (interactive)
2181   (when (gnus-article-next-page)
2182     (goto-char (point-min))
2183     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
2184
2185 (defun gnus-article-goto-prev-page ()
2186   "Show the next page of the article."
2187   (interactive)
2188   (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
2189     (gnus-article-prev-page nil)))
2190
2191 (defun gnus-article-next-page (&optional lines)
2192   "Show the next page of the current article.
2193 If end of article, return non-nil.  Otherwise return nil.
2194 Argument LINES specifies lines to be scrolled up."
2195   (interactive "p")
2196   (move-to-window-line -1)
2197   (if (save-excursion
2198         (end-of-line)
2199         (and (pos-visible-in-window-p)  ;Not continuation line.
2200              (eobp)))
2201       ;; Nothing in this page.
2202       (if (or (not gnus-page-broken)
2203               (save-excursion
2204                 (save-restriction
2205                   (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
2206           t                             ;Nothing more.
2207         (gnus-narrow-to-page 1)         ;Go to next page.
2208         nil)
2209     ;; More in this page.
2210     (let ((scroll-in-place nil))
2211       (condition-case ()
2212           (scroll-up lines)
2213         (end-of-buffer
2214          ;; Long lines may cause an end-of-buffer error.
2215          (goto-char (point-max)))))
2216     (move-to-window-line 0)
2217     nil))
2218
2219 (defun gnus-article-prev-page (&optional lines)
2220   "Show previous page of current article.
2221 Argument LINES specifies lines to be scrolled down."
2222   (interactive "p")
2223   (move-to-window-line 0)
2224   (if (and gnus-page-broken
2225            (bobp)
2226            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
2227       (progn
2228         (gnus-narrow-to-page -1)        ;Go to previous page.
2229         (goto-char (point-max))
2230         (recenter -1))
2231     (let ((scroll-in-place nil))
2232       (prog1
2233           (condition-case ()
2234               (scroll-down lines)
2235             (beginning-of-buffer
2236              (goto-char (point-min))))
2237         (move-to-window-line 0)))))
2238
2239 (defun gnus-article-refer-article ()
2240   "Read article specified by message-id around point."
2241   (interactive)
2242   (let ((point (point)))
2243     (search-forward ">" nil t)          ;Move point to end of "<....>".
2244     (if (re-search-backward "\\(<[^<> \t\n]+>\\)" nil t)
2245         (let ((message-id (match-string 1)))
2246           (goto-char point)
2247           (set-buffer gnus-summary-buffer)
2248           (gnus-summary-refer-article message-id))
2249       (goto-char (point))
2250       (error "No references around point"))))
2251
2252 (defun gnus-article-show-summary ()
2253   "Reconfigure windows to show summary buffer."
2254   (interactive)
2255   (if (not (gnus-buffer-live-p gnus-summary-buffer))
2256       (error "There is no summary buffer for this article buffer")
2257     (gnus-article-set-globals)
2258     (gnus-configure-windows 'article)
2259     (gnus-summary-goto-subject gnus-current-article)))
2260
2261 (defun gnus-article-describe-briefly ()
2262   "Describe article mode commands briefly."
2263   (interactive)
2264   (gnus-message 6
2265                 (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")))
2266
2267 (defun gnus-article-summary-command ()
2268   "Execute the last keystroke in the summary buffer."
2269   (interactive)
2270   (let ((obuf (current-buffer))
2271         (owin (current-window-configuration))
2272         func)
2273     (switch-to-buffer gnus-article-current-summary 'norecord)
2274     (setq func (lookup-key (current-local-map) (this-command-keys)))
2275     (call-interactively func)
2276     (set-buffer obuf)
2277     (set-window-configuration owin)
2278     (set-window-point (get-buffer-window (current-buffer)) (point))))
2279
2280 (defun gnus-article-summary-command-nosave ()
2281   "Execute the last keystroke in the summary buffer."
2282   (interactive)
2283   (let (func)
2284     (pop-to-buffer gnus-article-current-summary 'norecord)
2285     (setq func (lookup-key (current-local-map) (this-command-keys)))
2286     (call-interactively func)))
2287
2288 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
2289   "Read a summary buffer key sequence and execute it from the article buffer."
2290   (interactive "P")
2291   (let ((nosaves
2292          '("q" "Q"  "c" "r" "R" "\C-c\C-f" "m"  "a" "f" "F"
2293            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
2294            "=" "^" "\M-^" "|"))
2295         (nosave-but-article
2296          '("A\r"))
2297         (nosave-in-article
2298          '("\C-d"))
2299         (up-to-top
2300          '("n" "Gn" "p" "Gp"))
2301         keys new-sum-point)
2302     (save-excursion
2303       (set-buffer gnus-article-current-summary)
2304       (let (gnus-pick-mode)
2305         (push (or key last-command-event) unread-command-events)
2306         (setq keys (read-key-sequence nil))))
2307     (message "")
2308
2309     (if (or (member keys nosaves)
2310             (member keys nosave-but-article)
2311             (member keys nosave-in-article))
2312         (let (func)
2313           (save-window-excursion
2314             (pop-to-buffer gnus-article-current-summary 'norecord)
2315             ;; We disable the pick minor mode commands.
2316             (let (gnus-pick-mode)
2317               (setq func (lookup-key (current-local-map) keys))))
2318           (if (not func)
2319               (ding)
2320             (unless (member keys nosave-in-article)
2321               (set-buffer gnus-article-current-summary))
2322             (call-interactively func)
2323             (setq new-sum-point (point)))
2324           (when (member keys nosave-but-article)
2325             (pop-to-buffer gnus-article-buffer 'norecord)))
2326       ;; These commands should restore window configuration.
2327       (let ((obuf (current-buffer))
2328             (owin (current-window-configuration))
2329             (opoint (point))
2330             (summary gnus-article-current-summary)
2331             func in-buffer selected)
2332         (if not-restore-window
2333             (pop-to-buffer summary 'norecord)
2334           (switch-to-buffer summary 'norecord))
2335         (setq in-buffer (current-buffer))
2336         ;; We disable the pick minor mode commands.
2337         (if (setq func (let (gnus-pick-mode)
2338                          (lookup-key (current-local-map) keys)))
2339             (progn
2340               (call-interactively func)
2341               (setq new-sum-point (point)))
2342           (ding))
2343         (when (eq in-buffer (current-buffer))
2344           (setq selected (gnus-summary-select-article))
2345           (set-buffer obuf)
2346           (unless not-restore-window
2347             (set-window-configuration owin))
2348           (unless (or (not (eq selected 'old)) (member keys up-to-top))
2349             (set-window-point (get-buffer-window (current-buffer))
2350                               opoint))
2351           (let ((win (get-buffer-window gnus-article-current-summary)))
2352             (when win
2353               (set-window-point win new-sum-point))))))))
2354
2355 (defun gnus-article-hide (&optional arg force)
2356   "Hide all the gruft in the current article.
2357 This means that PGP stuff, signatures, cited text and (some)
2358 headers will be hidden.
2359 If given a prefix, show the hidden text instead."
2360   (interactive (append (gnus-article-hidden-arg) (list 'force)))
2361   (gnus-article-hide-headers arg)
2362   (gnus-article-hide-pgp arg)
2363   (gnus-article-hide-citation-maybe arg force)
2364   (gnus-article-hide-signature arg))
2365
2366 (defun gnus-article-maybe-highlight ()
2367   "Do some article highlighting if `article-visual' is non-nil."
2368   (when (gnus-visual-p 'article-highlight 'highlight)
2369     (gnus-article-highlight-some)))
2370
2371 (defun gnus-request-article-this-buffer (article group)
2372   "Get an article and insert it into this buffer."
2373   (let (do-update-line)
2374     (prog1
2375         (save-excursion
2376           (erase-buffer)
2377           (gnus-kill-all-overlays)
2378           (setq group (or group gnus-newsgroup-name))
2379
2380           ;; Open server if it has closed.
2381           (gnus-check-server (gnus-find-method-for-group group))
2382
2383           ;; Using `gnus-request-article' directly will insert the article into
2384           ;; `nntp-server-buffer' - so we'll save some time by not having to
2385           ;; copy it from the server buffer into the article buffer.
2386
2387           ;; We only request an article by message-id when we do not have the
2388           ;; headers for it, so we'll have to get those.
2389           (when (stringp article)
2390             (let ((gnus-override-method gnus-refer-article-method))
2391               (gnus-read-header article)))
2392
2393           ;; If the article number is negative, that means that this article
2394           ;; doesn't belong in this newsgroup (possibly), so we find its
2395           ;; message-id and request it by id instead of number.
2396           (when (and (numberp article)
2397                      gnus-summary-buffer
2398                      (get-buffer gnus-summary-buffer)
2399                      (gnus-buffer-exists-p gnus-summary-buffer))
2400             (save-excursion
2401               (set-buffer gnus-summary-buffer)
2402               (let ((header (gnus-summary-article-header article)))
2403                 (when (< article 0)
2404                   (cond
2405                    ((memq article gnus-newsgroup-sparse)
2406                     ;; This is a sparse gap article.
2407                     (setq do-update-line article)
2408                     (setq article (mail-header-id header))
2409                     (let ((gnus-override-method gnus-refer-article-method))
2410                       (gnus-read-header article))
2411                     (setq gnus-newsgroup-sparse
2412                           (delq article gnus-newsgroup-sparse)))
2413                    ((vectorp header)
2414                     ;; It's a real article.
2415                     (setq article (mail-header-id header)))
2416                    (t
2417                     ;; It is an extracted pseudo-article.
2418                     (setq article 'pseudo)
2419                     (gnus-request-pseudo-article header))))
2420
2421                 (let ((method (gnus-find-method-for-group
2422                                gnus-newsgroup-name)))
2423                   (when (and (eq (car method) 'nneething)
2424                              (vectorp header))
2425                     (let ((dir (concat (file-name-as-directory (nth 1 method))
2426                                        (mail-header-subject header))))
2427                       (when (file-directory-p dir)
2428                         (setq article 'nneething)
2429                         (gnus-group-enter-directory dir))))))))
2430
2431           (cond
2432            ;; Refuse to select canceled articles.
2433            ((and (numberp article)
2434                  gnus-summary-buffer
2435                  (get-buffer gnus-summary-buffer)
2436                  (gnus-buffer-exists-p gnus-summary-buffer)
2437                  (eq (cdr (save-excursion
2438                             (set-buffer gnus-summary-buffer)
2439                             (assq article gnus-newsgroup-reads)))
2440                      gnus-canceled-mark))
2441             nil)
2442            ;; We first check `gnus-original-article-buffer'.
2443            ((and (get-buffer gnus-original-article-buffer)
2444                  (numberp article)
2445                  (save-excursion
2446                    (set-buffer gnus-original-article-buffer)
2447                    (and (equal (car gnus-original-article) group)
2448                         (eq (cdr gnus-original-article) article))))
2449             (insert-buffer-substring gnus-original-article-buffer)
2450             'article)
2451            ;; Check the backlog.
2452            ((and gnus-keep-backlog
2453                  (gnus-backlog-request-article group article (current-buffer)))
2454             'article)
2455            ;; Check asynchronous pre-fetch.
2456            ((gnus-async-request-fetched-article group article (current-buffer))
2457             (gnus-async-prefetch-next group article gnus-summary-buffer)
2458             (when (and (numberp article) gnus-keep-backlog)
2459               (gnus-backlog-enter-article group article (current-buffer)))
2460             'article)
2461            ;; Check the cache.
2462            ((and gnus-use-cache
2463                  (numberp article)
2464                  (gnus-cache-request-article article group))
2465             'article)
2466            ;; Get the article and put into the article buffer.
2467            ((or (stringp article) (numberp article))
2468             (let ((gnus-override-method
2469                    (and (stringp article) gnus-refer-article-method))
2470                   (buffer-read-only nil))
2471               (erase-buffer)
2472               (gnus-kill-all-overlays)
2473               (when (gnus-request-article article group (current-buffer))
2474                 (when (numberp article)
2475                   (gnus-async-prefetch-next group article gnus-summary-buffer)
2476                   (when gnus-keep-backlog
2477                     (gnus-backlog-enter-article
2478                      group article (current-buffer))))
2479                 'article)))
2480            ;; It was a pseudo.
2481            (t article)))
2482
2483       ;; Associate this article with the current summary buffer.
2484       (setq gnus-article-current-summary gnus-summary-buffer)
2485       
2486       ;; Take the article from the original article buffer
2487       ;; and place it in the buffer it's supposed to be in.
2488       (when (and (get-buffer gnus-article-buffer)
2489                  (equal (buffer-name (current-buffer))
2490                         (buffer-name (get-buffer gnus-article-buffer))))
2491         (save-excursion
2492           (if (get-buffer gnus-original-article-buffer)
2493               (set-buffer gnus-original-article-buffer)
2494             (set-buffer (get-buffer-create gnus-original-article-buffer))
2495             (buffer-disable-undo (current-buffer))
2496             (setq major-mode 'gnus-original-article-mode)
2497             (setq buffer-read-only t)
2498             (gnus-add-current-to-buffer-list))
2499           (let (buffer-read-only)
2500             (erase-buffer)
2501             (insert-buffer-substring gnus-article-buffer))
2502           (setq gnus-original-article (cons group article))))
2503
2504       ;; Update sparse articles.
2505       (when (and do-update-line
2506                  (or (numberp article)
2507                      (stringp article)))
2508         (let ((buf (current-buffer)))
2509           (set-buffer gnus-summary-buffer)
2510           (gnus-summary-update-article do-update-line)
2511           (gnus-summary-goto-subject do-update-line nil t)
2512           (set-window-point (get-buffer-window (current-buffer) t)
2513                             (point))
2514           (set-buffer buf))))))
2515
2516 ;;;
2517 ;;; Article editing
2518 ;;;
2519
2520 (defcustom gnus-article-edit-mode-hook nil
2521   "Hook run in article edit mode buffers."
2522   :group 'gnus-article-various
2523   :type 'hook)
2524
2525 (defvar gnus-article-edit-done-function nil)
2526
2527 (defvar gnus-article-edit-mode-map nil)
2528
2529 (unless gnus-article-edit-mode-map
2530   (setq gnus-article-edit-mode-map (copy-keymap text-mode-map))
2531
2532   (gnus-define-keys gnus-article-edit-mode-map
2533     "\C-c\C-c" gnus-article-edit-done
2534     "\C-c\C-k" gnus-article-edit-exit)
2535
2536   (gnus-define-keys (gnus-article-edit-wash-map
2537                      "\C-c\C-w" gnus-article-edit-mode-map)
2538     "f" gnus-article-edit-full-stops))
2539
2540 (defun gnus-article-edit-mode ()
2541   "Major mode for editing articles.
2542 This is an extended text-mode.
2543
2544 \\{gnus-article-edit-mode-map}"
2545   (interactive)
2546   (setq major-mode 'gnus-article-edit-mode)
2547   (setq mode-name "Article Edit")
2548   (use-local-map gnus-article-edit-mode-map)
2549   (make-local-variable 'gnus-article-edit-done-function)
2550   (make-local-variable 'gnus-prev-winconf)
2551   (setq buffer-read-only nil)
2552   (buffer-enable-undo)
2553   (widen)
2554   (gnus-run-hooks 'text-mode-hook 'gnus-article-edit-mode-hook))
2555
2556 (defun gnus-article-edit (&optional force)
2557   "Edit the current article.
2558 This will have permanent effect only in mail groups.
2559 If FORCE is non-nil, allow editing of articles even in read-only
2560 groups."
2561   (interactive "P")
2562   (when (and (not force)
2563              (gnus-group-read-only-p))
2564     (error "The current newsgroup does not support article editing"))
2565   (gnus-article-date-original)
2566   (gnus-article-edit-article
2567    `(lambda (no-highlight)
2568       (gnus-summary-edit-article-done
2569        ,(or (mail-header-references gnus-current-headers) "")
2570        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
2571
2572 (defun gnus-article-edit-article (exit-func)
2573   "Start editing the contents of the current article buffer."
2574   (let ((winconf (current-window-configuration)))
2575     (set-buffer gnus-article-buffer)
2576     (gnus-article-edit-mode)
2577     (gnus-set-text-properties (point-min) (point-max) nil)
2578     (gnus-configure-windows 'edit-article)
2579     (setq gnus-article-edit-done-function exit-func)
2580     (setq gnus-prev-winconf winconf)
2581     (gnus-message 6 "C-c C-c to end edits")))
2582
2583 (defun gnus-article-edit-done (&optional arg)
2584   "Update the article edits and exit."
2585   (interactive "P")
2586   (save-excursion
2587     (save-restriction
2588       (widen)
2589       (goto-char (point-min))
2590       (when (search-forward "\n\n" nil 1)
2591         (let ((lines (count-lines (point) (point-max)))
2592               (length (- (point-max) (point)))
2593               (case-fold-search t)
2594               (body (copy-marker (point))))
2595           (goto-char (point-min))
2596           (when (re-search-forward "^content-length:[ \t]\\([0-9]+\\)" body t)
2597             (delete-region (match-beginning 1) (match-end 1))
2598             (insert (number-to-string length)))
2599           (goto-char (point-min))
2600           (when (re-search-forward
2601                  "^x-content-length:[ \t]\\([0-9]+\\)" body t)
2602             (delete-region (match-beginning 1) (match-end 1))
2603             (insert (number-to-string length)))
2604           (goto-char (point-min))
2605           (when (re-search-forward "^lines:[ \t]\\([0-9]+\\)" body t)
2606             (delete-region (match-beginning 1) (match-end 1))
2607             (insert (number-to-string lines)))))))
2608   (let ((func gnus-article-edit-done-function)
2609         (buf (current-buffer))
2610         (start (window-start)))
2611     (gnus-article-edit-exit)
2612     (save-excursion
2613       (set-buffer buf)
2614       (let ((buffer-read-only nil))
2615         (funcall func arg)))
2616     (set-buffer buf)
2617     (set-window-start (get-buffer-window buf) start)
2618     (set-window-point (get-buffer-window buf) (point))))
2619
2620 (defun gnus-article-edit-exit ()
2621   "Exit the article editing without updating."
2622   (interactive)
2623   ;; We remove all text props from the article buffer.
2624   (let ((buf (format "%s" (buffer-string)))
2625         (curbuf (current-buffer))
2626         (p (point))
2627         (window-start (window-start)))
2628     (erase-buffer)
2629     (insert buf)
2630     (let ((winconf gnus-prev-winconf))
2631       (gnus-article-mode)
2632       ;; The cache and backlog have to be flushed somewhat.
2633       (when gnus-use-cache
2634         (gnus-cache-update-article
2635          (car gnus-article-current) (cdr gnus-article-current)))
2636       (when gnus-keep-backlog
2637         (gnus-backlog-remove-article
2638          (car gnus-article-current) (cdr gnus-article-current)))
2639       ;; Flush original article as well.
2640       (save-excursion
2641         (when (get-buffer gnus-original-article-buffer)
2642           (set-buffer gnus-original-article-buffer)
2643           (setq gnus-original-article nil)))
2644       (set-window-configuration winconf)
2645       ;; Tippy-toe some to make sure that point remains where it was.
2646       (let ((buf (current-buffer)))
2647         (set-buffer curbuf)
2648         (set-window-start (get-buffer-window (current-buffer)) window-start)
2649         (goto-char p)
2650         (set-buffer buf)))))
2651
2652 (defun gnus-article-edit-full-stops ()
2653   "Interactively repair spacing at end of sentences."
2654   (interactive)
2655   (save-excursion
2656     (goto-char (point-min))
2657     (search-forward-regexp "^$" nil t)
2658     (let ((case-fold-search nil))
2659       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
2660
2661 ;;;
2662 ;;; Article highlights
2663 ;;;
2664
2665 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
2666
2667 ;;; Internal Variables:
2668
2669 (defcustom gnus-button-url-regexp "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?\\([-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,]\\|\\w\\)+\\([-a-zA-Z0-9_=#$@~`%&*+|\\/]\\|\\w\\)"
2670   "Regular expression that matches URLs."
2671   :group 'gnus-article-buttons
2672   :type 'regexp)
2673
2674 (defcustom gnus-button-alist
2675   `(("<\\(url:[>\n\t ]*?\\)?news:[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>" 0 t
2676      gnus-button-message-id 2)
2677     ("\\bnews:\\([^>\n\t ]*@[^>\n\t ]*\\)" 0 t gnus-button-message-id 1)
2678     ("\\(\\b<\\(url:[>\n\t ]*\\)?news:[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
2679      1 t
2680      gnus-button-fetch-group 4)
2681     ("\\bnews:\\(//\\)?\\([^'\">\n\t ]+\\)" 0 t gnus-button-fetch-group 2)
2682     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)" 2
2683      t gnus-button-message-id 3)
2684     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>" 0 t gnus-url-mailto 2)
2685     ("mailto:\\([a-zA-Z.-@_+0-9%]+\\)" 0 t gnus-url-mailto 2)
2686     ("\\bmailto:\\([^ \n\t]+\\)" 0 t gnus-url-mailto 1)
2687     ;; This is how URLs _should_ be embedded in text...
2688     ("<URL: *\\([^>]*\\)>" 0 t gnus-button-embedded-url 1)
2689     ;; Raw URLs.
2690     (,gnus-button-url-regexp 0 t gnus-button-url 0))
2691   "*Alist of regexps matching buttons in article bodies.
2692
2693 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
2694 REGEXP: is the string matching text around the button,
2695 BUTTON: is the number of the regexp grouping actually matching the button,
2696 FORM: is a lisp expression which must eval to true for the button to
2697 be added,
2698 CALLBACK: is the function to call when the user push this button, and each
2699 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
2700
2701 CALLBACK can also be a variable, in that case the value of that
2702 variable it the real callback function."
2703   :group 'gnus-article-buttons
2704   :type '(repeat (list regexp
2705                        (integer :tag "Button")
2706                        (sexp :tag "Form")
2707                        (function :tag "Callback")
2708                        (repeat :tag "Par"
2709                                :inline t
2710                                (integer :tag "Regexp group")))))
2711
2712 (defcustom gnus-header-button-alist
2713   `(("^\\(References\\|Message-I[Dd]\\):" "<[^>]+>"
2714      0 t gnus-button-message-id 0)
2715     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$" 1 t gnus-button-reply 1)
2716     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
2717      0 t gnus-button-mailto 0)
2718     ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2719     ("^Subject:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2720     ("^[^:]+:" ,gnus-button-url-regexp 0 t gnus-button-url 0)
2721     ("^[^:]+:" "\\(<\\(url: \\)?news:\\([^>\n ]*\\)>\\)" 1 t
2722      gnus-button-message-id 3))
2723   "*Alist of headers and regexps to match buttons in article heads.
2724
2725 This alist is very similar to `gnus-button-alist', except that each
2726 alist has an additional HEADER element first in each entry:
2727
2728 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
2729
2730 HEADER is a regexp to match a header.  For a fuller explanation, see
2731 `gnus-button-alist'."
2732   :group 'gnus-article-buttons
2733   :group 'gnus-article-headers
2734   :type '(repeat (list (regexp :tag "Header")
2735                        regexp
2736                        (integer :tag "Button")
2737                        (sexp :tag "Form")
2738                        (function :tag "Callback")
2739                        (repeat :tag "Par"
2740                                :inline t
2741                                (integer :tag "Regexp group")))))
2742
2743 (defvar gnus-button-regexp nil)
2744 (defvar gnus-button-marker-list nil)
2745 ;; Regexp matching any of the regexps from `gnus-button-alist'.
2746
2747 (defvar gnus-button-last nil)
2748 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
2749
2750 ;;; Commands:
2751
2752 (defun gnus-article-push-button (event)
2753   "Check text under the mouse pointer for a callback function.
2754 If the text under the mouse pointer has a `gnus-callback' property,
2755 call it with the value of the `gnus-data' text property."
2756   (interactive "e")
2757   (set-buffer (window-buffer (posn-window (event-start event))))
2758   (let* ((pos (posn-point (event-start event)))
2759          (data (get-text-property pos 'gnus-data))
2760          (fun (get-text-property pos 'gnus-callback)))
2761     (when fun
2762       (funcall fun data))))
2763
2764 (defun gnus-article-press-button ()
2765   "Check text at point for a callback function.
2766 If the text at point has a `gnus-callback' property,
2767 call it with the value of the `gnus-data' text property."
2768   (interactive)
2769   (let* ((data (get-text-property (point) 'gnus-data))
2770          (fun (get-text-property (point) 'gnus-callback)))
2771     (when fun
2772       (funcall fun data))))
2773
2774 (defun gnus-article-prev-button (n)
2775   "Move point to N buttons backward.
2776 If N is negative, move forward instead."
2777   (interactive "p")
2778   (gnus-article-next-button (- n)))
2779
2780 (defun gnus-article-next-button (n)
2781   "Move point to N buttons forward.
2782 If N is negative, move backward instead."
2783   (interactive "p")
2784   (let ((function (if (< n 0) 'previous-single-property-change
2785                     'next-single-property-change))
2786         (inhibit-point-motion-hooks t)
2787         (backward (< n 0))
2788         (limit (if (< n 0) (point-min) (point-max))))
2789     (setq n (abs n))
2790     (while (and (not (= limit (point)))
2791                 (> n 0))
2792       ;; Skip past the current button.
2793       (when (get-text-property (point) 'gnus-callback)
2794         (goto-char (funcall function (point) 'gnus-callback nil limit)))
2795       ;; Go to the next (or previous) button.
2796       (gnus-goto-char (funcall function (point) 'gnus-callback nil limit))
2797       ;; Put point at the start of the button.
2798       (when (and backward (not (get-text-property (point) 'gnus-callback)))
2799         (goto-char (funcall function (point) 'gnus-callback nil limit)))
2800       ;; Skip past intangible buttons.
2801       (when (get-text-property (point) 'intangible)
2802         (incf n))
2803       (decf n))
2804     (unless (zerop n)
2805       (gnus-message 5 "No more buttons"))
2806     n))
2807
2808 (defun gnus-article-highlight (&optional force)
2809   "Highlight current article.
2810 This function calls `gnus-article-highlight-headers',
2811 `gnus-article-highlight-citation',
2812 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2813 do the highlighting.  See the documentation for those functions."
2814   (interactive (list 'force))
2815   (gnus-article-highlight-headers)
2816   (gnus-article-highlight-citation force)
2817   (gnus-article-highlight-signature)
2818   (gnus-article-add-buttons force)
2819   (gnus-article-add-buttons-to-head))
2820
2821 (defun gnus-article-highlight-some (&optional force)
2822   "Highlight current article.
2823 This function calls `gnus-article-highlight-headers',
2824 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
2825 do the highlighting.  See the documentation for those functions."
2826   (interactive (list 'force))
2827   (gnus-article-highlight-headers)
2828   (gnus-article-highlight-signature)
2829   (gnus-article-add-buttons))
2830
2831 (defun gnus-article-highlight-headers ()
2832   "Highlight article headers as specified by `gnus-header-face-alist'."
2833   (interactive)
2834   (save-excursion
2835     (set-buffer gnus-article-buffer)
2836     (save-restriction
2837       (let ((alist gnus-header-face-alist)
2838             (buffer-read-only nil)
2839             (case-fold-search t)
2840             (inhibit-point-motion-hooks t)
2841             entry regexp header-face field-face from hpoints fpoints)
2842         (message-narrow-to-head)
2843         (while (setq entry (pop alist))
2844           (goto-char (point-min))
2845           (setq regexp (concat "^\\("
2846                                (if (string-equal "" (nth 0 entry))
2847                                    "[^\t ]"
2848                                  (nth 0 entry))
2849                                "\\)")
2850                 header-face (nth 1 entry)
2851                 field-face (nth 2 entry))
2852           (while (and (re-search-forward regexp nil t)
2853                       (not (eobp)))
2854             (beginning-of-line)
2855             (setq from (point))
2856             (unless (search-forward ":" nil t)
2857               (forward-char 1))
2858             (when (and header-face
2859                        (not (memq (point) hpoints)))
2860               (push (point) hpoints)
2861               (gnus-put-text-property from (point) 'face header-face))
2862             (when (and field-face
2863                        (not (memq (setq from (point)) fpoints)))
2864               (push from fpoints)
2865               (if (re-search-forward "^[^ \t]" nil t)
2866                   (forward-char -2)
2867                 (goto-char (point-max)))
2868               (gnus-put-text-property from (point) 'face field-face))))))))
2869
2870 (defun gnus-article-highlight-signature ()
2871   "Highlight the signature in an article.
2872 It does this by highlighting everything after
2873 `gnus-signature-separator' using `gnus-signature-face'."
2874   (interactive)
2875   (save-excursion
2876     (set-buffer gnus-article-buffer)
2877     (let ((buffer-read-only nil)
2878           (inhibit-point-motion-hooks t))
2879       (save-restriction
2880         (when (and gnus-signature-face
2881                    (gnus-article-narrow-to-signature))
2882           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
2883                             'face gnus-signature-face)
2884           (widen)
2885           (gnus-article-search-signature)
2886           (let ((start (match-beginning 0))
2887                 (end (set-marker (make-marker) (1+ (match-end 0)))))
2888             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
2889                                      end)))))))
2890
2891 (defun gnus-button-in-region-p (b e prop)
2892   "Say whether PROP exists in the region."
2893   (text-property-not-all b e prop nil))
2894
2895 (defun gnus-article-add-buttons (&optional force)
2896   "Find external references in the article and make buttons of them.
2897 \"External references\" are things like Message-IDs and URLs, as
2898 specified by `gnus-button-alist'."
2899   (interactive (list 'force))
2900   (save-excursion
2901     (set-buffer gnus-article-buffer)
2902     (let ((buffer-read-only nil)
2903           (inhibit-point-motion-hooks t)
2904           (case-fold-search t)
2905           (alist gnus-button-alist)
2906           beg entry regexp)
2907       ;; Remove all old markers.
2908       (let (marker entry)
2909         (while (setq marker (pop gnus-button-marker-list))
2910           (goto-char marker)
2911           (when (setq entry (gnus-button-entry))
2912             (put-text-property (match-beginning (nth 1 entry))
2913                                (match-end (nth 1 entry))
2914                                'gnus-callback nil))
2915           (set-marker marker nil)))
2916       ;; We skip the headers.
2917       (goto-char (point-min))
2918       (unless (search-forward "\n\n" nil t)
2919         (goto-char (point-max)))
2920       (setq beg (point))
2921       (while (setq entry (pop alist))
2922         (setq regexp (car entry))
2923         (goto-char beg)
2924         (while (re-search-forward regexp nil t)
2925           (let* ((start (and entry (match-beginning (nth 1 entry))))
2926                  (end (and entry (match-end (nth 1 entry))))
2927                  (from (match-beginning 0)))
2928             (when (and (or (eq t (nth 2 entry))
2929                            (eval (nth 2 entry)))
2930                        (not (gnus-button-in-region-p
2931                              start end 'gnus-callback)))
2932               ;; That optional form returned non-nil, so we add the
2933               ;; button.
2934               (gnus-article-add-button
2935                start end 'gnus-button-push
2936                (car (push (set-marker (make-marker) from)
2937                           gnus-button-marker-list))))))))))
2938
2939 ;; Add buttons to the head of an article.
2940 (defun gnus-article-add-buttons-to-head ()
2941   "Add buttons to the head of the article."
2942   (interactive)
2943   (save-excursion
2944     (set-buffer gnus-article-buffer)
2945     (let ((buffer-read-only nil)
2946           (inhibit-point-motion-hooks t)
2947           (case-fold-search t)
2948           (alist gnus-header-button-alist)
2949           entry beg end)
2950       (nnheader-narrow-to-headers)
2951       (while alist
2952         ;; Each alist entry.
2953         (setq entry (car alist)
2954               alist (cdr alist))
2955         (goto-char (point-min))
2956         (while (re-search-forward (car entry) nil t)
2957           ;; Each header matching the entry.
2958           (setq beg (match-beginning 0))
2959           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
2960                              (match-beginning 0))
2961                         (point-max)))
2962           (goto-char beg)
2963           (while (re-search-forward (nth 1 entry) end t)
2964             ;; Each match within a header.
2965             (let* ((entry (cdr entry))
2966                    (start (match-beginning (nth 1 entry)))
2967                    (end (match-end (nth 1 entry)))
2968                    (form (nth 2 entry)))
2969               (goto-char (match-end 0))
2970               (when (eval form)
2971                 (gnus-article-add-button
2972                  start end (nth 3 entry)
2973                  (buffer-substring (match-beginning (nth 4 entry))
2974                                    (match-end (nth 4 entry)))))))
2975           (goto-char end))))
2976     (widen)))
2977
2978 ;;; External functions:
2979
2980 (defun gnus-article-add-button (from to fun &optional data)
2981   "Create a button between FROM and TO with callback FUN and data DATA."
2982   (when gnus-article-button-face
2983     (gnus-overlay-put (gnus-make-overlay from to)
2984                       'face gnus-article-button-face))
2985   (gnus-add-text-properties
2986    from to
2987    (nconc (and gnus-article-mouse-face
2988                (list gnus-mouse-face-prop gnus-article-mouse-face))
2989           (list 'gnus-callback fun)
2990           (and data (list 'gnus-data data)))))
2991
2992 ;;; Internal functions:
2993
2994 (defun gnus-article-set-globals ()
2995   (save-excursion
2996     (set-buffer gnus-summary-buffer)
2997     (gnus-set-global-variables)))
2998
2999 (defun gnus-signature-toggle (end)
3000   (save-excursion
3001     (set-buffer gnus-article-buffer)
3002     (let ((buffer-read-only nil)
3003           (inhibit-point-motion-hooks t))
3004       (if (get-text-property end 'invisible)
3005           (gnus-article-unhide-text end (point-max))
3006         (gnus-article-hide-text end (point-max) gnus-hidden-properties)))))
3007
3008 (defun gnus-button-entry ()
3009   ;; Return the first entry in `gnus-button-alist' matching this place.
3010   (let ((alist gnus-button-alist)
3011         (entry nil))
3012     (while alist
3013       (setq entry (pop alist))
3014       (if (looking-at (car entry))
3015           (setq alist nil)
3016         (setq entry nil)))
3017     entry))
3018
3019 (defun gnus-button-push (marker)
3020   ;; Push button starting at MARKER.
3021   (save-excursion
3022     (set-buffer gnus-article-buffer)
3023     (goto-char marker)
3024     (let* ((entry (gnus-button-entry))
3025            (inhibit-point-motion-hooks t)
3026            (fun (nth 3 entry))
3027            (args (mapcar (lambda (group)
3028                            (let ((string (match-string group)))
3029                              (gnus-set-text-properties
3030                               0 (length string) nil string)
3031                              string))
3032                          (nthcdr 4 entry))))
3033       (cond
3034        ((fboundp fun)
3035         (apply fun args))
3036        ((and (boundp fun)
3037              (fboundp (symbol-value fun)))
3038         (apply (symbol-value fun) args))
3039        (t
3040         (gnus-message 1 "You must define `%S' to use this button"
3041                       (cons fun args)))))))
3042
3043 (defun gnus-button-message-id (message-id)
3044   "Fetch MESSAGE-ID."
3045   (save-excursion
3046     (set-buffer gnus-summary-buffer)
3047     (gnus-summary-refer-article message-id)))
3048
3049 (defun gnus-button-fetch-group (address)
3050   "Fetch GROUP specified by ADDRESS."
3051   (if (not (string-match "[:/]" address))
3052       ;; This is just a simple group url.
3053       (gnus-group-read-ephemeral-group address gnus-select-method)
3054     (if (not (string-match "^\\([^:/]+\\)\\(:\\([^/]+\\)/\\)?\\(.*\\)$"
3055                            address))
3056         (error "Can't parse %s" address)
3057       (gnus-group-read-ephemeral-group
3058        (match-string 4 address)
3059        `(nntp ,(match-string 1 address)
3060               (nntp-address ,(match-string 1 address))
3061               (nntp-port-number ,(if (match-end 3)
3062                                      (match-string 3 address)
3063                                    "nntp")))))))
3064
3065 (defun gnus-split-string (string pattern)
3066   "Return a list of substrings of STRING which are separated by PATTERN."
3067   (let (parts (start 0))
3068     (while (string-match pattern string start)
3069       (setq parts (cons (substring string start (match-beginning 0)) parts)
3070             start (match-end 0)))
3071     (nreverse (cons (substring string start) parts))))
3072
3073 (defun gnus-url-parse-query-string (query &optional downcase)
3074   (let (retval pairs cur key val)
3075     (setq pairs (gnus-split-string query "&"))
3076     (while pairs
3077       (setq cur (car pairs)
3078             pairs (cdr pairs))
3079       (if (not (string-match "=" cur))
3080           nil                           ; Grace
3081         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
3082               val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
3083         (if downcase
3084             (setq key (downcase key)))
3085         (setq cur (assoc key retval))
3086         (if cur
3087             (setcdr cur (cons val (cdr cur)))
3088           (setq retval (cons (list key val) retval)))))
3089     retval))
3090
3091 (defun gnus-url-unhex (x)
3092   (if (> x ?9)
3093       (if (>= x ?a)
3094           (+ 10 (- x ?a))
3095         (+ 10 (- x ?A)))
3096     (- x ?0)))
3097
3098 (defun gnus-url-unhex-string (str &optional allow-newlines)
3099   "Remove %XXX embedded spaces, etc in a url.
3100 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
3101 decoding of carriage returns and line feeds in the string, which is normally
3102 forbidden in URL encoding."
3103   (setq str (or str ""))
3104   (let ((tmp "")
3105         (case-fold-search t))
3106     (while (string-match "%[0-9a-f][0-9a-f]" str)
3107       (let* ((start (match-beginning 0))
3108              (ch1 (gnus-url-unhex (elt str (+ start 1))))
3109              (code (+ (* 16 ch1)
3110                       (gnus-url-unhex (elt str (+ start 2))))))
3111         (setq tmp (concat
3112                    tmp (substring str 0 start)
3113                    (cond
3114                     (allow-newlines
3115                      (char-to-string code))
3116                     ((or (= code ?\n) (= code ?\r))
3117                      " ")
3118                     (t (char-to-string code))))
3119               str (substring str (match-end 0)))))
3120     (setq tmp (concat tmp str))
3121     tmp))
3122
3123 (defun gnus-url-mailto (url)
3124   ;; Send mail to someone
3125   (when (string-match "mailto:/*\\(.*\\)" url)
3126     (setq url (substring url (match-beginning 1) nil)))
3127   (let (to args source-url subject func)
3128     (if (string-match (regexp-quote "?") url)
3129         (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
3130               args (gnus-url-parse-query-string
3131                     (substring url (match-end 0) nil) t))
3132       (setq to (gnus-url-unhex-string url)))
3133     (setq args (cons (list "to" to) args)
3134           subject (cdr-safe (assoc "subject" args)))
3135     (message-mail)
3136     (while args
3137       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
3138       (if (fboundp func)
3139           (funcall func)
3140         (message-position-on-field (caar args)))
3141       (insert (mapconcat 'identity (cdar args) ", "))
3142       (setq args (cdr args)))
3143     (if subject
3144         (message-goto-body)
3145       (message-goto-subject))))
3146
3147 (defun gnus-button-mailto (address)
3148   ;; Mail to ADDRESS.
3149   (set-buffer (gnus-copy-article-buffer))
3150   (message-reply address))
3151
3152 (defun gnus-button-reply (address)
3153   ;; Reply to ADDRESS.
3154   (message-reply address))
3155
3156 (defun gnus-button-url (address)
3157   "Browse ADDRESS."
3158   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
3159   (if (listp browse-url-browser-function)
3160       (browse-url address)
3161     (funcall browse-url-browser-function address)))
3162
3163 (defun gnus-button-embedded-url (address)
3164   "Browse ADDRESS."
3165   ;; In Emacs 20, `browse-url-browser-function' may be an alist.
3166   (if (listp browse-url-browser-function)
3167       (browse-url (gnus-strip-whitespace address))
3168     (funcall browse-url-browser-function (gnus-strip-whitespace address))))
3169
3170 ;;; Next/prev buttons in the article buffer.
3171
3172 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
3173 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
3174
3175 (defvar gnus-prev-page-map nil)
3176 (unless gnus-prev-page-map
3177   (setq gnus-prev-page-map (make-sparse-keymap))
3178   (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
3179   (define-key gnus-prev-page-map "\r" 'gnus-button-prev-page))
3180
3181 (defun gnus-insert-prev-page-button ()
3182   (let ((buffer-read-only nil))
3183     (gnus-eval-format
3184      gnus-prev-page-line-format nil
3185      `(gnus-prev t local-map ,gnus-prev-page-map
3186                  gnus-callback gnus-article-button-prev-page))))
3187
3188 (defvar gnus-next-page-map nil)
3189 (unless gnus-next-page-map
3190   (setq gnus-next-page-map (make-keymap))
3191   (suppress-keymap gnus-prev-page-map)
3192   (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
3193   (define-key gnus-next-page-map "\r" 'gnus-button-next-page))
3194
3195 (defun gnus-button-next-page ()
3196   "Go to the next page."
3197   (interactive)
3198   (let ((win (selected-window)))
3199     (select-window (get-buffer-window gnus-article-buffer t))
3200     (gnus-article-next-page)
3201     (select-window win)))
3202
3203 (defun gnus-button-prev-page ()
3204   "Go to the prev page."
3205   (interactive)
3206   (let ((win (selected-window)))
3207     (select-window (get-buffer-window gnus-article-buffer t))
3208     (gnus-article-prev-page)
3209     (select-window win)))
3210
3211 (defun gnus-insert-next-page-button ()
3212   (let ((buffer-read-only nil))
3213     (gnus-eval-format gnus-next-page-line-format nil
3214                       `(gnus-next t local-map ,gnus-next-page-map
3215                                   gnus-callback
3216                                   gnus-article-button-next-page))))
3217
3218 (defun gnus-article-button-next-page (arg)
3219   "Go to the next page."
3220   (interactive "P")
3221   (let ((win (selected-window)))
3222     (select-window (get-buffer-window gnus-article-buffer t))
3223     (gnus-article-next-page)
3224     (select-window win)))
3225
3226 (defun gnus-article-button-prev-page (arg)
3227   "Go to the prev page."
3228   (interactive "P")
3229   (let ((win (selected-window)))
3230     (select-window (get-buffer-window gnus-article-buffer t))
3231     (gnus-article-prev-page)
3232     (select-window win)))
3233
3234
3235 ;;; @ for mime-view
3236 ;;;
3237
3238 (defun gnus-article-header-presentation-method (entity situation)
3239   (mime-insert-decoded-header entity nil nil default-mime-charset)
3240   )
3241
3242 (set-alist 'mime-header-presentation-method-alist
3243            'gnus-original-article-mode
3244            #'gnus-article-header-presentation-method)
3245
3246 (defun mime-preview-quitting-method-for-gnus ()
3247   (if (not gnus-show-mime)
3248       (mime-preview-kill-buffer))
3249   (delete-other-windows)
3250   (gnus-article-show-summary)
3251   (if (or (not gnus-show-mime)
3252           (null gnus-have-all-headers))
3253       (gnus-summary-select-article nil t)
3254     ))
3255
3256 (set-alist 'mime-raw-representation-type-alist
3257            'gnus-original-article-mode 'binary)
3258
3259 (set-alist 'mime-preview-quitting-method-alist
3260            'gnus-original-article-mode
3261            #'mime-preview-quitting-method-for-gnus)
3262
3263 (set-alist 'mime-view-show-summary-method
3264            'gnus-original-article-mode
3265            #'mime-preview-quitting-method-for-gnus)
3266
3267 (defun gnus-following-method (buf)
3268   (set-buffer buf)
3269   (message-followup)
3270   (message-yank-original)
3271   (kill-buffer buf)
3272   (goto-char (point-min))
3273   )
3274
3275 (set-alist 'mime-preview-following-method-alist
3276            'gnus-original-article-mode #'gnus-following-method)
3277
3278
3279 ;;; @ end
3280 ;;;
3281
3282 (gnus-ems-redefine)
3283
3284 (provide 'gnus-art)
3285
3286 (run-hooks 'gnus-art-load-hook)
3287
3288 ;;; gnus-art.el ends here