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