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