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