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