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