88e0652f12ef7599d42d5e9e7cece05bd7c0edf4
[elisp/gnus.git-] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987-1990,1993-1999 Free Software Foundation, Inc.
3
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval '(run-hooks 'gnus-load-hook))
30
31 (eval-when-compile (require 'cl))
32 (require 'mm-util)
33
34 (require 'custom)
35 (eval-and-compile
36   (if (< emacs-major-version 20)
37       (require 'gnus-load)))
38 (require 'message)
39
40 (defgroup gnus nil
41   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42   :group 'news
43   :group 'mail)
44
45 (defgroup gnus-charset nil
46   "Group character set issues."
47   :link '(custom-manual "(gnus)Charsets")
48   :group 'gnus)
49
50 (defgroup gnus-cache nil
51   "Cache interface."
52   :group 'gnus)
53
54 (defgroup gnus-start nil
55   "Starting your favorite newsreader."
56   :group 'gnus)
57
58 (defgroup gnus-start-server nil
59   "Server options at startup."
60   :group 'gnus-start)
61
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
64   "Group buffers."
65   :link '(custom-manual "(gnus)The Group Buffer")
66   :group 'gnus)
67
68 (defgroup gnus-group-foreign nil
69   "Foreign groups."
70   :link '(custom-manual "(gnus)Foreign Groups")
71   :group 'gnus-group)
72
73 (defgroup gnus-group-new nil
74   "Automatic subscription of new groups."
75   :group 'gnus-group)
76
77 (defgroup gnus-group-levels nil
78   "Group levels."
79   :link '(custom-manual "(gnus)Group Levels")
80   :group 'gnus-group)
81
82 (defgroup gnus-group-select nil
83   "Selecting a Group."
84   :link '(custom-manual "(gnus)Selecting a Group")
85   :group 'gnus-group)
86
87 (defgroup gnus-group-listing nil
88   "Showing slices of the group list."
89   :link '(custom-manual "(gnus)Listing Groups")
90   :group 'gnus-group)
91
92 (defgroup gnus-group-visual nil
93   "Sorting the group buffer."
94   :link '(custom-manual "(gnus)Group Buffer Format")
95   :group 'gnus-group
96   :group 'gnus-visual)
97
98 (defgroup gnus-group-various nil
99   "Various group options."
100   :link '(custom-manual "(gnus)Scanning New Messages")
101   :group 'gnus-group)
102
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
105   "Summary buffers."
106   :link '(custom-manual "(gnus)The Summary Buffer")
107   :group 'gnus)
108
109 (defgroup gnus-summary-exit nil
110   "Leaving summary buffers."
111   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112   :group 'gnus-summary)
113
114 (defgroup gnus-summary-marks nil
115   "Marks used in summary buffers."
116   :link '(custom-manual "(gnus)Marking Articles")
117   :group 'gnus-summary)
118
119 (defgroup gnus-thread nil
120   "Ordering articles according to replies."
121   :link '(custom-manual "(gnus)Threading")
122   :group 'gnus-summary)
123
124 (defgroup gnus-summary-format nil
125   "Formatting of the summary buffer."
126   :link '(custom-manual "(gnus)Summary Buffer Format")
127   :group 'gnus-summary)
128
129 (defgroup gnus-summary-choose nil
130   "Choosing Articles."
131   :link '(custom-manual "(gnus)Choosing Articles")
132   :group 'gnus-summary)
133
134 (defgroup gnus-summary-maneuvering nil
135   "Summary movement commands."
136   :link '(custom-manual "(gnus)Summary Maneuvering")
137   :group 'gnus-summary)
138
139 (defgroup gnus-summary-mail nil
140   "Mail group commands."
141   :link '(custom-manual "(gnus)Mail Group Commands")
142   :group 'gnus-summary)
143
144 (defgroup gnus-summary-sort nil
145   "Sorting the summary buffer."
146   :link '(custom-manual "(gnus)Sorting")
147   :group 'gnus-summary)
148
149 (defgroup gnus-summary-visual nil
150   "Highlighting and menus in the summary buffer."
151   :link '(custom-manual "(gnus)Summary Highlighting")
152   :group 'gnus-visual
153   :group 'gnus-summary)
154
155 (defgroup gnus-summary-various nil
156   "Various summary buffer options."
157   :link '(custom-manual "(gnus)Various Summary Stuff")
158   :group 'gnus-summary)
159
160 (defgroup gnus-summary-pick nil
161   "Pick mode in the summary buffer."
162   :link '(custom-manual "(gnus)Pick and Read")
163   :prefix "gnus-pick-"
164   :group 'gnus-summary)
165
166 (defgroup gnus-summary-tree nil
167   "Tree display of threads in the summary buffer."
168   :link '(custom-manual "(gnus)Tree Display")
169   :prefix "gnus-tree-"
170   :group 'gnus-summary)
171
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174   "Viewing extracted files."
175   :link '(custom-manual "(gnus)Viewing Files")
176   :group 'gnus-extract)
177
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180   "Score and kill file handling."
181   :group 'gnus)
182
183 (defgroup gnus-score-kill nil
184   "Kill files."
185   :group 'gnus-score)
186
187 (defgroup gnus-score-adapt nil
188   "Adaptive score files."
189   :group 'gnus-score)
190
191 (defgroup gnus-score-default nil
192   "Default values for score files."
193   :group 'gnus-score)
194
195 (defgroup gnus-score-expire nil
196   "Expiring score rules."
197   :group 'gnus-score)
198
199 (defgroup gnus-score-decay nil
200   "Decaying score rules."
201   :group 'gnus-score)
202
203 (defgroup gnus-score-files nil
204   "Score and kill file names."
205   :group 'gnus-score
206   :group 'gnus-files)
207
208 (defgroup gnus-score-various nil
209   "Various scoring and killing options."
210   :group 'gnus-score)
211
212 ;; Other
213 (defgroup gnus-visual nil
214   "Options controling the visual fluff."
215   :group 'gnus
216   :group 'faces)
217
218 (defgroup gnus-agent nil
219   "Offline support for Gnus."
220   :group 'gnus)
221
222 (defgroup gnus-files nil
223   "Files used by Gnus."
224   :group 'gnus)
225
226 (defgroup gnus-dribble-file nil
227   "Auto save file."
228   :link '(custom-manual "(gnus)Auto Save")
229   :group 'gnus-files)
230
231 (defgroup gnus-newsrc nil
232   "Storing Gnus state."
233   :group 'gnus-files)
234
235 (defgroup gnus-server nil
236   "Options related to newsservers and other servers used by Gnus."
237   :group 'gnus)
238
239 (defgroup gnus-message '((message custom-group))
240   "Composing replies and followups in Gnus."
241   :group 'gnus)
242
243 (defgroup gnus-meta nil
244   "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
247   :group 'gnus)
248
249 (defgroup gnus-various nil
250   "Other Gnus options."
251   :link '(custom-manual "(gnus)Various Various")
252   :group 'gnus)
253
254 (defgroup gnus-mime nil
255   "Variables for controlling the Gnus MIME interface."
256   :group 'gnus)
257
258 (defgroup gnus-exit nil
259   "Exiting gnus."
260   :link '(custom-manual "(gnus)Exiting Gnus")
261   :group 'gnus)
262
263 (defconst gnus-original-version-number "5.8.2"
264   "Version number for this version of original Gnus.")
265
266 (defconst gnus-original-version
267   (format "Gnus v%s" gnus-original-version-number)
268   "Version string for this version of Gnus.")
269
270 (defconst gnus-product-name "Nana-gnus"
271   "Product name of this version of gnus.")
272
273 (defconst gnus-version-number "7.1.0.1"
274   "Version number for this version of gnus.")
275
276 (defconst gnus-version
277   (format "%s %s (based on %s; for SEMI 1.13, FLIM 1.13)"
278           gnus-product-name gnus-version-number gnus-original-version)
279   "Version string for this version of gnus.")
280
281 (defcustom gnus-inhibit-startup-message nil
282   "If non-nil, the startup message will not be displayed.
283 This variable is used before `.gnus.el' is loaded, so it should
284 be set in `.emacs' instead."
285   :group 'gnus-start
286   :type 'boolean)
287
288 (defcustom gnus-play-startup-jingle nil
289   "If non-nil, play the Gnus jingle at startup."
290   :group 'gnus-start
291   :type 'boolean)
292
293 (unless (featurep 'gnus-xmas)
294   (defalias 'gnus-make-overlay 'make-overlay)
295   (defalias 'gnus-delete-overlay 'delete-overlay)
296   (defalias 'gnus-overlay-put 'overlay-put)
297   (defalias 'gnus-move-overlay 'move-overlay)
298   (defalias 'gnus-overlay-end 'overlay-end)
299   (defalias 'gnus-extent-detached-p 'ignore)
300   (defalias 'gnus-extent-start-open 'ignore)
301   (defalias 'gnus-set-text-properties 'set-text-properties)
302   (defalias 'gnus-group-remove-excess-properties 'ignore)
303   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
304   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
305   (defalias 'gnus-character-to-event 'identity)
306   (defalias 'gnus-add-text-properties 'add-text-properties)
307   (defalias 'gnus-put-text-property 'put-text-property)
308   (defalias 'gnus-mode-line-buffer-identification 'identity)
309   (defalias 'gnus-characterp 'numberp)
310   (defalias 'gnus-deactivate-mark 'deactivate-mark)
311   (defalias 'gnus-window-edges 'window-edges)
312   (defalias 'gnus-key-press-event-p 'numberp)
313   (defalias 'gnus-decode-rfc1522 'ignore))
314
315 ;; We define these group faces here to avoid the display
316 ;; update forced when creating new faces.
317
318 (defface gnus-group-news-1-face
319   '((((class color)
320       (background dark))
321      (:foreground "PaleTurquoise" :bold t))
322     (((class color)
323       (background light))
324      (:foreground "ForestGreen" :bold t))
325     (t
326      ()))
327   "Level 1 newsgroup face.")
328
329 (defface gnus-group-news-1-empty-face
330   '((((class color)
331       (background dark))
332      (:foreground "PaleTurquoise"))
333     (((class color)
334       (background light))
335      (:foreground "ForestGreen"))
336     (t
337      ()))
338   "Level 1 empty newsgroup face.")
339
340 (defface gnus-group-news-2-face
341   '((((class color)
342       (background dark))
343      (:foreground "turquoise" :bold t))
344     (((class color)
345       (background light))
346      (:foreground "CadetBlue4" :bold t))
347     (t
348      ()))
349   "Level 2 newsgroup face.")
350
351 (defface gnus-group-news-2-empty-face
352   '((((class color)
353       (background dark))
354      (:foreground "turquoise"))
355     (((class color)
356       (background light))
357      (:foreground "CadetBlue4"))
358     (t
359      ()))
360   "Level 2 empty newsgroup face.")
361
362 (defface gnus-group-news-3-face
363   '((((class color)
364       (background dark))
365      (:bold t))
366     (((class color)
367       (background light))
368      (:bold t))
369     (t
370      ()))
371   "Level 3 newsgroup face.")
372
373 (defface gnus-group-news-3-empty-face
374   '((((class color)
375       (background dark))
376      ())
377     (((class color)
378       (background light))
379      ())
380     (t
381      ()))
382   "Level 3 empty newsgroup face.")
383
384 (defface gnus-group-news-4-face
385   '((((class color)
386       (background dark))
387      (:bold t))
388     (((class color)
389       (background light))
390      (:bold t))
391     (t
392      ()))
393   "Level 4 newsgroup face.")
394
395 (defface gnus-group-news-4-empty-face
396   '((((class color)
397       (background dark))
398      ())
399     (((class color)
400       (background light))
401      ())
402     (t
403      ()))
404   "Level 4 empty newsgroup face.")
405
406 (defface gnus-group-news-5-face
407   '((((class color)
408       (background dark))
409      (:bold t))
410     (((class color)
411       (background light))
412      (:bold t))
413     (t
414      ()))
415   "Level 5 newsgroup face.")
416
417 (defface gnus-group-news-5-empty-face
418   '((((class color)
419       (background dark))
420      ())
421     (((class color)
422       (background light))
423      ())
424     (t
425      ()))
426   "Level 5 empty newsgroup face.")
427
428 (defface gnus-group-news-6-face
429   '((((class color)
430       (background dark))
431      (:bold t))
432     (((class color)
433       (background light))
434      (:bold t))
435     (t
436      ()))
437   "Level 6 newsgroup face.")
438
439 (defface gnus-group-news-6-empty-face
440   '((((class color)
441       (background dark))
442      ())
443     (((class color)
444       (background light))
445      ())
446     (t
447      ()))
448   "Level 6 empty newsgroup face.")
449
450 (defface gnus-group-news-low-face
451   '((((class color)
452       (background dark))
453      (:foreground "DarkTurquoise" :bold t))
454     (((class color)
455       (background light))
456      (:foreground "DarkGreen" :bold t))
457     (t
458      ()))
459   "Low level newsgroup face.")
460
461 (defface gnus-group-news-low-empty-face
462   '((((class color)
463       (background dark))
464      (:foreground "DarkTurquoise"))
465     (((class color)
466       (background light))
467      (:foreground "DarkGreen"))
468     (t
469      ()))
470   "Low level empty newsgroup face.")
471
472 (defface gnus-group-mail-1-face
473   '((((class color)
474       (background dark))
475      (:foreground "aquamarine1" :bold t))
476     (((class color)
477       (background light))
478      (:foreground "DeepPink3" :bold t))
479     (t
480      (:bold t)))
481   "Level 1 mailgroup face.")
482
483 (defface gnus-group-mail-1-empty-face
484   '((((class color)
485       (background dark))
486      (:foreground "aquamarine1"))
487     (((class color)
488       (background light))
489      (:foreground "DeepPink3"))
490     (t
491      (:italic t :bold t)))
492   "Level 1 empty mailgroup face.")
493
494 (defface gnus-group-mail-2-face
495   '((((class color)
496       (background dark))
497      (:foreground "aquamarine2" :bold t))
498     (((class color)
499       (background light))
500      (:foreground "HotPink3" :bold t))
501     (t
502      (:bold t)))
503   "Level 2 mailgroup face.")
504
505 (defface gnus-group-mail-2-empty-face
506   '((((class color)
507       (background dark))
508      (:foreground "aquamarine2"))
509     (((class color)
510       (background light))
511      (:foreground "HotPink3"))
512     (t
513      (:bold t)))
514   "Level 2 empty mailgroup face.")
515
516 (defface gnus-group-mail-3-face
517   '((((class color)
518       (background dark))
519      (:foreground "aquamarine3" :bold t))
520     (((class color)
521       (background light))
522      (:foreground "magenta4" :bold t))
523     (t
524      (:bold t)))
525   "Level 3 mailgroup face.")
526
527 (defface gnus-group-mail-3-empty-face
528   '((((class color)
529       (background dark))
530      (:foreground "aquamarine3"))
531     (((class color)
532       (background light))
533      (:foreground "magenta4"))
534     (t
535      ()))
536   "Level 3 empty mailgroup face.")
537
538 (defface gnus-group-mail-low-face
539   '((((class color)
540       (background dark))
541      (:foreground "aquamarine4" :bold t))
542     (((class color)
543       (background light))
544      (:foreground "DeepPink4" :bold t))
545     (t
546      (:bold t)))
547   "Low level mailgroup face.")
548
549 (defface gnus-group-mail-low-empty-face
550   '((((class color)
551       (background dark))
552      (:foreground "aquamarine4"))
553     (((class color)
554       (background light))
555      (:foreground "DeepPink4"))
556     (t
557      (:bold t)))
558   "Low level empty mailgroup face.")
559
560 ;; Summary mode faces.
561
562 (defface gnus-summary-selected-face '((t
563                                        (:underline t)))
564   "Face used for selected articles.")
565
566 (defface gnus-summary-cancelled-face
567   '((((class color))
568      (:foreground "yellow" :background "black")))
569   "Face used for cancelled articles.")
570
571 (defface gnus-summary-high-ticked-face
572   '((((class color)
573       (background dark))
574      (:foreground "pink" :bold t))
575     (((class color)
576       (background light))
577      (:foreground "firebrick" :bold t))
578     (t
579      (:bold t)))
580   "Face used for high interest ticked articles.")
581
582 (defface gnus-summary-low-ticked-face
583   '((((class color)
584       (background dark))
585      (:foreground "pink" :italic t))
586     (((class color)
587       (background light))
588      (:foreground "firebrick" :italic t))
589     (t
590      (:italic t)))
591   "Face used for low interest ticked articles.")
592
593 (defface gnus-summary-normal-ticked-face
594   '((((class color)
595       (background dark))
596      (:foreground "pink"))
597     (((class color)
598       (background light))
599      (:foreground "firebrick"))
600     (t
601      ()))
602   "Face used for normal interest ticked articles.")
603
604 (defface gnus-summary-high-ancient-face
605   '((((class color)
606       (background dark))
607      (:foreground "SkyBlue" :bold t))
608     (((class color)
609       (background light))
610      (:foreground "RoyalBlue" :bold t))
611     (t
612      (:bold t)))
613   "Face used for high interest ancient articles.")
614
615 (defface gnus-summary-low-ancient-face
616   '((((class color)
617       (background dark))
618      (:foreground "SkyBlue" :italic t))
619     (((class color)
620       (background light))
621      (:foreground "RoyalBlue" :italic t))
622     (t
623      (:italic t)))
624   "Face used for low interest ancient articles.")
625
626 (defface gnus-summary-normal-ancient-face
627   '((((class color)
628       (background dark))
629      (:foreground "SkyBlue"))
630     (((class color)
631       (background light))
632      (:foreground "RoyalBlue"))
633     (t
634      ()))
635   "Face used for normal interest ancient articles.")
636
637 (defface gnus-summary-high-unread-face
638   '((t
639      (:bold t)))
640   "Face used for high interest unread articles.")
641
642 (defface gnus-summary-low-unread-face
643   '((t
644      (:italic t)))
645   "Face used for low interest unread articles.")
646
647 (defface gnus-summary-normal-unread-face
648   '((t
649      ()))
650   "Face used for normal interest unread articles.")
651
652 (defface gnus-summary-high-read-face
653   '((((class color)
654       (background dark))
655      (:foreground "PaleGreen"
656                   :bold t))
657     (((class color)
658       (background light))
659      (:foreground "DarkGreen"
660                   :bold t))
661     (t
662      (:bold t)))
663   "Face used for high interest read articles.")
664
665 (defface gnus-summary-low-read-face
666   '((((class color)
667       (background dark))
668      (:foreground "PaleGreen"
669                   :italic t))
670     (((class color)
671       (background light))
672      (:foreground "DarkGreen"
673                   :italic t))
674     (t
675      (:italic t)))
676   "Face used for low interest read articles.")
677
678 (defface gnus-summary-normal-read-face
679   '((((class color)
680       (background dark))
681      (:foreground "PaleGreen"))
682     (((class color)
683       (background light))
684      (:foreground "DarkGreen"))
685     (t
686      ()))
687   "Face used for normal interest read articles.")
688
689
690 ;;;
691 ;;; Gnus buffers
692 ;;;
693
694 (defvar gnus-buffers nil)
695
696 (defun gnus-get-buffer-create (name)
697   "Do the same as `get-buffer-create', but store the created buffer."
698   (or (get-buffer name)
699       (car (push (get-buffer-create name) gnus-buffers))))
700
701 (defun gnus-add-buffer ()
702   "Add the current buffer to the list of Gnus buffers."
703   (push (current-buffer) gnus-buffers))
704
705 (defun gnus-buffers ()
706   "Return a list of live Gnus buffers."
707   (while (and gnus-buffers
708               (not (buffer-name (car gnus-buffers))))
709     (pop gnus-buffers))
710   (let ((buffers gnus-buffers))
711     (while (cdr buffers)
712       (if (buffer-name (cadr buffers))
713           (pop buffers)
714         (setcdr buffers (cddr buffers)))))
715   gnus-buffers)
716
717 ;;; Splash screen.
718
719 (defvar gnus-group-buffer "*Group*")
720
721 (eval-and-compile
722   (autoload 'gnus-play-jingle "gnus-audio"))
723
724 (defface gnus-splash-face
725   '((((class color)
726       (background dark))
727      (:foreground "Brown"))
728     (((class color)
729       (background light))
730      (:foreground "Brown"))
731     (t
732      ()))
733   "Face of the splash screen.")
734
735 (defun gnus-splash ()
736   (save-excursion
737     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
738     (let ((buffer-read-only nil))
739       (erase-buffer)
740       (unless gnus-inhibit-startup-message
741         (gnus-group-startup-message)
742         (sit-for 0)
743         (when gnus-play-startup-jingle
744           (gnus-play-jingle))))))
745
746 (defun gnus-indent-rigidly (start end arg)
747   "Indent rigidly using only spaces and no tabs."
748   (save-excursion
749     (save-restriction
750       (narrow-to-region start end)
751       (let ((tab-width 8))
752         (indent-rigidly start end arg)
753         ;; We translate tabs into spaces -- not everybody uses
754         ;; an 8-character tab.
755         (goto-char (point-min))
756         (while (search-forward "\t" nil t)
757           (replace-match "        " t t))))))
758
759 (defvar gnus-simple-splash nil)
760
761 (defun gnus-group-startup-message (&optional x y)
762   "Insert startup message in current buffer."
763   ;; Insert the message.
764   (erase-buffer)
765   (insert
766    (format "              %s
767           _    ___ _             _
768           _ ___ __ ___  __    _ ___
769           __   _     ___    __  ___
770               _           ___     _
771              _  _ __             _
772              ___   __            _
773                    __           _
774                     _      _   _
775                    _      _    _
776                       _  _    _
777                   __  ___
778                  _   _ _     _
779                 _   _
780               _    _
781              _    _
782             _
783           __
784
785 "
786            ""))
787   ;; And then hack it.
788   (gnus-indent-rigidly (point-min) (point-max)
789                        (/ (max (- (window-width) (or x 46)) 0) 2))
790   (goto-char (point-min))
791   (forward-line 1)
792   (let* ((pheight (count-lines (point-min) (point-max)))
793          (wheight (window-height))
794          (rest (- wheight pheight)))
795     (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
796   ;; Fontify some.
797   (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
798   (goto-char (point-min))
799   (setq mode-line-buffer-identification (concat " " gnus-version))
800   (setq gnus-simple-splash t)
801   (set-buffer-modified-p t))
802
803 (eval-when (load)
804   (let ((command (format "%s" this-command)))
805     (if (and (string-match "gnus" command)
806              (not (string-match "gnus-other-frame" command)))
807         (gnus-splash)
808       (gnus-get-buffer-create gnus-group-buffer))))
809
810 ;;; Do the rest.
811
812 (require 'custom)
813 (require 'gnus-util)
814 (require 'nnheader)
815
816 (defcustom gnus-home-directory "~/"
817   "Directory variable that specifies the \"home\" directory.
818 All other Gnus path variables are initialized from this variable."
819   :group 'gnus-files
820   :type 'directory)
821
822 (defcustom gnus-directory (or (getenv "SAVEDIR")
823                               (nnheader-concat gnus-home-directory "News/"))
824   "*Directory variable from which all other Gnus file variables are derived.
825
826 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
827 This means that other directory variables that are initialized from
828 this variable won't be set properly if you set this variable in `.gnus.el'.
829 Set this variable in `.emacs' instead."
830   :group 'gnus-files
831   :type 'directory)
832
833 (defcustom gnus-default-directory nil
834   "*Default directory for all Gnus buffers."
835   :group 'gnus-files
836   :type '(choice (const :tag "current" nil)
837                  directory))
838
839 ;; Site dependent variables.  These variables should be defined in
840 ;; paths.el.
841
842 (defvar gnus-default-nntp-server nil
843   "Specify a default NNTP server.
844 This variable should be defined in paths.el, and should never be set
845 by the user.
846 If you want to change servers, you should use `gnus-select-method'.
847 See the documentation to that variable.")
848
849 ;; Don't touch this variable.
850 (defvar gnus-nntp-service "nntp"
851   "NNTP service name (\"nntp\" or 119).
852 This is an obsolete variable, which is scarcely used.  If you use an
853 nntp server for your newsgroup and want to change the port number
854 used to 899, you would say something along these lines:
855
856  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
857
858 (defcustom gnus-nntpserver-file "/etc/nntpserver"
859   "A file with only the name of the nntp server in it."
860   :group 'gnus-files
861   :group 'gnus-server
862   :type 'file)
863
864 ;; This function is used to check both the environment variable
865 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
866 ;; an nntp server name default.
867 (defun gnus-getenv-nntpserver ()
868   (or (getenv "NNTPSERVER")
869       (and (file-readable-p gnus-nntpserver-file)
870            (save-excursion
871              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
872              (insert-file-contents gnus-nntpserver-file)
873              (let ((name (buffer-string)))
874                (prog1
875                    (if (string-match "\\'[ \t\n]*$" name)
876                        nil
877                      name)
878                  (kill-buffer (current-buffer))))))))
879
880 (defcustom gnus-select-method
881   (ignore-errors
882     (nconc
883      (list 'nntp (or (ignore-errors
884                        (gnus-getenv-nntpserver))
885                      (when (and gnus-default-nntp-server
886                                 (not (string= gnus-default-nntp-server "")))
887                        gnus-default-nntp-server)
888                      "news"))
889      (if (or (null gnus-nntp-service)
890              (equal gnus-nntp-service "nntp"))
891          nil
892        (list gnus-nntp-service))))
893   "*Default method for selecting a newsgroup.
894 This variable should be a list, where the first element is how the
895 news is to be fetched, the second is the address.
896
897 For instance, if you want to get your news via NNTP from
898 \"flab.flab.edu\", you could say:
899
900 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
901
902 If you want to use your local spool, say:
903
904 \(setq gnus-select-method (list 'nnspool (system-name)))
905
906 If you use this variable, you must set `gnus-nntp-server' to nil.
907
908 There is a lot more to know about select methods and virtual servers -
909 see the manual for details."
910   :group 'gnus-server
911   :type 'gnus-select-method)
912
913 (defcustom gnus-message-archive-method
914   `(nnfolder
915     "archive"
916     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
917     (nnfolder-active-file
918      ,(nnheader-concat message-directory "archive/active"))
919     (nnfolder-get-new-mail nil)
920     (nnfolder-inhibit-expiry t))
921   "*Method used for archiving messages you've sent.
922 This should be a mail method.
923
924 It's probably not a very effective to change this variable once you've
925 run Gnus once.  After doing that, you must edit this server from the
926 server buffer."
927   :group 'gnus-server
928   :group 'gnus-message
929   :type 'gnus-select-method)
930
931 (defcustom gnus-message-archive-group nil
932   "*Name of the group in which to save the messages you've written.
933 This can either be a string; a list of strings; or an alist
934 of regexps/functions/forms to be evaluated to return a string (or a list
935 of strings).  The functions are called with the name of the current
936 group (or nil) as a parameter.
937
938 If you want to save your mail in one group and the news articles you
939 write in another group, you could say something like:
940
941  \(setq gnus-message-archive-group
942         '((if (message-news-p)
943               \"misc-news\"
944             \"misc-mail\")))
945
946 Normally the group names returned by this variable should be
947 unprefixed -- which implicitly means \"store on the archive server\".
948 However, you may wish to store the message on some other server.  In
949 that case, just return a fully prefixed name of the group --
950 \"nnml+private:mail.misc\", for instance."
951   :group 'gnus-message
952   :type '(choice (const :tag "none" nil)
953                  function
954                  sexp
955                  string))
956
957 (defcustom gnus-secondary-servers nil
958   "List of NNTP servers that the user can choose between interactively.
959 To make Gnus query you for a server, you have to give `gnus' a
960 non-numeric prefix - `C-u M-x gnus', in short."
961   :group 'gnus-server
962   :type '(repeat string))
963
964 (defcustom gnus-nntp-server nil
965   "*The name of the host running the NNTP server.
966 This variable is semi-obsolete.  Use the `gnus-select-method'
967 variable instead."
968   :group 'gnus-server
969   :type '(choice (const :tag "disable" nil)
970                  string))
971
972 (defcustom gnus-secondary-select-methods nil
973   "A list of secondary methods that will be used for reading news.
974 This is a list where each element is a complete select method (see
975 `gnus-select-method').
976
977 If, for instance, you want to read your mail with the nnml backend,
978 you could set this variable:
979
980 \(setq gnus-secondary-select-methods '((nnml \"\")))"
981 :group 'gnus-server
982 :type '(repeat gnus-select-method))
983
984 (defvar gnus-backup-default-subscribed-newsgroups
985   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
986   "Default default new newsgroups the first time Gnus is run.
987 Should be set in paths.el, and shouldn't be touched by the user.")
988
989 (defcustom gnus-local-domain nil
990   "Local domain name without a host name.
991 The DOMAINNAME environment variable is used instead if it is defined.
992 If the `system-name' function returns the full Internet name, there is
993 no need to set this variable."
994   :group 'gnus-message
995   :type '(choice (const :tag "default" nil)
996                  string))
997
998 (defvar gnus-local-organization nil
999   "String with a description of what organization (if any) the user belongs to.
1000 Obsolete variable; use `message-user-organization' instead.")
1001
1002 ;; Customization variables
1003
1004 (defcustom gnus-refer-article-method nil
1005   "Preferred method for fetching an article by Message-ID.
1006 If you are reading news from the local spool (with nnspool), fetching
1007 articles by Message-ID is painfully slow.  By setting this method to an
1008 nntp method, you might get acceptable results.
1009
1010 The value of this variable must be a valid select method as discussed
1011 in the documentation of `gnus-select-method'.
1012
1013 It can also be a list of select methods, as well as the special symbol
1014 `current', which means to use the current select method.  If it is a
1015 list, Gnus will try all the methods in the list until it finds a match."
1016   :group 'gnus-server
1017   :type '(choice (const :tag "default" nil)
1018                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1019                  gnus-select-method
1020                  (repeat :menu-tag "Try multiple" 
1021                          :tag "Multiple"
1022                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1023                          (choice :tag "Method"
1024                                  (const current)
1025                                  (const :tag "DejaNews" 
1026                                         (nnweb "refer" (nnweb-type dejanews)))
1027                                  gnus-select-method))))
1028
1029 (defcustom gnus-group-faq-directory
1030   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1031     "/ftp@sunsite.auc.dk:/pub/usenet/"
1032     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1033     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1034     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1035     "/ftp@rtfm.mit.edu:/pub/usenet/"
1036     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1037     "/ftp@ftp.sunet.se:/pub/usenet/"
1038     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1039     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1040     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1041   "*Directory where the group FAQs are stored.
1042 This will most commonly be on a remote machine, and the file will be
1043 fetched by ange-ftp.
1044
1045 This variable can also be a list of directories.  In that case, the
1046 first element in the list will be used by default.  The others can
1047 be used when being prompted for a site.
1048
1049 Note that Gnus uses an aol machine as the default directory.  If this
1050 feels fundamentally unclean, just think of it as a way to finally get
1051 something of value back from them.
1052
1053 If the default site is too slow, try one of these:
1054
1055    North America: mirrors.aol.com                /pub/rtfm/usenet
1056                   ftp.seas.gwu.edu               /pub/rtfm
1057                   rtfm.mit.edu                   /pub/usenet
1058    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1059                   src.doc.ic.ac.uk               /usenet/news-FAQS
1060                   ftp.sunet.se                   /pub/usenet
1061                   sunsite.auc.dk                 /pub/usenet
1062    Asia:          nctuccca.edu.tw                /USENET/FAQ
1063                   hwarang.postech.ac.kr          /pub/usenet
1064                   ftp.hk.super.net               /mirror/faqs"
1065   :group 'gnus-group-various
1066   :type '(choice directory
1067                  (repeat directory)))
1068
1069 (defcustom gnus-use-cross-reference t
1070   "*Non-nil means that cross referenced articles will be marked as read.
1071 If nil, ignore cross references.  If t, mark articles as read in
1072 subscribed newsgroups.  If neither t nor nil, mark as read in all
1073 newsgroups."
1074   :group 'gnus-server
1075   :type '(choice (const :tag "off" nil)
1076                  (const :tag "subscribed" t)
1077                  (sexp :format "all"
1078                        :value always)))
1079
1080 (defcustom gnus-process-mark ?#
1081   "*Process mark."
1082   :group 'gnus-group-visual
1083   :group 'gnus-summary-marks
1084   :type 'character)
1085
1086 (defcustom gnus-asynchronous nil
1087   "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1088   :group 'gnus-asynchronous
1089   :type 'boolean)
1090
1091 (defcustom gnus-large-newsgroup 200
1092   "*The number of articles which indicates a large newsgroup.
1093 If the number of articles in a newsgroup is greater than this value,
1094 confirmation is required for selecting the newsgroup."
1095   :group 'gnus-group-select
1096   :type 'integer)
1097
1098 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1099   "*Non-nil means that the default name of a file to save articles in is the group name.
1100 If it's nil, the directory form of the group name is used instead.
1101
1102 If this variable is a list, and the list contains the element
1103 `not-score', long file names will not be used for score files; if it
1104 contains the element `not-save', long file names will not be used for
1105 saving; and if it contains the element `not-kill', long file names
1106 will not be used for kill files.
1107
1108 Note that the default for this variable varies according to what system
1109 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1110 to nil while on all other systems it defaults to t."
1111   :group 'gnus-start
1112   :type 'boolean)
1113
1114 (defcustom gnus-kill-files-directory gnus-directory
1115   "*Name of the directory where kill files will be stored (default \"~/News\")."
1116   :group 'gnus-score-files
1117   :group 'gnus-score-kill
1118   :type 'directory)
1119
1120 (defcustom gnus-save-score nil
1121   "*If non-nil, save group scoring info."
1122   :group 'gnus-score-various
1123   :group 'gnus-start
1124   :type 'boolean)
1125
1126 (defcustom gnus-use-undo t
1127   "*If non-nil, allow undoing in Gnus group mode buffers."
1128   :group 'gnus-meta
1129   :type 'boolean)
1130
1131 (defcustom gnus-use-adaptive-scoring nil
1132   "*If non-nil, use some adaptive scoring scheme.
1133 If a list, then the values `word' and `line' are meaningful.  The
1134 former will perform adaption on individual words in the subject
1135 header while `line' will perform adaption on several headers."
1136   :group 'gnus-meta
1137   :group 'gnus-score-adapt
1138   :type '(set (const word) (const line)))
1139
1140 (defcustom gnus-use-cache 'passive
1141   "*If nil, Gnus will ignore the article cache.
1142 If `passive', it will allow entering (and reading) articles
1143 explicitly entered into the cache.  If anything else, use the
1144 cache to the full extent of the law."
1145   :group 'gnus-meta
1146   :group 'gnus-cache
1147   :type '(choice (const :tag "off" nil)
1148                  (const :tag "passive" passive)
1149                  (const :tag "active" t)))
1150
1151 (defcustom gnus-use-trees nil
1152   "*If non-nil, display a thread tree buffer."
1153   :group 'gnus-meta
1154   :type 'boolean)
1155
1156 (defcustom gnus-use-grouplens nil
1157   "*If non-nil, use GroupLens ratings."
1158   :group 'gnus-meta
1159   :type 'boolean)
1160
1161 (defcustom gnus-keep-backlog nil
1162   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1163 If it is a number N, then Gnus will only keep the last N articles
1164 read.  If it is neither nil nor a number, Gnus will keep all read
1165 articles.  This is not a good idea."
1166   :group 'gnus-meta
1167   :type '(choice (const :tag "off" nil)
1168                  integer
1169                  (sexp :format "all"
1170                        :value t)))
1171
1172 (defcustom gnus-use-nocem nil
1173   "*If non-nil, Gnus will read NoCeM cancel messages."
1174   :group 'gnus-meta
1175   :type 'boolean)
1176
1177 (defcustom gnus-suppress-duplicates nil
1178   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1179   :group 'gnus-meta
1180   :type 'boolean)
1181
1182 (defcustom gnus-use-scoring t
1183   "*If non-nil, enable scoring."
1184   :group 'gnus-meta
1185   :type 'boolean)
1186
1187 (defcustom gnus-use-picons nil
1188   "*If non-nil, display picons in a frame of their own."
1189   :group 'gnus-meta
1190   :type 'boolean)
1191
1192 (defcustom gnus-summary-prepare-exit-hook
1193   '(gnus-summary-expire-articles)
1194   "*A hook called when preparing to exit from the summary buffer.
1195 It calls `gnus-summary-expire-articles' by default."
1196   :group 'gnus-summary-exit
1197   :type 'hook)
1198
1199 (defcustom gnus-novice-user t
1200   "*Non-nil means that you are a usenet novice.
1201 If non-nil, verbose messages may be displayed and confirmations may be
1202 required."
1203   :group 'gnus-meta
1204   :type 'boolean)
1205
1206 (defcustom gnus-expert-user nil
1207   "*Non-nil means that you will never be asked for confirmation about anything.
1208 That doesn't mean *anything* anything; particularly destructive
1209 commands will still require prompting."
1210   :group 'gnus-meta
1211   :type 'boolean)
1212
1213 (defcustom gnus-interactive-catchup t
1214   "*If non-nil, require your confirmation when catching up a group."
1215   :group 'gnus-group-select
1216   :type 'boolean)
1217
1218 (defcustom gnus-interactive-exit t
1219   "*If non-nil, require your confirmation when exiting Gnus."
1220   :group 'gnus-exit
1221   :type 'boolean)
1222
1223 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1224   "*Function for extracting address components from a From header.
1225 Two pre-defined function exist: `gnus-extract-address-components',
1226 which is the default, quite fast, and too simplistic solution, and
1227 `mail-extract-address-components', which works much better, but is
1228 slower."
1229   :group 'gnus-summary-format
1230   :type '(radio (function-item gnus-extract-address-components)
1231                 (function-item mail-extract-address-components)
1232                 (function :tag "Other")))
1233
1234 (defcustom gnus-carpal nil
1235   "*If non-nil, display clickable icons."
1236   :group 'gnus-meta
1237   :type 'boolean)
1238
1239 (defcustom gnus-shell-command-separator ";"
1240   "String used to separate to shell commands."
1241   :group 'gnus-files
1242   :type 'string)
1243
1244 (defcustom gnus-valid-select-methods
1245   '(("nntp" post address prompt-address physical-address)
1246     ("nnspool" post address)
1247     ("nnvirtual" post-mail virtual prompt-address)
1248     ("nnmbox" mail respool address)
1249     ("nnml" mail respool address)
1250     ("nnmh" mail respool address)
1251     ("nndir" post-mail prompt-address physical-address)
1252     ("nneething" none address prompt-address physical-address)
1253     ("nndoc" none address prompt-address)
1254     ("nnbabyl" mail address respool)
1255     ("nnkiboze" post virtual)
1256     ("nnsoup" post-mail address)
1257     ("nndraft" post-mail)
1258     ("nnfolder" mail respool address)
1259     ("nngateway" post-mail address prompt-address physical-address)
1260     ("nnweb" none)
1261     ("nnslashdot" post)
1262     ("nnultimate" none)
1263     ("nnwarchive" none)
1264     ("nnlistserv" none)
1265     ("nnagent" post-mail)
1266     ("nnimap" post-mail address prompt-address physical-address))
1267   "*An alist of valid select methods.
1268 The first element of each list lists should be a string with the name
1269 of the select method.  The other elements may be the category of
1270 this method (i. e., `post', `mail', `none' or whatever) or other
1271 properties that this method has (like being respoolable).
1272 If you implement a new select method, all you should have to change is
1273 this variable.  I think."
1274   :group 'gnus-server
1275   :type '(repeat (group (string :tag "Name")
1276                         (radio-button-choice (const :format "%v " post)
1277                                              (const :format "%v " mail)
1278                                              (const :format "%v " none)
1279                                              (const post-mail))
1280                         (checklist :inline t
1281                                    (const :format "%v " address)
1282                                    (const :format "%v " prompt-address)
1283                                    (const :format "%v " physical-address)
1284                                    (const :format "%v " virtual)
1285                                    (const respool)))))
1286
1287 (define-widget 'gnus-select-method 'list
1288   "Widget for entering a select method."
1289   :value '(nntp "")
1290   :tag "Select Method"
1291   :args `((choice :tag "Method"
1292                   ,@(mapcar (lambda (entry)
1293                               (list 'const :format "%v\n"
1294                                     (intern (car entry))))
1295                             gnus-valid-select-methods))
1296           (string :tag "Address")
1297           (editable-list  :inline t
1298                           (list :format "%v"
1299                                 variable
1300                                 (sexp :tag "Value")))))
1301
1302 (defcustom gnus-updated-mode-lines '(group article summary tree)
1303   "List of buffers that should update their mode lines.
1304 The list may contain the symbols `group', `article', `tree' and
1305 `summary'.  If the corresponding symbol is present, Gnus will keep
1306 that mode line updated with information that may be pertinent.
1307 If this variable is nil, screen refresh may be quicker."
1308   :group 'gnus-various
1309   :type '(set (const group)
1310               (const article)
1311               (const summary)
1312               (const tree)))
1313
1314 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1315 (defcustom gnus-mode-non-string-length nil
1316   "*Max length of mode-line non-string contents.
1317 If this is nil, Gnus will take space as is needed, leaving the rest
1318 of the modeline intact.  Note that the default of nil is unlikely
1319 to be desirable; see the manual for further details."
1320   :group 'gnus-various
1321   :type '(choice (const nil)
1322                  integer))
1323
1324 (defcustom gnus-auto-expirable-newsgroups nil
1325   "*Groups in which to automatically mark read articles as expirable.
1326 If non-nil, this should be a regexp that should match all groups in
1327 which to perform auto-expiry.  This only makes sense for mail groups."
1328   :group 'nnmail-expire
1329   :type '(choice (const nil)
1330                  regexp))
1331
1332 (defcustom gnus-total-expirable-newsgroups nil
1333   "*Groups in which to perform expiry of all read articles.
1334 Use with extreme caution.  All groups that match this regexp will be
1335 expiring - which means that all read articles will be deleted after
1336 \(say) one week.         (This only goes for mail groups and the like, of
1337 course.)"
1338   :group 'nnmail-expire
1339   :type '(choice (const nil)
1340                  regexp))
1341
1342 (defcustom gnus-group-uncollapsed-levels 1
1343   "Number of group name elements to leave alone when making a short group name."
1344   :group 'gnus-group-visual
1345   :type 'integer)
1346
1347 (defcustom gnus-group-use-permanent-levels nil
1348   "*If non-nil, once you set a level, Gnus will use this level."
1349   :group 'gnus-group-levels
1350   :type 'boolean)
1351
1352 ;; Hooks.
1353
1354 (defcustom gnus-load-hook nil
1355   "A hook run while Gnus is loaded."
1356   :group 'gnus-start
1357   :type 'hook)
1358
1359 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1360   "A hook called to apply kill files to a group.
1361 This hook is intended to apply a kill file to the selected newsgroup.
1362 The function `gnus-apply-kill-file' is called by default.
1363
1364 Since a general kill file is too heavy to use only for a few
1365 newsgroups, I recommend you to use a lighter hook function.  For
1366 example, if you'd like to apply a kill file to articles which contains
1367 a string `rmgroup' in subject in newsgroup `control', you can use the
1368 following hook:
1369
1370  (setq gnus-apply-kill-hook
1371       (list
1372         (lambda ()
1373           (cond ((string-match \"control\" gnus-newsgroup-name)
1374                  (gnus-kill \"Subject\" \"rmgroup\")
1375                  (gnus-expunge \"X\"))))))"
1376   :group 'gnus-score-kill
1377   :options '(gnus-apply-kill-file)
1378   :type 'hook)
1379
1380 (defcustom gnus-group-change-level-function nil
1381   "Function run when a group level is changed.
1382 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1383   :group 'gnus-group-levels
1384   :type 'function)
1385
1386 ;;; Face thingies.
1387
1388 (defcustom gnus-visual
1389   '(summary-highlight group-highlight article-highlight
1390                       mouse-face
1391                       summary-menu group-menu article-menu
1392                       tree-highlight menu highlight
1393                       browse-menu server-menu
1394                       page-marker tree-menu binary-menu pick-menu
1395                       grouplens-menu)
1396   "*Enable visual features.
1397 If `visual' is disabled, there will be no menus and few faces.  Most of
1398 the visual customization options below will be ignored.  Gnus will use
1399 less space and be faster as a result.
1400
1401 This variable can also be a list of visual elements to switch on.  For
1402 instance, to switch off all visual things except menus, you can say:
1403
1404    (setq gnus-visual '(menu))
1405
1406 Valid elements include `summary-highlight', `group-highlight',
1407 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1408 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1409 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1410 and `grouplens-menu'."
1411   :group 'gnus-meta
1412   :group 'gnus-visual
1413   :type '(set (const summary-highlight)
1414               (const group-highlight)
1415               (const article-highlight)
1416               (const mouse-face)
1417               (const summary-menu)
1418               (const group-menu)
1419               (const article-menu)
1420               (const tree-highlight)
1421               (const menu)
1422               (const highlight)
1423               (const browse-menu)
1424               (const server-menu)
1425               (const page-marker)
1426               (const tree-menu)
1427               (const binary-menu)
1428               (const pick-menu)
1429               (const grouplens-menu)))
1430
1431 (defcustom gnus-mouse-face
1432   (condition-case ()
1433       (if (gnus-visual-p 'mouse-face 'highlight)
1434           (if (boundp 'gnus-mouse-face)
1435               (or gnus-mouse-face 'highlight)
1436             'highlight)
1437         'default)
1438     (error 'highlight))
1439   "*Face used for group or summary buffer mouse highlighting.
1440 The line beneath the mouse pointer will be highlighted with this
1441 face."
1442   :group 'gnus-visual
1443   :type 'face)
1444
1445 (defcustom gnus-article-save-directory gnus-directory
1446   "*Name of the directory articles will be saved in (default \"~/News\")."
1447   :group 'gnus-article-saving
1448   :type 'directory)
1449
1450 (defvar gnus-plugged t
1451   "Whether Gnus is plugged or not.")
1452
1453 (defcustom gnus-default-charset 'iso-8859-1
1454   "Default charset assumed to be used when viewing non-ASCII characters.
1455 This variable is overridden on a group-to-group basis by the
1456 gnus-group-charset-alist variable and is only used on groups not
1457 covered by that variable."
1458   :type 'symbol
1459   :group 'gnus-charset)
1460
1461 (defcustom gnus-default-posting-charset nil
1462   "Default charset assumed to be used when posting non-ASCII characters.
1463 This variable is overridden on a group-to-group basis by the
1464 gnus-group-posting-charset-alist variable and is only used on groups not
1465 covered by that variable.
1466 If nil, no default charset is assumed when posting."
1467   :type 'symbol
1468   :group 'gnus-charset)
1469
1470 \f
1471 ;;; Internal variables
1472
1473 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1474 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1475 (defvar gnus-original-article-buffer " *Original Article*")
1476 (defvar gnus-newsgroup-name nil)
1477 (defvar gnus-ephemeral-servers nil)
1478
1479 (defvar gnus-agent nil
1480   "Whether we want to use the Gnus agent or not.")
1481
1482 (defvar gnus-command-method nil
1483   "Dynamically bound variable that says what the current backend is.")
1484
1485 (defvar gnus-current-select-method nil
1486   "The current method for selecting a newsgroup.")
1487
1488 (defvar gnus-tree-buffer "*Tree*"
1489   "Buffer where Gnus thread trees are displayed.")
1490
1491 ;; Dummy variable.
1492 (defvar gnus-use-generic-from nil)
1493
1494 ;; Variable holding the user answers to all method prompts.
1495 (defvar gnus-method-history nil)
1496
1497 ;; Variable holding the user answers to all mail method prompts.
1498 (defvar gnus-mail-method-history nil)
1499
1500 ;; Variable holding the user answers to all group prompts.
1501 (defvar gnus-group-history nil)
1502
1503 (defvar gnus-server-alist nil
1504   "List of available servers.")
1505
1506 (defcustom gnus-cache-directory
1507   (nnheader-concat gnus-directory "cache/")
1508   "*The directory where cached articles will be stored."
1509   :group 'gnus-cache
1510   :type 'directory)
1511
1512 (defvar gnus-predefined-server-alist
1513   `(("cache"
1514      nnspool "cache"
1515      (nnspool-spool-directory ,gnus-cache-directory)
1516      (nnspool-nov-directory ,gnus-cache-directory)
1517      (nnspool-active-file
1518       ,(nnheader-concat gnus-cache-directory "active"))))
1519   "List of predefined (convenience) servers.")
1520
1521 (defvar gnus-topic-indentation "");; Obsolete variable.
1522
1523 (defconst gnus-article-mark-lists
1524   '((marked . tick) (replied . reply)
1525     (expirable . expire) (killed . killed)
1526     (bookmarks . bookmark) (dormant . dormant)
1527     (scored . score) (saved . save)
1528     (cached . cache) (downloadable . download)
1529     (unsendable . unsend)))
1530
1531 (defvar gnus-headers-retrieved-by nil)
1532 (defvar gnus-article-reply nil)
1533 (defvar gnus-override-method nil)
1534 (defvar gnus-article-check-size nil)
1535 (defvar gnus-opened-servers nil)
1536
1537 (defvar gnus-current-kill-article nil)
1538
1539 (defvar gnus-have-read-active-file nil)
1540
1541 (defconst gnus-maintainer
1542   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1543   "The mail address of the Gnus maintainers.")
1544
1545 (defconst semi-gnus-developers
1546   "Semi-gnus Developers:
1547  semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1548  semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1549   "The mail address of the Semi-gnus developers.")
1550
1551 (defvar gnus-info-nodes
1552   '((gnus-group-mode "(gnus)The Group Buffer")
1553     (gnus-summary-mode "(gnus)The Summary Buffer")
1554     (gnus-article-mode "(gnus)The Article Buffer")
1555     (gnus-server-mode "(gnus)The Server Buffer")
1556     (gnus-browse-mode "(gnus)Browse Foreign Server")
1557     (gnus-tree-mode "(gnus)Tree Display"))
1558   "Alist of major modes and related Info nodes.")
1559
1560 (defvar gnus-group-buffer "*Group*")
1561 (defvar gnus-summary-buffer "*Summary*")
1562 (defvar gnus-article-buffer "*Article*")
1563 (defvar gnus-server-buffer "*Server*")
1564
1565 (defvar gnus-slave nil
1566   "Whether this Gnus is a slave or not.")
1567
1568 (defvar gnus-batch-mode nil
1569   "Whether this Gnus is running in batch mode or not.")
1570
1571 (defvar gnus-variable-list
1572   '(gnus-newsrc-options gnus-newsrc-options-n
1573     gnus-newsrc-last-checked-date
1574     gnus-newsrc-alist gnus-server-alist
1575     gnus-killed-list gnus-zombie-list
1576     gnus-topic-topology gnus-topic-alist
1577     gnus-format-specs)
1578   "Gnus variables saved in the quick startup file.")
1579
1580 (defvar gnus-newsrc-alist nil
1581   "Assoc list of read articles.
1582 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1583
1584 (defvar gnus-newsrc-hashtb nil
1585   "Hashtable of gnus-newsrc-alist.")
1586
1587 (defvar gnus-killed-list nil
1588   "List of killed newsgroups.")
1589
1590 (defvar gnus-killed-hashtb nil
1591   "Hash table equivalent of gnus-killed-list.")
1592
1593 (defvar gnus-zombie-list nil
1594   "List of almost dead newsgroups.")
1595
1596 (defvar gnus-description-hashtb nil
1597   "Descriptions of newsgroups.")
1598
1599 (defvar gnus-list-of-killed-groups nil
1600   "List of newsgroups that have recently been killed by the user.")
1601
1602 (defvar gnus-active-hashtb nil
1603   "Hashtable of active articles.")
1604
1605 (defvar gnus-moderated-hashtb nil
1606   "Hashtable of moderated newsgroups.")
1607
1608 ;; Save window configuration.
1609 (defvar gnus-prev-winconf nil)
1610
1611 (defvar gnus-reffed-article-number nil)
1612
1613 ;;; Let the byte-compiler know that we know about this variable.
1614 (defvar rmail-default-rmail-file)
1615
1616 (defvar gnus-dead-summary nil)
1617
1618 ;;; End of variables.
1619
1620 ;; Define some autoload functions Gnus might use.
1621 (eval-and-compile
1622
1623   ;; This little mapcar goes through the list below and marks the
1624   ;; symbols in question as autoloaded functions.
1625   (mapcar
1626    (lambda (package)
1627      (let ((interactive (nth 1 (memq ':interactive package))))
1628        (mapcar
1629         (lambda (function)
1630           (let (keymap)
1631             (when (consp function)
1632               (setq keymap (car (memq 'keymap function)))
1633               (setq function (car function)))
1634             (autoload function (car package) nil interactive keymap)))
1635         (if (eq (nth 1 package) ':interactive)
1636             (cdddr package)
1637           (cdr package)))))
1638    '(("metamail" metamail-buffer)
1639      ("info" Info-goto-node)
1640      ("pp" pp pp-to-string pp-eval-expression)
1641      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1642      ("ps-print" ps-print-preprint)
1643      ("mail-extr" mail-extract-address-components)
1644      ("browse-url" browse-url)
1645      ("message" :interactive t
1646       message-send-and-exit message-yank-original)
1647      ("babel" babel-as-string)
1648      ("nnmail" nnmail-split-fancy nnmail-article-group)
1649      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1650      ("rmailout" rmail-output rmail-output-to-rmail-file)
1651      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1652       rmail-show-message rmail-summary-exists
1653       rmail-select-summary rmail-update-summary)
1654      ("gnus-audio" :interactive t gnus-audio-play)
1655      ("gnus-xmas" gnus-xmas-splash)
1656      ("gnus-soup" :interactive t
1657       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1658       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1659      ("nnsoup" nnsoup-pack-replies)
1660      ("score-mode" :interactive t gnus-score-mode)
1661      ("gnus-mh" gnus-summary-save-article-folder
1662       gnus-Folder-save-name gnus-folder-save-name)
1663      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1664      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1665       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1666       gnus-demon-add-disconnection gnus-demon-add-handler
1667       gnus-demon-remove-handler)
1668      ("gnus-demon" :interactive t
1669       gnus-demon-init gnus-demon-cancel)
1670      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1671       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1672      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1673       gnus-nocem-unwanted-article-p)
1674      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1675       gnus-server-server-name)
1676      ("gnus-srvr" gnus-browse-foreign-server)
1677      ("gnus-cite" :interactive t
1678       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1679       gnus-article-hide-citation gnus-article-fill-cited-article
1680       gnus-article-hide-citation-in-followups)
1681      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1682       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1683       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1684      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1685       gnus-cache-possibly-remove-articles gnus-cache-request-article
1686       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1687       gnus-cache-enter-remove-article gnus-cached-article-p
1688       gnus-cache-open gnus-cache-close gnus-cache-update-article)
1689       ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1690        gnus-cache-remove-article gnus-summary-insert-cached-articles)
1691       ("gnus-score" :interactive t
1692        gnus-summary-increase-score gnus-summary-set-score
1693        gnus-summary-raise-thread gnus-summary-raise-same-subject
1694        gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1695        gnus-summary-lower-thread gnus-summary-lower-same-subject
1696        gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1697        gnus-summary-current-score gnus-score-default
1698        gnus-score-flush-cache gnus-score-close
1699        gnus-possibly-score-headers gnus-score-followup-article
1700        gnus-score-followup-thread)
1701       ("gnus-score"
1702        (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1703       gnus-current-score-file-nondirectory gnus-score-adaptive
1704       gnus-score-find-trace gnus-score-file-name)
1705      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1706      ("gnus-topic" :interactive t gnus-topic-mode)
1707      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1708       gnus-subscribe-topics)
1709      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1710      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1711      ("gnus-uu" :interactive t
1712       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1713       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1714       gnus-uu-mark-by-regexp gnus-uu-mark-all
1715       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1716       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1717       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1718       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1719       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1720       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1721       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1722       gnus-uu-mark-over gnus-uu-post-news)
1723      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1724      ("gnus-msg" (gnus-summary-send-map keymap)
1725       gnus-article-mail gnus-copy-article-buffer)
1726      ("gnus-msg" :interactive t
1727       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1728       gnus-summary-followup gnus-summary-followup-with-original
1729       gnus-summary-cancel-article gnus-summary-supersede-article
1730       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1731       gnus-summary-mail-forward gnus-summary-mail-other-window
1732       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1733       gnus-summary-wide-reply gnus-summary-followup-to-mail
1734       gnus-summary-followup-to-mail-with-original gnus-bug
1735       gnus-summary-wide-reply-with-original
1736       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1737       gnus-summary-post-forward)
1738      ("gnus-picon" :interactive t gnus-article-display-picons
1739       gnus-group-display-picons gnus-picons-article-display-x-face
1740       gnus-picons-display-x-face)
1741      ("gnus-picon" gnus-picons-buffer-name)
1742      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1743       gnus-grouplens-mode)
1744      ("smiley" :interactive t gnus-smiley-display)
1745      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1746      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1747       gnus-list-of-unread-articles gnus-list-of-read-articles
1748       gnus-offer-save-summaries gnus-make-thread-indent-array
1749       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1750       gnus-summary-skip-intangible gnus-summary-article-number
1751       gnus-data-header gnus-data-find)
1752      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1753       gnus-group-list-groups gnus-group-first-unread-group
1754       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1755       gnus-group-setup-buffer gnus-group-get-new-news
1756       gnus-group-make-help-group gnus-group-update-group
1757       gnus-group-iterate gnus-group-group-name)
1758      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1759       gnus-backlog-remove-article)
1760      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1761       gnus-article-prepare gnus-article-set-window-start
1762       gnus-article-next-page gnus-article-prev-page
1763       gnus-request-article-this-buffer gnus-article-mode
1764       gnus-article-setup-buffer gnus-narrow-to-page
1765       gnus-article-delete-invisible-text gnus-treat-article)
1766      ("gnus-art" :interactive t
1767       gnus-article-hide-headers gnus-article-hide-boring-headers
1768       gnus-article-treat-overstrike 
1769       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1770       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1771       gnus-article-hide-pgp
1772       gnus-article-hide-pem gnus-article-hide-signature
1773       gnus-article-strip-leading-blank-lines gnus-article-date-local
1774       gnus-article-date-original gnus-article-date-lapsed
1775       gnus-article-show-all-headers
1776       gnus-article-edit-mode gnus-article-edit-article
1777       gnus-article-edit-done gnus-article-decode-encoded-words
1778       gnus-start-date-timer gnus-stop-date-timer
1779       gnus-mime-view-all-parts)
1780      ("gnus-int" gnus-request-type)
1781      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1782       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1783      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1784       gnus-dup-enter-articles)
1785      ("gnus-range" gnus-copy-sequence)
1786      ("gnus-eform" gnus-edit-form)
1787      ("gnus-move" :interactive t
1788       gnus-group-move-group-to-server gnus-change-server)
1789      ("gnus-logic" gnus-score-advanced)
1790      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1791      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1792       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1793       gnus-async-halt-prefetch)
1794      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1795       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1796       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1797       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1798      ("gnus-agent" :interactive t
1799       gnus-unplugged gnus-agentize gnus-agent-batch)
1800      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1801       gnus-summary-save-article-vm)
1802      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1803      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1804      ("gnus-mlspl" :interactive t gnus-group-split-setup
1805       gnus-group-split-update))))
1806
1807 ;;; gnus-sum.el thingies
1808
1809
1810 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1811   "*The format specification of the lines in the summary buffer.
1812
1813 It works along the same lines as a normal formatting string,
1814 with some simple extensions.
1815
1816 %N   Article number, left padded with spaces (string)
1817 %S   Subject (string)
1818 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1819 %n   Name of the poster (string)
1820 %a   Extracted name of the poster (string)
1821 %A   Extracted address of the poster (string)
1822 %F   Contents of the From: header (string)
1823 %f   Contents of the From: or To: headers (string)
1824 %x   Contents of the Xref: header (string)
1825 %D   Date of the article (string)
1826 %d   Date of the article (string) in DD-MMM format
1827 %M   Message-id of the article (string)
1828 %r   References of the article (string)
1829 %c   Number of characters in the article (integer)
1830 %L   Number of lines in the article (integer)
1831 %I   Indentation based on thread level (a string of spaces)
1832 %T   A string with two possible values: 80 spaces if the article
1833      is on thread level two or larger and 0 spaces on level one
1834 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1835 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1836 %[   Opening bracket (character, \"[\" or \"<\")
1837 %]   Closing bracket (character, \"]\" or \">\")
1838 %>   Spaces of length thread-level (string)
1839 %<   Spaces of length (- 20 thread-level) (string)
1840 %i   Article score (number)
1841 %z   Article zcore (character)
1842 %t   Number of articles under the current thread (number).
1843 %e   Whether the thread is empty or not (character).
1844 %l   GroupLens score (string).
1845 %V   Total thread score (number).
1846 %P   The line number (number).
1847 %O   Download mark (character).
1848 %u   User defined specifier.  The next character in the format string should
1849      be a letter.  Gnus will call the function gnus-user-format-function-X,
1850      where X is the letter following %u.  The function will be passed the
1851      current header as argument.  The function should return a string, which
1852      will be inserted into the summary just like information from any other
1853      summary specifier.
1854
1855 Text between %( and %) will be highlighted with `gnus-mouse-face'
1856 when the mouse point is placed inside the area.  There can only be one
1857 such area.
1858
1859 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1860 with care.  For reasons of efficiency, Gnus will compute what column
1861 these characters will end up in, and \"hard-code\" that.  This means that
1862 it is invalid to have these specs after a variable-length spec.  Well,
1863 you might not be arrested, but your summary buffer will look strange,
1864 which is bad enough.
1865
1866 The smart choice is to have these specs as for to the left as
1867 possible.
1868
1869 This restriction may disappear in later versions of Gnus."
1870   :type 'string
1871   :group 'gnus-summary-format)
1872
1873 ;;;
1874 ;;; Skeleton keymaps
1875 ;;;
1876
1877 (defun gnus-suppress-keymap (keymap)
1878   (suppress-keymap keymap)
1879   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1880     (while keys
1881       (define-key keymap (pop keys) 'undefined))))
1882
1883 (defvar gnus-article-mode-map
1884   (let ((keymap (make-sparse-keymap)))
1885     (gnus-suppress-keymap keymap)
1886     keymap))
1887 (defvar gnus-summary-mode-map
1888   (let ((keymap (make-keymap)))
1889     (gnus-suppress-keymap keymap)
1890     keymap))
1891 (defvar gnus-group-mode-map
1892   (let ((keymap (make-keymap)))
1893     (gnus-suppress-keymap keymap)
1894     keymap))
1895
1896 \f
1897
1898 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1899 ;; If you want the cursor to go somewhere else, set these two
1900 ;; functions in some startup hook to whatever you want.
1901 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1902 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1903
1904 ;;; Various macros and substs.
1905
1906 (defun gnus-header-from (header)
1907   (mail-header-from header))
1908
1909 (defmacro gnus-gethash (string hashtable)
1910   "Get hash value of STRING in HASHTABLE."
1911   `(symbol-value (intern-soft ,string ,hashtable)))
1912
1913 (defmacro gnus-sethash (string value hashtable)
1914   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1915   `(set (intern ,string ,hashtable) ,value))
1916 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1917
1918 (defmacro gnus-group-unread (group)
1919   "Get the currently computed number of unread articles in GROUP."
1920   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1921
1922 (defmacro gnus-group-entry (group)
1923   "Get the newsrc entry for GROUP."
1924   `(gnus-gethash ,group gnus-newsrc-hashtb))
1925
1926 (defmacro gnus-active (group)
1927   "Get active info on GROUP."
1928   `(gnus-gethash ,group gnus-active-hashtb))
1929
1930 (defmacro gnus-set-active (group active)
1931   "Set GROUP's active info."
1932   `(gnus-sethash ,group ,active gnus-active-hashtb))
1933
1934 ;; Info access macros.
1935
1936 (defmacro gnus-info-group (info)
1937   `(nth 0 ,info))
1938 (defmacro gnus-info-rank (info)
1939   `(nth 1 ,info))
1940 (defmacro gnus-info-read (info)
1941   `(nth 2 ,info))
1942 (defmacro gnus-info-marks (info)
1943   `(nth 3 ,info))
1944 (defmacro gnus-info-method (info)
1945   `(nth 4 ,info))
1946 (defmacro gnus-info-params (info)
1947   `(nth 5 ,info))
1948
1949 (defmacro gnus-info-level (info)
1950   `(let ((rank (gnus-info-rank ,info)))
1951      (if (consp rank)
1952          (car rank)
1953        rank)))
1954 (defmacro gnus-info-score (info)
1955   `(let ((rank (gnus-info-rank ,info)))
1956      (or (and (consp rank) (cdr rank)) 0)))
1957
1958 (defmacro gnus-info-set-group (info group)
1959   `(setcar ,info ,group))
1960 (defmacro gnus-info-set-rank (info rank)
1961   `(setcar (nthcdr 1 ,info) ,rank))
1962 (defmacro gnus-info-set-read (info read)
1963   `(setcar (nthcdr 2 ,info) ,read))
1964 (defmacro gnus-info-set-marks (info marks &optional extend)
1965   (if extend
1966       `(gnus-info-set-entry ,info ,marks 3)
1967     `(setcar (nthcdr 3 ,info) ,marks)))
1968 (defmacro gnus-info-set-method (info method &optional extend)
1969   (if extend
1970       `(gnus-info-set-entry ,info ,method 4)
1971     `(setcar (nthcdr 4 ,info) ,method)))
1972 (defmacro gnus-info-set-params (info params &optional extend)
1973   (if extend
1974       `(gnus-info-set-entry ,info ,params 5)
1975     `(setcar (nthcdr 5 ,info) ,params)))
1976
1977 (defun gnus-info-set-entry (info entry number)
1978   ;; Extend the info until we have enough elements.
1979   (while (<= (length info) number)
1980     (nconc info (list nil)))
1981   ;; Set the entry.
1982   (setcar (nthcdr number info) entry))
1983
1984 (defmacro gnus-info-set-level (info level)
1985   `(let ((rank (cdr ,info)))
1986      (if (consp (car rank))
1987          (setcar (car rank) ,level)
1988        (setcar rank ,level))))
1989 (defmacro gnus-info-set-score (info score)
1990   `(let ((rank (cdr ,info)))
1991      (if (consp (car rank))
1992          (setcdr (car rank) ,score)
1993        (setcar rank (cons (car rank) ,score)))))
1994
1995 (defmacro gnus-get-info (group)
1996   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1997
1998 ;; Byte-compiler warning.
1999 (defvar gnus-visual)
2000 ;; Find out whether the gnus-visual TYPE is wanted.
2001 (defun gnus-visual-p (&optional type class)
2002   (and gnus-visual                      ; Has to be non-nil, at least.
2003        (if (not type)                   ; We don't care about type.
2004            gnus-visual
2005          (if (listp gnus-visual)        ; It's a list, so we check it.
2006              (or (memq type gnus-visual)
2007                  (memq class gnus-visual))
2008            t))))
2009
2010 ;;; Load the compatability functions.
2011
2012 (require 'gnus-ems)
2013
2014 \f
2015 ;;;
2016 ;;; Shutdown
2017 ;;;
2018
2019 (defvar gnus-shutdown-alist nil)
2020
2021 (defun gnus-add-shutdown (function &rest symbols)
2022   "Run FUNCTION whenever one of SYMBOLS is shut down."
2023   (push (cons function symbols) gnus-shutdown-alist))
2024
2025 (defun gnus-shutdown (symbol)
2026   "Shut down everything that waits for SYMBOL."
2027   (let ((alist gnus-shutdown-alist)
2028         entry)
2029     (while (setq entry (pop alist))
2030       (when (memq symbol (cdr entry))
2031         (funcall (car entry))))))
2032
2033 \f
2034 ;;;
2035 ;;; Gnus Utility Functions
2036 ;;;
2037
2038
2039 (defmacro gnus-string-or (&rest strings)
2040   "Return the first element of STRINGS that is a non-blank string.
2041 STRINGS will be evaluated in normal `or' order."
2042   `(gnus-string-or-1 ',strings))
2043
2044 (defun gnus-string-or-1 (strings)
2045   (let (string)
2046     (while strings
2047       (setq string (eval (pop strings)))
2048       (if (string-match "^[ \t]*$" string)
2049           (setq string nil)
2050         (setq strings nil)))
2051     string))
2052
2053 (defun gnus-version (&optional arg)
2054   "Version number of this version of Gnus.
2055 If ARG, insert string at point."
2056   (interactive "P")
2057   (if arg
2058       (insert (message gnus-version))
2059     (message gnus-version)))
2060
2061 (defun gnus-continuum-version (version)
2062   "Return VERSION as a floating point number."
2063   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2064             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2065     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2066           (number (match-string 2 version))
2067           major minor least)
2068       (unless (string-match
2069                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2070         (error "Invalid version string: %s" version))
2071       (setq major (string-to-number (match-string 1 number))
2072             minor (string-to-number (match-string 2 number))
2073             least (if (match-beginning 3)
2074                       (string-to-number (match-string 3 number))
2075                     0))
2076       (string-to-number
2077        (if (zerop major)
2078            (format "%s00%02d%02d"
2079                    (if (member alpha '("(ding)" "d"))
2080                        "4.99"
2081                      (+ 5 (* 0.02
2082                              (abs
2083                               (- (mm-char-int (aref (downcase alpha) 0))
2084                                  (mm-char-int ?t))))
2085                         -0.01))
2086                    minor least)
2087          (format "%d.%02d%02d" major minor least))))))
2088
2089 (defun gnus-info-find-node ()
2090   "Find Info documentation of Gnus."
2091   (interactive)
2092   ;; Enlarge info window if needed.
2093   (let (gnus-info-buffer)
2094     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2095     (setq gnus-info-buffer (current-buffer))
2096     (gnus-configure-windows 'info)))
2097
2098 ;;;
2099 ;;; gnus-interactive
2100 ;;;
2101
2102 (defvar gnus-current-prefix-symbol nil
2103   "Current prefix symbol.")
2104
2105 (defvar gnus-current-prefix-symbols nil
2106   "List of current prefix symbols.")
2107
2108 (defun gnus-interactive (string &optional params)
2109   "Return a list that can be fed to `interactive'.
2110 See `interactive' for full documentation.
2111
2112 Adds the following specs:
2113
2114 y -- The current symbolic prefix.
2115 Y -- A list of the current symbolic prefix(es).
2116 A -- Article number.
2117 H -- Article header.
2118 g -- Group name."
2119   (let ((i 0)
2120         out c prompt)
2121     (while (< i (length string))
2122       (string-match ".\\([^\n]*\\)\n?" string i)
2123       (setq c (aref string i))
2124       (when (match-end 1)
2125         (setq prompt (match-string 1 string)))
2126       (setq i (match-end 0))
2127       ;; We basically emulate just about everything that
2128       ;; `interactive' does, but add the specs listed above.
2129       (push
2130        (cond
2131         ((= c ?a)
2132          (completing-read prompt obarray 'fboundp t))
2133         ((= c ?b)
2134          (read-buffer prompt (current-buffer) t))
2135         ((= c ?B)
2136          (read-buffer prompt (other-buffer (current-buffer))))
2137         ((= c ?c)
2138          (read-char))
2139         ((= c ?C)
2140          (completing-read prompt obarray 'commandp t))
2141         ((= c ?d)
2142          (point))
2143         ((= c ?D)
2144          (read-file-name prompt nil default-directory 'lambda))
2145         ((= c ?f)
2146          (read-file-name prompt nil nil 'lambda))
2147         ((= c ?F)
2148          (read-file-name prompt))
2149         ((= c ?k)
2150          (read-key-sequence prompt))
2151         ((= c ?K)
2152          (error "Not implemented spec"))
2153         ((= c ?e)
2154          (error "Not implemented spec"))
2155         ((= c ?m)
2156          (mark))
2157         ((= c ?N)
2158          (error "Not implemented spec"))
2159         ((= c ?n)
2160          (string-to-number (read-from-minibuffer prompt)))
2161         ((= c ?p)
2162          (prefix-numeric-value current-prefix-arg))
2163         ((= c ?P)
2164          current-prefix-arg)
2165         ((= c ?r)
2166          'gnus-prefix-nil)
2167         ((= c ?s)
2168          (read-string prompt))
2169         ((= c ?S)
2170          (intern (read-string prompt)))
2171         ((= c ?v)
2172          (read-variable prompt))
2173         ((= c ?x)
2174          (read-minibuffer prompt))
2175         ((= c ?x)
2176          (eval-minibuffer prompt))
2177         ;; And here the new specs come.
2178         ((= c ?y)
2179          gnus-current-prefix-symbol)
2180         ((= c ?Y)
2181          gnus-current-prefix-symbols)
2182         ((= c ?g)
2183          (gnus-group-group-name))
2184         ((= c ?A)
2185          (gnus-summary-skip-intangible)
2186          (or (get-text-property (point) 'gnus-number)
2187              (gnus-summary-last-subject)))
2188         ((= c ?H)
2189          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2190         (t
2191          (error "Non-implemented spec")))
2192        out)
2193       (cond
2194        ((= c ?r)
2195         (push (if (< (point) (mark) (point) (mark))) out)
2196         (push (if (> (point) (mark) (point) (mark))) out))))
2197     (setq out (delq 'gnus-prefix-nil out))
2198     (nreverse out)))
2199
2200 (defun gnus-symbolic-argument (&optional arg)
2201   "Read a symbolic argument and a command, and then execute command."
2202   (interactive "P")
2203   (let* ((in-command (this-command-keys))
2204          (command in-command)
2205          gnus-current-prefix-symbols
2206          gnus-current-prefix-symbol
2207          syms)
2208     (while (equal in-command command)
2209       (message "%s-" (key-description (this-command-keys)))
2210       (push (intern (char-to-string (read-char))) syms)
2211       (setq command (read-key-sequence nil t)))
2212     (setq gnus-current-prefix-symbols (nreverse syms)
2213           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2214     (call-interactively (key-binding command t))))
2215
2216 ;;; More various functions.
2217
2218 (defsubst gnus-check-backend-function (func group)
2219   "Check whether GROUP supports function FUNC.
2220 GROUP can either be a string (a group name) or a select method."
2221   (ignore-errors
2222     (let ((method (if (stringp group)
2223                       (car (gnus-find-method-for-group group))
2224                     group)))
2225       (unless (featurep method)
2226         (require method))
2227       (fboundp (intern (format "%s-%s" method func))))))
2228
2229 (defun gnus-group-read-only-p (&optional group)
2230   "Check whether GROUP supports editing or not.
2231 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2232 that that variable is buffer-local to the summary buffers."
2233   (let ((group (or group gnus-newsgroup-name)))
2234     (not (gnus-check-backend-function 'request-replace-article group))))
2235
2236 (defun gnus-group-total-expirable-p (group)
2237   "Check whether GROUP is total-expirable or not."
2238   (let ((params (gnus-group-find-parameter group))
2239         val)
2240     (cond
2241      ((memq 'total-expire params)
2242       t)
2243      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2244       (cdr val))
2245      (gnus-total-expirable-newsgroups   ; Check var.
2246       (string-match gnus-total-expirable-newsgroups group)))))
2247
2248 (defun gnus-group-auto-expirable-p (group)
2249   "Check whether GROUP is auto-expirable or not."
2250   (let ((params (gnus-group-find-parameter group))
2251         val)
2252     (cond
2253      ((memq 'auto-expire params)
2254       t)
2255      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2256       (cdr val))
2257      (gnus-auto-expirable-newsgroups    ; Check var.
2258       (string-match gnus-auto-expirable-newsgroups group)))))
2259
2260 (defun gnus-virtual-group-p (group)
2261   "Say whether GROUP is virtual or not."
2262   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2263                         gnus-valid-select-methods)))
2264
2265 (defun gnus-news-group-p (group &optional article)
2266   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2267   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2268       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2269            (if (or (null article)
2270                    (not (< article 0)))
2271                (eq (gnus-request-type group article) 'news)
2272              (if (not (vectorp article))
2273                  nil
2274                ;; It's a real article.
2275                (eq (gnus-request-type group (mail-header-id article))
2276                    'news))))))
2277
2278 ;; Returns a list of writable groups.
2279 (defun gnus-writable-groups ()
2280   (let ((alist gnus-newsrc-alist)
2281         groups group)
2282     (while (setq group (car (pop alist)))
2283       (unless (gnus-group-read-only-p group)
2284         (push group groups)))
2285     (nreverse groups)))
2286
2287 ;; Check whether to use long file names.
2288 (defun gnus-use-long-file-name (symbol)
2289   ;; The variable has to be set...
2290   (and gnus-use-long-file-name
2291        ;; If it isn't a list, then we return t.
2292        (or (not (listp gnus-use-long-file-name))
2293            ;; If it is a list, and the list contains `symbol', we
2294            ;; return nil.
2295            (not (memq symbol gnus-use-long-file-name)))))
2296
2297 ;; Generate a unique new group name.
2298 (defun gnus-generate-new-group-name (leaf)
2299   (let ((name leaf)
2300         (num 0))
2301     (while (gnus-gethash name gnus-newsrc-hashtb)
2302       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2303     name))
2304
2305 (defun gnus-ephemeral-group-p (group)
2306   "Say whether GROUP is ephemeral or not."
2307   (gnus-group-get-parameter group 'quit-config t))
2308
2309 (defun gnus-group-quit-config (group)
2310   "Return the quit-config of GROUP."
2311   (gnus-group-get-parameter group 'quit-config t))
2312
2313 (defun gnus-kill-ephemeral-group (group)
2314   "Remove ephemeral GROUP from relevant structures."
2315   (gnus-sethash group nil gnus-newsrc-hashtb))
2316
2317 (defun gnus-simplify-mode-line ()
2318   "Make mode lines a bit simpler."
2319   (setq mode-line-modified (cdr gnus-mode-line-modified))
2320   (when (listp mode-line-format)
2321     (make-local-variable 'mode-line-format)
2322     (setq mode-line-format (copy-sequence mode-line-format))
2323     (when (equal (nth 3 mode-line-format) "   ")
2324       (setcar (nthcdr 3 mode-line-format) " "))))
2325
2326 ;;; Servers and groups.
2327
2328 (defsubst gnus-server-add-address (method)
2329   (let ((method-name (symbol-name (car method))))
2330     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2331              (not (assq (intern (concat method-name "-address")) method))
2332              (memq 'physical-address (assq (car method)
2333                                            gnus-valid-select-methods)))
2334         (append method (list (list (intern (concat method-name "-address"))
2335                                    (nth 1 method))))
2336       method)))
2337
2338 (defsubst gnus-server-get-method (group method)
2339   ;; Input either a server name, and extended server name, or a
2340   ;; select method, and return a select method.
2341   (cond ((stringp method)
2342          (gnus-server-to-method method))
2343         ((equal method gnus-select-method)
2344          gnus-select-method)
2345         ((and (stringp (car method))
2346               group)
2347          (gnus-server-extend-method group method))
2348         ((and method
2349               (not group)
2350               (equal (cadr method) ""))
2351          method)
2352         (t
2353          (gnus-server-add-address method))))
2354
2355 (defun gnus-server-to-method (server)
2356   "Map virtual server names to select methods."
2357   (or
2358    ;; Is this a method, perhaps?
2359    (and server (listp server) server)
2360    ;; Perhaps this is the native server?
2361    (and (equal server "native") gnus-select-method)
2362    ;; It should be in the server alist.
2363    (cdr (assoc server gnus-server-alist))
2364    ;; It could be in the predefined server alist.
2365    (cdr (assoc server gnus-predefined-server-alist))
2366    ;; If not, we look through all the opened server
2367    ;; to see whether we can find it there.
2368    (let ((opened gnus-opened-servers))
2369      (while (and opened
2370                  (not (equal server (format "%s:%s" (caaar opened)
2371                                             (cadaar opened)))))
2372        (pop opened))
2373      (caar opened))
2374    ;; It could be a named method, search all servers
2375    (let ((servers gnus-secondary-select-methods))
2376      (while (and servers
2377                  (not (equal server (format "%s:%s" (caar servers)
2378                                             (cadar servers)))))
2379        (pop servers))
2380      (car servers))))
2381
2382 (defmacro gnus-method-equal (ss1 ss2)
2383   "Say whether two servers are equal."
2384   `(let ((s1 ,ss1)
2385          (s2 ,ss2))
2386      (or (equal s1 s2)
2387          (and (= (length s1) (length s2))
2388               (progn
2389                 (while (and s1 (member (car s1) s2))
2390                   (setq s1 (cdr s1)))
2391                 (null s1))))))
2392
2393 (defun gnus-methods-equal-p (m1 m2)
2394   (let ((m1 (or m1 gnus-select-method))
2395         (m2 (or m2 gnus-select-method)))
2396     (or (equal m1 m2)
2397         (and (eq (car m1) (car m2))
2398              (or (not (memq 'address (assoc (symbol-name (car m1))
2399                                             gnus-valid-select-methods)))
2400                  (equal (nth 1 m1) (nth 1 m2)))))))
2401
2402 (defun gnus-server-equal (m1 m2)
2403   "Say whether two methods are equal."
2404   (let ((m1 (cond ((null m1) gnus-select-method)
2405                   ((stringp m1) (gnus-server-to-method m1))
2406                   (t m1)))
2407         (m2 (cond ((null m2) gnus-select-method)
2408                   ((stringp m2) (gnus-server-to-method m2))
2409                   (t m2))))
2410     (gnus-method-equal m1 m2)))
2411
2412 (defun gnus-servers-using-backend (backend)
2413   "Return a list of known servers using BACKEND."
2414   (let ((opened gnus-opened-servers)
2415         out)
2416     (while opened
2417       (when (eq backend (caaar opened))
2418         (push (caar opened) out))
2419       (pop opened))
2420     out))
2421
2422 (defun gnus-archive-server-wanted-p ()
2423   "Say whether the user wants to use the archive server."
2424   (cond
2425    ((or (not gnus-message-archive-method)
2426         (not gnus-message-archive-group))
2427     nil)
2428    ((and gnus-message-archive-method gnus-message-archive-group)
2429     t)
2430    (t
2431     (let ((active (cadr (assq 'nnfolder-active-file
2432                               gnus-message-archive-method))))
2433       (and active
2434            (file-exists-p active))))))
2435
2436 (defun gnus-group-prefixed-name (group method)
2437   "Return the whole name from GROUP and METHOD."
2438   (and (stringp method) (setq method (gnus-server-to-method method)))
2439   (if (or (not method)
2440           (gnus-server-equal method "native"))
2441       group
2442     (concat (format "%s" (car method))
2443             (when (and
2444                    (or (assoc (format "%s" (car method))
2445                               (gnus-methods-using 'address))
2446                        (gnus-server-equal method gnus-message-archive-method))
2447                    (nth 1 method)
2448                    (not (string= (nth 1 method) "")))
2449               (concat "+" (nth 1 method)))
2450             ":" group)))
2451
2452 (defun gnus-group-real-prefix (group)
2453   "Return the prefix of the current group name."
2454   (if (string-match "^[^:]+:" group)
2455       (substring group 0 (match-end 0))
2456     ""))
2457
2458 (defun gnus-group-method (group)
2459   "Return the server or method used for selecting GROUP.
2460 You should probably use `gnus-find-method-for-group' instead."
2461   (let ((prefix (gnus-group-real-prefix group)))
2462     (if (equal prefix "")
2463         gnus-select-method
2464       (let ((servers gnus-opened-servers)
2465             (server "")
2466             backend possible found)
2467         (if (string-match "^[^\\+]+\\+" prefix)
2468             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2469                   server (substring prefix (match-end 0) (1- (length prefix))))
2470           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2471         (while servers
2472           (when (eq (caaar servers) backend)
2473             (setq possible (caar servers))
2474             (when (equal (cadaar servers) server)
2475               (setq found (caar servers))))
2476           (pop servers))
2477         (or (car (rassoc found gnus-server-alist))
2478             found
2479             (car (rassoc possible gnus-server-alist))
2480             possible
2481             (list backend server))))))
2482
2483 (defsubst gnus-native-method-p (method)
2484   "Return whether METHOD is the native select method."
2485   (gnus-method-equal method gnus-select-method))
2486
2487 (defsubst gnus-secondary-method-p (method)
2488   "Return whether METHOD is a secondary select method."
2489   (let ((methods gnus-secondary-select-methods)
2490         (gmethod (gnus-server-get-method nil method)))
2491     (while (and methods
2492                (not (gnus-method-equal
2493                      (gnus-server-get-method nil (car methods))
2494                      gmethod)))
2495       (setq methods (cdr methods)))
2496     methods))
2497
2498 (defun gnus-method-simplify (method)
2499   "Return the shortest uniquely identifying string or method for METHOD."
2500   (cond ((stringp method)
2501          method)
2502         ((gnus-native-method-p method)
2503          nil)
2504         ((gnus-secondary-method-p method)
2505          (format "%s:%s" (nth 0 method) (nth 1 method)))
2506         (t
2507          method)))
2508
2509 (defun gnus-groups-from-server (server)
2510   "Return a list of all groups that are fetched from SERVER."
2511   (let ((alist (cdr gnus-newsrc-alist))
2512         info groups)
2513     (while (setq info (pop alist))
2514       (when (gnus-server-equal (gnus-info-method info) server)
2515         (push (gnus-info-group info) groups)))
2516     (sort groups 'string<)))
2517
2518 (defun gnus-group-foreign-p (group)
2519   "Say whether a group is foreign or not."
2520   (and (not (gnus-group-native-p group))
2521        (not (gnus-group-secondary-p group))))
2522
2523 (defun gnus-group-native-p (group)
2524   "Say whether the group is native or not."
2525   (not (string-match ":" group)))
2526
2527 (defun gnus-group-secondary-p (group)
2528   "Say whether the group is secondary or not."
2529   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2530
2531 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2532   "Return the group parameters for GROUP.
2533 If SYMBOL, return the value of that symbol in the group parameters."
2534   (save-excursion
2535     (set-buffer gnus-group-buffer)
2536     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2537       (if symbol
2538           (gnus-group-parameter-value parameters symbol allow-list)
2539         parameters))))
2540
2541 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2542   "Return the group parameters for GROUP.
2543 If SYMBOL, return the value of that symbol in the group parameters.
2544 Most functions should use `gnus-group-find-parameter', which
2545 also examines the topic parameters."
2546   (let ((params (gnus-info-params (gnus-get-info group))))
2547     (if symbol
2548         (gnus-group-parameter-value params symbol allow-list)
2549       params)))
2550
2551 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2552   "Return the value of SYMBOL in group PARAMS."
2553   ;; We only wish to return group parameters (dotted lists) and
2554   ;; not local variables, which may have the same names.
2555   ;; But first we handle single elements...
2556   (or (car (memq symbol params))
2557       ;; Handle alist.
2558       (let (elem)
2559         (catch 'found
2560           (while (setq elem (pop params))
2561             (when (and (consp elem)
2562                        (eq (car elem) symbol)
2563                        (or allow-list
2564                            (atom (cdr elem))))
2565               (throw 'found (cdr elem))))))))
2566
2567 (defun gnus-group-add-parameter (group param)
2568   "Add parameter PARAM to GROUP."
2569   (let ((info (gnus-get-info group)))
2570     (when info
2571       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2572       ;; Cons the new param to the old one and update.
2573       (gnus-group-set-info (cons param (gnus-info-params info))
2574                            group 'params))))
2575
2576 (defun gnus-group-set-parameter (group name value)
2577   "Set parameter NAME to VALUE in GROUP."
2578   (let ((info (gnus-get-info group)))
2579     (when info
2580       (gnus-group-remove-parameter group name)
2581       (let ((old-params (gnus-info-params info))
2582             (new-params (list (cons name value))))
2583         (while old-params
2584           (when (or (not (listp (car old-params)))
2585                     (not (eq (caar old-params) name)))
2586             (setq new-params (append new-params (list (car old-params)))))
2587           (setq old-params (cdr old-params)))
2588         (gnus-group-set-info new-params group 'params)))))
2589
2590 (defun gnus-group-remove-parameter (group name)
2591   "Remove parameter NAME from GROUP."
2592   (let ((info (gnus-get-info group)))
2593     (when info
2594       (let ((params (gnus-info-params info)))
2595         (when params
2596           (setq params (delq name params))
2597           (while (assq name params)
2598             (gnus-pull name params))
2599           (gnus-info-set-params info params))))))
2600
2601 (defun gnus-group-add-score (group &optional score)
2602   "Add SCORE to the GROUP score.
2603 If SCORE is nil, add 1 to the score of GROUP."
2604   (let ((info (gnus-get-info group)))
2605     (when info
2606       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2607
2608 (defun gnus-short-group-name (group &optional levels)
2609   "Collapse GROUP name LEVELS.
2610 Select methods are stripped and any remote host name is stripped down to
2611 just the host name."
2612   (let* ((name "")
2613          (foreign "")
2614          (depth 0)
2615          (skip 1)
2616          (levels (or levels
2617                      gnus-group-uncollapsed-levels
2618                      (progn
2619                        (while (string-match "\\." group skip)
2620                          (setq skip (match-end 0)
2621                                depth (+ depth 1)))
2622                        depth))))
2623     ;; Separate foreign select method from group name and collapse.
2624     ;; If method contains a server, collapse to non-domain server name,
2625     ;; otherwise collapse to select method.
2626     (let* ((colon (string-match ":" group))
2627            (server (and colon (substring group 0 colon)))
2628            (plus (and server (string-match "+" server))))
2629       (when server
2630         (if plus
2631             (setq foreign (substring server (+ 1 plus)
2632                                      (string-match "\\." server))
2633                   group (substring group (+ 1 colon)))
2634           (setq foreign server
2635                 group (substring group (+ 1 colon))))
2636         (setq foreign (concat foreign ":")))
2637       ;; Collapse group name leaving LEVELS uncollapsed elements
2638       (let* ((glist (split-string group "\\."))
2639              (glen (length glist))
2640              res)
2641         (setq levels (- glen levels))
2642         (dolist (g glist)
2643           (push (if (>= (decf levels) 0)
2644                     (if (zerop (length g))
2645                         ""
2646                       (substring g 0 1))
2647                   g)
2648                 res))
2649         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2650
2651 (defun gnus-narrow-to-body ()
2652   "Narrow to the body of an article."
2653   (narrow-to-region
2654    (progn
2655      (goto-char (point-min))
2656      (or (search-forward "\n\n" nil t)
2657          (point-max)))
2658    (point-max)))
2659
2660 \f
2661 ;;;
2662 ;;; Kill file handling.
2663 ;;;
2664
2665 (defun gnus-apply-kill-file ()
2666   "Apply a kill file to the current newsgroup.
2667 Returns the number of articles marked as read."
2668   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2669           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2670       (gnus-apply-kill-file-internal)
2671     0))
2672
2673 (defun gnus-kill-save-kill-buffer ()
2674   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2675     (when (get-file-buffer file)
2676       (save-excursion
2677         (set-buffer (get-file-buffer file))
2678         (when (buffer-modified-p)
2679           (save-buffer))
2680         (kill-buffer (current-buffer))))))
2681
2682 (defcustom gnus-kill-file-name "KILL"
2683   "Suffix of the kill files."
2684   :group 'gnus-score-kill
2685   :group 'gnus-score-files
2686   :type 'string)
2687
2688 (defun gnus-newsgroup-kill-file (newsgroup)
2689   "Return the name of a kill file name for NEWSGROUP.
2690 If NEWSGROUP is nil, return the global kill file name instead."
2691   (cond
2692    ;; The global KILL file is placed at top of the directory.
2693    ((or (null newsgroup)
2694         (string-equal newsgroup ""))
2695     (expand-file-name gnus-kill-file-name
2696                       gnus-kill-files-directory))
2697    ;; Append ".KILL" to newsgroup name.
2698    ((gnus-use-long-file-name 'not-kill)
2699     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2700                               "." gnus-kill-file-name)
2701                       gnus-kill-files-directory))
2702    ;; Place "KILL" under the hierarchical directory.
2703    (t
2704     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2705                               "/" gnus-kill-file-name)
2706                       gnus-kill-files-directory))))
2707
2708 ;;; Server things.
2709
2710 (defun gnus-member-of-valid (symbol group)
2711   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2712   (memq symbol (assoc
2713                 (symbol-name (car (gnus-find-method-for-group group)))
2714                 gnus-valid-select-methods)))
2715
2716 (defun gnus-method-option-p (method option)
2717   "Return non-nil if select METHOD has OPTION as a parameter."
2718   (when (stringp method)
2719     (setq method (gnus-server-to-method method)))
2720   (memq option (assoc (format "%s" (car method))
2721                       gnus-valid-select-methods)))
2722
2723 (defun gnus-similar-server-opened (method)
2724   (let ((opened gnus-opened-servers))
2725     (while (and method opened)
2726       (when (and (equal (cadr method) (cadaar opened))
2727                 (equal (car method) (caaar opened))
2728                  (not (equal method (caar opened))))
2729         (setq method nil))
2730       (pop opened))
2731     (not method)))
2732
2733 (defun gnus-server-extend-method (group method)
2734   ;; This function "extends" a virtual server.  If the server is
2735   ;; "hello", and the select method is ("hello" (my-var "something"))
2736   ;; in the group "alt.alt", this will result in a new virtual server
2737   ;; called "hello+alt.alt".
2738   (if (or (not (inline (gnus-similar-server-opened method)))
2739           (not (cddr method)))
2740       method
2741     `(,(car method) ,(concat (cadr method) "+" group)
2742       (,(intern (format "%s-address" (car method))) ,(cadr method))
2743       ,@(cddr method))))
2744
2745 (defun gnus-server-status (method)
2746   "Return the status of METHOD."
2747   (nth 1 (assoc method gnus-opened-servers)))
2748
2749 (defun gnus-group-name-to-method (group)
2750   "Guess a select method based on GROUP."
2751   (if (string-match ":" group)
2752       (let ((server (substring group 0 (match-beginning 0))))
2753         (if (string-match "\\+" server)
2754             (list (intern (substring server 0 (match-beginning 0)))
2755                   (substring server (match-end 0)))
2756           (list (intern server) "")))
2757     gnus-select-method))
2758
2759 (defun gnus-find-method-for-group (group &optional info)
2760   "Find the select method that GROUP uses."
2761   (or gnus-override-method
2762       (and (not group)
2763            gnus-select-method)
2764       (and (not (gnus-group-entry group)) ;; a new group
2765            (gnus-group-name-to-method group))
2766       (let ((info (or info (gnus-get-info group)))
2767             method)
2768         (if (or (not info)
2769                 (not (setq method (gnus-info-method info)))
2770                 (equal method "native"))
2771             gnus-select-method
2772           (setq method
2773                 (cond ((stringp method)
2774                        (inline (gnus-server-to-method method)))
2775                       ((stringp (cadr method))
2776                        (inline (gnus-server-extend-method group method)))
2777                       (t
2778                        method)))
2779           (cond ((equal (cadr method) "")
2780                  method)
2781                 ((null (cadr method))
2782                  (list (car method) ""))
2783                 (t
2784                  (gnus-server-add-address method)))))))
2785
2786 (defun gnus-methods-using (feature)
2787   "Find all methods that have FEATURE."
2788   (let ((valids gnus-valid-select-methods)
2789         outs)
2790     (while valids
2791       (when (memq feature (car valids))
2792         (push (car valids) outs))
2793       (setq valids (cdr valids)))
2794     outs))
2795
2796 (defun gnus-read-group (prompt &optional default)
2797   "Prompt the user for a group name.
2798 Disallow invalid group names."
2799   (let ((prefix "")
2800         group)
2801     (while (not group)
2802       (when (string-match
2803              "[: `'\"/]\\|^$"
2804              (setq group (read-string (concat prefix prompt)
2805                                       (cons (or default "") 0)
2806                                       'gnus-group-history)))
2807         (setq prefix (format "Invalid group name: \"%s\".  " group)
2808               group nil)))
2809     group))
2810
2811 (defun gnus-read-method (prompt)
2812   "Prompt the user for a method.
2813 Allow completion over sensible values."
2814   (let* ((servers
2815           (append gnus-valid-select-methods
2816                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2817                                                     (cadar i))))
2818                           gnus-opened-servers)
2819                   gnus-predefined-server-alist
2820                   gnus-server-alist))
2821          (method
2822           (completing-read
2823            prompt servers
2824            nil t nil 'gnus-method-history)))
2825     (cond
2826      ((equal method "")
2827       (setq method gnus-select-method))
2828      ((assoc method gnus-valid-select-methods)
2829       (let ((address (if (memq 'prompt-address
2830                                (assoc method gnus-valid-select-methods))
2831                          (read-string "Address: ")
2832                        "")))
2833         (or (let ((opened gnus-opened-servers))
2834               (while (and opened
2835                           (not (equal (format "%s:%s" method address)
2836                                       (format "%s:%s" (caaar opened) 
2837                                               (cadaar opened)))))
2838                 (pop opened))
2839               (caar opened))
2840             (list (intern method) address))))
2841      ((assoc method servers)
2842       method)
2843      (t
2844       (list (intern method) "")))))
2845
2846 ;;; User-level commands.
2847
2848 ;;;###autoload
2849 (defun gnus-slave-no-server (&optional arg)
2850   "Read network news as a slave, without connecting to local server."
2851   (interactive "P")
2852   (gnus-no-server arg t))
2853
2854 ;;;###autoload
2855 (defun gnus-no-server (&optional arg slave)
2856   "Read network news.
2857 If ARG is a positive number, Gnus will use that as the
2858 startup level.  If ARG is nil, Gnus will be started at level 2.
2859 If ARG is non-nil and not a positive number, Gnus will
2860 prompt the user for the name of an NNTP server to use.
2861 As opposed to `gnus', this command will not connect to the local server."
2862   (interactive "P")
2863   (gnus-no-server-1 arg slave))
2864
2865 ;;;###autoload
2866 (defun gnus-slave (&optional arg)
2867   "Read news as a slave."
2868   (interactive "P")
2869   (gnus arg nil 'slave))
2870
2871 ;;;###autoload
2872 (defun gnus-other-frame (&optional arg)
2873   "Pop up a frame to read news."
2874   (interactive "P")
2875   (let ((window (get-buffer-window gnus-group-buffer)))
2876     (cond (window
2877            (select-frame (window-frame window)))
2878           (t
2879            (other-frame 1))))
2880   (gnus arg))
2881
2882 ;;;###autoload
2883 (defun gnus (&optional arg dont-connect slave)
2884   "Read network news.
2885 If ARG is non-nil and a positive number, Gnus will use that as the
2886 startup level.  If ARG is non-nil and not a positive number, Gnus will
2887 prompt the user for the name of an NNTP server to use."
2888   (interactive "P")
2889   (gnus-1 arg dont-connect slave))
2890
2891 ;; Allow redefinition of Gnus functions.
2892
2893 (gnus-ems-redefine)
2894
2895 (provide 'gnus)
2896
2897 ;;; gnus.el ends here