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