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