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