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