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