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