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