Synch with Oort Gnus.
[elisp/gnus.git-] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
4
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
8 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
9 ;; Keywords: news, mail
10
11 ;; This file is part of GNU Emacs.
12
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
27
28 ;;; Commentary:
29
30 ;;; Code:
31
32 (eval '(run-hooks 'gnus-load-hook))
33
34 (eval-when-compile (require 'cl))
35 (eval-when-compile (require 'static))
36
37 (require 'gnus-vers)
38
39 (defgroup gnus nil
40   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
41   :group 'news
42   :group 'mail)
43
44 (defgroup gnus-charset nil
45   "Group character set issues."
46   :link '(custom-manual "(gnus)Charsets")
47   :version "21.1"
48   :group 'gnus)
49
50 (defgroup gnus-cache nil
51   "Cache interface."
52   :group 'gnus)
53
54 (defgroup gnus-start nil
55   "Starting your favorite newsreader."
56   :group 'gnus)
57
58 (defgroup gnus-start-server nil
59   "Server options at startup."
60   :group 'gnus-start)
61
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
64   "Group buffers."
65   :link '(custom-manual "(gnus)The Group Buffer")
66   :group 'gnus)
67
68 (defgroup gnus-group-foreign nil
69   "Foreign groups."
70   :link '(custom-manual "(gnus)Foreign Groups")
71   :group 'gnus-group)
72
73 (defgroup gnus-group-new nil
74   "Automatic subscription of new groups."
75   :group 'gnus-group)
76
77 (defgroup gnus-group-levels nil
78   "Group levels."
79   :link '(custom-manual "(gnus)Group Levels")
80   :group 'gnus-group)
81
82 (defgroup gnus-group-select nil
83   "Selecting a Group."
84   :link '(custom-manual "(gnus)Selecting a Group")
85   :group 'gnus-group)
86
87 (defgroup gnus-group-listing nil
88   "Showing slices of the group list."
89   :link '(custom-manual "(gnus)Listing Groups")
90   :group 'gnus-group)
91
92 (defgroup gnus-group-visual nil
93   "Sorting the group buffer."
94   :link '(custom-manual "(gnus)Group Buffer Format")
95   :group 'gnus-group
96   :group 'gnus-visual)
97
98 (defgroup gnus-group-various nil
99   "Various group options."
100   :link '(custom-manual "(gnus)Scanning New Messages")
101   :group 'gnus-group)
102
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
105   "Summary buffers."
106   :link '(custom-manual "(gnus)The Summary Buffer")
107   :group 'gnus)
108
109 (defgroup gnus-summary-exit nil
110   "Leaving summary buffers."
111   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112   :group 'gnus-summary)
113
114 (defgroup gnus-summary-marks nil
115   "Marks used in summary buffers."
116   :link '(custom-manual "(gnus)Marking Articles")
117   :group 'gnus-summary)
118
119 (defgroup gnus-thread nil
120   "Ordering articles according to replies."
121   :link '(custom-manual "(gnus)Threading")
122   :group 'gnus-summary)
123
124 (defgroup gnus-summary-format nil
125   "Formatting of the summary buffer."
126   :link '(custom-manual "(gnus)Summary Buffer Format")
127   :group 'gnus-summary)
128
129 (defgroup gnus-summary-choose nil
130   "Choosing Articles."
131   :link '(custom-manual "(gnus)Choosing Articles")
132   :group 'gnus-summary)
133
134 (defgroup gnus-summary-maneuvering nil
135   "Summary movement commands."
136   :link '(custom-manual "(gnus)Summary Maneuvering")
137   :group 'gnus-summary)
138
139 (defgroup gnus-summary-mail nil
140   "Mail group commands."
141   :link '(custom-manual "(gnus)Mail Group Commands")
142   :group 'gnus-summary)
143
144 (defgroup gnus-summary-sort nil
145   "Sorting the summary buffer."
146   :link '(custom-manual "(gnus)Sorting")
147   :group 'gnus-summary)
148
149 (defgroup gnus-summary-visual nil
150   "Highlighting and menus in the summary buffer."
151   :link '(custom-manual "(gnus)Summary Highlighting")
152   :group 'gnus-visual
153   :group 'gnus-summary)
154
155 (defgroup gnus-summary-various nil
156   "Various summary buffer options."
157   :link '(custom-manual "(gnus)Various Summary Stuff")
158   :group 'gnus-summary)
159
160 (defgroup gnus-summary-pick nil
161   "Pick mode in the summary buffer."
162   :link '(custom-manual "(gnus)Pick and Read")
163   :prefix "gnus-pick-"
164   :group 'gnus-summary)
165
166 (defgroup gnus-summary-tree nil
167   "Tree display of threads in the summary buffer."
168   :link '(custom-manual "(gnus)Tree Display")
169   :prefix "gnus-tree-"
170   :group 'gnus-summary)
171
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174   "Viewing extracted files."
175   :link '(custom-manual "(gnus)Viewing Files")
176   :group 'gnus-extract)
177
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180   "Score and kill file handling."
181   :group 'gnus)
182
183 (defgroup gnus-score-kill nil
184   "Kill files."
185   :group 'gnus-score)
186
187 (defgroup gnus-score-adapt nil
188   "Adaptive score files."
189   :group 'gnus-score)
190
191 (defgroup gnus-score-default nil
192   "Default values for score files."
193   :group 'gnus-score)
194
195 (defgroup gnus-score-expire nil
196   "Expiring score rules."
197   :group 'gnus-score)
198
199 (defgroup gnus-score-decay nil
200   "Decaying score rules."
201   :group 'gnus-score)
202
203 (defgroup gnus-score-files nil
204   "Score and kill file names."
205   :group 'gnus-score
206   :group 'gnus-files)
207
208 (defgroup gnus-score-various nil
209   "Various scoring and killing options."
210   :group 'gnus-score)
211
212 ;; Other
213 (defgroup gnus-visual nil
214   "Options controling the visual fluff."
215   :group 'gnus
216   :group 'faces)
217
218 (defgroup gnus-agent nil
219   "Offline support for Gnus."
220   :group 'gnus)
221
222 (defgroup gnus-files nil
223   "Files used by Gnus."
224   :group 'gnus)
225
226 (defgroup gnus-dribble-file nil
227   "Auto save file."
228   :link '(custom-manual "(gnus)Auto Save")
229   :group 'gnus-files)
230
231 (defgroup gnus-newsrc nil
232   "Storing Gnus state."
233   :group 'gnus-files)
234
235 (defgroup gnus-server nil
236   "Options related to newsservers and other servers used by Gnus."
237   :group 'gnus)
238
239 (defgroup gnus-message '((message custom-group))
240   "Composing replies and followups in Gnus."
241   :group 'gnus)
242
243 (defgroup gnus-meta nil
244   "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
247   :group 'gnus)
248
249 (defgroup gnus-various nil
250   "Other Gnus options."
251   :link '(custom-manual "(gnus)Various Various")
252   :group 'gnus)
253
254 (defgroup gnus-mime nil
255   "Variables for controlling the Gnus MIME interface."
256   :group 'gnus)
257
258 (defgroup gnus-exit nil
259   "Exiting gnus."
260   :link '(custom-manual "(gnus)Exiting Gnus")
261   :group 'gnus)
262
263 (defcustom gnus-inhibit-startup-message nil
264   "If non-nil, the startup message will not be displayed.
265 This variable is used before `.gnus.el' is loaded, so it should
266 be set in `.emacs' instead."
267   :group 'gnus-start
268   :type 'boolean)
269
270 (defcustom gnus-play-startup-jingle nil
271   "If non-nil, play the Gnus jingle at startup."
272   :group 'gnus-start
273   :type 'boolean)
274
275 (unless (fboundp 'gnus-group-remove-excess-properties)
276   (defalias 'gnus-group-remove-excess-properties 'ignore))
277
278 (unless (fboundp 'gnus-set-text-properties)
279   (defalias 'gnus-set-text-properties 'set-text-properties))
280
281 (unless (featurep 'gnus-xmas)
282   (defalias 'gnus-make-overlay 'make-overlay)
283   (defalias 'gnus-delete-overlay 'delete-overlay)
284   (defalias 'gnus-overlay-put 'overlay-put)
285   (defalias 'gnus-move-overlay 'move-overlay)
286   (defalias 'gnus-overlay-buffer 'overlay-buffer)
287   (defalias 'gnus-overlay-start 'overlay-start)
288   (defalias 'gnus-overlay-end 'overlay-end)
289   (defalias 'gnus-extent-detached-p 'ignore)
290   (defalias 'gnus-extent-start-open 'ignore)
291   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
292   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
293   (defalias 'gnus-character-to-event 'identity)
294   (defalias 'gnus-add-text-properties 'add-text-properties)
295   (defalias 'gnus-put-text-property 'put-text-property)
296   (defvar gnus-mode-line-image-cache t)
297   (if (fboundp 'find-image)
298       (defun gnus-mode-line-buffer-identification (line)
299         (let ((str (car-safe line)))
300           (if (and (stringp str)
301                    (string-match "^Gnus:" str))
302               (progn (add-text-properties
303                       0 5
304                       (list 'display
305                             (if (eq t gnus-mode-line-image-cache)
306                                 (setq gnus-mode-line-image-cache
307                                       (find-image
308                                        '((:type xpm :file "gnus-pointer.xpm"
309                                                 :ascent center)
310                                          (:type xbm :file "gnus-pointer.xbm"
311                                                 :ascent center))))
312                               gnus-mode-line-image-cache)
313                             'help-echo "This is Gnus")
314                       str)
315                      (list str))
316             line)))
317     (defalias 'gnus-mode-line-buffer-identification 'identity))
318   (defalias 'gnus-characterp 'numberp)
319   (defalias 'gnus-deactivate-mark 'deactivate-mark)
320   (defalias 'gnus-window-edges 'window-edges)
321   (defalias 'gnus-key-press-event-p 'numberp)
322   ;;(defalias 'gnus-decode-rfc1522 'ignore)
323   )
324
325 ;; We define these group faces here to avoid the display
326 ;; update forced when creating new faces.
327
328 (defface gnus-group-news-1-face
329   '((((class color)
330       (background dark))
331      (:foreground "PaleTurquoise" :bold t))
332     (((class color)
333       (background light))
334      (:foreground "ForestGreen" :bold t))
335     (t
336      ()))
337   "Level 1 newsgroup face.")
338
339 (defface gnus-group-news-1-empty-face
340   '((((class color)
341       (background dark))
342      (:foreground "PaleTurquoise"))
343     (((class color)
344       (background light))
345      (:foreground "ForestGreen"))
346     (t
347      ()))
348   "Level 1 empty newsgroup face.")
349
350 (defface gnus-group-news-2-face
351   '((((class color)
352       (background dark))
353      (:foreground "turquoise" :bold t))
354     (((class color)
355       (background light))
356      (:foreground "CadetBlue4" :bold t))
357     (t
358      ()))
359   "Level 2 newsgroup face.")
360
361 (defface gnus-group-news-2-empty-face
362   '((((class color)
363       (background dark))
364      (:foreground "turquoise"))
365     (((class color)
366       (background light))
367      (:foreground "CadetBlue4"))
368     (t
369      ()))
370   "Level 2 empty newsgroup face.")
371
372 (defface gnus-group-news-3-face
373   '((((class color)
374       (background dark))
375      (:bold t))
376     (((class color)
377       (background light))
378      (:bold t))
379     (t
380      ()))
381   "Level 3 newsgroup face.")
382
383 (defface gnus-group-news-3-empty-face
384   '((((class color)
385       (background dark))
386      ())
387     (((class color)
388       (background light))
389      ())
390     (t
391      ()))
392   "Level 3 empty newsgroup face.")
393
394 (defface gnus-group-news-4-face
395   '((((class color)
396       (background dark))
397      (:bold t))
398     (((class color)
399       (background light))
400      (:bold t))
401     (t
402      ()))
403   "Level 4 newsgroup face.")
404
405 (defface gnus-group-news-4-empty-face
406   '((((class color)
407       (background dark))
408      ())
409     (((class color)
410       (background light))
411      ())
412     (t
413      ()))
414   "Level 4 empty newsgroup face.")
415
416 (defface gnus-group-news-5-face
417   '((((class color)
418       (background dark))
419      (:bold t))
420     (((class color)
421       (background light))
422      (:bold t))
423     (t
424      ()))
425   "Level 5 newsgroup face.")
426
427 (defface gnus-group-news-5-empty-face
428   '((((class color)
429       (background dark))
430      ())
431     (((class color)
432       (background light))
433      ())
434     (t
435      ()))
436   "Level 5 empty newsgroup face.")
437
438 (defface gnus-group-news-6-face
439   '((((class color)
440       (background dark))
441      (:bold t))
442     (((class color)
443       (background light))
444      (:bold t))
445     (t
446      ()))
447   "Level 6 newsgroup face.")
448
449 (defface gnus-group-news-6-empty-face
450   '((((class color)
451       (background dark))
452      ())
453     (((class color)
454       (background light))
455      ())
456     (t
457      ()))
458   "Level 6 empty newsgroup face.")
459
460 (defface gnus-group-news-low-face
461   '((((class color)
462       (background dark))
463      (:foreground "DarkTurquoise" :bold t))
464     (((class color)
465       (background light))
466      (:foreground "DarkGreen" :bold t))
467     (t
468      ()))
469   "Low level newsgroup face.")
470
471 (defface gnus-group-news-low-empty-face
472   '((((class color)
473       (background dark))
474      (:foreground "DarkTurquoise"))
475     (((class color)
476       (background light))
477      (:foreground "DarkGreen"))
478     (t
479      ()))
480   "Low level empty newsgroup face.")
481
482 (defface gnus-group-mail-1-face
483   '((((class color)
484       (background dark))
485      (:foreground "aquamarine1" :bold t))
486     (((class color)
487       (background light))
488      (:foreground "DeepPink3" :bold t))
489     (t
490      (:bold t)))
491   "Level 1 mailgroup face.")
492
493 (defface gnus-group-mail-1-empty-face
494   '((((class color)
495       (background dark))
496      (:foreground "aquamarine1"))
497     (((class color)
498       (background light))
499      (:foreground "DeepPink3"))
500     (t
501      (:italic t :bold t)))
502   "Level 1 empty mailgroup face.")
503
504 (defface gnus-group-mail-2-face
505   '((((class color)
506       (background dark))
507      (:foreground "aquamarine2" :bold t))
508     (((class color)
509       (background light))
510      (:foreground "HotPink3" :bold t))
511     (t
512      (:bold t)))
513   "Level 2 mailgroup face.")
514
515 (defface gnus-group-mail-2-empty-face
516   '((((class color)
517       (background dark))
518      (:foreground "aquamarine2"))
519     (((class color)
520       (background light))
521      (:foreground "HotPink3"))
522     (t
523      (:bold t)))
524   "Level 2 empty mailgroup face.")
525
526 (defface gnus-group-mail-3-face
527   '((((class color)
528       (background dark))
529      (:foreground "aquamarine3" :bold t))
530     (((class color)
531       (background light))
532      (:foreground "magenta4" :bold t))
533     (t
534      (:bold t)))
535   "Level 3 mailgroup face.")
536
537 (defface gnus-group-mail-3-empty-face
538   '((((class color)
539       (background dark))
540      (:foreground "aquamarine3"))
541     (((class color)
542       (background light))
543      (:foreground "magenta4"))
544     (t
545      ()))
546   "Level 3 empty mailgroup face.")
547
548 (defface gnus-group-mail-low-face
549   '((((class color)
550       (background dark))
551      (:foreground "aquamarine4" :bold t))
552     (((class color)
553       (background light))
554      (:foreground "DeepPink4" :bold t))
555     (t
556      (:bold t)))
557   "Low level mailgroup face.")
558
559 (defface gnus-group-mail-low-empty-face
560   '((((class color)
561       (background dark))
562      (:foreground "aquamarine4"))
563     (((class color)
564       (background light))
565      (:foreground "DeepPink4"))
566     (t
567      (:bold t)))
568   "Low level empty mailgroup face.")
569
570 ;; Summary mode faces.
571
572 (defface gnus-summary-selected-face '((t
573                                        (:underline t)))
574   "Face used for selected articles.")
575
576 (defface gnus-summary-cancelled-face
577   '((((class color))
578      (:foreground "yellow" :background "black")))
579   "Face used for cancelled articles.")
580
581 (defface gnus-summary-high-ticked-face
582   '((((class color)
583       (background dark))
584      (:foreground "pink" :bold t))
585     (((class color)
586       (background light))
587      (:foreground "firebrick" :bold t))
588     (t
589      (:bold t)))
590   "Face used for high interest ticked articles.")
591
592 (defface gnus-summary-low-ticked-face
593   '((((class color)
594       (background dark))
595      (:foreground "pink" :italic t))
596     (((class color)
597       (background light))
598      (:foreground "firebrick" :italic t))
599     (t
600      (:italic t)))
601   "Face used for low interest ticked articles.")
602
603 (defface gnus-summary-normal-ticked-face
604   '((((class color)
605       (background dark))
606      (:foreground "pink"))
607     (((class color)
608       (background light))
609      (:foreground "firebrick"))
610     (t
611      ()))
612   "Face used for normal interest ticked articles.")
613
614 (defface gnus-summary-high-ancient-face
615   '((((class color)
616       (background dark))
617      (:foreground "SkyBlue" :bold t))
618     (((class color)
619       (background light))
620      (:foreground "RoyalBlue" :bold t))
621     (t
622      (:bold t)))
623   "Face used for high interest ancient articles.")
624
625 (defface gnus-summary-low-ancient-face
626   '((((class color)
627       (background dark))
628      (:foreground "SkyBlue" :italic t))
629     (((class color)
630       (background light))
631      (:foreground "RoyalBlue" :italic t))
632     (t
633      (:italic t)))
634   "Face used for low interest ancient articles.")
635
636 (defface gnus-summary-normal-ancient-face
637   '((((class color)
638       (background dark))
639      (:foreground "SkyBlue"))
640     (((class color)
641       (background light))
642      (:foreground "RoyalBlue"))
643     (t
644      ()))
645   "Face used for normal interest ancient articles.")
646
647 (defface gnus-summary-high-unread-face
648   '((t
649      (:bold t)))
650   "Face used for high interest unread articles.")
651
652 (defface gnus-summary-low-unread-face
653   '((t
654      (:italic t)))
655   "Face used for low interest unread articles.")
656
657 (defface gnus-summary-normal-unread-face
658   '((t
659      ()))
660   "Face used for normal interest unread articles.")
661
662 (defface gnus-summary-incorporated-face
663   '((t
664      ()))
665   "Face used for incorporated articles.")
666
667 (defface gnus-summary-high-read-face
668   '((((class color)
669       (background dark))
670      (:foreground "PaleGreen"
671                   :bold t))
672     (((class color)
673       (background light))
674      (:foreground "DarkGreen"
675                   :bold t))
676     (t
677      (:bold t)))
678   "Face used for high interest read articles.")
679
680 (defface gnus-summary-low-read-face
681   '((((class color)
682       (background dark))
683      (:foreground "PaleGreen"
684                   :italic t))
685     (((class color)
686       (background light))
687      (:foreground "DarkGreen"
688                   :italic t))
689     (t
690      (:italic t)))
691   "Face used for low interest read articles.")
692
693 (defface gnus-summary-normal-read-face
694   '((((class color)
695       (background dark))
696      (:foreground "PaleGreen"))
697     (((class color)
698       (background light))
699      (:foreground "DarkGreen"))
700     (t
701      ()))
702   "Face used for normal interest read articles.")
703
704
705 ;;;
706 ;;; Gnus buffers
707 ;;;
708
709 (defvar gnus-buffers nil)
710
711 (defun gnus-get-buffer-create (name)
712   "Do the same as `get-buffer-create', but store the created buffer."
713   (or (get-buffer name)
714       (car (push (get-buffer-create name) gnus-buffers))))
715
716 (defun gnus-add-buffer ()
717   "Add the current buffer to the list of Gnus buffers."
718   (push (current-buffer) gnus-buffers))
719
720 (defun gnus-buffers ()
721   "Return a list of live Gnus buffers."
722   (while (and gnus-buffers
723               (not (buffer-name (car gnus-buffers))))
724     (pop gnus-buffers))
725   (let ((buffers gnus-buffers))
726     (while (cdr buffers)
727       (if (buffer-name (cadr buffers))
728           (pop buffers)
729         (setcdr buffers (cddr buffers)))))
730   gnus-buffers)
731
732 ;;; Splash screen.
733
734 (defvar gnus-group-buffer "*Group*")
735
736 (eval-and-compile
737   (autoload 'gnus-play-jingle "gnus-audio"))
738
739 (defface gnus-splash-face
740   '((((class color)
741       (background dark))
742      (:foreground "Brown"))
743     (((class color)
744       (background light))
745      (:foreground "Brown"))
746     (t
747      ()))
748   "Face of the splash screen.")
749
750 (defun gnus-splash ()
751   (save-excursion
752     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
753     (let ((buffer-read-only nil))
754       (erase-buffer)
755       (unless gnus-inhibit-startup-message
756         (gnus-group-startup-message)
757         (sit-for 0)
758         (when gnus-play-startup-jingle
759           (gnus-play-jingle))))))
760
761 (defun gnus-indent-rigidly (start end arg)
762   "Indent rigidly using only spaces and no tabs."
763   (save-excursion
764     (save-restriction
765       (narrow-to-region start end)
766       (let ((tab-width 8))
767         (indent-rigidly start end arg)
768         ;; We translate tabs into spaces -- not everybody uses
769         ;; an 8-character tab.
770         (goto-char (point-min))
771         (while (search-forward "\t" nil t)
772           (replace-match "        " t t))))))
773
774 (defvar gnus-simple-splash nil)
775
776 (defun gnus-group-startup-message (&optional x y)
777   "Insert startup message in current buffer."
778   ;; Insert the message.
779   (erase-buffer)
780   (cond
781    ((and (fboundp 'find-image)
782          (display-graphic-p)
783          (let* ((bg (face-background 'default))
784                 (fg (face-foreground 'gnus-splash-face))
785                 (image (find-image
786                         `((:type xpm :file "gnus.xpm"
787                                  :color-symbols (("thing" . "#724214")
788                                                  ("shadow" . "#1e3f03")
789                                                  ("background" . ,bg)))
790                           (:type pbm :file "gnus.pbm"
791                                  ;; Account for the pbm's blackground.
792                                  :background ,bg :foreground ,fg)
793                           (:type xbm :file "gnus.xbm"
794                                  ;; Account for the xbm's blackground.
795                                  :background ,bg :foreground ,fg)))))
796            (when image
797              (insert
798               (propertize
799                (concat gnus-product-name " " gnus-version-number
800                        (if (zerop (string-to-number gnus-revision-number))
801                            ""
802                          (concat " (r" gnus-revision-number ")"))
803                        " based on " gnus-original-product-name " v"
804                        gnus-original-version-number)
805                'face `(variable-pitch :background ,bg :foreground ,fg)))
806              (let ((fill-column (window-width)))
807                (center-region (point-min) (point)))
808              (let ((size (image-size image)))
809                (insert-char ?\n (max 1 (round (- (window-height)
810                                                  (or y (cdr size))) 2)))
811                (insert
812                 (propertize " " 'display
813                             `(space :align-to
814                                     ,(max 0 (round (- (window-width)
815                                                       (or x (car size))) 2)))))
816                (insert-image image))
817              (setq gnus-simple-splash nil)
818              t))))
819    (t
820     (insert "
821           _    ___ _             _
822           _ ___ __ ___  __    _ ___
823           __   _     ___    __  ___
824               _           ___     _
825              _  _ __             _
826              ___   __            _
827                    __           _
828                     _      _   _
829                    _      _    _
830                       _  _    _
831                   __  ___
832                  _   _ _     _
833                 _   _
834               _    _
835              _    _
836             _
837           __
838
839 "
840             )
841     (goto-char (point-min))
842     (insert gnus-product-name " " gnus-version-number
843             (if (zerop (string-to-number gnus-revision-number))
844                 ""
845               (concat " (r" gnus-revision-number ")"))
846             " based on " gnus-original-product-name " v"
847             gnus-original-version-number)
848     (insert-char ?\  (prog1
849                          (max 0 (/ (- (window-width) (point)) 2))
850                        (goto-char (point-min))))
851     (forward-line 1)
852     ;; And then hack it.
853     (gnus-indent-rigidly (point) (point-max)
854                          (/ (max (- (window-width) (or x 46)) 0) 2))
855     (goto-char (point-min))
856     (forward-line 1)
857     (let* ((pheight (count-lines (point-min) (point-max)))
858            (wheight (window-height))
859            (rest (- wheight pheight)))
860       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
861     ;; Fontify some.
862     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
863     (setq gnus-simple-splash t)))
864   (goto-char (point-min))
865   (setq mode-line-buffer-identification (concat " " gnus-version))
866   (set-buffer-modified-p t))
867
868 (eval-when (load)
869   (let ((command (format "%s" this-command)))
870     (if (and (string-match "gnus" command)
871              (not (string-match "gnus-other-frame" command)))
872         (gnus-splash)
873       (gnus-get-buffer-create gnus-group-buffer))))
874
875 ;;; Do the rest.
876
877 (require 'gnus-util)
878 (require 'nnheader)
879
880 (defcustom gnus-home-directory "~/"
881   "Directory variable that specifies the \"home\" directory.
882 All other Gnus path variables are initialized from this variable."
883   :group 'gnus-files
884   :type 'directory)
885
886 (defcustom gnus-directory (or (getenv "SAVEDIR")
887                               (nnheader-concat gnus-home-directory "News/"))
888   "*Directory variable from which all other Gnus file variables are derived.
889
890 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
891 This means that other directory variables that are initialized from
892 this variable won't be set properly if you set this variable in `.gnus.el'.
893 Set this variable in `.emacs' instead."
894   :group 'gnus-files
895   :type 'directory)
896
897 (defcustom gnus-default-directory nil
898   "*Default directory for all Gnus buffers."
899   :group 'gnus-files
900   :type '(choice (const :tag "current" nil)
901                  directory))
902
903 ;; Site dependent variables.  These variables should be defined in
904 ;; paths.el.
905
906 (defvar gnus-default-nntp-server nil
907   "Specify a default NNTP server.
908 This variable should be defined in paths.el, and should never be set
909 by the user.
910 If you want to change servers, you should use `gnus-select-method'.
911 See the documentation to that variable.")
912
913 ;; Don't touch this variable.
914 (defvar gnus-nntp-service "nntp"
915   "NNTP service name (\"nntp\" or 119).
916 This is an obsolete variable, which is scarcely used.  If you use an
917 nntp server for your newsgroup and want to change the port number
918 used to 899, you would say something along these lines:
919
920  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
921
922 (defcustom gnus-nntpserver-file "/etc/nntpserver"
923   "A file with only the name of the nntp server in it."
924   :group 'gnus-files
925   :group 'gnus-server
926   :type 'file)
927
928 ;; This function is used to check both the environment variable
929 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
930 ;; an nntp server name default.
931 (defun gnus-getenv-nntpserver ()
932   (or (getenv "NNTPSERVER")
933       (and (file-readable-p gnus-nntpserver-file)
934            (save-excursion
935              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
936              (insert-file-contents gnus-nntpserver-file)
937              (let ((name (buffer-string)))
938                (prog1
939                    (if (string-match "\\'[ \t\n]*$" name)
940                        nil
941                      name)
942                  (kill-buffer (current-buffer))))))))
943
944 (defcustom gnus-select-method
945   (condition-case nil
946       (nconc
947        (list 'nntp (or (condition-case nil
948                            (gnus-getenv-nntpserver)
949                          (error nil))
950                        (when (and gnus-default-nntp-server
951                                   (not (string= gnus-default-nntp-server "")))
952                          gnus-default-nntp-server)
953                        "news"))
954        (if (or (null gnus-nntp-service)
955                (equal gnus-nntp-service "nntp"))
956            nil
957          (list gnus-nntp-service)))
958     (error nil))
959   "Default method for selecting a newsgroup.
960 This variable should be a list, where the first element is how the
961 news is to be fetched, the second is the address.
962
963 For instance, if you want to get your news via NNTP from
964 \"flab.flab.edu\", you could say:
965
966 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
967
968 If you want to use your local spool, say:
969
970 \(setq gnus-select-method (list 'nnspool (system-name)))
971
972 If you use this variable, you must set `gnus-nntp-server' to nil.
973
974 There is a lot more to know about select methods and virtual servers -
975 see the manual for details."
976   :group 'gnus-server
977   :type 'gnus-select-method)
978
979 (defcustom gnus-message-archive-method
980   (progn
981     ;; Don't require it at top level to avoid circularity.
982     (require 'message)
983     `(nnfolder
984       "archive"
985       (nnfolder-directory ,(nnheader-concat message-directory "archive"))
986       (nnfolder-active-file
987        ,(nnheader-concat message-directory "archive/active"))
988       (nnfolder-get-new-mail nil)
989       (nnfolder-inhibit-expiry t)))
990   "*Method used for archiving messages you've sent.
991 This should be a mail method.
992
993 It's probably not very effective to change this variable once you've
994 run Gnus once.  After doing that, you must edit this server from the
995 server buffer."
996   :group 'gnus-server
997   :group 'gnus-message
998   :type 'gnus-select-method)
999
1000 (defcustom gnus-message-archive-group nil
1001   "*Name of the group in which to save the messages you've written.
1002 This can either be a string; a list of strings; or an alist
1003 of regexps/functions/forms to be evaluated to return a string (or a list
1004 of strings).  The functions are called with the name of the current
1005 group (or nil) as a parameter.
1006
1007 If you want to save your mail in one group and the news articles you
1008 write in another group, you could say something like:
1009
1010  \(setq gnus-message-archive-group
1011         '((if (message-news-p)
1012               \"misc-news\"
1013             \"misc-mail\")))
1014
1015 Normally the group names returned by this variable should be
1016 unprefixed -- which implicitly means \"store on the archive server\".
1017 However, you may wish to store the message on some other server.  In
1018 that case, just return a fully prefixed name of the group --
1019 \"nnml+private:mail.misc\", for instance."
1020   :group 'gnus-message
1021   :type '(choice (const :tag "none" nil)
1022                  function
1023                  sexp
1024                  string))
1025
1026 (defcustom gnus-secondary-servers nil
1027   "List of NNTP servers that the user can choose between interactively.
1028 To make Gnus query you for a server, you have to give `gnus' a
1029 non-numeric prefix - `C-u M-x gnus', in short."
1030   :group 'gnus-server
1031   :type '(repeat string))
1032
1033 (defcustom gnus-nntp-server nil
1034   "*The name of the host running the NNTP server.
1035 This variable is semi-obsolete.  Use the `gnus-select-method'
1036 variable instead."
1037   :group 'gnus-server
1038   :type '(choice (const :tag "disable" nil)
1039                  string))
1040
1041 (defcustom gnus-secondary-select-methods nil
1042   "A list of secondary methods that will be used for reading news.
1043 This is a list where each element is a complete select method (see
1044 `gnus-select-method').
1045
1046 If, for instance, you want to read your mail with the nnml backend,
1047 you could set this variable:
1048
1049 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1050   :group 'gnus-server
1051   :type '(repeat gnus-select-method))
1052
1053 (defvar gnus-backup-default-subscribed-newsgroups
1054   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1055   "Default default new newsgroups the first time Gnus is run.
1056 Should be set in paths.el, and shouldn't be touched by the user.")
1057
1058 (defcustom gnus-local-domain nil
1059   "Local domain name without a host name.
1060 The DOMAINNAME environment variable is used instead if it is defined.
1061 If the `system-name' function returns the full Internet name, there is
1062 no need to set this variable."
1063   :group 'gnus-message
1064   :type '(choice (const :tag "default" nil)
1065                  string))
1066
1067 (defvar gnus-local-organization nil
1068   "String with a description of what organization (if any) the user belongs to.
1069 Obsolete variable; use `message-user-organization' instead.")
1070
1071 ;; Customization variables
1072
1073 (defcustom gnus-refer-article-method nil
1074   "Preferred method for fetching an article by Message-ID.
1075 If you are reading news from the local spool (with nnspool), fetching
1076 articles by Message-ID is painfully slow.  By setting this method to an
1077 nntp method, you might get acceptable results.
1078
1079 The value of this variable must be a valid select method as discussed
1080 in the documentation of `gnus-select-method'.
1081
1082 It can also be a list of select methods, as well as the special symbol
1083 `current', which means to use the current select method.  If it is a
1084 list, Gnus will try all the methods in the list until it finds a match."
1085   :group 'gnus-server
1086   :type '(choice (const :tag "default" nil)
1087                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1088                  gnus-select-method
1089                  (repeat :menu-tag "Try multiple"
1090                          :tag "Multiple"
1091                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1092                          (choice :tag "Method"
1093                                  (const current)
1094                                  (const :tag "DejaNews"
1095                                         (nnweb "refer" (nnweb-type dejanews)))
1096                                  gnus-select-method))))
1097
1098 (defcustom gnus-group-faq-directory
1099   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1100     "/ftp@sunsite.auc.dk:/pub/usenet/"
1101     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1102     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1103     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1104     "/ftp@rtfm.mit.edu:/pub/usenet/"
1105     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1106     "/ftp@ftp.sunet.se:/pub/usenet/"
1107     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1108     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1109     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1110   "*Directory where the group FAQs are stored.
1111 This will most commonly be on a remote machine, and the file will be
1112 fetched by ange-ftp.
1113
1114 This variable can also be a list of directories.  In that case, the
1115 first element in the list will be used by default.  The others can
1116 be used when being prompted for a site.
1117
1118 Note that Gnus uses an aol machine as the default directory.  If this
1119 feels fundamentally unclean, just think of it as a way to finally get
1120 something of value back from them.
1121
1122 If the default site is too slow, try one of these:
1123
1124    North America: mirrors.aol.com                /pub/rtfm/usenet
1125                   ftp.seas.gwu.edu               /pub/rtfm
1126                   rtfm.mit.edu                   /pub/usenet
1127    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1128                   src.doc.ic.ac.uk               /usenet/news-FAQS
1129                   ftp.sunet.se                   /pub/usenet
1130                   sunsite.auc.dk                 /pub/usenet
1131    Asia:          nctuccca.edu.tw                /USENET/FAQ
1132                   hwarang.postech.ac.kr          /pub/usenet
1133                   ftp.hk.super.net               /mirror/faqs"
1134   :group 'gnus-group-various
1135   :type '(choice directory
1136                  (repeat directory)))
1137
1138 (defcustom gnus-use-cross-reference t
1139   "*Non-nil means that cross referenced articles will be marked as read.
1140 If nil, ignore cross references.  If t, mark articles as read in
1141 subscribed newsgroups.  If neither t nor nil, mark as read in all
1142 newsgroups."
1143   :group 'gnus-server
1144   :type '(choice (const :tag "off" nil)
1145                  (const :tag "subscribed" t)
1146                  (sexp :format "all"
1147                        :value always)))
1148
1149 (defcustom gnus-process-mark ?#
1150   "*Process mark."
1151   :group 'gnus-group-visual
1152   :group 'gnus-summary-marks
1153   :type 'character)
1154
1155 (defcustom gnus-large-newsgroup 200
1156   "*The number of articles which indicates a large newsgroup.
1157 If the number of articles in a newsgroup is greater than this value,
1158 confirmation is required for selecting the newsgroup."
1159   :group 'gnus-group-select
1160   :type 'integer)
1161
1162 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1163   "*Non-nil means that the default name of a file to save articles in is the group name.
1164 If it's nil, the directory form of the group name is used instead.
1165
1166 If this variable is a list, and the list contains the element
1167 `not-score', long file names will not be used for score files; if it
1168 contains the element `not-save', long file names will not be used for
1169 saving; and if it contains the element `not-kill', long file names
1170 will not be used for kill files.
1171
1172 Note that the default for this variable varies according to what system
1173 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1174 to nil while on all other systems it defaults to t."
1175   :group 'gnus-start
1176   :type 'boolean)
1177
1178 (defcustom gnus-kill-files-directory gnus-directory
1179   "*Name of the directory where kill files will be stored (default \"~/News\")."
1180   :group 'gnus-score-files
1181   :group 'gnus-score-kill
1182   :type 'directory)
1183
1184 (defcustom gnus-save-score nil
1185   "*If non-nil, save group scoring info."
1186   :group 'gnus-score-various
1187   :group 'gnus-start
1188   :type 'boolean)
1189
1190 (defcustom gnus-use-undo t
1191   "*If non-nil, allow undoing in Gnus group mode buffers."
1192   :group 'gnus-meta
1193   :type 'boolean)
1194
1195 (defcustom gnus-use-adaptive-scoring nil
1196   "*If non-nil, use some adaptive scoring scheme.
1197 If a list, then the values `word' and `line' are meaningful.  The
1198 former will perform adaption on individual words in the subject
1199 header while `line' will perform adaption on several headers."
1200   :group 'gnus-meta
1201   :group 'gnus-score-adapt
1202   :type '(set (const word) (const line)))
1203
1204 (defcustom gnus-use-cache 'passive
1205   "*If nil, Gnus will ignore the article cache.
1206 If `passive', it will allow entering (and reading) articles
1207 explicitly entered into the cache.  If anything else, use the
1208 cache to the full extent of the law."
1209   :group 'gnus-meta
1210   :group 'gnus-cache
1211   :type '(choice (const :tag "off" nil)
1212                  (const :tag "passive" passive)
1213                  (const :tag "active" t)))
1214
1215 (defcustom gnus-use-trees nil
1216   "*If non-nil, display a thread tree buffer."
1217   :group 'gnus-meta
1218   :type 'boolean)
1219
1220 (defcustom gnus-use-grouplens nil
1221   "*If non-nil, use GroupLens ratings."
1222   :group 'gnus-meta
1223   :type 'boolean)
1224
1225 (defcustom gnus-keep-backlog nil
1226   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1227 If it is a number N, then Gnus will only keep the last N articles
1228 read.  If it is neither nil nor a number, Gnus will keep all read
1229 articles.  This is not a good idea."
1230   :group 'gnus-meta
1231   :type '(choice (const :tag "off" nil)
1232                  integer
1233                  (sexp :format "all"
1234                        :value t)))
1235
1236 (defcustom gnus-use-nocem nil
1237   "*If non-nil, Gnus will read NoCeM cancel messages."
1238   :group 'gnus-meta
1239   :type 'boolean)
1240
1241 (defcustom gnus-suppress-duplicates nil
1242   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1243   :group 'gnus-meta
1244   :type 'boolean)
1245
1246 (defcustom gnus-use-scoring t
1247   "*If non-nil, enable scoring."
1248   :group 'gnus-meta
1249   :type 'boolean)
1250
1251 (defcustom gnus-use-picons nil
1252   "*If non-nil, display picons in a frame of their own."
1253   :group 'gnus-meta
1254   :type 'boolean)
1255
1256 (defcustom gnus-summary-prepare-exit-hook
1257   '(gnus-summary-expire-articles)
1258   "*A hook called when preparing to exit from the summary buffer.
1259 It calls `gnus-summary-expire-articles' by default."
1260   :group 'gnus-summary-exit
1261   :type 'hook)
1262
1263 (defcustom gnus-novice-user t
1264   "*Non-nil means that you are a usenet novice.
1265 If non-nil, verbose messages may be displayed and confirmations may be
1266 required."
1267   :group 'gnus-meta
1268   :type 'boolean)
1269
1270 (defcustom gnus-expert-user nil
1271   "*Non-nil means that you will never be asked for confirmation about anything.
1272 That doesn't mean *anything* anything; particularly destructive
1273 commands will still require prompting."
1274   :group 'gnus-meta
1275   :type 'boolean)
1276
1277 (defcustom gnus-interactive-catchup t
1278   "*If non-nil, require your confirmation when catching up a group."
1279   :group 'gnus-group-select
1280   :type 'boolean)
1281
1282 (defcustom gnus-interactive-exit t
1283   "*If non-nil, require your confirmation when exiting Gnus."
1284   :group 'gnus-exit
1285   :type 'boolean)
1286
1287 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1288   "*Function for extracting address components from a From header.
1289 Two pre-defined function exist: `gnus-extract-address-components',
1290 which is the default, quite fast, and too simplistic solution, and
1291 `mail-extract-address-components', which works much better, but is
1292 slower."
1293   :group 'gnus-summary-format
1294   :type '(radio (function-item gnus-extract-address-components)
1295                 (function-item mail-extract-address-components)
1296                 (function-item std11-extract-address-components)
1297                 (function :tag "Other")))
1298
1299 (defcustom gnus-carpal nil
1300   "*If non-nil, display clickable icons."
1301   :group 'gnus-meta
1302   :type 'boolean)
1303
1304 (defcustom gnus-shell-command-separator ";"
1305   "String used to separate to shell commands."
1306   :group 'gnus-files
1307   :type 'string)
1308
1309 (defcustom gnus-valid-select-methods
1310   '(("nntp" post address prompt-address physical-address)
1311     ("nnspool" post address)
1312     ("nnvirtual" post-mail virtual prompt-address)
1313     ("nnmbox" mail respool address)
1314     ("nnml" mail respool address)
1315     ("nnmh" mail respool address)
1316     ("nndir" post-mail prompt-address physical-address)
1317     ("nneething" none address prompt-address physical-address)
1318     ("nndoc" none address prompt-address)
1319     ("nnbabyl" mail address respool)
1320     ("nnkiboze" post virtual)
1321     ("nnsoup" post-mail address)
1322     ("nndraft" post-mail)
1323     ("nnfolder" mail respool address)
1324     ("nngateway" post-mail address prompt-address physical-address)
1325     ("nnweb" none)
1326     ("nnslashdot" post)
1327     ("nnultimate" none)
1328     ("nnwfm" none)
1329     ("nnwarchive" none)
1330     ("nnlistserv" none)
1331     ("nnagent" post-mail)
1332     ("nnimap" post-mail address prompt-address physical-address))
1333   "*An alist of valid select methods.
1334 The first element of each list lists should be a string with the name
1335 of the select method.  The other elements may be the category of
1336 this method (i. e., `post', `mail', `none' or whatever) or other
1337 properties that this method has (like being respoolable).
1338 If you implement a new select method, all you should have to change is
1339 this variable.  I think."
1340   :group 'gnus-server
1341   :type '(repeat (group (string :tag "Name")
1342                         (radio-button-choice (const :format "%v " post)
1343                                              (const :format "%v " mail)
1344                                              (const :format "%v " none)
1345                                              (const post-mail))
1346                         (checklist :inline t
1347                                    (const :format "%v " address)
1348                                    (const :format "%v " prompt-address)
1349                                    (const :format "%v " physical-address)
1350                                    (const :format "%v " virtual)
1351                                    (const respool)))))
1352
1353 (defun gnus-redefine-select-method-widget ()
1354   "Recomputes the select-method widget based on the value of
1355 `gnus-valid-select-methods'."
1356   (define-widget 'gnus-select-method 'list
1357     "Widget for entering a select method."
1358     :value '(nntp "")
1359     :tag "Select Method"
1360     :args `((choice :tag "Method"
1361                     ,@(mapcar (lambda (entry)
1362                                 (list 'const :format "%v\n"
1363                                       (intern (car entry))))
1364                               gnus-valid-select-methods)
1365                     (symbol :tag "other"))
1366             (string :tag "Address")
1367             (repeat :tag "Options"
1368                     :inline t
1369                     (list :format "%v"
1370                           variable
1371                           (sexp :tag "Value"))))))
1372
1373 (gnus-redefine-select-method-widget)
1374
1375 (defcustom gnus-updated-mode-lines '(group article summary tree)
1376   "List of buffers that should update their mode lines.
1377 The list may contain the symbols `group', `article', `tree' and
1378 `summary'.  If the corresponding symbol is present, Gnus will keep
1379 that mode line updated with information that may be pertinent.
1380 If this variable is nil, screen refresh may be quicker."
1381   :group 'gnus-various
1382   :type '(set (const group)
1383               (const article)
1384               (const summary)
1385               (const tree)))
1386
1387 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1388 (defcustom gnus-mode-non-string-length nil
1389   "*Max length of mode-line non-string contents.
1390 If this is nil, Gnus will take space as is needed, leaving the rest
1391 of the modeline intact.  Note that the default of nil is unlikely
1392 to be desirable; see the manual for further details."
1393   :group 'gnus-various
1394   :type '(choice (const nil)
1395                  integer))
1396
1397 (defcustom gnus-auto-expirable-newsgroups nil
1398   "*Groups in which to automatically mark read articles as expirable.
1399 If non-nil, this should be a regexp that should match all groups in
1400 which to perform auto-expiry.  This only makes sense for mail groups."
1401   :group 'nnmail-expire
1402   :type '(choice (const nil)
1403                  regexp))
1404
1405 (defcustom gnus-total-expirable-newsgroups nil
1406   "*Groups in which to perform expiry of all read articles.
1407 Use with extreme caution.  All groups that match this regexp will be
1408 expiring - which means that all read articles will be deleted after
1409 \(say) one week.         (This only goes for mail groups and the like, of
1410 course.)"
1411   :group 'nnmail-expire
1412   :type '(choice (const nil)
1413                  regexp))
1414
1415 (defcustom gnus-group-uncollapsed-levels 1
1416   "Number of group name elements to leave alone when making a short group name."
1417   :group 'gnus-group-visual
1418   :type 'integer)
1419
1420 (defcustom gnus-group-use-permanent-levels nil
1421   "*If non-nil, once you set a level, Gnus will use this level."
1422   :group 'gnus-group-levels
1423   :type 'boolean)
1424
1425 ;; Hooks.
1426
1427 (defcustom gnus-load-hook nil
1428   "A hook run while Gnus is loaded."
1429   :group 'gnus-start
1430   :type 'hook)
1431
1432 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1433   "A hook called to apply kill files to a group.
1434 This hook is intended to apply a kill file to the selected newsgroup.
1435 The function `gnus-apply-kill-file' is called by default.
1436
1437 Since a general kill file is too heavy to use only for a few
1438 newsgroups, I recommend you to use a lighter hook function.  For
1439 example, if you'd like to apply a kill file to articles which contains
1440 a string `rmgroup' in subject in newsgroup `control', you can use the
1441 following hook:
1442
1443  (setq gnus-apply-kill-hook
1444       (list
1445         (lambda ()
1446           (cond ((string-match \"control\" gnus-newsgroup-name)
1447                  (gnus-kill \"Subject\" \"rmgroup\")
1448                  (gnus-expunge \"X\"))))))"
1449   :group 'gnus-score-kill
1450   :options '(gnus-apply-kill-file)
1451   :type 'hook)
1452
1453 (defcustom gnus-group-change-level-function nil
1454   "Function run when a group level is changed.
1455 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1456   :group 'gnus-group-levels
1457   :type 'function)
1458
1459 ;;; Face thingies.
1460
1461 (defcustom gnus-visual
1462   '(summary-highlight group-highlight article-highlight
1463                       mouse-face
1464                       summary-menu group-menu article-menu
1465                       tree-highlight menu highlight
1466                       browse-menu server-menu
1467                       page-marker tree-menu binary-menu pick-menu
1468                       grouplens-menu)
1469   "*Enable visual features.
1470 If `visual' is disabled, there will be no menus and few faces.  Most of
1471 the visual customization options below will be ignored.  Gnus will use
1472 less space and be faster as a result.
1473
1474 This variable can also be a list of visual elements to switch on.  For
1475 instance, to switch off all visual things except menus, you can say:
1476
1477    (setq gnus-visual '(menu))
1478
1479 Valid elements include `summary-highlight', `group-highlight',
1480 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1481 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1482 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1483 and `grouplens-menu'."
1484   :group 'gnus-meta
1485   :group 'gnus-visual
1486   :type '(set (const summary-highlight)
1487               (const group-highlight)
1488               (const article-highlight)
1489               (const mouse-face)
1490               (const summary-menu)
1491               (const group-menu)
1492               (const article-menu)
1493               (const tree-highlight)
1494               (const menu)
1495               (const highlight)
1496               (const browse-menu)
1497               (const server-menu)
1498               (const page-marker)
1499               (const tree-menu)
1500               (const binary-menu)
1501               (const pick-menu)
1502               (const grouplens-menu)))
1503
1504 (defcustom gnus-mouse-face
1505   (condition-case ()
1506       (if (gnus-visual-p 'mouse-face 'highlight)
1507           (if (boundp 'gnus-mouse-face)
1508               (or gnus-mouse-face 'highlight)
1509             'highlight)
1510         'default)
1511     (error 'highlight))
1512   "*Face used for group or summary buffer mouse highlighting.
1513 The line beneath the mouse pointer will be highlighted with this
1514 face."
1515   :group 'gnus-visual
1516   :type 'face)
1517
1518 (defcustom gnus-article-save-directory gnus-directory
1519   "*Name of the directory articles will be saved in (default \"~/News\")."
1520   :group 'gnus-article-saving
1521   :type 'directory)
1522
1523 (defvar gnus-plugged t
1524   "Whether Gnus is plugged or not.")
1525
1526 (defcustom gnus-default-charset 'iso-8859-1
1527   "Default charset assumed to be used when viewing non-ASCII characters.
1528 This variable is overridden on a group-to-group basis by the
1529 gnus-group-charset-alist variable and is only used on groups not
1530 covered by that variable."
1531   :type 'symbol
1532   :group 'gnus-charset)
1533
1534 (defcustom gnus-default-posting-charset nil
1535   "Default charset assumed to be used when posting non-ASCII characters.
1536 This variable is overridden on a group-to-group basis by the
1537 gnus-group-posting-charset-alist variable and is only used on groups not
1538 covered by that variable.
1539 If nil, no default charset is assumed when posting."
1540   :type 'symbol
1541   :group 'gnus-charset)
1542
1543 \f
1544 ;;; Internal variables
1545
1546 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1547 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1548 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1549 (defvar gnus-original-article-buffer " *Original Article*")
1550 (defvar gnus-newsgroup-name nil)
1551 (defvar gnus-ephemeral-servers nil)
1552
1553 (defvar gnus-agent nil
1554   "Whether we want to use the Gnus agent or not.")
1555
1556 (defvar gnus-agent-fetching nil
1557   "Whether Gnus agent is in fetching mode.")
1558
1559 (defvar gnus-agent-fetching nil
1560   "Whether Gnus agent is in fetching mode.")
1561
1562 (defvar gnus-command-method nil
1563   "Dynamically bound variable that says what the current backend is.")
1564
1565 (defvar gnus-current-select-method nil
1566   "The current method for selecting a newsgroup.")
1567
1568 (defvar gnus-tree-buffer "*Tree*"
1569   "Buffer where Gnus thread trees are displayed.")
1570
1571 ;; Dummy variable.
1572 (defvar gnus-use-generic-from nil)
1573
1574 ;; Variable holding the user answers to all method prompts.
1575 (defvar gnus-method-history nil)
1576
1577 ;; Variable holding the user answers to all mail method prompts.
1578 (defvar gnus-mail-method-history nil)
1579
1580 ;; Variable holding the user answers to all group prompts.
1581 (defvar gnus-group-history nil)
1582
1583 (defvar gnus-server-alist nil
1584   "List of available servers.")
1585
1586 (defcustom gnus-cache-directory
1587   (nnheader-concat gnus-directory "cache/")
1588   "*The directory where cached articles will be stored."
1589   :group 'gnus-cache
1590   :type 'directory)
1591
1592 (defvar gnus-predefined-server-alist
1593   `(("cache"
1594      nnspool "cache"
1595      (nnspool-spool-directory ,gnus-cache-directory)
1596      (nnspool-nov-directory ,gnus-cache-directory)
1597      (nnspool-active-file
1598       ,(nnheader-concat gnus-cache-directory "active"))))
1599   "List of predefined (convenience) servers.")
1600
1601 (defvar gnus-topic-indentation "");; Obsolete variable.
1602
1603 (defconst gnus-article-mark-lists
1604   '((marked . tick) (replied . reply)
1605     (expirable . expire) (killed . killed)
1606     (bookmarks . bookmark) (dormant . dormant)
1607     (scored . score) (saved . save)
1608     (cached . cache) (downloadable . download)
1609     (unsendable . unsend)))
1610
1611 (defvar gnus-headers-retrieved-by nil)
1612 (defvar gnus-article-reply nil)
1613 (defvar gnus-override-method nil)
1614 (defvar gnus-article-check-size nil)
1615 (defvar gnus-opened-servers nil)
1616
1617 (defvar gnus-current-kill-article nil)
1618
1619 (defvar gnus-have-read-active-file nil)
1620
1621 (defconst gnus-maintainer
1622   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
1623   "The mail address of the T-gnus maintainers.")
1624
1625 (defcustom gnus-info-filename nil
1626   "*Controls language of gnus Info.
1627 If nil and current-language-environment is Japanese, go to gnus-ja.
1628 Otherwise go to corresponding Info.
1629 This variable can be nil, gnus or gnus-ja."
1630   :group 'gnus-start
1631   :type '(choice (const nil)
1632                  (const :tag "English" gnus)
1633                  (const :tag "Japanese" gnus-ja)))
1634
1635 (defvar gnus-info-nodes
1636   '((gnus-group-mode "The Group Buffer")
1637     (gnus-summary-mode "The Summary Buffer")
1638     (gnus-article-mode "The Article Buffer")
1639     (gnus-server-mode "The Server Buffer")
1640     (gnus-browse-mode "Browse Foreign Server")
1641     (gnus-tree-mode "Tree Display"))
1642   "Alist of major modes and related Info nodes.")
1643
1644 (defvar gnus-group-buffer "*Group*")
1645 (defvar gnus-summary-buffer "*Summary*")
1646 (defvar gnus-article-buffer "*Article*")
1647 (defvar gnus-server-buffer "*Server*")
1648
1649 (defvar gnus-slave nil
1650   "Whether this Gnus is a slave or not.")
1651
1652 (defvar gnus-batch-mode nil
1653   "Whether this Gnus is running in batch mode or not.")
1654
1655 (defvar gnus-variable-list
1656   '(gnus-newsrc-options gnus-newsrc-options-n
1657                         gnus-newsrc-last-checked-date
1658                         gnus-newsrc-alist gnus-server-alist
1659                         gnus-killed-list gnus-zombie-list
1660                         gnus-topic-topology gnus-topic-alist)
1661   "Gnus variables saved in the quick startup file.")
1662
1663 (defvar gnus-product-variable-file-list
1664   (let ((version (product-version (product-find 'gnus-vers)))
1665         (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1666     `(("strict-cache" ((product-version ,version) (emacs-version))
1667        binary
1668        gnus-format-specs-compiled)
1669       ("cache" ((product-version ,version) (emacs-version))
1670        ,codesys
1671        gnus-format-specs)))
1672   "Gnus variables are saved in the produce depend quick startup files.")
1673
1674 (defcustom gnus-compile-user-specs t
1675   "If non-nil, the user-defined format specs will be byte-compiled
1676 automatically.
1677 It has an effect on the values of `gnus-*-line-format-spec'."
1678   :group 'gnus
1679   :type 'boolean)
1680
1681 (defvar gnus-newsrc-alist nil
1682   "Assoc list of read articles.
1683 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1684
1685 (defvar gnus-newsrc-hashtb nil
1686   "Hashtable of gnus-newsrc-alist.")
1687
1688 (defvar gnus-killed-list nil
1689   "List of killed newsgroups.")
1690
1691 (defvar gnus-killed-hashtb nil
1692   "Hash table equivalent of gnus-killed-list.")
1693
1694 (defvar gnus-zombie-list nil
1695   "List of almost dead newsgroups.")
1696
1697 (defvar gnus-description-hashtb nil
1698   "Descriptions of newsgroups.")
1699
1700 (defvar gnus-list-of-killed-groups nil
1701   "List of newsgroups that have recently been killed by the user.")
1702
1703 (defvar gnus-active-hashtb nil
1704   "Hashtable of active articles.")
1705
1706 (defvar gnus-moderated-hashtb nil
1707   "Hashtable of moderated newsgroups.")
1708
1709 ;; Save window configuration.
1710 (defvar gnus-prev-winconf nil)
1711
1712 (defvar gnus-reffed-article-number nil)
1713
1714 ;;; Let the byte-compiler know that we know about this variable.
1715 (defvar rmail-default-rmail-file)
1716
1717 (defvar gnus-dead-summary nil)
1718
1719 (defvar gnus-article-display-hook nil
1720   "Controls how the article buffer will look.  This is an obsolete variable;
1721 use the article treating faculties instead.  Is is described in Info node
1722 `Customizing Articles'.")
1723
1724 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1725   "Regexp matching invalid groups.")
1726
1727 ;;; End of variables.
1728
1729 ;; Define some autoload functions Gnus might use.
1730 (eval-and-compile
1731
1732   ;; This little mapcar goes through the list below and marks the
1733   ;; symbols in question as autoloaded functions.
1734   (mapcar
1735    (lambda (package)
1736      (let ((interactive (nth 1 (memq ':interactive package))))
1737        (mapcar
1738         (lambda (function)
1739           (let (keymap)
1740             (when (consp function)
1741               (setq keymap (car (memq 'keymap function)))
1742               (setq function (car function)))
1743             (unless (fboundp function)
1744               (autoload function (car package) nil interactive keymap))))
1745         (if (eq (nth 1 package) ':interactive)
1746             (nthcdr 3 package)
1747           (cdr package)))))
1748    '(("info" :interactive t Info-goto-node)
1749      ("pp" pp-to-string)
1750      ("ps-print" ps-print-preprint)
1751      ("message" :interactive t
1752       message-send-and-exit message-yank-original)
1753      ("babel" babel-as-string)
1754      ("nnmail" nnmail-split-fancy nnmail-article-group)
1755      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1756      ("rmailout" rmail-output rmail-output-to-rmail-file)
1757      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1758       rmail-show-message rmail-summary-exists
1759       rmail-select-summary rmail-update-summary)
1760      ("gnus-audio" :interactive t gnus-audio-play)
1761      ("gnus-xmas" gnus-xmas-splash)
1762      ("gnus-soup" :interactive t
1763       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1764       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1765      ("nnsoup" nnsoup-pack-replies)
1766      ("score-mode" :interactive t gnus-score-mode)
1767      ("gnus-mh" gnus-summary-save-article-folder
1768       gnus-Folder-save-name gnus-folder-save-name)
1769      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1770      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1771       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1772       gnus-demon-add-disconnection gnus-demon-add-handler
1773       gnus-demon-remove-handler)
1774      ("gnus-demon" :interactive t
1775       gnus-demon-init gnus-demon-cancel)
1776      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1777       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1778      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1779       gnus-nocem-unwanted-article-p)
1780      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1781       gnus-server-server-name)
1782      ("gnus-srvr" gnus-browse-foreign-server)
1783      ("gnus-cite" :interactive t
1784       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1785       gnus-article-hide-citation gnus-article-fill-cited-article
1786       gnus-article-hide-citation-in-followups)
1787      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1788       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1789       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1790      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1791       gnus-cache-possibly-remove-articles gnus-cache-request-article
1792       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1793       gnus-cache-enter-remove-article gnus-cached-article-p
1794       gnus-cache-open gnus-cache-close gnus-cache-update-article
1795       gnus-cache-articles-in-group)
1796      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1797       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1798      ("gnus-score" :interactive t
1799       gnus-summary-increase-score gnus-summary-set-score
1800       gnus-summary-raise-thread gnus-summary-raise-same-subject
1801       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1802       gnus-summary-lower-thread gnus-summary-lower-same-subject
1803       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1804       gnus-summary-current-score gnus-score-delta-default
1805       gnus-score-flush-cache gnus-score-close
1806       gnus-possibly-score-headers gnus-score-followup-article
1807       gnus-score-followup-thread)
1808      ("gnus-score"
1809       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1810       gnus-current-score-file-nondirectory gnus-score-adaptive
1811       gnus-score-find-trace gnus-score-file-name)
1812      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
1813       gnus-score-customize)
1814      ("gnus-topic" :interactive t gnus-topic-mode)
1815      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1816       gnus-subscribe-topics)
1817      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1818      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1819      ("gnus-uu" :interactive t
1820       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1821       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1822       gnus-uu-mark-by-regexp gnus-uu-mark-all
1823       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1824       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1825       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1826       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1827       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1828       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1829       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1830       gnus-uu-mark-over gnus-uu-post-news)
1831      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1832       gnus-uu-unmark-thread)
1833      ("gnus-msg" (gnus-summary-send-map keymap)
1834       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
1835      ("gnus-msg" :interactive t
1836       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1837       gnus-summary-followup gnus-summary-followup-with-original
1838       gnus-summary-cancel-article gnus-summary-supersede-article
1839       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1840       gnus-summary-mail-forward gnus-summary-mail-other-window
1841       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1842       gnus-summary-wide-reply gnus-summary-followup-to-mail
1843       gnus-summary-followup-to-mail-with-original gnus-bug
1844       gnus-summary-wide-reply-with-original
1845       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1846       gnus-summary-post-forward)
1847      ("gnus-picon" :interactive t gnus-article-display-picons
1848       gnus-group-display-picons)
1849      ("gnus-picon" gnus-picons-buffer-name)
1850      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1851       gnus-grouplens-mode)
1852      ("smiley" :interactive t gnus-smiley-display)
1853      ("smiley" smiley-toggle-buffer)
1854      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1855      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1856       gnus-list-of-unread-articles gnus-list-of-read-articles
1857       gnus-offer-save-summaries gnus-make-thread-indent-array
1858       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1859       gnus-summary-skip-intangible gnus-summary-article-number
1860       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
1861      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1862       gnus-group-list-groups gnus-group-first-unread-group
1863       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1864       gnus-group-setup-buffer gnus-group-get-new-news
1865       gnus-group-make-help-group gnus-group-update-group
1866       gnus-group-iterate gnus-group-group-name)
1867      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1868       gnus-backlog-remove-article)
1869      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1870       gnus-article-prepare gnus-article-set-window-start
1871       gnus-article-next-page gnus-article-prev-page
1872       gnus-request-article-this-buffer gnus-article-mode
1873       gnus-article-setup-buffer gnus-narrow-to-page
1874       gnus-article-delete-invisible-text gnus-treat-article)
1875      ("gnus-art" :interactive t
1876       gnus-article-hide-headers gnus-article-hide-boring-headers
1877       gnus-article-treat-overstrike
1878       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1879       gnus-article-display-x-face
1880       gnus-article-decode-HZ
1881       gnus-article-wash-html
1882       gnus-article-hide-pgp
1883       gnus-article-hide-pem gnus-article-hide-signature
1884       gnus-article-strip-leading-blank-lines gnus-article-date-local
1885       gnus-article-date-original gnus-article-date-lapsed
1886       gnus-article-show-all-headers gnus-article-show-all
1887       gnus-article-edit-mode gnus-article-edit-article
1888       gnus-article-edit-done article-decode-encoded-words
1889       gnus-start-date-timer gnus-stop-date-timer
1890       gnus-article-toggle-headers)
1891      ("gnus-int" gnus-request-type)
1892      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1893       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1894      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1895       gnus-dup-enter-articles)
1896      ("gnus-range" gnus-copy-sequence)
1897      ("gnus-eform" gnus-edit-form)
1898      ("gnus-move" :interactive t
1899       gnus-group-move-group-to-server gnus-change-server)
1900      ("gnus-logic" gnus-score-advanced)
1901      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1902      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1903       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1904       gnus-async-halt-prefetch)
1905      ("gnus-offline"
1906       gnus-offline-setup)
1907      ("gnus-offline" :interactive t
1908       gnus-offline-toggle-plugged
1909       gnus-offline-set-unplugged-state
1910       gnus-offline-toggle-auto-hangup
1911       gnus-offline-toggle-on/off-send-mail
1912       gnus-offline-toggle-articles-to-fetch
1913       gnus-offline-set-interval-time
1914       gnus-offline-agent-expire)
1915      ("miee" :interactive t gnspool-get-news
1916       mail-spool-send news-spool-post)
1917      ("international/mw32misc" define-process-argument-editing
1918       general-process-argument-editing-function)
1919      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1920       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1921       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1922       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1923      ("gnus-agent" :interactive t
1924       gnus-unplugged gnus-agentize gnus-agent-batch)
1925      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1926       gnus-summary-save-article-vm)
1927      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1928      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1929      ("gnus-mlspl" :interactive t gnus-group-split-setup
1930       gnus-group-split-update))))
1931
1932 (eval-and-compile
1933   (unless (featurep 'xemacs)
1934     (autoload 'gnus-smiley-display "gnus-bitmap" nil t)
1935     (autoload 'smiley-toggle-buffer "gnus-bitmap")
1936     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")
1937     (when (>= emacs-major-version 21)
1938       (autoload 'x-face-decode-message-header "x-face-e21"))))
1939
1940 ;;; gnus-sum.el thingies
1941
1942
1943 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1944   "*The format specification of the lines in the summary buffer.
1945
1946 It works along the same lines as a normal formatting string,
1947 with some simple extensions.
1948
1949 %N   Article number, left padded with spaces (string)
1950 %S   Subject (string)
1951 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1952 %n   Name of the poster (string)
1953 %a   Extracted name of the poster (string)
1954 %A   Extracted address of the poster (string)
1955 %F   Contents of the From: header (string)
1956 %f   Contents of the From: or To: headers (string)
1957 %x   Contents of the Xref: header (string)
1958 %D   Date of the article (string)
1959 %d   Date of the article (string) in DD-MMM format
1960 %M   Message-id of the article (string)
1961 %r   References of the article (string)
1962 %c   Number of characters in the article (integer)
1963 %L   Number of lines in the article (integer)
1964 %I   Indentation based on thread level (a string of spaces)
1965 %T   A string with two possible values: 80 spaces if the article
1966      is on thread level two or larger and 0 spaces on level one
1967 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1968 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1969 %[   Opening bracket (character, \"[\" or \"<\")
1970 %]   Closing bracket (character, \"]\" or \">\")
1971 %>   Spaces of length thread-level (string)
1972 %<   Spaces of length (- 20 thread-level) (string)
1973 %i   Article score (number)
1974 %z   Article zcore (character)
1975 %t   Number of articles under the current thread (number).
1976 %e   Whether the thread is empty or not (character).
1977 %l   GroupLens score (string).
1978 %V   Total thread score (number).
1979 %P   The line number (number).
1980 %O   Download mark (character).
1981 %u   User defined specifier.  The next character in the format string should
1982      be a letter.  Gnus will call the function gnus-user-format-function-X,
1983      where X is the letter following %u.  The function will be passed the
1984      current header as argument.  The function should return a string, which
1985      will be inserted into the summary just like information from any other
1986      summary specifier.
1987
1988 Text between %( and %) will be highlighted with `gnus-mouse-face'
1989 when the mouse point is placed inside the area.  There can only be one
1990 such area.
1991
1992 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1993 with care.  For reasons of efficiency, Gnus will compute what column
1994 these characters will end up in, and \"hard-code\" that.  This means that
1995 it is invalid to have these specs after a variable-length spec.  Well,
1996 you might not be arrested, but your summary buffer will look strange,
1997 which is bad enough.
1998
1999 The smart choice is to have these specs as for to the left as
2000 possible.
2001
2002 This restriction may disappear in later versions of Gnus."
2003   :type 'string
2004   :group 'gnus-summary-format)
2005
2006 ;;;
2007 ;;; Skeleton keymaps
2008 ;;;
2009
2010 (defun gnus-suppress-keymap (keymap)
2011   (suppress-keymap keymap)
2012   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2013     (while keys
2014       (define-key keymap (pop keys) 'undefined))))
2015
2016 (defvar gnus-article-mode-map
2017   (let ((keymap (make-sparse-keymap)))
2018     (gnus-suppress-keymap keymap)
2019     keymap))
2020 (defvar gnus-summary-mode-map
2021   (let ((keymap (make-keymap)))
2022     (gnus-suppress-keymap keymap)
2023     keymap))
2024 (defvar gnus-group-mode-map
2025   (let ((keymap (make-keymap)))
2026     (gnus-suppress-keymap keymap)
2027     keymap))
2028
2029 \f
2030
2031 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2032 ;; If you want the cursor to go somewhere else, set these two
2033 ;; functions in some startup hook to whatever you want.
2034 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2035 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2036
2037 ;;; Various macros and substs.
2038
2039 (defun gnus-header-from (header)
2040   (mail-header-from header))
2041
2042 (defmacro gnus-gethash (string hashtable)
2043   "Get hash value of STRING in HASHTABLE."
2044   `(symbol-value (intern-soft ,string ,hashtable)))
2045
2046 (defmacro gnus-sethash (string value hashtable)
2047   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2048   `(set (intern ,string ,hashtable) ,value))
2049 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2050
2051 (defmacro gnus-group-unread (group)
2052   "Get the currently computed number of unread articles in GROUP."
2053   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2054
2055 (defmacro gnus-group-entry (group)
2056   "Get the newsrc entry for GROUP."
2057   `(gnus-gethash ,group gnus-newsrc-hashtb))
2058
2059 (defmacro gnus-active (group)
2060   "Get active info on GROUP."
2061   `(gnus-gethash ,group gnus-active-hashtb))
2062
2063 (defmacro gnus-set-active (group active)
2064   "Set GROUP's active info."
2065   `(gnus-sethash ,group ,active gnus-active-hashtb))
2066
2067 ;; Info access macros.
2068
2069 (defmacro gnus-info-group (info)
2070   `(nth 0 ,info))
2071 (defmacro gnus-info-rank (info)
2072   `(nth 1 ,info))
2073 (defmacro gnus-info-read (info)
2074   `(nth 2 ,info))
2075 (defmacro gnus-info-marks (info)
2076   `(nth 3 ,info))
2077 (defmacro gnus-info-method (info)
2078   `(nth 4 ,info))
2079 (defmacro gnus-info-params (info)
2080   `(nth 5 ,info))
2081
2082 (defmacro gnus-info-level (info)
2083   `(let ((rank (gnus-info-rank ,info)))
2084      (if (consp rank)
2085          (car rank)
2086        rank)))
2087 (defmacro gnus-info-score (info)
2088   `(let ((rank (gnus-info-rank ,info)))
2089      (or (and (consp rank) (cdr rank)) 0)))
2090
2091 (defmacro gnus-info-set-group (info group)
2092   `(setcar ,info ,group))
2093 (defmacro gnus-info-set-rank (info rank)
2094   `(setcar (nthcdr 1 ,info) ,rank))
2095 (defmacro gnus-info-set-read (info read)
2096   `(setcar (nthcdr 2 ,info) ,read))
2097 (defmacro gnus-info-set-marks (info marks &optional extend)
2098   (if extend
2099       `(gnus-info-set-entry ,info ,marks 3)
2100     `(setcar (nthcdr 3 ,info) ,marks)))
2101 (defmacro gnus-info-set-method (info method &optional extend)
2102   (if extend
2103       `(gnus-info-set-entry ,info ,method 4)
2104     `(setcar (nthcdr 4 ,info) ,method)))
2105 (defmacro gnus-info-set-params (info params &optional extend)
2106   (if extend
2107       `(gnus-info-set-entry ,info ,params 5)
2108     `(setcar (nthcdr 5 ,info) ,params)))
2109
2110 (defun gnus-info-set-entry (info entry number)
2111   ;; Extend the info until we have enough elements.
2112   (while (<= (length info) number)
2113     (nconc info (list nil)))
2114   ;; Set the entry.
2115   (setcar (nthcdr number info) entry))
2116
2117 (defmacro gnus-info-set-level (info level)
2118   `(let ((rank (cdr ,info)))
2119      (if (consp (car rank))
2120          (setcar (car rank) ,level)
2121        (setcar rank ,level))))
2122 (defmacro gnus-info-set-score (info score)
2123   `(let ((rank (cdr ,info)))
2124      (if (consp (car rank))
2125          (setcdr (car rank) ,score)
2126        (setcar rank (cons (car rank) ,score)))))
2127
2128 (defmacro gnus-get-info (group)
2129   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2130
2131 ;; Byte-compiler warning.
2132 (defvar gnus-visual)
2133 ;; Find out whether the gnus-visual TYPE is wanted.
2134 (defun gnus-visual-p (&optional type class)
2135   (and gnus-visual                      ; Has to be non-nil, at least.
2136        (if (not type)                   ; We don't care about type.
2137            gnus-visual
2138          (if (listp gnus-visual)        ; It's a list, so we check it.
2139              (or (memq type gnus-visual)
2140                  (memq class gnus-visual))
2141            t))))
2142
2143 ;;; Load the compatability functions.
2144
2145 (require 'gnus-ems)
2146
2147 \f
2148 ;;;
2149 ;;; Shutdown
2150 ;;;
2151
2152 (defvar gnus-shutdown-alist nil)
2153
2154 (defun gnus-add-shutdown (function &rest symbols)
2155   "Run FUNCTION whenever one of SYMBOLS is shut down."
2156   (push (cons function symbols) gnus-shutdown-alist))
2157
2158 (defun gnus-shutdown (symbol)
2159   "Shut down everything that waits for SYMBOL."
2160   (let ((alist gnus-shutdown-alist)
2161         entry)
2162     (while (setq entry (pop alist))
2163       (when (memq symbol (cdr entry))
2164         (funcall (car entry))))))
2165
2166 \f
2167 ;;;
2168 ;;; Gnus Utility Functions
2169 ;;;
2170
2171
2172 (defmacro gnus-string-or (&rest strings)
2173   "Return the first element of STRINGS that is a non-blank string.
2174 STRINGS will be evaluated in normal `or' order."
2175   `(gnus-string-or-1 ',strings))
2176
2177 (defun gnus-string-or-1 (strings)
2178   (let (string)
2179     (while strings
2180       (setq string (eval (pop strings)))
2181       (if (string-match "^[ \t]*$" string)
2182           (setq string nil)
2183         (setq strings nil)))
2184     string))
2185
2186 (defun gnus-info-find-node ()
2187   "Find Info documentation of Gnus."
2188   (interactive)
2189   ;; Enlarge info window if needed.
2190   (let (gnus-info-buffer)
2191     (Info-goto-node
2192      (format "(%s)%s"
2193              (or gnus-info-filename
2194                  (get-language-info current-language-environment 'gnus-info)
2195                  "gnus")
2196              (cadr (assq major-mode gnus-info-nodes))))
2197     (setq gnus-info-buffer (current-buffer))
2198     (gnus-configure-windows 'info)))
2199
2200 ;;;
2201 ;;; gnus-interactive
2202 ;;;
2203
2204 (defvar gnus-current-prefix-symbol nil
2205   "Current prefix symbol.")
2206
2207 (defvar gnus-current-prefix-symbols nil
2208   "List of current prefix symbols.")
2209
2210 (defun gnus-interactive (string &optional params)
2211   "Return a list that can be fed to `interactive'.
2212 See `interactive' for full documentation.
2213
2214 Adds the following specs:
2215
2216 y -- The current symbolic prefix.
2217 Y -- A list of the current symbolic prefix(es).
2218 A -- Article number.
2219 H -- Article header.
2220 g -- Group name."
2221   (let ((i 0)
2222         out c prompt)
2223     (while (< i (length string))
2224       (string-match ".\\([^\n]*\\)\n?" string i)
2225       (setq c (aref string i))
2226       (when (match-end 1)
2227         (setq prompt (match-string 1 string)))
2228       (setq i (match-end 0))
2229       ;; We basically emulate just about everything that
2230       ;; `interactive' does, but add the specs listed above.
2231       (push
2232        (cond
2233         ((= c ?a)
2234          (completing-read prompt obarray 'fboundp t))
2235         ((= c ?b)
2236          (read-buffer prompt (current-buffer) t))
2237         ((= c ?B)
2238          (read-buffer prompt (other-buffer (current-buffer))))
2239         ((= c ?c)
2240          (read-char))
2241         ((= c ?C)
2242          (completing-read prompt obarray 'commandp t))
2243         ((= c ?d)
2244          (point))
2245         ((= c ?D)
2246          (read-file-name prompt nil default-directory 'lambda))
2247         ((= c ?f)
2248          (read-file-name prompt nil nil 'lambda))
2249         ((= c ?F)
2250          (read-file-name prompt))
2251         ((= c ?k)
2252          (read-key-sequence prompt))
2253         ((= c ?K)
2254          (error "Not implemented spec"))
2255         ((= c ?e)
2256          (error "Not implemented spec"))
2257         ((= c ?m)
2258          (mark))
2259         ((= c ?N)
2260          (error "Not implemented spec"))
2261         ((= c ?n)
2262          (string-to-number (read-from-minibuffer prompt)))
2263         ((= c ?p)
2264          (prefix-numeric-value current-prefix-arg))
2265         ((= c ?P)
2266          current-prefix-arg)
2267         ((= c ?r)
2268          'gnus-prefix-nil)
2269         ((= c ?s)
2270          (read-string prompt))
2271         ((= c ?S)
2272          (intern (read-string prompt)))
2273         ((= c ?v)
2274          (read-variable prompt))
2275         ((= c ?x)
2276          (read-minibuffer prompt))
2277         ((= c ?x)
2278          (eval-minibuffer prompt))
2279         ;; And here the new specs come.
2280         ((= c ?y)
2281          gnus-current-prefix-symbol)
2282         ((= c ?Y)
2283          gnus-current-prefix-symbols)
2284         ((= c ?g)
2285          (gnus-group-group-name))
2286         ((= c ?A)
2287          (gnus-summary-skip-intangible)
2288          (or (get-text-property (point) 'gnus-number)
2289              (gnus-summary-last-subject)))
2290         ((= c ?H)
2291          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2292         (t
2293          (error "Non-implemented spec")))
2294        out)
2295       (cond
2296        ((= c ?r)
2297         (push (if (< (point) (mark) (point) (mark))) out)
2298         (push (if (> (point) (mark) (point) (mark))) out))))
2299     (setq out (delq 'gnus-prefix-nil out))
2300     (nreverse out)))
2301
2302 (defun gnus-symbolic-argument (&optional arg)
2303   "Read a symbolic argument and a command, and then execute command."
2304   (interactive "P")
2305   (let* ((in-command (this-command-keys))
2306          (command in-command)
2307          gnus-current-prefix-symbols
2308          gnus-current-prefix-symbol
2309          syms)
2310     (while (equal in-command command)
2311       (message "%s-" (key-description (this-command-keys)))
2312       (push (intern (char-to-string (read-char))) syms)
2313       (setq command (read-key-sequence nil t)))
2314     (setq gnus-current-prefix-symbols (nreverse syms)
2315           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2316     (call-interactively (key-binding command t))))
2317
2318 ;;; More various functions.
2319
2320 (defsubst gnus-check-backend-function (func group)
2321   "Check whether GROUP supports function FUNC.
2322 GROUP can either be a string (a group name) or a select method."
2323   (ignore-errors
2324     (let ((method (if (stringp group)
2325                       (car (gnus-find-method-for-group group))
2326                     group)))
2327       (unless (featurep method)
2328         (require method))
2329       (fboundp (intern (format "%s-%s" method func))))))
2330
2331 (defun gnus-group-read-only-p (&optional group)
2332   "Check whether GROUP supports editing or not.
2333 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2334 that that variable is buffer-local to the summary buffers."
2335   (let ((group (or group gnus-newsgroup-name)))
2336     (not (gnus-check-backend-function 'request-replace-article group))))
2337
2338 (defun gnus-group-total-expirable-p (group)
2339   "Check whether GROUP is total-expirable or not."
2340   (let ((params (gnus-group-find-parameter group))
2341         val)
2342     (cond
2343      ((memq 'total-expire params)
2344       t)
2345      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2346       (cdr val))
2347      (gnus-total-expirable-newsgroups   ; Check var.
2348       (string-match gnus-total-expirable-newsgroups group)))))
2349
2350 (defun gnus-group-auto-expirable-p (group)
2351   "Check whether GROUP is auto-expirable or not."
2352   (let ((params (gnus-group-find-parameter group))
2353         val)
2354     (cond
2355      ((memq 'auto-expire params)
2356       t)
2357      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2358       (cdr val))
2359      (gnus-auto-expirable-newsgroups    ; Check var.
2360       (string-match gnus-auto-expirable-newsgroups group)))))
2361
2362 (defun gnus-virtual-group-p (group)
2363   "Say whether GROUP is virtual or not."
2364   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2365                         gnus-valid-select-methods)))
2366
2367 (defun gnus-news-group-p (group &optional article)
2368   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2369   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2370       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2371            (if (or (null article)
2372                    (not (< article 0)))
2373                (eq (gnus-request-type group article) 'news)
2374              (if (not (vectorp article))
2375                  nil
2376                ;; It's a real article.
2377                (eq (gnus-request-type group (mail-header-id article))
2378                    'news))))))
2379
2380 ;; Returns a list of writable groups.
2381 (defun gnus-writable-groups ()
2382   (let ((alist gnus-newsrc-alist)
2383         groups group)
2384     (while (setq group (car (pop alist)))
2385       (unless (gnus-group-read-only-p group)
2386         (push group groups)))
2387     (nreverse groups)))
2388
2389 ;; Check whether to use long file names.
2390 (defun gnus-use-long-file-name (symbol)
2391   ;; The variable has to be set...
2392   (and gnus-use-long-file-name
2393        ;; If it isn't a list, then we return t.
2394        (or (not (listp gnus-use-long-file-name))
2395            ;; If it is a list, and the list contains `symbol', we
2396            ;; return nil.
2397            (not (memq symbol gnus-use-long-file-name)))))
2398
2399 ;; Generate a unique new group name.
2400 (defun gnus-generate-new-group-name (leaf)
2401   (let ((name leaf)
2402         (num 0))
2403     (while (gnus-gethash name gnus-newsrc-hashtb)
2404       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2405     name))
2406
2407 (defun gnus-ephemeral-group-p (group)
2408   "Say whether GROUP is ephemeral or not."
2409   (gnus-group-get-parameter group 'quit-config t))
2410
2411 (defun gnus-group-quit-config (group)
2412   "Return the quit-config of GROUP."
2413   (gnus-group-get-parameter group 'quit-config t))
2414
2415 (defun gnus-kill-ephemeral-group (group)
2416   "Remove ephemeral GROUP from relevant structures."
2417   (gnus-sethash group nil gnus-newsrc-hashtb))
2418
2419 (defun gnus-simplify-mode-line ()
2420   "Make mode lines a bit simpler."
2421   (setq mode-line-modified (cdr gnus-mode-line-modified))
2422   (when (listp mode-line-format)
2423     (make-local-variable 'mode-line-format)
2424     (setq mode-line-format (copy-sequence mode-line-format))
2425     (when (equal (nth 3 mode-line-format) "   ")
2426       (setcar (nthcdr 3 mode-line-format) " "))))
2427
2428 ;;; Servers and groups.
2429
2430 (defsubst gnus-server-add-address (method)
2431   (let ((method-name (symbol-name (car method))))
2432     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2433              (not (assq (intern (concat method-name "-address")) method))
2434              (memq 'physical-address (assq (car method)
2435                                            gnus-valid-select-methods)))
2436         (append method (list (list (intern (concat method-name "-address"))
2437                                    (nth 1 method))))
2438       method)))
2439
2440 (defsubst gnus-server-get-method (group method)
2441   ;; Input either a server name, and extended server name, or a
2442   ;; select method, and return a select method.
2443   (cond ((stringp method)
2444          (gnus-server-to-method method))
2445         ((equal method gnus-select-method)
2446          gnus-select-method)
2447         ((and (stringp (car method))
2448               group)
2449          (gnus-server-extend-method group method))
2450         ((and method
2451               (not group)
2452               (equal (cadr method) ""))
2453          method)
2454         (t
2455          (gnus-server-add-address method))))
2456
2457 (defun gnus-server-to-method (server)
2458   "Map virtual server names to select methods."
2459   (or
2460    ;; Is this a method, perhaps?
2461    (and server (listp server) server)
2462    ;; Perhaps this is the native server?
2463    (and (equal server "native") gnus-select-method)
2464    ;; It should be in the server alist.
2465    (cdr (assoc server gnus-server-alist))
2466    ;; It could be in the predefined server alist.
2467    (cdr (assoc server gnus-predefined-server-alist))
2468    ;; If not, we look through all the opened server
2469    ;; to see whether we can find it there.
2470    (let ((opened gnus-opened-servers))
2471      (while (and opened
2472                  (not (equal server (format "%s:%s" (caaar opened)
2473                                             (cadaar opened)))))
2474        (pop opened))
2475      (caar opened))
2476    ;; It could be a named method, search all servers
2477    (let ((servers gnus-secondary-select-methods))
2478      (while (and servers
2479                  (not (equal server (format "%s:%s" (caar servers)
2480                                             (cadar servers)))))
2481        (pop servers))
2482      (car servers))))
2483
2484 (defmacro gnus-method-equal (ss1 ss2)
2485   "Say whether two servers are equal."
2486   `(let ((s1 ,ss1)
2487          (s2 ,ss2))
2488      (or (equal s1 s2)
2489          (and (= (length s1) (length s2))
2490               (progn
2491                 (while (and s1 (member (car s1) s2))
2492                   (setq s1 (cdr s1)))
2493                 (null s1))))))
2494
2495 (defun gnus-methods-equal-p (m1 m2)
2496   (let ((m1 (or m1 gnus-select-method))
2497         (m2 (or m2 gnus-select-method)))
2498     (or (equal m1 m2)
2499         (and (eq (car m1) (car m2))
2500              (or (not (memq 'address (assoc (symbol-name (car m1))
2501                                             gnus-valid-select-methods)))
2502                  (equal (nth 1 m1) (nth 1 m2)))))))
2503
2504 (defun gnus-server-equal (m1 m2)
2505   "Say whether two methods are equal."
2506   (let ((m1 (cond ((null m1) gnus-select-method)
2507                   ((stringp m1) (gnus-server-to-method m1))
2508                   (t m1)))
2509         (m2 (cond ((null m2) gnus-select-method)
2510                   ((stringp m2) (gnus-server-to-method m2))
2511                   (t m2))))
2512     (gnus-method-equal m1 m2)))
2513
2514 (defun gnus-servers-using-backend (backend)
2515   "Return a list of known servers using BACKEND."
2516   (let ((opened gnus-opened-servers)
2517         out)
2518     (while opened
2519       (when (eq backend (caaar opened))
2520         (push (caar opened) out))
2521       (pop opened))
2522     out))
2523
2524 (defun gnus-archive-server-wanted-p ()
2525   "Say whether the user wants to use the archive server."
2526   (cond
2527    ((or (not gnus-message-archive-method)
2528         (not gnus-message-archive-group))
2529     nil)
2530    ((and gnus-message-archive-method gnus-message-archive-group)
2531     t)
2532    (t
2533     (let ((active (cadr (assq 'nnfolder-active-file
2534                               gnus-message-archive-method))))
2535       (and active
2536            (file-exists-p active))))))
2537
2538 (defun gnus-group-prefixed-name (group method)
2539   "Return the whole name from GROUP and METHOD."
2540   (and (stringp method) (setq method (gnus-server-to-method method)))
2541   (if (or (not method)
2542           (gnus-server-equal method "native"))
2543       group
2544     (concat (format "%s" (car method))
2545             (when (and
2546                    (or (assoc (format "%s" (car method))
2547                               (gnus-methods-using 'address))
2548                        (gnus-server-equal method gnus-message-archive-method))
2549                    (nth 1 method)
2550                    (not (string= (nth 1 method) "")))
2551               (concat "+" (nth 1 method)))
2552             ":" group)))
2553
2554 (defun gnus-group-real-prefix (group)
2555   "Return the prefix of the current group name."
2556   (if (string-match "^[^:]+:" group)
2557       (substring group 0 (match-end 0))
2558     ""))
2559
2560 (defun gnus-group-method (group)
2561   "Return the server or method used for selecting GROUP.
2562 You should probably use `gnus-find-method-for-group' instead."
2563   (let ((prefix (gnus-group-real-prefix group)))
2564     (if (equal prefix "")
2565         gnus-select-method
2566       (let ((servers gnus-opened-servers)
2567             (server "")
2568             backend possible found)
2569         (if (string-match "^[^\\+]+\\+" prefix)
2570             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2571                   server (substring prefix (match-end 0) (1- (length prefix))))
2572           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2573         (while servers
2574           (when (eq (caaar servers) backend)
2575             (setq possible (caar servers))
2576             (when (equal (cadaar servers) server)
2577               (setq found (caar servers))))
2578           (pop servers))
2579         (or (car (rassoc found gnus-server-alist))
2580             found
2581             (car (rassoc possible gnus-server-alist))
2582             possible
2583             (list backend server))))))
2584
2585 (defsubst gnus-native-method-p (method)
2586   "Return whether METHOD is the native select method."
2587   (gnus-method-equal method gnus-select-method))
2588
2589 (defsubst gnus-secondary-method-p (method)
2590   "Return whether METHOD is a secondary select method."
2591   (let ((methods gnus-secondary-select-methods)
2592         (gmethod (gnus-server-get-method nil method)))
2593     (while (and methods
2594                 (not (gnus-method-equal
2595                       (gnus-server-get-method nil (car methods))
2596                       gmethod)))
2597       (setq methods (cdr methods)))
2598     methods))
2599
2600 (defun gnus-method-simplify (method)
2601   "Return the shortest uniquely identifying string or method for METHOD."
2602   (cond ((stringp method)
2603          method)
2604         ((gnus-native-method-p method)
2605          nil)
2606         ((gnus-secondary-method-p method)
2607          (format "%s:%s" (nth 0 method) (nth 1 method)))
2608         (t
2609          method)))
2610
2611 (defun gnus-groups-from-server (server)
2612   "Return a list of all groups that are fetched from SERVER."
2613   (let ((alist (cdr gnus-newsrc-alist))
2614         info groups)
2615     (while (setq info (pop alist))
2616       (when (gnus-server-equal (gnus-info-method info) server)
2617         (push (gnus-info-group info) groups)))
2618     (sort groups 'string<)))
2619
2620 (defun gnus-group-foreign-p (group)
2621   "Say whether a group is foreign or not."
2622   (and (not (gnus-group-native-p group))
2623        (not (gnus-group-secondary-p group))))
2624
2625 (defun gnus-group-native-p (group)
2626   "Say whether the group is native or not."
2627   (not (string-match ":" group)))
2628
2629 (defun gnus-group-secondary-p (group)
2630   "Say whether the group is secondary or not."
2631   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2632
2633 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2634   "Return the group parameters for GROUP.
2635 If SYMBOL, return the value of that symbol in the group parameters."
2636   (save-excursion
2637     (set-buffer gnus-group-buffer)
2638     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2639       (if symbol
2640           (gnus-group-parameter-value parameters symbol allow-list)
2641         parameters))))
2642
2643 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2644   "Return the group parameters for GROUP.
2645 If SYMBOL, return the value of that symbol in the group parameters.
2646 Most functions should use `gnus-group-find-parameter', which
2647 also examines the topic parameters."
2648   (let ((params (gnus-info-params (gnus-get-info group))))
2649     (if symbol
2650         (gnus-group-parameter-value params symbol allow-list)
2651       params)))
2652
2653 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2654   "Return the value of SYMBOL in group PARAMS."
2655   ;; We only wish to return group parameters (dotted lists) and
2656   ;; not local variables, which may have the same names.
2657   ;; But first we handle single elements...
2658   (or (car (memq symbol params))
2659       ;; Handle alist.
2660       (let (elem)
2661         (catch 'found
2662           (while (setq elem (pop params))
2663             (when (and (consp elem)
2664                        (eq (car elem) symbol)
2665                        (or allow-list
2666                            (atom (cdr elem))))
2667               (throw 'found (cdr elem))))))))
2668
2669 (defun gnus-group-add-parameter (group param)
2670   "Add parameter PARAM to GROUP."
2671   (let ((info (gnus-get-info group)))
2672     (when info
2673       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2674       ;; Cons the new param to the old one and update.
2675       (gnus-group-set-info (cons param (gnus-info-params info))
2676                            group 'params))))
2677
2678 (defun gnus-group-set-parameter (group name value)
2679   "Set parameter NAME to VALUE in GROUP."
2680   (let ((info (gnus-get-info group)))
2681     (when info
2682       (gnus-group-remove-parameter group name)
2683       (let ((old-params (gnus-info-params info))
2684             (new-params (list (cons name value))))
2685         (while old-params
2686           (when (or (not (listp (car old-params)))
2687                     (not (eq (caar old-params) name)))
2688             (setq new-params (append new-params (list (car old-params)))))
2689           (setq old-params (cdr old-params)))
2690         (gnus-group-set-info new-params group 'params)))))
2691
2692 (defun gnus-group-remove-parameter (group name)
2693   "Remove parameter NAME from GROUP."
2694   (let ((info (gnus-get-info group)))
2695     (when info
2696       (let ((params (gnus-info-params info)))
2697         (when params
2698           (setq params (delq name params))
2699           (while (assq name params)
2700             (gnus-pull name params))
2701           (gnus-info-set-params info params))))))
2702
2703 (defun gnus-group-add-score (group &optional score)
2704   "Add SCORE to the GROUP score.
2705 If SCORE is nil, add 1 to the score of GROUP."
2706   (let ((info (gnus-get-info group)))
2707     (when info
2708       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2709
2710 (defun gnus-short-group-name (group &optional levels)
2711   "Collapse GROUP name LEVELS.
2712 Select methods are stripped and any remote host name is stripped down to
2713 just the host name."
2714   (let* ((name "")
2715          (foreign "")
2716          (depth 0)
2717          (skip 1)
2718          (levels (or levels
2719                      gnus-group-uncollapsed-levels
2720                      (progn
2721                        (while (string-match "\\." group skip)
2722                          (setq skip (match-end 0)
2723                                depth (+ depth 1)))
2724                        depth))))
2725     ;; Separate foreign select method from group name and collapse.
2726     ;; If method contains a server, collapse to non-domain server name,
2727     ;; otherwise collapse to select method.
2728     (let* ((colon (string-match ":" group))
2729            (server (and colon (substring group 0 colon)))
2730            (plus (and server (string-match "+" server))))
2731       (when server
2732         (if plus
2733             (setq foreign (substring server (+ 1 plus)
2734                                      (string-match "\\." server))
2735                   group (substring group (+ 1 colon)))
2736           (setq foreign server
2737                 group (substring group (+ 1 colon))))
2738         (setq foreign (concat foreign ":")))
2739       ;; Collapse group name leaving LEVELS uncollapsed elements
2740       (let* ((slist (split-string group "/"))
2741              (slen (length slist))
2742              (dlist (split-string group "\\."))
2743              (dlen (length dlist))
2744              glist
2745              glen
2746              gsep
2747              res)
2748         (if (> slen dlen)
2749             (setq glist slist
2750                   glen slen
2751                   gsep "/")
2752           (setq glist dlist
2753                 glen dlen
2754                 gsep "."))
2755         (setq levels (- glen levels))
2756         (dolist (g glist)
2757           (push (if (>= (decf levels) 0)
2758                     (if (zerop (length g))
2759                         ""
2760                       (substring g 0 1))
2761                   g)
2762                 res))
2763         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2764
2765 (defun gnus-narrow-to-body ()
2766   "Narrow to the body of an article."
2767   (narrow-to-region
2768    (progn
2769      (goto-char (point-min))
2770      (or (search-forward "\n\n" nil t)
2771          (point-max)))
2772    (point-max)))
2773
2774 \f
2775 ;;;
2776 ;;; Kill file handling.
2777 ;;;
2778
2779 (defun gnus-apply-kill-file ()
2780   "Apply a kill file to the current newsgroup.
2781 Returns the number of articles marked as read."
2782   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2783           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2784       (gnus-apply-kill-file-internal)
2785     0))
2786
2787 (defun gnus-kill-save-kill-buffer ()
2788   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2789     (when (get-file-buffer file)
2790       (save-excursion
2791         (set-buffer (get-file-buffer file))
2792         (when (buffer-modified-p)
2793           (save-buffer))
2794         (kill-buffer (current-buffer))))))
2795
2796 (defcustom gnus-kill-file-name "KILL"
2797   "Suffix of the kill files."
2798   :group 'gnus-score-kill
2799   :group 'gnus-score-files
2800   :type 'string)
2801
2802 (defun gnus-newsgroup-kill-file (newsgroup)
2803   "Return the name of a kill file name for NEWSGROUP.
2804 If NEWSGROUP is nil, return the global kill file name instead."
2805   (cond
2806    ;; The global KILL file is placed at top of the directory.
2807    ((or (null newsgroup)
2808         (string-equal newsgroup ""))
2809     (expand-file-name gnus-kill-file-name
2810                       gnus-kill-files-directory))
2811    ;; Append ".KILL" to newsgroup name.
2812    ((gnus-use-long-file-name 'not-kill)
2813     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2814                               "." gnus-kill-file-name)
2815                       gnus-kill-files-directory))
2816    ;; Place "KILL" under the hierarchical directory.
2817    (t
2818     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2819                               "/" gnus-kill-file-name)
2820                       gnus-kill-files-directory))))
2821
2822 ;;; Server things.
2823
2824 (defun gnus-member-of-valid (symbol group)
2825   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2826   (memq symbol (assoc
2827                 (symbol-name (car (gnus-find-method-for-group group)))
2828                 gnus-valid-select-methods)))
2829
2830 (defun gnus-method-option-p (method option)
2831   "Return non-nil if select METHOD has OPTION as a parameter."
2832   (when (stringp method)
2833     (setq method (gnus-server-to-method method)))
2834   (memq option (assoc (format "%s" (car method))
2835                       gnus-valid-select-methods)))
2836
2837 (defun gnus-similar-server-opened (method)
2838   (let ((opened gnus-opened-servers))
2839     (while (and method opened)
2840       (when (and (equal (cadr method) (cadaar opened))
2841                  (equal (car method) (caaar opened))
2842                  (not (equal method (caar opened))))
2843         (setq method nil))
2844       (pop opened))
2845     (not method)))
2846
2847 (defun gnus-server-extend-method (group method)
2848   ;; This function "extends" a virtual server.  If the server is
2849   ;; "hello", and the select method is ("hello" (my-var "something"))
2850   ;; in the group "alt.alt", this will result in a new virtual server
2851   ;; called "hello+alt.alt".
2852   (if (or (not (inline (gnus-similar-server-opened method)))
2853           (not (cddr method)))
2854       method
2855     `(,(car method) ,(concat (cadr method) "+" group)
2856       (,(intern (format "%s-address" (car method))) ,(cadr method))
2857       ,@(cddr method))))
2858
2859 (defun gnus-server-status (method)
2860   "Return the status of METHOD."
2861   (nth 1 (assoc method gnus-opened-servers)))
2862
2863 (defun gnus-group-name-to-method (group)
2864   "Guess a select method based on GROUP."
2865   (if (string-match ":" group)
2866       (let ((server (substring group 0 (match-beginning 0))))
2867         (if (string-match "\\+" server)
2868             (list (intern (substring server 0 (match-beginning 0)))
2869                   (substring server (match-end 0)))
2870           (list (intern server) "")))
2871     gnus-select-method))
2872
2873 (defun gnus-find-method-for-group (group &optional info)
2874   "Find the select method that GROUP uses."
2875   (or gnus-override-method
2876       (and (not group)
2877            gnus-select-method)
2878       (and (not (gnus-group-entry group));; a new group
2879            (gnus-group-name-to-method group))
2880       (let ((info (or info (gnus-get-info group)))
2881             method)
2882         (if (or (not info)
2883                 (not (setq method (gnus-info-method info)))
2884                 (equal method "native"))
2885             gnus-select-method
2886           (setq method
2887                 (cond ((stringp method)
2888                        (inline (gnus-server-to-method method)))
2889                       ((stringp (cadr method))
2890                        (inline (gnus-server-extend-method group method)))
2891                       (t
2892                        method)))
2893           (cond ((equal (cadr method) "")
2894                  method)
2895                 ((null (cadr method))
2896                  (list (car method) ""))
2897                 (t
2898                  (gnus-server-add-address method)))))))
2899
2900 (defun gnus-methods-using (feature)
2901   "Find all methods that have FEATURE."
2902   (let ((valids gnus-valid-select-methods)
2903         outs)
2904     (while valids
2905       (when (memq feature (car valids))
2906         (push (car valids) outs))
2907       (setq valids (cdr valids)))
2908     outs))
2909
2910 (defun gnus-read-group (prompt &optional default)
2911   "Prompt the user for a group name.
2912 Disallow invalid group names."
2913   (let ((prefix "")
2914         group)
2915     (while (not group)
2916       (when (string-match 
2917              gnus-invalid-group-regexp
2918              (setq group (read-string (concat prefix prompt)
2919                                       (cons (or default "") 0)
2920                                       'gnus-group-history)))
2921         (setq prefix (format "Invalid group name: \"%s\".  " group)
2922               group nil)))
2923     group))
2924
2925 (defun gnus-read-method (prompt)
2926   "Prompt the user for a method.
2927 Allow completion over sensible values."
2928   (let* ((servers
2929           (append gnus-valid-select-methods
2930                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2931                                                     (cadar i))))
2932                           gnus-opened-servers)
2933                   gnus-predefined-server-alist
2934                   gnus-server-alist))
2935          (method
2936           (completing-read
2937            prompt servers
2938            nil t nil 'gnus-method-history)))
2939     (cond
2940      ((equal method "")
2941       (setq method gnus-select-method))
2942      ((assoc method gnus-valid-select-methods)
2943       (let ((address (if (memq 'prompt-address
2944                                (assoc method gnus-valid-select-methods))
2945                          (read-string "Address: ")
2946                        "")))
2947         (or (let ((opened gnus-opened-servers))
2948               (while (and opened
2949                           (not (equal (format "%s:%s" method address)
2950                                       (format "%s:%s" (caaar opened)
2951                                               (cadaar opened)))))
2952                 (pop opened))
2953               (caar opened))
2954             (list (intern method) address))))
2955      ((assoc method servers)
2956       method)
2957      (t
2958       (list (intern method) "")))))
2959
2960 ;;; User-level commands.
2961
2962 ;;;###autoload
2963 (defun gnus-slave-no-server (&optional arg)
2964   "Read network news as a slave, without connecting to local server."
2965   (interactive "P")
2966   (gnus-no-server arg t))
2967
2968 ;;;###autoload
2969 (defun gnus-no-server (&optional arg slave)
2970   "Read network news.
2971 If ARG is a positive number, Gnus will use that as the
2972 startup level.  If ARG is nil, Gnus will be started at level 2.
2973 If ARG is non-nil and not a positive number, Gnus will
2974 prompt the user for the name of an NNTP server to use.
2975 As opposed to `gnus', this command will not connect to the local server."
2976   (interactive "P")
2977   (gnus-no-server-1 arg slave))
2978
2979 ;;;###autoload
2980 (defun gnus-slave (&optional arg)
2981   "Read news as a slave."
2982   (interactive "P")
2983   (gnus arg nil 'slave))
2984
2985 (defcustom gnus-frame-properties nil
2986   "The properties of the frame in which gnus is displayed. Under XEmacs,
2987 the variable `toolbar-news-frame-plist' will be refered instead."
2988   :type '(repeat (cons :format "%v"
2989                        (symbol :tag "Parameter")
2990                        (sexp :tag "Value")))
2991   :group 'gnus)
2992
2993 (defvar gnus-frame nil
2994   "The frame in which gnus is displayed. It is not used under XEmacs.")
2995
2996 ;;;###autoload
2997 (defun gnus-other-frame (&optional arg)
2998   "Pop up a frame to read news."
2999   (interactive "P")
3000   (static-if (featurep 'xemacs)
3001       (let ((toolbar-news-use-separate-frame t))
3002         (toolbar-gnus))
3003     (if (frame-live-p gnus-frame)
3004         (raise-frame gnus-frame)
3005       (setq gnus-frame (make-frame gnus-frame-properties))
3006       (if (and (gnus-buffer-live-p gnus-group-buffer)
3007                (save-current-buffer
3008                  (set-buffer gnus-group-buffer)
3009                  (eq 'gnus-group-mode major-mode)))
3010           (progn
3011             (select-frame gnus-frame)
3012             (switch-to-buffer gnus-group-buffer))
3013         (add-hook 'gnus-exit-gnus-hook
3014                   (lambda ()
3015                     (when (and (frame-live-p gnus-frame)
3016                                (cdr (frame-list)))
3017                       (delete-frame gnus-frame))
3018                     (setq gnus-frame nil)))
3019         (select-frame gnus-frame)
3020         (gnus arg)))))
3021
3022 ;;;###autoload
3023 (defun gnus (&optional arg dont-connect slave)
3024   "Read network news.
3025 If ARG is non-nil and a positive number, Gnus will use that as the
3026 startup level.  If ARG is non-nil and not a positive number, Gnus will
3027 prompt the user for the name of an NNTP server to use."
3028   (interactive "P")
3029   (gnus-1 arg dont-connect slave))
3030
3031 ;; Allow redefinition of Gnus functions.
3032
3033 (gnus-ems-redefine)
3034
3035 (product-provide (provide 'gnus) 'gnus-vers)
3036
3037 ;;; gnus.el ends here