* gnus-start.el (gnus-read-init-file): Ditto.
[gnus] / lisp / gnus-start.el
1 ;;; gnus-start.el --- startup functions for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
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 (require 'message)
36 (eval-when-compile (require 'cl))
37
38 (defcustom gnus-startup-file (nnheader-concat gnus-home-directory ".newsrc")
39   "Your `.newsrc' file.
40 `.newsrc-SERVER' will be used instead if that exists."
41   :group 'gnus-start
42   :type 'file)
43
44 (defcustom gnus-init-file (nnheader-concat gnus-home-directory ".gnus")
45   "Your Gnus Emacs-Lisp startup file name.
46 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
47   :group 'gnus-start
48   :type 'file)
49
50 (defcustom gnus-site-init-file
51   (condition-case nil
52       (concat (file-name-directory
53                (directory-file-name installation-directory))
54               "site-lisp/gnus-init")
55     (error nil))
56   "The site-wide Gnus Emacs-Lisp startup file name, or nil if none.
57 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
58   :group 'gnus-start
59   :type '(choice file (const nil)))
60
61 (defcustom gnus-default-subscribed-newsgroups nil
62   "List of newsgroups to subscribe, when a user runs Gnus the first time.
63 The value should be a list of strings.
64 If it is t, Gnus will not do anything special the first time it is
65 started; it'll just use the normal newsgroups subscription methods."
66   :group 'gnus-start
67   :type '(choice (repeat string) (const :tag "Nothing special" t)))
68
69 (defcustom gnus-use-dribble-file t
70   "*Non-nil means that Gnus will use a dribble file to store user updates.
71 If Emacs should crash without saving the .newsrc files, complete
72 information can be restored from the dribble file."
73   :group 'gnus-dribble-file
74   :type 'boolean)
75
76 (defcustom gnus-dribble-directory nil
77   "*The directory where dribble files will be saved.
78 If this variable is nil, the directory where the .newsrc files are
79 saved will be used."
80   :group 'gnus-dribble-file
81   :type '(choice directory (const nil)))
82
83 (defcustom gnus-check-new-newsgroups 'ask-server
84   "*Non-nil means that Gnus will run `gnus-find-new-newsgroups' at startup.
85 This normally finds new newsgroups by comparing the active groups the
86 servers have already reported with those Gnus already knows, either alive
87 or killed.
88
89 When any of the following are true, `gnus-find-new-newsgroups' will instead
90 ask the servers (primary, secondary, and archive servers) to list new
91 groups since the last time it checked:
92   1. This variable is `ask-server'.
93   2. This variable is a list of select methods (see below).
94   3. `gnus-read-active-file' is nil or `some'.
95   4. A prefix argument is given to `gnus-find-new-newsgroups' interactively.
96
97 Thus, if this variable is `ask-server' or a list of select methods or
98 `gnus-read-active-file' is nil or `some', then the killed list is no
99 longer necessary, so you could safely set `gnus-save-killed-list' to nil.
100
101 This variable can be a list of select methods which Gnus will query with
102 the `ask-server' method in addition to the primary, secondary, and archive
103 servers.
104
105 Eg.
106   (setq gnus-check-new-newsgroups
107         '((nntp \"some.server\") (nntp \"other.server\")))
108
109 If this variable is nil, then you have to tell Gnus explicitly to
110 check for new newsgroups with \\<gnus-group-mode-map>\\[gnus-find-new-newsgroups]."
111   :group 'gnus-start
112   :type '(choice (const :tag "no" nil)
113                  (const :tag "by brute force" t)
114                  (const :tag "ask servers" ask-server)
115                  (repeat :menu-tag "ask additional servers"
116                          :tag "ask additional servers"
117                          :value ((nntp ""))
118                          (sexp :format "%v"))))
119
120 (defcustom gnus-check-bogus-newsgroups nil
121   "*Non-nil means that Gnus will check and remove bogus newsgroup at startup.
122 If this variable is nil, then you have to tell Gnus explicitly to
123 check for bogus newsgroups with \\<gnus-group-mode-map>\\[gnus-group-check-bogus-groups]."
124   :group 'gnus-start-server
125   :type 'boolean)
126
127 (defcustom gnus-read-active-file 'some
128   "*Non-nil means that Gnus will read the entire active file at startup.
129 If this variable is nil, Gnus will only know about the groups in your
130 `.newsrc' file.
131
132 If this variable is `some', Gnus will try to only read the relevant
133 parts of the active file from the server.  Not all servers support
134 this, and it might be quite slow with other servers, but this should
135 generally be faster than both the t and nil value.
136
137 If you set this variable to nil or `some', you probably still want to
138 be told about new newsgroups that arrive.  To do that, set
139 `gnus-check-new-newsgroups' to `ask-server'.  This may not work
140 properly with all servers."
141   :group 'gnus-start-server
142   :type '(choice (const nil)
143                  (const some)
144                  (const t)))
145
146 (defconst gnus-level-subscribed 5
147   "Groups with levels less than or equal to this variable are subscribed.")
148
149 (defconst gnus-level-unsubscribed 7
150   "Groups with levels less than or equal to this variable are unsubscribed.
151 Groups with levels less than `gnus-level-subscribed', which should be
152 less than this variable, are subscribed.")
153
154 (defconst gnus-level-zombie 8
155   "Groups with this level are zombie groups.")
156
157 (defconst gnus-level-killed 9
158   "Groups with this level are killed.")
159
160 (defcustom gnus-level-default-subscribed 3
161   "*New subscribed groups will be subscribed at this level."
162   :group 'gnus-group-levels
163   :type 'integer)
164
165 (defcustom gnus-level-default-unsubscribed 6
166   "*New unsubscribed groups will be unsubscribed at this level."
167   :group 'gnus-group-levels
168   :type 'integer)
169
170 (defcustom gnus-activate-level (1+ gnus-level-subscribed)
171   "*Groups higher than this level won't be activated on startup.
172 Setting this variable to something low might save lots of time when
173 you have many groups that you aren't interested in."
174   :group 'gnus-group-levels
175   :type 'integer)
176
177 (defcustom gnus-activate-foreign-newsgroups 4
178   "*If nil, Gnus will not check foreign newsgroups at startup.
179 If it is non-nil, it should be a number between one and nine.  Foreign
180 newsgroups that have a level lower or equal to this number will be
181 activated on startup.  For instance, if you want to active all
182 subscribed newsgroups, but not the rest, you'd set this variable to
183 `gnus-level-subscribed'.
184
185 If you subscribe to lots of newsgroups from different servers, startup
186 might take a while.  By setting this variable to nil, you'll save time,
187 but you won't be told how many unread articles there are in the
188 groups."
189   :group 'gnus-group-levels
190   :type '(choice integer
191                  (const :tag "none" nil)))
192
193 (defcustom gnus-read-newsrc-file t
194   "*Non-nil means that Gnus will read the `.newsrc' file.
195 Gnus always reads its own startup file, which is called
196 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
197 be readily understood by other newsreaders.  If you don't plan on
198 using other newsreaders, set this variable to nil to save some time on
199 entry."
200   :version "21.1"
201   :group 'gnus-newsrc
202   :type 'boolean)
203
204 (defcustom gnus-save-newsrc-file t
205   "*Non-nil means that Gnus will save the `.newsrc' file.
206 Gnus always saves its own startup file, which is called
207 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
208 be readily understood by other newsreaders.  If you don't plan on
209 using other newsreaders, set this variable to nil to save some time on
210 exit."
211   :group 'gnus-newsrc
212   :type 'boolean)
213
214 (defcustom gnus-save-killed-list t
215   "*If non-nil, save the list of killed groups to the startup file.
216 If you set this variable to nil, you'll save both time (when starting
217 and quitting) and space (both memory and disk), but it will also mean
218 that Gnus has no record of which groups are new and which are old, so
219 the automatic new newsgroups subscription methods become meaningless.
220
221 You should always set `gnus-check-new-newsgroups' to `ask-server' or
222 nil if you set this variable to nil.
223
224 This variable can also be a regexp.  In that case, all groups that do
225 not match this regexp will be removed before saving the list."
226   :group 'gnus-newsrc
227   :type 'boolean)
228
229 (defcustom gnus-ignored-newsgroups
230   (mapconcat 'identity
231              '("^to\\."                 ; not "real" groups
232                "^[0-9. \t]+\\( \\|$\\)" ; all digits in name
233                "^[\"][]\"[#'()]"        ; bogus characters
234                )
235              "\\|")
236   "*A regexp to match uninteresting newsgroups in the active file.
237 Any lines in the active file matching this regular expression are
238 removed from the newsgroup list before anything else is done to it,
239 thus making them effectively non-existent."
240   :group 'gnus-group-new
241   :type 'regexp)
242
243 (defcustom gnus-subscribe-newsgroup-method 'gnus-subscribe-zombies
244   "*Function(s) called with a group name when new group is detected.
245 A few pre-made functions are supplied: `gnus-subscribe-randomly'
246 inserts new groups at the beginning of the list of groups;
247 `gnus-subscribe-alphabetically' inserts new groups in strict
248 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
249 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
250 for your decision; `gnus-subscribe-killed' kills all new groups;
251 `gnus-subscribe-zombies' will make all new groups into zombies;
252 `gnus-subscribe-topics' will enter groups into the topics that
253 claim them."
254   :group 'gnus-group-new
255   :type '(radio (function-item gnus-subscribe-randomly)
256                 (function-item gnus-subscribe-alphabetically)
257                 (function-item gnus-subscribe-hierarchically)
258                 (function-item gnus-subscribe-interactively)
259                 (function-item gnus-subscribe-killed)
260                 (function-item gnus-subscribe-zombies)
261                 (function-item gnus-subscribe-topics)
262                 function
263                 (repeat function)))
264
265 (defcustom gnus-subscribe-newsgroup-hooks nil
266   "*Hooks run after you subscribe to a new group. The hooks will be called
267 with new group's name as argument."
268   :group 'gnus-group-new
269   :type 'hook)
270
271 (defcustom gnus-subscribe-options-newsgroup-method
272   'gnus-subscribe-alphabetically
273   "*Function(s) called to subscribe newsgroups mentioned on \"options -n\" lines.
274 If, for instance, you want to subscribe to all newsgroups in the
275 \"no\" and \"alt\" hierarchies, you'd put the following in your
276 .newsrc file:
277
278 options -n no.all alt.all
279
280 Gnus will the subscribe all new newsgroups in these hierarchies with
281 the subscription method in this variable."
282   :group 'gnus-group-new
283   :type '(radio (function-item gnus-subscribe-randomly)
284                 (function-item gnus-subscribe-alphabetically)
285                 (function-item gnus-subscribe-hierarchically)
286                 (function-item gnus-subscribe-interactively)
287                 (function-item gnus-subscribe-killed)
288                 (function-item gnus-subscribe-zombies)
289                 (function-item gnus-subscribe-topics)
290                 function
291                 (repeat function)))
292
293 (defcustom gnus-subscribe-hierarchical-interactive nil
294   "*If non-nil, Gnus will offer to subscribe hierarchically.
295 When a new hierarchy appears, Gnus will ask the user:
296
297 'alt.binaries': Do you want to subscribe to this hierarchy? ([d]ys):
298
299 If the user pressed `d', Gnus will descend the hierarchy, `y' will
300 subscribe to all newsgroups in the hierarchy and `s' will skip this
301 hierarchy in its entirety."
302   :group 'gnus-group-new
303   :type 'boolean)
304
305 (defcustom gnus-auto-subscribed-groups
306   "^nnml\\|^nnfolder\\|^nnmbox\\|^nnmh\\|^nnbabyl"
307   "*All new groups that match this regexp will be subscribed automatically.
308 Note that this variable only deals with new groups.  It has no effect
309 whatsoever on old groups.
310
311 New groups that match this regexp will not be handled by
312 `gnus-subscribe-newsgroup-method'.  Instead, they will
313 be subscribed using `gnus-subscribe-options-newsgroup-method'."
314   :group 'gnus-group-new
315   :type 'regexp)
316
317 (defcustom gnus-options-subscribe nil
318   "*All new groups matching this regexp will be subscribed unconditionally.
319 Note that this variable deals only with new newsgroups.  This variable
320 does not affect old newsgroups.
321
322 New groups that match this regexp will not be handled by
323 `gnus-subscribe-newsgroup-method'.  Instead, they will
324 be subscribed using `gnus-subscribe-options-newsgroup-method'."
325   :group 'gnus-group-new
326   :type '(choice regexp
327                  (const :tag "none" nil)))
328
329 (defcustom gnus-options-not-subscribe nil
330   "*All new groups matching this regexp will be ignored.
331 Note that this variable deals only with new newsgroups.  This variable
332 does not affect old (already subscribed) newsgroups."
333   :group 'gnus-group-new
334   :type '(choice regexp
335                  (const :tag "none" nil)))
336
337 (defcustom gnus-modtime-botch nil
338   "*Non-nil means .newsrc should be deleted prior to save.
339 Its use is due to the bogus appearance that .newsrc was modified on
340 disc."
341   :group 'gnus-newsrc
342   :type 'boolean)
343
344 (defcustom gnus-check-bogus-groups-hook nil
345   "A hook run after removing bogus groups."
346   :group 'gnus-start-server
347   :type 'hook)
348
349 (defcustom gnus-startup-hook nil
350   "A hook called at startup.
351 This hook is called after Gnus is connected to the NNTP server."
352   :group 'gnus-start
353   :type 'hook)
354
355 (defcustom gnus-before-startup-hook nil
356   "A hook called at before startup.
357 This hook is called as the first thing when Gnus is started."
358   :group 'gnus-start
359   :type 'hook)
360
361 (defcustom gnus-started-hook nil
362   "A hook called as the last thing after startup."
363   :group 'gnus-start
364   :type 'hook)
365
366 (defcustom gnus-setup-news-hook nil
367   "A hook after reading the .newsrc file, but before generating the buffer."
368   :group 'gnus-start
369   :type 'hook)
370
371 (defcustom gnus-get-new-news-hook nil
372   "A hook run just before Gnus checks for new news."
373   :group 'gnus-group-new
374   :type 'hook)
375
376 (defcustom gnus-after-getting-new-news-hook
377   '(gnus-display-time-event-handler)
378   "*A hook run after Gnus checks for new news when Gnus is already running."
379   :group 'gnus-group-new
380   :type 'hook)
381
382 (defcustom gnus-save-newsrc-hook nil
383   "A hook called before saving any of the newsrc files."
384   :group 'gnus-newsrc
385   :type 'hook)
386
387 (defcustom gnus-save-quick-newsrc-hook nil
388   "A hook called just before saving the quick newsrc file.
389 Can be used to turn version control on or off."
390   :group 'gnus-newsrc
391   :type 'hook)
392
393 (defcustom gnus-save-standard-newsrc-hook nil
394   "A hook called just before saving the standard newsrc file.
395 Can be used to turn version control on or off."
396   :group 'gnus-newsrc
397   :type 'hook)
398
399 (defcustom gnus-group-mode-hook nil
400   "Hook for Gnus group mode."
401   :group 'gnus-group-various
402   :options '(gnus-topic-mode)
403   :type 'hook)
404
405 (defcustom gnus-always-read-dribble-file nil
406   "Unconditionally read the dribble file."
407   :group 'gnus-newsrc
408   :type 'boolean)
409
410 ;;; Internal variables
411
412 (defvar gnus-ding-file-coding-system mm-universal-coding-system
413   "Coding system for ding file.")
414
415 (defvar gnus-newsrc-file-version nil)
416 (defvar gnus-override-subscribe-method nil)
417 (defvar gnus-dribble-buffer nil)
418 (defvar gnus-newsrc-options nil
419   "Options line in the .newsrc file.")
420
421 (defvar gnus-newsrc-options-n nil
422   "List of regexps representing groups to be subscribed/ignored unconditionally.")
423
424 (defvar gnus-newsrc-last-checked-date nil
425   "Date Gnus last asked server for new newsgroups.")
426
427 (defvar gnus-current-startup-file nil
428   "Startup file for the current host.")
429
430 ;; Byte-compiler warning.
431 (defvar gnus-group-line-format)
432
433 ;; Suggested by Brian Edmonds <edmonds@cs.ubc.ca>.
434 (defvar gnus-init-inhibit nil)
435 (defun gnus-read-init-file (&optional inhibit-next)
436   ;; Don't load .gnus if the -q option was used.
437   (when init-file-user
438     (if gnus-init-inhibit
439         (setq gnus-init-inhibit nil)
440       (setq gnus-init-inhibit inhibit-next)
441       (dolist (file (list gnus-site-init-file gnus-init-file))
442         (when (and file
443                    (locate-library file))
444           (if (or debug-on-error debug-on-quit)
445               (load file nil t)
446             (condition-case var
447                 (load file nil t)
448               (error
449                (error "Error in %s: %s" file (cadr var))))))))))
450
451 ;; For subscribing new newsgroup
452
453 (defun gnus-subscribe-hierarchical-interactive (groups)
454   (let ((groups (sort groups 'string<))
455         prefixes prefix start ans group starts)
456     (while groups
457       (setq prefixes (list "^"))
458       (while (and groups prefixes)
459         (while (not (string-match (car prefixes) (car groups)))
460           (setq prefixes (cdr prefixes)))
461         (setq prefix (car prefixes))
462         (setq start (1- (length prefix)))
463         (if (and (string-match "[^\\.]\\." (car groups) start)
464                  (cdr groups)
465                  (setq prefix
466                        (concat "^" (substring (car groups) 0 (match-end 0))))
467                  (string-match prefix (cadr groups)))
468             (progn
469               (push prefix prefixes)
470               (message "Descend hierarchy %s? ([y]nsq): "
471                        (substring prefix 1 (1- (length prefix))))
472               (while (not (memq (setq ans (read-char-exclusive))
473                                 '(?y ?\n ?\r ?n ?s ?q)))
474                 (ding)
475                 (message "Descend hierarchy %s? ([y]nsq): "
476                          (substring prefix 1 (1- (length prefix)))))
477               (cond ((= ans ?n)
478                      (while (and groups
479                                  (string-match prefix
480                                                (setq group (car groups))))
481                        (push group gnus-killed-list)
482                        (gnus-sethash group group gnus-killed-hashtb)
483                        (setq groups (cdr groups)))
484                      (setq starts (cdr starts)))
485                     ((= ans ?s)
486                      (while (and groups
487                                  (string-match prefix
488                                                (setq group (car groups))))
489                        (gnus-sethash group group gnus-killed-hashtb)
490                        (gnus-subscribe-alphabetically (car groups))
491                        (setq groups (cdr groups)))
492                      (setq starts (cdr starts)))
493                     ((= ans ?q)
494                      (while groups
495                        (setq group (car groups))
496                        (push group gnus-killed-list)
497                        (gnus-sethash group group gnus-killed-hashtb)
498                        (setq groups (cdr groups))))
499                     (t nil)))
500           (message "Subscribe %s? ([n]yq)" (car groups))
501           (while (not (memq (setq ans (read-char-exclusive))
502                             '(?y ?\n ?\r ?q ?n)))
503             (ding)
504             (message "Subscribe %s? ([n]yq)" (car groups)))
505           (setq group (car groups))
506           (cond ((= ans ?y)
507                  (gnus-subscribe-alphabetically (car groups))
508                  (gnus-sethash group group gnus-killed-hashtb))
509                 ((= ans ?q)
510                  (while groups
511                    (setq group (car groups))
512                    (push group gnus-killed-list)
513                    (gnus-sethash group group gnus-killed-hashtb)
514                    (setq groups (cdr groups))))
515                 (t
516                  (push group gnus-killed-list)
517                  (gnus-sethash group group gnus-killed-hashtb)))
518           (setq groups (cdr groups)))))))
519
520 (defun gnus-subscribe-randomly (newsgroup)
521   "Subscribe new NEWSGROUP by making it the first newsgroup."
522   (gnus-subscribe-newsgroup newsgroup))
523
524 (defun gnus-subscribe-alphabetically (newgroup)
525   "Subscribe new NEWSGROUP and insert it in alphabetical order."
526   (let ((groups (cdr gnus-newsrc-alist))
527         before)
528     (while (and (not before) groups)
529       (if (string< newgroup (caar groups))
530           (setq before (caar groups))
531         (setq groups (cdr groups))))
532     (gnus-subscribe-newsgroup newgroup before)))
533
534 (defun gnus-subscribe-hierarchically (newgroup)
535   "Subscribe new NEWSGROUP and insert it in hierarchical newsgroup order."
536   ;; Basic ideas by mike-w@cs.aukuni.ac.nz (Mike Williams)
537   (save-excursion
538     (set-buffer (nnheader-find-file-noselect gnus-current-startup-file))
539     (prog1
540         (let ((groupkey newgroup) before)
541           (while (and (not before) groupkey)
542             (goto-char (point-min))
543             (let ((groupkey-re
544                    (concat "^\\(" (regexp-quote groupkey) ".*\\)[!:]")))
545               (while (and (re-search-forward groupkey-re nil t)
546                           (progn
547                             (setq before (match-string 1))
548                             (string< before newgroup)))))
549             ;; Remove tail of newsgroup name (eg. a.b.c -> a.b)
550             (setq groupkey
551                   (when (string-match "^\\(.*\\)\\.[^.]+$" groupkey)
552                     (substring groupkey (match-beginning 1) (match-end 1)))))
553           (gnus-subscribe-newsgroup newgroup before))
554       (kill-buffer (current-buffer)))))
555
556 (defun gnus-subscribe-interactively (group)
557   "Subscribe the new GROUP interactively.
558 It is inserted in hierarchical newsgroup order if subscribed.  If not,
559 it is killed."
560   (if (gnus-y-or-n-p (format "Subscribe new newsgroup: %s " group))
561       (gnus-subscribe-hierarchically group)
562     (push group gnus-killed-list)))
563
564 (defun gnus-subscribe-zombies (group)
565   "Make the new GROUP into a zombie group."
566   (push group gnus-zombie-list))
567
568 (defun gnus-subscribe-killed (group)
569   "Make the new GROUP a killed group."
570   (push group gnus-killed-list))
571
572 (defun gnus-subscribe-newsgroup (newsgroup &optional next)
573   "Subscribe new NEWSGROUP.
574 If NEXT is non-nil, it is inserted before NEXT.  Otherwise it is made
575 the first newsgroup."
576   (save-excursion
577     (goto-char (point-min))
578     ;; We subscribe the group by changing its level to `subscribed'.
579     (gnus-group-change-level
580      newsgroup gnus-level-default-subscribed
581      gnus-level-killed (gnus-gethash (or next "dummy.group")
582                                      gnus-newsrc-hashtb))
583     (gnus-message 5 "Subscribe newsgroup: %s" newsgroup)
584     (run-hook-with-args 'gnus-subscribe-newsgroup-hooks newsgroup)
585     t))
586
587 (defun gnus-read-active-file-p ()
588   "Say whether the active file has been read from `gnus-select-method'."
589   (memq gnus-select-method gnus-have-read-active-file))
590
591 ;;; General various misc type functions.
592
593 ;; Silence byte-compiler.
594 (defvar gnus-current-headers)
595 (defvar gnus-thread-indent-array)
596 (defvar gnus-newsgroup-name)
597 (defvar gnus-newsgroup-headers)
598 (defvar gnus-group-list-mode)
599 (defvar gnus-group-mark-positions)
600 (defvar gnus-newsgroup-data)
601 (defvar gnus-newsgroup-unreads)
602 (defvar nnoo-state-alist)
603 (defvar gnus-current-select-method)
604
605 (defun gnus-close-all-servers ()
606   "Close all servers."
607   (interactive)
608   (dolist (server gnus-opened-servers)
609     (gnus-close-server (car server))))
610
611 (defun gnus-clear-system ()
612   "Clear all variables and buffers."
613   ;; Clear Gnus variables.
614   (let ((variables (delete 'gnus-format-specs gnus-variable-list)))
615     (while variables
616       (set (car variables) nil)
617       (setq variables (cdr variables))))
618   ;; Clear other internal variables.
619   (setq gnus-list-of-killed-groups nil
620         gnus-have-read-active-file nil
621         gnus-newsrc-alist nil
622         gnus-newsrc-hashtb nil
623         gnus-killed-list nil
624         gnus-zombie-list nil
625         gnus-killed-hashtb nil
626         gnus-active-hashtb nil
627         gnus-moderated-hashtb nil
628         gnus-description-hashtb nil
629         gnus-current-headers nil
630         gnus-thread-indent-array nil
631         gnus-newsgroup-headers nil
632         gnus-newsgroup-name nil
633         gnus-server-alist nil
634         gnus-group-list-mode nil
635         gnus-opened-servers nil
636         gnus-group-mark-positions nil
637         gnus-newsgroup-data nil
638         gnus-newsgroup-unreads nil
639         nnoo-state-alist nil
640         gnus-current-select-method nil
641         nnmail-split-history nil
642         gnus-ephemeral-servers nil)
643   (gnus-shutdown 'gnus)
644   ;; Kill the startup file.
645   (and gnus-current-startup-file
646        (get-file-buffer gnus-current-startup-file)
647        (kill-buffer (get-file-buffer gnus-current-startup-file)))
648   ;; Clear the dribble buffer.
649   (gnus-dribble-clear)
650   ;; Kill global KILL file buffer.
651   (when (get-file-buffer (gnus-newsgroup-kill-file nil))
652     (kill-buffer (get-file-buffer (gnus-newsgroup-kill-file nil))))
653   (gnus-kill-buffer nntp-server-buffer)
654   ;; Kill Gnus buffers.
655   (let ((buffers (gnus-buffers)))
656     (when buffers
657       (mapcar 'kill-buffer buffers)))
658   ;; Remove Gnus frames.
659   (gnus-kill-gnus-frames))
660
661 (defun gnus-no-server-1 (&optional arg slave)
662   "Read network news.
663 If ARG is a positive number, Gnus will use that as the
664 startup level.  If ARG is nil, Gnus will be started at level 2.
665 If ARG is non-nil and not a positive number, Gnus will
666 prompt the user for the name of an NNTP server to use.
667 As opposed to `gnus', this command will not connect to the local server."
668   (interactive "P")
669   (let ((val (or arg (1- gnus-level-default-subscribed))))
670     (gnus val t slave)
671     (make-local-variable 'gnus-group-use-permanent-levels)
672     (setq gnus-group-use-permanent-levels val)))
673
674 (defun gnus-1 (&optional arg dont-connect slave)
675   "Read network news.
676 If ARG is non-nil and a positive number, Gnus will use that as the
677 startup level.  If ARG is non-nil and not a positive number, Gnus will
678 prompt the user for the name of an NNTP server to use."
679   (interactive "P")
680
681   (if (gnus-alive-p)
682       (progn
683         (switch-to-buffer gnus-group-buffer)
684         (gnus-group-get-new-news
685          (and (numberp arg)
686               (> arg 0)
687               (max (car gnus-group-list-mode) arg))))
688
689     (gnus-clear-system)
690     (gnus-splash)
691     (gnus-run-hooks 'gnus-before-startup-hook)
692     (nnheader-init-server-buffer)
693     (setq gnus-slave slave)
694     (gnus-read-init-file)
695     (if gnus-agent
696         (gnus-agentize))
697
698     (when gnus-simple-splash
699       (setq gnus-simple-splash nil)
700       (cond
701        ((featurep 'xemacs)
702         (gnus-xmas-splash))
703        ((and window-system
704              (= (frame-height) (1+ (window-height))))
705         (gnus-x-splash))))
706
707     (let ((level (and (numberp arg) (> arg 0) arg))
708           did-connect)
709       (unwind-protect
710           (progn
711             (unless dont-connect
712               (setq did-connect
713                     (gnus-start-news-server (and arg (not level))))))
714         (if (and (not dont-connect)
715                  (not did-connect))
716             (gnus-group-quit)
717           (gnus-run-hooks 'gnus-startup-hook)
718           ;; NNTP server is successfully open.
719
720           ;; Find the current startup file name.
721           (setq gnus-current-startup-file
722                 (gnus-make-newsrc-file gnus-startup-file))
723
724           ;; Read the dribble file.
725           (when (or gnus-slave gnus-use-dribble-file)
726             (gnus-dribble-read-file))
727
728           ;; Allow using GroupLens predictions.
729           (when gnus-use-grouplens
730             (bbb-login)
731             (add-hook 'gnus-summary-mode-hook 'gnus-grouplens-mode))
732
733           ;; Do the actual startup.
734           (gnus-setup-news nil level dont-connect)
735           (gnus-run-hooks 'gnus-setup-news-hook)
736           (gnus-start-draft-setup)
737           ;; Generate the group buffer.
738           (gnus-group-list-groups level)
739           (gnus-group-first-unread-group)
740           (gnus-configure-windows 'group)
741           (gnus-group-set-mode-line)
742           (gnus-run-hooks 'gnus-started-hook))))))
743
744 (defun gnus-start-draft-setup ()
745   "Make sure the draft group exists."
746   (gnus-request-create-group "drafts" '(nndraft ""))
747   (unless (gnus-gethash "nndraft:drafts" gnus-newsrc-hashtb)
748     (let ((gnus-level-default-subscribed 1))
749       (gnus-subscribe-group "nndraft:drafts" nil '(nndraft "")))
750     (gnus-group-set-parameter
751      "nndraft:drafts" 'gnus-dummy '((gnus-draft-mode)))))
752
753 ;;;###autoload
754 (defun gnus-unload ()
755   "Unload all Gnus features.
756 \(For some value of `all' or `Gnus'.)  Currently, features whose names
757 have prefixes `gnus-', `nn', `mm-' or `rfc' are unloaded.  Use
758 cautiously -- unloading may cause trouble."
759   (interactive)
760   (dolist (feature features)
761     (if (string-match "^\\(gnus-\\|nn\\|mm-\\|rfc\\)" (symbol-name feature))
762         (unload-feature feature 'force))))
763
764 \f
765 ;;;
766 ;;; Dribble file
767 ;;;
768
769 (defvar gnus-dribble-ignore nil)
770 (defvar gnus-dribble-eval-file nil)
771
772 (defun gnus-dribble-file-name ()
773   "Return the dribble file for the current .newsrc."
774   (concat
775    (if gnus-dribble-directory
776        (concat (file-name-as-directory gnus-dribble-directory)
777                (file-name-nondirectory gnus-current-startup-file))
778      gnus-current-startup-file)
779    "-dribble"))
780
781 (defun gnus-dribble-enter (string)
782   "Enter STRING into the dribble buffer."
783   (when (and (not gnus-dribble-ignore)
784              gnus-dribble-buffer
785              (buffer-name gnus-dribble-buffer))
786     (let ((obuf (current-buffer)))
787       (set-buffer gnus-dribble-buffer)
788       (goto-char (point-max))
789       (insert string "\n")
790       (set-window-point (get-buffer-window (current-buffer)) (point-max))
791       (bury-buffer gnus-dribble-buffer)
792       (save-excursion
793         (set-buffer gnus-group-buffer)
794         (gnus-group-set-mode-line))
795       (set-buffer obuf))))
796
797 (defun gnus-dribble-touch ()
798   "Touch the dribble buffer."
799   (gnus-dribble-enter ""))
800
801 (defun gnus-dribble-read-file ()
802   "Read the dribble file from disk."
803   (let ((dribble-file (gnus-dribble-file-name)))
804     (save-excursion
805       (set-buffer (setq gnus-dribble-buffer
806                         (gnus-get-buffer-create
807                          (file-name-nondirectory dribble-file))))
808       (erase-buffer)
809       (setq buffer-file-name dribble-file)
810       (auto-save-mode t)
811       (buffer-disable-undo)
812       (bury-buffer (current-buffer))
813       (set-buffer-modified-p nil)
814       (let ((auto (make-auto-save-file-name))
815             (gnus-dribble-ignore t)
816             (purpose nil)
817             modes)
818         (when (or (file-exists-p auto) (file-exists-p dribble-file))
819           ;; Load whichever file is newest -- the auto save file
820           ;; or the "real" file.
821           (if (file-newer-than-file-p auto dribble-file)
822               (nnheader-insert-file-contents auto)
823             (nnheader-insert-file-contents dribble-file))
824           (unless (zerop (buffer-size))
825             (set-buffer-modified-p t))
826           ;; Set the file modes to reflect the .newsrc file modes.
827           (save-buffer)
828           (when (and (file-exists-p gnus-current-startup-file)
829                      (file-exists-p dribble-file)
830                      (setq modes (file-modes gnus-current-startup-file)))
831             (set-file-modes dribble-file modes))
832           (goto-char (point-min))
833           (when (search-forward "Gnus was exited on purpose" nil t)
834             (setq purpose t))
835           ;; Possibly eval the file later.
836           (when (or gnus-always-read-dribble-file
837                     (gnus-y-or-n-p
838                      (if purpose
839                          "Gnus exited on purpose without saving; read auto-save file anyway? "
840                      "Gnus auto-save file exists.  Do you want to read it? ")))
841             (setq gnus-dribble-eval-file t)))))))
842
843 (defun gnus-dribble-eval-file ()
844   (when gnus-dribble-eval-file
845     (setq gnus-dribble-eval-file nil)
846     (save-excursion
847       (let ((gnus-dribble-ignore t))
848         (set-buffer gnus-dribble-buffer)
849         (eval-buffer (current-buffer))))))
850
851 (defun gnus-dribble-delete-file ()
852   (when (file-exists-p (gnus-dribble-file-name))
853     (delete-file (gnus-dribble-file-name)))
854   (when gnus-dribble-buffer
855     (save-excursion
856       (set-buffer gnus-dribble-buffer)
857       (let ((auto (make-auto-save-file-name)))
858         (when (file-exists-p auto)
859           (delete-file auto))
860         (erase-buffer)
861         (set-buffer-modified-p nil)))))
862
863 (defun gnus-dribble-save ()
864   (when (and gnus-dribble-buffer
865              (buffer-name gnus-dribble-buffer))
866     (save-excursion
867       (set-buffer gnus-dribble-buffer)
868       (save-buffer))))
869
870 (defun gnus-dribble-clear ()
871   (when (gnus-buffer-exists-p gnus-dribble-buffer)
872     (save-excursion
873       (set-buffer gnus-dribble-buffer)
874       (erase-buffer)
875       (set-buffer-modified-p nil)
876       (setq buffer-saved-size (buffer-size)))))
877
878 \f
879 ;;;
880 ;;; Active & Newsrc File Handling
881 ;;;
882
883 (defun gnus-setup-news (&optional rawfile level dont-connect)
884   "Setup news information.
885 If RAWFILE is non-nil, the .newsrc file will also be read.
886 If LEVEL is non-nil, the news will be set up at level LEVEL."
887   (require 'nnmail)
888   (let ((init (not (and gnus-newsrc-alist gnus-active-hashtb (not rawfile))))
889         ;; Binding this variable will inhibit multiple fetchings
890         ;; of the same mail source.
891         (nnmail-fetched-sources (list t)))
892
893     (when init
894       ;; Clear some variables to re-initialize news information.
895       (setq gnus-newsrc-alist nil
896             gnus-active-hashtb nil)
897       ;; Read the newsrc file and create `gnus-newsrc-hashtb'.
898       (gnus-read-newsrc-file rawfile))
899
900     ;; Make sure the archive server is available to all and sundry.
901     (when gnus-message-archive-method
902       (unless (assoc "archive" gnus-server-alist)
903         (push `("archive"
904                 nnfolder
905                 "archive"
906                 (nnfolder-directory
907                  ,(nnheader-concat message-directory "archive"))
908                 (nnfolder-active-file
909                  ,(nnheader-concat message-directory "archive/active"))
910                 (nnfolder-get-new-mail nil)
911                 (nnfolder-inhibit-expiry t))
912               gnus-server-alist)))
913
914     ;; If we don't read the complete active file, we fill in the
915     ;; hashtb here.
916     (when (or (null gnus-read-active-file)
917               (eq gnus-read-active-file 'some))
918       (gnus-update-active-hashtb-from-killed))
919
920     ;; Read the active file and create `gnus-active-hashtb'.
921     ;; If `gnus-read-active-file' is nil, then we just create an empty
922     ;; hash table.  The partial filling out of the hash table will be
923     ;; done in `gnus-get-unread-articles'.
924     (and gnus-read-active-file
925          (not level)
926          (gnus-read-active-file nil dont-connect))
927
928     (unless gnus-active-hashtb
929       (setq gnus-active-hashtb (gnus-make-hashtable 4096)))
930
931     ;; Initialize the cache.
932     (when gnus-use-cache
933       (gnus-cache-open))
934
935     ;; Possibly eval the dribble file.
936     (and init
937          (or gnus-use-dribble-file gnus-slave)
938          (gnus-dribble-eval-file))
939
940     ;; Slave Gnusii should then clear the dribble buffer.
941     (when (and init gnus-slave)
942       (gnus-dribble-clear))
943
944     (gnus-update-format-specifications)
945
946     ;; See whether we need to read the description file.
947     (when (and (boundp 'gnus-group-line-format)
948                (stringp gnus-group-line-format)
949                (let ((case-fold-search nil))
950                  (string-match "%[-,0-9]*D" gnus-group-line-format))
951                (not gnus-description-hashtb)
952                (not dont-connect)
953                gnus-read-active-file)
954       (gnus-read-all-descriptions-files))
955
956     ;; Find new newsgroups and treat them.
957     (when (and init gnus-check-new-newsgroups (not level)
958                (gnus-check-server gnus-select-method)
959                (not gnus-slave)
960                gnus-plugged)
961       (gnus-find-new-newsgroups))
962
963     ;; Check and remove bogus newsgroups.
964     (when (and init gnus-check-bogus-newsgroups
965                gnus-read-active-file (not level)
966                (gnus-server-opened gnus-select-method))
967       (gnus-check-bogus-newsgroups))
968
969     ;; We might read in new NoCeM messages here.
970     (when (and gnus-use-nocem
971                (not level)
972                (not dont-connect))
973       (gnus-nocem-scan-groups))
974
975     ;; Read any slave files.
976     (gnus-master-read-slave-newsrc)
977
978     ;; Find the number of unread articles in each non-dead group.
979     (let ((gnus-read-active-file (and (not level) gnus-read-active-file)))
980       (gnus-get-unread-articles level))))
981
982 (defun gnus-call-subscribe-functions (method group)
983   "Call METHOD to subscribe GROUP.
984 If no function returns `non-nil', call `gnus-subscribe-zombies'."
985   (unless (cond
986            ((gnus-functionp method)
987             (funcall method group))
988            ((listp method)
989             (catch 'found
990               (dolist (func method)
991                 (if (funcall func group)
992                     (throw 'found t)))
993               nil))
994            (t nil))
995     (gnus-subscribe-zombies group)))
996
997 (defun gnus-find-new-newsgroups (&optional arg)
998   "Search for new newsgroups and add them.
999 Each new newsgroup will be treated with `gnus-subscribe-newsgroup-method'.
1000 The `-n' option line from .newsrc is respected.
1001
1002 With 1 C-u, use the `ask-server' method to query the server for new
1003 groups.
1004 With 2 C-u's, use most complete method possible to query the server
1005 for new groups, and subscribe the new groups as zombies."
1006   (interactive "p")
1007   (let* ((gnus-subscribe-newsgroup-method
1008           gnus-subscribe-newsgroup-method)
1009          (check (cond
1010                  ((or (and (= (or arg 1) 4)
1011                            (not (listp gnus-check-new-newsgroups)))
1012                       (null gnus-read-active-file)
1013                       (eq gnus-read-active-file 'some))
1014                   'ask-server)
1015                  ((= (or arg 1) 16)
1016                   (setq gnus-subscribe-newsgroup-method
1017                         'gnus-subscribe-zombies)
1018                   t)
1019                  (t gnus-check-new-newsgroups))))
1020     (unless (gnus-check-first-time-used)
1021       (if (or (consp check)
1022               (eq check 'ask-server))
1023           ;; Ask the server for new groups.
1024           (gnus-ask-server-for-new-groups)
1025         ;; Go through the active hashtb and look for new groups.
1026         (let ((groups 0)
1027               group new-newsgroups)
1028           (gnus-message 5 "Looking for new newsgroups...")
1029           (unless gnus-have-read-active-file
1030             (gnus-read-active-file))
1031           (setq gnus-newsrc-last-checked-date (message-make-date))
1032           (unless gnus-killed-hashtb
1033             (gnus-make-hashtable-from-killed))
1034           ;; Go though every newsgroup in `gnus-active-hashtb' and compare
1035           ;; with `gnus-newsrc-hashtb' and `gnus-killed-hashtb'.
1036           (mapatoms
1037            (lambda (sym)
1038              (if (or (null (setq group (symbol-name sym)))
1039                      (not (boundp sym))
1040                      (null (symbol-value sym))
1041                      (gnus-gethash group gnus-killed-hashtb)
1042                      (gnus-gethash group gnus-newsrc-hashtb))
1043                  ()
1044                (let ((do-sub (gnus-matches-options-n group)))
1045                  (cond
1046                   ((eq do-sub 'subscribe)
1047                    (setq groups (1+ groups))
1048                    (gnus-sethash group group gnus-killed-hashtb)
1049                    (gnus-call-subscribe-functions
1050                     gnus-subscribe-options-newsgroup-method group))
1051                   ((eq do-sub 'ignore)
1052                    nil)
1053                   (t
1054                    (setq groups (1+ groups))
1055                    (gnus-sethash group group gnus-killed-hashtb)
1056                    (if gnus-subscribe-hierarchical-interactive
1057                        (push group new-newsgroups)
1058                      (gnus-call-subscribe-functions
1059                       gnus-subscribe-newsgroup-method group)))))))
1060            gnus-active-hashtb)
1061           (when new-newsgroups
1062             (gnus-subscribe-hierarchical-interactive new-newsgroups))
1063           (if (> groups 0)
1064               (gnus-message 5 "%d new newsgroup%s arrived."
1065                             groups (if (> groups 1) "s have" " has"))
1066             (gnus-message 5 "No new newsgroups.")))))))
1067
1068 (defun gnus-matches-options-n (group)
1069   ;; Returns `subscribe' if the group is to be unconditionally
1070   ;; subscribed, `ignore' if it is to be ignored, and nil if there is
1071   ;; no match for the group.
1072
1073   ;; First we check the two user variables.
1074   (cond
1075    ((and gnus-options-subscribe
1076          (string-match gnus-options-subscribe group))
1077     'subscribe)
1078    ((and gnus-auto-subscribed-groups
1079          (string-match gnus-auto-subscribed-groups group))
1080     'subscribe)
1081    ((and gnus-options-not-subscribe
1082          (string-match gnus-options-not-subscribe group))
1083     'ignore)
1084    ;; Then we go through the list that was retrieved from the .newsrc
1085    ;; file.  This list has elements on the form
1086    ;; `(REGEXP . {ignore,subscribe})'.  The first match found (the list
1087    ;; is in the reverse order of the options line) is returned.
1088    (t
1089     (let ((regs gnus-newsrc-options-n))
1090       (while (and regs
1091                   (not (string-match (caar regs) group)))
1092         (setq regs (cdr regs)))
1093       (and regs (cdar regs))))))
1094
1095 (defun gnus-ask-server-for-new-groups ()
1096   (let* ((new-date (message-make-date))
1097          (date (or gnus-newsrc-last-checked-date new-date))
1098          (methods (cons gnus-select-method
1099                         (nconc
1100                          (when (gnus-archive-server-wanted-p)
1101                            (list "archive"))
1102                          (append
1103                           (and (consp gnus-check-new-newsgroups)
1104                                gnus-check-new-newsgroups)
1105                           gnus-secondary-select-methods))))
1106          (groups 0)
1107          group new-newsgroups got-new method hashtb
1108          gnus-override-subscribe-method)
1109     (unless gnus-killed-hashtb
1110       (gnus-make-hashtable-from-killed))
1111     ;; Go through both primary and secondary select methods and
1112     ;; request new newsgroups.
1113     (while (setq method (gnus-server-get-method nil (pop methods)))
1114       (setq new-newsgroups nil
1115             gnus-override-subscribe-method method)
1116       (when (and (gnus-check-server method)
1117                  (gnus-request-newgroups date method))
1118         (save-excursion
1119           (setq got-new t
1120                 hashtb (gnus-make-hashtable 100))
1121           (set-buffer nntp-server-buffer)
1122           ;; Enter all the new groups into a hashtable.
1123           (gnus-active-to-gnus-format method hashtb 'ignore))
1124         ;; Now all new groups from `method' are in `hashtb'.
1125         (mapatoms
1126          (lambda (group-sym)
1127            (if (or (null (setq group (symbol-name group-sym)))
1128                    (not (boundp group-sym))
1129                    (null (symbol-value group-sym))
1130                    (gnus-gethash group gnus-newsrc-hashtb)
1131                    (member group gnus-zombie-list)
1132                    (member group gnus-killed-list))
1133                ;; The group is already known.
1134                ()
1135              ;; Make this group active.
1136              (when (symbol-value group-sym)
1137                (gnus-set-active group (symbol-value group-sym)))
1138              ;; Check whether we want it or not.
1139              (let ((do-sub (gnus-matches-options-n group)))
1140                (cond
1141                 ((eq do-sub 'subscribe)
1142                  (incf groups)
1143                  (gnus-sethash group group gnus-killed-hashtb)
1144                  (gnus-call-subscribe-functions
1145                   gnus-subscribe-options-newsgroup-method group))
1146                 ((eq do-sub 'ignore)
1147                  nil)
1148                 (t
1149                  (incf groups)
1150                  (gnus-sethash group group gnus-killed-hashtb)
1151                  (if gnus-subscribe-hierarchical-interactive
1152                      (push group new-newsgroups)
1153                    (gnus-call-subscribe-functions
1154                     gnus-subscribe-newsgroup-method group)))))))
1155          hashtb))
1156       (when new-newsgroups
1157         (gnus-subscribe-hierarchical-interactive new-newsgroups)))
1158     (if (> groups 0)
1159         (gnus-message 5 "%d new newsgroup%s arrived"
1160                       groups (if (> groups 1) "s have" " has"))
1161       (gnus-message 5 "No new newsgroups"))
1162     (when got-new
1163       (setq gnus-newsrc-last-checked-date new-date))
1164     got-new))
1165
1166 (defun gnus-check-first-time-used ()
1167   (catch 'ended
1168     ;; First check if any of the following files exist.  If they do,
1169     ;; it's not the first time the user has used Gnus.
1170     (dolist (file (list (concat gnus-current-startup-file ".el")
1171                         (concat gnus-current-startup-file ".eld")
1172                         (concat gnus-startup-file ".el")
1173                         (concat gnus-startup-file ".eld")))
1174       (when (file-exists-p file)
1175         (throw 'ended nil)))
1176     (gnus-message 6 "First time user; subscribing you to default groups")
1177     (unless (gnus-read-active-file-p)
1178       (let ((gnus-read-active-file t))
1179         (gnus-read-active-file)))
1180     (setq gnus-newsrc-last-checked-date (message-make-date))
1181     ;; Subscribe to the default newsgroups.
1182     (let ((groups (or gnus-default-subscribed-newsgroups
1183                       gnus-backup-default-subscribed-newsgroups))
1184           group)
1185       (if (eq groups t)
1186           ;; If t, we subscribe (or not) all groups as if they were new.
1187           (mapatoms
1188            (lambda (sym)
1189              (when (setq group (symbol-name sym))
1190                (let ((do-sub (gnus-matches-options-n group)))
1191                  (cond
1192                   ((eq do-sub 'subscribe)
1193                    (gnus-sethash group group gnus-killed-hashtb)
1194                    (gnus-call-subscribe-functions
1195                     gnus-subscribe-options-newsgroup-method group))
1196                   ((eq do-sub 'ignore)
1197                    nil)
1198                   (t
1199                    (push group gnus-killed-list))))))
1200            gnus-active-hashtb)
1201         (dolist (group groups)
1202           ;; Only subscribe the default groups that are activated.
1203           (when (gnus-active group)
1204             (gnus-group-change-level
1205              group gnus-level-default-subscribed gnus-level-killed)))
1206         (save-excursion
1207           (set-buffer gnus-group-buffer)
1208           ;; Don't error if the group already exists. This happens when a
1209           ;; first-time user types 'F'. -- didier
1210           (gnus-group-make-help-group t))
1211         (when gnus-novice-user
1212           (gnus-message 7 "`A k' to list killed groups"))))))
1213
1214 (defun gnus-subscribe-group (group &optional previous method)
1215   "Subcribe GROUP and put it after PREVIOUS."
1216   (gnus-group-change-level
1217    (if method
1218        (list t group gnus-level-default-subscribed nil nil method)
1219      group)
1220    gnus-level-default-subscribed gnus-level-killed previous t)
1221   t)
1222
1223 ;; `gnus-group-change-level' is the fundamental function for changing
1224 ;; subscription levels of newsgroups.  This might mean just changing
1225 ;; from level 1 to 2, which is pretty trivial, from 2 to 6 or back
1226 ;; again, which subscribes/unsubscribes a group, which is equally
1227 ;; trivial.  Changing from 1-7 to 8-9 means that you kill a group, and
1228 ;; from 8-9 to 1-7 means that you remove the group from the list of
1229 ;; killed (or zombie) groups and add them to the (kinda) subscribed
1230 ;; groups.  And last but not least, moving from 8 to 9 and 9 to 8,
1231 ;; which is trivial.
1232 ;; ENTRY can either be a string (newsgroup name) or a list (if
1233 ;; FROMKILLED is t, it's a list on the format (NUM INFO-LIST),
1234 ;; otherwise it's a list in the format of the `gnus-newsrc-hashtb'
1235 ;; entries.
1236 ;; LEVEL is the new level of the group, OLDLEVEL is the old level and
1237 ;; PREVIOUS is the group (in hashtb entry format) to insert this group
1238 ;; after.
1239 (defun gnus-group-change-level (entry level &optional oldlevel
1240                                       previous fromkilled)
1241   (let (group info active num)
1242     ;; Glean what info we can from the arguments
1243     (if (consp entry)
1244         (if fromkilled (setq group (nth 1 entry))
1245           (setq group (car (nth 2 entry))))
1246       (setq group entry))
1247     (when (and (stringp entry)
1248                oldlevel
1249                (< oldlevel gnus-level-zombie))
1250       (setq entry (gnus-gethash entry gnus-newsrc-hashtb)))
1251     (if (and (not oldlevel)
1252              (consp entry))
1253         (setq oldlevel (gnus-info-level (nth 2 entry)))
1254       (setq oldlevel (or oldlevel gnus-level-killed)))
1255     (when (stringp previous)
1256       (setq previous (gnus-gethash previous gnus-newsrc-hashtb)))
1257
1258     (if (and (>= oldlevel gnus-level-zombie)
1259              (gnus-gethash group gnus-newsrc-hashtb))
1260         ;; We are trying to subscribe a group that is already
1261         ;; subscribed.
1262         ()                              ; Do nothing.
1263
1264       (unless (gnus-ephemeral-group-p group)
1265         (gnus-dribble-enter
1266          (format "(gnus-group-change-level %S %S %S %S %S)"
1267                  group level oldlevel (car (nth 2 previous)) fromkilled)))
1268
1269       ;; Then we remove the newgroup from any old structures, if needed.
1270       ;; If the group was killed, we remove it from the killed or zombie
1271       ;; list.  If not, and it is in fact going to be killed, we remove
1272       ;; it from the newsrc hash table and assoc.
1273       (cond
1274        ((>= oldlevel gnus-level-zombie)
1275         ;; oldlevel could be wrong.
1276         (setq gnus-zombie-list (delete group gnus-zombie-list))
1277         (setq gnus-killed-list (delete group gnus-killed-list)))
1278        (t
1279         (when (and (>= level gnus-level-zombie)
1280                    entry)
1281           (gnus-sethash (car (nth 2 entry)) nil gnus-newsrc-hashtb)
1282           (when (nth 3 entry)
1283             (setcdr (gnus-gethash (car (nth 3 entry))
1284                                   gnus-newsrc-hashtb)
1285                     (cdr entry)))
1286           (setcdr (cdr entry) (cdddr entry)))))
1287
1288       ;; Finally we enter (if needed) the list where it is supposed to
1289       ;; go, and change the subscription level.  If it is to be killed,
1290       ;; we enter it into the killed or zombie list.
1291       (cond
1292        ((>= level gnus-level-zombie)
1293         ;; Remove from the hash table.
1294         (gnus-sethash group nil gnus-newsrc-hashtb)
1295         ;; We do not enter foreign groups into the list of dead
1296         ;; groups.
1297         (unless (gnus-group-foreign-p group)
1298           (if (= level gnus-level-zombie)
1299               (push group gnus-zombie-list)
1300             (if (= oldlevel gnus-level-killed)
1301                 ;; Remove from active hashtb.
1302                 (unintern group gnus-active-hashtb)
1303               ;; Don't add it into killed-list if it was killed.
1304               (push group gnus-killed-list)))))
1305        (t
1306         ;; If the list is to be entered into the newsrc assoc, and
1307         ;; it was killed, we have to create an entry in the newsrc
1308         ;; hashtb format and fix the pointers in the newsrc assoc.
1309         (if (< oldlevel gnus-level-zombie)
1310             ;; It was alive, and it is going to stay alive, so we
1311             ;; just change the level and don't change any pointers or
1312             ;; hash table entries.
1313             (setcar (cdaddr entry) level)
1314           (if (listp entry)
1315               (setq info (cdr entry)
1316                     num (car entry))
1317             (setq active (gnus-active group))
1318             (setq num
1319                   (if active (- (1+ (cdr active)) (car active)) t))
1320             ;; Shorten the select method if possible, if we need to
1321             ;; store it at all (native groups).
1322             (let ((method (gnus-method-simplify
1323                            (or gnus-override-subscribe-method
1324                                (gnus-group-method group)))))
1325               (if method
1326                   (setq info (list group level nil nil method))
1327                 (setq info (list group level nil)))))
1328           (unless previous
1329             (setq previous
1330                   (let ((p gnus-newsrc-alist))
1331                     (while (cddr p)
1332                       (setq p (cdr p)))
1333                     p)))
1334           (setq entry (cons info (cddr previous)))
1335           (if (cdr previous)
1336               (progn
1337                 (setcdr (cdr previous) entry)
1338                 (gnus-sethash group (cons num (cdr previous))
1339                               gnus-newsrc-hashtb))
1340             (setcdr previous entry)
1341             (gnus-sethash group (cons num previous)
1342                           gnus-newsrc-hashtb))
1343           (when (cdr entry)
1344             (setcdr (gnus-gethash (caadr entry) gnus-newsrc-hashtb) entry))
1345           (gnus-dribble-enter
1346            (format
1347             "(gnus-group-set-info '%S)" info)))))
1348       (when gnus-group-change-level-function
1349         (funcall gnus-group-change-level-function
1350                  group level oldlevel previous)))))
1351
1352 (defun gnus-kill-newsgroup (newsgroup)
1353   "Obsolete function.  Kills a newsgroup."
1354   (gnus-group-change-level
1355    (gnus-gethash newsgroup gnus-newsrc-hashtb) gnus-level-killed))
1356
1357 (defun gnus-check-bogus-newsgroups (&optional confirm)
1358   "Remove bogus newsgroups.
1359 If CONFIRM is non-nil, the user has to confirm the deletion of every
1360 newsgroup."
1361   (let ((newsrc (cdr gnus-newsrc-alist))
1362         bogus group entry info)
1363     (gnus-message 5 "Checking bogus newsgroups...")
1364     (unless (gnus-read-active-file-p)
1365       (gnus-read-active-file t))
1366     (when (gnus-read-active-file-p)
1367       ;; Find all bogus newsgroup that are subscribed.
1368       (while newsrc
1369         (setq info (pop newsrc)
1370               group (gnus-info-group info))
1371         (unless (or (gnus-active group) ; Active
1372                     (and (gnus-info-method info)
1373                          (not (gnus-secondary-method-p
1374                                (gnus-info-method info))))) ; Foreign
1375           ;; Found a bogus newsgroup.
1376           (push group bogus)))
1377       (if confirm
1378           (map-y-or-n-p
1379            "Remove bogus group %s? "
1380            (lambda (group)
1381              ;; Remove all bogus subscribed groups by first killing them, and
1382              ;; then removing them from the list of killed groups.
1383              (when (setq entry (gnus-gethash group gnus-newsrc-hashtb))
1384                (gnus-group-change-level entry gnus-level-killed)
1385                (setq gnus-killed-list (delete group gnus-killed-list))))
1386            bogus '("group" "groups" "remove"))
1387         (while (setq group (pop bogus))
1388           ;; Remove all bogus subscribed groups by first killing them, and
1389           ;; then removing them from the list of killed groups.
1390           (when (setq entry (gnus-gethash group gnus-newsrc-hashtb))
1391             (gnus-group-change-level entry gnus-level-killed)
1392             (setq gnus-killed-list (delete group gnus-killed-list)))))
1393       ;; Then we remove all bogus groups from the list of killed and
1394       ;; zombie groups.  They are removed without confirmation.
1395       (let ((dead-lists '(gnus-killed-list gnus-zombie-list))
1396             killed)
1397         (while dead-lists
1398           (setq killed (symbol-value (car dead-lists)))
1399           (while killed
1400             (unless (gnus-active (setq group (pop killed)))
1401               ;; The group is bogus.
1402               ;; !!!Slow as hell.
1403               (set (car dead-lists)
1404                    (delete group (symbol-value (car dead-lists))))))
1405           (setq dead-lists (cdr dead-lists))))
1406       (gnus-run-hooks 'gnus-check-bogus-groups-hook)
1407       (gnus-message 5 "Checking bogus newsgroups...done"))))
1408
1409 (defun gnus-check-duplicate-killed-groups ()
1410   "Remove duplicates from the list of killed groups."
1411   (interactive)
1412   (let ((killed gnus-killed-list))
1413     (while killed
1414       (gnus-message 9 "%d" (length killed))
1415       (setcdr killed (delete (car killed) (cdr killed)))
1416       (setq killed (cdr killed)))))
1417
1418 ;; We want to inline a function from gnus-cache, so we cheat here:
1419 (eval-when-compile
1420   (defvar gnus-cache-active-hashtb)
1421   (defun gnus-cache-possibly-alter-active (group active)
1422     "Alter the ACTIVE info for GROUP to reflect the articles in the cache."
1423     (when gnus-cache-active-hashtb
1424       (let ((cache-active (gnus-gethash group gnus-cache-active-hashtb)))
1425         (when cache-active
1426           (when (< (car cache-active) (car active))
1427             (setcar active (car cache-active)))
1428           (when (> (cdr cache-active) (cdr active))
1429             (setcdr active (cdr cache-active))))))))
1430
1431 (defun gnus-activate-group (group &optional scan dont-check method)
1432   ;; Check whether a group has been activated or not.
1433   ;; If SCAN, request a scan of that group as well.
1434   (let ((method (or method (inline (gnus-find-method-for-group group))))
1435         active)
1436     (and (inline (gnus-check-server method))
1437          ;; We escape all bugs and quit here to make it possible to
1438          ;; continue if a group is so out-there that it reports bugs
1439          ;; and stuff.
1440          (progn
1441            (and scan
1442                 (gnus-check-backend-function 'request-scan (car method))
1443                 (gnus-request-scan group method))
1444            t)
1445          (if (or debug-on-error debug-on-quit)
1446              (inline (gnus-request-group group dont-check method))
1447            (condition-case ()
1448                (inline (gnus-request-group group dont-check method))
1449              ;;(error nil)
1450              (quit
1451               (message "Quit activating %s" group)
1452               nil)))
1453          (unless dont-check
1454            (setq active (gnus-parse-active))
1455            ;; If there are no articles in the group, the GROUP
1456            ;; command may have responded with the `(0 . 0)'.  We
1457            ;; ignore this if we already have an active entry
1458            ;; for the group.
1459            (if (and (zerop (car active))
1460                     (zerop (cdr active))
1461                     (gnus-active group))
1462                (gnus-active group)
1463              (gnus-set-active group active)
1464              ;; Return the new active info.
1465              active)))))
1466
1467 (defun gnus-get-unread-articles-in-group (info active &optional update)
1468   (when active
1469     ;; Allow the backend to update the info in the group.
1470     (when (and update
1471                (gnus-request-update-info
1472                 info (inline (gnus-find-method-for-group
1473                               (gnus-info-group info)))))
1474       (gnus-activate-group (gnus-info-group info) nil t))
1475
1476     (let* ((range (gnus-info-read info))
1477            (num 0))
1478       ;; If a cache is present, we may have to alter the active info.
1479       (when (and gnus-use-cache info)
1480         (inline (gnus-cache-possibly-alter-active
1481                  (gnus-info-group info) active)))
1482       ;; Modify the list of read articles according to what articles
1483       ;; are available; then tally the unread articles and add the
1484       ;; number to the group hash table entry.
1485       (cond
1486        ((zerop (cdr active))
1487         (setq num 0))
1488        ((not range)
1489         (setq num (- (1+ (cdr active)) (car active))))
1490        ((not (listp (cdr range)))
1491         ;; Fix a single (num . num) range according to the
1492         ;; active hash table.
1493         ;; Fix by Carsten Bormann <cabo@Informatik.Uni-Bremen.DE>.
1494         (and (< (cdr range) (car active)) (setcdr range (1- (car active))))
1495         (and (> (cdr range) (cdr active)) (setcdr range (cdr active)))
1496         ;; Compute number of unread articles.
1497         (setq num (max 0 (- (cdr active) (- (1+ (cdr range)) (car range))))))
1498        (t
1499         ;; The read list is a list of ranges.  Fix them according to
1500         ;; the active hash table.
1501         ;; First peel off any elements that are below the lower
1502         ;; active limit.
1503         (while (and (cdr range)
1504                     (>= (car active)
1505                         (or (and (atom (cadr range)) (cadr range))
1506                             (caadr range))))
1507           (if (numberp (car range))
1508               (setcar range
1509                       (cons (car range)
1510                             (or (and (numberp (cadr range))
1511                                      (cadr range))
1512                                 (cdadr range))))
1513             (setcdr (car range)
1514                     (or (and (numberp (nth 1 range)) (nth 1 range))
1515                         (cdadr range))))
1516           (setcdr range (cddr range)))
1517         ;; Adjust the first element to be the same as the lower limit.
1518         (when (and (not (atom (car range)))
1519                    (< (cdar range) (car active)))
1520           (setcdr (car range) (1- (car active))))
1521         ;; Then we want to peel off any elements that are higher
1522         ;; than the upper active limit.
1523         (let ((srange range))
1524           ;; Go past all valid elements.
1525           (while (and (cdr srange)
1526                       (<= (or (and (atom (cadr srange))
1527                                    (cadr srange))
1528                               (caadr srange))
1529                           (cdr active)))
1530             (setq srange (cdr srange)))
1531           (when (cdr srange)
1532             ;; Nuke all remaining invalid elements.
1533             (setcdr srange nil))
1534
1535           ;; Adjust the final element.
1536           (when (and (not (atom (car srange)))
1537                      (> (cdar srange) (cdr active)))
1538             (setcdr (car srange) (cdr active))))
1539         ;; Compute the number of unread articles.
1540         (while range
1541           (setq num (+ num (- (1+ (or (and (atom (car range)) (car range))
1542                                       (cdar range)))
1543                               (or (and (atom (car range)) (car range))
1544                                   (caar range)))))
1545           (setq range (cdr range)))
1546         (setq num (max 0 (- (cdr active) num)))))
1547       ;; Set the number of unread articles.
1548       (when info
1549         (setcar (gnus-gethash (gnus-info-group info) gnus-newsrc-hashtb) num))
1550       num)))
1551
1552 ;; Go though `gnus-newsrc-alist' and compare with `gnus-active-hashtb'
1553 ;; and compute how many unread articles there are in each group.
1554 (defun gnus-get-unread-articles (&optional level)
1555   (setq gnus-server-method-cache nil)
1556   (let* ((newsrc (cdr gnus-newsrc-alist))
1557          (level (or level gnus-activate-level (1+ gnus-level-subscribed)))
1558          (foreign-level
1559           (min
1560            (cond ((and gnus-activate-foreign-newsgroups
1561                        (not (numberp gnus-activate-foreign-newsgroups)))
1562                   (1+ gnus-level-subscribed))
1563                  ((numberp gnus-activate-foreign-newsgroups)
1564                   gnus-activate-foreign-newsgroups)
1565                  (t 0))
1566            level))
1567          scanned-methods info group active method retrieve-groups)
1568     (gnus-message 5 "Checking new news...")
1569
1570     (while newsrc
1571       (setq active (gnus-active (setq group (gnus-info-group
1572                                              (setq info (pop newsrc))))))
1573
1574       ;; Check newsgroups.  If the user doesn't want to check them, or
1575       ;; they can't be checked (for instance, if the news server can't
1576       ;; be reached) we just set the number of unread articles in this
1577       ;; newsgroup to t.  This means that Gnus thinks that there are
1578       ;; unread articles, but it has no idea how many.
1579
1580       ;; To be more explicit:
1581       ;; >0 for an active group with messages
1582       ;; 0 for an active group with no unread messages
1583       ;; nil for non-foreign groups that the user has requested not be checked
1584       ;; t for unchecked foreign groups or bogus groups, or groups that can't
1585       ;;   be checked, for one reason or other.
1586       (if (and (setq method (gnus-info-method info))
1587                (not (inline
1588                       (gnus-server-equal
1589                        gnus-select-method
1590                        (setq method (gnus-server-get-method nil method)))))
1591                (not (gnus-secondary-method-p method)))
1592           ;; These groups are foreign.  Check the level.
1593           (when (and (<= (gnus-info-level info) foreign-level)
1594                      (setq active (gnus-activate-group group 'scan)))
1595             ;; Let the Gnus agent save the active file.
1596             (when (and gnus-agent active (gnus-online method))
1597               (gnus-agent-save-group-info
1598                method (gnus-group-real-name group) active))
1599             (unless (inline (gnus-virtual-group-p group))
1600               (inline (gnus-close-group group)))
1601             (when (fboundp (intern (concat (symbol-name (car method))
1602                                            "-request-update-info")))
1603               (inline (gnus-request-update-info info method))))
1604         ;; These groups are native or secondary.
1605         (cond
1606          ;; We don't want these groups.
1607          ((> (gnus-info-level info) level)
1608           (setq active 'ignore))
1609          ;; Activate groups.
1610          ((not gnus-read-active-file)
1611           (if (gnus-check-backend-function 'retrieve-groups group)
1612               ;; if server support gnus-retrieve-groups we push
1613               ;; the group onto retrievegroups for later checking
1614               (if (assoc method retrieve-groups)
1615                   (setcdr (assoc method retrieve-groups)
1616                           (cons group (cdr (assoc method retrieve-groups))))
1617                 (push (list method group) retrieve-groups))
1618             ;; hack: `nnmail-get-new-mail' changes the mail-source depending
1619             ;; on the group, so we must perform a scan for every group
1620             ;; if the users has any directory mail sources.
1621             ;; hack: if `nnmail-scan-directory-mail-source-once' is non-nil,
1622             ;; for it scan all spool files even when the groups are
1623             ;; not required.
1624             (if (and
1625                  (or nnmail-scan-directory-mail-source-once
1626                      (null (assq 'directory
1627                                  (or mail-sources
1628                                      (if (listp nnmail-spool-file)
1629                                          nnmail-spool-file
1630                                        (list nnmail-spool-file))))))
1631                  (member method scanned-methods))
1632                 (setq active (gnus-activate-group group))
1633               (setq active (gnus-activate-group group 'scan))
1634               (push method scanned-methods))
1635             (when active
1636               (gnus-close-group group))))))
1637
1638       ;; Get the number of unread articles in the group.
1639       (cond
1640        ((eq active 'ignore)
1641         ;; Don't do anything.
1642         )
1643        (active
1644         (inline (gnus-get-unread-articles-in-group info active t)))
1645        (t
1646         ;; The group couldn't be reached, so we nix out the number of
1647         ;; unread articles and stuff.
1648         (gnus-set-active group nil)
1649         (let ((tmp (gnus-gethash group gnus-newsrc-hashtb)))
1650           (when tmp
1651             (setcar tmp t))))))
1652
1653     ;; iterate through groups on methods which support gnus-retrieve-groups
1654     ;; and fetch a partial active file and use it to find new news.
1655     (dolist (rg retrieve-groups)
1656       (let ((method (or (car rg) gnus-select-method))
1657             (groups (cdr rg)))
1658         (when (gnus-check-server method)
1659           ;; Request that the backend scan its incoming messages.
1660           (when (gnus-check-backend-function 'request-scan (car method))
1661             (gnus-request-scan nil method))
1662           (gnus-read-active-file-2
1663            (mapcar (lambda (group) (gnus-group-real-name group)) groups)
1664            method)
1665           (dolist (group groups)
1666             (cond
1667              ((setq active (gnus-active (gnus-info-group
1668                                          (setq info (gnus-get-info group)))))
1669               (inline (gnus-get-unread-articles-in-group info active t)))
1670              (t
1671               ;; The group couldn't be reached, so we nix out the number of
1672               ;; unread articles and stuff.
1673               (gnus-set-active group nil)
1674               (setcar (gnus-gethash group gnus-newsrc-hashtb) t)))))))
1675
1676     (gnus-message 5 "Checking new news...done")))
1677
1678 ;; Create a hash table out of the newsrc alist.  The `car's of the
1679 ;; alist elements are used as keys.
1680 (defun gnus-make-hashtable-from-newsrc-alist ()
1681   (let ((alist gnus-newsrc-alist)
1682         (ohashtb gnus-newsrc-hashtb)
1683         prev)
1684     (setq gnus-newsrc-hashtb (gnus-make-hashtable (length alist)))
1685     (setq alist
1686           (setq prev (setq gnus-newsrc-alist
1687                            (if (equal (caar gnus-newsrc-alist)
1688                                       "dummy.group")
1689                                gnus-newsrc-alist
1690                              (cons (list "dummy.group" 0 nil) alist)))))
1691     (while alist
1692       (gnus-sethash
1693        (caar alist)
1694        ;; Preserve number of unread articles in groups.
1695        (cons (and ohashtb (car (gnus-gethash (caar alist) ohashtb)))
1696              prev)
1697        gnus-newsrc-hashtb)
1698       (setq prev alist
1699             alist (cdr alist)))))
1700
1701 (defun gnus-make-hashtable-from-killed ()
1702   "Create a hash table from the killed and zombie lists."
1703   (let ((lists '(gnus-killed-list gnus-zombie-list))
1704         list)
1705     (setq gnus-killed-hashtb
1706           (gnus-make-hashtable
1707            (+ (length gnus-killed-list) (length gnus-zombie-list))))
1708     (while lists
1709       (setq list (symbol-value (pop lists)))
1710       (while list
1711         (gnus-sethash (car list) (pop list) gnus-killed-hashtb)))))
1712
1713 (defun gnus-parse-active ()
1714   "Parse active info in the nntp server buffer."
1715   (save-excursion
1716     (set-buffer nntp-server-buffer)
1717     (goto-char (point-min))
1718     ;; Parse the result we got from `gnus-request-group'.
1719     (when (looking-at "[0-9]+ [0-9]+ \\([0-9]+\\) [0-9]+")
1720       (goto-char (match-beginning 1))
1721       (cons (read (current-buffer))
1722             (read (current-buffer))))))
1723
1724 (defun gnus-make-articles-unread (group articles)
1725   "Mark ARTICLES in GROUP as unread."
1726   (let* ((info (nth 2 (or (gnus-gethash group gnus-newsrc-hashtb)
1727                           (gnus-gethash (gnus-group-real-name group)
1728                                         gnus-newsrc-hashtb))))
1729          (ranges (gnus-info-read info))
1730          news article)
1731     (while articles
1732       (when (gnus-member-of-range
1733              (setq article (pop articles)) ranges)
1734         (push article news)))
1735     (when news
1736       (gnus-info-set-read
1737        info (gnus-remove-from-range (gnus-info-read info) (nreverse news)))
1738       (gnus-group-update-group group t))))
1739
1740 ;; Enter all dead groups into the hashtb.
1741 (defun gnus-update-active-hashtb-from-killed ()
1742   (let ((hashtb (setq gnus-active-hashtb (gnus-make-hashtable 4096)))
1743         (lists (list gnus-killed-list gnus-zombie-list))
1744         killed)
1745     (while lists
1746       (setq killed (car lists))
1747       (while killed
1748         (gnus-sethash (car killed) nil hashtb)
1749         (setq killed (cdr killed)))
1750       (setq lists (cdr lists)))))
1751
1752 (defun gnus-get-killed-groups ()
1753   "Go through the active hashtb and mark all unknown groups as killed."
1754   ;; First make sure active file has been read.
1755   (unless (gnus-read-active-file-p)
1756     (let ((gnus-read-active-file t))
1757       (gnus-read-active-file)))
1758   (unless gnus-killed-hashtb
1759     (gnus-make-hashtable-from-killed))
1760   ;; Go through all newsgroups that are known to Gnus - enlarge kill list.
1761   (mapatoms
1762    (lambda (sym)
1763      (let ((groups 0)
1764            (group (symbol-name sym)))
1765        (if (or (null group)
1766                (gnus-gethash group gnus-killed-hashtb)
1767                (gnus-gethash group gnus-newsrc-hashtb))
1768            ()
1769          (let ((do-sub (gnus-matches-options-n group)))
1770            (if (or (eq do-sub 'subscribe) (eq do-sub 'ignore))
1771                ()
1772              (setq groups (1+ groups))
1773              (push group gnus-killed-list)
1774              (gnus-sethash group group gnus-killed-hashtb))))))
1775    gnus-active-hashtb)
1776   (gnus-dribble-touch))
1777
1778 ;; Get the active file(s) from the backend(s).
1779 (defun gnus-read-active-file (&optional force not-native)
1780   (gnus-group-set-mode-line)
1781   (let ((methods
1782          (mapcar
1783           (lambda (m) (if (stringp m) (gnus-server-get-method nil m) m))
1784           (append
1785            (if (and (not not-native)
1786                     (gnus-check-server gnus-select-method))
1787                ;; The native server is available.
1788                (cons gnus-select-method gnus-secondary-select-methods)
1789              ;; The native server is down, so we just do the
1790              ;; secondary ones.
1791              gnus-secondary-select-methods)
1792            ;; Also read from the archive server.
1793            (when (gnus-archive-server-wanted-p)
1794              (list "archive")))))
1795         method)
1796     (setq gnus-have-read-active-file nil)
1797     (save-excursion
1798       (set-buffer nntp-server-buffer)
1799       (while (setq method (pop methods))
1800         ;; Only do each method once, in case the methods appear more
1801         ;; than once in this list.
1802         (unless (member method methods)
1803           (if (or debug-on-error debug-on-quit)
1804               (gnus-read-active-file-1 method force)
1805             (condition-case ()
1806                 (gnus-read-active-file-1 method force)
1807               ;; We catch C-g so that we can continue past servers
1808               ;; that do not respond.
1809               (quit
1810                (message "Quit reading the active file")
1811                nil))))))))
1812
1813 (defun gnus-read-active-file-1 (method force)
1814   (let (where mesg)
1815     (setq where (nth 1 method)
1816           mesg (format "Reading active file%s via %s..."
1817                        (if (and where (not (zerop (length where))))
1818                            (concat " from " where) "")
1819                        (car method)))
1820     (gnus-message 5 mesg)
1821     (when (gnus-check-server method)
1822       ;; Request that the backend scan its incoming messages.
1823       (when (gnus-check-backend-function 'request-scan (car method))
1824         (gnus-request-scan nil method))
1825       (cond
1826        ((and (eq gnus-read-active-file 'some)
1827              (gnus-check-backend-function 'retrieve-groups (car method))
1828              (not force))
1829         (let ((newsrc (cdr gnus-newsrc-alist))
1830               (gmethod (gnus-server-get-method nil method))
1831               groups info)
1832           (while (setq info (pop newsrc))
1833             (when (inline
1834                     (gnus-server-equal
1835                      (inline
1836                        (gnus-find-method-for-group
1837                         (gnus-info-group info) info))
1838                      gmethod))
1839               (push (gnus-group-real-name (gnus-info-group info))
1840                     groups)))
1841           (gnus-read-active-file-2 groups method)))
1842        ((null method)
1843         t)
1844        (t
1845         (if (not (gnus-request-list method))
1846             (unless (equal method gnus-message-archive-method)
1847               (gnus-error 1 "Cannot read active file from %s server"
1848                           (car method)))
1849           (gnus-message 5 mesg)
1850           (gnus-active-to-gnus-format method gnus-active-hashtb nil t)
1851           ;; We mark this active file as read.
1852           (push method gnus-have-read-active-file)
1853           (gnus-message 5 "%sdone" mesg)))))))
1854
1855 (defun gnus-read-active-file-2 (groups method)
1856   "Read an active file for GROUPS in METHOD using gnus-retrieve-groups."
1857   (when groups
1858     (save-excursion
1859       (set-buffer nntp-server-buffer)
1860       (gnus-check-server method)
1861       (let ((list-type (gnus-retrieve-groups groups method)))
1862         (cond ((not list-type)
1863                (gnus-error
1864                 1.2 "Cannot read partial active file from %s server."
1865                 (car method)))
1866               ((eq list-type 'active)
1867                (gnus-active-to-gnus-format method gnus-active-hashtb nil t))
1868               (t
1869                (gnus-groups-to-gnus-format method gnus-active-hashtb t)))))))
1870
1871 ;; Read an active file and place the results in `gnus-active-hashtb'.
1872 (defun gnus-active-to-gnus-format (&optional method hashtb ignore-errors
1873                                              real-active)
1874   (unless method
1875     (setq method gnus-select-method))
1876   (let ((cur (current-buffer))
1877         (hashtb (or hashtb
1878                     (if (and gnus-active-hashtb
1879                              (not (equal method gnus-select-method)))
1880                         gnus-active-hashtb
1881                       (setq gnus-active-hashtb
1882                             (if (equal method gnus-select-method)
1883                                 (gnus-make-hashtable
1884                                  (count-lines (point-min) (point-max)))
1885                               (gnus-make-hashtable 4096)))))))
1886     ;; Delete unnecessary lines.
1887     (goto-char (point-min))
1888     (cond
1889      ((string= gnus-ignored-newsgroups "")
1890       (delete-matching-lines "^to\\."))
1891      (t
1892       (delete-matching-lines (concat "^to\\.\\|" gnus-ignored-newsgroups))))
1893
1894     (goto-char (point-min))
1895     (unless (re-search-forward "[\\\"]" nil t)
1896       ;; Make the group names readable as a lisp expression even if they
1897       ;; contain special characters.
1898       (goto-char (point-max))
1899       (while (re-search-backward "[][';?()#]" nil t)
1900         (insert ?\\)))
1901
1902     ;; Let the Gnus agent save the active file.
1903     (when (and gnus-agent real-active (gnus-online method))
1904       (gnus-agent-save-active method))
1905
1906     ;; If these are groups from a foreign select method, we insert the
1907     ;; group prefix in front of the group names.
1908     (when (not (gnus-server-equal
1909                 (gnus-server-get-method nil method)
1910                 (gnus-server-get-method nil gnus-select-method)))
1911       (let ((prefix (gnus-group-prefixed-name "" method)))
1912         (goto-char (point-min))
1913         (while (and (not (eobp))
1914                     (progn
1915                       (when (= (following-char) ?\")
1916                         (forward-char 1))
1917                       (insert prefix)
1918                       (zerop (forward-line 1)))))))
1919     ;; Store the active file in a hash table.
1920     (goto-char (point-min))
1921     (let (group max min)
1922       (while (not (eobp))
1923         (condition-case ()
1924             (progn
1925               (narrow-to-region (point) (gnus-point-at-eol))
1926               ;; group gets set to a symbol interned in the hash table
1927               ;; (what a hack!!) - jwz
1928               (setq group (let ((obarray hashtb)) (read cur)))
1929               ;; ### The extended group name scheme makes
1930               ;; the previous optimization strategy sort of pointless...
1931               (when (stringp group)
1932                 (setq group (intern group hashtb)))
1933               (if (and (numberp (setq max (read cur)))
1934                        (numberp (setq min (read cur)))
1935                        (progn
1936                          (skip-chars-forward " \t")
1937                          (not
1938                           (or (eq (char-after) ?=)
1939                               (eq (char-after) ?x)
1940                               (eq (char-after) ?j)))))
1941                   (progn
1942                     (set group (cons min max))
1943                     ;; if group is moderated, stick in moderation table
1944                     (when (eq (char-after) ?m)
1945                       (unless gnus-moderated-hashtb
1946                         (setq gnus-moderated-hashtb (gnus-make-hashtable)))
1947                       (gnus-sethash (symbol-name group) t
1948                                     gnus-moderated-hashtb)))
1949                 (set group nil)))
1950           (error
1951            (and group
1952                 (symbolp group)
1953                 (set group nil))
1954            (unless ignore-errors
1955              (gnus-message 3 "Warning - invalid active: %s"
1956                            (buffer-substring
1957                             (gnus-point-at-bol) (gnus-point-at-eol))))))
1958         (widen)
1959         (forward-line 1)))))
1960
1961 (defun gnus-groups-to-gnus-format (method &optional hashtb real-active)
1962   ;; Parse a "groups" active file.
1963   (let ((cur (current-buffer))
1964         (hashtb (or hashtb
1965                     (if (and method gnus-active-hashtb)
1966                         gnus-active-hashtb
1967                       (setq gnus-active-hashtb
1968                             (gnus-make-hashtable
1969                              (count-lines (point-min) (point-max)))))))
1970         (prefix (and method
1971                      (not (gnus-server-equal
1972                            (gnus-server-get-method nil method)
1973                            (gnus-server-get-method nil gnus-select-method)))
1974                      (gnus-group-prefixed-name "" method))))
1975
1976     ;; Let the Gnus agent save the active file.
1977     (if (and gnus-agent
1978              real-active
1979              (gnus-online method)
1980              (gnus-agent-method-p method))
1981         (progn
1982           (gnus-agent-save-groups method)
1983           (gnus-active-to-gnus-format method hashtb nil real-active))
1984
1985       (goto-char (point-min))
1986       ;; We split this into to separate loops, one with the prefix
1987       ;; and one without to speed the reading up somewhat.
1988       (if prefix
1989           (let (min max opoint group)
1990             (while (not (eobp))
1991               (condition-case ()
1992                   (progn
1993                     (read cur) (read cur)
1994                     (setq min (read cur)
1995                           max (read cur)
1996                           opoint (point))
1997                     (skip-chars-forward " \t")
1998                     (insert prefix)
1999                     (goto-char opoint)
2000                     (set (let ((obarray hashtb)) (read cur))
2001                          (cons min max)))
2002                 (error (and group (symbolp group) (set group nil))))
2003               (forward-line 1)))
2004         (let (min max group)
2005           (while (not (eobp))
2006             (condition-case ()
2007                 (when (eq (char-after) ?2)
2008                   (read cur) (read cur)
2009                   (setq min (read cur)
2010                         max (read cur))
2011                   (set (setq group (let ((obarray hashtb)) (read cur)))
2012                        (cons min max)))
2013               (error (and group (symbolp group) (set group nil))))
2014             (forward-line 1)))))))
2015
2016 (defun gnus-read-newsrc-file (&optional force)
2017   "Read startup file.
2018 If FORCE is non-nil, the .newsrc file is read."
2019   ;; Reset variables that might be defined in the .newsrc.eld file.
2020   (let ((variables (delete 'gnus-format-specs gnus-variable-list)))
2021     (while variables
2022       (set (car variables) nil)
2023       (setq variables (cdr variables))))
2024   (let* ((newsrc-file gnus-current-startup-file)
2025          (quick-file (concat newsrc-file ".el")))
2026     (save-excursion
2027       ;; We always load the .newsrc.eld file.  If always contains
2028       ;; much information that can not be gotten from the .newsrc
2029       ;; file (ticked articles, killed groups, foreign methods, etc.)
2030       (gnus-read-newsrc-el-file quick-file)
2031
2032       (when (and gnus-read-newsrc-file
2033                  (file-exists-p gnus-current-startup-file)
2034                  (or force
2035                      (and (file-newer-than-file-p newsrc-file quick-file)
2036                           (file-newer-than-file-p newsrc-file
2037                                                   (concat quick-file "d")))
2038                      (not gnus-newsrc-alist)))
2039         ;; We read the .newsrc file.  Note that if there if a
2040         ;; .newsrc.eld file exists, it has already been read, and
2041         ;; the `gnus-newsrc-hashtb' has been created.  While reading
2042         ;; the .newsrc file, Gnus will only use the information it
2043         ;; can find there for changing the data already read -
2044         ;; i. e., reading the .newsrc file will not trash the data
2045         ;; already read (except for read articles).
2046         (save-excursion
2047           (gnus-message 5 "Reading %s..." newsrc-file)
2048           (set-buffer (nnheader-find-file-noselect newsrc-file))
2049           (buffer-disable-undo)
2050           (gnus-newsrc-to-gnus-format)
2051           (kill-buffer (current-buffer))
2052           (gnus-message 5 "Reading %s...done" newsrc-file)))
2053
2054       ;; Convert old to new.
2055       (gnus-convert-old-newsrc))))
2056
2057 (defun gnus-convert-old-newsrc ()
2058   "Convert old newsrc into the new format, if needed."
2059   (let ((fcv (and gnus-newsrc-file-version
2060                   (gnus-continuum-version gnus-newsrc-file-version))))
2061     (cond
2062      ;; No .newsrc.eld file was loaded.
2063      ((null fcv) nil)
2064      ;; Gnus 5 .newsrc.eld was loaded.
2065      ((< fcv (gnus-continuum-version "September Gnus v0.1"))
2066       (gnus-convert-old-ticks)))))
2067
2068 (defun gnus-convert-old-ticks ()
2069   (let ((newsrc (cdr gnus-newsrc-alist))
2070         marks info dormant ticked)
2071     (while (setq info (pop newsrc))
2072       (when (setq marks (gnus-info-marks info))
2073         (setq dormant (cdr (assq 'dormant marks))
2074               ticked (cdr (assq 'tick marks)))
2075         (when (or dormant ticked)
2076           (gnus-info-set-read
2077            info
2078            (gnus-add-to-range
2079             (gnus-info-read info)
2080             (nconc (gnus-uncompress-range dormant)
2081                    (gnus-uncompress-range ticked)))))))))
2082
2083 (defun gnus-read-newsrc-el-file (file)
2084   (let ((ding-file (concat file "d")))
2085     ;; We always, always read the .eld file.
2086     (gnus-message 5 "Reading %s..." ding-file)
2087     (let (gnus-newsrc-assoc)
2088       (if (or debug-on-error debug-on-quit)
2089           (let ((coding-system-for-read gnus-ding-file-coding-system))
2090             (load ding-file t t t))
2091         (condition-case nil
2092             (let ((coding-system-for-read gnus-ding-file-coding-system))
2093               (load ding-file t t t))
2094           (error
2095            (ding)
2096            (unless (gnus-yes-or-no-p
2097                     (format "Error in %s; continue? " ding-file))
2098              (error "Error in %s" ding-file)))))
2099       ;; Older versions of `gnus-format-specs' are no longer valid
2100       ;; in Oort Gnus 0.01.
2101       (let ((version
2102              (and gnus-newsrc-file-version
2103                   (gnus-continuum-version gnus-newsrc-file-version))))
2104         (when (or (not version)
2105                   (< version 5.090009))
2106           (setq gnus-format-specs gnus-default-format-specs)))
2107       (when gnus-newsrc-assoc
2108         (setq gnus-newsrc-alist gnus-newsrc-assoc)))
2109     (gnus-make-hashtable-from-newsrc-alist)
2110     (when (file-newer-than-file-p file ding-file)
2111       ;; Old format quick file
2112       (gnus-message 5 "Reading %s..." file)
2113       ;; The .el file is newer than the .eld file, so we read that one
2114       ;; as well.
2115       (gnus-read-old-newsrc-el-file file))))
2116
2117 ;; Parse the old-style quick startup file
2118 (defun gnus-read-old-newsrc-el-file (file)
2119   (let (newsrc killed marked group m info)
2120     (prog1
2121         (let ((gnus-killed-assoc nil)
2122               gnus-marked-assoc gnus-newsrc-alist gnus-newsrc-assoc)
2123           (prog1
2124               (ignore-errors
2125                 (load file t t t))
2126             (setq newsrc gnus-newsrc-assoc
2127                   killed gnus-killed-assoc
2128                   marked gnus-marked-assoc)))
2129       (setq gnus-newsrc-alist nil)
2130       (while (setq group (pop newsrc))
2131         (if (setq info (gnus-get-info (car group)))
2132             (progn
2133               (gnus-info-set-read info (cddr group))
2134               (gnus-info-set-level
2135                info (if (nth 1 group) gnus-level-default-subscribed
2136                       gnus-level-default-unsubscribed))
2137               (push info gnus-newsrc-alist))
2138           (push (setq info
2139                       (list (car group)
2140                             (if (nth 1 group) gnus-level-default-subscribed
2141                               gnus-level-default-unsubscribed)
2142                             (cddr group)))
2143                 gnus-newsrc-alist))
2144         ;; Copy marks into info.
2145         (when (setq m (assoc (car group) marked))
2146           (unless (nthcdr 3 info)
2147             (nconc info (list nil)))
2148           (gnus-info-set-marks
2149            info (list (cons 'tick (gnus-compress-sequence
2150                                    (sort (cdr m) '<) t))))))
2151       (setq newsrc killed)
2152       (while newsrc
2153         (setcar newsrc (caar newsrc))
2154         (setq newsrc (cdr newsrc)))
2155       (setq gnus-killed-list killed))
2156     ;; The .el file version of this variable does not begin with
2157     ;; "options", while the .eld version does, so we just add it if it
2158     ;; isn't there.
2159     (when
2160         gnus-newsrc-options
2161       (when (not (string-match "^ *options" gnus-newsrc-options))
2162         (setq gnus-newsrc-options (concat "options " gnus-newsrc-options)))
2163       (when (not (string-match "\n$" gnus-newsrc-options))
2164         (setq gnus-newsrc-options (concat gnus-newsrc-options "\n")))
2165       ;; Finally, if we read some options lines, we parse them.
2166       (unless (string= gnus-newsrc-options "")
2167         (gnus-newsrc-parse-options gnus-newsrc-options)))
2168
2169     (setq gnus-newsrc-alist (nreverse gnus-newsrc-alist))
2170     (gnus-make-hashtable-from-newsrc-alist)))
2171
2172 (defun gnus-make-newsrc-file (file)
2173   "Make server dependent file name by catenating FILE and server host name."
2174   (let* ((file (expand-file-name file nil))
2175          (real-file (concat file "-" (nth 1 gnus-select-method))))
2176     (if (or (file-exists-p real-file)
2177             (file-exists-p (concat real-file ".el"))
2178             (file-exists-p (concat real-file ".eld")))
2179         real-file
2180       file)))
2181
2182 (defun gnus-newsrc-to-gnus-format ()
2183   (setq gnus-newsrc-options "")
2184   (setq gnus-newsrc-options-n nil)
2185
2186   (unless gnus-active-hashtb
2187     (setq gnus-active-hashtb (gnus-make-hashtable 4096)))
2188   (let ((buf (current-buffer))
2189         (already-read (> (length gnus-newsrc-alist) 1))
2190         group subscribed options-symbol newsrc Options-symbol
2191         symbol reads num1)
2192     (goto-char (point-min))
2193     ;; We intern the symbol `options' in the active hashtb so that we
2194     ;; can `eq' against it later.
2195     (set (setq options-symbol (intern "options" gnus-active-hashtb)) nil)
2196     (set (setq Options-symbol (intern "Options" gnus-active-hashtb)) nil)
2197
2198     (while (not (eobp))
2199       ;; We first read the first word on the line by narrowing and
2200       ;; then reading into `gnus-active-hashtb'.  Most groups will
2201       ;; already exist in that hashtb, so this will save some string
2202       ;; space.
2203       (narrow-to-region
2204        (point)
2205        (progn (skip-chars-forward "^ \t!:\n") (point)))
2206       (goto-char (point-min))
2207       (setq symbol
2208             (and (/= (point-min) (point-max))
2209                  (let ((obarray gnus-active-hashtb)) (read buf))))
2210       (widen)
2211       ;; Now, the symbol we have read is either `options' or a group
2212       ;; name.  If it is an options line, we just add it to a string.
2213       (cond
2214        ((or (eq symbol options-symbol)
2215             (eq symbol Options-symbol))
2216         (setq gnus-newsrc-options
2217               ;; This concating is quite inefficient, but since our
2218               ;; thorough studies show that approx 99.37% of all
2219               ;; .newsrc files only contain a single options line, we
2220               ;; don't give a damn, frankly, my dear.
2221               (concat gnus-newsrc-options
2222                       (buffer-substring
2223                        (gnus-point-at-bol)
2224                        ;; Options may continue on the next line.
2225                        (or (and (re-search-forward "^[^ \t]" nil 'move)
2226                                 (progn (beginning-of-line) (point)))
2227                            (point)))))
2228         (forward-line -1))
2229        (symbol
2230         ;; Group names can be just numbers.
2231         (when (numberp symbol)
2232           (setq symbol (intern (int-to-string symbol) gnus-active-hashtb)))
2233         (unless (boundp symbol)
2234           (set symbol nil))
2235         ;; It was a group name.
2236         (setq subscribed (eq (char-after) ?:)
2237               group (symbol-name symbol)
2238               reads nil)
2239         (if (eolp)
2240             ;; If the line ends here, this is clearly a buggy line, so
2241             ;; we put point a the beginning of line and let the cond
2242             ;; below do the error handling.
2243             (beginning-of-line)
2244           ;; We skip to the beginning of the ranges.
2245           (skip-chars-forward "!: \t"))
2246         ;; We are now at the beginning of the list of read articles.
2247         ;; We read them range by range.
2248         (while
2249             (cond
2250              ((looking-at "[0-9]+")
2251               ;; We narrow and read a number instead of buffer-substring/
2252               ;; string-to-int because it's faster.  narrow/widen is
2253               ;; faster than save-restriction/narrow, and save-restriction
2254               ;; produces a garbage object.
2255               (setq num1 (progn
2256                            (narrow-to-region (match-beginning 0) (match-end 0))
2257                            (read buf)))
2258               (widen)
2259               ;; If the next character is a dash, then this is a range.
2260               (if (eq (char-after) ?-)
2261                   (progn
2262                     ;; We read the upper bound of the range.
2263                     (forward-char 1)
2264                     (if (not (looking-at "[0-9]+"))
2265                         ;; This is a buggy line, by we pretend that
2266                         ;; it's kinda OK.  Perhaps the user should be
2267                         ;; dinged?
2268                         (push num1 reads)
2269                       (push
2270                        (cons num1
2271                              (progn
2272                                (narrow-to-region (match-beginning 0)
2273                                                  (match-end 0))
2274                                (read buf)))
2275                        reads)
2276                       (widen)))
2277                 ;; It was just a simple number, so we add it to the
2278                 ;; list of ranges.
2279                 (push num1 reads))
2280               ;; If the next char in ?\n, then we have reached the end
2281               ;; of the line and return nil.
2282               (not (eq (char-after) ?\n)))
2283              ((eq (char-after) ?\n)
2284               ;; End of line, so we end.
2285               nil)
2286              (t
2287               ;; Not numbers and not eol, so this might be a buggy
2288               ;; line...
2289               (unless (eobp)
2290                 ;; If it was eob instead of ?\n, we allow it.
2291                 ;; The line was buggy.
2292                 (setq group nil)
2293                 (gnus-error 3.1 "Mangled line: %s"
2294                             (buffer-substring (gnus-point-at-bol)
2295                                               (gnus-point-at-eol))))
2296               nil))
2297           ;; Skip past ", ".  Spaces are invalid in these ranges, but
2298           ;; we allow them, because it's a common mistake to put a
2299           ;; space after the comma.
2300           (skip-chars-forward ", "))
2301
2302         ;; We have already read .newsrc.eld, so we gently update the
2303         ;; data in the hash table with the information we have just
2304         ;; read.
2305         (when group
2306           (let ((info (gnus-get-info group))
2307                 level)
2308             (if info
2309                 ;; There is an entry for this file in the alist.
2310                 (progn
2311                   (gnus-info-set-read info (nreverse reads))
2312                   ;; We update the level very gently.  In fact, we
2313                   ;; only change it if there's been a status change
2314                   ;; from subscribed to unsubscribed, or vice versa.
2315                   (setq level (gnus-info-level info))
2316                   (cond ((and (<= level gnus-level-subscribed)
2317                               (not subscribed))
2318                          (setq level (if reads
2319                                          gnus-level-default-unsubscribed
2320                                        (1+ gnus-level-default-unsubscribed))))
2321                         ((and (> level gnus-level-subscribed) subscribed)
2322                          (setq level gnus-level-default-subscribed)))
2323                   (gnus-info-set-level info level))
2324               ;; This is a new group.
2325               (setq info (list group
2326                                (if subscribed
2327                                    gnus-level-default-subscribed
2328                                  (if reads
2329                                      (1+ gnus-level-subscribed)
2330                                    gnus-level-default-unsubscribed))
2331                                (nreverse reads))))
2332             (push info newsrc)))))
2333       (forward-line 1))
2334
2335     (setq newsrc (nreverse newsrc))
2336
2337     (if (not already-read)
2338         ()
2339       ;; We now have two newsrc lists - `newsrc', which is what we
2340       ;; have read from .newsrc, and `gnus-newsrc-alist', which is
2341       ;; what we've read from .newsrc.eld.  We have to merge these
2342       ;; lists.  We do this by "attaching" any (foreign) groups in the
2343       ;; gnus-newsrc-alist to the (native) group that precedes them.
2344       (let ((rc (cdr gnus-newsrc-alist))
2345             (prev gnus-newsrc-alist)
2346             entry mentry)
2347         (while rc
2348           (or (null (nth 4 (car rc)))   ; It's a native group.
2349               (assoc (caar rc) newsrc)  ; It's already in the alist.
2350               (if (setq entry (assoc (caar prev) newsrc))
2351                   (setcdr (setq mentry (memq entry newsrc))
2352                           (cons (car rc) (cdr mentry)))
2353                 (push (car rc) newsrc)))
2354           (setq prev rc
2355                 rc (cdr rc)))))
2356
2357     (setq gnus-newsrc-alist newsrc)
2358     ;; We make the newsrc hashtb.
2359     (gnus-make-hashtable-from-newsrc-alist)
2360
2361     ;; Finally, if we read some options lines, we parse them.
2362     (unless (string= gnus-newsrc-options "")
2363       (gnus-newsrc-parse-options gnus-newsrc-options))))
2364
2365 ;; Parse options lines to find "options -n !all rec.all" and stuff.
2366 ;; The return value will be a list on the form
2367 ;; ((regexp1 . ignore)
2368 ;;  (regexp2 . subscribe)...)
2369 ;; When handling new newsgroups, groups that match a `ignore' regexp
2370 ;; will be ignored, and groups that match a `subscribe' regexp will be
2371 ;; subscribed.  A line like
2372 ;; options -n !all rec.all
2373 ;; will lead to a list that looks like
2374 ;; (("^rec\\..+" . subscribe)
2375 ;;  ("^.+" . ignore))
2376 ;; So all "rec.*" groups will be subscribed, while all the other
2377 ;; groups will be ignored.  Note that "options -n !all rec.all" is very
2378 ;; different from "options -n rec.all !all".
2379 (defun gnus-newsrc-parse-options (options)
2380   (let (out eol)
2381     (save-excursion
2382       (gnus-set-work-buffer)
2383       (insert (regexp-quote options))
2384       ;; First we treat all continuation lines.
2385       (goto-char (point-min))
2386       (while (re-search-forward "\n[ \t]+" nil t)
2387         (replace-match " " t t))
2388       ;; Then we transform all "all"s into ".+"s.
2389       (goto-char (point-min))
2390       (while (re-search-forward "\\ball\\b" nil t)
2391         (replace-match ".+" t t))
2392       (goto-char (point-min))
2393       ;; We remove all other options than the "-n" ones.
2394       (while (re-search-forward "[ \t]-[^n][^-]*" nil t)
2395         (replace-match " ")
2396         (forward-char -1))
2397       (goto-char (point-min))
2398
2399       ;; We are only interested in "options -n" lines - we
2400       ;; ignore the other option lines.
2401       (while (re-search-forward "[ \t]-n" nil t)
2402         (setq eol
2403               (or (save-excursion
2404                     (and (re-search-forward "[ \t]-n" (gnus-point-at-eol) t)
2405                          (- (point) 2)))
2406                   (gnus-point-at-eol)))
2407         ;; Search for all "words"...
2408         (while (re-search-forward "[^ \t,\n]+" eol t)
2409           (if (eq (char-after (match-beginning 0)) ?!)
2410               ;; If the word begins with a bang (!), this is a "not"
2411               ;; spec.  We put this spec (minus the bang) and the
2412               ;; symbol `ignore' into the list.
2413               (push (cons (concat
2414                            "^" (buffer-substring
2415                                 (1+ (match-beginning 0))
2416                                 (match-end 0))
2417                            "\\($\\|\\.\\)")
2418                           'ignore)
2419                     out)
2420             ;; There was no bang, so this is a "yes" spec.
2421             (push (cons (concat "^" (match-string 0) "\\($\\|\\.\\)")
2422                         'subscribe)
2423                   out))))
2424
2425       (setq gnus-newsrc-options-n out))))
2426
2427 (defun gnus-save-newsrc-file (&optional force)
2428   "Save .newsrc file."
2429   ;; Note: We cannot save .newsrc file if all newsgroups are removed
2430   ;; from the variable gnus-newsrc-alist.
2431   (when (and (or gnus-newsrc-alist gnus-killed-list)
2432              gnus-current-startup-file)
2433     (save-excursion
2434       (if (and (or gnus-use-dribble-file gnus-slave)
2435                (not force)
2436                (or (not gnus-dribble-buffer)
2437                    (not (buffer-name gnus-dribble-buffer))
2438                    (zerop (save-excursion
2439                             (set-buffer gnus-dribble-buffer)
2440                             (buffer-size)))))
2441           (gnus-message 4 "(No changes need to be saved)")
2442         (gnus-run-hooks 'gnus-save-newsrc-hook)
2443         (if gnus-slave
2444             (gnus-slave-save-newsrc)
2445           ;; Save .newsrc.
2446           (when gnus-save-newsrc-file
2447             (gnus-message 8 "Saving %s..." gnus-current-startup-file)
2448             (gnus-gnus-to-newsrc-format)
2449             (gnus-message 8 "Saving %s...done" gnus-current-startup-file))
2450           ;; Save .newsrc.eld.
2451           (set-buffer (gnus-get-buffer-create " *Gnus-newsrc*"))
2452           (make-local-variable 'version-control)
2453           (setq version-control 'never)
2454           (setq buffer-file-name
2455                 (concat gnus-current-startup-file ".eld"))
2456           (setq default-directory (file-name-directory buffer-file-name))
2457           (buffer-disable-undo)
2458           (erase-buffer)
2459           (gnus-message 5 "Saving %s.eld..." gnus-current-startup-file)
2460           (gnus-gnus-to-quick-newsrc-format)
2461           (gnus-run-hooks 'gnus-save-quick-newsrc-hook)
2462           (let ((coding-system-for-write gnus-ding-file-coding-system))
2463             (save-buffer))
2464           (kill-buffer (current-buffer))
2465           (gnus-message
2466            5 "Saving %s.eld...done" gnus-current-startup-file))
2467         (gnus-dribble-delete-file)
2468         (gnus-group-set-mode-line)))))
2469
2470 (defun gnus-gnus-to-quick-newsrc-format ()
2471   "Insert Gnus variables such as gnus-newsrc-alist in lisp format."
2472   (let ((print-quoted t)
2473         (print-escape-newlines t))
2474
2475     (insert ";; -*- emacs-lisp -*-\n")
2476     (insert ";; Gnus startup file.\n")
2477     (insert "\
2478 ;; Never delete this file -- if you want to force Gnus to read the
2479 ;; .newsrc file (if you have one), touch .newsrc instead.\n")
2480     (insert "(setq gnus-newsrc-file-version "
2481             (prin1-to-string gnus-version) ")\n")
2482     (let* ((gnus-killed-list
2483             (if (and gnus-save-killed-list
2484                      (stringp gnus-save-killed-list))
2485                 (gnus-strip-killed-list)
2486               gnus-killed-list))
2487            (variables
2488             (if gnus-save-killed-list gnus-variable-list
2489               ;; Remove the `gnus-killed-list' from the list of variables
2490               ;; to be saved, if required.
2491               (delq 'gnus-killed-list (copy-sequence gnus-variable-list))))
2492            ;; Peel off the "dummy" group.
2493            (gnus-newsrc-alist (cdr gnus-newsrc-alist))
2494            variable)
2495       ;; Insert the variables into the file.
2496       (while variables
2497         (when (and (boundp (setq variable (pop variables)))
2498                    (symbol-value variable))
2499           (insert "(setq " (symbol-name variable) " '")
2500           (gnus-prin1 (symbol-value variable))
2501           (insert ")\n"))))))
2502
2503 (defun gnus-strip-killed-list ()
2504   "Return the killed list minus the groups that match `gnus-save-killed-list'."
2505   (let ((list gnus-killed-list)
2506         olist)
2507     (while list
2508       (when (string-match gnus-save-killed-list (car list))
2509         (push (car list) olist))
2510       (pop list))
2511     (nreverse olist)))
2512
2513 (defun gnus-gnus-to-newsrc-format ()
2514   ;; Generate and save the .newsrc file.
2515   (save-excursion
2516     (set-buffer (create-file-buffer gnus-current-startup-file))
2517     (let ((newsrc (cdr gnus-newsrc-alist))
2518           (standard-output (current-buffer))
2519           info ranges range method)
2520       (setq buffer-file-name gnus-current-startup-file)
2521       (setq default-directory (file-name-directory buffer-file-name))
2522       (buffer-disable-undo)
2523       (erase-buffer)
2524       ;; Write options.
2525       (when gnus-newsrc-options
2526         (insert gnus-newsrc-options))
2527       ;; Write subscribed and unsubscribed.
2528       (while (setq info (pop newsrc))
2529         ;; Don't write foreign groups to .newsrc.
2530         (when (or (null (setq method (gnus-info-method info)))
2531                   (equal method "native")
2532                   (inline (gnus-server-equal method gnus-select-method)))
2533           (insert (gnus-info-group info)
2534                   (if (> (gnus-info-level info) gnus-level-subscribed)
2535                       "!" ":"))
2536           (when (setq ranges (gnus-info-read info))
2537             (insert " ")
2538             (if (not (listp (cdr ranges)))
2539                 (if (= (car ranges) (cdr ranges))
2540                     (princ (car ranges))
2541                   (princ (car ranges))
2542                   (insert "-")
2543                   (princ (cdr ranges)))
2544               (while (setq range (pop ranges))
2545                 (if (or (atom range) (= (car range) (cdr range)))
2546                     (princ (or (and (atom range) range) (car range)))
2547                   (princ (car range))
2548                   (insert "-")
2549                   (princ (cdr range)))
2550                 (when ranges
2551                   (insert ",")))))
2552           (insert "\n")))
2553       (make-local-variable 'version-control)
2554       (setq version-control 'never)
2555       ;; It has been reported that sometime the modtime on the .newsrc
2556       ;; file seems to be off.  We really do want to overwrite it, so
2557       ;; we clear the modtime here before saving.  It's a bit odd,
2558       ;; though...
2559       ;; sometimes the modtime clear isn't sufficient.  most brute force:
2560       ;; delete the silly thing entirely first.  but this fails to provide
2561       ;; such niceties as .newsrc~ creation.
2562       (if gnus-modtime-botch
2563           (delete-file gnus-startup-file)
2564         (clear-visited-file-modtime))
2565       (gnus-run-hooks 'gnus-save-standard-newsrc-hook)
2566       (save-buffer)
2567       (kill-buffer (current-buffer)))))
2568
2569 \f
2570 ;;;
2571 ;;; Slave functions.
2572 ;;;
2573
2574 (defvar gnus-slave-mode nil)
2575
2576 (defun gnus-slave-mode ()
2577   "Minor mode for slave Gnusae."
2578   (gnus-add-minor-mode 'gnus-slave-mode " Slave" (make-sparse-keymap))
2579   (gnus-run-hooks 'gnus-slave-mode-hook))
2580
2581 (defun gnus-slave-save-newsrc ()
2582   (save-excursion
2583     (set-buffer gnus-dribble-buffer)
2584     (let ((slave-name
2585            (make-temp-name (concat gnus-current-startup-file "-slave-")))
2586           (modes (ignore-errors
2587                    (file-modes (concat gnus-current-startup-file ".eld")))))
2588       (let ((coding-system-for-write gnus-ding-file-coding-system))
2589         (gnus-write-buffer slave-name))
2590       (when modes
2591         (set-file-modes slave-name modes)))))
2592
2593 (defun gnus-master-read-slave-newsrc ()
2594   (let ((slave-files
2595          (directory-files
2596           (file-name-directory gnus-current-startup-file)
2597           t (concat
2598              "^" (regexp-quote
2599                   (concat
2600                    (file-name-nondirectory gnus-current-startup-file)
2601                    "-slave-")))
2602           t))
2603         file)
2604     (if (not slave-files)
2605         ()                              ; There are no slave files to read.
2606       (gnus-message 7 "Reading slave newsrcs...")
2607       (save-excursion
2608         (set-buffer (gnus-get-buffer-create " *gnus slave*"))
2609         (setq slave-files
2610               (sort (mapcar (lambda (file)
2611                               (list (nth 5 (file-attributes file)) file))
2612                             slave-files)
2613                     (lambda (f1 f2)
2614                       (or (< (caar f1) (caar f2))
2615                           (< (nth 1 (car f1)) (nth 1 (car f2)))))))
2616         (while slave-files
2617           (erase-buffer)
2618           (setq file (nth 1 (car slave-files)))
2619           (nnheader-insert-file-contents file)
2620           (when (condition-case ()
2621                     (progn
2622                       (eval-buffer (current-buffer))
2623                       t)
2624                   (error
2625                    (gnus-error 3.2 "Possible error in %s" file)
2626                    nil))
2627             (unless gnus-slave          ; Slaves shouldn't delete these files.
2628               (ignore-errors
2629                 (delete-file file))))
2630           (setq slave-files (cdr slave-files))))
2631       (gnus-dribble-touch)
2632       (gnus-message 7 "Reading slave newsrcs...done"))))
2633
2634 \f
2635 ;;;
2636 ;;; Group description.
2637 ;;;
2638
2639 (defun gnus-read-all-descriptions-files ()
2640   (let ((methods (cons gnus-select-method
2641                        (nconc
2642                         (when (gnus-archive-server-wanted-p)
2643                           (list "archive"))
2644                         gnus-secondary-select-methods))))
2645     (while methods
2646       (gnus-read-descriptions-file (car methods))
2647       (setq methods (cdr methods)))
2648     t))
2649
2650 (defun gnus-read-descriptions-file (&optional method)
2651   (let ((method (or method gnus-select-method))
2652         group)
2653     (when (stringp method)
2654       (setq method (gnus-server-to-method method)))
2655     ;; We create the hashtable whether we manage to read the desc file
2656     ;; to avoid trying to re-read after a failed read.
2657     (unless gnus-description-hashtb
2658       (setq gnus-description-hashtb
2659             (gnus-make-hashtable (length gnus-active-hashtb))))
2660     ;; Mark this method's desc file as read.
2661     (gnus-sethash (gnus-group-prefixed-name "" method) "Has read"
2662                   gnus-description-hashtb)
2663
2664     (gnus-message 5 "Reading descriptions file via %s..." (car method))
2665     (cond
2666      ((null (gnus-get-function method 'request-list-newsgroups t))
2667       t)
2668      ((not (gnus-check-server method))
2669       (gnus-message 1 "Couldn't open server")
2670       nil)
2671      ((not (gnus-request-list-newsgroups method))
2672       (gnus-message 1 "Couldn't read newsgroups descriptions")
2673       nil)
2674      (t
2675       (save-excursion
2676         (save-restriction
2677           (set-buffer nntp-server-buffer)
2678           (goto-char (point-min))
2679           (when (or (search-forward "\n.\n" nil t)
2680                     (goto-char (point-max)))
2681             (beginning-of-line)
2682             (narrow-to-region (point-min) (point)))
2683           ;; If these are groups from a foreign select method, we insert the
2684           ;; group prefix in front of the group names.
2685           (and method (not (inline
2686                              (gnus-server-equal
2687                               (gnus-server-get-method nil method)
2688                               (gnus-server-get-method
2689                                nil gnus-select-method))))
2690                (let ((prefix (gnus-group-prefixed-name "" method)))
2691                  (goto-char (point-min))
2692                  (while (and (not (eobp))
2693                              (progn (insert prefix)
2694                                     (zerop (forward-line 1)))))))
2695           (goto-char (point-min))
2696           (while (not (eobp))
2697             ;; If we get an error, we set group to 0, which is not a
2698             ;; symbol...
2699             (setq group
2700                   (condition-case ()
2701                       (let ((obarray gnus-description-hashtb))
2702                         ;; Group is set to a symbol interned in this
2703                         ;; hash table.
2704                         (read nntp-server-buffer))
2705                     (error 0)))
2706             (skip-chars-forward " \t")
2707             ;; ...  which leads to this line being effectively ignored.
2708             (when (symbolp group)
2709               (let* ((str (buffer-substring
2710                            (point) (progn (end-of-line) (point))))
2711                      (name (symbol-name group))
2712                      (charset
2713                       (or (gnus-group-name-charset method name)
2714                           (gnus-parameter-charset name)
2715                           gnus-default-charset)))
2716                 (when (and str charset (featurep 'mule))
2717                   (setq str (mm-decode-coding-string str charset)))
2718                 (set group str)))
2719             (forward-line 1))))
2720       (gnus-message 5 "Reading descriptions file...done")
2721       t))))
2722
2723 (defun gnus-group-get-description (group)
2724   "Get the description of a group by sending XGTITLE to the server."
2725   (when (gnus-request-group-description group)
2726     (save-excursion
2727       (set-buffer nntp-server-buffer)
2728       (goto-char (point-min))
2729       (when (looking-at "[^ \t]+[ \t]+\\(.*\\)")
2730         (match-string 1)))))
2731
2732 ;;;###autoload
2733 (defun gnus-declare-backend (name &rest abilities)
2734   "Declare backend NAME with ABILITIES as a Gnus backend."
2735   (setq gnus-valid-select-methods
2736         (nconc gnus-valid-select-methods
2737                (list (apply 'list name abilities))))
2738   (gnus-redefine-select-method-widget))
2739
2740 (defun gnus-set-default-directory ()
2741   "Set the default directory in the current buffer to `gnus-default-directory'.
2742 If this variable is nil, don't do anything."
2743   (setq default-directory
2744         (if (and gnus-default-directory
2745                  (file-exists-p gnus-default-directory))
2746             (file-name-as-directory (expand-file-name gnus-default-directory))
2747           default-directory)))
2748
2749 (defun gnus-display-time-event-handler ()
2750   "Like `display-time-event-handler', but test `display-time-timer'."
2751   (when (gnus-boundp 'display-time-timer)
2752     (display-time-event-handler)))
2753
2754 (provide 'gnus-start)
2755
2756 ;;; gnus-start.el ends here