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