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