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