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