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