(The problem of spam): fixed so many countries and
[gnus] / lisp / gnus-start.el
1 ;;; gnus-start.el --- startup functions for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (require 'gnus)
30 (require 'gnus-win)
31 (require 'gnus-int)
32 (require 'gnus-spec)
33 (require 'gnus-range)
34 (require 'gnus-util)
35 (autoload 'message-make-date "message")
36 (autoload 'gnus-agent-read-servers-validate "gnus-agent")
37 (autoload 'gnus-agent-possibly-alter-active "gnus-agent")
38 (eval-when-compile (require 'cl))
39
40 (defcustom gnus-startup-file (nnheader-concat gnus-home-directory ".newsrc")
41   "Your `.newsrc' file.
42 `.newsrc-SERVER' will be used instead if that exists."
43   :group 'gnus-start
44   :type 'file)
45
46 (defcustom gnus-backup-startup-file 'never
47   "Whether to create backup files.
48 This variable takes the same values as the `version-control'
49 variable."
50   :group 'gnus-start
51   :type '(choice (const :tag "Never" never)
52                  (const :tag "If existing" nil)
53                  (other :tag "Always" t)))
54
55 (defcustom gnus-save-startup-file-via-temp-buffer t
56   "Whether to write the startup file contents to a buffer then save
57 the buffer or write directly to the file.  The buffer is faster
58 because all of the contents are written at once.  The direct write
59 uses considerably less memory."
60   :group 'gnus-start
61   :type '(choice (const :tag "Write via buffer" t)
62                  (const :tag "Write directly to file" nil)))
63
64 (defcustom gnus-init-file (nnheader-concat gnus-home-directory ".gnus")
65   "Your Gnus Emacs-Lisp startup file name.
66 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
67   :group 'gnus-start
68   :type 'file)
69
70 (defcustom gnus-site-init-file
71   (condition-case nil
72       (concat (file-name-directory
73                (directory-file-name installation-directory))
74               "site-lisp/gnus-init")
75     (error nil))
76   "The site-wide Gnus Emacs-Lisp startup file name, or nil if none.
77 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
78   :group 'gnus-start
79   :type '(choice file (const nil)))
80
81 (defcustom gnus-default-subscribed-newsgroups nil
82   "List of newsgroups to subscribe, when a user runs Gnus the first time.
83 The value should be a list of strings.
84 If it is t, Gnus will not do anything special the first time it is
85 started; it'll just use the normal newsgroups subscription methods."
86   :group 'gnus-start
87   :type '(choice (repeat string) (const :tag "Nothing special" t)))
88
89 (defcustom gnus-use-dribble-file t
90   "*Non-nil means that Gnus will use a dribble file to store user updates.
91 If Emacs should crash without saving the .newsrc files, complete
92 information can be restored from the dribble file."
93   :group 'gnus-dribble-file
94   :type 'boolean)
95
96 (defcustom gnus-dribble-directory nil
97   "*The directory where dribble files will be saved.
98 If this variable is nil, the directory where the .newsrc files are
99 saved will be used."
100   :group 'gnus-dribble-file
101   :type '(choice directory (const nil)))
102
103 (defcustom gnus-check-new-newsgroups 'ask-server
104   "*Non-nil means that Gnus will run `gnus-find-new-newsgroups' at startup.
105 This normally finds new newsgroups by comparing the active groups the
106 servers have already reported with those Gnus already knows, either alive
107 or killed.
108
109 When any of the following are true, `gnus-find-new-newsgroups' will instead
110 ask the servers (primary, secondary, and archive servers) to list new
111 groups since the last time it checked:
112   1. This variable is `ask-server'.
113   2. This variable is a list of select methods (see below).
114   3. `gnus-read-active-file' is nil or `some'.
115   4. A prefix argument is given to `gnus-find-new-newsgroups' interactively.
116
117 Thus, if this variable is `ask-server' or a list of select methods or
118 `gnus-read-active-file' is nil or `some', then the killed list is no
119 longer necessary, so you could safely set `gnus-save-killed-list' to nil.
120
121 This variable can be a list of select methods which Gnus will query with
122 the `ask-server' method in addition to the primary, secondary, and archive
123 servers.
124
125 Eg.
126   (setq gnus-check-new-newsgroups
127         '((nntp \"some.server\") (nntp \"other.server\")))
128
129 If this variable is nil, then you have to tell Gnus explicitly to
130 check for new newsgroups with \\<gnus-group-mode-map>\\[gnus-find-new-newsgroups]."
131   :group 'gnus-start
132   :type '(choice (const :tag "no" nil)
133                  (const :tag "by brute force" t)
134                  (const :tag "ask servers" ask-server)
135                  (repeat :menu-tag "ask additional servers"
136                          :tag "ask additional servers"
137                          :value ((nntp ""))
138                          (sexp :format "%v"))))
139
140 (defcustom gnus-check-bogus-newsgroups nil
141   "*Non-nil means that Gnus will check and remove bogus newsgroup at startup.
142 If this variable is nil, then you have to tell Gnus explicitly to
143 check for bogus newsgroups with \\<gnus-group-mode-map>\\[gnus-group-check-bogus-groups]."
144   :group 'gnus-start-server
145   :type 'boolean)
146
147 (defcustom gnus-read-active-file 'some
148   "*Non-nil means that Gnus will read the entire active file at startup.
149 If this variable is nil, Gnus will only know about the groups in your
150 `.newsrc' file.
151
152 If this variable is `some', Gnus will try to only read the relevant
153 parts of the active file from the server.  Not all servers support
154 this, and it might be quite slow with other servers, but this should
155 generally be faster than both the t and nil value.
156
157 If you set this variable to nil or `some', you probably still want to
158 be told about new newsgroups that arrive.  To do that, set
159 `gnus-check-new-newsgroups' to `ask-server'.  This may not work
160 properly with all servers."
161   :group 'gnus-start-server
162   :type '(choice (const nil)
163                  (const some)
164                  (const t)))
165
166 (defconst gnus-level-subscribed 5
167   "Groups with levels less than or equal to this variable are subscribed.")
168
169 (defconst gnus-level-unsubscribed 7
170   "Groups with levels less than or equal to this variable are unsubscribed.
171 Groups with levels less than `gnus-level-subscribed', which should be
172 less than this variable, are subscribed.")
173
174 (defconst gnus-level-zombie 8
175   "Groups with this level are zombie groups.")
176
177 (defconst gnus-level-killed 9
178   "Groups with this level are killed.")
179
180 (defcustom gnus-level-default-subscribed 3
181   "*New subscribed groups will be subscribed at this level."
182   :group 'gnus-group-levels
183   :type 'integer)
184
185 (defcustom gnus-level-default-unsubscribed 6
186   "*New unsubscribed groups will be unsubscribed at this level."
187   :group 'gnus-group-levels
188   :type 'integer)
189
190 (defcustom gnus-activate-level (1+ gnus-level-subscribed)
191   "*Groups higher than this level won't be activated on startup.
192 Setting this variable to something low might save lots of time when
193 you have many groups that you aren't interested in."
194   :group 'gnus-group-levels
195   :type 'integer)
196
197 (defcustom gnus-activate-foreign-newsgroups 4
198   "*If nil, Gnus will not check foreign newsgroups at startup.
199 If it is non-nil, it should be a number between one and nine.  Foreign
200 newsgroups that have a level lower or equal to this number will be
201 activated on startup.  For instance, if you want to active all
202 subscribed newsgroups, but not the rest, you'd set this variable to
203 `gnus-level-subscribed'.
204
205 If you subscribe to lots of newsgroups from different servers, startup
206 might take a while.  By setting this variable to nil, you'll save time,
207 but you won't be told how many unread articles there are in the
208 groups."
209   :group 'gnus-group-levels
210   :type '(choice integer
211                  (const :tag "none" nil)))
212
213 (defcustom gnus-read-newsrc-file t
214   "*Non-nil means that Gnus will read the `.newsrc' file.
215 Gnus always reads its own startup file, which is called
216 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
217 be readily understood by other newsreaders.  If you don't plan on
218 using other newsreaders, set this variable to nil to save some time on
219 entry."
220   :version "21.1"
221   :group 'gnus-newsrc
222   :type 'boolean)
223
224 (defcustom gnus-save-newsrc-file t
225   "*Non-nil means that Gnus will save the `.newsrc' file.
226 Gnus always saves its own startup file, which is called
227 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
228 be readily understood by other newsreaders.  If you don't plan on
229 using other newsreaders, set this variable to nil to save some time on
230 exit."
231   :group 'gnus-newsrc
232   :type 'boolean)
233
234 (defcustom gnus-save-killed-list t
235   "*If non-nil, save the list of killed groups to the startup file.
236 If you set this variable to nil, you'll save both time (when starting
237 and quitting) and space (both memory and disk), but it will also mean
238 that Gnus has no record of which groups are new and which are old, so
239 the automatic new newsgroups subscription methods become meaningless.
240
241 You should always set `gnus-check-new-newsgroups' to `ask-server' or
242 nil if you set this variable to nil.
243
244 This variable can also be a regexp.  In that case, all groups that do
245 not match this regexp will be removed before saving the list."
246   :group 'gnus-newsrc
247   :type '(radio (sexp :format "Non-nil\n"
248                       :match (lambda (widget value)
249                                (and value (not (stringp value))))
250                       :value t)
251                 (const nil)
252                 (regexp :format "%t: %v\n" :size 0)))
253
254 (defcustom gnus-ignored-newsgroups
255   (mapconcat 'identity
256              '("^to\\."                 ; not "real" groups
257                "^[0-9. \t]+\\( \\|$\\)" ; all digits in name
258                "^[\"][]\"[#'()]"        ; bogus characters
259                )
260              "\\|")
261   "*A regexp to match uninteresting newsgroups in the active file.
262 Any lines in the active file matching this regular expression are
263 removed from the newsgroup list before anything else is done to it,
264 thus making them effectively non-existent."
265   :group 'gnus-group-new
266   :type 'regexp)
267
268 (defcustom gnus-subscribe-newsgroup-method 'gnus-subscribe-zombies
269   "*Function(s) called with a group name when new group is detected.
270 A few pre-made functions are supplied: `gnus-subscribe-randomly'
271 inserts new groups at the beginning of the list of groups;
272 `gnus-subscribe-alphabetically' inserts new groups in strict
273 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
274 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
275 for your decision; `gnus-subscribe-killed' kills all new groups;
276 `gnus-subscribe-zombies' will make all new groups into zombies;
277 `gnus-subscribe-topics' will enter groups into the topics that
278 claim them."
279   :group 'gnus-group-new
280   :type '(radio (function-item gnus-subscribe-randomly)
281                 (function-item gnus-subscribe-alphabetically)
282                 (function-item gnus-subscribe-hierarchically)
283                 (function-item gnus-subscribe-interactively)
284                 (function-item gnus-subscribe-killed)
285                 (function-item gnus-subscribe-zombies)
286                 (function-item gnus-subscribe-topics)
287                 function
288                 (repeat function)))
289
290 (defcustom gnus-subscribe-newsgroup-hooks nil
291   "*Hooks run after you subscribe to a new group.
292 The hooks will be called with new group's name as argument."
293   :group 'gnus-group-new
294   :type 'hook)
295
296 (defcustom gnus-subscribe-options-newsgroup-method
297   'gnus-subscribe-alphabetically
298   "*Function(s) called to subscribe newsgroups mentioned on \"options -n\" lines.
299 If, for instance, you want to subscribe to all newsgroups in the
300 \"no\" and \"alt\" hierarchies, you'd put the following in your
301 .newsrc file:
302
303 options -n no.all alt.all
304
305 Gnus will the subscribe all new newsgroups in these hierarchies with
306 the subscription method in this variable."
307   :group 'gnus-group-new
308   :type '(radio (function-item gnus-subscribe-randomly)
309                 (function-item gnus-subscribe-alphabetically)
310                 (function-item gnus-subscribe-hierarchically)
311                 (function-item gnus-subscribe-interactively)
312                 (function-item gnus-subscribe-killed)
313                 (function-item gnus-subscribe-zombies)
314                 (function-item gnus-subscribe-topics)
315                 function
316                 (repeat function)))
317
318 (defcustom gnus-subscribe-hierarchical-interactive nil
319   "*If non-nil, Gnus will offer to subscribe hierarchically.
320 When a new hierarchy appears, Gnus will ask the user:
321
322 'alt.binaries': Do you want to subscribe to this hierarchy? ([d]ys):
323
324 If the user pressed `d', Gnus will descend the hierarchy, `y' will
325 subscribe to all newsgroups in the hierarchy and `s' will skip this
326 hierarchy in its entirety."
327   :group 'gnus-group-new
328   :type 'boolean)
329
330 (defcustom gnus-auto-subscribed-groups
331   "^nnml\\|^nnfolder\\|^nnmbox\\|^nnmh\\|^nnbabyl\\|^nnmaildir"
332   "*All new groups that match this regexp will be subscribed automatically.
333 Note that this variable only deals with new groups.  It has no effect
334 whatsoever on old groups.
335
336 New groups that match this regexp will not be handled by
337 `gnus-subscribe-newsgroup-method'.  Instead, they will
338 be subscribed using `gnus-subscribe-options-newsgroup-method'."
339   :group 'gnus-group-new
340   :type 'regexp)
341
342 (defcustom gnus-options-subscribe nil
343   "*All new groups matching this regexp will be subscribed unconditionally.
344 Note that this variable deals only with new newsgroups.  This variable
345 does not affect old newsgroups.
346
347 New groups that match this regexp will not be handled by
348 `gnus-subscribe-newsgroup-method'.  Instead, they will
349 be subscribed using `gnus-subscribe-options-newsgroup-method'."
350   :group 'gnus-group-new
351   :type '(choice regexp
352                  (const :tag "none" nil)))
353
354 (defcustom gnus-options-not-subscribe nil
355   "*All new groups matching this regexp will be ignored.
356 Note that this variable deals only with new newsgroups.  This variable
357 does not affect old (already subscribed) newsgroups."
358   :group 'gnus-group-new
359   :type '(choice regexp
360                  (const :tag "none" nil)))
361
362 (defcustom gnus-modtime-botch nil
363   "*Non-nil means .newsrc should be deleted prior to save.
364 Its use is due to the bogus appearance that .newsrc was modified on
365 disc."
366   :group 'gnus-newsrc
367   :type 'boolean)
368
369 (defcustom gnus-check-bogus-groups-hook nil
370   "A hook run after removing bogus groups."
371   :group 'gnus-start-server
372   :type 'hook)
373
374 (defcustom gnus-startup-hook nil
375   "A hook called at startup.
376 This hook is called after Gnus is connected to the NNTP server."
377   :group 'gnus-start
378   :type 'hook)
379
380 (defcustom gnus-before-startup-hook nil
381   "A hook called at before startup.
382 This hook is called as the first thing when Gnus is started."
383   :group 'gnus-start
384   :type 'hook)
385
386 (defcustom gnus-started-hook nil
387   "A hook called as the last thing after startup."
388   :group 'gnus-start
389   :type 'hook)
390
391 (defcustom gnus-setup-news-hook
392   '(gnus-fixup-nnimap-unread-after-getting-new-news)
393   "A hook after reading the .newsrc file, but before generating the buffer."
394   :group 'gnus-start
395   :type 'hook)
396
397 (defcustom gnus-get-top-new-news-hook nil
398   "A hook run just before Gnus checks for new news globally."
399   :group 'gnus-group-new
400   :type 'hook)
401
402 (defcustom gnus-get-new-news-hook nil
403   "A hook run just before Gnus checks for new news."
404   :group 'gnus-group-new
405   :type 'hook)
406
407 (defcustom gnus-after-getting-new-news-hook
408   '(gnus-display-time-event-handler
409     gnus-fixup-nnimap-unread-after-getting-new-news)
410   "*A hook run after Gnus checks for new news when Gnus is already running."
411   :group 'gnus-group-new
412   :type 'hook)
413
414 (defcustom gnus-read-newsrc-el-hook nil
415   "A hook called after reading the newsrc.eld? file."
416   :group 'gnus-newsrc
417   :type 'hook)
418
419 (defcustom gnus-save-newsrc-hook nil
420   "A hook called before saving any of the newsrc files."
421   :group 'gnus-newsrc
422   :type 'hook)
423
424 (defcustom gnus-save-quick-newsrc-hook nil
425   "A hook called just before saving the quick newsrc file.
426 Can be used to turn version control on or off."
427   :group 'gnus-newsrc
428   :type 'hook)
429
430 (defcustom gnus-save-standard-newsrc-hook nil
431   "A hook called just before saving the standard newsrc file.
432 Can be used to turn version control on or off."
433   :group 'gnus-newsrc
434   :type 'hook)
435
436 (defcustom gnus-group-mode-hook nil
437   "Hook for Gnus group mode."
438   :group 'gnus-group-various
439   :options '(gnus-topic-mode)
440   :type 'hook)
441
442 (defcustom gnus-always-read-dribble-file nil
443   "Unconditionally read the dribble file."
444   :group 'gnus-newsrc
445   :type 'boolean)
446
447 ;;; Internal variables
448
449 (defvar gnus-ding-file-coding-system mm-universal-coding-system
450   "Coding system for ding file.")
451
452 (defvar gnus-newsrc-file-version nil)
453 (defvar gnus-override-subscribe-method nil)
454 (defvar gnus-dribble-buffer nil)
455 (defvar gnus-newsrc-options nil
456   "Options line in the .newsrc file.")
457
458 (defvar gnus-newsrc-options-n nil
459   "List of regexps representing groups to be subscribed/ignored unconditionally.")
460
461 (defvar gnus-newsrc-last-checked-date nil
462   "Date Gnus last asked server for new newsgroups.")
463
464 (defvar gnus-current-startup-file nil
465   "Startup file for the current host.")
466
467 ;; Byte-compiler warning.
468 (defvar gnus-group-line-format)
469
470 ;; Suggested by Brian Edmonds <edmonds@cs.ubc.ca>.
471 (defvar gnus-init-inhibit nil)
472 (defun gnus-read-init-file (&optional inhibit-next)
473   ;; Don't load .gnus if the -q option was used.
474   (when init-file-user
475     (if gnus-init-inhibit
476         (setq gnus-init-inhibit nil)
477       (setq gnus-init-inhibit inhibit-next)
478       (dolist (file (list gnus-site-init-file gnus-init-file))
479         (when (and file
480                    (locate-library file))
481           (if (or debug-on-error debug-on-quit)
482               (load file nil t)
483             (condition-case var
484                 (load file nil t)
485               (error
486                (error "Error in %s: %s" file (cadr var))))))))))
487
488 ;; For subscribing new newsgroup
489
490 (defun gnus-subscribe-hierarchical-interactive (groups)
491   (let ((groups (sort groups 'string<))
492         prefixes prefix start ans group starts)
493     (while groups
494       (setq prefixes (list "^"))
495       (while (and groups prefixes)
496         (while (not (string-match (car prefixes) (car groups)))
497           (setq prefixes (cdr prefixes)))
498         (setq prefix (car prefixes))
499         (setq start (1- (length prefix)))
500         (if (and (string-match "[^\\.]\\." (car groups) start)
501                  (cdr groups)
502                  (setq prefix
503                        (concat "^" (substring (car groups) 0 (match-end 0))))
504                  (string-match prefix (cadr groups)))
505             (progn
506               (push prefix prefixes)
507               (message "Descend hierarchy %s? ([y]nsq): "
508                        (substring prefix 1 (1- (length prefix))))
509               (while (not (memq (setq ans (read-char-exclusive))
510                                 '(?y ?\n ?\r ?n ?s ?q)))
511                 (ding)
512                 (message "Descend hierarchy %s? ([y]nsq): "
513                          (substring prefix 1 (1- (length prefix)))))
514               (cond ((= ans ?n)
515                      (while (and groups
516                                  (string-match prefix
517                                                (setq group (car groups))))
518                        (push group gnus-killed-list)
519                        (gnus-sethash group group gnus-killed-hashtb)
520                        (setq groups (cdr groups)))
521                      (setq starts (cdr starts)))
522                     ((= ans ?s)
523                      (while (and groups
524                                  (string-match prefix
525                                                (setq group (car groups))))
526                        (gnus-sethash group group gnus-killed-hashtb)
527                        (gnus-subscribe-alphabetically (car groups))
528                        (setq groups (cdr groups)))
529                      (setq starts (cdr starts)))
530                     ((= ans ?q)
531                      (while groups
532                        (setq group (car groups))
533                        (push group gnus-killed-list)
534                        (gnus-sethash group group gnus-killed-hashtb)
535                        (setq groups (cdr groups))))
536                     (t nil)))
537           (message "Subscribe %s? ([n]yq)" (car groups))
538           (while (not (memq (setq ans (read-char-exclusive))
539                             '(?y ?\n ?\r ?q ?n)))
540             (ding)
541             (message "Subscribe %s? ([n]yq)" (car groups)))
542           (setq group (car groups))
543           (cond ((= ans ?y)
544                  (gnus-subscribe-alphabetically (car groups))
545                  (gnus-sethash group group gnus-killed-hashtb))
546                 ((= ans ?q)
547                  (while groups
548                    (setq group (car groups))
549                    (push group gnus-killed-list)
550                    (gnus-sethash group group gnus-killed-hashtb)
551                    (setq groups (cdr groups))))
552                 (t
553                  (push group gnus-killed-list)
554                  (gnus-sethash group group gnus-killed-hashtb)))
555           (setq groups (cdr groups)))))))
556
557 (defun gnus-subscribe-randomly (newsgroup)
558   "Subscribe new NEWSGROUP by making it the first newsgroup."
559   (gnus-subscribe-newsgroup newsgroup))
560
561 (defun gnus-subscribe-alphabetically (newgroup)
562   "Subscribe new NEWGROUP and insert it in alphabetical order."
563   (let ((groups (cdr gnus-newsrc-alist))
564         before)
565     (while (and (not before) groups)
566       (if (string< newgroup (caar groups))
567           (setq before (caar groups))
568         (setq groups (cdr groups))))
569     (gnus-subscribe-newsgroup newgroup before)))
570
571 (defun gnus-subscribe-hierarchically (newgroup)
572   "Subscribe new NEWGROUP and insert it in hierarchical newsgroup order."
573   ;; Basic ideas by mike-w@cs.aukuni.ac.nz (Mike Williams)
574   (save-excursion
575     (set-buffer (nnheader-find-file-noselect gnus-current-startup-file))
576     (prog1
577         (let ((groupkey newgroup) before)
578           (while (and (not before) groupkey)
579             (goto-char (point-min))
580             (let ((groupkey-re
581                    (concat "^\\(" (regexp-quote groupkey) ".*\\)[!:]")))
582               (while (and (re-search-forward groupkey-re nil t)
583                           (progn
584                             (setq before (match-string 1))
585                             (string< before newgroup)))))
586             ;; Remove tail of newsgroup name (eg. a.b.c -> a.b)
587             (setq groupkey
588                   (when (string-match "^\\(.*\\)\\.[^.]+$" groupkey)
589                     (substring groupkey (match-beginning 1) (match-end 1)))))
590           (gnus-subscribe-newsgroup newgroup before))
591       (kill-buffer (current-buffer)))))
592
593 (defun gnus-subscribe-interactively (group)
594   "Subscribe the new GROUP interactively.
595 It is inserted in hierarchical newsgroup order if subscribed.  If not,
596 it is killed."
597   (if (gnus-y-or-n-p (format "Subscribe new newsgroup: %s " group))
598       (gnus-subscribe-hierarchically group)
599     (push group gnus-killed-list)))
600
601 (defun gnus-subscribe-zombies (group)
602   "Make the new GROUP into a zombie group."
603   (push group gnus-zombie-list))
604
605 (defun gnus-subscribe-killed (group)
606   "Make the new GROUP a killed group."
607   (push group gnus-killed-list))
608
609 (defun gnus-subscribe-newsgroup (newsgroup &optional next)
610   "Subscribe new NEWSGROUP.
611 If NEXT is non-nil, it is inserted before NEXT.  Otherwise it is made
612 the first newsgroup."
613   (save-excursion
614     (goto-char (point-min))
615     ;; We subscribe the group by changing its level to `subscribed'.
616     (gnus-group-change-level
617      newsgroup gnus-level-default-subscribed
618      gnus-level-killed (gnus-group-entry (or next "dummy.group")))
619     (gnus-message 5 "Subscribe newsgroup: %s" newsgroup)
620     (run-hook-with-args 'gnus-subscribe-newsgroup-hooks newsgroup)
621     t))
622
623 (defun gnus-read-active-file-p ()
624   "Say whether the active file has been read from `gnus-select-method'."
625   (memq gnus-select-method gnus-have-read-active-file))
626
627 ;;; General various misc type functions.
628
629 ;; Silence byte-compiler.
630 (eval-when-compile
631   (defvar gnus-current-headers)
632   (defvar gnus-thread-indent-array)
633   (defvar gnus-newsgroup-name)
634   (defvar gnus-newsgroup-headers)
635   (defvar gnus-group-list-mode)
636   (defvar gnus-group-mark-positions)
637   (defvar gnus-newsgroup-data)
638   (defvar gnus-newsgroup-unreads)
639   (defvar nnoo-state-alist)
640   (defvar gnus-current-select-method)
641   (defvar mail-sources)
642   (defvar nnmail-scan-directory-mail-source-once)
643   (defvar nnmail-split-history)
644   (defvar nnmail-spool-file))
645
646 (defun gnus-close-all-servers ()
647   "Close all servers."
648   (interactive)
649   (dolist (server gnus-opened-servers)
650     (gnus-close-server (car server))))
651
652 (defun gnus-clear-system ()
653   "Clear all variables and buffers."
654   ;; Clear Gnus variables.
655   (let ((variables (remove 'gnus-format-specs gnus-variable-list)))
656     (while variables
657       (set (car variables) nil)
658       (setq variables (cdr variables))))
659   ;; Clear other internal variables.
660   (setq gnus-list-of-killed-groups nil
661         gnus-have-read-active-file nil
662         gnus-agent-covered-methods nil
663         gnus-server-method-cache nil
664         gnus-newsrc-alist nil
665         gnus-newsrc-hashtb nil
666         gnus-killed-list nil
667         gnus-zombie-list nil
668         gnus-killed-hashtb nil
669         gnus-active-hashtb nil
670         gnus-moderated-hashtb nil
671         gnus-description-hashtb nil
672         gnus-current-headers nil
673         gnus-thread-indent-array nil
674         gnus-newsgroup-headers nil
675         gnus-newsgroup-name nil
676         gnus-server-alist nil
677         gnus-group-list-mode nil
678         gnus-opened-servers nil
679         gnus-group-mark-positions nil
680         gnus-newsgroup-data nil
681         gnus-newsgroup-unreads nil
682         nnoo-state-alist nil
683         gnus-current-select-method nil
684         nnmail-split-history nil
685         gnus-ephemeral-servers nil)
686   (gnus-shutdown 'gnus)
687   ;; Kill the startup file.
688   (and gnus-current-startup-file
689        (get-file-buffer gnus-current-startup-file)
690        (kill-buffer (get-file-buffer gnus-current-startup-file)))
691   ;; Clear the dribble buffer.
692   (gnus-dribble-clear)
693   ;; Kill global KILL file buffer.
694   (when (get-file-buffer (gnus-newsgroup-kill-file nil))
695     (kill-buffer (get-file-buffer (gnus-newsgroup-kill-file nil))))
696   (gnus-kill-buffer nntp-server-buffer)
697   ;; Kill Gnus buffers.
698   (dolist (buffer (gnus-buffers))
699     (gnus-kill-buffer buffer))
700   ;; Remove Gnus frames.
701   (gnus-kill-gnus-frames))
702
703 (defun gnus-no-server-1 (&optional arg slave)
704   "Read network news.
705 If ARG is a positive number, Gnus will use that as the
706 startup level.  If ARG is nil, Gnus will be started at level 2.
707 If ARG is non-nil and not a positive number, Gnus will
708 prompt the user for the name of an NNTP server to use.
709 As opposed to `gnus', this command will not connect to the local server."
710   (interactive "P")
711   (let ((val (or arg (1- gnus-level-default-subscribed))))
712     (gnus val t slave)
713     (make-local-variable 'gnus-group-use-permanent-levels)
714     (setq gnus-group-use-permanent-levels val)))
715
716 (defun gnus-1 (&optional arg dont-connect slave)
717   "Read network news.
718 If ARG is non-nil and a positive number, Gnus will use that as the
719 startup level.  If ARG is non-nil and not a positive number, Gnus will
720 prompt the user for the name of an NNTP server to use."
721   (interactive "P")
722
723   (if (gnus-alive-p)
724       (progn
725         (switch-to-buffer gnus-group-buffer)
726         (gnus-group-get-new-news
727          (and (numberp arg)
728               (> arg 0)
729               (max (car gnus-group-list-mode) arg))))
730
731     (gnus-clear-system)
732     (gnus-splash)
733     (gnus-run-hooks 'gnus-before-startup-hook)
734     (nnheader-init-server-buffer)
735     (setq gnus-slave slave)
736     (gnus-read-init-file)
737     (if gnus-agent
738         (gnus-agentize))
739
740     (when gnus-simple-splash
741       (setq gnus-simple-splash nil)
742       (cond
743        ((featurep 'xemacs)
744         (gnus-xmas-splash))
745        ((and window-system
746              (= (frame-height) (1+ (window-height))))
747         (gnus-x-splash))))
748
749     (let ((level (and (numberp arg) (> arg 0) arg))
750           did-connect)
751       (unwind-protect
752           (progn
753             (unless dont-connect
754               (setq did-connect
755                     (gnus-start-news-server (and arg (not level))))))
756         (if (and (not dont-connect)
757                  (not did-connect))
758             (gnus-group-quit)
759           (gnus-run-hooks 'gnus-startup-hook)
760           ;; NNTP server is successfully open.
761
762           ;; Find the current startup file name.
763           (setq gnus-current-startup-file
764                 (gnus-make-newsrc-file gnus-startup-file))
765
766           ;; Read the dribble file.
767           (when (or gnus-slave gnus-use-dribble-file)
768             (gnus-dribble-read-file))
769
770           ;; Allow using GroupLens predictions.
771           (when gnus-use-grouplens
772             (bbb-login)
773             (add-hook 'gnus-summary-mode-hook 'gnus-grouplens-mode))
774
775           ;; Do the actual startup.
776           (if gnus-agent
777               (gnus-request-create-group "queue" '(nndraft "")))
778           (gnus-request-create-group "drafts" '(nndraft ""))
779           (gnus-setup-news nil level dont-connect)
780           (gnus-run-hooks 'gnus-setup-news-hook)
781           (gnus-start-draft-setup)
782           ;; Generate the group buffer.
783           (gnus-group-list-groups level)
784           (gnus-group-first-unread-group)
785           (gnus-configure-windows 'group)
786           (gnus-group-set-mode-line)
787           (gnus-run-hooks 'gnus-started-hook))))))
788
789 (defun gnus-start-draft-setup ()
790   "Make sure the draft group exists."
791   (gnus-request-create-group "drafts" '(nndraft ""))
792   (unless (gnus-group-entry "nndraft:drafts")
793     (let ((gnus-level-default-subscribed 1))
794       (gnus-subscribe-group "nndraft:drafts" nil '(nndraft "")))
795     (gnus-group-set-parameter
796      "nndraft:drafts" 'gnus-dummy '((gnus-draft-mode)))))
797
798 \f
799 ;;;
800 ;;; Dribble file
801 ;;;
802
803 (defvar gnus-dribble-ignore nil)
804 (defvar gnus-dribble-eval-file nil)
805
806 (defun gnus-dribble-file-name ()
807   "Return the dribble file for the current .newsrc."
808   (concat
809    (if gnus-dribble-directory
810        (concat (file-name-as-directory gnus-dribble-directory)
811                (file-name-nondirectory gnus-current-startup-file))
812      gnus-current-startup-file)
813    "-dribble"))
814
815 (defun gnus-dribble-enter (string)
816   "Enter STRING into the dribble buffer."
817   (when (and (not gnus-dribble-ignore)
818              gnus-dribble-buffer
819              (buffer-name gnus-dribble-buffer))
820     (let ((obuf (current-buffer)))
821       (set-buffer gnus-dribble-buffer)
822       (goto-char (point-max))
823       (insert string "\n")
824       ;; This has been commented by Josh Huber <huber@alum.wpi.edu>
825       ;; It causes problems with both XEmacs and Emacs 21, and doesn't
826       ;; seem to be of much value. (FIXME: remove this after we make sure
827       ;; it's not needed).
828       ;; (set-window-point (get-buffer-window (current-buffer)) (point-max))
829       (bury-buffer gnus-dribble-buffer)
830       (save-excursion
831         (set-buffer gnus-group-buffer)
832         (gnus-group-set-mode-line))
833       (set-buffer obuf))))
834
835 (defun gnus-dribble-touch ()
836   "Touch the dribble buffer."
837   (gnus-dribble-enter ""))
838
839 (defun gnus-dribble-read-file ()
840   "Read the dribble file from disk."
841   (let ((dribble-file (gnus-dribble-file-name)))
842     (save-excursion
843       (set-buffer (setq gnus-dribble-buffer
844                         (gnus-get-buffer-create
845                          (file-name-nondirectory dribble-file))))
846       (erase-buffer)
847       (setq buffer-file-name dribble-file)
848       (auto-save-mode t)
849       (buffer-disable-undo)
850       (bury-buffer (current-buffer))
851       (set-buffer-modified-p nil)
852       (let ((auto (make-auto-save-file-name))
853             (gnus-dribble-ignore t)
854             (purpose nil)
855             modes)
856         (when (or (file-exists-p auto) (file-exists-p dribble-file))
857           ;; Load whichever file is newest -- the auto save file
858           ;; or the "real" file.
859           (if (file-newer-than-file-p auto dribble-file)
860               (nnheader-insert-file-contents auto)
861             (nnheader-insert-file-contents dribble-file))
862           (unless (zerop (buffer-size))
863             (set-buffer-modified-p t))
864           ;; Set the file modes to reflect the .newsrc file modes.
865           (save-buffer)
866           (when (and (file-exists-p gnus-current-startup-file)
867                      (file-exists-p dribble-file)
868                      (setq modes (file-modes gnus-current-startup-file)))
869             (set-file-modes dribble-file modes))
870           (goto-char (point-min))
871           (when (search-forward "Gnus was exited on purpose" nil t)
872             (setq purpose t))
873           ;; Possibly eval the file later.
874           (when (or gnus-always-read-dribble-file
875                     (gnus-y-or-n-p
876                      (if purpose
877                          "Gnus exited on purpose without saving; read auto-save file anyway? "
878                      "Gnus auto-save file exists.  Do you want to read it? ")))
879             (setq gnus-dribble-eval-file t)))))))
880
881 (defun gnus-dribble-eval-file ()
882   (when gnus-dribble-eval-file
883     (setq gnus-dribble-eval-file nil)
884     (save-excursion
885       (let ((gnus-dribble-ignore t))
886         (set-buffer gnus-dribble-buffer)
887         (eval-buffer (current-buffer))))))
888
889 (defun gnus-dribble-delete-file ()
890   (when (file-exists-p (gnus-dribble-file-name))
891     (delete-file (gnus-dribble-file-name)))
892   (when gnus-dribble-buffer
893     (save-excursion
894       (set-buffer gnus-dribble-buffer)
895       (let ((auto (make-auto-save-file-name)))
896         (when (file-exists-p auto)
897           (delete-file auto))
898         (erase-buffer)
899         (set-buffer-modified-p nil)))))
900
901 (defun gnus-dribble-save ()
902   (when (and gnus-dribble-buffer
903              (buffer-name gnus-dribble-buffer))
904     (save-excursion
905       (set-buffer gnus-dribble-buffer)
906       (save-buffer))))
907
908 (defun gnus-dribble-clear ()
909   (when (gnus-buffer-exists-p gnus-dribble-buffer)
910     (save-excursion
911       (set-buffer gnus-dribble-buffer)
912       (erase-buffer)
913       (set-buffer-modified-p nil)
914       (setq buffer-saved-size (buffer-size)))))
915
916 \f
917 ;;;
918 ;;; Active & Newsrc File Handling
919 ;;;
920
921 (defun gnus-setup-news (&optional rawfile level dont-connect)
922   "Setup news information.
923 If RAWFILE is non-nil, the .newsrc file will also be read.
924 If LEVEL is non-nil, the news will be set up at level LEVEL."
925   (require 'nnmail)
926   (let ((init (not (and gnus-newsrc-alist gnus-active-hashtb (not rawfile))))
927         ;; Binding this variable will inhibit multiple fetchings
928         ;; of the same mail source.
929         (nnmail-fetched-sources (list t)))
930
931     (when init
932       ;; Clear some variables to re-initialize news information.
933       (setq gnus-newsrc-alist nil
934             gnus-active-hashtb nil)
935       ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
936       (gnus-read-newsrc-file rawfile))
937
938     ;; Make sure the archive server is available to all and sundry.
939     (when gnus-message-archive-method
940       (unless (assoc "archive" gnus-server-alist)
941         (push `("archive"
942                 nnfolder
943                 "archive"
944                 (nnfolder-directory
945                  ,(nnheader-concat message-directory "archive"))
946                 (nnfolder-active-file
947                  ,(nnheader-concat message-directory "archive/active"))
948                 (nnfolder-get-new-mail nil)
949                 (nnfolder-inhibit-expiry t))
950               gnus-server-alist)))
951
952     ;; If we don't read the complete active file, we fill in the
953     ;; hashtb here.
954     (when (or (null gnus-read-active-file)
955               (eq gnus-read-active-file 'some))
956       (gnus-update-active-hashtb-from-killed))
957
958     ;; Validate agent covered methods now that gnus-server-alist has
959     ;; been initialized.
960     ;; NOTE: This is here for one purpose only.  By validating the
961     ;; agentized server's, it converts the old 5.10.3, and earlier,
962     ;; format to the current format.  That enables the agent code
963     ;; within gnus-read-active-file to function correctly.
964     (if gnus-agent
965         (gnus-agent-read-servers-validate))
966
967     ;; Read the active file and create `gnus-active-hashtb'.
968     ;; If `gnus-read-active-file' is nil, then we just create an empty
969     ;; hash table.  The partial filling out of the hash table will be
970     ;; done in `gnus-get-unread-articles'.
971     (and gnus-read-active-file
972          (not level)
973          (gnus-read-active-file nil dont-connect))
974
975     (unless gnus-active-hashtb
976       (setq gnus-active-hashtb (gnus-make-hashtable 4096)))
977
978     ;; Initialize the cache.
979     (when gnus-use-cache
980       (gnus-cache-open))
981
982     ;; Possibly eval the dribble file.
983     (and init
984          (or gnus-use-dribble-file gnus-slave)
985          (gnus-dribble-eval-file))
986
987     ;; Slave Gnusii should then clear the dribble buffer.
988     (when (and init gnus-slave)
989       (gnus-dribble-clear))
990
991     (gnus-update-format-specifications)
992
993     ;; See whether we need to read the description file.
994     (when (and (boundp 'gnus-group-line-format)
995                (stringp gnus-group-line-format)
996                (let ((case-fold-search nil))
997                  (string-match "%[-,0-9]*D" gnus-group-line-format))
998                (not gnus-description-hashtb)
999                (not dont-connect)
1000                gnus-read-active-file)
1001       (gnus-read-all-descriptions-files))
1002
1003     ;; Find new newsgroups and treat them.
1004     (when (and init gnus-check-new-newsgroups (not level)
1005                (gnus-check-server gnus-select-method)
1006                (not gnus-slave)
1007                gnus-plugged)
1008       (gnus-find-new-newsgroups))
1009
1010     ;; Check and remove bogus newsgroups.
1011     (when (and init gnus-check-bogus-newsgroups
1012                gnus-read-active-file (not level)
1013                (gnus-server-opened gnus-select-method))
1014       (gnus-check-bogus-newsgroups))
1015
1016     ;; We might read in new NoCeM messages here.
1017     (when (and gnus-use-nocem
1018                (not level)
1019                (not dont-connect))
1020       (gnus-nocem-scan-groups))
1021
1022     ;; Read any slave files.
1023     (gnus-master-read-slave-newsrc)
1024
1025     ;; Find the number of unread articles in each non-dead group.
1026     (let ((gnus-read-active-file (and (not level) gnus-read-active-file)))
1027       (gnus-get-unread-articles level))))
1028
1029 (defun gnus-call-subscribe-functions (method group)
1030   "Call METHOD to subscribe GROUP.
1031 If no function returns `non-nil', call `gnus-subscribe-zombies'."
1032   (unless (cond
1033            ((functionp method)
1034             (funcall method group))
1035            ((listp method)
1036             (catch 'found
1037               (dolist (func method)
1038                 (if (funcall func group)
1039                     (throw 'found t)))
1040               nil))
1041            (t nil))
1042     (gnus-subscribe-zombies group)))
1043
1044 (defun gnus-find-new-newsgroups (&optional arg)
1045   "Search for new newsgroups and add them.
1046 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1047 The `-n' option line from .newsrc is respected.
1048
1049 With 1 C-u, use the `ask-server' method to query the server for new
1050 groups.
1051 With 2 C-u's, use most complete method possible to query the server
1052 for new groups, and subscribe the new groups as zombies."
1053   (interactive "p")
1054   (let* ((gnus-subscribe-newsgroup-method
1055           gnus-subscribe-newsgroup-method)
1056          (check (cond
1057                  ((or (and (= (or arg 1) 4)
1058                            (not (listp gnus-check-new-newsgroups)))
1059                       (null gnus-read-active-file)
1060                       (eq gnus-read-active-file 'some))
1061                   'ask-server)
1062                  ((= (or arg 1) 16)
1063                   (setq gnus-subscribe-newsgroup-method
1064                         'gnus-subscribe-zombies)
1065                   t)
1066                  (t gnus-check-new-newsgroups))))
1067     (unless (gnus-check-first-time-used)
1068       (if (or (consp check)
1069               (eq check 'ask-server))
1070           ;; Ask the server for new groups.
1071           (gnus-ask-server-for-new-groups)
1072         ;; Go through the active hashtb and look for new groups.
1073         (let ((groups 0)
1074               group new-newsgroups)
1075           (gnus-message 5 "Looking for new newsgroups...")
1076           (unless gnus-have-read-active-file
1077             (gnus-read-active-file))
1078           (setq gnus-newsrc-last-checked-date (message-make-date))
1079           (unless gnus-killed-hashtb
1080             (gnus-make-hashtable-from-killed))
1081           ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1082           ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1083           (mapatoms
1084            (lambda (sym)
1085              (if (or (null (setq group (symbol-name sym)))
1086                      (not (boundp sym))
1087                      (null (symbol-value sym))
1088                      (gnus-gethash group gnus-killed-hashtb)
1089                      (gnus-gethash group gnus-newsrc-hashtb))
1090                  ()
1091                (let ((do-sub (gnus-matches-options-n group)))
1092                  (cond
1093                   ((eq do-sub 'subscribe)
1094                    (setq groups (1+ groups))
1095                    (gnus-sethash group group gnus-killed-hashtb)
1096                    (gnus-call-subscribe-functions
1097                     gnus-subscribe-options-newsgroup-method group))
1098                   ((eq do-sub 'ignore)
1099                    nil)
1100                   (t
1101                    (setq groups (1+ groups))
1102                    (gnus-sethash group group gnus-killed-hashtb)
1103                    (if gnus-subscribe-hierarchical-interactive
1104                        (push group new-newsgroups)
1105                      (gnus-call-subscribe-functions
1106                       gnus-subscribe-newsgroup-method group)))))))
1107            gnus-active-hashtb)
1108           (when new-newsgroups
1109             (gnus-subscribe-hierarchical-interactive new-newsgroups))
1110           (if (> groups 0)
1111               (gnus-message 5 "%d new newsgroup%s arrived."
1112                             groups (if (> groups 1) "s have" " has"))
1113             (gnus-message 5 "No new newsgroups.")))))))
1114
1115 (defun gnus-matches-options-n (group)
1116   ;; Returns `subscribe' if the group is to be unconditionally
1117   ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1118   ;; no match for the group.
1119
1120   ;; First we check the two user variables.
1121   (cond
1122    ((and gnus-options-subscribe
1123          (string-match gnus-options-subscribe group))
1124     'subscribe)
1125    ((and gnus-auto-subscribed-groups
1126          (string-match gnus-auto-subscribed-groups group))
1127     'subscribe)
1128    ((and gnus-options-not-subscribe
1129          (string-match gnus-options-not-subscribe group))
1130     'ignore)
1131    ;; Then we go through the list that was retrieved from the .newsrc
1132    ;; file.  This list has elements on the form
1133    ;; `(REGEXP . {ignore,subscribe})'.  The first match found (the list
1134    ;; is in the reverse order of the options line) is returned.
1135    (t
1136     (let ((regs gnus-newsrc-options-n))
1137       (while (and regs
1138                   (not (string-match (caar regs) group)))
1139         (setq regs (cdr regs)))
1140       (and regs (cdar regs))))))
1141
1142 (defun gnus-ask-server-for-new-groups ()
1143   (let* ((new-date (message-make-date))
1144          (date (or gnus-newsrc-last-checked-date new-date))
1145          (methods (cons gnus-select-method
1146                         (nconc
1147                          (when (gnus-archive-server-wanted-p)
1148                            (list "archive"))
1149                          (append
1150                           (and (consp gnus-check-new-newsgroups)
1151                                gnus-check-new-newsgroups)
1152                           gnus-secondary-select-methods))))
1153          (groups 0)
1154          group new-newsgroups got-new method hashtb
1155          gnus-override-subscribe-method)
1156     (unless gnus-killed-hashtb
1157       (gnus-make-hashtable-from-killed))
1158     ;; Go through both primary and secondary select methods and
1159     ;; request new newsgroups.
1160     (while (setq method (gnus-server-get-method nil (pop methods)))
1161       (setq new-newsgroups nil
1162             gnus-override-subscribe-method method)
1163       (when (and (gnus-check-server method)
1164                  (gnus-request-newgroups date method))
1165         (save-excursion