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