git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-start.el

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