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