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