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