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